Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2021 - E2165. Fix teammate-review view

2021-11-28T19:45:29Z

Vdeshmu: /* Explanation of fixes */

== Team Introduction ==

Dr. Edward Gehringer (instructor), Parimal Mehta (mentor)

1. Anjali Garg (unity ID : agarg25)

2. Arvasu Chikara (unity ID: achikar2)

3. Lalit Bangad (unity ID: llbangad)

4. Vinay Deshmukh (unity ID: vdeshmu)

== Problems to be addressed ==

After a project is submitted and reviewed, both the team members (students) and instructors should be able to view the teammate reviews. Students should be able to view the reviews by going to a particular assignment's -> your scores, at the bottom of the page. An instructor can view the teammate reviews by going to assignments -> assignment -> particular team's submission -> view submission -> assign grades -> view scores.

In the case of the instructor, a single heat grid is shown whereas in the case of a team member, we cant view the scores. In the heat grid, it is not clear if the scores visible are for the reviews that the student has *written* for their teammates or the scores that the student has *received* from their teammates. Additionally, for instructors can choose from a list of the students on the team, but they have no way to tell whether the heat grid shows the reviews done *by* that student or done *for* that student.

== Methodology Overview ==

We have divided our work in the following tasks to address the above problems:

1. Distinguish reviews done for a student by rendering separates heatgrids for each student

2. For instructors, the table will have sections based on the students

3. Include a checkbox on the edit assignment page that enables/disables visibility of heat grid to students

4. Fix the average column for a table (which breaks for some reviews)

5. Show a composite score derived from all reviews. Make this code generalized, so other kinds of heat grid views could use it.

6. Changes should work even in an anonymized view

== Motivations ==

1. Enable users to clearly tell which reviews are done by them, and which reviews are done for them.

2. Code should be generic so it can be used for different types of heat grids as well.

== Control Flow to access the concerned screens ==
'''1. For instructor (Log in as an instructor):-'''

Screen after logging in by the instructor
[[File:ss1.png |border|1000px|center]]
Got to assignments on the Manage menu
[[File:ss2.png |border|1000px|center]]
Go to assignments
[[File:ss3.png |border|1000px|center]]
Go to submissions for any assignment
[[File:ss4a.png |border|1000px|center]]
Go to Assign Grade
[[File:ss5a.png |border|1000px|center]]
You will land on the page where the changes are made and can be reviewed
[[File:ss7a.png |border|1000px|center]]

'''2. Student:- (Instructor impersonating a student)'''

After landing on the assignments page, select any student from an assignment as shown below
[[File:ss6a.png |border|1000px|center]]
Go to/Select any assignment
[[File:ss9a.png |border|1000px|center]]
Go to your scores
[[File:ss10a.png |border|1000px|center]]
You will land on the page where the changes are made and can be reviewed
[[File:ss11a.png |border|1000px|center]]

== Old Status of the application ==

'''1. Instructor's view of teammate review''': This is the current screen given to the instructor. Here we see that the instructor can not determine who has given which review to which student in a team.

[[File:Instructor-view-1.png|border| 700px |center|alt=The proposed expanded student display.|The proposed expanded student display.]]

'''2. Student's view of teammate review''': Currently, a student is not able to see what grades were given by their teammates. We need to implement that functionality so that the student is able to view those grades.

[[File:Student-view-2.png|border| 700px |center|alt=The current instructor view.|The current review display for instructors.]]

'''3. Error in existing UI for student''': In the existing UI for a student, the highlighted block should not be rendered. This part of the screen is meant for the instructors/TAs.

[[File:Wrong render for student.png|border|700px|center|alt=Existing UI for student|Existing UI for student.]]

== Proposed changes ==

''' 1) Proposed UI for instructor ''': The instructor is able to see the score for all teammates. In the existing code, only one teammate's scores are being shown. But, we are planning to change the way the (VmQuestionResponse array is populated)[https://github.com/expertiza/expertiza/blob/master/app/controllers/grades_controller.rb#L114], so that the scores for all teammates are appended to it so it correctly shows what should have already been shown in this screen for the instructor.

[[File:Proposed_screen.png|border|700px|center|alt=Proposed UI for instructor|Proposed UI for instructor.]]

Note: When a student visits this screen, they will only be shown the reviews received by them, assuming the instructor has allowed visibility of teammate reviews to students.

''' 2) Show detailed review for a particular question''': The instructor can see detailed review given to a student by their teammates by clicking on a particular question number in the table.

[[File:ss12a.png|border|700px|center|alt=New UI for students|New UI for students ]]

''' 3) Show teammate review to student UI ''': The existing code doesn't render a student's teammate review scores at all. We are planning to render the scores to a student (as shown below) when they visit this screen. However, the visibility of this screen is contingent on whether the instructor has allowed visibility of the teammate review screen to students. If the instructor has disabled this feature, then the heatgrid will not be displayed at all.

[[File:UI_for_student.png|border|700px|center|alt=New UI for students|New UI for students ]]

== User Stories ==

1. As an instructor, I can view what reviews one teammate has given to other teammates.

2. As a student, I can view what reviews my teammates have given to me.

3. As an instructor, I can choose if I want to see all student's teammates reviews together or one by one.

4. As a student, if I am also a TA for another subject, I should not be able to see an instructor's view to the view_team page.

5. As an instructor, I should be able to see the name of the reviewers for the reviews to a particular student.

== UML diagram for the system ==

[[File:vie_team_use_case.png|border|center]]

== Changes to the models ==

1. Added new instance variable and method to the class VmQuestionResponseScoreCell.
[[File:cd1.png |border|400px|center]]

2. Added two new methods to VmQuestionResponse class.
[[File:cd2.png |border|400px|center]]

== Explanation of fixes ==

The below diagram illustrates the proposed code change for showing all team members with the teammate review data to an instructor. The existing code only iterated on the `Participant` whose ID is present in the URL of the page. To fix this, we will iterate over all teammates of the given participant so that all teammate reviews for all team members are shown to the instructor.

[[File:Logic e2165.png|border|center|alt=Flow diagram of proposed changes for showing team review data to instructor]]

===Changes made to the code are shown below. Every change is shown and explained separately===

====A. Added the following to app/assets/stylesheets/grades.scss:====
<pre>
.teammate_table.hidden {
display: none;
}
</pre>

====B. In app/controllers/grades_controller.rb: ====

'''B.1:'''

Old code: The existing code does not differentiate when adding a view model for the TeammateReview questionnaire
questionnaires.each do |questionnaire|
...
@vmlist << populate_view_model(questionnaire)
end

New code: Since the current page URL contains an ID for the participant, from which we get an assignment, which gives us a list of questionnaires, we need to iterate all participants for a `TeammateReveiwQuestionnaire` questionnaire, so that we get the heatgrid view models for all members of a team.
questionnaires.each do |questionnaire|
...
if questionnaire.type == "TeammateReviewQuestionnaire"
# as teammate review will be different for each participant
# we need to create a separate table for each teammate
@participant.team.participants.each do |team_participant|
@vmlist << populate_view_model(team_participant, questionnaire, @team)
end
else
# only one participant needs iterating, as apart from teammatereview
# all other reviews are at "team" level
@vmlist << populate_view_model(@participant, questionnaire, @team)
end
end

'''B.2: '''

Old code: This code uses @participant as an instance variable, but this structure will not work as we need to call this ViewModel with multiple participants when iterating for a teammate review questionnaire.
def populate_view_model(questionnaire)
vm = VmQuestionResponse.new(questionnaire, @assignment, @round)
vmquestions = questionnaire.questions
vm.add_questions(vmquestions)
vm.add_team_members(@team)
vm.add_reviews(@participant, @team, @assignment.vary_by_round)
vm.number_of_comments_greater_than_10_words
vm
end

New code: We need to call this function with a separate participant in each invocation due to our change for TeammateReviewQuestionnaire, hence it makes sense to make `participant` as an argument to this function. Similarly, as `team` is a closely related model to `participant`, we are passing it as an argument, to keep this function as "pure" as possible.
def populate_view_model(participant, questionnaire, team)
...
vm.add_team_members(team)
vm.add_reviews(participant, team, @assignment.vary_by_round)
...
end

====C. In app/models/vm_question_response.rb:====

'''C.1: '''Added the reviewee_id method: Created a helper method within the VmQuestionReponse model to retrieve the `reviewee_id` for a heatgrid

def reviewee_id
@participant_who_is_reviewee.user_id
end

'''C.2: '''Added the reviewee_name method: Created a helper method within the VmQuestionReponse model to retrieve the name of the student who is being reviewed for a heatgrid. This method uses the functionality to anonymize the name when we are in anonymized view.

def reviewee_name(ip_address = nil)
part = @participant_who_is_reviewee
User.find_by(id: reviewee_id).fullname(ip_address)
end

'''C.3: '''

Old code: Does not keep track of the student being reviewed
elsif @questionnaire_type == "TeammateReviewQuestionnaire"
reviews = participant.teammate_reviews
reviews.each do |review|
review_mapping = TeammateReviewResponseMap.find_by(id: review.map_id)
participant = Participant.find(review_mapping.reviewer_id)

New code: Add an instance variable to keep track of the student who is being reviewed in this VmQuestionReponse
elsif @questionnaire_type == "TeammateReviewQuestionnaire"
reviews = participant.teammate_reviews
@participant_who_is_reviewee = participant
reviews.each do |review|
review_mapping = TeammateReviewResponseMap.find_by(id: review.map_id)
participant = Participant.find(review_mapping.reviewer_id)

'''C.4: '''

Old code: Existing VmQuestionReponseScoreCell keeps no information about the reviewer, as it only stores the answer score
row.score_row.push(VmQuestionResponseScoreCell.new(answer.answer, color_code, answer.comments, vm_tag_prompts))

New code: Keep track of the response ID, so that we can retrieve the user ID for the reviewer in the model to use in the view file.

row.score_row.push(VmQuestionResponseScoreCell.new(answer.answer, color_code, answer.comments, vm_tag_prompts, answer.response_id))

====D. In app/models/vm_question_response_score_cell.rb:====

'''D.1: '''In the method initialize of class VmQuestionResponseScoreCell

Old code: Existing code doesn't keep track of the response id
def initialize(score_value, color_code, comments, vmprompts = nil)
@score_value = score_value
@color_code = color_code
@comment = comments
@vm_prompts = vmprompts
end

New code: We added an instance variable to keep track of response_id

def initialize(score_value, color_code, comments, vmprompts = nil, response_id)
...
@response_id = response_id
end

'''D.2: '''Added a method reviewer_id to the class VmQuestionResponseScoreCell: This helper method retrieves the ID for the reviewer who created this response.

def reviewer_id
resp = Response.find(@response_id)
map = ResponseMap.find(resp.map_id)
map.reviewer_id
end

====E. In app/views/grades/_add_icon_to_name.html.erb:====

'''E.1 '''Added the following code to the file: Write the code to generate the review text only once to reduce WET code

<%# Determine the content of the reviewed by text %>
<% review_text = "" %>
<% if @current_role_name.eql?'Student' or questionnaire_type != "TeammateReviewQuestionnaire" %>
<%# Use Review {{index}} format for student view, and when questionnaire_type is not teammatereview %>
<% review_text = "Review #{i + 1}" %>
<% else %>
<% resp = Response.find(review.id) %>
<% map = ResponseMap.find(resp.map_id) %>
<% reviewer_id = map.reviewer_id %>
<% fullname = Participant.find_by(id: reviewer_id).fullname(session[:ip]) %>
<% review_text = "Review by #{fullname}" %>
<% end%>

'''E.2: '''

Old code: Existing code is very unreadable as it's not indented, and written in a single line with 359 characters, which breaks the ruby style guide rules

<% if review.done_by_staff_participant? %>
<th class="sorter-false"> <img data-toggle="tooltip" data-placement="right" title="Icon indicates this review was done by course staff" class="img_icon" src="/assets/staff.png"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% else %>
<th class="sorter-false"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% end %>

New code: Correctly indented and removes WET repetition of code blocks and makes the resulting code DRYer

<th class="sorter-false">
<% if review.done_by_staff_participant? %>
<img
data-toggle="tooltip"
data-placement="right"
title="Icon indicates this review was done by course staff" class="img_icon"
src="/assets/staff.png"
>
<% end %>
<a
target="_blank"
href="../response/view?id=<%= review.id.to_s %>"
data-toggle="tooltip"
data-placement="right"
title="Click to see details">
<%= review_text %>
</a>
</th>

====F.In app/views/grades/view_team.html.erb:====

'''F.1: '''Added function teammateSelectOnChange: This function toggles the visibility for the teammate heatgrids when the instructor changes the dropdown

<pre>
function teammateSelectOnChange(selectNode) {
const revieweeIdToShow= selectNode.value;
const tableSelector = ".teammate_table";
if(revieweeIdToShow == "all") {
document.querySelectorAll(tableSelector).forEach((tableNode) => {
tableNode.classList.remove("hidden");
});
return;
}

document.querySelectorAll(tableSelector).forEach((tableNode) => {
const tableRevieweeId = tableNode.getAttribute('data-reviewee_id');
if(tableRevieweeId == revieweeIdToShow) {
tableNode.classList.remove("hidden");
} else {
tableNode.classList.add("hidden");
}
});
}
</pre>

'''F.2: '''

Old code: Existing code doesn't render TeammateReviewQuestionnaire
<pre>
<% @vmlist.each do |vm| %>
<% if (vm.questionnaire_display_type == "Metareview" or vm.questionnaire_display_type == "Author Feedback" or vm.questionnaire_display_type == "Teammate Review") and @current_role_name.eql?'Student' %>
<% else %>
<% if vm.list_of_reviewers.length > 0 %>
</pre>

New code: Use a boolean to render a dropdown (that contains the students' IDs and names) just before the first TeammateReviewQuestionnaire, and unset that boolean so we only render 1 table.
<pre>
<%# This boolean is used to render a dropdown just before the first teammate review heat grid %>
<% first_teammate_review_appeared = false %>
<% @vmlist.each do |vm| %>
<% if (not @current_role_name.eql?'Student' and
not first_teammate_review_appeared and
vm.questionnaire_type == "TeammateReviewQuestionnaire"
) %>
<div>
<select onchange="teammateSelectOnChange(this)">
<option value="all">All</option>
<% @vmlist.select { |tm_vm| tm_vm.questionnaire_type == "TeammateReviewQuestionnaire" }.each do |tm_vm| %>
<option value="<%= tm_vm.reviewee_id %>">
<%= tm_vm.reviewee_name(session[:ip]) %>
</option>
<% end %>
</select>
</div>
<% first_teammate_review_appeared = true %>
<% end %>

New code: Add conditions which check for the truthiness of ```@assignment.show_teammate_reviews``` and if the current user is a student to decide whether to render the table or not. Since the existing code checks truthiness for the cases for which NOT to render a table, we have followed the existing style of the code.

1) If type of view model is teammate review questionnaire, and current role is student, and if @assignment.show_teammate_reviews is false, then we don't render anything
2) If type of view model is teammate review questionnaire, and current role is student, but @assignment.show_teammate_reviews is true, then we don't render anything if the current reviewer_id is different to the currently logged in user.
<pre>
<% if (vm.questionnaire_display_type == "Metareview" or vm.questionnaire_display_type == "Author Feedback") and @current_role_name.eql?'Student' %>
<% elsif (
vm.questionnaire_type == "TeammateReviewQuestionnaire" and
@current_role_name.eql?'Student' and
!@assignment.show_teammate_reviews
) %>
<% elsif (
vm.questionnaire_type == "TeammateReviewQuestionnaire" and
@current_role_name.eql?'Student' and
@assignment.show_teammate_reviews and current_user.id != vm.reviewee_id
)%>
</pre>

New code: Finally, add a CSS class and a `data-reviewee_id` to keep track of the heatgrids when toggling visibility.
<pre>
<% else %>
<% if vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
<div class="teammate_table" data-reviewee_id="<%= vm.reviewee_id %>">
<% else %>
<div>
<% end %>
</pre>

'''F.3 '''

Old code: Existing code doesn't print the teammate who is being reviewed.
<pre>

<h4 style="display:inline-block;"><%= vm.questionnaire_display_type %>
<% if vm.questionnaire_type == "ReviewQuestionnaire" %>
(Round: <%= vm.round.to_s %> of <%= vm.rounds.to_s %>)
<%end %>
</pre>

New code: If TeammteReviewQuestionnaire is used, then use the `:reviewee_name` method for VmQuestionResponse model to print the name of the student who is being reviewed.
<pre>

<h4 style="display:inline-block;"><%= vm.questionnaire_display_type %>
<% if vm.questionnaire_type == "ReviewQuestionnaire" %>
(Round: <%= vm.round.to_s %> of <%= vm.rounds.to_s %>)
<% elsif vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
(For: <%= vm.reviewee_name(session[:ip]) %>)
<%end %>
</pre>

'''F.4 '''

Old code: Existing code doesn't inform the partial about the type of review being done
<pre>
<% vm.list_of_reviews.each do |review| %>

<% if (['Student'].include? @current_role_name) && @assignment.is_anonymous%>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i} %>
<% else %>
<% user_name = User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).fullname(session[:ip]).to_s %>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i} %>
<% end %>
<% i += 1 %>
<% end %>
New code: Passes the type of review being done to the partial, so it can decide on how to render the review title. Note: This code seems to use repetition, but since the conditional used here are accessing `Anonymous` assignments and checking for user roles, we have not modified this code, as it is not directly related to our scope.
<pre>
<% vm.list_of_reviews.each do |review| %>

<% if (['Student'].include? @current_role_name) && @assignment.is_anonymous%>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i, questionnaire_type: vm.questionnaire_type } %>
<% else %>
<% user_name = User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).fullname(session[:ip]).to_s %>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i, questionnaire_type: vm.questionnaire_type } %>
<% end %>
<% i += 1 %>
<% end %>
</pre>

Old code: Contains a `metrics-1` column
<pre>
<th class="sorter-true" align="right" >
Avg<span></span>
</th>
<th class="sorter-false">
<span data-toggle="tooltip" data-placement="right" title="A count of comments, for the respective question, which have word count > 10. The purpose of this metric is to represent how many comments for the question are of a substantial length to provide quality feedback.">metric-1</span>
</th>
</tr>
</thead>
</pre>

New code: As per discussion with mentor, this column has been removed in our PR.
<pre>
<th class="sorter-true" align="right" >
Avg<span></span>
</th>
</tr>
</thead>
</pre>

'''F.5 '''

Old code: It creates the ID inline in multiple places, so if we decide to change the ID generation logic, we need to modify it in multiple places. (which happened when we started rendering multiple tables for each teammate).
<pre>
<% vm.list_of_rows.each do |row| %>

<tr data-toggle="collapse" class="accordion-toggle" data-target="#hid<%= row.question_id.to_s + vm.round.to_s %>">
</pre>

New code: Generate the unique HTML ID once, in a readable manner once. And conditionally make it more unique, if it is a TeammateReviewQuestionnaire, since jQuery code requires these IDs to be unique amongst different tables. If we don't make it more unique, then clicking on one teammate review table will toggle the table visibility for the first table. To prevent this "clashing", we need to make these IDs more unique for a TeammateReviewQuestionnaire.
<pre>
<% vm.list_of_rows.each do |row| %>
<% target_id = "hid__#{row.question_id}__#{vm.round}" %>
<% if vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
<%# Since we render different heatgrids with the same questions for each
teammember, we need to distinguish the ID, based on the user for whom,
the reviews have been created. %>
<% target_id += "__#{vm.reviewee_id}" %>
<% end%>


<tr data-toggle="collapse" class="accordion-toggle" data-target="<%= "#" + target_id %>">
</pre>

Old code: Written on a single line crossing 80 characters on a single line
<pre>
<% row.score_row.each do |score| %>
<% score_comment = score.comment.nil? ? '' : score.comment %> 
<td class="<%= score.color_code %>" align="center" data-toggle="tooltip" title="<%= strip_tags(score.comment).html_safe%>">
<span class="<%= underlined?(score) %>"><%= score.score_value.to_s %></span>
</td>
<% end %>
</pre>

New code: Make code more readable by indenting it and splitting it over multiple lines
<pre>

<% row.score_row.each do |score| %>
<% score_comment = score.comment.nil? ? '' : score.comment %>

<td class="<%= score.color_code %>" align="center" data-toggle="tooltip" title="<%= strip_tags(score.comment).html_safe%>">
<span class="<%= underlined?(score) %>">
<%= score.score_value.to_s %>
</span>
</td>
<% end %>
</pre>

'''F.6 '''Removed the following code as it corresponds to the deleted column

<pre>
<td class = 'cf' align="center">
<%= row.countofcomments.to_s %>
</td>
</pre>

'''F.7 '''

Old code: Existing code just unconditionally prints the text "Review" followed by an index.
<pre>
<% for index in 0 .. row.score_row.length - 1 %>
<tr>
<td>Review <%=index + 1%></td>
</pre>

New code: Conditionally change the review text that is displayed based on the type of review and the access level of the user
<pre>
<% for index in 0 .. row.score_row.length - 1 %>
<tr>
<% if @current_role_name.eql?'Student' or vm.questionnaire_type != "TeammateReviewQuestionnaire" %>
<%# Use Review {{index}} format for student view, and
when questionnaire_type is not teammatereview %>
<td>Review <%=index + 1%></td>
<% else %>
<td>
<% reviewer_id = row.score_row[index].reviewer_id %>
<% fullname = Participant.find_by(id: reviewer_id).fullname(session[:ip]) %>
Review by <%= fullname %>
</td>
<% end%>
</pre>

====G. In spec/controllers/grades_controller_spec.rb:====

'''G.1 '''

Old code
<pre>
before(:each) do
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:team).and_return(team)
stub_current_user(instructor, instructor.role.name, instructor.role)
allow(Assignment).to receive(:find).with('1').and_return(assignment)
@@ -91,29 +90,106 @@
end
end
</pre>

New code
<pre>
before(:each) do
allow(participant).to receive(:team).and_return(team)
stub_current_user(instructor, instructor.role.name, instructor.role)
allow(Assignment).to receive(:find).with('1').and_return(assignment)
@@ -91,29 +90,106 @@
end
end
</pre>

'''G.2 '''Remove xdescribe '#view_team' and change describe '#view_team' as follows.

Old code
<pre>
describe '#view_team' do
render_views
context 'when view_team page is viewed by a student who is also a TA for another course' do
it 'renders grades#view_team page' do
allow(participant).to receive(:team).and_return(team)
allow(AssignmentQuestionnaire).to receive(:find_by).with(assignment_id: 1, questionnaire_id: 1).and_return(assignment_questionnaire)
allow(AssignmentQuestionnaire).to receive(:where).with(any_args).and_return([assignment_questionnaire])
allow(assignment).to receive(:late_policy_id).and_return(false)
allow(assignment).to receive(:calculate_penalty).and_return(false)
allow(assignment).to receive(:compute_total_score).with(any_args).and_return(100)
allow(review_questionnaire).to receive(:get_assessments_round_for).with(participant, 1).and_return([review_response])
allow(Answer).to receive(:compute_scores).with([review_response], [question]).and_return(max: 95, min: 88, avg: 90)
params = {id: 1}
allow(TaMapping).to receive(:exists?).with(ta_id: 1, course_id: 1).and_return(true)
</pre>

New code
<pre>
describe '#view_team' do
render_views

# All stubs and factories are instantiated within this scope so as to not
# clash with other broken test.
# The names of the factories created for testing view_team
# have `_vt` suffix ```where necessary``` to differentiate them from
# the above declared factories

let(:student1_vt) { create(:student, name: "barry", id: 12) }
let(:student2_vt) { create(:student, name: "iris", id: 13) }

let(:tm_questionnaire) {
build(
:teammate_review_questionnaire,
id: 12,
questions: [question],
max_question_score: 5
)
}
let(:assignment_vt) {
create(:assignment, id: 6, max_team_size: 2,
questionnaires: [tm_questionnaire])
}
let(:assignment_questionnaire_vt) {
create(:tm_assignment_questionnaire, id: 12, used_in_round: nil,
assignment: assignment_vt, questionnaire: tm_questionnaire) }
let(:team_vt) { create(:assignment_team, id: 12,
assignment: assignment_vt) }
let(:participant_vt) { create(:participant, id: 12,
assignment: assignment_vt, user_id: student1_vt.id) }
let(:participant2_vt) { create(:participant, id: 13,
assignment: assignment_vt, user_id: student2_vt.id) }

before(:each) do
# Need to stub this method so the factory instance with
# the stubbed :team method is returned by :find
# instead of a separate instance with the same data
allow(AssignmentParticipant)
.to receive(:find)
.with(participant_vt.id.to_s)
.and_return(participant_vt)
allow(participant_vt).to receive(:team).and_return(team_vt)
allow(team_vt).to receive(:participants).and_return([participant_vt, participant2_vt])
allow(AssignmentQuestionnaire)
.to receive(:find_by)
.with(assignment_id: assignment_vt.id, questionnaire_id: tm_questionnaire.id)
.and_return(assignment_questionnaire_vt)
allow(AssignmentQuestionnaire)
.to receive(:find_by)
.with(assignment_id: assignment.id, questionnaire_id: review_questionnaire.id)
.and_return(assignment_questionnaire_vt)
allow(AssignmentQuestionnaire)
.to receive(:where)
.with(any_args)
.and_return([assignment_questionnaire_vt])
allow(assignment_vt)
.to receive(:late_policy_id)
.and_return(false)
allow(assignment_vt)
.to receive(:calculate_penalty)
.and_return(false)
allow(assignment_vt)
.to receive(:compute_total_score)
.with(any_args)
.and_return(100)
allow(review_questionnaire).to receive(:get_assessments_round_for).with(participant, 1).and_return([review_response])
allow(Answer).to receive(:compute_scores).with([review_response], [question]).and_return(max: 95, min: 88, avg: 90)
end

it 'renders grades#view_team page' do
params = {id: participant_vt.id}
get :view_team, params
expect(response).to render_template(:view_team)
end

context 'when view_team page is opened by student' do
it 'dropdown is not rendered' do
session = { user: student1_vt }
params = {id: participant_vt.id}
stub_current_user(student1_vt, student1_vt.role.name, student1_vt.role)
get :view_team, params
expect(response.body).to_not have_selector('select')
end
end

context 'when view_team page is opened by instructor' do
it 'dropdown is rendered' do
session = { user: instructor }
params = {id: participant_vt.id}
get :view_team, params
expect(response.body).to have_selector('select')
end
end

context 'when view_team page is viewed by a student who is also a TA for another course' do
it 'renders grades#view_team page' do
params = { id: participant_vt.id }
allow(TaMapping).to receive(:exists?).with(ta_id: participant_vt.user_id, course_id: 1).and_return(true)
</pre>

====H. In spec/factories/factories.rb:====

'''H.1 '''Add the following factory:

<pre>
factory :teammate_review_questionnaire, class: TeammateReviewQuestionnaire do
</pre>

'''H.2 '''Add another factory

<pre>
factory :tm_assignment_questionnaire, class: AssignmentQuestionnaire do
user_id 1
questionnaire { association(:teammate_review_questionnaire) }
questionnaire_weight 100
used_in_round nil
topic_id nil
dropdown 1
end
</pre>

== Testing ==
The tests written as a part of this project can be run by running the following command on terminal:

1. rspec ./spec/controllers/grades_controller_spec.rb -e "#view_team"

2. rspec .vm_question_response_score_cell_spec.rb -e "#reviewer_id"

'''OLD STATUS'''

1. Earlier, the tests contained an xdescribe test to check if the view_team page is rendered correctly. However, this test was being skipped as this was an xdescribe segment. There was another test for when the view_team page is accessed by a student who is also a TA for another course. This can be checked [https://github.com/expertiza/expertiza/blob/beta/spec/controllers/grades_controller_spec.rb here].

<pre>
xdescribe '#view_team' do
it 'renders grades#view_team page' do
allow(participant).to receive(:team).and_return(team)
params = {id: 1}
get :view_team, params
expect(response).to render_template(:view_team)
end
end

describe '#view_team' do
render_views
context 'when view_team page is viewed by a student who is also a TA for another course' do
it 'renders grades#view_team page' do
allow(participant).to receive(:team).and_return(team)
allow(AssignmentQuestionnaire).to receive(:find_by).with(assignment_id: 1, questionnaire_id: 1).and_return(assignment_questionnaire)
allow(AssignmentQuestionnaire).to receive(:where).with(any_args).and_return([assignment_questionnaire])
allow(assignment).to receive(:late_policy_id).and_return(false)
allow(assignment).to receive(:calculate_penalty).and_return(false)
allow(assignment).to receive(:compute_total_score).with(any_args).and_return(100)
allow(review_questionnaire).to receive(:get_assessments_round_for).with(participant, 1).and_return([review_response])
allow(Answer).to receive(:compute_scores).with([review_response], [question]).and_return(max: 95, min: 88, avg: 90)
params = {id: 1}
allow(TaMapping).to receive(:exists?).with(ta_id: 1, course_id: 1).and_return(true)
stub_current_user(ta, ta.role.name, ta.role)
get :view_team, params
expect(response.body).not_to have_content "TA"
end
end
end
</pre>

'''NEW STATUS'''

1. The view_team page is rendered correctly for a given student or an instructor. This can be checked in [https://github.com/expertiza/expertiza/blob/66239d9a8a53697ea170a92208593b36d06dfd24/spec/controllers/grades_controller_spec.rb this] file.
<pre>
it 'renders grades#view_team page' do
params = {id: participant_vt.id}
get :view_team, params
expect(response).to render_template(:view_team)
end
</pre>

2. When students access then the view_team page, the dropdown to select a student's teammate reviews is not rendered on the page. The dropdown is rendered if the page is accessed by an instructor. This can be checked in [https://github.com/expertiza/expertiza/blob/66239d9a8a53697ea170a92208593b36d06dfd24/spec/controllers/grades_controller_spec.rb this] file.
<pre>
context 'dropdown for selecting a teammate review' do
render_views
it 'is not rendered is not rendered when page is opened by student' do
session = { user: student1_vt }
params = {id: participant_vt.id}
stub_current_user(student1_vt, student1_vt.role.name, student1_vt.role)
get :view_team, params
expect(response.body).to_not have_selector('select')
end

it 'is rendered when page is opened by instructor' do
session = { user: instructor }
params = {id: participant_vt.id}
get :view_team, params
expect(response.body).to have_selector('select')
end
end
</pre>

3. When a student who is also a TA for another course access the view_team page, that student should be able to a student's view to the page. This can be checked in [https://github.com/expertiza/expertiza/blob/66239d9a8a53697ea170a92208593b36d06dfd24/spec/controllers/grades_controller_spec.rb this] file.
<pre>
context 'when view_team page is viewed by a student who is also a TA for another course' do
it 'renders grades#view_team page' do
params = { id: participant_vt.id }
allow(TaMapping).to receive(:exists?).with(ta_id: participant_vt.user_id, course_id: 1).and_return(true)
stub_current_user(ta, ta.role.name, ta.role)
get :view_team, params
expect(response.body).not_to have_content "TA"
end
end
</pre>

4. If show_teammate_reviews boolean is set to False, then the student should not be able to see the teammate reviews given to him/her. An instructor can still see the teammate reviews. This can be checked in [https://github.com/expertiza/expertiza/blob/66239d9a8a53697ea170a92208593b36d06dfd24/spec/controllers/grades_controller_spec.rb this] file.
<pre>
context 'when assignment(show reviews) value is unchecked' do
before(:each) do
allow(assignment_vt).to receive(:show_teammate_reviews).and_return(false)
end
it 'Student cannot view his score' do
session = { user: student1_vt }
params = {id: participant_vt.id}
stub_current_user(student1_vt, student1_vt.role.name, student1_vt.role)
get :view_team, params
expect(response.body).to_not have_selector(".teammate_table[data-reviewee_id=\"#{participant_vt.id}\"]")
expect(response.body).to_not have_selector(".teammate_table[data-reviewee_id=\"#{participant2_vt.id}\"]")
end

it 'Instructor can view the student score' do
params = {id: participant_vt.id}
get :view_team, params
expect(response.body).to have_selector(".teammate_table[data-reviewee_id=\"#{participant_vt.id}\"]")
expect(response.body).to have_selector(".teammate_table[data-reviewee_id=\"#{participant2_vt.id}\"]")
end
end
end
</pre>

5. If show_teammate_reviews boolean is set to True, then both the student should and instructor should be able to see the teammate reviews. The student should see only the reviews received by him/her. The instructor should be able to see all student's teammate reviews. This can be checked in [https://github.com/expertiza/expertiza/blob/66239d9a8a53697ea170a92208593b36d06dfd24/spec/controllers/grades_controller_spec.rb this] file.
<pre>

context 'when assignment(show reviews) value is checked' do
it 'Student can view his score' do
session = { user: student1_vt }
params = {id: participant_vt.id}
stub_current_user(student1_vt, student1_vt.role.name, student1_vt.role)
get :view_team, params
expect(response.body).to have_selector(".teammate_table[data-reviewee_id=\"#{participant_vt.id}\"]")
expect(response.body).to_not have_selector(".teammate_table[data-reviewee_id=\"#{participant2_vt.id}\"]")
end

it 'Instructor can view the student score' do
params = {id: participant_vt.id}
get :view_team, params
expect(response.body).to have_selector(".teammate_table[data-reviewee_id=\"#{participant_vt.id}\"]")
expect(response.body).to have_selector(".teammate_table[data-reviewee_id=\"#{participant2_vt.id}\"]")
end
end
</pre>

6. The reviewer id is tracked correctly to show the correct reviewer name in the teammate reviews table. This can be checked in [https://github.com/expertiza/expertiza/blob/66239d9a8a53697ea170a92208593b36d06dfd24/spec/models/vm_question_response_score_cell_spec.rb this] file
<pre>
describe '#reviewer_id' do
it 'returns reviewer id' do
allow(ResponseMap).to receive(:find).with(1).and_return(review_response_map)
allow(response).to receive(:populate_new_response).with(:review_response_map, "0").and_return(response)
expect(response.id).to eq(1)
end
end
</pre>

== Summary of file changes ==

The following files are modified:

1. app/controllers/grades_controller.rb - Controller file which changed how the view model is populated

2. app/views/grades/view_team.html.erb - View file, which conditionally rendered the teammate name, for a teammate review heatgrid

3. spec/controllers/grades_controller_spec.rb - For tests verifying the proposed changes

4. app/models/vm_question_response.rb - To modify the view-model so it can tell us the name of the person being reviewed for the current heatgrid

5. app/models/vm_question_response_score_cell.rb -

6. app/assets/stylesheets/grades.scss -

7. app/views/grades/_add_icon_to_name.html.erb -

8. spec/factories/factories.rb -

== Design Patterns ==

Existing code does not use any design patterns, apart from if-else. It uses if-else conditional statements to check what type of questionnaire is present in the viewmodel `VmQuestionResponse`, and based on that, it renders the appropriate content.

We decided to continue with this approach since to change the present coding style, there were required many changes (refactoring) to many files which were out of the scope of the present project. To complete the project in the assigned time, we followed the if-else approach.

==References==

<p>https://expertiza.ncsu.edu/</p>

CSC/ECE 517 Fall 2021 - E2165. Fix teammate-review view

2021-11-28T19:20:17Z

Vdeshmu: /* Changes made to the code are shown below. Every change is shown and explained separately */

== Team Introduction ==

Dr. Edward Gehringer (instructor), Parimal Mehta (mentor)

1. Anjali Garg (unity ID : agarg25)

2. Arvasu Chikara (unity ID: achikar2)

3. Lalit Bangad (unity ID: llbangad)

4. Vinay Deshmukh (unity ID: vdeshmu)

== Problems to be addressed ==

After a project is submitted and reviewed, both the team members (students) and instructors should be able to view the teammate reviews. Students should be able to view the reviews by going to a particular assignment's -> your scores, at the bottom of the page. An instructor can view the teammate reviews by going to assignments -> assignment -> particular team's submission -> view submission -> assign grades -> view scores.

In the case of the instructor, a single heat grid is shown whereas in the case of a team member, we cant view the scores. In the heat grid, it is not clear if the scores visible are for the reviews that the student has *written* for their teammates or the scores that the student has *received* from their teammates. Additionally, for instructors can choose from a list of the students on the team, but they have no way to tell whether the heat grid shows the reviews done *by* that student or done *for* that student.

== Methodology Overview ==

We have divided our work in the following tasks to address the above problems:

1. Distinguish reviews done for a student by rendering separates heatgrids for each student

2. For instructors, the table will have sections based on the students

3. Include a checkbox on the edit assignment page that enables/disables visibility of heat grid to students

4. Fix the average column for a table (which breaks for some reviews)

5. Show a composite score derived from all reviews. Make this code generalized, so other kinds of heat grid views could use it.

6. Changes should work even in an anonymized view

== Motivations ==

1. Enable users to clearly tell which reviews are done by them, and which reviews are done for them.

2. Code should be generic so it can be used for different types of heat grids as well.

== Control Flow to access the concerned screens ==
'''1. For instructor (Log in as an instructor):-'''

Screen after logging in by the instructor
[[File:ss1.png |border|1000px|center]]
Got to assignments on the Manage menu
[[File:ss2.png |border|1000px|center]]
Go to assignments
[[File:ss3.png |border|1000px|center]]
Go to submissions for any assignment
[[File:ss4a.png |border|1000px|center]]
Go to Assign Grade
[[File:ss5a.png |border|1000px|center]]
You will land on the page where the changes are made and can be reviewed
[[File:ss7a.png |border|1000px|center]]

'''2. Student:- (Instructor impersonating a student)'''

After landing on the assignments page, select any student from an assignment as shown below
[[File:ss6a.png |border|1000px|center]]
Go to/Select any assignment
[[File:ss9a.png |border|1000px|center]]
Go to your scores
[[File:ss10a.png |border|1000px|center]]
You will land on the page where the changes are made and can be reviewed
[[File:ss11a.png |border|1000px|center]]

== Old Status of the application ==

'''1. Instructor's view of teammate review''': This is the current screen given to the instructor. Here we see that the instructor can not determine who has given which review to which student in a team.

[[File:Instructor-view-1.png|border| 700px |center|alt=The proposed expanded student display.|The proposed expanded student display.]]

'''2. Student's view of teammate review''': Currently, a student is not able to see what grades were given by their teammates. We need to implement that functionality so that the student is able to view those grades.

[[File:Student-view-2.png|border| 700px |center|alt=The current instructor view.|The current review display for instructors.]]

'''3. Error in existing UI for student''': In the existing UI for a student, the highlighted block should not be rendered. This part of the screen is meant for the instructors/TAs.

[[File:Wrong render for student.png|border|700px|center|alt=Existing UI for student|Existing UI for student.]]

== Proposed changes ==

''' 1) Proposed UI for instructor ''': The instructor is able to see the score for all teammates. In the existing code, only one teammate's scores are being shown. But, we are planning to change the way the (VmQuestionResponse array is populated)[https://github.com/expertiza/expertiza/blob/master/app/controllers/grades_controller.rb#L114], so that the scores for all teammates are appended to it so it correctly shows what should have already been shown in this screen for the instructor.

[[File:Proposed_screen.png|border|700px|center|alt=Proposed UI for instructor|Proposed UI for instructor.]]

Note: When a student visits this screen, they will only be shown the reviews received by them, assuming the instructor has allowed visibility of teammate reviews to students.

''' 2) Show detailed review for a particular question''': The instructor can see detailed review given to a student by their teammates by clicking on a particular question number in the table.

[[File:ss12a.png|border|700px|center|alt=New UI for students|New UI for students ]]

''' 3) Show teammate review to student UI ''': The existing code doesn't render a student's teammate review scores at all. We are planning to render the scores to a student (as shown below) when they visit this screen. However, the visibility of this screen is contingent on whether the instructor has allowed visibility of the teammate review screen to students. If the instructor has disabled this feature, then the heatgrid will not be displayed at all.

[[File:UI_for_student.png|border|700px|center|alt=New UI for students|New UI for students ]]

== User Stories ==

1. As an instructor, I can view what reviews one teammate has given to other teammates.

2. As a student, I can view what reviews my teammates have given to me.

3. As an instructor, I can choose if I want to see all student's teammates reviews together or one by one.

4. As a student, if I am also a TA for another subject, I should not be able to see an instructor's view to the view_team page.

5. As an instructor, I should be able to see the name of the reviewers for the reviews to a particular student.

== Use case diagram for the system ==

[[File:vie_team_use_case.png|border|center]]

== Models used / Explanation of fixes ==

The below diagram illustrates the proposed code change for showing all team members with the teammate review data to an instructor. The existing code only iterated on the `Participant` whose ID is present in the URL of the page. To fix this, we will iterate over all teammates of the given participant so that all teammate reviews for all team members are shown to the instructor.

[[File:Logic e2165.png|border|center|alt=Flow diagram of proposed changes for showing team review data to instructor]]

===Changes made to the code are shown below. Every change is shown and explained separately===

====A. Added the following to app/assets/stylesheets/grades.scss:====
<pre>
.teammate_table.hidden {
display: none;
}
</pre>

====B. In app/controllers/grades_controller.rb: ====

'''B.1:'''

Old code: The existing code does not differentiate when adding a view model for the TeammateReview questionnaire
questionnaires.each do |questionnaire|
...
@vmlist << populate_view_model(questionnaire)
end

New code: Since the current page URL contains an ID for the participant, from which we get an assignment, which gives us a list of questionnaires, we need to iterate all participants for a `TeammateReveiwQuestionnaire` questionnaire, so that we get the heatgrid view models for all members of a team.
questionnaires.each do |questionnaire|
...
if questionnaire.type == "TeammateReviewQuestionnaire"
# as teammate review will be different for each participant
# we need to create a separate table for each teammate
@participant.team.participants.each do |team_participant|
@vmlist << populate_view_model(team_participant, questionnaire, @team)
end
else
# only one participant needs iterating, as apart from teammatereview
# all other reviews are at "team" level
@vmlist << populate_view_model(@participant, questionnaire, @team)
end
end

'''B.2: '''

Old code: This code uses @participant as an instance variable, but this structure will not work as we need to call this ViewModel with multiple participants when iterating for a teammate review questionnaire.
def populate_view_model(questionnaire)
vm = VmQuestionResponse.new(questionnaire, @assignment, @round)
vmquestions = questionnaire.questions
vm.add_questions(vmquestions)
vm.add_team_members(@team)
vm.add_reviews(@participant, @team, @assignment.vary_by_round)
vm.number_of_comments_greater_than_10_words
vm
end

New code: We need to call this function with a separate participant in each invocation due to our change for TeammateReviewQuestionnaire, hence it makes sense to make `participant` as an argument to this function. Similarly, as `team` is a closely related model to `participant`, we are passing it as an argument, to keep this function as "pure" as possible.
def populate_view_model(participant, questionnaire, team)
...
vm.add_team_members(team)
vm.add_reviews(participant, team, @assignment.vary_by_round)
...
end

====C. In app/models/vm_question_response.rb:====

'''C.1: '''Added the reviewee_id method: Created a helper method within the VmQuestionReponse model to retrieve the `reviewee_id` for a heatgrid

def reviewee_id
@participant_who_is_reviewee.user_id
end

'''C.2: '''Added the reviewee_name method: Created a helper method within the VmQuestionReponse model to retrieve the name of the student who is being reviewed for a heatgrid. This method uses the functionality to anonymize the name when we are in anonymized view.

def reviewee_name(ip_address = nil)
part = @participant_who_is_reviewee
User.find_by(id: part.user_id).fullname(ip_address)
end

'''C.3: '''

Old code: Does not keep track of the student being reviewed
elsif @questionnaire_type == "TeammateReviewQuestionnaire"
reviews = participant.teammate_reviews
reviews.each do |review|
review_mapping = TeammateReviewResponseMap.find_by(id: review.map_id)
participant = Participant.find(review_mapping.reviewer_id)

New code: Add an instance variable to keep track of the student who is being reviewed in this VmQuestionReponse
elsif @questionnaire_type == "TeammateReviewQuestionnaire"
reviews = participant.teammate_reviews
@participant_who_is_reviewee = participant
reviews.each do |review|
review_mapping = TeammateReviewResponseMap.find_by(id: review.map_id)
participant = Participant.find(review_mapping.reviewer_id)

'''C.4: '''

Old code: Existing VmQuestionReponseScoreCell keeps no information about the reviewer, as it only stores the answer score
row.score_row.push(VmQuestionResponseScoreCell.new(answer.answer, color_code, answer.comments, vm_tag_prompts))

New code: Keep track of the response ID, so that we can retrieve the user ID for the reviewer in the model to use in the view file.

row.score_row.push(VmQuestionResponseScoreCell.new(answer.answer, color_code, answer.comments, vm_tag_prompts, answer.response_id))

====D. In app/models/vm_question_response_score_cell.rb:====

'''D.1: '''In the method initialize of class VmQuestionResponseScoreCell

Old code: Existing code doesn't keep track of the response id
def initialize(score_value, color_code, comments, vmprompts = nil)
@score_value = score_value
@color_code = color_code
@comment = comments
@vm_prompts = vmprompts
end

New code: We added an instance variable to keep track of response_id

def initialize(score_value, color_code, comments, vmprompts = nil, response_id)
...
@response_id = response_id
end

'''D.2: '''Added a method reviewer_id to the class VmQuestionResponseScoreCell: This helper method retrieves the ID for the reviewer who created this response.

def reviewer_id
resp = Response.find(@response_id)
map = ResponseMap.find(resp.map_id)
map.reviewer_id
end

====E. In app/views/grades/_add_icon_to_name.html.erb:====

'''E.1 '''Added the following code to the file: Write the code to generate the review text only once to reduce WET code

<%# Determine the content of the reviewed by text %>
<% review_text = "" %>
<% if @current_role_name.eql?'Student' or questionnaire_type != "TeammateReviewQuestionnaire" %>
<%# Use Review {{index}} format for student view, and when questionnaire_type is not teammatereview %>
<% review_text = "Review #{i + 1}" %>
<% else %>
<% resp = Response.find(review.id) %>
<% map = ResponseMap.find(resp.map_id) %>
<% reviewer_id = map.reviewer_id %>
<% fullname = Participant.find_by(id: reviewer_id).fullname(session[:ip]) %>
<% review_text = "Review by #{fullname}" %>
<% end%>

'''E.2: '''

Old code: Existing code is very unreadable as it's not indented, and written in a single line with 359 characters, which breaks the ruby style guide rules

<% if review.done_by_staff_participant? %>
<th class="sorter-false"> <img data-toggle="tooltip" data-placement="right" title="Icon indicates this review was done by course staff" class="img_icon" src="/assets/staff.png"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% else %>
<th class="sorter-false"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% end %>

New code: Correctly indented and removes WET repetition of code blocks and makes the resulting code DRYer

<th class="sorter-false">
<% if review.done_by_staff_participant? %>
<img
data-toggle="tooltip"
data-placement="right"
title="Icon indicates this review was done by course staff" class="img_icon"
src="/assets/staff.png"
>
<% end %>
<a
target="_blank"
href="../response/view?id=<%= review.id.to_s %>"
data-toggle="tooltip"
data-placement="right"
title="Click to see details">
<%= review_text %>
</a>
</th>

====F.In app/views/grades/view_team.html.erb:====

'''F.1: '''Added function teammateSelectOnChange: This function toggles the visibility for the teammate heatgrids when the instructor changes the dropdown

<pre>
function teammateSelectOnChange(selectNode) {
const revieweeIdToShow= selectNode.value;
const tableSelector = ".teammate_table";
if(revieweeIdToShow == "all") {
document.querySelectorAll(tableSelector).forEach((tableNode) => {
tableNode.classList.remove("hidden");
});
return;
}

document.querySelectorAll(tableSelector).forEach((tableNode) => {
const tableRevieweeId = tableNode.getAttribute('data-reviewee_id');
if(tableRevieweeId == revieweeIdToShow) {
tableNode.classList.remove("hidden");
} else {
tableNode.classList.add("hidden");
}
});
}
</pre>

'''F.2: '''

Old code: Existing code doesn't render TeammateReviewQuestionnaire
<pre>
<% @vmlist.each do |vm| %>
<% if (vm.questionnaire_display_type == "Metareview" or vm.questionnaire_display_type == "Author Feedback" or vm.questionnaire_display_type == "Teammate Review") and @current_role_name.eql?'Student' %>
<% else %>
<% if vm.list_of_reviewers.length > 0 %>
</pre>

New code: Use a boolean to render a dropdown (that contains the students' IDs and names) just before the first TeammateReviewQuestionnaire, and unset that boolean so we only render 1 table.
<pre>
<%# This boolean is used to render a dropdown just before the first teammate review heat grid %>
<% first_teammate_review_appeared = false %>
<% @vmlist.each do |vm| %>
<% if (not @current_role_name.eql?'Student' and
not first_teammate_review_appeared and
vm.questionnaire_type == "TeammateReviewQuestionnaire"
) %>
<div>
<select onchange="teammateSelectOnChange(this)">
<option value="all">All</option>
<% @vmlist.select { |tm_vm| tm_vm.questionnaire_type == "TeammateReviewQuestionnaire" }.each do |tm_vm| %>
<option value="<%= tm_vm.reviewee_id %>">
<%= tm_vm.reviewee_name(session[:ip]) %>
</option>
<% end %>
</select>
</div>
<% first_teammate_review_appeared = true %>
<% end %>

New code: Add conditions which check for the truthiness of ```@assignment.show_teammate_reviews``` and if the current user is a student to decide whether to render the table or not. Since the existing code checks truthiness for the cases for which NOT to render a table, we have followed the existing style of the code.

1) If type of view model is teammate review questionnaire, and current role is student, and if @assignment.show_teammate_reviews is false, then we don't render anything
2) If type of view model is teammate review questionnaire, and current role is student, but @assignment.show_teammate_reviews is true, then we don't render anything if the current reviewer_id is different to the currently logged in user.
<pre>
<% if (vm.questionnaire_display_type == "Metareview" or vm.questionnaire_display_type == "Author Feedback") and @current_role_name.eql?'Student' %>
<% elsif (
vm.questionnaire_type == "TeammateReviewQuestionnaire" and
@current_role_name.eql?'Student' and
!@assignment.show_teammate_reviews
) %>
<% elsif (
vm.questionnaire_type == "TeammateReviewQuestionnaire" and
@current_role_name.eql?'Student' and
@assignment.show_teammate_reviews and current_user.id != vm.reviewee_id
)%>
</pre>

New code: Finally, add a CSS class and a `data-reviewee_id` to keep track of the heatgrids when toggling visibility.
<pre>
<% else %>
<% if vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
<div class="teammate_table" data-reviewee_id="<%= vm.reviewee_id %>">
<% else %>
<div>
<% end %>
</pre>

'''F.3 '''

Old code: Existing code doesn't print the teammate who is being reviewed.
<pre>

<h4 style="display:inline-block;"><%= vm.questionnaire_display_type %>
<% if vm.questionnaire_type == "ReviewQuestionnaire" %>
(Round: <%= vm.round.to_s %> of <%= vm.rounds.to_s %>)
<%end %>
</pre>

New code: If TeammteReviewQuestionnaire is used, then use the `:reviewee_name` method for VmQuestionResponse model to print the name of the student who is being reviewed.
<pre>

<h4 style="display:inline-block;"><%= vm.questionnaire_display_type %>
<% if vm.questionnaire_type == "ReviewQuestionnaire" %>
(Round: <%= vm.round.to_s %> of <%= vm.rounds.to_s %>)
<% elsif vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
(For: <%= vm.reviewee_name(session[:ip]) %>)
<%end %>
</pre>

'''F.4 '''

Old code: Existing code doesn't inform the partial about the type of review being done
<pre>
<% vm.list_of_reviews.each do |review| %>

<% if (['Student'].include? @current_role_name) && @assignment.is_anonymous%>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i} %>
<% else %>
<% user_name = User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).fullname(session[:ip]).to_s %>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i} %>
<% end %>
<% i += 1 %>
<% end %>
New code: Passes the type of review being done to the partial, so it can decide on how to render the review title. Note: This code seems to use repetition, but since the conditional used here are accessing `Anonymous` assignments and checking for user roles, we have not modified this code, as it is not directly related to our scope.
<pre>
<% vm.list_of_reviews.each do |review| %>

<% if (['Student'].include? @current_role_name) && @assignment.is_anonymous%>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i, questionnaire_type: vm.questionnaire_type } %>
<% else %>
<% user_name = User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).fullname(session[:ip]).to_s %>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i, questionnaire_type: vm.questionnaire_type } %>
<% end %>
<% i += 1 %>
<% end %>
</pre>

Old code: Contains a `metrics-1` column
<pre>
<th class="sorter-true" align="right" >
Avg<span></span>
</th>
<th class="sorter-false">
<span data-toggle="tooltip" data-placement="right" title="A count of comments, for the respective question, which have word count > 10. The purpose of this metric is to represent how many comments for the question are of a substantial length to provide quality feedback.">metric-1</span>
</th>
</tr>
</thead>
</pre>

New code: As per discussion with mentor, this column has been removed in our PR.
<pre>
<th class="sorter-true" align="right" >
Avg<span></span>
</th>
</tr>
</thead>
</pre>

'''F.5 '''

Old code: It creates the ID inline in multiple places, so if we decide to change the ID generation logic, we need to modify it in multiple places. (which happened when we started rendering multiple tables for each teammate).
<pre>
<% vm.list_of_rows.each do |row| %>

<tr data-toggle="collapse" class="accordion-toggle" data-target="#hid<%= row.question_id.to_s + vm.round.to_s %>">
</pre>

New code: Generate the unique HTML ID once, in a readable manner once. And conditionally make it more unique, if it is a TeammateReviewQuestionnaire, since jQuery code requires these IDs to be unique amongst different tables. If we don't make it more unique, then clicking on one teammate review table will toggle the table visibility for the first table. To prevent this "clashing", we need to make these IDs more unique for a TeammateReviewQuestionnaire.
<pre>
<% vm.list_of_rows.each do |row| %>
<% target_id = "hid__#{row.question_id}__#{vm.round}" %>
<% if vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
<%# Since we render different heatgrids with the same questions for each
teammember, we need to distinguish the ID, based on the user for whom,
the reviews have been created. %>
<% target_id += "__#{vm.reviewee_id}" %>
<% end%>


<tr data-toggle="collapse" class="accordion-toggle" data-target="<%= "#" + target_id %>">
</pre>

Old code: Written on a single line crossing 80 characters on a single line
<pre>
<% row.score_row.each do |score| %>
<% score_comment = score.comment.nil? ? '' : score.comment %> 
<td class="<%= score.color_code %>" align="center" data-toggle="tooltip" title="<%= strip_tags(score.comment).html_safe%>">
<span class="<%= underlined?(score) %>"><%= score.score_value.to_s %></span>
</td>
<% end %>
</pre>

New code: Make code more readable by indenting it and splitting it over multiple lines
<pre>

<% row.score_row.each do |score| %>
<% score_comment = score.comment.nil? ? '' : score.comment %>

<td class="<%= score.color_code %>" align="center" data-toggle="tooltip" title="<%= strip_tags(score.comment).html_safe%>">
<span class="<%= underlined?(score) %>">
<%= score.score_value.to_s %>
</span>
</td>
<% end %>
</pre>

'''F.6 '''Removed the following code as it corresponds to the deleted column

<pre>
<td class = 'cf' align="center">
<%= row.countofcomments.to_s %>
</td>
</pre>

'''F.7 '''

Old code: Existing code just unconditionally prints the text "Review" followed by an index.
<pre>
<% for index in 0 .. row.score_row.length - 1 %>
<tr>
<td>Review <%=index + 1%></td>
</pre>

New code: Conditionally change the review text that is displayed based on the type of review and the access level of the user
<pre>
<% for index in 0 .. row.score_row.length - 1 %>
<tr>
<% if @current_role_name.eql?'Student' or vm.questionnaire_type != "TeammateReviewQuestionnaire" %>
<%# Use Review {{index}} format for student view, and
when questionnaire_type is not teammatereview %>
<td>Review <%=index + 1%></td>
<% else %>
<td>
<% reviewer_id = row.score_row[index].reviewer_id %>
<% fullname = Participant.find_by(id: reviewer_id).fullname(session[:ip]) %>
Review by <%= fullname %>
</td>
<% end%>
</pre>

====G. In spec/controllers/grades_controller_spec.rb:====

'''G.1 '''

Old code
<pre>
before(:each) do
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:team).and_return(team)
stub_current_user(instructor, instructor.role.name, instructor.role)
allow(Assignment).to receive(:find).with('1').and_return(assignment)
@@ -91,29 +90,106 @@
end
end
</pre>

New code
<pre>
before(:each) do
allow(participant).to receive(:team).and_return(team)
stub_current_user(instructor, instructor.role.name, instructor.role)
allow(Assignment).to receive(:find).with('1').and_return(assignment)
@@ -91,29 +90,106 @@
end
end
</pre>

'''G.2 '''Remove xdescribe '#view_team' and change describe '#view_team' as follows.

Old code
<pre>
describe '#view_team' do
render_views
context 'when view_team page is viewed by a student who is also a TA for another course' do
it 'renders grades#view_team page' do
allow(participant).to receive(:team).and_return(team)
allow(AssignmentQuestionnaire).to receive(:find_by).with(assignment_id: 1, questionnaire_id: 1).and_return(assignment_questionnaire)
allow(AssignmentQuestionnaire).to receive(:where).with(any_args).and_return([assignment_questionnaire])
allow(assignment).to receive(:late_policy_id).and_return(false)
allow(assignment).to receive(:calculate_penalty).and_return(false)
allow(assignment).to receive(:compute_total_score).with(any_args).and_return(100)
allow(review_questionnaire).to receive(:get_assessments_round_for).with(participant, 1).and_return([review_response])
allow(Answer).to receive(:compute_scores).with([review_response], [question]).and_return(max: 95, min: 88, avg: 90)
params = {id: 1}
allow(TaMapping).to receive(:exists?).with(ta_id: 1, course_id: 1).and_return(true)
</pre>

New code
<pre>
describe '#view_team' do
render_views

# All stubs and factories are instantiated within this scope so as to not
# clash with other broken test.
# The names of the factories created for testing view_team
# have `_vt` suffix ```where necessary``` to differentiate them from
# the above declared factories

let(:student1_vt) { create(:student, name: "barry", id: 12) }
let(:student2_vt) { create(:student, name: "iris", id: 13) }

let(:tm_questionnaire) {
build(
:teammate_review_questionnaire,
id: 12,
questions: [question],
max_question_score: 5
)
}
let(:assignment_vt) {
create(:assignment, id: 6, max_team_size: 2,
questionnaires: [tm_questionnaire])
}
let(:assignment_questionnaire_vt) {
create(:tm_assignment_questionnaire, id: 12, used_in_round: nil,
assignment: assignment_vt, questionnaire: tm_questionnaire) }
let(:team_vt) { create(:assignment_team, id: 12,
assignment: assignment_vt) }
let(:participant_vt) { create(:participant, id: 12,
assignment: assignment_vt, user_id: student1_vt.id) }
let(:participant2_vt) { create(:participant, id: 13,
assignment: assignment_vt, user_id: student2_vt.id) }

before(:each) do
# Need to stub this method so the factory instance with
# the stubbed :team method is returned by :find
# instead of a separate instance with the same data
allow(AssignmentParticipant)
.to receive(:find)
.with(participant_vt.id.to_s)
.and_return(participant_vt)
allow(participant_vt).to receive(:team).and_return(team_vt)
allow(team_vt).to receive(:participants).and_return([participant_vt, participant2_vt])
allow(AssignmentQuestionnaire)
.to receive(:find_by)
.with(assignment_id: assignment_vt.id, questionnaire_id: tm_questionnaire.id)
.and_return(assignment_questionnaire_vt)
allow(AssignmentQuestionnaire)
.to receive(:find_by)
.with(assignment_id: assignment.id, questionnaire_id: review_questionnaire.id)
.and_return(assignment_questionnaire_vt)
allow(AssignmentQuestionnaire)
.to receive(:where)
.with(any_args)
.and_return([assignment_questionnaire_vt])
allow(assignment_vt)
.to receive(:late_policy_id)
.and_return(false)
allow(assignment_vt)
.to receive(:calculate_penalty)
.and_return(false)
allow(assignment_vt)
.to receive(:compute_total_score)
.with(any_args)
.and_return(100)
allow(review_questionnaire).to receive(:get_assessments_round_for).with(participant, 1).and_return([review_response])
allow(Answer).to receive(:compute_scores).with([review_response], [question]).and_return(max: 95, min: 88, avg: 90)
end

it 'renders grades#view_team page' do
params = {id: participant_vt.id}
get :view_team, params
expect(response).to render_template(:view_team)
end

context 'when view_team page is opened by student' do
it 'dropdown is not rendered' do
session = { user: student1_vt }
params = {id: participant_vt.id}
stub_current_user(student1_vt, student1_vt.role.name, student1_vt.role)
get :view_team, params
expect(response.body).to_not have_selector('select')
end
end

context 'when view_team page is opened by instructor' do
it 'dropdown is rendered' do
session = { user: instructor }
params = {id: participant_vt.id}
get :view_team, params
expect(response.body).to have_selector('select')
end
end

context 'when view_team page is viewed by a student who is also a TA for another course' do
it 'renders grades#view_team page' do
params = { id: participant_vt.id }
allow(TaMapping).to receive(:exists?).with(ta_id: participant_vt.user_id, course_id: 1).and_return(true)
</pre>

====H. In spec/factories/factories.rb:====

'''H.1 '''Add the following factory:

<pre>
factory :teammate_review_questionnaire, class: TeammateReviewQuestionnaire do
</pre>

'''H.2 '''Add another factory

<pre>
factory :tm_assignment_questionnaire, class: AssignmentQuestionnaire do
user_id 1
questionnaire { association(:teammate_review_questionnaire) }
questionnaire_weight 100
used_in_round nil
topic_id nil
dropdown 1
end
</pre>

== Testing ==
'''OLD STATUS'''

1. Earlier, the tests contained an xdescribe test to check if the view_team page is rendered correctly. However, this test was being skipped as this was an xdescribe segment. There was another test for when the view_team page is accessed by a student who is also a TA for another course. This can be checked [https://github.com/expertiza/expertiza/blob/beta/spec/controllers/grades_controller_spec.rb here].

<pre>
xdescribe '#view_team' do
it 'renders grades#view_team page' do
allow(participant).to receive(:team).and_return(team)
params = {id: 1}
get :view_team, params
expect(response).to render_template(:view_team)
end
end

describe '#view_team' do
render_views
context 'when view_team page is viewed by a student who is also a TA for another course' do
it 'renders grades#view_team page' do
allow(participant).to receive(:team).and_return(team)
allow(AssignmentQuestionnaire).to receive(:find_by).with(assignment_id: 1, questionnaire_id: 1).and_return(assignment_questionnaire)
allow(AssignmentQuestionnaire).to receive(:where).with(any_args).and_return([assignment_questionnaire])
allow(assignment).to receive(:late_policy_id).and_return(false)
allow(assignment).to receive(:calculate_penalty).and_return(false)
allow(assignment).to receive(:compute_total_score).with(any_args).and_return(100)
allow(review_questionnaire).to receive(:get_assessments_round_for).with(participant, 1).and_return([review_response])
allow(Answer).to receive(:compute_scores).with([review_response], [question]).and_return(max: 95, min: 88, avg: 90)
params = {id: 1}
allow(TaMapping).to receive(:exists?).with(ta_id: 1, course_id: 1).and_return(true)
stub_current_user(ta, ta.role.name, ta.role)
get :view_team, params
expect(response.body).not_to have_content "TA"
end
end
end
</pre>

'''NEW STATUS'''

1. The view_team page is rendered correctly for a given student or an instructor. This can be checked in [https://github.com/expertiza/expertiza/blob/66239d9a8a53697ea170a92208593b36d06dfd24/spec/controllers/grades_controller_spec.rb this] file.
<pre>
it 'renders grades#view_team page' do
params = {id: participant_vt.id}
get :view_team, params
expect(response).to render_template(:view_team)
end
</pre>

2. When students access then the view_team page, the dropdown to select a student's teammate reviews is not rendered on the page. This can be checked in [https://github.com/expertiza/expertiza/blob/66239d9a8a53697ea170a92208593b36d06dfd24/spec/controllers/grades_controller_spec.rb this] file.
<pre>
context 'when view_team page is opened by student' do
it 'dropdown is not rendered' do
session = { user: student1_vt }
params = {id: participant_vt.id}
stub_current_user(student1_vt, student1_vt.role.name, student1_vt.role)
get :view_team, params
expect(response.body).to_not have_selector('select')
end
end
</pre>

3. When an instructor access then the view_team page, the dropdown to select a student's teammate reviews is rendered on the page. This can be checked in [https://github.com/expertiza/expertiza/blob/66239d9a8a53697ea170a92208593b36d06dfd24/spec/controllers/grades_controller_spec.rb this] file.
<pre>
context 'when view_team page is opened by instructor' do
it 'dropdown is rendered' do
session = { user: instructor }
params = {id: participant_vt.id}
get :view_team, params
expect(response.body).to have_selector('select')
end
end
</pre>

4. When a student who is also a TA for another course access the view_team page, that student should be able to a student's view to the page. This can be checked in [https://github.com/expertiza/expertiza/blob/66239d9a8a53697ea170a92208593b36d06dfd24/spec/controllers/grades_controller_spec.rb this] file.
<pre>
context 'when view_team page is viewed by a student who is also a TA for another course' do
it 'renders grades#view_team page' do
params = { id: participant_vt.id }
allow(TaMapping).to receive(:exists?).with(ta_id: participant_vt.user_id, course_id: 1).and_return(true)
stub_current_user(ta, ta.role.name, ta.role)
get :view_team, params
expect(response.body).not_to have_content "TA"
end
end
</pre>

5. If show_teammate_reviews boolean is set to False, then the student should not be able to see the teammate reviews given to him/her. An instructor can still see the teammate reviews. This can be checked in [https://github.com/expertiza/expertiza/blob/66239d9a8a53697ea170a92208593b36d06dfd24/spec/controllers/grades_controller_spec.rb this] file.
<pre>
context 'when assignment(show reviews) value is unchecked' do
before(:each) do
allow(assignment_vt).to receive(:show_teammate_reviews).and_return(false)
end
it 'Student cannot view his score' do
session = { user: student1_vt }
params = {id: participant_vt.id}
stub_current_user(student1_vt, student1_vt.role.name, student1_vt.role)
get :view_team, params
expect(response.body).to_not have_selector(".teammate_table[data-reviewee_id=\"#{participant_vt.id}\"]")
expect(response.body).to_not have_selector(".teammate_table[data-reviewee_id=\"#{participant2_vt.id}\"]")
end

it 'Instructor can view the student score' do
params = {id: participant_vt.id}
get :view_team, params
expect(response.body).to have_selector(".teammate_table[data-reviewee_id=\"#{participant_vt.id}\"]")
expect(response.body).to have_selector(".teammate_table[data-reviewee_id=\"#{participant2_vt.id}\"]")
end
end
end
</pre>

6. If show_teammate_reviews boolean is set to True, then both the student should and instructor should be able to see the teammate reviews. The student should see only the reviews received by him/her. The instructor should be able to see all student's teammate reviews. This can be checked in [https://github.com/expertiza/expertiza/blob/66239d9a8a53697ea170a92208593b36d06dfd24/spec/controllers/grades_controller_spec.rb this] file.
<pre>

context 'when assignment(show reviews) value is checked' do
it 'Student can view his score' do
session = { user: student1_vt }
params = {id: participant_vt.id}
stub_current_user(student1_vt, student1_vt.role.name, student1_vt.role)
get :view_team, params
expect(response.body).to have_selector(".teammate_table[data-reviewee_id=\"#{participant_vt.id}\"]")
expect(response.body).to_not have_selector(".teammate_table[data-reviewee_id=\"#{participant2_vt.id}\"]")
end

it 'Instructor can view the student score' do
params = {id: participant_vt.id}
get :view_team, params
expect(response.body).to have_selector(".teammate_table[data-reviewee_id=\"#{participant_vt.id}\"]")
expect(response.body).to have_selector(".teammate_table[data-reviewee_id=\"#{participant2_vt.id}\"]")
end
end
</pre>

7. The reviewer id is tracked correctly to show the correct reviewer name in the teammate reviews table. This can be checked in [https://github.com/expertiza/expertiza/blob/66239d9a8a53697ea170a92208593b36d06dfd24/spec/models/vm_question_response_score_cell_spec.rb this] file
<pre>
describe '#reviewer_id' do
it 'returns reviewer id' do
allow(ResponseMap).to receive(:find).with(1).and_return(review_response_map)
allow(response).to receive(:populate_new_response).with(:review_response_map, "0").and_return(response)
expect(response.id).to eq(1)
end
end
</pre>

== Summary of file changes ==

The following files are modified:

1. app/controllers/grades_controller.rb - Controller file which changed how the view model is populated

2. app/views/grades/view_team.html.erb - View file, which conditionally rendered the teammate name, for a teammate review heatgrid

3. spec/controllers/grades_controller_spec.rb - For tests verifying the proposed changes

4. app/models/vm_question_response.rb - To modify the view-model so it can tell us the name of the person being reviewed for the current heatgrid

5. app/models/vm_question_response_score_cell.rb -

6. app/assets/stylesheets/grades.scss -

7. app/views/grades/_add_icon_to_name.html.erb -

8. spec/factories/factories.rb -

== Design Patterns ==

Existing code does not use any design patterns, apart from if-else. It uses if-else conditional statements to check what type of questionnaire is present in the viewmodel `VmQuestionResponse`, and based on that, it renders the appropriate content.

We decided to continue with this approach since to change the present coding style, there were required many changes (refactoring) to many files which were out of the scope of the present project. To complete the project in the assigned time, we followed the if-else approach.

==References==

<p>https://expertiza.ncsu.edu/</p>

CSC/ECE 517 Fall 2021 - E2165. Fix teammate-review view

2021-11-28T19:02:57Z

Vdeshmu: /* F.In app/views/grades/view_team.html.erb: */

== Team Introduction ==

Dr. Edward Gehringer (instructor), Parimal Mehta (mentor)

1. Anjali Garg (unity ID : agarg25)

2. Arvasu Chikara (unity ID: achikar2)

3. Lalit Bangad (unity ID: llbangad)

4. Vinay Deshmukh (unity ID: vdeshmu)

== Problems to be addressed ==

After a project is submitted and reviewed, both the team members (students) and instructors should be able to view the teammate reviews. Students should be able to view the reviews by going to a particular assignment's -> your scores, at the bottom of the page. An instructor can view the teammate reviews by going to assignments -> assignment -> particular team's submission -> view submission -> assign grades -> view scores.

In the case of the instructor, a single heat grid is shown whereas in the case of a team member, we cant view the scores. In the heat grid, it is not clear if the scores visible are for the reviews that the student has *written* for their teammates or the scores that the student has *received* from their teammates. Additionally, for instructors can choose from a list of the students on the team, but they have no way to tell whether the heat grid shows the reviews done *by* that student or done *for* that student.

== Methodology Overview ==

We have divided our work in the following tasks to address the above problems:

1. Distinguish reviews done for a student by rendering separates heatgrids for each student

2. For instructors, the table will have sections based on the students

3. Include a checkbox on the edit assignment page that enables/disables visibility of heat grid to students

4. Fix the average column for a table (which breaks for some reviews)

5. Show a composite score derived from all reviews. Make this code generalized, so other kinds of heat grid views could use it.

6. Changes should work even in an anonymized view

== Motivations ==

1. Enable users to clearly tell which reviews are done by them, and which reviews are done for them.

2. Code should be generic so it can be used for different types of heat grids as well.

== Control Flow to access the concerned screens ==
'''1. For instructor (Log in as an instructor):-'''

Screen after logging in by the instructor
[[File:ss1.png |border|1000px|center]]
Got to assignments on the Manage menu
[[File:ss2.png |border|1000px|center]]
Go to assignments
[[File:ss3.png |border|1000px|center]]
Go to submissions for any assignment
[[File:ss4a.png |border|1000px|center]]
Go to Assign Grade
[[File:ss5a.png |border|1000px|center]]
You will land on the page where the changes are made and can be reviewed
[[File:ss7a.png |border|1000px|center]]

'''2. Student:- (Instructor impersonating a student)'''

After landing on the assignments page, select any student from an assignment as shown below
[[File:ss6a.png |border|1000px|center]]
Go to/Select any assignment
[[File:ss9a.png |border|1000px|center]]
Go to your scores
[[File:ss10a.png |border|1000px|center]]
You will land on the page where the changes are made and can be reviewed
[[File:ss11a.png |border|1000px|center]]

== Old Status of the application ==

'''1. Instructor's view of teammate review''': This is the current screen given to the instructor. Here we see that the instructor can not determine who has given which review to which student in a team.

[[File:Instructor-view-1.png|border| 700px |center|alt=The proposed expanded student display.|The proposed expanded student display.]]

'''2. Student's view of teammate review''': Currently, a student is not able to see what grades were given by their teammates. We need to implement that functionality so that the student is able to view those grades.

[[File:Student-view-2.png|border| 700px |center|alt=The current instructor view.|The current review display for instructors.]]

'''3. Error in existing UI for student''': In the existing UI for a student, the highlighted block should not be rendered. This part of the screen is meant for the instructors/TAs.

[[File:Wrong render for student.png|border|700px|center|alt=Existing UI for student|Existing UI for student.]]

== Proposed changes ==

''' 1) Proposed UI for instructor ''': The instructor is able to see the score for all teammates. In the existing code, only one teammate's scores are being shown. But, we are planning to change the way the (VmQuestionResponse array is populated)[https://github.com/expertiza/expertiza/blob/master/app/controllers/grades_controller.rb#L114], so that the scores for all teammates are appended to it so it correctly shows what should have already been shown in this screen for the instructor.

[[File:Proposed_screen.png|border|700px|center|alt=Proposed UI for instructor|Proposed UI for instructor.]]

Note: When a student visits this screen, they will only be shown the reviews received by them, assuming the instructor has allowed visibility of teammate reviews to students.

''' 2) Show detailed review for a particular question''': The instructor can see detailed review given to a student by their teammates by clicking on a particular question number in the table.

[[File:ss12a.png|border|700px|center|alt=New UI for students|New UI for students ]]

''' 3) Show teammate review to student UI ''': The existing code doesn't render a student's teammate review scores at all. We are planning to render the scores to a student (as shown below) when they visit this screen. However, the visibility of this screen is contingent on whether the instructor has allowed visibility of the teammate review screen to students. If the instructor has disabled this feature, then the heatgrid will not be displayed at all.

[[File:UI_for_student.png|border|700px|center|alt=New UI for students|New UI for students ]]

== User Stories ==

1. As an instructor, I can view what reviews one teammate has given to other teammates.

2. As a student, I can view what reviews my teammates have given to me.

3. As an instructor, I can choose if I want to see all student's teammates reviews together or one by one.

4. As a student, if I am also a TA for another subject, I should not be able to see an instructor's view to the view_team page.

5. As an instructor, I should be able to see the name of the reviewers for the reviews to a particular student.

== Use case diagram for the system ==

[[File:vie_team_use_case.png|border|center]]

== Models used / Explanation of fixes ==

The below diagram illustrates the proposed code change for showing all team members with the teammate review data to an instructor. The existing code only iterated on the `Participant` whose ID is present in the URL of the page. To fix this, we will iterate over all teammates of the given participant so that all teammate reviews for all team members are shown to the instructor.

[[File:Logic e2165.png|border|center|alt=Flow diagram of proposed changes for showing team review data to instructor]]

===Changes made to the code are shown below. Every change is shown and explained separately===

====A. Added the following to app/assets/stylesheets/grades.scss:====
<pre>
.teammate_table.hidden {
display: none;
}
</pre>

====B. In app/controllers/grades_controller.rb: ====

'''B.1:'''

Old code: The existing code does not differentiate when adding a view model for the TeammateReview questionnaire
questionnaires.each do |questionnaire|
...
@vmlist << populate_view_model(questionnaire)
end

New code: Since the current page URL contains an ID for the participant, from which we get an assignment, which gives us a list of questionnaires, we need to iterate all participants for a `TeammateReveiwQuestionnaire` questionnaire, so that we get the heatgrid view models for all members of a team.
questionnaires.each do |questionnaire|
...
if questionnaire.type == "TeammateReviewQuestionnaire"
# as teammate review will be different for each participant
# we need to create a separate table for each teammate
@participant.team.participants.each do |team_participant|
@vmlist << populate_view_model(team_participant, questionnaire, @team)
end
else
# only one participant needs iterating, as apart from teammatereview
# all other reviews are at "team" level
@vmlist << populate_view_model(@participant, questionnaire, @team)
end
end

'''B.2: '''

Old code: This code uses @participant as an instance variable, but this structure will not work as we need to call this ViewModel with multiple participants when iterating for a teammate review questionnaire.
def populate_view_model(questionnaire)
vm = VmQuestionResponse.new(questionnaire, @assignment, @round)
vmquestions = questionnaire.questions
vm.add_questions(vmquestions)
vm.add_team_members(@team)
vm.add_reviews(@participant, @team, @assignment.vary_by_round)
vm.number_of_comments_greater_than_10_words
vm
end

New code: We need to call this function with a separate participant in each invocation due to our change for TeammateReviewQuestionnaire, hence it makes sense to make `participant` as an argument to this function. Similarly, as `team` is a closely related model to `participant`, we are passing it as an argument, to keep this function as "pure" as possible.
def populate_view_model(participant, questionnaire, team)
...
vm.add_team_members(team)
vm.add_reviews(participant, team, @assignment.vary_by_round)
...
end

====C. In app/models/vm_question_response.rb:====

'''C.1: '''Added the reviewee_id method: Created a helper method within the VmQuestionReponse model to retrieve the `reviewee_id` for a heatgrid

def reviewee_id
@participant_who_is_reviewee.user_id
end

'''C.2: '''Added the reviewee_name method: Created a helper method within the VmQuestionReponse model to retrieve the name of the student who is being reviewed for a heatgrid. This method uses the functionality to anonymize the name when we are in anonymized view.

def reviewee_name(ip_address = nil)
part = @participant_who_is_reviewee
User.find_by(id: part.user_id).fullname(ip_address)
end

'''C.3: '''

Old code: Does not keep track of the student being reviewed
elsif @questionnaire_type == "TeammateReviewQuestionnaire"
reviews = participant.teammate_reviews
reviews.each do |review|
review_mapping = TeammateReviewResponseMap.find_by(id: review.map_id)
participant = Participant.find(review_mapping.reviewer_id)

New code: Add an instance variable to keep track of the student who is being reviewed in this VmQuestionReponse
elsif @questionnaire_type == "TeammateReviewQuestionnaire"
reviews = participant.teammate_reviews
@participant_who_is_reviewee = participant
reviews.each do |review|
review_mapping = TeammateReviewResponseMap.find_by(id: review.map_id)
participant = Participant.find(review_mapping.reviewer_id)

'''C.4: '''

Old code: Existing VmQuestionReponseScoreCell keeps no information about the reviewer, as it only stores the answer score
row.score_row.push(VmQuestionResponseScoreCell.new(answer.answer, color_code, answer.comments, vm_tag_prompts))

New code: Keep track of the response ID, so that we can retrieve the user ID for the reviewer in the model to use in the view file.

row.score_row.push(VmQuestionResponseScoreCell.new(answer.answer, color_code, answer.comments, vm_tag_prompts, answer.response_id))

====D. In app/models/vm_question_response_score_cell.rb:====

'''D.1: '''In the method initialize of class VmQuestionResponseScoreCell

Old code: Existing code doesn't keep track of the response id
def initialize(score_value, color_code, comments, vmprompts = nil)
@score_value = score_value
@color_code = color_code
@comment = comments
@vm_prompts = vmprompts
end

New code: We added an instance variable to keep track of response_id

def initialize(score_value, color_code, comments, vmprompts = nil, response_id)
...
@response_id = response_id
end

'''D.2: '''Added a method reviewer_id to the class VmQuestionResponseScoreCell: This helper method retrieves the ID for the reviewer who created this response.

def reviewer_id
resp = Response.find(@response_id)
map = ResponseMap.find(resp.map_id)
map.reviewer_id
end

====E. In app/views/grades/_add_icon_to_name.html.erb:====

'''E.1 '''Added the following code to the file: Write the code to generate the review text only once to reduce WET code

<%# Determine the content of the reviewed by text %>
<% review_text = "" %>
<% if @current_role_name.eql?'Student' or questionnaire_type != "TeammateReviewQuestionnaire" %>
<%# Use Review {{index}} format for student view, and when questionnaire_type is not teammatereview %>
<% review_text = "Review #{i + 1}" %>
<% else %>
<% resp = Response.find(review.id) %>
<% map = ResponseMap.find(resp.map_id) %>
<% reviewer_id = map.reviewer_id %>
<% fullname = Participant.find_by(id: reviewer_id).fullname(session[:ip]) %>
<% review_text = "Review by #{fullname}" %>
<% end%>

'''E.2: '''

Old code: Existing code is very unreadable as it's not indented, and written in a single line with 359 characters, which breaks the ruby style guide rules

<% if review.done_by_staff_participant? %>
<th class="sorter-false"> <img data-toggle="tooltip" data-placement="right" title="Icon indicates this review was done by course staff" class="img_icon" src="/assets/staff.png"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% else %>
<th class="sorter-false"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% end %>

New code: Correctly indented and removes WET repetition of code blocks and makes the resulting code DRYer

<th class="sorter-false">
<% if review.done_by_staff_participant? %>
<img
data-toggle="tooltip"
data-placement="right"
title="Icon indicates this review was done by course staff" class="img_icon"
src="/assets/staff.png"
>
<% end %>
<a
target="_blank"
href="../response/view?id=<%= review.id.to_s %>"
data-toggle="tooltip"
data-placement="right"
title="Click to see details">
<%= review_text %>
</a>
</th>

====F.In app/views/grades/view_team.html.erb:====

'''F.1: '''Added function teammateSelectOnChange: This function toggles the visibility for the teammate heatgrids when the instructor changes the dropdown

<pre>
function teammateSelectOnChange(selectNode) {
const revieweeIdToShow= selectNode.value;
const tableSelector = ".teammate_table";
if(revieweeIdToShow == "all") {
document.querySelectorAll(tableSelector).forEach((tableNode) => {
tableNode.classList.remove("hidden");
});
return;
}

document.querySelectorAll(tableSelector).forEach((tableNode) => {
const tableRevieweeId = tableNode.getAttribute('data-reviewee_id');
if(tableRevieweeId == revieweeIdToShow) {
tableNode.classList.remove("hidden");
} else {
tableNode.classList.add("hidden");
}
});
}
</pre>

'''F.2: '''

Old code: Existing code doesn't render TeammateReviewQuestionnaire
<pre>
<% @vmlist.each do |vm| %>
<% if (vm.questionnaire_display_type == "Metareview" or vm.questionnaire_display_type == "Author Feedback" or vm.questionnaire_display_type == "Teammate Review") and @current_role_name.eql?'Student' %>
<% else %>
<% if vm.list_of_reviewers.length > 0 %>
</pre>

New code: Use a boolean to render a dropdown (that contains the students' IDs and names) just before the first TeammateReviewQuestionnaire, and unset that boolean so we only render 1 table. Add conditions which check for the truthiness of ```@assignment.show_teammate_reviews``` and if the current user is a student to decide whether to render the table or not. Finally, add a CSS class and a `data-reviewee_id` to keep track of the heatgrids when toggling visibility
<pre>
<%# This boolean is used to render a dropdown just before the first teammate review heat grid %>
<% first_teammate_review_appeared = false %>
<% @vmlist.each do |vm| %>
<% if not @current_role_name.eql?'Student' and not first_teammate_review_appeared and vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
<div>
<select onchange="teammateSelectOnChange(this)">
<option value="all">All</option>
<% @vmlist.select { |tm_vm| tm_vm.questionnaire_type == "TeammateReviewQuestionnaire" }.each do |tm_vm| %>
<option value="<%= tm_vm.reviewee_id %>">
<%= tm_vm.reviewee_name(session[:ip]) %>
</option>
<% end %>
</select>
</div>
<% first_teammate_review_appeared = true %>
<% end %>
<% if (vm.questionnaire_display_type == "Metareview" or vm.questionnaire_display_type == "Author Feedback") and @current_role_name.eql?'Student' %>
<% elsif (vm.questionnaire_type == "TeammateReviewQuestionnaire" and @current_role_name.eql?'Student' and !@assignment.show_teammate_reviews)%>
<% elsif (vm.questionnaire_type == "TeammateReviewQuestionnaire" and @current_role_name.eql?'Student' and @assignment.show_teammate_reviews and current_user.id != vm.reviewee_id )%>
<% else %>
<% if vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
<div class="teammate_table" data-reviewee_id="<%= vm.reviewee_id %>">
<% else %>
<div>
<% end %>
</pre>

'''F.3 '''

Old code: Existing code doesn't print the teammate who is being reviewed.
<pre>

<h4 style="display:inline-block;"><%= vm.questionnaire_display_type %>
<% if vm.questionnaire_type == "ReviewQuestionnaire" %>
(Round: <%= vm.round.to_s %> of <%= vm.rounds.to_s %>)
<%end %>
</pre>

New code: If TeammteReviewQuestionnaire is used, then use the `:reviewee_name` method for VmQuestionResponse model to print the name of the student who is being reviewed.
<pre>

<h4 style="display:inline-block;"><%= vm.questionnaire_display_type %>
<% if vm.questionnaire_type == "ReviewQuestionnaire" %>
(Round: <%= vm.round.to_s %> of <%= vm.rounds.to_s %>)
<% elsif vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
(For: <%= vm.reviewee_name(session[:ip]) %>)
<%end %>
</pre>

'''F.4 '''

Old code: Existing code doesn't inform the partial about the type of review being done
<pre>
<% vm.list_of_reviews.each do |review| %>

<% if (['Student'].include? @current_role_name) && @assignment.is_anonymous%>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i} %>
<% else %>
<% user_name = User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).fullname(session[:ip]).to_s %>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i} %>
<% end %>
<% i += 1 %>
<% end %>
New code: Passes the type of review being done to the partial, so it can decide on how to render the review title. Note: This code seems to use repetition, but since the conditional used here are accessing `Anonymous` assignments and checking for user roles, we have not modified this code, as it is not directly related to our scope.
<pre>
<% vm.list_of_reviews.each do |review| %>

<% if (['Student'].include? @current_role_name) && @assignment.is_anonymous%>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i, questionnaire_type: vm.questionnaire_type } %>
<% else %>
<% user_name = User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).fullname(session[:ip]).to_s %>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i, questionnaire_type: vm.questionnaire_type } %>
<% end %>
<% i += 1 %>
<% end %>
</pre>

Old code: Contains a `metrics-1` column
<pre>
<th class="sorter-true" align="right" >
Avg<span></span>
</th>
<th class="sorter-false">
<span data-toggle="tooltip" data-placement="right" title="A count of comments, for the respective question, which have word count > 10. The purpose of this metric is to represent how many comments for the question are of a substantial length to provide quality feedback.">metric-1</span>
</th>
</tr>
</thead>
</pre>

New code: As per discussion with mentor, this column has been removed in our PR.
<pre>
<th class="sorter-true" align="right" >
Avg<span></span>
</th>
</tr>
</thead>
</pre>

'''F.5 '''

Old code: It creates the ID inline in multiple places, so if we decide to change the ID generation logic, we need to modify it in multiple places. (which happened when we started rendering multiple tables for each teammate).
<pre>
<% vm.list_of_rows.each do |row| %>

<tr data-toggle="collapse" class="accordion-toggle" data-target="#hid<%= row.question_id.to_s + vm.round.to_s %>">
</pre>

New code: Generate the unique HTML ID once, in a readable manner once. And conditionally make it more unique, if it is a TeammateReviewQuestionnaire, since jQuery code requires these IDs to be unique amongst different tables. If we don't make it more unique, then clicking on one teammate review table will toggle the table visibility for the first table. To prevent this "clashing", we need to make these IDs more unique for a TeammateReviewQuestionnaire.
<pre>
<% vm.list_of_rows.each do |row| %>
<% target_id = "hid__#{row.question_id}__#{vm.round}" %>
<% if vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
<%# Since we render different heatgrids with the same questions for each
teammember, we need to distinguish the ID, based on the user for whom,
the reviews have been created. %>
<% target_id += "__#{vm.reviewee_id}" %>
<% end%>


<tr data-toggle="collapse" class="accordion-toggle" data-target="<%= "#" + target_id %>">
</pre>

Old code: Written on a single line crossing 80 characters on a single line
<pre>
<% row.score_row.each do |score| %>
<% score_comment = score.comment.nil? ? '' : score.comment %> 
<td class="<%= score.color_code %>" align="center" data-toggle="tooltip" title="<%= strip_tags(score.comment).html_safe%>">
<span class="<%= underlined?(score) %>"><%= score.score_value.to_s %></span>
</td>
<% end %>
</pre>

New code: Make code more readable by indenting it and splitting it over multiple lines
<pre>

<% row.score_row.each do |score| %>
<% score_comment = score.comment.nil? ? '' : score.comment %>

<td class="<%= score.color_code %>" align="center" data-toggle="tooltip" title="<%= strip_tags(score.comment).html_safe%>">
<span class="<%= underlined?(score) %>">
<%= score.score_value.to_s %>
</span>
</td>
<% end %>
</pre>

'''F.6 '''Removed the following code as it corresponds to the deleted column

<pre>
<td class = 'cf' align="center">
<%= row.countofcomments.to_s %>
</td>
</pre>

'''F.7 '''

Old code: Existing code just unconditionally prints the text "Review" followed by an index.
<pre>
<% for index in 0 .. row.score_row.length - 1 %>
<tr>
<td>Review <%=index + 1%></td>
</pre>

New code: Conditionally change the review text that is displayed based on the type of review and the access level of the user
<pre>
<% for index in 0 .. row.score_row.length - 1 %>
<tr>
<% if @current_role_name.eql?'Student' or vm.questionnaire_type != "TeammateReviewQuestionnaire" %>
<%# Use Review {{index}} format for student view, and
when questionnaire_type is not teammatereview %>
<td>Review <%=index + 1%></td>
<% else %>
<td>
<% reviewer_id = row.score_row[index].reviewer_id %>
<% fullname = Participant.find_by(id: reviewer_id).fullname(session[:ip]) %>
Review by <%= fullname %>
</td>
<% end%>
</pre>

====G. In spec/controllers/grades_controller_spec.rb:====

'''G.1 '''

Old code
<pre>
before(:each) do
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:team).and_return(team)
stub_current_user(instructor, instructor.role.name, instructor.role)
allow(Assignment).to receive(:find).with('1').and_return(assignment)
@@ -91,29 +90,106 @@
end
end
</pre>

New code
<pre>
before(:each) do
allow(participant).to receive(:team).and_return(team)
stub_current_user(instructor, instructor.role.name, instructor.role)
allow(Assignment).to receive(:find).with('1').and_return(assignment)
@@ -91,29 +90,106 @@
end
end
</pre>

'''G.2 '''Remove xdescribe '#view_team' and change describe '#view_team' as follows.

Old code
<pre>
describe '#view_team' do
render_views
context 'when view_team page is viewed by a student who is also a TA for another course' do
it 'renders grades#view_team page' do
allow(participant).to receive(:team).and_return(team)
allow(AssignmentQuestionnaire).to receive(:find_by).with(assignment_id: 1, questionnaire_id: 1).and_return(assignment_questionnaire)
allow(AssignmentQuestionnaire).to receive(:where).with(any_args).and_return([assignment_questionnaire])
allow(assignment).to receive(:late_policy_id).and_return(false)
allow(assignment).to receive(:calculate_penalty).and_return(false)
allow(assignment).to receive(:compute_total_score).with(any_args).and_return(100)
allow(review_questionnaire).to receive(:get_assessments_round_for).with(participant, 1).and_return([review_response])
allow(Answer).to receive(:compute_scores).with([review_response], [question]).and_return(max: 95, min: 88, avg: 90)
params = {id: 1}
allow(TaMapping).to receive(:exists?).with(ta_id: 1, course_id: 1).and_return(true)
</pre>

New code
<pre>
describe '#view_team' do
render_views

# All stubs and factories are instantiated within this scope so as to not
# clash with other broken test.
# The names of the factories created for testing view_team
# have `_vt` suffix ```where necessary``` to differentiate them from
# the above declared factories

let(:student1_vt) { create(:student, name: "barry", id: 12) }
let(:student2_vt) { create(:student, name: "iris", id: 13) }

let(:tm_questionnaire) {
build(
:teammate_review_questionnaire,
id: 12,
questions: [question],
max_question_score: 5
)
}
let(:assignment_vt) {
create(:assignment, id: 6, max_team_size: 2,
questionnaires: [tm_questionnaire])
}
let(:assignment_questionnaire_vt) {
create(:tm_assignment_questionnaire, id: 12, used_in_round: nil,
assignment: assignment_vt, questionnaire: tm_questionnaire) }
let(:team_vt) { create(:assignment_team, id: 12,
assignment: assignment_vt) }
let(:participant_vt) { create(:participant, id: 12,
assignment: assignment_vt, user_id: student1_vt.id) }
let(:participant2_vt) { create(:participant, id: 13,
assignment: assignment_vt, user_id: student2_vt.id) }

before(:each) do
# Need to stub this method so the factory instance with
# the stubbed :team method is returned by :find
# instead of a separate instance with the same data
allow(AssignmentParticipant)
.to receive(:find)
.with(participant_vt.id.to_s)
.and_return(participant_vt)
allow(participant_vt).to receive(:team).and_return(team_vt)
allow(team_vt).to receive(:participants).and_return([participant_vt, participant2_vt])
allow(AssignmentQuestionnaire)
.to receive(:find_by)
.with(assignment_id: assignment_vt.id, questionnaire_id: tm_questionnaire.id)
.and_return(assignment_questionnaire_vt)
allow(AssignmentQuestionnaire)
.to receive(:find_by)
.with(assignment_id: assignment.id, questionnaire_id: review_questionnaire.id)
.and_return(assignment_questionnaire_vt)
allow(AssignmentQuestionnaire)
.to receive(:where)
.with(any_args)
.and_return([assignment_questionnaire_vt])
allow(assignment_vt)
.to receive(:late_policy_id)
.and_return(false)
allow(assignment_vt)
.to receive(:calculate_penalty)
.and_return(false)
allow(assignment_vt)
.to receive(:compute_total_score)
.with(any_args)
.and_return(100)
allow(review_questionnaire).to receive(:get_assessments_round_for).with(participant, 1).and_return([review_response])
allow(Answer).to receive(:compute_scores).with([review_response], [question]).and_return(max: 95, min: 88, avg: 90)
end

it 'renders grades#view_team page' do
params = {id: participant_vt.id}
get :view_team, params
expect(response).to render_template(:view_team)
end

context 'when view_team page is opened by student' do
it 'dropdown is not rendered' do
session = { user: student1_vt }
params = {id: participant_vt.id}
stub_current_user(student1_vt, student1_vt.role.name, student1_vt.role)
get :view_team, params
expect(response.body).to_not have_selector('select')
end
end

context 'when view_team page is opened by instructor' do
it 'dropdown is rendered' do
session = { user: instructor }
params = {id: participant_vt.id}
get :view_team, params
expect(response.body).to have_selector('select')
end
end

context 'when view_team page is viewed by a student who is also a TA for another course' do
it 'renders grades#view_team page' do
params = { id: participant_vt.id }
allow(TaMapping).to receive(:exists?).with(ta_id: participant_vt.user_id, course_id: 1).and_return(true)
</pre>

====H. In spec/factories/factories.rb:====

'''H.1 '''Add the following factory:

<pre>
factory :teammate_review_questionnaire, class: TeammateReviewQuestionnaire do
</pre>

'''H.2 '''Add another factory

<pre>
factory :tm_assignment_questionnaire, class: AssignmentQuestionnaire do
user_id 1
questionnaire { association(:teammate_review_questionnaire) }
questionnaire_weight 100
used_in_round nil
topic_id nil
dropdown 1
end
</pre>

== Testing ==
'''OLD STATUS'''

1. Earlier, the tests only covered if the view_team is page is rendered when it is asked for. This can be seen on the line 94 and 103 in [https://github.com/expertiza/expertiza/blob/beta/spec/controllers/grades_controller_spec.rb this] file.

'''NEW STATUS'''

1. The view_team page is rendered correctly for a given student or an instructor.

2. When students access then the view_team page, the dropdown to select a student's teammate reviews is not rendered on the page.

3. When instructor access then the view_team page, the dropdown to select a student's teammate reviews is rendered on the page.

4. When a student who is also a TA for another course access the view_team page, that student should be able to a student's view to the page.

5. If show_teammate_reviews boolean is set to False, then the student should not be able to see the teammate reviews given to him/her. If it is set to True, then the student should be able to see the reviews.

6. An instructor should be able to see the teammate reviews for all students regardless of whether the show_teammate_reviews boolean is set to True or False.

7. The reviewer id is tracked correctly to show the correct reviewer name in the teammate reviews table. This can be seen on line 27 in [https://github.com/expertiza/expertiza/blob/66239d9a8a53697ea170a92208593b36d06dfd24/spec/models/vm_question_response_score_cell_spec.rb this] file

8. An instructor can select which student's scores he/she wants to see. If no student's name is selected then the professor can see the scores of all the students.

== Summary of file changes ==

The following files are modified:

1. app/controllers/grades_controller.rb - Controller file which changed how the view model is populated

2. app/views/grades/view_team.html.erb - View file, which conditionally rendered the teammate name, for a teammate review heatgrid

3. spec/controllers/grades_controller_spec.rb - For tests verifying the proposed changes

4. app/models/vm_question_response.rb - To modify the view-model so it can tell us the name of the person being reviewed for the current heatgrid

5. app/models/vm_question_response_score_cell.rb -

6. app/assets/stylesheets/grades.scss -

7. app/views/grades/_add_icon_to_name.html.erb -

8. spec/factories/factories.rb -

== Design Patterns ==

Existing code does not use any design patterns, apart from if-else. It uses if-else conditional statements to check what type of questionnaire is present in the viewmodel `VmQuestionResponse`, and based on that, it renders the appropriate content.

We decided to continue with this approach since to change the present coding style, there were required many changes (refactoring) to many files which were out of the scope of the present project. To complete the project in the assigned time, we followed the if-else approach.

==References==

<p>https://expertiza.ncsu.edu/</p>

CSC/ECE 517 Fall 2021 - E2165. Fix teammate-review view

2021-11-28T18:46:57Z

Vdeshmu: /* F.In app/views/grades/view_team.html.erb: */

== Team Introduction ==

Dr. Edward Gehringer (instructor), Parimal Mehta (mentor)

1. Anjali Garg (unity ID : agarg25)

2. Arvasu Chikara (unity ID: achikar2)

3. Lalit Bangad (unity ID: llbangad)

4. Vinay Deshmukh (unity ID: vdeshmu)

== Problems to be addressed ==

After a project is submitted and reviewed, both the team members (students) and instructors should be able to view the teammate reviews. Students should be able to view the reviews by going to a particular assignment's -> your scores, at the bottom of the page. An instructor can view the teammate reviews by going to assignments -> assignment -> particular team's submission -> view submission -> assign grades -> view scores.

In the case of the instructor, a single heat grid is shown whereas in the case of a team member, we cant view the scores. In the heat grid, it is not clear if the scores visible are for the reviews that the student has *written* for their teammates or the scores that the student has *received* from their teammates. Additionally, for instructors can choose from a list of the students on the team, but they have no way to tell whether the heat grid shows the reviews done *by* that student or done *for* that student.

== Methodology Overview ==

We have divided our work in the following tasks to address the above problems:

1. Distinguish reviews done for a student by rendering separates heatgrids for each student

2. For instructors, the table will have sections based on the students

3. Include a checkbox on the edit assignment page that enables/disables visibility of heat grid to students

4. Fix the average column for a table (which breaks for some reviews)

5. Show a composite score derived from all reviews. Make this code generalized, so other kinds of heat grid views could use it.

6. Changes should work even in an anonymized view

== Motivations ==

1. Enable users to clearly tell which reviews are done by them, and which reviews are done for them.

2. Code should be generic so it can be used for different types of heat grids as well.

== Control Flow to access the concerned screens ==
'''1. For instructor (Log in as an instructor):-'''

Screen after logging in by the instructor
[[File:ss1.png |border|1000px|center]]
Got to assignments on the Manage menu
[[File:ss2.png |border|1000px|center]]
Go to assignments
[[File:ss3.png |border|1000px|center]]
Go to submissions for any assignment
[[File:ss4a.png |border|1000px|center]]
Go to Assign Grade
[[File:ss5a.png |border|1000px|center]]
You will land on the page where the changes are made and can be reviewed
[[File:ss7a.png |border|1000px|center]]

'''2. Student:- (Logged in as an instructor)'''

After landing on the assignments page, select any student from an assignment as shown below
[[File:ss6a.png |border|1000px|center]]
Go to/Select any assignment
[[File:ss9a.png |border|1000px|center]]
Go to your scores
[[File:ss10a.png |border|1000px|center]]
You will land on the page where the changes are made and can be reviewed
[[File:ss11a.png |border|1000px|center]]

== Old Status of the application ==

'''1. Instructor's view of teammate review''': This is the current screen given to the instructor. Here we see that the instructor can not determine who has given which review to which student in a team.

[[File:Instructor-view-1.png|border| 700px |center|alt=The proposed expanded student display.|The proposed expanded student display.]]

'''2. Student's view of teammate review''': Currently, a student is not able to see what grades were given by their teammates. We need to implement that functionality so that the student is able to view those grades.

[[File:Student-view-2.png|border| 700px |center|alt=The current instructor view.|The current review display for instructors.]]

'''3. Error in existing UI for student''': In the existing UI for a student, the highlighted block should not be rendered. This part of the screen is meant for the instructors/TAs.

[[File:Wrong render for student.png|border|700px|center|alt=Existing UI for student|Existing UI for student.]]

== Proposed changes ==

''' 1) Proposed UI for instructor ''': The instructor is able to see the score for all teammates. In the existing code, only one teammate's scores are being shown. But, we are planning to change the way the (VmQuestionResponse array is populated)[https://github.com/expertiza/expertiza/blob/master/app/controllers/grades_controller.rb#L114], so that the scores for all teammates are appended to it so it correctly shows what should have already been shown in this screen for the instructor.

[[File:Proposed_screen.png|border|700px|center|alt=Proposed UI for instructor|Proposed UI for instructor.]]

Note: When a student visits this screen, they will only be shown the reviews received by them, assuming the instructor has allowed visibility of teammate reviews to students.

''' 2) Show detailed review for a particular question''': The instructor can see detailed review given to a student by their teammates by clicking on a particular question number in the table.

[[File:ss12a.png|border|700px|center|alt=New UI for students|New UI for students ]]

''' 3) Show teammate review to student UI ''': The existing code doesn't render a student's teammate review scores at all. We are planning to render the scores to a student (as shown below) when they visit this screen. However, the visibility of this screen is contingent on whether the instructor has allowed visibility of the teammate review screen to students. If the instructor has disabled this feature, then the heatgrid will not be displayed at all.

[[File:UI_for_student.png|border|700px|center|alt=New UI for students|New UI for students ]]

== User Stories ==

1. As an instructor, I can view what reviews one teammate has given to other teammates.

2. As a student, I can view what reviews my teammates have given to me.

3. As an instructor, I can choose if I want to see all student's teammates reviews together or one by one.

4. As a student, if I am also a TA for another subject, I should not be able to see an instructor's view to the view_team page.

5. As an instructor, I should be able to see the name of the reviewers for the reviews to a particular student.

== Use case diagram for the system ==

== Models used / Explanation of fixes ==

The below diagram illustrates the proposed code change for showing all team members with the teammate review data to an instructor. The existing code only iterated on the `Participant` whose ID is present in the URL of the page. To fix this, we will iterate over all teammates of the given participant so that all teammate reviews for all team members are shown to the instructor.

[[File:Logic e2165.png|border|center|alt=Flow diagram of proposed changes for showing team review data to instructor]]

===Changes made to the code are shown below. Every change is shown and explained separately===

====A. Added the following to app/assets/stylesheets/grades.scss:====
<pre>
.teammate_table.hidden {
display: none;
}
</pre>

====B. In app/controllers/grades_controller.rb: ====

'''B.1:'''

Old code: The existing code does not differentiate when adding a view model for the TeammateReview questionnaire
questionnaires.each do |questionnaire|
...
@vmlist << populate_view_model(questionnaire)
end

New code: Since the current page URL contains an ID for the participant, from which we get an assignment, which gives us a list of questionnaires, we need to iterate all participants for a `TeammateReveiwQuestionnaire` questionnaire, so that we get the heatgrid view models for all members of a team.
questionnaires.each do |questionnaire|
...
if questionnaire.type == "TeammateReviewQuestionnaire"
# as teammate review will be different for each participant
# we need to create a separate table for each teammate
@participant.team.participants.each do |team_participant|
@vmlist << populate_view_model(team_participant, questionnaire, @team)
end
else
# only one participant needs iterating, as apart from teammatereview
# all other reviews are at "team" level
@vmlist << populate_view_model(@participant, questionnaire, @team)
end
end

'''B.2: '''

Old code: This code uses @participant as an instance variable, but this structure will not work as we need to call this ViewModel with multiple participants when iterating for a teammate review questionnaire.
def populate_view_model(questionnaire)
vm = VmQuestionResponse.new(questionnaire, @assignment, @round)
vmquestions = questionnaire.questions
vm.add_questions(vmquestions)
vm.add_team_members(@team)
vm.add_reviews(@participant, @team, @assignment.vary_by_round)
vm.number_of_comments_greater_than_10_words
vm
end

New code: We need to call this function with a separate participant in each invocation due to our change for TeammateReviewQuestionnaire, hence it makes sense to make `participant` as an argument to this function. Similarly, as `team` is a closely related model to `participant`, we are passing it as an argument, to keep this function as "pure" as possible.
def populate_view_model(participant, questionnaire, team)
...
vm.add_team_members(team)
vm.add_reviews(participant, team, @assignment.vary_by_round)
...
end

====C. In app/models/vm_question_response.rb:====

'''C.1: '''Added the reviewee_id method: Created a helper method within the VmQuestionReponse model to retrieve the `reviewee_id` for a heatgrid

def reviewee_id
@participant_who_is_reviewee.user_id
end

'''C.2: '''Added the reviewee_name method: Created a helper method within the VmQuestionReponse model to retrieve the name of the student who is being reviewed for a heatgrid. This method uses the functionality to anonymize the name when we are in anonymized view.

def reviewee_name(ip_address = nil)
part = @participant_who_is_reviewee
User.find_by(id: part.user_id).fullname(ip_address)
end

'''C.3: '''

Old code: Does not keep track of the student being reviewed
elsif @questionnaire_type == "TeammateReviewQuestionnaire"
reviews = participant.teammate_reviews
reviews.each do |review|
review_mapping = TeammateReviewResponseMap.find_by(id: review.map_id)
participant = Participant.find(review_mapping.reviewer_id)

New code: Add an instance variable to keep track of the student who is being reviewed in this VmQuestionReponse
elsif @questionnaire_type == "TeammateReviewQuestionnaire"
reviews = participant.teammate_reviews
@participant_who_is_reviewee = participant
reviews.each do |review|
review_mapping = TeammateReviewResponseMap.find_by(id: review.map_id)
participant = Participant.find(review_mapping.reviewer_id)

'''C.4: '''

Old code: Existing VmQuestionReponseScoreCell keeps no information about the reviewer, as it only stores the answer score
row.score_row.push(VmQuestionResponseScoreCell.new(answer.answer, color_code, answer.comments, vm_tag_prompts))

New code: Keep track of the response ID, so that we can retrieve the user ID for the reviewer in the model to use in the view file.

row.score_row.push(VmQuestionResponseScoreCell.new(answer.answer, color_code, answer.comments, vm_tag_prompts, answer.response_id))

====D. In app/models/vm_question_response_score_cell.rb:====

'''D.1: '''In the method initialize of class VmQuestionResponseScoreCell

Old code: Existing code doesn't keep track of the response id
def initialize(score_value, color_code, comments, vmprompts = nil)
@score_value = score_value
@color_code = color_code
@comment = comments
@vm_prompts = vmprompts
end

New code: We added an instance variable to keep track of response_id

def initialize(score_value, color_code, comments, vmprompts = nil, response_id)
...
@response_id = response_id
end

'''D.2: '''Added a method reviewer_id to the class VmQuestionResponseScoreCell: This helper method retrieves the ID for the reviewer who created this response.

def reviewer_id
resp = Response.find(@response_id)
map = ResponseMap.find(resp.map_id)
map.reviewer_id
end

====E. In app/views/grades/_add_icon_to_name.html.erb:====

'''E.1 '''Added the following code to the file: Write the code to generate the review text only once to reduce WET code

<%# Determine the content of the reviewed by text %>
<% review_text = "" %>
<% if @current_role_name.eql?'Student' or questionnaire_type != "TeammateReviewQuestionnaire" %>
<%# Use Review {{index}} format for student view, and when questionnaire_type is not teammatereview %>
<% review_text = "Review #{i + 1}" %>
<% else %>
<% resp = Response.find(review.id) %>
<% map = ResponseMap.find(resp.map_id) %>
<% reviewer_id = map.reviewer_id %>
<% fullname = Participant.find_by(id: reviewer_id).fullname(session[:ip]) %>
<% review_text = "Review by #{fullname}" %>
<% end%>

'''E.2: '''

Old code: Existing code is very unreadable as it's not indented, and written in a single line with 359 characters, which breaks the ruby style guide rules

<% if review.done_by_staff_participant? %>
<th class="sorter-false"> <img data-toggle="tooltip" data-placement="right" title="Icon indicates this review was done by course staff" class="img_icon" src="/assets/staff.png"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% else %>
<th class="sorter-false"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% end %>

New code: Correctly indented and removes WET repetition of code blocks and makes the resulting code DRYer

<th class="sorter-false">
<% if review.done_by_staff_participant? %>
<img
data-toggle="tooltip"
data-placement="right"
title="Icon indicates this review was done by course staff" class="img_icon"
src="/assets/staff.png"
>
<% end %>
<a
target="_blank"
href="../response/view?id=<%= review.id.to_s %>"
data-toggle="tooltip"
data-placement="right"
title="Click to see details">
<%= review_text %>
</a>
</th>

====F.In app/views/grades/view_team.html.erb:====

'''F.1: '''Added function teammateSelectOnChange: This function toggles the visibility for the teammate heatgrids when the instructor changes the dropdown

<pre>
function teammateSelectOnChange(selectNode) {
const revieweeIdToShow= selectNode.value;
const tableSelector = ".teammate_table";
if(revieweeIdToShow == "all") {
document.querySelectorAll(tableSelector).forEach((tableNode) => {
tableNode.classList.remove("hidden");
});
return;
}

document.querySelectorAll(tableSelector).forEach((tableNode) => {
const tableRevieweeId = tableNode.getAttribute('data-reviewee_id');
if(tableRevieweeId == revieweeIdToShow) {
tableNode.classList.remove("hidden");
} else {
tableNode.classList.add("hidden");
}
});
}
</pre>

'''F.2: '''

Old code: Existing code doesn't render TeammateReviewQuestionnaire
<pre>
<% @vmlist.each do |vm| %>
<% if (vm.questionnaire_display_type == "Metareview" or vm.questionnaire_display_type == "Author Feedback" or vm.questionnaire_display_type == "Teammate Review") and @current_role_name.eql?'Student' %>
<% else %>
<% if vm.list_of_reviewers.length > 0 %>
</pre>

New code: Use a boolean to render a dropdown just before the first TeammateReviewQuestionnaire, and unset that boolean so we only render 1 table. Add conditions which check for the truthiness of ```@assignment.show_teammate_reviews``` and if the current user is a student to decide whether to render the table or not. Finally, add a CSS class and a `data-reviewee_id` to keep track of the heatgrids when toggling visibility
<pre>
<%# This boolean is used to render a dropdown just before the first teammate review heat grid %>
<% first_teammate_review_appeared = false %>
<% @vmlist.each do |vm| %>
<% if not @current_role_name.eql?'Student' and not first_teammate_review_appeared and vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
<div>
<select onchange="teammateSelectOnChange(this)">
<option value="all">All</option>
<% @vmlist.select { |tm_vm| tm_vm.questionnaire_type == "TeammateReviewQuestionnaire" }.each do |tm_vm| %>
<option value="<%= tm_vm.reviewee_id %>">
<%= tm_vm.reviewee_name(session[:ip]) %>
</option>
<% end %>
</select>
</div>
<% first_teammate_review_appeared = true %>
<% end %>
<% if (vm.questionnaire_display_type == "Metareview" or vm.questionnaire_display_type == "Author Feedback") and @current_role_name.eql?'Student' %>
<% elsif (vm.questionnaire_type == "TeammateReviewQuestionnaire" and @current_role_name.eql?'Student' and !@assignment.show_teammate_reviews)%>
<% elsif (vm.questionnaire_type == "TeammateReviewQuestionnaire" and @current_role_name.eql?'Student' and @assignment.show_teammate_reviews and current_user.id != vm.reviewee_id )%>
<% else %>
<% if vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
<div class="teammate_table" data-reviewee_id="<%= vm.reviewee_id %>">
<% else %>
<div>
<% end %>
</pre>

'''F.3 '''

Old code: Existing code doesn't print the teammate who is being reviewed.
<pre>

<h4 style="display:inline-block;"><%= vm.questionnaire_display_type %>
<% if vm.questionnaire_type == "ReviewQuestionnaire" %>
(Round: <%= vm.round.to_s %> of <%= vm.rounds.to_s %>)
<%end %>
</pre>

New code: If TeammteReviewQuestionnaire is used, then use the `:reviewee_name` method for VmQuestionResponse model to print the name of the student who is being reviewed.
<pre>

<h4 style="display:inline-block;"><%= vm.questionnaire_display_type %>
<% if vm.questionnaire_type == "ReviewQuestionnaire" %>
(Round: <%= vm.round.to_s %> of <%= vm.rounds.to_s %>)
<% elsif vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
(For: <%= vm.reviewee_name(session[:ip]) %>)
<%end %>
</pre>

'''F.4 '''

Old code: Existing code doesn't inform the partial about the type of review being done
<pre>
<% vm.list_of_reviews.each do |review| %>

<% if (['Student'].include? @current_role_name) && @assignment.is_anonymous%>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i} %>
<% else %>
<% user_name = User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).fullname(session[:ip]).to_s %>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i} %>
<% end %>
<% i += 1 %>
<% end %>
New code: Passes the type of review being done to the partial, so it can decide on how to render the review title. Note: This code seems to use repetition, but since the conditional used here are accessing `Anonymous` assignments and checking for user roles, we have not modified this code, as it is not directly related to our scope.
<pre>
<% vm.list_of_reviews.each do |review| %>

<% if (['Student'].include? @current_role_name) && @assignment.is_anonymous%>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i, questionnaire_type: vm.questionnaire_type } %>
<% else %>
<% user_name = User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).fullname(session[:ip]).to_s %>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i, questionnaire_type: vm.questionnaire_type } %>
<% end %>
<% i += 1 %>
<% end %>
</pre>

Old code: Contains a `metrics-` column
<pre>
<th class="sorter-true" align="right" >
Avg<span></span>
</th>
<th class="sorter-false">
<span data-toggle="tooltip" data-placement="right" title="A count of comments, for the respective question, which have word count > 10. The purpose of this metric is to represent how many comments for the question are of a substantial length to provide quality feedback.">metric-1</span>
</th>
</tr>
</thead>
</pre>

New code: As per discussion with mentor, this column has been removed in our PR.
<pre>
<th class="sorter-true" align="right" >
Avg<span></span>
</th>
</tr>
</thead>
</pre>

'''F.5 '''

Old code: It creates the ID inline in multiple places, so if we decide to change the ID generation logic, we need to modify it in multiple places. (which happened when we started rendering multiple tables for each teammate).
<pre>
<% vm.list_of_rows.each do |row| %>

<tr data-toggle="collapse" class="accordion-toggle" data-target="#hid<%= row.question_id.to_s + vm.round.to_s %>">
<td class = 'cf' data-toggle="tooltip" title="<%= row.question_text %>"> <div style='float: left'><%= j.to_s %></div><div style='float: right'> &#<%= type_and_max(row) %>;</div> </td>

</pre>

New code: Generate the unique HTML ID once, in a readable manner once. And conditionally make it more unique, if it is a TeammateReviewQuestionnaire, since jQuery code requires these IDs to be unique amongst different tables. If we don't make it more unique, then clicking on one teammate review table will toggle the table visibility for the first table. To prevent this "clashing", we need to make these IDs more unique for a TeammateReviewQuestionnaire.
<pre>
<% vm.list_of_rows.each do |row| %>
<% target_id = "hid__#{row.question_id}__#{vm.round}" %>
<% if vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
<%# Since we render different heatgrids with the same questions for each
teammember, we need to distinguish the ID, based on the user for whom,
the reviews have been created. %>
<% target_id += "__#{vm.reviewee_id}" %>
<% end%>


<tr data-toggle="collapse" class="accordion-toggle" data-target="<%= "#" + target_id %>">
</pre>

Old code: Written on a single line crossing 80 characters on a single line
<pre>
<% row.score_row.each do |score| %>
<% score_comment = score.comment.nil? ? '' : score.comment %> 
<td class="<%= score.color_code %>" align="center" data-toggle="tooltip" title="<%= strip_tags(score.comment).html_safe%>">
<span class="<%= underlined?(score) %>"><%= score.score_value.to_s %></span>
</td>
<% end %>
</pre>

New code: Make code more readable by indenting it and splitting it over multiple lines
<pre>

<% row.score_row.each do |score| %>
<% score_comment = score.comment.nil? ? '' : score.comment %>

<td class="<%= score.color_code %>" align="center" data-toggle="tooltip" title="<%= strip_tags(score.comment).html_safe%>">
<span class="<%= underlined?(score) %>">
<%= score.score_value.to_s %>
</span>
</td>
<% end %>
</pre>

'''F.6 '''Removed the following code as it corresponds to the deleted column

<pre>
<td class = 'cf' align="center">
<%= row.countofcomments.to_s %>
</td>
</pre>

'''F.7 '''

Old code
<pre>

<tr class="tablesorter-childRow">
<td colspan="<%= (i+1).to_s %>" class="hiddenRow" ><div id="hid<%= row.question_id.to_s + vm.round.to_s %>" class="accordion-body collapse" style="margin-left:10px;">
<div style="padding-top: 10px; padding-bottom: 10px;"><%= sanitize row.question_text %></div>
<div>
<table class="table tbl_questlist">
@@ -181,7 +233,17 @@
</thead>
<% for index in 0 .. row.score_row.length - 1 %>
<tr>
<td>Review <%=index + 1%></td>
</pre>

New code
<pre>

<tr class="tablesorter-childRow">
<td colspan="<%= (i+1).to_s %>" class="hiddenRow" ><div id="<%= target_id %>" class="accordion-body collapse" style="margin-left:10px;">
<div style="padding-top: 10px; padding-bottom: 10px;"><%= sanitize row.question_text %></div>
<div>
<table class="table tbl_questlist">
@@ -181,7 +233,17 @@
</thead>
<% for index in 0 .. row.score_row.length - 1 %>
<tr>
<% if @current_role_name.eql?'Student' or vm.questionnaire_type != "TeammateReviewQuestionnaire" %>
<%# Use Review {{index}} format for student view, and
when questionnaire_type is not teammatereview %>
<td>Review <%=index + 1%></td>
<% else %>
<td>
<% reviewer_id = row.score_row[index].reviewer_id %>
<% fullname = Participant.find_by(id: reviewer_id).fullname(session[:ip]) %>
Review by <%= fullname %>
</td>
<% end%>
</pre>

====G. In spec/controllers/grades_controller_spec.rb:====

'''G.1 '''

Old code
<pre>
before(:each) do
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:team).and_return(team)
stub_current_user(instructor, instructor.role.name, instructor.role)
allow(Assignment).to receive(:find).with('1').and_return(assignment)
@@ -91,29 +90,106 @@
end
end
</pre>

New code
<pre>
before(:each) do
allow(participant).to receive(:team).and_return(team)
stub_current_user(instructor, instructor.role.name, instructor.role)
allow(Assignment).to receive(:find).with('1').and_return(assignment)
@@ -91,29 +90,106 @@
end
end
</pre>

'''G.2 '''Remove xdescribe '#view_team' and change describe '#view_team' as follows.

Old code
<pre>
describe '#view_team' do
render_views
context 'when view_team page is viewed by a student who is also a TA for another course' do
it 'renders grades#view_team page' do
allow(participant).to receive(:team).and_return(team)
allow(AssignmentQuestionnaire).to receive(:find_by).with(assignment_id: 1, questionnaire_id: 1).and_return(assignment_questionnaire)
allow(AssignmentQuestionnaire).to receive(:where).with(any_args).and_return([assignment_questionnaire])
allow(assignment).to receive(:late_policy_id).and_return(false)
allow(assignment).to receive(:calculate_penalty).and_return(false)
allow(assignment).to receive(:compute_total_score).with(any_args).and_return(100)
allow(review_questionnaire).to receive(:get_assessments_round_for).with(participant, 1).and_return([review_response])
allow(Answer).to receive(:compute_scores).with([review_response], [question]).and_return(max: 95, min: 88, avg: 90)
params = {id: 1}
allow(TaMapping).to receive(:exists?).with(ta_id: 1, course_id: 1).and_return(true)
</pre>

New code
<pre>
describe '#view_team' do
render_views

# All stubs and factories are instantiated within this scope so as to not
# clash with other broken test.
# The names of the factories created for testing view_team
# have `_vt` suffix ```where necessary``` to differentiate them from
# the above declared factories

let(:student1_vt) { create(:student, name: "barry", id: 12) }
let(:student2_vt) { create(:student, name: "iris", id: 13) }

let(:tm_questionnaire) {
build(
:teammate_review_questionnaire,
id: 12,
questions: [question],
max_question_score: 5
)
}
let(:assignment_vt) {
create(:assignment, id: 6, max_team_size: 2,
questionnaires: [tm_questionnaire])
}
let(:assignment_questionnaire_vt) {
create(:tm_assignment_questionnaire, id: 12, used_in_round: nil,
assignment: assignment_vt, questionnaire: tm_questionnaire) }
let(:team_vt) { create(:assignment_team, id: 12,
assignment: assignment_vt) }
let(:participant_vt) { create(:participant, id: 12,
assignment: assignment_vt, user_id: student1_vt.id) }
let(:participant2_vt) { create(:participant, id: 13,
assignment: assignment_vt, user_id: student2_vt.id) }

before(:each) do
# Need to stub this method so the factory instance with
# the stubbed :team method is returned by :find
# instead of a separate instance with the same data
allow(AssignmentParticipant)
.to receive(:find)
.with(participant_vt.id.to_s)
.and_return(participant_vt)
allow(participant_vt).to receive(:team).and_return(team_vt)
allow(team_vt).to receive(:participants).and_return([participant_vt, participant2_vt])
allow(AssignmentQuestionnaire)
.to receive(:find_by)
.with(assignment_id: assignment_vt.id, questionnaire_id: tm_questionnaire.id)
.and_return(assignment_questionnaire_vt)
allow(AssignmentQuestionnaire)
.to receive(:find_by)
.with(assignment_id: assignment.id, questionnaire_id: review_questionnaire.id)
.and_return(assignment_questionnaire_vt)
allow(AssignmentQuestionnaire)
.to receive(:where)
.with(any_args)
.and_return([assignment_questionnaire_vt])
allow(assignment_vt)
.to receive(:late_policy_id)
.and_return(false)
allow(assignment_vt)
.to receive(:calculate_penalty)
.and_return(false)
allow(assignment_vt)
.to receive(:compute_total_score)
.with(any_args)
.and_return(100)
allow(review_questionnaire).to receive(:get_assessments_round_for).with(participant, 1).and_return([review_response])
allow(Answer).to receive(:compute_scores).with([review_response], [question]).and_return(max: 95, min: 88, avg: 90)
end

it 'renders grades#view_team page' do
params = {id: participant_vt.id}
get :view_team, params
expect(response).to render_template(:view_team)
end

context 'when view_team page is opened by student' do
it 'dropdown is not rendered' do
session = { user: student1_vt }
params = {id: participant_vt.id}
stub_current_user(student1_vt, student1_vt.role.name, student1_vt.role)
get :view_team, params
expect(response.body).to_not have_selector('select')
end
end

context 'when view_team page is opened by instructor' do
it 'dropdown is rendered' do
session = { user: instructor }
params = {id: participant_vt.id}
get :view_team, params
expect(response.body).to have_selector('select')
end
end

context 'when view_team page is viewed by a student who is also a TA for another course' do
it 'renders grades#view_team page' do
params = { id: participant_vt.id }
allow(TaMapping).to receive(:exists?).with(ta_id: participant_vt.user_id, course_id: 1).and_return(true)
</pre>

====H. In spec/factories/factories.rb:====

'''H.1 '''Add the following factory:

<pre>
factory :teammate_review_questionnaire, class: TeammateReviewQuestionnaire do
</pre>

'''H.2 '''Add another factory

<pre>
factory :tm_assignment_questionnaire, class: AssignmentQuestionnaire do
user_id 1
questionnaire { association(:teammate_review_questionnaire) }
questionnaire_weight 100
used_in_round nil
topic_id nil
dropdown 1
end
</pre>

=== Summary of file changes ===

The following files are modified:

1. app/controllers/grades_controller.rb - Controller file which changed how the view model is populated

2. app/views/grades/view_team.html.erb - View file, which conditionally rendered the teammate name, for a teammate review heatgrid

3. spec/controllers/grades_controller_spec.rb - For tests verifying the proposed changes

4. app/models/vm_question_response.rb - To modify the view-model so it can tell us the name of the person being reviewed for the current heatgrid

5. app/models/vm_question_response_score_cell.rb -

6. app/assets/stylesheets/grades.scss -

7. app/views/grades/_add_icon_to_name.html.erb -

8. spec/factories/factories.rb -

== Design Patterns ==

Existing code does not use any design patterns, apart from if-else. It uses if-else conditional statements to check what type of questionnaire is present in the viewmodel `VmQuestionResponse`, and based on that, it renders the appropriate content.

We decided to continue with this approach since to change the present coding style, there were required many changes (refactoring) to many files which were out of the scope of the present project. To complete the project in the assigned time, we followed the if-else approach.

== Testing ==
'''OLD STATUS'''

1. Earlier, the tests only covered if the view_team is page is rendered when it is asked for. This can be seen on the line 94 and 103 in [https://github.com/expertiza/expertiza/blob/beta/spec/controllers/grades_controller_spec.rb this] file.

'''NEW STATUS'''

1. The view_team page is rendered correctly for a given student or an instructor.

2. When students access then the view_team page, the dropdown to select a student's teammate reviews is not rendered on the page.

3. When instructor access then the view_team page, the dropdown to select a student's teammate reviews is rendered on the page.

4. When a student who is also a TA for another course access the view_team page, that student should be able to a student's view to the page.

5. If show_teammate_reviews boolean is set to False, then the student should not be able to see the teammate reviews given to him/her. If it is set to True, then the student should be able to see the reviews.

6. An instructor should be able to see the teammate reviews for all students regardless of whether the show_teammate_reviews boolean is set to True or False.

7. The reviewer id is tracked correctly to show the correct reviewer name in the teammate reviews table. This can be seen on line 27 in [https://github.com/expertiza/expertiza/blob/66239d9a8a53697ea170a92208593b36d06dfd24/spec/models/vm_question_response_score_cell_spec.rb this] file

8. An instructor can select which student's scores he/she wants to see. If no student's name is selected then the professor can see the scores of all the students.

==References==

<p>https://expertiza.ncsu.edu/</p>

CSC/ECE 517 Fall 2021 - E2165. Fix teammate-review view

2021-11-28T18:21:20Z

Vdeshmu: /* E. In app/views/grades/_add_icon_to_name.html.erb: */

== Team Introduction ==

Dr. Edward Gehringer (instructor), Parimal Mehta (mentor)

1. Anjali Garg (unity ID : agarg25)

2. Arvasu Chikara (unity ID: achikar2)

3. Lalit Bangad (unity ID: llbangad)

4. Vinay Deshmukh (unity ID: vdeshmu)

== Problems to be addressed ==

After a project is submitted and reviewed, both the team members (students) and instructors should be able to view the teammate reviews. Students should be able to view the reviews by going to a particular assignment's -> your scores, at the bottom of the page. An instructor can view the teammate reviews by going to assignments -> assignment -> particular team's submission -> view submission -> assign grades -> view scores.

In the case of the instructor, a single heat grid is shown whereas in the case of a team member, we cant view the scores. In the heat grid, it is not clear if the scores visible are for the reviews that the student has *written* for their teammates or the scores that the student has *received* from their teammates. Additionally, for instructors can choose from a list of the students on the team, but they have no way to tell whether the heat grid shows the reviews done *by* that student or done *for* that student.

== Methodology Overview ==

We have divided our work in the following tasks to address the above problems:

1. Distinguish reviews done for a student by rendering separates heatgrids for each student

2. For instructors, the table will have sections based on the students

3. Include a checkbox on the edit assignment page that enables/disables visibility of heat grid to students

4. Fix the average column for a table (which breaks for some reviews)

5. Show a composite score derived from all reviews. Make this code generalized, so other kinds of heat grid views could use it.

6. Changes should work even in an anonymized view

== Motivations ==

1. Enable users to clearly tell which reviews are done by them, and which reviews are done for them.

2. Code should be generic so it can be used for different types of heat grids as well.

== Control Flow to access the concerned screens ==
'''1. For instructor (Log in as an instructor):-'''

Screen after logging in by the instructor
[[File:ss1.png |border|1000px|center]]
Got to assignments on the Manage menu
[[File:ss2.png |border|1000px|center]]
Go to assignments
[[File:ss3.png |border|1000px|center]]
Go to submissions for any assignment
[[File:ss4a.png |border|1000px|center]]
Go to Assign Grade
[[File:ss5a.png |border|1000px|center]]
You will land on the page where the changes are made and can be reviewed
[[File:ss7a.png |border|1000px|center]]

'''2. Student:- (Logged in as an instructor)'''

After landing on the assignments page, select any student from an assignment as shown below
[[File:ss6a.png |border|1000px|center]]
Go to/Select any assignment
[[File:ss9a.png |border|1000px|center]]
Go to your scores
[[File:ss10a.png |border|1000px|center]]
You will land on the page where the changes are made and can be reviewed
[[File:ss11a.png |border|1000px|center]]

== Old Status of the application ==

'''1. Instructor's view of teammate review''': This is the current screen given to the instructor. Here we see that the instructor can not determine who has given which review to which student in a team.

[[File:Instructor-view-1.png|border| 700px |center|alt=The proposed expanded student display.|The proposed expanded student display.]]

'''2. Student's view of teammate review''': Currently, a student is not able to see what grades were given by their teammates. We need to implement that functionality so that the student is able to view those grades.

[[File:Student-view-2.png|border| 700px |center|alt=The current instructor view.|The current review display for instructors.]]

'''3. Error in existing UI for student''': In the existing UI for a student, the highlighted block should not be rendered. This part of the screen is meant for the instructors/TAs.

[[File:Wrong render for student.png|border|700px|center|alt=Existing UI for student|Existing UI for student.]]

== Proposed changes ==

''' 1) Proposed UI for instructor ''': The instructor is able to see the score for all teammates. In the existing code, only one teammate's scores are being shown. But, we are planning to change the way the (VmQuestionResponse array is populated)[https://github.com/expertiza/expertiza/blob/master/app/controllers/grades_controller.rb#L114], so that the scores for all teammates are appended to it so it correctly shows what should have already been shown in this screen for the instructor.

[[File:Proposed_screen.png|border|700px|center|alt=Proposed UI for instructor|Proposed UI for instructor.]]

Note: When a student visits this screen, they will only be shown the reviews received by them, assuming the instructor has allowed visibility of teammate reviews to students.

''' 2) Show detailed review for a particular question''': The instructor can see detailed review given to a student by their teammates by clicking on a particular question number in the table.

[[File:ss12a.png|border|700px|center|alt=New UI for students|New UI for students ]]

''' 3) Show teammate review to student UI ''': The existing code doesn't render a student's teammate review scores at all. We are planning to render the scores to a student (as shown below) when they visit this screen. However, the visibility of this screen is contingent on whether the instructor has allowed visibility of the teammate review screen to students. If the instructor has disabled this feature, then the heatgrid will not be displayed at all.

[[File:UI_for_student.png|border|700px|center|alt=New UI for students|New UI for students ]]

== Models used / Explanation of fixes ==

The below diagram illustrates the proposed code change for showing all team members with the teammate review data to an instructor. The existing code only iterated on the `Participant` whose ID is present in the URL of the page. To fix this, we will iterate over all teammates of the given participant so that all teammate reviews for all team members are shown to the instructor.

[[File:Logic e2165.png|border|center|alt=Flow diagram of proposed changes for showing team review data to instructor]]

===Changes made to the code are shown below. Every change is shown and explained separately===

====A. Added the following to app/assets/stylesheets/grades.scss:====
<pre>
.teammate_table.hidden {
display: none;
}
</pre>

====B. In app/controllers/grades_controller.rb: ====

'''B.1:'''

Old code: The existing code does not differentiate when adding a view model for the TeammateReview questionnaire
questionnaires.each do |questionnaire|
...
@vmlist << populate_view_model(questionnaire)
end

New code: Since the current page URL contains an ID for the participant, from which we get an assignment, which gives us a list of questionnaires, we need to iterate all participants for a `TeammateReveiwQuestionnaire` questionnaire, so that we get the heatgrid view models for all members of a team.
questionnaires.each do |questionnaire|
...
if questionnaire.type == "TeammateReviewQuestionnaire"
# as teammate review will be different for each participant
# we need to create a separate table for each teammate
@participant.team.participants.each do |team_participant|
@vmlist << populate_view_model(team_participant, questionnaire, @team)
end
else
# only one participant needs iterating, as apart from teammatereview
# all other reviews are at "team" level
@vmlist << populate_view_model(@participant, questionnaire, @team)
end
end

'''B.2: '''

Old code: This code uses @participant as an instance variable, but this structure will not work as we need to call this ViewModel with multiple participants when iterating for a teammate review questionnaire.
def populate_view_model(questionnaire)
vm = VmQuestionResponse.new(questionnaire, @assignment, @round)
vmquestions = questionnaire.questions
vm.add_questions(vmquestions)
vm.add_team_members(@team)
vm.add_reviews(@participant, @team, @assignment.vary_by_round)
vm.number_of_comments_greater_than_10_words
vm
end

New code: We need to call this function with a separate participant in each invocation due to our change for TeammateReviewQuestionnaire, hence it makes sense to make `participant` as an argument to this function. Similarly, as `team` is a closely related model to `participant`, we are passing it as an argument, to keep this function as "pure" as possible.
def populate_view_model(participant, questionnaire, team)
...
vm.add_team_members(team)
vm.add_reviews(participant, team, @assignment.vary_by_round)
...
end

====C. In app/models/vm_question_response.rb:====

'''C.1: '''Added the reviewee_id method: Created a helper method within the VmQuestionReponse model to retrieve the `reviewee_id` for a heatgrid

def reviewee_id
@participant_who_is_reviewee.user_id
end

'''C.2: '''Added the reviewee_name method: Created a helper method within the VmQuestionReponse model to retrieve the name of the student who is being reviewed for a heatgrid. This method uses the functionality to anonymize the name when we are in anonymized view.

def reviewee_name(ip_address = nil)
part = @participant_who_is_reviewee
User.find_by(id: part.user_id).fullname(ip_address)
end

'''C.3: '''

Old code: Does not keep track of the student being reviewed
elsif @questionnaire_type == "TeammateReviewQuestionnaire"
reviews = participant.teammate_reviews
reviews.each do |review|
review_mapping = TeammateReviewResponseMap.find_by(id: review.map_id)
participant = Participant.find(review_mapping.reviewer_id)

New code: Add an instance variable to keep track of the student who is being reviewed in this VmQuestionReponse
elsif @questionnaire_type == "TeammateReviewQuestionnaire"
reviews = participant.teammate_reviews
@participant_who_is_reviewee = participant
reviews.each do |review|
review_mapping = TeammateReviewResponseMap.find_by(id: review.map_id)
participant = Participant.find(review_mapping.reviewer_id)

'''C.4: '''

Old code: Existing VmQuestionReponseScoreCell keeps no information about the reviewer, as it only stores the answer score
row.score_row.push(VmQuestionResponseScoreCell.new(answer.answer, color_code, answer.comments, vm_tag_prompts))

New code: Keep track of the response ID, so that we can retrieve the user ID for the reviewer in the model to use in the view file.

row.score_row.push(VmQuestionResponseScoreCell.new(answer.answer, color_code, answer.comments, vm_tag_prompts, answer.response_id))

====D. In app/models/vm_question_response_score_cell.rb:====

'''D.1: '''In the method initialize of class VmQuestionResponseScoreCell

Old code: Existing code doesn't keep track of the response id
def initialize(score_value, color_code, comments, vmprompts = nil)
@score_value = score_value
@color_code = color_code
@comment = comments
@vm_prompts = vmprompts
end

New code: We added an instance variable to keep track of response_id

def initialize(score_value, color_code, comments, vmprompts = nil, response_id)
...
@response_id = response_id
end

'''D.2: '''Added a method reviewer_id to the class VmQuestionResponseScoreCell: This helper method retrieves the ID for the reviewer who created this response.

def reviewer_id
resp = Response.find(@response_id)
map = ResponseMap.find(resp.map_id)
map.reviewer_id
end

====E. In app/views/grades/_add_icon_to_name.html.erb:====

'''E.1 '''Added the following code to the file: Write the code to generate the review text only once to reduce WET code

<%# Determine the content of the reviewed by text %>
<% review_text = "" %>
<% if @current_role_name.eql?'Student' or questionnaire_type != "TeammateReviewQuestionnaire" %>
<%# Use Review {{index}} format for student view, and when questionnaire_type is not teammatereview %>
<% review_text = "Review #{i + 1}" %>
<% else %>
<% resp = Response.find(review.id) %>
<% map = ResponseMap.find(resp.map_id) %>
<% reviewer_id = map.reviewer_id %>
<% fullname = Participant.find_by(id: reviewer_id).fullname(session[:ip]) %>
<% review_text = "Review by #{fullname}" %>
<% end%>

'''E.2: '''

Old code: Existing code is very unreadable as it's not indented, and written in a single line with 359 characters, which breaks the ruby style guide rules

<% if review.done_by_staff_participant? %>
<th class="sorter-false"> <img data-toggle="tooltip" data-placement="right" title="Icon indicates this review was done by course staff" class="img_icon" src="/assets/staff.png"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% else %>
<th class="sorter-false"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% end %>

New code: Correctly indented and removes WET repetition of code blocks and makes the resulting code DRYer

<th class="sorter-false">
<% if review.done_by_staff_participant? %>
<img
data-toggle="tooltip"
data-placement="right"
title="Icon indicates this review was done by course staff" class="img_icon"
src="/assets/staff.png"
>
<% end %>
<a
target="_blank"
href="../response/view?id=<%= review.id.to_s %>"
data-toggle="tooltip"
data-placement="right"
title="Click to see details">
<%= review_text %>
</a>
</th>

====F.In app/views/grades/view_team.html.erb:====

'''F.1: '''Added function teammateSelectOnChange:

<pre>
function teammateSelectOnChange(selectNode) {
const revieweeIdToShow= selectNode.value;
const tableSelector = ".teammate_table";
if(revieweeIdToShow == "all") {
document.querySelectorAll(tableSelector).forEach((tableNode) => {
tableNode.classList.remove("hidden");
});
return;
}

document.querySelectorAll(tableSelector).forEach((tableNode) => {
const tableRevieweeId = tableNode.getAttribute('data-reviewee_id');
if(tableRevieweeId == revieweeIdToShow) {
tableNode.classList.remove("hidden");
} else {
tableNode.classList.add("hidden");
}
});
}
</pre>

'''F.2: '''

Old code
<pre>
<% @vmlist.each do |vm| %>
<% if (vm.questionnaire_display_type == "Metareview" or vm.questionnaire_display_type == "Author Feedback" or vm.questionnaire_display_type == "Teammate Review") and @current_role_name.eql?'Student' %>
<% else %>
<% if vm.list_of_reviewers.length > 0 %>



@@ -87,6 +131,8 @@
<h4 style="display:inline-block;"><%= vm.questionnaire_display_type %>
<% if vm.questionnaire_type == "ReviewQuestionnaire" %>
(Round: <%= vm.round.to_s %> of <%= vm.rounds.to_s %>)
<%end %>
</pre>

New code
<pre>
<%# This boolean is used to render a dropdown just before the first teammate review heat grid %>
<% first_teammate_review_appeared = false %>
<% @vmlist.each do |vm| %>
<% if not @current_role_name.eql?'Student' and not first_teammate_review_appeared and vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
<div>
<select onchange="teammateSelectOnChange(this)">
<option value="all">All</option>
<% @vmlist.select { |tm_vm| tm_vm.questionnaire_type == "TeammateReviewQuestionnaire" }.each do |tm_vm| %>
<option value="<%= tm_vm.reviewee_id %>">
<%= tm_vm.reviewee_name(session[:ip]) %>
</option>
<% end %>
</select>
</div>
<% first_teammate_review_appeared = true %>
<% end %>
<% if (vm.questionnaire_display_type == "Metareview" or vm.questionnaire_display_type == "Author Feedback") and @current_role_name.eql?'Student' %>
<% elsif (vm.questionnaire_type == "TeammateReviewQuestionnaire" and @current_role_name.eql?'Student' and !@assignment.show_teammate_reviews)%>
<% elsif (vm.questionnaire_type == "TeammateReviewQuestionnaire" and @current_role_name.eql?'Student' and @assignment.show_teammate_reviews and current_user.id != vm.reviewee_id )%>
<% else %>
<% if vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
<div class="teammate_table" data-reviewee_id="<%= vm.reviewee_id %>">
<% else %>
<div>
<% end %>
</pre>

'''F.3 '''

Old code
<pre>

@@ -87,6 +131,8 @@
<h4 style="display:inline-block;"><%= vm.questionnaire_display_type %>
<% if vm.questionnaire_type == "ReviewQuestionnaire" %>
(Round: <%= vm.round.to_s %> of <%= vm.rounds.to_s %>)
<%end %>
</pre>

New code
<pre>

@@ -87,6 +131,8 @@
<h4 style="display:inline-block;"><%= vm.questionnaire_display_type %>
<% if vm.questionnaire_type == "ReviewQuestionnaire" %>
(Round: <%= vm.round.to_s %> of <%= vm.rounds.to_s %>)
<% elsif vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
(For: <%= vm.reviewee_name(session[:ip]) %>)
<%end %>
</pre>

'''F.4 '''

Old code
<pre>
<% vm.list_of_reviews.each do |review| %>

<% if (['Student'].include? @current_role_name) && @assignment.is_anonymous%>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i} %>
<% else %>
<% user_name = User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).fullname(session[:ip]).to_s %>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i} %>
<% end %>
<% i += 1 %>
<% end %>

<th class="sorter-true" align="right" >
Avg<span></span>
</th>
<th class="sorter-false">
<span data-toggle="tooltip" data-placement="right" title="A count of comments, for the respective question, which have word count > 10. The purpose of this metric is to represent how many comments for the question are of a substantial length to provide quality feedback.">metric-1</span>
</th>
</tr>
</thead>
</pre>

New code
<pre>
<% vm.list_of_reviews.each do |review| %>

<% if (['Student'].include? @current_role_name) && @assignment.is_anonymous%>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i, questionnaire_type: vm.questionnaire_type } %>
<% else %>
<% user_name = User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).fullname(session[:ip]).to_s %>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i, questionnaire_type: vm.questionnaire_type } %>
<% end %>
<% i += 1 %>
<% end %>

<th class="sorter-true" align="right" >
Avg<span></span>
</th>
</tr>
</thead>
</pre>

'''F.5 '''

Old code
<pre>
<% vm.list_of_rows.each do |row| %>

<tr data-toggle="collapse" class="accordion-toggle" data-target="#hid<%= row.question_id.to_s + vm.round.to_s %>">
<td class = 'cf' data-toggle="tooltip" title="<%= row.question_text %>"> <div style='float: left'><%= j.to_s %></div><div style='float: right'> &#<%= type_and_max(row) %>;</div> </td>


<% row.score_row.each do |score| %>
<% score_comment = score.comment.nil? ? '' : score.comment %> 
<td class="<%= score.color_code %>" align="center" data-toggle="tooltip" title="<%= strip_tags(score.comment).html_safe%>">
<span class="<%= underlined?(score) %>"><%= score.score_value.to_s %></span>
</td>
<% end %>
</pre>

New code
<pre>
<% vm.list_of_rows.each do |row| %>
<% target_id = "hid__#{row.question_id}__#{vm.round}" %>
<% if vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
<%# Since we render different heatgrids with the same questions for each
teammember, we need to distinguish the ID, based on the user for whom,
the reviews have been created. %>
<% target_id += "__#{vm.reviewee_id}" %>
<% end%>


<tr data-toggle="collapse" class="accordion-toggle" data-target="<%= "#" + target_id %>">
<td class = 'cf' data-toggle="tooltip" title="<%= row.question_text %>"> <div style='float: left'><%= j.to_s %></div><div style='float: right'> &#<%= type_and_max(row) %>;</div> </td>


<% row.score_row.each do |score| %>
<% score_comment = score.comment.nil? ? '' : score.comment %>

<td class="<%= score.color_code %>" align="center" data-toggle="tooltip" title="<%= strip_tags(score.comment).html_safe%>">
<span class="<%= underlined?(score) %>">
<%= score.score_value.to_s %>
</span>
</td>
<% end %>
</pre>

'''F.6 '''Removed the following code.

<pre>
<td class = 'cf' align="center">
<%= row.countofcomments.to_s %>
</td>
</pre>

'''F.7 '''

Old code
<pre>

<tr class="tablesorter-childRow">
<td colspan="<%= (i+1).to_s %>" class="hiddenRow" ><div id="hid<%= row.question_id.to_s + vm.round.to_s %>" class="accordion-body collapse" style="margin-left:10px;">
<div style="padding-top: 10px; padding-bottom: 10px;"><%= sanitize row.question_text %></div>
<div>
<table class="table tbl_questlist">
@@ -181,7 +233,17 @@
</thead>
<% for index in 0 .. row.score_row.length - 1 %>
<tr>
<td>Review <%=index + 1%></td>
</pre>

New code
<pre>

<tr class="tablesorter-childRow">
<td colspan="<%= (i+1).to_s %>" class="hiddenRow" ><div id="<%= target_id %>" class="accordion-body collapse" style="margin-left:10px;">
<div style="padding-top: 10px; padding-bottom: 10px;"><%= sanitize row.question_text %></div>
<div>
<table class="table tbl_questlist">
@@ -181,7 +233,17 @@
</thead>
<% for index in 0 .. row.score_row.length - 1 %>
<tr>
<% if @current_role_name.eql?'Student' or vm.questionnaire_type != "TeammateReviewQuestionnaire" %>
<%# Use Review {{index}} format for student view, and
when questionnaire_type is not teammatereview %>
<td>Review <%=index + 1%></td>
<% else %>
<td>
<% reviewer_id = row.score_row[index].reviewer_id %>
<% fullname = Participant.find_by(id: reviewer_id).fullname(session[:ip]) %>
Review by <%= fullname %>
</td>
<% end%>
</pre>

====G. In spec/controllers/grades_controller_spec.rb:====

'''G.1 '''

Old code
<pre>
before(:each) do
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:team).and_return(team)
stub_current_user(instructor, instructor.role.name, instructor.role)
allow(Assignment).to receive(:find).with('1').and_return(assignment)
@@ -91,29 +90,106 @@
end
end
</pre>

New code
<pre>
before(:each) do
allow(participant).to receive(:team).and_return(team)
stub_current_user(instructor, instructor.role.name, instructor.role)
allow(Assignment).to receive(:find).with('1').and_return(assignment)
@@ -91,29 +90,106 @@
end
end
</pre>

'''G.2 '''Remove xdescribe '#view_team' and change describe '#view_team' as follows.

Old code
<pre>
describe '#view_team' do
render_views
context 'when view_team page is viewed by a student who is also a TA for another course' do
it 'renders grades#view_team page' do
allow(participant).to receive(:team).and_return(team)
allow(AssignmentQuestionnaire).to receive(:find_by).with(assignment_id: 1, questionnaire_id: 1).and_return(assignment_questionnaire)
allow(AssignmentQuestionnaire).to receive(:where).with(any_args).and_return([assignment_questionnaire])
allow(assignment).to receive(:late_policy_id).and_return(false)
allow(assignment).to receive(:calculate_penalty).and_return(false)
allow(assignment).to receive(:compute_total_score).with(any_args).and_return(100)
allow(review_questionnaire).to receive(:get_assessments_round_for).with(participant, 1).and_return([review_response])
allow(Answer).to receive(:compute_scores).with([review_response], [question]).and_return(max: 95, min: 88, avg: 90)
params = {id: 1}
allow(TaMapping).to receive(:exists?).with(ta_id: 1, course_id: 1).and_return(true)
</pre>

New code
<pre>
describe '#view_team' do
render_views

# All stubs and factories are instantiated within this scope so as to not
# clash with other broken test.
# The names of the factories created for testing view_team
# have `_vt` suffix ```where necessary``` to differentiate them from
# the above declared factories

let(:student1_vt) { create(:student, name: "barry", id: 12) }
let(:student2_vt) { create(:student, name: "iris", id: 13) }

let(:tm_questionnaire) {
build(
:teammate_review_questionnaire,
id: 12,
questions: [question],
max_question_score: 5
)
}
let(:assignment_vt) {
create(:assignment, id: 6, max_team_size: 2,
questionnaires: [tm_questionnaire])
}
let(:assignment_questionnaire_vt) {
create(:tm_assignment_questionnaire, id: 12, used_in_round: nil,
assignment: assignment_vt, questionnaire: tm_questionnaire) }
let(:team_vt) { create(:assignment_team, id: 12,
assignment: assignment_vt) }
let(:participant_vt) { create(:participant, id: 12,
assignment: assignment_vt, user_id: student1_vt.id) }
let(:participant2_vt) { create(:participant, id: 13,
assignment: assignment_vt, user_id: student2_vt.id) }

before(:each) do
# Need to stub this method so the factory instance with
# the stubbed :team method is returned by :find
# instead of a separate instance with the same data
allow(AssignmentParticipant)
.to receive(:find)
.with(participant_vt.id.to_s)
.and_return(participant_vt)
allow(participant_vt).to receive(:team).and_return(team_vt)
allow(team_vt).to receive(:participants).and_return([participant_vt, participant2_vt])
allow(AssignmentQuestionnaire)
.to receive(:find_by)
.with(assignment_id: assignment_vt.id, questionnaire_id: tm_questionnaire.id)
.and_return(assignment_questionnaire_vt)
allow(AssignmentQuestionnaire)
.to receive(:find_by)
.with(assignment_id: assignment.id, questionnaire_id: review_questionnaire.id)
.and_return(assignment_questionnaire_vt)
allow(AssignmentQuestionnaire)
.to receive(:where)
.with(any_args)
.and_return([assignment_questionnaire_vt])
allow(assignment_vt)
.to receive(:late_policy_id)
.and_return(false)
allow(assignment_vt)
.to receive(:calculate_penalty)
.and_return(false)
allow(assignment_vt)
.to receive(:compute_total_score)
.with(any_args)
.and_return(100)
allow(review_questionnaire).to receive(:get_assessments_round_for).with(participant, 1).and_return([review_response])
allow(Answer).to receive(:compute_scores).with([review_response], [question]).and_return(max: 95, min: 88, avg: 90)
end

it 'renders grades#view_team page' do
params = {id: participant_vt.id}
get :view_team, params
expect(response).to render_template(:view_team)
end

context 'when view_team page is opened by student' do
it 'dropdown is not rendered' do
session = { user: student1_vt }
params = {id: participant_vt.id}
stub_current_user(student1_vt, student1_vt.role.name, student1_vt.role)
get :view_team, params
expect(response.body).to_not have_selector('select')
end
end

context 'when view_team page is opened by instructor' do
it 'dropdown is rendered' do
session = { user: instructor }
params = {id: participant_vt.id}
get :view_team, params
expect(response.body).to have_selector('select')
end
end

context 'when view_team page is viewed by a student who is also a TA for another course' do
it 'renders grades#view_team page' do
params = { id: participant_vt.id }
allow(TaMapping).to receive(:exists?).with(ta_id: participant_vt.user_id, course_id: 1).and_return(true)
</pre>

====H. In spec/factories/factories.rb:====

'''H.1 '''Add the following factory:

<pre>
factory :teammate_review_questionnaire, class: TeammateReviewQuestionnaire do
</pre>

'''H.2 '''Add another factory

<pre>
factory :tm_assignment_questionnaire, class: AssignmentQuestionnaire do
user_id 1
questionnaire { association(:teammate_review_questionnaire) }
questionnaire_weight 100
used_in_round nil
topic_id nil
dropdown 1
end
</pre>

=== Summary of file changes ===

The following files are modified:

1. app/controllers/grades_controller.rb - Controller file which changed how the view model is populated

2. app/views/grades/view_team.html.erb - View file, which conditionally rendered the teammate name, for a teammate review heatgrid

3. spec/controllers/grades_controller_spec.rb - For tests verifying the proposed changes

4. app/models/vm_question_response.rb - To modify the view-model so it can tell us the name of the person being reviewed for the current heatgrid

5. app/models/vm_question_response_score_cell.rb -

6. app/assets/stylesheets/grades.scss -

7. app/views/grades/_add_icon_to_name.html.erb -

8. spec/factories/factories.rb -

== Design Patterns ==

Existing code does not use any design patterns, apart from if-else. It uses if-else conditional statements to check what type of questionnaire is present in the viewmodel `VmQuestionResponse`, and based on that, it renders the appropriate content.

We decided to continue with this approach since to change the present coding style, there were required many changes (refactoring) to many files which were out of the scope of the present project. To complete the project in the assigned time, we followed the if-else approach.

== User Stories ==

1. As an instructor, I can view what reviews one teammate has given to other teammates.

2. As a student, I can view what reviews my teammates have given to me.

3. As an instructor, I can choose if I want to see all student's teammates reviews together or one by one.

4. As a student, if I am also a TA for another subject, I should not be able to see an instructor's view to the view_team page.

5. As an instructor, I should be able to see the name of the reviewers for the reviews to a particular student.

== Testing ==
'''OLD STATUS'''

1. Earlier, the tests only covered if the view_team is page is rendered when it is asked for. This can be seen on the line 94 and 103 in [https://github.com/expertiza/expertiza/blob/beta/spec/controllers/grades_controller_spec.rb this] file.

'''NEW STATUS'''

1. The view_team page is rendered correctly for a given student or an instructor.

2. When students access then the view_team page, the dropdown to select a student's teammate reviews is not rendered on the page.

3. When instructor access then the view_team page, the dropdown to select a student's teammate reviews is rendered on the page.

4. When a student who is also a TA for another course access the view_team page, that student should be able to a student's view to the page.

5. If show_teammate_reviews boolean is set to False, then the student should not be able to see the teammate reviews given to him/her. If it is set to True, then the student should be able to see the reviews.

6. An instructor should be able to see the teammate reviews for all students regardless of whether the show_teammate_reviews boolean is set to True or False.

7. The reviewer id is tracked correctly to show the correct reviewer name in the teammate reviews table. This can be seen on line 27 in [https://github.com/expertiza/expertiza/blob/66239d9a8a53697ea170a92208593b36d06dfd24/spec/models/vm_question_response_score_cell_spec.rb this] file

8. An instructor can select which student's scores he/she wants to see. If no student's name is selected then the professor can see the scores of all the students.

==References==

<p>https://expertiza.ncsu.edu/</p>

CSC/ECE 517 Fall 2021 - E2165. Fix teammate-review view

2021-11-28T18:04:17Z

Vdeshmu: /* D. In app/models/vm_question_response_score_cell.rb: */

== Team Introduction ==

Dr. Edward Gehringer (instructor), Parimal Mehta (mentor)

1. Anjali Garg (unity ID : agarg25)

2. Arvasu Chikara (unity ID: achikar2)

3. Lalit Bangad (unity ID: llbangad)

4. Vinay Deshmukh (unity ID: vdeshmu)

== Problems to be addressed ==

After a project is submitted and reviewed, both the team members (students) and instructors should be able to view the teammate reviews. Students should be able to view the reviews by going to a particular assignment's -> your scores, at the bottom of the page. An instructor can view the teammate reviews by going to assignments -> assignment -> particular team's submission -> view submission -> assign grades -> view scores.

In the case of the instructor, a single heat grid is shown whereas in the case of a team member, we cant view the scores. In the heat grid, it is not clear if the scores visible are for the reviews that the student has *written* for their teammates or the scores that the student has *received* from their teammates. Additionally, for instructors can choose from a list of the students on the team, but they have no way to tell whether the heat grid shows the reviews done *by* that student or done *for* that student.

== Methodology Overview ==

We have divided our work in the following tasks to address the above problems:

1. Distinguish reviews done for a student by rendering separates heatgrids for each student

2. For instructors, the table will have sections based on the students

3. Include a checkbox on the edit assignment page that enables/disables visibility of heat grid to students

4. Fix the average column for a table (which breaks for some reviews)

5. Show a composite score derived from all reviews. Make this code generalized, so other kinds of heat grid views could use it.

6. Changes should work even in an anonymized view

== Motivations ==

1. Enable users to clearly tell which reviews are done by them, and which reviews are done for them.

2. Code should be generic so it can be used for different types of heat grids as well.

== Control Flow to access the concerned screens ==
'''1. For instructor (Log in as an instructor):-'''

Screen after logging in by the instructor
[[File:ss1.png |border|1000px|center]]
Got to assignments on the Manage menu
[[File:ss2.png |border|1000px|center]]
Go to assignments
[[File:ss3.png |border|1000px|center]]
Go to submissions for any assignment
[[File:ss4a.png |border|1000px|center]]
Go to Assign Grade
[[File:ss5a.png |border|1000px|center]]
You will land on the page where the changes are made and can be reviewed
[[File:ss7a.png |border|1000px|center]]

'''2. Student:- (Logged in as an instructor)'''

After landing on the assignments page, select any student from an assignment as shown below
[[File:ss6a.png |border|1000px|center]]
Go to/Select any assignment
[[File:ss9a.png |border|1000px|center]]
Go to your scores
[[File:ss10a.png |border|1000px|center]]
You will land on the page where the changes are made and can be reviewed
[[File:ss11a.png |border|1000px|center]]

== Old Status of the application ==

'''1. Instructor's view of teammate review''': This is the current screen given to the instructor. Here we see that the instructor can not determine who has given which review to which student in a team.

[[File:Instructor-view-1.png|border| 700px |center|alt=The proposed expanded student display.|The proposed expanded student display.]]

'''2. Student's view of teammate review''': Currently, a student is not able to see what grades were given by their teammates. We need to implement that functionality so that the student is able to view those grades.

[[File:Student-view-2.png|border| 700px |center|alt=The current instructor view.|The current review display for instructors.]]

'''3. Error in existing UI for student''': In the existing UI for a student, the highlighted block should not be rendered. This part of the screen is meant for the instructors/TAs.

[[File:Wrong render for student.png|border|700px|center|alt=Existing UI for student|Existing UI for student.]]

== Proposed changes ==

''' 1) Proposed UI for instructor ''': The instructor is able to see the score for all teammates. In the existing code, only one teammate's scores are being shown. But, we are planning to change the way the (VmQuestionResponse array is populated)[https://github.com/expertiza/expertiza/blob/master/app/controllers/grades_controller.rb#L114], so that the scores for all teammates are appended to it so it correctly shows what should have already been shown in this screen for the instructor.

[[File:Proposed_screen.png|border|700px|center|alt=Proposed UI for instructor|Proposed UI for instructor.]]

Note: When a student visits this screen, they will only be shown the reviews received by them, assuming the instructor has allowed visibility of teammate reviews to students.

''' 2) Show detailed review for a particular question''': The instructor can see detailed review given to a student by their teammates by clicking on a particular question number in the table.

[[File:ss12a.png|border|700px|center|alt=New UI for students|New UI for students ]]

''' 3) Show teammate review to student UI ''': The existing code doesn't render a student's teammate review scores at all. We are planning to render the scores to a student (as shown below) when they visit this screen. However, the visibility of this screen is contingent on whether the instructor has allowed visibility of the teammate review screen to students. If the instructor has disabled this feature, then the heatgrid will not be displayed at all.

[[File:UI_for_student.png|border|700px|center|alt=New UI for students|New UI for students ]]

== Models used / Explanation of fixes ==

The below diagram illustrates the proposed code change for showing all team members with the teammate review data to an instructor. The existing code only iterated on the `Participant` whose ID is present in the URL of the page. To fix this, we will iterate over all teammates of the given participant so that all teammate reviews for all team members are shown to the instructor.

[[File:Logic e2165.png|border|center|alt=Flow diagram of proposed changes for showing team review data to instructor]]

===Changes made to the code are shown below. Every change is shown and explained separately===

====A. Added the following to app/assets/stylesheets/grades.scss:====
<pre>
.teammate_table.hidden {
display: none;
}
</pre>

====B. In app/controllers/grades_controller.rb: ====

'''B.1:'''

Old code: The existing code does not differentiate when adding a view model for the TeammateReview questionnaire
questionnaires.each do |questionnaire|
...
@vmlist << populate_view_model(questionnaire)
end

New code: Since the current page URL contains an ID for the participant, from which we get an assignment, which gives us a list of questionnaires, we need to iterate all participants for a `TeammateReveiwQuestionnaire` questionnaire, so that we get the heatgrid view models for all members of a team.
questionnaires.each do |questionnaire|
...
if questionnaire.type == "TeammateReviewQuestionnaire"
# as teammate review will be different for each participant
# we need to create a separate table for each teammate
@participant.team.participants.each do |team_participant|
@vmlist << populate_view_model(team_participant, questionnaire, @team)
end
else
# only one participant needs iterating, as apart from teammatereview
# all other reviews are at "team" level
@vmlist << populate_view_model(@participant, questionnaire, @team)
end
end

'''B.2: '''

Old code: This code uses @participant as an instance variable, but this structure will not work as we need to call this ViewModel with multiple participants when iterating for a teammate review questionnaire.
def populate_view_model(questionnaire)
vm = VmQuestionResponse.new(questionnaire, @assignment, @round)
vmquestions = questionnaire.questions
vm.add_questions(vmquestions)
vm.add_team_members(@team)
vm.add_reviews(@participant, @team, @assignment.vary_by_round)
vm.number_of_comments_greater_than_10_words
vm
end

New code: We need to call this function with a separate participant in each invocation due to our change for TeammateReviewQuestionnaire, hence it makes sense to make `participant` as an argument to this function. Similarly, as `team` is a closely related model to `participant`, we are passing it as an argument, to keep this function as "pure" as possible.
def populate_view_model(participant, questionnaire, team)
...
vm.add_team_members(team)
vm.add_reviews(participant, team, @assignment.vary_by_round)
...
end

====C. In app/models/vm_question_response.rb:====

'''C.1: '''Added the reviewee_id method: Created a helper method within the VmQuestionReponse model to retrieve the `reviewee_id` for a heatgrid

def reviewee_id
@participant_who_is_reviewee.user_id
end

'''C.2: '''Added the reviewee_name method: Created a helper method within the VmQuestionReponse model to retrieve the name of the student who is being reviewed for a heatgrid. This method uses the functionality to anonymize the name when we are in anonymized view.

def reviewee_name(ip_address = nil)
part = @participant_who_is_reviewee
User.find_by(id: part.user_id).fullname(ip_address)
end

'''C.3: '''

Old code: Does not keep track of the student being reviewed
elsif @questionnaire_type == "TeammateReviewQuestionnaire"
reviews = participant.teammate_reviews
reviews.each do |review|
review_mapping = TeammateReviewResponseMap.find_by(id: review.map_id)
participant = Participant.find(review_mapping.reviewer_id)

New code: Add an instance variable to keep track of the student who is being reviewed in this VmQuestionReponse
elsif @questionnaire_type == "TeammateReviewQuestionnaire"
reviews = participant.teammate_reviews
@participant_who_is_reviewee = participant
reviews.each do |review|
review_mapping = TeammateReviewResponseMap.find_by(id: review.map_id)
participant = Participant.find(review_mapping.reviewer_id)

'''C.4: '''

Old code: Existing VmQuestionReponseScoreCell keeps no information about the reviewer, as it only stores the answer score
row.score_row.push(VmQuestionResponseScoreCell.new(answer.answer, color_code, answer.comments, vm_tag_prompts))

New code: Keep track of the response ID, so that we can retrieve the user ID for the reviewer in the model to use in the view file.

row.score_row.push(VmQuestionResponseScoreCell.new(answer.answer, color_code, answer.comments, vm_tag_prompts, answer.response_id))

====D. In app/models/vm_question_response_score_cell.rb:====

'''D.1: '''In the method initialize of class VmQuestionResponseScoreCell

Old code: Existing code doesn't keep track of the response id
def initialize(score_value, color_code, comments, vmprompts = nil)
@score_value = score_value
@color_code = color_code
@comment = comments
@vm_prompts = vmprompts
end

New code: We added an instance variable to keep track of response_id

def initialize(score_value, color_code, comments, vmprompts = nil, response_id)
...
@response_id = response_id
end

'''D.2: '''Added a method reviewer_id to the class VmQuestionResponseScoreCell: This helper method retrieves the ID for the reviewer who created this response.

def reviewer_id
resp = Response.find(@response_id)
map = ResponseMap.find(resp.map_id)
map.reviewer_id
end

====E. In app/views/grades/_add_icon_to_name.html.erb:====

'''E.1 '''Added the following code to the file:

<%# Determine the content of the reviewed by text %>
<% review_text = "" %>
<% if @current_role_name.eql?'Student' or questionnaire_type != "TeammateReviewQuestionnaire" %>
<%# Use Review {{index}} format for student view, and when questionnaire_type is not teammatereview %>
<% review_text = "Review #{i + 1}" %>
<% else %>
<% resp = Response.find(review.id) %>
<% map = ResponseMap.find(resp.map_id) %>
<% reviewer_id = map.reviewer_id %>
<% fullname = Participant.find_by(id: reviewer_id).fullname(session[:ip]) %>
<% review_text = "Review by #{fullname}" %>
<% end%>

'''E.2: '''

Old code

<% if review.done_by_staff_participant? %>
<th class="sorter-false"> <img data-toggle="tooltip" data-placement="right" title="Icon indicates this review was done by course staff" class="img_icon" src="/assets/staff.png"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% else %>
<th class="sorter-false"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% end %>

New code

<% if review.done_by_staff_participant? %>
<th class="sorter-false">
<img
data-toggle="tooltip"
data-placement="right"
title="Icon indicates this review was done by course staff" class="img_icon"
src="/assets/staff.png"
>
<a
target="_blank"
href="../response/view?id=<%= review.id.to_s %>"
data-toggle="tooltip"
data-placement="right"
title="Click to see details">
<%= review_text %>
</a>
</th>
<% else %>
<th class="sorter-false">
<a
target="_blank"
href="../response/view?id=<%= review.id.to_s %>"
data-toggle="tooltip"
data-placement="right"
title="Click to see details"
>
<%= review_text %>
</a>
</th>
<% end %>

====F.In app/views/grades/view_team.html.erb:====

'''F.1: '''Added function teammateSelectOnChange:

<pre>
function teammateSelectOnChange(selectNode) {
const revieweeIdToShow= selectNode.value;
const tableSelector = ".teammate_table";
if(revieweeIdToShow == "all") {
document.querySelectorAll(tableSelector).forEach((tableNode) => {
tableNode.classList.remove("hidden");
});
return;
}

document.querySelectorAll(tableSelector).forEach((tableNode) => {
const tableRevieweeId = tableNode.getAttribute('data-reviewee_id');
if(tableRevieweeId == revieweeIdToShow) {
tableNode.classList.remove("hidden");
} else {
tableNode.classList.add("hidden");
}
});
}
</pre>

'''F.2: '''

Old code
<pre>
<% @vmlist.each do |vm| %>
<% if (vm.questionnaire_display_type == "Metareview" or vm.questionnaire_display_type == "Author Feedback" or vm.questionnaire_display_type == "Teammate Review") and @current_role_name.eql?'Student' %>
<% else %>
<% if vm.list_of_reviewers.length > 0 %>



@@ -87,6 +131,8 @@
<h4 style="display:inline-block;"><%= vm.questionnaire_display_type %>
<% if vm.questionnaire_type == "ReviewQuestionnaire" %>
(Round: <%= vm.round.to_s %> of <%= vm.rounds.to_s %>)
<%end %>
</pre>

New code
<pre>
<%# This boolean is used to render a dropdown just before the first teammate review heat grid %>
<% first_teammate_review_appeared = false %>
<% @vmlist.each do |vm| %>
<% if not @current_role_name.eql?'Student' and not first_teammate_review_appeared and vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
<div>
<select onchange="teammateSelectOnChange(this)">
<option value="all">All</option>
<% @vmlist.select { |tm_vm| tm_vm.questionnaire_type == "TeammateReviewQuestionnaire" }.each do |tm_vm| %>
<option value="<%= tm_vm.reviewee_id %>">
<%= tm_vm.reviewee_name(session[:ip]) %>
</option>
<% end %>
</select>
</div>
<% first_teammate_review_appeared = true %>
<% end %>
<% if (vm.questionnaire_display_type == "Metareview" or vm.questionnaire_display_type == "Author Feedback") and @current_role_name.eql?'Student' %>
<% elsif (vm.questionnaire_type == "TeammateReviewQuestionnaire" and @current_role_name.eql?'Student' and !@assignment.show_teammate_reviews)%>
<% elsif (vm.questionnaire_type == "TeammateReviewQuestionnaire" and @current_role_name.eql?'Student' and @assignment.show_teammate_reviews and current_user.id != vm.reviewee_id )%>
<% else %>
<% if vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
<div class="teammate_table" data-reviewee_id="<%= vm.reviewee_id %>">
<% else %>
<div>
<% end %>
</pre>

'''F.3 '''

Old code
<pre>

@@ -87,6 +131,8 @@
<h4 style="display:inline-block;"><%= vm.questionnaire_display_type %>
<% if vm.questionnaire_type == "ReviewQuestionnaire" %>
(Round: <%= vm.round.to_s %> of <%= vm.rounds.to_s %>)
<%end %>
</pre>

New code
<pre>

@@ -87,6 +131,8 @@
<h4 style="display:inline-block;"><%= vm.questionnaire_display_type %>
<% if vm.questionnaire_type == "ReviewQuestionnaire" %>
(Round: <%= vm.round.to_s %> of <%= vm.rounds.to_s %>)
<% elsif vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
(For: <%= vm.reviewee_name(session[:ip]) %>)
<%end %>
</pre>

'''F.4 '''

Old code
<pre>
<% vm.list_of_reviews.each do |review| %>

<% if (['Student'].include? @current_role_name) && @assignment.is_anonymous%>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i} %>
<% else %>
<% user_name = User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).fullname(session[:ip]).to_s %>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i} %>
<% end %>
<% i += 1 %>
<% end %>

<th class="sorter-true" align="right" >
Avg<span></span>
</th>
<th class="sorter-false">
<span data-toggle="tooltip" data-placement="right" title="A count of comments, for the respective question, which have word count > 10. The purpose of this metric is to represent how many comments for the question are of a substantial length to provide quality feedback.">metric-1</span>
</th>
</tr>
</thead>
</pre>

New code
<pre>
<% vm.list_of_reviews.each do |review| %>

<% if (['Student'].include? @current_role_name) && @assignment.is_anonymous%>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i, questionnaire_type: vm.questionnaire_type } %>
<% else %>
<% user_name = User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).fullname(session[:ip]).to_s %>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i, questionnaire_type: vm.questionnaire_type } %>
<% end %>
<% i += 1 %>
<% end %>

<th class="sorter-true" align="right" >
Avg<span></span>
</th>
</tr>
</thead>
</pre>

'''F.5 '''

Old code
<pre>
<% vm.list_of_rows.each do |row| %>

<tr data-toggle="collapse" class="accordion-toggle" data-target="#hid<%= row.question_id.to_s + vm.round.to_s %>">
<td class = 'cf' data-toggle="tooltip" title="<%= row.question_text %>"> <div style='float: left'><%= j.to_s %></div><div style='float: right'> &#<%= type_and_max(row) %>;</div> </td>


<% row.score_row.each do |score| %>
<% score_comment = score.comment.nil? ? '' : score.comment %> 
<td class="<%= score.color_code %>" align="center" data-toggle="tooltip" title="<%= strip_tags(score.comment).html_safe%>">
<span class="<%= underlined?(score) %>"><%= score.score_value.to_s %></span>
</td>
<% end %>
</pre>

New code
<pre>
<% vm.list_of_rows.each do |row| %>
<% target_id = "hid__#{row.question_id}__#{vm.round}" %>
<% if vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
<%# Since we render different heatgrids with the same questions for each
teammember, we need to distinguish the ID, based on the user for whom,
the reviews have been created. %>
<% target_id += "__#{vm.reviewee_id}" %>
<% end%>


<tr data-toggle="collapse" class="accordion-toggle" data-target="<%= "#" + target_id %>">
<td class = 'cf' data-toggle="tooltip" title="<%= row.question_text %>"> <div style='float: left'><%= j.to_s %></div><div style='float: right'> &#<%= type_and_max(row) %>;</div> </td>


<% row.score_row.each do |score| %>
<% score_comment = score.comment.nil? ? '' : score.comment %>

<td class="<%= score.color_code %>" align="center" data-toggle="tooltip" title="<%= strip_tags(score.comment).html_safe%>">
<span class="<%= underlined?(score) %>">
<%= score.score_value.to_s %>
</span>
</td>
<% end %>
</pre>

'''F.6 '''Removed the following code.

<pre>
<td class = 'cf' align="center">
<%= row.countofcomments.to_s %>
</td>
</pre>

'''F.7 '''

Old code
<pre>

<tr class="tablesorter-childRow">
<td colspan="<%= (i+1).to_s %>" class="hiddenRow" ><div id="hid<%= row.question_id.to_s + vm.round.to_s %>" class="accordion-body collapse" style="margin-left:10px;">
<div style="padding-top: 10px; padding-bottom: 10px;"><%= sanitize row.question_text %></div>
<div>
<table class="table tbl_questlist">
@@ -181,7 +233,17 @@
</thead>
<% for index in 0 .. row.score_row.length - 1 %>
<tr>
<td>Review <%=index + 1%></td>
</pre>

New code
<pre>

<tr class="tablesorter-childRow">
<td colspan="<%= (i+1).to_s %>" class="hiddenRow" ><div id="<%= target_id %>" class="accordion-body collapse" style="margin-left:10px;">
<div style="padding-top: 10px; padding-bottom: 10px;"><%= sanitize row.question_text %></div>
<div>
<table class="table tbl_questlist">
@@ -181,7 +233,17 @@
</thead>
<% for index in 0 .. row.score_row.length - 1 %>
<tr>
<% if @current_role_name.eql?'Student' or vm.questionnaire_type != "TeammateReviewQuestionnaire" %>
<%# Use Review {{index}} format for student view, and
when questionnaire_type is not teammatereview %>
<td>Review <%=index + 1%></td>
<% else %>
<td>
<% reviewer_id = row.score_row[index].reviewer_id %>
<% fullname = Participant.find_by(id: reviewer_id).fullname(session[:ip]) %>
Review by <%= fullname %>
</td>
<% end%>
</pre>

====G. In spec/controllers/grades_controller_spec.rb:====

'''G.1 '''

Old code
<pre>
before(:each) do
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:team).and_return(team)
stub_current_user(instructor, instructor.role.name, instructor.role)
allow(Assignment).to receive(:find).with('1').and_return(assignment)
@@ -91,29 +90,106 @@
end
end
</pre>

New code
<pre>
before(:each) do
allow(participant).to receive(:team).and_return(team)
stub_current_user(instructor, instructor.role.name, instructor.role)
allow(Assignment).to receive(:find).with('1').and_return(assignment)
@@ -91,29 +90,106 @@
end
end
</pre>

'''G.2 '''Remove xdescribe '#view_team' and change describe '#view_team' as follows.

Old code
<pre>
describe '#view_team' do
render_views
context 'when view_team page is viewed by a student who is also a TA for another course' do
it 'renders grades#view_team page' do
allow(participant).to receive(:team).and_return(team)
allow(AssignmentQuestionnaire).to receive(:find_by).with(assignment_id: 1, questionnaire_id: 1).and_return(assignment_questionnaire)
allow(AssignmentQuestionnaire).to receive(:where).with(any_args).and_return([assignment_questionnaire])
allow(assignment).to receive(:late_policy_id).and_return(false)
allow(assignment).to receive(:calculate_penalty).and_return(false)
allow(assignment).to receive(:compute_total_score).with(any_args).and_return(100)
allow(review_questionnaire).to receive(:get_assessments_round_for).with(participant, 1).and_return([review_response])
allow(Answer).to receive(:compute_scores).with([review_response], [question]).and_return(max: 95, min: 88, avg: 90)
params = {id: 1}
allow(TaMapping).to receive(:exists?).with(ta_id: 1, course_id: 1).and_return(true)
</pre>

New code
<pre>
describe '#view_team' do
render_views

# All stubs and factories are instantiated within this scope so as to not
# clash with other broken test.
# The names of the factories created for testing view_team
# have `_vt` suffix ```where necessary``` to differentiate them from
# the above declared factories

let(:student1_vt) { create(:student, name: "barry", id: 12) }
let(:student2_vt) { create(:student, name: "iris", id: 13) }

let(:tm_questionnaire) {
build(
:teammate_review_questionnaire,
id: 12,
questions: [question],
max_question_score: 5
)
}
let(:assignment_vt) {
create(:assignment, id: 6, max_team_size: 2,
questionnaires: [tm_questionnaire])
}
let(:assignment_questionnaire_vt) {
create(:tm_assignment_questionnaire, id: 12, used_in_round: nil,
assignment: assignment_vt, questionnaire: tm_questionnaire) }
let(:team_vt) { create(:assignment_team, id: 12,
assignment: assignment_vt) }
let(:participant_vt) { create(:participant, id: 12,
assignment: assignment_vt, user_id: student1_vt.id) }
let(:participant2_vt) { create(:participant, id: 13,
assignment: assignment_vt, user_id: student2_vt.id) }

before(:each) do
# Need to stub this method so the factory instance with
# the stubbed :team method is returned by :find
# instead of a separate instance with the same data
allow(AssignmentParticipant)
.to receive(:find)
.with(participant_vt.id.to_s)
.and_return(participant_vt)
allow(participant_vt).to receive(:team).and_return(team_vt)
allow(team_vt).to receive(:participants).and_return([participant_vt, participant2_vt])
allow(AssignmentQuestionnaire)
.to receive(:find_by)
.with(assignment_id: assignment_vt.id, questionnaire_id: tm_questionnaire.id)
.and_return(assignment_questionnaire_vt)
allow(AssignmentQuestionnaire)
.to receive(:find_by)
.with(assignment_id: assignment.id, questionnaire_id: review_questionnaire.id)
.and_return(assignment_questionnaire_vt)
allow(AssignmentQuestionnaire)
.to receive(:where)
.with(any_args)
.and_return([assignment_questionnaire_vt])
allow(assignment_vt)
.to receive(:late_policy_id)
.and_return(false)
allow(assignment_vt)
.to receive(:calculate_penalty)
.and_return(false)
allow(assignment_vt)
.to receive(:compute_total_score)
.with(any_args)
.and_return(100)
allow(review_questionnaire).to receive(:get_assessments_round_for).with(participant, 1).and_return([review_response])
allow(Answer).to receive(:compute_scores).with([review_response], [question]).and_return(max: 95, min: 88, avg: 90)
end

it 'renders grades#view_team page' do
params = {id: participant_vt.id}
get :view_team, params
expect(response).to render_template(:view_team)
end

context 'when view_team page is opened by student' do
it 'dropdown is not rendered' do
session = { user: student1_vt }
params = {id: participant_vt.id}
stub_current_user(student1_vt, student1_vt.role.name, student1_vt.role)
get :view_team, params
expect(response.body).to_not have_selector('select')
end
end

context 'when view_team page is opened by instructor' do
it 'dropdown is rendered' do
session = { user: instructor }
params = {id: participant_vt.id}
get :view_team, params
expect(response.body).to have_selector('select')
end
end

context 'when view_team page is viewed by a student who is also a TA for another course' do
it 'renders grades#view_team page' do
params = { id: participant_vt.id }
allow(TaMapping).to receive(:exists?).with(ta_id: participant_vt.user_id, course_id: 1).and_return(true)
</pre>

====H. In spec/factories/factories.rb:====

'''H.1 '''Add the following factory:

<pre>
factory :teammate_review_questionnaire, class: TeammateReviewQuestionnaire do
</pre>

'''H.2 '''Add another factory

<pre>
factory :tm_assignment_questionnaire, class: AssignmentQuestionnaire do
user_id 1
questionnaire { association(:teammate_review_questionnaire) }
questionnaire_weight 100
used_in_round nil
topic_id nil
dropdown 1
end
</pre>

=== Summary of file changes ===

The following files are modified:

1. app/controllers/grades_controller.rb - Controller file which changed how the view model is populated

2. app/views/grades/view_team.html.erb - View file, which conditionally rendered the teammate name, for a teammate review heatgrid

3. spec/controllers/grades_controller_spec.rb - For tests verifying the proposed changes

4. app/models/vm_question_response.rb - To modify the view-model so it can tell us the name of the person being reviewed for the current heatgrid

5. app/models/vm_question_response_score_cell.rb -

6. app/assets/stylesheets/grades.scss -

7. app/views/grades/_add_icon_to_name.html.erb -

8. spec/factories/factories.rb -

== Design Patterns ==

Existing code does not use any design patterns, apart from if-else. It uses if-else conditional statements to check what type of questionnaire is present in the viewmodel `VmQuestionResponse`, and based on that, it renders the appropriate content.

We decided to continue with this approach since to change the present coding style, there were required many changes (refactoring) to many files which were out of the scope of the present project. To complete the project in the assigned time, we followed the if-else approach.

== User Stories ==

1. As an instructor, I can view what reviews one teammate has given to other teammates.

2. As a student, I can view what reviews my teammates have given to me.

3. As an instructor, I can select if a student's reviews are anonymously shown to their teammates.

== Testing ==
'''CURRENT STATUS'''

1. Presently, the tests only cover if the view_team is page is rendered when it is asked for. This can be seen in the following link:

'''OUR PROPOSAL'''

- When show_team is set as false by the professor, the student should not be able to see his scores.

- When show_team is set as true by the professor, the student should be able to see his.

- An instructor can select which student's scores he/she wants to see. If no student's name is selected then the professor can see the scores of all the students.
- The instructor can decide whether to show the names of the reviewer to the reviewer in teammate reviews, by selecting a checkbox for the same.
[[File:Untitled Diagram.drawio.png|border|center|alt=New UI for students|New UI for students ]]

==References==

<p>https://expertiza.ncsu.edu/</p>

CSC/ECE 517 Fall 2021 - E2165. Fix teammate-review view

2021-11-28T17:57:27Z

Vdeshmu: /* C. In app/models/vm_question_response.rb: */

== Team Introduction ==

Dr. Edward Gehringer (instructor), Parimal Mehta (mentor)

1. Anjali Garg (unity ID : agarg25)

2. Arvasu Chikara (unity ID: achikar2)

3. Lalit Bangad (unity ID: llbangad)

4. Vinay Deshmukh (unity ID: vdeshmu)

== Problems to be addressed ==

After a project is submitted and reviewed, both the team members (students) and instructors should be able to view the teammate reviews. Students should be able to view the reviews by going to a particular assignment's -> your scores, at the bottom of the page. An instructor can view the teammate reviews by going to assignments -> assignment -> particular team's submission -> view submission -> assign grades -> view scores.

In the case of the instructor, a single heat grid is shown whereas in the case of a team member, we cant view the scores. In the heat grid, it is not clear if the scores visible are for the reviews that the student has *written* for their teammates or the scores that the student has *received* from their teammates. Additionally, for instructors can choose from a list of the students on the team, but they have no way to tell whether the heat grid shows the reviews done *by* that student or done *for* that student.

== Methodology Overview ==

We have divided our work in the following tasks to address the above problems:

1. Distinguish reviews done for a student by rendering separates heatgrids for each student

2. For instructors, the table will have sections based on the students

3. Include a checkbox on the edit assignment page that enables/disables visibility of heat grid to students

4. Fix the average column for a table (which breaks for some reviews)

5. Show a composite score derived from all reviews. Make this code generalized, so other kinds of heat grid views could use it.

6. Changes should work even in an anonymized view

== Motivations ==

1. Enable users to clearly tell which reviews are done by them, and which reviews are done for them.

2. Code should be generic so it can be used for different types of heat grids as well.

== Control Flow to access the concerned screens ==
'''1. For instructor (Log in as an instructor):-'''

Screen after logging in by the instructor
[[File:ss1.png |border|1000px|center]]
Got to assignments on the Manage menu
[[File:ss2.png |border|1000px|center]]
Go to assignments
[[File:ss3.png |border|1000px|center]]
Go to submissions for any assignment
[[File:ss4a.png |border|1000px|center]]
Go to Assign Grade
[[File:ss5a.png |border|1000px|center]]
You will land on the page where the changes are made and can be reviewed
[[File:ss7a.png |border|1000px|center]]

'''2. Student:- (Logged in as an instructor)'''

After landing on the assignments page, select any student from an assignment as shown below
[[File:ss6a.png |border|1000px|center]]
Go to/Select any assignment
[[File:ss9a.png |border|1000px|center]]
Go to your scores
[[File:ss10a.png |border|1000px|center]]
You will land on the page where the changes are made and can be reviewed
[[File:ss11a.png |border|1000px|center]]

== Old Status of the application ==

'''1. Instructor's view of teammate review''': This is the current screen given to the instructor. Here we see that the instructor can not determine who has given which review to which student in a team.

[[File:Instructor-view-1.png|border| 700px |center|alt=The proposed expanded student display.|The proposed expanded student display.]]

'''2. Student's view of teammate review''': Currently, a student is not able to see what grades were given by their teammates. We need to implement that functionality so that the student is able to view those grades.

[[File:Student-view-2.png|border| 700px |center|alt=The current instructor view.|The current review display for instructors.]]

'''3. Error in existing UI for student''': In the existing UI for a student, the highlighted block should not be rendered. This part of the screen is meant for the instructors/TAs.

[[File:Wrong render for student.png|border|700px|center|alt=Existing UI for student|Existing UI for student.]]

== Proposed changes ==

''' 1) Proposed UI for instructor ''': The instructor is able to see the score for all teammates. In the existing code, only one teammate's scores are being shown. But, we are planning to change the way the (VmQuestionResponse array is populated)[https://github.com/expertiza/expertiza/blob/master/app/controllers/grades_controller.rb#L114], so that the scores for all teammates are appended to it so it correctly shows what should have already been shown in this screen for the instructor.

[[File:Proposed_screen.png|border|700px|center|alt=Proposed UI for instructor|Proposed UI for instructor.]]

Note: When a student visits this screen, they will only be shown the reviews received by them, assuming the instructor has allowed visibility of teammate reviews to students.

''' 2) Show detailed review for a particular question''': The instructor can see detailed review given to a student by their teammates by clicking on a particular question number in the table.

[[File:ss12a.png|border|700px|center|alt=New UI for students|New UI for students ]]

''' 3) Show teammate review to student UI ''': The existing code doesn't render a student's teammate review scores at all. We are planning to render the scores to a student (as shown below) when they visit this screen. However, the visibility of this screen is contingent on whether the instructor has allowed visibility of the teammate review screen to students. If the instructor has disabled this feature, then the heatgrid will not be displayed at all.

[[File:UI_for_student.png|border|700px|center|alt=New UI for students|New UI for students ]]

== Models used / Explanation of fixes ==

The below diagram illustrates the proposed code change for showing all team members with the teammate review data to an instructor. The existing code only iterated on the `Participant` whose ID is present in the URL of the page. To fix this, we will iterate over all teammates of the given participant so that all teammate reviews for all team members are shown to the instructor.

[[File:Logic e2165.png|border|center|alt=Flow diagram of proposed changes for showing team review data to instructor]]

===Changes made to the code are shown below. Every change is shown and explained separately===

====A. Added the following to app/assets/stylesheets/grades.scss:====
<pre>
.teammate_table.hidden {
display: none;
}
</pre>

====B. In app/controllers/grades_controller.rb: ====

'''B.1:'''

Old code: The existing code does not differentiate when adding a view model for the TeammateReview questionnaire
questionnaires.each do |questionnaire|
...
@vmlist << populate_view_model(questionnaire)
end

New code: Since the current page URL contains an ID for the participant, from which we get an assignment, which gives us a list of questionnaires, we need to iterate all participants for a `TeammateReveiwQuestionnaire` questionnaire, so that we get the heatgrid view models for all members of a team.
questionnaires.each do |questionnaire|
...
if questionnaire.type == "TeammateReviewQuestionnaire"
# as teammate review will be different for each participant
# we need to create a separate table for each teammate
@participant.team.participants.each do |team_participant|
@vmlist << populate_view_model(team_participant, questionnaire, @team)
end
else
# only one participant needs iterating, as apart from teammatereview
# all other reviews are at "team" level
@vmlist << populate_view_model(@participant, questionnaire, @team)
end
end

'''B.2: '''

Old code: This code uses @participant as an instance variable, but this structure will not work as we need to call this ViewModel with multiple participants when iterating for a teammate review questionnaire.
def populate_view_model(questionnaire)
vm = VmQuestionResponse.new(questionnaire, @assignment, @round)
vmquestions = questionnaire.questions
vm.add_questions(vmquestions)
vm.add_team_members(@team)
vm.add_reviews(@participant, @team, @assignment.vary_by_round)
vm.number_of_comments_greater_than_10_words
vm
end

New code: We need to call this function with a separate participant in each invocation due to our change for TeammateReviewQuestionnaire, hence it makes sense to make `participant` as an argument to this function. Similarly, as `team` is a closely related model to `participant`, we are passing it as an argument, to keep this function as "pure" as possible.
def populate_view_model(participant, questionnaire, team)
...
vm.add_team_members(team)
vm.add_reviews(participant, team, @assignment.vary_by_round)
...
end

====C. In app/models/vm_question_response.rb:====

'''C.1: '''Added the reviewee_id method: Created a helper method within the VmQuestionReponse model to retrieve the `reviewee_id` for a heatgrid

def reviewee_id
@participant_who_is_reviewee.user_id
end

'''C.2: '''Added the reviewee_name method: Created a helper method within the VmQuestionReponse model to retrieve the name of the student who is being reviewed for a heatgrid. This method uses the functionality to anonymize the name when we are in anonymized view.

def reviewee_name(ip_address = nil)
part = @participant_who_is_reviewee
User.find_by(id: part.user_id).fullname(ip_address)
end

'''C.3: '''

Old code: Does not keep track of the student being reviewed
elsif @questionnaire_type == "TeammateReviewQuestionnaire"
reviews = participant.teammate_reviews
reviews.each do |review|
review_mapping = TeammateReviewResponseMap.find_by(id: review.map_id)
participant = Participant.find(review_mapping.reviewer_id)

New code: Add an instance variable to keep track of the student who is being reviewed in this VmQuestionReponse
elsif @questionnaire_type == "TeammateReviewQuestionnaire"
reviews = participant.teammate_reviews
@participant_who_is_reviewee = participant
reviews.each do |review|
review_mapping = TeammateReviewResponseMap.find_by(id: review.map_id)
participant = Participant.find(review_mapping.reviewer_id)

'''C.4: '''

Old code: Existing VmQuestionReponseScoreCell keeps no information about the reviewer, as it only stores the answer score
row.score_row.push(VmQuestionResponseScoreCell.new(answer.answer, color_code, answer.comments, vm_tag_prompts))

New code: Keep track of the response ID, so that we can retrieve the user ID for the reviewer in the model to use in the view file.

row.score_row.push(VmQuestionResponseScoreCell.new(answer.answer, color_code, answer.comments, vm_tag_prompts, answer.response_id))

====D. In app/models/vm_question_response_score_cell.rb:====

'''D.1: '''In the method initialize of class VmQuestionResponseScoreCell

Old code
def initialize(score_value, color_code, comments, vmprompts = nil)
@score_value = score_value
@color_code = color_code
@comment = comments
@vm_prompts = vmprompts
end

New code

def initialize(score_value, color_code, comments, vmprompts = nil, response_id)
@score_value = score_value
@color_code = color_code
@comment = comments
@vm_prompts = vmprompts
@response_id = response_id
end

'''D.2: '''Added a method reviewer_id to the class VmQuestionResponseScoreCell

def reviewer_id
resp = Response.find(@response_id)
map = ResponseMap.find(resp.map_id)
map.reviewer_id
end

====E. In app/views/grades/_add_icon_to_name.html.erb:====

'''E.1 '''Added the following code to the file:

<%# Determine the content of the reviewed by text %>
<% review_text = "" %>
<% if @current_role_name.eql?'Student' or questionnaire_type != "TeammateReviewQuestionnaire" %>
<%# Use Review {{index}} format for student view, and when questionnaire_type is not teammatereview %>
<% review_text = "Review #{i + 1}" %>
<% else %>
<% resp = Response.find(review.id) %>
<% map = ResponseMap.find(resp.map_id) %>
<% reviewer_id = map.reviewer_id %>
<% fullname = Participant.find_by(id: reviewer_id).fullname(session[:ip]) %>
<% review_text = "Review by #{fullname}" %>
<% end%>

'''E.2: '''

Old code

<% if review.done_by_staff_participant? %>
<th class="sorter-false"> <img data-toggle="tooltip" data-placement="right" title="Icon indicates this review was done by course staff" class="img_icon" src="/assets/staff.png"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% else %>
<th class="sorter-false"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% end %>

New code

<% if review.done_by_staff_participant? %>
<th class="sorter-false">
<img
data-toggle="tooltip"
data-placement="right"
title="Icon indicates this review was done by course staff" class="img_icon"
src="/assets/staff.png"
>
<a
target="_blank"
href="../response/view?id=<%= review.id.to_s %>"
data-toggle="tooltip"
data-placement="right"
title="Click to see details">
<%= review_text %>
</a>
</th>
<% else %>
<th class="sorter-false">
<a
target="_blank"
href="../response/view?id=<%= review.id.to_s %>"
data-toggle="tooltip"
data-placement="right"
title="Click to see details"
>
<%= review_text %>
</a>
</th>
<% end %>

====F.In app/views/grades/view_team.html.erb:====

'''F.1: '''Added function teammateSelectOnChange:

<pre>
function teammateSelectOnChange(selectNode) {
const revieweeIdToShow= selectNode.value;
const tableSelector = ".teammate_table";
if(revieweeIdToShow == "all") {
document.querySelectorAll(tableSelector).forEach((tableNode) => {
tableNode.classList.remove("hidden");
});
return;
}

document.querySelectorAll(tableSelector).forEach((tableNode) => {
const tableRevieweeId = tableNode.getAttribute('data-reviewee_id');
if(tableRevieweeId == revieweeIdToShow) {
tableNode.classList.remove("hidden");
} else {
tableNode.classList.add("hidden");
}
});
}
</pre>

'''F.2: '''

Old code
<pre>
<% @vmlist.each do |vm| %>
<% if (vm.questionnaire_display_type == "Metareview" or vm.questionnaire_display_type == "Author Feedback" or vm.questionnaire_display_type == "Teammate Review") and @current_role_name.eql?'Student' %>
<% else %>
<% if vm.list_of_reviewers.length > 0 %>



@@ -87,6 +131,8 @@
<h4 style="display:inline-block;"><%= vm.questionnaire_display_type %>
<% if vm.questionnaire_type == "ReviewQuestionnaire" %>
(Round: <%= vm.round.to_s %> of <%= vm.rounds.to_s %>)
<%end %>
</pre>

New code
<pre>
<%# This boolean is used to render a dropdown just before the first teammate review heat grid %>
<% first_teammate_review_appeared = false %>
<% @vmlist.each do |vm| %>
<% if not @current_role_name.eql?'Student' and not first_teammate_review_appeared and vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
<div>
<select onchange="teammateSelectOnChange(this)">
<option value="all">All</option>
<% @vmlist.select { |tm_vm| tm_vm.questionnaire_type == "TeammateReviewQuestionnaire" }.each do |tm_vm| %>
<option value="<%= tm_vm.reviewee_id %>">
<%= tm_vm.reviewee_name(session[:ip]) %>
</option>
<% end %>
</select>
</div>
<% first_teammate_review_appeared = true %>
<% end %>
<% if (vm.questionnaire_display_type == "Metareview" or vm.questionnaire_display_type == "Author Feedback") and @current_role_name.eql?'Student' %>
<% elsif (vm.questionnaire_type == "TeammateReviewQuestionnaire" and @current_role_name.eql?'Student' and !@assignment.show_teammate_reviews)%>
<% elsif (vm.questionnaire_type == "TeammateReviewQuestionnaire" and @current_role_name.eql?'Student' and @assignment.show_teammate_reviews and current_user.id != vm.reviewee_id )%>
<% else %>
<% if vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
<div class="teammate_table" data-reviewee_id="<%= vm.reviewee_id %>">
<% else %>
<div>
<% end %>
</pre>

'''F.3 '''

Old code
<pre>

@@ -87,6 +131,8 @@
<h4 style="display:inline-block;"><%= vm.questionnaire_display_type %>
<% if vm.questionnaire_type == "ReviewQuestionnaire" %>
(Round: <%= vm.round.to_s %> of <%= vm.rounds.to_s %>)
<%end %>
</pre>

New code
<pre>

@@ -87,6 +131,8 @@
<h4 style="display:inline-block;"><%= vm.questionnaire_display_type %>
<% if vm.questionnaire_type == "ReviewQuestionnaire" %>
(Round: <%= vm.round.to_s %> of <%= vm.rounds.to_s %>)
<% elsif vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
(For: <%= vm.reviewee_name(session[:ip]) %>)
<%end %>
</pre>

'''F.4 '''

Old code
<pre>
<% vm.list_of_reviews.each do |review| %>

<% if (['Student'].include? @current_role_name) && @assignment.is_anonymous%>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i} %>
<% else %>
<% user_name = User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).fullname(session[:ip]).to_s %>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i} %>
<% end %>
<% i += 1 %>
<% end %>

<th class="sorter-true" align="right" >
Avg<span></span>
</th>
<th class="sorter-false">
<span data-toggle="tooltip" data-placement="right" title="A count of comments, for the respective question, which have word count > 10. The purpose of this metric is to represent how many comments for the question are of a substantial length to provide quality feedback.">metric-1</span>
</th>
</tr>
</thead>
</pre>

New code
<pre>
<% vm.list_of_reviews.each do |review| %>

<% if (['Student'].include? @current_role_name) && @assignment.is_anonymous%>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i, questionnaire_type: vm.questionnaire_type } %>
<% else %>
<% user_name = User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).fullname(session[:ip]).to_s %>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i, questionnaire_type: vm.questionnaire_type } %>
<% end %>
<% i += 1 %>
<% end %>

<th class="sorter-true" align="right" >
Avg<span></span>
</th>
</tr>
</thead>
</pre>

'''F.5 '''

Old code
<pre>
<% vm.list_of_rows.each do |row| %>

<tr data-toggle="collapse" class="accordion-toggle" data-target="#hid<%= row.question_id.to_s + vm.round.to_s %>">
<td class = 'cf' data-toggle="tooltip" title="<%= row.question_text %>"> <div style='float: left'><%= j.to_s %></div><div style='float: right'> &#<%= type_and_max(row) %>;</div> </td>


<% row.score_row.each do |score| %>
<% score_comment = score.comment.nil? ? '' : score.comment %> 
<td class="<%= score.color_code %>" align="center" data-toggle="tooltip" title="<%= strip_tags(score.comment).html_safe%>">
<span class="<%= underlined?(score) %>"><%= score.score_value.to_s %></span>
</td>
<% end %>
</pre>

New code
<pre>
<% vm.list_of_rows.each do |row| %>
<% target_id = "hid__#{row.question_id}__#{vm.round}" %>
<% if vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
<%# Since we render different heatgrids with the same questions for each
teammember, we need to distinguish the ID, based on the user for whom,
the reviews have been created. %>
<% target_id += "__#{vm.reviewee_id}" %>
<% end%>


<tr data-toggle="collapse" class="accordion-toggle" data-target="<%= "#" + target_id %>">
<td class = 'cf' data-toggle="tooltip" title="<%= row.question_text %>"> <div style='float: left'><%= j.to_s %></div><div style='float: right'> &#<%= type_and_max(row) %>;</div> </td>


<% row.score_row.each do |score| %>
<% score_comment = score.comment.nil? ? '' : score.comment %>

<td class="<%= score.color_code %>" align="center" data-toggle="tooltip" title="<%= strip_tags(score.comment).html_safe%>">
<span class="<%= underlined?(score) %>">
<%= score.score_value.to_s %>
</span>
</td>
<% end %>
</pre>

'''F.6 '''Removed the following code.

<pre>
<td class = 'cf' align="center">
<%= row.countofcomments.to_s %>
</td>
</pre>

'''F.7 '''

Old code
<pre>

<tr class="tablesorter-childRow">
<td colspan="<%= (i+1).to_s %>" class="hiddenRow" ><div id="hid<%= row.question_id.to_s + vm.round.to_s %>" class="accordion-body collapse" style="margin-left:10px;">
<div style="padding-top: 10px; padding-bottom: 10px;"><%= sanitize row.question_text %></div>
<div>
<table class="table tbl_questlist">
@@ -181,7 +233,17 @@
</thead>
<% for index in 0 .. row.score_row.length - 1 %>
<tr>
<td>Review <%=index + 1%></td>
</pre>

New code
<pre>

<tr class="tablesorter-childRow">
<td colspan="<%= (i+1).to_s %>" class="hiddenRow" ><div id="<%= target_id %>" class="accordion-body collapse" style="margin-left:10px;">
<div style="padding-top: 10px; padding-bottom: 10px;"><%= sanitize row.question_text %></div>
<div>
<table class="table tbl_questlist">
@@ -181,7 +233,17 @@
</thead>
<% for index in 0 .. row.score_row.length - 1 %>
<tr>
<% if @current_role_name.eql?'Student' or vm.questionnaire_type != "TeammateReviewQuestionnaire" %>
<%# Use Review {{index}} format for student view, and
when questionnaire_type is not teammatereview %>
<td>Review <%=index + 1%></td>
<% else %>
<td>
<% reviewer_id = row.score_row[index].reviewer_id %>
<% fullname = Participant.find_by(id: reviewer_id).fullname(session[:ip]) %>
Review by <%= fullname %>
</td>
<% end%>
</pre>

====G. In spec/controllers/grades_controller_spec.rb:====

'''G.1 '''

Old code
<pre>
before(:each) do
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:team).and_return(team)
stub_current_user(instructor, instructor.role.name, instructor.role)
allow(Assignment).to receive(:find).with('1').and_return(assignment)
@@ -91,29 +90,106 @@
end
end
</pre>

New code
<pre>
before(:each) do
allow(participant).to receive(:team).and_return(team)
stub_current_user(instructor, instructor.role.name, instructor.role)
allow(Assignment).to receive(:find).with('1').and_return(assignment)
@@ -91,29 +90,106 @@
end
end
</pre>

'''G.2 '''Remove xdescribe '#view_team' and change describe '#view_team' as follows.

Old code
<pre>
describe '#view_team' do
render_views
context 'when view_team page is viewed by a student who is also a TA for another course' do
it 'renders grades#view_team page' do
allow(participant).to receive(:team).and_return(team)
allow(AssignmentQuestionnaire).to receive(:find_by).with(assignment_id: 1, questionnaire_id: 1).and_return(assignment_questionnaire)
allow(AssignmentQuestionnaire).to receive(:where).with(any_args).and_return([assignment_questionnaire])
allow(assignment).to receive(:late_policy_id).and_return(false)
allow(assignment).to receive(:calculate_penalty).and_return(false)
allow(assignment).to receive(:compute_total_score).with(any_args).and_return(100)
allow(review_questionnaire).to receive(:get_assessments_round_for).with(participant, 1).and_return([review_response])
allow(Answer).to receive(:compute_scores).with([review_response], [question]).and_return(max: 95, min: 88, avg: 90)
params = {id: 1}
allow(TaMapping).to receive(:exists?).with(ta_id: 1, course_id: 1).and_return(true)
</pre>

New code
<pre>
describe '#view_team' do
render_views

# All stubs and factories are instantiated within this scope so as to not
# clash with other broken test.
# The names of the factories created for testing view_team
# have `_vt` suffix ```where necessary``` to differentiate them from
# the above declared factories

let(:student1_vt) { create(:student, name: "barry", id: 12) }
let(:student2_vt) { create(:student, name: "iris", id: 13) }

let(:tm_questionnaire) {
build(
:teammate_review_questionnaire,
id: 12,
questions: [question],
max_question_score: 5
)
}
let(:assignment_vt) {
create(:assignment, id: 6, max_team_size: 2,
questionnaires: [tm_questionnaire])
}
let(:assignment_questionnaire_vt) {
create(:tm_assignment_questionnaire, id: 12, used_in_round: nil,
assignment: assignment_vt, questionnaire: tm_questionnaire) }
let(:team_vt) { create(:assignment_team, id: 12,
assignment: assignment_vt) }
let(:participant_vt) { create(:participant, id: 12,
assignment: assignment_vt, user_id: student1_vt.id) }
let(:participant2_vt) { create(:participant, id: 13,
assignment: assignment_vt, user_id: student2_vt.id) }

before(:each) do
# Need to stub this method so the factory instance with
# the stubbed :team method is returned by :find
# instead of a separate instance with the same data
allow(AssignmentParticipant)
.to receive(:find)
.with(participant_vt.id.to_s)
.and_return(participant_vt)
allow(participant_vt).to receive(:team).and_return(team_vt)
allow(team_vt).to receive(:participants).and_return([participant_vt, participant2_vt])
allow(AssignmentQuestionnaire)
.to receive(:find_by)
.with(assignment_id: assignment_vt.id, questionnaire_id: tm_questionnaire.id)
.and_return(assignment_questionnaire_vt)
allow(AssignmentQuestionnaire)
.to receive(:find_by)
.with(assignment_id: assignment.id, questionnaire_id: review_questionnaire.id)
.and_return(assignment_questionnaire_vt)
allow(AssignmentQuestionnaire)
.to receive(:where)
.with(any_args)
.and_return([assignment_questionnaire_vt])
allow(assignment_vt)
.to receive(:late_policy_id)
.and_return(false)
allow(assignment_vt)
.to receive(:calculate_penalty)
.and_return(false)
allow(assignment_vt)
.to receive(:compute_total_score)
.with(any_args)
.and_return(100)
allow(review_questionnaire).to receive(:get_assessments_round_for).with(participant, 1).and_return([review_response])
allow(Answer).to receive(:compute_scores).with([review_response], [question]).and_return(max: 95, min: 88, avg: 90)
end

it 'renders grades#view_team page' do
params = {id: participant_vt.id}
get :view_team, params
expect(response).to render_template(:view_team)
end

context 'when view_team page is opened by student' do
it 'dropdown is not rendered' do
session = { user: student1_vt }
params = {id: participant_vt.id}
stub_current_user(student1_vt, student1_vt.role.name, student1_vt.role)
get :view_team, params
expect(response.body).to_not have_selector('select')
end
end

context 'when view_team page is opened by instructor' do
it 'dropdown is rendered' do
session = { user: instructor }
params = {id: participant_vt.id}
get :view_team, params
expect(response.body).to have_selector('select')
end
end

context 'when view_team page is viewed by a student who is also a TA for another course' do
it 'renders grades#view_team page' do
params = { id: participant_vt.id }
allow(TaMapping).to receive(:exists?).with(ta_id: participant_vt.user_id, course_id: 1).and_return(true)
</pre>

====H. In spec/factories/factories.rb:====

'''H.1 '''Add the following factory:

<pre>
factory :teammate_review_questionnaire, class: TeammateReviewQuestionnaire do
</pre>

'''H.2 '''Add another factory

<pre>
factory :tm_assignment_questionnaire, class: AssignmentQuestionnaire do
user_id 1
questionnaire { association(:teammate_review_questionnaire) }
questionnaire_weight 100
used_in_round nil
topic_id nil
dropdown 1
end
</pre>

=== Summary of file changes ===

The following files are modified:

1. app/controllers/grades_controller.rb - Controller file which changed how the view model is populated

2. app/views/grades/view_team.html.erb - View file, which conditionally rendered the teammate name, for a teammate review heatgrid

3. spec/controllers/grades_controller_spec.rb - For tests verifying the proposed changes

4. app/models/vm_question_response.rb - To modify the view-model so it can tell us the name of the person being reviewed for the current heatgrid

5. app/models/vm_question_response_score_cell.rb -

6. app/assets/stylesheets/grades.scss -

7. app/views/grades/_add_icon_to_name.html.erb -

8. spec/factories/factories.rb -

== Design Patterns ==

Existing code does not use any design patterns, apart from if-else. It uses if-else conditional statements to check what type of questionnaire is present in the viewmodel `VmQuestionResponse`, and based on that, it renders the appropriate content.

We decided to continue with this approach since to change the present coding style, there were required many changes (refactoring) to many files which were out of the scope of the present project. To complete the project in the assigned time, we followed the if-else approach.

== User Stories ==

1. As an instructor, I can view what reviews one teammate has given to other teammates.

2. As a student, I can view what reviews my teammates have given to me.

3. As an instructor, I can select if a student's reviews are anonymously shown to their teammates.

== Testing ==
'''CURRENT STATUS'''

1. Presently, the tests only cover if the view_team is page is rendered when it is asked for. This can be seen in the following link:

'''OUR PROPOSAL'''

- When show_team is set as false by the professor, the student should not be able to see his scores.

- When show_team is set as true by the professor, the student should be able to see his.

- An instructor can select which student's scores he/she wants to see. If no student's name is selected then the professor can see the scores of all the students.
- The instructor can decide whether to show the names of the reviewer to the reviewer in teammate reviews, by selecting a checkbox for the same.
[[File:Untitled Diagram.drawio.png|border|center|alt=New UI for students|New UI for students ]]

==References==

<p>https://expertiza.ncsu.edu/</p>

CSC/ECE 517 Fall 2021 - E2165. Fix teammate-review view

2021-11-28T17:45:24Z

Vdeshmu: /* B. In app/controllers/grades_controller.rb: */

== Team Introduction ==

Dr. Edward Gehringer (instructor), Parimal Mehta (mentor)

1. Anjali Garg (unity ID : agarg25)

2. Arvasu Chikara (unity ID: achikar2)

3. Lalit Bangad (unity ID: llbangad)

4. Vinay Deshmukh (unity ID: vdeshmu)

== Problems to be addressed ==

After a project is submitted and reviewed, both the team members (students) and instructors should be able to view the teammate reviews. Students should be able to view the reviews by going to a particular assignment's -> your scores, at the bottom of the page. An instructor can view the teammate reviews by going to assignments -> assignment -> particular team's submission -> view submission -> assign grades -> view scores.

In the case of the instructor, a single heat grid is shown whereas in the case of a team member, we cant view the scores. In the heat grid, it is not clear if the scores visible are for the reviews that the student has *written* for their teammates or the scores that the student has *received* from their teammates. Additionally, for instructors can choose from a list of the students on the team, but they have no way to tell whether the heat grid shows the reviews done *by* that student or done *for* that student.

== Methodology Overview ==

We have divided our work in the following tasks to address the above problems:

1. Distinguish reviews done for a student by rendering separates heatgrids for each student

2. For instructors, the table will have sections based on the students

3. Include a checkbox on the edit assignment page that enables/disables visibility of heat grid to students

4. Fix the average column for a table (which breaks for some reviews)

5. Show a composite score derived from all reviews. Make this code generalized, so other kinds of heat grid views could use it.

6. Changes should work even in an anonymized view

== Motivations ==

1. Enable users to clearly tell which reviews are done by them, and which reviews are done for them.

2. Code should be generic so it can be used for different types of heat grids as well.

== Control Flow to access the concerned screens ==
'''1. For instructor (Log in as an instructor):-'''

Screen after logging in by the instructor
[[File:ss1.png |border|1000px|center]]
Got to assignments on the Manage menu
[[File:ss2.png |border|1000px|center]]
Go to assignments
[[File:ss3.png |border|1000px|center]]
Go to submissions for any assignment
[[File:ss4a.png |border|1000px|center]]
Go to Assign Grade
[[File:ss5a.png |border|1000px|center]]
You will land on the page where the changes are made and can be reviewed
[[File:ss7a.png |border|1000px|center]]

'''2. Student:- (Logged in as an instructor)'''

After landing on the assignments page, select any student from an assignment as shown below
[[File:ss6a.png |border|1000px|center]]
Go to/Select any assignment
[[File:ss9a.png |border|1000px|center]]
Go to your scores
[[File:ss10a.png |border|1000px|center]]
You will land on the page where the changes are made and can be reviewed
[[File:ss11a.png |border|1000px|center]]

== Old Status of the application ==

'''1. Instructor's view of teammate review''': This is the current screen given to the instructor. Here we see that the instructor can not determine who has given which review to which student in a team.

[[File:Instructor-view-1.png|border| 700px |center|alt=The proposed expanded student display.|The proposed expanded student display.]]

'''2. Student's view of teammate review''': Currently, a student is not able to see what grades were given by their teammates. We need to implement that functionality so that the student is able to view those grades.

[[File:Student-view-2.png|border| 700px |center|alt=The current instructor view.|The current review display for instructors.]]

'''3. Error in existing UI for student''': In the existing UI for a student, the highlighted block should not be rendered. This part of the screen is meant for the instructors/TAs.

[[File:Wrong render for student.png|border|700px|center|alt=Existing UI for student|Existing UI for student.]]

== Proposed changes ==

''' 1) Proposed UI for instructor ''': The instructor is able to see the score for all teammates. In the existing code, only one teammate's scores are being shown. But, we are planning to change the way the (VmQuestionResponse array is populated)[https://github.com/expertiza/expertiza/blob/master/app/controllers/grades_controller.rb#L114], so that the scores for all teammates are appended to it so it correctly shows what should have already been shown in this screen for the instructor.

[[File:Proposed_screen.png|border|700px|center|alt=Proposed UI for instructor|Proposed UI for instructor.]]

Note: When a student visits this screen, they will only be shown the reviews received by them, assuming the instructor has allowed visibility of teammate reviews to students.

''' 2) Show detailed review for a particular question''': The instructor can see detailed review given to a student by their teammates by clicking on a particular question number in the table.

[[File:ss12a.png|border|700px|center|alt=New UI for students|New UI for students ]]

''' 3) Show teammate review to student UI ''': The existing code doesn't render a student's teammate review scores at all. We are planning to render the scores to a student (as shown below) when they visit this screen. However, the visibility of this screen is contingent on whether the instructor has allowed visibility of the teammate review screen to students. If the instructor has disabled this feature, then the heatgrid will not be displayed at all.

[[File:UI_for_student.png|border|700px|center|alt=New UI for students|New UI for students ]]

== Models used / Explanation of fixes ==

The below diagram illustrates the proposed code change for showing all team members with the teammate review data to an instructor. The existing code only iterated on the `Participant` whose ID is present in the URL of the page. To fix this, we will iterate over all teammates of the given participant so that all teammate reviews for all team members are shown to the instructor.

[[File:Logic e2165.png|border|center|alt=Flow diagram of proposed changes for showing team review data to instructor]]

===Changes made to the code are shown below. Every change is shown and explained separately===

====A. Added the following to app/assets/stylesheets/grades.scss:====
<pre>
.teammate_table.hidden {
display: none;
}
</pre>

====B. In app/controllers/grades_controller.rb: ====

'''B.1:'''

Old code: The existing code does not differentiate when adding a view model for the TeammateReview questionnaire
questionnaires.each do |questionnaire|
...
@vmlist << populate_view_model(questionnaire)
end

New code: Since the current page URL contains an ID for the participant, from which we get an assignment, which gives us a list of questionnaires, we need to iterate all participants for a `TeammateReveiwQuestionnaire` questionnaire, so that we get the heatgrid view models for all members of a team.
questionnaires.each do |questionnaire|
...
if questionnaire.type == "TeammateReviewQuestionnaire"
# as teammate review will be different for each participant
# we need to create a separate table for each teammate
@participant.team.participants.each do |team_participant|
@vmlist << populate_view_model(team_participant, questionnaire, @team)
end
else
# only one participant needs iterating, as apart from teammatereview
# all other reviews are at "team" level
@vmlist << populate_view_model(@participant, questionnaire, @team)
end
end

'''B.2: '''

Old code: This code uses @participant as an instance variable, but this structure will not work as we need to call this ViewModel with multiple participants when iterating for a teammate review questionnaire.
def populate_view_model(questionnaire)
vm = VmQuestionResponse.new(questionnaire, @assignment, @round)
vmquestions = questionnaire.questions
vm.add_questions(vmquestions)
vm.add_team_members(@team)
vm.add_reviews(@participant, @team, @assignment.vary_by_round)
vm.number_of_comments_greater_than_10_words
vm
end

New code: We need to call this function with a separate participant in each invocation due to our change for TeammateReviewQuestionnaire, hence it makes sense to make `participant` as an argument to this function. Similarly, as `team` is a closely related model to `participant`, we are passing it as an argument, to keep this function as "pure" as possible.
def populate_view_model(participant, questionnaire, team)
...
vm.add_team_members(team)
vm.add_reviews(participant, team, @assignment.vary_by_round)
...
end

====C. In app/models/vm_question_response.rb:====

'''C.1: '''Added the reviewee_id method

def reviewee_id
@participant_who_is_reviewee.user_id
end

'''C.2: '''Added the reviewee_name method

def reviewee_name(ip_address = nil)
part = @participant_who_is_reviewee
User.find_by(id: part.user_id).fullname(ip_address)
end

'''C.3: '''

Old code
elsif @questionnaire_type == "TeammateReviewQuestionnaire"
reviews = participant.teammate_reviews
reviews.each do |review|
review_mapping = TeammateReviewResponseMap.find_by(id: review.map_id)
participant = Participant.find(review_mapping.reviewer_id)

New code
elsif @questionnaire_type == "TeammateReviewQuestionnaire"
reviews = participant.teammate_reviews
@participant_who_is_reviewee = participant
reviews.each do |review|
review_mapping = TeammateReviewResponseMap.find_by(id: review.map_id)
participant = Participant.find(review_mapping.reviewer_id)

'''C.4: '''

Old code
row.score_row.push(VmQuestionResponseScoreCell.new(answer.answer, color_code, answer.comments, vm_tag_prompts))

New code

row.score_row.push(VmQuestionResponseScoreCell.new(answer.answer, color_code, answer.comments, vm_tag_prompts, answer.response_id))

====D. In app/models/vm_question_response_score_cell.rb:====

'''D.1: '''In the method initialize of class VmQuestionResponseScoreCell

Old code
def initialize(score_value, color_code, comments, vmprompts = nil)
@score_value = score_value
@color_code = color_code
@comment = comments
@vm_prompts = vmprompts
end

New code

def initialize(score_value, color_code, comments, vmprompts = nil, response_id)
@score_value = score_value
@color_code = color_code
@comment = comments
@vm_prompts = vmprompts
@response_id = response_id
end

'''D.2: '''Added a method reviewer_id to the class VmQuestionResponseScoreCell

def reviewer_id
resp = Response.find(@response_id)
map = ResponseMap.find(resp.map_id)
map.reviewer_id
end

====E. In app/views/grades/_add_icon_to_name.html.erb:====

'''E.1 '''Added the following code to the file:

<%# Determine the content of the reviewed by text %>
<% review_text = "" %>
<% if @current_role_name.eql?'Student' or questionnaire_type != "TeammateReviewQuestionnaire" %>
<%# Use Review {{index}} format for student view, and when questionnaire_type is not teammatereview %>
<% review_text = "Review #{i + 1}" %>
<% else %>
<% resp = Response.find(review.id) %>
<% map = ResponseMap.find(resp.map_id) %>
<% reviewer_id = map.reviewer_id %>
<% fullname = Participant.find_by(id: reviewer_id).fullname(session[:ip]) %>
<% review_text = "Review by #{fullname}" %>
<% end%>

'''E.2: '''

Old code

<% if review.done_by_staff_participant? %>
<th class="sorter-false"> <img data-toggle="tooltip" data-placement="right" title="Icon indicates this review was done by course staff" class="img_icon" src="/assets/staff.png"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% else %>
<th class="sorter-false"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= "Review " + i.to_s %></a> </th>
<% end %>

New code

<% if review.done_by_staff_participant? %>
<th class="sorter-false">
<img
data-toggle="tooltip"
data-placement="right"
title="Icon indicates this review was done by course staff" class="img_icon"
src="/assets/staff.png"
>
<a
target="_blank"
href="../response/view?id=<%= review.id.to_s %>"
data-toggle="tooltip"
data-placement="right"
title="Click to see details">
<%= review_text %>
</a>
</th>
<% else %>
<th class="sorter-false">
<a
target="_blank"
href="../response/view?id=<%= review.id.to_s %>"
data-toggle="tooltip"
data-placement="right"
title="Click to see details"
>
<%= review_text %>
</a>
</th>
<% end %>

====F.In app/views/grades/view_team.html.erb:====

'''F.1: '''Added function teammateSelectOnChange:

<pre>
function teammateSelectOnChange(selectNode) {
const revieweeIdToShow= selectNode.value;
const tableSelector = ".teammate_table";
if(revieweeIdToShow == "all") {
document.querySelectorAll(tableSelector).forEach((tableNode) => {
tableNode.classList.remove("hidden");
});
return;
}

document.querySelectorAll(tableSelector).forEach((tableNode) => {
const tableRevieweeId = tableNode.getAttribute('data-reviewee_id');
if(tableRevieweeId == revieweeIdToShow) {
tableNode.classList.remove("hidden");
} else {
tableNode.classList.add("hidden");
}
});
}
</pre>

'''F.2: '''

Old code
<pre>
<% @vmlist.each do |vm| %>
<% if (vm.questionnaire_display_type == "Metareview" or vm.questionnaire_display_type == "Author Feedback" or vm.questionnaire_display_type == "Teammate Review") and @current_role_name.eql?'Student' %>
<% else %>
<% if vm.list_of_reviewers.length > 0 %>



@@ -87,6 +131,8 @@
<h4 style="display:inline-block;"><%= vm.questionnaire_display_type %>
<% if vm.questionnaire_type == "ReviewQuestionnaire" %>
(Round: <%= vm.round.to_s %> of <%= vm.rounds.to_s %>)
<%end %>
</pre>

New code
<pre>
<%# This boolean is used to render a dropdown just before the first teammate review heat grid %>
<% first_teammate_review_appeared = false %>
<% @vmlist.each do |vm| %>
<% if not @current_role_name.eql?'Student' and not first_teammate_review_appeared and vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
<div>
<select onchange="teammateSelectOnChange(this)">
<option value="all">All</option>
<% @vmlist.select { |tm_vm| tm_vm.questionnaire_type == "TeammateReviewQuestionnaire" }.each do |tm_vm| %>
<option value="<%= tm_vm.reviewee_id %>">
<%= tm_vm.reviewee_name(session[:ip]) %>
</option>
<% end %>
</select>
</div>
<% first_teammate_review_appeared = true %>
<% end %>
<% if (vm.questionnaire_display_type == "Metareview" or vm.questionnaire_display_type == "Author Feedback") and @current_role_name.eql?'Student' %>
<% elsif (vm.questionnaire_type == "TeammateReviewQuestionnaire" and @current_role_name.eql?'Student' and !@assignment.show_teammate_reviews)%>
<% elsif (vm.questionnaire_type == "TeammateReviewQuestionnaire" and @current_role_name.eql?'Student' and @assignment.show_teammate_reviews and current_user.id != vm.reviewee_id )%>
<% else %>
<% if vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
<div class="teammate_table" data-reviewee_id="<%= vm.reviewee_id %>">
<% else %>
<div>
<% end %>
</pre>

'''F.3 '''

Old code
<pre>

@@ -87,6 +131,8 @@
<h4 style="display:inline-block;"><%= vm.questionnaire_display_type %>
<% if vm.questionnaire_type == "ReviewQuestionnaire" %>
(Round: <%= vm.round.to_s %> of <%= vm.rounds.to_s %>)
<%end %>
</pre>

New code
<pre>

@@ -87,6 +131,8 @@
<h4 style="display:inline-block;"><%= vm.questionnaire_display_type %>
<% if vm.questionnaire_type == "ReviewQuestionnaire" %>
(Round: <%= vm.round.to_s %> of <%= vm.rounds.to_s %>)
<% elsif vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
(For: <%= vm.reviewee_name(session[:ip]) %>)
<%end %>
</pre>

'''F.4 '''

Old code
<pre>
<% vm.list_of_reviews.each do |review| %>

<% if (['Student'].include? @current_role_name) && @assignment.is_anonymous%>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i} %>
<% else %>
<% user_name = User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).fullname(session[:ip]).to_s %>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i} %>
<% end %>
<% i += 1 %>
<% end %>

<th class="sorter-true" align="right" >
Avg<span></span>
</th>
<th class="sorter-false">
<span data-toggle="tooltip" data-placement="right" title="A count of comments, for the respective question, which have word count > 10. The purpose of this metric is to represent how many comments for the question are of a substantial length to provide quality feedback.">metric-1</span>
</th>
</tr>
</thead>
</pre>

New code
<pre>
<% vm.list_of_reviews.each do |review| %>

<% if (['Student'].include? @current_role_name) && @assignment.is_anonymous%>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i, questionnaire_type: vm.questionnaire_type } %>
<% else %>
<% user_name = User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).fullname(session[:ip]).to_s %>
<%= render :partial => 'add_icon_to_name', :locals => {review: review, i: i, questionnaire_type: vm.questionnaire_type } %>
<% end %>
<% i += 1 %>
<% end %>

<th class="sorter-true" align="right" >
Avg<span></span>
</th>
</tr>
</thead>
</pre>

'''F.5 '''

Old code
<pre>
<% vm.list_of_rows.each do |row| %>

<tr data-toggle="collapse" class="accordion-toggle" data-target="#hid<%= row.question_id.to_s + vm.round.to_s %>">
<td class = 'cf' data-toggle="tooltip" title="<%= row.question_text %>"> <div style='float: left'><%= j.to_s %></div><div style='float: right'> &#<%= type_and_max(row) %>;</div> </td>


<% row.score_row.each do |score| %>
<% score_comment = score.comment.nil? ? '' : score.comment %> 
<td class="<%= score.color_code %>" align="center" data-toggle="tooltip" title="<%= strip_tags(score.comment).html_safe%>">
<span class="<%= underlined?(score) %>"><%= score.score_value.to_s %></span>
</td>
<% end %>
</pre>

New code
<pre>
<% vm.list_of_rows.each do |row| %>
<% target_id = "hid__#{row.question_id}__#{vm.round}" %>
<% if vm.questionnaire_type == "TeammateReviewQuestionnaire" %>
<%# Since we render different heatgrids with the same questions for each
teammember, we need to distinguish the ID, based on the user for whom,
the reviews have been created. %>
<% target_id += "__#{vm.reviewee_id}" %>
<% end%>


<tr data-toggle="collapse" class="accordion-toggle" data-target="<%= "#" + target_id %>">
<td class = 'cf' data-toggle="tooltip" title="<%= row.question_text %>"> <div style='float: left'><%= j.to_s %></div><div style='float: right'> &#<%= type_and_max(row) %>;</div> </td>


<% row.score_row.each do |score| %>
<% score_comment = score.comment.nil? ? '' : score.comment %>

<td class="<%= score.color_code %>" align="center" data-toggle="tooltip" title="<%= strip_tags(score.comment).html_safe%>">
<span class="<%= underlined?(score) %>">
<%= score.score_value.to_s %>
</span>
</td>
<% end %>
</pre>

'''F.6 '''Removed the following code.

<pre>
<td class = 'cf' align="center">
<%= row.countofcomments.to_s %>
</td>
</pre>

'''F.7 '''

Old code
<pre>

<tr class="tablesorter-childRow">
<td colspan="<%= (i+1).to_s %>" class="hiddenRow" ><div id="hid<%= row.question_id.to_s + vm.round.to_s %>" class="accordion-body collapse" style="margin-left:10px;">
<div style="padding-top: 10px; padding-bottom: 10px;"><%= sanitize row.question_text %></div>
<div>
<table class="table tbl_questlist">
@@ -181,7 +233,17 @@
</thead>
<% for index in 0 .. row.score_row.length - 1 %>
<tr>
<td>Review <%=index + 1%></td>
</pre>

New code
<pre>

<tr class="tablesorter-childRow">
<td colspan="<%= (i+1).to_s %>" class="hiddenRow" ><div id="<%= target_id %>" class="accordion-body collapse" style="margin-left:10px;">
<div style="padding-top: 10px; padding-bottom: 10px;"><%= sanitize row.question_text %></div>
<div>
<table class="table tbl_questlist">
@@ -181,7 +233,17 @@
</thead>
<% for index in 0 .. row.score_row.length - 1 %>
<tr>
<% if @current_role_name.eql?'Student' or vm.questionnaire_type != "TeammateReviewQuestionnaire" %>
<%# Use Review {{index}} format for student view, and
when questionnaire_type is not teammatereview %>
<td>Review <%=index + 1%></td>
<% else %>
<td>
<% reviewer_id = row.score_row[index].reviewer_id %>
<% fullname = Participant.find_by(id: reviewer_id).fullname(session[:ip]) %>
Review by <%= fullname %>
</td>
<% end%>
</pre>

====G. In spec/controllers/grades_controller_spec.rb:====

'''G.1 '''

Old code
<pre>
before(:each) do
allow(AssignmentParticipant).to receive(:find).with('1').and_return(participant)
allow(participant).to receive(:team).and_return(team)
stub_current_user(instructor, instructor.role.name, instructor.role)
allow(Assignment).to receive(:find).with('1').and_return(assignment)
@@ -91,29 +90,106 @@
end
end
</pre>

New code
<pre>
before(:each) do
allow(participant).to receive(:team).and_return(team)
stub_current_user(instructor, instructor.role.name, instructor.role)
allow(Assignment).to receive(:find).with('1').and_return(assignment)
@@ -91,29 +90,106 @@
end
end
</pre>

'''G.2 '''Remove xdescribe '#view_team' and change describe '#view_team' as follows.

Old code
<pre>
describe '#view_team' do
render_views
context 'when view_team page is viewed by a student who is also a TA for another course' do
it 'renders grades#view_team page' do
allow(participant).to receive(:team).and_return(team)
allow(AssignmentQuestionnaire).to receive(:find_by).with(assignment_id: 1, questionnaire_id: 1).and_return(assignment_questionnaire)
allow(AssignmentQuestionnaire).to receive(:where).with(any_args).and_return([assignment_questionnaire])
allow(assignment).to receive(:late_policy_id).and_return(false)
allow(assignment).to receive(:calculate_penalty).and_return(false)
allow(assignment).to receive(:compute_total_score).with(any_args).and_return(100)
allow(review_questionnaire).to receive(:get_assessments_round_for).with(participant, 1).and_return([review_response])
allow(Answer).to receive(:compute_scores).with([review_response], [question]).and_return(max: 95, min: 88, avg: 90)
params = {id: 1}
allow(TaMapping).to receive(:exists?).with(ta_id: 1, course_id: 1).and_return(true)
</pre>

New code
<pre>
describe '#view_team' do
render_views

# All stubs and factories are instantiated within this scope so as to not
# clash with other broken test.
# The names of the factories created for testing view_team
# have `_vt` suffix ```where necessary``` to differentiate them from
# the above declared factories

let(:student1_vt) { create(:student, name: "barry", id: 12) }
let(:student2_vt) { create(:student, name: "iris", id: 13) }

let(:tm_questionnaire) {
build(
:teammate_review_questionnaire,
id: 12,
questions: [question],
max_question_score: 5
)
}
let(:assignment_vt) {
create(:assignment, id: 6, max_team_size: 2,
questionnaires: [tm_questionnaire])
}
let(:assignment_questionnaire_vt) {
create(:tm_assignment_questionnaire, id: 12, used_in_round: nil,
assignment: assignment_vt, questionnaire: tm_questionnaire) }
let(:team_vt) { create(:assignment_team, id: 12,
assignment: assignment_vt) }
let(:participant_vt) { create(:participant, id: 12,
assignment: assignment_vt, user_id: student1_vt.id) }
let(:participant2_vt) { create(:participant, id: 13,
assignment: assignment_vt, user_id: student2_vt.id) }

before(:each) do
# Need to stub this method so the factory instance with
# the stubbed :team method is returned by :find
# instead of a separate instance with the same data
allow(AssignmentParticipant)
.to receive(:find)
.with(participant_vt.id.to_s)
.and_return(participant_vt)
allow(participant_vt).to receive(:team).and_return(team_vt)
allow(team_vt).to receive(:participants).and_return([participant_vt, participant2_vt])
allow(AssignmentQuestionnaire)
.to receive(:find_by)
.with(assignment_id: assignment_vt.id, questionnaire_id: tm_questionnaire.id)
.and_return(assignment_questionnaire_vt)
allow(AssignmentQuestionnaire)
.to receive(:find_by)
.with(assignment_id: assignment.id, questionnaire_id: review_questionnaire.id)
.and_return(assignment_questionnaire_vt)
allow(AssignmentQuestionnaire)
.to receive(:where)
.with(any_args)
.and_return([assignment_questionnaire_vt])
allow(assignment_vt)
.to receive(:late_policy_id)
.and_return(false)
allow(assignment_vt)
.to receive(:calculate_penalty)
.and_return(false)
allow(assignment_vt)
.to receive(:compute_total_score)
.with(any_args)
.and_return(100)
allow(review_questionnaire).to receive(:get_assessments_round_for).with(participant, 1).and_return([review_response])
allow(Answer).to receive(:compute_scores).with([review_response], [question]).and_return(max: 95, min: 88, avg: 90)
end

it 'renders grades#view_team page' do
params = {id: participant_vt.id}
get :view_team, params
expect(response).to render_template(:view_team)
end

context 'when view_team page is opened by student' do
it 'dropdown is not rendered' do
session = { user: student1_vt }
params = {id: participant_vt.id}
stub_current_user(student1_vt, student1_vt.role.name, student1_vt.role)
get :view_team, params
expect(response.body).to_not have_selector('select')
end
end

context 'when view_team page is opened by instructor' do
it 'dropdown is rendered' do
session = { user: instructor }
params = {id: participant_vt.id}
get :view_team, params
expect(response.body).to have_selector('select')
end
end

context 'when view_team page is viewed by a student who is also a TA for another course' do
it 'renders grades#view_team page' do
params = { id: participant_vt.id }
allow(TaMapping).to receive(:exists?).with(ta_id: participant_vt.user_id, course_id: 1).and_return(true)
</pre>

====H. In spec/factories/factories.rb:====

'''H.1 '''Add the following factory:

<pre>
factory :teammate_review_questionnaire, class: TeammateReviewQuestionnaire do
</pre>

'''H.2 '''Add another factory

<pre>
factory :tm_assignment_questionnaire, class: AssignmentQuestionnaire do
user_id 1
questionnaire { association(:teammate_review_questionnaire) }
questionnaire_weight 100
used_in_round nil
topic_id nil
dropdown 1
end
</pre>

=== Summary of file changes ===

The following files are modified:

1. app/controllers/grades_controller.rb - Controller file which changed how the view model is populated

2. app/views/grades/view_team.html.erb - View file, which conditionally rendered the teammate name, for a teammate review heatgrid

3. spec/controllers/grades_controller_spec.rb - For tests verifying the proposed changes

4. app/models/vm_question_response.rb - To modify the view-model so it can tell us the name of the person being reviewed for the current heatgrid

5. app/models/vm_question_response_score_cell.rb -

6. app/assets/stylesheets/grades.scss -

7. app/views/grades/_add_icon_to_name.html.erb -

8. spec/factories/factories.rb -

== Design Patterns ==

Existing code does not use any design patterns, apart from if-else. It uses if-else conditional statements to check what type of questionnaire is present in the viewmodel `VmQuestionResponse`, and based on that, it renders the appropriate content.

We decided to continue with this approach since to change the present coding style, there were required many changes (refactoring) to many files which were out of the scope of the present project. To complete the project in the assigned time, we followed the if-else approach.

== User Stories ==

1. As an instructor, I can view what reviews one teammate has given to other teammates.

2. As a student, I can view what reviews my teammates have given to me.

3. As an instructor, I can select if a student's reviews are anonymously shown to their teammates.

== Testing ==
'''CURRENT STATUS'''

1. Presently, the tests only cover if the view_team is page is rendered when it is asked for. This can be seen in the following link:

'''OUR PROPOSAL'''

- When show_team is set as false by the professor, the student should not be able to see his scores.

- When show_team is set as true by the professor, the student should be able to see his.

- An instructor can select which student's scores he/she wants to see. If no student's name is selected then the professor can see the scores of all the students.
- The instructor can decide whether to show the names of the reviewer to the reviewer in teammate reviews, by selecting a checkbox for the same.
[[File:Untitled Diagram.drawio.png|border|center|alt=New UI for students|New UI for students ]]

==References==

<p>https://expertiza.ncsu.edu/</p>

CSC/ECE 517 Fall 2021 - E2165. Fix teammate-review view

2021-11-09T02:40:05Z

Vdeshmu:

== Team Introduction ==

Dr. Edward Gehringer (instructor), Parimal Mehta (mentor)

1. Lalit Bangad (unity ID: llbangad)

2. Vinay Deshmukh (unity ID: vdeshmu)

3. Arvasu Chikara (unity ID: achikar2)

4. Anjali Garg (unity ID : agarg25)

== Problems to be addressed ==

After a project is submitted and reviewed, both the team members (students) and instructors should be able to view the teammate reviews. Students should be able to view the reviews by going to a particular assignment's -> your scores, at the bottom of the page. An instructor can view the teammate reviews by going to assignments -> assignment -> particular team's submission -> view submission -> assign grades -> view scores.

In the case of the instructor, a single heat grid is shown whereas in the case of a team member, we cant view the scores. In the heat grid, it is not clear if the scores visible are for the reviews that the student has *written* for their teammates or the scores that the student has *received* from their teammates. Additionally, for instructors can choose from a list of the students on the team, but they have no way to tell whether the heat grid shows the reviews done *by* that student or done *for* that student.

== Methodology Overview ==

We have divided our work in the following tasks to address the above problems:

1. Distinguish reviews done for a student by rendering separates heatgrids for each student

2. For instructors, the table will have sections based on the students

3. Include a checkbox on the edit assignment page that enables/disables visibility of heat grid to students

4. Fix the average column for a table (which breaks for some reviews)

5. Show a composite score derived from all reviews. Make this code generalized, so other kinds of heat grid views could use it.

6. Changes should work even in an anonymized view

== Motivations ==

1. Enable users to clearly tell which reviews are done by them, and which reviews are done for them.

2. Code should be generic so it can be used for different types of heat grids as well.

== Control Flow to access the concerned screens ==

== Models used / Explanation of fixes ==

The below diagram illustrates the proposed code change for showing all team members with the teammate review data to an instructor. The existing code only iterated on the `Participant` whose ID is present in the URL of the page. To fix this, we will iterate over all teammates of the given participant so that all teammate reviews for all team members are shown to the instructor.

[[File:Logic e2165.png|border|center|alt=Flow diagram of proposed changes for showing team review data to instructor]]

Existing code:

questionnaires.each do |questionnaire|
@round = nil
if @assignment.vary_by_round && questionnaire.type == "ReviewQuestionnaire"
questionnaires = AssignmentQuestionnaire.where(assignment_id: @assignment.id, questionnaire_id: questionnaire.id)
if questionnaires.count > 1
@round = questionnaires[counter_for_same_rubric].used_in_round
counter_for_same_rubric += 1
else
@round = questionnaires[0].used_in_round
counter_for_same_rubric = 0
end
end

# line which is causing the issue
@vmlist << populate_view_model(@participant, questionnaire, @team)
end

Modified code (replace the line which is causing issues):

if questionnaire.display_type == "Teammate Review"
# as teammate review will be different for each participant
# we need to create a separate table for each teammate
@participant.team.participants.each do |participant|
@vmlist << populate_view_model(participant, questionnaire, @team)
end
else
# only one participant needs iterating, as apart from teammatereview
# all other reviews are at "team" level
@vmlist << populate_view_model(@participant, questionnaire, @team)
end

'''Image 1. Instructor's view of teammate review'''
[[File:Instructor-view-1.png|border|center|alt=The proposed expanded student display.|The proposed expanded student display.]]

The `populate_view_model` returns an instance of `VmQuestionResponse`. This model represents the data required to render the table along with it's metadata, like `list_of_reviews` which is used to render the rows.

== Present Status of the application ==

'''Image 1. Instructor's view of teammate review''': This is the current screen given to the instructor. Here we see that the instructor can not determine who has given which review to which student.

[[File:Instructor-view-1.png|border|center|alt=The proposed expanded student display.|The proposed expanded student display.]]

'''Image 2. Student's view of teammate review''': Currently, a student is not able to see what grades were given by their teammates. We need to implement that functionality so that the student is able to view the grades.

[[File:Student-view-2.png|border|center|alt=The current instructor view.|The current review display for instructors.]]

'''Image 3. UML Diagram''': We are planning to add two variables namely showTeammateReview and hideReviewerName. showTeammateReview will decide whether the students would be able to view their team members reviews. hideReviewerName will decide whether the student is able to view peer's names or not.
[[File:Uml-assignment.png|border|center|alt=The proposed condensed student display.|The proposed condensed student display.]]

== Proposed changes ==

1)''' Proposed UI for instructor ''': The instructor is able to see the score for all teammates. In the existing code, only one teammate's scores are being shown. But, we are planning to change the way the (VmQuestionResponse array is populated)[https://github.com/expertiza/expertiza/blob/master/app/controllers/grades_controller.rb#L114], so that the scores for all teammates are appended to it so it correctly shows what should have already been shown in this screen for the instructor.

[[File:Proposed_screen.png|border|center|alt=Proposed UI for instructor|Proposed UI for instructor.]]

Note: When a student visits this screen, they will only be shown the reviews received by them, assuming the instructor has allowed visibility of teammate reviews to students.

2)''' Error in existing UI for student ''': In the existing UI for a student, the highlighted block should not be rendered. This part of the screen is meant for the instructors/TAs. This portion of the screen being rendered to a student is a mistake, and we will remove this part of the screen from the student's screen as part of our proposed changes.

[[File:Wrong render for student.png|border|center|alt=Existing UI for student|Existing UI for student.]]

3)''' Show teammate review to student UI ''': The existing code doesn't render a student's teammate review scores at all. We are planning to render the scores to a student when they visit this screen. However, the visibility of this screen is contingent on whether the instructor has allowed visibility of the teammate review screen to students. If the instructor has disabled this feature, then the heatgrid will not be displayed at all.

[[File:UI_for_student.png|border|center|alt=New UI for students|New UI for students ]]

=== Files to be modified ===

In the current design plan, the following files are planned to be edited:

1. app/controllers/grades_controller.rb - Controller file which will change how the view model is populated
2. app/views/grades/view_team.html.erb - View file, which will conditionally render the teammate name, for a teammate review heatgrid
3. spec/controllers/grades_controller_spec.rb - For tests verifying the proposed changes
4. app/models/vm_question_response.rb - We need to modify the view-model so it can tell us the name of the person being reviewed for the current heatgrid

Apart from these, there will be a schema change for the `Assignment` model, as we need to add the appropriate boolean flags

== Design Patterns ==

Existing code does not use any design patterns, apart from if-else. It uses if-else conditional statements to check what type of questionnaire is present in the viewmodel `VmQuestionResponse`, and based on that, it renders the appropriate content.

We can use decorator pattern, for handling the visibility of the heatgrid when rendering heatgrids for a student login.

== User Stories ==

1. As an instructor, I can view what reviews one teammate has given to other teammates.

2. As a student, I can view what reviews my teammates have given to me.

3. As an instructor, I can select if a student's reviews are anonymously shown to their teammates.

== Testing ==
'''CURRENT STATUS'''

1. Presently, the tests only cover if the view_team is page is rendered when it is asked for.

[[File:current_testing_status.png|border|center|alt=New UI for students|New UI for students ]]

'''OUR PROPOSAL'''

1. For a student:

- When show_team is set as false, the student should not be able to see his scores.

- When show_team is set as true, the student should be able to see his scores.

2. For instructor:

- Should be able to see all the scores by default.

- The instructor can decide whether to show the names of the reviewer to the reviewer in teammate reviews, by selecting a checkbox for the same.
[[File:Untitled Diagram.drawio.png|border|center|alt=New UI for students|New UI for students ]]

==References==

<p>https://expertiza.ncsu.edu/</p>

CSC/ECE 517 Fall 2021 - E2165. Fix teammate-review view

2021-11-09T02:29:42Z

Vdeshmu: /* Proposed changes */

== Team Introduction ==

Dr. Edward Gehringer (instructor), Parimal Mehta (mentor)

1. Lalit Bangad (unity ID: llbangad)

2. Vinay Deshmukh (unity ID: vdeshmu)

3. Arvasu Chikara (unity ID: achikar2)

4. Anjali Garg (unity ID : agarg25)

== Problems to be addressed ==

After a project is submitted and reviewed, both the team members (students) and instructors should be able to view the teammate reviews. Students should be able to view the reviews by going to a particular assignment's -> your scores, at the bottom of the page. An instructor can view the teammate reviews by going to assignments -> assignment -> particular team's submission -> view submission -> assign grades -> view scores.

In the case of the instructor, a single heat grid is shown whereas in the case of a team member, we cant view the scores. In the heat grid, it is not clear if the scores visible are for the reviews that the student has *written* for their teammates or the scores that the student has *received* from their teammates. Additionally, for instructors can choose from a list of the students on the team, but they have no way to tell whether the heat grid shows the reviews done *by* that student or done *for* that student.

== Methodology Overview ==

We have divided our work in the following tasks to address the above problems:

1. Distinguish reviews done for a student by rendering separates heatgrids for each student

2. For instructors, the table will have sections based on the students

3. Include a checkbox on the edit assignment page that enables/disables visibility of heat grid to students

4. Fix the average column for a table (which breaks for some reviews)

5. Show a composite score derived from all reviews. Make this code generalized, so other kinds of heat grid views could use it.

6. Changes should work even in an anonymized view

== Motivations ==

1. Enable users to clearly tell which reviews are done by them, and which reviews are done for them.

2. Code should be generic so it can be used for different types of heat grids as well.

== Control Flow to access the concerned screens ==

== Models used / Explanation of fixes ==

The below diagram illustrates the proposed code change for showing all team members with the teammate review data to an instructor. The existing code only iterated on the `Participant` whose ID is present in the URL of the page. To fix this, we will iterate over all teammates of the given participant so that all teammate reviews for all team members are shown to the instructor.

[[File:Logic e2165.png|border|center|alt=Flow diagram of proposed changes for showing team review data to instructor]]

Existing code:

questionnaires.each do |questionnaire|
@round = nil
if @assignment.vary_by_round && questionnaire.type == "ReviewQuestionnaire"
questionnaires = AssignmentQuestionnaire.where(assignment_id: @assignment.id, questionnaire_id: questionnaire.id)
if questionnaires.count > 1
@round = questionnaires[counter_for_same_rubric].used_in_round
counter_for_same_rubric += 1
else
@round = questionnaires[0].used_in_round
counter_for_same_rubric = 0
end
end

# line which is causing the issue
@vmlist << populate_view_model(@participant, questionnaire, @team)
end

Modified code (replace the line which is causing issues):

if questionnaire.display_type == "Teammate Review"
# as teammate review will be different for each participant
# we need to create a separate table for each teammate
@participant.team.participants.each do |participant|
@vmlist << populate_view_model(participant, questionnaire, @team)
end
else
# only one participant needs iterating, as apart from teammatereview
# all other reviews are at "team" level
@vmlist << populate_view_model(@participant, questionnaire, @team)
end

'''Image 1. Instructor's view of teammate review'''
[[File:Instructor-view-1.png|border|center|alt=The proposed expanded student display.|The proposed expanded student display.]]

The `populate_view_model` returns an instance of `VmQuestionResponse`. This model represents the data required to render the table along with it's metadata, like `list_of_reviews` which is used to render the rows.

== Present Status of the application ==

'''Image 1. Instructor's view of teammate review''': This is the current screen given to the instructor. Here we see that the instructor can not determine who has given which review to which student.

[[File:Instructor-view-1.png|border|center|alt=The proposed expanded student display.|The proposed expanded student display.]]

'''Image 2. Student's view of teammate review''': Currently, a student is not able to see what grades were given by their teammates. We need to implement that functionality so that the student is able to view the grades.

[[File:Student-view-2.png|border|center|alt=The current instructor view.|The current review display for instructors.]]

'''Image 3. UML Diagram''': We are planning to add two variables namely showTeammateReview and hideReviewerName. showTeammateReview will decide whether the students would be able to view their team members reviews. hideReviewerName will decide whether the student is able to view peer's names or not.
[[File:Uml-assignment.png|border|center|alt=The proposed condensed student display.|The proposed condensed student display.]]

== Proposed changes ==

1)''' Proposed UI for instructor ''': The instructor is able to see the score for all teammates. In the existing code, only one teammate's scores are being shown. But, we are planning to change the way the (VmQuestionResponse array is populated)[https://github.com/expertiza/expertiza/blob/master/app/controllers/grades_controller.rb#L114], so that the scores for all teammates are appended to it so it correctly shows what should have already been shown in this screen for the instructor.

[[File:Proposed_screen.png|border|center|alt=Proposed UI for instructor|Proposed UI for instructor.]]

Note: When a student visits this screen, they will only be shown the reviews received by them, assuming the instructor has allowed visibility of teammate reviews to students.

2)''' Error in existing UI for student ''': In the existing UI for a student, the highlighted block should not be rendered. This part of the screen is meant for the instructors/TAs. This portion of the screen being rendered to a student is a mistake, and we will remove this part of the screen from the student's screen as part of our proposed changes.

[[File:Wrong render for student.png|border|center|alt=Existing UI for student|Existing UI for student.]]

3)''' Show teammate review to student UI ''': The existing code doesn't render a student's teammate review scores at all. We are planning to render the scores to a student when they visit this screen. However, the visibility of this screen is contingent on whether the instructor has allowed visibility of the teammate review screen to students. If the instructor has disabled this feature, then the heatgrid will not be displayed at all.

[[File:UI_for_student.png|border|center|alt=New UI for students|New UI for students ]]

== Design Patterns ==

Existing code does not use any design patterns, apart from if-else. It uses if-else conditional statements to check what type of questionnaire is present in the viewmodel `VmQuestionResponse`, and based on that, it renders the appropriate content.

We can use decorator pattern, for handling the visibility of the heatgrid when rendering heatgrids for a student login.

== User Stories ==

1. As an instructor, I can view what reviews one teammate has given to other teammates.

2. As a student, I can view what reviews my teammates have given to me.

3. As an instructor, I can select if a student's reviews are anonymously shown to their teammates.

== Testing ==
'''CURRENT STATUS'''

1. Presently, the tests only cover if the view_team is page is rendered when it is asked for.

'''OUR PROPOSAL'''

1. For a student:

- When show_team is set as false, the student should not be able to see his scores.

- When show_team is set as true, the student should be able to see his scores.

2. For instructor:

- Should be able to see all the scores by default.

- The instructor can decide whether to show the names of the reviewer to the reviewer in teammate reviews, by selecting a checkbox for the same.
[[File:Untitled Diagram.drawio.png|border|center|alt=New UI for students|New UI for students ]]

==References==

<p>https://expertiza.ncsu.edu/</p>

CSC/ECE 517 Fall 2021 - E2165. Fix teammate-review view

2021-11-09T01:51:40Z

Vdeshmu: /* Design Patterns */

== Team Introduction ==

Dr. Edward Gehringer (instructor), Parimal Mehta (mentor)

1. Lalit Bangad (unity ID: llbangad)

2. Vinay Deshmukh (unity ID: vdeshmu)

3. Arvasu Chikara (unity ID: achikar2)

4. Anjali Garg (unity ID : agarg25)

== Problems to be addressed ==

After a project is submitted and reviewed, both the team members (students) and instructors should be able to view the teammate reviews. Students should be able to view the reviews by going to a particular assignment's -> your scores, at the bottom of the page. An instructor can view the teammate reviews by going to assignments -> assignment -> particular team's submission -> view submission -> assign grades -> view scores.

In the case of the instructor, a single heat grid is shown whereas in the case of a team member, we cant view the scores. In the heat grid, it is not clear if the scores visible are for the reviews that the student has *written* for their teammates or the scores that the student has *received* from their teammates. Additionally, for instructors can choose from a list of the students on the team, but they have no way to tell whether the heat grid shows the reviews done *by* that student or done *for* that student.

== Methodology Overview ==

We have divided our work in the following tasks to address the above problems:

1. Distinguish reviews done for a student by rendering separates heatgrids for each student

2. For instructors, the table will have sections based on the students

3. Include a checkbox on the edit assignment page that enables/disables visibility of heat grid to students

4. Fix the average column for a table (which breaks for some reviews)

5. Show a composite score derived from all reviews. Make this code generalized, so other kinds of heat grid views could use it.

6. Changes should work even in an anonymized view

== Motivations ==

1. Enable users to clearly tell which reviews are done by them, and which reviews are done for them.

2. Code should be generic so it can be used for different types of heat grids as well.

== Control Flow to access the concerned screens ==

== Models used / Explanation of fixes ==

The below diagram illustrates the proposed code change for showing all team members with the teammate review data to an instructor. The existing code only iterated on the `Participant` whose ID is present in the URL of the page. To fix this, we will iterate over all teammates of the given participant so that all teammate reviews for all team members are shown to the instructor.

[[File:Logic e2165.png|border|center|alt=Flow diagram of proposed changes for showing team review data to instructor]]

Existing code:

questionnaires.each do |questionnaire|
@round = nil
if @assignment.vary_by_round && questionnaire.type == "ReviewQuestionnaire"
questionnaires = AssignmentQuestionnaire.where(assignment_id: @assignment.id, questionnaire_id: questionnaire.id)
if questionnaires.count > 1
@round = questionnaires[counter_for_same_rubric].used_in_round
counter_for_same_rubric += 1
else
@round = questionnaires[0].used_in_round
counter_for_same_rubric = 0
end
end

# line which is causing the issue
@vmlist << populate_view_model(@participant, questionnaire, @team)
end

Modified code (replace the line which is causing issues):

if questionnaire.display_type == "Teammate Review"
# as teammate review will be different for each participant
# we need to create a separate table for each teammate
@participant.team.participants.each do |participant|
@vmlist << populate_view_model(participant, questionnaire, @team)
end
else
# only one participant needs iterating, as apart from teammatereview
# all other reviews are at "team" level
@vmlist << populate_view_model(@participant, questionnaire, @team)
end

'''Image 1. Instructor's view of teammate review'''
[[File:Instructor-view-1.png|border|center|alt=The proposed expanded student display.|The proposed expanded student display.]]

The `populate_view_model` returns an instance of `VmQuestionResponse`. This model represents the data required to render the table along with it's metadata, like `list_of_reviews` which is used to render the rows.

== Present Status of the application ==

'''Image 1. Instructor's view of teammate review''': This is the current screen given to the instructor. Here we see that the instructor can not determine who has given which review to which student.

[[File:Instructor-view-1.png|border|center|alt=The proposed expanded student display.|The proposed expanded student display.]]

'''Image 2. Student's view of teammate review''': Currently, a student is not able to see what grades were given by their teammates. We need to implement that functionality so that the student is able to view the grades.

[[File:Student-view-2.png|border|center|alt=The current instructor view.|The current review display for instructors.]]

'''Image 3. UML Diagram''': We are planning to add two variables namely showTeammateReview and hideReviewerName. showTeammateReview will decide whether the students would be able to view their team members reviews. hideReviewerName will decide whether the student is able to view peer's names or not.
[[File:Uml-assignment.png|border|center|alt=The proposed condensed student display.|The proposed condensed student display.]]

== Proposed changes ==

1)''' Proposed UI for instructor ''': The instructor is able to see the score for all teammates. In the existing code, only one teammate's scores are being shown. But, we are planning to change the way the VmQuestionResponse array is created, so that the scores for all teammates are appended to it so it correctly shows what should have already been shown in this screen for the instructor.

[[File:Proposed_screen.png|border|center|alt=Proposed UI for instructor|Proposed UI for instructor.]]

Note: When a student visits this screen, they will only be shown the reviews received by them, assuming the instructor has allowed visibility of teammate reviews to students.

2)''' Error in existing UI for student ''': In the existing UI for a student, the highlighted block should not be rendered. This part of the screen is meant for the instructors/TAs. This portion of the screen being rendered to a student is a mistake, and we will remove this part of the screen from the student's screen as part of our proposed changes.

[[File:Wrong render for student.png|border|center|alt=Existing UI for student|Existing UI for student.]]

3)''' Show teammate review to student UI ''': The existing code doesn't render a student's teammate review scores at all. We are planning to render the scores to a student when they visit this screen. However, the visibility of this screen is contingent on whether the instructor has allowed visibility of the teammate review screen to students. If the instructor has disabled this feature, then the heatgrid will not be displayed at all.

[[File:UI_for_student.png|border|center|alt=New UI for students|New UI for students ]]

== Design Patterns ==

Existing code does not use any design patterns, apart from if-else. It uses if-else conditional statements to check what type of questionnaire is present in the viewmodel `VmQuestionResponse`, and based on that, it renders the appropriate content.

We can use decorator pattern, for handling the visibility of the heatgrid when rendering heatgrids for a student login.

== User Stories ==

1. As an instructor, I can view what reviews one teammate has given to other teammates.

2. As a student, I can view what reviews my teammates have given to me.

3. As an instructor, I can select if a student's reviews are anonymously shown to their teammates.

== Testing ==

We will be using RSpec and Capybara for unit and functional testing. UI testing will be done manually.

==References==

<p>https://expertiza.ncsu.edu/</p>

CSC/ECE 517 Fall 2021 - E2165. Fix teammate-review view

2021-11-09T01:33:09Z

Vdeshmu: /* Models used / Explanation of fixes */

== Team Introduction ==

Dr. Edward Gehringer (instructor), Parimal Mehta (mentor)

1. Lalit Bangad (unity ID: llbangad)

2. Vinay Deshmukh (unity ID: vdeshmu)

3. Arvasu Chikara (unity ID: achikar2)

4. Anjali Garg (unity ID : agarg25)

== Problems to be addressed ==

After a project is submitted and reviewed, both the team members (students) and instructors should be able to view the teammate reviews. Students should be able to view the reviews by going to a particular assignment's -> your scores, at the bottom of the page. An instructor can view the teammate reviews by going to assignments -> assignment -> particular team's submission -> view submission -> assign grades -> view scores.

In the case of the instructor, a single heat grid is shown whereas in the case of a team member, we cant view the scores. In the heat grid, it is not clear if the scores visible are for the reviews that the student has *written* for their teammates or the scores that the student has *received* from their teammates. Additionally, for instructors can choose from a list of the students on the team, but they have no way to tell whether the heat grid shows the reviews done *by* that student or done *for* that student.

== Methodology Overview ==

We have divided our work in the following tasks to address the above problems:

1. Distinguish reviews done for a student by rendering separates heatgrids for each student

2. For instructors, the table will have sections based on the students

3. Include a checkbox on the edit assignment page that enables/disables visibility of heat grid to students

4. Fix the average column for a table (which breaks for some reviews)

5. Show a composite score derived from all reviews. Make this code generalized, so other kinds of heat grid views could use it.

6. Changes should work even in an anonymized view

== Motivations ==

1. Enable users to clearly tell which reviews are done by them, and which reviews are done for them.

2. Code should be generic so it can be used for different types of heat grids as well.

== Control Flow to access the concerned screens ==

== Models used / Explanation of fixes ==

[[File:Logic e2165.png|border|center|alt=Flow diagram of proposed changes for showing team review data to instructor]]

The above diagram illustrates the proposed code change for showing all team members with the teammate review data to an instructor.

The existing code only iterated on the `Participant` whose ID is present in the URL of the page. To fix this, we will iterate over all teammates of the given participant so that all teammate reviews for all team members are shown to the instructor.

Existing code:

questionnaires.each do |questionnaire|
@round = nil
if @assignment.vary_by_round && questionnaire.type == "ReviewQuestionnaire"
questionnaires = AssignmentQuestionnaire.where(assignment_id: @assignment.id, questionnaire_id: questionnaire.id)
if questionnaires.count > 1
@round = questionnaires[counter_for_same_rubric].used_in_round
counter_for_same_rubric += 1
else
@round = questionnaires[0].used_in_round
counter_for_same_rubric = 0
end
end

# line which is causing the issue
@vmlist << populate_view_model(@participant, questionnaire, @team)
end

Modified code (replace the line which is causing issues):

if questionnaire.display_type == "Teammate Review"
# as teammate review will be different for each participant
# we need to create a separate table for each teammate
@participant.team.participants.each do |participant|
@vmlist << populate_view_model(participant, questionnaire, @team)
end
else
# only one participant needs iterating, as apart from teammatereview
# all other reviews are at "team" level
@vmlist << populate_view_model(@participant, questionnaire, @team)
end

'''Image 1. Instructor's view of teammate review'''
[[File:Instructor-view-1.png|border|center|alt=The proposed expanded student display.|The proposed expanded student display.]]

The `populate_view_model` returns an instance of `VmQuestionResponse`. This model represents the data required to render the table along with it's metadata, like `list_of_reviews` which is used to render the rows.

== Present Status of the application ==

'''Image 1. Instructor's view of teammate review''': This is the current screen given to the instructor. Here we see that the instructor can not determine who has given which review to which student.

[[File:Instructor-view-1.png|border|center|alt=The proposed expanded student display.|The proposed expanded student display.]]

'''Image 2. Student's view of teammate review''': Currently, a student is not able to see what grades were given by their teammates. We need to implement that functionality so that the student is able to view the grades.

[[File:Student-view-2.png|border|center|alt=The current instructor view.|The current review display for instructors.]]

'''Image 3. UML Diagram''': We are planning to add two variables namely showTeammateReview and hideReviewerName. showTeammateReview will decide whether the students would be able to view their team members reviews. hideReviewerName will decide whether the student is able to view peer's names or not.
[[File:Uml-assignment.png|border|center|alt=The proposed condensed student display.|The proposed condensed student display.]]

== Proposed changes ==

1)''' Proposed UI for instructor ''': The instructor is able to see the score for all teammates. In the existing code, only one teammate's scores are being shown. But, we are planning to change the way the VmQuestionResponse array is created, so that the scores for all teammates are appended to it so it correctly shows what should have already been shown in this screen for the instructor.

[[File:Proposed_screen.png|border|center|alt=Proposed UI for instructor|Proposed UI for instructor.]]

Note: When a student visits this screen, they will only be shown the reviews received by them, assuming the instructor has allowed visibility of teammate reviews to students.

2)''' Error in existing UI for student ''': In the existing UI for a student, the highlighted block should not be rendered. This part of the screen is meant for the instructors/TAs. This portion of the screen being rendered to a student is a mistake, and we will remove this part of the screen from the student's screen as part of our proposed changes.

[[File:Wrong render for student.png|border|center|alt=Existing UI for student|Existing UI for student.]]

3)''' Show teammate review to student UI ''': The existing code doesn't render a student's teammate review scores at all. We are planning to render the scores to a student when they visit this screen. However, the visibility of this screen is contingent on whether the instructor has allowed visibility of the teammate review screen to students. If the instructor has disabled this feature, then the heatgrid will not be displayed at all.

[[File:UI_for_student.png|border|center|alt=New UI for students|New UI for students ]]

== Design Patterns ==
We think that we will be using Abstract Factory for our implementation but this may change as we further our development.

== User Stories ==

1. As an instructor, I can view what reviews one teammate has given to other teammates.

2. As a student, I can view what reviews my teammates have given to me.

3. As an instructor, I can select if a student's reviews are anonymously shown to their teammates.

== Testing ==

We will be using RSpec and Capybara for unit and functional testing. UI testing will be done manually.

==References==

<p>https://expertiza.ncsu.edu/</p>

CSC/ECE 517 Fall 2021 - E2165. Fix teammate-review view

== Introduction ==
[https://expertiza.ncsu.edu/ Expertiza] is an open-source education and classroom web-tool founded by the [http://www.nsf.gov/ National Science Foundation]. Built with Ruby on Rails, it is designed to manage complete courses and students’ work within those courses. Each course can have a collection of instructors and students, though the interaction between instructors and students is minimal. The real emphasis of Expertiza is placed on peer-to-peer interactions, fostering a student-driven learning environment. Courses are comprised of assignments which users complete individually or with a team. Assignments usually encourage or require a team to enforce practicing peer-to-peer interaction.

== Assignment ==

=== Description ===

The tasks of the assignment are as follows:

# Distinguish reviews done by a student and for a student, by creating sections in the table
# For instructors, the table will have sections based on the students
# Include a checkbox on edit assignment page that enables/disables visibiity of heatgrid to students
# Fix average column for table (which breaks for some reviews)
# Show a composite score derived from all reviews. Make this code generalized, so other kinds of heatgrid views could use it.
# Changes should work even in anonymized view

=== Purpose ===
==== Motivations ====
* Enable users to clearly tell which reviews are done by them, and which reviews are done for them.
* Code should be generic so it can be used for different heatgrids as well

==== Discussion ====

// TODO:
There is no denying that the usability of viewing peer reviews leaves much to be desired. It lacks uniformity across the student and instructor roles, and the view itself has no semblance of order or organization. Viewing a single student’s review is a chore for both instructors and students, as there is no clear separation between reviews. In addition, all reviews are displayed at once, meaning viewing a single review requires scrolling through the page until the desired review is found. Our goal is to take the same data in the current display and present it in a more focused manner that allows a user, in either the instructor or student role, to absorb and process the content in the peer review more efficiently. Accessing, viewing, and understanding a review should be a far more simple task than what it currently is. In addition to the overhaul of the presentation layer, we also strive to drastically increase code reuse in the controller and model layers of the review module, which will in turn create a more uniform experience for both the instructor and student roles.

=== Scope ===

// TODO:
The scope of this task is limited to enhancing the usability of viewing peer reviews for both students and instructors. It is within our scope to modify the corresponding views for this functionality, as well as the underlying controllers and models as needed. The modifications to the Ruby classes will either be to accommodate changes to the view or to provide a uniform experience for both the instructor and student. As this is more of a user experience task, e.g, changing the way data is displayed to the user, there will be limited modifications to the base functionality of this module. It is not within our scope to change any element of the actual peer review process, such as selecting a topic to review or completing a review of a topic. As a result, we will not be modifying the results of peer reviews; the same peer review data will be present both before and after our task is completed.

== Design ==

=== Discussion of Resolution ===
The goal of this project is to optimize code and UI of review module, to make it more readable and user-friendly. To be more specific, our work focuses on the following specific areas:

* Add the checkbox to enable/disable visibility of heatgrid for students
* Modifying UI to clearly denote the reviews given by and for a student for both instructors and students

=== Mock-Ups ===

// TODO:

[[File:Heatgrid_studen_condensed.png|border|center|alt=The proposed condensed student display.|The proposed condensed student display.]]
'''Image 2. The proposed student review report, in default collapsed view.'''

Text

[[File:Heatgrid_student_expanded.png|border|center|alt=The proposed expanded student display.|The proposed expanded student display.]]
'''Image 3. The proposed student review report, in expanded view.'''

Text

[[File:Current Instructor.PNG|border|center|alt=The current instructor view.|The current review display for instructors.]]
'''Image 4. Current design of the Instructor's Review Report.'''

Text

=== Design Patterns ===
The implementation team used following design patterns in the solution:

* Pattern 1
* Pattern 2

=== User Stories ===

* Use 1
* Use 2
* Use 3

=== Testing ===
Much of the testing was done informally during the development phase in the development database. Because the database was converted from the production environment, the development environment provide many opportunities for parallel testing between the view_my_scores (existing) and view_team (new) views.

Some functional tests were completed with RSpec, but not many and probably not enough. This was because the scope of the project was large and the implementation team ran out of time before the deadline.

One situation where the parallel testing of the development environment provided limited value was with multi-round assignments and multi-round rubrics because the database came from production prior to the functionality being available in production. thus, in order to have sufficient tests, we created assignments new assignments, and new reviews in the development environment. The tests were not exhaustive, and probably not along the lines of TDD.

=== Functional Tests ===

* ColorMapping module:

* Role Security Testing:

* Char Comment Count Module:

* Calculate Total Review Score:

* Calculate Question Average Score:

=== UI Tests ===

UI will be tested manually, but also automatedly with [https://en.wikipedia.org/wiki/Selenium_(software) Selenium].

== Implementation ==
=== New Files ===

=== Modified Files ===

=== View Models: What, Why How. ===
Advantages:
* fast: The view_team view generates quickly compared to the view_my_scores. the main reason for this is that the view models only contain and retrieve what is necessary to populate the view.

=== Javascript, JQuery, CSS tactics in the view_team view ===
There are 3 main mechanisms that need to be understood in order to modify the view_team view in future development tasks:

The <code>stylesheet grades.scss</code> is used to create the heat grid effect, allowing users to quickly hone in on bad scores:

[[File:Detailedreview2.png|border|center|alt=uml.|UML]]

Text

[[File:Rsz_screenshot_2015-12-04_235548.png|border|center|alt=uml.|UML]]

Text

[[File:detailedreview.png|border|center|alt=uml.|UML]]

=== Users' Access of Report ===
'''see associated video for a visual walk-through here'''
* Instructors: Instructors will access the heat-grid view_team view via the grades/view . A 'heat grid' link appears for each participant.
* Students: Students will access the heat-grid via the student_task/view view, which already lists links available for a participant.

=== UML & ER diagrams ===

Below is a UML diagram of the main model classes used in our solution.
[[File:FinalProjUml2.png|border|center|alt=uml.|UML]]

Below is a ER diagram of the added model classes used in our solution.
[[File:Er_vm2.png|border|center|alt=er.|ER]]

=== Special Testing ===
Screenshot of a single round assignment review
[[File:Singleround.PNG|border|center|alt=singleround.|singleround]]
Screenshot of a multiround assignment review
[[File:Multi_no_vary.PNG|border|center|alt=Multi_no_vary.PNG.|Multi_no_vary.PNG]]
Screenshot of a vary-by-rubric review, with reviews for rounds 1 and 3, and blank 2.
[[File:Vary13.PNG|border|center|alt=Vary13.PNG.|Vary13.PNG]]
Screenshot of a vary-by-rubric review, with reviews for rounds 1 and 2, and blank 3.
[[File:Vary12.PNG|border|center|alt=Vary12.PNG.|Vary12.PNG]]
Screenshot of a vary-by-rubric review, with reviews for rounds 2 and 3, and blank 1.
[[Image:Vary23.PNG|border|center|alt=Vary23.PNG.|Vary23.PNG]]

==Future Enhancements==
* The project team may attempt to implement sorting of the lists and tables in in both the instructor and student review pages.
* The project team suggests that an instructor view of the heat grid be created, with lists all peer reviews for all teams stacked vertically on one page.
* The mock-ups above include suggested functionality for expanding all heatgrid rows. This was not implemented due to time limitations.
* Teammate review display have been suppressed such that they will not be displayed. At the end of the project, we realized that teammate reviews are hidden for the current semester, and we don't know how to implement that logic, so we suppressed teammate reviews to be safe.
==References==
<references/>
<p>https://expertiza.ncsu.edu/</p>

// Add more

CSC/ECE 517 Fall 2021

2021-11-02T18:04:32Z

Vdeshmu: /* Final Projects */

== OSS Projects ==

* [[CSC/ECE 517 Fall 2021 - E2117. Refactor questionaires_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2128. Refactor student_quizzes_controller.rb & late_policies_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2129. Refactor auth_controller.rb & password_retrieval_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2132. Add tests cases for review mapping helper.rb]]
* [[CSC/ECE 517 Fall 2021 - E2134. Write unit tests for admin_controller.rb and institution_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2138. Auto-generate submission directory names based on assignment]]
* [[CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications]]
* [[CSC/ECE 517 Fall 2021 - E2133. Write tests for popup_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2120. Refactor reputation_web_service_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2139. Remove multiple topics at a time]]
* [[CSC/ECE 517 Fall 2021 - E2131. Improve assessment360_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2121. Refactor suggestion_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2122. Refactor impersonate_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2123. Refactor sign_up_sheet_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2126. Refactor account_request_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2124. Refactor review_mapping_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2125. Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Fall 2021 - E2127. Refactor teams_controller]]
* [[CSC/ECE 517 Fall 2021 - E2130. Refactor submitted_content_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2140. Create new late policy successfully and fix Bank link]]
* [[CSC/ECE 517 Fall 2021 - E2141. OSS project Finklestein: Instructors & Institutions]]
* [[CSC/ECE 517 Fall 2021 - E2144. Refactor delayed mailer and scheduled task]]
* [[CSC/ECE 517 Fall 2021 - E2147. Role-based reviewing]]
* [[CSC/ECE 517 Fall 2021 - E2145. OSS Project Beige]]
* [[CSC/ECE 517 Fall 2021 - E2146. Introduce a Student View for instructors]]
* [[CSC/ECE 517 Fall 2021 - Refactor Evaluation of SQL Queries]]
* [[CSC/ECE 517 Fall 2021 - E2135. Email notification to reviewers and instructors]]
* [[CSC/ECE 517 Fall 2021 - E2168. Testing - Reputations]]
* [[CSC/ECE 517 Fall 2021 - E2166. Testing - Scoring & Grades]]
* [[CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations]]

== Final Projects ==
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2152._Revision_planning_tool#Description_about_project CSC/ECE 517 Fall 2021 - E2152. Revision_planning_tool]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2170._Testing_-_Response_Maps#Description_about_project CSC/ECE 517 Fall 2021 - E2170. Testing - Response Maps]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza#Description_about_project CSC/ECE 517 Fall 2021 - E2153. Improving search facility in Expertiza]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper CSC/ECE 517 Fall 2021 - E2162. Further refactoring and improvement of review mapping helper]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2165._Fix_teammate-review_view CSC/ECE 517 Fall 2021 - E2165. Fix teammate review view ]

CSC/ECE 517 Fall 2021

2021-11-02T18:02:07Z

Vdeshmu: /* Final Projects */

== OSS Projects ==

* [[CSC/ECE 517 Fall 2021 - E2117. Refactor questionaires_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2128. Refactor student_quizzes_controller.rb & late_policies_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2129. Refactor auth_controller.rb & password_retrieval_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2132. Add tests cases for review mapping helper.rb]]
* [[CSC/ECE 517 Fall 2021 - E2134. Write unit tests for admin_controller.rb and institution_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2138. Auto-generate submission directory names based on assignment]]
* [[CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications]]
* [[CSC/ECE 517 Fall 2021 - E2133. Write tests for popup_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2120. Refactor reputation_web_service_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2139. Remove multiple topics at a time]]
* [[CSC/ECE 517 Fall 2021 - E2131. Improve assessment360_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2121. Refactor suggestion_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2122. Refactor impersonate_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2123. Refactor sign_up_sheet_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2126. Refactor account_request_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2124. Refactor review_mapping_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2125. Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Fall 2021 - E2127. Refactor teams_controller]]
* [[CSC/ECE 517 Fall 2021 - E2130. Refactor submitted_content_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2140. Create new late policy successfully and fix Bank link]]
* [[CSC/ECE 517 Fall 2021 - E2141. OSS project Finklestein: Instructors & Institutions]]
* [[CSC/ECE 517 Fall 2021 - E2144. Refactor delayed mailer and scheduled task]]
* [[CSC/ECE 517 Fall 2021 - E2147. Role-based reviewing]]
* [[CSC/ECE 517 Fall 2021 - E2145. OSS Project Beige]]
* [[CSC/ECE 517 Fall 2021 - E2146. Introduce a Student View for instructors]]
* [[CSC/ECE 517 Fall 2021 - Refactor Evaluation of SQL Queries]]
* [[CSC/ECE 517 Fall 2021 - E2135. Email notification to reviewers and instructors]]
* [[CSC/ECE 517 Fall 2021 - E2168. Testing - Reputations]]
* [[CSC/ECE 517 Fall 2021 - E2166. Testing - Scoring & Grades]]
* [[CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations]]

== Final Projects ==
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2152._Revision_planning_tool#Description_about_project CSC/ECE 517 Fall 2021 - E2152. Revision_planning_tool]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2170._Testing_-_Response_Maps#Description_about_project CSC/ECE 517 Fall 2021 - E2170. Testing - Response Maps]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza#Description_about_project CSC/ECE 517 Fall 2021 - E2153. Improving search facility in Expertiza]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper CSC/ECE 517 Fall 2021 - E2162. Further refactoring and improvement of review mapping helper]
* [[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2165. Fix teammate-review view]]

CSC/ECE 517 Fall 2021 - E2165. Fix teammate-review view

2021-11-02T18:01:45Z

Vdeshmu: Created page with "E2165"

E2165

2021-10-21T02:37:47Z

Vdeshmu:

__TOC__

==E2140. Create new late policy successfully and fix "Back" link==

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

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

===Problem Statement===
Create new late policy successfull and fix "Back" link.

==Fixes performed==

* Fix back link on "New late policy" page.
* Fix incorrect flash message on the screen when new late policy is created
* Add controller unit tests for create and edit actions for late_policies_controller
* Add functional test for late policy creation
* Add functional test for back button on new late policy page
* Improve flow of late_policies_controller#edit action for better tests
* Fix late_policies_controller#edit action when it displayed two contradictory flashes
* TODO: SQL stack trace shows up when long string is entered in policy name
* View was checked after a controller test to ensure that the correct message is shown to the user.
* Database was checked after controller test to verify whether correct changes happened or didn't.
* TODO: model was also checked to ensure the database is in a correct state

===About Late Policies Controller===

This controller can be accessed by editing an assignment, going on "Due Dates" page and clicking on "New late policy".

== Files modified in current project ==

1. app/controllers/late_policies_controller.rb <br/>
2. app/views/late_policies/new.html.erb <br/>
3. spec/factories/factories.rb<br/>

==Files added for tests===

1. spec/controllers/late_policies_controller_spec.rb <br/>
2. spec/features/late_policy_creation_spec.rb <br/>
3. spec/features/late_policy_back_button_spec.rb <br/>

==Files modified for tests===

1. spec/factories/factories.rb<br />
2. app/controllers/late_policies_controller.rb

===Current Implementation===

* There were no tests present in beta branch, so tests for the CRUD operations were added.
* Edit action for late_policies_controller is complex to reason about, with booleans deciding whether there are errors.
* Back button does not lead to the assignment from which the new late policy page was created.

=====Functionality=====

1.

=====Drawbacks and Solutions=====
* '''Problem 1''': Back button was taking user to index of late_policies, and not assignment due dates page
::The back button was performing it's default action of going back to index page of late_policies, but it needs to send user to the assginment page.

Before: <br />
<pre>
<%= link_to 'Back', :action => 'index' %>
</pre>
After: <br />
<pre>
<%= link_to 'Back', edit_assignment_path(session[:edit_assignment]) %>
</pre>
* '''Solution''': The link_to function is called with the link to the assignment which was last edited, so it will go to assginment page.

* Use edit_assignment_path(session[:edit_assignment]) to go back to the previous page

* '''Problem 2''': Creating new policy with blank fields does not give a proper error

::The existing code just shows a blank error, without specifying what has gone wrong. Hence, user will not know what is wrong when they created a new policy.

* '''Solution''': The existing error handling code was changed to show the ActiveRecord::Invalid errors to user. And in case, a different exception occurs, a "Something went wrong" message is shown, as this exception shouldn't be visible to users.

Before:
<pre>
rescue StandardError
flash[:error] = "The following error occurred while saving the penalty policy: "
</pre>
After:
<pre>
rescue ActiveRecord::RecordInvalid => exception
flash[:error] = exception.record.errors.full_messages.join("<br />").html_safe
redirect_to action: 'new'
rescue StandardError => exception
# In case it's some error, this error should not be shown to users
flash[:error] = "Something went wrong"
</pre>

* '''Problem 3''': Update `update` method of late_policies_controller
:: Existing update method was too convoluted to read and due to it's convolution, it was showing wrong errors on screen.
* '''Solution''':
The control flow of the `update` method was improved to use early exits when errors occur, instead of using booleans to manage execution.

===Code improvements===
late_policies_controller#update
Before
<pre>
@penalty_policy = LatePolicy.find(params[:id])
flash[:error] = "The maximum penalty cannot be less than penalty per unit." if invalid_penalty_per_unit
same_policy_name = false
# if name has changed then only check for this
if same_policy_name == LatePolicy.check_policy_with_same_name(params[:late_policy][:policy_name], instructor_id)
flash[:error] = "The policy could not be updated because a policy with the same name already exists."
if !same_policy_name && !invalid_penalty_per_unit
begin
@penalty_policy.update_attributes(late_policy_params)
@penalty_policy.save!
LatePolicy.update_calculated_penalty_objects(@penalty_policy)
flash[:notice] = "The late policy was successfully updated."
redirect_to action: 'index'
rescue StandardError
flash[:error] = "The following error occurred while updating the penalty policy: "
redirect_to action: 'edit', id: params[:id]
end
elsif invalid_penalty_per_unit
flash[:error] = "Cannot edit the policy. The maximum penalty cannot be less than penalty per unit."
redirect_to action: 'edit', id: params[:id]
elsif same_policy_name
flash[:error] = "Cannot edit the policy. A policy with the same name " + params[:late_policy][:policy_name] + " already exists."
redirect_to action: 'edit', id: params[:id]
</pre>

After:
<pre>
invalid_penalty_per_unit = params[:late_policy][:max_penalty].to_i < params[:late_policy][:penalty_per_unit].to_i
# If penalty per unit is invalid, exit early
if invalid_penalty_per_unit
flash[:error] = "Cannot edit the policy. The maximum penalty cannot be less than penalty per unit."
redirect_to action: 'edit', id: params[:id] and return
end

# Only do DB search if we pass the invalid penalty check
@penalty_policy = LatePolicy.find(params[:id])
# if name has changed, then only check for this
if params[:late_policy][:policy_name] != @penalty_policy.policy_name
if LatePolicy.check_policy_with_same_name(params[:late_policy][:policy_name], instructor_id)
flash[:error] = "Cannot edit the policy. A policy with the same name " + params[:late_policy][:policy_name] + " already exists."
redirect_to action: 'edit', id: params[:id] and return
end
end

begin
@penalty_policy.update_attributes(late_policy_params)
@penalty_policy.save!
LatePolicy.update_calculated_penalty_objects(@penalty_policy)
flash[:notice] = "The late policy was successfully updated."
redirect_to action: 'index' and return
rescue StandardError
flash[:error] = "The following error occurred while updating the penalty policy: "
redirect_to action: 'edit', id: params[:id] and return
end
* text

<pre>
</pre>

:text

<pre>
</pre>

===Automated Testing using RSPEC===
TODO: add this section
The current version of expertiza did not have any test for LatePoliciesController, and for back button.
Using the test driven development(TDD) approach, we have added an exhaustive set of RSPEC tests for LatePoliciesController, to test creation and expected failure to create scenarios.
We have also added tests for back button on new late policy page.
Similarly, we have added feature tests for late policy creation.

Late policy creation tests
<pre>
$ rspec ./spec/features/late_policy_creation_spec.rb
Randomized with seed 65056
.....

Finished in 22.28 seconds (files took 9.71 seconds to load)
5 examples, 0 failures

Randomized with seed 65056

Coverage report generated for RSpec to /.../expertiza/coverage. 2074 / 15378 LOC (13.49%) covered.
[Coveralls] Outside the Travis environment, not sending data.
</pre>

Back button tests
<pre>
$ rspec ./spec/features/late_policy_back_button_spec.rb
Randomized with seed 15242
.

Finished in 9.74 seconds (files took 8.95 seconds to load)
1 example, 0 failures

Randomized with seed 15242

Coverage report generated for RSpec to /.../expertiza/coverage. 2041 / 15378 LOC (13.27%) covered.
</pre>
<pre>
$ rspec ./spec/controllers/late_policies_controller_spec.rb

Randomized with seed 29277
........

Finished in 17.56 seconds (files took 8.64 seconds to load)
8 examples, 0 failures

Randomized with seed 29277

Coverage report generated for RSpec to /.../expertiza/coverage. 1587 / 15800 LOC (10.04%) covered.
[Coveralls] Outside the Travis environment, not sending data.
</pre>

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/vinay-deshmukh/expertiza GitHub Project Repository Fork]
#[https://github.com/expertiza/expertiza/pull/2087/ Pull request to Expertiza repo]
#[https://github.com/vinay-deshmukh/expertiza/projects/1 GitHub Fork: Project board]
#[https://github.com/vinay-deshmukh/expertiza/issues Issues made while development]
#[https://github.com/vinay-deshmukh/expertiza/pulls Pull requests made to the fork to document work]
#[https://github.com/vinay-deshmukh/expertiza/pulls?q=is%3Apr+is%3Aclosed Closed Pull Requests on Fork]

CSC/ECE 517 Fall 2021 - E2140. Create new late policy successfully and fix Bank link

2021-10-20T01:42:25Z

Vdeshmu:

CSC/ECE 517 Fall 2021 - E2140. Create new late policy successfully and fix Bank link

2021-10-19T02:08:03Z

Vdeshmu:

==E2140. Create new late policy successfully and fix "Back" link==

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

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

===Problem Statement===
Create new late policy successfull and fix "Back" link.

==Fixes performed===

* Fix back link on "New late policy" page.
* Fix incorrect flash message on the screen when new late policy is created
* Add controller unit tests for create actions for late_policies_controller
* Add functional test for late policy creation
* Add functional test for back button on new late policy page
* Improve flow of late_policies_controller#edit action for better tests
* Fix late_policies_controller#edit action when it displayed two contradictory flashes
* TODO: SQL stack trace shows up when long string is entered in policy name
* View was checked after a controller test to ensure that the correct message is shown to the user.
* TODO: model was also checked to ensure the database is in a correct state

===About Late Policies Controller===

This controller can be accessed by editing an assignment, going on "Due Dates" page and clicking on "New late policy".

== Files modified in current project ==

1. app/controllers/late_policies_controller.rb <br/>
2. app/views/late_policies/new.html.erb <br/>
3. spec/factories/factories.rb<br/>

==Files added for tests===

1. spec/controllers/late_policies_controller_spec.rb <br/>
2. spec/features/late_policy_creation_spec.rb <br/>

===About Versions Controller===
This class manages different versions of reviews. If a reviewer reviews a submission, and after that, the author revises the submission, the next time the reviewer does a review (s)he will create a new version. Sometimes it’s necessary to find the current version of a review; sometimes it’s necessary to find all versions. Similarly, a user may want to delete the current version of a review, or all versions of a review. Pagination of versions helps the user to view a subset of versions at a time. Considering the huge number of versions in the system, it is very useful to have a pagination mechanism and a filtering mechanism which can be applied on the whole set of versions. The idea is to display the versions in an ordered, comprehensible and logical manner. In Expertiza the gem ‘will_paginate’ is used to achieve pagination.

===Current Implementation===

* There were no tests present in beta branch, so tests for the CRUD operations were added.
* Edit action for late_policies_controller is complex to reason about, with booleans deciding whether there are errors.
* Back button does not lead to the assignment from which the new late policy page was created.

=====Functionality=====

1.

=====Drawbacks and Solutions=====
* '''Problem 1''': Back button was taking user to index of late_policies, and not assignment due dates page
::The back button was performing it's default action of going back to index page of late_policies, but it needs to send user to the assginment page.

Before: <br />
<pre>
<%= link_to 'Back', :action => 'index' %>
</pre>
After: <br />
<pre>
<%= link_to 'Back', 'javascript:history.back()' %>
</pre>
* '''Solution''': The link_to function is called with the page previous to current page, so it will go to assginment page.

* Use javascript:history.back() to go back to the previous page

* '''Problem 2''': Creating new policy with blank fields does not give a proper error

::The existing code just shows a blank error, without specifying what has gone wrong. Hence, user will not know what is wrong when they created a new policy.

* '''Solution''': The existing error handling code was changed to show the ActiveRecord::Invalid errors to user. And in case, a different exception occurs, a "something went wrong" message is shown, as this exception shouldn't be visible to users.

Before:
<pre>
rescue StandardError
flash[:error] = "The following error occurred while saving the penalty policy: "
</pre>
After:
<pre>
rescue ActiveRecord::RecordInvalid => exception
flash[:error] = exception.record.errors.full_messages.join("<br />").html_safe
redirect_to action: 'new'
rescue StandardError => exception
# In case it's some error, this error should not be shown to users
flash[:error] = "Something went wrong"
</pre>

* '''Problem 3''': The paginate method can be moved to a helper class.
::VersionsController is not the only component which require to paginate items. There are other components too. For instance, the UsersController has to paginate the list of users. Hence the Paginate method can be moved to a helper class which can be accessed by other components as well.
* '''Solution''': The filtering options has also been enhanced. The current user can now choose as part of the version search filter any user from a list of users if the current user is authorized to see the versions created by that user.

===New Implementation===
text
<pre>
</pre>
* text

<pre>
</pre>

* text
<pre>
</pre>

===Code improvements===
* text

<pre>
</pre>

:text

<pre>
</pre>

===Automated Testing using RSPEC===
TODO: add this section
The current version of expertiza did not have any test for LatePoliciesController.
Using the test driven development(TDD) approach, we have added an exhaustive set of RSPEC tests for LatePoliciesController, to test all the modifications we have done to the code of the controller class. The tests use double and stub features of rspec-rails gem, to fake the log in by different users - Administrator, Instructor, Student etc. The tests can be executed "rpec spec" command as shown below.
<pre>
TODO:: Add execution trace for tests, with time taken, etc
</pre>

===Testing from UI===
===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/vinay-deshmukh/expertiza GitHub Project Repository Fork]
#[https://github.com/expertiza/expertiza/pull/2087/ Pull request to Expertiza repo]
#[https://github.com/vinay-deshmukh/expertiza/projects/1 GitHub Fork: Project board]
#[https://github.com/vinay-deshmukh/expertiza/issues Issues made while development]
#[https://github.com/vinay-deshmukh/expertiza/pulls Pull requests made to the fork to document work]