Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T03:38:18Z

Jcai3: /* Manual UI Testing */

== ''' Introduction ''' ==
* In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide feedback for this review, called “author feedback.” While grading peer reviews, it would be nice for the instructors to include the author feedback, since it shows how helpful the peer review actually was to the author of the project.

== ''' Current Implementation ''' ==
* Currently, the instructor can only see several information, including numbers of review done, team the student which have reviewed, about author feedback. The current view report can be shown as below.
[[File:Review_report_before.png]]

* However, the instructor has no easy way of seeing the author-feedback scores, so it would be far too much trouble to include them in grades for reviewing.
* So the aim of this project is to build more feedback information into the reviewer report. So that the instructor of the course is able to grade reviewers based on author feedback and review data.

== ''' Problem Statement ''' ==
* We need to implement the integration of review performance which includes:
# # of reviews completed
# Length of reviews
# [Summary of reviews]
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors
# An interactive visualization or table that showed this would be GREAT (We may use “HighChart” javascript library to do it.)

* After analysis the current code, we found that the number of reviews, summary of reviews and visualization of length of reviews have already existed in the system. So we only need to finished the following tasks.
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors

* As the description of our object, the average ratings part of this project has been done last year. And they add a new column (author feedback) to review report. But their functions still have some drawbacks. So we also need to improve the several functions of author feedback.
# Fix code to calculate the average score of feedback
# Make the author feedback column adjust to existing view.

* So here is our plan and solutions to finish this project.
[[File: Feedback_task.png]]

== ''' Project Design''' ==
The basic design of this project can be shown in the UML flow chart below.

[[File: UML_flow_chart.png]]

=== View Improvement ===

* We decide mainly change the page of "Review report" (Log in as an instructor then go to Manage -> Assignments -> View review report.) from three aspects.
# We are planning to add one more column to show the average ratings for feedback for a student's review of a particular assignment. The logic for calculating the average score for the metareviews would be similar to already implemented logic for the "Score Awarded/Average Score" column.
# We are planning to improve the column of review length. Now it is just bare data and average data. We will make the review length into visualized chart by using “HighChart” javascript library. So that length of review will become more clear for instructors. The chart will be shown like below.
# We are planning to add all links which attached to their reviews below Team name. If there are links in the review, the links will be shown below.

=== Controller Improvement ===

The Controller design is based on the data we need for view.

As we found that the links and files in review are both stored as URLs, so we only need to list url in reviews.

So We change following methods. Specify changes will be shown in File Change.
# calcutate_average_author_feedback_score
# list_url_in_comments

== ''' Code Changes ''' ==

Here is the file we have changed.

'''1. _review_report.html.erb'''

We add a new column to show average score of feedback score.

<pre style="color: black; border:1px;">



<td align='left'>
<% @response_maps.each_with_index do |ri, index| %>
<% if Team.where(id: ri.reviewee_id).length > 0 %>
<% if index == 0 %>
<div>
<% else %>
<div style="border-top: solid; border-width: 1px;">
<% end %>
<%= calcutate_average_author_feedback_score(@assignment.id, @assignment.max_team_size, ri.id, ri.reviewee_id) %>
</div>
<% end %>
<% end %>
</td>
</pre>

Then we use new-added method to show all URLs below each Team name.
<pre style="color: black; border:1px;">

<% urls = list_url_in_comments(ri.id)%>
</div>
<% if !urls.nil? %>
<% urls.each_with_index do |url| %>
<%= link_to url.to_s, url %>
<% end %>
<% end %>
</pre>

'''2. review_mapping_helper.rb'''

We first fix ''calcutate_average_author_feedback_score'' method.

<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
def calcutate_average_author_feedback_score(assignment_id, max_team_size, response_map_id, reviewee_id)
review_response = ResponseMap.where(id: response_map_id).try(:first).try(:response).try(:last)
author_feedback_avg_score = "-- / --"
unless review_response.nil?
# Total score of author feedback given by all team members.
author_feedback_total_score = 0
# Max score of author feedback
author_feedback_max_score = 0
# Number of author feedback given by all team members.
author_feedback_count = 0
# For each user in teamsUser find author feedback score.
TeamsUser.where(team_id: reviewee_id).try(:each) do |teamsUser|
user = teamsUser.try(:user)
author = Participant.where(parent_id: assignment_id, user_id: user.id).try(:first) unless user.nil?
feedback_response = ResponseMap.where(reviewed_object_id: review_response.id, reviewer_id: author.id).try(:first).try(:response).try(:last) unless author.nil?
unless feedback_response.nil?
author_feedback_total_score += feedback_response.total_score
author_feedback_max_score = feedback_response.maximum_score
author_feedback_count +=1
end
end
# return "-- / --" if no author feedback, otherwise return avg_score
author_feedback_avg_score = author_feedback_count == 0 ? "-- / --" : "#{author_feedback_total_score/author_feedback_count} / #{author_feedback_max_score}"
end
author_feedback_avg_score
end
</pre>

Then we add a new method called ''list_url_in_comments'' to shown all urls.
<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
# list all urls in comments for each review map
def list_url_in_comments(response_map_id)
response = Response.where(map_id: response_map_id)
# find all comments in each repsonse
Answer.where(response_id: response.ids).try(:each) do |ans|
@comments = ''
@comments += ans.try(:comments)
end
if @comments.nil?
return @comments
end
urls = []
# get every words in the comment
words = @comments.split(" ")
words.each do |element|
# see if it starts with http or https
if element =~ /https?:\/\/[\S]+/
urls.append(element)
end
end
urls
end
</pre>

'''3. review_mapping_helper_spec.rb'''

'''4. review_mapping_spec.rb '''

Finally, we add some tests for the changes made. The specific test cases will be shown in Test Plan.

== ''' Test Plan ''' ==
We will use unit test and functionally test with Rspec, and integration test by using TravisCI and Coveralls bot.

=== Automated Testing Using Rspec ===

As we add new column for Average Author feedback, we add corresponding Rspec test in review_mapping_helper_spec.rb.

<pre style="color: black; border:1px;">
describe "Test assignment review report" do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_button "View"
end

it 'should contain Average Author feedback' do
create(:review_response_map)
expect(page).to have_content('Average Author feedback')
end
end
</pre>

During the testing process, we found that there are no tests for other columns as well.
So we also add some tests for number of reviews completed, length of reviews and summary of reviews in review_mapping_spec.rb

<pre style="color: black; border:1px;">
it "should calculate number of reviews correctly" do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('0/2')
end
</pre>

<pre style="color: black; border:1px;">
it "can show length of reviews", js: true do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

# it should find there is a chart in the view that shows the review length
expect(page).to have_selector("#chart-0")
end

</pre>

<pre style="color: black; border:1px;">
it "can show summary" do
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# add_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
expect(page).to have_content participant_reviewer.user.name

# add_meta_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
click_link('add metareviewer')
add_matareviewer(participant_reviewer2.user.name)
expect(page).to have_content participant_reviewer2.user.name

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('summary')
end
</pre>

=== Coverage ===
The coverage of Coveralls is 24.272% for whole expertiza.

=== Manual UI Testing ===
# Log in as an instructor
# Click Manage and choose Assignments
# Select the Assignment you want to further check, for example, Final project (and design doc)
# Choose review report and click view
# Check "Average Feedback Score" column, for example, student5061 have reviewed Team_BEND_Final_Project and his Average Feedback Score is 13 of total score 15.
# Check urls below each "Team reviewed", for example, student5698 have reviewed Final project(and design doc)_Team_113, and there is a URL about reactkungfu in his review
The anticipated result can be same as below.

[[File:E1979_test_result.png]]

== ''' Team Information ''' ==
Mentor: Mohit Jain

* Mentor: Mohit Jain
* Jing Cai
* Yongjian Zhu
* Weiran Fu
* Dongyuan Wang

== ''' Related Links ''' ==
#[https://github.com/aranne/expertiza Forked GitHub Repository]
#[https://github.com/expertiza/expertiza/pull/1628 pull request]
#[https://www.youtube.com/watch?v=kTEgNyljAd8 screencast video]

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T03:38:04Z

Jcai3: /* Team Information */

== ''' Introduction ''' ==
* In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide feedback for this review, called “author feedback.” While grading peer reviews, it would be nice for the instructors to include the author feedback, since it shows how helpful the peer review actually was to the author of the project.

== ''' Current Implementation ''' ==
* Currently, the instructor can only see several information, including numbers of review done, team the student which have reviewed, about author feedback. The current view report can be shown as below.
[[File:Review_report_before.png]]

* However, the instructor has no easy way of seeing the author-feedback scores, so it would be far too much trouble to include them in grades for reviewing.
* So the aim of this project is to build more feedback information into the reviewer report. So that the instructor of the course is able to grade reviewers based on author feedback and review data.

== ''' Problem Statement ''' ==
* We need to implement the integration of review performance which includes:
# # of reviews completed
# Length of reviews
# [Summary of reviews]
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors
# An interactive visualization or table that showed this would be GREAT (We may use “HighChart” javascript library to do it.)

* After analysis the current code, we found that the number of reviews, summary of reviews and visualization of length of reviews have already existed in the system. So we only need to finished the following tasks.
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors

* As the description of our object, the average ratings part of this project has been done last year. And they add a new column (author feedback) to review report. But their functions still have some drawbacks. So we also need to improve the several functions of author feedback.
# Fix code to calculate the average score of feedback
# Make the author feedback column adjust to existing view.

* So here is our plan and solutions to finish this project.
[[File: Feedback_task.png]]

== ''' Project Design''' ==
The basic design of this project can be shown in the UML flow chart below.

[[File: UML_flow_chart.png]]

=== View Improvement ===

* We decide mainly change the page of "Review report" (Log in as an instructor then go to Manage -> Assignments -> View review report.) from three aspects.
# We are planning to add one more column to show the average ratings for feedback for a student's review of a particular assignment. The logic for calculating the average score for the metareviews would be similar to already implemented logic for the "Score Awarded/Average Score" column.
# We are planning to improve the column of review length. Now it is just bare data and average data. We will make the review length into visualized chart by using “HighChart” javascript library. So that length of review will become more clear for instructors. The chart will be shown like below.
# We are planning to add all links which attached to their reviews below Team name. If there are links in the review, the links will be shown below.

=== Controller Improvement ===

The Controller design is based on the data we need for view.

As we found that the links and files in review are both stored as URLs, so we only need to list url in reviews.

So We change following methods. Specify changes will be shown in File Change.
# calcutate_average_author_feedback_score
# list_url_in_comments

== ''' Code Changes ''' ==

Here is the file we have changed.

'''1. _review_report.html.erb'''

We add a new column to show average score of feedback score.

<pre style="color: black; border:1px;">



<td align='left'>
<% @response_maps.each_with_index do |ri, index| %>
<% if Team.where(id: ri.reviewee_id).length > 0 %>
<% if index == 0 %>
<div>
<% else %>
<div style="border-top: solid; border-width: 1px;">
<% end %>
<%= calcutate_average_author_feedback_score(@assignment.id, @assignment.max_team_size, ri.id, ri.reviewee_id) %>
</div>
<% end %>
<% end %>
</td>
</pre>

Then we use new-added method to show all URLs below each Team name.
<pre style="color: black; border:1px;">

<% urls = list_url_in_comments(ri.id)%>
</div>
<% if !urls.nil? %>
<% urls.each_with_index do |url| %>
<%= link_to url.to_s, url %>
<% end %>
<% end %>
</pre>

'''2. review_mapping_helper.rb'''

We first fix ''calcutate_average_author_feedback_score'' method.

<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
def calcutate_average_author_feedback_score(assignment_id, max_team_size, response_map_id, reviewee_id)
review_response = ResponseMap.where(id: response_map_id).try(:first).try(:response).try(:last)
author_feedback_avg_score = "-- / --"
unless review_response.nil?
# Total score of author feedback given by all team members.
author_feedback_total_score = 0
# Max score of author feedback
author_feedback_max_score = 0
# Number of author feedback given by all team members.
author_feedback_count = 0
# For each user in teamsUser find author feedback score.
TeamsUser.where(team_id: reviewee_id).try(:each) do |teamsUser|
user = teamsUser.try(:user)
author = Participant.where(parent_id: assignment_id, user_id: user.id).try(:first) unless user.nil?
feedback_response = ResponseMap.where(reviewed_object_id: review_response.id, reviewer_id: author.id).try(:first).try(:response).try(:last) unless author.nil?
unless feedback_response.nil?
author_feedback_total_score += feedback_response.total_score
author_feedback_max_score = feedback_response.maximum_score
author_feedback_count +=1
end
end
# return "-- / --" if no author feedback, otherwise return avg_score
author_feedback_avg_score = author_feedback_count == 0 ? "-- / --" : "#{author_feedback_total_score/author_feedback_count} / #{author_feedback_max_score}"
end
author_feedback_avg_score
end
</pre>

Then we add a new method called ''list_url_in_comments'' to shown all urls.
<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
# list all urls in comments for each review map
def list_url_in_comments(response_map_id)
response = Response.where(map_id: response_map_id)
# find all comments in each repsonse
Answer.where(response_id: response.ids).try(:each) do |ans|
@comments = ''
@comments += ans.try(:comments)
end
if @comments.nil?
return @comments
end
urls = []
# get every words in the comment
words = @comments.split(" ")
words.each do |element|
# see if it starts with http or https
if element =~ /https?:\/\/[\S]+/
urls.append(element)
end
end
urls
end
</pre>

'''3. review_mapping_helper_spec.rb'''

'''4. review_mapping_spec.rb '''

Finally, we add some tests for the changes made. The specific test cases will be shown in Test Plan.

== ''' Test Plan ''' ==
We will use unit test and functionally test with Rspec, and integration test by using TravisCI and Coveralls bot.

=== Automated Testing Using Rspec ===

As we add new column for Average Author feedback, we add corresponding Rspec test in review_mapping_helper_spec.rb.

<pre style="color: black; border:1px;">
describe "Test assignment review report" do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_button "View"
end

it 'should contain Average Author feedback' do
create(:review_response_map)
expect(page).to have_content('Average Author feedback')
end
end
</pre>

During the testing process, we found that there are no tests for other columns as well.
So we also add some tests for number of reviews completed, length of reviews and summary of reviews in review_mapping_spec.rb

<pre style="color: black; border:1px;">
it "should calculate number of reviews correctly" do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('0/2')
end
</pre>

<pre style="color: black; border:1px;">
it "can show length of reviews", js: true do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

# it should find there is a chart in the view that shows the review length
expect(page).to have_selector("#chart-0")
end

</pre>

<pre style="color: black; border:1px;">
it "can show summary" do
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# add_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
expect(page).to have_content participant_reviewer.user.name

# add_meta_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
click_link('add metareviewer')
add_matareviewer(participant_reviewer2.user.name)
expect(page).to have_content participant_reviewer2.user.name

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('summary')
end
</pre>

=== Coverage ===
The coverage of Coveralls is 24.272% for whole expertiza.

=== Manual UI Testing ===
# Log in as an instructor
# Click Manage and choose Assignments
# Select the Assignment you want to further check, for example, Final project (and design doc)
# Choose review report and click view
# Check "Average Feedback Score" column, for example, student5061 have reviewed Team_BEND_Final_Project and his Average Feedback Score is 13 of total score 15.
# Check urls below each "Team reviewed", for example, student5698 have reviewed Final project(and design doc)_Team_113, and there is a URL about reactkungfu in his review
The anticipated result can be same as below.
[[File:E1979_test_result.png]]

== ''' Team Information ''' ==
Mentor: Mohit Jain

* Mentor: Mohit Jain
* Jing Cai
* Yongjian Zhu
* Weiran Fu
* Dongyuan Wang

== ''' Related Links ''' ==
#[https://github.com/aranne/expertiza Forked GitHub Repository]
#[https://github.com/expertiza/expertiza/pull/1628 pull request]
#[https://www.youtube.com/watch?v=kTEgNyljAd8 screencast video]

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T03:36:59Z

Jcai3: /* Code Changes */

== ''' Introduction ''' ==
* In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide feedback for this review, called “author feedback.” While grading peer reviews, it would be nice for the instructors to include the author feedback, since it shows how helpful the peer review actually was to the author of the project.

== ''' Current Implementation ''' ==
* Currently, the instructor can only see several information, including numbers of review done, team the student which have reviewed, about author feedback. The current view report can be shown as below.
[[File:Review_report_before.png]]

* However, the instructor has no easy way of seeing the author-feedback scores, so it would be far too much trouble to include them in grades for reviewing.
* So the aim of this project is to build more feedback information into the reviewer report. So that the instructor of the course is able to grade reviewers based on author feedback and review data.

== ''' Problem Statement ''' ==
* We need to implement the integration of review performance which includes:
# # of reviews completed
# Length of reviews
# [Summary of reviews]
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors
# An interactive visualization or table that showed this would be GREAT (We may use “HighChart” javascript library to do it.)

* After analysis the current code, we found that the number of reviews, summary of reviews and visualization of length of reviews have already existed in the system. So we only need to finished the following tasks.
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors

* As the description of our object, the average ratings part of this project has been done last year. And they add a new column (author feedback) to review report. But their functions still have some drawbacks. So we also need to improve the several functions of author feedback.
# Fix code to calculate the average score of feedback
# Make the author feedback column adjust to existing view.

* So here is our plan and solutions to finish this project.
[[File: Feedback_task.png]]

== ''' Project Design''' ==
The basic design of this project can be shown in the UML flow chart below.

[[File: UML_flow_chart.png]]

=== View Improvement ===

* We decide mainly change the page of "Review report" (Log in as an instructor then go to Manage -> Assignments -> View review report.) from three aspects.
# We are planning to add one more column to show the average ratings for feedback for a student's review of a particular assignment. The logic for calculating the average score for the metareviews would be similar to already implemented logic for the "Score Awarded/Average Score" column.
# We are planning to improve the column of review length. Now it is just bare data and average data. We will make the review length into visualized chart by using “HighChart” javascript library. So that length of review will become more clear for instructors. The chart will be shown like below.
# We are planning to add all links which attached to their reviews below Team name. If there are links in the review, the links will be shown below.

=== Controller Improvement ===

The Controller design is based on the data we need for view.

As we found that the links and files in review are both stored as URLs, so we only need to list url in reviews.

So We change following methods. Specify changes will be shown in File Change.
# calcutate_average_author_feedback_score
# list_url_in_comments

== ''' Code Changes ''' ==

Here is the file we have changed.

'''1. _review_report.html.erb'''

We add a new column to show average score of feedback score.

<pre style="color: black; border:1px;">



<td align='left'>
<% @response_maps.each_with_index do |ri, index| %>
<% if Team.where(id: ri.reviewee_id).length > 0 %>
<% if index == 0 %>
<div>
<% else %>
<div style="border-top: solid; border-width: 1px;">
<% end %>
<%= calcutate_average_author_feedback_score(@assignment.id, @assignment.max_team_size, ri.id, ri.reviewee_id) %>
</div>
<% end %>
<% end %>
</td>
</pre>

Then we use new-added method to show all URLs below each Team name.
<pre style="color: black; border:1px;">

<% urls = list_url_in_comments(ri.id)%>
</div>
<% if !urls.nil? %>
<% urls.each_with_index do |url| %>
<%= link_to url.to_s, url %>
<% end %>
<% end %>
</pre>

'''2. review_mapping_helper.rb'''

We first fix ''calcutate_average_author_feedback_score'' method.

<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
def calcutate_average_author_feedback_score(assignment_id, max_team_size, response_map_id, reviewee_id)
review_response = ResponseMap.where(id: response_map_id).try(:first).try(:response).try(:last)
author_feedback_avg_score = "-- / --"
unless review_response.nil?
# Total score of author feedback given by all team members.
author_feedback_total_score = 0
# Max score of author feedback
author_feedback_max_score = 0
# Number of author feedback given by all team members.
author_feedback_count = 0
# For each user in teamsUser find author feedback score.
TeamsUser.where(team_id: reviewee_id).try(:each) do |teamsUser|
user = teamsUser.try(:user)
author = Participant.where(parent_id: assignment_id, user_id: user.id).try(:first) unless user.nil?
feedback_response = ResponseMap.where(reviewed_object_id: review_response.id, reviewer_id: author.id).try(:first).try(:response).try(:last) unless author.nil?
unless feedback_response.nil?
author_feedback_total_score += feedback_response.total_score
author_feedback_max_score = feedback_response.maximum_score
author_feedback_count +=1
end
end
# return "-- / --" if no author feedback, otherwise return avg_score
author_feedback_avg_score = author_feedback_count == 0 ? "-- / --" : "#{author_feedback_total_score/author_feedback_count} / #{author_feedback_max_score}"
end
author_feedback_avg_score
end
</pre>

Then we add a new method called ''list_url_in_comments'' to shown all urls.
<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
# list all urls in comments for each review map
def list_url_in_comments(response_map_id)
response = Response.where(map_id: response_map_id)
# find all comments in each repsonse
Answer.where(response_id: response.ids).try(:each) do |ans|
@comments = ''
@comments += ans.try(:comments)
end
if @comments.nil?
return @comments
end
urls = []
# get every words in the comment
words = @comments.split(" ")
words.each do |element|
# see if it starts with http or https
if element =~ /https?:\/\/[\S]+/
urls.append(element)
end
end
urls
end
</pre>

'''3. review_mapping_helper_spec.rb'''

'''4. review_mapping_spec.rb '''

Finally, we add some tests for the changes made. The specific test cases will be shown in Test Plan.

== ''' Test Plan ''' ==
We will use unit test and functionally test with Rspec, and integration test by using TravisCI and Coveralls bot.

=== Automated Testing Using Rspec ===

As we add new column for Average Author feedback, we add corresponding Rspec test in review_mapping_helper_spec.rb.

<pre style="color: black; border:1px;">
describe "Test assignment review report" do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_button "View"
end

it 'should contain Average Author feedback' do
create(:review_response_map)
expect(page).to have_content('Average Author feedback')
end
end
</pre>

During the testing process, we found that there are no tests for other columns as well.
So we also add some tests for number of reviews completed, length of reviews and summary of reviews in review_mapping_spec.rb

<pre style="color: black; border:1px;">
it "should calculate number of reviews correctly" do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('0/2')
end
</pre>

<pre style="color: black; border:1px;">
it "can show length of reviews", js: true do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

# it should find there is a chart in the view that shows the review length
expect(page).to have_selector("#chart-0")
end

</pre>

<pre style="color: black; border:1px;">
it "can show summary" do
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# add_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
expect(page).to have_content participant_reviewer.user.name

# add_meta_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
click_link('add metareviewer')
add_matareviewer(participant_reviewer2.user.name)
expect(page).to have_content participant_reviewer2.user.name

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('summary')
end
</pre>

=== Coverage ===
The coverage of Coveralls is 24.272% for whole expertiza.

=== Manual UI Testing ===
# Log in as an instructor
# Click Manage and choose Assignments
# Select the Assignment you want to further check, for example, Final project (and design doc)
# Choose review report and click view
# Check "Average Feedback Score" column, for example, student5061 have reviewed Team_BEND_Final_Project and his Average Feedback Score is 13 of total score 15.
# Check urls below each "Team reviewed", for example, student5698 have reviewed Final project(and design doc)_Team_113, and there is a URL about reactkungfu in his review
The anticipated result can be same as below.
[[File:E1979_test_result.png]]

== ''' Team Information ''' ==
Mentor: Mohit Jain

* Mentor: Mohit Jain
* Jing Cai
* Yongjian Zhu
* Weiran Fu
* Dongyuan Wang

===Related Links===
#[https://github.com/aranne/expertiza Forked GitHub Repository]
#[https://github.com/expertiza/expertiza/pull/1628 pull request]
#[https://www.youtube.com/watch?v=kTEgNyljAd8 screencast video]

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T02:05:44Z

Jcai3: /* Controller Improvement */

== ''' Introduction ''' ==
* In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide feedback for this review, called “author feedback.” While grading peer reviews, it would be nice for the instructors to include the author feedback, since it shows how helpful the peer review actually was to the author of the project.

== ''' Current Implementation ''' ==
* Currently, the instructor can only see several information, including numbers of review done, team the student which have reviewed, about author feedback. The current view report can be shown as below.
[[File:Review_report_before.png]]

* However, the instructor has no easy way of seeing the author-feedback scores, so it would be far too much trouble to include them in grades for reviewing.
* So the aim of this project is to build more feedback information into the reviewer report. So that the instructor of the course is able to grade reviewers based on author feedback and review data.

== ''' Problem Statement ''' ==
* We need to implement the integration of review performance which includes:
# # of reviews completed
# Length of reviews
# [Summary of reviews]
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors
# An interactive visualization or table that showed this would be GREAT (We may use “HighChart” javascript library to do it.)

* After analysis the current code, we found that the number of reviews, summary of reviews and visualization of length of reviews have already existed in the system. So we only need to finished the following tasks.
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors

* As the description of our object, the average ratings part of this project has been done last year. And they add a new column (author feedback) to review report. But their functions still have some drawbacks. So we also need to improve the several functions of author feedback.
# Fix code to calculate the average score of feedback
# Make the author feedback column adjust to existing view.

* So here is our plan and solutions to finish this project.
[[File: Feedback_task.png]]

== ''' Project Design''' ==
The basic design of this project can be shown in the UML flow chart below.

[[File: UML_flow_chart.png]]

=== View Improvement ===

* We decide mainly change the page of "Review report" (Log in as an instructor then go to Manage -> Assignments -> View review report.) from three aspects.
# We are planning to add one more column to show the average ratings for feedback for a student's review of a particular assignment. The logic for calculating the average score for the metareviews would be similar to already implemented logic for the "Score Awarded/Average Score" column.
# We are planning to improve the column of review length. Now it is just bare data and average data. We will make the review length into visualized chart by using “HighChart” javascript library. So that length of review will become more clear for instructors. The chart will be shown like below.
# We are planning to add all links which attached to their reviews below Team name. If there are links in the review, the links will be shown below.

=== Controller Improvement ===

The Controller design is based on the data we need for view.

As we found that the links and files in review are both stored as URLs, so we only need to list url in reviews.

So We change following methods. Specify changes will be shown in File Change.
# calcutate_average_author_feedback_score
# list_url_in_comments

== ''' Code Changes ''' ==

Here is the file we have changed.

'''1. _review_report.html.erb'''

We add a new column to show average score of feedback score.

<pre style="color: black; border:1px;">



<td align='left'>
<% @response_maps.each_with_index do |ri, index| %>
<% if Team.where(id: ri.reviewee_id).length > 0 %>
<% if index == 0 %>
<div>
<% else %>
<div style="border-top: solid; border-width: 1px;">
<% end %>
<%= calcutate_average_author_feedback_score(@assignment.id, @assignment.max_team_size, ri.id, ri.reviewee_id) %>
</div>
<% end %>
<% end %>
</td>
</pre>

Then we use new-added method to show all link below each Team name.
<pre style="color: black; border:1px;">

<% urls = list_url_in_comments(ri.id)%>
</div>
<% if !urls.nil? %>
<% urls.each_with_index do |url| %>
<%= link_to url.to_s, url %>
<% end %>
<% end %>
</pre>

'''2. review_mapping_helper.rb'''

We first fix ''calcutate_average_author_feedback_score'' method.

<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
def calcutate_average_author_feedback_score(assignment_id, max_team_size, response_map_id, reviewee_id)
review_response = ResponseMap.where(id: response_map_id).try(:first).try(:response).try(:last)
author_feedback_avg_score = "-- / --"
unless review_response.nil?
# Total score of author feedback given by all team members.
author_feedback_total_score = 0
# Max score of author feedback
author_feedback_max_score = 0
# Number of author feedback given by all team members.
author_feedback_count = 0
# For each user in teamsUser find author feedback score.
TeamsUser.where(team_id: reviewee_id).try(:each) do |teamsUser|
user = teamsUser.try(:user)
author = Participant.where(parent_id: assignment_id, user_id: user.id).try(:first) unless user.nil?
feedback_response = ResponseMap.where(reviewed_object_id: review_response.id, reviewer_id: author.id).try(:first).try(:response).try(:last) unless author.nil?
unless feedback_response.nil?
author_feedback_total_score += feedback_response.total_score
author_feedback_max_score = feedback_response.maximum_score
author_feedback_count +=1
end
end
# return "-- / --" if no author feedback, otherwise return avg_score
author_feedback_avg_score = author_feedback_count == 0 ? "-- / --" : "#{author_feedback_total_score/author_feedback_count} / #{author_feedback_max_score}"
end
author_feedback_avg_score
end
</pre>

Then we add a new method called ''list_url_in_comments'' to shown all urls.
<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
# list all urls in comments for each review map
def list_url_in_comments(response_map_id)
response = Response.where(map_id: response_map_id)
# find all comments in each repsonse
Answer.where(response_id: response.ids).try(:each) do |ans|
@comments = ''
@comments += ans.try(:comments)
end
if @comments.nil?
return @comments
end
urls = []
# get every words in the comment
words = @comments.split(" ")
words.each do |element|
# see if it starts with http or https
if element =~ /https?:\/\/[\S]+/
urls.append(element)
end
end
urls
end
</pre>

'''3. review_mapping_helper_spec.rb'''

'''4. review_mapping_spec.rb '''

Finally, we add some tests for the changes made. The specific test cases will be shown in Test Plan.

== ''' Test Plan ''' ==
We will use unit test and functionally test with Rspec, and integration test by using TravisCI and Coveralls bot.

=== Automated Testing Using Rspec ===

As we add new column for Average Author feedback, we add corresponding Rspec test in review_mapping_helper_spec.rb.

<pre style="color: black; border:1px;">
describe "Test assignment review report" do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_button "View"
end

it 'should contain Average Author feedback' do
create(:review_response_map)
expect(page).to have_content('Average Author feedback')
end
end
</pre>

During the testing process, we found that there are no tests for other columns as well.
So we also add some tests for number of reviews completed, length of reviews and summary of reviews in review_mapping_spec.rb

<pre style="color: black; border:1px;">
it "should calculate number of reviews correctly" do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('0/2')
end
</pre>

<pre style="color: black; border:1px;">
it "can show length of reviews", js: true do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

# it should find there is a chart in the view that shows the review length
expect(page).to have_selector("#chart-0")
end

</pre>

<pre style="color: black; border:1px;">
it "can show summary" do
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# add_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
expect(page).to have_content participant_reviewer.user.name

# add_meta_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
click_link('add metareviewer')
add_matareviewer(participant_reviewer2.user.name)
expect(page).to have_content participant_reviewer2.user.name

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('summary')
end
</pre>

=== Coverage ===
The coverage of Coveralls is 24.272% for whole expertiza.

=== Manual UI Testing ===
# Log in as an instructor
# Click Manage and choose Assignments
# Select the Assignment you want to further check, for example, Final project (and design doc)
# Choose review report and click view
# Check "Average Feedback Score" column, for example, student5061 have reviewed Team_BEND_Final_Project and his Average Feedback Score is 13 of total score 15.
# Check urls below each "Team reviewed", for example, student5698 have reviewed Final project(and design doc)_Team_113, and there is a URL about reactkungfu in his review
The anticipated result can be same as below.
[[File:E1979_test_result.png]]

== ''' Team Information ''' ==
Mentor: Mohit Jain

* Mentor: Mohit Jain
* Jing Cai
* Yongjian Zhu
* Weiran Fu
* Dongyuan Wang

===Related Links===
#[https://github.com/aranne/expertiza Forked GitHub Repository]
#[https://github.com/expertiza/expertiza/pull/1628 pull request]
#[https://www.youtube.com/watch?v=kTEgNyljAd8 screencast video]

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T02:05:36Z

Jcai3: /* Controller Improvement */

== ''' Introduction ''' ==
* In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide feedback for this review, called “author feedback.” While grading peer reviews, it would be nice for the instructors to include the author feedback, since it shows how helpful the peer review actually was to the author of the project.

== ''' Current Implementation ''' ==
* Currently, the instructor can only see several information, including numbers of review done, team the student which have reviewed, about author feedback. The current view report can be shown as below.
[[File:Review_report_before.png]]

* However, the instructor has no easy way of seeing the author-feedback scores, so it would be far too much trouble to include them in grades for reviewing.
* So the aim of this project is to build more feedback information into the reviewer report. So that the instructor of the course is able to grade reviewers based on author feedback and review data.

== ''' Problem Statement ''' ==
* We need to implement the integration of review performance which includes:
# # of reviews completed
# Length of reviews
# [Summary of reviews]
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors
# An interactive visualization or table that showed this would be GREAT (We may use “HighChart” javascript library to do it.)

* After analysis the current code, we found that the number of reviews, summary of reviews and visualization of length of reviews have already existed in the system. So we only need to finished the following tasks.
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors

* As the description of our object, the average ratings part of this project has been done last year. And they add a new column (author feedback) to review report. But their functions still have some drawbacks. So we also need to improve the several functions of author feedback.
# Fix code to calculate the average score of feedback
# Make the author feedback column adjust to existing view.

* So here is our plan and solutions to finish this project.
[[File: Feedback_task.png]]

== ''' Project Design''' ==
The basic design of this project can be shown in the UML flow chart below.

[[File: UML_flow_chart.png]]

=== View Improvement ===

* We decide mainly change the page of "Review report" (Log in as an instructor then go to Manage -> Assignments -> View review report.) from three aspects.
# We are planning to add one more column to show the average ratings for feedback for a student's review of a particular assignment. The logic for calculating the average score for the metareviews would be similar to already implemented logic for the "Score Awarded/Average Score" column.
# We are planning to improve the column of review length. Now it is just bare data and average data. We will make the review length into visualized chart by using “HighChart” javascript library. So that length of review will become more clear for instructors. The chart will be shown like below.
# We are planning to add all links which attached to their reviews below Team name. If there are links in the review, the links will be shown below.

=== Controller Improvement ===

The Controller design is based on the data we need for view. As we found that the links and files in review are both stored as URLs, so we only need to list url in reviews.

So We change following methods. Specify changes will be shown in File Change.
# calcutate_average_author_feedback_score
# list_url_in_comments

== ''' Code Changes ''' ==

Here is the file we have changed.

'''1. _review_report.html.erb'''

We add a new column to show average score of feedback score.

<pre style="color: black; border:1px;">



<td align='left'>
<% @response_maps.each_with_index do |ri, index| %>
<% if Team.where(id: ri.reviewee_id).length > 0 %>
<% if index == 0 %>
<div>
<% else %>
<div style="border-top: solid; border-width: 1px;">
<% end %>
<%= calcutate_average_author_feedback_score(@assignment.id, @assignment.max_team_size, ri.id, ri.reviewee_id) %>
</div>
<% end %>
<% end %>
</td>
</pre>

Then we use new-added method to show all link below each Team name.
<pre style="color: black; border:1px;">

<% urls = list_url_in_comments(ri.id)%>
</div>
<% if !urls.nil? %>
<% urls.each_with_index do |url| %>
<%= link_to url.to_s, url %>
<% end %>
<% end %>
</pre>

'''2. review_mapping_helper.rb'''

We first fix ''calcutate_average_author_feedback_score'' method.

<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
def calcutate_average_author_feedback_score(assignment_id, max_team_size, response_map_id, reviewee_id)
review_response = ResponseMap.where(id: response_map_id).try(:first).try(:response).try(:last)
author_feedback_avg_score = "-- / --"
unless review_response.nil?
# Total score of author feedback given by all team members.
author_feedback_total_score = 0
# Max score of author feedback
author_feedback_max_score = 0
# Number of author feedback given by all team members.
author_feedback_count = 0
# For each user in teamsUser find author feedback score.
TeamsUser.where(team_id: reviewee_id).try(:each) do |teamsUser|
user = teamsUser.try(:user)
author = Participant.where(parent_id: assignment_id, user_id: user.id).try(:first) unless user.nil?
feedback_response = ResponseMap.where(reviewed_object_id: review_response.id, reviewer_id: author.id).try(:first).try(:response).try(:last) unless author.nil?
unless feedback_response.nil?
author_feedback_total_score += feedback_response.total_score
author_feedback_max_score = feedback_response.maximum_score
author_feedback_count +=1
end
end
# return "-- / --" if no author feedback, otherwise return avg_score
author_feedback_avg_score = author_feedback_count == 0 ? "-- / --" : "#{author_feedback_total_score/author_feedback_count} / #{author_feedback_max_score}"
end
author_feedback_avg_score
end
</pre>

Then we add a new method called ''list_url_in_comments'' to shown all urls.
<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
# list all urls in comments for each review map
def list_url_in_comments(response_map_id)
response = Response.where(map_id: response_map_id)
# find all comments in each repsonse
Answer.where(response_id: response.ids).try(:each) do |ans|
@comments = ''
@comments += ans.try(:comments)
end
if @comments.nil?
return @comments
end
urls = []
# get every words in the comment
words = @comments.split(" ")
words.each do |element|
# see if it starts with http or https
if element =~ /https?:\/\/[\S]+/
urls.append(element)
end
end
urls
end
</pre>

'''3. review_mapping_helper_spec.rb'''

'''4. review_mapping_spec.rb '''

Finally, we add some tests for the changes made. The specific test cases will be shown in Test Plan.

== ''' Test Plan ''' ==
We will use unit test and functionally test with Rspec, and integration test by using TravisCI and Coveralls bot.

=== Automated Testing Using Rspec ===

As we add new column for Average Author feedback, we add corresponding Rspec test in review_mapping_helper_spec.rb.

<pre style="color: black; border:1px;">
describe "Test assignment review report" do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_button "View"
end

it 'should contain Average Author feedback' do
create(:review_response_map)
expect(page).to have_content('Average Author feedback')
end
end
</pre>

During the testing process, we found that there are no tests for other columns as well.
So we also add some tests for number of reviews completed, length of reviews and summary of reviews in review_mapping_spec.rb

<pre style="color: black; border:1px;">
it "should calculate number of reviews correctly" do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('0/2')
end
</pre>

<pre style="color: black; border:1px;">
it "can show length of reviews", js: true do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

# it should find there is a chart in the view that shows the review length
expect(page).to have_selector("#chart-0")
end

</pre>

<pre style="color: black; border:1px;">
it "can show summary" do
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# add_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
expect(page).to have_content participant_reviewer.user.name

# add_meta_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
click_link('add metareviewer')
add_matareviewer(participant_reviewer2.user.name)
expect(page).to have_content participant_reviewer2.user.name

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('summary')
end
</pre>

=== Coverage ===
The coverage of Coveralls is 24.272% for whole expertiza.

=== Manual UI Testing ===
# Log in as an instructor
# Click Manage and choose Assignments
# Select the Assignment you want to further check, for example, Final project (and design doc)
# Choose review report and click view
# Check "Average Feedback Score" column, for example, student5061 have reviewed Team_BEND_Final_Project and his Average Feedback Score is 13 of total score 15.
# Check urls below each "Team reviewed", for example, student5698 have reviewed Final project(and design doc)_Team_113, and there is a URL about reactkungfu in his review
The anticipated result can be same as below.
[[File:E1979_test_result.png]]

== ''' Team Information ''' ==
Mentor: Mohit Jain

* Mentor: Mohit Jain
* Jing Cai
* Yongjian Zhu
* Weiran Fu
* Dongyuan Wang

===Related Links===
#[https://github.com/aranne/expertiza Forked GitHub Repository]
#[https://github.com/expertiza/expertiza/pull/1628 pull request]
#[https://www.youtube.com/watch?v=kTEgNyljAd8 screencast video]

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T02:00:49Z

Jcai3: /* Related Links */

== ''' Introduction ''' ==
* In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide feedback for this review, called “author feedback.” While grading peer reviews, it would be nice for the instructors to include the author feedback, since it shows how helpful the peer review actually was to the author of the project.

== ''' Current Implementation ''' ==
* Currently, the instructor can only see several information, including numbers of review done, team the student which have reviewed, about author feedback. The current view report can be shown as below.
[[File:Review_report_before.png]]

* However, the instructor has no easy way of seeing the author-feedback scores, so it would be far too much trouble to include them in grades for reviewing.
* So the aim of this project is to build more feedback information into the reviewer report. So that the instructor of the course is able to grade reviewers based on author feedback and review data.

== ''' Problem Statement ''' ==
* We need to implement the integration of review performance which includes:
# # of reviews completed
# Length of reviews
# [Summary of reviews]
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors
# An interactive visualization or table that showed this would be GREAT (We may use “HighChart” javascript library to do it.)

* After analysis the current code, we found that the number of reviews, summary of reviews and visualization of length of reviews have already existed in the system. So we only need to finished the following tasks.
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors

* As the description of our object, the average ratings part of this project has been done last year. And they add a new column (author feedback) to review report. But their functions still have some drawbacks. So we also need to improve the several functions of author feedback.
# Fix code to calculate the average score of feedback
# Make the author feedback column adjust to existing view.

* So here is our plan and solutions to finish this project.
[[File: Feedback_task.png]]

== ''' Project Design''' ==
The basic design of this project can be shown in the UML flow chart below.

[[File: UML_flow_chart.png]]

=== View Improvement ===

* We decide mainly change the page of "Review report" (Log in as an instructor then go to Manage -> Assignments -> View review report.) from three aspects.
# We are planning to add one more column to show the average ratings for feedback for a student's review of a particular assignment. The logic for calculating the average score for the metareviews would be similar to already implemented logic for the "Score Awarded/Average Score" column.
# We are planning to improve the column of review length. Now it is just bare data and average data. We will make the review length into visualized chart by using “HighChart” javascript library. So that length of review will become more clear for instructors. The chart will be shown like below.
# We are planning to add all links which attached to their reviews below Team name. If there are links in the review, the links will be shown below.

=== Controller Improvement ===

The Controller design is based on the data we need for view. We change following method. Specify changes will be shown in File Change.
# calcutate_average_author_feedback_score
# list_url_in_comments

== ''' Code Changes ''' ==

Here is the file we have changed.

'''1. _review_report.html.erb'''

We add a new column to show average score of feedback score.

<pre style="color: black; border:1px;">



<td align='left'>
<% @response_maps.each_with_index do |ri, index| %>
<% if Team.where(id: ri.reviewee_id).length > 0 %>
<% if index == 0 %>
<div>
<% else %>
<div style="border-top: solid; border-width: 1px;">
<% end %>
<%= calcutate_average_author_feedback_score(@assignment.id, @assignment.max_team_size, ri.id, ri.reviewee_id) %>
</div>
<% end %>
<% end %>
</td>
</pre>

Then we use new-added method to show all link below each Team name.
<pre style="color: black; border:1px;">

<% urls = list_url_in_comments(ri.id)%>
</div>
<% if !urls.nil? %>
<% urls.each_with_index do |url| %>
<%= link_to url.to_s, url %>
<% end %>
<% end %>
</pre>

'''2. review_mapping_helper.rb'''

We first fix ''calcutate_average_author_feedback_score'' method.

<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
def calcutate_average_author_feedback_score(assignment_id, max_team_size, response_map_id, reviewee_id)
review_response = ResponseMap.where(id: response_map_id).try(:first).try(:response).try(:last)
author_feedback_avg_score = "-- / --"
unless review_response.nil?
# Total score of author feedback given by all team members.
author_feedback_total_score = 0
# Max score of author feedback
author_feedback_max_score = 0
# Number of author feedback given by all team members.
author_feedback_count = 0
# For each user in teamsUser find author feedback score.
TeamsUser.where(team_id: reviewee_id).try(:each) do |teamsUser|
user = teamsUser.try(:user)
author = Participant.where(parent_id: assignment_id, user_id: user.id).try(:first) unless user.nil?
feedback_response = ResponseMap.where(reviewed_object_id: review_response.id, reviewer_id: author.id).try(:first).try(:response).try(:last) unless author.nil?
unless feedback_response.nil?
author_feedback_total_score += feedback_response.total_score
author_feedback_max_score = feedback_response.maximum_score
author_feedback_count +=1
end
end
# return "-- / --" if no author feedback, otherwise return avg_score
author_feedback_avg_score = author_feedback_count == 0 ? "-- / --" : "#{author_feedback_total_score/author_feedback_count} / #{author_feedback_max_score}"
end
author_feedback_avg_score
end
</pre>

Then we add a new method called ''list_url_in_comments'' to shown all urls.
<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
# list all urls in comments for each review map
def list_url_in_comments(response_map_id)
response = Response.where(map_id: response_map_id)
# find all comments in each repsonse
Answer.where(response_id: response.ids).try(:each) do |ans|
@comments = ''
@comments += ans.try(:comments)
end
if @comments.nil?
return @comments
end
urls = []
# get every words in the comment
words = @comments.split(" ")
words.each do |element|
# see if it starts with http or https
if element =~ /https?:\/\/[\S]+/
urls.append(element)
end
end
urls
end
</pre>

'''3. review_mapping_helper_spec.rb'''

'''4. review_mapping_spec.rb '''

Finally, we add some tests for the changes made. The specific test cases will be shown in Test Plan.

== ''' Test Plan ''' ==
We will use unit test and functionally test with Rspec, and integration test by using TravisCI and Coveralls bot.

=== Automated Testing Using Rspec ===

As we add new column for Average Author feedback, we add corresponding Rspec test in review_mapping_helper_spec.rb.

<pre style="color: black; border:1px;">
describe "Test assignment review report" do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_button "View"
end

it 'should contain Average Author feedback' do
create(:review_response_map)
expect(page).to have_content('Average Author feedback')
end
end
</pre>

During the testing process, we found that there are no tests for other columns as well.
So we also add some tests for number of reviews completed, length of reviews and summary of reviews in review_mapping_spec.rb

<pre style="color: black; border:1px;">
it "should calculate number of reviews correctly" do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('0/2')
end
</pre>

<pre style="color: black; border:1px;">
it "can show length of reviews", js: true do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

# it should find there is a chart in the view that shows the review length
expect(page).to have_selector("#chart-0")
end

</pre>

<pre style="color: black; border:1px;">
it "can show summary" do
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# add_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
expect(page).to have_content participant_reviewer.user.name

# add_meta_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
click_link('add metareviewer')
add_matareviewer(participant_reviewer2.user.name)
expect(page).to have_content participant_reviewer2.user.name

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('summary')
end
</pre>

=== Coverage ===
The coverage of Coveralls is 24.272% for whole expertiza.

=== Manual UI Testing ===
# Log in as an instructor
# Click Manage and choose Assignments
# Select the Assignment you want to further check, for example, Final project (and design doc)
# Choose review report and click view
# Check "Average Feedback Score" column, for example, student5061 have reviewed Team_BEND_Final_Project and his Average Feedback Score is 13 of total score 15.
# Check urls below each "Team reviewed", for example, student5698 have reviewed Final project(and design doc)_Team_113, and there is a URL about reactkungfu in his review
The anticipated result can be same as below.
[[File:E1979_test_result.png]]

== ''' Team Information ''' ==
Mentor: Mohit Jain

* Mentor: Mohit Jain
* Jing Cai
* Yongjian Zhu
* Weiran Fu
* Dongyuan Wang

===Related Links===
#[https://github.com/aranne/expertiza Forked GitHub Repository]
#[https://github.com/expertiza/expertiza/pull/1628 pull request]
#[https://www.youtube.com/watch?v=kTEgNyljAd8 screencast video]

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T01:17:35Z

Jcai3: /* Team Information */

== ''' Introduction ''' ==
* In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide feedback for this review, called “author feedback.” While grading peer reviews, it would be nice for the instructors to include the author feedback, since it shows how helpful the peer review actually was to the author of the project.

== ''' Current Implementation ''' ==
* Currently, the instructor can only see several information, including numbers of review done, team the student which have reviewed, about author feedback. The current view report can be shown as below.
[[File:Review_report_before.png]]

* However, the instructor has no easy way of seeing the author-feedback scores, so it would be far too much trouble to include them in grades for reviewing.
* So the aim of this project is to build more feedback information into the reviewer report. So that the instructor of the course is able to grade reviewers based on author feedback and review data.

== ''' Problem Statement ''' ==
* We need to implement the integration of review performance which includes:
# # of reviews completed
# Length of reviews
# [Summary of reviews]
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors
# An interactive visualization or table that showed this would be GREAT (We may use “HighChart” javascript library to do it.)

* After analysis the current code, we found that the number of reviews, summary of reviews and visualization of length of reviews have already existed in the system. So we only need to finished the following tasks.
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors

* As the description of our object, the average ratings part of this project has been done last year. And they add a new column (author feedback) to review report. But their functions still have some drawbacks. So we also need to improve the several functions of author feedback.
# Fix code to calculate the average score of feedback
# Make the author feedback column adjust to existing view.

* So here is our plan and solutions to finish this project.
[[File: Feedback_task.png]]

== ''' Project Design''' ==
The basic design of this project can be shown in the UML flow chart below.

[[File: UML_flow_chart.png]]

=== View Improvement ===

* We decide mainly change the page of "Review report" (Log in as an instructor then go to Manage -> Assignments -> View review report.) from three aspects.
# We are planning to add one more column to show the average ratings for feedback for a student's review of a particular assignment. The logic for calculating the average score for the metareviews would be similar to already implemented logic for the "Score Awarded/Average Score" column.
# We are planning to improve the column of review length. Now it is just bare data and average data. We will make the review length into visualized chart by using “HighChart” javascript library. So that length of review will become more clear for instructors. The chart will be shown like below.
# We are planning to add all links which attached to their reviews below Team name. If there are links in the review, the links will be shown below.

=== Controller Improvement ===

The Controller design is based on the data we need for view. We change following method. Specify changes will be shown in File Change.
# calcutate_average_author_feedback_score
# list_url_in_comments

== ''' Code Changes ''' ==

Here is the file we have changed.

'''1. _review_report.html.erb'''

We add a new column to show average score of feedback score.

<pre style="color: black; border:1px;">



<td align='left'>
<% @response_maps.each_with_index do |ri, index| %>
<% if Team.where(id: ri.reviewee_id).length > 0 %>
<% if index == 0 %>
<div>
<% else %>
<div style="border-top: solid; border-width: 1px;">
<% end %>
<%= calcutate_average_author_feedback_score(@assignment.id, @assignment.max_team_size, ri.id, ri.reviewee_id) %>
</div>
<% end %>
<% end %>
</td>
</pre>

Then we use new-added method to show all link below each Team name.
<pre style="color: black; border:1px;">

<% urls = list_url_in_comments(ri.id)%>
</div>
<% if !urls.nil? %>
<% urls.each_with_index do |url| %>
<%= link_to url.to_s, url %>
<% end %>
<% end %>
</pre>

'''2. review_mapping_helper.rb'''

We first fix ''calcutate_average_author_feedback_score'' method.

<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
def calcutate_average_author_feedback_score(assignment_id, max_team_size, response_map_id, reviewee_id)
review_response = ResponseMap.where(id: response_map_id).try(:first).try(:response).try(:last)
author_feedback_avg_score = "-- / --"
unless review_response.nil?
# Total score of author feedback given by all team members.
author_feedback_total_score = 0
# Max score of author feedback
author_feedback_max_score = 0
# Number of author feedback given by all team members.
author_feedback_count = 0
# For each user in teamsUser find author feedback score.
TeamsUser.where(team_id: reviewee_id).try(:each) do |teamsUser|
user = teamsUser.try(:user)
author = Participant.where(parent_id: assignment_id, user_id: user.id).try(:first) unless user.nil?
feedback_response = ResponseMap.where(reviewed_object_id: review_response.id, reviewer_id: author.id).try(:first).try(:response).try(:last) unless author.nil?
unless feedback_response.nil?
author_feedback_total_score += feedback_response.total_score
author_feedback_max_score = feedback_response.maximum_score
author_feedback_count +=1
end
end
# return "-- / --" if no author feedback, otherwise return avg_score
author_feedback_avg_score = author_feedback_count == 0 ? "-- / --" : "#{author_feedback_total_score/author_feedback_count} / #{author_feedback_max_score}"
end
author_feedback_avg_score
end
</pre>

Then we add a new method called ''list_url_in_comments'' to shown all urls.
<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
# list all urls in comments for each review map
def list_url_in_comments(response_map_id)
response = Response.where(map_id: response_map_id)
# find all comments in each repsonse
Answer.where(response_id: response.ids).try(:each) do |ans|
@comments = ''
@comments += ans.try(:comments)
end
if @comments.nil?
return @comments
end
urls = []
# get every words in the comment
words = @comments.split(" ")
words.each do |element|
# see if it starts with http or https
if element =~ /https?:\/\/[\S]+/
urls.append(element)
end
end
urls
end
</pre>

'''3. review_mapping_helper_spec.rb'''

'''4. review_mapping_spec.rb '''

Finally, we add some tests for the changes made. The specific test cases will be shown in Test Plan.

== ''' Test Plan ''' ==
We will use unit test and functionally test with Rspec, and integration test by using TravisCI and Coveralls bot.

=== Automated Testing Using Rspec ===

As we add new column for Average Author feedback, we add corresponding Rspec test in review_mapping_helper_spec.rb.

<pre style="color: black; border:1px;">
describe "Test assignment review report" do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_button "View"
end

it 'should contain Average Author feedback' do
create(:review_response_map)
expect(page).to have_content('Average Author feedback')
end
end
</pre>

During the testing process, we found that there are no tests for other columns as well.
So we also add some tests for number of reviews completed, length of reviews and summary of reviews in review_mapping_spec.rb

<pre style="color: black; border:1px;">
it "should calculate number of reviews correctly" do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('0/2')
end
</pre>

<pre style="color: black; border:1px;">
it "can show length of reviews", js: true do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

# it should find there is a chart in the view that shows the review length
expect(page).to have_selector("#chart-0")
end

</pre>

<pre style="color: black; border:1px;">
it "can show summary" do
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# add_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
expect(page).to have_content participant_reviewer.user.name

# add_meta_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
click_link('add metareviewer')
add_matareviewer(participant_reviewer2.user.name)
expect(page).to have_content participant_reviewer2.user.name

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('summary')
end
</pre>

=== Coverage ===
The coverage of Coveralls is 24.272% for whole expertiza.

=== Manual UI Testing ===
# Log in as an instructor
# Click Manage and choose Assignments
# Select the Assignment you want to further check, for example, Final project (and design doc)
# Choose review report and click view
# Check "Average Feedback Score" column, for example, student5061 have reviewed Team_BEND_Final_Project and his Average Feedback Score is 13 of total score 15.
# Check urls below each "Team reviewed", for example, student5698 have reviewed Final project(and design doc)_Team_113, and there is a URL about reactkungfu in his review
The anticipated result can be same as below.
[[File:E1979_test_result.png]]

== ''' Team Information ''' ==
Mentor: Mohit Jain

* Mentor: Mohit Jain
* Jing Cai
* Yongjian Zhu
* Weiran Fu
* Dongyuan Wang

===Related Links===
#[https://github.com/aranne/expertiza Forked GitHub Repository]
#[https://github.com/expertiza/expertiza/pull/1628 pull request]

File:E1979 test result.png

2019-12-07T01:16:46Z

Jcai3: uploaded a new version of "File:E1979 test result.png"

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T01:06:54Z

Jcai3: /* Related Links */

== ''' Introduction ''' ==
* In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide feedback for this review, called “author feedback.” While grading peer reviews, it would be nice for the instructors to include the author feedback, since it shows how helpful the peer review actually was to the author of the project.

== ''' Current Implementation ''' ==
* Currently, the instructor can only see several information, including numbers of review done, team the student which have reviewed, about author feedback. The current view report can be shown as below.
[[File:Review_report_before.png]]

* However, the instructor has no easy way of seeing the author-feedback scores, so it would be far too much trouble to include them in grades for reviewing.
* So the aim of this project is to build more feedback information into the reviewer report. So that the instructor of the course is able to grade reviewers based on author feedback and review data.

== ''' Problem Statement ''' ==
* We need to implement the integration of review performance which includes:
# # of reviews completed
# Length of reviews
# [Summary of reviews]
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors
# An interactive visualization or table that showed this would be GREAT (We may use “HighChart” javascript library to do it.)

* After analysis the current code, we found that the number of reviews, summary of reviews and visualization of length of reviews have already existed in the system. So we only need to finished the following tasks.
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors

* As the description of our object, the average ratings part of this project has been done last year. And they add a new column (author feedback) to review report. But their functions still have some drawbacks. So we also need to improve the several functions of author feedback.
# Fix code to calculate the average score of feedback
# Make the author feedback column adjust to existing view.

* So here is our plan and solutions to finish this project.
[[File: Feedback_task.png]]

== ''' Project Design''' ==
The basic design of this project can be shown in the UML flow chart below.

[[File: UML_flow_chart.png]]

=== View Improvement ===

* We decide mainly change the page of "Review report" (Log in as an instructor then go to Manage -> Assignments -> View review report.) from three aspects.
# We are planning to add one more column to show the average ratings for feedback for a student's review of a particular assignment. The logic for calculating the average score for the metareviews would be similar to already implemented logic for the "Score Awarded/Average Score" column.
# We are planning to improve the column of review length. Now it is just bare data and average data. We will make the review length into visualized chart by using “HighChart” javascript library. So that length of review will become more clear for instructors. The chart will be shown like below.
# We are planning to add all links which attached to their reviews below Team name. If there are links in the review, the links will be shown below.

=== Controller Improvement ===

The Controller design is based on the data we need for view. We change following method. Specify changes will be shown in File Change.
# calcutate_average_author_feedback_score
# list_url_in_comments

== ''' Code Changes ''' ==

Here is the file we have changed.

'''1. _review_report.html.erb'''

We add a new column to show average score of feedback score.

<pre style="color: black; border:1px;">



<td align='left'>
<% @response_maps.each_with_index do |ri, index| %>
<% if Team.where(id: ri.reviewee_id).length > 0 %>
<% if index == 0 %>
<div>
<% else %>
<div style="border-top: solid; border-width: 1px;">
<% end %>
<%= calcutate_average_author_feedback_score(@assignment.id, @assignment.max_team_size, ri.id, ri.reviewee_id) %>
</div>
<% end %>
<% end %>
</td>
</pre>

Then we use new-added method to show all link below each Team name.
<pre style="color: black; border:1px;">

<% urls = list_url_in_comments(ri.id)%>
</div>
<% if !urls.nil? %>
<% urls.each_with_index do |url| %>
<%= link_to url.to_s, url %>
<% end %>
<% end %>
</pre>

'''2. review_mapping_helper.rb'''

We first fix ''calcutate_average_author_feedback_score'' method.

<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
def calcutate_average_author_feedback_score(assignment_id, max_team_size, response_map_id, reviewee_id)
review_response = ResponseMap.where(id: response_map_id).try(:first).try(:response).try(:last)
author_feedback_avg_score = "-- / --"
unless review_response.nil?
# Total score of author feedback given by all team members.
author_feedback_total_score = 0
# Max score of author feedback
author_feedback_max_score = 0
# Number of author feedback given by all team members.
author_feedback_count = 0
# For each user in teamsUser find author feedback score.
TeamsUser.where(team_id: reviewee_id).try(:each) do |teamsUser|
user = teamsUser.try(:user)
author = Participant.where(parent_id: assignment_id, user_id: user.id).try(:first) unless user.nil?
feedback_response = ResponseMap.where(reviewed_object_id: review_response.id, reviewer_id: author.id).try(:first).try(:response).try(:last) unless author.nil?
unless feedback_response.nil?
author_feedback_total_score += feedback_response.total_score
author_feedback_max_score = feedback_response.maximum_score
author_feedback_count +=1
end
end
# return "-- / --" if no author feedback, otherwise return avg_score
author_feedback_avg_score = author_feedback_count == 0 ? "-- / --" : "#{author_feedback_total_score/author_feedback_count} / #{author_feedback_max_score}"
end
author_feedback_avg_score
end
</pre>

Then we add a new method called ''list_url_in_comments'' to shown all urls.
<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
# list all urls in comments for each review map
def list_url_in_comments(response_map_id)
response = Response.where(map_id: response_map_id)
# find all comments in each repsonse
Answer.where(response_id: response.ids).try(:each) do |ans|
@comments = ''
@comments += ans.try(:comments)
end
if @comments.nil?
return @comments
end
urls = []
# get every words in the comment
words = @comments.split(" ")
words.each do |element|
# see if it starts with http or https
if element =~ /https?:\/\/[\S]+/
urls.append(element)
end
end
urls
end
</pre>

'''3. review_mapping_helper_spec.rb'''

'''4. review_mapping_spec.rb '''

Finally, we add some tests for the changes made. The specific test cases will be shown in Test Plan.

== ''' Test Plan ''' ==
We will use unit test and functionally test with Rspec, and integration test by using TravisCI and Coveralls bot.

=== Automated Testing Using Rspec ===

As we add new column for Average Author feedback, we add corresponding Rspec test in review_mapping_helper_spec.rb.

<pre style="color: black; border:1px;">
describe "Test assignment review report" do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_button "View"
end

it 'should contain Average Author feedback' do
create(:review_response_map)
expect(page).to have_content('Average Author feedback')
end
end
</pre>

During the testing process, we found that there are no tests for other columns as well.
So we also add some tests for number of reviews completed, length of reviews and summary of reviews in review_mapping_spec.rb

<pre style="color: black; border:1px;">
it "should calculate number of reviews correctly" do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('0/2')
end
</pre>

<pre style="color: black; border:1px;">
it "can show length of reviews", js: true do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

# it should find there is a chart in the view that shows the review length
expect(page).to have_selector("#chart-0")
end

</pre>

<pre style="color: black; border:1px;">
it "can show summary" do
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# add_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
expect(page).to have_content participant_reviewer.user.name

# add_meta_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
click_link('add metareviewer')
add_matareviewer(participant_reviewer2.user.name)
expect(page).to have_content participant_reviewer2.user.name

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('summary')
end
</pre>

=== Coverage ===
The coverage of Coveralls is 24.272% for whole expertiza.

=== Manual UI Testing ===
# Log in as an instructor
# Click Manage and choose Assignments
# Select the Assignment you want to further check, for example, Final project (and design doc)
# Choose review report and click view
# Check "Average Feedback Score" column, for example, student5061 have reviewed Team_BEND_Final_Project and his Average Feedback Score is 13 of total score 15.
# Check urls below each "Team reviewed", for example, student5698 have reviewed Final project(and design doc)_Team_113, and there is a URL about reactkungfu in his review
The anticipated result can be same as below.
[[File:E1979_test_result.png]]

== ''' Team Information ''' ==
Mentor: Mohit Jain

* Mentor: Mohit Jain ()
* Jing Cai ()
* Yongjian Zhu ()
* Weiran Fu ()
* Dongyuan Wang ()

===Related Links===
#[https://github.com/aranne/expertiza Forked GitHub Repository]
#[https://github.com/expertiza/expertiza/pull/1628 pull request]

File:UML flow chart.png

2019-12-07T00:49:27Z

Jcai3: uploaded a new version of "File:UML flow chart.png"

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T00:46:36Z

Jcai3: /* Project Design */

== ''' Introduction ''' ==
* In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide feedback for this review, called “author feedback.” While grading peer reviews, it would be nice for the instructors to include the author feedback, since it shows how helpful the peer review actually was to the author of the project.

== ''' Current Implementation ''' ==
* Currently, the instructor can only see several information, including numbers of review done, team the student which have reviewed, about author feedback. The current view report can be shown as below.
[[File:Review_report_before.png]]

* However, the instructor has no easy way of seeing the author-feedback scores, so it would be far too much trouble to include them in grades for reviewing.
* So the aim of this project is to build more feedback information into the reviewer report. So that the instructor of the course is able to grade reviewers based on author feedback and review data.

== ''' Problem Statement ''' ==
* We need to implement the integration of review performance which includes:
# # of reviews completed
# Length of reviews
# [Summary of reviews]
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors
# An interactive visualization or table that showed this would be GREAT (We may use “HighChart” javascript library to do it.)

* After analysis the current code, we found that the number of reviews, summary of reviews and visualization of length of reviews have already existed in the system. So we only need to finished the following tasks.
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors

* As the description of our object, the average ratings part of this project has been done last year. And they add a new column (author feedback) to review report. But their functions still have some drawbacks. So we also need to improve the several functions of author feedback.
# Fix code to calculate the average score of feedback
# Make the author feedback column adjust to existing view.

* So here is our plan and solutions to finish this project.
[[File: Feedback_task.png]]

== ''' Project Design''' ==
The basic design of this project can be shown in the UML flow chart below.

[[File: UML_flow_chart.png]]

=== View Improvement ===

* We decide mainly change the page of "Review report" (Log in as an instructor then go to Manage -> Assignments -> View review report.) from three aspects.
# We are planning to add one more column to show the average ratings for feedback for a student's review of a particular assignment. The logic for calculating the average score for the metareviews would be similar to already implemented logic for the "Score Awarded/Average Score" column.
# We are planning to improve the column of review length. Now it is just bare data and average data. We will make the review length into visualized chart by using “HighChart” javascript library. So that length of review will become more clear for instructors. The chart will be shown like below.
# We are planning to add all links which attached to their reviews below Team name. If there are links in the review, the links will be shown below.

=== Controller Improvement ===

The Controller design is based on the data we need for view. We change following method. Specify changes will be shown in File Change.
# calcutate_average_author_feedback_score
# list_url_in_comments

== ''' Code Changes ''' ==

Here is the file we have changed.

'''1. _review_report.html.erb'''

We add a new column to show average score of feedback score.

<pre style="color: black; border:1px;">



<td align='left'>
<% @response_maps.each_with_index do |ri, index| %>
<% if Team.where(id: ri.reviewee_id).length > 0 %>
<% if index == 0 %>
<div>
<% else %>
<div style="border-top: solid; border-width: 1px;">
<% end %>
<%= calcutate_average_author_feedback_score(@assignment.id, @assignment.max_team_size, ri.id, ri.reviewee_id) %>
</div>
<% end %>
<% end %>
</td>
</pre>

Then we use new-added method to show all link below each Team name.
<pre style="color: black; border:1px;">

<% urls = list_url_in_comments(ri.id)%>
</div>
<% if !urls.nil? %>
<% urls.each_with_index do |url| %>
<%= link_to url.to_s, url %>
<% end %>
<% end %>
</pre>

'''2. review_mapping_helper.rb'''

We first fix ''calcutate_average_author_feedback_score'' method.

<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
def calcutate_average_author_feedback_score(assignment_id, max_team_size, response_map_id, reviewee_id)
review_response = ResponseMap.where(id: response_map_id).try(:first).try(:response).try(:last)
author_feedback_avg_score = "-- / --"
unless review_response.nil?
# Total score of author feedback given by all team members.
author_feedback_total_score = 0
# Max score of author feedback
author_feedback_max_score = 0
# Number of author feedback given by all team members.
author_feedback_count = 0
# For each user in teamsUser find author feedback score.
TeamsUser.where(team_id: reviewee_id).try(:each) do |teamsUser|
user = teamsUser.try(:user)
author = Participant.where(parent_id: assignment_id, user_id: user.id).try(:first) unless user.nil?
feedback_response = ResponseMap.where(reviewed_object_id: review_response.id, reviewer_id: author.id).try(:first).try(:response).try(:last) unless author.nil?
unless feedback_response.nil?
author_feedback_total_score += feedback_response.total_score
author_feedback_max_score = feedback_response.maximum_score
author_feedback_count +=1
end
end
# return "-- / --" if no author feedback, otherwise return avg_score
author_feedback_avg_score = author_feedback_count == 0 ? "-- / --" : "#{author_feedback_total_score/author_feedback_count} / #{author_feedback_max_score}"
end
author_feedback_avg_score
end
</pre>

Then we add a new method called ''list_url_in_comments'' to shown all urls.
<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
# list all urls in comments for each review map
def list_url_in_comments(response_map_id)
response = Response.where(map_id: response_map_id)
# find all comments in each repsonse
Answer.where(response_id: response.ids).try(:each) do |ans|
@comments = ''
@comments += ans.try(:comments)
end
if @comments.nil?
return @comments
end
urls = []
# get every words in the comment
words = @comments.split(" ")
words.each do |element|
# see if it starts with http or https
if element =~ /https?:\/\/[\S]+/
urls.append(element)
end
end
urls
end
</pre>

'''3. review_mapping_helper_spec.rb'''

'''4. review_mapping_spec.rb '''

Finally, we add some tests for the changes made. The specific test cases will be shown in Test Plan.

== ''' Test Plan ''' ==
We will use unit test and functionally test with Rspec, and integration test by using TravisCI and Coveralls bot.

=== Automated Testing Using Rspec ===

As we add new column for Average Author feedback, we add corresponding Rspec test in review_mapping_helper_spec.rb.

<pre style="color: black; border:1px;">
describe "Test assignment review report" do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_button "View"
end

it 'should contain Average Author feedback' do
create(:review_response_map)
expect(page).to have_content('Average Author feedback')
end
end
</pre>

During the testing process, we found that there are no tests for other columns as well.
So we also add some tests for number of reviews completed, length of reviews and summary of reviews in review_mapping_spec.rb

<pre style="color: black; border:1px;">
it "should calculate number of reviews correctly" do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('0/2')
end
</pre>

<pre style="color: black; border:1px;">
it "can show length of reviews", js: true do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

# it should find there is a chart in the view that shows the review length
expect(page).to have_selector("#chart-0")
end

</pre>

<pre style="color: black; border:1px;">
it "can show summary" do
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# add_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
expect(page).to have_content participant_reviewer.user.name

# add_meta_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
click_link('add metareviewer')
add_matareviewer(participant_reviewer2.user.name)
expect(page).to have_content participant_reviewer2.user.name

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('summary')
end
</pre>

=== Coverage ===
The coverage of Coveralls is 24.272% for whole expertiza.

=== Manual UI Testing ===
# Log in as an instructor
# Click Manage and choose Assignments
# Select the Assignment you want to further check, for example, Final project (and design doc)
# Choose review report and click view
# Check "Average Feedback Score" column, for example, student5061 have reviewed Team_BEND_Final_Project and his Average Feedback Score is 13 of total score 15.
# Check urls below each "Team reviewed", for example, student5698 have reviewed Final project(and design doc)_Team_113, and there is a URL about reactkungfu in his review
The anticipated result can be same as below.
[[File:E1979_test_result.png]]

== ''' Team Information ''' ==
Mentor: Mohit Jain

* Mentor: Mohit Jain ()
* Jing Cai ()
* Yongjian Zhu ()
* Weiran Fu ()
* Dongyuan Wang ()

===Related Links===
#[https://github.com/aranne/expertiza Forked GitHub Repository]

File:UML flow chart.png

2019-12-07T00:45:13Z

Jcai3: uploaded a new version of "File:UML flow chart.png"

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T00:40:56Z

Jcai3: /* Automated Testing Using Rspec */

== ''' Introduction ''' ==
* In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide feedback for this review, called “author feedback.” While grading peer reviews, it would be nice for the instructors to include the author feedback, since it shows how helpful the peer review actually was to the author of the project.

== ''' Current Implementation ''' ==
* Currently, the instructor can only see several information, including numbers of review done, team the student which have reviewed, about author feedback. The current view report can be shown as below.
[[File:Review_report_before.png]]

* However, the instructor has no easy way of seeing the author-feedback scores, so it would be far too much trouble to include them in grades for reviewing.
* So the aim of this project is to build more feedback information into the reviewer report. So that the instructor of the course is able to grade reviewers based on author feedback and review data.

== ''' Problem Statement ''' ==
* We need to implement the integration of review performance which includes:
# # of reviews completed
# Length of reviews
# [Summary of reviews]
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors
# An interactive visualization or table that showed this would be GREAT (We may use “HighChart” javascript library to do it.)

* After analysis the current code, we found that the number of reviews, summary of reviews and visualization of length of reviews have already existed in the system. So we only need to finished the following tasks.
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors

* As the description of our object, the average ratings part of this project has been done last year. And they add a new column (author feedback) to review report. But their functions still have some drawbacks. So we also need to improve the several functions of author feedback.
# Fix code to calculate the average score of feedback
# Make the author feedback column adjust to existing view.

* So here is our plan and solutions to finish this project.
[[File: Feedback_task.png]]

== ''' Project Design''' ==
The basic design of this project can be shown in the UML flow chart below.

[[File:UML_flow_chart.png]]

=== View Improvement ===

* We decide mainly change the page of "Review report" (Log in as an instructor then go to Manage -> Assignments -> View review report.) from three aspects.
# We are planning to add one more column to show the average ratings for feedback for a student's review of a particular assignment. The logic for calculating the average score for the metareviews would be similar to already implemented logic for the "Score Awarded/Average Score" column.
# We are planning to improve the column of review length. Now it is just bare data and average data. We will make the review length into visualized chart by using “HighChart” javascript library. So that length of review will become more clear for instructors. The chart will be shown like below.
# We are planning to add all links which attached to their reviews below Team name. If there are links in the review, the links will be shown below.

=== Controller Improvement ===

The Controller design is based on the data we need for view. We change following method. Specify changes will be shown in File Change.
# calcutate_average_author_feedback_score
# list_url_in_comments

== ''' Code Changes ''' ==

Here is the file we have changed.

'''1. _review_report.html.erb'''

We add a new column to show average score of feedback score.

<pre style="color: black; border:1px;">



<td align='left'>
<% @response_maps.each_with_index do |ri, index| %>
<% if Team.where(id: ri.reviewee_id).length > 0 %>
<% if index == 0 %>
<div>
<% else %>
<div style="border-top: solid; border-width: 1px;">
<% end %>
<%= calcutate_average_author_feedback_score(@assignment.id, @assignment.max_team_size, ri.id, ri.reviewee_id) %>
</div>
<% end %>
<% end %>
</td>
</pre>

Then we use new-added method to show all link below each Team name.
<pre style="color: black; border:1px;">

<% urls = list_url_in_comments(ri.id)%>
</div>
<% if !urls.nil? %>
<% urls.each_with_index do |url| %>
<%= link_to url.to_s, url %>
<% end %>
<% end %>
</pre>

'''2. review_mapping_helper.rb'''

We first fix ''calcutate_average_author_feedback_score'' method.

<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
def calcutate_average_author_feedback_score(assignment_id, max_team_size, response_map_id, reviewee_id)
review_response = ResponseMap.where(id: response_map_id).try(:first).try(:response).try(:last)
author_feedback_avg_score = "-- / --"
unless review_response.nil?
# Total score of author feedback given by all team members.
author_feedback_total_score = 0
# Max score of author feedback
author_feedback_max_score = 0
# Number of author feedback given by all team members.
author_feedback_count = 0
# For each user in teamsUser find author feedback score.
TeamsUser.where(team_id: reviewee_id).try(:each) do |teamsUser|
user = teamsUser.try(:user)
author = Participant.where(parent_id: assignment_id, user_id: user.id).try(:first) unless user.nil?
feedback_response = ResponseMap.where(reviewed_object_id: review_response.id, reviewer_id: author.id).try(:first).try(:response).try(:last) unless author.nil?
unless feedback_response.nil?
author_feedback_total_score += feedback_response.total_score
author_feedback_max_score = feedback_response.maximum_score
author_feedback_count +=1
end
end
# return "-- / --" if no author feedback, otherwise return avg_score
author_feedback_avg_score = author_feedback_count == 0 ? "-- / --" : "#{author_feedback_total_score/author_feedback_count} / #{author_feedback_max_score}"
end
author_feedback_avg_score
end
</pre>

Then we add a new method called ''list_url_in_comments'' to shown all urls.
<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
# list all urls in comments for each review map
def list_url_in_comments(response_map_id)
response = Response.where(map_id: response_map_id)
# find all comments in each repsonse
Answer.where(response_id: response.ids).try(:each) do |ans|
@comments = ''
@comments += ans.try(:comments)
end
if @comments.nil?
return @comments
end
urls = []
# get every words in the comment
words = @comments.split(" ")
words.each do |element|
# see if it starts with http or https
if element =~ /https?:\/\/[\S]+/
urls.append(element)
end
end
urls
end
</pre>

'''3. review_mapping_helper_spec.rb'''

'''4. review_mapping_spec.rb '''

Finally, we add some tests for the changes made. The specific test cases will be shown in Test Plan.

== ''' Test Plan ''' ==
We will use unit test and functionally test with Rspec, and integration test by using TravisCI and Coveralls bot.

=== Automated Testing Using Rspec ===

As we add new column for Average Author feedback, we add corresponding Rspec test in review_mapping_helper_spec.rb.

<pre style="color: black; border:1px;">
describe "Test assignment review report" do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_button "View"
end

it 'should contain Average Author feedback' do
create(:review_response_map)
expect(page).to have_content('Average Author feedback')
end
end
</pre>

During the testing process, we found that there are no tests for other columns as well.
So we also add some tests for number of reviews completed, length of reviews and summary of reviews in review_mapping_spec.rb

<pre style="color: black; border:1px;">
it "should calculate number of reviews correctly" do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('0/2')
end
</pre>

<pre style="color: black; border:1px;">
it "can show length of reviews", js: true do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

# it should find there is a chart in the view that shows the review length
expect(page).to have_selector("#chart-0")
end

</pre>

<pre style="color: black; border:1px;">
it "can show summary" do
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# add_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
expect(page).to have_content participant_reviewer.user.name

# add_meta_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
click_link('add metareviewer')
add_matareviewer(participant_reviewer2.user.name)
expect(page).to have_content participant_reviewer2.user.name

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('summary')
end
</pre>

=== Coverage ===
The coverage of Coveralls is 24.272% for whole expertiza.

=== Manual UI Testing ===
# Log in as an instructor
# Click Manage and choose Assignments
# Select the Assignment you want to further check, for example, Final project (and design doc)
# Choose review report and click view
# Check "Average Feedback Score" column, for example, student5061 have reviewed Team_BEND_Final_Project and his Average Feedback Score is 13 of total score 15.
# Check urls below each "Team reviewed", for example, student5698 have reviewed Final project(and design doc)_Team_113, and there is a URL about reactkungfu in his review
The anticipated result can be same as below.
[[File:E1979_test_result.png]]

== ''' Team Information ''' ==
Mentor: Mohit Jain

* Mentor: Mohit Jain ()
* Jing Cai ()
* Yongjian Zhu ()
* Weiran Fu ()
* Dongyuan Wang ()

===Related Links===
#[https://github.com/aranne/expertiza Forked GitHub Repository]

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T00:36:51Z

Jcai3: /* Automated Testing Using Rspec */

== ''' Introduction ''' ==
* In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide feedback for this review, called “author feedback.” While grading peer reviews, it would be nice for the instructors to include the author feedback, since it shows how helpful the peer review actually was to the author of the project.

== ''' Current Implementation ''' ==
* Currently, the instructor can only see several information, including numbers of review done, team the student which have reviewed, about author feedback. The current view report can be shown as below.
[[File:Review_report_before.png]]

* However, the instructor has no easy way of seeing the author-feedback scores, so it would be far too much trouble to include them in grades for reviewing.
* So the aim of this project is to build more feedback information into the reviewer report. So that the instructor of the course is able to grade reviewers based on author feedback and review data.

== ''' Problem Statement ''' ==
* We need to implement the integration of review performance which includes:
# # of reviews completed
# Length of reviews
# [Summary of reviews]
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors
# An interactive visualization or table that showed this would be GREAT (We may use “HighChart” javascript library to do it.)

* After analysis the current code, we found that the number of reviews, summary of reviews and visualization of length of reviews have already existed in the system. So we only need to finished the following tasks.
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors

* As the description of our object, the average ratings part of this project has been done last year. And they add a new column (author feedback) to review report. But their functions still have some drawbacks. So we also need to improve the several functions of author feedback.
# Fix code to calculate the average score of feedback
# Make the author feedback column adjust to existing view.

* So here is our plan and solutions to finish this project.
[[File: Feedback_task.png]]

== ''' Project Design''' ==
The basic design of this project can be shown in the UML flow chart below.

[[File:UML_flow_chart.png]]

=== View Improvement ===

* We decide mainly change the page of "Review report" (Log in as an instructor then go to Manage -> Assignments -> View review report.) from three aspects.
# We are planning to add one more column to show the average ratings for feedback for a student's review of a particular assignment. The logic for calculating the average score for the metareviews would be similar to already implemented logic for the "Score Awarded/Average Score" column.
# We are planning to improve the column of review length. Now it is just bare data and average data. We will make the review length into visualized chart by using “HighChart” javascript library. So that length of review will become more clear for instructors. The chart will be shown like below.
# We are planning to add all links which attached to their reviews below Team name. If there are links in the review, the links will be shown below.

=== Controller Improvement ===

The Controller design is based on the data we need for view. We change following method. Specify changes will be shown in File Change.
# calcutate_average_author_feedback_score
# list_url_in_comments

== ''' Code Changes ''' ==

Here is the file we have changed.

'''1. _review_report.html.erb'''

We add a new column to show average score of feedback score.

<pre style="color: black; border:1px;">



<td align='left'>
<% @response_maps.each_with_index do |ri, index| %>
<% if Team.where(id: ri.reviewee_id).length > 0 %>
<% if index == 0 %>
<div>
<% else %>
<div style="border-top: solid; border-width: 1px;">
<% end %>
<%= calcutate_average_author_feedback_score(@assignment.id, @assignment.max_team_size, ri.id, ri.reviewee_id) %>
</div>
<% end %>
<% end %>
</td>
</pre>

Then we use new-added method to show all link below each Team name.
<pre style="color: black; border:1px;">

<% urls = list_url_in_comments(ri.id)%>
</div>
<% if !urls.nil? %>
<% urls.each_with_index do |url| %>
<%= link_to url.to_s, url %>
<% end %>
<% end %>
</pre>

'''2. review_mapping_helper.rb'''

We first fix ''calcutate_average_author_feedback_score'' method.

<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
def calcutate_average_author_feedback_score(assignment_id, max_team_size, response_map_id, reviewee_id)
review_response = ResponseMap.where(id: response_map_id).try(:first).try(:response).try(:last)
author_feedback_avg_score = "-- / --"
unless review_response.nil?
# Total score of author feedback given by all team members.
author_feedback_total_score = 0
# Max score of author feedback
author_feedback_max_score = 0
# Number of author feedback given by all team members.
author_feedback_count = 0
# For each user in teamsUser find author feedback score.
TeamsUser.where(team_id: reviewee_id).try(:each) do |teamsUser|
user = teamsUser.try(:user)
author = Participant.where(parent_id: assignment_id, user_id: user.id).try(:first) unless user.nil?
feedback_response = ResponseMap.where(reviewed_object_id: review_response.id, reviewer_id: author.id).try(:first).try(:response).try(:last) unless author.nil?
unless feedback_response.nil?
author_feedback_total_score += feedback_response.total_score
author_feedback_max_score = feedback_response.maximum_score
author_feedback_count +=1
end
end
# return "-- / --" if no author feedback, otherwise return avg_score
author_feedback_avg_score = author_feedback_count == 0 ? "-- / --" : "#{author_feedback_total_score/author_feedback_count} / #{author_feedback_max_score}"
end
author_feedback_avg_score
end
</pre>

Then we add a new method called ''list_url_in_comments'' to shown all urls.
<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
# list all urls in comments for each review map
def list_url_in_comments(response_map_id)
response = Response.where(map_id: response_map_id)
# find all comments in each repsonse
Answer.where(response_id: response.ids).try(:each) do |ans|
@comments = ''
@comments += ans.try(:comments)
end
if @comments.nil?
return @comments
end
urls = []
# get every words in the comment
words = @comments.split(" ")
words.each do |element|
# see if it starts with http or https
if element =~ /https?:\/\/[\S]+/
urls.append(element)
end
end
urls
end
</pre>

'''3. review_mapping_helper_spec.rb'''

'''4. review_mapping_spec.rb '''

Finally, we add some tests for the changes made. The specific test cases will be shown in Test Plan.

== ''' Test Plan ''' ==
We will use unit test and functionally test with Rspec, and integration test by using TravisCI and Coveralls bot.

=== Automated Testing Using Rspec ===
# '''Controller logic''':

As we change two methods, we created corresponding tests for them in review_mapping_helper_spec.rb.

<pre style="color: black; border:1px;">
describe "Test assignment review report" do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_button "View"
end

it 'should contain Average Author feedback' do
create(:review_response_map)
expect(page).to have_content('Average Author feedback')
end
end
</pre>

# '''View logic''':

We added Rspec tests in review_mapping_spec.rb which tests average feedback score column.
During the coding process, we found that there are no tests for other columns as well.
So we also add some tests for number of reviews completed, length of reviews and summary of reviews.

<pre style="color: black; border:1px;">
it "should calculate number of reviews correctly" do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('0/2')
end
</pre>

<pre style="color: black; border:1px;">
it "can show length of reviews", js: true do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

# it should find there is a chart in the view that shows the review length
expect(page).to have_selector("#chart-0")
end

</pre>

<pre style="color: black; border:1px;">
it "can show summary" do
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# add_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
expect(page).to have_content participant_reviewer.user.name

# add_meta_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
click_link('add metareviewer')
add_matareviewer(participant_reviewer2.user.name)
expect(page).to have_content participant_reviewer2.user.name

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('summary')
end
</pre>

=== Coverage ===
The coverage of Coveralls is 24.272% for whole expertiza.

=== Manual UI Testing ===
# Log in as an instructor
# Click Manage and choose Assignments
# Select the Assignment you want to further check, for example, Final project (and design doc)
# Choose review report and click view
# Check "Average Feedback Score" column, for example, student5061 have reviewed Team_BEND_Final_Project and his Average Feedback Score is 13 of total score 15.
# Check urls below each "Team reviewed", for example, student5698 have reviewed Final project(and design doc)_Team_113, and there is a URL about reactkungfu in his review
The anticipated result can be same as below.
[[File:E1979_test_result.png]]

== ''' Team Information ''' ==
Mentor: Mohit Jain

* Mentor: Mohit Jain ()
* Jing Cai ()
* Yongjian Zhu ()
* Weiran Fu ()
* Dongyuan Wang ()

===Related Links===
#[https://github.com/aranne/expertiza Forked GitHub Repository]

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T00:35:46Z

Jcai3: /* Manual UI Testing */

== ''' Introduction ''' ==
* In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide feedback for this review, called “author feedback.” While grading peer reviews, it would be nice for the instructors to include the author feedback, since it shows how helpful the peer review actually was to the author of the project.

== ''' Current Implementation ''' ==
* Currently, the instructor can only see several information, including numbers of review done, team the student which have reviewed, about author feedback. The current view report can be shown as below.
[[File:Review_report_before.png]]

* However, the instructor has no easy way of seeing the author-feedback scores, so it would be far too much trouble to include them in grades for reviewing.
* So the aim of this project is to build more feedback information into the reviewer report. So that the instructor of the course is able to grade reviewers based on author feedback and review data.

== ''' Problem Statement ''' ==
* We need to implement the integration of review performance which includes:
# # of reviews completed
# Length of reviews
# [Summary of reviews]
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors
# An interactive visualization or table that showed this would be GREAT (We may use “HighChart” javascript library to do it.)

* After analysis the current code, we found that the number of reviews, summary of reviews and visualization of length of reviews have already existed in the system. So we only need to finished the following tasks.
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors

* As the description of our object, the average ratings part of this project has been done last year. And they add a new column (author feedback) to review report. But their functions still have some drawbacks. So we also need to improve the several functions of author feedback.
# Fix code to calculate the average score of feedback
# Make the author feedback column adjust to existing view.

* So here is our plan and solutions to finish this project.
[[File: Feedback_task.png]]

== ''' Project Design''' ==
The basic design of this project can be shown in the UML flow chart below.

[[File:UML_flow_chart.png]]

=== View Improvement ===

* We decide mainly change the page of "Review report" (Log in as an instructor then go to Manage -> Assignments -> View review report.) from three aspects.
# We are planning to add one more column to show the average ratings for feedback for a student's review of a particular assignment. The logic for calculating the average score for the metareviews would be similar to already implemented logic for the "Score Awarded/Average Score" column.
# We are planning to improve the column of review length. Now it is just bare data and average data. We will make the review length into visualized chart by using “HighChart” javascript library. So that length of review will become more clear for instructors. The chart will be shown like below.
# We are planning to add all links which attached to their reviews below Team name. If there are links in the review, the links will be shown below.

=== Controller Improvement ===

The Controller design is based on the data we need for view. We change following method. Specify changes will be shown in File Change.
# calcutate_average_author_feedback_score
# list_url_in_comments

== ''' Code Changes ''' ==

Here is the file we have changed.

'''1. _review_report.html.erb'''

We add a new column to show average score of feedback score.

<pre style="color: black; border:1px;">



<td align='left'>
<% @response_maps.each_with_index do |ri, index| %>
<% if Team.where(id: ri.reviewee_id).length > 0 %>
<% if index == 0 %>
<div>
<% else %>
<div style="border-top: solid; border-width: 1px;">
<% end %>
<%= calcutate_average_author_feedback_score(@assignment.id, @assignment.max_team_size, ri.id, ri.reviewee_id) %>
</div>
<% end %>
<% end %>
</td>
</pre>

Then we use new-added method to show all link below each Team name.
<pre style="color: black; border:1px;">

<% urls = list_url_in_comments(ri.id)%>
</div>
<% if !urls.nil? %>
<% urls.each_with_index do |url| %>
<%= link_to url.to_s, url %>
<% end %>
<% end %>
</pre>

'''2. review_mapping_helper.rb'''

We first fix ''calcutate_average_author_feedback_score'' method.

<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
def calcutate_average_author_feedback_score(assignment_id, max_team_size, response_map_id, reviewee_id)
review_response = ResponseMap.where(id: response_map_id).try(:first).try(:response).try(:last)
author_feedback_avg_score = "-- / --"
unless review_response.nil?
# Total score of author feedback given by all team members.
author_feedback_total_score = 0
# Max score of author feedback
author_feedback_max_score = 0
# Number of author feedback given by all team members.
author_feedback_count = 0
# For each user in teamsUser find author feedback score.
TeamsUser.where(team_id: reviewee_id).try(:each) do |teamsUser|
user = teamsUser.try(:user)
author = Participant.where(parent_id: assignment_id, user_id: user.id).try(:first) unless user.nil?
feedback_response = ResponseMap.where(reviewed_object_id: review_response.id, reviewer_id: author.id).try(:first).try(:response).try(:last) unless author.nil?
unless feedback_response.nil?
author_feedback_total_score += feedback_response.total_score
author_feedback_max_score = feedback_response.maximum_score
author_feedback_count +=1
end
end
# return "-- / --" if no author feedback, otherwise return avg_score
author_feedback_avg_score = author_feedback_count == 0 ? "-- / --" : "#{author_feedback_total_score/author_feedback_count} / #{author_feedback_max_score}"
end
author_feedback_avg_score
end
</pre>

Then we add a new method called ''list_url_in_comments'' to shown all urls.
<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
# list all urls in comments for each review map
def list_url_in_comments(response_map_id)
response = Response.where(map_id: response_map_id)
# find all comments in each repsonse
Answer.where(response_id: response.ids).try(:each) do |ans|
@comments = ''
@comments += ans.try(:comments)
end
if @comments.nil?
return @comments
end
urls = []
# get every words in the comment
words = @comments.split(" ")
words.each do |element|
# see if it starts with http or https
if element =~ /https?:\/\/[\S]+/
urls.append(element)
end
end
urls
end
</pre>

'''3. review_mapping_helper_spec.rb'''

'''4. review_mapping_spec.rb '''

Finally, we add some tests for the changes made. The specific test cases will be shown in Test Plan.

== ''' Test Plan ''' ==
We will use unit test and functionally test with Rspec, and integration test by using TravisCI and Coveralls bot.

=== Automated Testing Using Rspec ===
# '''Controller logic''':

As we change two methods, we created corresponding tests for them in review_mapping_helper_spec.rb.

<pre style="color: black; border:1px;">
describe "Test assignment review report" do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_button "View"
end

it 'should contain Average Author feedback' do
create(:review_response_map)
expect(page).to have_content('Average Author feedback')
end
end
</pre>

# '''View logic''':

We added Rspec tests in review_mapping_spec.rb which tests average feedback score column.
During the coding process, we found that there are no tests for other columns as well.
So we also add some tests for number of reviews completed, length of reviews and summary of reviews.

<pre style="color: black; border:1px;">
it "should calculate number of reviews correctly" do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('0/2')
end

it "can show length of reviews", js: true do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

# it should find there is a chart in the view that shows the review length
expect(page).to have_selector("#chart-0")
end

it "can show summary" do
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# add_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
expect(page).to have_content participant_reviewer.user.name

# add_meta_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
click_link('add metareviewer')
add_matareviewer(participant_reviewer2.user.name)
expect(page).to have_content participant_reviewer2.user.name

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('summary')
end
</pre>

=== Coverage ===
The coverage of Coveralls is 24.272% for whole expertiza.

=== Manual UI Testing ===
# Log in as an instructor
# Click Manage and choose Assignments
# Select the Assignment you want to further check, for example, Final project (and design doc)
# Choose review report and click view
# Check "Average Feedback Score" column, for example, student5061 have reviewed Team_BEND_Final_Project and his Average Feedback Score is 13 of total score 15.
# Check urls below each "Team reviewed", for example, student5698 have reviewed Final project(and design doc)_Team_113, and there is a URL about reactkungfu in his review
The anticipated result can be same as below.
[[File:E1979_test_result.png]]

== ''' Team Information ''' ==
Mentor: Mohit Jain

* Mentor: Mohit Jain ()
* Jing Cai ()
* Yongjian Zhu ()
* Weiran Fu ()
* Dongyuan Wang ()

===Related Links===
#[https://github.com/aranne/expertiza Forked GitHub Repository]

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T00:29:18Z

Jcai3: /* Coverage */

== ''' Introduction ''' ==
* In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide feedback for this review, called “author feedback.” While grading peer reviews, it would be nice for the instructors to include the author feedback, since it shows how helpful the peer review actually was to the author of the project.

== ''' Current Implementation ''' ==
* Currently, the instructor can only see several information, including numbers of review done, team the student which have reviewed, about author feedback. The current view report can be shown as below.
[[File:Review_report_before.png]]

* However, the instructor has no easy way of seeing the author-feedback scores, so it would be far too much trouble to include them in grades for reviewing.
* So the aim of this project is to build more feedback information into the reviewer report. So that the instructor of the course is able to grade reviewers based on author feedback and review data.

== ''' Problem Statement ''' ==
* We need to implement the integration of review performance which includes:
# # of reviews completed
# Length of reviews
# [Summary of reviews]
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors
# An interactive visualization or table that showed this would be GREAT (We may use “HighChart” javascript library to do it.)

* After analysis the current code, we found that the number of reviews, summary of reviews and visualization of length of reviews have already existed in the system. So we only need to finished the following tasks.
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors

* As the description of our object, the average ratings part of this project has been done last year. And they add a new column (author feedback) to review report. But their functions still have some drawbacks. So we also need to improve the several functions of author feedback.
# Fix code to calculate the average score of feedback
# Make the author feedback column adjust to existing view.

* So here is our plan and solutions to finish this project.
[[File: Feedback_task.png]]

== ''' Project Design''' ==
The basic design of this project can be shown in the UML flow chart below.

[[File:UML_flow_chart.png]]

=== View Improvement ===

* We decide mainly change the page of "Review report" (Log in as an instructor then go to Manage -> Assignments -> View review report.) from three aspects.
# We are planning to add one more column to show the average ratings for feedback for a student's review of a particular assignment. The logic for calculating the average score for the metareviews would be similar to already implemented logic for the "Score Awarded/Average Score" column.
# We are planning to improve the column of review length. Now it is just bare data and average data. We will make the review length into visualized chart by using “HighChart” javascript library. So that length of review will become more clear for instructors. The chart will be shown like below.
# We are planning to add all links which attached to their reviews below Team name. If there are links in the review, the links will be shown below.

=== Controller Improvement ===

The Controller design is based on the data we need for view. We change following method. Specify changes will be shown in File Change.
# calcutate_average_author_feedback_score
# list_url_in_comments

== ''' Code Changes ''' ==

Here is the file we have changed.

'''1. _review_report.html.erb'''

We add a new column to show average score of feedback score.

<pre style="color: black; border:1px;">



<td align='left'>
<% @response_maps.each_with_index do |ri, index| %>
<% if Team.where(id: ri.reviewee_id).length > 0 %>
<% if index == 0 %>
<div>
<% else %>
<div style="border-top: solid; border-width: 1px;">
<% end %>
<%= calcutate_average_author_feedback_score(@assignment.id, @assignment.max_team_size, ri.id, ri.reviewee_id) %>
</div>
<% end %>
<% end %>
</td>
</pre>

Then we use new-added method to show all link below each Team name.
<pre style="color: black; border:1px;">

<% urls = list_url_in_comments(ri.id)%>
</div>
<% if !urls.nil? %>
<% urls.each_with_index do |url| %>
<%= link_to url.to_s, url %>
<% end %>
<% end %>
</pre>

'''2. review_mapping_helper.rb'''

We first fix ''calcutate_average_author_feedback_score'' method.

<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
def calcutate_average_author_feedback_score(assignment_id, max_team_size, response_map_id, reviewee_id)
review_response = ResponseMap.where(id: response_map_id).try(:first).try(:response).try(:last)
author_feedback_avg_score = "-- / --"
unless review_response.nil?
# Total score of author feedback given by all team members.
author_feedback_total_score = 0
# Max score of author feedback
author_feedback_max_score = 0
# Number of author feedback given by all team members.
author_feedback_count = 0
# For each user in teamsUser find author feedback score.
TeamsUser.where(team_id: reviewee_id).try(:each) do |teamsUser|
user = teamsUser.try(:user)
author = Participant.where(parent_id: assignment_id, user_id: user.id).try(:first) unless user.nil?
feedback_response = ResponseMap.where(reviewed_object_id: review_response.id, reviewer_id: author.id).try(:first).try(:response).try(:last) unless author.nil?
unless feedback_response.nil?
author_feedback_total_score += feedback_response.total_score
author_feedback_max_score = feedback_response.maximum_score
author_feedback_count +=1
end
end
# return "-- / --" if no author feedback, otherwise return avg_score
author_feedback_avg_score = author_feedback_count == 0 ? "-- / --" : "#{author_feedback_total_score/author_feedback_count} / #{author_feedback_max_score}"
end
author_feedback_avg_score
end
</pre>

Then we add a new method called ''list_url_in_comments'' to shown all urls.
<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
# list all urls in comments for each review map
def list_url_in_comments(response_map_id)
response = Response.where(map_id: response_map_id)
# find all comments in each repsonse
Answer.where(response_id: response.ids).try(:each) do |ans|
@comments = ''
@comments += ans.try(:comments)
end
if @comments.nil?
return @comments
end
urls = []
# get every words in the comment
words = @comments.split(" ")
words.each do |element|
# see if it starts with http or https
if element =~ /https?:\/\/[\S]+/
urls.append(element)
end
end
urls
end
</pre>

'''3. review_mapping_helper_spec.rb'''

'''4. review_mapping_spec.rb '''

Finally, we add some tests for the changes made. The specific test cases will be shown in Test Plan.

== ''' Test Plan ''' ==
We will use unit test and functionally test with Rspec, and integration test by using TravisCI and Coveralls bot.

=== Automated Testing Using Rspec ===
# '''Controller logic''':

As we change two methods, we created corresponding tests for them in review_mapping_helper_spec.rb.

<pre style="color: black; border:1px;">
describe "Test assignment review report" do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_button "View"
end

it 'should contain Average Author feedback' do
create(:review_response_map)
expect(page).to have_content('Average Author feedback')
end
end
</pre>

# '''View logic''':

We added Rspec tests in review_mapping_spec.rb which tests average feedback score column.
During the coding process, we found that there are no tests for other columns as well.
So we also add some tests for number of reviews completed, length of reviews and summary of reviews.

<pre style="color: black; border:1px;">
it "should calculate number of reviews correctly" do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('0/2')
end

it "can show length of reviews", js: true do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

# it should find there is a chart in the view that shows the review length
expect(page).to have_selector("#chart-0")
end

it "can show summary" do
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# add_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
expect(page).to have_content participant_reviewer.user.name

# add_meta_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
click_link('add metareviewer')
add_matareviewer(participant_reviewer2.user.name)
expect(page).to have_content participant_reviewer2.user.name

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('summary')
end
</pre>

=== Coverage ===
The coverage of Coveralls is 24.272% for whole expertiza.

=== Manual UI Testing ===
# Log in as an instructor
# Click Manage and choose Assignments
# Choose review report and click view
# Check "Average Feedback Score" column
# Check urls below each "Team reviewed"

The anticipated result can be same as below.
[[File:E1979_test_result.png]]

== ''' Team Information ''' ==
Mentor: Mohit Jain

* Mentor: Mohit Jain ()
* Jing Cai ()
* Yongjian Zhu ()
* Weiran Fu ()
* Dongyuan Wang ()

===Related Links===
#[https://github.com/aranne/expertiza Forked GitHub Repository]

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T00:26:18Z

Jcai3: /* Test Plan */

== ''' Introduction ''' ==
* In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide feedback for this review, called “author feedback.” While grading peer reviews, it would be nice for the instructors to include the author feedback, since it shows how helpful the peer review actually was to the author of the project.

== ''' Current Implementation ''' ==
* Currently, the instructor can only see several information, including numbers of review done, team the student which have reviewed, about author feedback. The current view report can be shown as below.
[[File:Review_report_before.png]]

* However, the instructor has no easy way of seeing the author-feedback scores, so it would be far too much trouble to include them in grades for reviewing.
* So the aim of this project is to build more feedback information into the reviewer report. So that the instructor of the course is able to grade reviewers based on author feedback and review data.

== ''' Problem Statement ''' ==
* We need to implement the integration of review performance which includes:
# # of reviews completed
# Length of reviews
# [Summary of reviews]
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors
# An interactive visualization or table that showed this would be GREAT (We may use “HighChart” javascript library to do it.)

* After analysis the current code, we found that the number of reviews, summary of reviews and visualization of length of reviews have already existed in the system. So we only need to finished the following tasks.
# Whether reviewers added a file or link to their review
# The average ratings they received from the authors

* As the description of our object, the average ratings part of this project has been done last year. And they add a new column (author feedback) to review report. But their functions still have some drawbacks. So we also need to improve the several functions of author feedback.
# Fix code to calculate the average score of feedback
# Make the author feedback column adjust to existing view.

* So here is our plan and solutions to finish this project.
[[File: Feedback_task.png]]

== ''' Project Design''' ==
The basic design of this project can be shown in the UML flow chart below.

[[File:UML_flow_chart.png]]

=== View Improvement ===

* We decide mainly change the page of "Review report" (Log in as an instructor then go to Manage -> Assignments -> View review report.) from three aspects.
# We are planning to add one more column to show the average ratings for feedback for a student's review of a particular assignment. The logic for calculating the average score for the metareviews would be similar to already implemented logic for the "Score Awarded/Average Score" column.
# We are planning to improve the column of review length. Now it is just bare data and average data. We will make the review length into visualized chart by using “HighChart” javascript library. So that length of review will become more clear for instructors. The chart will be shown like below.
# We are planning to add all links which attached to their reviews below Team name. If there are links in the review, the links will be shown below.

=== Controller Improvement ===

The Controller design is based on the data we need for view. We change following method. Specify changes will be shown in File Change.
# calcutate_average_author_feedback_score
# list_url_in_comments

== ''' Code Changes ''' ==

Here is the file we have changed.

'''1. _review_report.html.erb'''

We add a new column to show average score of feedback score.

<pre style="color: black; border:1px;">



<td align='left'>
<% @response_maps.each_with_index do |ri, index| %>
<% if Team.where(id: ri.reviewee_id).length > 0 %>
<% if index == 0 %>
<div>
<% else %>
<div style="border-top: solid; border-width: 1px;">
<% end %>
<%= calcutate_average_author_feedback_score(@assignment.id, @assignment.max_team_size, ri.id, ri.reviewee_id) %>
</div>
<% end %>
<% end %>
</td>
</pre>

Then we use new-added method to show all link below each Team name.
<pre style="color: black; border:1px;">

<% urls = list_url_in_comments(ri.id)%>
</div>
<% if !urls.nil? %>
<% urls.each_with_index do |url| %>
<%= link_to url.to_s, url %>
<% end %>
<% end %>
</pre>

'''2. review_mapping_helper.rb'''

We first fix ''calcutate_average_author_feedback_score'' method.

<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
def calcutate_average_author_feedback_score(assignment_id, max_team_size, response_map_id, reviewee_id)
review_response = ResponseMap.where(id: response_map_id).try(:first).try(:response).try(:last)
author_feedback_avg_score = "-- / --"
unless review_response.nil?
# Total score of author feedback given by all team members.
author_feedback_total_score = 0
# Max score of author feedback
author_feedback_max_score = 0
# Number of author feedback given by all team members.
author_feedback_count = 0
# For each user in teamsUser find author feedback score.
TeamsUser.where(team_id: reviewee_id).try(:each) do |teamsUser|
user = teamsUser.try(:user)
author = Participant.where(parent_id: assignment_id, user_id: user.id).try(:first) unless user.nil?
feedback_response = ResponseMap.where(reviewed_object_id: review_response.id, reviewer_id: author.id).try(:first).try(:response).try(:last) unless author.nil?
unless feedback_response.nil?
author_feedback_total_score += feedback_response.total_score
author_feedback_max_score = feedback_response.maximum_score
author_feedback_count +=1
end
end
# return "-- / --" if no author feedback, otherwise return avg_score
author_feedback_avg_score = author_feedback_count == 0 ? "-- / --" : "#{author_feedback_total_score/author_feedback_count} / #{author_feedback_max_score}"
end
author_feedback_avg_score
end
</pre>

Then we add a new method called ''list_url_in_comments'' to shown all urls.
<pre style="color: black; border:1px;">
# E1979: Completion/Progress view changes
# list all urls in comments for each review map
def list_url_in_comments(response_map_id)
response = Response.where(map_id: response_map_id)
# find all comments in each repsonse
Answer.where(response_id: response.ids).try(:each) do |ans|
@comments = ''
@comments += ans.try(:comments)
end
if @comments.nil?
return @comments
end
urls = []
# get every words in the comment
words = @comments.split(" ")
words.each do |element|
# see if it starts with http or https
if element =~ /https?:\/\/[\S]+/
urls.append(element)
end
end
urls
end
</pre>

'''3. review_mapping_helper_spec.rb'''

'''4. review_mapping_spec.rb '''

Finally, we add some tests for the changes made. The specific test cases will be shown in Test Plan.

== ''' Test Plan ''' ==
We will use unit test and functionally test with Rspec, and integration test by using TravisCI and Coveralls bot.

=== Automated Testing Using Rspec ===
# '''Controller logic''':

As we change two methods, we created corresponding tests for them in review_mapping_helper_spec.rb.

<pre style="color: black; border:1px;">
describe "Test assignment review report" do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_button "View"
end

it 'should contain Average Author feedback' do
create(:review_response_map)
expect(page).to have_content('Average Author feedback')
end
end
</pre>

# '''View logic''':

We added Rspec tests in review_mapping_spec.rb which tests average feedback score column.
During the coding process, we found that there are no tests for other columns as well.
So we also add some tests for number of reviews completed, length of reviews and summary of reviews.

<pre style="color: black; border:1px;">
it "should calculate number of reviews correctly" do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('0/2')
end

it "can show length of reviews", js: true do
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "submission").first, due_at: DateTime.now.in_time_zone + 1.day)
create(:assignment_due_date, deadline_type: DeadlineType.where(name: "review").first, due_at: DateTime.now.in_time_zone + 1.day)
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# assign 2 reviews to student 4
visit "/review_mapping/select_reviewer?contributor_id=1&id=1"
add_reviewer("student4")
visit "/review_mapping/select_reviewer?contributor_id=3&id=1"
add_reviewer("student4")

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

# it should find there is a chart in the view that shows the review length
expect(page).to have_selector("#chart-0")
end

it "can show summary" do
participant_reviewer = create :participant, assignment: @assignment
participant_reviewer2 = create :participant, assignment: @assignment
login_as("instructor6")
visit "/review_mapping/list_mappings?id=#{@assignment.id}"

# add_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
expect(page).to have_content participant_reviewer.user.name

# add_meta_reviewer
first(:link, 'add reviewer').click
add_reviewer(participant_reviewer.user.name)
click_link('add metareviewer')
add_matareviewer(participant_reviewer2.user.name)
expect(page).to have_content participant_reviewer2.user.name

visit "/reports/response_report?id=#{@assignment.id}"
click_button "View"

expect(page).to have_content('summary')
end
</pre>

=== Coverage ===
The coverage of Coveralls bot will be filled after our finish all our work.

=== Manual UI Testing ===
# Log in as an instructor
# Click Manage and choose Assignments
# Choose review report and click view
# Check "Average Feedback Score" column
# Check urls below each "Team reviewed"

The anticipated result can be same as below.
[[File:E1979_test_result.png]]

== ''' Team Information ''' ==
Mentor: Mohit Jain

* Mentor: Mohit Jain ()
* Jing Cai ()
* Yongjian Zhu ()
* Weiran Fu ()
* Dongyuan Wang ()

===Related Links===
#[https://github.com/aranne/expertiza Forked GitHub Repository]

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T00:16:21Z

Jcai3: /* Automated Testing Using Rspec */

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T00:16:01Z

Jcai3: /* Code Changes */

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T00:15:50Z

Jcai3: /* Code Changes */

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T00:13:28Z

Jcai3: /* Code Changes */

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T00:12:44Z

Jcai3: /* Problem Statement */

File:Feedback task.png

2019-12-07T00:12:06Z

Jcai3: uploaded a new version of "File:Feedback task.png"

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T00:09:46Z

Jcai3: /* Problem Statement */

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T00:09:12Z

Jcai3: /* Problem Statement */

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T00:08:47Z

Jcai3: /* Problem Statement */

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T00:06:55Z

Jcai3: /* Problem Statement */

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-07T00:06:07Z

Jcai3: /* Problem Statement */

File:Feedback task.png

2019-12-07T00:05:01Z

Jcai3: uploaded a new version of "File:Feedback task.png"

File:Feedback task.png

2019-12-07T00:04:23Z

Jcai3: uploaded a new version of "File:Feedback task.png"

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-06T23:59:08Z

Jcai3: /* Problem Statement */

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-06T23:56:56Z

Jcai3: /* View Improvement */

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-06T23:56:40Z

Jcai3: /* Current Implementation */

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-06T23:54:41Z

Jcai3: /* Controller Improvement */

File:E1979 test result.png

2019-12-06T23:47:20Z

Jcai3: uploaded a new version of "File:E1979 test result.png"

File:E1979 test result.png

2019-12-06T23:46:11Z

Jcai3: uploaded a new version of "File:E1979 test result.png"

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-06T19:00:21Z

Jcai3: /* Manual UI Testing */

File:E1979 test result.png

2019-12-06T18:59:53Z

Jcai3:

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-06T18:59:08Z

Jcai3: /* Manual UI Testing */

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-06T18:55:52Z

Jcai3: /* Manual UI Testing */

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-06T18:53:08Z

Jcai3: /* Automated Testing Using Rspec */

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-06T18:40:13Z

Jcai3: /* Code Changes */

CSC/ECE 517 Fall 2018/E1876 Completion/Progress view

2019-12-06T18:39:39Z

Jcai3: /* Controller-level Logic */

='''Problem Statement'''=
A key component of Expertiza is peer reviews, which provide feedback to authors so that they can improve their work. Expertiza also supports grading of these reviews to ensure students write quality reviews, helping them learn more about the assignment by looking at their peers' work. In addition, Expertiza allows for metareviews, which are reviews the authors of the original work write for the reviews of their original work. This author feedback is useful for grading the reviews because it indicates how helpful this review was to the authors of the original work. The objective of this project is to add metareview or author feedback information to the review report page, which shows a summary of all the reviews written by the students for an assignment.

='''Goal'''=

The aim of this project is to build this into the system. We need an additional column in the 'Review Report' page for reviews which shows the calculation of the author feedback. This will help instructor's to know how the reviews proved useful to the authors/team. The aim of this project is to integrate the author feedback column in the summary page

='''Design'''=

== User Interface Enhancements ==

In the page "Review report for Design exercise" (Log in as an instructor then go to Manage -> Assignments -> View review report.), we are planning to add one more column to show the average ratings for the author feedback for a student's review of a particular assignment. The logic for calculating the average score for the metareviews would be similar to already implemented logic for the "Score Awarded/Average Score" column. Below is the page we are planning to edit.

[[File:Feedback_new.png]]

== Controller-level Logic ==

The following method shows the code logic we are planning to write for calculating the average scores for the feedback given by authors for the reviews of their work.

<pre style="color: black; border:1px;">
def calculate_avg_score_by_feedback(question_answers, q_max_score)
# get score and summary of answers for each question
# only include divide the valid_answer_sum with the number of valid answers

valid_answer_counter = 0
question_score = 0.0
question_answers.each do |ans|
# calculate score per question
unless ans.answer.nil?
question_score += ans.answer
valid_answer_counter += 1
end
end

if valid_answer_counter > 0 and q_max_score > 0
# convert the score in percentage
question_score /= (valid_answer_counter * q_max_score)
question_score = question_score.round(2) * 100
end
question_score
end
</pre>

== Relevant Database Tables ==

The following are the table structures we will need for this feature. First, the questions table has all the questions based on the questionnaire. We will be only concerned with the questions in the feedback questionnaire. The answers for each question in the feedback questionnaire are saved in the Answers table below based on the Question ID. Now, in order to know if the answer is a feedback by team members or a review by reviewer, the mapping for the Answers table is done by the response_id which is a foreign key to the Response table. This Response table gives us the map_id which maps to a response map table. Now, the response map table gives us information on the reviewer_id, reviewee_id, reviewed_object_id (which is the ID for the assignment being reviewed) and the type (whether it's a teammate review, author feedback, a regular review, etc.). We will have to fetch the answers from the Answer table based on response_id because in our case, the response is from a previous reviewee and not a reviewer. So, we will fetch those answers whose response type is FeedbackResponseMap and calculate scores for those questions for the corresponding ReviewScores table. Below are excerpts from the [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza database documentation] which describe the database tables relevant to our design.

=== Questions Table Structure ===


{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|unique identifier for the record
|-
!txt
|text
|the question string
|-
!weight
|int(11)
|specifies the weighting of the question
|-
!questionnaire_id
|int(11)
|the id of the questionnaire that this question belongs to
|-
!seq
|DECIMAL
|
|-
!type
|VARCHAR(255)
|Type of question
|-
!size
|VARCHAR(255)
|Size of the question
|-
!alternatives
|VARCHAR(255)
|Other question which means the same
|-
!break_before
|BIT
|
|-
!max_label
|VARCHAR(255)
|
|-
!min_label
|VARCHAR(255)
|
|}

=== Answer Table Structure ===

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|Unique ID for each Answers record.
|-
!question_id
|int(11)
|ID of Question.
|-
!answer
|int(11)
|Value of each of the answer.
|-
!comments
|text
|Comment given to the answer.
|-
!reponse_id
|int(11)
|ID of the response associated with this Answer.
|}

=== Response Table Structure ===

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|The unique record id
|-
!map_id
|int(11)
|The ID of the [[response_maps|response map]] defining the relationship that this response applies to
|-
!additional_comment
|text
|An additional comment provided by the reviewer to support his/her response
|-
!updated_at
|datetime
|The timestamp indicating when this response was last modified
|-
!created_at
|datetime
|The timestamp indicating when this response was created
|-
!version_num
|int(11)
|The version of the review.
|-
!round
|int(11)
|The round the review is connected to.
|-
!is_submitted
|tinyint(1)
|Boolean Field to indicate whether the review is submitted.
|}

=== Response Map Table ===

{| class="wikitable"
!Field Name !!Type !!Description
|-
!id
|int(11)
|The unique record id
|-
!reviewed_object_id
|int(11)
|The object being reviewed in the [[responses|response]]. Possible objects include other ResponseMaps or [[assignments]]
|-
!reviewer_id
|int(11)
|The [[participants|participant]] (actually AssignmentParticipant) providing the response
|-
!reviewee_id
|int(11)
|The [[teams|team]] (AssignmentTeam) receiving the response
|-
!type
|varchar(255)
|Used for subclassing the response map. Available subclasses are ReviewResponseMap, MetareviewResponseMap, FeedbackResponseMap, TeammateReviewResponseMap
|-
!created_at
|DATETIME
|Date and Time for when the record was created
|-
!updated_at
|DATETIME
|Date and Time when the last update was made
|-
!calibrate_to
|BIT
|}

== UML Flow-Chart ==

[[File:UML-progress.png]]

== Files That Will be Changed ==

1. To calculate the average author feedback score: https://github.com/jainmohit1/expertiza/blob/master/app/models/on_the_fly_calc.rb

2. To populate the average author feedback score for the view: https://github.com/jainmohit1/expertiza/blob/master/app/controllers/review_mapping_controller.rb

3. To add a field in the view: https://github.com/jainmohit1/expertiza/blob/master/app/views/review_mapping/response_report.html.haml

4. To add a field in the partial : https://github.com/jainmohit1/expertiza/blob/master/app/views/review_mapping/_review_report.html.erb

5. To add a field in the partial: https://github.com/jainmohit1/expertiza/blob/master/app/views/review_mapping/_team_score.html.erb

= Implementation =

We added functionality in the on_the_fly_calc.rb file in Models. The methods in consideration are:<br>
1. compute_author_feedback_scores<br>
2. calc_avg_feedback_score(response)<br>
3. calc_feedback_scores_sum<br>

The first method fetches the Feedback Response from ResponseMaps table based on the responses given earlier. Responses means the reviews given. Each feedback is saved to ResponseMap table with type = 'FeedbackResponseMap'. The feedback is fetched according to the assignment id, the reviewer who gave the review for that assignment and the reviews in each round. For each feedback response, we get the weight of the answer(feedback) submitted by author from Answer table and the weight of each answer from Questions table for the FeedbackQuestionnaire in consideration which we fetched from Questionnaire table. We calculate by taking an average of all feedbacks given by all team members to the reviews that they got. Following is the code snippet:

<pre style="color: black; border:1px;">
def compute_author_feedback_scores
@author_feedback_scores = {}
@response_maps = ResponseMap.where('reviewed_object_id = ? && type = ?', self.id, 'ReviewResponseMap')
rounds = self.rounds_of_reviews
(1..rounds).each do |round|
@response_maps.each do |response_map|
response = Response.where('map_id = ?', response_map.id)
response = response.select {|response| response.round == round }
@round = round
@response_map = response_map
calc_avg_feedback_score(response) unless response.empty?
end
end
@author_feedback_scores
end
</pre>

<pre style="color: black; border:1px;">
def calc_avg_feedback_score(response)
# Retrieve the author feedback response maps for the teammates reviewing the review of their work.
author_feedback_response_maps = ResponseMap.where('reviewed_object_id = ? && type = ?', response.first.id, 'FeedbackResponseMap')
author_feedback_response_maps.each do |author_feedback_response_map|
@corresponding_response = Response.where('map_id = ?', author_feedback_response_map.id)
next if @corresponding_response.empty?
calc_feedback_scores_sum
end
# Divide the sum of the author feedback scores for this review by their number to get the
# average.

if !@author_feedback_scores[@response_map.reviewer_id].nil? &&
!@author_feedback_scores[@response_map.reviewer_id][@round].nil? &&
!@author_feedback_scores[@response_map.reviewer_id][@round][@response_map.reviewee_id].nil? &&
!author_feedback_response_maps.empty?
@author_feedback_scores[@response_map.reviewer_id][@round][@response_map.reviewee_id] /= author_feedback_response_maps.count
end
end
</pre>

<pre style="color: black; border:1px;">
def calc_feedback_scores_sum
@respective_scores = {}
if !@author_feedback_scores[@response_map.reviewer_id].nil? && !@author_feedback_scores[@response_map.reviewer_id][@round].nil?
@respective_scores = @author_feedback_scores[@response_map.reviewer_id][@round]
end
author_feedback_questionnaire_id = feedback_questionnaire_id(@corresponding_response)
@questions = Question.where('questionnaire_id = ?', author_feedback_questionnaire_id)
# Calculate the score of the author feedback review.
calc_review_score
# Compute the sum of the author feedback scores for this review.
@respective_scores[@response_map.reviewee_id] = 0 if @respective_scores[@response_map.reviewee_id].nil?
@respective_scores[@response_map.reviewee_id] += @this_review_score
# The reviewer is the metareviewee whose review the authors or teammates are reviewing.
@author_feedback_scores[@response_map.reviewer_id] = {} if @author_feedback_scores[@response_map.reviewer_id].nil?
@author_feedback_scores[@response_map.reviewer_id][@round] = {} if @author_feedback_scores[@response_map.reviewer_id][@round].nil?
@author_feedback_scores[@response_map.reviewer_id][@round] = @respective_scores
end
</pre>
== View ==

We added another column to show the average author feedback score for each student who reviewed and for each team the student reviewed.

<pre style="color: black; border:1px;">
<td align = 'left' >
<% @response_maps.each_with_index do |ri, index| %>
<% if Team.where(id: ri.reviewee_id).length > 0 %>
<%@team = Team.find(ri.reviewee_id) %>
<%= render partial: 'team_feedback_score', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: r.id} %>
<%end %>
<%end %>
</td>
</pre>

= Test Plan =
We plan to test the response report page (/review_mapping/response_report?id={:assignmentID}) to make sure the new field (average author feedback) exists.

Using [http://rspec.info/ RSpec] we will add a test case to review_mapping_controller_spec.rb.

<pre>
context 'when type is FeedbackResponseMap' do
context 'when assignment has author feedback feature' do
it 'renders response_report page with average author feedback data' do
allow(assignment).to receive(:varying_rubrics_by_round?).and_return(true)
allow(FeedbackResponseMap).to receive(:feedback_response_report).with('1', 'FeedbackResponseMap')
.and_return([participant, participant1], [1, 2], [3, 4], [])
params = {
id: 1,
report: {type: 'FeedbackResponseMap'},
}
get :response_report, params
expect(response).to render_template(:response_report)
expect(response).to have(:avg_author_feedback)
end
end
end
</pre>

We also plan to manually test the response report page to make sure the new field is aligning well in the UI in the expected place. We will attach the screenshot of the UI as the test result. We will test the cases of one and multiple reviews by a reviewer and verify the number and average scores of the metareviews for those reviews are rendered correctly.

== Review Report Page ==

Below is the screenshot of review report page which now shows a new column for Author Feedback Score. <br>
[[File:impl_screenshot.png]]

== Test Implementation ==

We added a rspec test in on_the_fly_calc_spec.rb which tests our method: 'compute_author_feedback_scores' that calculates the average feedback score. Below is the snippet:
<pre style="color: black; border:1px;">

describe '#compute_author_feedback_score' do
let(:reviewer) { build(:participant, id: 1) }
let(:feedback) { Answer.new(answer: 2, response_id: 1, comments: 'Feedback Text', question_id: 2) }
let(:feedback_question) { build(:question, questionnaire: questionnaire2, weight: 1, id: 2) }
let(:questionnaire2) { build(:questionnaire, name: "feedback", private: 0, min_question_score: 0, max_question_score: 10, instructor_id: 1234) }
let(:reviewer1) { build(:participant, id: 2) }
let score = {}
let(:team_user) { build(:team_user, team: 2, user: 2) }
let(:feedback_response) { build(:response, id: 2, map_id: 2, scores: [feedback]) }
let(:feedback_response_map) { build(:response_map, id: 2, reviewed_object_id: 1, reviewer_id: 2, reviewee_id: 1) }

before(:each) do
allow(on_the_fly_calc).to receive(:rounds_of_reviews).and_return(1)
allow(on_the_fly_calc).to receive(:review_questionnaire_id).and_return(1)
end
context 'verifies feedback score' do
it 'computes feedback score based on reviews' do
expect(assignment.compute_author_feedback_scores).to eq(score)
end
end
end

</pre>

= Project Walk-through =
https://www.youtube.com/watch?v=14bx6vD3dOE&feature=youtu.be

= References =
1. http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables

2. https://github.com/jainmohit1/expertiza

3. https://github.com/expertiza/expertiza/pull/1290

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-06T18:38:41Z

Jcai3: /* Code Changes */

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-06T18:37:53Z

Jcai3: /* Code Changes */

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-06T18:28:46Z

Jcai3: /* Problem Statement */

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-06T18:16:09Z

Jcai3: /* Code Changes */

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-06T18:15:39Z

Jcai3: /* Code Changes */

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-06T18:14:24Z

Jcai3: /* Controller Improvement */

CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view

2019-12-06T18:13:29Z

Jcai3: /* Controller Improvement */