-
Notifications
You must be signed in to change notification settings - Fork 124
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
base: main
Are you sure you want to change the base?
Conversation
1460594
to
1be5945
Compare
941c3c8
to
193fe5d
Compare
193fe5d
to
95b8049
Compare
There was a problem hiding this 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(); |
There was a problem hiding this comment.
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
?
auto filename = saveDir + wsName + ".nxs"; | ||
if (filename.empty()) | ||
saveProps->setProperty("Filename", wsName + ".nxs"); |
There was a problem hiding this comment.
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() { |
There was a problem hiding this comment.
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
StretchView *m_view; | ||
std::unique_ptr<StretchModel> m_model; |
There was a problem hiding this comment.
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, |
There was a problem hiding this comment.
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
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
Functional Tests
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.