Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2021 - E2155. Calibration submissions should be copied along with calibration assignments

2021-11-04T03:01:36Z

Aho: /* Previous Implementation */

==Project Overview==
===Background===
To improve the experience of peer-reviewing in Expertiza and determine the competent reviewers amongst all the reviewers, creating a new form of review for assignments was considered. As a result, "calibration assignments" were introduced to the Expertiza system. The calibration assignments were to be assigned before peer review occurred so that students would know if they reviewed using the same rubrics as the instructor.

To set up a calibration assignment that both the instructor and the course students can review, the instructor needs to create a new assignment, add the extra participant manually, impersonate the participant, and finally, submit the review, which is not a great experience. What's more is that currently, if an instructor wishes to do this every semester or every year with the same course to copy over the calibration assignments, they have to repeat this process yet again.

===Objectives===
Expertiza can fix the problem of repeatedly setting up the calibration assignments by automatically copying the previous calibration assignments with all attached reviews.

===Previous Implementation===
In the previous implementation, the implementors designed the calibration review as part of the assignment and students were able to participate in calibration review training before reviewing other students' work.

The instructor can enable the calibration review in an assignment by checking "Calibration for training?" before assignment creation.

[[File:2021-11-03 011751.png]]

Detailed System Overview can be found at the following: 
[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2017/E17A4_Allow_calibration_to_be_part_of_an_assignment CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment]

However, their implementation introduced several assumptions about the system that we will address to allow merging into production.

===Issues of Previous work===
#The project assumes that the calibration starts at directory 0, which occasionally causes Expertiza to copy the wrong submission.
##Suggested Fix: set submitter_count to the largest directory number that Expertiza used for calibration.
###Allows us to keep track of the most recent calibration submission.
###Gives us something we can reference during copying to get the correct directory.

==Design==

==Implementation==

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

2021-10-27T03:47:17Z

Aho: /* 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>

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

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

2021-10-27T03:46:53Z

Aho: /* Test Plan */

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

2021-10-27T03:42:12Z

Aho: /* Testing Details 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>

=== 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: 
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 

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-24T01:22:51Z

Aho:

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

2021-10-22T13:39:54Z

Aho: Undo revision 139909 by Aho (talk)

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

2021-10-22T13:38:43Z

Aho: /* get_team_color */

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

2021-10-22T13:33:49Z

Aho: /* E2125. Refactor review mapping helper.rb */

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

2021-10-22T13:22:24Z

Aho: /* = */

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

2021-10-22T13:21:18Z

Aho: /* E2125. Refactor review mapping helper.rb */

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

2021-10-21T02:56:59Z

Aho: /* Testing Details in review_mapping_helper.rb */

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

2021-10-21T02:16:33Z

Aho: /* Testing Details */

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

2021-10-21T02:15:56Z

Aho: /* Modifications */

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

2021-10-21T02:12:50Z

Aho: /* Modified File */

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

2021-10-21T02:11:47Z

Aho: /* Testing Details */

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

2021-10-21T02:10:38Z

Aho: /* Testing */

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

2021-10-21T02:07:41Z

Aho: /* get_team_color */

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

2021-10-21T02:07:25Z

Aho: /* get_team_color */

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

2021-10-21T02:06:52Z

Aho: /* Files Modified */

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

2021-10-21T02:03:52Z

Aho: /* Modifications */

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

2021-10-21T01:49:19Z

Aho:

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

2021-10-21T01:46:51Z

Aho:

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

2021-10-21T01:46:20Z

Aho: /* New Implementation */

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

2021-10-20T22:48:26Z

Aho: /* Expertiza */

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

2021-10-20T22:45:43Z

Aho: /* Expertiza */

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

2021-10-20T22:39:23Z

Aho: /* E2125. Refactor review mapping helper.rb */

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

2021-10-20T22:10:03Z

Aho: Created page with "__TOC__ == E2125. Refactor review mapping helper.rb == This page provides a description of the Expertiza based OSS project. === Background === === Current Implementation ==..."

__TOC__

== E2125. Refactor review mapping helper.rb ==
This page provides a description of the Expertiza based OSS project.

=== Background ===

=== Current Implementation ===

=== New Implementation ===

=== Testing ===

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

2021-10-19T00:44:19Z

Aho:

== Refactor review mapping helper.rb ==

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

2021-10-18T21:56:41Z

Aho:

== About Expertiza ==

== Project Introduction ==

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

2021-10-18T21:53:18Z

Aho:

== About Expertiza ==

== Project Introduction ==

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

2021-10-18T21:51:08Z

Aho: Created page with " == About Expertiza =="

== About Expertiza ==