Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2021 - E2166. Testing - Scoring & Grades

2021-12-01T01:36:55Z

Lshan3: /* dispaly_as_html(prefix = nil, count = nil, _file_url = nil, show_tags = nil, current_user = nil) */

== Project Overview ==

In Expertiza, scoring and grades are a large part of its implement that benefit for both instructor and students. They play important role for students to examine others' work and for the instructor to grade students' performance. However, they are not fully tested and considered thoroughly. The main purpose of this project is to refactor grades in beta and adding test cases would be the method to do so.

=== Objectives ===

Our objectives for this project are the following:
*Develop the files below further to cover missing methods and lines.
*Write extra tests to cover any edge cases that may need to be considered.
*Increase the coverage of the spec.

=== Files Involved and original coverage===
*Grades_controller_spec [[https://coveralls.io/builds/43656335/source?filename=app%2Fcontrollers%2Fgrades_controller.rb here]]-86%covered
*Grades_helper_spec [[https://coveralls.io/builds/43656335/source?filename=app%2Fhelpers%2Fgrades_helper.rb here]]-58%covered
*Response_spec [[https://coveralls.io/builds/43656335/source?filename=app%2Fmodels%2Fresponse.rb here]]-86.4%covered

== Run the file ==
<pre>
rspec ./spec/helpers/Grades_helper_spec.rb
rspec ./spec/controller/Grades_controller_spec.rb
rsepc ./spec/model/Response_spec.rb
</pre>

== Test Plan ==
We look into these file and their related functions. The initial coverage is high, but we still want to add more test cases to cover almost every situation. Therefore, the functions below are what we plan to work on in this project. We are going to run the initial code first and see which lines are not executed and add the corresponding test cases to increase the coverage.
=== Relevant Methods ===
Grades_controller_spec
*action_allowed
*update
*save_grade_and_comment_for_submission
*self_review_finished

Grades_helper_spec
*accordion_title(last_topic, new_topic)
*has_team_and_metareview
*view_heatgrid(participant_id, type)
*penalty
Response_spec
*maximum_score
*email
*populate_new_response
*questionnaire_by_answer
*delete
*self.calibration_results_info
*notify_instructor_on_difference
*done_by_staff_participant?
*dispaly_as_html
*construct_review_response
== GradesController_spec ==
=== action_allowed ===
This function allows students to view their score and view their team by checking if current user has student privilege. We plan to add test on method of allowing current user to view team. If current user is a student, user id is expected to be found in AssignmentParticipant.

[[File:517_project4_1.jpg]]

*Initial Coverage:
[[File:action.jpg|border|1000px]]

*Test Cases Added:
[[File:ac.png|border|1000px]]

=== update ===
In this function, it returns a message depending on whether the participant grade is nil or not and redirects to a edit action. We plan to add test on computing the message if the participant score is not nil, it is expected to print a sentence like "A score of ... has been saved for ...".

[[File:517_project4_2.jpg]]

*Initial Coverage:
[[File:update_1.jpg|border|1000px]]

*Test Cases Added:
[[File:update_2.png|border|1000px]]

=== save_grade_and_comment_for_submission ===
This function saves the grade and comment after submission. We plan to add a test case that fails to save the submission. When we look up in flash, it is expected to be "$ERROR_INFO".

[[File:517_project4_3.jpg]]

*Initial Coverage:
[[File:save_grade.jpg|border|1000px]]

*Test Cases Added:
[[File:update_1.png|border|1000px]]

=== self_review_finished ===
This is a boolean function that tells if the students finished their self reviews or not. We plan to add a test case that shows if the system enables student to self review, which means the student hasn't submit the self review and the test is expected to get false.

[[File:517_project4_4.jpg]]

*Initial Coverage:
[[File:self_review.jpg|border|1000px]]

*Problem:
The self_review_finished method is a private method, difficult to test every scenarios through the public interface.

== GradesHelper_spec ==
=== accordion_title(last_topic, new_topic) ===
This function would render different view according to the comparison of last_topic and new_topic. We plan to create three contexts to test it as below:
1. When last_topic is empty, the function should return view which contains the new_topic
2. last_topic doesn't equal to new_topic, the function should return view which contains the new_topic
3. Other situation, the function should return nothing

[[File:517_project4_8.jpg]]

*Initial Coverage:
[[File:accordion.png|border|1000px]]
*Latest Coverage:
[[File:accor2.jpg|border|500px]]
*Test Cases Added:
[[File:accord.jpeg|border|800px]]

=== has_team_and_metareview? ===
In this function, we plan to complete cases to cover all the function. The cases include:
1. When an assignment is a team assignment and has meta review, the return values should contain true_num = 2.
2. When an assignment is a team assignment or has meta review, the return values should contain true_num = 1.
3. When an assignment is a personal assignment and doesn't has meta review, the return values should contain true_num = 0.

[[File:517_project4_9.jpg]]

*Initial Coverage:
[[File:has_team.jpg|border|1000px]]
*Latest Coverage:
[[File:meta2.jpg|border|500px]]

*Test Cases Added:
[[File:metaview_1.jpg|border|800px]]
*The comment part is the original code that shows bug:
[[File:metaview_2.jpg|border|800px]]

=== view_heatgrid(participant_id, type) ===
This function would get all the questionnaires belonging to a participant, and filter questionnaires according to 'type' parameter, and then collect questionnaire to render the target view
So, we plan to check if the return value only contends the certain type of questionnaires.
*Initial Coverage:
[[File:viewgrid.jpg|border|1000px]]

*Latest Coverage:
[[File:heat2.jpg|border|500px]]

*Test Cases Added:
[[File:heatgrid.jpg|border|800px]]

=== penalty ===
This function would calcualte the penalties of an assignment. We plan to give an assignment and check if its field 'is_penalty_calculated' change to 'true'
*Initial Coverage:
[[File:penal_initial.jpg|border|800px]]

*Latest Coverage:
[[File:penal_pass.jpg|border|500px]]

*Test Cases Added:
[[File:penalty.jpg|border|800px]]

== Response_spec ==
=== maximum_score ===
This function returns the highest possible score for this response, and it only accepts the scorable question and non nil answer. We plan to add a test case that a response doesn't have any score, in this case, total_weight is expected to remain 0 and result should be 0 as well.

[[File:517_project4_5.jpg]]
*Initial Coverage:
[[File:m_1.jpg|border|1000px]]

*Latest Coverage:
[[File:max_score.jpg|border|1000px]]

*Test Cases Added:
[[File:max3.png|border|1000px]]

=== email ===
This function finds out which kind of survey is it and searches the parent of the result. Parent is used as a common variable name for either an assignment or a course. We plan to add test case that the type of survey is associated with course, so we would directly get the assignment from participant, which is the response of course survey.

[[File:517_project4_6.jpg]]

*Initial Coverage:
[[File:e_1.jpg|border|1000px]]

*Latest Coverage:
[[File:email.jpg|border|1000px]]

*Test Cases Added:
[[File:emailtest.png|border|1000px]]

=== populate_new_response ===
This function returns a Response object used to populate @response instance object with the correct response according to review round or with a new response object that the controller can use. We plan to add test case that concludes three scenarios: A response exists after the latest submission, A response exists before the latest submission, No response exists in current submission. For the first case, it is expected to get the original response. As for the rest, it is expected to populate new response.

[[File:517_project4_7.jpg]]

*Initial Coverage:
[[File:populate.jpeg|border|1000px]]

*Latest Coverage:
[[File:p_2.jpeg|border|1000px]]

*Test Cases Added:
[[File:populatetest.png|border|1000px]]

=== questionnaire_by_answer ===
In this function, a questionnaire can be found by its answer, and this assignment can be gotten through either participant or map. We plan to add a test case that is to obtain the assignment through participant by a given answer.

*Initial Coverage:
[[File:q_1.jpeg|border|1000px]]

*Latest Coverage:
[[File:questionnaire.jpeg|border|1000px]]

*Test Cases Added:
[[File:ques3.png|border|1000px]]

=== delete ===
Before the response is destroyed, its response scores will also be destroyed.
*Initial Coverage:
[[File:d1.jpg|border|1000px]]

*Latest Coverage:
[[File:d2.jpg|border|1000px]]

*Test Cases Added:
[[File:d3.png|border|1000px]]

=== self.calibration_results_info(calibration_id, response_id, assignment_id) ===
This method is used when a student views their calibration results for a particular review/assignment. It should return the reference of calibration response, review response, and questions.
*Initial Coverage:
[[File:s1.jpg|border|1000px]]

*Latest Coverage:
[[File:s2.jpg|border|1000px]]

*Test Cases Added:
[[File:s_3.png|border|1000px]]

=== notify_instructor_on_difference ===
This method will send a mail via Mailer when the review score is abnormal. The method should pass the data with the correct format to the Mailer and deliver the mail.
*Initial Coverage:
[[File:n1.jpg|border|1000px]]

*Latest Coverage:
[[File:n2.jpg|border|1000px]]

*Test Cases Added:
[[File:n_3.png|border|1000px]]

=== done_by_staff_participant? ===
This method will check if the review is done by a staff, which include TAs and instructors.

*Initial Coverage:
[[File:do1.jpg|border|1000px]]

*Latest Coverage:
[[File:do2.jpg|border|1000px]]

*Test Cases Added:
[[File:do3.png|border|1000px]]

=== dispaly_as_html(prefix = nil, count = nil, _file_url = nil, show_tags = nil, current_user = nil) ===
This method will return the data of the repsonse within HTML format, and might invoke several private methods that needs to be test.

*Initial Coverage:
[[File:di2.jpg|border|1000px]]

*Test Cases Added:
[[File:di3.png|border|1000px]]

=== construct_review_response(code, self_id, show_tags = nil, current_user = nil) ===
This method is a private method in response model, which will only be called by the display_as_html method. In this method, if the response contains additional commends, it will replace '/n' to ''.
*Initial Coverage:
[[File:c_1.jpg|border|1000px]]

*Latest Coverage:
[[File:c_2.jpg|border|1000px]]

*Test Cases Added:
[[File:c_3.png|border|1000px]]

== Results ==
[[File:grades_controller_cover.png|border|500px]]

[[File:grades_helper_cover.jpg|border|300px]]

[[File:grades_cover.jpg|border|900px]]

=== Collaborators ===
*Li Yu Shan (lshan3)
*Chao Ting Hung (chung4)
*Chen Ni Liu (cliu43)
*Kan No Lee (klee32)

=== Relevant Links ===
Main Expertiza Repository can be found [https://github.com/expertiza/expertiza here].

Our forked Repository can be found [https://github.com/gggho0806/expertiza/tree/beta here].

CSC/ECE 517 Fall 2021 - E2166. Testing - Scoring & Grades

2021-12-01T01:35:56Z

Lshan3: /* construct_review_response(code, self_id, show_tags = nil, current_user = nil) */

== Project Overview ==

In Expertiza, scoring and grades are a large part of its implement that benefit for both instructor and students. They play important role for students to examine others' work and for the instructor to grade students' performance. However, they are not fully tested and considered thoroughly. The main purpose of this project is to refactor grades in beta and adding test cases would be the method to do so.

=== Objectives ===

Our objectives for this project are the following:
*Develop the files below further to cover missing methods and lines.
*Write extra tests to cover any edge cases that may need to be considered.
*Increase the coverage of the spec.

=== Files Involved and original coverage===
*Grades_controller_spec [[https://coveralls.io/builds/43656335/source?filename=app%2Fcontrollers%2Fgrades_controller.rb here]]-86%covered
*Grades_helper_spec [[https://coveralls.io/builds/43656335/source?filename=app%2Fhelpers%2Fgrades_helper.rb here]]-58%covered
*Response_spec [[https://coveralls.io/builds/43656335/source?filename=app%2Fmodels%2Fresponse.rb here]]-86.4%covered

== Run the file ==
<pre>
rspec ./spec/helpers/Grades_helper_spec.rb
rspec ./spec/controller/Grades_controller_spec.rb
rsepc ./spec/model/Response_spec.rb
</pre>

== Test Plan ==
We look into these file and their related functions. The initial coverage is high, but we still want to add more test cases to cover almost every situation. Therefore, the functions below are what we plan to work on in this project. We are going to run the initial code first and see which lines are not executed and add the corresponding test cases to increase the coverage.
=== Relevant Methods ===
Grades_controller_spec
*action_allowed
*update
*save_grade_and_comment_for_submission
*self_review_finished

Grades_helper_spec
*accordion_title(last_topic, new_topic)
*has_team_and_metareview
*view_heatgrid(participant_id, type)
*penalty
Response_spec
*maximum_score
*email
*populate_new_response
*questionnaire_by_answer
*delete
*self.calibration_results_info
*notify_instructor_on_difference
*done_by_staff_participant?
*dispaly_as_html
*construct_review_response
== GradesController_spec ==
=== action_allowed ===
This function allows students to view their score and view their team by checking if current user has student privilege. We plan to add test on method of allowing current user to view team. If current user is a student, user id is expected to be found in AssignmentParticipant.

[[File:517_project4_1.jpg]]

*Initial Coverage:
[[File:action.jpg|border|1000px]]

*Test Cases Added:
[[File:ac.png|border|1000px]]

=== update ===
In this function, it returns a message depending on whether the participant grade is nil or not and redirects to a edit action. We plan to add test on computing the message if the participant score is not nil, it is expected to print a sentence like "A score of ... has been saved for ...".

[[File:517_project4_2.jpg]]

*Initial Coverage:
[[File:update_1.jpg|border|1000px]]

*Test Cases Added:
[[File:update_2.png|border|1000px]]

=== save_grade_and_comment_for_submission ===
This function saves the grade and comment after submission. We plan to add a test case that fails to save the submission. When we look up in flash, it is expected to be "$ERROR_INFO".

[[File:517_project4_3.jpg]]

*Initial Coverage:
[[File:save_grade.jpg|border|1000px]]

*Test Cases Added:
[[File:update_1.png|border|1000px]]

=== self_review_finished ===
This is a boolean function that tells if the students finished their self reviews or not. We plan to add a test case that shows if the system enables student to self review, which means the student hasn't submit the self review and the test is expected to get false.

[[File:517_project4_4.jpg]]

*Initial Coverage:
[[File:self_review.jpg|border|1000px]]

*Problem:
The self_review_finished method is a private method, difficult to test every scenarios through the public interface.

== GradesHelper_spec ==
=== accordion_title(last_topic, new_topic) ===
This function would render different view according to the comparison of last_topic and new_topic. We plan to create three contexts to test it as below:
1. When last_topic is empty, the function should return view which contains the new_topic
2. last_topic doesn't equal to new_topic, the function should return view which contains the new_topic
3. Other situation, the function should return nothing

[[File:517_project4_8.jpg]]

*Initial Coverage:
[[File:accordion.png|border|1000px]]
*Latest Coverage:
[[File:accor2.jpg|border|500px]]
*Test Cases Added:
[[File:accord.jpeg|border|800px]]

=== has_team_and_metareview? ===
In this function, we plan to complete cases to cover all the function. The cases include:
1. When an assignment is a team assignment and has meta review, the return values should contain true_num = 2.
2. When an assignment is a team assignment or has meta review, the return values should contain true_num = 1.
3. When an assignment is a personal assignment and doesn't has meta review, the return values should contain true_num = 0.

[[File:517_project4_9.jpg]]

*Initial Coverage:
[[File:has_team.jpg|border|1000px]]
*Latest Coverage:
[[File:meta2.jpg|border|500px]]

*Test Cases Added:
[[File:metaview_1.jpg|border|800px]]
*The comment part is the original code that shows bug:
[[File:metaview_2.jpg|border|800px]]

=== view_heatgrid(participant_id, type) ===
This function would get all the questionnaires belonging to a participant, and filter questionnaires according to 'type' parameter, and then collect questionnaire to render the target view
So, we plan to check if the return value only contends the certain type of questionnaires.
*Initial Coverage:
[[File:viewgrid.jpg|border|1000px]]

*Latest Coverage:
[[File:heat2.jpg|border|500px]]

*Test Cases Added:
[[File:heatgrid.jpg|border|800px]]

=== penalty ===
This function would calcualte the penalties of an assignment. We plan to give an assignment and check if its field 'is_penalty_calculated' change to 'true'
*Initial Coverage:
[[File:penal_initial.jpg|border|800px]]

*Latest Coverage:
[[File:penal_pass.jpg|border|500px]]

*Test Cases Added:
[[File:penalty.jpg|border|800px]]

== Response_spec ==
=== maximum_score ===
This function returns the highest possible score for this response, and it only accepts the scorable question and non nil answer. We plan to add a test case that a response doesn't have any score, in this case, total_weight is expected to remain 0 and result should be 0 as well.

[[File:517_project4_5.jpg]]
*Initial Coverage:
[[File:m_1.jpg|border|1000px]]

*Latest Coverage:
[[File:max_score.jpg|border|1000px]]

*Test Cases Added:
[[File:max3.png|border|1000px]]

=== email ===
This function finds out which kind of survey is it and searches the parent of the result. Parent is used as a common variable name for either an assignment or a course. We plan to add test case that the type of survey is associated with course, so we would directly get the assignment from participant, which is the response of course survey.

[[File:517_project4_6.jpg]]

*Initial Coverage:
[[File:e_1.jpg|border|1000px]]

*Latest Coverage:
[[File:email.jpg|border|1000px]]

*Test Cases Added:
[[File:emailtest.png|border|1000px]]

=== populate_new_response ===
This function returns a Response object used to populate @response instance object with the correct response according to review round or with a new response object that the controller can use. We plan to add test case that concludes three scenarios: A response exists after the latest submission, A response exists before the latest submission, No response exists in current submission. For the first case, it is expected to get the original response. As for the rest, it is expected to populate new response.

[[File:517_project4_7.jpg]]

*Initial Coverage:
[[File:populate.jpeg|border|1000px]]

*Latest Coverage:
[[File:p_2.jpeg|border|1000px]]

*Test Cases Added:
[[File:populatetest.png|border|1000px]]

=== questionnaire_by_answer ===
In this function, a questionnaire can be found by its answer, and this assignment can be gotten through either participant or map. We plan to add a test case that is to obtain the assignment through participant by a given answer.

*Initial Coverage:
[[File:q_1.jpeg|border|1000px]]

*Latest Coverage:
[[File:questionnaire.jpeg|border|1000px]]

*Test Cases Added:
[[File:ques3.png|border|1000px]]

=== delete ===
Before the response is destroyed, its response scores will also be destroyed.
*Initial Coverage:
[[File:d1.jpg|border|1000px]]

*Latest Coverage:
[[File:d2.jpg|border|1000px]]

*Test Cases Added:
[[File:d3.png|border|1000px]]

=== self.calibration_results_info(calibration_id, response_id, assignment_id) ===
This method is used when a student views their calibration results for a particular review/assignment. It should return the reference of calibration response, review response, and questions.
*Initial Coverage:
[[File:s1.jpg|border|1000px]]

*Latest Coverage:
[[File:s2.jpg|border|1000px]]

*Test Cases Added:
[[File:s_3.png|border|1000px]]

=== notify_instructor_on_difference ===
This method will send a mail via Mailer when the review score is abnormal. The method should pass the data with the correct format to the Mailer and deliver the mail.
*Initial Coverage:
[[File:n1.jpg|border|1000px]]

*Latest Coverage:
[[File:n2.jpg|border|1000px]]

*Test Cases Added:
[[File:n_3.png|border|1000px]]

=== done_by_staff_participant? ===
This method will check if the review is done by a staff, which include TAs and instructors.

*Initial Coverage:
[[File:do1.jpg|border|1000px]]

*Latest Coverage:
[[File:do2.jpg|border|1000px]]

*Test Cases Added:
[[File:do3.png|border|1000px]]

=== dispaly_as_html(prefix = nil, count = nil, _file_url = nil, show_tags = nil, current_user = nil) ===

*Initial Coverage:
[[File:di2.jpg|border|1000px]]

*Test Cases Added:
[[File:di3.png|border|1000px]]

=== construct_review_response(code, self_id, show_tags = nil, current_user = nil) ===
This method is a private method in response model, which will only be called by the display_as_html method. In this method, if the response contains additional commends, it will replace '/n' to ''.
*Initial Coverage:
[[File:c_1.jpg|border|1000px]]

*Latest Coverage:
[[File:c_2.jpg|border|1000px]]

*Test Cases Added:
[[File:c_3.png|border|1000px]]

== Results ==
[[File:grades_controller_cover.png|border|500px]]

[[File:grades_helper_cover.jpg|border|300px]]

[[File:grades_cover.jpg|border|900px]]

=== Collaborators ===
*Li Yu Shan (lshan3)
*Chao Ting Hung (chung4)
*Chen Ni Liu (cliu43)
*Kan No Lee (klee32)

=== Relevant Links ===
Main Expertiza Repository can be found [https://github.com/expertiza/expertiza here].

Our forked Repository can be found [https://github.com/gggho0806/expertiza/tree/beta here].

CSC/ECE 517 Fall 2021 - E2166. Testing - Scoring & Grades

2021-12-01T01:35:41Z

Lshan3: /* construct_review_response(code, self_id, show_tags = nil, current_user = nil) */

== Project Overview ==

In Expertiza, scoring and grades are a large part of its implement that benefit for both instructor and students. They play important role for students to examine others' work and for the instructor to grade students' performance. However, they are not fully tested and considered thoroughly. The main purpose of this project is to refactor grades in beta and adding test cases would be the method to do so.

=== Objectives ===

Our objectives for this project are the following:
*Develop the files below further to cover missing methods and lines.
*Write extra tests to cover any edge cases that may need to be considered.
*Increase the coverage of the spec.

=== Files Involved and original coverage===
*Grades_controller_spec [[https://coveralls.io/builds/43656335/source?filename=app%2Fcontrollers%2Fgrades_controller.rb here]]-86%covered
*Grades_helper_spec [[https://coveralls.io/builds/43656335/source?filename=app%2Fhelpers%2Fgrades_helper.rb here]]-58%covered
*Response_spec [[https://coveralls.io/builds/43656335/source?filename=app%2Fmodels%2Fresponse.rb here]]-86.4%covered

== Run the file ==
<pre>
rspec ./spec/helpers/Grades_helper_spec.rb
rspec ./spec/controller/Grades_controller_spec.rb
rsepc ./spec/model/Response_spec.rb
</pre>

== Test Plan ==
We look into these file and their related functions. The initial coverage is high, but we still want to add more test cases to cover almost every situation. Therefore, the functions below are what we plan to work on in this project. We are going to run the initial code first and see which lines are not executed and add the corresponding test cases to increase the coverage.
=== Relevant Methods ===
Grades_controller_spec
*action_allowed
*update
*save_grade_and_comment_for_submission
*self_review_finished

Grades_helper_spec
*accordion_title(last_topic, new_topic)
*has_team_and_metareview
*view_heatgrid(participant_id, type)
*penalty
Response_spec
*maximum_score
*email
*populate_new_response
*questionnaire_by_answer
*delete
*self.calibration_results_info
*notify_instructor_on_difference
*done_by_staff_participant?
*dispaly_as_html
*construct_review_response
== GradesController_spec ==
=== action_allowed ===
This function allows students to view their score and view their team by checking if current user has student privilege. We plan to add test on method of allowing current user to view team. If current user is a student, user id is expected to be found in AssignmentParticipant.

[[File:517_project4_1.jpg]]

*Initial Coverage:
[[File:action.jpg|border|1000px]]

*Test Cases Added:
[[File:ac.png|border|1000px]]

=== update ===
In this function, it returns a message depending on whether the participant grade is nil or not and redirects to a edit action. We plan to add test on computing the message if the participant score is not nil, it is expected to print a sentence like "A score of ... has been saved for ...".

[[File:517_project4_2.jpg]]

*Initial Coverage:
[[File:update_1.jpg|border|1000px]]

*Test Cases Added:
[[File:update_2.png|border|1000px]]

=== save_grade_and_comment_for_submission ===
This function saves the grade and comment after submission. We plan to add a test case that fails to save the submission. When we look up in flash, it is expected to be "$ERROR_INFO".

[[File:517_project4_3.jpg]]

*Initial Coverage:
[[File:save_grade.jpg|border|1000px]]

*Test Cases Added:
[[File:update_1.png|border|1000px]]

=== self_review_finished ===
This is a boolean function that tells if the students finished their self reviews or not. We plan to add a test case that shows if the system enables student to self review, which means the student hasn't submit the self review and the test is expected to get false.

[[File:517_project4_4.jpg]]

*Initial Coverage:
[[File:self_review.jpg|border|1000px]]

*Problem:
The self_review_finished method is a private method, difficult to test every scenarios through the public interface.

== GradesHelper_spec ==
=== accordion_title(last_topic, new_topic) ===
This function would render different view according to the comparison of last_topic and new_topic. We plan to create three contexts to test it as below:
1. When last_topic is empty, the function should return view which contains the new_topic
2. last_topic doesn't equal to new_topic, the function should return view which contains the new_topic
3. Other situation, the function should return nothing

[[File:517_project4_8.jpg]]

*Initial Coverage:
[[File:accordion.png|border|1000px]]
*Latest Coverage:
[[File:accor2.jpg|border|500px]]
*Test Cases Added:
[[File:accord.jpeg|border|800px]]

=== has_team_and_metareview? ===
In this function, we plan to complete cases to cover all the function. The cases include:
1. When an assignment is a team assignment and has meta review, the return values should contain true_num = 2.
2. When an assignment is a team assignment or has meta review, the return values should contain true_num = 1.
3. When an assignment is a personal assignment and doesn't has meta review, the return values should contain true_num = 0.

[[File:517_project4_9.jpg]]

*Initial Coverage:
[[File:has_team.jpg|border|1000px]]
*Latest Coverage:
[[File:meta2.jpg|border|500px]]

*Test Cases Added:
[[File:metaview_1.jpg|border|800px]]
*The comment part is the original code that shows bug:
[[File:metaview_2.jpg|border|800px]]

=== view_heatgrid(participant_id, type) ===
This function would get all the questionnaires belonging to a participant, and filter questionnaires according to 'type' parameter, and then collect questionnaire to render the target view
So, we plan to check if the return value only contends the certain type of questionnaires.
*Initial Coverage:
[[File:viewgrid.jpg|border|1000px]]

*Latest Coverage:
[[File:heat2.jpg|border|500px]]

*Test Cases Added:
[[File:heatgrid.jpg|border|800px]]

=== penalty ===
This function would calcualte the penalties of an assignment. We plan to give an assignment and check if its field 'is_penalty_calculated' change to 'true'
*Initial Coverage:
[[File:penal_initial.jpg|border|800px]]

*Latest Coverage:
[[File:penal_pass.jpg|border|500px]]

*Test Cases Added:
[[File:penalty.jpg|border|800px]]

== Response_spec ==
=== maximum_score ===
This function returns the highest possible score for this response, and it only accepts the scorable question and non nil answer. We plan to add a test case that a response doesn't have any score, in this case, total_weight is expected to remain 0 and result should be 0 as well.

[[File:517_project4_5.jpg]]
*Initial Coverage:
[[File:m_1.jpg|border|1000px]]

*Latest Coverage:
[[File:max_score.jpg|border|1000px]]

*Test Cases Added:
[[File:max3.png|border|1000px]]

=== email ===
This function finds out which kind of survey is it and searches the parent of the result. Parent is used as a common variable name for either an assignment or a course. We plan to add test case that the type of survey is associated with course, so we would directly get the assignment from participant, which is the response of course survey.

[[File:517_project4_6.jpg]]

*Initial Coverage:
[[File:e_1.jpg|border|1000px]]

*Latest Coverage:
[[File:email.jpg|border|1000px]]

*Test Cases Added:
[[File:emailtest.png|border|1000px]]

=== populate_new_response ===
This function returns a Response object used to populate @response instance object with the correct response according to review round or with a new response object that the controller can use. We plan to add test case that concludes three scenarios: A response exists after the latest submission, A response exists before the latest submission, No response exists in current submission. For the first case, it is expected to get the original response. As for the rest, it is expected to populate new response.

[[File:517_project4_7.jpg]]

*Initial Coverage:
[[File:populate.jpeg|border|1000px]]

*Latest Coverage:
[[File:p_2.jpeg|border|1000px]]

*Test Cases Added:
[[File:populatetest.png|border|1000px]]

=== questionnaire_by_answer ===
In this function, a questionnaire can be found by its answer, and this assignment can be gotten through either participant or map. We plan to add a test case that is to obtain the assignment through participant by a given answer.

*Initial Coverage:
[[File:q_1.jpeg|border|1000px]]

*Latest Coverage:
[[File:questionnaire.jpeg|border|1000px]]

*Test Cases Added:
[[File:ques3.png|border|1000px]]

=== delete ===
Before the response is destroyed, its response scores will also be destroyed.
*Initial Coverage:
[[File:d1.jpg|border|1000px]]

*Latest Coverage:
[[File:d2.jpg|border|1000px]]

*Test Cases Added:
[[File:d3.png|border|1000px]]

=== self.calibration_results_info(calibration_id, response_id, assignment_id) ===
This method is used when a student views their calibration results for a particular review/assignment. It should return the reference of calibration response, review response, and questions.
*Initial Coverage:
[[File:s1.jpg|border|1000px]]

*Latest Coverage:
[[File:s2.jpg|border|1000px]]

*Test Cases Added:
[[File:s_3.png|border|1000px]]

=== notify_instructor_on_difference ===
This method will send a mail via Mailer when the review score is abnormal. The method should pass the data with the correct format to the Mailer and deliver the mail.
*Initial Coverage:
[[File:n1.jpg|border|1000px]]

*Latest Coverage:
[[File:n2.jpg|border|1000px]]

*Test Cases Added:
[[File:n_3.png|border|1000px]]

=== done_by_staff_participant? ===
This method will check if the review is done by a staff, which include TAs and instructors.

*Initial Coverage:
[[File:do1.jpg|border|1000px]]

*Latest Coverage:
[[File:do2.jpg|border|1000px]]

*Test Cases Added:
[[File:do3.png|border|1000px]]

=== dispaly_as_html(prefix = nil, count = nil, _file_url = nil, show_tags = nil, current_user = nil) ===

*Initial Coverage:
[[File:di2.jpg|border|1000px]]

*Test Cases Added:
[[File:di3.png|border|1000px]]

=== construct_review_response(code, self_id, show_tags = nil, current_user = nil) ===
This method is a private method in response model, which will only be called by the display_as_html method. In this method, if the response contains additional commends, it will replace /n to .
*Initial Coverage:
[[File:c_1.jpg|border|1000px]]

*Latest Coverage:
[[File:c_2.jpg|border|1000px]]

*Test Cases Added:
[[File:c_3.png|border|1000px]]

== Results ==
[[File:grades_controller_cover.png|border|500px]]

[[File:grades_helper_cover.jpg|border|300px]]

[[File:grades_cover.jpg|border|900px]]

=== Collaborators ===
*Li Yu Shan (lshan3)
*Chao Ting Hung (chung4)
*Chen Ni Liu (cliu43)
*Kan No Lee (klee32)

=== Relevant Links ===
Main Expertiza Repository can be found [https://github.com/expertiza/expertiza here].

Our forked Repository can be found [https://github.com/gggho0806/expertiza/tree/beta here].

CSC/ECE 517 Fall 2021 - E2166. Testing - Scoring & Grades

2021-12-01T01:32:57Z

Lshan3: /* done_by_staff_participant? */

== Project Overview ==

In Expertiza, scoring and grades are a large part of its implement that benefit for both instructor and students. They play important role for students to examine others' work and for the instructor to grade students' performance. However, they are not fully tested and considered thoroughly. The main purpose of this project is to refactor grades in beta and adding test cases would be the method to do so.

=== Objectives ===

Our objectives for this project are the following:
*Develop the files below further to cover missing methods and lines.
*Write extra tests to cover any edge cases that may need to be considered.
*Increase the coverage of the spec.

=== Files Involved and original coverage===
*Grades_controller_spec [[https://coveralls.io/builds/43656335/source?filename=app%2Fcontrollers%2Fgrades_controller.rb here]]-86%covered
*Grades_helper_spec [[https://coveralls.io/builds/43656335/source?filename=app%2Fhelpers%2Fgrades_helper.rb here]]-58%covered
*Response_spec [[https://coveralls.io/builds/43656335/source?filename=app%2Fmodels%2Fresponse.rb here]]-86.4%covered

== Run the file ==
<pre>
rspec ./spec/helpers/Grades_helper_spec.rb
rspec ./spec/controller/Grades_controller_spec.rb
rsepc ./spec/model/Response_spec.rb
</pre>

== Test Plan ==
We look into these file and their related functions. The initial coverage is high, but we still want to add more test cases to cover almost every situation. Therefore, the functions below are what we plan to work on in this project. We are going to run the initial code first and see which lines are not executed and add the corresponding test cases to increase the coverage.
=== Relevant Methods ===
Grades_controller_spec
*action_allowed
*update
*save_grade_and_comment_for_submission
*self_review_finished

Grades_helper_spec
*accordion_title(last_topic, new_topic)
*has_team_and_metareview
*view_heatgrid(participant_id, type)
*penalty
Response_spec
*maximum_score
*email
*populate_new_response
*questionnaire_by_answer
*delete
*self.calibration_results_info
*notify_instructor_on_difference
*done_by_staff_participant?
*dispaly_as_html
*construct_review_response
== GradesController_spec ==
=== action_allowed ===
This function allows students to view their score and view their team by checking if current user has student privilege. We plan to add test on method of allowing current user to view team. If current user is a student, user id is expected to be found in AssignmentParticipant.

[[File:517_project4_1.jpg]]

*Initial Coverage:
[[File:action.jpg|border|1000px]]

*Test Cases Added:
[[File:ac.png|border|1000px]]

=== update ===
In this function, it returns a message depending on whether the participant grade is nil or not and redirects to a edit action. We plan to add test on computing the message if the participant score is not nil, it is expected to print a sentence like "A score of ... has been saved for ...".

[[File:517_project4_2.jpg]]

*Initial Coverage:
[[File:update_1.jpg|border|1000px]]

*Test Cases Added:
[[File:update_2.png|border|1000px]]

=== save_grade_and_comment_for_submission ===
This function saves the grade and comment after submission. We plan to add a test case that fails to save the submission. When we look up in flash, it is expected to be "$ERROR_INFO".

[[File:517_project4_3.jpg]]

*Initial Coverage:
[[File:save_grade.jpg|border|1000px]]

*Test Cases Added:
[[File:update_1.png|border|1000px]]

=== self_review_finished ===
This is a boolean function that tells if the students finished their self reviews or not. We plan to add a test case that shows if the system enables student to self review, which means the student hasn't submit the self review and the test is expected to get false.

[[File:517_project4_4.jpg]]

*Initial Coverage:
[[File:self_review.jpg|border|1000px]]

*Problem:
The self_review_finished method is a private method, difficult to test every scenarios through the public interface.

== GradesHelper_spec ==
=== accordion_title(last_topic, new_topic) ===
This function would render different view according to the comparison of last_topic and new_topic. We plan to create three contexts to test it as below:
1. When last_topic is empty, the function should return view which contains the new_topic
2. last_topic doesn't equal to new_topic, the function should return view which contains the new_topic
3. Other situation, the function should return nothing

[[File:517_project4_8.jpg]]

*Initial Coverage:
[[File:accordion.png|border|1000px]]
*Latest Coverage:
[[File:accor2.jpg|border|500px]]
*Test Cases Added:
[[File:accord.jpeg|border|800px]]

=== has_team_and_metareview? ===
In this function, we plan to complete cases to cover all the function. The cases include:
1. When an assignment is a team assignment and has meta review, the return values should contain true_num = 2.
2. When an assignment is a team assignment or has meta review, the return values should contain true_num = 1.
3. When an assignment is a personal assignment and doesn't has meta review, the return values should contain true_num = 0.

[[File:517_project4_9.jpg]]

*Initial Coverage:
[[File:has_team.jpg|border|1000px]]
*Latest Coverage:
[[File:meta2.jpg|border|500px]]

*Test Cases Added:
[[File:metaview_1.jpg|border|800px]]
*The comment part is the original code that shows bug:
[[File:metaview_2.jpg|border|800px]]

=== view_heatgrid(participant_id, type) ===
This function would get all the questionnaires belonging to a participant, and filter questionnaires according to 'type' parameter, and then collect questionnaire to render the target view
So, we plan to check if the return value only contends the certain type of questionnaires.
*Initial Coverage:
[[File:viewgrid.jpg|border|1000px]]

*Latest Coverage:
[[File:heat2.jpg|border|500px]]

*Test Cases Added:
[[File:heatgrid.jpg|border|800px]]

=== penalty ===
This function would calcualte the penalties of an assignment. We plan to give an assignment and check if its field 'is_penalty_calculated' change to 'true'
*Initial Coverage:
[[File:penal_initial.jpg|border|800px]]

*Latest Coverage:
[[File:penal_pass.jpg|border|500px]]

*Test Cases Added:
[[File:penalty.jpg|border|800px]]

== Response_spec ==
=== maximum_score ===
This function returns the highest possible score for this response, and it only accepts the scorable question and non nil answer. We plan to add a test case that a response doesn't have any score, in this case, total_weight is expected to remain 0 and result should be 0 as well.

[[File:517_project4_5.jpg]]
*Initial Coverage:
[[File:m_1.jpg|border|1000px]]

*Latest Coverage:
[[File:max_score.jpg|border|1000px]]

*Test Cases Added:
[[File:max3.png|border|1000px]]

=== email ===
This function finds out which kind of survey is it and searches the parent of the result. Parent is used as a common variable name for either an assignment or a course. We plan to add test case that the type of survey is associated with course, so we would directly get the assignment from participant, which is the response of course survey.

[[File:517_project4_6.jpg]]

*Initial Coverage:
[[File:e_1.jpg|border|1000px]]

*Latest Coverage:
[[File:email.jpg|border|1000px]]

*Test Cases Added:
[[File:emailtest.png|border|1000px]]

=== populate_new_response ===
This function returns a Response object used to populate @response instance object with the correct response according to review round or with a new response object that the controller can use. We plan to add test case that concludes three scenarios: A response exists after the latest submission, A response exists before the latest submission, No response exists in current submission. For the first case, it is expected to get the original response. As for the rest, it is expected to populate new response.

[[File:517_project4_7.jpg]]

*Initial Coverage:
[[File:populate.jpeg|border|1000px]]

*Latest Coverage:
[[File:p_2.jpeg|border|1000px]]

*Test Cases Added:
[[File:populatetest.png|border|1000px]]

=== questionnaire_by_answer ===
In this function, a questionnaire can be found by its answer, and this assignment can be gotten through either participant or map. We plan to add a test case that is to obtain the assignment through participant by a given answer.

*Initial Coverage:
[[File:q_1.jpeg|border|1000px]]

*Latest Coverage:
[[File:questionnaire.jpeg|border|1000px]]

*Test Cases Added:
[[File:ques3.png|border|1000px]]

=== delete ===
Before the response is destroyed, its response scores will also be destroyed.
*Initial Coverage:
[[File:d1.jpg|border|1000px]]

*Latest Coverage:
[[File:d2.jpg|border|1000px]]

*Test Cases Added:
[[File:d3.png|border|1000px]]

=== self.calibration_results_info(calibration_id, response_id, assignment_id) ===
This method is used when a student views their calibration results for a particular review/assignment. It should return the reference of calibration response, review response, and questions.
*Initial Coverage:
[[File:s1.jpg|border|1000px]]

*Latest Coverage:
[[File:s2.jpg|border|1000px]]

*Test Cases Added:
[[File:s_3.png|border|1000px]]

=== notify_instructor_on_difference ===
This method will send a mail via Mailer when the review score is abnormal. The method should pass the data with the correct format to the Mailer and deliver the mail.
*Initial Coverage:
[[File:n1.jpg|border|1000px]]

*Latest Coverage:
[[File:n2.jpg|border|1000px]]

*Test Cases Added:
[[File:n_3.png|border|1000px]]

=== done_by_staff_participant? ===
This method will check if the review is done by a staff, which include TAs and instructors.

*Initial Coverage:
[[File:do1.jpg|border|1000px]]

*Latest Coverage:
[[File:do2.jpg|border|1000px]]

*Test Cases Added:
[[File:do3.png|border|1000px]]

=== dispaly_as_html(prefix = nil, count = nil, _file_url = nil, show_tags = nil, current_user = nil) ===

*Initial Coverage:
[[File:di2.jpg|border|1000px]]

*Test Cases Added:
[[File:di3.png|border|1000px]]

=== construct_review_response(code, self_id, show_tags = nil, current_user = nil) ===
*Initial Coverage:
[[File:c_1.jpg|border|1000px]]

*Latest Coverage:
[[File:c_2.jpg|border|1000px]]

*Test Cases Added:
[[File:c_3.png|border|1000px]]

== Results ==
[[File:grades_controller_cover.png|border|500px]]

[[File:grades_helper_cover.jpg|border|300px]]

[[File:grades_cover.jpg|border|900px]]

=== Collaborators ===
*Li Yu Shan (lshan3)
*Chao Ting Hung (chung4)
*Chen Ni Liu (cliu43)
*Kan No Lee (klee32)

=== Relevant Links ===
Main Expertiza Repository can be found [https://github.com/expertiza/expertiza here].

Our forked Repository can be found [https://github.com/gggho0806/expertiza/tree/beta here].

CSC/ECE 517 Fall 2021 - E2166. Testing - Scoring & Grades

2021-12-01T01:32:17Z

Lshan3: /* notify_instructor_on_difference */

== Project Overview ==

In Expertiza, scoring and grades are a large part of its implement that benefit for both instructor and students. They play important role for students to examine others' work and for the instructor to grade students' performance. However, they are not fully tested and considered thoroughly. The main purpose of this project is to refactor grades in beta and adding test cases would be the method to do so.

=== Objectives ===

Our objectives for this project are the following:
*Develop the files below further to cover missing methods and lines.
*Write extra tests to cover any edge cases that may need to be considered.
*Increase the coverage of the spec.

=== Files Involved and original coverage===
*Grades_controller_spec [[https://coveralls.io/builds/43656335/source?filename=app%2Fcontrollers%2Fgrades_controller.rb here]]-86%covered
*Grades_helper_spec [[https://coveralls.io/builds/43656335/source?filename=app%2Fhelpers%2Fgrades_helper.rb here]]-58%covered
*Response_spec [[https://coveralls.io/builds/43656335/source?filename=app%2Fmodels%2Fresponse.rb here]]-86.4%covered

== Run the file ==
<pre>
rspec ./spec/helpers/Grades_helper_spec.rb
rspec ./spec/controller/Grades_controller_spec.rb
rsepc ./spec/model/Response_spec.rb
</pre>

== Test Plan ==
We look into these file and their related functions. The initial coverage is high, but we still want to add more test cases to cover almost every situation. Therefore, the functions below are what we plan to work on in this project. We are going to run the initial code first and see which lines are not executed and add the corresponding test cases to increase the coverage.
=== Relevant Methods ===
Grades_controller_spec
*action_allowed
*update
*save_grade_and_comment_for_submission
*self_review_finished

Grades_helper_spec
*accordion_title(last_topic, new_topic)
*has_team_and_metareview
*view_heatgrid(participant_id, type)
*penalty
Response_spec
*maximum_score
*email
*populate_new_response
*questionnaire_by_answer
*delete
*self.calibration_results_info
*notify_instructor_on_difference
*done_by_staff_participant?
*dispaly_as_html
*construct_review_response
== GradesController_spec ==
=== action_allowed ===
This function allows students to view their score and view their team by checking if current user has student privilege. We plan to add test on method of allowing current user to view team. If current user is a student, user id is expected to be found in AssignmentParticipant.

[[File:517_project4_1.jpg]]

*Initial Coverage:
[[File:action.jpg|border|1000px]]

*Test Cases Added:
[[File:ac.png|border|1000px]]

=== update ===
In this function, it returns a message depending on whether the participant grade is nil or not and redirects to a edit action. We plan to add test on computing the message if the participant score is not nil, it is expected to print a sentence like "A score of ... has been saved for ...".

[[File:517_project4_2.jpg]]

*Initial Coverage:
[[File:update_1.jpg|border|1000px]]

*Test Cases Added:
[[File:update_2.png|border|1000px]]

=== save_grade_and_comment_for_submission ===
This function saves the grade and comment after submission. We plan to add a test case that fails to save the submission. When we look up in flash, it is expected to be "$ERROR_INFO".

[[File:517_project4_3.jpg]]

*Initial Coverage:
[[File:save_grade.jpg|border|1000px]]

*Test Cases Added:
[[File:update_1.png|border|1000px]]

=== self_review_finished ===
This is a boolean function that tells if the students finished their self reviews or not. We plan to add a test case that shows if the system enables student to self review, which means the student hasn't submit the self review and the test is expected to get false.

[[File:517_project4_4.jpg]]

*Initial Coverage:
[[File:self_review.jpg|border|1000px]]

*Problem:
The self_review_finished method is a private method, difficult to test every scenarios through the public interface.

== GradesHelper_spec ==
=== accordion_title(last_topic, new_topic) ===
This function would render different view according to the comparison of last_topic and new_topic. We plan to create three contexts to test it as below:
1. When last_topic is empty, the function should return view which contains the new_topic
2. last_topic doesn't equal to new_topic, the function should return view which contains the new_topic
3. Other situation, the function should return nothing

[[File:517_project4_8.jpg]]

*Initial Coverage:
[[File:accordion.png|border|1000px]]
*Latest Coverage:
[[File:accor2.jpg|border|500px]]
*Test Cases Added:
[[File:accord.jpeg|border|800px]]

=== has_team_and_metareview? ===
In this function, we plan to complete cases to cover all the function. The cases include:
1. When an assignment is a team assignment and has meta review, the return values should contain true_num = 2.
2. When an assignment is a team assignment or has meta review, the return values should contain true_num = 1.
3. When an assignment is a personal assignment and doesn't has meta review, the return values should contain true_num = 0.

[[File:517_project4_9.jpg]]

*Initial Coverage:
[[File:has_team.jpg|border|1000px]]
*Latest Coverage:
[[File:meta2.jpg|border|500px]]

*Test Cases Added:
[[File:metaview_1.jpg|border|800px]]
*The comment part is the original code that shows bug:
[[File:metaview_2.jpg|border|800px]]

=== view_heatgrid(participant_id, type) ===
This function would get all the questionnaires belonging to a participant, and filter questionnaires according to 'type' parameter, and then collect questionnaire to render the target view
So, we plan to check if the return value only contends the certain type of questionnaires.
*Initial Coverage:
[[File:viewgrid.jpg|border|1000px]]

*Latest Coverage:
[[File:heat2.jpg|border|500px]]

*Test Cases Added:
[[File:heatgrid.jpg|border|800px]]

=== penalty ===
This function would calcualte the penalties of an assignment. We plan to give an assignment and check if its field 'is_penalty_calculated' change to 'true'
*Initial Coverage:
[[File:penal_initial.jpg|border|800px]]

*Latest Coverage:
[[File:penal_pass.jpg|border|500px]]

*Test Cases Added:
[[File:penalty.jpg|border|800px]]

== Response_spec ==
=== maximum_score ===
This function returns the highest possible score for this response, and it only accepts the scorable question and non nil answer. We plan to add a test case that a response doesn't have any score, in this case, total_weight is expected to remain 0 and result should be 0 as well.

[[File:517_project4_5.jpg]]
*Initial Coverage:
[[File:m_1.jpg|border|1000px]]

*Latest Coverage:
[[File:max_score.jpg|border|1000px]]

*Test Cases Added:
[[File:max3.png|border|1000px]]

=== email ===
This function finds out which kind of survey is it and searches the parent of the result. Parent is used as a common variable name for either an assignment or a course. We plan to add test case that the type of survey is associated with course, so we would directly get the assignment from participant, which is the response of course survey.

[[File:517_project4_6.jpg]]

*Initial Coverage:
[[File:e_1.jpg|border|1000px]]

*Latest Coverage:
[[File:email.jpg|border|1000px]]

*Test Cases Added:
[[File:emailtest.png|border|1000px]]

=== populate_new_response ===
This function returns a Response object used to populate @response instance object with the correct response according to review round or with a new response object that the controller can use. We plan to add test case that concludes three scenarios: A response exists after the latest submission, A response exists before the latest submission, No response exists in current submission. For the first case, it is expected to get the original response. As for the rest, it is expected to populate new response.

[[File:517_project4_7.jpg]]

*Initial Coverage:
[[File:populate.jpeg|border|1000px]]

*Latest Coverage:
[[File:p_2.jpeg|border|1000px]]

*Test Cases Added:
[[File:populatetest.png|border|1000px]]

=== questionnaire_by_answer ===
In this function, a questionnaire can be found by its answer, and this assignment can be gotten through either participant or map. We plan to add a test case that is to obtain the assignment through participant by a given answer.

*Initial Coverage:
[[File:q_1.jpeg|border|1000px]]

*Latest Coverage:
[[File:questionnaire.jpeg|border|1000px]]

*Test Cases Added:
[[File:ques3.png|border|1000px]]

=== delete ===
Before the response is destroyed, its response scores will also be destroyed.
*Initial Coverage:
[[File:d1.jpg|border|1000px]]

*Latest Coverage:
[[File:d2.jpg|border|1000px]]

*Test Cases Added:
[[File:d3.png|border|1000px]]

=== self.calibration_results_info(calibration_id, response_id, assignment_id) ===
This method is used when a student views their calibration results for a particular review/assignment. It should return the reference of calibration response, review response, and questions.
*Initial Coverage:
[[File:s1.jpg|border|1000px]]

*Latest Coverage:
[[File:s2.jpg|border|1000px]]

*Test Cases Added:
[[File:s_3.png|border|1000px]]

=== notify_instructor_on_difference ===
This method will send a mail via Mailer when the review score is abnormal. The method should pass the data with the correct format to the Mailer and deliver the mail.
*Initial Coverage:
[[File:n1.jpg|border|1000px]]

*Latest Coverage:
[[File:n2.jpg|border|1000px]]

*Test Cases Added:
[[File:n_3.png|border|1000px]]

=== done_by_staff_participant? ===
*Initial Coverage:
[[File:do1.jpg|border|1000px]]

*Latest Coverage:
[[File:do2.jpg|border|1000px]]

*Test Cases Added:
[[File:do3.png|border|1000px]]

=== dispaly_as_html(prefix = nil, count = nil, _file_url = nil, show_tags = nil, current_user = nil) ===

*Initial Coverage:
[[File:di2.jpg|border|1000px]]

*Test Cases Added:
[[File:di3.png|border|1000px]]

=== construct_review_response(code, self_id, show_tags = nil, current_user = nil) ===
*Initial Coverage:
[[File:c_1.jpg|border|1000px]]

*Latest Coverage:
[[File:c_2.jpg|border|1000px]]

*Test Cases Added:
[[File:c_3.png|border|1000px]]

== Results ==
[[File:grades_controller_cover.png|border|500px]]

[[File:grades_helper_cover.jpg|border|300px]]

[[File:grades_cover.jpg|border|900px]]

=== Collaborators ===
*Li Yu Shan (lshan3)
*Chao Ting Hung (chung4)
*Chen Ni Liu (cliu43)
*Kan No Lee (klee32)

=== Relevant Links ===
Main Expertiza Repository can be found [https://github.com/expertiza/expertiza here].

Our forked Repository can be found [https://github.com/gggho0806/expertiza/tree/beta here].

CSC/ECE 517 Fall 2021 - E2166. Testing - Scoring & Grades

2021-12-01T01:30:32Z

Lshan3: /* self.calibration_results_info(calibration_id, response_id, assignment_id) */

== Project Overview ==

In Expertiza, scoring and grades are a large part of its implement that benefit for both instructor and students. They play important role for students to examine others' work and for the instructor to grade students' performance. However, they are not fully tested and considered thoroughly. The main purpose of this project is to refactor grades in beta and adding test cases would be the method to do so.

=== Objectives ===

Our objectives for this project are the following:
*Develop the files below further to cover missing methods and lines.
*Write extra tests to cover any edge cases that may need to be considered.
*Increase the coverage of the spec.

=== Files Involved and original coverage===
*Grades_controller_spec [[https://coveralls.io/builds/43656335/source?filename=app%2Fcontrollers%2Fgrades_controller.rb here]]-86%covered
*Grades_helper_spec [[https://coveralls.io/builds/43656335/source?filename=app%2Fhelpers%2Fgrades_helper.rb here]]-58%covered
*Response_spec [[https://coveralls.io/builds/43656335/source?filename=app%2Fmodels%2Fresponse.rb here]]-86.4%covered

== Run the file ==
<pre>
rspec ./spec/helpers/Grades_helper_spec.rb
rspec ./spec/controller/Grades_controller_spec.rb
rsepc ./spec/model/Response_spec.rb
</pre>

== Test Plan ==
We look into these file and their related functions. The initial coverage is high, but we still want to add more test cases to cover almost every situation. Therefore, the functions below are what we plan to work on in this project. We are going to run the initial code first and see which lines are not executed and add the corresponding test cases to increase the coverage.
=== Relevant Methods ===
Grades_controller_spec
*action_allowed
*update
*save_grade_and_comment_for_submission
*self_review_finished

Grades_helper_spec
*accordion_title(last_topic, new_topic)
*has_team_and_metareview
*view_heatgrid(participant_id, type)
*penalty
Response_spec
*maximum_score
*email
*populate_new_response
*questionnaire_by_answer
*delete
*self.calibration_results_info
*notify_instructor_on_difference
*done_by_staff_participant?
*dispaly_as_html
*construct_review_response
== GradesController_spec ==
=== action_allowed ===
This function allows students to view their score and view their team by checking if current user has student privilege. We plan to add test on method of allowing current user to view team. If current user is a student, user id is expected to be found in AssignmentParticipant.

[[File:517_project4_1.jpg]]

*Initial Coverage:
[[File:action.jpg|border|1000px]]

*Test Cases Added:
[[File:ac.png|border|1000px]]

=== update ===
In this function, it returns a message depending on whether the participant grade is nil or not and redirects to a edit action. We plan to add test on computing the message if the participant score is not nil, it is expected to print a sentence like "A score of ... has been saved for ...".

[[File:517_project4_2.jpg]]

*Initial Coverage:
[[File:update_1.jpg|border|1000px]]

*Test Cases Added:
[[File:update_2.png|border|1000px]]

=== save_grade_and_comment_for_submission ===
This function saves the grade and comment after submission. We plan to add a test case that fails to save the submission. When we look up in flash, it is expected to be "$ERROR_INFO".

[[File:517_project4_3.jpg]]

*Initial Coverage:
[[File:save_grade.jpg|border|1000px]]

*Test Cases Added:
[[File:update_1.png|border|1000px]]

=== self_review_finished ===
This is a boolean function that tells if the students finished their self reviews or not. We plan to add a test case that shows if the system enables student to self review, which means the student hasn't submit the self review and the test is expected to get false.

[[File:517_project4_4.jpg]]

*Initial Coverage:
[[File:self_review.jpg|border|1000px]]

*Problem:
The self_review_finished method is a private method, difficult to test every scenarios through the public interface.

== GradesHelper_spec ==
=== accordion_title(last_topic, new_topic) ===
This function would render different view according to the comparison of last_topic and new_topic. We plan to create three contexts to test it as below:
1. When last_topic is empty, the function should return view which contains the new_topic
2. last_topic doesn't equal to new_topic, the function should return view which contains the new_topic
3. Other situation, the function should return nothing

[[File:517_project4_8.jpg]]

*Initial Coverage:
[[File:accordion.png|border|1000px]]
*Latest Coverage:
[[File:accor2.jpg|border|500px]]
*Test Cases Added:
[[File:accord.jpeg|border|800px]]

=== has_team_and_metareview? ===
In this function, we plan to complete cases to cover all the function. The cases include:
1. When an assignment is a team assignment and has meta review, the return values should contain true_num = 2.
2. When an assignment is a team assignment or has meta review, the return values should contain true_num = 1.
3. When an assignment is a personal assignment and doesn't has meta review, the return values should contain true_num = 0.

[[File:517_project4_9.jpg]]

*Initial Coverage:
[[File:has_team.jpg|border|1000px]]
*Latest Coverage:
[[File:meta2.jpg|border|500px]]

*Test Cases Added:
[[File:metaview_1.jpg|border|800px]]
*The comment part is the original code that shows bug:
[[File:metaview_2.jpg|border|800px]]

=== view_heatgrid(participant_id, type) ===
This function would get all the questionnaires belonging to a participant, and filter questionnaires according to 'type' parameter, and then collect questionnaire to render the target view
So, we plan to check if the return value only contends the certain type of questionnaires.
*Initial Coverage:
[[File:viewgrid.jpg|border|1000px]]

*Latest Coverage:
[[File:heat2.jpg|border|500px]]

*Test Cases Added:
[[File:heatgrid.jpg|border|800px]]

=== penalty ===
This function would calcualte the penalties of an assignment. We plan to give an assignment and check if its field 'is_penalty_calculated' change to 'true'
*Initial Coverage:
[[File:penal_initial.jpg|border|800px]]

*Latest Coverage:
[[File:penal_pass.jpg|border|500px]]

*Test Cases Added:
[[File:penalty.jpg|border|800px]]

== Response_spec ==
=== maximum_score ===
This function returns the highest possible score for this response, and it only accepts the scorable question and non nil answer. We plan to add a test case that a response doesn't have any score, in this case, total_weight is expected to remain 0 and result should be 0 as well.

[[File:517_project4_5.jpg]]
*Initial Coverage:
[[File:m_1.jpg|border|1000px]]

*Latest Coverage:
[[File:max_score.jpg|border|1000px]]

*Test Cases Added:
[[File:max3.png|border|1000px]]

=== email ===
This function finds out which kind of survey is it and searches the parent of the result. Parent is used as a common variable name for either an assignment or a course. We plan to add test case that the type of survey is associated with course, so we would directly get the assignment from participant, which is the response of course survey.

[[File:517_project4_6.jpg]]

*Initial Coverage:
[[File:e_1.jpg|border|1000px]]

*Latest Coverage:
[[File:email.jpg|border|1000px]]

*Test Cases Added:
[[File:emailtest.png|border|1000px]]

=== populate_new_response ===
This function returns a Response object used to populate @response instance object with the correct response according to review round or with a new response object that the controller can use. We plan to add test case that concludes three scenarios: A response exists after the latest submission, A response exists before the latest submission, No response exists in current submission. For the first case, it is expected to get the original response. As for the rest, it is expected to populate new response.

[[File:517_project4_7.jpg]]

*Initial Coverage:
[[File:populate.jpeg|border|1000px]]

*Latest Coverage:
[[File:p_2.jpeg|border|1000px]]

*Test Cases Added:
[[File:populatetest.png|border|1000px]]

=== questionnaire_by_answer ===
In this function, a questionnaire can be found by its answer, and this assignment can be gotten through either participant or map. We plan to add a test case that is to obtain the assignment through participant by a given answer.

*Initial Coverage:
[[File:q_1.jpeg|border|1000px]]

*Latest Coverage:
[[File:questionnaire.jpeg|border|1000px]]

*Test Cases Added:
[[File:ques3.png|border|1000px]]

=== delete ===
Before the response is destroyed, its response scores will also be destroyed.
*Initial Coverage:
[[File:d1.jpg|border|1000px]]

*Latest Coverage:
[[File:d2.jpg|border|1000px]]

*Test Cases Added:
[[File:d3.png|border|1000px]]

=== self.calibration_results_info(calibration_id, response_id, assignment_id) ===
This method is used when a student views their calibration results for a particular review/assignment. It should return the reference of calibration response, review response, and questions.
*Initial Coverage:
[[File:s1.jpg|border|1000px]]

*Latest Coverage:
[[File:s2.jpg|border|1000px]]

*Test Cases Added:
[[File:s_3.png|border|1000px]]

=== notify_instructor_on_difference ===
*Initial Coverage:
[[File:n1.jpg|border|1000px]]

*Latest Coverage:
[[File:n2.jpg|border|1000px]]

*Test Cases Added:
[[File:n_3.png|border|1000px]]

=== done_by_staff_participant? ===
*Initial Coverage:
[[File:do1.jpg|border|1000px]]

*Latest Coverage:
[[File:do2.jpg|border|1000px]]

*Test Cases Added:
[[File:do3.png|border|1000px]]

=== dispaly_as_html(prefix = nil, count = nil, _file_url = nil, show_tags = nil, current_user = nil) ===

*Initial Coverage:
[[File:di2.jpg|border|1000px]]

*Test Cases Added:
[[File:di3.png|border|1000px]]

=== construct_review_response(code, self_id, show_tags = nil, current_user = nil) ===
*Initial Coverage:
[[File:c_1.jpg|border|1000px]]

*Latest Coverage:
[[File:c_2.jpg|border|1000px]]

*Test Cases Added:
[[File:c_3.png|border|1000px]]

== Results ==
[[File:grades_controller_cover.png|border|500px]]

[[File:grades_helper_cover.jpg|border|300px]]

[[File:grades_cover.jpg|border|900px]]

=== Collaborators ===
*Li Yu Shan (lshan3)
*Chao Ting Hung (chung4)
*Chen Ni Liu (cliu43)
*Kan No Lee (klee32)

=== Relevant Links ===
Main Expertiza Repository can be found [https://github.com/expertiza/expertiza here].

Our forked Repository can be found [https://github.com/gggho0806/expertiza/tree/beta here].

CSC/ECE 517 Fall 2021 - E2166. Testing - Scoring & Grades

2021-12-01T01:29:05Z

Lshan3: /* delete */

== Project Overview ==

In Expertiza, scoring and grades are a large part of its implement that benefit for both instructor and students. They play important role for students to examine others' work and for the instructor to grade students' performance. However, they are not fully tested and considered thoroughly. The main purpose of this project is to refactor grades in beta and adding test cases would be the method to do so.

=== Objectives ===

Our objectives for this project are the following:
*Develop the files below further to cover missing methods and lines.
*Write extra tests to cover any edge cases that may need to be considered.
*Increase the coverage of the spec.

=== Files Involved and original coverage===
*Grades_controller_spec [[https://coveralls.io/builds/43656335/source?filename=app%2Fcontrollers%2Fgrades_controller.rb here]]-86%covered
*Grades_helper_spec [[https://coveralls.io/builds/43656335/source?filename=app%2Fhelpers%2Fgrades_helper.rb here]]-58%covered
*Response_spec [[https://coveralls.io/builds/43656335/source?filename=app%2Fmodels%2Fresponse.rb here]]-86.4%covered

== Run the file ==
<pre>
rspec ./spec/helpers/Grades_helper_spec.rb
rspec ./spec/controller/Grades_controller_spec.rb
rsepc ./spec/model/Response_spec.rb
</pre>

== Test Plan ==
We look into these file and their related functions. The initial coverage is high, but we still want to add more test cases to cover almost every situation. Therefore, the functions below are what we plan to work on in this project. We are going to run the initial code first and see which lines are not executed and add the corresponding test cases to increase the coverage.
=== Relevant Methods ===
Grades_controller_spec
*action_allowed
*update
*save_grade_and_comment_for_submission
*self_review_finished

Grades_helper_spec
*accordion_title(last_topic, new_topic)
*has_team_and_metareview
*view_heatgrid(participant_id, type)
*penalty
Response_spec
*maximum_score
*email
*populate_new_response
*questionnaire_by_answer
*delete
*self.calibration_results_info
*notify_instructor_on_difference
*done_by_staff_participant?
*dispaly_as_html
*construct_review_response
== GradesController_spec ==
=== action_allowed ===
This function allows students to view their score and view their team by checking if current user has student privilege. We plan to add test on method of allowing current user to view team. If current user is a student, user id is expected to be found in AssignmentParticipant.

[[File:517_project4_1.jpg]]

*Initial Coverage:
[[File:action.jpg|border|1000px]]

*Test Cases Added:
[[File:ac.png|border|1000px]]

=== update ===
In this function, it returns a message depending on whether the participant grade is nil or not and redirects to a edit action. We plan to add test on computing the message if the participant score is not nil, it is expected to print a sentence like "A score of ... has been saved for ...".

[[File:517_project4_2.jpg]]

*Initial Coverage:
[[File:update_1.jpg|border|1000px]]

*Test Cases Added:
[[File:update_2.png|border|1000px]]

=== save_grade_and_comment_for_submission ===
This function saves the grade and comment after submission. We plan to add a test case that fails to save the submission. When we look up in flash, it is expected to be "$ERROR_INFO".

[[File:517_project4_3.jpg]]

*Initial Coverage:
[[File:save_grade.jpg|border|1000px]]

*Test Cases Added:
[[File:update_1.png|border|1000px]]

=== self_review_finished ===
This is a boolean function that tells if the students finished their self reviews or not. We plan to add a test case that shows if the system enables student to self review, which means the student hasn't submit the self review and the test is expected to get false.

[[File:517_project4_4.jpg]]

*Initial Coverage:
[[File:self_review.jpg|border|1000px]]

*Problem:
The self_review_finished method is a private method, difficult to test every scenarios through the public interface.

== GradesHelper_spec ==
=== accordion_title(last_topic, new_topic) ===
This function would render different view according to the comparison of last_topic and new_topic. We plan to create three contexts to test it as below:
1. When last_topic is empty, the function should return view which contains the new_topic
2. last_topic doesn't equal to new_topic, the function should return view which contains the new_topic
3. Other situation, the function should return nothing

[[File:517_project4_8.jpg]]

*Initial Coverage:
[[File:accordion.png|border|1000px]]
*Latest Coverage:
[[File:accor2.jpg|border|500px]]
*Test Cases Added:
[[File:accord.jpeg|border|800px]]

=== has_team_and_metareview? ===
In this function, we plan to complete cases to cover all the function. The cases include:
1. When an assignment is a team assignment and has meta review, the return values should contain true_num = 2.
2. When an assignment is a team assignment or has meta review, the return values should contain true_num = 1.
3. When an assignment is a personal assignment and doesn't has meta review, the return values should contain true_num = 0.

[[File:517_project4_9.jpg]]

*Initial Coverage:
[[File:has_team.jpg|border|1000px]]
*Latest Coverage:
[[File:meta2.jpg|border|500px]]

*Test Cases Added:
[[File:metaview_1.jpg|border|800px]]
*The comment part is the original code that shows bug:
[[File:metaview_2.jpg|border|800px]]

=== view_heatgrid(participant_id, type) ===
This function would get all the questionnaires belonging to a participant, and filter questionnaires according to 'type' parameter, and then collect questionnaire to render the target view
So, we plan to check if the return value only contends the certain type of questionnaires.
*Initial Coverage:
[[File:viewgrid.jpg|border|1000px]]

*Latest Coverage:
[[File:heat2.jpg|border|500px]]

*Test Cases Added:
[[File:heatgrid.jpg|border|800px]]

=== penalty ===
This function would calcualte the penalties of an assignment. We plan to give an assignment and check if its field 'is_penalty_calculated' change to 'true'
*Initial Coverage:
[[File:penal_initial.jpg|border|800px]]

*Latest Coverage:
[[File:penal_pass.jpg|border|500px]]

*Test Cases Added:
[[File:penalty.jpg|border|800px]]

== Response_spec ==
=== maximum_score ===
This function returns the highest possible score for this response, and it only accepts the scorable question and non nil answer. We plan to add a test case that a response doesn't have any score, in this case, total_weight is expected to remain 0 and result should be 0 as well.

[[File:517_project4_5.jpg]]
*Initial Coverage:
[[File:m_1.jpg|border|1000px]]

*Latest Coverage:
[[File:max_score.jpg|border|1000px]]

*Test Cases Added:
[[File:max3.png|border|1000px]]

=== email ===
This function finds out which kind of survey is it and searches the parent of the result. Parent is used as a common variable name for either an assignment or a course. We plan to add test case that the type of survey is associated with course, so we would directly get the assignment from participant, which is the response of course survey.

[[File:517_project4_6.jpg]]

*Initial Coverage:
[[File:e_1.jpg|border|1000px]]

*Latest Coverage:
[[File:email.jpg|border|1000px]]

*Test Cases Added:
[[File:emailtest.png|border|1000px]]

=== populate_new_response ===
This function returns a Response object used to populate @response instance object with the correct response according to review round or with a new response object that the controller can use. We plan to add test case that concludes three scenarios: A response exists after the latest submission, A response exists before the latest submission, No response exists in current submission. For the first case, it is expected to get the original response. As for the rest, it is expected to populate new response.

[[File:517_project4_7.jpg]]

*Initial Coverage:
[[File:populate.jpeg|border|1000px]]

*Latest Coverage:
[[File:p_2.jpeg|border|1000px]]

*Test Cases Added:
[[File:populatetest.png|border|1000px]]

=== questionnaire_by_answer ===
In this function, a questionnaire can be found by its answer, and this assignment can be gotten through either participant or map. We plan to add a test case that is to obtain the assignment through participant by a given answer.

*Initial Coverage:
[[File:q_1.jpeg|border|1000px]]

*Latest Coverage:
[[File:questionnaire.jpeg|border|1000px]]

*Test Cases Added:
[[File:ques3.png|border|1000px]]

=== delete ===
Before the response is destroyed, its response scores will also be destroyed.
*Initial Coverage:
[[File:d1.jpg|border|1000px]]

*Latest Coverage:
[[File:d2.jpg|border|1000px]]

*Test Cases Added:
[[File:d3.png|border|1000px]]

=== self.calibration_results_info(calibration_id, response_id, assignment_id) ===
*Initial Coverage:
[[File:s1.jpg|border|1000px]]

*Latest Coverage:
[[File:s2.jpg|border|1000px]]

*Test Cases Added:
[[File:s_3.png|border|1000px]]

=== notify_instructor_on_difference ===
*Initial Coverage:
[[File:n1.jpg|border|1000px]]

*Latest Coverage:
[[File:n2.jpg|border|1000px]]

*Test Cases Added:
[[File:n_3.png|border|1000px]]

=== done_by_staff_participant? ===
*Initial Coverage:
[[File:do1.jpg|border|1000px]]

*Latest Coverage:
[[File:do2.jpg|border|1000px]]

*Test Cases Added:
[[File:do3.png|border|1000px]]

=== dispaly_as_html(prefix = nil, count = nil, _file_url = nil, show_tags = nil, current_user = nil) ===

*Initial Coverage:
[[File:di2.jpg|border|1000px]]

*Test Cases Added:
[[File:di3.png|border|1000px]]

=== construct_review_response(code, self_id, show_tags = nil, current_user = nil) ===
*Initial Coverage:
[[File:c_1.jpg|border|1000px]]

*Latest Coverage:
[[File:c_2.jpg|border|1000px]]

*Test Cases Added:
[[File:c_3.png|border|1000px]]

== Results ==
[[File:grades_controller_cover.png|border|500px]]

[[File:grades_helper_cover.jpg|border|300px]]

[[File:grades_cover.jpg|border|900px]]

=== Collaborators ===
*Li Yu Shan (lshan3)
*Chao Ting Hung (chung4)
*Chen Ni Liu (cliu43)
*Kan No Lee (klee32)

=== Relevant Links ===
Main Expertiza Repository can be found [https://github.com/expertiza/expertiza here].

Our forked Repository can be found [https://github.com/gggho0806/expertiza/tree/beta here].

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-27T03:59:34Z

Lshan3: /* Manual Testing */

__TOC__

== E2125. Refactor review mapping helper.rb ==
This page describes the Expertiza based OSS project.

=== Expertiza ===

Expertiza is an open-source project contributed by both the students and the faculty at NCSU. It is developed on Ruby-on-Rails and software to create reusable learning objects through peer review. Expertiza allows the instructor to create new assignments, customize new or existing assignments, and create a topic list for students to sign up. It also supports students to form teams for team projects and allows submission with almost any document type, including URLs and wiki pages.

=== Background ===
==== E2125. Refactor review_mapping_helper.rb ====
* Files involved: review_mapping_helper.rb
* What is wrong:
** The review_mapping_helper.rb has methods that exceed the limit on lines of code Also, it is missing proper comments for each functionality. Cyclomatic complexity of most of the methods is way too high as per the standard defined in the Code Climate.
* What needs to be done:
# Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
# Read about cyclomatic complexity here.
# Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas and space or lack of it and assigning branching condition.
Write test cases of any new code written. Test the existing functionality after refactoring.

However, since the code-quality-analysis result from Code Climate shows that all cyclomatic complexity was resolved, the main work was to fix the logic of the method "get_team_color".

=== Modifications in review_mapping_helper.rb ===

==== get_team_color ====
This method is to determine the state of reviewers review on each team. Related pages can be found in "manages... -> assignments -> view reports -> view"

There are five different states:‎ 
[[File:Review_status_color.jpg]]
=====Example=====
Under the column "Team Reviewed", color brown indicates that a score is given to the reviewer (including zero), and color blue indicates that a score havnen't given to the reviewer. 
[[File:Review_mapping_example.png]]
----
The original code will not return the correct color, because when it is checking the grade for the reviewer, it is not checking the correct variable.

<pre> def get_team_color(response_map)
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at

# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)

# Returning colour based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).grade_for_reviewer.nil?
'brown'
elsif response_for_each_round?(response_map)
'blue'
else
check_submission_state(response_map, assignment_created, assignment_due_dates, @assignment.num_review_rounds)
end
else
'red'
end
end
</pre>

===== check_submission_state =====

This method checks whether the team submit the project on time or not. (If there are no submission or the submission is not on time, it is reasonable that the reviewer cannot review the project).
In addition, the submission time of a link should be checked by the last modified time of the webpage, not the moment the link itself is submitted.
----

<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? or (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
'green'
else
link_updated_at = get_link_updated_at(link)
link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>

===== obtain_team_color =====

----

This method has been removed because it is running unnecessary check on old submissions.

<pre>def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []
(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end
color[-1]
end </pre>

=== Test Plan ===

==== RSpec ====

----

All 32 test cases are currently passing.

# In method get_team_color(response_map) in review mapping helper.rb: Only checking if the record exist is not enough, because all mapping records pre-exist with empty scores in it.
# The for loop for checking multiple submission stage is unnecesasry, so we removed obtain_team_color and call check_submission_state directly.
# Stubbing NET::HTTP to fix test cases that originally failed if calling the method get_link_updated_at.
<pre> allow(Net::HTTP).to receive(:get_response).and_return(obj)</pre>

'''Scenarios for get_team_color:''' 
1. color should be red if response_map does not exist 
2. color should be blue if the a review was submitted for each round 
3. color should NOT be blue if the a review was NOT submitted for each round 
4. color should be brown if the review and review_grade exist 
5. color should be green if the submission link is non-existent 
6. color should be green if the submission link is NOT a link to a Expertiza wiki 
7. color should be purple if review were submitted for each round (on time) 
8. color should be purple if submission link has been updated since due date for a specified round 
9. should return green color if the submission link is not present 
10. should return green color if the assignment was not submitted within the round 
11. should return purple color if the assignment was submitted within the round 

'''Scenarios for check_submission_state:''' 
1. should return green color if the submitted link is not a wiki link 
2. should return green color if the submission link is not present 
3. should return green color if the assignment was not submitted within the round 
4. should return purple color if the assignment was submitted within the round 

Example test case:
<pre> it 'color should be purple if submission link has been updated since due date for a specified round' do
# deadline_right inspired from bookmark_review_spec
allow(Net::HTTP).to receive(:get_response).and_return({'last-modified' => DateTime.now.in_time_zone})
create(:deadline_right, name: 'No')
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

response_map_with_reviewee = create(:review_response_map, reviewer: @reviewer, reviewee: @reviewee_with_assignment)

create(:submission_record, assignment_id: @assignment.id, team_id: @reviewee_with_assignment.id, operation: 'Submit Hyperlink',
content: 'https://wiki.archlinux.org/', created_at: DateTime.now.in_time_zone - 7.day)

create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 1, due_at: DateTime.now.in_time_zone - 5.day)
create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 2, due_at: DateTime.now.in_time_zone + 6.day)

create(:response, response_map: response_map_with_reviewee)

color = get_team_color(response_map_with_reviewee)
expect(color).to eq('purple')
end
end
</pre>

==== Manual Testing ====
# Click "manage..." from the tabs above the webpage
# Select assignments from the dropdown list
# select the view reports icon from each created assignments
# click on view button to view different status of different conditions (can create additional assignments with shorter due date intervals, submit new works, and reviews to it)

=== Peer Review Credentials ===
<pre>
Username: instructor6
Password: password
</pre>

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-27T03:59:14Z

Lshan3: /* Test Plan */

__TOC__

== E2125. Refactor review mapping helper.rb ==
This page describes the Expertiza based OSS project.

=== Expertiza ===

Expertiza is an open-source project contributed by both the students and the faculty at NCSU. It is developed on Ruby-on-Rails and software to create reusable learning objects through peer review. Expertiza allows the instructor to create new assignments, customize new or existing assignments, and create a topic list for students to sign up. It also supports students to form teams for team projects and allows submission with almost any document type, including URLs and wiki pages.

=== Background ===
==== E2125. Refactor review_mapping_helper.rb ====
* Files involved: review_mapping_helper.rb
* What is wrong:
** The review_mapping_helper.rb has methods that exceed the limit on lines of code Also, it is missing proper comments for each functionality. Cyclomatic complexity of most of the methods is way too high as per the standard defined in the Code Climate.
* What needs to be done:
# Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
# Read about cyclomatic complexity here.
# Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas and space or lack of it and assigning branching condition.
Write test cases of any new code written. Test the existing functionality after refactoring.

However, since the code-quality-analysis result from Code Climate shows that all cyclomatic complexity was resolved, the main work was to fix the logic of the method "get_team_color".

=== Modifications in review_mapping_helper.rb ===

==== get_team_color ====
This method is to determine the state of reviewers review on each team. Related pages can be found in "manages... -> assignments -> view reports -> view"

There are five different states:‎ 
[[File:Review_status_color.jpg]]
=====Example=====
Under the column "Team Reviewed", color brown indicates that a score is given to the reviewer (including zero), and color blue indicates that a score havnen't given to the reviewer. 
[[File:Review_mapping_example.png]]
----
The original code will not return the correct color, because when it is checking the grade for the reviewer, it is not checking the correct variable.

<pre> def get_team_color(response_map)
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at

# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)

# Returning colour based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).grade_for_reviewer.nil?
'brown'
elsif response_for_each_round?(response_map)
'blue'
else
check_submission_state(response_map, assignment_created, assignment_due_dates, @assignment.num_review_rounds)
end
else
'red'
end
end
</pre>

===== check_submission_state =====

This method checks whether the team submit the project on time or not. (If there are no submission or the submission is not on time, it is reasonable that the reviewer cannot review the project).
In addition, the submission time of a link should be checked by the last modified time of the webpage, not the moment the link itself is submitted.
----

<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? or (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
'green'
else
link_updated_at = get_link_updated_at(link)
link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>

===== obtain_team_color =====

----

This method has been removed because it is running unnecessary check on old submissions.

<pre>def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []
(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end
color[-1]
end </pre>

=== Test Plan ===

==== RSpec ====

----

All 32 test cases are currently passing.

# In method get_team_color(response_map) in review mapping helper.rb: Only checking if the record exist is not enough, because all mapping records pre-exist with empty scores in it.
# The for loop for checking multiple submission stage is unnecesasry, so we removed obtain_team_color and call check_submission_state directly.
# Stubbing NET::HTTP to fix test cases that originally failed if calling the method get_link_updated_at.
<pre> allow(Net::HTTP).to receive(:get_response).and_return(obj)</pre>

'''Scenarios for get_team_color:''' 
1. color should be red if response_map does not exist 
2. color should be blue if the a review was submitted for each round 
3. color should NOT be blue if the a review was NOT submitted for each round 
4. color should be brown if the review and review_grade exist 
5. color should be green if the submission link is non-existent 
6. color should be green if the submission link is NOT a link to a Expertiza wiki 
7. color should be purple if review were submitted for each round (on time) 
8. color should be purple if submission link has been updated since due date for a specified round 
9. should return green color if the submission link is not present 
10. should return green color if the assignment was not submitted within the round 
11. should return purple color if the assignment was submitted within the round 

'''Scenarios for check_submission_state:''' 
1. should return green color if the submitted link is not a wiki link 
2. should return green color if the submission link is not present 
3. should return green color if the assignment was not submitted within the round 
4. should return purple color if the assignment was submitted within the round 

Example test case:
<pre> it 'color should be purple if submission link has been updated since due date for a specified round' do
# deadline_right inspired from bookmark_review_spec
allow(Net::HTTP).to receive(:get_response).and_return({'last-modified' => DateTime.now.in_time_zone})
create(:deadline_right, name: 'No')
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

response_map_with_reviewee = create(:review_response_map, reviewer: @reviewer, reviewee: @reviewee_with_assignment)

create(:submission_record, assignment_id: @assignment.id, team_id: @reviewee_with_assignment.id, operation: 'Submit Hyperlink',
content: 'https://wiki.archlinux.org/', created_at: DateTime.now.in_time_zone - 7.day)

create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 1, due_at: DateTime.now.in_time_zone - 5.day)
create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 2, due_at: DateTime.now.in_time_zone + 6.day)

create(:response, response_map: response_map_with_reviewee)

color = get_team_color(response_map_with_reviewee)
expect(color).to eq('purple')
end
end
</pre>

==== Manual Testing ====
# Click "manage..." from the tabs above the webpage
# Select assignments from the dropdown list
# select the view reports icon from each created assignments
# click on view button to view different status of different conditions (can create additional assignments with shorter due date intervals and submit new works and reviews to it)

=== Peer Review Credentials ===
<pre>
Username: instructor6
Password: password
</pre>

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-27T00:16:50Z

Lshan3: /* Modifications in review_mapping_helper.rb */

__TOC__

== E2125. Refactor review mapping helper.rb ==
This page describes the Expertiza based OSS project.

=== Expertiza ===

Expertiza is an open-source project contributed by both the students and the faculty at NCSU. It is developed on Ruby-on-Rails and software to create reusable learning objects through peer review. Expertiza allows the instructor to create new assignments, customize new or existing assignments, and create a topic list for students to sign up. It also supports students to form teams for team projects and allows submission with almost any document type, including URLs and wiki pages.

=== Background ===
==== E2125. Refactor review_mapping_helper.rb ====
* Files involved: review_mapping_helper.rb
* What is wrong:
** The review_mapping_helper.rb has methods that exceed the limit on lines of code Also, it is missing proper comments for each functionality. Cyclomatic complexity of most of the methods is way too high as per the standard defined in the Code Climate.
* What needs to be done:
# Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
# Read about cyclomatic complexity here.
# Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas and space or lack of it and assigning branching condition.
Write test cases of any new code written. Test the existing functionality after refactoring.

However, since the code-quality-analysis result from Code Climate shows that all cyclomatic complexity was resolved, the main work was to fix the logic of the method "get_team_color".

=== Modifications in review_mapping_helper.rb ===

==== get_team_color ====
This method is to determine the state of reviewers review on each team. Related pages can be found in "manages... -> assignments -> view reports -> view"

There are five different states:‎ 
[[File:Review_status_color.jpg]]
=====Example=====
Under the column "Team Reviewed", color brown indicates that a score is given to the reviewer (including zero), and color blue indicates that a score havnen't given to the reviewer. 
[[File:Review_mapping_example.png]]
----
The original code will not return the correct color, because when it is checking the grade for the reviewer, it is not checking the correct variable.

<pre> def get_team_color(response_map)
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at

# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)

# Returning colour based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).grade_for_reviewer.nil?
'brown'
elsif response_for_each_round?(response_map)
'blue'
else
check_submission_state(response_map, assignment_created, assignment_due_dates, @assignment.num_review_rounds)
end
else
'red'
end
end
</pre>

===== check_submission_state =====

This method checks whether the team submit the project on time or not. (If there are no submission or the submission is not on time, it is reasonable that the reviewer cannot review the project).
In addition, the submission time of a link should be checked by the last modified time of the webpage, not the moment the link itself is submitted.
----

<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? or (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
'green'
else
link_updated_at = get_link_updated_at(link)
link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>

===== obtain_team_color =====

----

This method has been removed because it is running unnecessary check on old submissions.

<pre>def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []
(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end
color[-1]
end </pre>

=== Testing Details in review_mapping_helper.rb ===

==== RSpec ====

----

All 32 test cases are currently passing.

# In method get_team_color(response_map) in review mapping helper.rb: Only checking if the record exist is not enough, because all mapping records pre-exist with empty scores in it.
# The for loop for checking multiple submission stage is unnecesasry, so we removed obtain_team_color and call check_submission_state directly.
# Stubbing NET::HTTP to fix test cases that originally failed if calling the method get_link_updated_at.
<pre> allow(Net::HTTP).to receive(:get_response).and_return(obj)</pre>
Example test case:
<pre> it 'color should be purple if submission link has been updated since due date for a specified round' do
# deadline_right inspired from bookmark_review_spec
allow(Net::HTTP).to receive(:get_response).and_return({'last-modified' => DateTime.now.in_time_zone})
create(:deadline_right, name: 'No')
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

response_map_with_reviewee = create(:review_response_map, reviewer: @reviewer, reviewee: @reviewee_with_assignment)

create(:submission_record, assignment_id: @assignment.id, team_id: @reviewee_with_assignment.id, operation: 'Submit Hyperlink',
content: 'https://wiki.archlinux.org/', created_at: DateTime.now.in_time_zone - 7.day)

create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 1, due_at: DateTime.now.in_time_zone - 5.day)
create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 2, due_at: DateTime.now.in_time_zone + 6.day)

create(:response, response_map: response_map_with_reviewee)

color = get_team_color(response_map_with_reviewee)
expect(color).to eq('purple')
end
end
</pre>

=== Peer Review Credentials ===
<pre>
Username: instructor6
Password: password
</pre>

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-27T00:16:19Z

Lshan3: /* E2125. Refactor review_mapping_helper.rb */

__TOC__

== E2125. Refactor review mapping helper.rb ==
This page describes the Expertiza based OSS project.

=== Expertiza ===

Expertiza is an open-source project contributed by both the students and the faculty at NCSU. It is developed on Ruby-on-Rails and software to create reusable learning objects through peer review. Expertiza allows the instructor to create new assignments, customize new or existing assignments, and create a topic list for students to sign up. It also supports students to form teams for team projects and allows submission with almost any document type, including URLs and wiki pages.

=== Background ===
==== E2125. Refactor review_mapping_helper.rb ====
* Files involved: review_mapping_helper.rb
* What is wrong:
** The review_mapping_helper.rb has methods that exceed the limit on lines of code Also, it is missing proper comments for each functionality. Cyclomatic complexity of most of the methods is way too high as per the standard defined in the Code Climate.
* What needs to be done:
# Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
# Read about cyclomatic complexity here.
# Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas and space or lack of it and assigning branching condition.
Write test cases of any new code written. Test the existing functionality after refactoring.

However, since the code-quality-analysis result from Code Climate shows that all cyclomatic complexity was resolved, the main work was to fix the logic of the method "get_team_color".

=== Modifications in review_mapping_helper.rb ===

==== get_team_color ====
This method is to determine the state of reviewers review on each team. Related pages can be found in "manages... -> assignments -> view reports -> view"

There are five different states:
‎ 
[[File:Review_status_color.jpg]]
‎ 
=====Example=====
Under the column "Team Reviewed", color brown indicates that a score is given to the reviewer (including zero), and color blue indicates that a score havnen't given to the reviewer. 
[[File:Review_mapping_example.png]]
----
The original code will not return the correct color, because when it is checking the grade for the reviewer, it is not checking the correct variable.

<pre> def get_team_color(response_map)
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at

# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)

# Returning colour based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).grade_for_reviewer.nil?
'brown'
elsif response_for_each_round?(response_map)
'blue'
else
check_submission_state(response_map, assignment_created, assignment_due_dates, @assignment.num_review_rounds)
end
else
'red'
end
end
</pre>

===== check_submission_state =====

This method checks whether the team submit the project on time or not. (If there are no submission or the submission is not on time, it is reasonable that the reviewer cannot review the project).
In addition, the submission time of a link should be checked by the last modified time of the webpage, not the moment the link itself is submitted.
----

<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? or (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
'green'
else
link_updated_at = get_link_updated_at(link)
link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>

===== obtain_team_color =====

----

This method has been removed because it is running unnecessary check on old submissions.

<pre>def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []
(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end
color[-1]
end </pre>

=== Testing Details in review_mapping_helper.rb ===

==== RSpec ====

----

All 32 test cases are currently passing.

# In method get_team_color(response_map) in review mapping helper.rb: Only checking if the record exist is not enough, because all mapping records pre-exist with empty scores in it.
# The for loop for checking multiple submission stage is unnecesasry, so we removed obtain_team_color and call check_submission_state directly.
# Stubbing NET::HTTP to fix test cases that originally failed if calling the method get_link_updated_at.
<pre> allow(Net::HTTP).to receive(:get_response).and_return(obj)</pre>
Example test case:
<pre> it 'color should be purple if submission link has been updated since due date for a specified round' do
# deadline_right inspired from bookmark_review_spec
allow(Net::HTTP).to receive(:get_response).and_return({'last-modified' => DateTime.now.in_time_zone})
create(:deadline_right, name: 'No')
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

response_map_with_reviewee = create(:review_response_map, reviewer: @reviewer, reviewee: @reviewee_with_assignment)

create(:submission_record, assignment_id: @assignment.id, team_id: @reviewee_with_assignment.id, operation: 'Submit Hyperlink',
content: 'https://wiki.archlinux.org/', created_at: DateTime.now.in_time_zone - 7.day)

create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 1, due_at: DateTime.now.in_time_zone - 5.day)
create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 2, due_at: DateTime.now.in_time_zone + 6.day)

create(:response, response_map: response_map_with_reviewee)

color = get_team_color(response_map_with_reviewee)
expect(color).to eq('purple')
end
end
</pre>

=== Peer Review Credentials ===
<pre>
Username: instructor6
Password: password
</pre>

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-27T00:15:46Z

Lshan3: /* E2125. Refactor review_mapping_helper.rb */

__TOC__

== E2125. Refactor review mapping helper.rb ==
This page describes the Expertiza based OSS project.

=== Expertiza ===

Expertiza is an open-source project contributed by both the students and the faculty at NCSU. It is developed on Ruby-on-Rails and software to create reusable learning objects through peer review. Expertiza allows the instructor to create new assignments, customize new or existing assignments, and create a topic list for students to sign up. It also supports students to form teams for team projects and allows submission with almost any document type, including URLs and wiki pages.

=== Background ===
==== E2125. Refactor review_mapping_helper.rb ====
* Files involved: review_mapping_helper.rb
* What is wrong:
** The review_mapping_helper.rb has methods that exceed the limit on lines of code Also, it is missing proper comments for each functionality. Cyclomatic complexity of most of the methods is way too high as per the standard defined in the Code Climate.
* What needs to be done:
# Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
# Read about cyclomatic complexity here.
# Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas and space or lack of it and assigning branching condition.
Write test cases of any new code written. Test the existing functionality after refactoring.

However, since the code-quality-analysis result from Code Climate shows that all cyclomatic complexity was resolved, our main work was fixing the logic of the method "get_team_color".

=== Modifications in review_mapping_helper.rb ===

==== get_team_color ====
This method is to determine the state of reviewers review on each team. Related pages can be found in "manages... -> assignments -> view reports -> view"

There are five different states:
‎ 
[[File:Review_status_color.jpg]]
‎ 
=====Example=====
Under the column "Team Reviewed", color brown indicates that a score is given to the reviewer (including zero), and color blue indicates that a score havnen't given to the reviewer. 
[[File:Review_mapping_example.png]]
----
The original code will not return the correct color, because when it is checking the grade for the reviewer, it is not checking the correct variable.

<pre> def get_team_color(response_map)
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at

# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)

# Returning colour based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).grade_for_reviewer.nil?
'brown'
elsif response_for_each_round?(response_map)
'blue'
else
check_submission_state(response_map, assignment_created, assignment_due_dates, @assignment.num_review_rounds)
end
else
'red'
end
end
</pre>

===== check_submission_state =====

This method checks whether the team submit the project on time or not. (If there are no submission or the submission is not on time, it is reasonable that the reviewer cannot review the project).
In addition, the submission time of a link should be checked by the last modified time of the webpage, not the moment the link itself is submitted.
----

<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? or (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
'green'
else
link_updated_at = get_link_updated_at(link)
link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>

===== obtain_team_color =====

----

This method has been removed because it is running unnecessary check on old submissions.

<pre>def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []
(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end
color[-1]
end </pre>

=== Testing Details in review_mapping_helper.rb ===

==== RSpec ====

----

All 32 test cases are currently passing.

# In method get_team_color(response_map) in review mapping helper.rb: Only checking if the record exist is not enough, because all mapping records pre-exist with empty scores in it.
# The for loop for checking multiple submission stage is unnecesasry, so we removed obtain_team_color and call check_submission_state directly.
# Stubbing NET::HTTP to fix test cases that originally failed if calling the method get_link_updated_at.
<pre> allow(Net::HTTP).to receive(:get_response).and_return(obj)</pre>
Example test case:
<pre> it 'color should be purple if submission link has been updated since due date for a specified round' do
# deadline_right inspired from bookmark_review_spec
allow(Net::HTTP).to receive(:get_response).and_return({'last-modified' => DateTime.now.in_time_zone})
create(:deadline_right, name: 'No')
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

response_map_with_reviewee = create(:review_response_map, reviewer: @reviewer, reviewee: @reviewee_with_assignment)

create(:submission_record, assignment_id: @assignment.id, team_id: @reviewee_with_assignment.id, operation: 'Submit Hyperlink',
content: 'https://wiki.archlinux.org/', created_at: DateTime.now.in_time_zone - 7.day)

create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 1, due_at: DateTime.now.in_time_zone - 5.day)
create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 2, due_at: DateTime.now.in_time_zone + 6.day)

create(:response, response_map: response_map_with_reviewee)

color = get_team_color(response_map_with_reviewee)
expect(color).to eq('purple')
end
end
</pre>

=== Peer Review Credentials ===
<pre>
Username: instructor6
Password: password
</pre>

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-27T00:15:31Z

Lshan3: /* E2125. Refactor review_mapping_helper.rb */

__TOC__

== E2125. Refactor review mapping helper.rb ==
This page describes the Expertiza based OSS project.

=== Expertiza ===

Expertiza is an open-source project contributed by both the students and the faculty at NCSU. It is developed on Ruby-on-Rails and software to create reusable learning objects through peer review. Expertiza allows the instructor to create new assignments, customize new or existing assignments, and create a topic list for students to sign up. It also supports students to form teams for team projects and allows submission with almost any document type, including URLs and wiki pages.

=== Background ===
==== E2125. Refactor review_mapping_helper.rb ====
* Files involved: review_mapping_helper.rb
* What is wrong:
** The review_mapping_helper.rb has methods that exceed the limit on lines of code Also, it is missing proper comments for each functionality. Cyclomatic complexity of most of the methods is way too high as per the standard defined in the Code Climate.
* What needs to be done:
# Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
# Read about cyclomatic complexity here.
# Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas and space or lack of it and assigning branching condition.
Write test cases of any new code written. Test the existing functionality after refactoring.

However, since the code quality analysis result from Code Climate shows that all cyclomatic complexity was resolved, our main work was fixing the logic of the method "get_team_color".

=== Modifications in review_mapping_helper.rb ===

==== get_team_color ====
This method is to determine the state of reviewers review on each team. Related pages can be found in "manages... -> assignments -> view reports -> view"

There are five different states:
‎ 
[[File:Review_status_color.jpg]]
‎ 
=====Example=====
Under the column "Team Reviewed", color brown indicates that a score is given to the reviewer (including zero), and color blue indicates that a score havnen't given to the reviewer. 
[[File:Review_mapping_example.png]]
----
The original code will not return the correct color, because when it is checking the grade for the reviewer, it is not checking the correct variable.

<pre> def get_team_color(response_map)
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at

# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)

# Returning colour based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).grade_for_reviewer.nil?
'brown'
elsif response_for_each_round?(response_map)
'blue'
else
check_submission_state(response_map, assignment_created, assignment_due_dates, @assignment.num_review_rounds)
end
else
'red'
end
end
</pre>

===== check_submission_state =====

This method checks whether the team submit the project on time or not. (If there are no submission or the submission is not on time, it is reasonable that the reviewer cannot review the project).
In addition, the submission time of a link should be checked by the last modified time of the webpage, not the moment the link itself is submitted.
----

<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? or (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
'green'
else
link_updated_at = get_link_updated_at(link)
link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>

===== obtain_team_color =====

----

This method has been removed because it is running unnecessary check on old submissions.

<pre>def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []
(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end
color[-1]
end </pre>

=== Testing Details in review_mapping_helper.rb ===

==== RSpec ====

----

All 32 test cases are currently passing.

# In method get_team_color(response_map) in review mapping helper.rb: Only checking if the record exist is not enough, because all mapping records pre-exist with empty scores in it.
# The for loop for checking multiple submission stage is unnecesasry, so we removed obtain_team_color and call check_submission_state directly.
# Stubbing NET::HTTP to fix test cases that originally failed if calling the method get_link_updated_at.
<pre> allow(Net::HTTP).to receive(:get_response).and_return(obj)</pre>
Example test case:
<pre> it 'color should be purple if submission link has been updated since due date for a specified round' do
# deadline_right inspired from bookmark_review_spec
allow(Net::HTTP).to receive(:get_response).and_return({'last-modified' => DateTime.now.in_time_zone})
create(:deadline_right, name: 'No')
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

response_map_with_reviewee = create(:review_response_map, reviewer: @reviewer, reviewee: @reviewee_with_assignment)

create(:submission_record, assignment_id: @assignment.id, team_id: @reviewee_with_assignment.id, operation: 'Submit Hyperlink',
content: 'https://wiki.archlinux.org/', created_at: DateTime.now.in_time_zone - 7.day)

create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 1, due_at: DateTime.now.in_time_zone - 5.day)
create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 2, due_at: DateTime.now.in_time_zone + 6.day)

create(:response, response_map: response_map_with_reviewee)

color = get_team_color(response_map_with_reviewee)
expect(color).to eq('purple')
end
end
</pre>

=== Peer Review Credentials ===
<pre>
Username: instructor6
Password: password
</pre>

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-27T00:14:18Z

Lshan3: /* Peer Review Credentials */

__TOC__

== E2125. Refactor review mapping helper.rb ==
This page describes the Expertiza based OSS project.

=== Expertiza ===

Expertiza is an open-source project contributed by both the students and the faculty at NCSU. It is developed on Ruby-on-Rails and software to create reusable learning objects through peer review. Expertiza allows the instructor to create new assignments, customize new or existing assignments, and create a topic list for students to sign up. It also supports students to form teams for team projects and allows submission with almost any document type, including URLs and wiki pages.

=== Background ===
==== E2125. Refactor review_mapping_helper.rb ====
* Files involved: review_mapping_helper.rb
* What is wrong:
** The review_mapping_helper.rb has methods that exceed the limit on lines of code Also, it is missing proper comments for each functionality. Cyclomatic complexity of most of the methods is way too high as per the standard defined in the Code Climate.
* What needs to be done:
# Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
# Read about cyclomatic complexity here.
# Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas and space or lack of it and assigning branching condition.
Write test cases of any new code written. Test the existing functionality after refactoring.

However, since in code climate it shows that all cyclomatic complexity was resolved, our main work was fixing the logic of the method "get_team_color".

=== Modifications in review_mapping_helper.rb ===

==== get_team_color ====
This method is to determine the state of reviewers review on each team. Related pages can be found in "manages... -> assignments -> view reports -> view"

There are five different states:
‎ 
[[File:Review_status_color.jpg]]
‎ 
=====Example=====
Under the column "Team Reviewed", color brown indicates that a score is given to the reviewer (including zero), and color blue indicates that a score havnen't given to the reviewer. 
[[File:Review_mapping_example.png]]
----
The original code will not return the correct color, because when it is checking the grade for the reviewer, it is not checking the correct variable.

<pre> def get_team_color(response_map)
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at

# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)

# Returning colour based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).grade_for_reviewer.nil?
'brown'
elsif response_for_each_round?(response_map)
'blue'
else
check_submission_state(response_map, assignment_created, assignment_due_dates, @assignment.num_review_rounds)
end
else
'red'
end
end
</pre>

===== check_submission_state =====

This method checks whether the team submit the project on time or not. (If there are no submission or the submission is not on time, it is reasonable that the reviewer cannot review the project).
In addition, the submission time of a link should be checked by the last modified time of the webpage, not the moment the link itself is submitted.
----

<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? or (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
'green'
else
link_updated_at = get_link_updated_at(link)
link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>

===== obtain_team_color =====

----

This method has been removed because it is running unnecessary check on old submissions.

<pre>def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []
(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end
color[-1]
end </pre>

=== Testing Details in review_mapping_helper.rb ===

==== RSpec ====

----

All 32 test cases are currently passing.

# In method get_team_color(response_map) in review mapping helper.rb: Only checking if the record exist is not enough, because all mapping records pre-exist with empty scores in it.
# The for loop for checking multiple submission stage is unnecesasry, so we removed obtain_team_color and call check_submission_state directly.
# Stubbing NET::HTTP to fix test cases that originally failed if calling the method get_link_updated_at.
<pre> allow(Net::HTTP).to receive(:get_response).and_return(obj)</pre>
Example test case:
<pre> it 'color should be purple if submission link has been updated since due date for a specified round' do
# deadline_right inspired from bookmark_review_spec
allow(Net::HTTP).to receive(:get_response).and_return({'last-modified' => DateTime.now.in_time_zone})
create(:deadline_right, name: 'No')
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

response_map_with_reviewee = create(:review_response_map, reviewer: @reviewer, reviewee: @reviewee_with_assignment)

create(:submission_record, assignment_id: @assignment.id, team_id: @reviewee_with_assignment.id, operation: 'Submit Hyperlink',
content: 'https://wiki.archlinux.org/', created_at: DateTime.now.in_time_zone - 7.day)

create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 1, due_at: DateTime.now.in_time_zone - 5.day)
create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 2, due_at: DateTime.now.in_time_zone + 6.day)

create(:response, response_map: response_map_with_reviewee)

color = get_team_color(response_map_with_reviewee)
expect(color).to eq('purple')
end
end
</pre>

=== Peer Review Credentials ===
<pre>
Username: instructor6
Password: password
</pre>

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-27T00:13:37Z

Lshan3: /* RSpec */

__TOC__

== E2125. Refactor review mapping helper.rb ==
This page describes the Expertiza based OSS project.

=== Expertiza ===

Expertiza is an open-source project contributed by both the students and the faculty at NCSU. It is developed on Ruby-on-Rails and software to create reusable learning objects through peer review. Expertiza allows the instructor to create new assignments, customize new or existing assignments, and create a topic list for students to sign up. It also supports students to form teams for team projects and allows submission with almost any document type, including URLs and wiki pages.

=== Background ===
==== E2125. Refactor review_mapping_helper.rb ====
* Files involved: review_mapping_helper.rb
* What is wrong:
** The review_mapping_helper.rb has methods that exceed the limit on lines of code Also, it is missing proper comments for each functionality. Cyclomatic complexity of most of the methods is way too high as per the standard defined in the Code Climate.
* What needs to be done:
# Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
# Read about cyclomatic complexity here.
# Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas and space or lack of it and assigning branching condition.
Write test cases of any new code written. Test the existing functionality after refactoring.

However, since in code climate it shows that all cyclomatic complexity was resolved, our main work was fixing the logic of the method "get_team_color".

=== Modifications in review_mapping_helper.rb ===

==== get_team_color ====
This method is to determine the state of reviewers review on each team. Related pages can be found in "manages... -> assignments -> view reports -> view"

There are five different states:
‎ 
[[File:Review_status_color.jpg]]
‎ 
=====Example=====
Under the column "Team Reviewed", color brown indicates that a score is given to the reviewer (including zero), and color blue indicates that a score havnen't given to the reviewer. 
[[File:Review_mapping_example.png]]
----
The original code will not return the correct color, because when it is checking the grade for the reviewer, it is not checking the correct variable.

<pre> def get_team_color(response_map)
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at

# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)

# Returning colour based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).grade_for_reviewer.nil?
'brown'
elsif response_for_each_round?(response_map)
'blue'
else
check_submission_state(response_map, assignment_created, assignment_due_dates, @assignment.num_review_rounds)
end
else
'red'
end
end
</pre>

===== check_submission_state =====

This method checks whether the team submit the project on time or not. (If there are no submission or the submission is not on time, it is reasonable that the reviewer cannot review the project).
In addition, the submission time of a link should be checked by the last modified time of the webpage, not the moment the link itself is submitted.
----

<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? or (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
'green'
else
link_updated_at = get_link_updated_at(link)
link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>

===== obtain_team_color =====

----

This method has been removed because it is running unnecessary check on old submissions.

<pre>def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []
(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end
color[-1]
end </pre>

=== Testing Details in review_mapping_helper.rb ===

==== RSpec ====

----

All 32 test cases are currently passing.

# In method get_team_color(response_map) in review mapping helper.rb: Only checking if the record exist is not enough, because all mapping records pre-exist with empty scores in it.
# The for loop for checking multiple submission stage is unnecesasry, so we removed obtain_team_color and call check_submission_state directly.
# Stubbing NET::HTTP to fix test cases that originally failed if calling the method get_link_updated_at.
<pre> allow(Net::HTTP).to receive(:get_response).and_return(obj)</pre>
Example test case:
<pre> it 'color should be purple if submission link has been updated since due date for a specified round' do
# deadline_right inspired from bookmark_review_spec
allow(Net::HTTP).to receive(:get_response).and_return({'last-modified' => DateTime.now.in_time_zone})
create(:deadline_right, name: 'No')
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

response_map_with_reviewee = create(:review_response_map, reviewer: @reviewer, reviewee: @reviewee_with_assignment)

create(:submission_record, assignment_id: @assignment.id, team_id: @reviewee_with_assignment.id, operation: 'Submit Hyperlink',
content: 'https://wiki.archlinux.org/', created_at: DateTime.now.in_time_zone - 7.day)

create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 1, due_at: DateTime.now.in_time_zone - 5.day)
create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 2, due_at: DateTime.now.in_time_zone + 6.day)

create(:response, response_map: response_map_with_reviewee)

color = get_team_color(response_map_with_reviewee)
expect(color).to eq('purple')
end
end
</pre>

=== Peer Review Credentials ===
Username: instructor6 
Password: password

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-27T00:13:24Z

Lshan3: /* RSpec */

__TOC__

== E2125. Refactor review mapping helper.rb ==
This page describes the Expertiza based OSS project.

=== Expertiza ===

Expertiza is an open-source project contributed by both the students and the faculty at NCSU. It is developed on Ruby-on-Rails and software to create reusable learning objects through peer review. Expertiza allows the instructor to create new assignments, customize new or existing assignments, and create a topic list for students to sign up. It also supports students to form teams for team projects and allows submission with almost any document type, including URLs and wiki pages.

=== Background ===
==== E2125. Refactor review_mapping_helper.rb ====
* Files involved: review_mapping_helper.rb
* What is wrong:
** The review_mapping_helper.rb has methods that exceed the limit on lines of code Also, it is missing proper comments for each functionality. Cyclomatic complexity of most of the methods is way too high as per the standard defined in the Code Climate.
* What needs to be done:
# Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
# Read about cyclomatic complexity here.
# Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas and space or lack of it and assigning branching condition.
Write test cases of any new code written. Test the existing functionality after refactoring.

However, since in code climate it shows that all cyclomatic complexity was resolved, our main work was fixing the logic of the method "get_team_color".

=== Modifications in review_mapping_helper.rb ===

==== get_team_color ====
This method is to determine the state of reviewers review on each team. Related pages can be found in "manages... -> assignments -> view reports -> view"

There are five different states:
‎ 
[[File:Review_status_color.jpg]]
‎ 
=====Example=====
Under the column "Team Reviewed", color brown indicates that a score is given to the reviewer (including zero), and color blue indicates that a score havnen't given to the reviewer. 
[[File:Review_mapping_example.png]]
----
The original code will not return the correct color, because when it is checking the grade for the reviewer, it is not checking the correct variable.

<pre> def get_team_color(response_map)
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at

# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)

# Returning colour based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).grade_for_reviewer.nil?
'brown'
elsif response_for_each_round?(response_map)
'blue'
else
check_submission_state(response_map, assignment_created, assignment_due_dates, @assignment.num_review_rounds)
end
else
'red'
end
end
</pre>

===== check_submission_state =====

This method checks whether the team submit the project on time or not. (If there are no submission or the submission is not on time, it is reasonable that the reviewer cannot review the project).
In addition, the submission time of a link should be checked by the last modified time of the webpage, not the moment the link itself is submitted.
----

<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? or (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
'green'
else
link_updated_at = get_link_updated_at(link)
link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>

===== obtain_team_color =====

----

This method has been removed because it is running unnecessary check on old submissions.

<pre>def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []
(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end
color[-1]
end </pre>

=== Testing Details in review_mapping_helper.rb ===

==== RSpec ====

----

All 32 test cases are currently passing.

# In method get_team_color(response_map) in review mapping helper.rb: Only checking if the record exist is not enough, because all mapping records pre-exist with empty scores in it.
# The for loop for checking multiple submission stage is unnecesasry, so we removed obtain_team_color and call check_submission_state directly.
# Stubbing NET::HTTP to fix test cases that originally failed if calling the method get_link_updated_at.
<pre> allow(Net::HTTP).to receive(:get_response).and_return(obj)(</pre>
Example test case:
<pre> it 'color should be purple if submission link has been updated since due date for a specified round' do
# deadline_right inspired from bookmark_review_spec
allow(Net::HTTP).to receive(:get_response).and_return({'last-modified' => DateTime.now.in_time_zone})
create(:deadline_right, name: 'No')
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

response_map_with_reviewee = create(:review_response_map, reviewer: @reviewer, reviewee: @reviewee_with_assignment)

create(:submission_record, assignment_id: @assignment.id, team_id: @reviewee_with_assignment.id, operation: 'Submit Hyperlink',
content: 'https://wiki.archlinux.org/', created_at: DateTime.now.in_time_zone - 7.day)

create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 1, due_at: DateTime.now.in_time_zone - 5.day)
create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 2, due_at: DateTime.now.in_time_zone + 6.day)

create(:response, response_map: response_map_with_reviewee)

color = get_team_color(response_map_with_reviewee)
expect(color).to eq('purple')
end
end
</pre>

=== Peer Review Credentials ===
Username: instructor6 
Password: password

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-27T00:12:20Z

Lshan3: /* Example */

__TOC__

== E2125. Refactor review mapping helper.rb ==
This page describes the Expertiza based OSS project.

=== Expertiza ===

Expertiza is an open-source project contributed by both the students and the faculty at NCSU. It is developed on Ruby-on-Rails and software to create reusable learning objects through peer review. Expertiza allows the instructor to create new assignments, customize new or existing assignments, and create a topic list for students to sign up. It also supports students to form teams for team projects and allows submission with almost any document type, including URLs and wiki pages.

=== Background ===
==== E2125. Refactor review_mapping_helper.rb ====
* Files involved: review_mapping_helper.rb
* What is wrong:
** The review_mapping_helper.rb has methods that exceed the limit on lines of code Also, it is missing proper comments for each functionality. Cyclomatic complexity of most of the methods is way too high as per the standard defined in the Code Climate.
* What needs to be done:
# Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
# Read about cyclomatic complexity here.
# Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas and space or lack of it and assigning branching condition.
Write test cases of any new code written. Test the existing functionality after refactoring.

However, since in code climate it shows that all cyclomatic complexity was resolved, our main work was fixing the logic of the method "get_team_color".

=== Modifications in review_mapping_helper.rb ===

==== get_team_color ====
This method is to determine the state of reviewers review on each team. Related pages can be found in "manages... -> assignments -> view reports -> view"

There are five different states:
‎ 
[[File:Review_status_color.jpg]]
‎ 
=====Example=====
Under the column "Team Reviewed", color brown indicates that a score is given to the reviewer (including zero), and color blue indicates that a score havnen't given to the reviewer. 
[[File:Review_mapping_example.png]]
----
The original code will not return the correct color, because when it is checking the grade for the reviewer, it is not checking the correct variable.

<pre> def get_team_color(response_map)
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at

# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)

# Returning colour based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).grade_for_reviewer.nil?
'brown'
elsif response_for_each_round?(response_map)
'blue'
else
check_submission_state(response_map, assignment_created, assignment_due_dates, @assignment.num_review_rounds)
end
else
'red'
end
end
</pre>

===== check_submission_state =====

This method checks whether the team submit the project on time or not. (If there are no submission or the submission is not on time, it is reasonable that the reviewer cannot review the project).
In addition, the submission time of a link should be checked by the last modified time of the webpage, not the moment the link itself is submitted.
----

<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? or (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
'green'
else
link_updated_at = get_link_updated_at(link)
link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>

===== obtain_team_color =====

----

This method has been removed because it is running unnecessary check on old submissions.

<pre>def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []
(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end
color[-1]
end </pre>

=== Testing Details in review_mapping_helper.rb ===

==== RSpec ====

----

All 32 test cases are currently passing.

# In method get_team_color(response_map) in review mapping helper.rb: Only checking if the record exist is not enough, because all mapping records pre-exist with empty scores in it.
# The for loop for checking multiple submission stage is unnecesasry, so we removed obtain_team_color and call check_submission_state directly.
# Stubbing NET::HTTP to fix test cases that originally failed if calling the method get_link_updated_at.

Example test case:
<pre> it 'color should be purple if submission link has been updated since due date for a specified round' do
# deadline_right inspired from bookmark_review_spec
allow(Net::HTTP).to receive(:get_response).and_return({'last-modified' => DateTime.now.in_time_zone})
create(:deadline_right, name: 'No')
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

response_map_with_reviewee = create(:review_response_map, reviewer: @reviewer, reviewee: @reviewee_with_assignment)

create(:submission_record, assignment_id: @assignment.id, team_id: @reviewee_with_assignment.id, operation: 'Submit Hyperlink',
content: 'https://wiki.archlinux.org/', created_at: DateTime.now.in_time_zone - 7.day)

create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 1, due_at: DateTime.now.in_time_zone - 5.day)
create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 2, due_at: DateTime.now.in_time_zone + 6.day)

create(:response, response_map: response_map_with_reviewee)

color = get_team_color(response_map_with_reviewee)
expect(color).to eq('purple')
end
end
</pre>

=== Peer Review Credentials ===
Username: instructor6 
Password: password

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-27T00:11:04Z

Lshan3: /* Modifications in review_mapping_helper.rb */

__TOC__

== E2125. Refactor review mapping helper.rb ==
This page describes the Expertiza based OSS project.

=== Expertiza ===

Expertiza is an open-source project contributed by both the students and the faculty at NCSU. It is developed on Ruby-on-Rails and software to create reusable learning objects through peer review. Expertiza allows the instructor to create new assignments, customize new or existing assignments, and create a topic list for students to sign up. It also supports students to form teams for team projects and allows submission with almost any document type, including URLs and wiki pages.

=== Background ===
==== E2125. Refactor review_mapping_helper.rb ====
* Files involved: review_mapping_helper.rb
* What is wrong:
** The review_mapping_helper.rb has methods that exceed the limit on lines of code Also, it is missing proper comments for each functionality. Cyclomatic complexity of most of the methods is way too high as per the standard defined in the Code Climate.
* What needs to be done:
# Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
# Read about cyclomatic complexity here.
# Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas and space or lack of it and assigning branching condition.
Write test cases of any new code written. Test the existing functionality after refactoring.

However, since in code climate it shows that all cyclomatic complexity was resolved, our main work was fixing the logic of the method "get_team_color".

=== Modifications in review_mapping_helper.rb ===

==== get_team_color ====
This method is to determine the state of reviewers review on each team. Related pages can be found in "manages... -> assignments -> view reports -> view"

There are five different states:
‎ 
[[File:Review_status_color.jpg]]
‎ 
=====Example=====
Brown indicates that a score is given to the reviewer (including zero). Blue indicates that a score havnen't given to the reviewer. 
[[File:Review_mapping_example.png]]
----
The original code will not return the correct color, because when it is checking the grade for the reviewer, it is not checking the correct variable.

<pre> def get_team_color(response_map)
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at

# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)

# Returning colour based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).grade_for_reviewer.nil?
'brown'
elsif response_for_each_round?(response_map)
'blue'
else
check_submission_state(response_map, assignment_created, assignment_due_dates, @assignment.num_review_rounds)
end
else
'red'
end
end
</pre>

===== check_submission_state =====

This method checks whether the team submit the project on time or not. (If there are no submission or the submission is not on time, it is reasonable that the reviewer cannot review the project).
In addition, the submission time of a link should be checked by the last modified time of the webpage, not the moment the link itself is submitted.
----

<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? or (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
'green'
else
link_updated_at = get_link_updated_at(link)
link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>

===== obtain_team_color =====

----

This method has been removed because it is running unnecessary check on old submissions.

<pre>def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []
(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end
color[-1]
end </pre>

=== Testing Details in review_mapping_helper.rb ===

==== RSpec ====

----

All 32 test cases are currently passing.

# In method get_team_color(response_map) in review mapping helper.rb: Only checking if the record exist is not enough, because all mapping records pre-exist with empty scores in it.
# The for loop for checking multiple submission stage is unnecesasry, so we removed obtain_team_color and call check_submission_state directly.
# Stubbing NET::HTTP to fix test cases that originally failed if calling the method get_link_updated_at.

Example test case:
<pre> it 'color should be purple if submission link has been updated since due date for a specified round' do
# deadline_right inspired from bookmark_review_spec
allow(Net::HTTP).to receive(:get_response).and_return({'last-modified' => DateTime.now.in_time_zone})
create(:deadline_right, name: 'No')
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

response_map_with_reviewee = create(:review_response_map, reviewer: @reviewer, reviewee: @reviewee_with_assignment)

create(:submission_record, assignment_id: @assignment.id, team_id: @reviewee_with_assignment.id, operation: 'Submit Hyperlink',
content: 'https://wiki.archlinux.org/', created_at: DateTime.now.in_time_zone - 7.day)

create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 1, due_at: DateTime.now.in_time_zone - 5.day)
create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 2, due_at: DateTime.now.in_time_zone + 6.day)

create(:response, response_map: response_map_with_reviewee)

color = get_team_color(response_map_with_reviewee)
expect(color).to eq('purple')
end
end
</pre>

=== Peer Review Credentials ===
Username: instructor6 
Password: password

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-27T00:10:02Z

Lshan3: /* Modifications in review_mapping_helper.rb */

__TOC__

== E2125. Refactor review mapping helper.rb ==
This page describes the Expertiza based OSS project.

=== Expertiza ===

Expertiza is an open-source project contributed by both the students and the faculty at NCSU. It is developed on Ruby-on-Rails and software to create reusable learning objects through peer review. Expertiza allows the instructor to create new assignments, customize new or existing assignments, and create a topic list for students to sign up. It also supports students to form teams for team projects and allows submission with almost any document type, including URLs and wiki pages.

=== Background ===
==== E2125. Refactor review_mapping_helper.rb ====
* Files involved: review_mapping_helper.rb
* What is wrong:
** The review_mapping_helper.rb has methods that exceed the limit on lines of code Also, it is missing proper comments for each functionality. Cyclomatic complexity of most of the methods is way too high as per the standard defined in the Code Climate.
* What needs to be done:
# Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
# Read about cyclomatic complexity here.
# Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas and space or lack of it and assigning branching condition.
Write test cases of any new code written. Test the existing functionality after refactoring.

However, since in code climate it shows that all cyclomatic complexity was resolved, our main work was fixing the logic of the method "get_team_color".

=== Modifications in review_mapping_helper.rb ===

===== get_team_color =====
This method is to determine the state of reviewers review on each team. Related pages can be found in "manages... -> assignments -> view reports -> view"

There are five different states:
‎ 
[[File:Review_status_color.jpg]]
‎ 
Example: Brown indicates that a score is given to the reviewer (including zero). Blue indicates that a score havnen't given to the reviewer. 
[[File:Review_mapping_example.png]]
----
The original code will not return the correct color, because when it is checking the grade for the reviewer, it is not checking the correct variable.

<pre> def get_team_color(response_map)
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at

# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)

# Returning colour based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).grade_for_reviewer.nil?
'brown'
elsif response_for_each_round?(response_map)
'blue'
else
check_submission_state(response_map, assignment_created, assignment_due_dates, @assignment.num_review_rounds)
end
else
'red'
end
end
</pre>

===== check_submission_state =====

This method checks whether the team submit the project on time or not. (If there are no submission or the submission is not on time, it is reasonable that the reviewer cannot review the project).
In addition, the submission time of a link should be checked by the last modified time of the webpage, not the moment the link itself is submitted.
----

<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? or (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
'green'
else
link_updated_at = get_link_updated_at(link)
link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>

===== obtain_team_color =====

----

This method has been removed because it is running unnecessary check on old submissions.

<pre>def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []
(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end
color[-1]
end </pre>

=== Testing Details in review_mapping_helper.rb ===

==== RSpec ====

----

All 32 test cases are currently passing.

# In method get_team_color(response_map) in review mapping helper.rb: Only checking if the record exist is not enough, because all mapping records pre-exist with empty scores in it.
# The for loop for checking multiple submission stage is unnecesasry, so we removed obtain_team_color and call check_submission_state directly.
# Stubbing NET::HTTP to fix test cases that originally failed if calling the method get_link_updated_at.

Example test case:
<pre> it 'color should be purple if submission link has been updated since due date for a specified round' do
# deadline_right inspired from bookmark_review_spec
allow(Net::HTTP).to receive(:get_response).and_return({'last-modified' => DateTime.now.in_time_zone})
create(:deadline_right, name: 'No')
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

response_map_with_reviewee = create(:review_response_map, reviewer: @reviewer, reviewee: @reviewee_with_assignment)

create(:submission_record, assignment_id: @assignment.id, team_id: @reviewee_with_assignment.id, operation: 'Submit Hyperlink',
content: 'https://wiki.archlinux.org/', created_at: DateTime.now.in_time_zone - 7.day)

create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 1, due_at: DateTime.now.in_time_zone - 5.day)
create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 2, due_at: DateTime.now.in_time_zone + 6.day)

create(:response, response_map: response_map_with_reviewee)

color = get_team_color(response_map_with_reviewee)
expect(color).to eq('purple')
end
end
</pre>

=== Peer Review Credentials ===
Username: instructor6 
Password: password

File:Review mapping example.png

2021-10-27T00:05:48Z

Lshan3:

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-26T23:58:24Z

Lshan3: /* get_team_color */

__TOC__

== E2125. Refactor review mapping helper.rb ==
This page describes the Expertiza based OSS project.

=== Expertiza ===

Expertiza is an open-source project contributed by both the students and the faculty at NCSU. It is developed on Ruby-on-Rails and software to create reusable learning objects through peer review. Expertiza allows the instructor to create new assignments, customize new or existing assignments, and create a topic list for students to sign up. It also supports students to form teams for team projects and allows submission with almost any document type, including URLs and wiki pages.

=== Background ===
==== E2125. Refactor review_mapping_helper.rb ====
* Files involved: review_mapping_helper.rb
* What is wrong:
** The review_mapping_helper.rb has methods that exceed the limit on lines of code Also, it is missing proper comments for each functionality. Cyclomatic complexity of most of the methods is way too high as per the standard defined in the Code Climate.
* What needs to be done:
# Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
# Read about cyclomatic complexity here.
# Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas and space or lack of it and assigning branching condition.
Write test cases of any new code written. Test the existing functionality after refactoring.

However, since in code climate it shows that all cyclomatic complexity was resolved, our main work was fixing the logic of the method "get_team_color".

=== Modifications in review_mapping_helper.rb ===

===== get_team_color =====
This method is to determine the state of reviewers review on each team. Related pages can be found in "manages... -> assignments -> view reports -> view"

There are five different states:‎ 
[[File:Review_status_color.jpg]]
----
The original code will not return the correct color, because when it is checking the grade for the reviewer, it is not checking the correct variable.

<pre> def get_team_color(response_map)
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at

# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)

# Returning colour based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).grade_for_reviewer.nil?
'brown'
elsif response_for_each_round?(response_map)
'blue'
else
check_submission_state(response_map, assignment_created, assignment_due_dates, @assignment.num_review_rounds)
end
else
'red'
end
end
</pre>

===== check_submission_state =====

This method checks whether the team submit the project on time or not. (If there are no submission or the submission is not on time, it is reasonable that the reviewer cannot review the project).
In addition, the submission time of a link should be checked by the last modified time of the webpage, not the moment the link itself is submitted.
----

<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? or (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
'green'
else
link_updated_at = get_link_updated_at(link)
link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>

===== obtain_team_color =====

----

This method has been removed because it is running unnecessary check on old submissions.

<pre>def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []
(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end
color[-1]
end </pre>

=== Testing Details in review_mapping_helper.rb ===

==== RSpec ====

----

All 32 test cases are currently passing.

# In method get_team_color(response_map) in review mapping helper.rb: Only checking if the record exist is not enough, because all mapping records pre-exist with empty scores in it.
# The for loop for checking multiple submission stage is unnecesasry, so we removed obtain_team_color and call check_submission_state directly.
# Stubbing NET::HTTP to fix test cases that originally failed if calling the method get_link_updated_at.

Example test case:
<pre> it 'color should be purple if submission link has been updated since due date for a specified round' do
# deadline_right inspired from bookmark_review_spec
allow(Net::HTTP).to receive(:get_response).and_return({'last-modified' => DateTime.now.in_time_zone})
create(:deadline_right, name: 'No')
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

response_map_with_reviewee = create(:review_response_map, reviewer: @reviewer, reviewee: @reviewee_with_assignment)

create(:submission_record, assignment_id: @assignment.id, team_id: @reviewee_with_assignment.id, operation: 'Submit Hyperlink',
content: 'https://wiki.archlinux.org/', created_at: DateTime.now.in_time_zone - 7.day)

create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 1, due_at: DateTime.now.in_time_zone - 5.day)
create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 2, due_at: DateTime.now.in_time_zone + 6.day)

create(:response, response_map: response_map_with_reviewee)

color = get_team_color(response_map_with_reviewee)
expect(color).to eq('purple')
end
end
</pre>

=== Peer Review Credentials ===
Username: instructor6 
Password: password

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-26T23:52:44Z

Lshan3: /* obtain_team_color */

__TOC__

== E2125. Refactor review mapping helper.rb ==
This page describes the Expertiza based OSS project.

=== Expertiza ===

Expertiza is an open-source project contributed by both the students and the faculty at NCSU. It is developed on Ruby-on-Rails and software to create reusable learning objects through peer review. Expertiza allows the instructor to create new assignments, customize new or existing assignments, and create a topic list for students to sign up. It also supports students to form teams for team projects and allows submission with almost any document type, including URLs and wiki pages.

=== Background ===
==== E2125. Refactor review_mapping_helper.rb ====
* Files involved: review_mapping_helper.rb
* What is wrong:
** The review_mapping_helper.rb has methods that exceed the limit on lines of code Also, it is missing proper comments for each functionality. Cyclomatic complexity of most of the methods is way too high as per the standard defined in the Code Climate.
* What needs to be done:
# Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
# Read about cyclomatic complexity here.
# Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas and space or lack of it and assigning branching condition.
Write test cases of any new code written. Test the existing functionality after refactoring.

However, since in code climate it shows that all cyclomatic complexity was resolved, our main work was fixing the logic of the method "get_team_color".

=== Modifications in review_mapping_helper.rb ===

===== get_team_color =====
This method is to determine the state of reviewers review on each team. There are five different states:‎ 
[[File:Review_status_color.jpg]]
----
The original code will not return the correct color, because when it is checking the grade for the reviewer, it is not checking the correct variable.

<pre> def get_team_color(response_map)
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at

# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)

# Returning colour based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).grade_for_reviewer.nil?
'brown'
elsif response_for_each_round?(response_map)
'blue'
else
check_submission_state(response_map, assignment_created, assignment_due_dates, @assignment.num_review_rounds)
end
else
'red'
end
end
</pre>

===== check_submission_state =====

This method checks whether the team submit the project on time or not. (If there are no submission or the submission is not on time, it is reasonable that the reviewer cannot review the project).
In addition, the submission time of a link should be checked by the last modified time of the webpage, not the moment the link itself is submitted.
----

<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? or (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
'green'
else
link_updated_at = get_link_updated_at(link)
link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>

===== obtain_team_color =====

----

This method has been removed because it is running unnecessary check on old submissions.

<pre>def obtain_team_color(response_map, assignment_created, assignment_due_dates)
color = []
(1..@assignment.num_review_rounds).each do |round|
check_submission_state(response_map, assignment_created, assignment_due_dates, round, color)
end
color[-1]
end </pre>

=== Testing Details in review_mapping_helper.rb ===

==== RSpec ====

----

All 32 test cases are currently passing.

# In method get_team_color(response_map) in review mapping helper.rb: Only checking if the record exist is not enough, because all mapping records pre-exist with empty scores in it.
# The for loop for checking multiple submission stage is unnecesasry, so we removed obtain_team_color and call check_submission_state directly.
# Stubbing NET::HTTP to fix test cases that originally failed if calling the method get_link_updated_at.

Example test case:
<pre> it 'color should be purple if submission link has been updated since due date for a specified round' do
# deadline_right inspired from bookmark_review_spec
allow(Net::HTTP).to receive(:get_response).and_return({'last-modified' => DateTime.now.in_time_zone})
create(:deadline_right, name: 'No')
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

response_map_with_reviewee = create(:review_response_map, reviewer: @reviewer, reviewee: @reviewee_with_assignment)

create(:submission_record, assignment_id: @assignment.id, team_id: @reviewee_with_assignment.id, operation: 'Submit Hyperlink',
content: 'https://wiki.archlinux.org/', created_at: DateTime.now.in_time_zone - 7.day)

create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 1, due_at: DateTime.now.in_time_zone - 5.day)
create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 2, due_at: DateTime.now.in_time_zone + 6.day)

create(:response, response_map: response_map_with_reviewee)

color = get_team_color(response_map_with_reviewee)
expect(color).to eq('purple')
end
end
</pre>

=== Peer Review Credentials ===
Username: instructor6 
Password: password

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-26T23:50:39Z

Lshan3: /* obtain_team_color */

__TOC__

== E2125. Refactor review mapping helper.rb ==
This page describes the Expertiza based OSS project.

=== Expertiza ===

Expertiza is an open-source project contributed by both the students and the faculty at NCSU. It is developed on Ruby-on-Rails and software to create reusable learning objects through peer review. Expertiza allows the instructor to create new assignments, customize new or existing assignments, and create a topic list for students to sign up. It also supports students to form teams for team projects and allows submission with almost any document type, including URLs and wiki pages.

=== Background ===
==== E2125. Refactor review_mapping_helper.rb ====
* Files involved: review_mapping_helper.rb
* What is wrong:
** The review_mapping_helper.rb has methods that exceed the limit on lines of code Also, it is missing proper comments for each functionality. Cyclomatic complexity of most of the methods is way too high as per the standard defined in the Code Climate.
* What needs to be done:
# Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
# Read about cyclomatic complexity here.
# Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas and space or lack of it and assigning branching condition.
Write test cases of any new code written. Test the existing functionality after refactoring.

However, since in code climate it shows that all cyclomatic complexity was resolved, our main work was fixing the logic of the method "get_team_color".

=== Modifications in review_mapping_helper.rb ===

===== get_team_color =====
This method is to determine the state of reviewers review on each team. There are five different states:‎ 
[[File:Review_status_color.jpg]]
----
The original code will not return the correct color, because when it is checking the grade for the reviewer, it is not checking the correct variable.

<pre> def get_team_color(response_map)
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at

# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)

# Returning colour based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).grade_for_reviewer.nil?
'brown'
elsif response_for_each_round?(response_map)
'blue'
else
check_submission_state(response_map, assignment_created, assignment_due_dates, @assignment.num_review_rounds)
end
else
'red'
end
end
</pre>

===== check_submission_state =====

This method checks whether the team submit the project on time or not. (If there are no submission or the submission is not on time, it is reasonable that the reviewer cannot review the project).
In addition, the submission time of a link should be checked by the last modified time of the webpage, not the moment the link itself is submitted.
----

<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? or (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
'green'
else
link_updated_at = get_link_updated_at(link)
link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>

===== obtain_team_color =====

----

This method has been removed because it is running unnecessary check on old submissions.

=== Testing Details in review_mapping_helper.rb ===

==== RSpec ====

----

All 32 test cases are currently passing.

# In method get_team_color(response_map) in review mapping helper.rb: Only checking if the record exist is not enough, because all mapping records pre-exist with empty scores in it.
# The for loop for checking multiple submission stage is unnecesasry, so we removed obtain_team_color and call check_submission_state directly.
# Stubbing NET::HTTP to fix test cases that originally failed if calling the method get_link_updated_at.

Example test case:
<pre> it 'color should be purple if submission link has been updated since due date for a specified round' do
# deadline_right inspired from bookmark_review_spec
allow(Net::HTTP).to receive(:get_response).and_return({'last-modified' => DateTime.now.in_time_zone})
create(:deadline_right, name: 'No')
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

response_map_with_reviewee = create(:review_response_map, reviewer: @reviewer, reviewee: @reviewee_with_assignment)

create(:submission_record, assignment_id: @assignment.id, team_id: @reviewee_with_assignment.id, operation: 'Submit Hyperlink',
content: 'https://wiki.archlinux.org/', created_at: DateTime.now.in_time_zone - 7.day)

create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 1, due_at: DateTime.now.in_time_zone - 5.day)
create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 2, due_at: DateTime.now.in_time_zone + 6.day)

create(:response, response_map: response_map_with_reviewee)

color = get_team_color(response_map_with_reviewee)
expect(color).to eq('purple')
end
end
</pre>

=== Peer Review Credentials ===
Username: instructor6 
Password: password

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-26T23:49:31Z

Lshan3: /* get_team_color */

__TOC__

== E2125. Refactor review mapping helper.rb ==
This page describes the Expertiza based OSS project.

=== Expertiza ===

Expertiza is an open-source project contributed by both the students and the faculty at NCSU. It is developed on Ruby-on-Rails and software to create reusable learning objects through peer review. Expertiza allows the instructor to create new assignments, customize new or existing assignments, and create a topic list for students to sign up. It also supports students to form teams for team projects and allows submission with almost any document type, including URLs and wiki pages.

=== Background ===
==== E2125. Refactor review_mapping_helper.rb ====
* Files involved: review_mapping_helper.rb
* What is wrong:
** The review_mapping_helper.rb has methods that exceed the limit on lines of code Also, it is missing proper comments for each functionality. Cyclomatic complexity of most of the methods is way too high as per the standard defined in the Code Climate.
* What needs to be done:
# Use Code Climate to do a diagnosis for Expertiza. Search for the issues involving the files mentioned above.
# Read about cyclomatic complexity here.
# Fix all the methods having the issue with cyclomatic complexity, assignment branch condition size, extra commas and space or lack of it and assigning branching condition.
Write test cases of any new code written. Test the existing functionality after refactoring.

However, since in code climate it shows that all cyclomatic complexity was resolved, our main work was fixing the logic of the method "get_team_color".

=== Modifications in review_mapping_helper.rb ===

===== get_team_color =====
This method is to determine the state of reviewers review on each team. There are five different states:‎ 
[[File:Review_status_color.jpg]]
----
The original code will not return the correct color, because when it is checking the grade for the reviewer, it is not checking the correct variable.

<pre> def get_team_color(response_map)
# Storing redundantly computed value in a variable
assignment_created = @assignment.created_at

# Storing redundantly computed value in a variable
assignment_due_dates = DueDate.where(parent_id: response_map.reviewed_object_id)

# Returning colour based on conditions
if Response.exists?(map_id: response_map.id)
if !response_map.try(:reviewer).try(:review_grade).grade_for_reviewer.nil?
'brown'
elsif response_for_each_round?(response_map)
'blue'
else
check_submission_state(response_map, assignment_created, assignment_due_dates, @assignment.num_review_rounds)
end
else
'red'
end
end
</pre>

===== check_submission_state =====

This method checks whether the team submit the project on time or not. (If there are no submission or the submission is not on time, it is reasonable that the reviewer cannot review the project).
In addition, the submission time of a link should be checked by the last modified time of the webpage, not the moment the link itself is submitted.
----

<pre>
def check_submission_state(response_map, assignment_created, assignment_due_dates, round)
if submitted_within_round?(round, response_map, assignment_created, assignment_due_dates)
'purple'
else
link = submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
if link.nil? or (link !~ %r{https*:\/\/wiki(.*)}) # can be extended for github links in future
'green'
else
link_updated_at = get_link_updated_at(link)
link_updated_since_last?(round, assignment_due_dates, link_updated_at) ? 'purple' : 'green'
end
end
end
</pre>

===== obtain_team_color =====

----

This method has been removed because it is running unnecessary loop.

=== Testing Details in review_mapping_helper.rb ===

==== RSpec ====

----

All 32 test cases are currently passing.

# In method get_team_color(response_map) in review mapping helper.rb: Only checking if the record exist is not enough, because all mapping records pre-exist with empty scores in it.
# The for loop for checking multiple submission stage is unnecesasry, so we removed obtain_team_color and call check_submission_state directly.
# Stubbing NET::HTTP to fix test cases that originally failed if calling the method get_link_updated_at.

Example test case:
<pre> it 'color should be purple if submission link has been updated since due date for a specified round' do
# deadline_right inspired from bookmark_review_spec
allow(Net::HTTP).to receive(:get_response).and_return({'last-modified' => DateTime.now.in_time_zone})
create(:deadline_right, name: 'No')
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

response_map_with_reviewee = create(:review_response_map, reviewer: @reviewer, reviewee: @reviewee_with_assignment)

create(:submission_record, assignment_id: @assignment.id, team_id: @reviewee_with_assignment.id, operation: 'Submit Hyperlink',
content: 'https://wiki.archlinux.org/', created_at: DateTime.now.in_time_zone - 7.day)

create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 1, due_at: DateTime.now.in_time_zone - 5.day)
create(:assignment_due_date, assignment: @assignment, parent_id: @assignment.id, round: 2, due_at: DateTime.now.in_time_zone + 6.day)

create(:response, response_map: response_map_with_reviewee)

color = get_team_color(response_map_with_reviewee)
expect(color).to eq('purple')
end
end
</pre>

=== Peer Review Credentials ===
Username: instructor6 
Password: password

File:Review status color.jpg

2021-10-26T23:46:44Z

Lshan3:

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-26T23:45:00Z

Lshan3: /* get_team_color */

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-26T23:42:54Z

Lshan3: /* Background */

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-26T23:42:10Z

Lshan3: /* Background */

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-26T23:41:54Z

Lshan3: /* Background */

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-26T23:31:59Z

Lshan3: /* RSpec */

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-26T23:25:36Z

Lshan3: /* RSpec */

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-24T03:26:45Z

Lshan3: /* Progress */

CSC/ECE 517 Fall 2021 - E2125. Refactor review mapping helper.rb

2021-10-24T03:06:19Z

Lshan3:

CSC/ECE 517 Fall 2021

2021-10-20T13:54:14Z

Lshan3:

== OSS Projects ==
* [[CSC/ECE 517 Fall 2021 - {$num}. {$desc.title}]]
* [[CSC/ECE 517 Fall 2021 - E2128. Refactor student_quizzes_controller.rb & late_policies_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2132. Add tests cases for review mapping helper.rb]]
* [[CSC/ECE 517 Fall 2021 - E2134. Write unit tests for admin_controller.rb and institution_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2138. Auto-generate submission directory names based on assignment]]
* [[CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications]]
* [[CSC/ECE 517 Fall 2021 - E2133. Write tests for popup_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2120. Refactor reputation_web_service_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2139. Remove multiple topics at a time]]
* [[CSC/ECE 517 Fall 2021 - E2131. Improve assessment360_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2121. Refactor suggestion_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2126. Refactor account_request_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2124. Refactor review_mapping_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2125. Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Fall 2021 - E2127. Refactor teams_controller]]