CSC/ECE 517 Spring 2023 -E2326 Refactor questionnaires controller.rb

From Expertiza_Wiki
Revision as of 00:00, 9 April 2023 by Tkini (talk | contribs) (→‎Tushar)
Jump to navigation Jump to search

Background

In Expertiza, Questionnaire is the superclass for all kinds of questionnaires and rubrics—rubrics for evaluating submissions and teammate contributions, and taking quizzes and surveys. All of these are subclasses of Questionnaire. questionnaires_controller.rb is charged with creating, displaying, and managing Questionnaires. Because it is used so widely, malfunctions could cause bugs in many parts of the system; hence it is especially important that the code be clear.

Project Purpose

In recent years, questionnaires_controller.rb has been refactored repeatedly. It is a lot clearer than it used to be. But rough edges still remain. question.rb contains a large number of constants. It is not clear what they are used for. There is a questionnaires_controller, but no questions_controller. The questionnaires_controller creates Question objects. This is not elegant, because a controller should only create objects of one type, the type of objects it controls.

Design

Tushar

 #  File/Function Change Proposed Rationale Commit Link
1 Refactored the create The cur Will be added later
2 Used We refa Will be added later
3 Renamed variable names Some Will be added later
4 Added comments to other helper methods Some functions had no comments which were needed. Will be added later

Ani

Jacob

Problems and planned changes

problems and planned changes

Important links

Github: https://github.com/Soultrekker21/expertiza

Test Plan

test1
test2