Expertiza_Wiki - User contributions [en]

File:UseCase rubric.png

2019-04-09T01:08:51Z

Ssiddha:

CSC/ECE 517 Spring 2019 - Project E1924. Regulate changing of rubrics while projects are in progress

2019-04-09T01:08:27Z

Ssiddha: /* Use case Diagram */

''' Regulate changing of rubrics while projects are in progress '''

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc). It consists of multiple features, one such feature is the ability to setup an assignment by an instructor. While setting up an assignment, the instructor would be asked to choose different kinds of rubrics. Any of these rubrics can later be edited or changed to a different rubric. A problem arises when an assignment is underway (students have already started reviewing) and a rubric is edited or changed. Some students started reviewing with the old rubric and the rest of the students who had not started a review will be presented with the updated rubric. This usually happens when an assignment is copied from a previous year and the rubrics are not updated to match the current topic. It could be at a later point that the instructor/TA realizes this and changes it. The goal of this project is two-fold: One, If a rubric is replaced, or the items/questions are changed, then all the reviews that have been done need to be redone and two, the system should then email the previously done reviews to the reviewer and delete the response object and all associated answer objects.

=='''Setting up and Building the Project'''==
Follow the Guidelines mentioned in the [https://github.com/expertiza/expertiza/blob/master/README.md read me] page of the project's Wiki Page for building the Project in a Local Environment.

=='''Project Description'''==
===Current Scenario===
Currently, when an instructor updates a questionnaire rubric of an ongoing assignment, the reviews are not reset and moreover, no notifications are sent to reviewers to update them of the changes made. Moreover, the instructor, post making changes, would have to individually inform each reviewer of the changes made and ask them to change the reviews accordingly.

===Expected Solution===
The project aims to resolve the two main issue arising from the problems mentioned above:

* If a rubric is replaced, or the items/questions are changed, then all the reviews that have been done need to be redone
* The system should then email the previously done reviews to the reviewer and delete the response object and all associated answer objects.

Further descriptions about how the project will be implemented and what files will be changed are mentioned in subsequent sections.

=='''Design Diagrams'''==
===Use case Diagram===

[[File:UseCase_rubric.png|Use Case Diagram]]

=='''Proposed Solution'''==
The solution is divided into 2 phases viz. Identification of edit and Notification.

===Identification of edit===
When a rubric is submitted after an edit, the update method is called. The current rubric is made such that the question type (Radio/Checkbox/True or False) is not editable, however, the wording of the question can be edited. The questions can be deleted and/or added. We term an edit as major edit if the change involves addition or deletion of a question and a minor edit corresponds to editing any existing questions. The params passed to the controller also includes a tag/identifier if a new question was added. We plan on using this identifier along with the number of questions to identify it the changes made were major or minor.

===E-mail Notification===
Once this solution finds that the rubric has major edits and there exists some user who has started the response (corresponding records exist), email notification module is initiated. In this phase, these records are pulled from the ActiveRecord and sent to the user through email. Once the email is sent successfully, records are deleted from the DB.

At this stage, the user has all the details already added by them and when they click on "Review", the questions now correspond to the new rubric. This lets the user to edit on the new rubric without losing data for any question. One of the motives behind sending these responses as email is that the first few questions in the review may be similar across rubrics and the user may re-use the same responses when prompted with the new rubric.

=='''Proposed Code Change'''==

=='''Test Plan'''==
The current rspec file describes various contexts for testing such as adding new questions if attributes weren't correctly entered etc. As stated in the earlier sections, the update method of the questionnaire controller would be edited to identify major changes and trigger emails and deletions of records of responses. A context corresponding to this in the spec file for questionnaire controller under the describe block for update would be added.

At this moment we are thinking of at least 2 new test cases, both these cases correspond to editing a rubric:
# If there is no new question added and the question id's match with the ones in the record - validate the existence of the record
# If there is a new question added - assert if the email was sent

CSC/ECE 517 Spring 2019 - Project E1924. Regulate changing of rubrics while projects are in progress

2019-04-09T01:08:03Z

Ssiddha:

''' Regulate changing of rubrics while projects are in progress '''

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc). It consists of multiple features, one such feature is the ability to setup an assignment by an instructor. While setting up an assignment, the instructor would be asked to choose different kinds of rubrics. Any of these rubrics can later be edited or changed to a different rubric. A problem arises when an assignment is underway (students have already started reviewing) and a rubric is edited or changed. Some students started reviewing with the old rubric and the rest of the students who had not started a review will be presented with the updated rubric. This usually happens when an assignment is copied from a previous year and the rubrics are not updated to match the current topic. It could be at a later point that the instructor/TA realizes this and changes it. The goal of this project is two-fold: One, If a rubric is replaced, or the items/questions are changed, then all the reviews that have been done need to be redone and two, the system should then email the previously done reviews to the reviewer and delete the response object and all associated answer objects.

=='''Setting up and Building the Project'''==
Follow the Guidelines mentioned in the [https://github.com/expertiza/expertiza/blob/master/README.md read me] page of the project's Wiki Page for building the Project in a Local Environment.

=='''Project Description'''==
===Current Scenario===
Currently, when an instructor updates a questionnaire rubric of an ongoing assignment, the reviews are not reset and moreover, no notifications are sent to reviewers to update them of the changes made. Moreover, the instructor, post making changes, would have to individually inform each reviewer of the changes made and ask them to change the reviews accordingly.

===Expected Solution===
The project aims to resolve the two main issue arising from the problems mentioned above:

* If a rubric is replaced, or the items/questions are changed, then all the reviews that have been done need to be redone
* The system should then email the previously done reviews to the reviewer and delete the response object and all associated answer objects.

Further descriptions about how the project will be implemented and what files will be changed are mentioned in subsequent sections.

=='''Design Diagrams'''==
===Use case Diagram===

[[File:UseCase.png|Use Case Diagram]]

=='''Proposed Solution'''==
The solution is divided into 2 phases viz. Identification of edit and Notification.

===Identification of edit===
When a rubric is submitted after an edit, the update method is called. The current rubric is made such that the question type (Radio/Checkbox/True or False) is not editable, however, the wording of the question can be edited. The questions can be deleted and/or added. We term an edit as major edit if the change involves addition or deletion of a question and a minor edit corresponds to editing any existing questions. The params passed to the controller also includes a tag/identifier if a new question was added. We plan on using this identifier along with the number of questions to identify it the changes made were major or minor.

===E-mail Notification===
Once this solution finds that the rubric has major edits and there exists some user who has started the response (corresponding records exist), email notification module is initiated. In this phase, these records are pulled from the ActiveRecord and sent to the user through email. Once the email is sent successfully, records are deleted from the DB.

At this stage, the user has all the details already added by them and when they click on "Review", the questions now correspond to the new rubric. This lets the user to edit on the new rubric without losing data for any question. One of the motives behind sending these responses as email is that the first few questions in the review may be similar across rubrics and the user may re-use the same responses when prompted with the new rubric.

=='''Proposed Code Change'''==

=='''Test Plan'''==
The current rspec file describes various contexts for testing such as adding new questions if attributes weren't correctly entered etc. As stated in the earlier sections, the update method of the questionnaire controller would be edited to identify major changes and trigger emails and deletions of records of responses. A context corresponding to this in the spec file for questionnaire controller under the describe block for update would be added.

At this moment we are thinking of at least 2 new test cases, both these cases correspond to editing a rubric:
# If there is no new question added and the question id's match with the ones in the record - validate the existence of the record
# If there is a new question added - assert if the email was sent

CSC/ECE 517 Spring 2019 - Project E1924. Regulate changing of rubrics while projects are in progress

2019-04-09T00:44:31Z

Ssiddha:

''' Regulate changing of rubrics while projects are in progress '''

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc). It consists of multiple features, one such feature is the ability to setup an assignment by an instructor. While setting up an assignment, the instructor would be asked to choose different kinds of rubrics. Any of these rubrics can later be edited or changed to a different rubric. A problem arises when an assignment is underway (students have already started reviewing) and a rubric is edited or changed. Some students started reviewing with the old rubric and the rest of the students who had not started a review will be presented with the updated rubric. This usually happens when an assignment is copied from a previous year and the rubrics are not updated to match the current topic. It could be at a later point that the instructor/TA realizes this and changes it. The goal of this project is two-fold: One, If a rubric is replaced, or the items/questions are changed, then all the reviews that have been done need to be redone and two, the system should then email the previously done reviews to the reviewer and delete the response object and all associated answer objects.

=='''Setting up and Building the Project'''==
Follow the Guidelines mentioned in the [https://github.com/expertiza/expertiza/blob/master/README.md read me] page of the project's Wiki Page for building the Project in a Local Environment.

=='''Project Description'''==
===Current Scenario===
Currently, when an instructor updates a questionnaire rubric of an ongoing assignment, the reviews are not reset and moreover, no notifications are sent to reviewers to update them of the changes made. Moreover, the instructor, post making changes, would have to individually inform each reviewer of the changes made and ask them to change the reviews accordingly.

===Expected Solution===
The project aims to resolve the two main issue arising from the problems mentioned above:

* If a rubric is replaced, or the items/questions are changed, then all the reviews that have been done need to be redone
* The system should then email the previously done reviews to the reviewer and delete the response object and all associated answer objects.

Further descriptions about how the project will be implemented and what files will be changed are mentioned in subsequent sections.

=='''Proposed Solution'''==
The solution is divided into 2 phases viz. Identification of edit and Notification.

===Identification of edit===
When a rubric is submitted after an edit, the update method is called. The current rubric is made such that the question type (Radio/Checkbox/True or False) is not editable, however, the wording of the question can be edited. The questions can be deleted and/or added. We term an edit as major edit if the change involves addition or deletion of a question and a minor edit corresponds to editing any existing questions. The params passed to the controller also includes a tag/identifier if a new question was added. We plan on using this identifier along with the number of questions to identify it the changes made were major or minor.

===E-mail Notification===
Once this solution finds that the rubric has major edits and there exists some user who has started the response (corresponding records exist), email notification module is initiated. In this phase, these records are pulled from the ActiveRecord and sent to the user through email. Once the email is sent successfully, records are deleted from the DB.

At this stage, the user has all the details already added by them and when they click on "Review", the questions now correspond to the new rubric. This lets the user to edit on the new rubric without losing data for any question. One of the motives behind sending these responses as email is that the first few questions in the review may be similar across rubrics and the user may re-use the same responses when prompted with the new rubric.

=='''Proposed Code Change'''==

=='''Test Plan'''==
The current rspec file describes various contexts for testing such as adding new questions if attributes weren't correctly entered etc. As stated in the earlier sections, the update method of the questionnaire controller would be edited to identify major changes and trigger emails and deletions of records of responses. A context corresponding to this in the spec file for questionnaire controller under the describe block for update would be added.

At this moment we are thinking of at least 2 new test cases, both these cases correspond to editing a rubric:
# If there is no new question added and the question id's match with the ones in the record - validate the existence of the record
# If there is a new question added - assert if the email was sent

CSC/ECE 517 Spring 2019 - Project E1924. Regulate changing of rubrics while projects are in progress

2019-04-09T00:43:57Z

Ssiddha:

''' Regulate changing of rubrics while projects are in progress '''

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc). It consists of multiple features, one such feature is the ability to setup an assignment by an instructor. While setting up an assignment, the instructor would be asked to choose different kinds of rubrics. Any of these rubrics can later be edited or changed to a different rubric. A problem arises when an assignment is underway (students have already started reviewing) and a rubric is edited or changed. Some students started reviewing with the old rubric and the rest of the students who had not started a review will be presented with the updated rubric. This usually happens when an assignment is copied from a previous year and the rubrics are not updated to match the current topic. It could be at a later point that the instructor/TA realizes this and changes it. The goal of this project is two-fold: One, If a rubric is replaced, or the items/questions are changed, then all the reviews that have been done need to be redone and two, the system should then email the previously done reviews to the reviewer and delete the response object and all associated answer objects.

=='''Setting up and Building the Project'''==
Follow the Guidelines mentioned in the [https://github.com/expertiza/expertiza/blob/master/README.md read me] page of the project's Wiki Page for building the Project in a Local Environment.

=='''Project Description'''==
===Current Scenario===
Currently, when an instructor updates a questionnaire rubric of an ongoing assignment, the reviews are not reset and moreover, no notifications are sent to reviewers to update them of the changes made. Moreover, the instructor, post making changes, would have to individually inform each reviewer of the changes made and ask them to change the reviews accordingly.

===Expected Solution===
The project aims to resolve the two main issue arising from the problems mentioned above:

* If a rubric is replaced, or the items/questions are changed, then all the reviews that have been done need to be redone
* The system should then email the previously done reviews to the reviewer and delete the response object and all associated answer objects.

Further descriptions about how the project will be implemented and what files will be changed are mentioned in subsequent sections.

=='''Proposed Solution'''==
The solution is divided into 2 phases viz. Identification of edit and Notification.

===Identification of edit===
When a rubric is submitted after an edit, the update method is called. The current rubric is made such that the question type (Radio/Checkbox/True or False) is not editable, however, the wording of the question can be edited. The questions can be deleted and/or added. We term an edit as major edit if the change involves addition or deletion of a question and a minor edit corresponds to editing any existing questions. The params passed to the controller also includes a tag/identifier if a new question was added. We plan on using this identifier along with the number of questions to identify it the changes made were major or minor.

===E-mail Notification===
Once this solution finds that the rubric has major edits and there exists some user who has started the response (corresponding records exist), email notification module is initiated. In this phase, these records are pulled from the ActiveRecord and sent to the user through email. Once the email is sent successfully, records are deleted from the DB.

At this stage, the user has all the details already added by them and when they click on "Review", the questions now correspond to the new rubric. This lets the user to edit on the new rubric without losing data for any question. One of the motives behind sending these responses as email is that the first few questions in the review may be similar across rubrics and the user may re-use the same responses when prompted with the new rubric.

===Proposed Code Change===

=='''Test Plan'''==
The current rspec file describes various contexts for testing such as adding new questions if attributes weren't correctly entered etc. As stated in the earlier sections, the update method of the questionnaire controller would be edited to identify major changes and trigger emails and deletions of records of responses. A context corresponding to this in the spec file for questionnaire controller under the describe block for update would be added.

At this moment we are thinking of at least 2 new test cases, both these cases correspond to editing a rubric:
# If there is no new question added and the question id's match with the ones in the record - validate the existence of the record
# If there is a new question added - assert if the email was sent

CSC/ECE 517 Spring 2019 - Project E1924. Regulate changing of rubrics while projects are in progress

2019-04-09T00:43:06Z

Ssiddha:

''' Regulate changing of rubrics while projects are in progress '''

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc). It consists of multiple features, one such feature is the ability to setup an assignment by an instructor. While setting up an assignment, the instructor would be asked to choose different kinds of rubrics. Any of these rubrics can later be edited or changed to a different rubric. A problem arises when an assignment is underway (students have already started reviewing) and a rubric is edited or changed. Some students started reviewing with the old rubric and the rest of the students who had not started a review will be presented with the updated rubric. This usually happens when an assignment is copied from a previous year and the rubrics are not updated to match the current topic. It could be at a later point that the instructor/TA realizes this and changes it. The goal of this project is two-fold: One, If a rubric is replaced, or the items/questions are changed, then all the reviews that have been done need to be redone and two, the system should then email the previously done reviews to the reviewer and delete the response object and all associated answer objects.

=='''Setting up and Building the Project'''==
Follow the Guidelines mentioned in the [https://github.com/expertiza/expertiza/blob/master/README.md read me] page of the project's Wiki Page for building the Project in a Local Environment.

=='''Project Description'''==
===Current Scenario===
Currently, when an instructor updates a questionnaire rubric of an ongoing assignment, the reviews are not reset and moreover, no notifications are sent to reviewers to update them of the changes made. Moreover, the instructor, post making changes, would have to individually inform each reviewer of the changes made and ask them to change the reviews accordingly.

===Expected Solution===
The project aims to resolve the two main issue arising from the problems mentioned above:

* If a rubric is replaced, or the items/questions are changed, then all the reviews that have been done need to be redone
* The system should then email the previously done reviews to the reviewer and delete the response object and all associated answer objects.

Further descriptions about how the project will be implemented and what files will be changed are mentioned in subsequent sections.

===Proposed Solution===
The solution is divided into 2 phases viz. Identification of edit and Notification.

When a rubric is submitted after an edit, the update method is called. The current rubric is made such that the question type (Radio/Checkbox/True or False) is not editable, however, the wording of the question can be edited. The questions can be deleted and/or added. We term an edit as major edit if the change involves addition or deletion of a question and a minor edit corresponds to editing any existing questions. The params passed to the controller also includes a tag/identifier if a new question was added. We plan on using this identifier along with the number of questions to identify it the changes made were major or minor.

===E-mail Notification===
Once this solution finds that the rubric has major edits and there exists some user who has started the response (corresponding records exist), email notification module is initiated. In this phase, these records are pulled from the ActiveRecord and sent to the user through email. Once the email is sent successfully, records are deleted from the DB.

At this stage, the user has all the details already added by them and when they click on "Review", the questions now correspond to the new rubric. This lets the user to edit on the new rubric without losing data for any question. One of the motives behind sending these responses as email is that the first few questions in the review may be similar across rubrics and the user may re-use the same responses when prompted with the new rubric.

===Proposed Code Change===

=='''Test Plan'''==
The current rspec file describes various contexts for testing such as adding new questions if attributes weren't correctly entered etc. As stated in the earlier sections, the update method of the questionnaire controller would be edited to identify major changes and trigger emails and deletions of records of responses. A context corresponding to this in the spec file for questionnaire controller under the describe block for update would be added.

At this moment we are thinking of at least 2 new test cases, both these cases correspond to editing a rubric:
# If there is no new question added and the question id's match with the ones in the record - validate the existence of the record
# If there is a new question added - assert if the email was sent

CSC/ECE 517 Spring 2019 - Project E1924. Regulate changing of rubrics while projects are in progress

2019-04-09T00:19:01Z

Ssiddha:

''' Regulate changing of rubrics while projects are in progress '''

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc). It consists of multiple features, one such feature is the ability to setup an assignment by an instructor. While setting up an assignment, the instructor would be asked to choose different kinds of rubrics. Any of these rubrics can later be edited or changed to a different rubric. A problem arises when an assignment is underway (students have already started reviewing) and a rubric is edited or changed. Some students started reviewing with the old rubric and the rest of the students who had not started a review will be presented with the updated rubric. This usually happens when an assignment is copied from a previous year and the rubrics are not updated to match the current topic. It could be at a later point that the instructor/TA realizes this and changes it. The goal of this project is two-fold: One, If a rubric is replaced, or the items/questions are changed, then all the reviews that have been done need to be redone and two, the system should then email the previously done reviews to the reviewer and delete the response object and all associated answer objects.

=='''Setting up and Building the Project'''==
Follow the Guidelines mentioned in the [https://github.com/expertiza/expertiza/blob/master/README.md read me] page of the project's Wiki Page for building the Project in a Local Environment.

=='''Project Description'''==
===Current Scenario===
Currently, when an instructor updates a questionnaire rubric of an ongoing assignment, the reviews are not reset and moreover, no notifications are sent to reviewers to update them of the changes made. Moreover, the instructor, post making changes, would have to individually inform each reviewer of the changes made and ask them to change the reviews accordingly.

===Expected Solution===
The project aims to resolve the two main issue arising from the problems mentioned above:

* If a rubric is replaced, or the items/questions are changed, then all the reviews that have been done need to be redone
* The system should then email the previously done reviews to the reviewer and delete the response object and all associated answer objects.

Further descriptions about how the project will be implemented and what files will be changed are mentioned in subsequent sections.

=='''Proposed Solution'''==
When a rubric is submitted after an edit, the update method is called. The current rubric is made such that the question type is not editable, however, the wording of the question can be edited. The questions can be deleted or/and added. The params passed to the controller also includes a tag/identifier if a new question was added. We plan on using this identifier along with the number of questions to identify it the changes made were major or minor.

If the number of questions returned from view and no new question tag/identifier then the change was minor, else the change was a major one.

===E-mail Notification===
Once this solution finds that the rubric has major edits and there exists some user who has started the response (corresponding records exist), email notification module is initiated. In this phase, these records are pulled from the ActiveRecord and sent to the user through email. Once the email is sent successfully, records are deleted from the DB.

At this stage, the user has all the details already added by them and when they click on "Review", the questions now correspond to the new rubric. This lets the user to edit on the new rubric without losing data for any question. One of the motives behind sending these responses as email is that the first few questions in the review may be similar across rubrics and the user may re-use the same responses when prompted with the new rubric.

=='''Test Plan'''==
The current rspec file describes various contexts for testing such as adding new questions if attributes weren't correctly entered etc. As stated in the earlier sections, the update method of the questionnaire controller would be edited to identify major changes and trigger emails and deletions of records of responses. A context corresponding to this in the spec file for questionnaire controller under the describe block for update would be added.

CSC/ECE 517 Spring 2019 - Project E1924. Regulate changing of rubrics while projects are in progress

2019-04-07T01:59:34Z

Ssiddha: Created page with "Test"

Test

CSC/ECE 517 Spring 2019

2019-03-28T17:27:30Z

Ssiddha:

*[[CSC/ECE 517 Spring 2019 - Project E1905. Refactor questionnaires_controller.rb]]
*[[CSC/ECE 517 Spring 2019 - Project E1916. Fix Code Climate issues in controllers with names beginning with A through N]]
*[[CSC/ECE 517 Spring 2019 - Project E1906. Refactor stage deadlines in Assignment.rb]]
*[[CSC/ECE 517 Spring 2019 - Project M1901 Implement missing WebAudio automation support]]
*[[CSC/ECE 517 Spring 2019 - Project E1917. Fix Code Climate issues in controllers with names beginning with P through Z]]
*[[CSC/ECE 517 Spring 2019 - Project E1921. Write tests for popup controller.rb]]
*[[CSC/ECE 517 Spring 2019 - M1902 Refactor bluetooth support for better maintainability]]
*[[CSC/ECE 517 Spring 2019 - E1922. Write tests for assessment360 controller.rb]]
*[[CSC/ECE 517 Spring 2019 - Project E1907 Refactor response controller]]
*[[CSC/ECE_517_Spring_2019_-_Project_E1903._Create_quiz_questionnaires_controller.rb]]

CSC/ECE 517 Spring 2019 - Project E1903. Create quiz questionnaires controller.rb

2019-03-26T00:55:46Z

Ssiddha: /* Changes made to current Implementation */

== Problem Statement ==

1. The questionnaires_controller.rb has multiple methods to handle quizzes. Some of these methods cater only to quizzes. The controller has to be refactored into 2 controllers by moving the functions related to quizzes and the dependencies into a new controller called quiz_questionnaire_controller.rb.

2. Some methods in the questionnaires_controller.rb are long or have hardcoded parameters. These methods have to be refactored into shorter functions rid of hardcoded parameters.

==Changes made to current Implementation==

1. Creation of new controller 
to be filled

2. Creation of Rspec file for new controller 
to be filled

3. Refactoring current controller 
'''Problem''': Due to multiple refactoring over the years, there are few redundant methods in questionnaire_controller.rb. Additionally, a few of the methods like update_quiz, create contain the redundant piece of code and multiple switch statements.

''Refactoring of create_questionnaire method'': 
The create_questionnaire method from questionnaire_controller.rb is used to create a questionnaire based on the type of questionnaire. The implementation corresponding to the quiz is irrelevant in the context of questionnaire_controller.rb. Newly created quiz_questionnaire_controller.rb undertakes the task of creating a questionnaire of type Quiz and the original method handles the creation of all other types of questionnaires. The control was delegated based on the type of questionnaire and the corresponding method is called. 
Refactored create_questionnaire method 
[[File:create_questionnaire.png]] 
Refactored create_quiz_questionnaire method 
[[File:create_quiz_questionnaire.png]]

''Refactoring of create method'': 
The create method is used to create a questionnaire in the questionnaire_controller.rb. Based on the type of questionnaire, the name in the view is changed. Assignment of display type is done using a switch case that takes up 11 lines of code and each case adds "%" to the camel cased value.
Solution: The implementation was changed to check if the display type matches with the available type and when matched, uses Regex, split and join methods to evaluate the same in a single line.

[[File:Refactor Create Method.png]]

''Refactoring of update_quiz method'': 
The update_quiz method is used to update the quiz when the user edits the existing quiz. Iterating over the set of questions, the attributes are updated based on the type of question (viz. Multiple Choice, Radio, True/False). The implementation for two of these types can be changed and can be used as private methods.
[[File:Private_methods.png]]

''Refactoring of save_choices method'': 
The save_choices method contains a lot of redundant hard coded data that is not accessed/used in the application. These hardcoded variables were removed and the relevant code is refactored to work seamlessly.

4. Creation of new route for quiz_questionnaire_controller and updated the affected links in views 
Created a new route quiz_questionnaire for quiz_questionnaire_controller in "routes.rb" and moved the custom created "get/post" routes for quizzes from questionnaires route to it.
<pre>
resources :quiz_questionnaire, only: %i[new create edit update] do
collection do
get :new_quiz
post :create_quiz_questionnaire
get :edit_quiz
post :update_quiz
end
end
</pre>
Then changed the controller name and route in all the following views which are accessing quiz_questionnaire_controller while keeping the application flow intact -

/app/views/questionnaire/view.html.erb 
<pre>
<% if @questionnaire.type == "QuizQuestionnaire" %>
<%= link_to 'Edit', :controller => :quiz_questionnaire, :action => :edit_quiz, :id =>
@questionnaire.id, :pid => @participant.id %>|
</pre>

/app/views/questionnaire/new_quiz.erb 
<pre>
<%= form_tag :controller => 'quiz_questionnaire', :action => 'create_quiz_questionnaire',
:pid => @participant_id, :aid => @assignment_id do %>
<% $disp_flag = 1 %>
<%= render :partial => 'quiz_questionnaire' %>
<% $disp_flag = 0 %>

<%= render :partial => 'new_question_template' %>

 
<%= submit_tag "Create Quiz", :name=>"save" %>
<% end %>
</pre>

/app/views/questionnaire/edit.html.erb 
<pre>
<%= form_tag({:controller=>'quiz_questionnaire', :action=>'update_quiz', :id=>@questionnaire.id, :pid => params[:pid]}, :multipart => true) do %>
</pre>
/app/views/submitted_content/_main.html.erb 
<pre>
<% if !t_id.nil? && questionnaire = QuizQuestionnaire.where(["instructor_id = ?", t_id]).first %>
<%= link_to 'View quiz', :controller => :quiz_questionnaire, :action => :view_quiz, :id => questionnaire.id, :pid => participant.id %>
 
<% if !questionnaire.taken_by_anyone?%>
<%= link_to 'Edit quiz', :controller => :quiz_questionnaire, :action => :edit_quiz, :id => questionnaire.id, :pid => participant.id %>
<% end %>
 

<% else %>
 
<%= link_to 'Create a quiz', :controller => :quiz_questionnaire, :action => :new_quiz, :model => "QuizQuestionnaire", :private => 0, :aid => @assignment.id, :pid => participant.id %>
 
<% end %>
</pre>

==Files affected==

The following files were created or refactored
1. /app/controllers/questionnaires_controller.rb 
2. /app/controllers/quiz_questionnaire_controller.rb 
3. /app/views/questionnaire/view.html.erb 
4. /app/views/questionnaire/new_quiz.erb 
5. /app/views/questionnaire/edit.html.erb 
6. /app/views/submitted_content/_main.html.erb 
7. /config/routes.rb 
8. /spec/controllers/questionnaires_controller_spec.rb 
9. /spec/controllers/quiz_questionnaire_controller_spec.rb

==Team members==
1. Abhishek Arya (aarya@ncsu.edu) 
2. Nitin Nataraj Kuncham (nkuncha@ncsu.edu) 
3. Suraj Siddharudh (ssiddha@ncsu.edu) 

==References==
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://www.rubyguides.com/2018/07/rspec-tutorial/ rpec tutorial]
#[https://www.stackoverflow.com/ Stackoverflow]

File:Create quiz questionnaire.png

2019-03-26T00:55:21Z

Ssiddha:

File:Create questionnaire.png

2019-03-26T00:55:00Z

Ssiddha:

CSC/ECE 517 Spring 2019 - Project E1903. Create quiz questionnaires controller.rb

2019-03-26T00:54:49Z

Ssiddha: /* Changes made to current Implementation */

== Problem Statement ==

1. The questionnaires_controller.rb has multiple methods to handle quizzes. Some of these methods cater only to quizzes. The controller has to be refactored into 2 controllers by moving the functions related to quizzes and the dependencies into a new controller called quiz_questionnaire_controller.rb.

2. Some methods in the questionnaires_controller.rb are long or have hardcoded parameters. These methods have to be refactored into shorter functions rid of hardcoded parameters.

==Changes made to current Implementation==

1. Creation of new controller 
to be filled

2. Creation of Rspec file for new controller 
to be filled

3. Refactoring current controller 
'''Problem''': Due to multiple refactoring over the years, there are few redundant methods in questionnaire_controller.rb. Additionally, a few of the methods like update_quiz, create contain the redundant piece of code and multiple switch statements.

''Refactoring of create_questionnaire method'': 
The create_questionnaire method from questionnaire_controller.rb is used to create a questionnaire based on the type of questionnaire. The implementation corresponding to the quiz is irrelevant in the context of questionnaire_controller.rb. Newly created quiz_questionnaire_controller.rb undertakes the task of creating a questionnaire of type Quiz and the original method handles the creation of all other types of questionnaires. The control was delegated based on the type of questionnaire and the corresponding method is called. 
Refactored create_questionnaire method 
[[File:create_questionnaire.png]]
Refactored create_quiz_questionnaire method 
[[File:create_quiz_questionnaire.png]]

''Refactoring of create method'': 
The create method is used to create a questionnaire in the questionnaire_controller.rb. Based on the type of questionnaire, the name in the view is changed. Assignment of display type is done using a switch case that takes up 11 lines of code and each case adds "%" to the camel cased value.
Solution: The implementation was changed to check if the display type matches with the available type and when matched, uses Regex, split and join methods to evaluate the same in a single line.

[[File:Refactor Create Method.png]]

''Refactoring of update_quiz method'': 
The update_quiz method is used to update the quiz when the user edits the existing quiz. Iterating over the set of questions, the attributes are updated based on the type of question (viz. Multiple Choice, Radio, True/False). The implementation for two of these types can be changed and can be used as private methods.
[[File:Private_methods.png]]

''Refactoring of save_choices method'': 
The save_choices method contains a lot of redundant hard coded data that is not accessed/used in the application. These hardcoded variables were removed and the relevant code is refactored to work seamlessly.

4. Creation of new route for quiz_questionnaire_controller and updated the affected links in views 
Created a new route quiz_questionnaire for quiz_questionnaire_controller in "routes.rb" and moved the custom created "get/post" routes for quizzes from questionnaires route to it.
<pre>
resources :quiz_questionnaire, only: %i[new create edit update] do
collection do
get :new_quiz
post :create_quiz_questionnaire
get :edit_quiz
post :update_quiz
end
end
</pre>
Then changed the controller name and route in all the following views which are accessing quiz_questionnaire_controller while keeping the application flow intact -

/app/views/questionnaire/view.html.erb 
<pre>
<% if @questionnaire.type == "QuizQuestionnaire" %>
<%= link_to 'Edit', :controller => :quiz_questionnaire, :action => :edit_quiz, :id =>
@questionnaire.id, :pid => @participant.id %>|
</pre>

/app/views/questionnaire/new_quiz.erb 
<pre>
<%= form_tag :controller => 'quiz_questionnaire', :action => 'create_quiz_questionnaire',
:pid => @participant_id, :aid => @assignment_id do %>
<% $disp_flag = 1 %>
<%= render :partial => 'quiz_questionnaire' %>
<% $disp_flag = 0 %>

<%= render :partial => 'new_question_template' %>

 
<%= submit_tag "Create Quiz", :name=>"save" %>
<% end %>
</pre>

/app/views/questionnaire/edit.html.erb 
<pre>
<%= form_tag({:controller=>'quiz_questionnaire', :action=>'update_quiz', :id=>@questionnaire.id, :pid => params[:pid]}, :multipart => true) do %>
</pre>
/app/views/submitted_content/_main.html.erb 
<pre>
<% if !t_id.nil? && questionnaire = QuizQuestionnaire.where(["instructor_id = ?", t_id]).first %>
<%= link_to 'View quiz', :controller => :quiz_questionnaire, :action => :view_quiz, :id => questionnaire.id, :pid => participant.id %>
 
<% if !questionnaire.taken_by_anyone?%>
<%= link_to 'Edit quiz', :controller => :quiz_questionnaire, :action => :edit_quiz, :id => questionnaire.id, :pid => participant.id %>
<% end %>
 

<% else %>
 
<%= link_to 'Create a quiz', :controller => :quiz_questionnaire, :action => :new_quiz, :model => "QuizQuestionnaire", :private => 0, :aid => @assignment.id, :pid => participant.id %>
 
<% end %>
</pre>

==Files affected==

The following files were created or refactored
1. /app/controllers/questionnaires_controller.rb 
2. /app/controllers/quiz_questionnaire_controller.rb 
3. /app/views/questionnaire/view.html.erb 
4. /app/views/questionnaire/new_quiz.erb 
5. /app/views/questionnaire/edit.html.erb 
6. /app/views/submitted_content/_main.html.erb 
7. /config/routes.rb 
8. /spec/controllers/questionnaires_controller_spec.rb 
9. /spec/controllers/quiz_questionnaire_controller_spec.rb

==Team members==
1. Abhishek Arya (aarya@ncsu.edu) 
2. Nitin Nataraj Kuncham (nkuncha@ncsu.edu) 
3. Suraj Siddharudh (ssiddha@ncsu.edu) 

==References==
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://www.rubyguides.com/2018/07/rspec-tutorial/ rpec tutorial]
#[https://www.stackoverflow.com/ Stackoverflow]

File:Private methods.png

2019-03-26T00:40:25Z

Ssiddha:

CSC/ECE 517 Spring 2019 - Project E1903. Create quiz questionnaires controller.rb

2019-03-26T00:39:59Z

Ssiddha: /* Changes made to current Implementation */

== Problem Statement ==

1. The questionnaires_controller.rb has multiple methods to handle quizzes. Some of these methods cater only to quizzes. The controller has to be refactored into 2 controllers by moving the functions related to quizzes and the dependencies into a new controller called quiz_questionnaire_controller.rb.

2. Some methods in the questionnaires_controller.rb are long or have hardcoded parameters. These methods have to be refactored into shorter functions rid of hardcoded parameters.

==Changes made to current Implementation==

1. Creation of new controller 
to be filled

2. Creation of Rspec file for new controller 
to be filled

3. Refactoring current controller 
'''Problem''': Due to multiple refactoring over the years, there are few redundant methods in questionnaire_controller.rb. Additionally, a few of the methods like update_quiz, create contain the redundant piece of code and multiple switch statements.

''Refactoring of create method'':
The create method is used to create a questionnaire in the questionnaire_controller.rb. Based on the type of questionnaire, the name in the view is changed. Assignment of display type is done using a switch case that takes up 11 lines of code and each case adds "%" to the camel cased value.
Solution: The implementation was changed to check if the display type matches with the available type and when matched, uses Regex, split and join methods to evaluate the same in a single line.

[[File:Refactor Create Method.png]]

''Refactoring of update_quiz method'':
The update_quiz method is used to update the quiz when the user edits the existing quiz. Iterating over the set of questions, the attributes are updated based on the type of question (viz. Multiple Choice, Radio, True/False). The implementation for two of these types can be changed and can be used as private methods.
[[File:Private_methods.png]]

''Refactoring of save_choices method'':
The save_choices method contains a lot of redundant hard coded data that is not accessed/used in the application. These hardcoded variables were removed and relevant code is refactored to work seemlessly

4. Creation of new route for quiz_questionnaire_controller and updated the affected links in views 
Created a new route quiz_questionnaire for quiz_questionnaire_controller in "routes.rb" and moved the custom created "get/post" routes for quizzes from questionnaires route to it.
<pre>
resources :quiz_questionnaire, only: %i[new create edit update] do
collection do
get :new_quiz
post :create_quiz_questionnaire
get :edit_quiz
post :update_quiz
end
end
</pre>
Then changed the controller name and route in all the following views which are accessing quiz_questionnaire_controller while keeping the application flow intact -

/app/views/questionnaire/view.html.erb 
<pre>
<% if @questionnaire.type == "QuizQuestionnaire" %>
<%= link_to 'Edit', :controller => :quiz_questionnaire, :action => :edit_quiz, :id =>
@questionnaire.id, :pid => @participant.id %>|
</pre>

/app/views/questionnaire/new_quiz.erb 
<pre>
<%= form_tag :controller => 'quiz_questionnaire', :action => 'create_quiz_questionnaire',
:pid => @participant_id, :aid => @assignment_id do %>
<% $disp_flag = 1 %>
<%= render :partial => 'quiz_questionnaire' %>
<% $disp_flag = 0 %>

<%= render :partial => 'new_question_template' %>

 
<%= submit_tag "Create Quiz", :name=>"save" %>
<% end %>
</pre>

/app/views/questionnaire/edit.html.erb 
<pre>
<%= form_tag({:controller=>'quiz_questionnaire', :action=>'update_quiz', :id=>@questionnaire.id, :pid => params[:pid]}, :multipart => true) do %>
</pre>
/app/views/submitted_content/_main.html.erb 
<pre>
<% if !t_id.nil? && questionnaire = QuizQuestionnaire.where(["instructor_id = ?", t_id]).first %>
<%= link_to 'View quiz', :controller => :quiz_questionnaire, :action => :view_quiz, :id => questionnaire.id, :pid => participant.id %>
 
<% if !questionnaire.taken_by_anyone?%>
<%= link_to 'Edit quiz', :controller => :quiz_questionnaire, :action => :edit_quiz, :id => questionnaire.id, :pid => participant.id %>
<% end %>
 

<% else %>
 
<%= link_to 'Create a quiz', :controller => :quiz_questionnaire, :action => :new_quiz, :model => "QuizQuestionnaire", :private => 0, :aid => @assignment.id, :pid => participant.id %>
 
<% end %>
</pre>

==Files affected==

The following files were created or refactored
1. /app/controllers/questionnaires_controller.rb 
2. /app/controllers/quiz_questionnaire_controller.rb 
3. /app/views/questionnaire/view.html.erb 
4. /app/views/questionnaire/new_quiz.erb 
5. /app/views/questionnaire/edit.html.erb 
6. /app/views/submitted_content/_main.html.erb 
7. /config/routes.rb 
8. /spec/controllers/questionnaires_controller_spec.rb 
9. /spec/controllers/quiz_questionnaire_controller_spec.rb

==Team members==
1. Abhishek Arya (aarya@ncsu.edu) 
2. Nitin Nataraj Kuncham (nkuncha@ncsu.edu) 
3. Suraj Siddharudh (ssiddha@ncsu.edu) 

==References==
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://www.rubyguides.com/2018/07/rspec-tutorial/ rpec tutorial]
#[https://www.stackoverflow.com/ Stackoverflow]

File:Refactor Create Method.png

2019-03-26T00:28:02Z

Ssiddha: uploaded a new version of "File:Refactor Create Method.png"

File:Refactor Create Method.png

2019-03-26T00:27:28Z

Ssiddha:

CSC/ECE 517 Spring 2019 - Project E1903. Create quiz questionnaires controller.rb

2019-03-26T00:26:56Z

Ssiddha: /* Changes made to current Implementation */

== Problem Statement ==

1. The questionnaires_controller.rb has multiple methods to handle quizzes. Some of these methods cater only to quizzes. The controller has to be refactored into 2 controllers by moving the functions related to quizzes and the dependencies into a new controller called quiz_questionnaire_controller.rb.

2. Some methods in the questionnaires_controller.rb are long or have hardcoded parameters. These methods have to be refactored into shorter functions rid of hardcoded parameters.

==Changes made to current Implementation==

1. Creation of new controller 
to be filled

2. Creation of Rspec file for new controller 
to be filled

3. Refactoring current controller 
'''Problem''': Due to multiple refactoring over the years, there are few redundant methods in questionnaire_controller.rb. Additionally, a few of the methods like update_quiz, create contain the redundant piece of code and multiple switch statements.

''Refactoring of create method'':
The create method is used to create a questionnaire in the questionnaire_controller.rb. Based on the type of questionnaire, the name in the view is changed. Assignment of display type is done using a switch case that takes up 11 lines of code and each case adds "%" to the camel cased value.
Solution: The implementation was changed to check if the display type matches with the available type and when matched, uses Regex, split and join methods to evaluate the same in a single line.

[[File:Refactor Create Method.jpg]]

4. Creation of new route for quiz_questionnaire_controller and updated the affected links in views 
Created a new route quiz_questionnaire for quiz_questionnaire_controller in "routes.rb" and moved the custom created "get/post" routes for quizzes from questionnaires route to it.
<pre>
resources :quiz_questionnaire, only: %i[new create edit update] do
collection do
get :new_quiz
post :create_quiz_questionnaire
get :edit_quiz
post :update_quiz
end
end
</pre>
Then changed the controller name and route in all the following views which are accessing quiz_questionnaire_controller while keeping the application flow intact -

/app/views/questionnaire/view.html.erb 
<pre>
<% if @questionnaire.type == "QuizQuestionnaire" %>
<%= link_to 'Edit', :controller => :quiz_questionnaire, :action => :edit_quiz, :id =>
@questionnaire.id, :pid => @participant.id %>|
</pre>

/app/views/questionnaire/new_quiz.erb 
<pre>
<%= form_tag :controller => 'quiz_questionnaire', :action => 'create_quiz_questionnaire',
:pid => @participant_id, :aid => @assignment_id do %>
<% $disp_flag = 1 %>
<%= render :partial => 'quiz_questionnaire' %>
<% $disp_flag = 0 %>

<%= render :partial => 'new_question_template' %>

 
<%= submit_tag "Create Quiz", :name=>"save" %>
<% end %>
</pre>

/app/views/questionnaire/edit.html.erb 
<pre>
<%= form_tag({:controller=>'quiz_questionnaire', :action=>'update_quiz', :id=>@questionnaire.id, :pid => params[:pid]}, :multipart => true) do %>
</pre>
/app/views/submitted_content/_main.html.erb 
<pre>
<% if !t_id.nil? && questionnaire = QuizQuestionnaire.where(["instructor_id = ?", t_id]).first %>
<%= link_to 'View quiz', :controller => :quiz_questionnaire, :action => :view_quiz, :id => questionnaire.id, :pid => participant.id %>
 
<% if !questionnaire.taken_by_anyone?%>
<%= link_to 'Edit quiz', :controller => :quiz_questionnaire, :action => :edit_quiz, :id => questionnaire.id, :pid => participant.id %>
<% end %>
 

<% else %>
 
<%= link_to 'Create a quiz', :controller => :quiz_questionnaire, :action => :new_quiz, :model => "QuizQuestionnaire", :private => 0, :aid => @assignment.id, :pid => participant.id %>
 
<% end %>
</pre>

==Files affected==

The following files were created or refactored
1. /app/controllers/questionnaires_controller.rb 
2. /app/controllers/quiz_questionnaire_controller.rb 
3. /app/views/questionnaire/view.html.erb 
4. /app/views/questionnaire/new_quiz.erb 
5. /app/views/questionnaire/edit.html.erb 
6. /app/views/submitted_content/_main.html.erb 
7. /config/routes.rb 
8. /spec/controllers/questionnaires_controller_spec.rb 
9. /spec/controllers/quiz_questionnaire_controller_spec.rb

==Team members==
1. Abhishek Arya (aarya@ncsu.edu) 
2. Nitin Nataraj Kuncham (nkuncha@ncsu.edu) 
3. Suraj Siddharudh (ssiddha@ncsu.edu) 

==References==
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://www.rubyguides.com/2018/07/rspec-tutorial/ rpec tutorial]
#[https://www.stackoverflow.com/ Stackoverflow]

CSC/ECE 517 Spring 2019 - Project E1903. Create quiz questionnaires controller.rb

2019-03-25T17:47:07Z

Ssiddha:

E1903. Create Quiz Questionnaire Controller Spring 2018, CSC/ECE 517.

== Problem Statement ==

CSC/ECE 517 Spring 2019 - Project E1903. Create quiz questionnaires controller.rb

2019-03-25T17:39:22Z

Ssiddha:

Test_E1903 Quiz Controller

CSC/ECE 517 Spring 2019 - Project E1903. Create quiz questionnaires controller.rb

2019-03-25T17:34:10Z

Ssiddha: Created page with "Test_E1903 Quiz COntroller"

Test_E1903 Quiz COntroller

E1836 Refactor Questionnaires Controller

2019-03-24T22:38:11Z

Ssiddha: Created page with "Refactor Questionnaire Controller"

Refactor Questionnaire Controller