CSC/ECE 517 Spring 2023 - E2302: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 23: | Line 23: | ||
Below is the summary of all the changes as part of this PR. | Below is the summary of all the changes as part of this PR. | ||
=== Changes to <code>spec/controllers/auth_controller_spec.rb</code> === | |||
{| class="wikitable" style="width: 100%; | |||
! # !! Change !! Rationale !! Commit Link | |||
|- | |||
|1 | |||
|We extracted the create method into multiple methods | |||
| the current create method is long and have multiple complex references and if statements. We created separate helpers to simplify complex db context | |||
|[https://github.com/tusharkini/expertiza/commit/4c2f0e04e7e3ab10443af26d2868758b5c696b55 Commit] | |||
|- | |||
|2 | |||
|Used early return in case of errors | |||
|We refactored the code such that the errors like the assignment already being present or the directory already being present were caught early in the code. It leads to cleaner code as well. | |||
|[https://github.com/tusharkini/expertiza/commit/3c00648b7228eb0daf8a9afd30f8f3abfb44c2c4 Commit] | |||
|- | |||
|3 | |||
|Renamed variable names | |||
|Some of the current variable names were ambiguous as to what they meant, (cur_questionnaire, cur_due, etc.) we renamed those names to be less ambiguous and state their function. | |||
|[https://github.com/tusharkini/expertiza/commit/4c2f0e04e7e3ab10443af26d2868758b5c696b55 Commit] | |||
|- | |||
|4 | |||
|Added comments to other helper methods | |||
|Some functions had comments missing. | |||
|[https://github.com/tusharkini/expertiza/commit/b72febb7f2370d6ccb0c99939500f6d36178bf00 Commit] | |||
|} | |||
Revision as of 00:54, 23 March 2023
E2302. Refactoring the Delayed Mailer and Scheduler
Topic Overview
Background
Prior Work
History: Previous projects
* E2253 [1] * E2144 [2] * E2273 [3]
Our Changes
Upon review of previous PRs, we found that the work was thorough, albeit a few test cases were failing, and comments and methods could be refactored better. Based on the prompts we got, we focussed on refactoring the create method of assignments controller, and assignments form, along with the refactoring of sidekiq-related files.
Below is the summary of all the changes as part of this PR.
Changes to spec/controllers/auth_controller_spec.rb
| # | Change | Rationale | Commit Link |
|---|---|---|---|
| 1 | We extracted the create method into multiple methods | the current create method is long and have multiple complex references and if statements. We created separate helpers to simplify complex db context | Commit |
| 2 | Used early return in case of errors | We refactored the code such that the errors like the assignment already being present or the directory already being present were caught early in the code. It leads to cleaner code as well. | Commit |
| 3 | Renamed variable names | Some of the current variable names were ambiguous as to what they meant, (cur_questionnaire, cur_due, etc.) we renamed those names to be less ambiguous and state their function. | Commit |
| 4 | Added comments to other helper methods | Some functions had comments missing. | Commit |