Expertiza_Wiki - User contributions [en]

File:Usecases.png

2019-11-10T21:22:55Z

Hwang85: uploaded a new version of "File:Usecases.png"

CSC/ECE 517 Fall 2019 - E1994. Mentor management for assignments without topics

2019-11-10T21:13:07Z

Hwang85:

== '''User Story''' ==
For assignments with topics, like the OSS project, mentors are associated with topics, and then whichever team is assigned to the topic inherits the mentor for that topic However, for assignments without topics (like Program 2), there is no good way to “automatically” assign mentors to projects. The instructor needs to watch teams being formed, and every time a new team is formed, a new mentor needs to be assigned, outside of Expertiza. This leads to a lot of work for the instructor, as well as sometimes long delays before a team is assigned a mentor.

== '''The goal behind this project:''' ==

Develop a trigger that:<br>
1) Is activated when any team has been formed that has k members, where k is greater than 50% of the maximum team capacity<br>
*ex) max members = 4, trigger activated when the team size reaches 3
2) Assign a mentor to the team<br>
*Mentors should be evenly assigned to teams, so a good strategy is to assign the mentor who has the fewest teams to mentor so far.
3) Notify the mentor via email that they are now assigned to a specific team, and provide the email addresses of the team members.
4) Possibly notify the team members that they have been assigned the mentor with contact information (further discussion here)<br>

== '''Design Pattern''' ==
Since the trigger we implemented would need multiple handlers and each of them reponses in different actions, we decide to use Chain of Responsibility as the design pattern. Chain of Responsibility is a behavioral design pattern that lets you pass requests along a chain of handlers. Upon receiving a request, each handler decides either to process the request or to pass it to the next handler in the chain.
[[File:Chain of Responsibility.png]]

== '''Project Description''' ==

=== Old version: ===
For assignments without a topic, there is no way to assign a mentor to the team on Expertiza system but to manually assigned one via Email out of the system.
[[File:Assign Mentor.png]]
<br>In the above case, only OSS project and final project which have topic could be assigned mentors automatically by Expertiza system.
=== New version: ===

== '''Design Diagrams''' ==

=== Use case Diagram ===
[[File:usecases.png]]
=== Data Flow Diagram ===

== '''Proposed Solution''' ==

'''The solution has five parts:'''

== '''Code Modified & Added''' ==

== '''Test Plan''' ==
To make sure the refactor code can work correctly, we need to run the original rspec test code and add some new test. Besides, we are plaining to test from UI to make sure all the features work. The test results are shown below.

*Run and pass existing RSpec Tests after refactoring
*Develop New RSpec Tests for the new features
*UI testing on the deployed project
==RSpec Test==
==UI Test==

== '''Team Member''' ==
Our team members: (Sorted in Alphabetical order)<br/>
*Hongli Wang, hwang85@ncsu.edu
*Minghao Liu, mliu25@ncsu.edu
*Ruiwen Wu, rwu5@ncsu.edu
*Siwei Wen, swen4@ncsu.edu

Mentor: Mrs. Carmen Aiken Bentley

File:Usecases.png

2019-11-10T21:12:24Z

Hwang85:

File:Use-cases.png

2019-11-10T21:09:09Z

Hwang85:

File:Use-case.png

2019-11-10T21:08:20Z

Hwang85:

CSC/ECE 517 Fall 2019 - E1994. Mentor management for assignments without topics

2019-11-10T20:17:45Z

Hwang85:

== '''The goal behind this project:''' ==

Develop a trigger that:<br>
Is activated when any team has been formed that has k members, where k is greater than 50% of the maximum team capacity
ex) max members = 4, trigger activated when the team size reaches 3
Assign a mentor to the team
Mentors should be evenly assigned to teams, so a good strategy is to assign the mentor who has the fewest teams to mentor so far.
Notify the mentor via email that they are now assigned to a specific team, and provide the email addresses of the team members.
Possibly notify the team members that they have been assigned the mentor with contact information (further discussion here)

== '''Project Description''' ==

=== Predict version: ===

== '''Design Diagrams''' ==

=== Use case Diagram ===

=== Data Flow Diagram ===

== '''Proposed Solution''' ==

'''The solution has five parts:'''

=== Check if the change to the rubric is made during the task duration ===

== '''Code Change''' ==

== '''Test Plan''' ==

CSC/ECE 517 Fall 2019 - E1994. Mentor management for assignments without topics

2019-11-10T20:11:26Z

Hwang85:

== '''The goal to this project:''' ==

#When a rubric is replaced or the items/questions attached to it are changed, all the active students’ responses object to that rubric will be deleted are created again, that means students need to redo the reviews if they have already done.
#The system will email the students who have done reviews to notify a redo request after deleting the response object and all associated answer objects.
#The “active” in the first goal means the replacement action happened during the task duration and the student responses have done in the task duration before the replacing rubric action. For example, a rubric starts from Sep.9th and ends at Sep.13th. An instructor replaces the rubric on Sep.12th, when 60 of 100 students have already finished their reviews. Then the response objects will be deleted and re-created to be new objects in the system, and students need to redo their reviews based on the new rubric.
#Write comprehensive tests for the above implementation to confidently prove they are correct.

== '''Project Description''' ==

=== Current version: ===

The function classification change as two kinds: Minor change & Major change.

Minor Change defined as the change makes no difference to reviewings so that we could also use reviewing before change made.(e.g. Delete questions or clarify the statement).
And Major change would modify or add some new questions which can’t be found in previous rubric. In such situations, system would delete all related reviewing records and email those reviewers to redone reviewing.

=== Predict version: ===

For Minor changes, we still make no movement to database since it makes no effect on scoring process. But Major changes have to be made further development as concerning about Time.

Time_1: Changes should be determined if it is changed in duration, when some students have started and the others not. If change isn’t made in this period it would have no effect.

Time_2: When changes are made at reviewing period, we should make a further consideration about record in DB. The records which were made in this period should be deleted but records in previous semesters are supposed to maintain.

== '''Design Diagrams''' ==
=== Use case Diagram ===
[[File:Ucdiagrame.png]]

=== Data Flow Diagram ===
[[File:DesignFlow.png]]

The main goal of the code is to edit the rubric. There are 3 types of action: edit, add, and delete questions. We classify these actions into two types: major change and minor change.

Note: Editing questions refers to editing only the text of the questions. Changing the type (multiple-choice, simple-text...) of a question is not allowed in Expertiza. You have to delete the old question and add a new one.

Minor change: Edit questions. In this case, we simply update the text of the questions. There’s no other actions needed.

Major change: Add/Delete questions. In this case, we have to check if there are any reviews done by students in the active period, i.e. the period of time when students can submit reviews. If there are any, we have to notify the affected students by email asking them to re-submit a review using the updated rubric, and delete their old reviews.

== '''Proposed Solution''' ==

'''The solution has five parts:'''

* Check the changes made by instructor. Major or minor?
* Check if the change to the rubric is made during the task duration (or if there is any active response?).
* Process updates when a major change is made.
* E- mail notification is sent to request students to redo their reviews.
* Test the implementation thoroughly.

=== Check if the change to the rubric is made during the task duration ===

After a change is made, the system will check if the date is during the task duration to determine whether it needs to update existing response objects. The function method will get params as the start time and expire time of the target rubric to proceed a checking. If the change is not during an active task duration, then nothing further needs to be done. If the change is during an active task duration, then the system will do the following work.
=== Check the changes made by instructor. Major or minor? ===
Changes are categorized to be major or minor. Minor changes affects only the wording of a particular rubric item. In this case, no action is necessary. Major changes involves rubric replacing and changing items/questions. In this case, all the reviews that have been done need to be redone. To tell a major change, the params passed to the controller includes a tag/identifier that indicates if a new question was added, hence a major change.
=== Process updates when a major change is made. ===
If the previous process returns that a major change has been made, the system deletes existing response objects and re-creates new updated object in database when a student press on “review”. As for minor changes, updates affects only the objects that created after the change.
=== E- mail notification is sent to request students to redo their reviews. ===
Once controller notice instructor makes a major change of the rubric, and some students have begun the peer review, email notification module is initiated. In this circumstance, the system will generate ActiveRecord and send it to those students. (Their email address could be found in user’s table.) After email successfully sent, record of this student in this assignment and period will be deleted from the database.
When students receive the email and update their review, the questions now correspond to the new rubric. And students can see all the details of the old questionnaire in the email, so they won’t have to rewrite the same questions’ answer.
=== Test the implementation thoroughly. ===
Our test is designed to three parts: common cases, invalid cases and extreme cases. Details of test plan are included in the Test Plan section below.

== '''Code Change''' ==

== '''Test Plan''' ==
Each component of the system is tested in a dedicated test file in the spec directory, and the test file name is according to the function tested. Our unit test is accomplished in questionnaires_controller_spec.rb. We should test each (reasonable) method of the controller with at least the following scenarios:
* Common Cases
** If the instructor only edit a particular rubric item (e.g. to clarify the statement), no action is necessary.
** If the instructor only delete a particular rubric item (e.g. to delete one of the peer review's criteria), no action is necessary.
** If the instructor add a particular rubric item (e.g. to add a peer review's criteria) in the student peer review period, the controller should then email the previously done reviews to the reviewer and delete the response object and all associated answer objects. (However, the response_map should not be changed.)

* Invalid Cases
** If the instructor add a particular rubric item (e.g. to add a peer review's criteria) out of the student peer review period, no action is necessary.

* Extreme Cases
** If the instructor change the whole rubric (e.g. to delete the old rubic, create a new rubic and assign it to this assignment) in the student peer review period, the controller should then email the previously done reviews to the reviewer and delete the response object and all associated answer objects. (The response_map should be changed since the id of rubric change.)

CSC/ECE 517 Fall 2019 - E1966. Tabbed reviews partial file refactor for displaying the alternate view of reviews

2019-10-29T23:31:42Z

Hwang85:

== '''About Expertiza''' ==

Expertiza is a open source project currently for CSC517 instructor and students forming groups, submit work, review, and view grades. The project is based on Ruby on Rails framework and the code is on Github: https://github.com/expertiza/expertiza. Expertiza serves wiki page, collecting information of all internal information and updates of all versions.

== '''Problem Statement''' ==
===Issue details===

1) On student end, Expertiza uses grades/_reviews.html.erb partial file to display reviewers, scores and review details; on instructor end, it uses Response model methods to construct html file for review pages. We need to use the same kinds of partials in instructor-end and student-end.

How to get the view of reviewers, scores and review details on student end? Click "Alternate View" button, and click "show reviews" link. The reviewers and scores pop up on the top and review details are below them.
How to get the view of reviewers, scores and review details on instructor end? Click "Scores" for a certain assignment and choose a team. Click "Statistics" tab and then reviewers and scores table show up. Click "Reviews" tab and then click one of students' name link in the table head. And a new page pops up with review details.

2) Give Feedback link at view_my_score at student-end should not appear at folded view.
Where to find Give Feedback link? On student end, click "Alternate View" button and click "show reviews" link. At the bottom of a certain review, a give feedback link shows up.

===What to do===
1) We need to use the same kinds of partials in instructor-end and student-end. So we decide to use grades/_team_statistics.html.erb to display reviewers and scores and to use grades/_tabbed_reviews.html.erb to display review details for both student-end and instructor-end.

2) Give Feedback link at view_my_score should appear at the bottom of expanded view.

== '''Solution''' ==
For student end, split reviews.html.erb into two partial files. One is grades/team_review_statistics.html.erb for reviewers and scores. The other one is grades/tabbed_reviews.html.erb for review details.
For instructor end, it used to use response model methods to construct html files for review details, now we use grades/tabbed_reviews.html.erb to display review details.
So student end and instructor end both use grades/team_review_statistics and grades/tabbed_reviews to display reviewers, scores and review details.
===Deploy Link===
[http://152.46.17.70:8080 Our project is deployed at VCL ]
===Student End===

* In student end, render grades/team_review_statistics and grades/tabbed_reviews two partial files instead of grades/reviews partial file.
'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/team_review_statistics', :locals => {:prefix => 'user', :participant => participant, :pscore => pscore} %>
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %>
</TD>
</TR>
</pre>
* Add statistics view to student end by using the team_review_statistics.html.erb file.
'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/team_review_statistics', :locals => {:prefix => 'user', :participant => participant, :pscore => pscore} %>
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %>
</TD>
</TR>
</pre>

'''app/views/grades/_team_review_statistics.html.erb'''
<pre>
<% if controller.action_name != "view_my_scores"%>
<tr>
<td colspan="10">
<% end %>

<% if controller.action_name != "view_my_scores"%>
</td>
</tr>
<% end %>
</pre>
[[File:student-table.png ]]

[[File:Student-detail.png]]

* Add feed back link in student end view.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<% if controller.action_name == "view_my_scores"%>

<% map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: participant.id).first
review_feedbacks = map.try :response %>
<% if review_feedbacks && !review_feedbacks.empty? %>
<%= link_to "View", :controller => 'response', :action => 'view', :id => review_feedbacks.first.id %> or
<%= link_to "Edit", :controller => 'response', :action => 'edit', :id => review_feedbacks.first.id, :return => "feedback" %> feedback for Review <%= count %>
<% else %>
<%= link_to "Give feedback", :controller => 'response', :action => 'new_feedback', :id => review.id %> for Review <%= count %>
<% end %>
</td></tr>
<% end %>
</pre>
[[File:Student-feedback.png]]

* Add javascript to tabbed review so it can be hidden or shown by clicking the show/hide reviews.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<script type="text/javascript">
toggle_tag_prompt = function() {
$('.tag_prompt_container').toggle();
};
$( document ).ready(function() {
$('#tag_prompt_toggler').click(function () {
if ($('#tag_prompt_toggler').text() == "hide tags")
$('#tag_prompt_toggler').text("show tags")
else
$('#tag_prompt_toggler').text("hide tags")
});
});
</script>
</pre>
===Instructor End===

* Create new method view2 for response_controller

''' app/controllers/response_controller.rb '''
<pre>
def view2
@response = Response.find(params[:id])
@map = @response.map
set_content2
render "response/view"
end
......
def set_content2(new_response = false)
@contributor = @map.contributor
members = TeamsUser.where(team_id: params[:team])
@user = members.first
@participant = AssignmentParticipant.where(user_id: @user.user_id, parent_id: params[:assignment]).first
@assignment = @participant.assignment
questionnaires = @assignment.questionnaires
@questions = retrieve_questions questionnaires, @assignment.id
# @pscore has the newest versions of response for each response map, and only one for each response map (unless it is vary rubric by round)
@pscore = @participant.scores(@questions)
@reviewer = @map.reviewer
@round = params[:round]
end
def retrieve_questions(questionnaires, assignment_id)
questions = {}
questionnaires.each do |questionnaire|
round = AssignmentQuestionnaire.where(assignment_id: assignment_id, questionnaire_id: questionnaire.id).first.used_in_round
questionnaire_symbol = if !round.nil?
(questionnaire.symbol.to_s + round.to_s).to_sym
else
questionnaire.symbol
end
questions[questionnaire_symbol] = questionnaire.questions
end
questions
end
</pre>

* change the url jumping to after clicking to a certain reviewer.
''' app/views/grades/_view_heatgrid.html.erb '''
<pre>
<th class="sorter-false"> <a target="_blank" href="../response/view2?id=<%= review.id.to_s %>&&team=<%= @team.id %>&&round=<%= vm.round.to_s %>&&assignment=<%= @assignment.id %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= user_name.to_s %></a> </th>
</pre>

* render grades/tabbed_reviews for review details at instructor end
''' app/views/response/view.html.erb '''
<pre>
<% if controller.action_name != "view2" %>
<% file_url = nil %>
<%= @response.display_as_html(nil, nil, file_url) %>
<br/>
<% else %>
<TR style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => @participant, :rscore => @pscore[:review], :reviewer => @reviewer, :round => @round} %>
</TD>
</TR>
<% end %>
</pre>

* show right round according to which round user click at instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% rounds.each do |round| %>
<% if controller.action_name == "view2"%>
<% next if round.to_s != @round.to_s %>
<% end %>
......
<% end %>
</pre>

* Create construct_instructor2_html in respond model in order to not show review number
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% prefix = "instructor" if controller.action_name == "view2" %>
</pre>

''' app/models/response.rb '''
<pre>
if prefix == "instructor"
self_id = self.id.to_s
code = construct_instructor2_html identifier, self_id, count
......
def construct_instructor2_html identifier, self_id, count
identifier += '<table width="100%">'\
'<tr>'\
'<td align="left" width="70%"><b>Review ' + '</b>   '\
'<a href="#" name= "review_' + self_id + 'Link" onClick="toggleElement(' + "'review_" + self_id + "','review'" + ');return false;">hide review</a>'\
'</td>'\
'<td align="left"><b>Last Reviewed:</b>'\
"<span>#{(self.updated_at.nil? ? 'Not available' : self.updated_at.strftime('%A %B %d %Y, %I:%M%p'))}</span></td>"\
'</tr></table>'
end
</pre>

* Show just one review in instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% rscore[:assessments].select{|response| response.round == round}.reverse.uniq{|response| response.map_id}.sort_by{|response| response.map_id}.each_with_index do |review, index| %>
<% if controller.action_name == "view2"%>
<% next if review.reviewer != @reviewer || count > 0 %>
<% end %>
......
<% end %>
</pre>
[[File:instructorend.png ]]

=='''Test Plans'''==
*The rspec test plan is written such that each requirement(for student-end and instructor-end) will have at least 1 different test.
*The test plan is also used as a check of bug fix implementation. It ensures that each required function is implemented and each bug is well fixed.
*The test file can be manually executed the by running "rspec ./spec/features/tabbed_reviews_spec.rb" on rails terminal.

=='''Test files'''==

*tabbed_review_spec.rb created and added 3 test cases for alternate view of reviews
'''spec/features/tabbed_review_spec.rb'''
<pre>
require "spec_helper"
require 'rspec'
describe "alternate view of reviews" do
before(:each) do
assignment1 = create(:assignment, name: "111", directory_path: 'test_assignment')
create_list(:participant, 3)
create(:assignment_node)
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_due_date, deadline_type: DeadlineType.where(name: 'review').first, due_at: Time.now.in_time_zone + 1.day)
create(:topic)
create(:topic, topic_name: "TestReview")
create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
create(:assignment_questionnaire)
create(:question)
# create(:review_response_map, reviewer_id: User.where(role_id: 2).third.id)
# create(:review_response_map, reviewer_id: User.where(role_id: 2).second.id, reviewee: AssignmentTeam.second)
# sleep(10000)
end

def load_alternate
login_as('student2064')
expect(page).to have_content "User: student2064"
expect(page).to have_content "111"

click_link "111"
expect(page).to have_content "Submit or Review work for 111"
expect(page).to have_content "Alternate View"

click_link "Alternate View"
expect(page).to have_content "Contributor"
end

it "shows the correct alternate view" do
# Load questionnaire with generic setup
load_alternate
expect(page).to have_content "Contributor"
expect(page).to have_content "Stats"
expect(page).to have_content "Submitted work"
expect(page).to have_content "Author Feedback"
expect(page).to have_content "Teammate Review"
expect(page).to have_content "Final Score"
expect(page).to have_content "Range"
expect(page).to have_content "Average"
expect(page).to have_content "student2064"

expect(page).to have_css "a[href='#']", text: 'hide stats'
expect(page).to have_css "a[href='#']", text: 'show submission'
#expect(page).to have_css "a[href='#']", text: 'show reviews'
#page.should have_selector('table tr', text: 'show reviews')
#find(:xpath, "//tr[contains(.,'show reviews')]/td/a", :text => 'show reviews').click
#expect(page).to have_content "Writeup"
end
#describe "grades/participant", :type => :view do
#it 'exists' do
#find(:xpath, "//tr[contains(.,'show reviews')]/td/a", :text => 'show reviews').click
#end
#end
end

describe "test for instructor" do
before(:each) do
# assignment and topic
create(:assignment,
name: "Test Assignment",
directory_path: "Test Assignment",
rounds_of_reviews: 2,
staggered_deadline: true,
max_team_size: 1,
allow_selecting_additional_reviews_after_1st_round: true)
create_list(:participant, 3)
create(:topic, topic_name: "Topic_1")
create(:topic, topic_name: "Topic_2")
create(:topic, topic_name: "Topic_3")
assignment_id = Assignment.where(name: 'Test Assignment')[0].id

#visit "/response/view2?id=#{review_id}&&team=#{team_id}&&round=1&&assignment=#{assignment_id}"
# rubric
create(:questionnaire, name: "TestQuestionnaire1")
create(:questionnaire, name: "TestQuestionnaire2")
create(:question, txt: "Question1", questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire1').first, type: "Criterion")
create(:question, txt: "Question2", questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire2').first, type: "Criterion")
create(:assignment_questionnaire, questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire1').first, used_in_round: 1)
create(:assignment_questionnaire, questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire2').first, used_in_round: 2)
questionnaire_id = ReviewQuestionnaire.first.id.to_s

# deadline type
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
visit "response/view2?id=#{questionnaire_id}&&team=1&&round=1&&assignment=#{assignment_id}"
end

it "can go to review details" do
expect(page).to have_content "Toggle navigation"
expect(page).to have_content "Papers on Expertiza"
expect(page).to have_content "response"
end

end
</pre>

=='''Team Information'''==
#[https://github.com/aranne/expertiza Forked Issue on Github]
#Weiran Fu (wfu4@ncsu.edu)
#Qingyan Wang (qwang20@ncsu.edu)
#Hongli Wang (hwang85@ncsu.edu)
#'''Mentor:''' Mohit Jain (mjain6@ncsu.edu)

=='''References'''==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1966. Tabbed reviews partial file refactor for displaying the alternate view of reviews

2019-10-29T23:14:07Z

Hwang85:

== '''About Expertiza''' ==

Expertiza is a open source project currently for CSC517 instructor and students forming groups, submit work, review, and view grades. The project is based on Ruby on Rails framework and the code is on Github: https://github.com/expertiza/expertiza. Expertiza serves wiki page, collecting information of all internal information and updates of all versions.

== '''Problem Statement''' ==
===Issue details===

1) On student end, Expertiza uses grades/_reviews.html.erb partial file to display reviewers, scores and review details; on instructor end, it uses Response model methods to construct html file for review pages. We need to use the same kinds of partials in instructor-end and student-end.

How to get the view of reviewers, scores and review details on student end? Click "Alternate View" button, and click "show reviews" link. The reviewers and scores pop up on the top and review details are below them.
How to get the view of reviewers, scores and review details on instructor end? Click "Scores" for a certain assignment and choose a team. Click "Statistics" tab and then reviewers and scores table show up. Click "Reviews" tab and then click one of students' name link in the table head. And a new page pops up with review details.

2) Give Feedback link at view_my_score at student-end should not appear at folded view.
Where to find Give Feedback link? On student end, click "Alternate View" button and click "show reviews" link. At the bottom of a certain review, a give feedback link shows up.

===What to do===
1) We need to use the same kinds of partials in instructor-end and student-end. So we decide to use grades/_team_statistics.html.erb to display reviewers and scores and to use grades/_tabbed_reviews.html.erb to display review details for both student-end and instructor-end.

2) Give Feedback link at view_my_score should appear at the bottom of expanded view.

== '''Solution''' ==
For student end, split reviews.html.erb into two partial files. One is grades/team_review_statistics.html.erb for reviewers and scores. The other one is grades/tabbed_reviews.html.erb for review details.
For instructor end, it used to use response model methods to construct html files for review details, now we use grades/tabbed_reviews.html.erb to display review details.
So student end and instructor end both use grades/team_review_statistics and grades/tabbed_reviews to display reviewers, scores and review details.
===Deploy Link===
[http://152.46.17.70:8080 Our project is deployed at VCL ]
===Student End===

* In student end, render grades/team_review_statistics and grades/tabbed_reviews two partial files instead of grades/reviews partial file.
'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/team_review_statistics', :locals => {:prefix => 'user', :participant => participant, :pscore => pscore} %>
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %>
</TD>
</TR>
</pre>
* Add statistics view to student end by using the team_review_statistics.html.erb file.
'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/team_review_statistics', :locals => {:prefix => 'user', :participant => participant, :pscore => pscore} %>
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %>
</TD>
</TR>
</pre>

'''app/views/grades/_team_review_statistics.html.erb'''
<pre>
<% if controller.action_name != "view_my_scores"%>
<tr>
<td colspan="10">
<% end %>

<% if controller.action_name != "view_my_scores"%>
</td>
</tr>
<% end %>
</pre>
[[File:student-table.png ]]

[[File:Student-detail.png]]

* Add feed back link in student end view.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<% if controller.action_name == "view_my_scores"%>

<% map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: participant.id).first
review_feedbacks = map.try :response %>
<% if review_feedbacks && !review_feedbacks.empty? %>
<%= link_to "View", :controller => 'response', :action => 'view', :id => review_feedbacks.first.id %> or
<%= link_to "Edit", :controller => 'response', :action => 'edit', :id => review_feedbacks.first.id, :return => "feedback" %> feedback for Review <%= count %>
<% else %>
<%= link_to "Give feedback", :controller => 'response', :action => 'new_feedback', :id => review.id %> for Review <%= count %>
<% end %>
</td></tr>
<% end %>
</pre>
[[File:Student-feedback.png]]

* Add javascript to tabbed review so it can be hidden or shown by clicking the show/hide reviews.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<script type="text/javascript">
toggle_tag_prompt = function() {
$('.tag_prompt_container').toggle();
};
$( document ).ready(function() {
$('#tag_prompt_toggler').click(function () {
if ($('#tag_prompt_toggler').text() == "hide tags")
$('#tag_prompt_toggler').text("show tags")
else
$('#tag_prompt_toggler').text("hide tags")
});
});
</script>
</pre>
===Instructor End===

* Create new method view2 for response_controller

''' app/controllers/response_controller.rb '''
<pre>
def view2
@response = Response.find(params[:id])
@map = @response.map
set_content2
render "response/view"
end
......
def set_content2(new_response = false)
@contributor = @map.contributor
members = TeamsUser.where(team_id: params[:team])
@user = members.first
@participant = AssignmentParticipant.where(user_id: @user.user_id, parent_id: params[:assignment]).first
@assignment = @participant.assignment
questionnaires = @assignment.questionnaires
@questions = retrieve_questions questionnaires, @assignment.id
# @pscore has the newest versions of response for each response map, and only one for each response map (unless it is vary rubric by round)
@pscore = @participant.scores(@questions)
@reviewer = @map.reviewer
@round = params[:round]
end
def retrieve_questions(questionnaires, assignment_id)
questions = {}
questionnaires.each do |questionnaire|
round = AssignmentQuestionnaire.where(assignment_id: assignment_id, questionnaire_id: questionnaire.id).first.used_in_round
questionnaire_symbol = if !round.nil?
(questionnaire.symbol.to_s + round.to_s).to_sym
else
questionnaire.symbol
end
questions[questionnaire_symbol] = questionnaire.questions
end
questions
end
</pre>

* change the url jumping to after clicking to a certain reviewer.
''' app/views/grades/_view_heatgrid.html.erb '''
<pre>
<th class="sorter-false"> <a target="_blank" href="../response/view2?id=<%= review.id.to_s %>&&team=<%= @team.id %>&&round=<%= vm.round.to_s %>&&assignment=<%= @assignment.id %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= user_name.to_s %></a> </th>
</pre>

* render grades/tabbed_reviews for review details at instructor end
''' app/views/response/view.html.erb '''
<pre>
<% if controller.action_name != "view2" %>
<% file_url = nil %>
<%= @response.display_as_html(nil, nil, file_url) %>
<br/>
<% else %>
<TR style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => @participant, :rscore => @pscore[:review], :reviewer => @reviewer, :round => @round} %>
</TD>
</TR>
<% end %>
</pre>

* show right round according to which round user click at instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% rounds.each do |round| %>
<% if controller.action_name == "view2"%>
<% next if round.to_s != @round.to_s %>
<% end %>
......
<% end %>
</pre>

* Create construct_instructor2_html in respond model in order to not show review number
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% prefix = "instructor" if controller.action_name == "view2" %>
</pre>

''' app/models/response.rb '''
<pre>
if prefix == "instructor"
self_id = self.id.to_s
code = construct_instructor2_html identifier, self_id, count
......
def construct_instructor2_html identifier, self_id, count
identifier += '<table width="100%">'\
'<tr>'\
'<td align="left" width="70%"><b>Review ' + '</b>   '\
'<a href="#" name= "review_' + self_id + 'Link" onClick="toggleElement(' + "'review_" + self_id + "','review'" + ');return false;">hide review</a>'\
'</td>'\
'<td align="left"><b>Last Reviewed:</b>'\
"<span>#{(self.updated_at.nil? ? 'Not available' : self.updated_at.strftime('%A %B %d %Y, %I:%M%p'))}</span></td>"\
'</tr></table>'
end
</pre>

* Show just one review in instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% rscore[:assessments].select{|response| response.round == round}.reverse.uniq{|response| response.map_id}.sort_by{|response| response.map_id}.each_with_index do |review, index| %>
<% if controller.action_name == "view2"%>
<% next if review.reviewer != @reviewer || count > 0 %>
<% end %>
......
<% end %>
</pre>
[[File:instructorend.png ]]

=='''Test Plans'''==

*tabbed_review_spec.rb created and added 3 test cases for alternate view of reviews
'''spec/features/tabbed_review_spec.rb'''
<pre>
require "spec_helper"
require 'rspec'
describe "alternate view of reviews" do
before(:each) do
assignment1 = create(:assignment, name: "111", directory_path: 'test_assignment')
create_list(:participant, 3)
create(:assignment_node)
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_due_date, deadline_type: DeadlineType.where(name: 'review').first, due_at: Time.now.in_time_zone + 1.day)
create(:topic)
create(:topic, topic_name: "TestReview")
create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
create(:assignment_questionnaire)
create(:question)
# create(:review_response_map, reviewer_id: User.where(role_id: 2).third.id)
# create(:review_response_map, reviewer_id: User.where(role_id: 2).second.id, reviewee: AssignmentTeam.second)
# sleep(10000)
end

def load_alternate
login_as('student2064')
expect(page).to have_content "User: student2064"
expect(page).to have_content "111"

click_link "111"
expect(page).to have_content "Submit or Review work for 111"
expect(page).to have_content "Alternate View"

click_link "Alternate View"
expect(page).to have_content "Contributor"
end

it "shows the correct alternate view" do
# Load questionnaire with generic setup
load_alternate
expect(page).to have_content "Contributor"
expect(page).to have_content "Stats"
expect(page).to have_content "Submitted work"
expect(page).to have_content "Author Feedback"
expect(page).to have_content "Teammate Review"
expect(page).to have_content "Final Score"
expect(page).to have_content "Range"
expect(page).to have_content "Average"
expect(page).to have_content "student2064"

expect(page).to have_css "a[href='#']", text: 'hide stats'
expect(page).to have_css "a[href='#']", text: 'show submission'
#expect(page).to have_css "a[href='#']", text: 'show reviews'
#page.should have_selector('table tr', text: 'show reviews')
#find(:xpath, "//tr[contains(.,'show reviews')]/td/a", :text => 'show reviews').click
#expect(page).to have_content "Writeup"
end
#describe "grades/participant", :type => :view do
#it 'exists' do
#find(:xpath, "//tr[contains(.,'show reviews')]/td/a", :text => 'show reviews').click
#end
#end
end

describe "test for instructor" do
before(:each) do
# assignment and topic
create(:assignment,
name: "Test Assignment",
directory_path: "Test Assignment",
rounds_of_reviews: 2,
staggered_deadline: true,
max_team_size: 1,
allow_selecting_additional_reviews_after_1st_round: true)
create_list(:participant, 3)
create(:topic, topic_name: "Topic_1")
create(:topic, topic_name: "Topic_2")
create(:topic, topic_name: "Topic_3")
assignment_id = Assignment.where(name: 'Test Assignment')[0].id

#visit "/response/view2?id=#{review_id}&&team=#{team_id}&&round=1&&assignment=#{assignment_id}"
# rubric
create(:questionnaire, name: "TestQuestionnaire1")
create(:questionnaire, name: "TestQuestionnaire2")
create(:question, txt: "Question1", questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire1').first, type: "Criterion")
create(:question, txt: "Question2", questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire2').first, type: "Criterion")
create(:assignment_questionnaire, questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire1').first, used_in_round: 1)
create(:assignment_questionnaire, questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire2').first, used_in_round: 2)
questionnaire_id = ReviewQuestionnaire.first.id.to_s

# deadline type
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
visit "response/view2?id=#{questionnaire_id}&&team=1&&round=1&&assignment=#{assignment_id}"
end

it "can go to review details" do
expect(page).to have_content "Toggle navigation"
expect(page).to have_content "Papers on Expertiza"
expect(page).to have_content "response"
end

end
</pre>

=='''Team Information'''==
#[https://github.com/aranne/expertiza Forked Issue on Github]
#Weiran Fu (wfu4@ncsu.edu)
#Qingyan Wang (qwang20@ncsu.edu)
#Hongli Wang (hwang85@ncsu.edu)
#'''Mentor:''' Mohit Jain (mjain6@ncsu.edu)

=='''References'''==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1966. Tabbed reviews partial file refactor for displaying the alternate view of reviews

2019-10-29T22:53:42Z

Hwang85:

== '''About Expertiza''' ==

Expertiza is a open source project currently for CSC517 instructor and students forming groups, submit work, review, and view grades. The project is based on Ruby on Rails framework and the code is on Github: https://github.com/expertiza/expertiza. Expertiza serves wiki page, collecting information of all internal information and updates of all versions.

== '''Problem Statement''' ==
===Issue details===

1) On student end, Expertiza uses grades/_reviews.html.erb partial file to display reviewers, scores and review details; on instructor end, it uses Response model methods to construct html file for review pages. We need to use the same kinds of partials in instructor-end and student-end.

How to get the view of reviewers, scores and review details on student end? Click "Alternate View" button, and click "show reviews" link. The reviewers and scores pop up on the top and review details are below them.
How to get the view of reviewers, scores and review details on instructor end? Click "Scores" for a certain assignment and choose a team. Click "Statistics" tab and then reviewers and scores table show up. Click "Reviews" tab and then click one of students' name link in the table head. And a new page pops up with review details.

2) Give Feedback link at view_my_score at student-end should not appear at folded view.
Where to find Give Feedback link? On student end, click "Alternate View" button and click "show reviews" link. At the bottom of a certain review, a give feedback link shows up.

===What to do===
1) We need to use the same kinds of partials in instructor-end and student-end. So we decide to use grades/_team_statistics.html.erb to display reviewers and scores and to use grades/_tabbed_reviews.html.erb to display review details for both student-end and instructor-end.

2) Give Feedback link at view_my_score should appear at the bottom of expanded view.

== '''Solution''' ==
For student end, split reviews.html.erb into two partial files. One is grades/team_review_statistics.html.erb for reviewers and scores. The other one is grades/tabbed_reviews.html.erb for review details.
For instructor end, it used to use response model methods to construct html files for review details, now we use grades/tabbed_reviews.html.erb to display review details.
So student end and instructor end both use grades/team_review_statistics and grades/tabbed_reviews to display reviewers, scores and review details.
===Deploy Link===
[http://152.46.17.70:8080 Our project is deployed at VCL ]
===Student End===

* In student end, render grades/team_review_statistics and grades/tabbed_reviews two partial files instead of grades/reviews partial file.
'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/team_review_statistics', :locals => {:prefix => 'user', :participant => participant, :pscore => pscore} %>
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %>
</TD>
</TR>
</pre>
* Add statistics view to student end by using the team_review_statistics.html.erb file.
'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/team_review_statistics', :locals => {:prefix => 'user', :participant => participant, :pscore => pscore} %>
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %>
</TD>
</TR>
</pre>

'''app/views/grades/_team_review_statistics.html.erb'''
<pre>
<% if controller.action_name != "view_my_scores"%>
<tr>
<td colspan="10">
<% end %>

<% if controller.action_name != "view_my_scores"%>
</td>
</tr>
<% end %>
</pre>
[[File:student-table.png ]]

[[File:Student-detail.png]]

* Add feed back link in student end view.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<% if controller.action_name == "view_my_scores"%>

<% map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: participant.id).first
review_feedbacks = map.try :response %>
<% if review_feedbacks && !review_feedbacks.empty? %>
<%= link_to "View", :controller => 'response', :action => 'view', :id => review_feedbacks.first.id %> or
<%= link_to "Edit", :controller => 'response', :action => 'edit', :id => review_feedbacks.first.id, :return => "feedback" %> feedback for Review <%= count %>
<% else %>
<%= link_to "Give feedback", :controller => 'response', :action => 'new_feedback', :id => review.id %> for Review <%= count %>
<% end %>
</td></tr>
<% end %>
</pre>
[[File:Student-feedback.png]]

* Add javascript to tabbed review so it can be hidden or shown by clicking the show/hide reviews.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<script type="text/javascript">
toggle_tag_prompt = function() {
$('.tag_prompt_container').toggle();
};
$( document ).ready(function() {
$('#tag_prompt_toggler').click(function () {
if ($('#tag_prompt_toggler').text() == "hide tags")
$('#tag_prompt_toggler').text("show tags")
else
$('#tag_prompt_toggler').text("hide tags")
});
});
</script>
</pre>
===Instructor End===

* Create new method view2 for response_controller

''' app/controllers/response_controller.rb '''
<pre>
def view2
@response = Response.find(params[:id])
@map = @response.map
set_content2
render "response/view"
end
......
def set_content2(new_response = false)
@contributor = @map.contributor
members = TeamsUser.where(team_id: params[:team])
@user = members.first
@participant = AssignmentParticipant.where(user_id: @user.user_id, parent_id: params[:assignment]).first
@assignment = @participant.assignment
questionnaires = @assignment.questionnaires
@questions = retrieve_questions questionnaires, @assignment.id
# @pscore has the newest versions of response for each response map, and only one for each response map (unless it is vary rubric by round)
@pscore = @participant.scores(@questions)
@reviewer = @map.reviewer
@round = params[:round]
end
def retrieve_questions(questionnaires, assignment_id)
questions = {}
questionnaires.each do |questionnaire|
round = AssignmentQuestionnaire.where(assignment_id: assignment_id, questionnaire_id: questionnaire.id).first.used_in_round
questionnaire_symbol = if !round.nil?
(questionnaire.symbol.to_s + round.to_s).to_sym
else
questionnaire.symbol
end
questions[questionnaire_symbol] = questionnaire.questions
end
questions
end
</pre>

* change the url jumping to after clicking to a certain reviewer.
''' app/views/grades/_view_heatgrid.html.erb '''
<pre>
<th class="sorter-false"> <a target="_blank" href="../response/view2?id=<%= review.id.to_s %>&&team=<%= @team.id %>&&round=<%= vm.round.to_s %>&&assignment=<%= @assignment.id %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= user_name.to_s %></a> </th>
</pre>

* render grades/tabbed_reviews for review details at instructor end
''' app/views/response/view.html.erb '''
<pre>
<% if controller.action_name != "view2" %>
<% file_url = nil %>
<%= @response.display_as_html(nil, nil, file_url) %>
<br/>
<% else %>
<TR style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => @participant, :rscore => @pscore[:review], :reviewer => @reviewer, :round => @round} %>
</TD>
</TR>
<% end %>
</pre>

* show right round according to which round user click at instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% rounds.each do |round| %>
<% if controller.action_name == "view2"%>
<% next if round.to_s != @round.to_s %>
<% end %>
......
<% end %>
</pre>

* Create construct_instructor2_html in respond model in order to not show review number
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% prefix = "instructor" if controller.action_name == "view2" %>
</pre>

''' app/models/response.rb '''
<pre>
if prefix == "instructor"
self_id = self.id.to_s
code = construct_instructor2_html identifier, self_id, count
......
def construct_instructor2_html identifier, self_id, count
identifier += '<table width="100%">'\
'<tr>'\
'<td align="left" width="70%"><b>Review ' + '</b>   '\
'<a href="#" name= "review_' + self_id + 'Link" onClick="toggleElement(' + "'review_" + self_id + "','review'" + ');return false;">hide review</a>'\
'</td>'\
'<td align="left"><b>Last Reviewed:</b>'\
"<span>#{(self.updated_at.nil? ? 'Not available' : self.updated_at.strftime('%A %B %d %Y, %I:%M%p'))}</span></td>"\
'</tr></table>'
end
</pre>

* Show just one review in instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% rscore[:assessments].select{|response| response.round == round}.reverse.uniq{|response| response.map_id}.sort_by{|response| response.map_id}.each_with_index do |review, index| %>
<% if controller.action_name == "view2"%>
<% next if review.reviewer != @reviewer || count > 0 %>
<% end %>
......
<% end %>
</pre>
[[File:instructorend.png ]]

=='''Test files'''==

*tabbed_review_spec.rb created and added 3 test cases for alternate view of reviews
'''spec/features/tabbed_review_spec.rb'''
<pre>
require "spec_helper"
require 'rspec'
describe "alternate view of reviews" do
before(:each) do
assignment1 = create(:assignment, name: "111", directory_path: 'test_assignment')
create_list(:participant, 3)
create(:assignment_node)
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_due_date, deadline_type: DeadlineType.where(name: 'review').first, due_at: Time.now.in_time_zone + 1.day)
create(:topic)
create(:topic, topic_name: "TestReview")
create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
create(:assignment_questionnaire)
create(:question)
# create(:review_response_map, reviewer_id: User.where(role_id: 2).third.id)
# create(:review_response_map, reviewer_id: User.where(role_id: 2).second.id, reviewee: AssignmentTeam.second)
# sleep(10000)
end

def load_alternate
login_as('student2064')
expect(page).to have_content "User: student2064"
expect(page).to have_content "111"

click_link "111"
expect(page).to have_content "Submit or Review work for 111"
expect(page).to have_content "Alternate View"

click_link "Alternate View"
expect(page).to have_content "Contributor"
end

it "shows the correct alternate view" do
# Load questionnaire with generic setup
load_alternate
expect(page).to have_content "Contributor"
expect(page).to have_content "Stats"
expect(page).to have_content "Submitted work"
expect(page).to have_content "Author Feedback"
expect(page).to have_content "Teammate Review"
expect(page).to have_content "Final Score"
expect(page).to have_content "Range"
expect(page).to have_content "Average"
expect(page).to have_content "student2064"

expect(page).to have_css "a[href='#']", text: 'hide stats'
expect(page).to have_css "a[href='#']", text: 'show submission'
#expect(page).to have_css "a[href='#']", text: 'show reviews'
#page.should have_selector('table tr', text: 'show reviews')
#find(:xpath, "//tr[contains(.,'show reviews')]/td/a", :text => 'show reviews').click
#expect(page).to have_content "Writeup"
end
#describe "grades/participant", :type => :view do
#it 'exists' do
#find(:xpath, "//tr[contains(.,'show reviews')]/td/a", :text => 'show reviews').click
#end
#end
end

describe "test for instructor" do
before(:each) do
# assignment and topic
create(:assignment,
name: "Test Assignment",
directory_path: "Test Assignment",
rounds_of_reviews: 2,
staggered_deadline: true,
max_team_size: 1,
allow_selecting_additional_reviews_after_1st_round: true)
create_list(:participant, 3)
create(:topic, topic_name: "Topic_1")
create(:topic, topic_name: "Topic_2")
create(:topic, topic_name: "Topic_3")
assignment_id = Assignment.where(name: 'Test Assignment')[0].id

#visit "/response/view2?id=#{review_id}&&team=#{team_id}&&round=1&&assignment=#{assignment_id}"
# rubric
create(:questionnaire, name: "TestQuestionnaire1")
create(:questionnaire, name: "TestQuestionnaire2")
create(:question, txt: "Question1", questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire1').first, type: "Criterion")
create(:question, txt: "Question2", questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire2').first, type: "Criterion")
create(:assignment_questionnaire, questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire1').first, used_in_round: 1)
create(:assignment_questionnaire, questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire2').first, used_in_round: 2)
questionnaire_id = ReviewQuestionnaire.first.id.to_s

# deadline type
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
visit "response/view2?id=#{questionnaire_id}&&team=1&&round=1&&assignment=#{assignment_id}"
end

it "can go to review details" do
expect(page).to have_content "Toggle navigation"
expect(page).to have_content "Papers on Expertiza"
expect(page).to have_content "response"
end

end
</pre>

=='''Team Information'''==
#[https://github.com/aranne/expertiza Forked Issue on Github]
#Weiran Fu (wfu4@ncsu.edu)
#Qingyan Wang (qwang20@ncsu.edu)
#Hongli Wang (hwang85@ncsu.edu)
#'''Mentor:''' Mohit Jain (mjain6@ncsu.edu)

=='''References'''==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1966. Tabbed reviews partial file refactor for displaying the alternate view of reviews

2019-10-29T22:53:20Z

Hwang85:

== '''About Expertiza''' ==

Expertiza is a open source project currently for CSC517 instructor and students forming groups, submit work, review, and view grades. The project is based on Ruby on Rails framework and the code is on Github: https://github.com/expertiza/expertiza. Expertiza serves wiki page, collecting information of all internal information and updates of all versions.

== '''Problem Statement''' ==
===Issue details===

1) On student end, Expertiza uses grades/_reviews.html.erb partial file to display reviewers, scores and review details; on instructor end, it uses Response model methods to construct html file for review pages. We need to use the same kinds of partials in instructor-end and student-end.

How to get the view of reviewers, scores and review details on student end? Click "Alternate View" button, and click "show reviews" link. The reviewers and scores pop up on the top and review details are below them.
How to get the view of reviewers, scores and review details on instructor end? Click "Scores" for a certain assignment and choose a team. Click "Statistics" tab and then reviewers and scores table show up. Click "Reviews" tab and then click one of students' name link in the table head. And a new page pops up with review details.

2) Give Feedback link at view_my_score at student-end should not appear at folded view.
Where to find Give Feedback link? On student end, click "Alternate View" button and click "show reviews" link. At the bottom of a certain review, a give feedback link shows up.

===What to do===
1) We need to use the same kinds of partials in instructor-end and student-end. So we decide to use grades/_team_statistics.html.erb to display reviewers and scores and to use grades/_tabbed_reviews.html.erb to display review details for both student-end and instructor-end.

2) Give Feedback link at view_my_score should appear at the bottom of expanded view.

== '''Solution''' ==
For student end, split reviews.html.erb into two partial files. One is grades/team_review_statistics.html.erb for reviewers and scores. The other one is grades/tabbed_reviews.html.erb for review details.
For instructor end, it used to use response model methods to construct html files for review details, now we use grades/tabbed_reviews.html.erb to display review details.
So student end and instructor end both use grades/team_review_statistics and grades/tabbed_reviews to display reviewers, scores and review details.
===Deploy Link===
[http://152.46.17.70 Our project is deployed at VCL ]
===Student End===

* In student end, render grades/team_review_statistics and grades/tabbed_reviews two partial files instead of grades/reviews partial file.
'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/team_review_statistics', :locals => {:prefix => 'user', :participant => participant, :pscore => pscore} %>
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %>
</TD>
</TR>
</pre>
* Add statistics view to student end by using the team_review_statistics.html.erb file.
'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/team_review_statistics', :locals => {:prefix => 'user', :participant => participant, :pscore => pscore} %>
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %>
</TD>
</TR>
</pre>

'''app/views/grades/_team_review_statistics.html.erb'''
<pre>
<% if controller.action_name != "view_my_scores"%>
<tr>
<td colspan="10">
<% end %>

<% if controller.action_name != "view_my_scores"%>
</td>
</tr>
<% end %>
</pre>
[[File:student-table.png ]]

[[File:Student-detail.png]]

* Add feed back link in student end view.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<% if controller.action_name == "view_my_scores"%>

<% map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: participant.id).first
review_feedbacks = map.try :response %>
<% if review_feedbacks && !review_feedbacks.empty? %>
<%= link_to "View", :controller => 'response', :action => 'view', :id => review_feedbacks.first.id %> or
<%= link_to "Edit", :controller => 'response', :action => 'edit', :id => review_feedbacks.first.id, :return => "feedback" %> feedback for Review <%= count %>
<% else %>
<%= link_to "Give feedback", :controller => 'response', :action => 'new_feedback', :id => review.id %> for Review <%= count %>
<% end %>
</td></tr>
<% end %>
</pre>
[[File:Student-feedback.png]]

* Add javascript to tabbed review so it can be hidden or shown by clicking the show/hide reviews.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<script type="text/javascript">
toggle_tag_prompt = function() {
$('.tag_prompt_container').toggle();
};
$( document ).ready(function() {
$('#tag_prompt_toggler').click(function () {
if ($('#tag_prompt_toggler').text() == "hide tags")
$('#tag_prompt_toggler').text("show tags")
else
$('#tag_prompt_toggler').text("hide tags")
});
});
</script>
</pre>
===Instructor End===

* Create new method view2 for response_controller

''' app/controllers/response_controller.rb '''
<pre>
def view2
@response = Response.find(params[:id])
@map = @response.map
set_content2
render "response/view"
end
......
def set_content2(new_response = false)
@contributor = @map.contributor
members = TeamsUser.where(team_id: params[:team])
@user = members.first
@participant = AssignmentParticipant.where(user_id: @user.user_id, parent_id: params[:assignment]).first
@assignment = @participant.assignment
questionnaires = @assignment.questionnaires
@questions = retrieve_questions questionnaires, @assignment.id
# @pscore has the newest versions of response for each response map, and only one for each response map (unless it is vary rubric by round)
@pscore = @participant.scores(@questions)
@reviewer = @map.reviewer
@round = params[:round]
end
def retrieve_questions(questionnaires, assignment_id)
questions = {}
questionnaires.each do |questionnaire|
round = AssignmentQuestionnaire.where(assignment_id: assignment_id, questionnaire_id: questionnaire.id).first.used_in_round
questionnaire_symbol = if !round.nil?
(questionnaire.symbol.to_s + round.to_s).to_sym
else
questionnaire.symbol
end
questions[questionnaire_symbol] = questionnaire.questions
end
questions
end
</pre>

* change the url jumping to after clicking to a certain reviewer.
''' app/views/grades/_view_heatgrid.html.erb '''
<pre>
<th class="sorter-false"> <a target="_blank" href="../response/view2?id=<%= review.id.to_s %>&&team=<%= @team.id %>&&round=<%= vm.round.to_s %>&&assignment=<%= @assignment.id %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= user_name.to_s %></a> </th>
</pre>

* render grades/tabbed_reviews for review details at instructor end
''' app/views/response/view.html.erb '''
<pre>
<% if controller.action_name != "view2" %>
<% file_url = nil %>
<%= @response.display_as_html(nil, nil, file_url) %>
<br/>
<% else %>
<TR style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => @participant, :rscore => @pscore[:review], :reviewer => @reviewer, :round => @round} %>
</TD>
</TR>
<% end %>
</pre>

* show right round according to which round user click at instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% rounds.each do |round| %>
<% if controller.action_name == "view2"%>
<% next if round.to_s != @round.to_s %>
<% end %>
......
<% end %>
</pre>

* Create construct_instructor2_html in respond model in order to not show review number
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% prefix = "instructor" if controller.action_name == "view2" %>
</pre>

''' app/models/response.rb '''
<pre>
if prefix == "instructor"
self_id = self.id.to_s
code = construct_instructor2_html identifier, self_id, count
......
def construct_instructor2_html identifier, self_id, count
identifier += '<table width="100%">'\
'<tr>'\
'<td align="left" width="70%"><b>Review ' + '</b>   '\
'<a href="#" name= "review_' + self_id + 'Link" onClick="toggleElement(' + "'review_" + self_id + "','review'" + ');return false;">hide review</a>'\
'</td>'\
'<td align="left"><b>Last Reviewed:</b>'\
"<span>#{(self.updated_at.nil? ? 'Not available' : self.updated_at.strftime('%A %B %d %Y, %I:%M%p'))}</span></td>"\
'</tr></table>'
end
</pre>

* Show just one review in instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% rscore[:assessments].select{|response| response.round == round}.reverse.uniq{|response| response.map_id}.sort_by{|response| response.map_id}.each_with_index do |review, index| %>
<% if controller.action_name == "view2"%>
<% next if review.reviewer != @reviewer || count > 0 %>
<% end %>
......
<% end %>
</pre>
[[File:instructorend.png ]]

=='''Test files'''==

*tabbed_review_spec.rb created and added 3 test cases for alternate view of reviews
'''spec/features/tabbed_review_spec.rb'''
<pre>
require "spec_helper"
require 'rspec'
describe "alternate view of reviews" do
before(:each) do
assignment1 = create(:assignment, name: "111", directory_path: 'test_assignment')
create_list(:participant, 3)
create(:assignment_node)
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_due_date, deadline_type: DeadlineType.where(name: 'review').first, due_at: Time.now.in_time_zone + 1.day)
create(:topic)
create(:topic, topic_name: "TestReview")
create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
create(:assignment_questionnaire)
create(:question)
# create(:review_response_map, reviewer_id: User.where(role_id: 2).third.id)
# create(:review_response_map, reviewer_id: User.where(role_id: 2).second.id, reviewee: AssignmentTeam.second)
# sleep(10000)
end

def load_alternate
login_as('student2064')
expect(page).to have_content "User: student2064"
expect(page).to have_content "111"

click_link "111"
expect(page).to have_content "Submit or Review work for 111"
expect(page).to have_content "Alternate View"

click_link "Alternate View"
expect(page).to have_content "Contributor"
end

it "shows the correct alternate view" do
# Load questionnaire with generic setup
load_alternate
expect(page).to have_content "Contributor"
expect(page).to have_content "Stats"
expect(page).to have_content "Submitted work"
expect(page).to have_content "Author Feedback"
expect(page).to have_content "Teammate Review"
expect(page).to have_content "Final Score"
expect(page).to have_content "Range"
expect(page).to have_content "Average"
expect(page).to have_content "student2064"

expect(page).to have_css "a[href='#']", text: 'hide stats'
expect(page).to have_css "a[href='#']", text: 'show submission'
#expect(page).to have_css "a[href='#']", text: 'show reviews'
#page.should have_selector('table tr', text: 'show reviews')
#find(:xpath, "//tr[contains(.,'show reviews')]/td/a", :text => 'show reviews').click
#expect(page).to have_content "Writeup"
end
#describe "grades/participant", :type => :view do
#it 'exists' do
#find(:xpath, "//tr[contains(.,'show reviews')]/td/a", :text => 'show reviews').click
#end
#end
end

describe "test for instructor" do
before(:each) do
# assignment and topic
create(:assignment,
name: "Test Assignment",
directory_path: "Test Assignment",
rounds_of_reviews: 2,
staggered_deadline: true,
max_team_size: 1,
allow_selecting_additional_reviews_after_1st_round: true)
create_list(:participant, 3)
create(:topic, topic_name: "Topic_1")
create(:topic, topic_name: "Topic_2")
create(:topic, topic_name: "Topic_3")
assignment_id = Assignment.where(name: 'Test Assignment')[0].id

#visit "/response/view2?id=#{review_id}&&team=#{team_id}&&round=1&&assignment=#{assignment_id}"
# rubric
create(:questionnaire, name: "TestQuestionnaire1")
create(:questionnaire, name: "TestQuestionnaire2")
create(:question, txt: "Question1", questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire1').first, type: "Criterion")
create(:question, txt: "Question2", questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire2').first, type: "Criterion")
create(:assignment_questionnaire, questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire1').first, used_in_round: 1)
create(:assignment_questionnaire, questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire2').first, used_in_round: 2)
questionnaire_id = ReviewQuestionnaire.first.id.to_s

# deadline type
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
visit "response/view2?id=#{questionnaire_id}&&team=1&&round=1&&assignment=#{assignment_id}"
end

it "can go to review details" do
expect(page).to have_content "Toggle navigation"
expect(page).to have_content "Papers on Expertiza"
expect(page).to have_content "response"
end

end
</pre>

=='''Team Information'''==
#[https://github.com/aranne/expertiza Forked Issue on Github]
#Weiran Fu (wfu4@ncsu.edu)
#Qingyan Wang (qwang20@ncsu.edu)
#Hongli Wang (hwang85@ncsu.edu)
#'''Mentor:''' Mohit Jain (mjain6@ncsu.edu)

=='''References'''==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1966. Tabbed reviews partial file refactor for displaying the alternate view of reviews

2019-10-29T03:21:56Z

Hwang85:

== '''About Expertiza''' ==

Expertiza is a open source project currently for CSC517 instructor and students forming groups, submit work, review, and view grades. The project is based on Ruby on Rails framework and the code is on Github: https://github.com/expertiza/expertiza. Expertiza serves wiki page, collecting information of all internal information and updates of all versions.

== '''Problem Statement''' ==
===Issue details===

1) On student end, Expertiza uses grades/_reviews.html.erb partial file to display reviewers, scores and review details; on instructor end, it uses Response model methods to construct html file for review pages. We need to use the same kinds of partials in instructor-end and student-end.

How to get the view of reviewers, scores and review details on student end? Click "Alternate View" button, and click "show reviews" link. The reviewers and scores pop up on the top and review details are below them.
How to get the view of reviewers, scores and review details on instructor end? Click "Scores" for a certain assignment and choose a team. Click "Statistics" tab and then reviewers and scores table show up. Click "Reviews" tab and then click one of students' name link in the table head. And a new page pops up with review details.

2) Give Feedback link at view_my_score at student-end should not appear at folded view.
Where to find Give Feedback link? On student end, click "Alternate View" button and click "show reviews" link. At the bottom of a certain review, a give feedback link shows up.

===What to do===
1) We need to use the same kinds of partials in instructor-end and student-end. So we decide to use grades/_team_statistics.html.erb to display reviewers and scores and to use grades/_tabbed_reviews.html.erb to display review details for both student-end and instructor-end.

2) Give Feedback link at view_my_score should appear at the bottom of expanded view.

== '''Solution''' ==
For student end, split reviews.html.erb into two partial files. One is grades/team_review_statistics.html.erb for reviewers and scores. The other one is grades/tabbed_reviews.html.erb for review details.
For instructor end, it used to use response model methods to construct html files for review details, now we use grades/tabbed_reviews.html.erb to display review details.
So student end and instructor end both use grades/team_review_statistics and grades/tabbed_reviews to display reviewers, scores and review details.
===Deploy Link===
[http://152.7.98.106:8080 Our project is deployed at VCL ]
===Student End===

* In student end, render grades/team_review_statistics and grades/tabbed_reviews two partial files instead of grades/reviews partial file.
'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/team_review_statistics', :locals => {:prefix => 'user', :participant => participant, :pscore => pscore} %>
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %>
</TD>
</TR>
</pre>
* Add statistics view to student end by using the team_review_statistics.html.erb file.
'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/team_review_statistics', :locals => {:prefix => 'user', :participant => participant, :pscore => pscore} %>
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %>
</TD>
</TR>
</pre>

'''app/views/grades/_team_review_statistics.html.erb'''
<pre>
<% if controller.action_name != "view_my_scores"%>
<tr>
<td colspan="10">
<% end %>

<% if controller.action_name != "view_my_scores"%>
</td>
</tr>
<% end %>
</pre>
[[File:student-table.png ]]

[[File:Student-detail.png]]

* Add feed back link in student end view.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<% if controller.action_name == "view_my_scores"%>

<% map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: participant.id).first
review_feedbacks = map.try :response %>
<% if review_feedbacks && !review_feedbacks.empty? %>
<%= link_to "View", :controller => 'response', :action => 'view', :id => review_feedbacks.first.id %> or
<%= link_to "Edit", :controller => 'response', :action => 'edit', :id => review_feedbacks.first.id, :return => "feedback" %> feedback for Review <%= count %>
<% else %>
<%= link_to "Give feedback", :controller => 'response', :action => 'new_feedback', :id => review.id %> for Review <%= count %>
<% end %>
</td></tr>
<% end %>
</pre>
[[File:Student-feedback.png]]

* Add javascript to tabbed review so it can be hidden or shown by clicking the show/hide reviews.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<script type="text/javascript">
toggle_tag_prompt = function() {
$('.tag_prompt_container').toggle();
};
$( document ).ready(function() {
$('#tag_prompt_toggler').click(function () {
if ($('#tag_prompt_toggler').text() == "hide tags")
$('#tag_prompt_toggler').text("show tags")
else
$('#tag_prompt_toggler').text("hide tags")
});
});
</script>
</pre>
===Instructor End===

* Create new method view2 for response_controller

''' app/controllers/response_controller.rb '''
<pre>
def view2
@response = Response.find(params[:id])
@map = @response.map
set_content2
render "response/view"
end
......
def set_content2(new_response = false)
@contributor = @map.contributor
members = TeamsUser.where(team_id: params[:team])
@user = members.first
@participant = AssignmentParticipant.where(user_id: @user.user_id, parent_id: params[:assignment]).first
@assignment = @participant.assignment
questionnaires = @assignment.questionnaires
@questions = retrieve_questions questionnaires, @assignment.id
# @pscore has the newest versions of response for each response map, and only one for each response map (unless it is vary rubric by round)
@pscore = @participant.scores(@questions)
@reviewer = @map.reviewer
@round = params[:round]
end
def retrieve_questions(questionnaires, assignment_id)
questions = {}
questionnaires.each do |questionnaire|
round = AssignmentQuestionnaire.where(assignment_id: assignment_id, questionnaire_id: questionnaire.id).first.used_in_round
questionnaire_symbol = if !round.nil?
(questionnaire.symbol.to_s + round.to_s).to_sym
else
questionnaire.symbol
end
questions[questionnaire_symbol] = questionnaire.questions
end
questions
end
</pre>

* change the url jumping to after clicking to a certain reviewer.
''' app/views/grades/_view_heatgrid.html.erb '''
<pre>
<th class="sorter-false"> <a target="_blank" href="../response/view2?id=<%= review.id.to_s %>&&team=<%= @team.id %>&&round=<%= vm.round.to_s %>&&assignment=<%= @assignment.id %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= user_name.to_s %></a> </th>
</pre>

* render grades/tabbed_reviews for review details at instructor end
''' app/views/response/view.html.erb '''
<pre>
<% if controller.action_name != "view2" %>
<% file_url = nil %>
<%= @response.display_as_html(nil, nil, file_url) %>
<br/>
<% else %>
<TR style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => @participant, :rscore => @pscore[:review], :reviewer => @reviewer, :round => @round} %>
</TD>
</TR>
<% end %>
</pre>

* show right round according to which round user click at instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% rounds.each do |round| %>
<% if controller.action_name == "view2"%>
<% next if round.to_s != @round.to_s %>
<% end %>
......
<% end %>
</pre>

* Create construct_instructor2_html in respond model in order to not show review number
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% prefix = "instructor" if controller.action_name == "view2" %>
</pre>

''' app/models/response.rb '''
<pre>
if prefix == "instructor"
self_id = self.id.to_s
code = construct_instructor2_html identifier, self_id, count
......
def construct_instructor2_html identifier, self_id, count
identifier += '<table width="100%">'\
'<tr>'\
'<td align="left" width="70%"><b>Review ' + '</b>   '\
'<a href="#" name= "review_' + self_id + 'Link" onClick="toggleElement(' + "'review_" + self_id + "','review'" + ');return false;">hide review</a>'\
'</td>'\
'<td align="left"><b>Last Reviewed:</b>'\
"<span>#{(self.updated_at.nil? ? 'Not available' : self.updated_at.strftime('%A %B %d %Y, %I:%M%p'))}</span></td>"\
'</tr></table>'
end
</pre>

* Show just one review in instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% rscore[:assessments].select{|response| response.round == round}.reverse.uniq{|response| response.map_id}.sort_by{|response| response.map_id}.each_with_index do |review, index| %>
<% if controller.action_name == "view2"%>
<% next if review.reviewer != @reviewer || count > 0 %>
<% end %>
......
<% end %>
</pre>
[[File:instructorend.png ]]

=='''Test files'''==

*tabbed_review_spec.rb created and added 3 test cases for alternate view of reviews
'''spec/features/tabbed_review_spec.rb'''
<pre>
require "spec_helper"
require 'rspec'
describe "alternate view of reviews" do
before(:each) do
assignment1 = create(:assignment, name: "111", directory_path: 'test_assignment')
create_list(:participant, 3)
create(:assignment_node)
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_due_date, deadline_type: DeadlineType.where(name: 'review').first, due_at: Time.now.in_time_zone + 1.day)
create(:topic)
create(:topic, topic_name: "TestReview")
create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
create(:assignment_questionnaire)
create(:question)
# create(:review_response_map, reviewer_id: User.where(role_id: 2).third.id)
# create(:review_response_map, reviewer_id: User.where(role_id: 2).second.id, reviewee: AssignmentTeam.second)
# sleep(10000)
end

def load_alternate
login_as('student2064')
expect(page).to have_content "User: student2064"
expect(page).to have_content "111"

click_link "111"
expect(page).to have_content "Submit or Review work for 111"
expect(page).to have_content "Alternate View"

click_link "Alternate View"
expect(page).to have_content "Contributor"
end

it "shows the correct alternate view" do
# Load questionnaire with generic setup
load_alternate
expect(page).to have_content "Contributor"
expect(page).to have_content "Stats"
expect(page).to have_content "Submitted work"
expect(page).to have_content "Author Feedback"
expect(page).to have_content "Teammate Review"
expect(page).to have_content "Final Score"
expect(page).to have_content "Range"
expect(page).to have_content "Average"
expect(page).to have_content "student2064"

expect(page).to have_css "a[href='#']", text: 'hide stats'
expect(page).to have_css "a[href='#']", text: 'show submission'
#expect(page).to have_css "a[href='#']", text: 'show reviews'
#page.should have_selector('table tr', text: 'show reviews')
#find(:xpath, "//tr[contains(.,'show reviews')]/td/a", :text => 'show reviews').click
#expect(page).to have_content "Writeup"
end
#describe "grades/participant", :type => :view do
#it 'exists' do
#find(:xpath, "//tr[contains(.,'show reviews')]/td/a", :text => 'show reviews').click
#end
#end
end

describe "test for instructor" do
before(:each) do
# assignment and topic
create(:assignment,
name: "Test Assignment",
directory_path: "Test Assignment",
rounds_of_reviews: 2,
staggered_deadline: true,
max_team_size: 1,
allow_selecting_additional_reviews_after_1st_round: true)
create_list(:participant, 3)
create(:topic, topic_name: "Topic_1")
create(:topic, topic_name: "Topic_2")
create(:topic, topic_name: "Topic_3")
assignment_id = Assignment.where(name: 'Test Assignment')[0].id

#visit "/response/view2?id=#{review_id}&&team=#{team_id}&&round=1&&assignment=#{assignment_id}"
# rubric
create(:questionnaire, name: "TestQuestionnaire1")
create(:questionnaire, name: "TestQuestionnaire2")
create(:question, txt: "Question1", questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire1').first, type: "Criterion")
create(:question, txt: "Question2", questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire2').first, type: "Criterion")
create(:assignment_questionnaire, questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire1').first, used_in_round: 1)
create(:assignment_questionnaire, questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire2').first, used_in_round: 2)
questionnaire_id = ReviewQuestionnaire.first.id.to_s

# deadline type
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
visit "response/view2?id=#{questionnaire_id}&&team=1&&round=1&&assignment=#{assignment_id}"
end

it "can go to review details" do
expect(page).to have_content "Toggle navigation"
expect(page).to have_content "Papers on Expertiza"
expect(page).to have_content "response"
end

end
</pre>

=='''Team Information'''==
#[https://github.com/aranne/expertiza Forked Issue on Github]
#Weiran Fu (@ncsu.edu)
#Qingyan Wang (qwang20@ncsu.edu)
#Hongli Wang (hwang85@ncsu.edu)
#'''Mentor:''' Mohit Jain (mjain6@ncsu.edu)

=='''References'''==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1966. Tabbed reviews partial file refactor for displaying the alternate view of reviews

2019-10-29T03:20:48Z

Hwang85:

== '''About Expertiza''' ==

Expertiza is a open source project currently for CSC517 instructor and students forming groups, submit work, review, and view grades. The project is based on Ruby on Rails framework and the code is on Github: https://github.com/expertiza/expertiza. Expertiza serves wiki page, collecting information of all internal information and updates of all versions.

== '''Problem Statement''' ==
===Issue details===

1) On student end, Expertiza uses grades/_reviews.html.erb partial file to display reviewers, scores and review details; on instructor end, it uses Response model methods to construct html file for review pages. We need to use the same kinds of partials in instructor-end and student-end.

How to get the view of reviewers, scores and review details on student end? Click "Alternate View" button, and click "show reviews" link. The reviewers and scores pop up on the top and review details are below them.
How to get the view of reviewers, scores and review details on instructor end? Click "Scores" for a certain assignment and choose a team. Click "Statistics" tab and then reviewers and scores table show up. Click "Reviews" tab and then click one of students' name link in the table head. And a new page pops up with review details.

2) Give Feedback link at view_my_score at student-end should not appear at folded view.
Where to find Give Feedback link? On student end, click "Alternate View" button and click "show reviews" link. At the bottom of a certain review, a give feedback link shows up.

===What to do===
1) We need to use the same kinds of partials in instructor-end and student-end. So we decide to use grades/_team_statistics.html.erb to display reviewers and scores and to use grades/_tabbed_reviews.html.erb to display review details for both student-end and instructor-end.

2) Give Feedback link at view_my_score should appear at the bottom of expanded view.

== '''Solution''' ==
For student end, split reviews.html.erb into two partial files. One is grades/team_review_statistics.html.erb for reviewers and scores. The other one is grades/tabbed_reviews.html.erb for review details.
For instructor end, it used to use response model methods to construct html files for review details, now we use grades/tabbed_reviews.html.erb to display review details.
So student end and instructor end both use grades/team_review_statistics and grades/tabbed_reviews to display reviewers, scores and review details.
===Deploy Link===
[http://152.46.19.149:8080 Our project is deployed at VCL ]
===Student End===

* In student end, render grades/team_review_statistics and grades/tabbed_reviews two partial files instead of grades/reviews partial file.
'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/team_review_statistics', :locals => {:prefix => 'user', :participant => participant, :pscore => pscore} %>
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %>
</TD>
</TR>
</pre>
* Add statistics view to student end by using the team_review_statistics.html.erb file.
'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/team_review_statistics', :locals => {:prefix => 'user', :participant => participant, :pscore => pscore} %>
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %>
</TD>
</TR>
</pre>

'''app/views/grades/_team_review_statistics.html.erb'''
<pre>
<% if controller.action_name != "view_my_scores"%>
<tr>
<td colspan="10">
<% end %>

<% if controller.action_name != "view_my_scores"%>
</td>
</tr>
<% end %>
</pre>
[[File:student-table.png ]]

[[File:Student-detail.png]]

* Add feed back link in student end view.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<% if controller.action_name == "view_my_scores"%>

<% map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: participant.id).first
review_feedbacks = map.try :response %>
<% if review_feedbacks && !review_feedbacks.empty? %>
<%= link_to "View", :controller => 'response', :action => 'view', :id => review_feedbacks.first.id %> or
<%= link_to "Edit", :controller => 'response', :action => 'edit', :id => review_feedbacks.first.id, :return => "feedback" %> feedback for Review <%= count %>
<% else %>
<%= link_to "Give feedback", :controller => 'response', :action => 'new_feedback', :id => review.id %> for Review <%= count %>
<% end %>
</td></tr>
<% end %>
</pre>
[[File:Student-feedback.png]]

* Add javascript to tabbed review so it can be hidden or shown by clicking the show/hide reviews.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<script type="text/javascript">
toggle_tag_prompt = function() {
$('.tag_prompt_container').toggle();
};
$( document ).ready(function() {
$('#tag_prompt_toggler').click(function () {
if ($('#tag_prompt_toggler').text() == "hide tags")
$('#tag_prompt_toggler').text("show tags")
else
$('#tag_prompt_toggler').text("hide tags")
});
});
</script>
</pre>
===Instructor End===

* Create new method view2 for response_controller

''' app/controllers/response_controller.rb '''
<pre>
def view2
@response = Response.find(params[:id])
@map = @response.map
set_content2
render "response/view"
end
......
def set_content2(new_response = false)
@contributor = @map.contributor
members = TeamsUser.where(team_id: params[:team])
@user = members.first
@participant = AssignmentParticipant.where(user_id: @user.user_id, parent_id: params[:assignment]).first
@assignment = @participant.assignment
questionnaires = @assignment.questionnaires
@questions = retrieve_questions questionnaires, @assignment.id
# @pscore has the newest versions of response for each response map, and only one for each response map (unless it is vary rubric by round)
@pscore = @participant.scores(@questions)
@reviewer = @map.reviewer
@round = params[:round]
end
def retrieve_questions(questionnaires, assignment_id)
questions = {}
questionnaires.each do |questionnaire|
round = AssignmentQuestionnaire.where(assignment_id: assignment_id, questionnaire_id: questionnaire.id).first.used_in_round
questionnaire_symbol = if !round.nil?
(questionnaire.symbol.to_s + round.to_s).to_sym
else
questionnaire.symbol
end
questions[questionnaire_symbol] = questionnaire.questions
end
questions
end
</pre>

* change the url jumping to after clicking to a certain reviewer.
''' app/views/grades/_view_heatgrid.html.erb '''
<pre>
<th class="sorter-false"> <a target="_blank" href="../response/view2?id=<%= review.id.to_s %>&&team=<%= @team.id %>&&round=<%= vm.round.to_s %>&&assignment=<%= @assignment.id %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= user_name.to_s %></a> </th>
</pre>

* render grades/tabbed_reviews for review details at instructor end
''' app/views/response/view.html.erb '''
<pre>
<% if controller.action_name != "view2" %>
<% file_url = nil %>
<%= @response.display_as_html(nil, nil, file_url) %>
<br/>
<% else %>
<TR style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => @participant, :rscore => @pscore[:review], :reviewer => @reviewer, :round => @round} %>
</TD>
</TR>
<% end %>
</pre>

* show right round according to which round user click at instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% rounds.each do |round| %>
<% if controller.action_name == "view2"%>
<% next if round.to_s != @round.to_s %>
<% end %>
......
<% end %>
</pre>

* Create construct_instructor2_html in respond model in order to not show review number
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% prefix = "instructor" if controller.action_name == "view2" %>
</pre>

''' app/models/response.rb '''
<pre>
if prefix == "instructor"
self_id = self.id.to_s
code = construct_instructor2_html identifier, self_id, count
......
def construct_instructor2_html identifier, self_id, count
identifier += '<table width="100%">'\
'<tr>'\
'<td align="left" width="70%"><b>Review ' + '</b>   '\
'<a href="#" name= "review_' + self_id + 'Link" onClick="toggleElement(' + "'review_" + self_id + "','review'" + ');return false;">hide review</a>'\
'</td>'\
'<td align="left"><b>Last Reviewed:</b>'\
"<span>#{(self.updated_at.nil? ? 'Not available' : self.updated_at.strftime('%A %B %d %Y, %I:%M%p'))}</span></td>"\
'</tr></table>'
end
</pre>

* Show just one review in instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% rscore[:assessments].select{|response| response.round == round}.reverse.uniq{|response| response.map_id}.sort_by{|response| response.map_id}.each_with_index do |review, index| %>
<% if controller.action_name == "view2"%>
<% next if review.reviewer != @reviewer || count > 0 %>
<% end %>
......
<% end %>
</pre>
[[File:instructorend.png ]]

=='''Test files'''==

*tabbed_review_spec.rb created and added 3 test cases for alternate view of reviews
'''spec/features/tabbed_review_spec.rb'''
<pre>
require "spec_helper"
require 'rspec'
describe "alternate view of reviews" do
before(:each) do
assignment1 = create(:assignment, name: "111", directory_path: 'test_assignment')
create_list(:participant, 3)
create(:assignment_node)
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_due_date, deadline_type: DeadlineType.where(name: 'review').first, due_at: Time.now.in_time_zone + 1.day)
create(:topic)
create(:topic, topic_name: "TestReview")
create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
create(:assignment_questionnaire)
create(:question)
# create(:review_response_map, reviewer_id: User.where(role_id: 2).third.id)
# create(:review_response_map, reviewer_id: User.where(role_id: 2).second.id, reviewee: AssignmentTeam.second)
# sleep(10000)
end

def load_alternate
login_as('student2064')
expect(page).to have_content "User: student2064"
expect(page).to have_content "111"

click_link "111"
expect(page).to have_content "Submit or Review work for 111"
expect(page).to have_content "Alternate View"

click_link "Alternate View"
expect(page).to have_content "Contributor"
end

it "shows the correct alternate view" do
# Load questionnaire with generic setup
load_alternate
expect(page).to have_content "Contributor"
expect(page).to have_content "Stats"
expect(page).to have_content "Submitted work"
expect(page).to have_content "Author Feedback"
expect(page).to have_content "Teammate Review"
expect(page).to have_content "Final Score"
expect(page).to have_content "Range"
expect(page).to have_content "Average"
expect(page).to have_content "student2064"

expect(page).to have_css "a[href='#']", text: 'hide stats'
expect(page).to have_css "a[href='#']", text: 'show submission'
#expect(page).to have_css "a[href='#']", text: 'show reviews'
#page.should have_selector('table tr', text: 'show reviews')
#find(:xpath, "//tr[contains(.,'show reviews')]/td/a", :text => 'show reviews').click
#expect(page).to have_content "Writeup"
end
#describe "grades/participant", :type => :view do
#it 'exists' do
#find(:xpath, "//tr[contains(.,'show reviews')]/td/a", :text => 'show reviews').click
#end
#end
end

describe "test for instructor" do
before(:each) do
# assignment and topic
create(:assignment,
name: "Test Assignment",
directory_path: "Test Assignment",
rounds_of_reviews: 2,
staggered_deadline: true,
max_team_size: 1,
allow_selecting_additional_reviews_after_1st_round: true)
create_list(:participant, 3)
create(:topic, topic_name: "Topic_1")
create(:topic, topic_name: "Topic_2")
create(:topic, topic_name: "Topic_3")
assignment_id = Assignment.where(name: 'Test Assignment')[0].id

#visit "/response/view2?id=#{review_id}&&team=#{team_id}&&round=1&&assignment=#{assignment_id}"
# rubric
create(:questionnaire, name: "TestQuestionnaire1")
create(:questionnaire, name: "TestQuestionnaire2")
create(:question, txt: "Question1", questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire1').first, type: "Criterion")
create(:question, txt: "Question2", questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire2').first, type: "Criterion")
create(:assignment_questionnaire, questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire1').first, used_in_round: 1)
create(:assignment_questionnaire, questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire2').first, used_in_round: 2)
questionnaire_id = ReviewQuestionnaire.first.id.to_s

# deadline type
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
visit "response/view2?id=#{questionnaire_id}&&team=1&&round=1&&assignment=#{assignment_id}"
end

it "can go to review details" do
expect(page).to have_content "Toggle navigation"
expect(page).to have_content "Papers on Expertiza"
expect(page).to have_content "response"
end

end
</pre>

=='''Team Information'''==
#[https://github.com/aranne/expertiza Forked Issue on Github]
#Weiran Fu (@ncsu.edu)
#Qingyan Wang (qwang20@ncsu.edu)
#Hongli Wang (hwang85@ncsu.edu)
#'''Mentor:''' Mohit Jain (mjain6@ncsu.edu)

=='''References'''==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]

File:Student-feedback.png

2019-10-29T03:11:56Z

Hwang85:

File:Student-detail.png

2019-10-29T03:09:36Z

Hwang85:

File:Student-table.png

2019-10-29T03:07:31Z

Hwang85:

File:Instructorend.png

2019-10-29T03:05:31Z

Hwang85:

File:Instructor-partial.png

2019-10-29T02:58:31Z

Hwang85:

File:Instructor-end.png

2019-10-29T02:41:31Z

Hwang85: instructor end screenshot

instructor end screenshot

CSC/ECE 517 Fall 2019 - E1966. Tabbed reviews partial file refactor for displaying the alternate view of reviews

2019-10-29T00:03:18Z

Hwang85:

== '''About Expertiza''' ==

Expertiza is a open source project currently for CSC517 instructor and students forming groups, submit work, review, and view grades. The project is based on Ruby on Rails framework and the code is on Github: https://github.com/expertiza/expertiza. Expertiza serves wiki page, collecting information of all internal information and updates of all versions.

== '''Problem Statement''' ==
===Issue details===

1) On student-end, Expertiza uses grades/_reviews.html.erb partial file to display reviewers, scores and review details; on instructor-end, it uses Response model methods to construct html file for review pages. We need to use the same kinds of partials in instructor-end and student-end.

2) Give Feedback link at view_my_score at student-end should not appear at folded view.

===What to do===
1) We need to use the same kinds of partials in instructor-end and student-end. So we decide to use grades/_team_statistics.html.erb to display reviewers and scores and to use grades/_tabbed_reviews.html.erb to display review details for both student-end and instructor-end.

2) Give Feedback link at view_my_score should appear at the bottom of expanded view.

== '''Solution''' ==
For student end, split reviews.html.erb into two partial files. One is grades/team_review_statistics.html.erb for reviewers and scores. The other one is grades/tabbed_reviews.html.erb for review details.
For instructor end, it used to use response model methods to construct html files for review details, now we use grades/tabbed_reviews.html.erb to display review details.
So student end and instructor end both use grades/team_review_statistics and grades/tabbed_reviews to display reviewers, scores and review details.
===Deploy Link===
[http://152.46.19.149:8080 Our project is deployed at VCL ]
===Student End===

* In student end, render grades/team_review_statistics and grades/tabbed_reviews two partial files instead of grades/reviews partial file.

'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/team_review_statistics', :locals => {:prefix => 'user', :participant => participant, :pscore => pscore} %>
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %>
</TD>
</TR>
</pre>
* Add feed back link in student end view.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<% if controller.action_name == "view_my_scores"%>

<% map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: participant.id).first
review_feedbacks = map.try :response %>
<% if review_feedbacks && !review_feedbacks.empty? %>
<%= link_to "View", :controller => 'response', :action => 'view', :id => review_feedbacks.first.id %> or
<%= link_to "Edit", :controller => 'response', :action => 'edit', :id => review_feedbacks.first.id, :return => "feedback" %> feedback for Review <%= count %>
<% else %>
<%= link_to "Give feedback", :controller => 'response', :action => 'new_feedback', :id => review.id %> for Review <%= count %>
<% end %>
</td></tr>
<% end %>
</pre>

* Add javascript to tabbed review so it can be hidden or shown by clicking the show/hide reviews.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<script type="text/javascript">
toggle_tag_prompt = function() {
$('.tag_prompt_container').toggle();
};
$( document ).ready(function() {
$('#tag_prompt_toggler').click(function () {
if ($('#tag_prompt_toggler').text() == "hide tags")
$('#tag_prompt_toggler').text("show tags")
else
$('#tag_prompt_toggler').text("hide tags")
});
});
</script>
</pre>

* Add statistics view to student end by using the team_review_statistics.html.erb file.
'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/team_review_statistics', :locals => {:prefix => 'user', :participant => participant, :pscore => pscore} %>
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %>
</TD>
</TR>
</pre>

'''app/views/grades/_team_review_statistics.html.erb'''
<pre>
<% if controller.action_name != "view_my_scores"%>
<tr>
<td colspan="10">
<% end %>

<% if controller.action_name != "view_my_scores"%>
</td>
</tr>
<% end %>
</pre>

===Instructor End===

* Create new method view2 for response_controller

''' app/controllers/response_controller.rb '''
<pre>
def view2
@response = Response.find(params[:id])
@map = @response.map
set_content2
render "response/view"
end
......
......
@participant = @map.reviewer
......
def set_content2(new_response = false)
@contributor = @map.contributor
members = TeamsUser.where(team_id: params[:team])
@user = members.first
@participant = AssignmentParticipant.where(user_id: @user.user_id, parent_id: params[:assignment]).first
@@ -264,7 +273,9 @@ def set_content(new_response = false)
@questions = retrieve_questions questionnaires, @assignment.id
# @pscore has the newest versions of response for each response map, and only one for each response map (unless it is vary rubric by round)
@pscore = @participant.scores(@questions)
@reviewer = @map.reviewer
@round = params[:round]
end
</pre>

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<% prefix = nil %>
......
<% if controller.action_name == "view_my_scores"%>

<% map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: participant.id).first
review_feedbacks = map.try :response %>
<% if review_feedbacks && !review_feedbacks.empty? %>
<%= link_to "View", :controller => 'response', :action => 'view', :id => review_feedbacks.first.id %> or
<%= link_to "Edit", :controller => 'response', :action => 'edit', :id => review_feedbacks.first.id, :return => "feedback" %> feedback for Review <%= count %>
<% else %>
<%= link_to "Give feedback", :controller => 'response', :action => 'new_feedback', :id => review.id %> for Review <%= count %>
<% end %>
</td></tr>
<% end %>
<% end %>
</table><hr>
<% end %>
</pre>

''' app/views/grades/_view_heatgrid.html.erb '''
<pre>
<th class="sorter-false"> <a target="_blank" href="../response/view2?id=<%= review.id.to_s %>&&team=<%= @team.id %>&&round=<%= vm.round.to_s %>&&assignment=<%= @assignment.id %>"
data-toggle="tooltip" data-placement="right" title="Click to see details"><%= user_name.to_s %></a> </th>

</pre>

''' app/views/response/view.html.erb '''
<pre>
<% if controller.action_name != "view2" %>
<% file_url = nil %>
<%= @response.display_as_html(nil, nil, file_url) %>
<br/>
<% else %>
<TR style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => @participant, :rscore => @pscore[:review], :reviewer => @reviewer, :round => @round} %>
</TD>
</TR>
<% end %>
</pre>

* show right round for instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% next if round.to_s != @round.to_s %>
</pre>

* Create construct_instructor2_html in order to not show review number
''' app/models/response.rb '''
<pre>
if prefix == "instructor"
self_id = self.id.to_s
code = construct_instructor2_html identifier, self_id, count
elsif prefix # has prefix means view_score page in instructor end
self_id = prefix + '_' + self.id.to_s
code = construct_instructor_html identifier, self_id, count
......
def construct_instructor2_html identifier, self_id, count
identifier += '<table width="100%">'\
'<tr>'\
'<td align="left" width="70%"><b>Review ' + '</b>   '\
'<a href="#" name= "review_' + self_id + 'Link" onClick="toggleElement(' + "'review_" + self_id + "','review'" + ');return false;">hide review</a>'\
'</td>'\
'<td align="left"><b>Last Reviewed:</b>'\
"<span>#{(self.updated_at.nil? ? 'Not available' : self.updated_at.strftime('%A %B %d %Y, %I:%M%p'))}</span></td>"\
'</tr></table>'
end
</pre>

'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% if controller.action_name != "view2"%>
<h3>Round <%= round %></h3>
<% if controller.action_name != "view_my_scores" %>
<a href="#" name= <%= participant.id.to_s + '_' + round.to_s + "Link" %> onClick="toggleElement('<%= participant.id.to_s + '_' + round.to_s %>','round <%= round.to_s%> reviews');return false;">show round <%= round.to_s%> reviews</a>
<% end %>
<% end %>
<% if @assignment.is_answer_tagging_allowed %>
<span class="spn_qsttog" id="tag_prompt_toggler" title="Click to display/hide tags" onclick="toggle_tag_prompt()">hide tags</span>
@@ -37,6 +39,7 @@
<% review_feedback = nil %>
<% count = count + 1 %>
<% prefix = nil %>
<% prefix = "instructor" if controller.action_name == "view2" %>
</pre>

* Show just one review in instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% rounds.each do |round| %>
<% if controller.action_name == "view2"%>
<% next if round.to_s != @round.to_s %>
<% end %>
<% if controller.action_name != "view2"%>
<h3>Round <%= round %></h3>
<% if controller.action_name != "view_my_scores" %>
@@ -33,8 +35,13 @@
<% if @assignment.is_answer_tagging_allowed %>
<span class="spn_qsttog" id="tag_prompt_toggler" title="Click to display/hide tags" onclick="toggle_tag_prompt()">hide tags</span>
<% end %>
<% if controller.action_name != "view2"%>
<table class="table table-striped" id=<%= participant.id.to_s + '_' + round.to_s %> <%= style="display: none;" if controller.action_name != "view_my_scores"%>>
<% end %>
<% rscore[:assessments].select{|response| response.round == round}.reverse.uniq{|response| response.map_id}.sort_by{|response| response.map_id}.each_with_index do |review, index| %>
<% if controller.action_name == "view2"%>
<% next if review.reviewer != @reviewer || count > 0 %>
<% end %>
<tr><td>
<% review_feedback = nil %>
<% count = count + 1 %>
@@ -72,7 +79,9 @@
</td></tr>
<% end %>
<% end %>
<% if controller.action_name != "view2"%>
</table><hr>
<% end %>
<% end %>
<% else %>
</pre>

=='''Test files'''==

*tabbed_review_spec.rb created and added 3 test cases for alternate view of reviews
'''spec/features/tabbed_review_spec.rb'''
<pre>
require "spec_helper"
require 'rspec'
describe "alternate view of reviews" do
before(:each) do
assignment1 = create(:assignment, name: "111", directory_path: 'test_assignment')
create_list(:participant, 3)
create(:assignment_node)
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_due_date, deadline_type: DeadlineType.where(name: 'review').first, due_at: Time.now.in_time_zone + 1.day)
create(:topic)
create(:topic, topic_name: "TestReview")
create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
create(:assignment_questionnaire)
create(:question)
# create(:review_response_map, reviewer_id: User.where(role_id: 2).third.id)
# create(:review_response_map, reviewer_id: User.where(role_id: 2).second.id, reviewee: AssignmentTeam.second)
# sleep(10000)
end

def load_alternate
login_as('student2064')
expect(page).to have_content "User: student2064"
expect(page).to have_content "111"

click_link "111"
expect(page).to have_content "Submit or Review work for 111"
expect(page).to have_content "Alternate View"

click_link "Alternate View"
expect(page).to have_content "Contributor"
end

it "shows the correct alternate view" do
# Load questionnaire with generic setup
load_alternate
expect(page).to have_content "Contributor"
expect(page).to have_content "Stats"
expect(page).to have_content "Submitted work"
expect(page).to have_content "Author Feedback"
expect(page).to have_content "Teammate Review"
expect(page).to have_content "Final Score"
expect(page).to have_content "Range"
expect(page).to have_content "Average"
expect(page).to have_content "student2064"

expect(page).to have_css "a[href='#']", text: 'hide stats'
expect(page).to have_css "a[href='#']", text: 'show submission'
#expect(page).to have_css "a[href='#']", text: 'show reviews'
#page.should have_selector('table tr', text: 'show reviews')
#find(:xpath, "//tr[contains(.,'show reviews')]/td/a", :text => 'show reviews').click
#expect(page).to have_content "Writeup"
end
#describe "grades/participant", :type => :view do
#it 'exists' do
#find(:xpath, "//tr[contains(.,'show reviews')]/td/a", :text => 'show reviews').click
#end
#end
end

describe "test for instructor" do
before(:each) do
# assignment and topic
create(:assignment,
name: "Test Assignment",
directory_path: "Test Assignment",
rounds_of_reviews: 2,
staggered_deadline: true,
max_team_size: 1,
allow_selecting_additional_reviews_after_1st_round: true)
create_list(:participant, 3)
create(:topic, topic_name: "Topic_1")
create(:topic, topic_name: "Topic_2")
create(:topic, topic_name: "Topic_3")
assignment_id = Assignment.where(name: 'Test Assignment')[0].id

#visit "/response/view2?id=#{review_id}&&team=#{team_id}&&round=1&&assignment=#{assignment_id}"
# rubric
create(:questionnaire, name: "TestQuestionnaire1")
create(:questionnaire, name: "TestQuestionnaire2")
create(:question, txt: "Question1", questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire1').first, type: "Criterion")
create(:question, txt: "Question2", questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire2').first, type: "Criterion")
create(:assignment_questionnaire, questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire1').first, used_in_round: 1)
create(:assignment_questionnaire, questionnaire: ReviewQuestionnaire.where(name: 'TestQuestionnaire2').first, used_in_round: 2)
questionnaire_id = ReviewQuestionnaire.first.id.to_s

# deadline type
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')

create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
visit "response/view2?id=#{questionnaire_id}&&team=1&&round=1&&assignment=#{assignment_id}"
end

it "can go to review details" do
expect(page).to have_content "Toggle navigation"
expect(page).to have_content "Papers on Expertiza"
expect(page).to have_content "response"
end

end
</pre>

=='''Team Information'''==
#[https://github.com/aranne/expertiza Forked Issue on Github]
#Weiran Fu (@ncsu.edu)
#Qingyan Wang (qwang20@ncsu.edu)
#Hongli Wang (hwang85@ncsu.edu)
#'''Mentor:''' Mohit Jain (mjain6@ncsu.edu)

=='''References'''==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1966. Tabbed reviews partial file refactor for displaying the alternate view of reviews

2019-10-28T23:13:17Z

Hwang85:

== '''About Expertiza''' ==

Expertiza is a open source project currently for CSC517 instructor and students forming groups, submit work, review, and view grades. The project is based on Ruby on Rails framework and the code is on Github: https://github.com/expertiza/expertiza. Expertiza serves wiki page, collecting information of all internal information and updates of all versions.

== '''Problem Statement''' ==
===Issue details===

1) On student-end, Expertiza uses grades/_reviews.html.erb partial file to display reviewers, scores and review details; on instructor-end, it uses response controller and model to construct html file for review pages. (the tables and charts are generated by grades/_team_statistics.html.erb (display reviewers and scores) in Statistics tab). We need to use the same kinds of partials in instructor-end and student-end, either _reviews partial or tabbed_reviews partial.

2) Give Feedback link at view_my_score at student-end should not appear at folded view.

===What to do===
1) We need to use the same kinds of partials in instructor-end and student-end.

2) Give Feedback link at view_my_score should appear at the bottom of expanded view.

== '''Solution''' ==
===Deploy Link===
[http://152.46.19.149:8080 Our project is deployed at VCL ]
===Student End===

* In student end, add render partial to tabbed reviews.

'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10"><%= render :partial=>'grades/reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %></TD>
<TD COLSPAN="10"><%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %></TD>
</TR>
</pre>
* Add feed back link in student end view.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<% rounds.each do |round| %>
<h3>Round <%= round %></h3>
<a href="#" name= <%= participant.id.to_s + '_' + round.to_s + "Link" %> onClick="toggleElement('<%= participant.id.to_s +
'_' + round.to_s %>','round <%= round.to_s%> reviews');return false;">show round <%= round.to_s%> reviews</a>
<table class="table table-striped" id=<%= participant.id.to_s + '_' + round.to_s %> <%= style="display: none;" if controller.action_name != "view_my_scores"%>>
<% rscore[:assessments].select{|response| response.round == round}.reverse.uniq{|response| response.map_id}.sort_by{|response| response.map_id}.each_with_index do |review, index| %>
<tr><td>
<% review_feedback = nil %>
<%= display_directory_tree(@participant, files, true).html_safe %>
<% end %>
<% end %>
<%= review.display_as_html(prefix, index + 1, nil, true) %>

<% map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: participant.id).first
review_feedbacks = map.try :response %>
<% if review_feedbacks && !review_feedbacks.empty? %>
<%= link_to "View", :controller => 'response', :action => 'view', :id => review_feedbacks.first.id %> or
<%= link_to "Edit", :controller => 'response', :action => 'edit', :id => review_feedbacks.first.id, :return => "feedback" %> feedback for Review <%= count %>
<% else %>
<%= link_to "Give feedback", :controller => 'response', :action => 'new_feedback', :id => review.id %> for Review <%= count %>
<% end %>
</td></tr>
<% end %>
</table><hr>
</pre>

* Add javascript to tabbed review so it can be hidden or shown by clicking the show/hide reviews.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<script type="text/javascript">
toggle_tag_prompt = function() {
$('.tag_prompt_container').toggle();
};
$( document ).ready(function() {
$('#tag_prompt_toggler').click(function () {
if ($('#tag_prompt_toggler').text() == "hide tags")
$('#tag_prompt_toggler').text("show tags")
else
$('#tag_prompt_toggler').text("hide tags")
});
});
</script>
</pre>

* Add statistic view to student end by using the team_review_statistics.html.erb file.
'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/team_review_statistics', :locals => {:prefix => 'user', :participant => participant, :pscore => pscore} %>
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %>
</TD>
</TR>
</pre>

'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% if @assignment.is_answer_tagging_allowed %>
<span class="spn_qsttog" id="tag_prompt_toggler" title="Click to display/hide tags" onclick="toggle_tag_prompt()">hide tags</span>
<% end %>
</pre>
'''app/views/grades/_team_review_statistics.html.erb'''
<pre>
<% if controller.action_name != "view_my_scores"%>
<tr>
<td colspan="10">
<% end %>

<% if rscore and rscore[:assessments].length > 0 %>
<%flag_varying_rubrics=false%>

@@ -25,6 +29,9 @@
<%if flag_varying_rubrics==false%>
<%= render :partial => 'grades/review_table', :locals => { :ctrl => 'review', :caction => 'view_review', :symbol => "review".to_sym, :prefix => prefix, :assignment => participant.assignment, :reviews => rscore[:assessments], :collabel => "Review", :rowlabel => "Reviewer" }%>
<%end%>
</td>
</tr>
<% end %>

<% if controller.action_name != "view_my_scores"%>
</td>
</tr>
<% end %>
</pre>
===Instructor End===

* Create new method view2 for response_controller

''' app/controllers/response_controller.rb '''
<pre>
def view2
@response = Response.find(params[:id])
@map = @response.map
set_content2
render "response/view"
end
......
......
@participant = @map.reviewer
......
def set_content2(new_response = false)
@contributor = @map.contributor
members = TeamsUser.where(team_id: params[:team])
@user = members.first
@participant = AssignmentParticipant.where(user_id: @user.user_id, parent_id: params[:assignment]).first
@@ -264,7 +273,9 @@ def set_content(new_response = false)
@questions = retrieve_questions questionnaires, @assignment.id
# @pscore has the newest versions of response for each response map, and only one for each response map (unless it is vary rubric by round)
@pscore = @participant.scores(@questions)
@reviewer = @map.reviewer
@round = params[:round]
end
</pre>

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<% prefix = nil %>
......
<% if controller.action_name == "view_my_scores"%>

<% map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: participant.id).first
review_feedbacks = map.try :response %>
<% if review_feedbacks && !review_feedbacks.empty? %>
<%= link_to "View", :controller => 'response', :action => 'view', :id => review_feedbacks.first.id %> or
<%= link_to "Edit", :controller => 'response', :action => 'edit', :id => review_feedbacks.first.id, :return => "feedback" %> feedback for Review <%= count %>
<% else %>
<%= link_to "Give feedback", :controller => 'response', :action => 'new_feedback', :id => review.id %> for Review <%= count %>
<% end %>
</td></tr>
<% end %>
<% end %>
</table><hr>
<% end %>
</pre>

''' app/views/grades/_view_heatgrid.html.erb '''
<pre>
<th class="sorter-false"> <a target="_blank" href="../response/view2?id=<%= review.id.to_s %>&&team=<%= @team.id %>&&round=<%= vm.round.to_s %>&&assignment=<%= @assignment.id %>"
data-toggle="tooltip" data-placement="right" title="Click to see details"><%= user_name.to_s %></a> </th>

</pre>

''' app/views/response/view.html.erb '''
<pre>
<% if controller.action_name != "view2" %>
<% file_url = nil %>
<%= @response.display_as_html(nil, nil, file_url) %>
<br/>
<% else %>
<TR style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => @participant, :rscore => @pscore[:review], :reviewer => @reviewer, :round => @round} %>
</TD>
</TR>
<% end %>
</pre>

* show right round for instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% next if round.to_s != @round.to_s %>
</pre>

* Create construct_instructor2_html in order to not show review number
''' app/models/response.rb '''
<pre>
if prefix == "instructor"
self_id = self.id.to_s
code = construct_instructor2_html identifier, self_id, count
elsif prefix # has prefix means view_score page in instructor end
self_id = prefix + '_' + self.id.to_s
code = construct_instructor_html identifier, self_id, count
......
def construct_instructor2_html identifier, self_id, count
identifier += '<table width="100%">'\
'<tr>'\
'<td align="left" width="70%"><b>Review ' + '</b>   '\
'<a href="#" name= "review_' + self_id + 'Link" onClick="toggleElement(' + "'review_" + self_id + "','review'" + ');return false;">hide review</a>'\
'</td>'\
'<td align="left"><b>Last Reviewed:</b>'\
"<span>#{(self.updated_at.nil? ? 'Not available' : self.updated_at.strftime('%A %B %d %Y, %I:%M%p'))}</span></td>"\
'</tr></table>'
end
</pre>

'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% if controller.action_name != "view2"%>
<h3>Round <%= round %></h3>
<% if controller.action_name != "view_my_scores" %>
<a href="#" name= <%= participant.id.to_s + '_' + round.to_s + "Link" %> onClick="toggleElement('<%= participant.id.to_s + '_' + round.to_s %>','round <%= round.to_s%> reviews');return false;">show round <%= round.to_s%> reviews</a>
<% end %>
<% end %>
<% if @assignment.is_answer_tagging_allowed %>
<span class="spn_qsttog" id="tag_prompt_toggler" title="Click to display/hide tags" onclick="toggle_tag_prompt()">hide tags</span>
@@ -37,6 +39,7 @@
<% review_feedback = nil %>
<% count = count + 1 %>
<% prefix = nil %>
<% prefix = "instructor" if controller.action_name == "view2" %>
</pre>

* Show just one review in instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% rounds.each do |round| %>
<% if controller.action_name == "view2"%>
<% next if round.to_s != @round.to_s %>
<% end %>
<% if controller.action_name != "view2"%>
<h3>Round <%= round %></h3>
<% if controller.action_name != "view_my_scores" %>
@@ -33,8 +35,13 @@
<% if @assignment.is_answer_tagging_allowed %>
<span class="spn_qsttog" id="tag_prompt_toggler" title="Click to display/hide tags" onclick="toggle_tag_prompt()">hide tags</span>
<% end %>
<% if controller.action_name != "view2"%>
<table class="table table-striped" id=<%= participant.id.to_s + '_' + round.to_s %> <%= style="display: none;" if controller.action_name != "view_my_scores"%>>
<% end %>
<% rscore[:assessments].select{|response| response.round == round}.reverse.uniq{|response| response.map_id}.sort_by{|response| response.map_id}.each_with_index do |review, index| %>
<% if controller.action_name == "view2"%>
<% next if review.reviewer != @reviewer || count > 0 %>
<% end %>
<tr><td>
<% review_feedback = nil %>
<% count = count + 1 %>
@@ -72,7 +79,9 @@
</td></tr>
<% end %>
<% end %>
<% if controller.action_name != "view2"%>
</table><hr>
<% end %>
<% end %>
<% else %>
</pre>

=='''Test files'''==

*tabbed_review_spec.rb created and added 3 test cases for alternate view of reviews
'''spec/features/tabbed_review_spec.rb'''
<pre>
require "spec_helper"
require 'rspec'
describe "alternate view of reviews" do
before(:each) do
assignment1 = create(:assignment, name: "111", directory_path: 'test_assignment')
create_list(:participant, 3)
create(:assignment_node)
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_due_date, deadline_type: DeadlineType.where(name: 'review').first, due_at: Time.now.in_time_zone + 1.day)
create(:topic)
create(:topic, topic_name: "TestReview")
create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
create(:assignment_questionnaire)
create(:question)
# create(:review_response_map, reviewer_id: User.where(role_id: 2).third.id)
# create(:review_response_map, reviewer_id: User.where(role_id: 2).second.id, reviewee: AssignmentTeam.second)
# sleep(10000)
end

def load_alternate
login_as('student2064')
expect(page).to have_content "User: student2064"
expect(page).to have_content "111"

click_link "111"
expect(page).to have_content "Submit or Review work for 111"
expect(page).to have_content "Alternate View"

click_link "Alternate View"
expect(page).to have_content "Contributor"
end

it "shows the correct alternate view" do
# Load questionnaire with generic setup
load_alternate
expect(page).to have_content "Contributor"
expect(page).to have_content "Stats"
expect(page).to have_content "Submitted work"
expect(page).to have_content "Author Feedback"
expect(page).to have_content "Teammate Review"
expect(page).to have_content "Final Score"
expect(page).to have_content "Range"
expect(page).to have_content "Average"
expect(page).to have_content "student2064"

expect(page).to have_css "a[href='#']", text: 'hide stats'
expect(page).to have_css "a[href='#']", text: 'show submission'
#expect(page).to have_css "a[href='#']", text: 'show reviews'
#page.should have_selector('table tr', text: 'show reviews')
#find(:xpath, "//tr[contains(.,'show reviews')]/td/a", :text => 'show reviews').click
#expect(page).to have_content "Writeup"
end
#describe "grades/participant", :type => :view do
#it 'exists' do
#find(:xpath, "//tr[contains(.,'show reviews')]/td/a", :text => 'show reviews').click
#end
#end
end

describe "test for instructor" do
before (:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id

assignment_team = create(:assignment_team)

create(:team_user)
login_as 'instructor6'
visit "/grades/view?id=#{assignment_id}"

end

it "shows summary report" do
expect(page).to have_content "Summary report for Test Assignment"
expect(page).to have_content "Show all teams"
page.first(:xpath, "//a[contains(@href,'#')]").click

end

end

describe "test for instructor" do
before (:each) do
create(:instructor)
@assignment = create(:assignment, name: "Test Assignment", directory_path: 'test_assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
assignment_team = create(:assignment_team)
create(:team_user)
team_id = AssignmentTeam.first.id.to_s
create(:topic)
create(:topic, topic_name: "TestReview")
create(:assignment_questionnaire)
create(:question)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
#create(:review)
#review_id = Review.first.id.to_s
#create(:review_response_map, reviewer_id: User.where(role_id: 2).third.id)
login_as 'instructor6'
#visit "/response/view2?id=#{review_id}&&team=#{team_id}&&round=1&&assignment=#{assignment_id}"
end
it "can go to review details" do
login_as 'instructor6'
visit "/response/view2?id=#{review_id}&&team=#{team_id}&&round=1&&assignment=#{assignment_id}"
end
it "can go to review details" do
end
end
</pre>

=='''Team Information'''==
#[https://github.com/aranne/expertiza Forked Issue on Github]
#Weiran Fu (@ncsu.edu)
#Qingyan Wang (qwang20@ncsu.edu)
#Hongli Wang (hwang85@ncsu.edu)
#'''Mentor:''' Mohit Jain (mjain6@ncsu.edu)

=='''References'''==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1966. Tabbed reviews partial file refactor for displaying the alternate view of reviews

2019-10-28T22:49:12Z

Hwang85:

== '''About Expertiza''' ==

Expertiza is a open source project currently for CSC517 instructor and students forming groups, submit work, review, and view grades. The project is based on Ruby on Rails framework and the code is on Github: https://github.com/expertiza/expertiza. Expertiza serves wiki page, collecting information of all internal information and updates of all versions.

== '''Problem Statement''' ==
===Issue details===

1) On student-end, Expertiza use grades/_reviews.html.erb partial to display reviewers, scores and review details; on instructor-end, it uses response controller and model to generate reviews page (the tables and charts are generated by grades/_team_statistics.html.erb (display reviewers and scores) in Statistics tab). We need to use the same kinds of partials in instructor-end and student-end, either _reviews partial or tabbed_reviews partial.

2) Give Feedback link at view_my_score at student-end should not appear at folded view.

===What to do===
1) We need to use the same kinds of partials in instructor-end and student-end.

2) Give Feedback link at view_my_score should appear at the bottom of expanded view.

== '''Solution''' ==
===Deploy Link===
[http://152.46.19.149:8080 Our project is deployed at VCL ]
===Student End===

* In student end, add render partial to tabbed reviews.

'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10"><%= render :partial=>'grades/reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %></TD>
<TD COLSPAN="10"><%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %></TD>
</TR>
</pre>
* Add feed back link in student end view.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<% rounds.each do |round| %>
<h3>Round <%= round %></h3>
<a href="#" name= <%= participant.id.to_s + '_' + round.to_s + "Link" %> onClick="toggleElement('<%= participant.id.to_s +
'_' + round.to_s %>','round <%= round.to_s%> reviews');return false;">show round <%= round.to_s%> reviews</a>
<table class="table table-striped" id=<%= participant.id.to_s + '_' + round.to_s %> <%= style="display: none;" if controller.action_name != "view_my_scores"%>>
<% rscore[:assessments].select{|response| response.round == round}.reverse.uniq{|response| response.map_id}.sort_by{|response| response.map_id}.each_with_index do |review, index| %>
<tr><td>
<% review_feedback = nil %>
<%= display_directory_tree(@participant, files, true).html_safe %>
<% end %>
<% end %>
<%= review.display_as_html(prefix, index + 1, nil, true) %>

<% map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: participant.id).first
review_feedbacks = map.try :response %>
<% if review_feedbacks && !review_feedbacks.empty? %>
<%= link_to "View", :controller => 'response', :action => 'view', :id => review_feedbacks.first.id %> or
<%= link_to "Edit", :controller => 'response', :action => 'edit', :id => review_feedbacks.first.id, :return => "feedback" %> feedback for Review <%= count %>
<% else %>
<%= link_to "Give feedback", :controller => 'response', :action => 'new_feedback', :id => review.id %> for Review <%= count %>
<% end %>
</td></tr>
<% end %>
</table><hr>
</pre>

* Add javascript to tabbed review so it can be hidden or shown by clicking the show/hide reviews.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<script type="text/javascript">
toggle_tag_prompt = function() {
$('.tag_prompt_container').toggle();
};
$( document ).ready(function() {
$('#tag_prompt_toggler').click(function () {
if ($('#tag_prompt_toggler').text() == "hide tags")
$('#tag_prompt_toggler').text("show tags")
else
$('#tag_prompt_toggler').text("hide tags")
});
});
</script>
</pre>

* Add statistic view to student end by using the team_review_statistics.html.erb file.
'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/team_review_statistics', :locals => {:prefix => 'user', :participant => participant, :pscore => pscore} %>
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %>
</TD>
</TR>
</pre>

'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% if @assignment.is_answer_tagging_allowed %>
<span class="spn_qsttog" id="tag_prompt_toggler" title="Click to display/hide tags" onclick="toggle_tag_prompt()">hide tags</span>
<% end %>
</pre>
'''app/views/grades/_team_review_statistics.html.erb'''
<pre>
<% if controller.action_name != "view_my_scores"%>
<tr>
<td colspan="10">
<% end %>

<% if rscore and rscore[:assessments].length > 0 %>
<%flag_varying_rubrics=false%>

@@ -25,6 +29,9 @@
<%if flag_varying_rubrics==false%>
<%= render :partial => 'grades/review_table', :locals => { :ctrl => 'review', :caction => 'view_review', :symbol => "review".to_sym, :prefix => prefix, :assignment => participant.assignment, :reviews => rscore[:assessments], :collabel => "Review", :rowlabel => "Reviewer" }%>
<%end%>
</td>
</tr>
<% end %>

<% if controller.action_name != "view_my_scores"%>
</td>
</tr>
<% end %>
</pre>
===Instructor End===

* Create new method view2 for response_controller

''' app/controllers/response_controller.rb '''
<pre>
def view2
@response = Response.find(params[:id])
@map = @response.map
set_content2
render "response/view"
end
......
......
@participant = @map.reviewer
......
def set_content2(new_response = false)
@contributor = @map.contributor
members = TeamsUser.where(team_id: params[:team])
@user = members.first
@participant = AssignmentParticipant.where(user_id: @user.user_id, parent_id: params[:assignment]).first
@@ -264,7 +273,9 @@ def set_content(new_response = false)
@questions = retrieve_questions questionnaires, @assignment.id
# @pscore has the newest versions of response for each response map, and only one for each response map (unless it is vary rubric by round)
@pscore = @participant.scores(@questions)
@reviewer = @map.reviewer
@round = params[:round]
end
</pre>

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<% prefix = nil %>
......
<% if controller.action_name == "view_my_scores"%>

<% map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: participant.id).first
review_feedbacks = map.try :response %>
<% if review_feedbacks && !review_feedbacks.empty? %>
<%= link_to "View", :controller => 'response', :action => 'view', :id => review_feedbacks.first.id %> or
<%= link_to "Edit", :controller => 'response', :action => 'edit', :id => review_feedbacks.first.id, :return => "feedback" %> feedback for Review <%= count %>
<% else %>
<%= link_to "Give feedback", :controller => 'response', :action => 'new_feedback', :id => review.id %> for Review <%= count %>
<% end %>
</td></tr>
<% end %>
<% end %>
</table><hr>
<% end %>
</pre>

''' app/views/grades/_view_heatgrid.html.erb '''
<pre>
<th class="sorter-false"> <a target="_blank" href="../response/view2?id=<%= review.id.to_s %>&&team=<%= @team.id %>&&round=<%= vm.round.to_s %>&&assignment=<%= @assignment.id %>"
data-toggle="tooltip" data-placement="right" title="Click to see details"><%= user_name.to_s %></a> </th>

</pre>

''' app/views/response/view.html.erb '''
<pre>
<% if controller.action_name != "view2" %>
<% file_url = nil %>
<%= @response.display_as_html(nil, nil, file_url) %>
<br/>
<% else %>
<TR style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => @participant, :rscore => @pscore[:review], :reviewer => @reviewer, :round => @round} %>
</TD>
</TR>
<% end %>
</pre>

* show right round for instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% next if round.to_s != @round.to_s %>
</pre>

* Create construct_instructor2_html in order to not show review number
''' app/models/response.rb '''
<pre>
if prefix == "instructor"
self_id = self.id.to_s
code = construct_instructor2_html identifier, self_id, count
elsif prefix # has prefix means view_score page in instructor end
self_id = prefix + '_' + self.id.to_s
code = construct_instructor_html identifier, self_id, count
......
def construct_instructor2_html identifier, self_id, count
identifier += '<table width="100%">'\
'<tr>'\
'<td align="left" width="70%"><b>Review ' + '</b>   '\
'<a href="#" name= "review_' + self_id + 'Link" onClick="toggleElement(' + "'review_" + self_id + "','review'" + ');return false;">hide review</a>'\
'</td>'\
'<td align="left"><b>Last Reviewed:</b>'\
"<span>#{(self.updated_at.nil? ? 'Not available' : self.updated_at.strftime('%A %B %d %Y, %I:%M%p'))}</span></td>"\
'</tr></table>'
end
</pre>

'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% if controller.action_name != "view2"%>
<h3>Round <%= round %></h3>
<% if controller.action_name != "view_my_scores" %>
<a href="#" name= <%= participant.id.to_s + '_' + round.to_s + "Link" %> onClick="toggleElement('<%= participant.id.to_s + '_' + round.to_s %>','round <%= round.to_s%> reviews');return false;">show round <%= round.to_s%> reviews</a>
<% end %>
<% end %>
<% if @assignment.is_answer_tagging_allowed %>
<span class="spn_qsttog" id="tag_prompt_toggler" title="Click to display/hide tags" onclick="toggle_tag_prompt()">hide tags</span>
@@ -37,6 +39,7 @@
<% review_feedback = nil %>
<% count = count + 1 %>
<% prefix = nil %>
<% prefix = "instructor" if controller.action_name == "view2" %>
</pre>

* Show just one review in instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% rounds.each do |round| %>
<% if controller.action_name == "view2"%>
<% next if round.to_s != @round.to_s %>
<% end %>
<% if controller.action_name != "view2"%>
<h3>Round <%= round %></h3>
<% if controller.action_name != "view_my_scores" %>
@@ -33,8 +35,13 @@
<% if @assignment.is_answer_tagging_allowed %>
<span class="spn_qsttog" id="tag_prompt_toggler" title="Click to display/hide tags" onclick="toggle_tag_prompt()">hide tags</span>
<% end %>
<% if controller.action_name != "view2"%>
<table class="table table-striped" id=<%= participant.id.to_s + '_' + round.to_s %> <%= style="display: none;" if controller.action_name != "view_my_scores"%>>
<% end %>
<% rscore[:assessments].select{|response| response.round == round}.reverse.uniq{|response| response.map_id}.sort_by{|response| response.map_id}.each_with_index do |review, index| %>
<% if controller.action_name == "view2"%>
<% next if review.reviewer != @reviewer || count > 0 %>
<% end %>
<tr><td>
<% review_feedback = nil %>
<% count = count + 1 %>
@@ -72,7 +79,9 @@
</td></tr>
<% end %>
<% end %>
<% if controller.action_name != "view2"%>
</table><hr>
<% end %>
<% end %>
<% else %>
</pre>

=='''Test files'''==

*tabbed_review_spec.rb created and added 3 test cases for alternate view of reviews
'''spec/features/tabbed_review_spec.rb'''
<pre>
require "spec_helper"
require 'rspec'
describe "alternate view of reviews" do
before(:each) do
assignment1 = create(:assignment, name: "111", directory_path: 'test_assignment')
create_list(:participant, 3)
create(:assignment_node)
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_due_date, deadline_type: DeadlineType.where(name: 'review').first, due_at: Time.now.in_time_zone + 1.day)
create(:topic)
create(:topic, topic_name: "TestReview")
create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
create(:assignment_questionnaire)
create(:question)
# create(:review_response_map, reviewer_id: User.where(role_id: 2).third.id)
# create(:review_response_map, reviewer_id: User.where(role_id: 2).second.id, reviewee: AssignmentTeam.second)
# sleep(10000)
end

def load_alternate
login_as('student2064')
expect(page).to have_content "User: student2064"
expect(page).to have_content "111"

click_link "111"
expect(page).to have_content "Submit or Review work for 111"
expect(page).to have_content "Alternate View"

click_link "Alternate View"
expect(page).to have_content "Contributor"
end

it "shows the correct alternate view" do
# Load questionnaire with generic setup
load_alternate
expect(page).to have_content "Contributor"
expect(page).to have_content "Stats"
expect(page).to have_content "Submitted work"
expect(page).to have_content "Author Feedback"
expect(page).to have_content "Teammate Review"
expect(page).to have_content "Final Score"
expect(page).to have_content "Range"
expect(page).to have_content "Average"
expect(page).to have_content "student2064"

expect(page).to have_css "a[href='#']", text: 'hide stats'
expect(page).to have_css "a[href='#']", text: 'show submission'
#expect(page).to have_css "a[href='#']", text: 'show reviews'
#page.should have_selector('table tr', text: 'show reviews')
#find(:xpath, "//tr[contains(.,'show reviews')]/td/a", :text => 'show reviews').click
#expect(page).to have_content "Writeup"
end
#describe "grades/participant", :type => :view do
#it 'exists' do
#find(:xpath, "//tr[contains(.,'show reviews')]/td/a", :text => 'show reviews').click
#end
#end
end

describe "test for instructor" do
before (:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id

assignment_team = create(:assignment_team)

create(:team_user)
login_as 'instructor6'
visit "/grades/view?id=#{assignment_id}"

end

it "shows summary report" do
expect(page).to have_content "Summary report for Test Assignment"
expect(page).to have_content "Show all teams"
page.first(:xpath, "//a[contains(@href,'#')]").click

end

end

describe "test for instructor" do
before (:each) do
create(:instructor)
@assignment = create(:assignment, name: "Test Assignment", directory_path: 'test_assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
assignment_team = create(:assignment_team)
create(:team_user)
team_id = AssignmentTeam.first.id.to_s
create(:topic)
create(:topic, topic_name: "TestReview")
create(:assignment_questionnaire)
create(:question)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
#create(:review)
#review_id = Review.first.id.to_s
#create(:review_response_map, reviewer_id: User.where(role_id: 2).third.id)
login_as 'instructor6'
#visit "/response/view2?id=#{review_id}&&team=#{team_id}&&round=1&&assignment=#{assignment_id}"
end
it "can go to review details" do
login_as 'instructor6'
visit "/response/view2?id=#{review_id}&&team=#{team_id}&&round=1&&assignment=#{assignment_id}"
end
it "can go to review details" do
end
end
</pre>

=='''Team Information'''==
#[https://github.com/aranne/expertiza Forked Issue on Github]
#Weiran Fu (@ncsu.edu)
#Qingyan Wang (qwang20@ncsu.edu)
#Hongli Wang (hwang85@ncsu.edu)
#'''Mentor:''' Mohit Jain (mjain6@ncsu.edu)

=='''References'''==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://bit.ly/myexpertiza Demo link]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1966. Tabbed reviews partial file refactor for displaying the alternate view of reviews

2019-10-28T22:46:03Z

Hwang85:

== '''About Expertiza''' ==

Expertiza is a open source project currently for CSC517 instructor and students forming groups, submit work, review, and view grades. The project is based on Ruby on Rails framework and the code is on Github: https://github.com/expertiza/expertiza. Expertiza serves wiki page, collecting information of all internal information and updates of all versions.

== '''Problem Statement''' ==
===Issue details===

1) On student-end, Expertiza use grades/_reviews.html.erb partial to display reviewers, scores and review details; on instructor-end, it uses response controller and model to generate reviews page (the tables and charts are generated by grades/_team_statistics.html.erb (display reviewers and scores) in Statistics tab). We need to use the same kinds of partials in instructor-end and student-end, either _reviews partial or tabbed_reviews partial.

2) Give Feedback link at view_my_score at student-end should not appear at folded view.

===What to do===
1) We need to use the same kinds of partials in instructor-end and student-end.

2) Give Feedback link at view_my_score should appear at the bottom of expanded view.

== '''Solution''' ==
===Student End===

* In student end, add render partial to tabbed reviews.

'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10"><%= render :partial=>'grades/reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %></TD>
<TD COLSPAN="10"><%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %></TD>
</TR>
</pre>
* Add feed back link in student end view.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<% rounds.each do |round| %>
<h3>Round <%= round %></h3>
<a href="#" name= <%= participant.id.to_s + '_' + round.to_s + "Link" %> onClick="toggleElement('<%= participant.id.to_s +
'_' + round.to_s %>','round <%= round.to_s%> reviews');return false;">show round <%= round.to_s%> reviews</a>
<table class="table table-striped" id=<%= participant.id.to_s + '_' + round.to_s %> <%= style="display: none;" if controller.action_name != "view_my_scores"%>>
<% rscore[:assessments].select{|response| response.round == round}.reverse.uniq{|response| response.map_id}.sort_by{|response| response.map_id}.each_with_index do |review, index| %>
<tr><td>
<% review_feedback = nil %>
<%= display_directory_tree(@participant, files, true).html_safe %>
<% end %>
<% end %>
<%= review.display_as_html(prefix, index + 1, nil, true) %>

<% map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: participant.id).first
review_feedbacks = map.try :response %>
<% if review_feedbacks && !review_feedbacks.empty? %>
<%= link_to "View", :controller => 'response', :action => 'view', :id => review_feedbacks.first.id %> or
<%= link_to "Edit", :controller => 'response', :action => 'edit', :id => review_feedbacks.first.id, :return => "feedback" %> feedback for Review <%= count %>
<% else %>
<%= link_to "Give feedback", :controller => 'response', :action => 'new_feedback', :id => review.id %> for Review <%= count %>
<% end %>
</td></tr>
<% end %>
</table><hr>
</pre>

* Add javascript to tabbed review so it can be hidden or shown by clicking the show/hide reviews.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<script type="text/javascript">
toggle_tag_prompt = function() {
$('.tag_prompt_container').toggle();
};
$( document ).ready(function() {
$('#tag_prompt_toggler').click(function () {
if ($('#tag_prompt_toggler').text() == "hide tags")
$('#tag_prompt_toggler').text("show tags")
else
$('#tag_prompt_toggler').text("hide tags")
});
});
</script>
</pre>

* Add statistic view to student end by using the team_review_statistics.html.erb file.
'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/team_review_statistics', :locals => {:prefix => 'user', :participant => participant, :pscore => pscore} %>
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %>
</TD>
</TR>
</pre>

'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% if @assignment.is_answer_tagging_allowed %>
<span class="spn_qsttog" id="tag_prompt_toggler" title="Click to display/hide tags" onclick="toggle_tag_prompt()">hide tags</span>
<% end %>
</pre>
'''app/views/grades/_team_review_statistics.html.erb'''
<pre>
<% if controller.action_name != "view_my_scores"%>
<tr>
<td colspan="10">
<% end %>

<% if rscore and rscore[:assessments].length > 0 %>
<%flag_varying_rubrics=false%>

@@ -25,6 +29,9 @@
<%if flag_varying_rubrics==false%>
<%= render :partial => 'grades/review_table', :locals => { :ctrl => 'review', :caction => 'view_review', :symbol => "review".to_sym, :prefix => prefix, :assignment => participant.assignment, :reviews => rscore[:assessments], :collabel => "Review", :rowlabel => "Reviewer" }%>
<%end%>
</td>
</tr>
<% end %>

<% if controller.action_name != "view_my_scores"%>
</td>
</tr>
<% end %>
</pre>
===Instructor End===

* Create new method view2 for response_controller

''' app/controllers/response_controller.rb '''
<pre>
def view2
@response = Response.find(params[:id])
@map = @response.map
set_content2
render "response/view"
end
......
......
@participant = @map.reviewer
......
def set_content2(new_response = false)
@contributor = @map.contributor
members = TeamsUser.where(team_id: params[:team])
@user = members.first
@participant = AssignmentParticipant.where(user_id: @user.user_id, parent_id: params[:assignment]).first
@@ -264,7 +273,9 @@ def set_content(new_response = false)
@questions = retrieve_questions questionnaires, @assignment.id
# @pscore has the newest versions of response for each response map, and only one for each response map (unless it is vary rubric by round)
@pscore = @participant.scores(@questions)
@reviewer = @map.reviewer
@round = params[:round]
end
</pre>

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<% prefix = nil %>
......
<% if controller.action_name == "view_my_scores"%>

<% map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: participant.id).first
review_feedbacks = map.try :response %>
<% if review_feedbacks && !review_feedbacks.empty? %>
<%= link_to "View", :controller => 'response', :action => 'view', :id => review_feedbacks.first.id %> or
<%= link_to "Edit", :controller => 'response', :action => 'edit', :id => review_feedbacks.first.id, :return => "feedback" %> feedback for Review <%= count %>
<% else %>
<%= link_to "Give feedback", :controller => 'response', :action => 'new_feedback', :id => review.id %> for Review <%= count %>
<% end %>
</td></tr>
<% end %>
<% end %>
</table><hr>
<% end %>
</pre>

''' app/views/grades/_view_heatgrid.html.erb '''
<pre>
<th class="sorter-false"> <a target="_blank" href="../response/view2?id=<%= review.id.to_s %>&&team=<%= @team.id %>&&round=<%= vm.round.to_s %>&&assignment=<%= @assignment.id %>"
data-toggle="tooltip" data-placement="right" title="Click to see details"><%= user_name.to_s %></a> </th>

</pre>

''' app/views/response/view.html.erb '''
<pre>
<% if controller.action_name != "view2" %>
<% file_url = nil %>
<%= @response.display_as_html(nil, nil, file_url) %>
<br/>
<% else %>
<TR style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => @participant, :rscore => @pscore[:review], :reviewer => @reviewer, :round => @round} %>
</TD>
</TR>
<% end %>
</pre>

* show right round for instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% next if round.to_s != @round.to_s %>
</pre>

* Create construct_instructor2_html in order to not show review number
''' app/models/response.rb '''
<pre>
if prefix == "instructor"
self_id = self.id.to_s
code = construct_instructor2_html identifier, self_id, count
elsif prefix # has prefix means view_score page in instructor end
self_id = prefix + '_' + self.id.to_s
code = construct_instructor_html identifier, self_id, count
......
def construct_instructor2_html identifier, self_id, count
identifier += '<table width="100%">'\
'<tr>'\
'<td align="left" width="70%"><b>Review ' + '</b>   '\
'<a href="#" name= "review_' + self_id + 'Link" onClick="toggleElement(' + "'review_" + self_id + "','review'" + ');return false;">hide review</a>'\
'</td>'\
'<td align="left"><b>Last Reviewed:</b>'\
"<span>#{(self.updated_at.nil? ? 'Not available' : self.updated_at.strftime('%A %B %d %Y, %I:%M%p'))}</span></td>"\
'</tr></table>'
end
</pre>

'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% if controller.action_name != "view2"%>
<h3>Round <%= round %></h3>
<% if controller.action_name != "view_my_scores" %>
<a href="#" name= <%= participant.id.to_s + '_' + round.to_s + "Link" %> onClick="toggleElement('<%= participant.id.to_s + '_' + round.to_s %>','round <%= round.to_s%> reviews');return false;">show round <%= round.to_s%> reviews</a>
<% end %>
<% end %>
<% if @assignment.is_answer_tagging_allowed %>
<span class="spn_qsttog" id="tag_prompt_toggler" title="Click to display/hide tags" onclick="toggle_tag_prompt()">hide tags</span>
@@ -37,6 +39,7 @@
<% review_feedback = nil %>
<% count = count + 1 %>
<% prefix = nil %>
<% prefix = "instructor" if controller.action_name == "view2" %>
</pre>

* Show just one review in instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% rounds.each do |round| %>
<% if controller.action_name == "view2"%>
<% next if round.to_s != @round.to_s %>
<% end %>
<% if controller.action_name != "view2"%>
<h3>Round <%= round %></h3>
<% if controller.action_name != "view_my_scores" %>
@@ -33,8 +35,13 @@
<% if @assignment.is_answer_tagging_allowed %>
<span class="spn_qsttog" id="tag_prompt_toggler" title="Click to display/hide tags" onclick="toggle_tag_prompt()">hide tags</span>
<% end %>
<% if controller.action_name != "view2"%>
<table class="table table-striped" id=<%= participant.id.to_s + '_' + round.to_s %> <%= style="display: none;" if controller.action_name != "view_my_scores"%>>
<% end %>
<% rscore[:assessments].select{|response| response.round == round}.reverse.uniq{|response| response.map_id}.sort_by{|response| response.map_id}.each_with_index do |review, index| %>
<% if controller.action_name == "view2"%>
<% next if review.reviewer != @reviewer || count > 0 %>
<% end %>
<tr><td>
<% review_feedback = nil %>
<% count = count + 1 %>
@@ -72,7 +79,9 @@
</td></tr>
<% end %>
<% end %>
<% if controller.action_name != "view2"%>
</table><hr>
<% end %>
<% end %>
<% else %>
</pre>

=='''Test files'''==

*tabbed_review_spec.rb created and added 3 test cases for alternate view of reviews
'''spec/features/tabbed_review_spec.rb'''
<pre>
require "spec_helper"
require 'rspec'
describe "alternate view of reviews" do
before(:each) do
assignment1 = create(:assignment, name: "111", directory_path: 'test_assignment')
create_list(:participant, 3)
create(:assignment_node)
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_due_date, deadline_type: DeadlineType.where(name: 'review').first, due_at: Time.now.in_time_zone + 1.day)
create(:topic)
create(:topic, topic_name: "TestReview")
create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
create(:assignment_questionnaire)
create(:question)
# create(:review_response_map, reviewer_id: User.where(role_id: 2).third.id)
# create(:review_response_map, reviewer_id: User.where(role_id: 2).second.id, reviewee: AssignmentTeam.second)
# sleep(10000)
end

def load_alternate
login_as('student2064')
expect(page).to have_content "User: student2064"
expect(page).to have_content "111"

click_link "111"
expect(page).to have_content "Submit or Review work for 111"
expect(page).to have_content "Alternate View"

click_link "Alternate View"
expect(page).to have_content "Contributor"
end

it "shows the correct alternate view" do
# Load questionnaire with generic setup
load_alternate
expect(page).to have_content "Contributor"
expect(page).to have_content "Stats"
expect(page).to have_content "Submitted work"
expect(page).to have_content "Author Feedback"
expect(page).to have_content "Teammate Review"
expect(page).to have_content "Final Score"
expect(page).to have_content "Range"
expect(page).to have_content "Average"
expect(page).to have_content "student2064"

expect(page).to have_css "a[href='#']", text: 'hide stats'
expect(page).to have_css "a[href='#']", text: 'show submission'
#expect(page).to have_css "a[href='#']", text: 'show reviews'
#page.should have_selector('table tr', text: 'show reviews')
#find(:xpath, "//tr[contains(.,'show reviews')]/td/a", :text => 'show reviews').click
#expect(page).to have_content "Writeup"
end
#describe "grades/participant", :type => :view do
#it 'exists' do
#find(:xpath, "//tr[contains(.,'show reviews')]/td/a", :text => 'show reviews').click
#end
#end
end

describe "test for instructor" do
before (:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id

assignment_team = create(:assignment_team)

create(:team_user)
login_as 'instructor6'
visit "/grades/view?id=#{assignment_id}"

end

it "shows summary report" do
expect(page).to have_content "Summary report for Test Assignment"
expect(page).to have_content "Show all teams"
page.first(:xpath, "//a[contains(@href,'#')]").click

end

end

describe "test for instructor" do
before (:each) do
create(:instructor)
@assignment = create(:assignment, name: "Test Assignment", directory_path: 'test_assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
assignment_team = create(:assignment_team)
create(:team_user)
team_id = AssignmentTeam.first.id.to_s
create(:topic)
create(:topic, topic_name: "TestReview")
create(:assignment_questionnaire)
create(:question)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
#create(:review)
#review_id = Review.first.id.to_s
#create(:review_response_map, reviewer_id: User.where(role_id: 2).third.id)
login_as 'instructor6'
#visit "/response/view2?id=#{review_id}&&team=#{team_id}&&round=1&&assignment=#{assignment_id}"
end
it "can go to review details" do
login_as 'instructor6'
visit "/response/view2?id=#{review_id}&&team=#{team_id}&&round=1&&assignment=#{assignment_id}"
end
it "can go to review details" do
end
end
</pre>

=='''Team Information'''==
#[https://github.com/aranne/expertiza Forked Issue on Github]
#Weiran Fu (@ncsu.edu)
#Qingyan Wang (qwang20@ncsu.edu)
#Hongli Wang (hwang85@ncsu.edu)
#'''Mentor:''' Mohit Jain (mjain6@ncsu.edu)

=='''References'''==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://bit.ly/myexpertiza Demo link]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1966. Tabbed reviews partial file refactor for displaying the alternate view of reviews

2019-10-28T21:08:01Z

Hwang85:

== '''About Expertiza''' ==

Expertiza is a open source project currently for CSC517 instructor and students forming groups, submit work, review, and view grades. The project is based on Ruby on Rails framework and the code is on Github: https://github.com/expertiza/expertiza. Expertiza serves wiki page, collecting information of all internal information and updates of all versions.

== '''Problem Statement''' ==
===Issue details===

1) On student-end, Expertiza use grades/_reviews.html.erb partial to display reviewers, scores and review details; on instructor-end, it uses response controller and model to generate reviews page (the tables and charts are generated by grades/_team_statistics.html.erb (display reviewers and scores) in Statistics tab). We need to use the same kinds of partials in instructor-end and student-end, either _reviews partial or tabbed_reviews partial.

2) Give Feedback link at view_my_score at student-end should not appear at folded view.

===What to do===
1) We need to use the same kinds of partials in instructor-end and student-end.

2) Give Feedback link at view_my_score should appear at the bottom of expanded view.

== '''Solution''' ==
===Student End===

* In student end, add render partial to tabbed reviews.

'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10"><%= render :partial=>'grades/reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %></TD>
<TD COLSPAN="10"><%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %></TD>
</TR>
</pre>
* Add feed back link in student end view.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<% rounds.each do |round| %>
<h3>Round <%= round %></h3>
<a href="#" name= <%= participant.id.to_s + '_' + round.to_s + "Link" %> onClick="toggleElement('<%= participant.id.to_s +
'_' + round.to_s %>','round <%= round.to_s%> reviews');return false;">show round <%= round.to_s%> reviews</a>
<table class="table table-striped" id=<%= participant.id.to_s + '_' + round.to_s %> <%= style="display: none;" if controller.action_name != "view_my_scores"%>>
<% rscore[:assessments].select{|response| response.round == round}.reverse.uniq{|response| response.map_id}.sort_by{|response| response.map_id}.each_with_index do |review, index| %>
<tr><td>
<% review_feedback = nil %>
<%= display_directory_tree(@participant, files, true).html_safe %>
<% end %>
<% end %>
<%= review.display_as_html(prefix, index + 1, nil, true) %>

<% map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: participant.id).first
review_feedbacks = map.try :response %>
<% if review_feedbacks && !review_feedbacks.empty? %>
<%= link_to "View", :controller => 'response', :action => 'view', :id => review_feedbacks.first.id %> or
<%= link_to "Edit", :controller => 'response', :action => 'edit', :id => review_feedbacks.first.id, :return => "feedback" %> feedback for Review <%= count %>
<% else %>
<%= link_to "Give feedback", :controller => 'response', :action => 'new_feedback', :id => review.id %> for Review <%= count %>
<% end %>
</td></tr>
<% end %>
</table><hr>
</pre>

* Add javascript to tabbed review so it can be hidden or shown by clicking the show/hide reviews.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<script type="text/javascript">
toggle_tag_prompt = function() {
$('.tag_prompt_container').toggle();
};
$( document ).ready(function() {
$('#tag_prompt_toggler').click(function () {
if ($('#tag_prompt_toggler').text() == "hide tags")
$('#tag_prompt_toggler').text("show tags")
else
$('#tag_prompt_toggler').text("hide tags")
});
});
</script>
</pre>

* Add statistic view to student end by using the team_review_statistics.html.erb file.
'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/team_review_statistics', :locals => {:prefix => 'user', :participant => participant, :pscore => pscore} %>
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %>
</TD>
</TR>
</pre>

'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% if @assignment.is_answer_tagging_allowed %>
<span class="spn_qsttog" id="tag_prompt_toggler" title="Click to display/hide tags" onclick="toggle_tag_prompt()">hide tags</span>
<% end %>
</pre>
'''app/views/grades/_team_review_statistics.html.erb'''
<pre>
<% if controller.action_name != "view_my_scores"%>
<tr>
<td colspan="10">
<% end %>

<% if rscore and rscore[:assessments].length > 0 %>
<%flag_varying_rubrics=false%>

@@ -25,6 +29,9 @@
<%if flag_varying_rubrics==false%>
<%= render :partial => 'grades/review_table', :locals => { :ctrl => 'review', :caction => 'view_review', :symbol => "review".to_sym, :prefix => prefix, :assignment => participant.assignment, :reviews => rscore[:assessments], :collabel => "Review", :rowlabel => "Reviewer" }%>
<%end%>
</td>
</tr>
<% end %>

<% if controller.action_name != "view_my_scores"%>
</td>
</tr>
<% end %>
</pre>
===Instructor End===

* Create new method view2 for response_controller

''' app/controllers/response_controller.rb '''
<pre>
def view2
@response = Response.find(params[:id])
@map = @response.map
set_content2
render "response/view"
end
......
......
@participant = @map.reviewer
......
def set_content2(new_response = false)
@contributor = @map.contributor
members = TeamsUser.where(team_id: params[:team])
@user = members.first
@participant = AssignmentParticipant.where(user_id: @user.user_id, parent_id: params[:assignment]).first
@@ -264,7 +273,9 @@ def set_content(new_response = false)
@questions = retrieve_questions questionnaires, @assignment.id
# @pscore has the newest versions of response for each response map, and only one for each response map (unless it is vary rubric by round)
@pscore = @participant.scores(@questions)
@reviewer = @map.reviewer
@round = params[:round]
end
</pre>

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<% prefix = nil %>
......
<% if controller.action_name == "view_my_scores"%>

<% map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: participant.id).first
review_feedbacks = map.try :response %>
<% if review_feedbacks && !review_feedbacks.empty? %>
<%= link_to "View", :controller => 'response', :action => 'view', :id => review_feedbacks.first.id %> or
<%= link_to "Edit", :controller => 'response', :action => 'edit', :id => review_feedbacks.first.id, :return => "feedback" %> feedback for Review <%= count %>
<% else %>
<%= link_to "Give feedback", :controller => 'response', :action => 'new_feedback', :id => review.id %> for Review <%= count %>
<% end %>
</td></tr>
<% end %>
<% end %>
</table><hr>
<% end %>
</pre>

''' app/views/grades/_view_heatgrid.html.erb '''
<pre>
<th class="sorter-false"> <a target="_blank" href="../response/view2?id=<%= review.id.to_s %>&&team=<%= @team.id %>&&round=<%= vm.round.to_s %>&&assignment=<%= @assignment.id %>"
data-toggle="tooltip" data-placement="right" title="Click to see details"><%= user_name.to_s %></a> </th>

</pre>

''' app/views/response/view.html.erb '''
<pre>
<% if controller.action_name != "view2" %>
<% file_url = nil %>
<%= @response.display_as_html(nil, nil, file_url) %>
<br/>
<% else %>
<TR style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => @participant, :rscore => @pscore[:review], :reviewer => @reviewer, :round => @round} %>
</TD>
</TR>
<% end %>
</pre>

* show right round for instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% next if round.to_s != @round.to_s %>
</pre>

* Create construct_instructor2_html in order to not show review number
''' app/models/response.rb '''
<pre>
if prefix == "instructor"
self_id = self.id.to_s
code = construct_instructor2_html identifier, self_id, count
elsif prefix # has prefix means view_score page in instructor end
self_id = prefix + '_' + self.id.to_s
code = construct_instructor_html identifier, self_id, count
......
def construct_instructor2_html identifier, self_id, count
identifier += '<table width="100%">'\
'<tr>'\
'<td align="left" width="70%"><b>Review ' + '</b>   '\
'<a href="#" name= "review_' + self_id + 'Link" onClick="toggleElement(' + "'review_" + self_id + "','review'" + ');return false;">hide review</a>'\
'</td>'\
'<td align="left"><b>Last Reviewed:</b>'\
"<span>#{(self.updated_at.nil? ? 'Not available' : self.updated_at.strftime('%A %B %d %Y, %I:%M%p'))}</span></td>"\
'</tr></table>'
end
</pre>

'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% if controller.action_name != "view2"%>
<h3>Round <%= round %></h3>
<% if controller.action_name != "view_my_scores" %>
<a href="#" name= <%= participant.id.to_s + '_' + round.to_s + "Link" %> onClick="toggleElement('<%= participant.id.to_s + '_' + round.to_s %>','round <%= round.to_s%> reviews');return false;">show round <%= round.to_s%> reviews</a>
<% end %>
<% end %>
<% if @assignment.is_answer_tagging_allowed %>
<span class="spn_qsttog" id="tag_prompt_toggler" title="Click to display/hide tags" onclick="toggle_tag_prompt()">hide tags</span>
@@ -37,6 +39,7 @@
<% review_feedback = nil %>
<% count = count + 1 %>
<% prefix = nil %>
<% prefix = "instructor" if controller.action_name == "view2" %>
</pre>

* Show just one review in instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% rounds.each do |round| %>
<% if controller.action_name == "view2"%>
<% next if round.to_s != @round.to_s %>
<% end %>
<% if controller.action_name != "view2"%>
<h3>Round <%= round %></h3>
<% if controller.action_name != "view_my_scores" %>
@@ -33,8 +35,13 @@
<% if @assignment.is_answer_tagging_allowed %>
<span class="spn_qsttog" id="tag_prompt_toggler" title="Click to display/hide tags" onclick="toggle_tag_prompt()">hide tags</span>
<% end %>
<% if controller.action_name != "view2"%>
<table class="table table-striped" id=<%= participant.id.to_s + '_' + round.to_s %> <%= style="display: none;" if controller.action_name != "view_my_scores"%>>
<% end %>
<% rscore[:assessments].select{|response| response.round == round}.reverse.uniq{|response| response.map_id}.sort_by{|response| response.map_id}.each_with_index do |review, index| %>
<% if controller.action_name == "view2"%>
<% next if review.reviewer != @reviewer || count > 0 %>
<% end %>
<tr><td>
<% review_feedback = nil %>
<% count = count + 1 %>
@@ -72,7 +79,9 @@
</td></tr>
<% end %>
<% end %>
<% if controller.action_name != "view2"%>
</table><hr>
<% end %>
<% end %>
<% else %>
</pre>

=='''Test files'''==

*tabbed_review_spec.rb created and added 3 test cases for alternate view of reviews
'''spec/features/tabbed_review_spec.rb'''
<pre>
require "spec_helper"
require 'rspec'
describe "alternate view of reviews" do
before(:each) do
assignment1 = create(:assignment, name: "111", directory_path: 'test_assignment')
create_list(:participant, 3)
create(:assignment_node)
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_due_date, deadline_type: DeadlineType.where(name: 'review').first, due_at: Time.now.in_time_zone + 1.day)
create(:topic)
create(:topic, topic_name: "TestReview")
create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
create(:assignment_questionnaire)
create(:question)
# create(:review_response_map, reviewer_id: User.where(role_id: 2).third.id)
# create(:review_response_map, reviewer_id: User.where(role_id: 2).second.id, reviewee: AssignmentTeam.second)
# sleep(10000)
end

def load_alternate
login_as('student2064')
expect(page).to have_content "User: student2064"
expect(page).to have_content "111"

click_link "111"
expect(page).to have_content "Submit or Review work for 111"
expect(page).to have_content "Alternate View"

click_link "Alternate View"
expect(page).to have_content "Contributor"
end

it "shows the correct alternate view" do
# Load questionnaire with generic setup
load_alternate
expect(page).to have_content "Contributor"
expect(page).to have_content "Stats"
expect(page).to have_content "Submitted work"
expect(page).to have_content "Author Feedback"
expect(page).to have_content "Teammate Review"
expect(page).to have_content "Final Score"
expect(page).to have_content "Range"
expect(page).to have_content "Average"
expect(page).to have_content "student2064"

expect(page).to have_css "a[href='#']", text: 'hide stats'
expect(page).to have_css "a[href='#']", text: 'show submission'
#expect(page).to have_css "a[href='#']", text: 'show reviews'
#page.should have_selector('table tr', text: 'show reviews')
#find(:xpath, "//tr[contains(.,'show reviews')]/td/a", :text => 'show reviews').click
#expect(page).to have_content "Writeup"
end
#describe "grades/participant", :type => :view do
#it 'exists' do
#find(:xpath, "//tr[contains(.,'show reviews')]/td/a", :text => 'show reviews').click
#end
#end
end

describe "test for instructor" do
before (:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id

assignment_team = create(:assignment_team)

create(:team_user)
login_as 'instructor6'
visit "/grades/view?id=#{assignment_id}"

end

it "shows summary report" do
expect(page).to have_content "Summary report for Test Assignment"
expect(page).to have_content "Show all teams"
page.first(:xpath, "//a[contains(@href,'#')]").click

end

end

describe "test for instructor" do
before (:each) do
create(:instructor)
@assignment = create(:assignment, name: "Test Assignment", directory_path: 'test_assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
assignment_team = create(:assignment_team)
create(:team_user)
team_id = AssignmentTeam.first.id.to_s
create(:topic)
create(:topic, topic_name: "TestReview")
create(:assignment_questionnaire)
create(:question)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
create(:review)
review_id = Review.first.id.to_s
create(:review_response_map, reviewer_id: User.where(role_id: 2).third.id)
login_as 'instructor6'
visit "/response/view2?id=#{review_id}&&team=#{team_id}&&round=1&&assignment=#{assignment_id}"
end
it "can go to review details" do

end
end
</pre>

=='''Team Information'''==
#[https://github.com/aranne/expertiza Forked Issue on Github]
#Weiran Fu (@ncsu.edu)
#Qingyan Wang (qwang20@ncsu.edu)
#Hongli Wang (hwang85@ncsu.edu)
#'''Mentor:''' Mohit Jain (mjain6@ncsu.edu)

=='''References'''==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://bit.ly/myexpertiza Demo link]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1966. Tabbed reviews partial file refactor for displaying the alternate view of reviews

2019-10-28T19:23:17Z

Hwang85:

== '''About Expertiza''' ==

Expertiza is a open source project currently for CSC517 instructor and students forming groups, submit work, review, and view grades. The project is based on Ruby on Rails framework and the code is on Github: https://github.com/expertiza/expertiza. Expertiza serves wiki page, collecting information of all internal information and updates of all versions.

== '''Problem Statement''' ==
===Issue details===

1) On student-end, Expertiza use grades/_reviews.html.erb partial to display reviewers, scores and review details; on instructor-end, it uses response controller and model to generate reviews page (the tables and charts are generated by grades/_team_statistics.html.erb (display reviewers and scores) in Statistics tab). We need to use the same kinds of partials in instructor-end and student-end, either _reviews partial or tabbed_reviews partial.

2) Give Feedback link at view_my_score at student-end should not appear at folded view.

===What to do===
1) We need to use the same kinds of partials in instructor-end and student-end.

2) Give Feedback link at view_my_score should appear at the bottom of expanded view.

== '''Solution''' ==
===Student End===

* In student end, add render partial to tabbed reviews.

'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10"><%= render :partial=>'grades/reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %></TD>
<TD COLSPAN="10"><%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %></TD>
</TR>
</pre>
* Add feed back link in student end view.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<% rounds.each do |round| %>
<h3>Round <%= round %></h3>
<a href="#" name= <%= participant.id.to_s + '_' + round.to_s + "Link" %> onClick="toggleElement('<%= participant.id.to_s +
'_' + round.to_s %>','round <%= round.to_s%> reviews');return false;">show round <%= round.to_s%> reviews</a>
<table class="table table-striped" id=<%= participant.id.to_s + '_' + round.to_s %> <%= style="display: none;" if controller.action_name != "view_my_scores"%>>
<% rscore[:assessments].select{|response| response.round == round}.reverse.uniq{|response| response.map_id}.sort_by{|response| response.map_id}.each_with_index do |review, index| %>
<tr><td>
<% review_feedback = nil %>
<%= display_directory_tree(@participant, files, true).html_safe %>
<% end %>
<% end %>
<%= review.display_as_html(prefix, index + 1, nil, true) %>

<% map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: participant.id).first
review_feedbacks = map.try :response %>
<% if review_feedbacks && !review_feedbacks.empty? %>
<%= link_to "View", :controller => 'response', :action => 'view', :id => review_feedbacks.first.id %> or
<%= link_to "Edit", :controller => 'response', :action => 'edit', :id => review_feedbacks.first.id, :return => "feedback" %> feedback for Review <%= count %>
<% else %>
<%= link_to "Give feedback", :controller => 'response', :action => 'new_feedback', :id => review.id %> for Review <%= count %>
<% end %>
</td></tr>
<% end %>
</table><hr>
</pre>

* Add javascript to tabbed review so it can be hidden or shown by clicking the show/hide reviews.

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<script type="text/javascript">
toggle_tag_prompt = function() {
$('.tag_prompt_container').toggle();
};
$( document ).ready(function() {
$('#tag_prompt_toggler').click(function () {
if ($('#tag_prompt_toggler').text() == "hide tags")
$('#tag_prompt_toggler').text("show tags")
else
$('#tag_prompt_toggler').text("hide tags")
});
});
</script>
</pre>

* Add statistic view to student end by using the team_review_statistics.html.erb file.
'''app/views/grades/_participant.html.erb '''
<pre>
<TR id="<%= prefix %>_reviews" style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/team_review_statistics', :locals => {:prefix => 'user', :participant => participant, :pscore => pscore} %>
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => participant, :rscore => pscore[:review]} %>
</TD>
</TR>
</pre>

'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% if @assignment.is_answer_tagging_allowed %>
<span class="spn_qsttog" id="tag_prompt_toggler" title="Click to display/hide tags" onclick="toggle_tag_prompt()">hide tags</span>
<% end %>
</pre>
'''app/views/grades/_team_review_statistics.html.erb'''
<pre>
<% if controller.action_name != "view_my_scores"%>
<tr>
<td colspan="10">
<% end %>

<% if rscore and rscore[:assessments].length > 0 %>
<%flag_varying_rubrics=false%>

@@ -25,6 +29,9 @@
<%if flag_varying_rubrics==false%>
<%= render :partial => 'grades/review_table', :locals => { :ctrl => 'review', :caction => 'view_review', :symbol => "review".to_sym, :prefix => prefix, :assignment => participant.assignment, :reviews => rscore[:assessments], :collabel => "Review", :rowlabel => "Reviewer" }%>
<%end%>
</td>
</tr>
<% end %>

<% if controller.action_name != "view_my_scores"%>
</td>
</tr>
<% end %>
</pre>
===Instructor End===

* Create new method view2 for response_controller

''' app/controllers/response_controller.rb '''
<pre>
def view2
@response = Response.find(params[:id])
@map = @response.map
set_content2
render "response/view"
end
......
......
@participant = @map.reviewer
......
def set_content2(new_response = false)
@contributor = @map.contributor
members = TeamsUser.where(team_id: params[:team])
@user = members.first
@participant = AssignmentParticipant.where(user_id: @user.user_id, parent_id: params[:assignment]).first
@@ -264,7 +273,9 @@ def set_content(new_response = false)
@questions = retrieve_questions questionnaires, @assignment.id
# @pscore has the newest versions of response for each response map, and only one for each response map (unless it is vary rubric by round)
@pscore = @participant.scores(@questions)
@reviewer = @map.reviewer
@round = params[:round]
end
</pre>

'''app/views/grades/_tabbed_reviews.html.erb '''
<pre>
<% prefix = nil %>
......
<% if controller.action_name == "view_my_scores"%>

<% map = FeedbackResponseMap.where(reviewed_object_id: review.id, reviewer_id: participant.id).first
review_feedbacks = map.try :response %>
<% if review_feedbacks && !review_feedbacks.empty? %>
<%= link_to "View", :controller => 'response', :action => 'view', :id => review_feedbacks.first.id %> or
<%= link_to "Edit", :controller => 'response', :action => 'edit', :id => review_feedbacks.first.id, :return => "feedback" %> feedback for Review <%= count %>
<% else %>
<%= link_to "Give feedback", :controller => 'response', :action => 'new_feedback', :id => review.id %> for Review <%= count %>
<% end %>
</td></tr>
<% end %>
<% end %>
</table><hr>
<% end %>
</pre>

''' app/views/grades/_view_heatgrid.html.erb '''
<pre>
<th class="sorter-false"> <a target="_blank" href="../response/view2?id=<%= review.id.to_s %>&&team=<%= @team.id %>&&round=<%= vm.round.to_s %>&&assignment=<%= @assignment.id %>"
data-toggle="tooltip" data-placement="right" title="Click to see details"><%= user_name.to_s %></a> </th>

</pre>

''' app/views/response/view.html.erb '''
<pre>
<% if controller.action_name != "view2" %>
<% file_url = nil %>
<%= @response.display_as_html(nil, nil, file_url) %>
<br/>
<% else %>
<TR style="display:none; background-color: white;">
<TD COLSPAN="10">
<%= render :partial=>'grades/tabbed_reviews', :locals => {:prefix => 'user', :participant => @participant, :rscore => @pscore[:review], :reviewer => @reviewer, :round => @round} %>
</TD>
</TR>
<% end %>
</pre>

* show right round for instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% next if round.to_s != @round.to_s %>
</pre>

* Create construct_instructor2_html in order to not show review number
''' app/models/response.rb '''
<pre>
if prefix == "instructor"
self_id = self.id.to_s
code = construct_instructor2_html identifier, self_id, count
elsif prefix # has prefix means view_score page in instructor end
self_id = prefix + '_' + self.id.to_s
code = construct_instructor_html identifier, self_id, count
......
def construct_instructor2_html identifier, self_id, count
identifier += '<table width="100%">'\
'<tr>'\
'<td align="left" width="70%"><b>Review ' + '</b>   '\
'<a href="#" name= "review_' + self_id + 'Link" onClick="toggleElement(' + "'review_" + self_id + "','review'" + ');return false;">hide review</a>'\
'</td>'\
'<td align="left"><b>Last Reviewed:</b>'\
"<span>#{(self.updated_at.nil? ? 'Not available' : self.updated_at.strftime('%A %B %d %Y, %I:%M%p'))}</span></td>"\
'</tr></table>'
end
</pre>

'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% if controller.action_name != "view2"%>
<h3>Round <%= round %></h3>
<% if controller.action_name != "view_my_scores" %>
<a href="#" name= <%= participant.id.to_s + '_' + round.to_s + "Link" %> onClick="toggleElement('<%= participant.id.to_s + '_' + round.to_s %>','round <%= round.to_s%> reviews');return false;">show round <%= round.to_s%> reviews</a>
<% end %>
<% end %>
<% if @assignment.is_answer_tagging_allowed %>
<span class="spn_qsttog" id="tag_prompt_toggler" title="Click to display/hide tags" onclick="toggle_tag_prompt()">hide tags</span>
@@ -37,6 +39,7 @@
<% review_feedback = nil %>
<% count = count + 1 %>
<% prefix = nil %>
<% prefix = "instructor" if controller.action_name == "view2" %>
</pre>

* Show just one review in instructor-end
'''app/views/grades/_tabbed_reviews.html.erb'''
<pre>
<% rounds.each do |round| %>
<% if controller.action_name == "view2"%>
<% next if round.to_s != @round.to_s %>
<% end %>
<% if controller.action_name != "view2"%>
<h3>Round <%= round %></h3>
<% if controller.action_name != "view_my_scores" %>
@@ -33,8 +35,13 @@
<% if @assignment.is_answer_tagging_allowed %>
<span class="spn_qsttog" id="tag_prompt_toggler" title="Click to display/hide tags" onclick="toggle_tag_prompt()">hide tags</span>
<% end %>
<% if controller.action_name != "view2"%>
<table class="table table-striped" id=<%= participant.id.to_s + '_' + round.to_s %> <%= style="display: none;" if controller.action_name != "view_my_scores"%>>
<% end %>
<% rscore[:assessments].select{|response| response.round == round}.reverse.uniq{|response| response.map_id}.sort_by{|response| response.map_id}.each_with_index do |review, index| %>
<% if controller.action_name == "view2"%>
<% next if review.reviewer != @reviewer || count > 0 %>
<% end %>
<tr><td>
<% review_feedback = nil %>
<% count = count + 1 %>
@@ -72,7 +79,9 @@
</td></tr>
<% end %>
<% end %>
<% if controller.action_name != "view2"%>
</table><hr>
<% end %>
<% end %>
<% else %>
</pre>

=='''Test files'''==

* what test done
::* how to do that

'''path to add '''

<pre>
test
</pre>

=='''Team Information'''==
#[https://github.com/aranne/expertiza Forked Issue on Github]
#Weiran Fu (@ncsu.edu)
#Qingyan Wang (qwang20@ncsu.edu)
#Hongli Wang (hwang85@ncsu.edu)
#'''Mentor:''' Mohit Jain (mjain6@ncsu.edu)

=='''References'''==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://bit.ly/myexpertiza Demo link]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1966. Tabbed reviews partial file refactor for displaying the alternate view of reviews

2019-10-28T17:28:12Z

Hwang85:

CSC/ECE 517 Fall 2019 - E1966. Tabbed reviews partial file refactor for displaying the alternate view of reviews

2019-10-27T20:39:23Z

Hwang85: