Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2022 - E2240. Re-write waitlist functionality

2022-04-06T20:07:19Z

Smulkur: /* RSpec Unit Tests */

== Problem Statement==

=== Feature Overview ===

=== Issues with existing functionality ===

=== Overview of Major Changes ===

== Proposed design and Plan of action ==

=== General Design Goals ===
=== Changes to the signed_up_teams Table ===
=== Files Involved ===

===Adding new waitlist_teams Table ===
#Add a new table waitlist_teams
#The attributes for the table are team_id(refers to the teams table), topic_id (refers to the sign_up_topics table)
#This table only stores the waitlisted teams for each topic.
#The default timestamp in the table will be used to check the first team waitlisted instead of using queues to implement the functionality.
#The waitlist_helper class will perform the following operations
##Delete all waitlists for team
##Purge all waitlists for topic
##Add team to waitlist
##Delete specific team from waitlist
##Get all waitlisted topics for team
##Get all waitlisted teams for topic
##Get first team in waitlist for topic
##Check waitlist empty for topic
##Check if team has any waitlists

===Refactoring and Design Patterns===
Since our goal is to fix existing functionalities we will not be updating the existing design patterns being employed in the code. Yet, we would like to discuss what makes these refactoring important. Refactoring is a systematic process of improving code without creating new functionality. Thus, a key to the success of our project is ensuring everything that was working before our changes work even after our changes have been added. To ensure this, we will continue to test the system after each issue has been fixed. This will allow us to ensure two things:

* We are only changing what we set out to change when fixing a particular issue.
* We are not breaking what was working before we deployed our fix.

We believe at the end our changes will increase the quality of Expertiza and improve the experience for users an developers alike.

=== Specific Tasks Completed ===
''will be added for the final submission''

== Implementation ==
''will be added for the final submission''

== Testing ==
=== Video Demonstration ===
''will be added for the final submission''
=== Testing Goals and Test Objects ===

''Drawing from the project objectives:''
#Ways to get added to waitlist for a topic
##Team requests a topic that has no slot available.
##When capacity/max choosers for a topic is increased
##When student gets added to a team which has signed up topic
#Ways to get off a waitlist
##team gets the topic they are waiting for ( all other waitlists are dropped for the team)
##team drops off the waitlist
##instructor drops team from the waitlist
##a drop-topic deadline passes
##team is deleted
##student gets added to a new team, then old team's waitlist should be dropped

=== RSpec Unit Tests ===
'''''Test cases provided here, will add RSpec code blocks for the final submission'''''
*Student Waitlist
<pre>
Scenario: Getting added to the waitlist for a topic
Given: Logged in as a Student
When: The topic for an assignment has no available slots
And: Student tries to signup for a topic
Then: The team that the student is a part of should be added to the waitlist for the topic.

Scenario: Getting enrolled in a topic
Given: Logged in as a Student
When: The topic for an assignment has available slots
And: Student tries to signup for a topic
Then: The team that the student is a part of should be enrolled for the topic.

Scenario: All waitlisted topics getting dropped
Given: Logged in as a Student
When: Student gets enrolled into a course for which he was waitlisted before.
Then: The team that the student is a part of should be dropped from the remaining waitlisted topics.

Scenario: All waitlisted teams getting dropped
Given: Logged in as a Student
When: The deadline for a topic passes.
Then: All the waitlisted teams for that particular topic must be dropped.

Scenario: Getting enrolled in a topic
Given: Logged in as a Student
When: The enrolled team for a topic drops
Then: The team that was waitlisted earlier for the topics must be enrolled.

=== Manual UI Tests ===
*Student ID in header
<pre>
Scenario: Student ID in grading history view
Logged in as an Instructor/Admin
On Assignment page, click on Grading History
Resulting Grading History Table is shown
Student ID appears in the header, not in any table columns
</pre>

=== Regression Testing ===
''In order to ensure complete coverage, testing of the changes done between the end of last semester and this project will be done to ensure that ''
''old test cases still pass.''

# Make sure all existing waitlist functionality still passes

== Conclusions and Future Work ==
=== Comprehensive Testing and Scope ===
* ''will be added for final submission''

=== Conclusion ===
''will be added for final submission''

== Useful Links ==
Pull request

Deployed application with changes

Forked repository

== Contributors ==
=== Students ===
*Krishna Saurabh Vankadaru (''kvankad'')
*Samson Mulkur (''smulkur'')
*Akhil Mengani (''amengan'')
*Sai Naga Vamshi Chidara (''schidar'')
=== Mentor ===
*Naman Shrimali (''nshrima'')

CSC/ECE 517 Spring 2022 - E2218: Refactor response controller

2022-03-27T22:28:54Z

Smulkur: /* Running Tests */

This page details project documentation for the CSC/ECE 517 Spring 2022, '''E2218 refactor response_controller.rb''' project.

== Background ==

A response is an object that is created when someone fills out a review rubric, such as when one writes a review, gives feedback to a reviewer, or fills out a survey. Responses to the individual rubric items are kept in Answer objects; each Answer object has a response_id to say what Response it is part of. Since response_controller needs to work with many kinds of responses, its code is pretty general. It is not the worst controller in the system, but it would be much clearer if its method names were more descriptive of what they do.

=== Mentor ===

Ed Gehringer, efg@ncsu.edu

=== Team Members ===

* Sai Naga Vamshi Chidara (schidar@ncsu.edu)
* Akhil Kumar Mengani (amengan@ncsu.edu)
* Samson Reddy Mulkur (smulkur@ncsu.edu)

=== Problem Statement ===

1) After providing a review of a particular project, calibration results are useful to differentiate the review given by the reviewer and that of the instructor's review for the same project. The main problem solved is to refactor the ''show_calibration_results_for_student'' method in the response controller. This method is called when the user clicks on show calibration results as shown in the UI Testing section.

Inside the ''show_calibration_results_for_student'' method, a call to the ''calibration_results_info'' method is made which is part of the response model. This particular method is returning three values calibration_response, review_response, questions. In general, it is not a good approach to return the array of three values from the model method as the controller method has no idea what would be the return value from the model method. We have done refactoring for this which is explained in the Modified files and Refactorization section.

2) In the ''Save'' method inside the response controller, changes are made which are specific to awarded badge model. But those changes should be part of a method present inside the awarded badge model and the controller should call that method. Changes are made for the same which are described in the below section.

3) There are code climate issues that are being fixed and are described in detail in the below section.

== Modified Files and Refactorization ==
A. '''response_controller.rb''' 

'''authorize_show_calibration_results'''
This method is used to authorize if the user(reviewer) is allowed to view the calibration results for the corresponding
''calibration_response_map_id'' and ''review_response_map_id''
passed as parameters in the URL.
Ex: https://expertiza.ncsu.edu/response/show_calibration_results_for_student?calibration_response_map_id=165688&review_response_map_id=165790
When someone tries to change the map_id's, the request should be authorized to check if the user can access the calibration result or not. 
[[File:Authorize_show_calibration_results.png|1180px|]]

'''set_response'''
@response and @map instance variables are initialized the same way across multiple methods.
In order to avoid duplication, we created a before_action action which will be called first before calling the corresponding methods.
[[File:Set_response_method.png|1170px|]]

B. '''response_helper.rb''' 

Following methods are moved from the ''response_controller.rb'' class to ''response_helper.rb'' class since these methods are called from the
controller action methods.
i) '''current_user_is_reviewer'''
ii) '''sort_questions'''
iii) '''store_total_cake_score'''
iv) '''set_content''' 

[[File:Response_helper_1.png|1170px|]]

[[File:Response_helper_2.png|1170px|]]

C. '''assignment_questionnaire.rb''' 
'''get_questions_by_assignment_id'''
Parameters : assignment_id
When a user clicks on 'calibration results' from UI, questions in the assignment that has been reviewed are displayed.
A new method is added in the ''AssignmentQuestionnaire'' model class that returns the appropriate questions by querying the
''AssignmentQuestionnaire'' using the ''assignment_id''.
This method is added to separate the business logic of retrieving the questions from the controller class.

[[File: Get_questions_by_assignment_id.png|1170px|]]

D. '''awarded_badge.rb''' 
'''award_badge'''
Parameters : participant_id, badge_name
This method adds the ''badge_name'' to a specific ''participant_id'' in the AwardedBadges table.
A separate method is created in the ''AwardedBadges'' model class to avoid the controller class from knowing the business logic of adding a badge
name to a participant.

[[File:RespControllerAwardBadge.png|1170px|]]

[[File:AwardBadgeMethod.png|1170px|]]

E. '''cake.rb''' 
'''store_total_cake_score'''
This method clearly exposes the logic of retrieving the score for a cake question in the ''response_controller.rb'' class which is an incorrect
design.
So, a model class method ''get_total_score_for_questions'' is added and the same logic of iterating over the Cake questions is moved there.
Return results for this method remains same here.
[[File:Cake.png|1170px|]]

F. '''response.rb''' 
'''calibration_results_info'''
This method in ''response.rb'' model is completely removed because this method only adds more complexity to the model class.
We refactored the method ''show_calibration_results_for_student'' in the ''response_controller.rb'' class.
Previously, ''calibration_results_info'' was just doing nothing but getting responses using ''calibration_response_map_id'' and
''review_response_map_id'', and querying ''AssignmentQuestionnaire''.
Both of these operations can be done by using ''find'' method of model class and adding model class ''get_questions_by_assignment_id'' method.

'''create_or_get_response'''
Method name ''populate_new_response'' is changed to ''create_or_get_response'' to convey the functionality of the method.

[[File:Create_or_get_response.png|1170px|]]

G. '''Code Climate issues''' 
'''Update'''
Made changes to split a line into multiple lines because it is too long.
[[File:Update_line_long.png|1170px|]]

'''Create'''
Made changes to split a line into multiple lines because it is too long.
[[File:Create_line_long.png|1170px|]]

== Testing ==
This is a refactoring project, so we have refactored response controller while ensuring that existing tests don't break.
=== Running Tests ===
<pre>
rspec spec/controllers/response_controller_spec.rb
</pre>

[[File:Resp_test_p1.jpeg|800px|]]
[[File:Resp_test_p2.jpeg|800px|]]

=== UI Testing ===
1) Login using the following details. User Name: student432 Password: password

[[File:resp_p1.png|800px|]]

2) Click on the assignment Design Exercise pertaining to course CSC/ECE 517, Spring 2017

[[File:resp_p2.png|800px|]]

3) Click on other's work

[[File:resp_p3.png|800px|]]

4) Click on show calibration results, verify if the calibration results are displayed on the UI.

[[File:resp_p4.png|800px|]]

[[File:resp_p5.png|800px|]]

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/vamshi-chidara/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2327 here]

CSC/ECE 517 Spring 2022 - E2218: Refactor response controller

2022-03-27T22:28:29Z

Smulkur: /* Testing */

This page details project documentation for the CSC/ECE 517 Spring 2022, '''E2218 refactor response_controller.rb''' project.

== Background ==

A response is an object that is created when someone fills out a review rubric, such as when one writes a review, gives feedback to a reviewer, or fills out a survey. Responses to the individual rubric items are kept in Answer objects; each Answer object has a response_id to say what Response it is part of. Since response_controller needs to work with many kinds of responses, its code is pretty general. It is not the worst controller in the system, but it would be much clearer if its method names were more descriptive of what they do.

=== Mentor ===

Ed Gehringer, efg@ncsu.edu

=== Team Members ===

* Sai Naga Vamshi Chidara (schidar@ncsu.edu)
* Akhil Kumar Mengani (amengan@ncsu.edu)
* Samson Reddy Mulkur (smulkur@ncsu.edu)

=== Problem Statement ===

1) After providing a review of a particular project, calibration results are useful to differentiate the review given by the reviewer and that of the instructor's review for the same project. The main problem solved is to refactor the ''show_calibration_results_for_student'' method in the response controller. This method is called when the user clicks on show calibration results as shown in the UI Testing section.

Inside the ''show_calibration_results_for_student'' method, a call to the ''calibration_results_info'' method is made which is part of the response model. This particular method is returning three values calibration_response, review_response, questions. In general, it is not a good approach to return the array of three values from the model method as the controller method has no idea what would be the return value from the model method. We have done refactoring for this which is explained in the Modified files and Refactorization section.

2) In the ''Save'' method inside the response controller, changes are made which are specific to awarded badge model. But those changes should be part of a method present inside the awarded badge model and the controller should call that method. Changes are made for the same which are described in the below section.

3) There are code climate issues that are being fixed and are described in detail in the below section.

== Modified Files and Refactorization ==
A. '''response_controller.rb''' 

'''authorize_show_calibration_results'''
This method is used to authorize if the user(reviewer) is allowed to view the calibration results for the corresponding
''calibration_response_map_id'' and ''review_response_map_id''
passed as parameters in the URL.
Ex: https://expertiza.ncsu.edu/response/show_calibration_results_for_student?calibration_response_map_id=165688&review_response_map_id=165790
When someone tries to change the map_id's, the request should be authorized to check if the user can access the calibration result or not. 
[[File:Authorize_show_calibration_results.png|1180px|]]

'''set_response'''
@response and @map instance variables are initialized the same way across multiple methods.
In order to avoid duplication, we created a before_action action which will be called first before calling the corresponding methods.
[[File:Set_response_method.png|1170px|]]

B. '''response_helper.rb''' 

Following methods are moved from the ''response_controller.rb'' class to ''response_helper.rb'' class since these methods are called from the
controller action methods.
i) '''current_user_is_reviewer'''
ii) '''sort_questions'''
iii) '''store_total_cake_score'''
iv) '''set_content''' 

[[File:Response_helper_1.png|1170px|]]

[[File:Response_helper_2.png|1170px|]]

C. '''assignment_questionnaire.rb''' 
'''get_questions_by_assignment_id'''
Parameters : assignment_id
When a user clicks on 'calibration results' from UI, questions in the assignment that has been reviewed are displayed.
A new method is added in the ''AssignmentQuestionnaire'' model class that returns the appropriate questions by querying the
''AssignmentQuestionnaire'' using the ''assignment_id''.
This method is added to separate the business logic of retrieving the questions from the controller class.

[[File: Get_questions_by_assignment_id.png|1170px|]]

D. '''awarded_badge.rb''' 
'''award_badge'''
Parameters : participant_id, badge_name
This method adds the ''badge_name'' to a specific ''participant_id'' in the AwardedBadges table.
A separate method is created in the ''AwardedBadges'' model class to avoid the controller class from knowing the business logic of adding a badge
name to a participant.

[[File:RespControllerAwardBadge.png|1170px|]]

[[File:AwardBadgeMethod.png|1170px|]]

E. '''cake.rb''' 
'''store_total_cake_score'''
This method clearly exposes the logic of retrieving the score for a cake question in the ''response_controller.rb'' class which is an incorrect
design.
So, a model class method ''get_total_score_for_questions'' is added and the same logic of iterating over the Cake questions is moved there.
Return results for this method remains same here.
[[File:Cake.png|1170px|]]

F. '''response.rb''' 
'''calibration_results_info'''
This method in ''response.rb'' model is completely removed because this method only adds more complexity to the model class.
We refactored the method ''show_calibration_results_for_student'' in the ''response_controller.rb'' class.
Previously, ''calibration_results_info'' was just doing nothing but getting responses using ''calibration_response_map_id'' and
''review_response_map_id'', and querying ''AssignmentQuestionnaire''.
Both of these operations can be done by using ''find'' method of model class and adding model class ''get_questions_by_assignment_id'' method.

'''create_or_get_response'''
Method name ''populate_new_response'' is changed to ''create_or_get_response'' to convey the functionality of the method.

[[File:Create_or_get_response.png|1170px|]]

G. '''Code Climate issues''' 
'''Update'''
Made changes to split a line into multiple lines because it is too long.
[[File:Update_line_long.png|1170px|]]

'''Create'''
Made changes to split a line into multiple lines because it is too long.
[[File:Create_line_long.png|1170px|]]

== Testing ==
This is a refactoring project, so we have refactored response controller while ensuring that existing tests don't break.
=== Running Tests ===
<pre>
rspec spec/controllers/response_controller_spec.rb
</pre>

<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>

[[File:Resp_test_p1.jpeg|800px|]]
[[File:Resp_test_p2.jpeg|800px|]]

=== UI Testing ===
1) Login using the following details. User Name: student432 Password: password

[[File:resp_p1.png|800px|]]

2) Click on the assignment Design Exercise pertaining to course CSC/ECE 517, Spring 2017

[[File:resp_p2.png|800px|]]

3) Click on other's work

[[File:resp_p3.png|800px|]]

4) Click on show calibration results, verify if the calibration results are displayed on the UI.

[[File:resp_p4.png|800px|]]

[[File:resp_p5.png|800px|]]

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/vamshi-chidara/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2327 here]

File:Resp test p2.jpeg

2022-03-27T22:27:58Z

Smulkur:

File:Resp test p1.jpeg

2022-03-27T22:27:37Z

Smulkur:

CSC/ECE 517 Spring 2022 - E2218: Refactor response controller

2022-03-27T22:24:27Z

Smulkur: /* Testing */

This page details project documentation for the CSC/ECE 517 Spring 2022, '''E2218 refactor response_controller.rb''' project.

== Background ==

A response is an object that is created when someone fills out a review rubric, such as when one writes a review, gives feedback to a reviewer, or fills out a survey. Responses to the individual rubric items are kept in Answer objects; each Answer object has a response_id to say what Response it is part of. Since response_controller needs to work with many kinds of responses, its code is pretty general. It is not the worst controller in the system, but it would be much clearer if its method names were more descriptive of what they do.

=== Mentor ===

Ed Gehringer, efg@ncsu.edu

=== Team Members ===

* Sai Naga Vamshi Chidara (schidar@ncsu.edu)
* Akhil Kumar Mengani (amengan@ncsu.edu)
* Samson Reddy Mulkur (smulkur@ncsu.edu)

=== Problem Statement ===

1) After providing a review of a particular project, calibration results are useful to differentiate the review given by the reviewer and that of the instructor's review for the same project. The main problem solved is to refactor the ''show_calibration_results_for_student'' method in the response controller. This method is called when the user clicks on show calibration results as shown in the UI Testing section.

Inside the ''show_calibration_results_for_student'' method, a call to the ''calibration_results_info'' method is made which is part of the response model. This particular method is returning three values calibration_response, review_response, questions. In general, it is not a good approach to return the array of three values from the model method as the controller method has no idea what would be the return value from the model method. We have done refactoring for this which is explained in the Modified files and Refactorization section.

2) In the ''Save'' method inside the response controller, changes are made which are specific to awarded badge model. But those changes should be part of a method present inside the awarded badge model and the controller should call that method. Changes are made for the same which are described in the below section.

3) There are code climate issues that are being fixed and are described in detail in the below section.

== Modified Files and Refactorization ==
A. '''response_controller.rb''' 

'''authorize_show_calibration_results'''
This method is used to authorize if the user(reviewer) is allowed to view the calibration results for the corresponding
''calibration_response_map_id'' and ''review_response_map_id''
passed as parameters in the URL.
Ex: https://expertiza.ncsu.edu/response/show_calibration_results_for_student?calibration_response_map_id=165688&review_response_map_id=165790
When someone tries to change the map_id's, the request should be authorized to check if the user can access the calibration result or not. 
[[File:Authorize_show_calibration_results.png|1180px|]]

'''set_response'''
@response and @map instance variables are initialized the same way across multiple methods.
In order to avoid duplication, we created a before_action action which will be called first before calling the corresponding methods.
[[File:Set_response_method.png|1170px|]]

B. '''response_helper.rb''' 

Following methods are moved from the ''response_controller.rb'' class to ''response_helper.rb'' class since these methods are called from the
controller action methods.
i) '''current_user_is_reviewer'''
ii) '''sort_questions'''
iii) '''store_total_cake_score'''
iv) '''set_content''' 

[[File:Response_helper_1.png|1170px|]]

[[File:Response_helper_2.png|1170px|]]

C. '''assignment_questionnaire.rb''' 
'''get_questions_by_assignment_id'''
Parameters : assignment_id
When a user clicks on 'calibration results' from UI, questions in the assignment that has been reviewed are displayed.
A new method is added in the ''AssignmentQuestionnaire'' model class that returns the appropriate questions by querying the
''AssignmentQuestionnaire'' using the ''assignment_id''.
This method is added to separate the business logic of retrieving the questions from the controller class.

[[File: Get_questions_by_assignment_id.png|1170px|]]

D. '''awarded_badge.rb''' 
'''award_badge'''
Parameters : participant_id, badge_name
This method adds the ''badge_name'' to a specific ''participant_id'' in the AwardedBadges table.
A separate method is created in the ''AwardedBadges'' model class to avoid the controller class from knowing the business logic of adding a badge
name to a participant.

[[File:RespControllerAwardBadge.png|1170px|]]

[[File:AwardBadgeMethod.png|1170px|]]

E. '''cake.rb''' 
'''store_total_cake_score'''
This method clearly exposes the logic of retrieving the score for a cake question in the ''response_controller.rb'' class which is an incorrect
design.
So, a model class method ''get_total_score_for_questions'' is added and the same logic of iterating over the Cake questions is moved there.
Return results for this method remains same here.
[[File:Cake.png|1170px|]]

F. '''response.rb''' 
'''calibration_results_info'''
This method in ''response.rb'' model is completely removed because this method only adds more complexity to the model class.
We refactored the method ''show_calibration_results_for_student'' in the ''response_controller.rb'' class.
Previously, ''calibration_results_info'' was just doing nothing but getting responses using ''calibration_response_map_id'' and
''review_response_map_id'', and querying ''AssignmentQuestionnaire''.
Both of these operations can be done by using ''find'' method of model class and adding model class ''get_questions_by_assignment_id'' method.

'''create_or_get_response'''
Method name ''populate_new_response'' is changed to ''create_or_get_response'' to convey the functionality of the method.

[[File:Create_or_get_response.png|1170px|]]

G. '''Code Climate issues''' 
'''Update'''
Made changes to split a line into multiple lines because it is too long.
[[File:Update_line_long.png|1170px|]]

'''Create'''
Made changes to split a line into multiple lines because it is too long.
[[File:Create_line_long.png|1170px|]]

== Testing ==
This is a refactoring project, so we have refactored response controller while ensuring that existing tests don't break.
=== Running Tests ===
<pre>
rspec spec/controllers/response_controller_spec.rb
</pre>

<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>

[[File:Resp_test_p1.png|800px|]]
[[File:Resp_test_p2.png|800px|]]

=== UI Testing ===
1) Login using the following details. User Name: student432 Password: password

[[File:resp_p1.png|800px|]]

2) Click on the assignment Design Exercise pertaining to course CSC/ECE 517, Spring 2017

[[File:resp_p2.png|800px|]]

3) Click on other's work

[[File:resp_p3.png|800px|]]

4) Click on show calibration results, verify if the calibration results are displayed on the UI.

[[File:resp_p4.png|800px|]]

[[File:resp_p5.png|800px|]]

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/vamshi-chidara/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2327 here]

CSC/ECE 517 Spring 2022 - E2218: Refactor response controller

2022-03-27T22:14:41Z

Smulkur: /* Problem Statement */

This page details project documentation for the CSC/ECE 517 Spring 2022, '''E2218 refactor response_controller.rb''' project.

== Background ==

A response is an object that is created when someone fills out a review rubric, such as when one writes a review, gives feedback to a reviewer, or fills out a survey. Responses to the individual rubric items are kept in Answer objects; each Answer object has a response_id to say what Response it is part of. Since response_controller needs to work with many kinds of responses, its code is pretty general. It is not the worst controller in the system, but it would be much clearer if its method names were more descriptive of what they do.

=== Mentor ===

Ed Gehringer, efg@ncsu.edu

=== Team Members ===

* Sai Naga Vamshi Chidara (schidar@ncsu.edu)
* Akhil Kumar Mengani (amengan@ncsu.edu)
* Samson Reddy Mulkur (smulkur@ncsu.edu)

=== Problem Statement ===

1) After providing a review of a particular project, calibration results are useful to differentiate the review given by the reviewer and that of the instructor's review for the same project. The main problem solved is to refactor the ''show_calibration_results_for_student'' method in the response controller. This method is called when the user clicks on show calibration results as shown in the UI Testing section.

Inside the ''show_calibration_results_for_student'' method, a call to the ''calibration_results_info'' method is made which is part of the response model. This particular method is returning three values calibration_response, review_response, questions. In general, it is not a good approach to return the array of three values from the model method as the controller method has no idea what would be the return value from the model method. We have done refactoring for this which is explained in the Modified files and Refactorization section.

2) In the ''Save'' method inside the response controller, changes are made which are specific to awarded badge model. But those changes should be part of a method present inside the awarded badge model and the controller should call that method. Changes are made for the same which are described in the below section.

3) There are code climate issues that are being fixed and are described in detail in the below section.

== Modified Files and Refactorization ==
A. '''response_controller.rb''' 

'''authorize_show_calibration_results'''
This method is used to authorize if the user(reviewer) is allowed to view the calibration results for the corresponding
''calibration_response_map_id'' and ''review_response_map_id''
passed as parameters in the URL.
Ex: https://expertiza.ncsu.edu/response/show_calibration_results_for_student?calibration_response_map_id=165688&review_response_map_id=165790
When someone tries to change the map_id's, the request should be authorized to check if the user can access the calibration result or not. 
[[File:Authorize_show_calibration_results.png|1180px|]]

'''set_response'''
@response and @map instance variables are initialized the same way across multiple methods.
In order to avoid duplication, we created a before_action action which will be called first before calling the corresponding methods.
[[File:Set_response_method.png|1170px|]]

B. '''response_helper.rb''' 

Following methods are moved from the ''response_controller.rb'' class to ''response_helper.rb'' class since these methods are called from the
controller action methods.
i) '''current_user_is_reviewer'''
ii) '''sort_questions'''
iii) '''store_total_cake_score'''
iv) '''set_content''' 

[[File:Response_helper_1.png|1170px|]]

[[File:Response_helper_2.png|1170px|]]

C. '''assignment_questionnaire.rb''' 
'''get_questions_by_assignment_id'''
Parameters : assignment_id
When a user clicks on 'calibration results' from UI, questions in the assignment that has been reviewed are displayed.
A new method is added in the ''AssignmentQuestionnaire'' model class that returns the appropriate questions by querying the
''AssignmentQuestionnaire'' using the ''assignment_id''.
This method is added to separate the business logic of retrieving the questions from the controller class.

[[File: Get_questions_by_assignment_id.png|1170px|]]

D. '''awarded_badge.rb''' 
'''award_badge'''
Parameters : participant_id, badge_name
This method adds the ''badge_name'' to a specific ''participant_id'' in the AwardedBadges table.
A separate method is created in the ''AwardedBadges'' model class to avoid the controller class from knowing the business logic of adding a badge
name to a participant.

[[File:RespControllerAwardBadge.png|1170px|]]

[[File:AwardBadgeMethod.png|1170px|]]

E. '''cake.rb''' 
'''store_total_cake_score'''
This method clearly exposes the logic of retrieving the score for a cake question in the ''response_controller.rb'' class which is an incorrect
design.
So, a model class method ''get_total_score_for_questions'' is added and the same logic of iterating over the Cake questions is moved there.
Return results for this method remains same here.
[[File:Cake.png|1170px|]]

F. '''response.rb''' 
'''calibration_results_info'''
This method in ''response.rb'' model is completely removed because this method only adds more complexity to the model class.
We refactored the method ''show_calibration_results_for_student'' in the ''response_controller.rb'' class.
Previously, ''calibration_results_info'' was just doing nothing but getting responses using ''calibration_response_map_id'' and
''review_response_map_id'', and querying ''AssignmentQuestionnaire''.
Both of these operations can be done by using ''find'' method of model class and adding model class ''get_questions_by_assignment_id'' method.

'''create_or_get_response'''
Method name ''populate_new_response'' is changed to ''create_or_get_response'' to convey the functionality of the method.

[[File:Create_or_get_response.png|1170px|]]

G. '''Code Climate issues''' 
'''Update'''
Made changes to split a line into multiple lines because it is too long.
[[File:Update_line_long.png|1170px|]]

'''Create'''
Made changes to split a line into multiple lines because it is too long.
[[File:Create_line_long.png|1170px|]]

== Testing ==
This is a refactoring project, so we have refactored response controller while ensuring that existing tests don't break.
=== Running Tests ===
<pre>
rspec spec/controllers/response_controller_spec.rb
</pre>

<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>

=== UI Testing ===
1) Login using the following details. User Name: student432 Password: password

[[File:resp_p1.png|800px|]]

2) Click on the assignment Design Exercise pertaining to course CSC/ECE 517, Spring 2017

[[File:resp_p2.png|800px|]]

3) Click on other's work

[[File:resp_p3.png|800px|]]

4) Click on show calibration results, verify if the calibration results are displayed on the UI.

[[File:resp_p4.png|800px|]]

[[File:resp_p5.png|800px|]]

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/vamshi-chidara/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2327 here]

CSC/ECE 517 Spring 2022 - E2218: Refactor response controller

2022-03-27T22:14:07Z

Smulkur:

This page details project documentation for the CSC/ECE 517 Spring 2022, '''E2218 refactor response_controller.rb''' project.

== Background ==

A response is an object that is created when someone fills out a review rubric, such as when one writes a review, gives feedback to a reviewer, or fills out a survey. Responses to the individual rubric items are kept in Answer objects; each Answer object has a response_id to say what Response it is part of. Since response_controller needs to work with many kinds of responses, its code is pretty general. It is not the worst controller in the system, but it would be much clearer if its method names were more descriptive of what they do.

=== Mentor ===

Ed Gehringer, efg@ncsu.edu

=== Team Members ===

* Sai Naga Vamshi Chidara (schidar@ncsu.edu)
* Akhil Kumar Mengani (amengan@ncsu.edu)
* Samson Reddy Mulkur (smulkur@ncsu.edu)

=== Problem Statement ===

1) After providing a review of a particular project, calibration results are useful to differentiate the review given by the reviewer and that of the instructor's review for the same project. The main problem solved is to refactor the '''show_calibration_results_for_student''' method in the response controller. This method is called when the user clicks on show calibration results as shown in the UI Testing section.

Inside the '''show_calibration_results_for_student''' method, a call to the '''calibration_results_info''' method is made which is part of the response model. This particular method is returning three values calibration_response, review_response, questions. In general, it is not a good approach to return the array of three values from the model method as the controller method has no idea what would be the return value from the model method. We have done refactoring for this which is explained in the Modified files and Refactorization section.

2) In the '''Save''' method inside the response controller, changes are made which are specific to awarded badge model. But those changes should be part of a method present inside the awarded badge model and the controller should call that method. Changes are made for the same which are described in the below section.

3) There are code climate issues that are being fixed and are described in detail in the below section.

== Modified Files and Refactorization ==
A. '''response_controller.rb''' 

'''authorize_show_calibration_results'''
This method is used to authorize if the user(reviewer) is allowed to view the calibration results for the corresponding
''calibration_response_map_id'' and ''review_response_map_id''
passed as parameters in the URL.
Ex: https://expertiza.ncsu.edu/response/show_calibration_results_for_student?calibration_response_map_id=165688&review_response_map_id=165790
When someone tries to change the map_id's, the request should be authorized to check if the user can access the calibration result or not. 
[[File:Authorize_show_calibration_results.png|1180px|]]

'''set_response'''
@response and @map instance variables are initialized the same way across multiple methods.
In order to avoid duplication, we created a before_action action which will be called first before calling the corresponding methods.
[[File:Set_response_method.png|1170px|]]

B. '''response_helper.rb''' 

Following methods are moved from the ''response_controller.rb'' class to ''response_helper.rb'' class since these methods are called from the
controller action methods.
i) '''current_user_is_reviewer'''
ii) '''sort_questions'''
iii) '''store_total_cake_score'''
iv) '''set_content''' 

[[File:Response_helper_1.png|1170px|]]

[[File:Response_helper_2.png|1170px|]]

C. '''assignment_questionnaire.rb''' 
'''get_questions_by_assignment_id'''
Parameters : assignment_id
When a user clicks on 'calibration results' from UI, questions in the assignment that has been reviewed are displayed.
A new method is added in the ''AssignmentQuestionnaire'' model class that returns the appropriate questions by querying the
''AssignmentQuestionnaire'' using the ''assignment_id''.
This method is added to separate the business logic of retrieving the questions from the controller class.

[[File: Get_questions_by_assignment_id.png|1170px|]]

D. '''awarded_badge.rb''' 
'''award_badge'''
Parameters : participant_id, badge_name
This method adds the ''badge_name'' to a specific ''participant_id'' in the AwardedBadges table.
A separate method is created in the ''AwardedBadges'' model class to avoid the controller class from knowing the business logic of adding a badge
name to a participant.

[[File:RespControllerAwardBadge.png|1170px|]]

[[File:AwardBadgeMethod.png|1170px|]]

E. '''cake.rb''' 
'''store_total_cake_score'''
This method clearly exposes the logic of retrieving the score for a cake question in the ''response_controller.rb'' class which is an incorrect
design.
So, a model class method ''get_total_score_for_questions'' is added and the same logic of iterating over the Cake questions is moved there.
Return results for this method remains same here.
[[File:Cake.png|1170px|]]

F. '''response.rb''' 
'''calibration_results_info'''
This method in ''response.rb'' model is completely removed because this method only adds more complexity to the model class.
We refactored the method ''show_calibration_results_for_student'' in the ''response_controller.rb'' class.
Previously, ''calibration_results_info'' was just doing nothing but getting responses using ''calibration_response_map_id'' and
''review_response_map_id'', and querying ''AssignmentQuestionnaire''.
Both of these operations can be done by using ''find'' method of model class and adding model class ''get_questions_by_assignment_id'' method.

'''create_or_get_response'''
Method name ''populate_new_response'' is changed to ''create_or_get_response'' to convey the functionality of the method.

[[File:Create_or_get_response.png|1170px|]]

G. '''Code Climate issues''' 
'''Update'''
Made changes to split a line into multiple lines because it is too long.
[[File:Update_line_long.png|1170px|]]

'''Create'''
Made changes to split a line into multiple lines because it is too long.
[[File:Create_line_long.png|1170px|]]

== Testing ==
This is a refactoring project, so we have refactored response controller while ensuring that existing tests don't break.
=== Running Tests ===
<pre>
rspec spec/controllers/response_controller_spec.rb
</pre>

<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>

=== UI Testing ===
1) Login using the following details. User Name: student432 Password: password

[[File:resp_p1.png|800px|]]

2) Click on the assignment Design Exercise pertaining to course CSC/ECE 517, Spring 2017

[[File:resp_p2.png|800px|]]

3) Click on other's work

[[File:resp_p3.png|800px|]]

4) Click on show calibration results, verify if the calibration results are displayed on the UI.

[[File:resp_p4.png|800px|]]

[[File:resp_p5.png|800px|]]

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/vamshi-chidara/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2327 here]

CSC/ECE 517 Spring 2022 - E2218: Refactor response controller

2022-03-27T22:08:19Z

Smulkur: In

This page details project documentation for the CSC/ECE 517 Spring 2022, '''E2218 refactor response_controller.rb''' project.

== Background ==

A response is the object that is created when someone fills out a review rubric, such as when one writes a review, gives feedback to a reviewer, or fills out a survey. Responses to the individual rubric items are kept in Answer objects; each Answer object has a response_id to say what Response it is part of. Since response_controller needs to work with many kinds of responses, its code is pretty general. It is not the worst controller in the system, but it would be much clearer if its method names were more descriptive of what they do.

=== Mentor ===

Ed Gehringer, efg@ncsu.edu

=== Team Members ===

* Sai Naga Vamshi Chidara (schidar@ncsu.edu)
* Akhil Kumar Mengani (amengan@ncsu.edu)
* Samson Reddy Mulkur (smulkur@ncsu.edu)

=== Problem Statement ===

1) After providing a review of a particular project, calibration results are useful to differentiate the review given by the reviewer and that of the instructor's review for the same project. The main problem solved is to refactor the show_calibration_results_for_student method in the response controller. This method is called when the user clicks on show calibration results as shown in the UI Testing section.

Inside the show_calibration_results_for_student method, a call to the calibration_results_info method is made which is part of the response model. This particular method is returning three values calibration_response, review_response, questions. In general, it is not a good approach to return the array of three values from the model method as the controller method has no idea what would be the return value from the model method. We have done refactoring for this which is explained in the Modified files and Refactorization section.

2) In the Save method inside the response controller, changes are made which are specific to awarded badge model. But those changes should be part of a method present inside the awarded badge method and the controller should call that method. Changes are made for the same which are described in the below section.

3) There are code climate issues that are being fixed and are described in detail in the below section.

== Modified Files and Refactorization ==
A. '''response_controller.rb''' 

'''authorize_show_calibration_results'''
This method is used to authorize if the user(reviewer) is allowed to view the calibration results for the corresponding
''calibration_response_map_id'' and ''review_response_map_id''
passed as parameters in the URL.
Ex: https://expertiza.ncsu.edu/response/show_calibration_results_for_student?calibration_response_map_id=165688&review_response_map_id=165790
When someone tries to change the map_id's, the request should be authorized to check if the user can access the calibration result or not. 
[[File:Authorize_show_calibration_results.png|1180px|]]

'''set_response'''
@response and @map instance variables are initialized the same way across multiple methods.
In order to avoid duplication, we created a before_action action which will be called first before calling the corresponding methods.
[[File:Set_response_method.png|1170px|]]

B. '''response_helper.rb''' 

Following methods are moved from the ''response_controller.rb'' class to ''response_helper.rb'' class since these methods are called from the
controller action methods.
i) '''current_user_is_reviewer'''
ii) '''sort_questions'''
iii) '''store_total_cake_score'''
iv) '''set_content''' 

[[File:Response_helper_1.png|1170px|]]

[[File:Response_helper_2.png|1170px|]]

C. '''assignment_questionnaire.rb''' 
'''get_questions_by_assignment_id'''
Parameters : assignment_id
When a user clicks on 'calibration results' from UI, questions in the assignment that has been reviewed are displayed.
A new method is added in the ''AssignmentQuestionnaire'' model class that returns the appropriate questions by querying the
''AssignmentQuestionnaire'' using the ''assignment_id''.
This method is added to separate the business logic of retrieving the questions from the controller class.

[[File: Get_questions_by_assignment_id.png|1170px|]]

D. '''awarded_badge.rb''' 
'''award_badge'''
Parameters : participant_id, badge_name
This method adds the ''badge_name'' to a specific ''participant_id'' in the AwardedBadges table.
A separate method is created in the ''AwardedBadges'' model class to avoid the controller class from knowing the business logic of adding a badge
name to a participant.

[[File:RespControllerAwardBadge.png|1170px|]]

[[File:AwardBadgeMethod.png|1170px|]]

E. '''cake.rb''' 
'''store_total_cake_score'''
This method clearly exposes the logic of retrieving the score for a cake question in the ''response_controller.rb'' class which is an incorrect
design.
So, a model class method ''get_total_score_for_questions'' is added and the same logic of iterating over the Cake questions is moved there.
Return results for this method remains same here.
[[File:Cake.png|1170px|]]

F. '''response.rb''' 
'''calibration_results_info'''
This method in ''response.rb'' model is completely removed because this method only adds more complexity to the model class.
We refactored the method ''show_calibration_results_for_student'' in the ''response_controller.rb'' class.
Previously, ''calibration_results_info'' was just doing nothing but getting responses using ''calibration_response_map_id'' and
''review_response_map_id'', and querying ''AssignmentQuestionnaire''.
Both of these operations can be done by using ''find'' method of model class and adding model class ''get_questions_by_assignment_id'' method.

'''create_or_get_response'''
Method name ''populate_new_response'' is changed to ''create_or_get_response'' to convey the functionality of the method.

[[File:Create_or_get_response.png|1170px|]]

G. '''Code Climate issues''' 
'''Update'''
Made changes to split a line into multiple lines because it is too long.
[[File:Update_line_long.png|1170px|]]

'''Create'''
Made changes to split a line into multiple lines because it is too long.
[[File:Create_line_long.png|1170px|]]

== Testing ==
This is a refactoring project, so we have refactored response controller while ensuring that existing tests don't break.
=== Running Tests ===
<pre>
rspec spec/controllers/response_controller_spec.rb
</pre>

<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>

=== UI Testing ===
1) Login using the following details. User Name: student432 Password: password

[[File:resp_p1.png|800px|]]

2) Click on the assignment Design Exercise pertaining to course CSC/ECE 517, Spring 2017

[[File:resp_p2.png|800px|]]

3) Click on other's work

[[File:resp_p3.png|800px|]]

4) Click on show calibration results, verify if the calibration results are displayed on the UI.

[[File:resp_p4.png|800px|]]

[[File:resp_p5.png|800px|]]

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/vamshi-chidara/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2327 here]

CSC/ECE 517 Spring 2022 - E2218: Refactor response controller

2022-03-22T22:26:30Z

Smulkur: /* UI Testing */

This page details project documentation for the CSC/ECE 517 Spring 2022, '''E2218 refactor response_controller.rb''' project.

== Background ==

A response is the object that is created when someone fills out a review rubric, such as when one writes a review, gives feedback to a reviewer, or fills out a survey. Responses to the individual rubric items are kept in Answer objects; each Answer object has a response_id to say what Response it is part of. Since response_controller needs to work with many kinds of responses, its code is pretty general. It is not the worst controller in the system, but it would be much clearer if its method names were more descriptive of what they do.

=== Mentor ===

Ed Gehringer, efg@ncsu.edu

=== Team Members ===

* Sai Naga Vamshi Chidara (schidar@ncsu.edu)
* Akhil Kumar Mengani (amengan@ncsu.edu)
* Samson Reddy Mulkur (smulkur@ncsu.edu)

== Modified Files and Refactorization ==
A. '''response_controller.rb''' 

'''authorize_show_calibration_results'''
This method is used to authorize if the user(reviewer) is allowed to view the calibration results for the corresponding
''calibration_response_map_id'' and ''review_response_map_id''
passed as parameters in the URL.
Ex: https://expertiza.ncsu.edu/response/show_calibration_results_for_student?calibration_response_map_id=165688&review_response_map_id=165790
When someone tries to change the map_id's, the request should be authorized to check if the user can access the calibration result or not. 
[[File:Authorize_show_calibration_results.png|1180px|]]

'''set_response'''
@response and @map instance variables are initialized the same way across multiple methods.
In order to avoid duplication, we created a before_action action which will be called first before calling the corresponding methods.
[[File:Set_response_method.png|1170px|]]

B. '''response_helper.rb''' 

Following methods are moved from the ''response_controller.rb'' class to ''response_helper.rb'' class since these methods are called from the
controller action methods.
i) '''current_user_is_reviewer'''
ii) '''sort_questions'''
iii) '''store_total_cake_score'''
iv) '''set_content''' 

[[File:Response_helper_1.png|1170px|]]

[[File:Response_helper_2.png|1170px|]]

C. '''assignment_questionnaire.rb''' 
'''get_questions_by_assignment_id'''
Parameters : assignment_id
When a user clicks on 'calibration results' from UI, questions in the assignment that has been reviewed are displayed.
A new method is added in the ''AssignmentQuestionnaire'' model class that returns the appropriate questions by querying the
''AssignmentQuestionnaire'' using the ''assignment_id''.
This method is added to separate the business logic of retrieving the questions from the controller class.

[[File: Get_questions_by_assignment_id.png|1170px|]]

D. '''awarded_badge.rb''' 
'''award_badge'''
Parameters : participant_id, badge_name
This method adds the ''badge_name'' to a specific ''participant_id'' in the AwardedBadges table.
A separate method is created in the ''AwardedBadges'' model class to avoid the controller class from knowing the business logic of adding a badge
name to a participant.

[[File:RespControllerAwardBadge.png|1170px|]]

[[File:AwardBadgeMethod.png|1170px|]]

E. '''cake.rb''' 
'''store_total_cake_score'''
This method clearly exposes the logic of retrieving the score for a cake question in the ''response_controller.rb'' class which is an incorrect
design.
So, a model class method ''get_total_score_for_questions'' is added and the same logic of iterating over the Cake questions is moved there.
Return results for this method remains same here.
[[File:Cake.png|1170px|]]

F. '''response.rb''' 
'''calibration_results_info'''
This method in ''response.rb'' model is completely removed because this method only adds more complexity to the model class.
We refactored the method ''show_calibration_results_for_student'' in the ''response_controller.rb'' class.
Previously, ''calibration_results_info'' was just doing nothing but getting responses using ''calibration_response_map_id'' and
''review_response_map_id'', and querying ''AssignmentQuestionnaire''.
Both of these operations can be done by using ''find'' method of model class and adding model class ''get_questions_by_assignment_id'' method.

'''create_or_get_response'''
Method name ''populate_new_response'' is changed to ''create_or_get_response'' to convey the functionality of the method.

[[File:Create_or_get_response.png|1170px|]]

G. '''Code Climate issues''' 
'''Update'''
Made changes to split a line into multiple lines because it is too long.
[[File:Update_line_long.png|1170px|]]

'''Create'''
Made changes to split a line into multiple lines because it is too long.
[[File:Create_line_long.png|1170px|]]

== Testing ==

=== Running Tests ===
<pre>
rspec spec/controllers/response_controller_spec.rb
</pre>

<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>

=== UI Testing ===
1) Login using the following details. User Name: student432 Password: password

[[File:resp_p1.png|800px|]]

2) Click on the assignment Design Exercise pertaining to course CSC/ECE 517, Spring 2017

[[File:resp_p2.png|800px|]]

3) Click on other's work

[[File:resp_p3.png|800px|]]

4) Click on show calibration results, verify if the calibration results are displayed on the UI.

[[File:resp_p4.png|800px|]]

[[File:resp_p5.png|800px|]]

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/vamshi-chidara/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2327 here]

File:Resp p5.png

2022-03-22T22:26:05Z

Smulkur:

CSC/ECE 517 Spring 2022 - E2218: Refactor response controller

2022-03-22T22:05:43Z

Smulkur: /* Running Tests */

This page details project documentation for the CSC/ECE 517 Spring 2022, '''E2218 refactor response_controller.rb''' project.

== Background ==

A response is the object that is created when someone fills out a review rubric, such as when one writes a review, gives feedback to a reviewer, or fills out a survey. Responses to the individual rubric items are kept in Answer objects; each Answer object has a response_id to say what Response it is part of. Since response_controller needs to work with many kinds of responses, its code is pretty general. It is not the worst controller in the system, but it would be much clearer if its method names were more descriptive of what they do.

=== Mentor ===

Ed Gehringer, efg@ncsu.edu

=== Team Members ===

* Sai Naga Vamshi Chidara (schidar@ncsu.edu)
* Akhil Kumar Mengani (amengan@ncsu.edu)
* Samson Reddy Mulkur (smulkur@ncsu.edu)

== Modified Files and Refactorization ==
A. '''response_controller.rb''' 

'''authorize_show_calibration_results'''
This method is used to authorize if the user(reviewer) is allowed to view the calibration results for the corresponding
''calibration_response_map_id'' and ''review_response_map_id''
passed as parameters in the URL.
Ex: https://expertiza.ncsu.edu/response/show_calibration_results_for_student?calibration_response_map_id=165688&review_response_map_id=165790
When someone tries to change the map_id's, the request should be authorized to check if the user can access the calibration result or not. 
[[File:Authorize_show_calibration_results.png|1180px|]]

'''set_response'''
@response and @map instance variables are initialized the same way across multiple methods.
In order to avoid duplication, we created a before_action action which will be called first before calling the corresponding methods.
[[File:Set_response_method.png|1170px|]]

B. '''response_helper.rb''' 

Following methods are moved from the ''response_controller.rb'' class to ''response_helper.rb'' class since these methods are called from the
controller action methods.
i) '''current_user_is_reviewer'''
ii) '''sort_questions'''
iii) '''store_total_cake_score'''
iv) '''set_content''' 

[[File:Response_helper_1.png|1170px|]]

[[File:Response_helper_2.png|1170px|]]

C. '''assignment_questionnaire.rb''' 
'''get_questions_by_assignment_id'''
Parameters : assignment_id
When a user clicks on 'calibration results' from UI, questions in the assignment that has been reviewed are displayed.
A new method is added in the ''AssignmentQuestionnaire'' model class that returns the appropriate questions by querying the
''AssignmentQuestionnaire'' using the ''assignment_id''.
This method is added to separate the business logic of retrieving the questions from the controller class.

[[File: Get_questions_by_assignment_id.png|1170px|]]

D. '''awarded_badge.rb''' 
'''award_badge'''
Parameters : participant_id, badge_name
This method adds the ''badge_name'' to a specific ''participant_id'' in the AwardedBadges table.
A separate method is created in the ''AwardedBadges'' model class to avoid the controller class from knowing the business logic of adding a badge
name to a participant.

[[File:RespControllerAwardBadge.png|1170px|]]

[[File:AwardBadgeMethod.png|1170px|]]

E. '''cake.rb''' 
'''store_total_cake_score'''
This method clearly exposes the logic of retrieving the score for a cake question in the ''response_controller.rb'' class which is an incorrect
design.
So, a model class method ''get_total_score_for_questions'' is added and the same logic of iterating over the Cake questions is moved there.
Return results for this method remains same here.
[[File:Cake.png|1170px|]]

F. '''response.rb''' 
'''calibration_results_info'''
This method in ''response.rb'' model is completely removed because this method only adds more complexity to the model class.
We refactored the method ''show_calibration_results_for_student'' in the ''response_controller.rb'' class.
Previously, ''calibration_results_info'' was just doing nothing but getting responses using ''calibration_response_map_id'' and
''review_response_map_id'', and querying ''AssignmentQuestionnaire''.
Both of these operations can be done by using ''find'' method of model class and adding model class ''get_questions_by_assignment_id'' method.

'''create_or_get_response'''
Method name ''populate_new_response'' is changed to ''create_or_get_response'' to convey the functionality of the method.

[[File:Create_or_get_response.png|1170px|]]

G. '''Code Climate issues''' 
'''Update'''
Made changes to split a line into multiple lines because it is too long.
[[File:Update_line_long.png|1170px|]]

'''Create'''
Made changes to split a line into multiple lines because it is too long.
[[File:Create_line_long.png|1170px|]]

== Testing ==

=== Running Tests ===
<pre>
rspec spec/controllers/response_controller_spec.rb
</pre>

<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>

=== UI Testing ===
1) Login using the following details. User Name: student432 Password: password

[[File:resp_p1.png|800px|]]

2) Click on the assignment Design Exercise pertaining to course CSC/ECE 517, Spring 2017

[[File:resp_p2.png|800px|]]

3) Click on other's work

[[File:resp_p3.png|800px|]]

4) Click on show calibration results, verify if the calibration results are displayed on the UI.

[[File:resp_p4.png|800px|]]

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/vamshi-chidara/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2327 here]

CSC/ECE 517 Spring 2022 - E2218: Refactor response controller

2022-03-22T22:05:11Z

Smulkur: /* Running Tests */

This page details project documentation for the CSC/ECE 517 Spring 2022, '''E2218 refactor response_controller.rb''' project.

== Background ==

A response is the object that is created when someone fills out a review rubric, such as when one writes a review, gives feedback to a reviewer, or fills out a survey. Responses to the individual rubric items are kept in Answer objects; each Answer object has a response_id to say what Response it is part of. Since response_controller needs to work with many kinds of responses, its code is pretty general. It is not the worst controller in the system, but it would be much clearer if its method names were more descriptive of what they do.

=== Mentor ===

Ed Gehringer, efg@ncsu.edu

=== Team Members ===

* Sai Naga Vamshi Chidara (schidar@ncsu.edu)
* Akhil Kumar Mengani (amengan@ncsu.edu)
* Samson Reddy Mulkur (smulkur@ncsu.edu)

== Modified Files and Refactorization ==
A. '''response_controller.rb''' 

'''authorize_show_calibration_results'''
This method is used to authorize if the user(reviewer) is allowed to view the calibration results for the corresponding
''calibration_response_map_id'' and ''review_response_map_id''
passed as parameters in the URL.
Ex: https://expertiza.ncsu.edu/response/show_calibration_results_for_student?calibration_response_map_id=165688&review_response_map_id=165790
When someone tries to change the map_id's, the request should be authorized to check if the user can access the calibration result or not. 
[[File:Authorize_show_calibration_results.png|1180px|]]

'''set_response'''
@response and @map instance variables are initialized the same way across multiple methods.
In order to avoid duplication, we created a before_action action which will be called first before calling the corresponding methods.
[[File:Set_response_method.png|1170px|]]

B. '''response_helper.rb''' 

Following methods are moved from the ''response_controller.rb'' class to ''response_helper.rb'' class since these methods are called from the
controller action methods.
i) '''current_user_is_reviewer'''
ii) '''sort_questions'''
iii) '''store_total_cake_score'''
iv) '''set_content''' 

[[File:Response_helper_1.png|1170px|]]

[[File:Response_helper_2.png|1170px|]]

C. '''assignment_questionnaire.rb''' 
'''get_questions_by_assignment_id'''
Parameters : assignment_id
When a user clicks on 'calibration results' from UI, questions in the assignment that has been reviewed are displayed.
A new method is added in the ''AssignmentQuestionnaire'' model class that returns the appropriate questions by querying the
''AssignmentQuestionnaire'' using the ''assignment_id''.
This method is added to separate the business logic of retrieving the questions from the controller class.

[[File: Get_questions_by_assignment_id.png|1170px|]]

D. '''awarded_badge.rb''' 
'''award_badge'''
Parameters : participant_id, badge_name
This method adds the ''badge_name'' to a specific ''participant_id'' in the AwardedBadges table.
A separate method is created in the ''AwardedBadges'' model class to avoid the controller class from knowing the business logic of adding a badge
name to a participant.

[[File:RespControllerAwardBadge.png|1170px|]]

[[File:AwardBadgeMethod.png|1170px|]]

E. '''cake.rb''' 
'''store_total_cake_score'''
This method clearly exposes the logic of retrieving the score for a cake question in the ''response_controller.rb'' class which is an incorrect
design.
So, a model class method ''get_total_score_for_questions'' is added and the same logic of iterating over the Cake questions is moved there.
Return results for this method remains same here.
[[File:Cake.png|1170px|]]

F. '''response.rb''' 
'''calibration_results_info'''
This method in ''response.rb'' model is completely removed because this method only adds more complexity to the model class.
We refactored the method ''show_calibration_results_for_student'' in the ''response_controller.rb'' class.
Previously, ''calibration_results_info'' was just doing nothing but getting responses using ''calibration_response_map_id'' and
''review_response_map_id'', and querying ''AssignmentQuestionnaire''.
Both of these operations can be done by using ''find'' method of model class and adding model class ''get_questions_by_assignment_id'' method.

'''create_or_get_response'''
Method name ''populate_new_response'' is changed to ''create_or_get_response'' to convey the functionality of the method.

[[File:Create_or_get_response.png|1170px|]]

G. '''Code Climate issues''' 
'''Update'''
Made changes to split a line into multiple lines because it is too long.
[[File:Update_line_long.png|1170px|]]

'''Create'''
Made changes to split a line into multiple lines because it is too long.
[[File:Create_line_long.png|1170px|]]

== Testing ==

=== Running Tests ===
<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>

=== UI Testing ===
1) Login using the following details. User Name: student432 Password: password

[[File:resp_p1.png|800px|]]

2) Click on the assignment Design Exercise pertaining to course CSC/ECE 517, Spring 2017

[[File:resp_p2.png|800px|]]

3) Click on other's work

[[File:resp_p3.png|800px|]]

4) Click on show calibration results, verify if the calibration results are displayed on the UI.

[[File:resp_p4.png|800px|]]

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/vamshi-chidara/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2327 here]

CSC/ECE 517 Spring 2022 - E2218: Refactor response controller

2022-03-22T22:03:43Z

Smulkur: /* UI Testing */

This page details project documentation for the CSC/ECE 517 Spring 2022, '''E2218 refactor response_controller.rb''' project.

== Background ==

A response is the object that is created when someone fills out a review rubric, such as when one writes a review, gives feedback to a reviewer, or fills out a survey. Responses to the individual rubric items are kept in Answer objects; each Answer object has a response_id to say what Response it is part of. Since response_controller needs to work with many kinds of responses, its code is pretty general. It is not the worst controller in the system, but it would be much clearer if its method names were more descriptive of what they do.

=== Mentor ===

Ed Gehringer, efg@ncsu.edu

=== Team Members ===

* Sai Naga Vamshi Chidara (schidar@ncsu.edu)
* Akhil Kumar Mengani (amengan@ncsu.edu)
* Samson Reddy Mulkur (smulkur@ncsu.edu)

== Modified Files and Refactorization ==
A. '''response_controller.rb''' 

'''authorize_show_calibration_results'''
This method is used to authorize if the user(reviewer) is allowed to view the calibration results for the corresponding
''calibration_response_map_id'' and ''review_response_map_id''
passed as parameters in the URL.
Ex: https://expertiza.ncsu.edu/response/show_calibration_results_for_student?calibration_response_map_id=165688&review_response_map_id=165790
When someone tries to change the map_id's, the request should be authorized to check if the user can access the calibration result or not. 
[[File:Authorize_show_calibration_results.png|1180px|]]

'''set_response'''
@response and @map instance variables are initialized the same way across multiple methods.
In order to avoid duplication, we created a before_action action which will be called first before calling the corresponding methods.
[[File:Set_response_method.png|1170px|]]

B. '''response_helper.rb''' 

Following methods are moved from the ''response_controller.rb'' class to ''response_helper.rb'' class since these methods are called from the
controller action methods.
i) '''current_user_is_reviewer'''
ii) '''sort_questions'''
iii) '''store_total_cake_score'''
iv) '''set_content''' 

[[File:Response_helper_1.png|1170px|]]

[[File:Response_helper_2.png|1170px|]]

C. '''assignment_questionnaire.rb''' 
'''get_questions_by_assignment_id'''
Parameters : assignment_id
When a user clicks on 'calibration results' from UI, questions in the assignment that has been reviewed are displayed.
A new method is added in the ''AssignmentQuestionnaire'' model class that returns the appropriate questions by querying the
''AssignmentQuestionnaire'' using the ''assignment_id''.
This method is added to separate the business logic of retrieving the questions from the controller class.

[[File: Get_questions_by_assignment_id.png|1170px|]]

D. '''awarded_badge.rb''' 
'''award_badge'''
Parameters : participant_id, badge_name
This method adds the ''badge_name'' to a specific ''participant_id'' in the AwardedBadges table.
A separate method is created in the ''AwardedBadges'' model class to avoid the controller class from knowing the business logic of adding a badge
name to a participant.

[[File:RespControllerAwardBadge.png|1170px|]]

[[File:AwardBadgeMethod.png|1170px|]]

E. '''cake.rb''' 
'''store_total_cake_score'''
This method clearly exposes the logic of retrieving the score for a cake question in the ''response_controller.rb'' class which is an incorrect
design.
So, a model class method ''get_total_score_for_questions'' is added and the same logic of iterating over the Cake questions is moved there.
Return results for this method remains same here.
[[File:Cake.png|1170px|]]

F. '''response.rb''' 
'''calibration_results_info'''
This method in ''response.rb'' model is completely removed because this method only adds more complexity to the model class.
We refactored the method ''show_calibration_results_for_student'' in the ''response_controller.rb'' class.
Previously, ''calibration_results_info'' was just doing nothing but getting responses using ''calibration_response_map_id'' and
''review_response_map_id'', and querying ''AssignmentQuestionnaire''.
Both of these operations can be done by using ''find'' method of model class and adding model class ''get_questions_by_assignment_id'' method.

'''create_or_get_response'''
Method name ''populate_new_response'' is changed to ''create_or_get_response'' to convey the functionality of the method.

[[File:Create_or_get_response.png|1170px|]]

G. '''Code Climate issues''' 
'''Update'''
Made changes to split a line into multiple lines because it is too long.
[[File:Update_line_long.png|1170px|]]

'''Create'''
Made changes to split a line into multiple lines because it is too long.
[[File:Create_line_long.png|1170px|]]

== Testing ==

=== Running Tests ===
<pre>
rspec spec/models/responses_spec.rb
</pre>
<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>

=== UI Testing ===
1) Login using the following details. User Name: student432 Password: password

[[File:resp_p1.png|800px|]]

2) Click on the assignment Design Exercise pertaining to course CSC/ECE 517, Spring 2017

[[File:resp_p2.png|800px|]]

3) Click on other's work

[[File:resp_p3.png|800px|]]

4) Click on show calibration results, verify if the calibration results are displayed on the UI.

[[File:resp_p4.png|800px|]]

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/vamshi-chidara/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2327 here]

CSC/ECE 517 Spring 2022 - E2218: Refactor response controller

2022-03-22T22:01:26Z

Smulkur: /* UI Testing */

This page details project documentation for the CSC/ECE 517 Spring 2022, '''E2218 refactor response_controller.rb''' project.

== Background ==

A response is the object that is created when someone fills out a review rubric, such as when one writes a review, gives feedback to a reviewer, or fills out a survey. Responses to the individual rubric items are kept in Answer objects; each Answer object has a response_id to say what Response it is part of. Since response_controller needs to work with many kinds of responses, its code is pretty general. It is not the worst controller in the system, but it would be much clearer if its method names were more descriptive of what they do.

=== Mentor ===

Ed Gehringer, efg@ncsu.edu

=== Team Members ===

* Sai Naga Vamshi Chidara (schidar@ncsu.edu)
* Akhil Kumar Mengani (amengan@ncsu.edu)
* Samson Reddy Mulkur (smulkur@ncsu.edu)

== Modified Files and Refactorization ==
A. '''response_controller.rb''' 

'''authorize_show_calibration_results'''
This method is used to authorize if the user(reviewer) is allowed to view the calibration results for the corresponding
''calibration_response_map_id'' and ''review_response_map_id''
passed as parameters in the URL.
Ex: https://expertiza.ncsu.edu/response/show_calibration_results_for_student?calibration_response_map_id=165688&review_response_map_id=165790
When someone tries to change the map_id's, the request should be authorized to check if the user can access the calibration result or not. 
[[File:Authorize_show_calibration_results.png|1180px|]]

'''set_response'''
@response and @map instance variables are initialized the same way across multiple methods.
In order to avoid duplication, we created a before_action action which will be called first before calling the corresponding methods.
[[File:Set_response_method.png|1170px|]]

B. '''response_helper.rb''' 

Following methods are moved from the ''response_controller.rb'' class to ''response_helper.rb'' class since these methods are called from the
controller action methods.
i) '''current_user_is_reviewer'''
ii) '''sort_questions'''
iii) '''store_total_cake_score'''
iv) '''set_content''' 

[[File:Response_helper_1.png|1170px|]]

[[File:Response_helper_2.png|1170px|]]

C. '''assignment_questionnaire.rb''' 
'''get_questions_by_assignment_id'''
Parameters : assignment_id
When a user clicks on 'calibration results' from UI, questions in the assignment that has been reviewed are displayed.
A new method is added in the ''AssignmentQuestionnaire'' model class that returns the appropriate questions by querying the
''AssignmentQuestionnaire'' using the ''assignment_id''.
This method is added to separate the business logic of retrieving the questions from the controller class.

[[File: Get_questions_by_assignment_id.png|1170px|]]

D. '''awarded_badge.rb''' 
'''award_badge'''
Parameters : participant_id, badge_name
This method adds the ''badge_name'' to a specific ''participant_id'' in the AwardedBadges table.
A separate method is created in the ''AwardedBadges'' model class to avoid the controller class from knowing the business logic of adding a badge
name to a participant.

[[File:RespControllerAwardBadge.png|1170px|]]

[[File:AwardBadgeMethod.png|1170px|]]

E. '''cake.rb''' 
'''store_total_cake_score'''
This method clearly exposes the logic of retrieving the score for a cake question in the ''response_controller.rb'' class which is an incorrect
design.
So, a model class method ''get_total_score_for_questions'' is added and the same logic of iterating over the Cake questions is moved there.
Return results for this method remains same here.
[[File:Cake.png|1170px|]]

F. '''response.rb''' 
'''calibration_results_info'''
This method in ''response.rb'' model is completely removed because this method only adds more complexity to the model class.
We refactored the method ''show_calibration_results_for_student'' in the ''response_controller.rb'' class.
Previously, ''calibration_results_info'' was just doing nothing but getting responses using ''calibration_response_map_id'' and
''review_response_map_id'', and querying ''AssignmentQuestionnaire''.
Both of these operations can be done by using ''find'' method of model class and adding model class ''get_questions_by_assignment_id'' method.

'''create_or_get_response'''
Method name ''populate_new_response'' is changed to ''create_or_get_response'' to convey the functionality of the method.

[[File:Create_or_get_response.png|1170px|]]

G. '''Code Climate issues''' 
'''Update'''
Made changes to split a line into multiple lines because it is too long.
[[File:Update_line_long.png|1170px|]]

'''Create'''
Made changes to split a line into multiple lines because it is too long.
[[File:Create_line_long.png|1170px|]]

== Testing ==

=== Running Tests ===
<pre>
rspec spec/models/responses_spec.rb
</pre>
<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>

=== UI Testing ===
1) Login using the following details. Username: student432, Password: password

[[File:resp_p1.png|800px|]]

2) Click on the assignment Design Exercise pertaining to course CSC/ECE 517, Spring 2017

[[File:resp_p2.png|800px|]]

3) Click on other's work

[[File:resp_p3.png|800px|]]

4) Click on show calibration results, verify if the calibration results are displayed on the UI.

[[File:resp_p4.png|800px|]]

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/vamshi-chidara/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2327 here]

CSC/ECE 517 Spring 2022 - E2218: Refactor response controller

2022-03-22T22:00:55Z

Smulkur: /* UI Testing */

This page details project documentation for the CSC/ECE 517 Spring 2022, '''E2218 refactor response_controller.rb''' project.

== Background ==

A response is the object that is created when someone fills out a review rubric, such as when one writes a review, gives feedback to a reviewer, or fills out a survey. Responses to the individual rubric items are kept in Answer objects; each Answer object has a response_id to say what Response it is part of. Since response_controller needs to work with many kinds of responses, its code is pretty general. It is not the worst controller in the system, but it would be much clearer if its method names were more descriptive of what they do.

=== Mentor ===

Ed Gehringer, efg@ncsu.edu

=== Team Members ===

* Sai Naga Vamshi Chidara (schidar@ncsu.edu)
* Akhil Kumar Mengani (amengan@ncsu.edu)
* Samson Reddy Mulkur (smulkur@ncsu.edu)

== Modified Files and Refactorization ==
A. '''response_controller.rb''' 

'''authorize_show_calibration_results'''
This method is used to authorize if the user(reviewer) is allowed to view the calibration results for the corresponding
''calibration_response_map_id'' and ''review_response_map_id''
passed as parameters in the URL.
Ex: https://expertiza.ncsu.edu/response/show_calibration_results_for_student?calibration_response_map_id=165688&review_response_map_id=165790
When someone tries to change the map_id's, the request should be authorized to check if the user can access the calibration result or not. 
[[File:Authorize_show_calibration_results.png|1180px|]]

'''set_response'''
@response and @map instance variables are initialized the same way across multiple methods.
In order to avoid duplication, we created a before_action action which will be called first before calling the corresponding methods.
[[File:Set_response_method.png|1170px|]]

B. '''response_helper.rb''' 

Following methods are moved from the ''response_controller.rb'' class to ''response_helper.rb'' class since these methods are called from the
controller action methods.
i) '''current_user_is_reviewer'''
ii) '''sort_questions'''
iii) '''store_total_cake_score'''
iv) '''set_content''' 

[[File:Response_helper_1.png|1170px|]]

[[File:Response_helper_2.png|1170px|]]

C. '''assignment_questionnaire.rb''' 
'''get_questions_by_assignment_id'''
Parameters : assignment_id
When a user clicks on 'calibration results' from UI, questions in the assignment that has been reviewed are displayed.
A new method is added in the ''AssignmentQuestionnaire'' model class that returns the appropriate questions by querying the
''AssignmentQuestionnaire'' using the ''assignment_id''.
This method is added to separate the business logic of retrieving the questions from the controller class.

[[File: Get_questions_by_assignment_id.png|1170px|]]

D. '''awarded_badge.rb''' 
'''award_badge'''
Parameters : participant_id, badge_name
This method adds the ''badge_name'' to a specific ''participant_id'' in the AwardedBadges table.
A separate method is created in the ''AwardedBadges'' model class to avoid the controller class from knowing the business logic of adding a badge
name to a participant.

[[File:RespControllerAwardBadge.png|1170px|]]

[[File:AwardBadgeMethod.png|1170px|]]

E. '''cake.rb''' 
'''store_total_cake_score'''
This method clearly exposes the logic of retrieving the score for a cake question in the ''response_controller.rb'' class which is an incorrect
design.
So, a model class method ''get_total_score_for_questions'' is added and the same logic of iterating over the Cake questions is moved there.
Return results for this method remains same here.
[[File:Cake.png|1170px|]]

F. '''response.rb''' 
'''calibration_results_info'''
This method in ''response.rb'' model is completely removed because this method only adds more complexity to the model class.
We refactored the method ''show_calibration_results_for_student'' in the ''response_controller.rb'' class.
Previously, ''calibration_results_info'' was just doing nothing but getting responses using ''calibration_response_map_id'' and
''review_response_map_id'', and querying ''AssignmentQuestionnaire''.
Both of these operations can be done by using ''find'' method of model class and adding model class ''get_questions_by_assignment_id'' method.

'''create_or_get_response'''
Method name ''populate_new_response'' is changed to ''create_or_get_response'' to convey the functionality of the method.

[[File:Create_or_get_response.png|1170px|]]

G. '''Code Climate issues''' 
'''Update'''
Made changes to split a line into multiple lines because it is too long.
[[File:Update_line_long.png|1170px|]]

'''Create'''
Made changes to split a line into multiple lines because it is too long.
[[File:Create_line_long.png|1170px|]]

== Testing ==

=== Running Tests ===
<pre>
rspec spec/models/responses_spec.rb
</pre>
<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>

=== UI Testing ===
1) Login using the following details. Username: student432, Password: password

[[File:resp_p1.png|800px|]]

2) Click on Design exercise pertaining to course CSC/ECE 517, Spring 2017

[[File:resp_p2.png|800px|]]

3) Click on other's work

[[File:resp_p3.png|800px|]]

4) Click on show calibration results, verify if the calibration results are displayed on the UI.

[[File:resp_p4.png|800px|]]

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/vamshi-chidara/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2327 here]

CSC/ECE 517 Spring 2022 - E2218: Refactor response controller

2022-03-22T21:59:58Z

Smulkur: /* Testing */

This page details project documentation for the CSC/ECE 517 Spring 2022, '''E2218 refactor response_controller.rb''' project.

== Background ==

A response is the object that is created when someone fills out a review rubric, such as when one writes a review, gives feedback to a reviewer, or fills out a survey. Responses to the individual rubric items are kept in Answer objects; each Answer object has a response_id to say what Response it is part of. Since response_controller needs to work with many kinds of responses, its code is pretty general. It is not the worst controller in the system, but it would be much clearer if its method names were more descriptive of what they do.

=== Mentor ===

Ed Gehringer, efg@ncsu.edu

=== Team Members ===

* Sai Naga Vamshi Chidara (schidar@ncsu.edu)
* Akhil Kumar Mengani (amengan@ncsu.edu)
* Samson Reddy Mulkur (smulkur@ncsu.edu)

== Modified Files and Refactorization ==
A. '''response_controller.rb''' 

'''authorize_show_calibration_results'''
This method is used to authorize if the user(reviewer) is allowed to view the calibration results for the corresponding
''calibration_response_map_id'' and ''review_response_map_id''
passed as parameters in the URL.
Ex: https://expertiza.ncsu.edu/response/show_calibration_results_for_student?calibration_response_map_id=165688&review_response_map_id=165790
When someone tries to change the map_id's, the request should be authorized to check if the user can access the calibration result or not. 
[[File:Authorize_show_calibration_results.png|1180px|]]

'''set_response'''
@response and @map instance variables are initialized the same way across multiple methods.
In order to avoid duplication, we created a before_action action which will be called first before calling the corresponding methods.
[[File:Set_response_method.png|1170px|]]

B. '''response_helper.rb''' 

Following methods are moved from the ''response_controller.rb'' class to ''response_helper.rb'' class since these methods are called from the
controller action methods.
i) '''current_user_is_reviewer'''
ii) '''sort_questions'''
iii) '''store_total_cake_score'''
iv) '''set_content''' 

[[File:Response_helper_1.png|1170px|]]

[[File:Response_helper_2.png|1170px|]]

C. '''assignment_questionnaire.rb''' 
'''get_questions_by_assignment_id'''
Parameters : assignment_id
When a user clicks on 'calibration results' from UI, questions in the assignment that has been reviewed are displayed.
A new method is added in the ''AssignmentQuestionnaire'' model class that returns the appropriate questions by querying the
''AssignmentQuestionnaire'' using the ''assignment_id''.
This method is added to separate the business logic of retrieving the questions from the controller class.

[[File: Get_questions_by_assignment_id.png|1170px|]]

D. '''awarded_badge.rb''' 
'''award_badge'''
Parameters : participant_id, badge_name
This method adds the ''badge_name'' to a specific ''participant_id'' in the AwardedBadges table.
A separate method is created in the ''AwardedBadges'' model class to avoid the controller class from knowing the business logic of adding a badge
name to a participant.

[[File:RespControllerAwardBadge.png|1170px|]]

[[File:AwardBadgeMethod.png|1170px|]]

E. '''cake.rb''' 
'''store_total_cake_score'''
This method clearly exposes the logic of retrieving the score for a cake question in the ''response_controller.rb'' class which is an incorrect
design.
So, a model class method ''get_total_score_for_questions'' is added and the same logic of iterating over the Cake questions is moved there.
Return results for this method remains same here.
[[File:Cake.png|1170px|]]

F. '''response.rb''' 
'''calibration_results_info'''
This method in ''response.rb'' model is completely removed because this method only adds more complexity to the model class.
We refactored the method ''show_calibration_results_for_student'' in the ''response_controller.rb'' class.
Previously, ''calibration_results_info'' was just doing nothing but getting responses using ''calibration_response_map_id'' and
''review_response_map_id'', and querying ''AssignmentQuestionnaire''.
Both of these operations can be done by using ''find'' method of model class and adding model class ''get_questions_by_assignment_id'' method.

'''create_or_get_response'''
Method name ''populate_new_response'' is changed to ''create_or_get_response'' to convey the functionality of the method.

[[File:Create_or_get_response.png|1170px|]]

G. '''Code Climate issues''' 
'''Update'''
Made changes to split a line into multiple lines because it is too long.
[[File:Update_line_long.png|1170px|]]

'''Create'''
Made changes to split a line into multiple lines because it is too long.
[[File:Create_line_long.png|1170px|]]

== Testing ==

=== Running Tests ===
<pre>
rspec spec/models/responses_spec.rb
</pre>
<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>

=== UI Testing ===
1) Login using the following details. Username: student432, Password: password

[[File:resp_p1.png|1180px|]]

2) Click on Design exercise pertaining to course CSC/ECE 517, Spring 2017

[[File:resp_p2.png|1180px|]]

3) Click on other's work

[[File:resp_p3.png|1180px|]]

4) Click on show calibration results, verify if the calibration results are displayed on the UI.

[[File:resp_p4.png|1180px|]]

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/vamshi-chidara/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2327 here]

File:Resp p4.png

2022-03-22T21:58:21Z

Smulkur:

File:Resp p3.png

2022-03-22T21:57:56Z

Smulkur:

File:Resp p2.png

2022-03-22T21:57:24Z

Smulkur:

File:Resp p1.png

2022-03-22T21:56:41Z

Smulkur:

CSC/ECE 517 Spring 2022 - E2218: Refactor response controller

2022-03-22T21:54:52Z

Smulkur: /* Testing */

This page details project documentation for the CSC/ECE 517 Spring 2022, '''E2218 refactor response_controller.rb''' project.

== Background ==

A response is the object that is created when someone fills out a review rubric, such as when one writes a review, gives feedback to a reviewer, or fills out a survey. Responses to the individual rubric items are kept in Answer objects; each Answer object has a response_id to say what Response it is part of. Since response_controller needs to work with many kinds of responses, its code is pretty general. It is not the worst controller in the system, but it would be much clearer if its method names were more descriptive of what they do.

=== Mentor ===

Ed Gehringer, efg@ncsu.edu

=== Team Members ===

* Sai Naga Vamshi Chidara (schidar@ncsu.edu)
* Akhil Kumar Mengani (amengan@ncsu.edu)
* Samson Reddy Mulkur (smulkur@ncsu.edu)

== Modified Files and Refactorization ==
A. '''response_controller.rb''' 

'''authorize_show_calibration_results'''
This method is used to authorize if the user(reviewer) is allowed to view the calibration results for the corresponding
''calibration_response_map_id'' and ''review_response_map_id''
passed as parameters in the URL.
Ex: https://expertiza.ncsu.edu/response/show_calibration_results_for_student?calibration_response_map_id=165688&review_response_map_id=165790
When someone tries to change the map_id's, the request should be authorized to check if the user can access the calibration result or not. 
[[File:Authorize_show_calibration_results.png|1180px|]]

'''set_response'''
@response and @map instance variables are initialized the same way across multiple methods.
In order to avoid duplication, we created a before_action action which will be called first before calling the corresponding methods.
[[File:Set_response_method.png|1170px|]]

B. '''response_helper.rb''' 

Following methods are moved from the ''response_controller.rb'' class to ''response_helper.rb'' class since these methods are called from the
controller action methods.
i) '''current_user_is_reviewer'''
ii) '''sort_questions'''
iii) '''store_total_cake_score'''
iv) '''set_content''' 

[[File:Response_helper_1.png|1170px|]]

[[File:Response_helper_2.png|1170px|]]

C. '''assignment_questionnaire.rb''' 
'''get_questions_by_assignment_id'''
Parameters : assignment_id
When a user clicks on 'calibration results' from UI, questions in the assignment that has been reviewed are displayed.
A new method is added in the ''AssignmentQuestionnaire'' model class that returns the appropriate questions by querying the
''AssignmentQuestionnaire'' using the ''assignment_id''.
This method is added to separate the business logic of retrieving the questions from the controller class.

[[File: Get_questions_by_assignment_id.png|1170px|]]

D. '''awarded_badge.rb''' 
'''award_badge'''
Parameters : participant_id, badge_name
This method adds the ''badge_name'' to a specific ''participant_id'' in the AwardedBadges table.
A separate method is created in the ''AwardedBadges'' model class to avoid the controller class from knowing the business logic of adding a badge
name to a participant.

[[File:RespControllerAwardBadge.png|1170px|]]

[[File:AwardBadgeMethod.png|1170px|]]

E. '''cake.rb''' 
'''store_total_cake_score'''
This method clearly exposes the logic of retrieving the score for a cake question in the ''response_controller.rb'' class which is an incorrect
design.
So, a model class method ''get_total_score_for_questions'' is added and the same logic of iterating over the Cake questions is moved there.
Return results for this method remains same here.
[[File:Cake.png|1170px|]]

F. '''response.rb''' 
'''calibration_results_info'''
This method in ''response.rb'' model is completely removed because this method only adds more complexity to the model class.
We refactored the method ''show_calibration_results_for_student'' in the ''response_controller.rb'' class.
Previously, ''calibration_results_info'' was just doing nothing but getting responses using ''calibration_response_map_id'' and
''review_response_map_id'', and querying ''AssignmentQuestionnaire''.
Both of these operations can be done by using ''find'' method of model class and adding model class ''get_questions_by_assignment_id'' method.

'''create_or_get_response'''
Method name ''populate_new_response'' is changed to ''create_or_get_response'' to convey the functionality of the method.

[[File:Create_or_get_response.png|1170px|]]

G. '''Code Climate issues''' 
'''Update'''
Made changes to split a line into multiple lines because it is too long.
[[File:Update_line_long.png|1170px|]]

'''Create'''
Made changes to split a line into multiple lines because it is too long.
[[File:Create_line_long.png|1170px|]]

== Testing ==

=== Running Tests ===
<pre>
rspec spec/models/responses_spec.rb
</pre>
<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>

=== UI Testing ===
1) Login using the following details. Username: student432, Password: password
2) Click on Design exercise pertaining to course CSC/ECE 517, Spring 2017
3) Click on other's work
4) Click on show calibration results, verify if the calibration results are displayed on the UI.

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/vamshi-chidara/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2327 here]

CSC/ECE 517 Spring 2022 - E2218: Refactor response controller

2022-03-21T21:40:09Z

Smulkur: /* Code Modifications and Refactorization */

This page details project documentation for the CSC/ECE 517 Spring 2022, "E2218 refactor response_controller.rb" project.

== Background ==

A response is the object that is created when someone fills out a review rubric, such as when one writes a review, gives feedback to a reviewer, or fills out a survey. Responses to the individual rubric items are kept in Answer objects; each Answer object has a response_id to say what Response it is part of. Since response_controller needs to work with many kinds of responses, its code is pretty general. It is not the worst controller in the system, but it would be much clearer if its method names were more descriptive of what they do.

=== Mentor ===

Ed Gehringer, efg@ncsu.edu

=== Team Members ===

* Sai Naga Vamshi Chidara (schidar@ncsu.edu)
* Akhil Kumar (amengan@ncsu.edu)
* Samson Mulkur (smulkur@ncsu.edu)

== Code Modifications and Refactorization ==
Described below are the code refactoring tasks and issues addressed by this team. We have also included any pertinent details, reasonings, comments, warnings, etc., corresponding to each task.

=== METHOD: def set_response ===
@response and @map instance variables are initialized the same way across multiple methods. In order to avoid duplication, we created a
before_action action which will be called first before calling the corresponding methods.

[[File:Set_response_method.png|1200px|]]

=== METHOD: def award_badge ===
The code for awarding the badge to a participant is written inside the response controller. It is moved to the AwardedBadge model file and called from the response controller.

[[File:RespControllerAwardBadge.png|1200px|]]

[[File:AwardBadgeMethod.png|1200px|]]

=== METHOD: update ===
Made changes to split a line into multiple lines because it is too long.

[[File:Update_line_long.png|1200px|]]

=== METHOD: create ===
Made changes to split a line into multiple lines because it is too long.

[[File:Create_line_long.png|1200px|]]

== Modified Files ==
<code>response_controller.rb</code>

<code>response_helper.rb</code>

<code>assignment_questionnaire.rb</code>

<code>awarded_badge.rb</code>

<code>cake.rb</code>

<code>response.rb</code>
== Testing ==

=== Running Tests ===
<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/vamshi-chidara/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2327 here]

File:Create line long.png

2022-03-21T21:39:08Z

Smulkur:

File:Update line long.png

2022-03-21T21:38:52Z

Smulkur:

CSC/ECE 517 Spring 2022 - E2218: Refactor response controller

2022-03-21T21:38:32Z

Smulkur: /* Code Modifications and Refactorization */

This page details project documentation for the CSC/ECE 517 Spring 2022, "E2218 refactor response_controller.rb" project.

== Background ==

A response is the object that is created when someone fills out a review rubric, such as when one writes a review, gives feedback to a reviewer, or fills out a survey. Responses to the individual rubric items are kept in Answer objects; each Answer object has a response_id to say what Response it is part of. Since response_controller needs to work with many kinds of responses, its code is pretty general. It is not the worst controller in the system, but it would be much clearer if its method names were more descriptive of what they do.

=== Mentor ===

Ed Gehringer, efg@ncsu.edu

=== Team Members ===

* Sai Naga Vamshi Chidara (schidar@ncsu.edu)
* Akhil Kumar (amengan@ncsu.edu)
* Samson Mulkur (smulkur@ncsu.edu)

== Code Modifications and Refactorization ==
Described below are the code refactoring tasks and issues addressed by this team. We have also included any pertinent details, reasonings, comments, warnings, etc., corresponding to each task.

=== METHOD: def set_response ===
@response and @map instance variables are initialized the same way across multiple methods. In order to avoid duplication, we created a
before_action action which will be called first before calling the corresponding methods.

[[File:Set_response_method.png|1200px|]]

=== METHOD: def award_badge ===
The code for awarding the badge to a participant is written inside the response controller. It is moved to the AwardedBadge model file and called from the response controller.

[[File:RespControllerAwardBadge.png|1200px|]]

[[File:AwardBadgeMethod.png|1200px|]]

=== METHOD: update ===
Made changes to split a line into multiple lines because it is too long.

=== METHOD: create ===
Made changes to split a line into multiple lines because it is too long.

== Modified Files ==
<code>response_controller.rb</code>

<code>response_helper.rb</code>

<code>assignment_questionnaire.rb</code>

<code>awarded_badge.rb</code>

<code>cake.rb</code>

<code>response.rb</code>
== Testing ==

=== Running Tests ===
<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/vamshi-chidara/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2327 here]

CSC/ECE 517 Spring 2022 - E2218: Refactor response controller

2022-03-21T20:37:47Z

Smulkur: /* METHOD: def award_badge */

This page details project documentation for the CSC/ECE 517 Spring 2022, "E2218 refactor response_controller.rb" project.

== Background ==

A response is the object that is created when someone fills out a review rubric, such as when one writes a review, gives feedback to a reviewer, or fills out a survey. Responses to the individual rubric items are kept in Answer objects; each Answer object has a response_id to say what Response it is part of. Since response_controller needs to work with many kinds of responses, its code is pretty general. It is not the worst controller in the system, but it would be much clearer if its method names were more descriptive of what they do.

=== Mentor ===

Ed Gehringer, efg@ncsu.edu

=== Team Members ===

* Sai Naga Vamshi Chidara (schidar@ncsu.edu)
* Akhil Kumar (amengan@ncsu.edu)
* Samson Mulkur (smulkur@ncsu.edu)

== Code Modifications and Refactorization ==
Described below are the code refactoring tasks and issues addressed by this team. We have also included any pertinent details, reasonings, comments, warnings, etc., corresponding to each task.

=== METHOD: def set_response ===
@response and @map instance variables are initialized the same way across multiple methods. In order to avoid duplication, we created a
before_action action which will be called first before calling the corresponding methods.

[[File:Set_response_method.png|1200px|]]

=== METHOD: def award_badge ===
The code for awarding the badge to a participant is written inside the response controller. It is moved to the AwardedBadge model file and called from the response controller.

[[File:RespControllerAwardBadge.png|1200px|]]

[[File:AwardBadgeMethod.png|1200px|]]

== Modified Files ==
<code>response_controller.rb</code>

<code>response_helper.rb</code>

<code>assignment_questionnaire.rb</code>

<code>awarded_badge.rb</code>

<code>cake.rb</code>

<code>response.rb</code>
== Testing ==

=== Running Tests ===
<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/vamshi-chidara/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2327 here]

File:RespControllerAwardBadge.png

2022-03-21T20:36:09Z

Smulkur:

File:AwardBadgeMethod.png

2022-03-21T20:35:52Z

Smulkur:

CSC/ECE 517 Spring 2022 - E2218: Refactor response controller

2022-03-21T20:29:43Z

Smulkur:

This page details project documentation for the CSC/ECE 517 Spring 2022, "E2218 refactor response_controller.rb" project.

== Background ==

A response is the object that is created when someone fills out a review rubric, such as when one writes a review, gives feedback to a reviewer, or fills out a survey. Responses to the individual rubric items are kept in Answer objects; each Answer object has a response_id to say what Response it is part of. Since response_controller needs to work with many kinds of responses, its code is pretty general. It is not the worst controller in the system, but it would be much clearer if its method names were more descriptive of what they do.

=== Mentor ===

Ed Gehringer, efg@ncsu.edu

=== Team Members ===

* Sai Naga Vamshi Chidara (schidar@ncsu.edu)
* Akhil Kumar (amengan@ncsu.edu)
* Samson Mulkur (smulkur@ncsu.edu)

== Code Modifications and Refactorization ==
Described below are the code refactoring tasks and issues addressed by this team. We have also included any pertinent details, reasonings, comments, warnings, etc., corresponding to each task.

=== METHOD: def set_response ===
@response and @map instance variables are initialized the same way across multiple methods. In order to avoid duplication, we created a
before_action action which will be called first before calling the corresponding methods.

[[File:Set_response_method.png|1200px|]]

=== METHOD: def award_badge ===
The code for awarding the badge to a participant is written inside the response controller. It is moved to the AwardedBadge model file and called from the response controller.

== Modified Files ==
<code>response_controller.rb</code>

<code>response_helper.rb</code>

<code>assignment_questionnaire.rb</code>

<code>awarded_badge.rb</code>

<code>cake.rb</code>

<code>response.rb</code>
== Testing ==

=== Running Tests ===
<pre>
rspec spec/controllers/questionnaires_controller_spec.rb
</pre>

==GitHub links and Pull Request==
Link to Expertiza repository: [https://github.com/expertiza/expertiza here]

Link to the forked repository: [https://github.com/vamshi-chidara/expertiza here]

Link to Pull Request: [https://github.com/expertiza/expertiza/pull/2327 here]