Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor the Stretch tab in BayesFitting to meet MVP design pattren #38388

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

MohamedAlmaki
Copy link
Contributor

Description of work

This pull request replaces the old single-class Stretch tab with new model, presenter, and view classes to follow the MVP pattern. The goal of this work is to modernize the current codebase of the tab and adhere to best design practices.
Fixes #38005.

To test:

Follow the manual testing documentation and try to test multiple scenarios: https://developer.mantidproject.org/Testing/Inelastic/BayesFittingTests.html


Reviewer

Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.

Code Review

  • Is the code of an acceptable quality?
  • Does the code conform to the coding standards?
  • Are the unit tests small and test the class in isolation?
  • If there is GUI work does it follow the GUI standards?
  • If there are changes in the release notes then do they describe the changes appropriately?
  • Do the release notes conform to the release notes guide?

Functional Tests

  • Do changes function as described? Add comments below that describe the tests performed?
  • Do the changes handle unexpected situations, e.g. bad input?
  • Has the relevant (user and developer) documentation been added/updated?

Does everything look good? Mark the review as Approve. A member of @mantidproject/gatekeepers will take care of it.

Gatekeeper

If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.

@MohamedAlmaki MohamedAlmaki added Indirect/Inelastic Issues and pull requests related to indirect or inelastic Maintenance Unassigned issues to be addressed in the next maintenance period. ISIS Team: Spectroscopy Issue and pull requests managed by the Spectroscopy subteam at ISIS labels Nov 12, 2024
@MohamedAlmaki MohamedAlmaki added this to the Release 6.12 milestone Nov 12, 2024
@MohamedAlmaki MohamedAlmaki force-pushed the 38005_mvp_stretch branch 4 times, most recently from 941c3c8 to 193fe5d Compare November 25, 2024 12:04
Copy link
Contributor

@robertapplin robertapplin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this much needed refactor! I've done a first pass through the code and have a couple of suggestions below

Please can you also add a test for the presenter and model?

@@ -45,6 +45,8 @@ class MANTIDQT_INELASTIC_DLL BayesFitting : public InelasticInterface {
void initLayout() override;

private:
std::unique_ptr<MantidQt::API::AlgorithmRunner> createAlgorithmRunner();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this function be const?

Comment on lines +53 to +55
auto filename = saveDir + wsName + ".nxs";
if (filename.empty())
saveProps->setProperty("Filename", wsName + ".nxs");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe the filename parameter will never be empty because it always has + ".nxs" added to the end even if the save directory or workspace name is empty


void StretchView::setSaveResultEnabled(bool enabled) { m_uiForm.pbSave->setEnabled(enabled); }

int StretchView::displaySaveDirectoryMessage() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this return type be bool? I think at the moment its doing an implicit cast from bool to int

Comment on lines +66 to +67
StretchView *m_view;
std::unique_ptr<StretchModel> m_model;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we want both of these to be an IStretchView and an IStretchModel, so that our tests can use the mock versions of our classes

class MANTIDQT_INELASTIC_DLL StretchPresenter : public BayesFittingTab, public IStretchPresenter {

public:
StretchPresenter(QWidget *parent, StretchView *view, std::unique_ptr<StretchModel> model,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We also want these arguments to be an IStretchView and IStretchModel

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Indirect/Inelastic Issues and pull requests related to indirect or inelastic ISIS Team: Spectroscopy Issue and pull requests managed by the Spectroscopy subteam at ISIS Maintenance Unassigned issues to be addressed in the next maintenance period.
Projects
Status: Waiting response
Development

Successfully merging this pull request may close these issues.

MVP for the Stretch tab of the Inelastic Bayes Fitting interface
2 participants