Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-12-08T04:14:53Z

Amishra6: /* References */

==E1854. Improve self-review, Link peer review & self-review to derive grades==

This page provides a description of the Expertiza based Semester project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===

Expertiza has the ability to require self-reviews on projects, self review is basically asking each team member in the group to evaluate their project on the same criteria as peer review, these self-review scores do not have much functionality currently. This project seeks to improve upon the self-review system, and extend its functionality. The main points of this project are as follows:
*Create a method to calculate a derived score(composite score) between self and peer-reviews. The closer the self-review is to the peer-review, the greater the score. Display this score on the "View Scores" page.
*Make sure that the peer-reviews should not be visible before self-review completion. Display the correct review scores accordingly.
*Display the self-review scores in the "View Scores" and heat map of peer-reviews, denoting that they are a different type of review.

===Application Flow===

[[File:E1799_design_1.jpg]]

The instructor has to login and create an assignment by checking allow self review option. The instructor has to add the topic and assign students to the topic. Now, the student has to login and submit the assignment. The self review link is visible in the page. The student should give the self review. After giving the self review, the student should be able to see the peer review, self review and the composite score.\

===Use case Diagram===
[[File:E1799_design_2.jpg]]

Actors:

Instructor: This actor is responsible for creating assignments and adding students to the assignment.
Student: This actor is responsible for submitting, self-reviewing and viewing the scores.

All the other use cases are implemented except “View Scores with self-review column and composite score”

'''Use Case: View score with self-review column and composite score'''

Preconditions:

1.The Instructor creates Assignments and checks the Allow Self Review check box in the Assignment
2.The Student should submit the assignment and self-review.
3.The other students should submit the reviews of the work submitted.

Student Sequence:

The student should login.
The student should browse and upload the assignment.
The student should submit the assignment.
The student should submit the self-review.
The student should choose your scores to view the score.
The student should be able to see the peer-review score with the self-review scores and composite score.

Post Conditions:

The self-review and composite score will be visible on the page.

===Method to calculate Composite Score===
The composite score is calculated using both self-review score and peer-review score (both are graded over 5 points for each criteria).
The composite score is calculated as follows:

composite score = [10 - abs(self review score - peer review score)] * peer review score / 10

By using this formula for calculating composite score we are discouraging students from either exaggerating or underrating their performance. The composite score model assigns more weight to the peer review score since the peer review score being used is the average of all peer review scores assigned and hence tends to be more appropriate than a single self review.

Also this composite score formula gives the score on a scale which is identical to the scale of the self and peer review score. Thus this formula is not dependent on the scale of the self-review and peer-review score as it will also return the composite score on the same scale.

For example: If someone gets an average peer review score of 3.5/5 and he gives 3.5/5 (self review score) while reviewing his project, then he will get a composite score of 3.5/5. And instead if the student reviews his project for 2/5 then the student will get a composite score of 2.975/5.

===Implementation===

As stated above the ability to do self reviews has already been implemented. This can be seen from the image shown below. The instructor has this ability to enable self reviews
.

[[File:Oodd abhisu.PNG]]

In our project, we were successful in displaying both the self-review score and composite review score on the view scores page. Shown below is an example of the output in the student profile. As we can see the self-review icon has a blue background to indicate that it is different from other peer reviews.

[[File:student view.PNG]]

The alternate view was also modified to accommodate a pictorial representation of the self review scores. The modified alternate view scores page is shown below.

[[File:alternate view.PNG]]

The same was achieved in the instructor profile too. In the current implementation of expertiza when self-review was not assigned, the instructor would view the scores of the first student in each team( it wouldn't matter much because without self-review all students in a team would have the same scores). But this would be a problem when self-review was enabled so we decided to display all the self-review scores of all students in the team for instructor view. As it can be seen below self-reviews of all students in the team (distinguished by their usernames) are indicated by blue background to differentiate them from peer review scores.

[[File:Instructor view.PNG]]

===Test Plan===
Test cases are as follows:
* Peer-reviews cannot be viewed before a self-review is completed.
This ensures that the student is not able to see his peer-review score before writing his self-review as the composite score takes into account the difference between the student peer-review and self-review score.
* Self-review scores are displayed with peer-review scores.
This enables the student and instructor to view all his scores in one place.
* The composite score must be properly calculated.
The composite score must be calculated so as to give students more points if their self-review score is closer to the peer review score.
* Composite score must be visible in both view scores page and Alternate view.
The scores must be displayed in both the views.

===Files Changed===
*app/controllers/grades_controller.rb
*app/models/response_map.rb
*app/models/vm_question_response.rb
*app/models/vm_question_response_row.rb
*app/views/grades/view_team.html.erb

===References===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/expertiza/expertiza/pull/1326 Pull Request]
#[https://www.youtube.com/watch?v=TBStYgnWiUI&feature=youtu.be Screencast video]

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-12-08T04:14:14Z

Amishra6: /* References */

==E1854. Improve self-review, Link peer review & self-review to derive grades==

This page provides a description of the Expertiza based Semester project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===

Expertiza has the ability to require self-reviews on projects, self review is basically asking each team member in the group to evaluate their project on the same criteria as peer review, these self-review scores do not have much functionality currently. This project seeks to improve upon the self-review system, and extend its functionality. The main points of this project are as follows:
*Create a method to calculate a derived score(composite score) between self and peer-reviews. The closer the self-review is to the peer-review, the greater the score. Display this score on the "View Scores" page.
*Make sure that the peer-reviews should not be visible before self-review completion. Display the correct review scores accordingly.
*Display the self-review scores in the "View Scores" and heat map of peer-reviews, denoting that they are a different type of review.

===Application Flow===

[[File:E1799_design_1.jpg]]

The instructor has to login and create an assignment by checking allow self review option. The instructor has to add the topic and assign students to the topic. Now, the student has to login and submit the assignment. The self review link is visible in the page. The student should give the self review. After giving the self review, the student should be able to see the peer review, self review and the composite score.\

===Use case Diagram===
[[File:E1799_design_2.jpg]]

Actors:

Instructor: This actor is responsible for creating assignments and adding students to the assignment.
Student: This actor is responsible for submitting, self-reviewing and viewing the scores.

All the other use cases are implemented except “View Scores with self-review column and composite score”

'''Use Case: View score with self-review column and composite score'''

Preconditions:

1.The Instructor creates Assignments and checks the Allow Self Review check box in the Assignment
2.The Student should submit the assignment and self-review.
3.The other students should submit the reviews of the work submitted.

Student Sequence:

The student should login.
The student should browse and upload the assignment.
The student should submit the assignment.
The student should submit the self-review.
The student should choose your scores to view the score.
The student should be able to see the peer-review score with the self-review scores and composite score.

Post Conditions:

The self-review and composite score will be visible on the page.

===Method to calculate Composite Score===
The composite score is calculated using both self-review score and peer-review score (both are graded over 5 points for each criteria).
The composite score is calculated as follows:

composite score = [10 - abs(self review score - peer review score)] * peer review score / 10

By using this formula for calculating composite score we are discouraging students from either exaggerating or underrating their performance. The composite score model assigns more weight to the peer review score since the peer review score being used is the average of all peer review scores assigned and hence tends to be more appropriate than a single self review.

Also this composite score formula gives the score on a scale which is identical to the scale of the self and peer review score. Thus this formula is not dependent on the scale of the self-review and peer-review score as it will also return the composite score on the same scale.

For example: If someone gets an average peer review score of 3.5/5 and he gives 3.5/5 (self review score) while reviewing his project, then he will get a composite score of 3.5/5. And instead if the student reviews his project for 2/5 then the student will get a composite score of 2.975/5.

===Implementation===

As stated above the ability to do self reviews has already been implemented. This can be seen from the image shown below. The instructor has this ability to enable self reviews
.

[[File:Oodd abhisu.PNG]]

In our project, we were successful in displaying both the self-review score and composite review score on the view scores page. Shown below is an example of the output in the student profile. As we can see the self-review icon has a blue background to indicate that it is different from other peer reviews.

[[File:student view.PNG]]

The alternate view was also modified to accommodate a pictorial representation of the self review scores. The modified alternate view scores page is shown below.

[[File:alternate view.PNG]]

The same was achieved in the instructor profile too. In the current implementation of expertiza when self-review was not assigned, the instructor would view the scores of the first student in each team( it wouldn't matter much because without self-review all students in a team would have the same scores). But this would be a problem when self-review was enabled so we decided to display all the self-review scores of all students in the team for instructor view. As it can be seen below self-reviews of all students in the team (distinguished by their usernames) are indicated by blue background to differentiate them from peer review scores.

[[File:Instructor view.PNG]]

===Test Plan===
Test cases are as follows:
* Peer-reviews cannot be viewed before a self-review is completed.
This ensures that the student is not able to see his peer-review score before writing his self-review as the composite score takes into account the difference between the student peer-review and self-review score.
* Self-review scores are displayed with peer-review scores.
This enables the student and instructor to view all his scores in one place.
* The composite score must be properly calculated.
The composite score must be calculated so as to give students more points if their self-review score is closer to the peer review score.
* Composite score must be visible in both view scores page and Alternate view.
The scores must be displayed in both the views.

===Files Changed===
*app/controllers/grades_controller.rb
*app/models/response_map.rb
*app/models/vm_question_response.rb
*app/models/vm_question_response_row.rb
*app/views/grades/view_team.html.erb

===References===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2018-_Project_E1819:_Improve_self_review,_link_self_and_peer_review_to_derive_grades#Score_Formulas Work done in Spring 2018]
#[https://github.com/expertiza/expertiza/pull/1326 Pull Request]
#[https://www.youtube.com/watch?v=TBStYgnWiUI&feature=youtu.be Screencast video]

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-12-08T01:16:42Z

Amishra6: /* Method to calculate Composite Score */

==E1854. Improve self-review, Link peer review & self-review to derive grades==

This page provides a description of the Expertiza based Semester project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===

Expertiza has the ability to require self-reviews on projects, self review is basically asking each team member in the group to evaluate their project on the same criteria as peer review, these self-review scores do not have much functionality currently. This project seeks to improve upon the self-review system, and extend its functionality. The main points of this project are as follows:
*Create a method to calculate a derived score(composite score) between self and peer-reviews. The closer the self-review is to the peer-review, the greater the score. Display this score on the "View Scores" page.
*Make sure that the peer-reviews should not be visible before self-review completion. Display the correct review scores accordingly.
*Display the self-review scores in the "View Scores" and heat map of peer-reviews, denoting that they are a different type of review.

===Application Flow===

[[File:E1799_design_1.jpg]]

The instructor has to login and create an assignment by checking allow self review option. The instructor has to add the topic and assign students to the topic. Now, the student has to login and submit the assignment. The self review link is visible in the page. The student should give the self review. After giving the self review, the student should be able to see the peer review, self review and the composite score.\

===Use case Diagram===
[[File:E1799_design_2.jpg]]

Actors:

Instructor: This actor is responsible for creating assignments and adding students to the assignment.
Student: This actor is responsible for submitting, self-reviewing and viewing the scores.

All the other use cases are implemented except “View Scores with self-review column and composite score”

'''Use Case: View score with self-review column and composite score'''

Preconditions:

1.The Instructor creates Assignments and checks the Allow Self Review check box in the Assignment
2.The Student should submit the assignment and self-review.
3.The other students should submit the reviews of the work submitted.

Student Sequence:

The student should login.
The student should browse and upload the assignment.
The student should submit the assignment.
The student should submit the self-review.
The student should choose your scores to view the score.
The student should be able to see the peer-review score with the self-review scores and composite score.

Post Conditions:

The self-review and composite score will be visible on the page.

===Method to calculate Composite Score===
The composite score is calculated using both self-review score and peer-review score (both are graded over 5 points for each criteria).
The composite score is calculated as follows:

composite score = [10 - abs(self review score - peer review score)] * peer review score / 10

By using this formula for calculating composite score we are discouraging students from either exaggerating or underrating their performance. The composite score model assigns more weight to the peer review score since the peer review score being used is the average of all peer review scores assigned and hence tends to be more appropriate than a single self review.

Also this composite score formula gives the score on a scale which is identical to the scale of the self and peer review score. Thus this formula is not dependent on the scale of the self-review and peer-review score as it will also return the composite score on the same scale.

For example: If someone gets an average peer review score of 3.5/5 and he gives 3.5/5 (self review score) while reviewing his project, then he will get a composite score of 3.5/5. And instead if the student reviews his project for 2/5 then the student will get a composite score of 2.975/5.

===Implementation===

As stated above the ability to do self reviews has already been implemented. This can be seen from the image shown below. The instructor has this ability to enable self reviews
.

[[File:Oodd abhisu.PNG]]

Our project is concerned with calculating the composite score and dispaying it in the view scores page along with other peer reviews and self review scores. We expect our final output to be in the form as shown below.

[[File:Oodd document.PNG]]

===Test Plan===
Test cases are as follows:
* Peer-reviews cannot be viewed before a self-review is completed.
This ensures that the student is not able to see his peer-review score before writing his self-review as the composite score takes into account the difference between the student peer-review and self-review score.
* Self-review scores are displayed with peer-review scores.
This enables the student and instructor to view all his scores in one place.
* The composite score must be properly calculated.
The composite score must be calculated so as to give students more points if their self-review score is closer to the peer review score.
* Composite score must be visible in both view scores page and Alternate view.
The scores must be displayed in both the views.

===Files Changed===
*app/controllers/grades_controller.rb
*app/models/response_map.rb
*app/models/vm_question_response.rb
*app/models/vm_question_response_row.rb
*app/views/grades/view_team.html.erb

===References===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2018-_Project_E1819:_Improve_self_review,_link_self_and_peer_review_to_derive_grades#Score_Formulas Work done in Spring 2018]
#[https://github.com/expertiza/expertiza/pull/1326 Pull Request]

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-12-08T01:15:14Z

Amishra6: /* Test Plan */

==E1854. Improve self-review, Link peer review & self-review to derive grades==

This page provides a description of the Expertiza based Semester project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===

Expertiza has the ability to require self-reviews on projects, self review is basically asking each team member in the group to evaluate their project on the same criteria as peer review, these self-review scores do not have much functionality currently. This project seeks to improve upon the self-review system, and extend its functionality. The main points of this project are as follows:
*Create a method to calculate a derived score(composite score) between self and peer-reviews. The closer the self-review is to the peer-review, the greater the score. Display this score on the "View Scores" page.
*Make sure that the peer-reviews should not be visible before self-review completion. Display the correct review scores accordingly.
*Display the self-review scores in the "View Scores" and heat map of peer-reviews, denoting that they are a different type of review.

===Application Flow===

[[File:E1799_design_1.jpg]]

The instructor has to login and create an assignment by checking allow self review option. The instructor has to add the topic and assign students to the topic. Now, the student has to login and submit the assignment. The self review link is visible in the page. The student should give the self review. After giving the self review, the student should be able to see the peer review, self review and the composite score.\

===Use case Diagram===
[[File:E1799_design_2.jpg]]

Actors:

Instructor: This actor is responsible for creating assignments and adding students to the assignment.
Student: This actor is responsible for submitting, self-reviewing and viewing the scores.

All the other use cases are implemented except “View Scores with self-review column and composite score”

'''Use Case: View score with self-review column and composite score'''

Preconditions:

1.The Instructor creates Assignments and checks the Allow Self Review check box in the Assignment
2.The Student should submit the assignment and self-review.
3.The other students should submit the reviews of the work submitted.

Student Sequence:

The student should login.
The student should browse and upload the assignment.
The student should submit the assignment.
The student should submit the self-review.
The student should choose your scores to view the score.
The student should be able to see the peer-review score with the self-review scores and composite score.

Post Conditions:

The self-review and composite score will be visible on the page.

===Method to calculate Composite Score===
The composite score is calculated using both self-review score and peer-review score (both are graded over 5 points for each criteria).
The composite score is calculated as follows:

composite score = [10 - abs(self review score - peer review score)] * peer review score / 10

By using this formula for calculating composite score we are discouraging students from either exaggerating or underrating their performance. The composite score model assigns more weight to the peer review score since the peer review score being used is the average of all peer review scores assigned and hence tends to be more appropriate than a single self review.

Also this composite score formula gives a score on a scale which is identical to the scale of the self and peer review score.

For example: If someone gets an average peer review score of 3.5/5 and he gives 3.5/5 (self review score) while reviewing his project, then he will get a composite score of 3.5/5. And instead if the student reviews his project for 2/5 then the student will get a composite score of 2.975/5.

===Implementation===

As stated above the ability to do self reviews has already been implemented. This can be seen from the image shown below. The instructor has this ability to enable self reviews
.

[[File:Oodd abhisu.PNG]]

Our project is concerned with calculating the composite score and dispaying it in the view scores page along with other peer reviews and self review scores. We expect our final output to be in the form as shown below.

[[File:Oodd document.PNG]]

===Test Plan===
Test cases are as follows:
* Peer-reviews cannot be viewed before a self-review is completed.
This ensures that the student is not able to see his peer-review score before writing his self-review as the composite score takes into account the difference between the student peer-review and self-review score.
* Self-review scores are displayed with peer-review scores.
This enables the student and instructor to view all his scores in one place.
* The composite score must be properly calculated.
The composite score must be calculated so as to give students more points if their self-review score is closer to the peer review score.
* Composite score must be visible in both view scores page and Alternate view.
The scores must be displayed in both the views.

===Files Changed===
*app/controllers/grades_controller.rb
*app/models/response_map.rb
*app/models/vm_question_response.rb
*app/models/vm_question_response_row.rb
*app/views/grades/view_team.html.erb

===References===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2018-_Project_E1819:_Improve_self_review,_link_self_and_peer_review_to_derive_grades#Score_Formulas Work done in Spring 2018]
#[https://github.com/expertiza/expertiza/pull/1326 Pull Request]

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-12-07T22:34:08Z

Amishra6: /* References */

==E1854. Improve self-review, Link peer review & self-review to derive grades==

This page provides a description of the Expertiza based Semester project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===

Expertiza has the ability to require self-reviews on projects, self review is basically asking each team member in the group to evaluate their project on the same criteria as peer review, these self-review scores do not have much functionality currently. This project seeks to improve upon the self-review system, and extend its functionality. The main points of this project are as follows:
*Create a method to calculate a derived score(composite score) between self and peer-reviews. The closer the self-review is to the peer-review, the greater the score. Display this score on the "View Scores" page.
*Make sure that the peer-reviews should not be visible before self-review completion. Display the correct review scores accordingly.
*Display the self-review scores in the "View Scores" and heat map of peer-reviews, denoting that they are a different type of review.

===Application Flow===

[[File:E1799_design_1.jpg]]

The instructor has to login and create an assignment by checking allow self review option. The instructor has to add the topic and assign students to the topic. Now, the student has to login and submit the assignment. The self review link is visible in the page. The student should give the self review. After giving the self review, the student should be able to see the peer review, self review and the composite score.\

===Use case Diagram===
[[File:E1799_design_2.jpg]]

Actors:

Instructor: This actor is responsible for creating assignments and adding students to the assignment.
Student: This actor is responsible for submitting, self-reviewing and viewing the scores.

All the other use cases are implemented except “View Scores with self-review column and composite score”

'''Use Case: View score with self-review column and composite score'''

Preconditions:

1.The Instructor creates Assignments and checks the Allow Self Review check box in the Assignment
2.The Student should submit the assignment and self-review.
3.The other students should submit the reviews of the work submitted.

Student Sequence:

The student should login.
The student should browse and upload the assignment.
The student should submit the assignment.
The student should submit the self-review.
The student should choose your scores to view the score.
The student should be able to see the peer-review score with the self-review scores and composite score.

Post Conditions:

The self-review and composite score will be visible on the page.

===Method to calculate Composite Score===
The composite score is calculated using both self-review score and peer-review score (both are graded over 5 points for each criteria).
The composite score is calculated as follows:

composite score = [10 - abs(self review score - peer review score)] * peer review score / 10

By using this formula for calculating composite score we are discouraging students from either exaggerating or underrating their performance. The composite score model assigns more weight to the peer review score since the peer review score being used is the average of all peer review scores assigned and hence tends to be more appropriate than a single self review.

Also this composite score formula gives a score on a scale which is identical to the scale of the self and peer review score.

For example: If someone gets an average peer review score of 3.5/5 and he gives 3.5/5 (self review score) while reviewing his project, then he will get a composite score of 3.5/5. And instead if the student reviews his project for 2/5 then the student will get a composite score of 2.975/5.

===Implementation===

As stated above the ability to do self reviews has already been implemented. This can be seen from the image shown below. The instructor has this ability to enable self reviews
.

[[File:Oodd abhisu.PNG]]

Our project is concerned with calculating the composite score and dispaying it in the view scores page along with other peer reviews and self review scores. We expect our final output to be in the form as shown below.

[[File:Oodd document.PNG]]

===Test Plan===
Test cases are as follows:
* Peer-reviews cannot be viewed before a self-review is completed.
* Self-review scores are displayed with peer-review scores.
* The composite score must be properly calculated.
* Composite score must be visible in both view scores page and Alternate view.

===References===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2018-_Project_E1819:_Improve_self_review,_link_self_and_peer_review_to_derive_grades#Score_Formulas Work done in Spring 2018]
#[https://github.com/expertiza/expertiza/pull/1326 Pull Request]

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-12-07T22:32:30Z

Amishra6: /* Method to calculate Composite Score */

==E1854. Improve self-review, Link peer review & self-review to derive grades==

This page provides a description of the Expertiza based Semester project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===

Expertiza has the ability to require self-reviews on projects, self review is basically asking each team member in the group to evaluate their project on the same criteria as peer review, these self-review scores do not have much functionality currently. This project seeks to improve upon the self-review system, and extend its functionality. The main points of this project are as follows:
*Create a method to calculate a derived score(composite score) between self and peer-reviews. The closer the self-review is to the peer-review, the greater the score. Display this score on the "View Scores" page.
*Make sure that the peer-reviews should not be visible before self-review completion. Display the correct review scores accordingly.
*Display the self-review scores in the "View Scores" and heat map of peer-reviews, denoting that they are a different type of review.

===Application Flow===

[[File:E1799_design_1.jpg]]

The instructor has to login and create an assignment by checking allow self review option. The instructor has to add the topic and assign students to the topic. Now, the student has to login and submit the assignment. The self review link is visible in the page. The student should give the self review. After giving the self review, the student should be able to see the peer review, self review and the composite score.\

===Use case Diagram===
[[File:E1799_design_2.jpg]]

Actors:

Instructor: This actor is responsible for creating assignments and adding students to the assignment.
Student: This actor is responsible for submitting, self-reviewing and viewing the scores.

All the other use cases are implemented except “View Scores with self-review column and composite score”

'''Use Case: View score with self-review column and composite score'''

Preconditions:

1.The Instructor creates Assignments and checks the Allow Self Review check box in the Assignment
2.The Student should submit the assignment and self-review.
3.The other students should submit the reviews of the work submitted.

Student Sequence:

The student should login.
The student should browse and upload the assignment.
The student should submit the assignment.
The student should submit the self-review.
The student should choose your scores to view the score.
The student should be able to see the peer-review score with the self-review scores and composite score.

Post Conditions:

The self-review and composite score will be visible on the page.

===Method to calculate Composite Score===
The composite score is calculated using both self-review score and peer-review score (both are graded over 5 points for each criteria).
The composite score is calculated as follows:

composite score = [10 - abs(self review score - peer review score)] * peer review score / 10

By using this formula for calculating composite score we are discouraging students from either exaggerating or underrating their performance. The composite score model assigns more weight to the peer review score since the peer review score being used is the average of all peer review scores assigned and hence tends to be more appropriate than a single self review.

Also this composite score formula gives a score on a scale which is identical to the scale of the self and peer review score.

For example: If someone gets an average peer review score of 3.5/5 and he gives 3.5/5 (self review score) while reviewing his project, then he will get a composite score of 3.5/5. And instead if the student reviews his project for 2/5 then the student will get a composite score of 2.975/5.

===Implementation===

As stated above the ability to do self reviews has already been implemented. This can be seen from the image shown below. The instructor has this ability to enable self reviews
.

[[File:Oodd abhisu.PNG]]

Our project is concerned with calculating the composite score and dispaying it in the view scores page along with other peer reviews and self review scores. We expect our final output to be in the form as shown below.

[[File:Oodd document.PNG]]

===Test Plan===
Test cases are as follows:
* Peer-reviews cannot be viewed before a self-review is completed.
* Self-review scores are displayed with peer-review scores.
* The composite score must be properly calculated.
* Composite score must be visible in both view scores page and Alternate view.

===References===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2018-_Project_E1819:_Improve_self_review,_link_self_and_peer_review_to_derive_grades#Score_Formulas Work done in Spring 2018]

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-21T00:41:08Z

Amishra6: /* Implementation */

==E1854. Improve self-review, Link peer review & self-review to derive grades==

This page provides a description of the Expertiza based Semester project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===

Expertiza has the ability to require self-reviews on projects, self review is basically asking each team member in the group to evaluate their project on the same criteria as peer review, these self-review scores do not have much functionality currently. This project seeks to improve upon the self-review system, and extend its functionality. The main points of this project are as follows:
*Create a method to calculate a derived score(composite score) between self and peer-reviews. The closer the self-review is to the peer-review, the greater the score. Display this score on the "View Scores" page.
*Make sure that the peer-reviews should not be visible before self-review completion. Display the correct review scores accordingly.
*Display the self-review scores in the "View Scores" and heat map of peer-reviews, denoting that they are a different type of review.

===Application Flow===

[[File:E1799_design_1.jpg]]

The instructor has to login and create an assignment by checking allow self review option. The instructor has to add the topic and assign students to the topic. Now, the student has to login and submit the assignment. The self review link is visible in the page. The student should give the self review. After giving the self review, the student should be able to see the peer review, self review and the composite score.\

===Use case Diagram===
[[File:E1799_design_2.jpg]]

Actors:

Instructor: This actor is responsible for creating assignments and adding students to the assignment.
Student: This actor is responsible for submitting, self-reviewing and viewing the scores.

All the other use cases are implemented except “View Scores with self-review column and composite score”

'''Use Case: View score with self-review column and composite score'''

Preconditions:

1.The Instructor creates Assignments and checks the Allow Self Review check box in the Assignment
2.The Student should submit the assignment and self-review.
3.The other students should submit the reviews of the work submitted.

Student Sequence:

The student should login.
The student should browse and upload the assignment.
The student should submit the assignment.
The student should submit the self-review.
The student should choose your scores to view the score.
The student should be able to see the peer-review score with the self-review scores and composite score.

Post Conditions:

The self-review and composite score will be visible on the page.

===Method to calculate Composite Score===
The composite score is calculated using both self-review score and peer-review score (both are graded over 5 points for each criteria).
The composite score is calculated as follows:

composite score = [10 - abs(self review score - peer review score)] * peer review score / 10

By using this formula for calculating composite score we are discouraging students from either exaggerating or underrating their performance. The composite score model assigns more weight to the peer review score since the peer review score being used is the average of all peer review scores assigned and hence tends to be more appropriate than a single self review.

For example: If someone gets an average peer review score of 3.5/5 and he gives 3.5/5 (self review score) while reviewing his project, then he will get a composite score of 3.5/5. And instead if the student reviews his project for 2/5 then the student will get a composite score of 2.975/5.

===Implementation===

As stated above the ability to do self reviews has already been implemented. This can be seen from the image shown below. The instructor has this ability to enable self reviews
.

[[File:Oodd abhisu.PNG]]

Our project is concerned with calculating the composite score and dispaying it in the view scores page along with other peer reviews and self review scores. We expect our final output to be in the form as shown below.

[[File:Oodd document.PNG]]

===Test Plan===
Test cases are as follows:
* Peer-reviews cannot be viewed before a self-review is completed.
* Self-review scores are displayed with peer-review scores.
* The composite score must be properly calculated.
* Composite score must be visible in both view scores page and Alternate view.

===References===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2018-_Project_E1819:_Improve_self_review,_link_self_and_peer_review_to_derive_grades#Score_Formulas Work done in Spring 2018]

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-21T00:40:52Z

Amishra6: /* Implementation */

==E1854. Improve self-review, Link peer review & self-review to derive grades==

This page provides a description of the Expertiza based Semester project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===

Expertiza has the ability to require self-reviews on projects, self review is basically asking each team member in the group to evaluate their project on the same criteria as peer review, these self-review scores do not have much functionality currently. This project seeks to improve upon the self-review system, and extend its functionality. The main points of this project are as follows:
*Create a method to calculate a derived score(composite score) between self and peer-reviews. The closer the self-review is to the peer-review, the greater the score. Display this score on the "View Scores" page.
*Make sure that the peer-reviews should not be visible before self-review completion. Display the correct review scores accordingly.
*Display the self-review scores in the "View Scores" and heat map of peer-reviews, denoting that they are a different type of review.

===Application Flow===

[[File:E1799_design_1.jpg]]

The instructor has to login and create an assignment by checking allow self review option. The instructor has to add the topic and assign students to the topic. Now, the student has to login and submit the assignment. The self review link is visible in the page. The student should give the self review. After giving the self review, the student should be able to see the peer review, self review and the composite score.\

===Use case Diagram===
[[File:E1799_design_2.jpg]]

Actors:

Instructor: This actor is responsible for creating assignments and adding students to the assignment.
Student: This actor is responsible for submitting, self-reviewing and viewing the scores.

All the other use cases are implemented except “View Scores with self-review column and composite score”

'''Use Case: View score with self-review column and composite score'''

Preconditions:

1.The Instructor creates Assignments and checks the Allow Self Review check box in the Assignment
2.The Student should submit the assignment and self-review.
3.The other students should submit the reviews of the work submitted.

Student Sequence:

The student should login.
The student should browse and upload the assignment.
The student should submit the assignment.
The student should submit the self-review.
The student should choose your scores to view the score.
The student should be able to see the peer-review score with the self-review scores and composite score.

Post Conditions:

The self-review and composite score will be visible on the page.

===Method to calculate Composite Score===
The composite score is calculated using both self-review score and peer-review score (both are graded over 5 points for each criteria).
The composite score is calculated as follows:

composite score = [10 - abs(self review score - peer review score)] * peer review score / 10

By using this formula for calculating composite score we are discouraging students from either exaggerating or underrating their performance. The composite score model assigns more weight to the peer review score since the peer review score being used is the average of all peer review scores assigned and hence tends to be more appropriate than a single self review.

For example: If someone gets an average peer review score of 3.5/5 and he gives 3.5/5 (self review score) while reviewing his project, then he will get a composite score of 3.5/5. And instead if the student reviews his project for 2/5 then the student will get a composite score of 2.975/5.

===Implementation===

As stated above the ability to do self reviews has already been implemented. This can be seen from the image shown below. The instructor has this ability to enable self reviews
.
[[File:Oodd abhisu.PNG]]

Our project is concerned with calculating the composite score and dispaying it in the view scores page along with other peer reviews and self review scores. We expect our final output to be in the form as shown below.

[[File:Oodd document.PNG]]

===Test Plan===
Test cases are as follows:
* Peer-reviews cannot be viewed before a self-review is completed.
* Self-review scores are displayed with peer-review scores.
* The composite score must be properly calculated.
* Composite score must be visible in both view scores page and Alternate view.

===References===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2018-_Project_E1819:_Improve_self_review,_link_self_and_peer_review_to_derive_grades#Score_Formulas Work done in Spring 2018]

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-19T23:58:41Z

Amishra6: /* Use case Diagram */

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-19T23:54:02Z

Amishra6: /* Method to calculate Composite Score */

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-19T23:51:16Z

Amishra6: /* Use case Diagram */

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-19T23:50:10Z

Amishra6: /* Method to calculate Composite Score */

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-19T23:49:57Z

Amishra6: /* Method to calculate Composite Score */

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-19T23:01:00Z

Amishra6: /* Method to calculate Composite Score */

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-13T21:14:40Z

Amishra6: /* Test Plan */

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-13T21:12:31Z

Amishra6: /* Problem Statement */

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-13T21:09:55Z

Amishra6: /* Test Plan */

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-13T21:09:00Z

Amishra6: /* E1854. Improve self-review, Link peer review & self-review to derive grades */

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-13T21:02:59Z

Amishra6: /* Introduction */

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-13T21:01:40Z

Amishra6: /* Plan of Work */

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-13T20:58:01Z

Amishra6: /* E1854. Improve self-review, Link peer review & self-review to derive grades */

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-13T20:57:29Z

Amishra6: /* E1854. Improve self-review, Link peer review & self-review to derive grades */

==E1854. Improve self-review, Link peer review & self-review to derive grades==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Introduction===

Expertiza has the ability to require self-reviews on projects, however, these self-review scores do not have much functionality. In the current system, self-review scores are created and stored, but are not used afterwards. This project seeks to improve upon the self-review system, and extend its functionality. The main points of this project are as follows:
*Create a method to calculate a derived score between self and peer-reviews. The closer the self-review is to the peer-review, the greater the score. Display this score on the "View Scores" page.
*Allow instructors to decide if peer-reviews should be visible before self-review completion. Display the correct review scores accordingly.
*Display the self-review scores in the "View Scores" and heat map of peer-reviews, denoting that they are a different type of review.

===Application Flow===

[[File:E1799_design_1.jpg]]

The instructor has to login and create an assignment by checking allow self review option. The instructor has to add the topic and assign students to the topic. Now, the student has to login and submit the assignment. The self review link is visible in the page. The student should give the self review. After giving the self review, the student should be able to see the peer review, self review and the composite score.\

===Plan of Work===

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-13T20:54:45Z

Amishra6: /* E1854. Improve self-review, Link peer review & self-review to derive grades */

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-13T20:53:23Z

Amishra6: /* Introduction */

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-13T20:53:15Z

Amishra6: /* About Expertiza */

==E1854. Improve self-review, Link peer review & self-review to derive grades==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

==Introduction==

Expertiza has the ability to require self-reviews on projects, however, these self-review scores do not have much functionality. In the current system, self-review scores are created and stored, but are not used afterwards. This project seeks to improve upon the self-review system, and extend its functionality. The main points of this project are as follows:
*Create a method to calculate a derived score between self and peer-reviews. The closer the self-review is to the peer-review, the greater the score. Display this score on the "View Scores" page.
*Allow instructors to decide if peer-reviews should be visible before self-review completion. Display the correct review scores accordingly.
*Display the self-review scores in the "View Scores" and heat map of peer-reviews, denoting that they are a different type of review.

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-13T20:51:37Z

Amishra6: /* About Expertiza */

==E1854. Improve self-review, Link peer review & self-review to derive grades==

This page provides a description of the Expertiza based OSS project.

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

==Introduction==

Expertiza has the ability to require self-reviews on projects, however, these self-review scores do not have much functionality. In the current system, self-review scores are created and stored, but are not used afterwards. This project seeks to improve upon the self-review system, and extend its functionality. The main points of this project are as follows:
*Create a method to calculate a derived score between self and peer-reviews. The closer the self-review is to the peer-review, the greater the score. Display this score on the "View Scores" page.
*Allow instructors to decide if peer-reviews should be visible before self-review completion. Display the correct review scores accordingly.
*Display the self-review scores in the "View Scores" and heat map of peer-reviews, denoting that they are a different type of review.

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-13T20:50:49Z

Amishra6: /* Introduction */

==E1854. Improve self-review, Link peer review & self-review to derive grades==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

==Introduction==

Expertiza has the ability to require self-reviews on projects, however, these self-review scores do not have much functionality. In the current system, self-review scores are created and stored, but are not used afterwards. This project seeks to improve upon the self-review system, and extend its functionality. The main points of this project are as follows:
*Create a method to calculate a derived score between self and peer-reviews. The closer the self-review is to the peer-review, the greater the score. Display this score on the "View Scores" page.
*Allow instructors to decide if peer-reviews should be visible before self-review completion. Display the correct review scores accordingly.
*Display the self-review scores in the "View Scores" and heat map of peer-reviews, denoting that they are a different type of review.

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-13T20:49:30Z

Amishra6: /* E1854. Improve self-review, Link peer review & self-review to derive grades */

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-13T20:47:30Z

Amishra6: /* E1836. Refactoring quiz_questionnaires_controller.rb */

CSC/ECE 517 Fall 2018 E1854

2018-11-13T20:45:07Z

Amishra6: moved CSC/ECE 517 Fall 2018 E1854 to CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

#REDIRECT [[CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades]]

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-13T20:45:07Z

Amishra6: moved CSC/ECE 517 Fall 2018 E1854 to CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

CSC/ECE 517 Fall 2018 E1854 Improve self-review, Link peer review & self-review to derive grades

2018-11-13T20:44:02Z

Amishra6: Created page with "==E1836. Refactoring quiz_questionnaires_controller.rb== This page provides a description of the Expertiza based OSS project. __TOC__ ===About Expertiza=== [http://expertiz..."

CSC/ECE 517 Fall 2018 E1836 Refactor quiz questionnaires controller.rb

2018-11-10T02:16:57Z

Amishra6: /* Testing from UI */

==E1836. Refactoring quiz_questionnaires_controller.rb==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===
The following tasks were accomplished in this project:
* Created quiz_questionnaire_controller.rb
* Moved view_quiz, new_quiz, create_quiz_questionnaire, edit_quiz and update_quiz from questionnaires_controller.rb, to quiz_questionnaires_controller.rb, and renamed it as view, new, create, edit and update respectively.
* Refactored the the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* Replaced switch statements in questionnaires_controller.rb with subclass methods.
* Created models for the subclasses.
* Removed hardcoded parameters, such as save_choice method.
* Appropriate tests were written to test the code.

===Implementation===

'''Problem 1''': Create quiz_questionnaire_controller.rb and move some of the methods in the questionnaires_controller.rb to the new file created.
* '''Solution''': The methods view_quiz, new_quiz, create_quiz, edit_quiz and update_quiz in the questionnaires_controller.rb were the methods identified and moved into the quiz_questionnaire_controller.rb. They were respectively renamed as view, new, create, edit and update. The implementation of the newly created quiz_questionnaire_controller.rb can be seen below.
<pre>
class QuizQuestionnairesController < QuestionnairesController

#=========================================================================================================
# Separate methods for quiz questionnaire
#=========================================================================================================

# View a quiz questionnaire
def view
@questionnaire = Questionnaire.find(params[:id])
@participant = Participant.find(params[:pid]) # creating an instance variable since it needs to be sent to submitted_content/edit
render :view
end

# define a new quiz questionnaire
# method invoked by the view
def new
valid_request = true
@assignment_id = params[:aid] # creating an instance variable to hold the assignment id
@participant_id = params[:pid] # creating an instance variable to hold the participant id
assignment = Assignment.find(@assignment_id)
if !assignment.require_quiz? # flash error if this assignment does not require quiz
flash[:error] = "This assignment does not support the quizzing feature."
valid_request = false
else
team = AssignmentParticipant.find(@participant_id).team

if team.nil? # flash error if this current participant does not have a team
flash[:error] = "You should create or join a team first."
valid_request = false
else
if assignment.topics? && team.topic.nil? # flash error if this assignment has topic but current team does not have a topic
flash[:error] = "Your team should have a topic."
valid_request = false
end
end
end

if valid_request && Questionnaire::QUESTIONNAIRE_TYPES.include?(params[:model])
@questionnaire = Object.const_get(params[:model]).new
@questionnaire.private = params[:private]
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1

render :new
else
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end

# seperate method for creating a quiz questionnaire because of differences in permission
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

# edit a quiz questionnaire
def edit
@questionnaire = Questionnaire.find(params[:id])
if !@questionnaire.taken_by_anyone?
render :edit
else
flash[:error] = "Your quiz has been taken by some other students, you cannot edit it anymore."
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end
# save an updated quiz questionnaire to the database
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)

for qid in params[:question].keys
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save

@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
i = 1
for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end

end
</pre>

'''Problem 2''': Refactor the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* '''Solution''':
a. Deleted the create_questionnaire method and replaced the call to it in create_quiz_questionnaire with the code of create_questionnaire and is later moved to quiz_questionnaires_controller.rb and the code snippet below is used.

<pre>
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

</pre>

b. Moved the large block of for and if statements into method called change_question_types in the quiz_questionnaire model.

<pre>
def change_question_types(quiz_question_choice, type, id, i)

if type == "MultipleChoiceCheckbox"

if params[:quiz_question_choices][id.to_s][type][i.to_s]
quiz_question_choice.update_attributes(iscorrect: params[:quiz_question_choices][id.to_s][type][i.to_s][:iscorrect], txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][quiz_question_choice.id.to_s][:txt])
end
end

if type == "MultipleChoiceRadio"

if params[:quiz_question_choices][id.to_s][type][:correctindex] == i.to_s
quiz_question_choice.update_attributes(iscorrect: '1', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])
end
end

if type == "TrueFalse"

if params[:quiz_question_choices][id.to_s][type][1.to_s][:iscorrect] == "True" # the statement is correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is correct so "True" is the right answer

else
quiz_question_choice.update_attributes(iscorrect: '0')
end

else # the statement is not correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '0')

else
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is not correct so "False" is the right answer
end
end
end
end
</pre>

c. Replaced large block of for and if statements in update with a call to the new change_question_types method.

<pre>

for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
</pre>

d. Moved export, import, copy_questionnaire_details, and assign_instructor_id to questionaire model.

<pre>
def copy_questionnaire_details(questions, orig_questionnaire, id)
self.instructor_id = self.assign_instructor_id()
self.name = 'Copy of ' + orig_questionnaire.name

begin
self.created_at = Time.now
self.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = id
new_question.size = '50,3' if (new_question.is_a? Criterion or new_question.is_a? TextResponse) and new_question.size.nil?
new_question.save!
advices = QuestionAdvice.where(question_id: question.id)
next if advices.empty?
advices.each do |advice|
new_advice = advice.dup
new_advice.question_id = new_question.id
new_advice.save!
end
end

pFolder = TreeFolder.find_by(name: question.set_display_type(display_type))
parent = FolderNode.find_by(node_object_id: pFolder.id)
QuestionnaireNode.find_or_create_by(parent_id: parent.id, node_object_id: id)
undo_link("Copy of questionnaire #{orig_questionnaire.name} has been created successfully.")
redirect_to controller: 'questionnaires', action: 'view', id: @questionnaire.id
rescue StandardError
flash[:error] = 'The questionnaire was not able to be copied. Please check the original course for missing information.' + $ERROR_INFO
redirect_to action: 'list', controller: 'tree_display'
end
end

def export
@questionnaire = Questionnaire.find(params[:id])
csv_data = QuestionnaireHelper.create_questionnaire_csv @questionnaire, session[:user].name
send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=questionnaires.csv"
end

def import
@questionnaire = Questionnaire.find(params[:id])
file = params['csv']
@questionnaire.questions << QuestionnaireHelper.get_questions_from_csv(@questionnaire, file)
end

def assign_instructor_id
# if the user to copy the questionnaire is a TA, the instructor should be the owner instead of the TA
if session[:user].role.name != "Teaching Assistant"
session[:user].id
else # for TA we need to get his instructor id and by default add it to his course for which he is the TA
Ta.get_my_instructor(session[:user].id)
end
end
</pre>

3''': Replace switch statements with subclasses methods and create models for the subclasses.
* '''Solution''': Moved the switch-case statement from create in questionaire_controller.rb into a method called set_display_type in questionaire model. The following is the code snippet that shows the same.

<pre>

def set_dispay_type(display_type)

case display_type

when 'Review'
display_type = 'Review'

when 'Metareview'
display_type = 'Metareview'

when 'AuthorFeedback'
display_type = 'Author%Feedback'

when 'CourseSurvey'
display_type = 'Course%Survey'

when 'TeammateReview'
display_type = 'Teammate%Review'

when 'GlobalSurvey'
display_type = 'Global%Survey'

when 'AssignmentSurvey'
display_type = 'Assignment%Survey'

when 'Bookmarkrating'
display_type = 'Bookmarkrating'
end
end
</pre>

'''Problem 4''': Remove hardcoded parameters, such as save_choice method
* '''Solution''': Hardcoded parameters are removed and necessary constants are defined.

===Test Plans===

Because the purpose of our project was to better arrange our code, it follows that we also needed to rearrange the tests for that code. We first divided the tests for questionnaires_controller into two test files, questionnaires_controller_spec and quiz_questionnaires_controller_spec and separated the tests for CRUD operations of quiz_questionnaires_controller into the quiz_questionnaires_controller_spec, renaming them from view_quiz, create_quiz and the like to view and create. After this separation of CRUD operation testing, we tested the functionality that we moved out of the controllers into the model including the validation method for the quiz questionnaire. We did not include tests to cover the existing model functions, nor did we test the new set_display_type or change_question_types functions as they are setter methods, which, according to our testing instruction are not worth testing.

The setup for testing was particularly troublesome for the deployment of this project. The tests did not run properly in RubyMine, so it was difficult to ensure they were set up properly, and none of the members of our group have any expertise in rspec testing.

===Testing from UI===

*The testing of the export feature is shown below:

[[File:Export_setup.png]]

[[File:Export_completed_successfully.png|center]]

*The successful creation of quiz is shown below:

[[File:Quiz created sucessfully.png|center]]

*The saving of question in a questionnaire is shown below:

[[File:Save question in review successfully.png]]

*The successful updating of questionnaire is shown below:

[[File:Updated questionnaire successfully.png]]

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/Riounis/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1271 GitHub Pull Request]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2018 E1836 Refactor quiz questionnaires controller.rb

2018-11-10T02:16:37Z

Amishra6: /* Testing from UI */

==E1836. Refactoring quiz_questionnaires_controller.rb==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===
The following tasks were accomplished in this project:
* Created quiz_questionnaire_controller.rb
* Moved view_quiz, new_quiz, create_quiz_questionnaire, edit_quiz and update_quiz from questionnaires_controller.rb, to quiz_questionnaires_controller.rb, and renamed it as view, new, create, edit and update respectively.
* Refactored the the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* Replaced switch statements in questionnaires_controller.rb with subclass methods.
* Created models for the subclasses.
* Removed hardcoded parameters, such as save_choice method.
* Appropriate tests were written to test the code.

===Implementation===

'''Problem 1''': Create quiz_questionnaire_controller.rb and move some of the methods in the questionnaires_controller.rb to the new file created.
* '''Solution''': The methods view_quiz, new_quiz, create_quiz, edit_quiz and update_quiz in the questionnaires_controller.rb were the methods identified and moved into the quiz_questionnaire_controller.rb. They were respectively renamed as view, new, create, edit and update. The implementation of the newly created quiz_questionnaire_controller.rb can be seen below.
<pre>
class QuizQuestionnairesController < QuestionnairesController

#=========================================================================================================
# Separate methods for quiz questionnaire
#=========================================================================================================

# View a quiz questionnaire
def view
@questionnaire = Questionnaire.find(params[:id])
@participant = Participant.find(params[:pid]) # creating an instance variable since it needs to be sent to submitted_content/edit
render :view
end

# define a new quiz questionnaire
# method invoked by the view
def new
valid_request = true
@assignment_id = params[:aid] # creating an instance variable to hold the assignment id
@participant_id = params[:pid] # creating an instance variable to hold the participant id
assignment = Assignment.find(@assignment_id)
if !assignment.require_quiz? # flash error if this assignment does not require quiz
flash[:error] = "This assignment does not support the quizzing feature."
valid_request = false
else
team = AssignmentParticipant.find(@participant_id).team

if team.nil? # flash error if this current participant does not have a team
flash[:error] = "You should create or join a team first."
valid_request = false
else
if assignment.topics? && team.topic.nil? # flash error if this assignment has topic but current team does not have a topic
flash[:error] = "Your team should have a topic."
valid_request = false
end
end
end

if valid_request && Questionnaire::QUESTIONNAIRE_TYPES.include?(params[:model])
@questionnaire = Object.const_get(params[:model]).new
@questionnaire.private = params[:private]
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1

render :new
else
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end

# seperate method for creating a quiz questionnaire because of differences in permission
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

# edit a quiz questionnaire
def edit
@questionnaire = Questionnaire.find(params[:id])
if !@questionnaire.taken_by_anyone?
render :edit
else
flash[:error] = "Your quiz has been taken by some other students, you cannot edit it anymore."
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end
# save an updated quiz questionnaire to the database
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)

for qid in params[:question].keys
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save

@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
i = 1
for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end

end
</pre>

'''Problem 2''': Refactor the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* '''Solution''':
a. Deleted the create_questionnaire method and replaced the call to it in create_quiz_questionnaire with the code of create_questionnaire and is later moved to quiz_questionnaires_controller.rb and the code snippet below is used.

<pre>
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

</pre>

b. Moved the large block of for and if statements into method called change_question_types in the quiz_questionnaire model.

<pre>
def change_question_types(quiz_question_choice, type, id, i)

if type == "MultipleChoiceCheckbox"

if params[:quiz_question_choices][id.to_s][type][i.to_s]
quiz_question_choice.update_attributes(iscorrect: params[:quiz_question_choices][id.to_s][type][i.to_s][:iscorrect], txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][quiz_question_choice.id.to_s][:txt])
end
end

if type == "MultipleChoiceRadio"

if params[:quiz_question_choices][id.to_s][type][:correctindex] == i.to_s
quiz_question_choice.update_attributes(iscorrect: '1', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])
end
end

if type == "TrueFalse"

if params[:quiz_question_choices][id.to_s][type][1.to_s][:iscorrect] == "True" # the statement is correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is correct so "True" is the right answer

else
quiz_question_choice.update_attributes(iscorrect: '0')
end

else # the statement is not correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '0')

else
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is not correct so "False" is the right answer
end
end
end
end
</pre>

c. Replaced large block of for and if statements in update with a call to the new change_question_types method.

<pre>

for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
</pre>

d. Moved export, import, copy_questionnaire_details, and assign_instructor_id to questionaire model.

<pre>
def copy_questionnaire_details(questions, orig_questionnaire, id)
self.instructor_id = self.assign_instructor_id()
self.name = 'Copy of ' + orig_questionnaire.name

begin
self.created_at = Time.now
self.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = id
new_question.size = '50,3' if (new_question.is_a? Criterion or new_question.is_a? TextResponse) and new_question.size.nil?
new_question.save!
advices = QuestionAdvice.where(question_id: question.id)
next if advices.empty?
advices.each do |advice|
new_advice = advice.dup
new_advice.question_id = new_question.id
new_advice.save!
end
end

pFolder = TreeFolder.find_by(name: question.set_display_type(display_type))
parent = FolderNode.find_by(node_object_id: pFolder.id)
QuestionnaireNode.find_or_create_by(parent_id: parent.id, node_object_id: id)
undo_link("Copy of questionnaire #{orig_questionnaire.name} has been created successfully.")
redirect_to controller: 'questionnaires', action: 'view', id: @questionnaire.id
rescue StandardError
flash[:error] = 'The questionnaire was not able to be copied. Please check the original course for missing information.' + $ERROR_INFO
redirect_to action: 'list', controller: 'tree_display'
end
end

def export
@questionnaire = Questionnaire.find(params[:id])
csv_data = QuestionnaireHelper.create_questionnaire_csv @questionnaire, session[:user].name
send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=questionnaires.csv"
end

def import
@questionnaire = Questionnaire.find(params[:id])
file = params['csv']
@questionnaire.questions << QuestionnaireHelper.get_questions_from_csv(@questionnaire, file)
end

def assign_instructor_id
# if the user to copy the questionnaire is a TA, the instructor should be the owner instead of the TA
if session[:user].role.name != "Teaching Assistant"
session[:user].id
else # for TA we need to get his instructor id and by default add it to his course for which he is the TA
Ta.get_my_instructor(session[:user].id)
end
end
</pre>

3''': Replace switch statements with subclasses methods and create models for the subclasses.
* '''Solution''': Moved the switch-case statement from create in questionaire_controller.rb into a method called set_display_type in questionaire model. The following is the code snippet that shows the same.

<pre>

def set_dispay_type(display_type)

case display_type

when 'Review'
display_type = 'Review'

when 'Metareview'
display_type = 'Metareview'

when 'AuthorFeedback'
display_type = 'Author%Feedback'

when 'CourseSurvey'
display_type = 'Course%Survey'

when 'TeammateReview'
display_type = 'Teammate%Review'

when 'GlobalSurvey'
display_type = 'Global%Survey'

when 'AssignmentSurvey'
display_type = 'Assignment%Survey'

when 'Bookmarkrating'
display_type = 'Bookmarkrating'
end
end
</pre>

'''Problem 4''': Remove hardcoded parameters, such as save_choice method
* '''Solution''': Hardcoded parameters are removed and necessary constants are defined.

===Test Plans===

Because the purpose of our project was to better arrange our code, it follows that we also needed to rearrange the tests for that code. We first divided the tests for questionnaires_controller into two test files, questionnaires_controller_spec and quiz_questionnaires_controller_spec and separated the tests for CRUD operations of quiz_questionnaires_controller into the quiz_questionnaires_controller_spec, renaming them from view_quiz, create_quiz and the like to view and create. After this separation of CRUD operation testing, we tested the functionality that we moved out of the controllers into the model including the validation method for the quiz questionnaire. We did not include tests to cover the existing model functions, nor did we test the new set_display_type or change_question_types functions as they are setter methods, which, according to our testing instruction are not worth testing.

The setup for testing was particularly troublesome for the deployment of this project. The tests did not run properly in RubyMine, so it was difficult to ensure they were set up properly, and none of the members of our group have any expertise in rspec testing.

===Testing from UI===

*The testing of the export feature is shown below:

[[File:Export_setup.png]]

[[File:Export_completed_successfully.png|center]]

*The successful creation of quiz is shown below:

[[File:Quiz created sucessfully.png|center]]

*The saving of question in a questionnaire is shown below:

[[File:Save question in review successfully.png]]

*The successful updating of questionnaire is shown below:

[[File:Updated questionnaire successfully.png|upright=0.5]]

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/Riounis/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1271 GitHub Pull Request]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2018 E1836 Refactor quiz questionnaires controller.rb

2018-11-10T02:16:20Z

Amishra6: /* Testing from UI */

==E1836. Refactoring quiz_questionnaires_controller.rb==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===
The following tasks were accomplished in this project:
* Created quiz_questionnaire_controller.rb
* Moved view_quiz, new_quiz, create_quiz_questionnaire, edit_quiz and update_quiz from questionnaires_controller.rb, to quiz_questionnaires_controller.rb, and renamed it as view, new, create, edit and update respectively.
* Refactored the the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* Replaced switch statements in questionnaires_controller.rb with subclass methods.
* Created models for the subclasses.
* Removed hardcoded parameters, such as save_choice method.
* Appropriate tests were written to test the code.

===Implementation===

'''Problem 1''': Create quiz_questionnaire_controller.rb and move some of the methods in the questionnaires_controller.rb to the new file created.
* '''Solution''': The methods view_quiz, new_quiz, create_quiz, edit_quiz and update_quiz in the questionnaires_controller.rb were the methods identified and moved into the quiz_questionnaire_controller.rb. They were respectively renamed as view, new, create, edit and update. The implementation of the newly created quiz_questionnaire_controller.rb can be seen below.
<pre>
class QuizQuestionnairesController < QuestionnairesController

#=========================================================================================================
# Separate methods for quiz questionnaire
#=========================================================================================================

# View a quiz questionnaire
def view
@questionnaire = Questionnaire.find(params[:id])
@participant = Participant.find(params[:pid]) # creating an instance variable since it needs to be sent to submitted_content/edit
render :view
end

# define a new quiz questionnaire
# method invoked by the view
def new
valid_request = true
@assignment_id = params[:aid] # creating an instance variable to hold the assignment id
@participant_id = params[:pid] # creating an instance variable to hold the participant id
assignment = Assignment.find(@assignment_id)
if !assignment.require_quiz? # flash error if this assignment does not require quiz
flash[:error] = "This assignment does not support the quizzing feature."
valid_request = false
else
team = AssignmentParticipant.find(@participant_id).team

if team.nil? # flash error if this current participant does not have a team
flash[:error] = "You should create or join a team first."
valid_request = false
else
if assignment.topics? && team.topic.nil? # flash error if this assignment has topic but current team does not have a topic
flash[:error] = "Your team should have a topic."
valid_request = false
end
end
end

if valid_request && Questionnaire::QUESTIONNAIRE_TYPES.include?(params[:model])
@questionnaire = Object.const_get(params[:model]).new
@questionnaire.private = params[:private]
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1

render :new
else
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end

# seperate method for creating a quiz questionnaire because of differences in permission
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

# edit a quiz questionnaire
def edit
@questionnaire = Questionnaire.find(params[:id])
if !@questionnaire.taken_by_anyone?
render :edit
else
flash[:error] = "Your quiz has been taken by some other students, you cannot edit it anymore."
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end
# save an updated quiz questionnaire to the database
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)

for qid in params[:question].keys
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save

@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
i = 1
for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end

end
</pre>

'''Problem 2''': Refactor the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* '''Solution''':
a. Deleted the create_questionnaire method and replaced the call to it in create_quiz_questionnaire with the code of create_questionnaire and is later moved to quiz_questionnaires_controller.rb and the code snippet below is used.

<pre>
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

</pre>

b. Moved the large block of for and if statements into method called change_question_types in the quiz_questionnaire model.

<pre>
def change_question_types(quiz_question_choice, type, id, i)

if type == "MultipleChoiceCheckbox"

if params[:quiz_question_choices][id.to_s][type][i.to_s]
quiz_question_choice.update_attributes(iscorrect: params[:quiz_question_choices][id.to_s][type][i.to_s][:iscorrect], txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][quiz_question_choice.id.to_s][:txt])
end
end

if type == "MultipleChoiceRadio"

if params[:quiz_question_choices][id.to_s][type][:correctindex] == i.to_s
quiz_question_choice.update_attributes(iscorrect: '1', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])
end
end

if type == "TrueFalse"

if params[:quiz_question_choices][id.to_s][type][1.to_s][:iscorrect] == "True" # the statement is correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is correct so "True" is the right answer

else
quiz_question_choice.update_attributes(iscorrect: '0')
end

else # the statement is not correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '0')

else
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is not correct so "False" is the right answer
end
end
end
end
</pre>

c. Replaced large block of for and if statements in update with a call to the new change_question_types method.

<pre>

for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
</pre>

d. Moved export, import, copy_questionnaire_details, and assign_instructor_id to questionaire model.

<pre>
def copy_questionnaire_details(questions, orig_questionnaire, id)
self.instructor_id = self.assign_instructor_id()
self.name = 'Copy of ' + orig_questionnaire.name

begin
self.created_at = Time.now
self.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = id
new_question.size = '50,3' if (new_question.is_a? Criterion or new_question.is_a? TextResponse) and new_question.size.nil?
new_question.save!
advices = QuestionAdvice.where(question_id: question.id)
next if advices.empty?
advices.each do |advice|
new_advice = advice.dup
new_advice.question_id = new_question.id
new_advice.save!
end
end

pFolder = TreeFolder.find_by(name: question.set_display_type(display_type))
parent = FolderNode.find_by(node_object_id: pFolder.id)
QuestionnaireNode.find_or_create_by(parent_id: parent.id, node_object_id: id)
undo_link("Copy of questionnaire #{orig_questionnaire.name} has been created successfully.")
redirect_to controller: 'questionnaires', action: 'view', id: @questionnaire.id
rescue StandardError
flash[:error] = 'The questionnaire was not able to be copied. Please check the original course for missing information.' + $ERROR_INFO
redirect_to action: 'list', controller: 'tree_display'
end
end

def export
@questionnaire = Questionnaire.find(params[:id])
csv_data = QuestionnaireHelper.create_questionnaire_csv @questionnaire, session[:user].name
send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=questionnaires.csv"
end

def import
@questionnaire = Questionnaire.find(params[:id])
file = params['csv']
@questionnaire.questions << QuestionnaireHelper.get_questions_from_csv(@questionnaire, file)
end

def assign_instructor_id
# if the user to copy the questionnaire is a TA, the instructor should be the owner instead of the TA
if session[:user].role.name != "Teaching Assistant"
session[:user].id
else # for TA we need to get his instructor id and by default add it to his course for which he is the TA
Ta.get_my_instructor(session[:user].id)
end
end
</pre>

3''': Replace switch statements with subclasses methods and create models for the subclasses.
* '''Solution''': Moved the switch-case statement from create in questionaire_controller.rb into a method called set_display_type in questionaire model. The following is the code snippet that shows the same.

<pre>

def set_dispay_type(display_type)

case display_type

when 'Review'
display_type = 'Review'

when 'Metareview'
display_type = 'Metareview'

when 'AuthorFeedback'
display_type = 'Author%Feedback'

when 'CourseSurvey'
display_type = 'Course%Survey'

when 'TeammateReview'
display_type = 'Teammate%Review'

when 'GlobalSurvey'
display_type = 'Global%Survey'

when 'AssignmentSurvey'
display_type = 'Assignment%Survey'

when 'Bookmarkrating'
display_type = 'Bookmarkrating'
end
end
</pre>

'''Problem 4''': Remove hardcoded parameters, such as save_choice method
* '''Solution''': Hardcoded parameters are removed and necessary constants are defined.

===Test Plans===

Because the purpose of our project was to better arrange our code, it follows that we also needed to rearrange the tests for that code. We first divided the tests for questionnaires_controller into two test files, questionnaires_controller_spec and quiz_questionnaires_controller_spec and separated the tests for CRUD operations of quiz_questionnaires_controller into the quiz_questionnaires_controller_spec, renaming them from view_quiz, create_quiz and the like to view and create. After this separation of CRUD operation testing, we tested the functionality that we moved out of the controllers into the model including the validation method for the quiz questionnaire. We did not include tests to cover the existing model functions, nor did we test the new set_display_type or change_question_types functions as they are setter methods, which, according to our testing instruction are not worth testing.

The setup for testing was particularly troublesome for the deployment of this project. The tests did not run properly in RubyMine, so it was difficult to ensure they were set up properly, and none of the members of our group have any expertise in rspec testing.

===Testing from UI===

*The testing of the export feature is shown below:

[[File:Export_setup.png]]

[[File:Export_completed_successfully.png|center]]

*The successful creation of quiz is shown below:

[[File:Quiz created sucessfully.png|center]]

*The saving of question in a questionnaire is shown below:

[[File:Save question in review successfully.png]]

*The successful updating of questionnaire is shown below:

[[File:Updated questionnaire successfully.png|upright=0.75]]

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/Riounis/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1271 GitHub Pull Request]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2018 E1836 Refactor quiz questionnaires controller.rb

2018-11-10T02:13:46Z

Amishra6: /* Testing from UI */

==E1836. Refactoring quiz_questionnaires_controller.rb==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===
The following tasks were accomplished in this project:
* Created quiz_questionnaire_controller.rb
* Moved view_quiz, new_quiz, create_quiz_questionnaire, edit_quiz and update_quiz from questionnaires_controller.rb, to quiz_questionnaires_controller.rb, and renamed it as view, new, create, edit and update respectively.
* Refactored the the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* Replaced switch statements in questionnaires_controller.rb with subclass methods.
* Created models for the subclasses.
* Removed hardcoded parameters, such as save_choice method.
* Appropriate tests were written to test the code.

===Implementation===

'''Problem 1''': Create quiz_questionnaire_controller.rb and move some of the methods in the questionnaires_controller.rb to the new file created.
* '''Solution''': The methods view_quiz, new_quiz, create_quiz, edit_quiz and update_quiz in the questionnaires_controller.rb were the methods identified and moved into the quiz_questionnaire_controller.rb. They were respectively renamed as view, new, create, edit and update. The implementation of the newly created quiz_questionnaire_controller.rb can be seen below.
<pre>
class QuizQuestionnairesController < QuestionnairesController

#=========================================================================================================
# Separate methods for quiz questionnaire
#=========================================================================================================

# View a quiz questionnaire
def view
@questionnaire = Questionnaire.find(params[:id])
@participant = Participant.find(params[:pid]) # creating an instance variable since it needs to be sent to submitted_content/edit
render :view
end

# define a new quiz questionnaire
# method invoked by the view
def new
valid_request = true
@assignment_id = params[:aid] # creating an instance variable to hold the assignment id
@participant_id = params[:pid] # creating an instance variable to hold the participant id
assignment = Assignment.find(@assignment_id)
if !assignment.require_quiz? # flash error if this assignment does not require quiz
flash[:error] = "This assignment does not support the quizzing feature."
valid_request = false
else
team = AssignmentParticipant.find(@participant_id).team

if team.nil? # flash error if this current participant does not have a team
flash[:error] = "You should create or join a team first."
valid_request = false
else
if assignment.topics? && team.topic.nil? # flash error if this assignment has topic but current team does not have a topic
flash[:error] = "Your team should have a topic."
valid_request = false
end
end
end

if valid_request && Questionnaire::QUESTIONNAIRE_TYPES.include?(params[:model])
@questionnaire = Object.const_get(params[:model]).new
@questionnaire.private = params[:private]
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1

render :new
else
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end

# seperate method for creating a quiz questionnaire because of differences in permission
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

# edit a quiz questionnaire
def edit
@questionnaire = Questionnaire.find(params[:id])
if !@questionnaire.taken_by_anyone?
render :edit
else
flash[:error] = "Your quiz has been taken by some other students, you cannot edit it anymore."
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end
# save an updated quiz questionnaire to the database
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)

for qid in params[:question].keys
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save

@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
i = 1
for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end

end
</pre>

'''Problem 2''': Refactor the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* '''Solution''':
a. Deleted the create_questionnaire method and replaced the call to it in create_quiz_questionnaire with the code of create_questionnaire and is later moved to quiz_questionnaires_controller.rb and the code snippet below is used.

<pre>
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

</pre>

b. Moved the large block of for and if statements into method called change_question_types in the quiz_questionnaire model.

<pre>
def change_question_types(quiz_question_choice, type, id, i)

if type == "MultipleChoiceCheckbox"

if params[:quiz_question_choices][id.to_s][type][i.to_s]
quiz_question_choice.update_attributes(iscorrect: params[:quiz_question_choices][id.to_s][type][i.to_s][:iscorrect], txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][quiz_question_choice.id.to_s][:txt])
end
end

if type == "MultipleChoiceRadio"

if params[:quiz_question_choices][id.to_s][type][:correctindex] == i.to_s
quiz_question_choice.update_attributes(iscorrect: '1', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])
end
end

if type == "TrueFalse"

if params[:quiz_question_choices][id.to_s][type][1.to_s][:iscorrect] == "True" # the statement is correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is correct so "True" is the right answer

else
quiz_question_choice.update_attributes(iscorrect: '0')
end

else # the statement is not correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '0')

else
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is not correct so "False" is the right answer
end
end
end
end
</pre>

c. Replaced large block of for and if statements in update with a call to the new change_question_types method.

<pre>

for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
</pre>

d. Moved export, import, copy_questionnaire_details, and assign_instructor_id to questionaire model.

<pre>
def copy_questionnaire_details(questions, orig_questionnaire, id)
self.instructor_id = self.assign_instructor_id()
self.name = 'Copy of ' + orig_questionnaire.name

begin
self.created_at = Time.now
self.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = id
new_question.size = '50,3' if (new_question.is_a? Criterion or new_question.is_a? TextResponse) and new_question.size.nil?
new_question.save!
advices = QuestionAdvice.where(question_id: question.id)
next if advices.empty?
advices.each do |advice|
new_advice = advice.dup
new_advice.question_id = new_question.id
new_advice.save!
end
end

pFolder = TreeFolder.find_by(name: question.set_display_type(display_type))
parent = FolderNode.find_by(node_object_id: pFolder.id)
QuestionnaireNode.find_or_create_by(parent_id: parent.id, node_object_id: id)
undo_link("Copy of questionnaire #{orig_questionnaire.name} has been created successfully.")
redirect_to controller: 'questionnaires', action: 'view', id: @questionnaire.id
rescue StandardError
flash[:error] = 'The questionnaire was not able to be copied. Please check the original course for missing information.' + $ERROR_INFO
redirect_to action: 'list', controller: 'tree_display'
end
end

def export
@questionnaire = Questionnaire.find(params[:id])
csv_data = QuestionnaireHelper.create_questionnaire_csv @questionnaire, session[:user].name
send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=questionnaires.csv"
end

def import
@questionnaire = Questionnaire.find(params[:id])
file = params['csv']
@questionnaire.questions << QuestionnaireHelper.get_questions_from_csv(@questionnaire, file)
end

def assign_instructor_id
# if the user to copy the questionnaire is a TA, the instructor should be the owner instead of the TA
if session[:user].role.name != "Teaching Assistant"
session[:user].id
else # for TA we need to get his instructor id and by default add it to his course for which he is the TA
Ta.get_my_instructor(session[:user].id)
end
end
</pre>

3''': Replace switch statements with subclasses methods and create models for the subclasses.
* '''Solution''': Moved the switch-case statement from create in questionaire_controller.rb into a method called set_display_type in questionaire model. The following is the code snippet that shows the same.

<pre>

def set_dispay_type(display_type)

case display_type

when 'Review'
display_type = 'Review'

when 'Metareview'
display_type = 'Metareview'

when 'AuthorFeedback'
display_type = 'Author%Feedback'

when 'CourseSurvey'
display_type = 'Course%Survey'

when 'TeammateReview'
display_type = 'Teammate%Review'

when 'GlobalSurvey'
display_type = 'Global%Survey'

when 'AssignmentSurvey'
display_type = 'Assignment%Survey'

when 'Bookmarkrating'
display_type = 'Bookmarkrating'
end
end
</pre>

'''Problem 4''': Remove hardcoded parameters, such as save_choice method
* '''Solution''': Hardcoded parameters are removed and necessary constants are defined.

===Test Plans===

Because the purpose of our project was to better arrange our code, it follows that we also needed to rearrange the tests for that code. We first divided the tests for questionnaires_controller into two test files, questionnaires_controller_spec and quiz_questionnaires_controller_spec and separated the tests for CRUD operations of quiz_questionnaires_controller into the quiz_questionnaires_controller_spec, renaming them from view_quiz, create_quiz and the like to view and create. After this separation of CRUD operation testing, we tested the functionality that we moved out of the controllers into the model including the validation method for the quiz questionnaire. We did not include tests to cover the existing model functions, nor did we test the new set_display_type or change_question_types functions as they are setter methods, which, according to our testing instruction are not worth testing.

The setup for testing was particularly troublesome for the deployment of this project. The tests did not run properly in RubyMine, so it was difficult to ensure they were set up properly, and none of the members of our group have any expertise in rspec testing.

===Testing from UI===

*The testing of the export feature is shown below:

[[File:Export_setup.png]]

[[File:Export_completed_successfully.png|center]]

*The successful creation of quiz is shown below:

[[File:Quiz created sucessfully.png|center]]

*The saving of question in a questionnaire is shown below:

[[File:Save question in review successfully.png]]

*The successful updating of questionnaire is shown below:

[[File:Updated questionnaire successfully.png|1500px]]

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/Riounis/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1271 GitHub Pull Request]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2018 E1836 Refactor quiz questionnaires controller.rb

2018-11-10T02:13:25Z

Amishra6: /* Testing from UI */

==E1836. Refactoring quiz_questionnaires_controller.rb==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===
The following tasks were accomplished in this project:
* Created quiz_questionnaire_controller.rb
* Moved view_quiz, new_quiz, create_quiz_questionnaire, edit_quiz and update_quiz from questionnaires_controller.rb, to quiz_questionnaires_controller.rb, and renamed it as view, new, create, edit and update respectively.
* Refactored the the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* Replaced switch statements in questionnaires_controller.rb with subclass methods.
* Created models for the subclasses.
* Removed hardcoded parameters, such as save_choice method.
* Appropriate tests were written to test the code.

===Implementation===

'''Problem 1''': Create quiz_questionnaire_controller.rb and move some of the methods in the questionnaires_controller.rb to the new file created.
* '''Solution''': The methods view_quiz, new_quiz, create_quiz, edit_quiz and update_quiz in the questionnaires_controller.rb were the methods identified and moved into the quiz_questionnaire_controller.rb. They were respectively renamed as view, new, create, edit and update. The implementation of the newly created quiz_questionnaire_controller.rb can be seen below.
<pre>
class QuizQuestionnairesController < QuestionnairesController

#=========================================================================================================
# Separate methods for quiz questionnaire
#=========================================================================================================

# View a quiz questionnaire
def view
@questionnaire = Questionnaire.find(params[:id])
@participant = Participant.find(params[:pid]) # creating an instance variable since it needs to be sent to submitted_content/edit
render :view
end

# define a new quiz questionnaire
# method invoked by the view
def new
valid_request = true
@assignment_id = params[:aid] # creating an instance variable to hold the assignment id
@participant_id = params[:pid] # creating an instance variable to hold the participant id
assignment = Assignment.find(@assignment_id)
if !assignment.require_quiz? # flash error if this assignment does not require quiz
flash[:error] = "This assignment does not support the quizzing feature."
valid_request = false
else
team = AssignmentParticipant.find(@participant_id).team

if team.nil? # flash error if this current participant does not have a team
flash[:error] = "You should create or join a team first."
valid_request = false
else
if assignment.topics? && team.topic.nil? # flash error if this assignment has topic but current team does not have a topic
flash[:error] = "Your team should have a topic."
valid_request = false
end
end
end

if valid_request && Questionnaire::QUESTIONNAIRE_TYPES.include?(params[:model])
@questionnaire = Object.const_get(params[:model]).new
@questionnaire.private = params[:private]
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1

render :new
else
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end

# seperate method for creating a quiz questionnaire because of differences in permission
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

# edit a quiz questionnaire
def edit
@questionnaire = Questionnaire.find(params[:id])
if !@questionnaire.taken_by_anyone?
render :edit
else
flash[:error] = "Your quiz has been taken by some other students, you cannot edit it anymore."
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end
# save an updated quiz questionnaire to the database
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)

for qid in params[:question].keys
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save

@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
i = 1
for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end

end
</pre>

'''Problem 2''': Refactor the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* '''Solution''':
a. Deleted the create_questionnaire method and replaced the call to it in create_quiz_questionnaire with the code of create_questionnaire and is later moved to quiz_questionnaires_controller.rb and the code snippet below is used.

<pre>
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

</pre>

b. Moved the large block of for and if statements into method called change_question_types in the quiz_questionnaire model.

<pre>
def change_question_types(quiz_question_choice, type, id, i)

if type == "MultipleChoiceCheckbox"

if params[:quiz_question_choices][id.to_s][type][i.to_s]
quiz_question_choice.update_attributes(iscorrect: params[:quiz_question_choices][id.to_s][type][i.to_s][:iscorrect], txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][quiz_question_choice.id.to_s][:txt])
end
end

if type == "MultipleChoiceRadio"

if params[:quiz_question_choices][id.to_s][type][:correctindex] == i.to_s
quiz_question_choice.update_attributes(iscorrect: '1', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])
end
end

if type == "TrueFalse"

if params[:quiz_question_choices][id.to_s][type][1.to_s][:iscorrect] == "True" # the statement is correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is correct so "True" is the right answer

else
quiz_question_choice.update_attributes(iscorrect: '0')
end

else # the statement is not correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '0')

else
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is not correct so "False" is the right answer
end
end
end
end
</pre>

c. Replaced large block of for and if statements in update with a call to the new change_question_types method.

<pre>

for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
</pre>

d. Moved export, import, copy_questionnaire_details, and assign_instructor_id to questionaire model.

<pre>
def copy_questionnaire_details(questions, orig_questionnaire, id)
self.instructor_id = self.assign_instructor_id()
self.name = 'Copy of ' + orig_questionnaire.name

begin
self.created_at = Time.now
self.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = id
new_question.size = '50,3' if (new_question.is_a? Criterion or new_question.is_a? TextResponse) and new_question.size.nil?
new_question.save!
advices = QuestionAdvice.where(question_id: question.id)
next if advices.empty?
advices.each do |advice|
new_advice = advice.dup
new_advice.question_id = new_question.id
new_advice.save!
end
end

pFolder = TreeFolder.find_by(name: question.set_display_type(display_type))
parent = FolderNode.find_by(node_object_id: pFolder.id)
QuestionnaireNode.find_or_create_by(parent_id: parent.id, node_object_id: id)
undo_link("Copy of questionnaire #{orig_questionnaire.name} has been created successfully.")
redirect_to controller: 'questionnaires', action: 'view', id: @questionnaire.id
rescue StandardError
flash[:error] = 'The questionnaire was not able to be copied. Please check the original course for missing information.' + $ERROR_INFO
redirect_to action: 'list', controller: 'tree_display'
end
end

def export
@questionnaire = Questionnaire.find(params[:id])
csv_data = QuestionnaireHelper.create_questionnaire_csv @questionnaire, session[:user].name
send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=questionnaires.csv"
end

def import
@questionnaire = Questionnaire.find(params[:id])
file = params['csv']
@questionnaire.questions << QuestionnaireHelper.get_questions_from_csv(@questionnaire, file)
end

def assign_instructor_id
# if the user to copy the questionnaire is a TA, the instructor should be the owner instead of the TA
if session[:user].role.name != "Teaching Assistant"
session[:user].id
else # for TA we need to get his instructor id and by default add it to his course for which he is the TA
Ta.get_my_instructor(session[:user].id)
end
end
</pre>

3''': Replace switch statements with subclasses methods and create models for the subclasses.
* '''Solution''': Moved the switch-case statement from create in questionaire_controller.rb into a method called set_display_type in questionaire model. The following is the code snippet that shows the same.

<pre>

def set_dispay_type(display_type)

case display_type

when 'Review'
display_type = 'Review'

when 'Metareview'
display_type = 'Metareview'

when 'AuthorFeedback'
display_type = 'Author%Feedback'

when 'CourseSurvey'
display_type = 'Course%Survey'

when 'TeammateReview'
display_type = 'Teammate%Review'

when 'GlobalSurvey'
display_type = 'Global%Survey'

when 'AssignmentSurvey'
display_type = 'Assignment%Survey'

when 'Bookmarkrating'
display_type = 'Bookmarkrating'
end
end
</pre>

'''Problem 4''': Remove hardcoded parameters, such as save_choice method
* '''Solution''': Hardcoded parameters are removed and necessary constants are defined.

===Test Plans===

Because the purpose of our project was to better arrange our code, it follows that we also needed to rearrange the tests for that code. We first divided the tests for questionnaires_controller into two test files, questionnaires_controller_spec and quiz_questionnaires_controller_spec and separated the tests for CRUD operations of quiz_questionnaires_controller into the quiz_questionnaires_controller_spec, renaming them from view_quiz, create_quiz and the like to view and create. After this separation of CRUD operation testing, we tested the functionality that we moved out of the controllers into the model including the validation method for the quiz questionnaire. We did not include tests to cover the existing model functions, nor did we test the new set_display_type or change_question_types functions as they are setter methods, which, according to our testing instruction are not worth testing.

The setup for testing was particularly troublesome for the deployment of this project. The tests did not run properly in RubyMine, so it was difficult to ensure they were set up properly, and none of the members of our group have any expertise in rspec testing.

===Testing from UI===

*The testing of the export feature is shown below:

[[File:Export_setup.png]]

[[File:Export_completed_successfully.png|center]]

*The successful creation of quiz is shown below:

[[File:Quiz created sucessfully.png|center]]

*The saving of question in a questionnaire is shown below:

[[File:Save question in review successfully.png]]

*The successful updating of questionnaire is shown below:

[[File:Updated questionnaire successfully.png|1000px]]

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/Riounis/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1271 GitHub Pull Request]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2018 E1836 Refactor quiz questionnaires controller.rb

2018-11-10T02:11:18Z

Amishra6: /* References */

==E1836. Refactoring quiz_questionnaires_controller.rb==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===
The following tasks were accomplished in this project:
* Created quiz_questionnaire_controller.rb
* Moved view_quiz, new_quiz, create_quiz_questionnaire, edit_quiz and update_quiz from questionnaires_controller.rb, to quiz_questionnaires_controller.rb, and renamed it as view, new, create, edit and update respectively.
* Refactored the the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* Replaced switch statements in questionnaires_controller.rb with subclass methods.
* Created models for the subclasses.
* Removed hardcoded parameters, such as save_choice method.
* Appropriate tests were written to test the code.

===Implementation===

'''Problem 1''': Create quiz_questionnaire_controller.rb and move some of the methods in the questionnaires_controller.rb to the new file created.
* '''Solution''': The methods view_quiz, new_quiz, create_quiz, edit_quiz and update_quiz in the questionnaires_controller.rb were the methods identified and moved into the quiz_questionnaire_controller.rb. They were respectively renamed as view, new, create, edit and update. The implementation of the newly created quiz_questionnaire_controller.rb can be seen below.
<pre>
class QuizQuestionnairesController < QuestionnairesController

#=========================================================================================================
# Separate methods for quiz questionnaire
#=========================================================================================================

# View a quiz questionnaire
def view
@questionnaire = Questionnaire.find(params[:id])
@participant = Participant.find(params[:pid]) # creating an instance variable since it needs to be sent to submitted_content/edit
render :view
end

# define a new quiz questionnaire
# method invoked by the view
def new
valid_request = true
@assignment_id = params[:aid] # creating an instance variable to hold the assignment id
@participant_id = params[:pid] # creating an instance variable to hold the participant id
assignment = Assignment.find(@assignment_id)
if !assignment.require_quiz? # flash error if this assignment does not require quiz
flash[:error] = "This assignment does not support the quizzing feature."
valid_request = false
else
team = AssignmentParticipant.find(@participant_id).team

if team.nil? # flash error if this current participant does not have a team
flash[:error] = "You should create or join a team first."
valid_request = false
else
if assignment.topics? && team.topic.nil? # flash error if this assignment has topic but current team does not have a topic
flash[:error] = "Your team should have a topic."
valid_request = false
end
end
end

if valid_request && Questionnaire::QUESTIONNAIRE_TYPES.include?(params[:model])
@questionnaire = Object.const_get(params[:model]).new
@questionnaire.private = params[:private]
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1

render :new
else
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end

# seperate method for creating a quiz questionnaire because of differences in permission
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

# edit a quiz questionnaire
def edit
@questionnaire = Questionnaire.find(params[:id])
if !@questionnaire.taken_by_anyone?
render :edit
else
flash[:error] = "Your quiz has been taken by some other students, you cannot edit it anymore."
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end
# save an updated quiz questionnaire to the database
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)

for qid in params[:question].keys
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save

@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
i = 1
for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end

end
</pre>

'''Problem 2''': Refactor the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* '''Solution''':
a. Deleted the create_questionnaire method and replaced the call to it in create_quiz_questionnaire with the code of create_questionnaire and is later moved to quiz_questionnaires_controller.rb and the code snippet below is used.

<pre>
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

</pre>

b. Moved the large block of for and if statements into method called change_question_types in the quiz_questionnaire model.

<pre>
def change_question_types(quiz_question_choice, type, id, i)

if type == "MultipleChoiceCheckbox"

if params[:quiz_question_choices][id.to_s][type][i.to_s]
quiz_question_choice.update_attributes(iscorrect: params[:quiz_question_choices][id.to_s][type][i.to_s][:iscorrect], txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][quiz_question_choice.id.to_s][:txt])
end
end

if type == "MultipleChoiceRadio"

if params[:quiz_question_choices][id.to_s][type][:correctindex] == i.to_s
quiz_question_choice.update_attributes(iscorrect: '1', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])
end
end

if type == "TrueFalse"

if params[:quiz_question_choices][id.to_s][type][1.to_s][:iscorrect] == "True" # the statement is correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is correct so "True" is the right answer

else
quiz_question_choice.update_attributes(iscorrect: '0')
end

else # the statement is not correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '0')

else
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is not correct so "False" is the right answer
end
end
end
end
</pre>

c. Replaced large block of for and if statements in update with a call to the new change_question_types method.

<pre>

for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
</pre>

d. Moved export, import, copy_questionnaire_details, and assign_instructor_id to questionaire model.

<pre>
def copy_questionnaire_details(questions, orig_questionnaire, id)
self.instructor_id = self.assign_instructor_id()
self.name = 'Copy of ' + orig_questionnaire.name

begin
self.created_at = Time.now
self.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = id
new_question.size = '50,3' if (new_question.is_a? Criterion or new_question.is_a? TextResponse) and new_question.size.nil?
new_question.save!
advices = QuestionAdvice.where(question_id: question.id)
next if advices.empty?
advices.each do |advice|
new_advice = advice.dup
new_advice.question_id = new_question.id
new_advice.save!
end
end

pFolder = TreeFolder.find_by(name: question.set_display_type(display_type))
parent = FolderNode.find_by(node_object_id: pFolder.id)
QuestionnaireNode.find_or_create_by(parent_id: parent.id, node_object_id: id)
undo_link("Copy of questionnaire #{orig_questionnaire.name} has been created successfully.")
redirect_to controller: 'questionnaires', action: 'view', id: @questionnaire.id
rescue StandardError
flash[:error] = 'The questionnaire was not able to be copied. Please check the original course for missing information.' + $ERROR_INFO
redirect_to action: 'list', controller: 'tree_display'
end
end

def export
@questionnaire = Questionnaire.find(params[:id])
csv_data = QuestionnaireHelper.create_questionnaire_csv @questionnaire, session[:user].name
send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=questionnaires.csv"
end

def import
@questionnaire = Questionnaire.find(params[:id])
file = params['csv']
@questionnaire.questions << QuestionnaireHelper.get_questions_from_csv(@questionnaire, file)
end

def assign_instructor_id
# if the user to copy the questionnaire is a TA, the instructor should be the owner instead of the TA
if session[:user].role.name != "Teaching Assistant"
session[:user].id
else # for TA we need to get his instructor id and by default add it to his course for which he is the TA
Ta.get_my_instructor(session[:user].id)
end
end
</pre>

3''': Replace switch statements with subclasses methods and create models for the subclasses.
* '''Solution''': Moved the switch-case statement from create in questionaire_controller.rb into a method called set_display_type in questionaire model. The following is the code snippet that shows the same.

<pre>

def set_dispay_type(display_type)

case display_type

when 'Review'
display_type = 'Review'

when 'Metareview'
display_type = 'Metareview'

when 'AuthorFeedback'
display_type = 'Author%Feedback'

when 'CourseSurvey'
display_type = 'Course%Survey'

when 'TeammateReview'
display_type = 'Teammate%Review'

when 'GlobalSurvey'
display_type = 'Global%Survey'

when 'AssignmentSurvey'
display_type = 'Assignment%Survey'

when 'Bookmarkrating'
display_type = 'Bookmarkrating'
end
end
</pre>

'''Problem 4''': Remove hardcoded parameters, such as save_choice method
* '''Solution''': Hardcoded parameters are removed and necessary constants are defined.

===Test Plans===

Because the purpose of our project was to better arrange our code, it follows that we also needed to rearrange the tests for that code. We first divided the tests for questionnaires_controller into two test files, questionnaires_controller_spec and quiz_questionnaires_controller_spec and separated the tests for CRUD operations of quiz_questionnaires_controller into the quiz_questionnaires_controller_spec, renaming them from view_quiz, create_quiz and the like to view and create. After this separation of CRUD operation testing, we tested the functionality that we moved out of the controllers into the model including the validation method for the quiz questionnaire. We did not include tests to cover the existing model functions, nor did we test the new set_display_type or change_question_types functions as they are setter methods, which, according to our testing instruction are not worth testing.

The setup for testing was particularly troublesome for the deployment of this project. The tests did not run properly in RubyMine, so it was difficult to ensure they were set up properly, and none of the members of our group have any expertise in rspec testing.

===Testing from UI===

*The testing of the export feature is shown below:

[[File:Export_setup.png]]

[[File:Export_completed_successfully.png]]

*The successful creation of quiz is shown below:

[[File:Quiz created sucessfully.png]]

*The saving of question in a questionnaire is shown below:

[[File:Save question in review successfully.png]]

*The successful updating of questionnaire is shown below:

[[File:Updated questionnaire successfully.png|center]]

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/Riounis/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1271 GitHub Pull Request]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2018 E1836 Refactor quiz questionnaires controller.rb

2018-11-10T02:11:05Z

Amishra6: /* Testing from UI */

==E1836. Refactoring quiz_questionnaires_controller.rb==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===
The following tasks were accomplished in this project:
* Created quiz_questionnaire_controller.rb
* Moved view_quiz, new_quiz, create_quiz_questionnaire, edit_quiz and update_quiz from questionnaires_controller.rb, to quiz_questionnaires_controller.rb, and renamed it as view, new, create, edit and update respectively.
* Refactored the the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* Replaced switch statements in questionnaires_controller.rb with subclass methods.
* Created models for the subclasses.
* Removed hardcoded parameters, such as save_choice method.
* Appropriate tests were written to test the code.

===Implementation===

'''Problem 1''': Create quiz_questionnaire_controller.rb and move some of the methods in the questionnaires_controller.rb to the new file created.
* '''Solution''': The methods view_quiz, new_quiz, create_quiz, edit_quiz and update_quiz in the questionnaires_controller.rb were the methods identified and moved into the quiz_questionnaire_controller.rb. They were respectively renamed as view, new, create, edit and update. The implementation of the newly created quiz_questionnaire_controller.rb can be seen below.
<pre>
class QuizQuestionnairesController < QuestionnairesController

#=========================================================================================================
# Separate methods for quiz questionnaire
#=========================================================================================================

# View a quiz questionnaire
def view
@questionnaire = Questionnaire.find(params[:id])
@participant = Participant.find(params[:pid]) # creating an instance variable since it needs to be sent to submitted_content/edit
render :view
end

# define a new quiz questionnaire
# method invoked by the view
def new
valid_request = true
@assignment_id = params[:aid] # creating an instance variable to hold the assignment id
@participant_id = params[:pid] # creating an instance variable to hold the participant id
assignment = Assignment.find(@assignment_id)
if !assignment.require_quiz? # flash error if this assignment does not require quiz
flash[:error] = "This assignment does not support the quizzing feature."
valid_request = false
else
team = AssignmentParticipant.find(@participant_id).team

if team.nil? # flash error if this current participant does not have a team
flash[:error] = "You should create or join a team first."
valid_request = false
else
if assignment.topics? && team.topic.nil? # flash error if this assignment has topic but current team does not have a topic
flash[:error] = "Your team should have a topic."
valid_request = false
end
end
end

if valid_request && Questionnaire::QUESTIONNAIRE_TYPES.include?(params[:model])
@questionnaire = Object.const_get(params[:model]).new
@questionnaire.private = params[:private]
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1

render :new
else
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end

# seperate method for creating a quiz questionnaire because of differences in permission
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

# edit a quiz questionnaire
def edit
@questionnaire = Questionnaire.find(params[:id])
if !@questionnaire.taken_by_anyone?
render :edit
else
flash[:error] = "Your quiz has been taken by some other students, you cannot edit it anymore."
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end
# save an updated quiz questionnaire to the database
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)

for qid in params[:question].keys
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save

@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
i = 1
for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end

end
</pre>

'''Problem 2''': Refactor the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* '''Solution''':
a. Deleted the create_questionnaire method and replaced the call to it in create_quiz_questionnaire with the code of create_questionnaire and is later moved to quiz_questionnaires_controller.rb and the code snippet below is used.

<pre>
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

</pre>

b. Moved the large block of for and if statements into method called change_question_types in the quiz_questionnaire model.

<pre>
def change_question_types(quiz_question_choice, type, id, i)

if type == "MultipleChoiceCheckbox"

if params[:quiz_question_choices][id.to_s][type][i.to_s]
quiz_question_choice.update_attributes(iscorrect: params[:quiz_question_choices][id.to_s][type][i.to_s][:iscorrect], txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][quiz_question_choice.id.to_s][:txt])
end
end

if type == "MultipleChoiceRadio"

if params[:quiz_question_choices][id.to_s][type][:correctindex] == i.to_s
quiz_question_choice.update_attributes(iscorrect: '1', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])
end
end

if type == "TrueFalse"

if params[:quiz_question_choices][id.to_s][type][1.to_s][:iscorrect] == "True" # the statement is correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is correct so "True" is the right answer

else
quiz_question_choice.update_attributes(iscorrect: '0')
end

else # the statement is not correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '0')

else
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is not correct so "False" is the right answer
end
end
end
end
</pre>

c. Replaced large block of for and if statements in update with a call to the new change_question_types method.

<pre>

for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
</pre>

d. Moved export, import, copy_questionnaire_details, and assign_instructor_id to questionaire model.

<pre>
def copy_questionnaire_details(questions, orig_questionnaire, id)
self.instructor_id = self.assign_instructor_id()
self.name = 'Copy of ' + orig_questionnaire.name

begin
self.created_at = Time.now
self.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = id
new_question.size = '50,3' if (new_question.is_a? Criterion or new_question.is_a? TextResponse) and new_question.size.nil?
new_question.save!
advices = QuestionAdvice.where(question_id: question.id)
next if advices.empty?
advices.each do |advice|
new_advice = advice.dup
new_advice.question_id = new_question.id
new_advice.save!
end
end

pFolder = TreeFolder.find_by(name: question.set_display_type(display_type))
parent = FolderNode.find_by(node_object_id: pFolder.id)
QuestionnaireNode.find_or_create_by(parent_id: parent.id, node_object_id: id)
undo_link("Copy of questionnaire #{orig_questionnaire.name} has been created successfully.")
redirect_to controller: 'questionnaires', action: 'view', id: @questionnaire.id
rescue StandardError
flash[:error] = 'The questionnaire was not able to be copied. Please check the original course for missing information.' + $ERROR_INFO
redirect_to action: 'list', controller: 'tree_display'
end
end

def export
@questionnaire = Questionnaire.find(params[:id])
csv_data = QuestionnaireHelper.create_questionnaire_csv @questionnaire, session[:user].name
send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=questionnaires.csv"
end

def import
@questionnaire = Questionnaire.find(params[:id])
file = params['csv']
@questionnaire.questions << QuestionnaireHelper.get_questions_from_csv(@questionnaire, file)
end

def assign_instructor_id
# if the user to copy the questionnaire is a TA, the instructor should be the owner instead of the TA
if session[:user].role.name != "Teaching Assistant"
session[:user].id
else # for TA we need to get his instructor id and by default add it to his course for which he is the TA
Ta.get_my_instructor(session[:user].id)
end
end
</pre>

3''': Replace switch statements with subclasses methods and create models for the subclasses.
* '''Solution''': Moved the switch-case statement from create in questionaire_controller.rb into a method called set_display_type in questionaire model. The following is the code snippet that shows the same.

<pre>

def set_dispay_type(display_type)

case display_type

when 'Review'
display_type = 'Review'

when 'Metareview'
display_type = 'Metareview'

when 'AuthorFeedback'
display_type = 'Author%Feedback'

when 'CourseSurvey'
display_type = 'Course%Survey'

when 'TeammateReview'
display_type = 'Teammate%Review'

when 'GlobalSurvey'
display_type = 'Global%Survey'

when 'AssignmentSurvey'
display_type = 'Assignment%Survey'

when 'Bookmarkrating'
display_type = 'Bookmarkrating'
end
end
</pre>

'''Problem 4''': Remove hardcoded parameters, such as save_choice method
* '''Solution''': Hardcoded parameters are removed and necessary constants are defined.

===Test Plans===

Because the purpose of our project was to better arrange our code, it follows that we also needed to rearrange the tests for that code. We first divided the tests for questionnaires_controller into two test files, questionnaires_controller_spec and quiz_questionnaires_controller_spec and separated the tests for CRUD operations of quiz_questionnaires_controller into the quiz_questionnaires_controller_spec, renaming them from view_quiz, create_quiz and the like to view and create. After this separation of CRUD operation testing, we tested the functionality that we moved out of the controllers into the model including the validation method for the quiz questionnaire. We did not include tests to cover the existing model functions, nor did we test the new set_display_type or change_question_types functions as they are setter methods, which, according to our testing instruction are not worth testing.

The setup for testing was particularly troublesome for the deployment of this project. The tests did not run properly in RubyMine, so it was difficult to ensure they were set up properly, and none of the members of our group have any expertise in rspec testing.

===Testing from UI===

*The testing of the export feature is shown below:

[[File:Export_setup.png]]

[[File:Export_completed_successfully.png]]

*The successful creation of quiz is shown below:

[[File:Quiz created sucessfully.png]]

*The saving of question in a questionnaire is shown below:

[[File:Save question in review successfully.png]]

*The successful updating of questionnaire is shown below:

[[File:Updated questionnaire successfully.png|center]]

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/Riounis/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1271 GitHub Pull Request]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2018 E1836 Refactor quiz questionnaires controller.rb

2018-11-10T02:07:16Z

Amishra6: /* Testing from UI */

==E1836. Refactoring quiz_questionnaires_controller.rb==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===
The following tasks were accomplished in this project:
* Created quiz_questionnaire_controller.rb
* Moved view_quiz, new_quiz, create_quiz_questionnaire, edit_quiz and update_quiz from questionnaires_controller.rb, to quiz_questionnaires_controller.rb, and renamed it as view, new, create, edit and update respectively.
* Refactored the the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* Replaced switch statements in questionnaires_controller.rb with subclass methods.
* Created models for the subclasses.
* Removed hardcoded parameters, such as save_choice method.
* Appropriate tests were written to test the code.

===Implementation===

'''Problem 1''': Create quiz_questionnaire_controller.rb and move some of the methods in the questionnaires_controller.rb to the new file created.
* '''Solution''': The methods view_quiz, new_quiz, create_quiz, edit_quiz and update_quiz in the questionnaires_controller.rb were the methods identified and moved into the quiz_questionnaire_controller.rb. They were respectively renamed as view, new, create, edit and update. The implementation of the newly created quiz_questionnaire_controller.rb can be seen below.
<pre>
class QuizQuestionnairesController < QuestionnairesController

#=========================================================================================================
# Separate methods for quiz questionnaire
#=========================================================================================================

# View a quiz questionnaire
def view
@questionnaire = Questionnaire.find(params[:id])
@participant = Participant.find(params[:pid]) # creating an instance variable since it needs to be sent to submitted_content/edit
render :view
end

# define a new quiz questionnaire
# method invoked by the view
def new
valid_request = true
@assignment_id = params[:aid] # creating an instance variable to hold the assignment id
@participant_id = params[:pid] # creating an instance variable to hold the participant id
assignment = Assignment.find(@assignment_id)
if !assignment.require_quiz? # flash error if this assignment does not require quiz
flash[:error] = "This assignment does not support the quizzing feature."
valid_request = false
else
team = AssignmentParticipant.find(@participant_id).team

if team.nil? # flash error if this current participant does not have a team
flash[:error] = "You should create or join a team first."
valid_request = false
else
if assignment.topics? && team.topic.nil? # flash error if this assignment has topic but current team does not have a topic
flash[:error] = "Your team should have a topic."
valid_request = false
end
end
end

if valid_request && Questionnaire::QUESTIONNAIRE_TYPES.include?(params[:model])
@questionnaire = Object.const_get(params[:model]).new
@questionnaire.private = params[:private]
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1

render :new
else
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end

# seperate method for creating a quiz questionnaire because of differences in permission
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

# edit a quiz questionnaire
def edit
@questionnaire = Questionnaire.find(params[:id])
if !@questionnaire.taken_by_anyone?
render :edit
else
flash[:error] = "Your quiz has been taken by some other students, you cannot edit it anymore."
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end
# save an updated quiz questionnaire to the database
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)

for qid in params[:question].keys
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save

@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
i = 1
for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end

end
</pre>

'''Problem 2''': Refactor the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* '''Solution''':
a. Deleted the create_questionnaire method and replaced the call to it in create_quiz_questionnaire with the code of create_questionnaire and is later moved to quiz_questionnaires_controller.rb and the code snippet below is used.

<pre>
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

</pre>

b. Moved the large block of for and if statements into method called change_question_types in the quiz_questionnaire model.

<pre>
def change_question_types(quiz_question_choice, type, id, i)

if type == "MultipleChoiceCheckbox"

if params[:quiz_question_choices][id.to_s][type][i.to_s]
quiz_question_choice.update_attributes(iscorrect: params[:quiz_question_choices][id.to_s][type][i.to_s][:iscorrect], txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][quiz_question_choice.id.to_s][:txt])
end
end

if type == "MultipleChoiceRadio"

if params[:quiz_question_choices][id.to_s][type][:correctindex] == i.to_s
quiz_question_choice.update_attributes(iscorrect: '1', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])
end
end

if type == "TrueFalse"

if params[:quiz_question_choices][id.to_s][type][1.to_s][:iscorrect] == "True" # the statement is correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is correct so "True" is the right answer

else
quiz_question_choice.update_attributes(iscorrect: '0')
end

else # the statement is not correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '0')

else
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is not correct so "False" is the right answer
end
end
end
end
</pre>

c. Replaced large block of for and if statements in update with a call to the new change_question_types method.

<pre>

for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
</pre>

d. Moved export, import, copy_questionnaire_details, and assign_instructor_id to questionaire model.

<pre>
def copy_questionnaire_details(questions, orig_questionnaire, id)
self.instructor_id = self.assign_instructor_id()
self.name = 'Copy of ' + orig_questionnaire.name

begin
self.created_at = Time.now
self.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = id
new_question.size = '50,3' if (new_question.is_a? Criterion or new_question.is_a? TextResponse) and new_question.size.nil?
new_question.save!
advices = QuestionAdvice.where(question_id: question.id)
next if advices.empty?
advices.each do |advice|
new_advice = advice.dup
new_advice.question_id = new_question.id
new_advice.save!
end
end

pFolder = TreeFolder.find_by(name: question.set_display_type(display_type))
parent = FolderNode.find_by(node_object_id: pFolder.id)
QuestionnaireNode.find_or_create_by(parent_id: parent.id, node_object_id: id)
undo_link("Copy of questionnaire #{orig_questionnaire.name} has been created successfully.")
redirect_to controller: 'questionnaires', action: 'view', id: @questionnaire.id
rescue StandardError
flash[:error] = 'The questionnaire was not able to be copied. Please check the original course for missing information.' + $ERROR_INFO
redirect_to action: 'list', controller: 'tree_display'
end
end

def export
@questionnaire = Questionnaire.find(params[:id])
csv_data = QuestionnaireHelper.create_questionnaire_csv @questionnaire, session[:user].name
send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=questionnaires.csv"
end

def import
@questionnaire = Questionnaire.find(params[:id])
file = params['csv']
@questionnaire.questions << QuestionnaireHelper.get_questions_from_csv(@questionnaire, file)
end

def assign_instructor_id
# if the user to copy the questionnaire is a TA, the instructor should be the owner instead of the TA
if session[:user].role.name != "Teaching Assistant"
session[:user].id
else # for TA we need to get his instructor id and by default add it to his course for which he is the TA
Ta.get_my_instructor(session[:user].id)
end
end
</pre>

3''': Replace switch statements with subclasses methods and create models for the subclasses.
* '''Solution''': Moved the switch-case statement from create in questionaire_controller.rb into a method called set_display_type in questionaire model. The following is the code snippet that shows the same.

<pre>

def set_dispay_type(display_type)

case display_type

when 'Review'
display_type = 'Review'

when 'Metareview'
display_type = 'Metareview'

when 'AuthorFeedback'
display_type = 'Author%Feedback'

when 'CourseSurvey'
display_type = 'Course%Survey'

when 'TeammateReview'
display_type = 'Teammate%Review'

when 'GlobalSurvey'
display_type = 'Global%Survey'

when 'AssignmentSurvey'
display_type = 'Assignment%Survey'

when 'Bookmarkrating'
display_type = 'Bookmarkrating'
end
end
</pre>

'''Problem 4''': Remove hardcoded parameters, such as save_choice method
* '''Solution''': Hardcoded parameters are removed and necessary constants are defined.

===Test Plans===

Because the purpose of our project was to better arrange our code, it follows that we also needed to rearrange the tests for that code. We first divided the tests for questionnaires_controller into two test files, questionnaires_controller_spec and quiz_questionnaires_controller_spec and separated the tests for CRUD operations of quiz_questionnaires_controller into the quiz_questionnaires_controller_spec, renaming them from view_quiz, create_quiz and the like to view and create. After this separation of CRUD operation testing, we tested the functionality that we moved out of the controllers into the model including the validation method for the quiz questionnaire. We did not include tests to cover the existing model functions, nor did we test the new set_display_type or change_question_types functions as they are setter methods, which, according to our testing instruction are not worth testing.

The setup for testing was particularly troublesome for the deployment of this project. The tests did not run properly in RubyMine, so it was difficult to ensure they were set up properly, and none of the members of our group have any expertise in rspec testing.

===Testing from UI===

*The testing of the export feature is shown below:

[[File:Export_setup.png]]

[[File:Export_completed_successfully.png]]

*The successful creation of quiz is shown below:

[[File:Quiz created sucessfully.png]]

*The saving of question in a questionnaire is shown below:

[[File:Save question in review successfully.png]]

*The successful updating of questionnaire is shown below:

[[File:Updated questionnaire successfully.png]]

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/Riounis/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1271 GitHub Pull Request]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

File:Updated questionnaire successfully.png

2018-11-10T02:05:53Z

Amishra6:

File:Save question in review successfully.png

2018-11-10T02:05:43Z

Amishra6:

File:Quiz created sucessfully.png

2018-11-10T02:05:29Z

Amishra6:

CSC/ECE 517 Fall 2018 E1836 Refactor quiz questionnaires controller.rb

2018-11-10T02:05:13Z

Amishra6: /* Testing from UI */

==E1836. Refactoring quiz_questionnaires_controller.rb==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===
The following tasks were accomplished in this project:
* Created quiz_questionnaire_controller.rb
* Moved view_quiz, new_quiz, create_quiz_questionnaire, edit_quiz and update_quiz from questionnaires_controller.rb, to quiz_questionnaires_controller.rb, and renamed it as view, new, create, edit and update respectively.
* Refactored the the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* Replaced switch statements in questionnaires_controller.rb with subclass methods.
* Created models for the subclasses.
* Removed hardcoded parameters, such as save_choice method.
* Appropriate tests were written to test the code.

===Implementation===

'''Problem 1''': Create quiz_questionnaire_controller.rb and move some of the methods in the questionnaires_controller.rb to the new file created.
* '''Solution''': The methods view_quiz, new_quiz, create_quiz, edit_quiz and update_quiz in the questionnaires_controller.rb were the methods identified and moved into the quiz_questionnaire_controller.rb. They were respectively renamed as view, new, create, edit and update. The implementation of the newly created quiz_questionnaire_controller.rb can be seen below.
<pre>
class QuizQuestionnairesController < QuestionnairesController

#=========================================================================================================
# Separate methods for quiz questionnaire
#=========================================================================================================

# View a quiz questionnaire
def view
@questionnaire = Questionnaire.find(params[:id])
@participant = Participant.find(params[:pid]) # creating an instance variable since it needs to be sent to submitted_content/edit
render :view
end

# define a new quiz questionnaire
# method invoked by the view
def new
valid_request = true
@assignment_id = params[:aid] # creating an instance variable to hold the assignment id
@participant_id = params[:pid] # creating an instance variable to hold the participant id
assignment = Assignment.find(@assignment_id)
if !assignment.require_quiz? # flash error if this assignment does not require quiz
flash[:error] = "This assignment does not support the quizzing feature."
valid_request = false
else
team = AssignmentParticipant.find(@participant_id).team

if team.nil? # flash error if this current participant does not have a team
flash[:error] = "You should create or join a team first."
valid_request = false
else
if assignment.topics? && team.topic.nil? # flash error if this assignment has topic but current team does not have a topic
flash[:error] = "Your team should have a topic."
valid_request = false
end
end
end

if valid_request && Questionnaire::QUESTIONNAIRE_TYPES.include?(params[:model])
@questionnaire = Object.const_get(params[:model]).new
@questionnaire.private = params[:private]
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1

render :new
else
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end

# seperate method for creating a quiz questionnaire because of differences in permission
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

# edit a quiz questionnaire
def edit
@questionnaire = Questionnaire.find(params[:id])
if !@questionnaire.taken_by_anyone?
render :edit
else
flash[:error] = "Your quiz has been taken by some other students, you cannot edit it anymore."
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end
# save an updated quiz questionnaire to the database
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)

for qid in params[:question].keys
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save

@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
i = 1
for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end

end
</pre>

'''Problem 2''': Refactor the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* '''Solution''':
a. Deleted the create_questionnaire method and replaced the call to it in create_quiz_questionnaire with the code of create_questionnaire and is later moved to quiz_questionnaires_controller.rb and the code snippet below is used.

<pre>
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

</pre>

b. Moved the large block of for and if statements into method called change_question_types in the quiz_questionnaire model.

<pre>
def change_question_types(quiz_question_choice, type, id, i)

if type == "MultipleChoiceCheckbox"

if params[:quiz_question_choices][id.to_s][type][i.to_s]
quiz_question_choice.update_attributes(iscorrect: params[:quiz_question_choices][id.to_s][type][i.to_s][:iscorrect], txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][quiz_question_choice.id.to_s][:txt])
end
end

if type == "MultipleChoiceRadio"

if params[:quiz_question_choices][id.to_s][type][:correctindex] == i.to_s
quiz_question_choice.update_attributes(iscorrect: '1', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])
end
end

if type == "TrueFalse"

if params[:quiz_question_choices][id.to_s][type][1.to_s][:iscorrect] == "True" # the statement is correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is correct so "True" is the right answer

else
quiz_question_choice.update_attributes(iscorrect: '0')
end

else # the statement is not correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '0')

else
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is not correct so "False" is the right answer
end
end
end
end
</pre>

c. Replaced large block of for and if statements in update with a call to the new change_question_types method.

<pre>

for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
</pre>

d. Moved export, import, copy_questionnaire_details, and assign_instructor_id to questionaire model.

<pre>
def copy_questionnaire_details(questions, orig_questionnaire, id)
self.instructor_id = self.assign_instructor_id()
self.name = 'Copy of ' + orig_questionnaire.name

begin
self.created_at = Time.now
self.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = id
new_question.size = '50,3' if (new_question.is_a? Criterion or new_question.is_a? TextResponse) and new_question.size.nil?
new_question.save!
advices = QuestionAdvice.where(question_id: question.id)
next if advices.empty?
advices.each do |advice|
new_advice = advice.dup
new_advice.question_id = new_question.id
new_advice.save!
end
end

pFolder = TreeFolder.find_by(name: question.set_display_type(display_type))
parent = FolderNode.find_by(node_object_id: pFolder.id)
QuestionnaireNode.find_or_create_by(parent_id: parent.id, node_object_id: id)
undo_link("Copy of questionnaire #{orig_questionnaire.name} has been created successfully.")
redirect_to controller: 'questionnaires', action: 'view', id: @questionnaire.id
rescue StandardError
flash[:error] = 'The questionnaire was not able to be copied. Please check the original course for missing information.' + $ERROR_INFO
redirect_to action: 'list', controller: 'tree_display'
end
end

def export
@questionnaire = Questionnaire.find(params[:id])
csv_data = QuestionnaireHelper.create_questionnaire_csv @questionnaire, session[:user].name
send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=questionnaires.csv"
end

def import
@questionnaire = Questionnaire.find(params[:id])
file = params['csv']
@questionnaire.questions << QuestionnaireHelper.get_questions_from_csv(@questionnaire, file)
end

def assign_instructor_id
# if the user to copy the questionnaire is a TA, the instructor should be the owner instead of the TA
if session[:user].role.name != "Teaching Assistant"
session[:user].id
else # for TA we need to get his instructor id and by default add it to his course for which he is the TA
Ta.get_my_instructor(session[:user].id)
end
end
</pre>

3''': Replace switch statements with subclasses methods and create models for the subclasses.
* '''Solution''': Moved the switch-case statement from create in questionaire_controller.rb into a method called set_display_type in questionaire model. The following is the code snippet that shows the same.

<pre>

def set_dispay_type(display_type)

case display_type

when 'Review'
display_type = 'Review'

when 'Metareview'
display_type = 'Metareview'

when 'AuthorFeedback'
display_type = 'Author%Feedback'

when 'CourseSurvey'
display_type = 'Course%Survey'

when 'TeammateReview'
display_type = 'Teammate%Review'

when 'GlobalSurvey'
display_type = 'Global%Survey'

when 'AssignmentSurvey'
display_type = 'Assignment%Survey'

when 'Bookmarkrating'
display_type = 'Bookmarkrating'
end
end
</pre>

'''Problem 4''': Remove hardcoded parameters, such as save_choice method
* '''Solution''': Hardcoded parameters are removed and necessary constants are defined.

===Test Plans===

Because the purpose of our project was to better arrange our code, it follows that we also needed to rearrange the tests for that code. We first divided the tests for questionnaires_controller into two test files, questionnaires_controller_spec and quiz_questionnaires_controller_spec and separated the tests for CRUD operations of quiz_questionnaires_controller into the quiz_questionnaires_controller_spec, renaming them from view_quiz, create_quiz and the like to view and create. After this separation of CRUD operation testing, we tested the functionality that we moved out of the controllers into the model including the validation method for the quiz questionnaire. We did not include tests to cover the existing model functions, nor did we test the new set_display_type or change_question_types functions as they are setter methods, which, according to our testing instruction are not worth testing.

The setup for testing was particularly troublesome for the deployment of this project. The tests did not run properly in RubyMine, so it was difficult to ensure they were set up properly, and none of the members of our group have any expertise in rspec testing.

===Testing from UI===

The testing of the export feature is shown below:

[[File:Export_setup.png]]

[[File:Export_completed_successfully.png]]

The successful creation of quiz is shown below:

[[File:Quiz created sucessfully.png]]

The saving of question in a questionnaire is shown below:

[[File:Save question in review successfully.png]]

The successful updating of questionnaire is shown below:

[[File:Updated questionnaire successfully.png]]

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/Riounis/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1271 GitHub Pull Request]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2018 E1836 Refactor quiz questionnaires controller.rb

2018-11-10T02:01:03Z

Amishra6: /* Testing from UI */

==E1836. Refactoring quiz_questionnaires_controller.rb==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===
The following tasks were accomplished in this project:
* Created quiz_questionnaire_controller.rb
* Moved view_quiz, new_quiz, create_quiz_questionnaire, edit_quiz and update_quiz from questionnaires_controller.rb, to quiz_questionnaires_controller.rb, and renamed it as view, new, create, edit and update respectively.
* Refactored the the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* Replaced switch statements in questionnaires_controller.rb with subclass methods.
* Created models for the subclasses.
* Removed hardcoded parameters, such as save_choice method.
* Appropriate tests were written to test the code.

===Implementation===

'''Problem 1''': Create quiz_questionnaire_controller.rb and move some of the methods in the questionnaires_controller.rb to the new file created.
* '''Solution''': The methods view_quiz, new_quiz, create_quiz, edit_quiz and update_quiz in the questionnaires_controller.rb were the methods identified and moved into the quiz_questionnaire_controller.rb. They were respectively renamed as view, new, create, edit and update. The implementation of the newly created quiz_questionnaire_controller.rb can be seen below.
<pre>
class QuizQuestionnairesController < QuestionnairesController

#=========================================================================================================
# Separate methods for quiz questionnaire
#=========================================================================================================

# View a quiz questionnaire
def view
@questionnaire = Questionnaire.find(params[:id])
@participant = Participant.find(params[:pid]) # creating an instance variable since it needs to be sent to submitted_content/edit
render :view
end

# define a new quiz questionnaire
# method invoked by the view
def new
valid_request = true
@assignment_id = params[:aid] # creating an instance variable to hold the assignment id
@participant_id = params[:pid] # creating an instance variable to hold the participant id
assignment = Assignment.find(@assignment_id)
if !assignment.require_quiz? # flash error if this assignment does not require quiz
flash[:error] = "This assignment does not support the quizzing feature."
valid_request = false
else
team = AssignmentParticipant.find(@participant_id).team

if team.nil? # flash error if this current participant does not have a team
flash[:error] = "You should create or join a team first."
valid_request = false
else
if assignment.topics? && team.topic.nil? # flash error if this assignment has topic but current team does not have a topic
flash[:error] = "Your team should have a topic."
valid_request = false
end
end
end

if valid_request && Questionnaire::QUESTIONNAIRE_TYPES.include?(params[:model])
@questionnaire = Object.const_get(params[:model]).new
@questionnaire.private = params[:private]
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1

render :new
else
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end

# seperate method for creating a quiz questionnaire because of differences in permission
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

# edit a quiz questionnaire
def edit
@questionnaire = Questionnaire.find(params[:id])
if !@questionnaire.taken_by_anyone?
render :edit
else
flash[:error] = "Your quiz has been taken by some other students, you cannot edit it anymore."
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end
# save an updated quiz questionnaire to the database
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)

for qid in params[:question].keys
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save

@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
i = 1
for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end

end
</pre>

'''Problem 2''': Refactor the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* '''Solution''':
a. Deleted the create_questionnaire method and replaced the call to it in create_quiz_questionnaire with the code of create_questionnaire and is later moved to quiz_questionnaires_controller.rb and the code snippet below is used.

<pre>
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

</pre>

b. Moved the large block of for and if statements into method called change_question_types in the quiz_questionnaire model.

<pre>
def change_question_types(quiz_question_choice, type, id, i)

if type == "MultipleChoiceCheckbox"

if params[:quiz_question_choices][id.to_s][type][i.to_s]
quiz_question_choice.update_attributes(iscorrect: params[:quiz_question_choices][id.to_s][type][i.to_s][:iscorrect], txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][quiz_question_choice.id.to_s][:txt])
end
end

if type == "MultipleChoiceRadio"

if params[:quiz_question_choices][id.to_s][type][:correctindex] == i.to_s
quiz_question_choice.update_attributes(iscorrect: '1', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])
end
end

if type == "TrueFalse"

if params[:quiz_question_choices][id.to_s][type][1.to_s][:iscorrect] == "True" # the statement is correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is correct so "True" is the right answer

else
quiz_question_choice.update_attributes(iscorrect: '0')
end

else # the statement is not correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '0')

else
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is not correct so "False" is the right answer
end
end
end
end
</pre>

c. Replaced large block of for and if statements in update with a call to the new change_question_types method.

<pre>

for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
</pre>

d. Moved export, import, copy_questionnaire_details, and assign_instructor_id to questionaire model.

<pre>
def copy_questionnaire_details(questions, orig_questionnaire, id)
self.instructor_id = self.assign_instructor_id()
self.name = 'Copy of ' + orig_questionnaire.name

begin
self.created_at = Time.now
self.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = id
new_question.size = '50,3' if (new_question.is_a? Criterion or new_question.is_a? TextResponse) and new_question.size.nil?
new_question.save!
advices = QuestionAdvice.where(question_id: question.id)
next if advices.empty?
advices.each do |advice|
new_advice = advice.dup
new_advice.question_id = new_question.id
new_advice.save!
end
end

pFolder = TreeFolder.find_by(name: question.set_display_type(display_type))
parent = FolderNode.find_by(node_object_id: pFolder.id)
QuestionnaireNode.find_or_create_by(parent_id: parent.id, node_object_id: id)
undo_link("Copy of questionnaire #{orig_questionnaire.name} has been created successfully.")
redirect_to controller: 'questionnaires', action: 'view', id: @questionnaire.id
rescue StandardError
flash[:error] = 'The questionnaire was not able to be copied. Please check the original course for missing information.' + $ERROR_INFO
redirect_to action: 'list', controller: 'tree_display'
end
end

def export
@questionnaire = Questionnaire.find(params[:id])
csv_data = QuestionnaireHelper.create_questionnaire_csv @questionnaire, session[:user].name
send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=questionnaires.csv"
end

def import
@questionnaire = Questionnaire.find(params[:id])
file = params['csv']
@questionnaire.questions << QuestionnaireHelper.get_questions_from_csv(@questionnaire, file)
end

def assign_instructor_id
# if the user to copy the questionnaire is a TA, the instructor should be the owner instead of the TA
if session[:user].role.name != "Teaching Assistant"
session[:user].id
else # for TA we need to get his instructor id and by default add it to his course for which he is the TA
Ta.get_my_instructor(session[:user].id)
end
end
</pre>

3''': Replace switch statements with subclasses methods and create models for the subclasses.
* '''Solution''': Moved the switch-case statement from create in questionaire_controller.rb into a method called set_display_type in questionaire model. The following is the code snippet that shows the same.

<pre>

def set_dispay_type(display_type)

case display_type

when 'Review'
display_type = 'Review'

when 'Metareview'
display_type = 'Metareview'

when 'AuthorFeedback'
display_type = 'Author%Feedback'

when 'CourseSurvey'
display_type = 'Course%Survey'

when 'TeammateReview'
display_type = 'Teammate%Review'

when 'GlobalSurvey'
display_type = 'Global%Survey'

when 'AssignmentSurvey'
display_type = 'Assignment%Survey'

when 'Bookmarkrating'
display_type = 'Bookmarkrating'
end
end
</pre>

'''Problem 4''': Remove hardcoded parameters, such as save_choice method
* '''Solution''': Hardcoded parameters are removed and necessary constants are defined.

===Test Plans===

Because the purpose of our project was to better arrange our code, it follows that we also needed to rearrange the tests for that code. We first divided the tests for questionnaires_controller into two test files, questionnaires_controller_spec and quiz_questionnaires_controller_spec and separated the tests for CRUD operations of quiz_questionnaires_controller into the quiz_questionnaires_controller_spec, renaming them from view_quiz, create_quiz and the like to view and create. After this separation of CRUD operation testing, we tested the functionality that we moved out of the controllers into the model including the validation method for the quiz questionnaire. We did not include tests to cover the existing model functions, nor did we test the new set_display_type or change_question_types functions as they are setter methods, which, according to our testing instruction are not worth testing.

The setup for testing was particularly troublesome for the deployment of this project. The tests did not run properly in RubyMine, so it was difficult to ensure they were set up properly, and none of the members of our group have any expertise in rspec testing.

===Testing from UI===

The testing of the export feature is shown below:

[[File:Export_completed_successfully.png|1000px]]

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/Riounis/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1271 GitHub Pull Request]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2018 E1836 Refactor quiz questionnaires controller.rb

2018-11-10T02:00:50Z

Amishra6: /* E1836. Refactoring quiz_questionnaires_controller.rb */

==E1836. Refactoring quiz_questionnaires_controller.rb==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===
The following tasks were accomplished in this project:
* Created quiz_questionnaire_controller.rb
* Moved view_quiz, new_quiz, create_quiz_questionnaire, edit_quiz and update_quiz from questionnaires_controller.rb, to quiz_questionnaires_controller.rb, and renamed it as view, new, create, edit and update respectively.
* Refactored the the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* Replaced switch statements in questionnaires_controller.rb with subclass methods.
* Created models for the subclasses.
* Removed hardcoded parameters, such as save_choice method.
* Appropriate tests were written to test the code.

===Implementation===

'''Problem 1''': Create quiz_questionnaire_controller.rb and move some of the methods in the questionnaires_controller.rb to the new file created.
* '''Solution''': The methods view_quiz, new_quiz, create_quiz, edit_quiz and update_quiz in the questionnaires_controller.rb were the methods identified and moved into the quiz_questionnaire_controller.rb. They were respectively renamed as view, new, create, edit and update. The implementation of the newly created quiz_questionnaire_controller.rb can be seen below.
<pre>
class QuizQuestionnairesController < QuestionnairesController

#=========================================================================================================
# Separate methods for quiz questionnaire
#=========================================================================================================

# View a quiz questionnaire
def view
@questionnaire = Questionnaire.find(params[:id])
@participant = Participant.find(params[:pid]) # creating an instance variable since it needs to be sent to submitted_content/edit
render :view
end

# define a new quiz questionnaire
# method invoked by the view
def new
valid_request = true
@assignment_id = params[:aid] # creating an instance variable to hold the assignment id
@participant_id = params[:pid] # creating an instance variable to hold the participant id
assignment = Assignment.find(@assignment_id)
if !assignment.require_quiz? # flash error if this assignment does not require quiz
flash[:error] = "This assignment does not support the quizzing feature."
valid_request = false
else
team = AssignmentParticipant.find(@participant_id).team

if team.nil? # flash error if this current participant does not have a team
flash[:error] = "You should create or join a team first."
valid_request = false
else
if assignment.topics? && team.topic.nil? # flash error if this assignment has topic but current team does not have a topic
flash[:error] = "Your team should have a topic."
valid_request = false
end
end
end

if valid_request && Questionnaire::QUESTIONNAIRE_TYPES.include?(params[:model])
@questionnaire = Object.const_get(params[:model]).new
@questionnaire.private = params[:private]
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1

render :new
else
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end

# seperate method for creating a quiz questionnaire because of differences in permission
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

# edit a quiz questionnaire
def edit
@questionnaire = Questionnaire.find(params[:id])
if !@questionnaire.taken_by_anyone?
render :edit
else
flash[:error] = "Your quiz has been taken by some other students, you cannot edit it anymore."
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end
# save an updated quiz questionnaire to the database
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)

for qid in params[:question].keys
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save

@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
i = 1
for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end

end
</pre>

'''Problem 2''': Refactor the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* '''Solution''':
a. Deleted the create_questionnaire method and replaced the call to it in create_quiz_questionnaire with the code of create_questionnaire and is later moved to quiz_questionnaires_controller.rb and the code snippet below is used.

<pre>
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

</pre>

b. Moved the large block of for and if statements into method called change_question_types in the quiz_questionnaire model.

<pre>
def change_question_types(quiz_question_choice, type, id, i)

if type == "MultipleChoiceCheckbox"

if params[:quiz_question_choices][id.to_s][type][i.to_s]
quiz_question_choice.update_attributes(iscorrect: params[:quiz_question_choices][id.to_s][type][i.to_s][:iscorrect], txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][quiz_question_choice.id.to_s][:txt])
end
end

if type == "MultipleChoiceRadio"

if params[:quiz_question_choices][id.to_s][type][:correctindex] == i.to_s
quiz_question_choice.update_attributes(iscorrect: '1', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])
end
end

if type == "TrueFalse"

if params[:quiz_question_choices][id.to_s][type][1.to_s][:iscorrect] == "True" # the statement is correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is correct so "True" is the right answer

else
quiz_question_choice.update_attributes(iscorrect: '0')
end

else # the statement is not correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '0')

else
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is not correct so "False" is the right answer
end
end
end
end
</pre>

c. Replaced large block of for and if statements in update with a call to the new change_question_types method.

<pre>

for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
</pre>

d. Moved export, import, copy_questionnaire_details, and assign_instructor_id to questionaire model.

<pre>
def copy_questionnaire_details(questions, orig_questionnaire, id)
self.instructor_id = self.assign_instructor_id()
self.name = 'Copy of ' + orig_questionnaire.name

begin
self.created_at = Time.now
self.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = id
new_question.size = '50,3' if (new_question.is_a? Criterion or new_question.is_a? TextResponse) and new_question.size.nil?
new_question.save!
advices = QuestionAdvice.where(question_id: question.id)
next if advices.empty?
advices.each do |advice|
new_advice = advice.dup
new_advice.question_id = new_question.id
new_advice.save!
end
end

pFolder = TreeFolder.find_by(name: question.set_display_type(display_type))
parent = FolderNode.find_by(node_object_id: pFolder.id)
QuestionnaireNode.find_or_create_by(parent_id: parent.id, node_object_id: id)
undo_link("Copy of questionnaire #{orig_questionnaire.name} has been created successfully.")
redirect_to controller: 'questionnaires', action: 'view', id: @questionnaire.id
rescue StandardError
flash[:error] = 'The questionnaire was not able to be copied. Please check the original course for missing information.' + $ERROR_INFO
redirect_to action: 'list', controller: 'tree_display'
end
end

def export
@questionnaire = Questionnaire.find(params[:id])
csv_data = QuestionnaireHelper.create_questionnaire_csv @questionnaire, session[:user].name
send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=questionnaires.csv"
end

def import
@questionnaire = Questionnaire.find(params[:id])
file = params['csv']
@questionnaire.questions << QuestionnaireHelper.get_questions_from_csv(@questionnaire, file)
end

def assign_instructor_id
# if the user to copy the questionnaire is a TA, the instructor should be the owner instead of the TA
if session[:user].role.name != "Teaching Assistant"
session[:user].id
else # for TA we need to get his instructor id and by default add it to his course for which he is the TA
Ta.get_my_instructor(session[:user].id)
end
end
</pre>

3''': Replace switch statements with subclasses methods and create models for the subclasses.
* '''Solution''': Moved the switch-case statement from create in questionaire_controller.rb into a method called set_display_type in questionaire model. The following is the code snippet that shows the same.

<pre>

def set_dispay_type(display_type)

case display_type

when 'Review'
display_type = 'Review'

when 'Metareview'
display_type = 'Metareview'

when 'AuthorFeedback'
display_type = 'Author%Feedback'

when 'CourseSurvey'
display_type = 'Course%Survey'

when 'TeammateReview'
display_type = 'Teammate%Review'

when 'GlobalSurvey'
display_type = 'Global%Survey'

when 'AssignmentSurvey'
display_type = 'Assignment%Survey'

when 'Bookmarkrating'
display_type = 'Bookmarkrating'
end
end
</pre>

'''Problem 4''': Remove hardcoded parameters, such as save_choice method
* '''Solution''': Hardcoded parameters are removed and necessary constants are defined.

===Test Plans===

Because the purpose of our project was to better arrange our code, it follows that we also needed to rearrange the tests for that code. We first divided the tests for questionnaires_controller into two test files, questionnaires_controller_spec and quiz_questionnaires_controller_spec and separated the tests for CRUD operations of quiz_questionnaires_controller into the quiz_questionnaires_controller_spec, renaming them from view_quiz, create_quiz and the like to view and create. After this separation of CRUD operation testing, we tested the functionality that we moved out of the controllers into the model including the validation method for the quiz questionnaire. We did not include tests to cover the existing model functions, nor did we test the new set_display_type or change_question_types functions as they are setter methods, which, according to our testing instruction are not worth testing.

The setup for testing was particularly troublesome for the deployment of this project. The tests did not run properly in RubyMine, so it was difficult to ensure they were set up properly, and none of the members of our group have any expertise in rspec testing.

===Testing from UI===

The testing of the export feature is shown below:

[[File:Export_completed_successfully.png|200px]]

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/Riounis/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1271 GitHub Pull Request]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2018 E1836 Refactor quiz questionnaires controller.rb

2018-11-10T02:00:09Z

Amishra6: /* Testing from UI */

==E1836. Refactoring quiz_questionnaires_controller.rb==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===
The following tasks were accomplished in this project:
* Created quiz_questionnaire_controller.rb
* Moved view_quiz, new_quiz, create_quiz_questionnaire, edit_quiz and update_quiz from questionnaires_controller.rb, to quiz_questionnaires_controller.rb, and renamed it as view, new, create, edit and update respectively.
* Refactored the the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* Replaced switch statements in questionnaires_controller.rb with subclass methods.
* Created models for the subclasses.
* Removed hardcoded parameters, such as save_choice method.
* Appropriate tests were written to test the code.

===Implementation===

'''Problem 1''': Create quiz_questionnaire_controller.rb and move some of the methods in the questionnaires_controller.rb to the new file created.
* '''Solution''': The methods view_quiz, new_quiz, create_quiz, edit_quiz and update_quiz in the questionnaires_controller.rb were the methods identified and moved into the quiz_questionnaire_controller.rb. They were respectively renamed as view, new, create, edit and update. The implementation of the newly created quiz_questionnaire_controller.rb can be seen below.
<pre>
class QuizQuestionnairesController < QuestionnairesController

#=========================================================================================================
# Separate methods for quiz questionnaire
#=========================================================================================================

# View a quiz questionnaire
def view
@questionnaire = Questionnaire.find(params[:id])
@participant = Participant.find(params[:pid]) # creating an instance variable since it needs to be sent to submitted_content/edit
render :view
end

# define a new quiz questionnaire
# method invoked by the view
def new
valid_request = true
@assignment_id = params[:aid] # creating an instance variable to hold the assignment id
@participant_id = params[:pid] # creating an instance variable to hold the participant id
assignment = Assignment.find(@assignment_id)
if !assignment.require_quiz? # flash error if this assignment does not require quiz
flash[:error] = "This assignment does not support the quizzing feature."
valid_request = false
else
team = AssignmentParticipant.find(@participant_id).team

if team.nil? # flash error if this current participant does not have a team
flash[:error] = "You should create or join a team first."
valid_request = false
else
if assignment.topics? && team.topic.nil? # flash error if this assignment has topic but current team does not have a topic
flash[:error] = "Your team should have a topic."
valid_request = false
end
end
end

if valid_request && Questionnaire::QUESTIONNAIRE_TYPES.include?(params[:model])
@questionnaire = Object.const_get(params[:model]).new
@questionnaire.private = params[:private]
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1

render :new
else
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end

# seperate method for creating a quiz questionnaire because of differences in permission
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

# edit a quiz questionnaire
def edit
@questionnaire = Questionnaire.find(params[:id])
if !@questionnaire.taken_by_anyone?
render :edit
else
flash[:error] = "Your quiz has been taken by some other students, you cannot edit it anymore."
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end
# save an updated quiz questionnaire to the database
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)

for qid in params[:question].keys
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save

@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
i = 1
for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end

end
</pre>

'''Problem 2''': Refactor the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* '''Solution''':
a. Deleted the create_questionnaire method and replaced the call to it in create_quiz_questionnaire with the code of create_questionnaire and is later moved to quiz_questionnaires_controller.rb and the code snippet below is used.

<pre>
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

</pre>

b. Moved the large block of for and if statements into method called change_question_types in the quiz_questionnaire model.

<pre>
def change_question_types(quiz_question_choice, type, id, i)

if type == "MultipleChoiceCheckbox"

if params[:quiz_question_choices][id.to_s][type][i.to_s]
quiz_question_choice.update_attributes(iscorrect: params[:quiz_question_choices][id.to_s][type][i.to_s][:iscorrect], txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][quiz_question_choice.id.to_s][:txt])
end
end

if type == "MultipleChoiceRadio"

if params[:quiz_question_choices][id.to_s][type][:correctindex] == i.to_s
quiz_question_choice.update_attributes(iscorrect: '1', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])
end
end

if type == "TrueFalse"

if params[:quiz_question_choices][id.to_s][type][1.to_s][:iscorrect] == "True" # the statement is correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is correct so "True" is the right answer

else
quiz_question_choice.update_attributes(iscorrect: '0')
end

else # the statement is not correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '0')

else
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is not correct so "False" is the right answer
end
end
end
end
</pre>

c. Replaced large block of for and if statements in update with a call to the new change_question_types method.

<pre>

for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
</pre>

d. Moved export, import, copy_questionnaire_details, and assign_instructor_id to questionaire model.

<pre>
def copy_questionnaire_details(questions, orig_questionnaire, id)
self.instructor_id = self.assign_instructor_id()
self.name = 'Copy of ' + orig_questionnaire.name

begin
self.created_at = Time.now
self.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = id
new_question.size = '50,3' if (new_question.is_a? Criterion or new_question.is_a? TextResponse) and new_question.size.nil?
new_question.save!
advices = QuestionAdvice.where(question_id: question.id)
next if advices.empty?
advices.each do |advice|
new_advice = advice.dup
new_advice.question_id = new_question.id
new_advice.save!
end
end

pFolder = TreeFolder.find_by(name: question.set_display_type(display_type))
parent = FolderNode.find_by(node_object_id: pFolder.id)
QuestionnaireNode.find_or_create_by(parent_id: parent.id, node_object_id: id)
undo_link("Copy of questionnaire #{orig_questionnaire.name} has been created successfully.")
redirect_to controller: 'questionnaires', action: 'view', id: @questionnaire.id
rescue StandardError
flash[:error] = 'The questionnaire was not able to be copied. Please check the original course for missing information.' + $ERROR_INFO
redirect_to action: 'list', controller: 'tree_display'
end
end

def export
@questionnaire = Questionnaire.find(params[:id])
csv_data = QuestionnaireHelper.create_questionnaire_csv @questionnaire, session[:user].name
send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=questionnaires.csv"
end

def import
@questionnaire = Questionnaire.find(params[:id])
file = params['csv']
@questionnaire.questions << QuestionnaireHelper.get_questions_from_csv(@questionnaire, file)
end

def assign_instructor_id
# if the user to copy the questionnaire is a TA, the instructor should be the owner instead of the TA
if session[:user].role.name != "Teaching Assistant"
session[:user].id
else # for TA we need to get his instructor id and by default add it to his course for which he is the TA
Ta.get_my_instructor(session[:user].id)
end
end
</pre>

3''': Replace switch statements with subclasses methods and create models for the subclasses.
* '''Solution''': Moved the switch-case statement from create in questionaire_controller.rb into a method called set_display_type in questionaire model. The following is the code snippet that shows the same.

<pre>

def set_dispay_type(display_type)

case display_type

when 'Review'
display_type = 'Review'

when 'Metareview'
display_type = 'Metareview'

when 'AuthorFeedback'
display_type = 'Author%Feedback'

when 'CourseSurvey'
display_type = 'Course%Survey'

when 'TeammateReview'
display_type = 'Teammate%Review'

when 'GlobalSurvey'
display_type = 'Global%Survey'

when 'AssignmentSurvey'
display_type = 'Assignment%Survey'

when 'Bookmarkrating'
display_type = 'Bookmarkrating'
end
end
</pre>

'''Problem 4''': Remove hardcoded parameters, such as save_choice method
* '''Solution''': Hardcoded parameters are removed and necessary constants are defined.

===Test Plans===

Because the purpose of our project was to better arrange our code, it follows that we also needed to rearrange the tests for that code. We first divided the tests for questionnaires_controller into two test files, questionnaires_controller_spec and quiz_questionnaires_controller_spec and separated the tests for CRUD operations of quiz_questionnaires_controller into the quiz_questionnaires_controller_spec, renaming them from view_quiz, create_quiz and the like to view and create. After this separation of CRUD operation testing, we tested the functionality that we moved out of the controllers into the model including the validation method for the quiz questionnaire. We did not include tests to cover the existing model functions, nor did we test the new set_display_type or change_question_types functions as they are setter methods, which, according to our testing instruction are not worth testing.

The setup for testing was particularly troublesome for the deployment of this project. The tests did not run properly in RubyMine, so it was difficult to ensure they were set up properly, and none of the members of our group have any expertise in rspec testing.

===Testing from UI===

The testing of the export feature is shown below:

[[File:Export_completed_successfully.png|upright]]

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/Riounis/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1271 GitHub Pull Request]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2018 E1836 Refactor quiz questionnaires controller.rb

2018-11-10T01:58:24Z

Amishra6: /* Testing from UI */

==E1836. Refactoring quiz_questionnaires_controller.rb==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===
The following tasks were accomplished in this project:
* Created quiz_questionnaire_controller.rb
* Moved view_quiz, new_quiz, create_quiz_questionnaire, edit_quiz and update_quiz from questionnaires_controller.rb, to quiz_questionnaires_controller.rb, and renamed it as view, new, create, edit and update respectively.
* Refactored the the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* Replaced switch statements in questionnaires_controller.rb with subclass methods.
* Created models for the subclasses.
* Removed hardcoded parameters, such as save_choice method.
* Appropriate tests were written to test the code.

===Implementation===

'''Problem 1''': Create quiz_questionnaire_controller.rb and move some of the methods in the questionnaires_controller.rb to the new file created.
* '''Solution''': The methods view_quiz, new_quiz, create_quiz, edit_quiz and update_quiz in the questionnaires_controller.rb were the methods identified and moved into the quiz_questionnaire_controller.rb. They were respectively renamed as view, new, create, edit and update. The implementation of the newly created quiz_questionnaire_controller.rb can be seen below.
<pre>
class QuizQuestionnairesController < QuestionnairesController

#=========================================================================================================
# Separate methods for quiz questionnaire
#=========================================================================================================

# View a quiz questionnaire
def view
@questionnaire = Questionnaire.find(params[:id])
@participant = Participant.find(params[:pid]) # creating an instance variable since it needs to be sent to submitted_content/edit
render :view
end

# define a new quiz questionnaire
# method invoked by the view
def new
valid_request = true
@assignment_id = params[:aid] # creating an instance variable to hold the assignment id
@participant_id = params[:pid] # creating an instance variable to hold the participant id
assignment = Assignment.find(@assignment_id)
if !assignment.require_quiz? # flash error if this assignment does not require quiz
flash[:error] = "This assignment does not support the quizzing feature."
valid_request = false
else
team = AssignmentParticipant.find(@participant_id).team

if team.nil? # flash error if this current participant does not have a team
flash[:error] = "You should create or join a team first."
valid_request = false
else
if assignment.topics? && team.topic.nil? # flash error if this assignment has topic but current team does not have a topic
flash[:error] = "Your team should have a topic."
valid_request = false
end
end
end

if valid_request && Questionnaire::QUESTIONNAIRE_TYPES.include?(params[:model])
@questionnaire = Object.const_get(params[:model]).new
@questionnaire.private = params[:private]
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1

render :new
else
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end

# seperate method for creating a quiz questionnaire because of differences in permission
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

# edit a quiz questionnaire
def edit
@questionnaire = Questionnaire.find(params[:id])
if !@questionnaire.taken_by_anyone?
render :edit
else
flash[:error] = "Your quiz has been taken by some other students, you cannot edit it anymore."
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end
# save an updated quiz questionnaire to the database
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)

for qid in params[:question].keys
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save

@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
i = 1
for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end

end
</pre>

'''Problem 2''': Refactor the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* '''Solution''':
a. Deleted the create_questionnaire method and replaced the call to it in create_quiz_questionnaire with the code of create_questionnaire and is later moved to quiz_questionnaires_controller.rb and the code snippet below is used.

<pre>
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

</pre>

b. Moved the large block of for and if statements into method called change_question_types in the quiz_questionnaire model.

<pre>
def change_question_types(quiz_question_choice, type, id, i)

if type == "MultipleChoiceCheckbox"

if params[:quiz_question_choices][id.to_s][type][i.to_s]
quiz_question_choice.update_attributes(iscorrect: params[:quiz_question_choices][id.to_s][type][i.to_s][:iscorrect], txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][quiz_question_choice.id.to_s][:txt])
end
end

if type == "MultipleChoiceRadio"

if params[:quiz_question_choices][id.to_s][type][:correctindex] == i.to_s
quiz_question_choice.update_attributes(iscorrect: '1', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])
end
end

if type == "TrueFalse"

if params[:quiz_question_choices][id.to_s][type][1.to_s][:iscorrect] == "True" # the statement is correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is correct so "True" is the right answer

else
quiz_question_choice.update_attributes(iscorrect: '0')
end

else # the statement is not correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '0')

else
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is not correct so "False" is the right answer
end
end
end
end
</pre>

c. Replaced large block of for and if statements in update with a call to the new change_question_types method.

<pre>

for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
</pre>

d. Moved export, import, copy_questionnaire_details, and assign_instructor_id to questionaire model.

<pre>
def copy_questionnaire_details(questions, orig_questionnaire, id)
self.instructor_id = self.assign_instructor_id()
self.name = 'Copy of ' + orig_questionnaire.name

begin
self.created_at = Time.now
self.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = id
new_question.size = '50,3' if (new_question.is_a? Criterion or new_question.is_a? TextResponse) and new_question.size.nil?
new_question.save!
advices = QuestionAdvice.where(question_id: question.id)
next if advices.empty?
advices.each do |advice|
new_advice = advice.dup
new_advice.question_id = new_question.id
new_advice.save!
end
end

pFolder = TreeFolder.find_by(name: question.set_display_type(display_type))
parent = FolderNode.find_by(node_object_id: pFolder.id)
QuestionnaireNode.find_or_create_by(parent_id: parent.id, node_object_id: id)
undo_link("Copy of questionnaire #{orig_questionnaire.name} has been created successfully.")
redirect_to controller: 'questionnaires', action: 'view', id: @questionnaire.id
rescue StandardError
flash[:error] = 'The questionnaire was not able to be copied. Please check the original course for missing information.' + $ERROR_INFO
redirect_to action: 'list', controller: 'tree_display'
end
end

def export
@questionnaire = Questionnaire.find(params[:id])
csv_data = QuestionnaireHelper.create_questionnaire_csv @questionnaire, session[:user].name
send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=questionnaires.csv"
end

def import
@questionnaire = Questionnaire.find(params[:id])
file = params['csv']
@questionnaire.questions << QuestionnaireHelper.get_questions_from_csv(@questionnaire, file)
end

def assign_instructor_id
# if the user to copy the questionnaire is a TA, the instructor should be the owner instead of the TA
if session[:user].role.name != "Teaching Assistant"
session[:user].id
else # for TA we need to get his instructor id and by default add it to his course for which he is the TA
Ta.get_my_instructor(session[:user].id)
end
end
</pre>

3''': Replace switch statements with subclasses methods and create models for the subclasses.
* '''Solution''': Moved the switch-case statement from create in questionaire_controller.rb into a method called set_display_type in questionaire model. The following is the code snippet that shows the same.

<pre>

def set_dispay_type(display_type)

case display_type

when 'Review'
display_type = 'Review'

when 'Metareview'
display_type = 'Metareview'

when 'AuthorFeedback'
display_type = 'Author%Feedback'

when 'CourseSurvey'
display_type = 'Course%Survey'

when 'TeammateReview'
display_type = 'Teammate%Review'

when 'GlobalSurvey'
display_type = 'Global%Survey'

when 'AssignmentSurvey'
display_type = 'Assignment%Survey'

when 'Bookmarkrating'
display_type = 'Bookmarkrating'
end
end
</pre>

'''Problem 4''': Remove hardcoded parameters, such as save_choice method
* '''Solution''': Hardcoded parameters are removed and necessary constants are defined.

===Test Plans===

Because the purpose of our project was to better arrange our code, it follows that we also needed to rearrange the tests for that code. We first divided the tests for questionnaires_controller into two test files, questionnaires_controller_spec and quiz_questionnaires_controller_spec and separated the tests for CRUD operations of quiz_questionnaires_controller into the quiz_questionnaires_controller_spec, renaming them from view_quiz, create_quiz and the like to view and create. After this separation of CRUD operation testing, we tested the functionality that we moved out of the controllers into the model including the validation method for the quiz questionnaire. We did not include tests to cover the existing model functions, nor did we test the new set_display_type or change_question_types functions as they are setter methods, which, according to our testing instruction are not worth testing.

The setup for testing was particularly troublesome for the deployment of this project. The tests did not run properly in RubyMine, so it was difficult to ensure they were set up properly, and none of the members of our group have any expertise in rspec testing.

===Testing from UI===

The testing of the export feature is shown below:

[[File:Export_completed_successfully.png]]

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/Riounis/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1271 GitHub Pull Request]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2018 E1836 Refactor quiz questionnaires controller.rb

2018-11-10T01:57:21Z

Amishra6: /* Testing from UI */

==E1836. Refactoring quiz_questionnaires_controller.rb==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===
The following tasks were accomplished in this project:
* Created quiz_questionnaire_controller.rb
* Moved view_quiz, new_quiz, create_quiz_questionnaire, edit_quiz and update_quiz from questionnaires_controller.rb, to quiz_questionnaires_controller.rb, and renamed it as view, new, create, edit and update respectively.
* Refactored the the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* Replaced switch statements in questionnaires_controller.rb with subclass methods.
* Created models for the subclasses.
* Removed hardcoded parameters, such as save_choice method.
* Appropriate tests were written to test the code.

===Implementation===

'''Problem 1''': Create quiz_questionnaire_controller.rb and move some of the methods in the questionnaires_controller.rb to the new file created.
* '''Solution''': The methods view_quiz, new_quiz, create_quiz, edit_quiz and update_quiz in the questionnaires_controller.rb were the methods identified and moved into the quiz_questionnaire_controller.rb. They were respectively renamed as view, new, create, edit and update. The implementation of the newly created quiz_questionnaire_controller.rb can be seen below.
<pre>
class QuizQuestionnairesController < QuestionnairesController

#=========================================================================================================
# Separate methods for quiz questionnaire
#=========================================================================================================

# View a quiz questionnaire
def view
@questionnaire = Questionnaire.find(params[:id])
@participant = Participant.find(params[:pid]) # creating an instance variable since it needs to be sent to submitted_content/edit
render :view
end

# define a new quiz questionnaire
# method invoked by the view
def new
valid_request = true
@assignment_id = params[:aid] # creating an instance variable to hold the assignment id
@participant_id = params[:pid] # creating an instance variable to hold the participant id
assignment = Assignment.find(@assignment_id)
if !assignment.require_quiz? # flash error if this assignment does not require quiz
flash[:error] = "This assignment does not support the quizzing feature."
valid_request = false
else
team = AssignmentParticipant.find(@participant_id).team

if team.nil? # flash error if this current participant does not have a team
flash[:error] = "You should create or join a team first."
valid_request = false
else
if assignment.topics? && team.topic.nil? # flash error if this assignment has topic but current team does not have a topic
flash[:error] = "Your team should have a topic."
valid_request = false
end
end
end

if valid_request && Questionnaire::QUESTIONNAIRE_TYPES.include?(params[:model])
@questionnaire = Object.const_get(params[:model]).new
@questionnaire.private = params[:private]
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1

render :new
else
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end

# seperate method for creating a quiz questionnaire because of differences in permission
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

# edit a quiz questionnaire
def edit
@questionnaire = Questionnaire.find(params[:id])
if !@questionnaire.taken_by_anyone?
render :edit
else
flash[:error] = "Your quiz has been taken by some other students, you cannot edit it anymore."
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end
# save an updated quiz questionnaire to the database
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)

for qid in params[:question].keys
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save

@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
i = 1
for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end

end
</pre>

'''Problem 2''': Refactor the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* '''Solution''':
a. Deleted the create_questionnaire method and replaced the call to it in create_quiz_questionnaire with the code of create_questionnaire and is later moved to quiz_questionnaires_controller.rb and the code snippet below is used.

<pre>
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

</pre>

b. Moved the large block of for and if statements into method called change_question_types in the quiz_questionnaire model.

<pre>
def change_question_types(quiz_question_choice, type, id, i)

if type == "MultipleChoiceCheckbox"

if params[:quiz_question_choices][id.to_s][type][i.to_s]
quiz_question_choice.update_attributes(iscorrect: params[:quiz_question_choices][id.to_s][type][i.to_s][:iscorrect], txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][quiz_question_choice.id.to_s][:txt])
end
end

if type == "MultipleChoiceRadio"

if params[:quiz_question_choices][id.to_s][type][:correctindex] == i.to_s
quiz_question_choice.update_attributes(iscorrect: '1', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])
end
end

if type == "TrueFalse"

if params[:quiz_question_choices][id.to_s][type][1.to_s][:iscorrect] == "True" # the statement is correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is correct so "True" is the right answer

else
quiz_question_choice.update_attributes(iscorrect: '0')
end

else # the statement is not correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '0')

else
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is not correct so "False" is the right answer
end
end
end
end
</pre>

c. Replaced large block of for and if statements in update with a call to the new change_question_types method.

<pre>

for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
</pre>

d. Moved export, import, copy_questionnaire_details, and assign_instructor_id to questionaire model.

<pre>
def copy_questionnaire_details(questions, orig_questionnaire, id)
self.instructor_id = self.assign_instructor_id()
self.name = 'Copy of ' + orig_questionnaire.name

begin
self.created_at = Time.now
self.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = id
new_question.size = '50,3' if (new_question.is_a? Criterion or new_question.is_a? TextResponse) and new_question.size.nil?
new_question.save!
advices = QuestionAdvice.where(question_id: question.id)
next if advices.empty?
advices.each do |advice|
new_advice = advice.dup
new_advice.question_id = new_question.id
new_advice.save!
end
end

pFolder = TreeFolder.find_by(name: question.set_display_type(display_type))
parent = FolderNode.find_by(node_object_id: pFolder.id)
QuestionnaireNode.find_or_create_by(parent_id: parent.id, node_object_id: id)
undo_link("Copy of questionnaire #{orig_questionnaire.name} has been created successfully.")
redirect_to controller: 'questionnaires', action: 'view', id: @questionnaire.id
rescue StandardError
flash[:error] = 'The questionnaire was not able to be copied. Please check the original course for missing information.' + $ERROR_INFO
redirect_to action: 'list', controller: 'tree_display'
end
end

def export
@questionnaire = Questionnaire.find(params[:id])
csv_data = QuestionnaireHelper.create_questionnaire_csv @questionnaire, session[:user].name
send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=questionnaires.csv"
end

def import
@questionnaire = Questionnaire.find(params[:id])
file = params['csv']
@questionnaire.questions << QuestionnaireHelper.get_questions_from_csv(@questionnaire, file)
end

def assign_instructor_id
# if the user to copy the questionnaire is a TA, the instructor should be the owner instead of the TA
if session[:user].role.name != "Teaching Assistant"
session[:user].id
else # for TA we need to get his instructor id and by default add it to his course for which he is the TA
Ta.get_my_instructor(session[:user].id)
end
end
</pre>

3''': Replace switch statements with subclasses methods and create models for the subclasses.
* '''Solution''': Moved the switch-case statement from create in questionaire_controller.rb into a method called set_display_type in questionaire model. The following is the code snippet that shows the same.

<pre>

def set_dispay_type(display_type)

case display_type

when 'Review'
display_type = 'Review'

when 'Metareview'
display_type = 'Metareview'

when 'AuthorFeedback'
display_type = 'Author%Feedback'

when 'CourseSurvey'
display_type = 'Course%Survey'

when 'TeammateReview'
display_type = 'Teammate%Review'

when 'GlobalSurvey'
display_type = 'Global%Survey'

when 'AssignmentSurvey'
display_type = 'Assignment%Survey'

when 'Bookmarkrating'
display_type = 'Bookmarkrating'
end
end
</pre>

'''Problem 4''': Remove hardcoded parameters, such as save_choice method
* '''Solution''': Hardcoded parameters are removed and necessary constants are defined.

===Test Plans===

Because the purpose of our project was to better arrange our code, it follows that we also needed to rearrange the tests for that code. We first divided the tests for questionnaires_controller into two test files, questionnaires_controller_spec and quiz_questionnaires_controller_spec and separated the tests for CRUD operations of quiz_questionnaires_controller into the quiz_questionnaires_controller_spec, renaming them from view_quiz, create_quiz and the like to view and create. After this separation of CRUD operation testing, we tested the functionality that we moved out of the controllers into the model including the validation method for the quiz questionnaire. We did not include tests to cover the existing model functions, nor did we test the new set_display_type or change_question_types functions as they are setter methods, which, according to our testing instruction are not worth testing.

The setup for testing was particularly troublesome for the deployment of this project. The tests did not run properly in RubyMine, so it was difficult to ensure they were set up properly, and none of the members of our group have any expertise in rspec testing.

===Testing from UI===

The testing of the export feature is shown below:

[[File:Export_completed_successfully.png|center]]

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/Riounis/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1271 GitHub Pull Request]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2018 E1836 Refactor quiz questionnaires controller.rb

2018-11-10T01:55:26Z

Amishra6: /* E1836. Refactoring quiz_questionnaires_controller.rb */

==E1836. Refactoring quiz_questionnaires_controller.rb==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ 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.

===Problem Statement===
The following tasks were accomplished in this project:
* Created quiz_questionnaire_controller.rb
* Moved view_quiz, new_quiz, create_quiz_questionnaire, edit_quiz and update_quiz from questionnaires_controller.rb, to quiz_questionnaires_controller.rb, and renamed it as view, new, create, edit and update respectively.
* Refactored the the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* Replaced switch statements in questionnaires_controller.rb with subclass methods.
* Created models for the subclasses.
* Removed hardcoded parameters, such as save_choice method.
* Appropriate tests were written to test the code.

===Implementation===

'''Problem 1''': Create quiz_questionnaire_controller.rb and move some of the methods in the questionnaires_controller.rb to the new file created.
* '''Solution''': The methods view_quiz, new_quiz, create_quiz, edit_quiz and update_quiz in the questionnaires_controller.rb were the methods identified and moved into the quiz_questionnaire_controller.rb. They were respectively renamed as view, new, create, edit and update. The implementation of the newly created quiz_questionnaire_controller.rb can be seen below.
<pre>
class QuizQuestionnairesController < QuestionnairesController

#=========================================================================================================
# Separate methods for quiz questionnaire
#=========================================================================================================

# View a quiz questionnaire
def view
@questionnaire = Questionnaire.find(params[:id])
@participant = Participant.find(params[:pid]) # creating an instance variable since it needs to be sent to submitted_content/edit
render :view
end

# define a new quiz questionnaire
# method invoked by the view
def new
valid_request = true
@assignment_id = params[:aid] # creating an instance variable to hold the assignment id
@participant_id = params[:pid] # creating an instance variable to hold the participant id
assignment = Assignment.find(@assignment_id)
if !assignment.require_quiz? # flash error if this assignment does not require quiz
flash[:error] = "This assignment does not support the quizzing feature."
valid_request = false
else
team = AssignmentParticipant.find(@participant_id).team

if team.nil? # flash error if this current participant does not have a team
flash[:error] = "You should create or join a team first."
valid_request = false
else
if assignment.topics? && team.topic.nil? # flash error if this assignment has topic but current team does not have a topic
flash[:error] = "Your team should have a topic."
valid_request = false
end
end
end

if valid_request && Questionnaire::QUESTIONNAIRE_TYPES.include?(params[:model])
@questionnaire = Object.const_get(params[:model]).new
@questionnaire.private = params[:private]
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1

render :new
else
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end

# seperate method for creating a quiz questionnaire because of differences in permission
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

# edit a quiz questionnaire
def edit
@questionnaire = Questionnaire.find(params[:id])
if !@questionnaire.taken_by_anyone?
render :edit
else
flash[:error] = "Your quiz has been taken by some other students, you cannot edit it anymore."
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end
end
# save an updated quiz questionnaire to the database
def update
@questionnaire = Questionnaire.find(params[:id])
if @questionnaire.nil?
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
return
end
if params['save'] && params[:question].try(:keys)
@questionnaire.update_attributes(questionnaire_params)

for qid in params[:question].keys
@question = Question.find(qid)
@question.txt = params[:question][qid.to_sym][:txt]
@question.save

@quiz_question_choices = QuizQuestionChoice.where(question_id: qid)
i = 1
for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
end
end
redirect_to controller: 'submitted_content', action: 'view', id: params[:pid]
end

end
</pre>

'''Problem 2''': Refactor the long methods in questionnaires_controller.rb, such as create and create_questionnaire, update quiz, valid quiz, etc.
* '''Solution''':
a. Deleted the create_questionnaire method and replaced the call to it in create_quiz_questionnaire with the code of create_questionnaire and is later moved to quiz_questionnaires_controller.rb and the code snippet below is used.

<pre>
def create
valid = QuizQuestionnaire.valid
if valid.eql?("valid")
@questionnaire = Object.const_get(params[:questionnaire][:type]).new(questionnaire_params)

# TODO: check for Quiz Questionnaire?
if @questionnaire.type == "QuizQuestionnaire" # checking if it is a quiz questionnaire
participant_id = params[:pid] # creating a local variable to send as parameter to submitted content if it is a quiz questionnaire
@questionnaire.min_question_score = 0
@questionnaire.max_question_score = 1
author_team = AssignmentTeam.team(Participant.find(participant_id))

@questionnaire.instructor_id = author_team.id # for a team assignment, set the instructor id to the team_id

@successful_create = true
save

save_choices @questionnaire.id

flash[:note] = "The quiz was successfully created." if @successful_create == true
redirect_to controller: 'submitted_content', action: 'edit', id: participant_id
else # if it is not a quiz questionnaire
@questionnaire.instructor_id = Ta.get_my_instructor(session[:user].id) if session[:user].role.name == "Teaching Assistant"
save

redirect_to controller: 'tree_display', action: 'list'
end
else
flash[:error] = valid.to_s
redirect_to :back
end
end

</pre>

b. Moved the large block of for and if statements into method called change_question_types in the quiz_questionnaire model.

<pre>
def change_question_types(quiz_question_choice, type, id, i)

if type == "MultipleChoiceCheckbox"

if params[:quiz_question_choices][id.to_s][type][i.to_s]
quiz_question_choice.update_attributes(iscorrect: params[:quiz_question_choices][id.to_s][type][i.to_s][:iscorrect], txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][quiz_question_choice.id.to_s][:txt])
end
end

if type == "MultipleChoiceRadio"

if params[:quiz_question_choices][id.to_s][type][:correctindex] == i.to_s
quiz_question_choice.update_attributes(iscorrect: '1', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])

else
quiz_question_choice.update_attributes(iscorrect: '0', txt: params[:quiz_question_choices][id.to_s][type][i.to_s][:txt])
end
end

if type == "TrueFalse"

if params[:quiz_question_choices][id.to_s][type][1.to_s][:iscorrect] == "True" # the statement is correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is correct so "True" is the right answer

else
quiz_question_choice.update_attributes(iscorrect: '0')
end

else # the statement is not correct

if quiz_question_choice.txt == "True"
quiz_question_choice.update_attributes(iscorrect: '0')

else
quiz_question_choice.update_attributes(iscorrect: '1') # the statement is not correct so "False" is the right answer
end
end
end
end
</pre>

c. Replaced large block of for and if statements in update with a call to the new change_question_types method.

<pre>

for quiz_question_choice in @quiz_question_choices
type = @question.type
id = @question.id
QuizQuestionnaire.change_question_types(quiz_question_choice, type, id, i)
i += 1
end
</pre>

d. Moved export, import, copy_questionnaire_details, and assign_instructor_id to questionaire model.

<pre>
def copy_questionnaire_details(questions, orig_questionnaire, id)
self.instructor_id = self.assign_instructor_id()
self.name = 'Copy of ' + orig_questionnaire.name

begin
self.created_at = Time.now
self.save!
questions.each do |question|
new_question = question.dup
new_question.questionnaire_id = id
new_question.size = '50,3' if (new_question.is_a? Criterion or new_question.is_a? TextResponse) and new_question.size.nil?
new_question.save!
advices = QuestionAdvice.where(question_id: question.id)
next if advices.empty?
advices.each do |advice|
new_advice = advice.dup
new_advice.question_id = new_question.id
new_advice.save!
end
end

pFolder = TreeFolder.find_by(name: question.set_display_type(display_type))
parent = FolderNode.find_by(node_object_id: pFolder.id)
QuestionnaireNode.find_or_create_by(parent_id: parent.id, node_object_id: id)
undo_link("Copy of questionnaire #{orig_questionnaire.name} has been created successfully.")
redirect_to controller: 'questionnaires', action: 'view', id: @questionnaire.id
rescue StandardError
flash[:error] = 'The questionnaire was not able to be copied. Please check the original course for missing information.' + $ERROR_INFO
redirect_to action: 'list', controller: 'tree_display'
end
end

def export
@questionnaire = Questionnaire.find(params[:id])
csv_data = QuestionnaireHelper.create_questionnaire_csv @questionnaire, session[:user].name
send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=questionnaires.csv"
end

def import
@questionnaire = Questionnaire.find(params[:id])
file = params['csv']
@questionnaire.questions << QuestionnaireHelper.get_questions_from_csv(@questionnaire, file)
end

def assign_instructor_id
# if the user to copy the questionnaire is a TA, the instructor should be the owner instead of the TA
if session[:user].role.name != "Teaching Assistant"
session[:user].id
else # for TA we need to get his instructor id and by default add it to his course for which he is the TA
Ta.get_my_instructor(session[:user].id)
end
end
</pre>

3''': Replace switch statements with subclasses methods and create models for the subclasses.
* '''Solution''': Moved the switch-case statement from create in questionaire_controller.rb into a method called set_display_type in questionaire model. The following is the code snippet that shows the same.

<pre>

def set_dispay_type(display_type)

case display_type

when 'Review'
display_type = 'Review'

when 'Metareview'
display_type = 'Metareview'

when 'AuthorFeedback'
display_type = 'Author%Feedback'

when 'CourseSurvey'
display_type = 'Course%Survey'

when 'TeammateReview'
display_type = 'Teammate%Review'

when 'GlobalSurvey'
display_type = 'Global%Survey'

when 'AssignmentSurvey'
display_type = 'Assignment%Survey'

when 'Bookmarkrating'
display_type = 'Bookmarkrating'
end
end
</pre>

'''Problem 4''': Remove hardcoded parameters, such as save_choice method
* '''Solution''': Hardcoded parameters are removed and necessary constants are defined.

===Test Plans===

Because the purpose of our project was to better arrange our code, it follows that we also needed to rearrange the tests for that code. We first divided the tests for questionnaires_controller into two test files, questionnaires_controller_spec and quiz_questionnaires_controller_spec and separated the tests for CRUD operations of quiz_questionnaires_controller into the quiz_questionnaires_controller_spec, renaming them from view_quiz, create_quiz and the like to view and create. After this separation of CRUD operation testing, we tested the functionality that we moved out of the controllers into the model including the validation method for the quiz questionnaire. We did not include tests to cover the existing model functions, nor did we test the new set_display_type or change_question_types functions as they are setter methods, which, according to our testing instruction are not worth testing.

The setup for testing was particularly troublesome for the deployment of this project. The tests did not run properly in RubyMine, so it was difficult to ensure they were set up properly, and none of the members of our group have any expertise in rspec testing.

===Testing from UI===

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/Riounis/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[https://github.com/expertiza/expertiza/pull/1271 GitHub Pull Request]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin