CSC/ECE 517 Fall 2019- Project E1946 Refactor Questionnaire Controller: Difference between revisions
No edit summary |
No edit summary |
||
| Line 32: | Line 32: | ||
Questionnaire Controller and Questionnaire model , Questionnaire Spec, Quiz Questionnaire was modified during this project. | Questionnaire Controller and Questionnaire model , Questionnaire Spec, Quiz Questionnaire was modified during this project. | ||
* Questionnaire Controller - This is the controller which handles all the CRUD operation performed on any kind of questionnaire - review or surveys, add weightage to all questions, selecting type of questions. This controller holds the | * Questionnaire Controller - This is the controller which handles all the CRUD operation performed on any kind of questionnaire - review or surveys, add weightage to all questions, selecting type of questions. This controller holds the major part of work done for creating questions. Creating of questionnaire was one method which was extremely complicated and not well commented about what is going on. Multiple things were done in just one method which we broke in modules doing that specific task. This controller was holding the business logic as well, which we can move to model. Variables were created separate to get value from UI. At many places string literals were being hardcoded, which were made as constants. | ||
major part of work done for creating questions. Creating of questionnaire was one method which was extremely complicated and not well commented about what is going on. Multiple things were done in just one method which we broke | |||
in modules doing that specific task. This controller was holding the business logic as well, which we can move to model. Variables were created separate to get value from UI. At many places string literals were being hardcoded, which | |||
* Questionnaire model - We have added self method in model which will create questionnaire object for us and we will get that object in controller and process it in controller. | * Questionnaire model - We have added self method in model which will create questionnaire object for us and we will get that object in controller and process it in controller. | ||
* Quiz Questionnaire Controller - Quiz questionnaire was calling multiple methods of quiz questionnaire by passing questionnaire id as parameter which we have removed. | * Quiz Questionnaire Controller - Quiz questionnaire was calling multiple methods of quiz questionnaire by passing questionnaire id as parameter which we have removed. | ||
* Questionnaire SPEC - We have changed this file in order to test the changes we have made in Questionnaire controller. | * Questionnaire SPEC - We have changed this file in order to test the changes we have made in Questionnaire controller. | ||
Revision as of 05:03, 29 October 2019
E1946. Refactoring the Questionnaire Controller
This page provides a description of the Expertiza based OSS project.
About Expertiza
Expertiza is an open source project based on Ruby on Rails framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.
About Questionnaire Controller
Questionnaire is the superclass for all kinds of questionnaires and rubrics, rubrics is used for evaluating submissions and teammate contributions, and taking quizzes and surveys. All of these are subclasses of Questionnaire. This controller is used for creating, displaying, and managing Questionnaires. Different type of questionnaire can be created in Expertiza like Review, Metareview, Teammate review, Quiz Questionnaire, Global Survey, Course Survey and many more. This Controller is widely used and malfunctions can cause many issues in different parts of the system.
Why Refactor Questionnaire Controller
In Questionnaire controller below are some of the problems which needs refactoring:
- Renaming the methods breaking Rubys naming conventions.
- Refactoring the methods doing multiple tasks and breaking them in different modules.
- Reducing the length of methods longer than 50 lines of code.
- Removing the string literal values used in controller.
- Separating the business logic from controller and putting it in method.
- Remove variables behaving same as ruby's given functionality.
- Commenting the code properly for easy understanding.
Files Modified
Questionnaire Controller and Questionnaire model , Questionnaire Spec, Quiz Questionnaire was modified during this project.
- Questionnaire Controller - This is the controller which handles all the CRUD operation performed on any kind of questionnaire - review or surveys, add weightage to all questions, selecting type of questions. This controller holds the major part of work done for creating questions. Creating of questionnaire was one method which was extremely complicated and not well commented about what is going on. Multiple things were done in just one method which we broke in modules doing that specific task. This controller was holding the business logic as well, which we can move to model. Variables were created separate to get value from UI. At many places string literals were being hardcoded, which were made as constants.
- Questionnaire model - We have added self method in model which will create questionnaire object for us and we will get that object in controller and process it in controller.
- Quiz Questionnaire Controller - Quiz questionnaire was calling multiple methods of quiz questionnaire by passing questionnaire id as parameter which we have removed.
- Questionnaire SPEC - We have changed this file in order to test the changes we have made in Questionnaire controller.