Refactor emails handling #26
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I've got a few points I wasn't sure about with this one:
|
johnny-m-young
force-pushed
the
refactor-emails-handling
branch
from
327d388 to
ccc7184
Compare
added 2 commits
September 13, 2023 13:22
I believe these changes will make it easier to extend the `annual_leave_request#update_status` method to accomodate other actions, such as editing and withdrawing annual leave requests. The present solution is very rigid, requiring new EmailsHelper methods to be written for each new update action. The new solution simply needs a new StatusUpdate class to be added for the new action, and for that action to be added to the case options in the private `status_update` method in AnnualLeaveRequestController. This brings the code much closer to being open for extension.
Updates the AnnualLeaveRequestController tests to check emails are sent to the correct person with the correct template used.
johnny-m-young
force-pushed
the
refactor-emails-handling
branch
from
ccc7184 to
576f415
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
This refactors the way emails are handled in the application. At present the application uses an EmailsHelper with various methods for sending emails depending on the type of email being sent. This has led to have lots of case statements throughout the code to determine what method should be called and with which parameters.
In this PR I have eliminated the need for the EmailsHelper. Instead I have created a factory in the
AnnualLeaveRequestsControllerwhich returns an instance of a StatusUpdate class, the type of which depends on the new status, which contains the email hash for the update. The controller then directly interacts with the Notify client to send an email using the#send_emailmethod with the email hash.Why
This makes the code more open to extension, which will come in useful when implementing the Edit and Withdraw actions.