Refactor route functionality into Controllers #1410
Merged
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
…nbounded to bounded) Firstly, Controllers.Course now only defines the main functions that define the actual response functionality. All the helper methods on which these main methods depend has been moved back to and used with bounded imports. Secondly, in Controllers.Course and in Database.CourseQueries I refactored the import code to ensure that only bounded imports are used, explicitly specifying the desired identifiers.”
There was a problem hiding this comment.
@mimischly7 and @is-ahmed good work. I left a few comments to work on.
applying the professor's comments, including aliasing for imports, changing routes in all places, and returning ServerPart Response instead of IO Response in controller functions
app/Routes.hs
Outdated
| @@ -3,13 +3,41 @@ module Routes | |||
|
|
|||
| import Control.Monad (MonadPlus (mplus), msum) | |||
| import Control.Monad.IO.Class (liftIO) | |||
| import Controllers.Course as CourseControllers (retrieveCourse, index, courseInfo, depts) | |||
There was a problem hiding this comment.
Oh I guess I didn't pick up on this on your clarifying comment, but this should be CoursesController the entity name is pluralized, not "controller". Same with the graph controller below.
app/Routes.hs
Outdated
| ("image", look "JsonLocalStorageObj" >>= graphImageResponse), | ||
| ("timetable-image", lookText' "session" >>= \session -> look "courses" >>= exportTimetableImageResponse session), | ||
| ("timetable-pdf", look "courses" >>= \courses -> look "JsonLocalStorageObj" >>= exportTimetablePDFResponse courses), | ||
| ("timetable-pdf", look "courses" >>= \coursesList -> look "JsonLocalStorageObj" >>= exportTimetablePDFResponse coursesList), |
There was a problem hiding this comment.
This change should no longer be necessary now that you're using the aliased import
david-yz-liu
approved these changes
May 31, 2024
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.
Proposed Changes
(Describe your changes here. Also describe the motivation for your changes: what problem do they solve, or how do they improve the application or codebase? If this pull request fixes an open issue, use a keyword to link this pull request to the issue.)
Based on the initiative to adapt a more MVC architecture for Courseougraphy, we (with @is-ahmed) moved the functionality of graph-related and course-related routes to the (new)
Controllers.GraphandControllers.Coursemodules.Also, we changed imports in
Routes.hs,Controllers/*.hs, andDatabase.CourseQueries.hsto ensure:Finally, some route and controller-function names (in particular for plural routes) have been changed to more closely abide by
Railsnaming conventions.Screenshots of your changes (if applicable)
Type of Change
(Write an
Xor a brief description next to the type or types that best describe your changes.)Checklist
(Complete each of the following items for your pull request. Indicate that you have completed an item by changing the
[ ]into a[x]in the raw text, or by clicking on the checkbox in the rendered description on GitHub.)Before opening your pull request:
After opening your pull request:
Questions and Comments
(Include any questions or comments you have regarding your changes.)