Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-24T03:27:03Z

Hhwang4: /* Testing Plan */

==E2020. Let course staff as well as students do reviews==

=='''Introduction'''==

===About Expertiza===
[http://expertiza.ncsu.edu/ Expertiza] is an open-source project that is built using the [http://rubyonrails.org/ Ruby on Rails] framework. At its core, it is a highly versatile tool that academic institutions can use to craft learning objectives centered around team projects, peer reviews, and highly-customizable assignments.

===Purpose and Problem===
The purpose of this project is to allow instructors or teaching assistants who are participants of an assignment to be able to review (before the last due date of the specific assignment) any team that has submitted the assignment. Beyond this general endeavor, there is also the condition that team members of the assignment should be able to view reviews done by the course staff that can be identified in an aesthetically pleasing manner. As an added feature, reviewers should see how their reviews differ from those done by the course staff.

There are two main issues:

1. Allow the instructor and teaching assistants to review teams that have submitted assignments.

2. Allow authors to visually identify reviews done by the course staff.

=='''Implementation Details'''==

===Problem 1: Allow the instructor and teaching assistants to review teams that have submitted assignments===
* Check will be done to verify whether the course staff is a participant. Staff can only review if they are a participant of the assignment.
* In the '''list_submissions.html.erb''' file, a "Perform Review" link is present if the final review due date of the assignment has not passed yet. If a review was already saved and the final review due date of the assignment has not passed, then a link to "Edit Review" will be present. If a review was already submitted and the due date has not passed, then a link to "View Review" will be present.
[[File:StaffPerformReview.jpg|center|The instructor/TA will see a "Perform Review" link if the final review due date has passed.]]
* Clicking on the "Perform Review", "Edit Review", and "View Review" links will take the instructor/TA to the pages governed by '''response_controller#new''', '''response_controller#edit''', and '''response_controller#view''' respectively.
* The already present "Assign Grade" link will only appear after the final review due date of the assignment has passed, if there are no review due dates, or if the user is not a participant of the assignment.
[[File:StaffAssignGrade.jpg|center|The instructor/TA will see a "Perform Review", "Edit Review", or "View Review" link if the final review due date has not passed.]]

* View changes
:app/views/assignments/list_submissions.html.erb
<% unless participants.empty? %>
<nowiki>
</nowiki> <% if not @assignment.find_due_dates('review').nil? %>
<nowiki></nowiki>
<% if Time.now > @assignment.find_due_dates('review').sort_by{|due_date| due_date.due_at}[-1].due_at or not @participant %>
<%= link_to 'Assign Grade', { controller: 'grades', action: 'view_team', id: participants.first.id}, target: '_blank' %>
<% else %>
<% review = @review_maps.select{|m| m.reviewee_id == team.id} %>
<nowiki></nowiki>
<% if review.size == 0 %>
<%= link_to 'Perform Review', {:controller => 'review_mapping', :action => 'add_staff_as_reviewer', :id => @assignment.id, :contributor_id => team.id, :user_id => current_user.id} %>
<% else %>
<% r = Response.where(["map_id IN (?)", review.last.id]).first %>
<% if r %>
<nowiki></nowiki>
<% if r.is_submitted %>
<%= link_to 'View Review', {:controller => 'response', :action => 'view', :id => r.id, :return => "instructor_review"} %>
<% else %>
<%= link_to 'Edit Review', {:controller => 'response', :action => 'edit', :id => r.id, :return => "instructor_review"} %>
<% end %>
<% end %>
<% end %>
<% end %>
<% else %>
<%= link_to 'Assign Grade', { controller: 'grades', action: 'view_team', id: participants.first.id}, target: '_blank' %>
<% end %>
<% end %>

* A method was added to review_mapping_controller.rb that creates a new ReviewResponseMap for an instructor, TA, or Admin for the assignment specified by the id in the params. This will be called when the staff user clicks "PerformReview". It will then redirect to '''response_controller#new'''.

:app/controllers/review_mapping_controller.rb
# Enable a staff user (Instructor, Teaching Assistant, Admin) to review all submissions for an assignment when they are a participant.
# Will redirect to the list_submissions view.
def add_staff_as_reviewer
assignment = Assignment.find(params[:id])
user = User.from_params(params)
# Get registration url for user in case the user is not a participant in the assignment.
regurl = url_for id: assignment.id,
user_id: user.id,
contributor_id: params[:contributor_id]
reviewer = get_reviewer(user, assignment, regurl)
# Create response map for the participant so they can begin review.
map = ReviewResponseMap.where(reviewee_id: params[:contributor_id], reviewer_id: reviewer.id, reviewed_object_id: assignment.id).first
if map.nil?
map = ReviewResponseMap.create(reviewee_id: params[:contributor_id], reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
end
redirect_to :controller => 'response', :action => 'new', :id => map.id, :contributor_id => params[:contributor_id], :return => "instructor_review"
end
* A check is now performed to determine if the current user is a participant in the assignment. If so, we'll check if they have any existing reviews.
:app/controllers/assignments_controller.rb
def list_submissions
@assignment = Assignment.find(params[:id])
@teams = Team.where(parent_id: params[:id])
@participant = AssignmentParticipant.where(user_id: current_user.id, parent_id: @assignment.id).first
# If the current user is not a participant in the assignment, they cannot review submissions.
if not @participant.nil?
@review_maps = ReviewResponseMap.where(reviewer_id: @participant.id, reviewed_object_id: @assignment.id)
else
@review_maps = []
end
end

===Problem 2: Allow authors to visually identify reviews done by the course staff===
* A star icon will be used to distinguish whether a review was done by a course staff and will appear below the 'Review #' heading.
* Add helper class grades_helper.rb to handle check to determine whether review was done by course staff based on the boolean flag attached to a response.
* Change will be made in view_team.html.erb such that after verifying that a response was done by a course staff via identity_helper.rb, a star is displayed below the 'Review #' heading.

'''Note:''' Previously, a review that was done by a course staff would not be visually recognizable by an author of the particular reviewed assignment. With the following changes, however, authors will be able to recognize reviews done under the "Summary Report for assignment" page, as reviews done by course staff will have a black star located immediately below the "Review #" header. A boolean check is done in the ''review_done_by_course_staff?'' method and used in ''view_team.html.erb'' to display a black star below a particular review if and only if ''review_done_by_course_staff?'' outputs true.

Changed files:
:app/helpers/grades_helper.rb
# used to determine whether a review was done by a course staff
# course staff is defined as an Instructor or Teaching Assistant
def review_done_by_course_staff?(review)
if review.nil?
false
else
role = Role.find(User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).role_id).name
role == ("Instructor" || "Teaching Assistant") ? true : false
end
end

:app/views/grades/view_team.html.erb
<pre style="color: black; border:1px;">


<% if (['Student'].include? @current_role_name) && (@assignment.is_anonymous) %>
<% review_name = "Review " + i.to_s %>
<% else %>
<% review_name = User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).fullname(session[:ip]).to_s %>
<% end %>
<th class="sorter-false"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= review_name %></a>
<% if review_done_by_course_staff?(review) %>
 
<% end %>
</pre>

Pull request can be found 
[https://github.com/epeden/expertiza/pull/15?file-filters%5B%5D= here]

* A staff user (Instructor, TA, Admin) will see the star for reviews done by another staff member as well as the names of all the reviewers.
[[File:InstructorReviews.png]]
* A student will still see the star for reviews done by a staff member but all names are anonymous.
[[File:StudentReviews.png]]

===All Modified Files===
*app/controllers/assignments_controller.rb
*app/controllers/response_controller.rb
*app/controllers/review_mapping_controller.rb
*app/helpers/grades_helper.rb
*app/views/assignments/list_submissions.html.erb
*app/views/grades/view_team.html.erb
*app/views/response/response.html.erb
*config/routes.rb

=='''Flow Chart'''==
This flow chart demonstrates the desired functionality. While students must submit reviews in the review stage, instructors/TA's can submit reviews any time before the final deadline. In order to submit reviews, the instructor/TA must be added as a participant to the assignment. Then, they will go to "View Submissions" on the Manage Assignments page. If the final deadline for the assignment has passed, they will see an "Assign Grade" link next to each submission. Otherwise, they will see a "Perform Review" link if a review has not been submitted yet or an "Edit Review" link if a review has been submitted already. Students can view only the reviews they have performed and the reviews of their work, while instructors/TA's can see all reviews for the assignment. Reviews done by course staff will be marked with a star to distinguish them from students' reviews.

[[File:Flow chart.png]]

=='''Database Design'''==
This diagram represents the relationship between different models involved with our proposed solution. We do not anticipate any changes to the database schema.

A model that's central to our proposed solution is the AssignmentQuestionnaire model defined in assignment_questionnaire.rb. It holds the user ID of the User (user.rb) who reviewed the assignment, from which we will determine the user's role: Instructor, TA, or student. It also contains the ID of the Assignment (assignment.rb) being reviewed. Additionally, the Questionnaire (questionnaire.rb) can be located by its ID defined in AssignmentQuestionnaire and consists of the Questions (question.rb) users use to review the assignment.

[[File:Model2picture.png ]]

=='''Testing Plan'''==

'''Testing from the UI'''
* Manual UI verification of our added features can be found in the demo video in the Resources section. These cases are included:

* An "Assign Grade" link is visible in the submissions list if the instructor is not a participant. Instructor can be added as participant
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click on the icon to view submissions.
# An "Assign Grade" link should be visible for the submissions.
# Navigate back to the test assignment and click the icon to add participants.
# Add the instructor as a participant on the assignment.
# Click on the icon to view submissions. A "Perform Review" link should be present for the submissions.

* Instructor should be able to add a review on an assignment if they are a participant and the review deadline has not passed.
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click on the Edit icon. Click on Due Dates and confirm the review due date has not passed.
# Click on the View Submissions icon.
# Verify a list of submissions appears. The “Perform review” link should be visible.
# Click on the “Perform review” link.
# Verify submitted work for team is visible.
# Complete review and click save.

* When an author view their reviews, reviews done by instructors should present a star.
# After logging in as the student, go to Assignments.
# Click on the test assignment
# Click "Your scores"
# If a review was done by an instructor, verify the star is present.

'''Automated Testing with RSpec'''

Comprehensive RSpec tests were added for all controller and model classes that we changed as well as automated UI tests for features we added. Test cases include:
* Verify that instructors can be added as participants for assignments.
* Verify that assignment reviews can be submitted by users with an Instructor, TA, or Student role assigned.
* Verify if a instructor is not a participant, an "Assign Grade" is visible.
* Verify if an assignment's deadline is passed and the instructor is a participant, an "Assign Grade" is visible.
* Verify if an assignment's deadline is not passed and the instructor is a participant, a "Perform Review" link is visible.
* Verify if a review has already been submitted by an instructor, a new ReviewResponseMap will not be created for the instructor when they load the list_submissions view.
* Verify a star icon appears next to only reviews done by instructors/TAs in the responses view. This should be visible to both staff and students.

Modified RSpec test files:
*spec/controllers/assignments_controller_spec.rb
*spec/controllers/review_mapping_controller_spec.rb
*spec/features/assignment_list_submissions_spec.rb
*spec/helpers/grades_helper_spec.rb

===Problem 1: Allow the instructor and teaching assistants to review teams that have submitted assignments===

===Problem 2: Allow authors to visually identify reviews done by the course staff===
UI Testing
<ol>
<li> Login as an instructor
<ul>
<li>Username: instructor6</li>
<li>Password: password</li>
</ul>
<li> As this test is an extension of the one conducted in Part 1, impersonate the student who the instructor performed a review for. Go to Manage -> Impersonate User and enter the student's user name.
<li> Now impersonated as the chosen student, go to Assignments -> Project_Name -> Your Scores.
<li> Yous should now be in the "Summary Report for assignment" page. Below whichever review that the instructor submitted, there will be a black star.
</ol>

[[File:Ui_test_part_2.png]]

RSpec Testing

'''Note:''' Additional tests were created for methods in the same grades_helper helper class that were not written by this team in order to abide by the philosophy that you should always leave code in a better position that they were originally.

:spec/helpers/grades_helper_spec.rb

describe 'has_team_and_metareview' do
before(:each) do
@assignment = create(:assignment, max_team_size: 1)
end
it 'should correctly identify the assignment from an assignment id' do
params[:id] = @assignment.id
result = Assignment.find(params[:id])
expect(result).to eq(@assignment)
end
it 'should correctly identify the assignment from a participant id' do
participant = create(:participant, assignment: @assignment)
params[:id] = participant.id
result = Participant.find(params[:id]).parent_id
expect(result).to eq(@assignment.id)
end
it 'should return 0 for an assignment without a team or a metareview deadline after a view action' do
params[:action] = 'view'
params[:id] = @assignment.id
result = has_team_and_metareview?
expect(result).to be == {has_team: false, has_metareview: false, true_num: 0}
end
it 'should return 1 for an assignment with a team but no metareview deadline after a view action' do
@assignment.max_team_size = 2
@assignment.save
params[:action] = 'view'
params[:id] = @assignment.id
result = has_team_and_metareview?
expect(result).to be == {has_team: true, has_metareview: false, true_num: 1}
end
end

describe 'type_and_max' do
it 'should fail when passing in nil row value' do
expect { type_and_max(nil) }.to raise_exception(NoMethodError)
end
end

describe 'underlined' do
it 'should fail when passing in nil score value' do
expect { underlined?(nil) }.to raise_exception(NoMethodError)
end
end

describe 'retrieve_questions' do
it 'should fail when passing in nil values for questionnaires and assignment_id' do
expect { retrieve_questions(nil,nil) }.to raise_exception(NoMethodError)
end
end

describe 'review_done_by_course_staff' do
it 'should return false' do
expect(review_done_by_course_staff?(nil)).to eq(false)
end
end

===Code Coverage===
Coverage increased (+11.01%) to 41.493%

=='''Team Information'''==
Danielle Hancock

Eric Peden

Hosung Hwang

Mentor: Abhirav Kariya

=='''Resources'''==
Forked Repo: https://github.com/epeden/expertiza

Expertiza Pull Request: https://github.com/expertiza/expertiza/pull/1729

Demo Video: https://youtu.be/mDsc5n1NZ9E

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-24T03:23:47Z

Hhwang4: /* Problem 2: Allow authors to visually identify reviews done by the course staff */

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-24T03:22:58Z

Hhwang4: /* Problem 2: Allow authors to visually identify reviews done by the course staff */

==E2020. Let course staff as well as students do reviews==

=='''Introduction'''==

===About Expertiza===
[http://expertiza.ncsu.edu/ Expertiza] is an open-source project that is built using the [http://rubyonrails.org/ Ruby on Rails] framework. At its core, it is a highly versatile tool that academic institutions can use to craft learning objectives centered around team projects, peer reviews, and highly-customizable assignments.

===Purpose and Problem===
The purpose of this project is to allow instructors or teaching assistants who are participants of an assignment to be able to review (before the last due date of the specific assignment) any team that has submitted the assignment. Beyond this general endeavor, there is also the condition that team members of the assignment should be able to view reviews done by the course staff that can be identified in an aesthetically pleasing manner. As an added feature, reviewers should see how their reviews differ from those done by the course staff.

There are two main issues:

1. Allow the instructor and teaching assistants to review teams that have submitted assignments.

2. Allow authors to visually identify reviews done by the course staff.

=='''Implementation Details'''==

===Problem 1: Allow the instructor and teaching assistants to review teams that have submitted assignments===
* Check will be done to verify whether the course staff is a participant. Staff can only review if they are a participant of the assignment.
* In the '''list_submissions.html.erb''' file, a "Perform Review" link is present if the final review due date of the assignment has not passed yet. If a review was already saved and the final review due date of the assignment has not passed, then a link to "Edit Review" will be present. If a review was already submitted and the due date has not passed, then a link to "View Review" will be present.
[[File:StaffPerformReview.jpg|center|The instructor/TA will see a "Perform Review" link if the final review due date has passed.]]
* Clicking on the "Perform Review", "Edit Review", and "View Review" links will take the instructor/TA to the pages governed by '''response_controller#new''', '''response_controller#edit''', and '''response_controller#view''' respectively.
* The already present "Assign Grade" link will only appear after the final review due date of the assignment has passed, if there are no review due dates, or if the user is not a participant of the assignment.
[[File:StaffAssignGrade.jpg|center|The instructor/TA will see a "Perform Review", "Edit Review", or "View Review" link if the final review due date has not passed.]]

* View changes
:app/views/assignments/list_submissions.html.erb
<% unless participants.empty? %>
<nowiki>
</nowiki> <% if not @assignment.find_due_dates('review').nil? %>
<nowiki></nowiki>
<% if Time.now > @assignment.find_due_dates('review').sort_by{|due_date| due_date.due_at}[-1].due_at or not @participant %>
<%= link_to 'Assign Grade', { controller: 'grades', action: 'view_team', id: participants.first.id}, target: '_blank' %>
<% else %>
<% review = @review_maps.select{|m| m.reviewee_id == team.id} %>
<nowiki></nowiki>
<% if review.size == 0 %>
<%= link_to 'Perform Review', {:controller => 'review_mapping', :action => 'add_staff_as_reviewer', :id => @assignment.id, :contributor_id => team.id, :user_id => current_user.id} %>
<% else %>
<% r = Response.where(["map_id IN (?)", review.last.id]).first %>
<% if r %>
<nowiki></nowiki>
<% if r.is_submitted %>
<%= link_to 'View Review', {:controller => 'response', :action => 'view', :id => r.id, :return => "instructor_review"} %>
<% else %>
<%= link_to 'Edit Review', {:controller => 'response', :action => 'edit', :id => r.id, :return => "instructor_review"} %>
<% end %>
<% end %>
<% end %>
<% end %>
<% else %>
<%= link_to 'Assign Grade', { controller: 'grades', action: 'view_team', id: participants.first.id}, target: '_blank' %>
<% end %>
<% end %>

* A method was added to review_mapping_controller.rb that creates a new ReviewResponseMap for an instructor, TA, or Admin for the assignment specified by the id in the params. This will be called when the staff user clicks "PerformReview". It will then redirect to '''response_controller#new'''.

:app/controllers/review_mapping_controller.rb
# Enable a staff user (Instructor, Teaching Assistant, Admin) to review all submissions for an assignment when they are a participant.
# Will redirect to the list_submissions view.
def add_staff_as_reviewer
assignment = Assignment.find(params[:id])
user = User.from_params(params)
# Get registration url for user in case the user is not a participant in the assignment.
regurl = url_for id: assignment.id,
user_id: user.id,
contributor_id: params[:contributor_id]
reviewer = get_reviewer(user, assignment, regurl)
# Create response map for the participant so they can begin review.
map = ReviewResponseMap.where(reviewee_id: params[:contributor_id], reviewer_id: reviewer.id, reviewed_object_id: assignment.id).first
if map.nil?
map = ReviewResponseMap.create(reviewee_id: params[:contributor_id], reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
end
redirect_to :controller => 'response', :action => 'new', :id => map.id, :contributor_id => params[:contributor_id], :return => "instructor_review"
end
* A check is now performed to determine if the current user is a participant in the assignment. If so, we'll check if they have any existing reviews.
:app/controllers/assignments_controller.rb
def list_submissions
@assignment = Assignment.find(params[:id])
@teams = Team.where(parent_id: params[:id])
@participant = AssignmentParticipant.where(user_id: current_user.id, parent_id: @assignment.id).first
# If the current user is not a participant in the assignment, they cannot review submissions.
if not @participant.nil?
@review_maps = ReviewResponseMap.where(reviewer_id: @participant.id, reviewed_object_id: @assignment.id)
else
@review_maps = []
end
end

===Problem 2: Allow authors to visually identify reviews done by the course staff===
* A star icon will be used to distinguish whether a review was done by a course staff and will appear below the 'Review #' heading.
* Add helper class grades_helper.rb to handle check to determine whether review was done by course staff based on the boolean flag attached to a response.
* Change will be made in view_team.html.erb such that after verifying that a response was done by a course staff via identity_helper.rb, a star is displayed below the 'Review #' heading.

'''Note:''' Previously, a review that was done by a course staff would not be visually recognizable by an author of the particular reviewed assignment. With the following changes, however, authors will be able to recognize reviews done under the "Summary Report for assignment" page, as reviews done by course staff will have a black star located immediately below the "Review #" header. A boolean check is done in the ''review_done_by_course_staff?'' method and used in ''view_team.html.erb'' to display a black star below a particular review if and only if ''review_done_by_course_staff?'' outputs true.

Changed files:
:app/helpers/grades_helper.rb
# used to determine whether a review was done by a course staff
# course staff is defined as an Instructor or Teaching Assistant
def review_done_by_course_staff?(review)
if review.nil?
false
else
role = Role.find(User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).role_id).name
role == ("Instructor" || "Teaching Assistant") ? true : false
end
end

:app/views/grades/view_team.html.erb
<pre style="color: black; border:1px;">


<% if (['Student'].include? @current_role_name) && (@assignment.is_anonymous) %>
<% review_name = "Review " + i.to_s %>
<% else %>
<% review_name = User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).fullname(session[:ip]).to_s %>
<% end %>
<th class="sorter-false"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= review_name %></a>
<% if review_done_by_course_staff?(review) %>
 
<% end %>
</pre>

Pull request can be found 
[https://github.com/epeden/expertiza/pull/15?file-filters%5B%5D= here]

[[File:InstructorReviews.png]]
[[File:StudentReviews.png]]

===All Modified Files===
*app/controllers/assignments_controller.rb
*app/controllers/response_controller.rb
*app/controllers/review_mapping_controller.rb
*app/helpers/grades_helper.rb
*app/views/assignments/list_submissions.html.erb
*app/views/grades/view_team.html.erb
*app/views/response/response.html.erb
*config/routes.rb

=='''Flow Chart'''==
This flow chart demonstrates the desired functionality. While students must submit reviews in the review stage, instructors/TA's can submit reviews any time before the final deadline. In order to submit reviews, the instructor/TA must be added as a participant to the assignment. Then, they will go to "View Submissions" on the Manage Assignments page. If the final deadline for the assignment has passed, they will see an "Assign Grade" link next to each submission. Otherwise, they will see a "Perform Review" link if a review has not been submitted yet or an "Edit Review" link if a review has been submitted already. Students can view only the reviews they have performed and the reviews of their work, while instructors/TA's can see all reviews for the assignment. Reviews done by course staff will be marked with a star to distinguish them from students' reviews.

[[File:Flow chart.png]]

=='''Database Design'''==
This diagram represents the relationship between different models involved with our proposed solution. We do not anticipate any changes to the database schema.

A model that's central to our proposed solution is the AssignmentQuestionnaire model defined in assignment_questionnaire.rb. It holds the user ID of the User (user.rb) who reviewed the assignment, from which we will determine the user's role: Instructor, TA, or student. It also contains the ID of the Assignment (assignment.rb) being reviewed. Additionally, the Questionnaire (questionnaire.rb) can be located by its ID defined in AssignmentQuestionnaire and consists of the Questions (question.rb) users use to review the assignment.

[[File:Model2picture.png ]]

=='''Testing Plan'''==

'''Testing from the UI'''
* Manual UI verification of our added features can be found in the demo video in the Resources section. These cases are included:

* An "Assign Grade" link is visible in the submissions list if the instructor is not a participant. Instructor can be added as participant
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click on the icon to view submissions.
# An "Assign Grade" link should be visible for the submissions.
# Navigate back to the test assignment and click the icon to add participants.
# Add the instructor as a participant on the assignment.
# Click on the icon to view submissions. A "Perform Review" link should be present for the submissions.

* Instructor should be able to add a review on an assignment if they are a participant and the review deadline has not passed.
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click on the Edit icon. Click on Due Dates and confirm the review due date has not passed.
# Click on the View Submissions icon.
# Verify a list of submissions appears. The “Perform review” link should be visible.
# Click on the “Perform review” link.
# Verify submitted work for team is visible.
# Complete review and click save.

* When an author view their reviews, reviews done by instructors should present a star.
# After logging in as the student, go to Assignments.
# Click on the test assignment
# Click "Your scores"
# If a review was done by an instructor, verify the star is present.

'''Automated Testing with RSpec'''

Comprehensive RSpec tests were added for all controller and model classes that we changed as well as automated UI tests for features we added. Test cases include:
* Verify that instructors can be added as participants for assignments.
* Verify that assignment reviews can be submitted by users with an Instructor, TA, or Student role assigned.
* Verify if a instructor is not a participant, an "Assign Grade" is visible.
* Verify if an assignment's deadline is passed and the instructor is a participant, an "Assign Grade" is visible.
* Verify if an assignment's deadline is not passed and the instructor is a participant, a "Perform Review" link is visible.
* Verify if a review has already been submitted by an instructor, a new ReviewResponseMap will not be created for the instructor when they load the list_submissions view.
* Verify a star icon appears next to only reviews done by instructors/TAs in the responses view. This should be visible to both staff and students.

Modified RSpec test files:
*spec/controllers/assignments_controller_spec.rb
*spec/controllers/review_mapping_controller_spec.rb
*spec/features/assignment_list_submissions_spec.rb
*spec/helpers/grades_helper_spec.rb

===Problem 1: Allow the instructor and teaching assistants to review teams that have submitted assignments===

===Problem 2: Allow authors to visually identify reviews done by the course staff===
UI Testing
<ol>
<li> Login as an instructor
<ul>
<li>Username: instructor6</li>
<li>Password: password</li>
</ul>
<li> As this test is an extension of the one conducted in Part 1, impersonate the student who the instructor performed a review for. Go to Manage -> Impersonate User and enter the student's user name.
<li> Now impersonated as the chosen student, go to Assignments -> Project_Name -> Your Scores.
<li> Yous should now be in the "Summary Report for assignment" page. Below whichever review that the instructor submitted, there will be a black star.
</ol>

[[File:Ui_test_part_2.png]]

RSpec Testing

'''Note:''' Tests were created for methods in the same grades_helper helper class that were not written by the team in order to abide by the philosophy that you should always leave code in a better position that they were originally.

:spec/helpers/grades_helper_spec.rb

describe 'has_team_and_metareview' do
before(:each) do
@assignment = create(:assignment, max_team_size: 1)
end
it 'should correctly identify the assignment from an assignment id' do
params[:id] = @assignment.id
result = Assignment.find(params[:id])
expect(result).to eq(@assignment)
end
it 'should correctly identify the assignment from a participant id' do
participant = create(:participant, assignment: @assignment)
params[:id] = participant.id
result = Participant.find(params[:id]).parent_id
expect(result).to eq(@assignment.id)
end
it 'should return 0 for an assignment without a team or a metareview deadline after a view action' do
params[:action] = 'view'
params[:id] = @assignment.id
result = has_team_and_metareview?
expect(result).to be == {has_team: false, has_metareview: false, true_num: 0}
end
it 'should return 1 for an assignment with a team but no metareview deadline after a view action' do
@assignment.max_team_size = 2
@assignment.save
params[:action] = 'view'
params[:id] = @assignment.id
result = has_team_and_metareview?
expect(result).to be == {has_team: true, has_metareview: false, true_num: 1}
end
end

describe 'type_and_max' do
it 'should fail when passing in nil row value' do
expect { type_and_max(nil) }.to raise_exception(NoMethodError)
end
end

describe 'underlined' do
it 'should fail when passing in nil score value' do
expect { underlined?(nil) }.to raise_exception(NoMethodError)
end
end

describe 'retrieve_questions' do
it 'should fail when passing in nil values for questionnaires and assignment_id' do
expect { retrieve_questions(nil,nil) }.to raise_exception(NoMethodError)
end
end

describe 'review_done_by_course_staff' do
it 'should return false' do
expect(review_done_by_course_staff?(nil)).to eq(false)
end
end

===Code Coverage===
Coverage increased (+11.01%) to 41.493%

=='''Team Information'''==
Danielle Hancock

Eric Peden

Hosung Hwang

Mentor: Abhirav Kariya

=='''Resources'''==
Forked Repo: https://github.com/epeden/expertiza

Expertiza Pull Request: https://github.com/expertiza/expertiza/pull/1729

Demo Video: https://youtu.be/mDsc5n1NZ9E

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-24T03:13:32Z

Hhwang4:

==E2020. Let course staff as well as students do reviews==

=='''Introduction'''==

===About Expertiza===
[http://expertiza.ncsu.edu/ Expertiza] is an open-source project that is built using the [http://rubyonrails.org/ Ruby on Rails] framework. At its core, it is a highly versatile tool that academic institutions can use to craft learning objectives centered around team projects, peer reviews, and highly-customizable assignments.

===Purpose and Problem===
The purpose of this project is to allow instructors or teaching assistants who are participants of an assignment to be able to review (before the last due date of the specific assignment) any team that has submitted the assignment. Beyond this general endeavor, there is also the condition that team members of the assignment should be able to view reviews done by the course staff that can be identified in an aesthetically pleasing manner. As an added feature, reviewers should see how their reviews differ from those done by the course staff.

There are two main issues:

1. Allow the instructor and teaching assistants to review teams that have submitted assignments.

2. Allow authors to visually identify reviews done by the course staff.

=='''Implementation Details'''==

===Problem 1: Allow the instructor and teaching assistants to review teams that have submitted assignments===
* Check will be done to verify whether the course staff is a participant. Staff can only review if they are a participant of the assignment.
* In the '''list_submissions.html.erb''' file, a "Perform Review" link is present if the final review due date of the assignment has not passed yet. If a review was already saved and the final review due date of the assignment has not passed, then a link to "Edit Review" will be present. If a review was already submitted and the due date has not passed, then a link to "View Review" will be present.
[[File:StaffPerformReview.jpg|center|The instructor/TA will see a "Perform Review" link if the final review due date has passed.]]
* Clicking on the "Perform Review", "Edit Review", and "View Review" links will take the instructor/TA to the pages governed by '''response_controller#new''', '''response_controller#edit''', and '''response_controller#view''' respectively.
* The already present "Assign Grade" link will only appear after the final review due date of the assignment has passed, if there are no review due dates, or if the user is not a participant of the assignment.
[[File:StaffAssignGrade.jpg|center|The instructor/TA will see a "Perform Review", "Edit Review", or "View Review" link if the final review due date has not passed.]]

* View changes
:app/views/assignments/list_submissions.html.erb
<% unless participants.empty? %>

<% if not @assignment.find_due_dates('review').nil? %>

<% if Time.now > @assignment.find_due_dates('review').sort_by{|due_date| due_date.due_at}[-1].due_at or not @participant %>
<%= link_to 'Assign Grade', { controller: 'grades', action: 'view_team', id: participants.first.id}, target: '_blank' %>
<% else %>
<% review = @review_maps.select{|m| m.reviewee_id == team.id} %>

<% if review.size == 0 %>
<%= link_to 'Perform Review', {:controller => 'review_mapping', :action => 'add_staff_as_reviewer', :id => @assignment.id, :contributor_id => team.id, :user_id => current_user.id} %>
<% else %>
<% r = Response.where(["map_id IN (?)", review.last.id]).first %>
<% if r %>

<% if r.is_submitted %>
<%= link_to 'View Review', {:controller => 'response', :action => 'view', :id => r.id, :return => "instructor_review"} %>
<% else %>
<%= link_to 'Edit Review', {:controller => 'response', :action => 'edit', :id => r.id, :return => "instructor_review"} %>
<% end %>
<% end %>
<% end %>
<% end %>
<% else %>
<%= link_to 'Assign Grade', { controller: 'grades', action: 'view_team', id: participants.first.id}, target: '_blank' %>
<% end %>
<% end %>

* A method was added to review_mapping_controller.rb that creates a new ReviewResponseMap for an instructor, TA, or Admin for the assignment specified by the id in the params. This will be called when the staff user clicks "PerformReview". It will then redirect to '''response_controller#new'''.

:app/controllers/review_mapping_controller.rb
# Enable a staff user (Instructor, Teaching Assistant, Admin) to review all submissions for an assignment when they are a participant.
# Will redirect to the list_submissions view.
def add_staff_as_reviewer
assignment = Assignment.find(params[:id])
user = User.from_params(params)
# Get registration url for user in case the user is not a participant in the assignment.
regurl = url_for id: assignment.id,
user_id: user.id,
contributor_id: params[:contributor_id]
reviewer = get_reviewer(user, assignment, regurl)
# Create response map for the participant so they can begin review.
map = ReviewResponseMap.where(reviewee_id: params[:contributor_id], reviewer_id: reviewer.id, reviewed_object_id: assignment.id).first
if map.nil?
map = ReviewResponseMap.create(reviewee_id: params[:contributor_id], reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
end
redirect_to :controller => 'response', :action => 'new', :id => map.id, :contributor_id => params[:contributor_id], :return => "instructor_review"
end
* A check is now performed to determine if the current user is a participant in the assignment. If so, we'll check if they have any existing reviews.
:app/controllers/assignments_controller.rb
def list_submissions
@assignment = Assignment.find(params[:id])
@teams = Team.where(parent_id: params[:id])
@participant = AssignmentParticipant.where(user_id: current_user.id, parent_id: @assignment.id).first
# If the current user is not a participant in the assignment, they cannot review submissions.
if not @participant.nil?
@review_maps = ReviewResponseMap.where(reviewer_id: @participant.id, reviewed_object_id: @assignment.id)
else
@review_maps = []
end
end

===Problem 2: Allow authors to visually identify reviews done by the course staff===
* A star icon will be used to distinguish whether a review was done by a course staff and will appear below the 'Review #' heading.
* Add helper class grades_helper.rb to handle check to determine whether review was done by course staff based on the boolean flag attached to a response.
* Change will be made in view_team.html.erb such that after verifying that a response was done by a course staff via identity_helper.rb, a star is displayed below the 'Review #' heading.

'''Note:''' Previously, a review that was done by a course staff would not be visually recognizable by an author of the particular reviewed assignment. With the following changes, however, authors will be able to recognize reviews done under the "Summary Report for assignment" page, as reviews done by course staff will have a black star located immediately below the "Review #" header. A boolean check is done in the ''review_done_by_course_staff?'' method and used in ''view_team.html.erb'' to display a black star below a particular review if and only if ''review_done_by_course_staff?'' outputs true.

Changed files:
:app/helpers/grades_helper.rb
# used to determine whether a review was done by a course staff
# course staff is defined as an Instructor or Teaching Assistant
def review_done_by_course_staff?(review)
if review.nil?
false
else
role = Role.find(User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).role_id).name
role == ("Instructor" || "Teaching Assistant") ? true : false
end
end

:app/views/grades/view_team.html.erb
<pre style="color: black; border:1px;">


<% if (['Student'].include? @current_role_name) && (@assignment.is_anonymous) %>
<% review_name = "Review " + i.to_s %>
<% else %>
<% review_name = User.find(Participant.find(ResponseMap.find(Response.find(review.id).map_id).reviewer_id).user_id).fullname(session[:ip]).to_s %>
<% end %>
<th class="sorter-false"> <a target="_blank" href="../response/view?id=<%= review.id.to_s %>" data-toggle="tooltip" data-placement="right" title="Click to see details"><%= review_name %></a>
<% if review_done_by_course_staff?(review) %>
 
<% end %>
</pre>

Pull request can be found 
[https://github.com/epeden/expertiza/pull/15?file-filters%5B%5D= here]

[[File:InstructorReviews.png]]
[[File:StudentReviews.png]]

===All Modified Files===
*app/controllers/assignments_controller.rb
*app/controllers/response_controller.rb
*app/controllers/review_mapping_controller.rb
*app/helpers/grades_helper.rb
*app/views/assignments/list_submissions.html.erb
*app/views/grades/view_team.html.erb
*app/views/response/response.html.erb
*config/routes.rb

=='''Flow Chart'''==
This flow chart demonstrates the desired functionality. While students must submit reviews in the review stage, instructors/TA's can submit reviews any time before the final deadline. In order to submit reviews, the instructor/TA must be added as a participant to the assignment. Then, they will go to "View Submissions" on the Manage Assignments page. If the final deadline for the assignment has passed, they will see an "Assign Grade" link next to each submission. Otherwise, they will see a "Perform Review" link if a review has not been submitted yet or an "Edit Review" link if a review has been submitted already. Students can view only the reviews they have performed and the reviews of their work, while instructors/TA's can see all reviews for the assignment. Reviews done by course staff will be marked with a star to distinguish them from students' reviews.

[[File:Flow chart.png]]

=='''Database Design'''==
This diagram represents the relationship between different models involved with our proposed solution. We do not anticipate any changes to the database schema.

A model that's central to our proposed solution is the AssignmentQuestionnaire model defined in assignment_questionnaire.rb. It holds the user ID of the User (user.rb) who reviewed the assignment, from which we will determine the user's role: Instructor, TA, or student. It also contains the ID of the Assignment (assignment.rb) being reviewed. Additionally, the Questionnaire (questionnaire.rb) can be located by its ID defined in AssignmentQuestionnaire and consists of the Questions (question.rb) users use to review the assignment.

[[File:Model2picture.png ]]

=='''Testing Plan'''==

'''Testing from the UI'''

* Add an instructor as a participant in the assignment.
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click the icon to add participants.
# Add the instructor as a participant on the assignment.

* Instructor should be able to add a review on an assignment.
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click on the View Submissions icon.
# Verify a list of submissions appears.
# If the last due date for the assignment has not passed, the “Perform review” link should be visible.
# Click on the “Perform review” link.
# Verify submitted work for team is visible.
# Complete review and click save.

* When an author view their reviews, reviews done by instructors should present a star.
# After logging in as the student, go to Assignments.
# Click on the test assignment
# Click "Your scores"
# If a review was done by an instructor, verify the star is present.

'''Automated Testing with RSpec'''

Comprehensive RSpec tests were added for all controller and model classes that we changed as well as automated UI tests for features we added. Some of the planned test cases include:
* Verify that instructors can be added as participants for assignments.
* Verify that assignment reviews can be submitted by users with an Instructor, TA, or Student role assigned.
* Verify if an assignment's deadline is passed, instructors can see a "Assign Grade" link to assign a grade.
* Verify if an assignment's deadline has not passed, instructors can see a "Perform Review" link to review work if they are a participant.
* Verify a star icon appears next to only reviews done by instructors/TAs in the responses view.

===Problem 1: Allow the instructor and teaching assistants to review teams that have submitted assignments===

===Problem 2: Allow authors to visually identify reviews done by the course staff===
UI Testing
<ol>
<li> Login as an instructor
<ul>
<li>Username: instructor6</li>
<li>Password: password</li>
</ul>
<li> As this test is an extension of the one conducted in Part 1, impersonate the student who the instructor performed a review for. Go to Manage -> Impersonate User and enter the student's user name.
<li> Now impersonated as the chosen student, go to Assignments -> Project_Name -> Your Scores.
<li> Yous should now be in the "Summary Report for assignment" page. Below whichever review that the instructor submitted, there will be a black star.
[[File:Ui_test_part_2.png]]

</ol>

===Code Coverage===
Coverage increased (+11.01%) to 41.493%

=='''Team Information'''==
Danielle Hancock

Eric Peden

Hosung Hwang

Mentor: Abhirav Kariya

=='''Resources'''==
Forked Repo: https://github.com/epeden/expertiza

Expertiza Pull Request: https://github.com/expertiza/expertiza/pull/1729

Demo Video: https://youtu.be/mDsc5n1NZ9E

File:Ui test part 2.png

2020-04-24T03:12:42Z

Hhwang4:

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-24T02:47:16Z

Hhwang4:

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-24T02:46:38Z

Hhwang4:

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-24T02:45:26Z

Hhwang4:

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-24T02:30:28Z

Hhwang4: /* Testing Plan */

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-24T02:28:38Z

Hhwang4: /* Implementation Details */

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-24T02:09:23Z

Hhwang4: /* Problem 2: Allow authors to visually identify reviews done by the course staff */

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-24T02:01:54Z

Hhwang4: /* Problem 2: Allow authors to visually identify reviews done by the course staff */

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-24T02:00:53Z

Hhwang4: /* Implementation Details */

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-24T00:52:57Z

Hhwang4:

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-24T00:43:45Z

Hhwang4: /* Introduction */

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-22T23:19:31Z

Hhwang4: /* Design */

==E2020. Let course staff as well as students do reviews==

=='''Introduction'''==

===Purpose and Problem===
The purpose of this project is to allow instructors or teaching assistants who are participants of an assignment to be able to review (before the last due date of the specific assignment) any team that has submitted the assignment. Beyond this general endeavor, there is also the condition that team members of the assignment should be able to view reviews done by the course staff that can be identified in an aesthetically pleasing manner. As an added feature, reviewers should see how their reviews differ from those done by the course staff.

There are two main issues (and a third as an '''extra feature'''):

1. Allow the instructor and teaching assistants to review teams that have submitted assignments.

2. Allow authors to visually identify reviews done by the course staff.

3. Allow the reviewers to see how their reviews differ from those done by the course staff.

=='''Design'''==

===Proposed Solution===

'''Problem 1:'''
* Check will be done to verify whether the course staff is a participant.
* In the list_submissions.html.erb file, have a "Perform Review" link present if the due date of the assignment has not passed yet.
* If a review was already reviewed and the due date of the assignment has not passed, then a link to "Edit Review" will be present.
* The already present "Assign Grade" link will only appear after the due date of the assignment has passed.
* Clicking on the "Perform Review" or "Edit Review" links will take the instructor/TA to the pages governed by response_controller#new and response_controller#edit, respectively.
* A flag will be placed on the responses done by the course staff.

'''Problem 2:'''
* A star icon will be used to distinguish whether a review was done by a course staff and will appear below the 'Review #' heading.
* Add helper class grades_helper.rb to handle check to determine whether review was done by course staff based on the boolean flag attached to a response.
* Change will be made in view_team.html.erb such that after verifying that a response was done by a course staff via identity_helper.rb, a star is displayed below the 'Review #' heading.

'''Problem 3:'''
* Add the ''Criterion'' review type by expanding the current conditional statements targeting ''Checkbox'' to include ''Criterion'' in show_calibration_results_for_student.html.erb.

===Relevant Files===
*views/assignments/list_submissions.html.erb
*views/reports/calibration_report.html.erb
*views/response/show_calibration_results_for_student.html.erb
*views/response/response.html.erb
*views/grades/view_team.html.erb
*views/grades/view_my_scores.html.erb
*controllers/response_controller.rb
*app/helpers/grades_helper.rb

=='''Flow Chart'''==
This flow chart demonstrates the desired functionality. While students must submit reviews in the review stage, instructors/TA's can submit reviews any time before the final deadline. In order to submit reviews, the instructor/TA must be added as a participant to the assignment. Then, they will go to "View Submissions" on the Manage Assignments page. If the final deadline for the assignment has passed, they will see an "Assign Grade" link next to each submission. Otherwise, they will see a "Perform Review" link if a review has not been submitted yet or an "Edit Review" link if a review has been submitted already. Students can view only the reviews they have performed and the reviews of their work, while instructors/TA's can see all reviews for the assignment. Reviews done by course staff will be marked with a star to distinguish them from students' reviews.

[[File:Flow chart.png]]

=='''Database Design'''==
This diagram represents the relationship between different models involved with our proposed solution. We do not anticipate any changes to the database schema.

A model that's central to our proposed solution is the AssignmentQuestionnaire model defined in assignment_questionnaire.rb. It holds the user ID of the User (user.rb) who reviewed the assignment, from which we will determine the user's role: Instructor, TA, or student. It also contains the ID of the Assignment (assignment.rb) being reviewed. Additionally, the Questionnaire (questionnaire.rb) can be located by its ID defined in AssignmentQuestionnaire and consists of the Questions (question.rb) users use to review the assignment.

[[File:Model2picture.png ]]

=='''Testing Plan'''==

'''Testing from the UI'''

* Add an instructor as a participant in the assignment.
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click the icon to add participants.
# Add the instructor as a participant on the assignment.

* Instructor should be able to add a review on an assignment.
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click on the View Submissions icon.
# Verify a list of submissions appears.
# If the last due date for the assignment has not passed, the “Perform review” link should be visible.
# Click on the “Perform review” link.
# Verify submitted work for team is visible.
# Complete review and click save.

* When an author view their reviews, reviews done by instructors should present a star.
# After logging in as the student, go to Assignments.
# Click on the test assignment
# Click "Your scores"
# If a review was done by an instructor, verify the star is present.

'''Automated Testing with RSpec'''

We plan on adding comprehensive RSpec tests for all controller and model classes that we change as well as automated UI tests for features we added. Some of the planned test cases include:
* Verify that instructors can be added as participants for assignments.
* Verify that assignment reviews can be submitted by users with an Instructor, TA, or Student role assigned.
* Verify if an assignment's deadline is passed, instructors can see a "Assign Grade" link to assign a grade.
* Verify if an assignment's deadline has not passed, instructors can see a "Perform Review" link to review work if they are a participant.
* Verify a star icon appears next to only reviews done by instructors/TAs in the responses view.

=='''Team Information'''==
Danielle Hancock

Eric Peden

Hosung Hwang

Mentor: Abhirav Kariya

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-13T22:57:57Z

Hhwang4: /* Design */

==E2020. Let course staff as well as students do reviews==

=='''Introduction'''==

===Purpose and Problem===
The purpose of this project is to allow instructors or teaching assistants who are participants of an assignment to be able to review (before the last due date of the specific assignment) any team that has submitted the assignment. Beyond this general endeavor, there is also the condition that team members of the assignment should be able to view reviews done by the course staff that can be identified in an aesthetically pleasing manner. As an added feature, reviewers should see how their reviews differ from those done by the course staff.

There are two main issues (and a third as an '''extra feature'''):

1. Allow the instructor and teaching assistants to review teams that have submitted assignments.

2. Allow authors to visually identify reviews done by the course staff.

3. Allow the reviewers to see how their reviews differ from those done by the course staff.

=='''Design'''==

===Proposed Solution===

'''Problem 1:'''
* Check will be done to verify whether the course staff is a participant.
* In the list_submissions.html.erb file, have a "Perform Review" link present if the due date of the assignment has not passed yet.
* If a review was already reviewed and the due date of the assignment has not passed, then a link to "Edit Review" will be present.
* The already present "Assign Grade" link will only appear after the due date of the assignment has passed.
* Clicking on the "Perform Review" or "Edit Review" links will take the instructor/TA to the pages governed by response_controller#new and response_controller#edit, respectively.
* A flag will be placed on the responses done by the course staff.

'''Problem 2:'''
* A star icon will be used to distinguish whether a review was done by a course staff and will appear below the 'Review #' heading.
* Add helper class identity_helper.rb to handle check to determine whether review was done by course staff based on the boolean flag attached to a response.
* Change will be made in view_team.html.erb such that after verifying that a response was done by a course staff via identity_helper.rb, a star is displayed below the 'Review #' heading.

'''Problem 3:'''
* Add the ''Criterion'' review type by expanding the current conditional statements targeting ''Checkbox'' to include ''Criterion'' in show_calibration_results_for_student.html.erb.

===Relevant Files===
*views/assignments/list_submissions.html.erb
*views/reports/calibration_report.html.erb
*views/response/show_calibration_results_for_student.html.erb
*views/response/response.html.erb
*views/grades/view_team.html.erb
*views/grades/view_my_scores.html.erb
*controllers/response_controller.rb
*app/helpers/identity_helper.rb

=='''Flow Chart'''==
This flow chart demonstrates the desired functionality. While students must submit reviews in the review stage, instructors/TA's can submit reviews any time before the final deadline. In order to submit reviews, the instructor/TA must be added as a participant to the assignment. Then, they will go to "View Submissions" on the Manage Assignments page. If the final deadline for the assignment has passed, they will see an "Assign Grade" link next to each submission. Otherwise, they will see a "Perform Review" link if a review has not been submitted yet or an "Edit Review" link if a review has been submitted already. Students can view only the reviews they have performed and the reviews of their work, while instructors/TA's can see all reviews for the assignment. Reviews done by course staff will be marked with a star to distinguish them from students' reviews.

[[File:Flow chart.png]]

=='''Database Design'''==
This diagram shows the relevant tables in the existing database. We do not anticipate any changes to the database design.

[[File:Model2picture.png ]]

=='''Testing Plan'''==

'''Testing from the UI'''

* Add an instructor as a participant in the assignment.
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click the icon to add participants.
# Add the instructor as a participant on the assignment.

* Instructor should be able to add a review on an assignment.
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click on the View Submissions icon.
# Verify a list of submissions appears.
# If the last due date for the assignment has not passed, the “Perform review” link should be visible.
# Click on the “Perform review” link.
# Verify submitted work for team is visible.
# Complete review and click save.

* When an author view their reviews, reviews done by instructors should present a star.
# After logging in as the student, go to Assignments.
# Click on the test assignment
# Click "Your scores"
# If a review was done by an instructor, verify the star is present.

'''Automated Testing with RSpec'''

We plan on adding comprehensive RSpec tests for all controller and model classes that we changed as well automated UI tests for features we added.

=='''Team Information'''==
Danielle Hancock

Eric Peden

Hosung Hwang

Mentor: Abhirav Kariya

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-13T22:55:14Z

Hhwang4: /* Design */

==E2020. Let course staff as well as students do reviews==

=='''Introduction'''==

===Purpose and Problem===
The purpose of this project is to allow instructors or teaching assistants who are participants of an assignment to be able to review (before the last due date of the specific assignment) any team that has submitted the assignment. Beyond this general endeavor, there is also the condition that team members of the assignment should be able to view reviews done by the course staff that can be identified in an aesthetically pleasing manner. As an added feature, reviewers should see how their reviews differ from those done by the course staff.

There are two main issues (and a third as an '''extra feature'''):

1. Allow the instructor and teaching assistants to review teams that have submitted assignments.

2. Allow authors to visually identify reviews done by the course staff.

3. Allow the reviewers to see how their reviews differ from those done by the course staff.

=='''Design'''==

===Proposed Solution===

'''Problem 1:'''
* Check will be done to verify whether the course staff is a participant.
* In the list_submissions.html.erb file, have a "Perform Review" link present if the due date of the assignment has not passed yet.
* If a review was already reviewed and the due date of the assignment has not passed, then a link to "Edit Review" will be present.
* The already present "Assign Grade" link will only appear after the due date of the assignment has passed.
* Clicking on the "Perform Review" or "Edit Review" links will take the instructor/TA to the pages governed by response_controller#new and response_controller#edit, respectively.
* A flag will be placed on the responses done by the course staff.

'''Problem 2:'''
* A star icon will be used to distinguish whether a review was done by a course staff and will appear below the 'Review #' heading.
* Addition of helper class identity_helper.rb to handle check to determine whether review was done by course staff based on the boolean flag attached to a response.
* Change will be made in view_team.html.erb such that after verifying that a response was done by a course staff via identity_helper.rb, a star is displayed below the 'Review #' heading.

'''Problem 3:'''
* Add the ''Criterion'' review type by expanding the current conditional statements targeting ''Checkbox'' to include ''Criterion'' in show_calibration_results_for_student.html.erb.

===Relevant Files===
*views/assignments/list_submissions.html.erb
*views/reports/calibration_report.html.erb
*views/response/show_calibration_results_for_student.html.erb
*views/response/response.html.erb
*views/grades/view_team.html.erb
*views/grades/view_my_scores.html.erb
*controllers/response_controller.rb
*app/helpers/identity_helper.rb

=='''Flow Chart'''==
This flow chart demonstrates the desired functionality. While students must submit reviews in the review stage, instructors/TA's can submit reviews any time before the final deadline. In order to submit reviews, the instructor/TA must be added as a participant to the assignment. Then, they will go to "View Submissions" on the Manage Assignments page. If the final deadline for the assignment has passed, they will see an "Assign Grade" link next to each submission. Otherwise, they will see a "Perform Review" link if a review has not been submitted yet or an "Edit Review" link if a review has been submitted already. Students can view only the reviews they have performed and the reviews of their work, while instructors/TA's can see all reviews for the assignment. Reviews done by course staff will be marked with a star to distinguish them from students' reviews.

[[File:Flow chart.png]]

=='''Database Design'''==
This diagram shows the relevant tables in the existing database. We do not anticipate any changes to the database design.

[[File:Model2picture.png ]]

=='''Testing Plan'''==

'''Testing from the UI'''

* Add an instructor as a participant in the assignment.
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click the icon to add participants.
# Add the instructor as a participant on the assignment.

* Instructor should be able to add a review on an assignment.
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click on the View Submissions icon.
# Verify a list of submissions appears.
# If the last due date for the assignment has not passed, the “Perform review” link should be visible.
# Click on the “Perform review” link.
# Verify submitted work for team is visible.
# Complete review and click save.

* When an author view their reviews, reviews done by instructors should present a star.
# After logging in as the student, go to Assignments.
# Click on the test assignment
# Click "Your scores"
# If a review was done by an instructor, verify the star is present.

'''Automated Testing with RSpec'''

We plan on adding comprehensive RSpec tests for all controller and model classes that we changed as well automated UI tests for features we added.

=='''Team Information'''==
Danielle Hancock

Eric Peden

Hosung Hwang

Mentor: Abhirav Kariya

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-13T22:18:27Z

Hhwang4: /* Design */

==E2020. Let course staff as well as students do reviews==

=='''Introduction'''==

===Purpose and Problem===
The purpose of this project is to allow instructors or teaching assistants who are participants of an assignment to be able to review (before the last due date of the specific assignment) any team that has submitted the assignment. Beyond this general endeavor, there is also the condition that team members of the assignment should be able to view reviews done by the course staff that can be identified in an aesthetically pleasing manner. As an added feature, reviewers should see how their reviews differ from those done by the course staff.

There are two main issues (and a third as an '''extra feature'''):

1. Allow the instructor and teaching assistants to review teams that have submitted assignments.

2. Allow authors to visually identify reviews done by the course staff.

3. Allow the reviewers to see how their reviews differ from those done by the course staff.

=='''Design'''==

===Proposed Solution===

'''Problem 1:'''
* Check will be done to verify whether the course staff is a participant.
* In the list_submissions.html.erb file, have a "Perform Review" link present if the due date of the assignment has not passed yet.
* If a review was already reviewed and the due date of the assignment has not passed, then a link to "Edit Review" will be present.
* The already present "Assign Grade" link will only appear after the due date of the assignment has passed.
* Clicking on the "Perform Review" or "Edit Review" links will take the instructor/TA to the pages governed by response_controller#new and response_controller#edit, respectively.
* A flag will be placed on the responses done by the course staff.

'''Problem 2:'''
* A star icon will be used to distinguish whether a review was done by a course staff and will appear below the 'Review #' heading.
* Addition of helper class identity_helper.rb to handle check to determine whether review was done by course staff based on the boolean flag attached to a response.
* Change needs to be made in view_team.html.erb such that after verifying that a response was done by a course staff via identity_helper.rb, a star is displayed below the 'Review #' heading.

'''Problem 3:'''
* As course staff cannot currently review assignments, verification of the extent of functionality for the already existing show_calibration_results_for_student.html.erb needs to be done once the feature for course staff is implemented fully.

===Relevant Files===
*views/assignments/list_submissions.html.erb
*views/reports/calibration_report.html.erb
*views/response/show_calibration_results_for_student.html.erb
*views/response/response.html.erb
*views/grades/view_team.html.erb
*views/grades/view_my_scores.html.erb
*controllers/response_controller.rb
*app/helpers/identity_helper.rb

=='''Flow Chart'''==
This flow chart demonstrates the desired functionality. While students must submit reviews in the review stage, instructors/TA's can submit reviews any time before the final deadline. In order to submit reviews, the instructor/TA must be added as a participant to the assignment. Then, they will go to "View Submissions" on the Manage Assignments page. If the final deadline for the assignment has passed, they will see an "Assign Grade" link next to each submission. Otherwise, they will see a "Perform Review" link if a review has not been submitted yet or an "Edit Review" link if a review has been submitted already. Students can view only the reviews they have performed and the reviews of their work, while instructors/TA's can see all reviews for the assignment. Reviews done by course staff will be marked with a star to distinguish them from students' reviews.

[[File:Flow chart.png]]

=='''Database Design'''==
This diagram shows the relevant tables in the existing database. We do not anticipate any changes to the database design.

[[File:Model2picture.png ]]

=='''Testing Plan'''==

'''Testing from the UI'''

* Add an instructor as a participant in the assignment.
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click the icon to add participants.
# Add the instructor as a participant on the assignment.

* Instructor should be able to add a review on an assignment.
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click on the View Submissions icon.
# Verify a list of submissions appears.
# If the last due date for the assignment has not passed, the “Perform review” link should be visible.
# Click on the “Perform review” link.
# Verify submitted work for team is visible.
# Complete review and click save.

* When an author view their reviews, reviews done by instructors should present a star.
# After logging in as the student, go to Assignments.
# Click on the test assignment
# Click "Your scores"
# If a review was done by an instructor, verify the star is present.

'''Automated Testing with RSpec'''

We plan on adding comprehensive RSpec tests for all controller and model classes that we changed as well automated UI tests for features we added.

=='''Team Information'''==
Danielle Hancock

Eric Peden

Hosung Hwang

Mentor: Abhirav Kariya

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-13T22:07:52Z

Hhwang4: /* Design */

==E2020. Let course staff as well as students do reviews==

=='''Introduction'''==

===Purpose and Problem===
The purpose of this project is to allow instructors or teaching assistants who are participants of an assignment to be able to review (before the last due date of the specific assignment) any team that has submitted the assignment. Beyond this general endeavor, there is also the condition that team members of the assignment should be able to view reviews done by the course staff that can be identified in an aesthetically pleasing manner. As an added feature, reviewers should see how their reviews differ from those done by the course staff.

There are two main issues (and a third as an '''extra feature'''):

1. Allow the instructor and teaching assistants to review teams that have submitted assignments.

2. Allow authors to visually identify reviews done by the course staff.

3. Allow the reviewers to see how their reviews differ from those done by the course staff.

=='''Design'''==

===Proposed Solution===

'''Problem 1:'''
* Check should be done to verify whether the course staff is a participant.
* In the list_submissions.html.erb file, have a "Perform Review" link present if the due date of the assignment has not passed yet.
* If a review was already reviewed and the due date of the assignment has not passed, then a link to "Edit Review" should be present.
* The already present "Assign Grade" link should only appear after the due date of the assignment has passed.
* Clicking on the "Perform Review" or "Edit Review" links should take the instructor/TA to the pages governed by response_controller#new and response_controller#edit, respectively.
* A flag should be placed on the responses done by the course staff.

'''Problem 2:'''
* A star icon will be used to distinguish whether a review was done by a course staff and will appear below the 'Review #' heading.
* Addition of helper class identity_helper.rb to handle check to determine whether review was done by course staff based on the boolean flag attached to a response.
* Change needs to be made in view_team.html.erb such that after verifying that a response was done by a course staff via identity_helper.rb, a star is displayed below the 'Review #' heading.

'''Problem 3:'''
* As course staff cannot currently review assignments, verification of the extent of functionality for the already existing show_calibration_results_for_student.html.erb needs to be done once the feature for course staff is implemented fully.

===Relevant Files===
*views/assignments/list_submissions.html.erb
*views/reports/calibration_report.html.erb
*views/response/show_calibration_results_for_student.html.erb
*views/response/response.html.erb
*views/grades/view_team.html.erb
*views/grades/view_my_scores.html.erb
*controllers/response_controller.rb
*app/helpers/identity_helper.rb

=='''Flow Chart'''==
This flow chart demonstrates the desired functionality. While students must submit reviews in the review stage, instructors/TA's can submit reviews any time before the final deadline. In order to submit reviews, the instructor/TA must be added as a participant to the assignment. Then, they will go to "View Submissions" on the Manage Assignments page. If the final deadline for the assignment has passed, they will see an "Assign Grade" link next to each submission. Otherwise, they will see a "Perform Review" link if a review has not been submitted yet or an "Edit Review" link if a review has been submitted already. Students can view only the reviews they have performed and the reviews of their work, while instructors/TA's can see all reviews for the assignment. Reviews done by course staff will be marked with a star to distinguish them from students' reviews.

[[File:Flow chart.png]]

=='''Database Design'''==
This diagram shows the relevant tables in the existing database. We do not anticipate any changes to the database design.

[[File:Model2picture.png ]]

=='''Testing Plan'''==

'''Testing from the UI'''

* Add an instructor as a participant in the assignment.
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click the icon to add participants.
# Add the instructor as a participant on the assignment.

* Instructor should be able to add a review on an assignment.
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click on the View Submissions icon.
# Verify a list of submissions appears.
# If the last due date for the assignment has not passed, the “Perform review” link should be visible.
# Click on the “Perform review” link.
# Verify submitted work for team is visible.
# Complete review and click save.

* When an author view their reviews, reviews done by instructors should present a star.
# After logging in as the student, go to Assignments.
# Click on the test assignment
# Click "Your scores"
# If a review was done by an instructor, verify the star is present.

'''Automated Testing with RSpec'''

We plan on adding comprehensive RSpec tests for all controller and model classes that we changed as well automated UI tests for features we added.

=='''Team Information'''==
Danielle Hancock

Eric Peden

Hosung Hwang

Mentor: Abhirav Kariya

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-13T22:05:44Z

Hhwang4: /* Proposed Solution */

==E2020. Let course staff as well as students do reviews==

=='''Introduction'''==

===Purpose and Problem===
The purpose of this project is to allow instructors or teaching assistants who are participants of an assignment to be able to review (before the last due date of the specific assignment) any team that has submitted the assignment. Beyond this general endeavor, there is also the condition that team members of the assignment should be able to view reviews done by the course staff that can be identified in an aesthetically pleasing manner. As an added feature, reviewers should see how their reviews differ from those done by the course staff.

There are two main issues (and a third as an '''extra feature'''):

1. Allow the instructor and teaching assistants to review teams that have submitted assignments.

2. Allow authors to visually identify reviews done by the course staff.

3. Allow the reviewers to see how their reviews differ from those done by the course staff.

=='''Design'''==

===Proposed Solution===

'''Problem 1:'''
* Check should be done to verify whether the course staff is a participant.
* In the list_submissions.html.erb file, have a "Perform Review" link present if the due date of the assignment has not passed yet.
* If a review was already reviewed and the due date of the assignment has not passed, then a link to "Edit Review" should be present.
* The already present "Assign Grade" link should only appear after the due date of the assignment has passed.
* Clicking on the "Perform Review" or "Edit Review" links should take the instructor/TA to the pages governed by response_controller#new and response_controller#edit, respectively.
* A flag should be placed on the responses done by the course staff.

'''Problem 2:'''
* A star icon will be used to distinguish whether a review was done by a course staff and will appear below the 'Review #' heading.
* Addition of helper class identity_helper.rb to handle check to determine whether review was done by course staff based on the boolean flag attached to a response.
* Change needs to be made in view_team.html.erb such that after verifying that a response was done by a course staff via identity_helper.rb, a star is displayed below the 'Review #' heading.

'''Problem 3:'''
* As course staff cannot currently review assignments, verification of the extent of functionality for the already existing show_calibration_results_for_student.html.erb needs to be done once the feature for course staff is implemented fully.

===Relevant Files===
*views/assignments/list_submissions.html.erb
*views/reports/calibration_report.html.erb
*views/response/response.html.erb
*views/grades/view_team.html.erb
*views/grades/view_my_scores.html.erb
*controllers/response_controller.rb

=='''Flow Chart'''==
This flow chart demonstrates the desired functionality. While students must submit reviews in the review stage, instructors/TA's can submit reviews any time before the final deadline. In order to submit reviews, the instructor/TA must be added as a participant to the assignment. Then, they will go to "View Submissions" on the Manage Assignments page. If the final deadline for the assignment has passed, they will see an "Assign Grade" link next to each submission. Otherwise, they will see a "Perform Review" link if a review has not been submitted yet or an "Edit Review" link if a review has been submitted already. Students can view only the reviews they have performed and the reviews of their work, while instructors/TA's can see all reviews for the assignment. Reviews done by course staff will be marked with a star to distinguish them from students' reviews.

[[File:Flow chart.png]]

=='''Database Design'''==
This diagram shows the relevant tables in the existing database. We do not anticipate any changes to the database design.

[[File:Model2picture.png ]]

=='''Testing Plan'''==

'''Testing from the UI'''

* Add an instructor as a participant in the assignment.
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click the icon to add participants.
# Add the instructor as a participant on the assignment.

* Instructor should be able to add a review on an assignment.
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click on the View Submissions icon.
# Verify a list of submissions appears.
# If the last due date for the assignment has not passed, the “Perform review” link should be visible.
# Click on the “Perform review” link.
# Verify submitted work for team is visible.
# Complete review and click save.

* When an author view their reviews, reviews done by instructors should present a star.
# After logging in as the student, go to Assignments.
# Click on the test assignment
# Click "Your scores"
# If a review was done by an instructor, verify the star is present.

'''Automated Testing with RSpec'''

We plan on adding comprehensive RSpec tests for all controller and model classes that we changed as well automated UI tests for features we added.

=='''Team Information'''==
Danielle Hancock

Eric Peden

Hosung Hwang

Mentor: Abhirav Kariya

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-08T20:07:41Z

Hhwang4: /* Flow Chart */

==E2020. Let course staff as well as students do reviews==

=='''Introduction'''==

===Purpose and Problem===
The purpose of this project is to allow instructors or teaching assistants who are participants of an assignment to be able to review (before the last due date of the specific assignment) any team that has submitted the assignment. Beyond this general endeavor, there is also the condition that team members of the assignment should be able to view reviews done by the course staff that can be identified in an aesthetically pleasing manner. As an added feature, reviewers should see how their reviews differ from those done by the course staff.

There are two main issues (and a third as an '''extra feature'''):

1. Allow the instructor and teaching assistants to review teams that have submitted assignments.

2. Allow authors to visually identify reviews done by the course staff.

3. Allow the reviewers to see how their reviews differ from those done by the course staff.

=='''Design'''==

===Proposed Solution===

'''Problem 1:'''
* Check should be done to verify whether the course staff is a participant.
* In the list_submissions.html.erb file, have a "Perform Review" link present if the due date of the assignment has not passed yet.
* If a review was already reviewed and the due date of the assignment has not passed, then a link to "Edit Review" should be present.
* The already present "Assign Grade" link should only appear after the due date of the assignment has passed.
* Clicking on the "Perform Review" or "Edit Review" links should take the instructor/TA to the pages governed by response_controller#new and response_controller#edit, respectively.
* A flag should be placed on the response done by the course staff.

'''Problem 2:'''
* A star icon will be used to distinguish whether a review was done by a course staff and will appear below the 'Review #' heading.
* Change needs to be made in view_team.html.erb such that after verifying that a response is flagged as done by a course staff, a star is displayed below the 'Review #' heading.

'''Problem 3:'''
* As course staff cannot currently review assignments, verification of the extent of functionality for show_calibration_results_for_student.html.erb needs to be done once the feature for course staff is implemented fully.

===Relevant Files===
*views/assignments/list_submissions.html.erb
*views/reports/calibration_report.html.erb
*views/response/response.html.erb
*views/grades/view_team.html.erb
*views/grades/view_my_scores.html.erb
*controllers/response_controller.rb

=='''Flow Chart'''==
This flow chart demonstrates the desired functionality. While students must submit reviews in the review stage, instructors/TA's can submit reviews any time before the final deadline. In order to submit reviews, the instructor/TA must be added as a participant to the assignment. Then, they will go to "View Submissions" on the Manage Assignments page. If the final deadline for the assignment has passed, they will see an "Assign Grade" link next to each submission. Otherwise, they will see a "Perform Review" link if a review has not been submitted yet or an "Edit Review" link if a review has been submitted already. Students can view only the reviews they have performed and the reviews of their work, while instructors/TA's can see all reviews for the assignment. Reviews done by course staff will be marked with a star to distinguish them from students' reviews.

[[File:Flow chart.png]]

=='''Database Design'''==
This diagram shows the relevant tables in the existing database. We do not anticipate any changes to the database design.

[[File:Model2picture.png ]]

=='''Testing Plan'''==

'''Testing from the UI'''

* Add an instructor as a participant in the assignment.
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click the icon to add participants.
# Add the instructor as a participant on the assignment.

* Instructor should be able to add a review on an assignment.
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click on the View Submissions icon.
# Verify a list of submissions appears.
# If the last due date for the assignment has not passed, the “Perform review” link should be visible.
# Click on the “Perform review” link.
# Verify submitted work for team is visible.
# Complete review and click save.

* When an author view their reviews, reviews done by instructors should present a star.
# After logging in as the student, go to Assignments.
# Click on the test assignment
# Click "Your scores"
# If a review was done by an instructor, verify the star is present.

'''Automated Testing with RSpec'''

We plan on adding comprehensive RSpec tests for all controller and model classes that we changed as well automated UI tests for features we added.

=='''Team Information'''==
Danielle Hancock

Eric Peden

Hosung Hwang

Mentor: Abhirav Kariya

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-08T20:07:12Z

Hhwang4: /* Design */

==E2020. Let course staff as well as students do reviews==

=='''Introduction'''==

===Purpose and Problem===
The purpose of this project is to allow instructors or teaching assistants who are participants of an assignment to be able to review (before the last due date of the specific assignment) any team that has submitted the assignment. Beyond this general endeavor, there is also the condition that team members of the assignment should be able to view reviews done by the course staff that can be identified in an aesthetically pleasing manner. As an added feature, reviewers should see how their reviews differ from those done by the course staff.

There are two main issues (and a third as an '''extra feature'''):

1. Allow the instructor and teaching assistants to review teams that have submitted assignments.

2. Allow authors to visually identify reviews done by the course staff.

3. Allow the reviewers to see how their reviews differ from those done by the course staff.

=='''Design'''==

===Proposed Solution===

'''Problem 1:'''
* Check should be done to verify whether the course staff is a participant.
* In the list_submissions.html.erb file, have a "Perform Review" link present if the due date of the assignment has not passed yet.
* If a review was already reviewed and the due date of the assignment has not passed, then a link to "Edit Review" should be present.
* The already present "Assign Grade" link should only appear after the due date of the assignment has passed.
* Clicking on the "Perform Review" or "Edit Review" links should take the instructor/TA to the pages governed by response_controller#new and response_controller#edit, respectively.
* A flag should be placed on the response done by the course staff.

'''Problem 2:'''
* A star icon will be used to distinguish whether a review was done by a course staff and will appear below the 'Review #' heading.
* Change needs to be made in view_team.html.erb such that after verifying that a response is flagged as done by a course staff, a star is displayed below the 'Review #' heading.

'''Problem 3:'''
* As course staff cannot currently review assignments, verification of the extent of functionality for show_calibration_results_for_student.html.erb needs to be done once the feature for course staff is implemented fully.

===Relevant Files===
*views/assignments/list_submissions.html.erb
*views/reports/calibration_report.html.erb
*views/response/response.html.erb
*views/grades/view_team.html.erb
*views/grades/view_my_scores.html.erb
*controllers/response_controller.rb

=='''Flow Chart'''==
This flow chart demonstrates the desired functionality. While students must submit reviews in the review stage, instructors/TA's can submit reviews any time before the final deadline. In order to submit reviews, the instructor/TA must be added as a participant to the assignment. Then, they will go to "View Submissions" on the Manage Assignments page. If the final deadline for the assignment has passed, they will see an "Assign Grade" link next to each submission. Otherwise, they will see a "Perform Review" link if a review has not been submitted yet or an "Edit Review" link if a review. Students can view only the reviews they have performed and the reviews of their work, while instructors/TA's can see all reviews for the assignment. Reviews done by course staff will be marked with a star to distinguish them from students' reviews.

[[File:Flow chart.png]]

=='''Database Design'''==
This diagram shows the relevant tables in the existing database. We do not anticipate any changes to the database design.

[[File:Model2picture.png ]]

=='''Testing Plan'''==

'''Testing from the UI'''

* Add an instructor as a participant in the assignment.
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click the icon to add participants.
# Add the instructor as a participant on the assignment.

* Instructor should be able to add a review on an assignment.
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click on the View Submissions icon.
# Verify a list of submissions appears.
# If the last due date for the assignment has not passed, the “Perform review” link should be visible.
# Click on the “Perform review” link.
# Verify submitted work for team is visible.
# Complete review and click save.

* When an author view their reviews, reviews done by instructors should present a star.
# After logging in as the student, go to Assignments.
# Click on the test assignment
# Click "Your scores"
# If a review was done by an instructor, verify the star is present.

'''Automated Testing with RSpec'''

We plan on adding comprehensive RSpec tests for all controller and model classes that we changed as well automated UI tests for features we added.

=='''Team Information'''==
Danielle Hancock

Eric Peden

Hosung Hwang

Mentor: Abhirav Kariya

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-08T20:06:39Z

Hhwang4: /* Flow Chart */

==E2020. Let course staff as well as students do reviews==

=='''Introduction'''==

===Purpose and Problem===
The purpose of this project is to allow instructors or teaching assistants who are participants of an assignment to be able to review (before the last due date of the specific assignment) any team that has submitted the assignment. Beyond this general endeavor, there is also the condition that team members of the assignment should be able to view reviews done by the course staff that can be identified in an aesthetically pleasing manner. As an added feature, reviewers should see how their reviews differ from those done by the course staff.

There are two main issues (and a third as an '''extra feature'''):

1. Allow the instructor and teaching assistants to review teams that have submitted assignments.

2. Allow authors to visually identify reviews done by the course staff.

3. Allow the reviewers to see how their reviews differ from those done by the course staff.

=='''Design'''==

===Proposed Solution===

'''Problem 1:'''
* Check should be done to verify whether the course staff is a participant.
* In the list_submissions.html.erb file, have a "Perform Review" link present if the due date of the assignment has not passed yet.
* If a review was already reviewed and the due date of the assignment has not passed, then a link to "Edit Review" should be present.
* The already present "Assign Grade" link should only appear after the due date of the assignment has passed.
* Clicking on the "Perform Review" or "Edit Reviews" links should take the instructor/TA to the pages governed by response_controller#new and response_controller#edit, respectively.
* A flag should be placed on the response done by the course staff.

'''Problem 2:'''
* A star icon will be used to distinguish whether a review was done by a course staff and will appear below the 'Review #' heading.
* Change needs to be made in view_team.html.erb such that after verifying that a response is flagged as done by a course staff, a star is displayed below the 'Review #' heading.

'''Problem 3:'''
* As course staff cannot currently review assignments, verification of the extent of functionality for show_calibration_results_for_student.html.erb needs to be done once the feature for course staff is implemented fully.

===Relevant Files===
*views/assignments/list_submissions.html.erb
*views/reports/calibration_report.html.erb
*views/response/response.html.erb
*views/grades/view_team.html.erb
*views/grades/view_my_scores.html.erb
*controllers/response_controller.rb

=='''Flow Chart'''==
This flow chart demonstrates the desired functionality. While students must submit reviews in the review stage, instructors/TA's can submit reviews any time before the final deadline. In order to submit reviews, the instructor/TA must be added as a participant to the assignment. Then, they will go to "View Submissions" on the Manage Assignments page. If the final deadline for the assignment has passed, they will see an "Assign Grade" link next to each submission. Otherwise, they will see a "Perform Review" link if a review has not been submitted yet or an "Edit Review" link if a review. Students can view only the reviews they have performed and the reviews of their work, while instructors/TA's can see all reviews for the assignment. Reviews done by course staff will be marked with a star to distinguish them from students' reviews.

[[File:Flow chart.png]]

=='''Database Design'''==
This diagram shows the relevant tables in the existing database. We do not anticipate any changes to the database design.

[[File:Model2picture.png ]]

=='''Testing Plan'''==

'''Testing from the UI'''

* Add an instructor as a participant in the assignment.
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click the icon to add participants.
# Add the instructor as a participant on the assignment.

* Instructor should be able to add a review on an assignment.
# After logging in as the instructor, go to Manage > Assignments.
# Find the test assignment and click on the View Submissions icon.
# Verify a list of submissions appears.
# If the last due date for the assignment has not passed, the “Perform review” link should be visible.
# Click on the “Perform review” link.
# Verify submitted work for team is visible.
# Complete review and click save.

* When an author view their reviews, reviews done by instructors should present a star.
# After logging in as the student, go to Assignments.
# Click on the test assignment
# Click "Your scores"
# If a review was done by an instructor, verify the star is present.

'''Automated Testing with RSpec'''

We plan on adding comprehensive RSpec tests for all controller and model classes that we changed as well automated UI tests for features we added.

=='''Team Information'''==
Danielle Hancock

Eric Peden

Hosung Hwang

Mentor: Abhirav Kariya

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-07T22:01:19Z

Hhwang4: /* Proposed Solution */

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-07T21:58:29Z

Hhwang4:

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-07T21:56:25Z

Hhwang4:

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-07T21:55:17Z

Hhwang4:

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-07T21:50:35Z

Hhwang4:

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-07T21:45:17Z

Hhwang4: /* Proposed Solution */

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-07T21:43:42Z

Hhwang4: /* Proposed Solution */

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-07T21:29:27Z

Hhwang4: /* Proposed Solution */

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-07T21:04:54Z

Hhwang4:

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-06T22:16:13Z

Hhwang4:

CSC/ECE 517 Spring 2020/E2020 Let course staff as well as students do reviews

2020-04-06T21:13:54Z

Hhwang4: Created page with "==E2020. Let course staff as well as students do reviews=="

==E2020. Let course staff as well as students do reviews==

CSC/ECE 517 Spring 2020 - E2005. Bookmark enhancements

2020-03-29T19:32:11Z

Hhwang4: /* Code Modifications */

==E2005. Bookmark Enhancements==

=='''Introduction'''==

===About Expertiza===
[http://expertiza.ncsu.edu/ Expertiza] is an open-source project that is built using the [http://rubyonrails.org/ Ruby on Rails] framework. At its core, it is a highly versatile tool that academic institutions can use to craft learning objectives centered around team projects, peer reviews, and highly-customizable assignments.

=='''Problem Statement'''==
The purpose of this project was to add meaningful enhancements and fixes to the bookmark feature in Expertiza, entities that can be attached to a topic to aid the authors who decide to take on a certain assignment. While the major functionality of the bookmark feature was already present by the time the team embarked on this project (most notably the ability to create/edit and rate bookmarks), many desired functions were conveniently broken or left out.

===Completed Stories===
Below is a breakdown of the stories that were drawn up and completed for this project:

1. Need a way to view all responses to the bookmark questionnaires.

2. Modify permissions for deleting bookmarks.The person who creates the bookmark, the team for whom the bookmark is meant, and the instructor, should be able to delete.

3. "View bookmarks" link on student_task/view breaks if the student has not selected a topic yet.

4. Bookmark rating questionnaire should include question asking the reviewer whether or not the bookmark appears to have been used by the author. Get the bookmark questionnaire functioning and add to the bookmark list page.

5. Fix issue in which users should not be able to review their own bookmark using the questionnaire, but currently can.

6. Add a number next to/inside the icon with the number of current bookmark in order to make it clear whether a bookmark exists for a topic.

7. Add a "View bookmarks" link to the assignment view page for easier access.

8. Add rating to the bookmark questionnaire and use that rating to calculate the average instead of using the current dropdown.

9. A student should not be able to rate his/her own bookmark.

10. Add URL to bookmark list for assignment topic on the assignment page, to make viewing bookmarks easier.

11. Instructors cannot currently see bookmarks (gets an error message saying instructors cannot create bookmarks).

12. "Back" button from Bookmarks list is broken.

13. When creating a bookmark with an empty description field, the notice says the bookmark was successfully created even though it fails.

14. "Bookmark ratings" should be a type of rubric when you go to Manage > Questionnaires. Although 'Bookmark Rating' is already a type of rubric, it isn't listed when hovering over Manage... > Questionnaires

15. Create a way to mark a bookmark that was rated to be helpful by all reviewers, on average.

16. Students can add/view bookmarks when "Allow participants to create bookmarks?" box is unchecked for the assignment.

=='''Code Modifications'''==

'''Fix the "Back" button:'''
When either backing out of creating or viewing/editing a bookmark, the back functionality does not work, both prompting errors. Issue has been fixed and users can once again go back to the appropriate page.

Changed files:
:app/views/bookmarks/list.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

:app/views/bookmarks/new.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

:app/views/bookmarks/edit.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

Pull request can be found [https://github.com/hosungh/expertiza/pull/2?file-filters%5B%5D= here]

Commit for "Back" capability when updating bookmark can be found [https://github.com/hosungh/expertiza/pull/4?file-filters%5B%5D= here]

'''Check whether text field is present when creating/updating bookmark:'''
Previously, when a bookmark was created/updated and the corresponding "Title", "URL", or "Description" text fields were not filled in, the bookmark was not created or updated sans any error or warning. In fact, the user would be taken to the list of bookmarks available, forcing him/her to go back to the page corresponding to the bookmark create/edit page. This fix prompts users with an error indicating which text field needs to be filled in in order to fulfill the particular bookmark create/edit function.

[[File:CheckFieldsTitle.png]][[File:CheckFieldsUrl.png]][[File:CheckFieldsDescription.png]]

Changed files:
:app/views/bookmarks/new.html.erb
<pre style="color: black; border:1px;">


<%= label_tag 'Title' %> 
<%= text_field_tag :title, params[:title], :required => true %> 
<%= label_tag 'Url' %> 
<%= text_field_tag :url, params[:url], :required => true %> 
<%= label_tag 'Description' %> 
<%= text_area_tag :description, params[:description], :required => true %> 

</pre>

:app/views/bookmarks/edit.html.erb

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


<%= label_tag 'Title' %> 
<%= f.text_field :title, :required => true %> 
<%= label_tag 'Url' %> 
<%= f.text_field :url, :required => true %> 
<%= label_tag 'Description' %> 
<%= f.text_area :description, :required => true %> 

</pre>
Pull request can be found [https://github.com/hosungh/expertiza/pull/4?file-filters%5B%5D= here]

'''Change average bookmark rating to be based on questionnaire:'''
The rating system for the bookmarks before these changes were elementary in nature - there was a drop-down menu to choose your particular rating for a bookmark while there was an average calculator just to the left of the aforementioned column. The new changes introduced allows the "Your rating" and "Avg. rating" columns for a particular bookmark to be calculated based on the scores given to the various questions present in a given bookmark questionnaire. The "Avg. rating" is calculated based on the mean rating of all the bookmark questionnaires scored by every reviewer while "Your rating" is simply the mean of the scores that you (the user) gave to all the questions on the questionnaire. The integer '5' used in calculating both types of average scores was used because of the fact that there are a total of five stars for each questionnaire question.

[[File:BookmarkAvgRatings.png]]

Qustionnaire for fourth bookmark listed above (do your own calculation to find the mean for 'Your rating'):

[[File:QuestionnaireForLastBookmark.png]]

Changed files:
:app/controllers/bookmarks_controller.rb
helper_method :specific_average_score
helper_method :total_average_score

# calculate average questionnaire score for 'Your rating' for specific bookmark
def specific_average_score(bookmark)
if bookmark.nil?
return '-'
else
assessment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assessment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assessment.id,
reviewee_id: bookmark.id,
reviewer_id: AssignmentParticipant.find_by(user_id: current_user.id).id).flat_map {|r| Response.where(map_id: r.id) }
score = Answer.get_total_score(response: responses, questions: questions)
if score.nil?
return '-'
else
(score * 5.0 / 100.0).round(2)
end
end
end

# calculate average questionnaire score for 'Avg. rating' for specific bookmark
def total_average_score(bookmark)
if bookmark.nil?
return '-'
else
assessment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assessment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assessment.id,
reviewee_id: bookmark.id).flat_map {|r| Response.where(map_id: r.id) }
totalScore = Answer.compute_scores(responses, questions)
if totalScore[:avg].nil?
return '-'
else
(totalScore[:avg] * 5.0 / 100.0).round(2)
end
end
end

:app/views/bookmarks/list.html.erb
<pre style="color: black; border:1px;">

<% totalAvg = total_average_score(bookmark) %>
<% if totalAvg != 0 %>
<%= totalAvg %>
<% else %>
<%= '-' %>
<% end %>
</pre>

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

<% specAvg = specific_average_score(bookmark) %>
<% if specAvg != 0 %>
<%= specAvg %>
<% else %>
<%= '-' %>
<% end %>
</pre>

Pull request can be found [https://github.com/hosungh/expertiza/pull/12?file-filters%5B%5D= here]

'''Addition of badges for exceptionally helpful bookmarks:'''
Originally, no badge system was setup for bookmarks that have proven to be helpful guides for other students taking on the same project. The new changes introduced allows bookmarks to be attached to bookmarks with exceptionally good average ratings (i.e, above a rating of 3). A badge is signified by a full star while the absence of a badge is represented by an empty star.

[[File:Bookmark list.png]]

Changed files:
:app/views/bookmarks/list.html.erb
<pre style="color: black; border:1px;">

<th class="head">Badge</th>

<td>



<% if totalAvg.to_f > 3 %>

<% else %>

<% end %>
</td>
</pre>

Pull request can be found [https://github.com/hosungh/expertiza/pull/14?file-filters%5B%5D= here]

'''Users cannot rate bookmarks they've uploaded. '''
We wanted to make sure that users cannot rate bookmarks that they uploaded.

Changed files:
:app/views/bookmarks/list.html.erb
<% unless session[:user].id == bookmark.user_id %>
# ... code for rating the bookmarks
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/1/files?w=1 here]

'''Users cannot review bookmarks they've uploaded using the questionnaire. '''
We also wanted to make sure that users cannot review bookmarks that they uploaded using the questionnaires.

Changed files:
:app/views/bookmarks/list.html.erb
<% unless session[:user].id == bookmark.user_id %>
# ... code for reviewing bookmarks using the questionnaire
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/5/files?w=1 here]

'''Users should be able to see the number of bookmarks from the topics list. '''
Previously, users could add bookmarks, but could not tell how many bookmarks were provided for each topic (if any) without clicking the "View bookmarks" icon. This UI change displays the number of bookmarks for the topic inside the view bookmarks icon from the topic list view so that users don't need to click through each topic individually.

[[File:Sign up sheet bookmarks.png]]

Changed files:
:app/views/sign_up_sheet/_actions.html.erb
<nowiki></nowiki>
<nowiki><%= Bookmark.where(topic_id: topic.id).length.to_s %></nowiki>
<nowiki></nowiki>

Pull request can be found [https://github.com/hosungh/expertiza/pull/6/files here]

'''UI changes to make finding your bookmarks easier:'''
We added a "View Bookmarks" link to the student task view, that takes the student directly to the bookmarks that have been submitted for their topic. This code was then modified such that the link is greyed out if the student does not have a topic, and is hidden if bookmarks are not enabled for the assignment.

Changed files:
:app/controllers/student_task_controller.rb
:app/views/student_task/view.html.erb
<% if @use_bookmark %>
<<nowiki />li>>
<% if @topic_id and @assignment.submission_allowed(@topic_id) %>
<%= link_to "View bookmarks", :controller=>'bookmarks', :action=> 'list', :id => @topic_id %> (View bookmarks others have submitted for your topic)
<% else %>
<<nowiki />font color="gray">View bookmarks (You have to choose a topic first)
<% end %>
<<nowiki />/li>
<% end %>

Relevant commits can be found [https://github.com/hosungh/expertiza/commit/04b24b1dedd3414f58f52d394f2a5b9568e83872 here] [https://github.com/hosungh/expertiza/commit/15a775624307651755a70e63625a370478aa63b4 here] and [https://github.com/hosungh/expertiza/commit/f144594ae062369754d54288eff8959136510ccc here]

'''Grey out add/view bookmarks link on the topic page if bookmarks are not enabled.''' Previously, students could submit and view bookmarks even if bookmarks were disabled for the assignment. Now these options are hidden.

Changed files:
:app/views/sign_up_sheet/_actions.html.erb
<% if @use_bookmark %>
<<nowiki />%= link_to :controller=>'bookmarks', :action=> 'list', :id => topic.id do %>
<<nowiki />span class="fa-stack fa-md" title='View topic bookmarks'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x">
<<nowiki />p class="fa fa-stack-2x fa-inverse" style='font-size: 1.0em; padding-top: 2px; font-weight: bold;'>
<%= Bookmark.where(topic_id: topic.id).length.to_s %>
<<nowiki />/p>
<<nowiki />/span>
<% end %>
<%= link_to :controller=>'bookmarks', :action=> 'new', :id => topic.id , :assignment_id => params[:assignment_id] do %>
<<nowiki />span class="fa-stack fa-md" title='Add bookmark to topic'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x">
<<nowiki />i class="fa fa-plus fa-stack-1x fa-inverse" style='font-size: .5em'>
<<nowiki />/span>
<% end %>
<<nowiki />% else %>
<<nowiki />span class="fa-stack fa-md" title='View topic bookmarks'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x" style="opacity: 0.3;">

<% end %>

:app/views/sign_up_sheet/_table_header.html.erb
<<nowiki />th width="10%"> Bookmarks
<% unless @use_bookmark %> (disabled) <% end %>
<<nowiki />/th>

Commit can be found [https://github.com/hosungh/expertiza/commit/f0352ddf441d3773109b2e0208981f3fe122b5df here]

[[File:Disable-bookmark-links.png]]

'''Modify Bookmark delete permissions. '''
Bookmarks should be deletable by the user who created the bookmark, a teammate of the user who provided the bookmark, and the instructor.

Changed files:
:app/views/bookmarks/list.html.erb

<% is_teammate = false %>
<% team = SignedUpTeam.find_by(topic_id: @topic.id) rescue nil %>
<% if team %>
<% teams_users = TeamsUser.where(['team_id = ?', team.team_id]) %>
<% is_teammate = teams_users.select {|tu| tu.user_id == session[:user].id}.size > 0 %>
<% end %>
<% if bookmark.user_id == session[:user].id or is_teammate or ['Instructor'].include? @current_role_name %>
<nowiki><td><%= link_to 'Edit Bookmark', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy Bookmark', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/13/files here]

'''Fix the ability to create bookmark questionnaires and use in assignments.'''
Previously, questionnaires for things like Teammate Reviews could be created and used in assignments. Users could fill these out and the scores would be stored for later reference by TAs and instructors. The questionnaire for bookmark reviews was previously not functional, but now instructors can create new bookmark questionnaires and assign them to assignments.

Changed files:
:app/controllers/questionnaires_controller.rb
@questionnaire = Object.const_get(params[:model].split.join).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:model].split.join
....
if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)

:app/controllers/questionnaires_controller.rb
....
when "bookmark"
bookmark = Bookmark.find(@map.response_map.reviewee_id)
redirect_to controller: 'bookmarks', action: 'list', id: bookmark.topic_id
....
"BookmarkRatingResponseMap"

:app/models/bookmark_rating_response_map.rb
....
self.assignment.questionnaires.find_by(type: 'BookmarkRatingQuestionnaire')

:app/views/bookmarks/list.html.erb
....
<td>
<% assignment_participant = AssignmentParticipant.find_by(user_id: session[:user].id) %>
<% map = BookmarkRatingResponseMap.where(reviewed_object_id: @topic.assignment.id, reviewer_id: assignment_participant.id, reviewee_id: bookmark.id).first %>
<% if map.nil? %>
<% map = BookmarkRatingResponseMap.create(reviewed_object_id: @topic.assignment.id, reviewer_id: assignment_participant.id, reviewee_id: bookmark.id) %>
<% end %>
<% review = map.response.last %>
<% if review.nil? %>
<%= link_to "Review", {:controller => 'response', :action => 'new', :id => map.map_id, :return => "bookmark"} %>
<% else %>
<%= link_to "View", {:controller => 'response', :action => 'view', :id => review.id} %>
<%= link_to "Edit", {:controller => 'response', :action => 'edit', :id => review.id, :return => "bookmark"} %>
<% end %>
</td>
<nowiki><% if bookmark.user_id == session[:user].id %></nowiki>
<nowiki><td><%= link_to 'Edit', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<nowiki><td><%= link_to 'Edit Bookmark', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy Bookmark', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<% end %>

:app/views/response/view.html.erb
<% if !(@map.instance_of? TeammateReviewResponseMap) && !@map.survey? && !(@map.instance_of? BookmarkRatingResponseMap) %>
....

Pull request can be found [https://github.com/hosungh/expertiza/pull/3/files here]

'''Instructors should have the ability to view all bookmark responses. '''
Instructors should have a way to view all the responses to the bookmark questionnaires so that can see which bookmarks provided were deemed useful.

[[File:Bookmark response list.png]]

Changed files:
:app/helpers/report_formatter_helper.rb
def bookmark_rating_response_map(params, _session = nil)
assign_basics(params)
@reviewers = BookmarkRatingResponseMap.bookmark_response_report(@id)
@topics = @assignment.sign_up_topics
end

:app/models/bookmark_rating_response_map.rb
class BookmarkRatingResponseMap < ReviewResponseMap

def self.bookmark_response_report(id)
BookmarkRatingResponseMap.select("DISTINCT reviewer_id").where("reviewed_object_id = ?", id)
end

:app/views/reports/_bookmark_rating_report.html.erb
<%= create_report_table_header("Reviewed By" => "16%",
"Topic" => "14%",
"Bookmark Review" => "20%",
"Submitted By" => "20%",
"Last reviewed at" => "20%") %>
<%@l = -1 %>

<% @reviewers.each do |r| %>
<% @user = User.find(Participant.find(r.reviewer_id).user_id) %>
<% @bookmark_rating_response_maps = BookmarkRatingResponseMap.where(reviewer_id: r.reviewer_id, reviewed_object_id: @id) %>

<% maps = @bookmark_rating_response_maps.select { |m| !Response.where(map_id: m.id).first.blank? and m.reviewee and m.reviewee.user_id != @user.id }%>

<%@l = @l+1 %>
<% (@l % 2 == 0) ? @bgcolor = "#ffffff" : @bgcolor = "#f9f9f9" %>

<tr>

<% if maps.count > 0 %>

<td bgcolor=<%= @bgcolor %> rowspan= <%= maps.count %>>
<% @reviewer_name = @user.fullname(session[:ip]) %>
<%= link_to @reviewer_name, :controller => 'popup', :action => 'reviewer_details_popup', :id => r.reviewer_id, :assignment_id => @id %>
</td>

<% maps.each do |map| %>
<% @reviewee = map.reviewee %>

<td bgcolor=<%= @bgcolor %> align="left" colspan=1>
<% topic = SignUpTopic.find(@reviewee.topic_id) %>
<%= topic.topic_name %>
</td>


<td id = "green" bgcolor=<%= @bgcolor %> align="left" colspan=1>
<%= link_to @reviewee.title, {:controller => 'response', :action => 'view', :id => map.response.last.id}, :title => "Click here to view this bookmark review" %>
</td>


<td id = "green" bgcolor=<%= @bgcolor %> style="color:#DD3300" align="left" colspan=1>
<% reviewed_by_user = User.find(@reviewee.user_id).name %>
<%= link_to reviewed_by_user, impersonate_impersonate_path(:user => {:name => reviewed_by_user}), :method => :post, :title => "Click here to impersonate this user" %>
</td>


<td bgcolor=<%= @bgcolor %> align="left">
<% @bookmark_review_response = Response.where(map_id: map.id).first %>
<%= @bookmark_review_response.updated_at.to_time.strftime("%m/%d/%Y - %I:%M%p") %>
</td>

</tr>
<tr>
<% end %>
<% end %>
</tr>
<% end %>
</table>
</div>

:app/views/reports/_searchbox.html.erb
....
<option value='BookmarkRatingResponseMap' >
Bookmark Review Report
</option>
....
<% elsif @type == "BookmarkReviewResponseMap" %>
<nowiki><h1> Bookmark review report for <%= @assignment.name%> </h1></nowiki>
....

:app/views/reports/response_report.html.haml
- elsif @type == "BookmarkRatingResponseMap"
= render :partial => 'bookmark_rating_report'

Pull request can be found [https://github.com/hosungh/expertiza/pull/10/files here]

=='''Testing Plan'''==

'''Testing from the UI'''

* Create a Bookmark Questionnaire
# After logging in as the instructor, go to Manage > Questionnaires.
# Find 'Bookmark Rating' and click the '+' to create a new questionnaire.
# Give a name for this questionnaire, leave the min and max score at 0 and 5 respectively, and click 'Create'.
# Go to Manage > Questionnaires and click on 'Bookmark Rating' to view all of the questionnaires. Click the edit icon for the questionnaire you just created.
# Select 'Add 1 more Criterion question(s)'.
# For the question, enter "Does this bookmark appear to have been used by the author?" and leave the other fields blank. This question will be helpful in determining how useful the bookmark was.
# Click 'Save bookmark rating questionnaire'. Now this questionnaire can be used in assignments.

* Enable Bookmarks
# After logging in as the instructor, go to Manage > Assignments.
# Choose an assignment that will be used for testing and have bookmarks enabled and select the edit icon under Actions.
# Under Topics Tab select 'Allow participants to create bookmarks?'.
# Go to Rubrics tab, under 'Bookmark Rating' select the Bookmark review questionnaire that was previously created to use for reviewing the bookmarks.

* Add a Bookmark to a Topic
# Log in as a student who is a participant of the assignment with bookmarks enabled and select that assignment.
# Select a "Signup sheet" to see the list of available topics.
# Choose a topic and select the 'Add bookmark to topic' icon from the Bookmarks column. The 'Add bookmark to topic' icon has a '+' sign.
# Fill in all the fields for the bookmark, including Title, Url, and Description and click 'Add new bookmark'.
# You should now see a page listing all bookmarks for this topic.

* Viewing all Bookmarks for a Topic
# Log in as a student who is a participant of the assignment with bookmarks enabled (or an instructor) and select that assignment.
# Select a "Signup sheet" to see the list of available topics.
# The number of bookmarks for each topic should be displayed visually inside the 'View topic bookmarks' icon in the bookmarks column.
# Click the 'View topic bookmarks icon' to see a list of all bookmarks for this topic.

* Editing and Destroying Bookmarks for a Topic
# Perform this test with each of the following users: an instructor, a user who is assigned to the topic, and a teammate of the user who is assigned to the topic.
## Log in with the user and select the assignment with bookmarks enabled.
## Select a "Signup sheet" to see the list of available topics.
## Click the 'View topic bookmarks icon' to see a list of all bookmarks for this topic.
## The user should see links to 'Edit Bookmark' and 'Destroy Bookmark' next to a bookmark only if the user is an instructor, the user submitted the bookmark, or the user is a teammate of the user who submitted the bookmark.

'''Automated Testing with RSpec'''

The current version of Expertiza does not have any tests for the bookmark controller or model. We intend on adding comprehensive RSpec tests for all changes we have added to controller classes and unit tests for model classes.

===Code Coverage===

=='''Application Deployment'''==

This web application deployed on VCL is located at [http://152.46.17.220:8080 http://152.46.17.220:8080]

Note: To aid in testing, we have created an assignment called "Bookmarks Test Assignment" as instructor6. The students assigned to this assignment include student7339, student7340, and student7341.

=='''Team Information'''==
Danielle Hancock

Eric Peden

Hosung Hwang

Mentor: Abhirav Kariya

=='''References'''==
1. [https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2. [https://github.com/hosungh/expertiza/ Forked GitHub Repo]

3. [http://152.46.17.220:8080 Deployed Application]

4. [https://github.com/expertiza/expertiza/pull/1704/ Beta Branch Pull Request]

CSC/ECE 517 Spring 2020 - E2005. Bookmark enhancements

2020-03-29T18:56:28Z

Hhwang4: /* Code Modifications */

==E2005. Bookmark Enhancements==

=='''Introduction'''==

===About Expertiza===
[http://expertiza.ncsu.edu/ Expertiza] is an open-source project that is built using the [http://rubyonrails.org/ Ruby on Rails] framework. At its core, it is a highly versatile tool that academic institutions can use to craft learning objectives centered around team projects, peer reviews, and highly-customizable assignments.

=='''Problem Statement'''==
The purpose of this project was to add meaningful enhancements and fixes to the bookmark feature in Expertiza, entities that can be attached to a topic to aid the authors who decide to take on a certain assignment. While the major functionality of the bookmark feature was already present by the time the team embarked on this project (most notably the ability to create/edit and rate bookmarks), many desired functions were conveniently broken or left out.

===Completed Stories===
Below is a breakdown of the stories that were drawn up and completed for this project:

1. Need a way to view all responses to the bookmark questionnaires.

2. Modify permissions for deleting bookmarks.The person who creates the bookmark, the team for whom the bookmark is meant, and the instructor, should be able to delete.

3. "View bookmarks" link on student_task/view breaks if the student has not selected a topic yet.

4. Bookmark rating questionnaire should include question asking the reviewer whether or not the bookmark appears to have been used by the author. Get the bookmark questionnaire functioning and add to the bookmark list page.

5. Fix issue in which users should not be able to review their own bookmark using the questionnaire, but currently can.

6. Add a number next to/inside the icon with the number of current bookmark in order to make it clear whether a bookmark exists for a topic.

7. Add a "View bookmarks" link to the assignment view page for easier access.

8. Add rating to the bookmark questionnaire and use that rating to calculate the average instead of using the current dropdown.

9. A student should not be able to rate his/her own bookmark.

10. Add URL to bookmark list for assignment topic on the assignment page, to make viewing bookmarks easier.

11. Instructors cannot currently see bookmarks (gets an error message saying instructors cannot create bookmarks).

12. "Back" button from Bookmarks list is broken.

13. When creating a bookmark with an empty description field, the notice says the bookmark was successfully created even though it fails.

14. "Bookmark ratings" should be a type of rubric when you go to Manage > Questionnaires. Although 'Bookmark Rating' is already a type of rubric, it isn't listed when hovering over Manage... > Questionnaires

15. Create a way to mark a bookmark that was rated to be helpful by all reviewers, on average.

16. Students can add/view bookmarks when "Allow participants to create bookmarks?" box is unchecked for the assignment.

=='''Code Modifications'''==

'''Fix the "Back" button:'''
When either backing out of creating or viewing/editing a bookmark, the back functionality does not work, both prompting errors. Issue has been fixed and users can once again go back to the appropriate page.

Changed files:
:app/views/bookmarks/list.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

:app/views/bookmarks/new.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

:app/views/bookmarks/edit.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

Pull request can be found [https://github.com/hosungh/expertiza/pull/2?file-filters%5B%5D= here]

Commit for "Back" capability when updating bookmark can be found [https://github.com/hosungh/expertiza/pull/4?file-filters%5B%5D= here]

'''Check whether text field is present when creating/updating bookmark:'''
Previously, when a bookmark was created/updated and the corresponding "Title", "URL", or "Description" text fields were not filled in, the bookmark was not created or updated sans any error or warning. In fact, the user would be taken to the list of bookmarks available, forcing him/her to go back to the page corresponding to the bookmark create/edit page. This fix prompts users with an error indicating which text field needs to be filled in in order to fulfill the particular bookmark create/edit function.

[[File:CheckFieldsTitle.png]][[File:CheckFieldsUrl.png]][[File:CheckFieldsDescription.png]]

Changed files:
:app/views/bookmarks/new.html.erb
<%= label_tag 'Title' %> 
<%= text_field_tag :title, params[:title], :required => true %> 
<%= label_tag 'Url' %> 
<%= text_field_tag :url, params[:url], :required => true %> 
<%= label_tag 'Description' %> 
<%= text_area_tag :description, params[:description], :required => true %> 

:app/views/bookmarks/edit.html.erb
<%= label_tag 'Title' %> 
<%= f.text_field :title, :required => true %> 
<%= label_tag 'Url' %> 
<%= f.text_field :url, :required => true %> 
<%= label_tag 'Description' %> 
<%= f.text_area :description, :required => true %> 

Pull request can be found [https://github.com/hosungh/expertiza/pull/4?file-filters%5B%5D= here]

'''Change average bookmark rating to be based on questionnaire:'''
The rating system for the bookmarks before these changes were elementary in nature - there was a drop-down menu to choose your particular rating for a bookmark while there was an average calculator just to the left of the aforementioned column. The new changes introduced allows the "Your rating" and "Avg. rating" columns for a particular bookmark to be calculated based on the scores given to the various questions present in a given bookmark questionnaire. The "Avg. rating" is calculated based on the mean rating of all the bookmark questionnaires scored by every reviewer while "Your rating" is simply the mean of the scores that you (the user) gave to all the questions on the questionnaire. The integer '5' used in calculating both types of average scores was used because of the fact that there are a total of five stars for each questionnaire question.

[[File:BookmarkAvgRatings.png]]

Qustionnaire for fourth bookmark listed above (do your own calculation to find the mean for 'Your rating'):

[[File:QuestionnaireForLastBookmark.png]]

Changed files:
:app/controllers/bookmarks_controller.rb
helper_method :specific_average_score
helper_method :total_average_score

def specific_average_score(bookmark)
if bookmark.nil?
return '-'
else
assessment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assessment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assessment.id,
reviewee_id: bookmark.id,
reviewer_id: AssignmentParticipant.find_by(user_id: current_user.id).id).flat_map {|r| Response.where(map_id: r.id) }
score = Answer.get_total_score(response: responses, questions: questions)
if score.nil?
return '-'
else
(score * 5.0 / 100.0).round(2)
end
end
end

def total_average_score(bookmark)
if bookmark.nil?
return '-'
else
assessment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assessment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assessment.id,
reviewee_id: bookmark.id).flat_map {|r| Response.where(map_id: r.id) }
totalScore = Answer.compute_scores(responses, questions)
if totalScore[:avg].nil?
return '-'
else
(totalScore[:avg] * 5.0 / 100.0).round(2)
end
end
end

:app/views/bookmarks/list.html.erb

<% totalAvg = total_average_score(bookmark) %>
<% if totalAvg != 0 %>
<%= totalAvg %>
<% else %>
<%= '-' %>
<% end %>


<% specAvg = specific_average_score(bookmark) %>
<% if specAvg != 0 %>
<%= specAvg %>
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/12?file-filters%5B%5D= here]

'''Addition of badges for exceptionally helpful bookmarks:'''
Originally, no badge system was setup for bookmarks that have proven to be helpful guides for other students taking on the same project. The new changes introduced allows bookmarks to be attached to bookmarks with exceptionally good average ratings (i.e, above a rating of 3). A badge is signified by a full star while the absence of a badge is represented by an empty star.

[[File:Bookmark list.png]]

Changed files:
:app/views/bookmarks/list.html.erb
<th class="head">Badge</th>

<td>

<% if totalAvg.to_f > 3 %>

<% else %>

<% end %>
</td>

Pull request can be found [https://github.com/hosungh/expertiza/pull/14?file-filters%5B%5D= here]

'''Users cannot rate bookmarks they've uploaded. '''
We wanted to make sure that users cannot rate bookmarks that they uploaded.

Changed files:
:app/views/bookmarks/list.html.erb
<% unless session[:user].id == bookmark.user_id %>
# ... code for rating the bookmarks
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/1/files?w=1 here]

'''Users cannot review bookmarks they've uploaded using the questionnaire. '''
We also wanted to make sure that users cannot review bookmarks that they uploaded using the questionnaires.

Changed files:
:app/views/bookmarks/list.html.erb
<% unless session[:user].id == bookmark.user_id %>
# ... code for reviewing bookmarks using the questionnaire
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/5/files?w=1 here]

'''Users should be able to see the number of bookmarks from the topics list. '''
Previously, users could add bookmarks, but could not tell how many bookmarks were provided for each topic (if any) without clicking the "View bookmarks" icon. This UI change displays the number of bookmarks for the topic inside the view bookmarks icon from the topic list view so that users don't need to click through each topic individually.

[[File:Sign up sheet bookmarks.png]]

Changed files:
:app/views/sign_up_sheet/_actions.html.erb
<nowiki></nowiki>
<nowiki><%= Bookmark.where(topic_id: topic.id).length.to_s %></nowiki>
<nowiki></nowiki>

Pull request can be found [https://github.com/hosungh/expertiza/pull/6/files here]

'''UI changes to make finding your bookmarks easier:'''
We added a "View Bookmarks" link to the student task view, that takes the student directly to the bookmarks that have been submitted for their topic. This code was then modified such that the link is greyed out if the student does not have a topic, and is hidden if bookmarks are not enabled for the assignment.

Changed files:
:app/controllers/student_task_controller.rb
:app/views/student_task/view.html.erb
<% if @use_bookmark %>
<<nowiki />li>>
<% if @topic_id and @assignment.submission_allowed(@topic_id) %>
<%= link_to "View bookmarks", :controller=>'bookmarks', :action=> 'list', :id => @topic_id %> (View bookmarks others have submitted for your topic)
<% else %>
<<nowiki />font color="gray">View bookmarks (You have to choose a topic first)
<% end %>
<<nowiki />/li>
<% end %>

Relevant commits can be found [https://github.com/hosungh/expertiza/commit/04b24b1dedd3414f58f52d394f2a5b9568e83872 here] [https://github.com/hosungh/expertiza/commit/15a775624307651755a70e63625a370478aa63b4 here] and [https://github.com/hosungh/expertiza/commit/f144594ae062369754d54288eff8959136510ccc here]

'''Grey out add/view bookmarks link on the topic page if bookmarks are not enabled.''' Previously, students could submit and view bookmarks even if bookmarks were disabled for the assignment. Now these options are hidden.

Changed files:
:app/views/sign_up_sheet/_actions.html.erb
<% if @use_bookmark %>
<<nowiki />%= link_to :controller=>'bookmarks', :action=> 'list', :id => topic.id do %>
<<nowiki />span class="fa-stack fa-md" title='View topic bookmarks'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x">
<<nowiki />p class="fa fa-stack-2x fa-inverse" style='font-size: 1.0em; padding-top: 2px; font-weight: bold;'>
<%= Bookmark.where(topic_id: topic.id).length.to_s %>
<<nowiki />/p>
<<nowiki />/span>
<% end %>
<%= link_to :controller=>'bookmarks', :action=> 'new', :id => topic.id , :assignment_id => params[:assignment_id] do %>
<<nowiki />span class="fa-stack fa-md" title='Add bookmark to topic'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x">
<<nowiki />i class="fa fa-plus fa-stack-1x fa-inverse" style='font-size: .5em'>
<<nowiki />/span>
<% end %>
<<nowiki />% else %>
<<nowiki />span class="fa-stack fa-md" title='View topic bookmarks'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x" style="opacity: 0.3;">

<% end %>

:app/views/sign_up_sheet/_table_header.html.erb
<<nowiki />th width="10%"> Bookmarks
<% unless @use_bookmark %> (disabled) <% end %>
<<nowiki />/th>

Commit can be found [https://github.com/hosungh/expertiza/commit/f0352ddf441d3773109b2e0208981f3fe122b5df here]

[[File:Disable-bookmark-links.png]]

'''Modify Bookmark delete permissions. '''
Bookmarks should be deletable by the user who created the bookmark, a teammate of the user who provided the bookmark, and the instructor.

Changed files:
:app/views/bookmarks/list.html.erb

<% is_teammate = false %>
<% team = SignedUpTeam.find_by(topic_id: @topic.id) rescue nil %>
<% if team %>
<% teams_users = TeamsUser.where(['team_id = ?', team.team_id]) %>
<% is_teammate = teams_users.select {|tu| tu.user_id == session[:user].id}.size > 0 %>
<% end %>
<% if bookmark.user_id == session[:user].id or is_teammate or ['Instructor'].include? @current_role_name %>
<nowiki><td><%= link_to 'Edit Bookmark', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy Bookmark', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/13/files here]

'''Fix the ability to create bookmark questionnaires and use in assignments.'''
Previously, questionnaires for things like Teammate Reviews could be created and used in assignments. Users could fill these out and the scores would be stored for later reference by TAs and instructors. The questionnaire for bookmark reviews was previously not functional, but now instructors can create new bookmark questionnaires and assign them to assignments.

Changed files:
:app/controllers/questionnaires_controller.rb
@questionnaire = Object.const_get(params[:model].split.join).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:model].split.join
....
if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)

:app/controllers/questionnaires_controller.rb
....
when "bookmark"
bookmark = Bookmark.find(@map.response_map.reviewee_id)
redirect_to controller: 'bookmarks', action: 'list', id: bookmark.topic_id
....
"BookmarkRatingResponseMap"

:app/models/bookmark_rating_response_map.rb
....
self.assignment.questionnaires.find_by(type: 'BookmarkRatingQuestionnaire')

:app/views/bookmarks/list.html.erb
....
<td>
<% assignment_participant = AssignmentParticipant.find_by(user_id: session[:user].id) %>
<% map = BookmarkRatingResponseMap.where(reviewed_object_id: @topic.assignment.id, reviewer_id: assignment_participant.id, reviewee_id: bookmark.id).first %>
<% if map.nil? %>
<% map = BookmarkRatingResponseMap.create(reviewed_object_id: @topic.assignment.id, reviewer_id: assignment_participant.id, reviewee_id: bookmark.id) %>
<% end %>
<% review = map.response.last %>
<% if review.nil? %>
<%= link_to "Review", {:controller => 'response', :action => 'new', :id => map.map_id, :return => "bookmark"} %>
<% else %>
<%= link_to "View", {:controller => 'response', :action => 'view', :id => review.id} %>
<%= link_to "Edit", {:controller => 'response', :action => 'edit', :id => review.id, :return => "bookmark"} %>
<% end %>
</td>
<nowiki><% if bookmark.user_id == session[:user].id %></nowiki>
<nowiki><td><%= link_to 'Edit', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<nowiki><td><%= link_to 'Edit Bookmark', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy Bookmark', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<% end %>

:app/views/response/view.html.erb
<% if !(@map.instance_of? TeammateReviewResponseMap) && !@map.survey? && !(@map.instance_of? BookmarkRatingResponseMap) %>
....

Pull request can be found [https://github.com/hosungh/expertiza/pull/3/files here]

'''Instructors should have the ability to view all bookmark responses. '''
Instructors should have a way to view all the responses to the bookmark questionnaires so that can see which bookmarks provided were deemed useful.

[[File:Bookmark response list.png]]

Changed files:
:app/helpers/report_formatter_helper.rb
def bookmark_rating_response_map(params, _session = nil)
assign_basics(params)
@reviewers = BookmarkRatingResponseMap.bookmark_response_report(@id)
@topics = @assignment.sign_up_topics
end

:app/models/bookmark_rating_response_map.rb
class BookmarkRatingResponseMap < ReviewResponseMap

def self.bookmark_response_report(id)
BookmarkRatingResponseMap.select("DISTINCT reviewer_id").where("reviewed_object_id = ?", id)
end

:app/views/reports/_bookmark_rating_report.html.erb
<%= create_report_table_header("Reviewed By" => "16%",
"Topic" => "14%",
"Bookmark Review" => "20%",
"Submitted By" => "20%",
"Last reviewed at" => "20%") %>
<%@l = -1 %>

<% @reviewers.each do |r| %>
<% @user = User.find(Participant.find(r.reviewer_id).user_id) %>
<% @bookmark_rating_response_maps = BookmarkRatingResponseMap.where(reviewer_id: r.reviewer_id, reviewed_object_id: @id) %>

<% maps = @bookmark_rating_response_maps.select { |m| !Response.where(map_id: m.id).first.blank? and m.reviewee and m.reviewee.user_id != @user.id }%>

<%@l = @l+1 %>
<% (@l % 2 == 0) ? @bgcolor = "#ffffff" : @bgcolor = "#f9f9f9" %>

<tr>

<% if maps.count > 0 %>

<td bgcolor=<%= @bgcolor %> rowspan= <%= maps.count %>>
<% @reviewer_name = @user.fullname(session[:ip]) %>
<%= link_to @reviewer_name, :controller => 'popup', :action => 'reviewer_details_popup', :id => r.reviewer_id, :assignment_id => @id %>
</td>

<% maps.each do |map| %>
<% @reviewee = map.reviewee %>

<td bgcolor=<%= @bgcolor %> align="left" colspan=1>
<% topic = SignUpTopic.find(@reviewee.topic_id) %>
<%= topic.topic_name %>
</td>


<td id = "green" bgcolor=<%= @bgcolor %> align="left" colspan=1>
<%= link_to @reviewee.title, {:controller => 'response', :action => 'view', :id => map.response.last.id}, :title => "Click here to view this bookmark review" %>
</td>


<td id = "green" bgcolor=<%= @bgcolor %> style="color:#DD3300" align="left" colspan=1>
<% reviewed_by_user = User.find(@reviewee.user_id).name %>
<%= link_to reviewed_by_user, impersonate_impersonate_path(:user => {:name => reviewed_by_user}), :method => :post, :title => "Click here to impersonate this user" %>
</td>


<td bgcolor=<%= @bgcolor %> align="left">
<% @bookmark_review_response = Response.where(map_id: map.id).first %>
<%= @bookmark_review_response.updated_at.to_time.strftime("%m/%d/%Y - %I:%M%p") %>
</td>

</tr>
<tr>
<% end %>
<% end %>
</tr>
<% end %>
</table>
</div>

:app/views/reports/_searchbox.html.erb
....
<option value='BookmarkRatingResponseMap' >
Bookmark Review Report
</option>
....
<% elsif @type == "BookmarkReviewResponseMap" %>
<nowiki><h1> Bookmark review report for <%= @assignment.name%> </h1></nowiki>
....

:app/views/reports/response_report.html.haml
- elsif @type == "BookmarkRatingResponseMap"
= render :partial => 'bookmark_rating_report'

Pull request can be found [https://github.com/hosungh/expertiza/pull/10/files here]

=='''Testing Plan'''==

'''Testing from the UI'''

* Create a Bookmark Questionnaire
# After logging in as the instructor, go to Manage > Questionnaires.
# Find 'Bookmark Rating' and click the '+' to create a new questionnaire.
# Give a name for this questionnaire, leave the min and max score at 0 and 5 respectively, and click 'Create'.
# Go to Manage > Questionnaires and click on 'Bookmark Rating' to view all of the questionnaires. Click the edit icon for the questionnaire you just created.
# Select 'Add 1 more Criterion question(s)'.
# For the question, enter "Does this bookmark appear to have been used by the author?" and leave the other fields blank. This question will be helpful in determining how useful the bookmark was.
# Click 'Save bookmark rating questionnaire'. Now this questionnaire can be used in assignments.

* Enable Bookmarks
# After logging in as the instructor, go to Manage > Assignments.
# Choose an assignment that will be used for testing and have bookmarks enabled and select the edit icon under Actions.
# Under Topics Tab select 'Allow participants to create bookmarks?'.
# Go to Rubrics tab, under 'Bookmark Rating' select the Bookmark review questionnaire that was previously created to use for reviewing the bookmarks.

* Add a Bookmark to a Topic
# Log in as a student who is a participant of the assignment with bookmarks enabled and select that assignment.
# Select a "Signup sheet" to see the list of available topics.
# Choose a topic and select the 'Add bookmark to topic' icon from the Bookmarks column. The 'Add bookmark to topic' icon has a '+' sign.
# Fill in all the fields for the bookmark, including Title, Url, and Description and click 'Add new bookmark'.
# You should now see a page listing all bookmarks for this topic.

* Viewing all Bookmarks for a Topic
# Log in as a student who is a participant of the assignment with bookmarks enabled (or an instructor) and select that assignment.
# Select a "Signup sheet" to see the list of available topics.
# The number of bookmarks for each topic should be displayed visually inside the 'View topic bookmarks' icon in the bookmarks column.
# Click the 'View topic bookmarks icon' to see a list of all bookmarks for this topic.

* Editing and Destroying Bookmarks for a Topic
# Perform this test with each of the following users: an instructor, a user who is assigned to the topic, and a teammate of the user who is assigned to the topic.
## Log in with the user and select the assignment with bookmarks enabled.
## Select a "Signup sheet" to see the list of available topics.
## Click the 'View topic bookmarks icon' to see a list of all bookmarks for this topic.
## The user should see links to 'Edit Bookmark' and 'Destroy Bookmark' next to a bookmark only if the user is an instructor, the user submitted the bookmark, or the user is a teammate of the user who submitted the bookmark.

'''Automated Testing with RSpec'''

The current version of Expertiza does not have any tests for the bookmark controller or model. We intend on adding comprehensive RSpec tests for all changes we have added to controller classes and unit tests for model classes.

===Code Coverage===

=='''Application Deployment'''==

This web application deployed on VCL is located at [http://152.46.17.220:8080 http://152.46.17.220:8080]

Note: To aid in testing, we have created an assignment called "Bookmarks Test Assignment" as instructor6. The students assigned to this assignment include student7339, student7340, and student7341.

=='''Team Information'''==
Danielle Hancock

Eric Peden

Hosung Hwang

Mentor: Abhirav Kariya

=='''References'''==
1. [https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2. [https://github.com/hosungh/expertiza/ Forked GitHub Repo]

3. [http://152.46.17.220:8080 Deployed Application]

4. [https://github.com/expertiza/expertiza/pull/1704/ Beta Branch Pull Request]

CSC/ECE 517 Spring 2020 - E2005. Bookmark enhancements

2020-03-23T23:34:30Z

Hhwang4: /* Code Modifications */

==E2005. Bookmark Enhancements==

=='''Introduction'''==

===About Expertiza===
[http://expertiza.ncsu.edu/ Expertiza] is an open-source project that is built using the [http://rubyonrails.org/ Ruby on Rails] framework. At its core, it is a highly versatile tool that academic institutions can use to craft learning objectives centered around team projects, peer reviews, and highly-customizable assignments.

=='''Problem Statement'''==
The purpose of this project was to add meaningful enhancements and fixes to the bookmark feature in Expertiza, entities that can be attached to a topic to aid the authors who decide to take on a certain assignment. While the major functionality of the bookmark feature was already present by the time the team embarked on this project (most notably the ability to create/edit and rate bookmarks), many desired functions were conveniently broken or left out.

===Completed Stories===
Below is a breakdown of the stories that were drawn up and completed for this project:

1. Need a way to view all responses to the bookmark questionnaires.

2. Modify permissions for deleting bookmarks.The person who creates the bookmark, the team for whom the bookmark is meant, and the instructor, should be able to delete.

3. "View bookmarks" link on student_task/view breaks if the student has not selected a topic yet.

4. Bookmark rating questionnaire should include question asking the reviewer whether or not the bookmark appears to have been used by the author. Get the bookmark questionnaire functioning and add to the bookmark list page.

5. Fix issue in which users should not be able to review their own bookmark using the questionnaire, but currently can.

6. Add a number next to/inside the icon with the number of current bookmark in order to make it clear whether a bookmark exists for a topic.

7. Add a "View bookmarks" link to the assignment view page for easier access.

8. Add rating to the bookmark questionnaire and use that rating to calculate the average instead of using the current dropdown.

9. A student should not be able to rate his/her own bookmark.

10. Add URL to bookmark list for assignment topic on the assignment page, to make viewing bookmarks easier.

11. Instructors cannot currently see bookmarks (gets an error message saying instructors cannot create bookmarks).

12. "Back" button from Bookmarks list is broken.

13. When creating a bookmark with an empty description field, the notice says the bookmark was successfully created even though it fails.

14. "Bookmark ratings" should be a type of rubric when you go to Manage > Questionnaires. Although 'Bookmark Rating' is already a type of rubric, it isn't listed when hovering over Manage... > Questionnaires

15. Create a way to mark a bookmark that was rated to be helpful by all reviewers, on average.

16. Students can add/view bookmarks when "Allow participants to create bookmarks?" box is unchecked for the assignment.

=='''Code Modifications'''==

'''Fix the "Back" button:'''
When either backing out of creating or viewing/editing a bookmark, the back functionality does not work, both prompting errors. Issue has been fixed and users can once again go back to the appropriate page.

Changed files:
:app/views/bookmarks/list.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

:app/views/bookmarks/new.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

:app/views/bookmarks/edit.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

Pull request can be found [https://github.com/hosungh/expertiza/pull/2?file-filters%5B%5D= here]

Commit for "Back" capability when updating bookmark can be found [https://github.com/hosungh/expertiza/pull/4?file-filters%5B%5D= here]

'''Check whether text field is present when creating/updating bookmark:'''
Previously, when a bookmark was created/updated and the corresponding "Title", "URL", or "Description" text fields were not filled in, the bookmark was not created or updated sans any error or warning. In fact, the user would be taken to the list of bookmarks available, forcing him/her to go back to the page corresponding to the bookmark create/edit page. This fix prompts users with an error indicating which text field needs to be filled in in order to fulfill the particular bookmark create/edit function.

[[File:CheckFieldsTitle.png]][[File:CheckFieldsUrl.png]][[File:CheckFieldsDescription.png]]

Changed files:
:app/views/bookmarks/new.html.erb
<%= label_tag 'Title' %> 
<%= text_field_tag :title, params[:title], :required => true %> 
<%= label_tag 'Url' %> 
<%= text_field_tag :url, params[:url], :required => true %> 
<%= label_tag 'Description' %> 
<%= text_area_tag :description, params[:description], :required => true %> 

:app/views/bookmarks/edit.html.erb
<%= label_tag 'Title' %> 
<%= f.text_field :title, :required => true %> 
<%= label_tag 'Url' %> 
<%= f.text_field :url, :required => true %> 
<%= label_tag 'Description' %> 
<%= f.text_area :description, :required => true %> 

Pull request can be found [https://github.com/hosungh/expertiza/pull/4?file-filters%5B%5D= here]

'''Change average bookmark rating to be based on questionnaire:'''
The rating system for the bookmarks before these changes were elementary in nature - there was a drop-down menu to choose your particular rating for a bookmark while there was an average calculator just to the left of the aforementioned column. The new changes introduced allows the "Your rating" and "Avg. rating" columns for a particular bookmark to be calculated based on the scores given to the various questions present in a given bookmark questionnaire. The "Avg. rating" is calculated based on the mean rating of all the bookmark questionnaires scored by every reviewer while "Your rating" is simply the mean of the scores that you (the user) gave to all the questions on the questionnaire.

[[File:BookmarkAvgRatings.png]]

Qustionnaire for fourth bookmark listed above (do your own calculation to find the mean for 'Your rating'):

[[File:QuestionnaireForLastBookmark.png]]

Changed files:
:app/controllers/bookmarks_controller.rb
helper_method :specific_average_score
helper_method :total_average_score

def specific_average_score(bookmark)
if bookmark.nil?
return '-'
else
assessment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assessment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assessment.id,
reviewee_id: bookmark.id,
reviewer_id: AssignmentParticipant.find_by(user_id: current_user.id).id).flat_map {|r| Response.where(map_id: r.id) }
score = Answer.get_total_score(response: responses, questions: questions)
if score.nil?
return '-'
else
(score * 5.0 / 100.0).round(2)
end
end
end

def total_average_score(bookmark)
if bookmark.nil?
return '-'
else
assessment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assessment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assessment.id,
reviewee_id: bookmark.id).flat_map {|r| Response.where(map_id: r.id) }
totalScore = Answer.compute_scores(responses, questions)
if totalScore[:avg].nil?
return '-'
else
(totalScore[:avg] * 5.0 / 100.0).round(2)
end
end
end

:app/views/bookmarks/list.html.erb

<% totalAvg = total_average_score(bookmark) %>
<% if totalAvg != 0 %>
<%= totalAvg %>
<% else %>
<%= '-' %>
<% end %>


<% specAvg = specific_average_score(bookmark) %>
<% if specAvg != 0 %>
<%= specAvg %>
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/12?file-filters%5B%5D= here]

'''Addition of badges for exceptionally helpful bookmarks:'''
Originally, no badge system was setup for bookmarks that have proven to be helpful guides for other students taking on the same project. The new changes introduced allows bookmarks to be attached to bookmarks with exceptionally good average ratings (i.e, above a rating of 3). A badge is signified by a full star while the absence of a badge is represented by an empty star.

[[File:Bookmark list.png]]

Changed files:
:app/views/bookmarks/list.html.erb
<th class="head">Badge</th>

<td>

<% if totalAvg.to_f > 3 %>

<% else %>

<% end %>
</td>

Pull request can be found [https://github.com/hosungh/expertiza/pull/14?file-filters%5B%5D= here]

'''Users cannot rate bookmarks they've uploaded. '''
We wanted to make sure that users cannot rate bookmarks that they uploaded.

Changed files:
:app/views/bookmarks/list.html.erb
<% unless session[:user].id == bookmark.user_id %>
# ... code for rating the bookmarks
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/1/files?w=1 here]

'''Users cannot review bookmarks they've uploaded using the questionnaire. '''
We also wanted to make sure that users cannot review bookmarks that they uploaded using the questionnaires.

Changed files:
:app/views/bookmarks/list.html.erb
<% unless session[:user].id == bookmark.user_id %>
# ... code for reviewing bookmarks using the questionnaire
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/5/files?w=1 here]

'''Users should be able to see the number of bookmarks from the topics list. '''
Previously, users could add bookmarks, but could not tell how many bookmarks were provided for each topic (if any) without clicking the "View bookmarks" icon. This UI change displays the number of bookmarks for the topic inside the view bookmarks icon from the topic list view so that users don't need to click through each topic individually.

[[File:Sign up sheet bookmarks.png]]

Changed files:
:app/views/sign_up_sheet/_actions.html.erb
<nowiki></nowiki>
<nowiki><%= Bookmark.where(topic_id: topic.id).length.to_s %></nowiki>
<nowiki></nowiki>

Pull request can be found [https://github.com/hosungh/expertiza/pull/6/files here]

'''UI changes to make finding your bookmarks easier:'''
We added a "View Bookmarks" link to the student task view, that takes the student directly to the bookmarks that have been submitted for their topic. This code was then modified such that the link is greyed out if the student does not have a topic, and is hidden if bookmarks are not enabled for the assignment.

Changed files:
:app/controllers/student_task_controller.rb
:app/views/student_task/view.html.erb
<% if @use_bookmark %>
<<nowiki />li>>
<% if @topic_id and @assignment.submission_allowed(@topic_id) %>
<%= link_to "View bookmarks", :controller=>'bookmarks', :action=> 'list', :id => @topic_id %> (View bookmarks others have submitted for your topic)
<% else %>
<<nowiki />font color="gray">View bookmarks (You have to choose a topic first)
<% end %>
<<nowiki />/li>
<% end %>

Relevant commits can be found [https://github.com/hosungh/expertiza/commit/04b24b1dedd3414f58f52d394f2a5b9568e83872 here] [https://github.com/hosungh/expertiza/commit/15a775624307651755a70e63625a370478aa63b4 here] and [https://github.com/hosungh/expertiza/commit/f144594ae062369754d54288eff8959136510ccc here]

'''Grey out add/view bookmarks link on the topic page if bookmarks are not enabled.''' Previously, students could submit and view bookmarks even if bookmarks were disabled for the assignment. Now these options are hidden.

Changed files:
:app/views/sign_up_sheet/_actions.html.erb
<% if @use_bookmark %>
<<nowiki />%= link_to :controller=>'bookmarks', :action=> 'list', :id => topic.id do %>
<<nowiki />span class="fa-stack fa-md" title='View topic bookmarks'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x">
<<nowiki />p class="fa fa-stack-2x fa-inverse" style='font-size: 1.0em; padding-top: 2px; font-weight: bold;'>
<%= Bookmark.where(topic_id: topic.id).length.to_s %>
<<nowiki />/p>
<<nowiki />/span>
<% end %>
<%= link_to :controller=>'bookmarks', :action=> 'new', :id => topic.id , :assignment_id => params[:assignment_id] do %>
<<nowiki />span class="fa-stack fa-md" title='Add bookmark to topic'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x">
<<nowiki />i class="fa fa-plus fa-stack-1x fa-inverse" style='font-size: .5em'>
<<nowiki />/span>
<% end %>
<<nowiki />% else %>
<<nowiki />span class="fa-stack fa-md" title='View topic bookmarks'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x" style="opacity: 0.3;">

<% end %>

:app/views/sign_up_sheet/_table_header.html.erb
<<nowiki />th width="10%"> Bookmarks
<% unless @use_bookmark %> (disabled) <% end %>
<<nowiki />/th>

Commit can be found [https://github.com/hosungh/expertiza/commit/f0352ddf441d3773109b2e0208981f3fe122b5df here]

[[File:Disable-bookmark-links.png]]

'''Modify Bookmark delete permissions. '''
Bookmarks should be deletable by the user who created the bookmark, a teammate of the user who provided the bookmark, and the instructor.

Changed files:
:app/views/bookmarks/list.html.erb

<% is_teammate = false %>
<% team = SignedUpTeam.find_by(topic_id: @topic.id) rescue nil %>
<% if team %>
<% teams_users = TeamsUser.where(['team_id = ?', team.team_id]) %>
<% is_teammate = teams_users.select {|tu| tu.user_id == session[:user].id}.size > 0 %>
<% end %>
<% if bookmark.user_id == session[:user].id or is_teammate or ['Instructor'].include? @current_role_name %>
<nowiki><td><%= link_to 'Edit Bookmark', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy Bookmark', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/13/files here]

'''Fix the ability to create bookmark questionnaires and use in assignments.'''
Previously, questionnaires for things like Teammate Reviews could be created and used in assignments. Users could fill these out and the scores would be stored for later reference by TAs and instructors. The questionnaire for bookmark reviews was previously not functional, but now instructors can create new bookmark questionnaires and assign them to assignments.

Changed files:
:app/controllers/questionnaires_controller.rb
@questionnaire = Object.const_get(params[:model].split.join).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:model].split.join
....
if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)

:app/controllers/questionnaires_controller.rb
....
when "bookmark"
bookmark = Bookmark.find(@map.response_map.reviewee_id)
redirect_to controller: 'bookmarks', action: 'list', id: bookmark.topic_id
....
"BookmarkRatingResponseMap"

:app/models/bookmark_rating_response_map.rb
....
self.assignment.questionnaires.find_by(type: 'BookmarkRatingQuestionnaire')

:app/views/bookmarks/list.html.erb
....
<td>
<% assignment_participant = AssignmentParticipant.find_by(user_id: session[:user].id) %>
<% map = BookmarkRatingResponseMap.where(reviewed_object_id: @topic.assignment.id, reviewer_id: assignment_participant.id, reviewee_id: bookmark.id).first %>
<% if map.nil? %>
<% map = BookmarkRatingResponseMap.create(reviewed_object_id: @topic.assignment.id, reviewer_id: assignment_participant.id, reviewee_id: bookmark.id) %>
<% end %>
<% review = map.response.last %>
<% if review.nil? %>
<%= link_to "Review", {:controller => 'response', :action => 'new', :id => map.map_id, :return => "bookmark"} %>
<% else %>
<%= link_to "View", {:controller => 'response', :action => 'view', :id => review.id} %>
<%= link_to "Edit", {:controller => 'response', :action => 'edit', :id => review.id, :return => "bookmark"} %>
<% end %>
</td>
<nowiki><% if bookmark.user_id == session[:user].id %></nowiki>
<nowiki><td><%= link_to 'Edit', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<nowiki><td><%= link_to 'Edit Bookmark', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy Bookmark', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<% end %>

:app/views/response/view.html.erb
<% if !(@map.instance_of? TeammateReviewResponseMap) && !@map.survey? && !(@map.instance_of? BookmarkRatingResponseMap) %>
....

Pull request can be found [https://github.com/hosungh/expertiza/pull/3/files here]

'''Instructors should have the ability to view all bookmark responses. '''
Instructors should have a way to view all the responses to the bookmark questionnaires so that can see which bookmarks provided were deemed useful.

[[File:Bookmark response list.png]]

Changed files:
:app/helpers/report_formatter_helper.rb
def bookmark_rating_response_map(params, _session = nil)
assign_basics(params)
@reviewers = BookmarkRatingResponseMap.bookmark_response_report(@id)
@topics = @assignment.sign_up_topics
end

:app/models/bookmark_rating_response_map.rb
class BookmarkRatingResponseMap < ReviewResponseMap

def self.bookmark_response_report(id)
BookmarkRatingResponseMap.select("DISTINCT reviewer_id").where("reviewed_object_id = ?", id)
end

:app/views/reports/_bookmark_rating_report.html.erb
<%= create_report_table_header("Reviewed By" => "16%",
"Topic" => "14%",
"Bookmark Review" => "20%",
"Submitted By" => "20%",
"Last reviewed at" => "20%") %>
<%@l = -1 %>

<% @reviewers.each do |r| %>
<% @user = User.find(Participant.find(r.reviewer_id).user_id) %>
<% @bookmark_rating_response_maps = BookmarkRatingResponseMap.where(reviewer_id: r.reviewer_id, reviewed_object_id: @id) %>

<% maps = @bookmark_rating_response_maps.select { |m| !Response.where(map_id: m.id).first.blank? and m.reviewee and m.reviewee.user_id != @user.id }%>

<%@l = @l+1 %>
<% (@l % 2 == 0) ? @bgcolor = "#ffffff" : @bgcolor = "#f9f9f9" %>

<tr>

<% if maps.count > 0 %>

<td bgcolor=<%= @bgcolor %> rowspan= <%= maps.count %>>
<% @reviewer_name = @user.fullname(session[:ip]) %>
<%= link_to @reviewer_name, :controller => 'popup', :action => 'reviewer_details_popup', :id => r.reviewer_id, :assignment_id => @id %>
</td>

<% maps.each do |map| %>
<% @reviewee = map.reviewee %>

<td bgcolor=<%= @bgcolor %> align="left" colspan=1>
<% topic = SignUpTopic.find(@reviewee.topic_id) %>
<%= topic.topic_name %>
</td>


<td id = "green" bgcolor=<%= @bgcolor %> align="left" colspan=1>
<%= link_to @reviewee.title, {:controller => 'response', :action => 'view', :id => map.response.last.id}, :title => "Click here to view this bookmark review" %>
</td>


<td id = "green" bgcolor=<%= @bgcolor %> style="color:#DD3300" align="left" colspan=1>
<% reviewed_by_user = User.find(@reviewee.user_id).name %>
<%= link_to reviewed_by_user, impersonate_impersonate_path(:user => {:name => reviewed_by_user}), :method => :post, :title => "Click here to impersonate this user" %>
</td>


<td bgcolor=<%= @bgcolor %> align="left">
<% @bookmark_review_response = Response.where(map_id: map.id).first %>
<%= @bookmark_review_response.updated_at.to_time.strftime("%m/%d/%Y - %I:%M%p") %>
</td>

</tr>
<tr>
<% end %>
<% end %>
</tr>
<% end %>
</table>
</div>

:app/views/reports/_searchbox.html.erb
....
<option value='BookmarkRatingResponseMap' >
Bookmark Review Report
</option>
....
<% elsif @type == "BookmarkReviewResponseMap" %>
<nowiki><h1> Bookmark review report for <%= @assignment.name%> </h1></nowiki>
....

:app/views/reports/response_report.html.haml
- elsif @type == "BookmarkRatingResponseMap"
= render :partial => 'bookmark_rating_report'

Pull request can be found [https://github.com/hosungh/expertiza/pull/10/files here]

=='''Testing Plan'''==

'''Testing from the UI'''

* Create a Bookmark Questionnaire
# After logging in as the instructor, go to Manage > Questionnaires.
# Find 'Bookmark Rating' and click the '+' to create a new questionnaire.
# Give a name for this questionnaire, leave the min and max score at 0 and 5 respectively, and click 'Create'.
# Go to Manage > Questionnaires and click on 'Bookmark Rating' to view all of the questionnaires. Click the edit icon for the questionnaire you just created.
# Select 'Add 1 more Criterion question(s)'.
# For the question, enter "Does this bookmark appear to have been used by the author?" and leave the other fields blank. This question will be helpful in determining how useful the bookmark was.
# Click 'Save bookmark rating questionnaire'. Now this questionnaire can be used in assignments.

* Enable Bookmarks
# After logging in as the instructor, go to Manage > Assignments.
# Choose an assignment that will be used for testing and have bookmarks enabled and select the edit icon under Actions.
# Under Topics Tab select 'Allow participants to create bookmarks?'.
# Go to Rubrics tab, under 'Bookmark Rating' select the Bookmark review questionnaire that was previously created to use for reviewing the bookmarks.

* Add a Bookmark to a Topic
# Log in as a student who is a participant of the assignment with bookmarks enabled and select that assignment.
# Select a "Signup sheet" to see the list of available topics.
# Choose a topic and select the 'Add bookmark to topic' icon from the Bookmarks column. The 'Add bookmark to topic' icon has a '+' sign.
# Fill in all the fields for the bookmark, including Title, Url, and Description and click 'Add new bookmark'.
# You should now see a page listing all bookmarks for this topic.

* Viewing all Bookmarks for a Topic
# Log in as a student who is a participant of the assignment with bookmarks enabled (or an instructor) and select that assignment.
# Select a "Signup sheet" to see the list of available topics.
# The number of bookmarks for each topic should be displayed visually inside the 'View topic bookmarks' icon in the bookmarks column.
# Click the 'View topic bookmarks icon' to see a list of all bookmarks for this topic.

* Editing and Destroying Bookmarks for a Topic
# Perform this test with each of the following users: an instructor, a user who is assigned to the topic, and a teammate of the user who is assigned to the topic.
## Log in with the user and select the assignment with bookmarks enabled.
## Select a "Signup sheet" to see the list of available topics.
## Click the 'View topic bookmarks icon' to see a list of all bookmarks for this topic.
## The user should see links to 'Edit Bookmark' and 'Destroy Bookmark' next to a bookmark only if the user is an instructor, the user submitted the bookmark, or the user is a teammate of the user who submitted the bookmark.

'''Automated Testing with RSpec'''

The current version of Expertiza does not have any tests for the bookmark controller or model. We intend on adding comprehensive RSpec tests for all changes we have added to controller classes and unit tests for model classes.

===Code Coverage===

=='''Application Deployment'''==

This web application deployed on VCL is located at [http://152.46.17.220:8080 http://152.46.17.220:8080]

=='''Team Information'''==
Danielle Hancock

Eric Peden

Hosung Hwang

Mentor: Abhirav Kariya

=='''References'''==
1. [https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2. [https://github.com/hosungh/expertiza/ Forked GitHub Repo]

3. [http://152.46.17.220:8080 Deployed Application]

4. [https://github.com/expertiza/expertiza/pull/1704/ Beta Branch Pull Request]

CSC/ECE 517 Spring 2020 - E2005. Bookmark enhancements

2020-03-23T23:33:02Z

Hhwang4: /* Code Modifications */

==E2005. Bookmark Enhancements==

=='''Introduction'''==

===About Expertiza===
[http://expertiza.ncsu.edu/ Expertiza] is an open-source project that is built using the [http://rubyonrails.org/ Ruby on Rails] framework. At its core, it is a highly versatile tool that academic institutions can use to craft learning objectives centered around team projects, peer reviews, and highly-customizable assignments.

=='''Problem Statement'''==
The purpose of this project was to add meaningful enhancements and fixes to the bookmark feature in Expertiza, entities that can be attached to a topic to aid the authors who decide to take on a certain assignment. While the major functionality of the bookmark feature was already present by the time the team embarked on this project (most notably the ability to create/edit and rate bookmarks), many desired functions were conveniently broken or left out.

===Completed Stories===
Below is a breakdown of the stories that were drawn up and completed for this project:

1. Need a way to view all responses to the bookmark questionnaires.

2. Modify permissions for deleting bookmarks.The person who creates the bookmark, the team for whom the bookmark is meant, and the instructor, should be able to delete.

3. "View bookmarks" link on student_task/view breaks if the student has not selected a topic yet.

4. Bookmark rating questionnaire should include question asking the reviewer whether or not the bookmark appears to have been used by the author. Get the bookmark questionnaire functioning and add to the bookmark list page.

5. Fix issue in which users should not be able to review their own bookmark using the questionnaire, but currently can.

6. Add a number next to/inside the icon with the number of current bookmark in order to make it clear whether a bookmark exists for a topic.

7. Add a "View bookmarks" link to the assignment view page for easier access.

8. Add rating to the bookmark questionnaire and use that rating to calculate the average instead of using the current dropdown.

9. A student should not be able to rate his/her own bookmark.

10. Add URL to bookmark list for assignment topic on the assignment page, to make viewing bookmarks easier.

11. Instructors cannot currently see bookmarks (gets an error message saying instructors cannot create bookmarks).

12. "Back" button from Bookmarks list is broken.

13. When creating a bookmark with an empty description field, the notice says the bookmark was successfully created even though it fails.

14. "Bookmark ratings" should be a type of rubric when you go to Manage > Questionnaires. Although 'Bookmark Rating' is already a type of rubric, it isn't listed when hovering over Manage... > Questionnaires

15. Create a way to mark a bookmark that was rated to be helpful by all reviewers, on average.

16. Students can add/view bookmarks when "Allow participants to create bookmarks?" box is unchecked for the assignment.

=='''Code Modifications'''==

'''Fix the "Back" button:'''
When either backing out of creating or viewing/editing a bookmark, the back functionality does not work, both prompting errors. Issue has been fixed and users can once again go back to the appropriate page.

Changed files:
:app/views/bookmarks/list.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

:app/views/bookmarks/new.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

:app/views/bookmarks/edit.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

Pull request can be found [https://github.com/hosungh/expertiza/pull/2?file-filters%5B%5D= here]

Commit for "Back" capability when updating bookmark can be found [https://github.com/hosungh/expertiza/pull/4?file-filters%5B%5D= here]

'''Check whether text field is present when creating/updating bookmark:'''
Previously, when a bookmark was created/updated and the corresponding "Title", "URL", or "Description" text fields were not filled in, the bookmark was not created or updated sans any error or warning. In fact, the user would be taken to the list of bookmarks available, forcing him/her to go back to the page corresponding to the bookmark create/edit page. This fix prompts users with an error indicating which text field needs to be filled in in order to fulfill the particular bookmark create/edit function.

[[File:CheckFieldsTitle.png]][[File:CheckFieldsUrl.png]][[File:CheckFieldsDescription.png]]

Changed files:
:app/views/bookmarks/new.html.erb
<%= label_tag 'Title' %> 
<%= text_field_tag :title, params[:title], :required => true %> 
<%= label_tag 'Url' %> 
<%= text_field_tag :url, params[:url], :required => true %> 
<%= label_tag 'Description' %> 
<%= text_area_tag :description, params[:description], :required => true %> 

:app/views/bookmarks/edit.html.erb
<%= label_tag 'Title' %> 
<%= f.text_field :title, :required => true %> 
<%= label_tag 'Url' %> 
<%= f.text_field :url, :required => true %> 
<%= label_tag 'Description' %> 
<%= f.text_area :description, :required => true %> 

Pull request can be found [https://github.com/hosungh/expertiza/pull/4?file-filters%5B%5D= here]

'''Change average bookmark rating to be based on questionnaire:'''
The rating system for the bookmarks before these changes were elementary in nature - there was a drop-down menu to choose your particular rating for a bookmark while there was an average calculator just to the left of the aforementioned column. The new changes introduced allows the "Your rating" and "Avg. rating" columns for a particular bookmark to be calculated based on the scores given to the various questions present in a given bookmark questionnaire. The "Avg. rating" is calculated based on the mean rating of all the bookmark questionnaires scored by every reviewer while "Your rating" is simply the mean of the scores that you (the user) gave to all the questions on the questionnaire.

[[File:BookmarkAvgRatings.png]]

Qustionnaire for fourth bookmark listed above (do your own calculation to find the mean):

[[File:QuestionnaireForLastBookmark.png]]

Changed files:
:app/controllers/bookmarks_controller.rb
helper_method :specific_average_score
helper_method :total_average_score

def specific_average_score(bookmark)
if bookmark.nil?
return '-'
else
assessment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assessment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assessment.id,
reviewee_id: bookmark.id,
reviewer_id: AssignmentParticipant.find_by(user_id: current_user.id).id).flat_map {|r| Response.where(map_id: r.id) }
score = Answer.get_total_score(response: responses, questions: questions)
if score.nil?
return '-'
else
(score * 5.0 / 100.0).round(2)
end
end
end

def total_average_score(bookmark)
if bookmark.nil?
return '-'
else
assessment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assessment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assessment.id,
reviewee_id: bookmark.id).flat_map {|r| Response.where(map_id: r.id) }
totalScore = Answer.compute_scores(responses, questions)
if totalScore[:avg].nil?
return '-'
else
(totalScore[:avg] * 5.0 / 100.0).round(2)
end
end
end

:app/views/bookmarks/list.html.erb

<% totalAvg = total_average_score(bookmark) %>
<% if totalAvg != 0 %>
<%= totalAvg %>
<% else %>
<%= '-' %>
<% end %>


<% specAvg = specific_average_score(bookmark) %>
<% if specAvg != 0 %>
<%= specAvg %>
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/12?file-filters%5B%5D= here]

'''Addition of badges for exceptionally helpful bookmarks:'''
Originally, no badge system was setup for bookmarks that have proven to be helpful guides for other students taking on the same project. The new changes introduced allows bookmarks to be attached to bookmarks with exceptionally good average ratings (i.e, above a rating of 3). A badge is signified by a full star while the absence of a badge is represented by an empty star.

[[File:Bookmark list.png]]

Changed files:
:app/views/bookmarks/list.html.erb
<th class="head">Badge</th>

<td>

<% if totalAvg.to_f > 3 %>

<% else %>

<% end %>
</td>

Pull request can be found [https://github.com/hosungh/expertiza/pull/14?file-filters%5B%5D= here]

'''Users cannot rate bookmarks they've uploaded. '''
We wanted to make sure that users cannot rate bookmarks that they uploaded.

Changed files:
:app/views/bookmarks/list.html.erb
<% unless session[:user].id == bookmark.user_id %>
# ... code for rating the bookmarks
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/1/files?w=1 here]

'''Users cannot review bookmarks they've uploaded using the questionnaire. '''
We also wanted to make sure that users cannot review bookmarks that they uploaded using the questionnaires.

Changed files:
:app/views/bookmarks/list.html.erb
<% unless session[:user].id == bookmark.user_id %>
# ... code for reviewing bookmarks using the questionnaire
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/5/files?w=1 here]

'''Users should be able to see the number of bookmarks from the topics list. '''
Previously, users could add bookmarks, but could not tell how many bookmarks were provided for each topic (if any) without clicking the "View bookmarks" icon. This UI change displays the number of bookmarks for the topic inside the view bookmarks icon from the topic list view so that users don't need to click through each topic individually.

[[File:Sign up sheet bookmarks.png]]

Changed files:
:app/views/sign_up_sheet/_actions.html.erb
<nowiki></nowiki>
<nowiki><%= Bookmark.where(topic_id: topic.id).length.to_s %></nowiki>
<nowiki></nowiki>

Pull request can be found [https://github.com/hosungh/expertiza/pull/6/files here]

'''UI changes to make finding your bookmarks easier:'''
We added a "View Bookmarks" link to the student task view, that takes the student directly to the bookmarks that have been submitted for their topic. This code was then modified such that the link is greyed out if the student does not have a topic, and is hidden if bookmarks are not enabled for the assignment.

Changed files:
:app/controllers/student_task_controller.rb
:app/views/student_task/view.html.erb
<% if @use_bookmark %>
<<nowiki />li>>
<% if @topic_id and @assignment.submission_allowed(@topic_id) %>
<%= link_to "View bookmarks", :controller=>'bookmarks', :action=> 'list', :id => @topic_id %> (View bookmarks others have submitted for your topic)
<% else %>
<<nowiki />font color="gray">View bookmarks (You have to choose a topic first)
<% end %>
<<nowiki />/li>
<% end %>

Relevant commits can be found [https://github.com/hosungh/expertiza/commit/04b24b1dedd3414f58f52d394f2a5b9568e83872 here] [https://github.com/hosungh/expertiza/commit/15a775624307651755a70e63625a370478aa63b4 here] and [https://github.com/hosungh/expertiza/commit/f144594ae062369754d54288eff8959136510ccc here]

'''Grey out add/view bookmarks link on the topic page if bookmarks are not enabled.''' Previously, students could submit and view bookmarks even if bookmarks were disabled for the assignment. Now these options are hidden.

Changed files:
:app/views/sign_up_sheet/_actions.html.erb
<% if @use_bookmark %>
<<nowiki />%= link_to :controller=>'bookmarks', :action=> 'list', :id => topic.id do %>
<<nowiki />span class="fa-stack fa-md" title='View topic bookmarks'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x">
<<nowiki />p class="fa fa-stack-2x fa-inverse" style='font-size: 1.0em; padding-top: 2px; font-weight: bold;'>
<%= Bookmark.where(topic_id: topic.id).length.to_s %>
<<nowiki />/p>
<<nowiki />/span>
<% end %>
<%= link_to :controller=>'bookmarks', :action=> 'new', :id => topic.id , :assignment_id => params[:assignment_id] do %>
<<nowiki />span class="fa-stack fa-md" title='Add bookmark to topic'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x">
<<nowiki />i class="fa fa-plus fa-stack-1x fa-inverse" style='font-size: .5em'>
<<nowiki />/span>
<% end %>
<<nowiki />% else %>
<<nowiki />span class="fa-stack fa-md" title='View topic bookmarks'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x" style="opacity: 0.3;">

<% end %>

:app/views/sign_up_sheet/_table_header.html.erb
<<nowiki />th width="10%"> Bookmarks
<% unless @use_bookmark %> (disabled) <% end %>
<<nowiki />/th>

Commit can be found [https://github.com/hosungh/expertiza/commit/f0352ddf441d3773109b2e0208981f3fe122b5df here]

[[File:Disable-bookmark-links.png]]

'''Modify Bookmark delete permissions. '''
Bookmarks should be deletable by the user who created the bookmark, a teammate of the user who provided the bookmark, and the instructor.

Changed files:
:app/views/bookmarks/list.html.erb

<% is_teammate = false %>
<% team = SignedUpTeam.find_by(topic_id: @topic.id) rescue nil %>
<% if team %>
<% teams_users = TeamsUser.where(['team_id = ?', team.team_id]) %>
<% is_teammate = teams_users.select {|tu| tu.user_id == session[:user].id}.size > 0 %>
<% end %>
<% if bookmark.user_id == session[:user].id or is_teammate or ['Instructor'].include? @current_role_name %>
<nowiki><td><%= link_to 'Edit Bookmark', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy Bookmark', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/13/files here]

'''Fix the ability to create bookmark questionnaires and use in assignments.'''
Previously, questionnaires for things like Teammate Reviews could be created and used in assignments. Users could fill these out and the scores would be stored for later reference by TAs and instructors. The questionnaire for bookmark reviews was previously not functional, but now instructors can create new bookmark questionnaires and assign them to assignments.

Changed files:
:app/controllers/questionnaires_controller.rb
@questionnaire = Object.const_get(params[:model].split.join).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:model].split.join
....
if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)

:app/controllers/questionnaires_controller.rb
....
when "bookmark"
bookmark = Bookmark.find(@map.response_map.reviewee_id)
redirect_to controller: 'bookmarks', action: 'list', id: bookmark.topic_id
....
"BookmarkRatingResponseMap"

:app/models/bookmark_rating_response_map.rb
....
self.assignment.questionnaires.find_by(type: 'BookmarkRatingQuestionnaire')

:app/views/bookmarks/list.html.erb
....
<td>
<% assignment_participant = AssignmentParticipant.find_by(user_id: session[:user].id) %>
<% map = BookmarkRatingResponseMap.where(reviewed_object_id: @topic.assignment.id, reviewer_id: assignment_participant.id, reviewee_id: bookmark.id).first %>
<% if map.nil? %>
<% map = BookmarkRatingResponseMap.create(reviewed_object_id: @topic.assignment.id, reviewer_id: assignment_participant.id, reviewee_id: bookmark.id) %>
<% end %>
<% review = map.response.last %>
<% if review.nil? %>
<%= link_to "Review", {:controller => 'response', :action => 'new', :id => map.map_id, :return => "bookmark"} %>
<% else %>
<%= link_to "View", {:controller => 'response', :action => 'view', :id => review.id} %>
<%= link_to "Edit", {:controller => 'response', :action => 'edit', :id => review.id, :return => "bookmark"} %>
<% end %>
</td>
<nowiki><% if bookmark.user_id == session[:user].id %></nowiki>
<nowiki><td><%= link_to 'Edit', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<nowiki><td><%= link_to 'Edit Bookmark', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy Bookmark', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<% end %>

:app/views/response/view.html.erb
<% if !(@map.instance_of? TeammateReviewResponseMap) && !@map.survey? && !(@map.instance_of? BookmarkRatingResponseMap) %>
....

Pull request can be found [https://github.com/hosungh/expertiza/pull/3/files here]

'''Instructors should have the ability to view all bookmark responses. '''
Instructors should have a way to view all the responses to the bookmark questionnaires so that can see which bookmarks provided were deemed useful.

[[File:Bookmark response list.png]]

Changed files:
:app/helpers/report_formatter_helper.rb
def bookmark_rating_response_map(params, _session = nil)
assign_basics(params)
@reviewers = BookmarkRatingResponseMap.bookmark_response_report(@id)
@topics = @assignment.sign_up_topics
end

:app/models/bookmark_rating_response_map.rb
class BookmarkRatingResponseMap < ReviewResponseMap

def self.bookmark_response_report(id)
BookmarkRatingResponseMap.select("DISTINCT reviewer_id").where("reviewed_object_id = ?", id)
end

:app/views/reports/_bookmark_rating_report.html.erb
<%= create_report_table_header("Reviewed By" => "16%",
"Topic" => "14%",
"Bookmark Review" => "20%",
"Submitted By" => "20%",
"Last reviewed at" => "20%") %>
<%@l = -1 %>

<% @reviewers.each do |r| %>
<% @user = User.find(Participant.find(r.reviewer_id).user_id) %>
<% @bookmark_rating_response_maps = BookmarkRatingResponseMap.where(reviewer_id: r.reviewer_id, reviewed_object_id: @id) %>

<% maps = @bookmark_rating_response_maps.select { |m| !Response.where(map_id: m.id).first.blank? and m.reviewee and m.reviewee.user_id != @user.id }%>

<%@l = @l+1 %>
<% (@l % 2 == 0) ? @bgcolor = "#ffffff" : @bgcolor = "#f9f9f9" %>

<tr>

<% if maps.count > 0 %>

<td bgcolor=<%= @bgcolor %> rowspan= <%= maps.count %>>
<% @reviewer_name = @user.fullname(session[:ip]) %>
<%= link_to @reviewer_name, :controller => 'popup', :action => 'reviewer_details_popup', :id => r.reviewer_id, :assignment_id => @id %>
</td>

<% maps.each do |map| %>
<% @reviewee = map.reviewee %>

<td bgcolor=<%= @bgcolor %> align="left" colspan=1>
<% topic = SignUpTopic.find(@reviewee.topic_id) %>
<%= topic.topic_name %>
</td>


<td id = "green" bgcolor=<%= @bgcolor %> align="left" colspan=1>
<%= link_to @reviewee.title, {:controller => 'response', :action => 'view', :id => map.response.last.id}, :title => "Click here to view this bookmark review" %>
</td>


<td id = "green" bgcolor=<%= @bgcolor %> style="color:#DD3300" align="left" colspan=1>
<% reviewed_by_user = User.find(@reviewee.user_id).name %>
<%= link_to reviewed_by_user, impersonate_impersonate_path(:user => {:name => reviewed_by_user}), :method => :post, :title => "Click here to impersonate this user" %>
</td>


<td bgcolor=<%= @bgcolor %> align="left">
<% @bookmark_review_response = Response.where(map_id: map.id).first %>
<%= @bookmark_review_response.updated_at.to_time.strftime("%m/%d/%Y - %I:%M%p") %>
</td>

</tr>
<tr>
<% end %>
<% end %>
</tr>
<% end %>
</table>
</div>

:app/views/reports/_searchbox.html.erb
....
<option value='BookmarkRatingResponseMap' >
Bookmark Review Report
</option>
....
<% elsif @type == "BookmarkReviewResponseMap" %>
<nowiki><h1> Bookmark review report for <%= @assignment.name%> </h1></nowiki>
....

:app/views/reports/response_report.html.haml
- elsif @type == "BookmarkRatingResponseMap"
= render :partial => 'bookmark_rating_report'

Pull request can be found [https://github.com/hosungh/expertiza/pull/10/files here]

=='''Testing Plan'''==

'''Testing from the UI'''

* Create a Bookmark Questionnaire
# After logging in as the instructor, go to Manage > Questionnaires.
# Find 'Bookmark Rating' and click the '+' to create a new questionnaire.
# Give a name for this questionnaire, leave the min and max score at 0 and 5 respectively, and click 'Create'.
# Go to Manage > Questionnaires and click on 'Bookmark Rating' to view all of the questionnaires. Click the edit icon for the questionnaire you just created.
# Select 'Add 1 more Criterion question(s)'.
# For the question, enter "Does this bookmark appear to have been used by the author?" and leave the other fields blank. This question will be helpful in determining how useful the bookmark was.
# Click 'Save bookmark rating questionnaire'. Now this questionnaire can be used in assignments.

* Enable Bookmarks
# After logging in as the instructor, go to Manage > Assignments.
# Choose an assignment that will be used for testing and have bookmarks enabled and select the edit icon under Actions.
# Under Topics Tab select 'Allow participants to create bookmarks?'.
# Go to Rubrics tab, under 'Bookmark Rating' select the Bookmark review questionnaire that was previously created to use for reviewing the bookmarks.

* Add a Bookmark to a Topic
# Log in as a student who is a participant of the assignment with bookmarks enabled and select that assignment.
# Select a "Signup sheet" to see the list of available topics.
# Choose a topic and select the 'Add bookmark to topic' icon from the Bookmarks column. The 'Add bookmark to topic' icon has a '+' sign.
# Fill in all the fields for the bookmark, including Title, Url, and Description and click 'Add new bookmark'.
# You should now see a page listing all bookmarks for this topic.

* Viewing all Bookmarks for a Topic
# Log in as a student who is a participant of the assignment with bookmarks enabled (or an instructor) and select that assignment.
# Select a "Signup sheet" to see the list of available topics.
# The number of bookmarks for each topic should be displayed visually inside the 'View topic bookmarks' icon in the bookmarks column.
# Click the 'View topic bookmarks icon' to see a list of all bookmarks for this topic.

* Editing and Destroying Bookmarks for a Topic
# Perform this test with each of the following users: an instructor, a user who is assigned to the topic, and a teammate of the user who is assigned to the topic.
## Log in with the user and select the assignment with bookmarks enabled.
## Select a "Signup sheet" to see the list of available topics.
## Click the 'View topic bookmarks icon' to see a list of all bookmarks for this topic.
## The user should see links to 'Edit Bookmark' and 'Destroy Bookmark' next to a bookmark only if the user is an instructor, the user submitted the bookmark, or the user is a teammate of the user who submitted the bookmark.

'''Automated Testing with RSpec'''

The current version of Expertiza does not have any tests for the bookmark controller or model. We intend on adding comprehensive RSpec tests for all changes we have added to controller classes and unit tests for model classes.

===Code Coverage===

=='''Application Deployment'''==

This web application deployed on VCL is located at [http://152.46.17.220:8080 http://152.46.17.220:8080]

=='''Team Information'''==
Danielle Hancock

Eric Peden

Hosung Hwang

Mentor: Abhirav Kariya

=='''References'''==
1. [https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2. [https://github.com/hosungh/expertiza/ Forked GitHub Repo]

3. [http://152.46.17.220:8080 Deployed Application]

4. [https://github.com/expertiza/expertiza/pull/1704/ Beta Branch Pull Request]

CSC/ECE 517 Spring 2020 - E2005. Bookmark enhancements

2020-03-23T23:32:03Z

Hhwang4: /* Code Modifications */

==E2005. Bookmark Enhancements==

=='''Introduction'''==

===About Expertiza===
[http://expertiza.ncsu.edu/ Expertiza] is an open-source project that is built using the [http://rubyonrails.org/ Ruby on Rails] framework. At its core, it is a highly versatile tool that academic institutions can use to craft learning objectives centered around team projects, peer reviews, and highly-customizable assignments.

=='''Problem Statement'''==
The purpose of this project was to add meaningful enhancements and fixes to the bookmark feature in Expertiza, entities that can be attached to a topic to aid the authors who decide to take on a certain assignment. While the major functionality of the bookmark feature was already present by the time the team embarked on this project (most notably the ability to create/edit and rate bookmarks), many desired functions were conveniently broken or left out.

===Completed Stories===
Below is a breakdown of the stories that were drawn up and completed for this project:

1. Need a way to view all responses to the bookmark questionnaires.

2. Modify permissions for deleting bookmarks.The person who creates the bookmark, the team for whom the bookmark is meant, and the instructor, should be able to delete.

3. "View bookmarks" link on student_task/view breaks if the student has not selected a topic yet.

4. Bookmark rating questionnaire should include question asking the reviewer whether or not the bookmark appears to have been used by the author. Get the bookmark questionnaire functioning and add to the bookmark list page.

5. Fix issue in which users should not be able to review their own bookmark using the questionnaire, but currently can.

6. Add a number next to/inside the icon with the number of current bookmark in order to make it clear whether a bookmark exists for a topic.

7. Add a "View bookmarks" link to the assignment view page for easier access.

8. Add rating to the bookmark questionnaire and use that rating to calculate the average instead of using the current dropdown.

9. A student should not be able to rate his/her own bookmark.

10. Add URL to bookmark list for assignment topic on the assignment page, to make viewing bookmarks easier.

11. Instructors cannot currently see bookmarks (gets an error message saying instructors cannot create bookmarks).

12. "Back" button from Bookmarks list is broken.

13. When creating a bookmark with an empty description field, the notice says the bookmark was successfully created even though it fails.

14. "Bookmark ratings" should be a type of rubric when you go to Manage > Questionnaires. Although 'Bookmark Rating' is already a type of rubric, it isn't listed when hovering over Manage... > Questionnaires

15. Create a way to mark a bookmark that was rated to be helpful by all reviewers, on average.

16. Students can add/view bookmarks when "Allow participants to create bookmarks?" box is unchecked for the assignment.

=='''Code Modifications'''==

'''Fix the "Back" button:'''
When either backing out of creating or viewing/editing a bookmark, the back functionality does not work, both prompting errors. Issue has been fixed and users can once again go back to the appropriate page.

Changed files:
:app/views/bookmarks/list.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

:app/views/bookmarks/new.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

:app/views/bookmarks/edit.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

Pull request can be found [https://github.com/hosungh/expertiza/pull/2?file-filters%5B%5D= here]

Commit for "Back" capability when updating bookmark can be found [https://github.com/hosungh/expertiza/pull/4?file-filters%5B%5D= here]

'''Check whether text field is present when creating/updating bookmark:'''
Previously, when a bookmark was created/updated and the corresponding "Title", "URL", or "Description" text fields were not filled in, the bookmark was not created or updated sans any error or warning. In fact, the user would be taken to the list of bookmarks available, forcing him/her to go back to the page corresponding to the bookmark create/edit page. This fix prompts users with an error indicating which text field needs to be filled in in order to fulfill the particular bookmark create/edit function.

[[File:CheckFieldsTitle.png]][[File:CheckFieldsUrl.png]][[File:CheckFieldsDescription.png]]

Changed files:
:app/views/bookmarks/new.html.erb
<%= label_tag 'Title' %> 
<%= text_field_tag :title, params[:title], :required => true %> 
<%= label_tag 'Url' %> 
<%= text_field_tag :url, params[:url], :required => true %> 
<%= label_tag 'Description' %> 
<%= text_area_tag :description, params[:description], :required => true %> 

:app/views/bookmarks/edit.html.erb
<%= label_tag 'Title' %> 
<%= f.text_field :title, :required => true %> 
<%= label_tag 'Url' %> 
<%= f.text_field :url, :required => true %> 
<%= label_tag 'Description' %> 
<%= f.text_area :description, :required => true %> 

Pull request can be found [https://github.com/hosungh/expertiza/pull/4?file-filters%5B%5D= here]

'''Change average bookmark rating to be based on questionnaire:'''
The rating system for the bookmarks before these changes were elementary in nature - there was a drop-down menu to choose your particular rating for a bookmark while there was an average calculator just to the left of the aforementioned column. The new changes introduced allows the "Your rating" and "Avg. rating" columns for a particular bookmark to be calculated based on the scores given to the various questions present in a given bookmark questionnaire. The "Avg. rating" is calculated based on the mean rating of all the bookmark questionnaires scored by every reviewer while "Your rating" is simply the mean of the scores that you (the user) gave to all the questions on the questionnaire.

[[File:BookmarkAvgRatings.png]]

Qustionnaire for Last Bookmark listed above (do your own calculation to find the mean):

[[File:QuestionnaireForLastBookmark.png]]

Changed files:
:app/controllers/bookmarks_controller.rb
helper_method :specific_average_score
helper_method :total_average_score

def specific_average_score(bookmark)
if bookmark.nil?
return '-'
else
assessment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assessment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assessment.id,
reviewee_id: bookmark.id,
reviewer_id: AssignmentParticipant.find_by(user_id: current_user.id).id).flat_map {|r| Response.where(map_id: r.id) }
score = Answer.get_total_score(response: responses, questions: questions)
if score.nil?
return '-'
else
(score * 5.0 / 100.0).round(2)
end
end
end

def total_average_score(bookmark)
if bookmark.nil?
return '-'
else
assessment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assessment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assessment.id,
reviewee_id: bookmark.id).flat_map {|r| Response.where(map_id: r.id) }
totalScore = Answer.compute_scores(responses, questions)
if totalScore[:avg].nil?
return '-'
else
(totalScore[:avg] * 5.0 / 100.0).round(2)
end
end
end

:app/views/bookmarks/list.html.erb

<% totalAvg = total_average_score(bookmark) %>
<% if totalAvg != 0 %>
<%= totalAvg %>
<% else %>
<%= '-' %>
<% end %>


<% specAvg = specific_average_score(bookmark) %>
<% if specAvg != 0 %>
<%= specAvg %>
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/12?file-filters%5B%5D= here]

'''Addition of badges for exceptionally helpful bookmarks:'''
Originally, no badge system was setup for bookmarks that have proven to be helpful guides for other students taking on the same project. The new changes introduced allows bookmarks to be attached to bookmarks with exceptionally good average ratings (i.e, above a rating of 3). A badge is signified by a full star while the absence of a badge is represented by an empty star.

[[File:Bookmark list.png]]

Changed files:
:app/views/bookmarks/list.html.erb
<th class="head">Badge</th>

<td>

<% if totalAvg.to_f > 3 %>

<% else %>

<% end %>
</td>

Pull request can be found [https://github.com/hosungh/expertiza/pull/14?file-filters%5B%5D= here]

'''Users cannot rate bookmarks they've uploaded. '''
We wanted to make sure that users cannot rate bookmarks that they uploaded.

Changed files:
:app/views/bookmarks/list.html.erb
<% unless session[:user].id == bookmark.user_id %>
# ... code for rating the bookmarks
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/1/files?w=1 here]

'''Users cannot review bookmarks they've uploaded using the questionnaire. '''
We also wanted to make sure that users cannot review bookmarks that they uploaded using the questionnaires.

Changed files:
:app/views/bookmarks/list.html.erb
<% unless session[:user].id == bookmark.user_id %>
# ... code for reviewing bookmarks using the questionnaire
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/5/files?w=1 here]

'''Users should be able to see the number of bookmarks from the topics list. '''
Previously, users could add bookmarks, but could not tell how many bookmarks were provided for each topic (if any) without clicking the "View bookmarks" icon. This UI change displays the number of bookmarks for the topic inside the view bookmarks icon from the topic list view so that users don't need to click through each topic individually.

[[File:Sign up sheet bookmarks.png]]

Changed files:
:app/views/sign_up_sheet/_actions.html.erb
<nowiki></nowiki>
<nowiki><%= Bookmark.where(topic_id: topic.id).length.to_s %></nowiki>
<nowiki></nowiki>

Pull request can be found [https://github.com/hosungh/expertiza/pull/6/files here]

'''UI changes to make finding your bookmarks easier:'''
We added a "View Bookmarks" link to the student task view, that takes the student directly to the bookmarks that have been submitted for their topic. This code was then modified such that the link is greyed out if the student does not have a topic, and is hidden if bookmarks are not enabled for the assignment.

Changed files:
:app/controllers/student_task_controller.rb
:app/views/student_task/view.html.erb
<% if @use_bookmark %>
<<nowiki />li>>
<% if @topic_id and @assignment.submission_allowed(@topic_id) %>
<%= link_to "View bookmarks", :controller=>'bookmarks', :action=> 'list', :id => @topic_id %> (View bookmarks others have submitted for your topic)
<% else %>
<<nowiki />font color="gray">View bookmarks (You have to choose a topic first)
<% end %>
<<nowiki />/li>
<% end %>

Relevant commits can be found [https://github.com/hosungh/expertiza/commit/04b24b1dedd3414f58f52d394f2a5b9568e83872 here] [https://github.com/hosungh/expertiza/commit/15a775624307651755a70e63625a370478aa63b4 here] and [https://github.com/hosungh/expertiza/commit/f144594ae062369754d54288eff8959136510ccc here]

'''Grey out add/view bookmarks link on the topic page if bookmarks are not enabled.''' Previously, students could submit and view bookmarks even if bookmarks were disabled for the assignment. Now these options are hidden.

Changed files:
:app/views/sign_up_sheet/_actions.html.erb
<% if @use_bookmark %>
<<nowiki />%= link_to :controller=>'bookmarks', :action=> 'list', :id => topic.id do %>
<<nowiki />span class="fa-stack fa-md" title='View topic bookmarks'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x">
<<nowiki />p class="fa fa-stack-2x fa-inverse" style='font-size: 1.0em; padding-top: 2px; font-weight: bold;'>
<%= Bookmark.where(topic_id: topic.id).length.to_s %>
<<nowiki />/p>
<<nowiki />/span>
<% end %>
<%= link_to :controller=>'bookmarks', :action=> 'new', :id => topic.id , :assignment_id => params[:assignment_id] do %>
<<nowiki />span class="fa-stack fa-md" title='Add bookmark to topic'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x">
<<nowiki />i class="fa fa-plus fa-stack-1x fa-inverse" style='font-size: .5em'>
<<nowiki />/span>
<% end %>
<<nowiki />% else %>
<<nowiki />span class="fa-stack fa-md" title='View topic bookmarks'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x" style="opacity: 0.3;">

<% end %>

:app/views/sign_up_sheet/_table_header.html.erb
<<nowiki />th width="10%"> Bookmarks
<% unless @use_bookmark %> (disabled) <% end %>
<<nowiki />/th>

Commit can be found [https://github.com/hosungh/expertiza/commit/f0352ddf441d3773109b2e0208981f3fe122b5df here]

[[File:Disable-bookmark-links.png]]

'''Modify Bookmark delete permissions. '''
Bookmarks should be deletable by the user who created the bookmark, a teammate of the user who provided the bookmark, and the instructor.

Changed files:
:app/views/bookmarks/list.html.erb

<% is_teammate = false %>
<% team = SignedUpTeam.find_by(topic_id: @topic.id) rescue nil %>
<% if team %>
<% teams_users = TeamsUser.where(['team_id = ?', team.team_id]) %>
<% is_teammate = teams_users.select {|tu| tu.user_id == session[:user].id}.size > 0 %>
<% end %>
<% if bookmark.user_id == session[:user].id or is_teammate or ['Instructor'].include? @current_role_name %>
<nowiki><td><%= link_to 'Edit Bookmark', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy Bookmark', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/13/files here]

'''Fix the ability to create bookmark questionnaires and use in assignments.'''
Previously, questionnaires for things like Teammate Reviews could be created and used in assignments. Users could fill these out and the scores would be stored for later reference by TAs and instructors. The questionnaire for bookmark reviews was previously not functional, but now instructors can create new bookmark questionnaires and assign them to assignments.

Changed files:
:app/controllers/questionnaires_controller.rb
@questionnaire = Object.const_get(params[:model].split.join).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:model].split.join
....
if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)

:app/controllers/questionnaires_controller.rb
....
when "bookmark"
bookmark = Bookmark.find(@map.response_map.reviewee_id)
redirect_to controller: 'bookmarks', action: 'list', id: bookmark.topic_id
....
"BookmarkRatingResponseMap"

:app/models/bookmark_rating_response_map.rb
....
self.assignment.questionnaires.find_by(type: 'BookmarkRatingQuestionnaire')

:app/views/bookmarks/list.html.erb
....
<td>
<% assignment_participant = AssignmentParticipant.find_by(user_id: session[:user].id) %>
<% map = BookmarkRatingResponseMap.where(reviewed_object_id: @topic.assignment.id, reviewer_id: assignment_participant.id, reviewee_id: bookmark.id).first %>
<% if map.nil? %>
<% map = BookmarkRatingResponseMap.create(reviewed_object_id: @topic.assignment.id, reviewer_id: assignment_participant.id, reviewee_id: bookmark.id) %>
<% end %>
<% review = map.response.last %>
<% if review.nil? %>
<%= link_to "Review", {:controller => 'response', :action => 'new', :id => map.map_id, :return => "bookmark"} %>
<% else %>
<%= link_to "View", {:controller => 'response', :action => 'view', :id => review.id} %>
<%= link_to "Edit", {:controller => 'response', :action => 'edit', :id => review.id, :return => "bookmark"} %>
<% end %>
</td>
<nowiki><% if bookmark.user_id == session[:user].id %></nowiki>
<nowiki><td><%= link_to 'Edit', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<nowiki><td><%= link_to 'Edit Bookmark', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy Bookmark', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<% end %>

:app/views/response/view.html.erb
<% if !(@map.instance_of? TeammateReviewResponseMap) && !@map.survey? && !(@map.instance_of? BookmarkRatingResponseMap) %>
....

Pull request can be found [https://github.com/hosungh/expertiza/pull/3/files here]

'''Instructors should have the ability to view all bookmark responses. '''
Instructors should have a way to view all the responses to the bookmark questionnaires so that can see which bookmarks provided were deemed useful.

[[File:Bookmark response list.png]]

Changed files:
:app/helpers/report_formatter_helper.rb
def bookmark_rating_response_map(params, _session = nil)
assign_basics(params)
@reviewers = BookmarkRatingResponseMap.bookmark_response_report(@id)
@topics = @assignment.sign_up_topics
end

:app/models/bookmark_rating_response_map.rb
class BookmarkRatingResponseMap < ReviewResponseMap

def self.bookmark_response_report(id)
BookmarkRatingResponseMap.select("DISTINCT reviewer_id").where("reviewed_object_id = ?", id)
end

:app/views/reports/_bookmark_rating_report.html.erb
<%= create_report_table_header("Reviewed By" => "16%",
"Topic" => "14%",
"Bookmark Review" => "20%",
"Submitted By" => "20%",
"Last reviewed at" => "20%") %>
<%@l = -1 %>

<% @reviewers.each do |r| %>
<% @user = User.find(Participant.find(r.reviewer_id).user_id) %>
<% @bookmark_rating_response_maps = BookmarkRatingResponseMap.where(reviewer_id: r.reviewer_id, reviewed_object_id: @id) %>

<% maps = @bookmark_rating_response_maps.select { |m| !Response.where(map_id: m.id).first.blank? and m.reviewee and m.reviewee.user_id != @user.id }%>

<%@l = @l+1 %>
<% (@l % 2 == 0) ? @bgcolor = "#ffffff" : @bgcolor = "#f9f9f9" %>

<tr>

<% if maps.count > 0 %>

<td bgcolor=<%= @bgcolor %> rowspan= <%= maps.count %>>
<% @reviewer_name = @user.fullname(session[:ip]) %>
<%= link_to @reviewer_name, :controller => 'popup', :action => 'reviewer_details_popup', :id => r.reviewer_id, :assignment_id => @id %>
</td>

<% maps.each do |map| %>
<% @reviewee = map.reviewee %>

<td bgcolor=<%= @bgcolor %> align="left" colspan=1>
<% topic = SignUpTopic.find(@reviewee.topic_id) %>
<%= topic.topic_name %>
</td>


<td id = "green" bgcolor=<%= @bgcolor %> align="left" colspan=1>
<%= link_to @reviewee.title, {:controller => 'response', :action => 'view', :id => map.response.last.id}, :title => "Click here to view this bookmark review" %>
</td>


<td id = "green" bgcolor=<%= @bgcolor %> style="color:#DD3300" align="left" colspan=1>
<% reviewed_by_user = User.find(@reviewee.user_id).name %>
<%= link_to reviewed_by_user, impersonate_impersonate_path(:user => {:name => reviewed_by_user}), :method => :post, :title => "Click here to impersonate this user" %>
</td>


<td bgcolor=<%= @bgcolor %> align="left">
<% @bookmark_review_response = Response.where(map_id: map.id).first %>
<%= @bookmark_review_response.updated_at.to_time.strftime("%m/%d/%Y - %I:%M%p") %>
</td>

</tr>
<tr>
<% end %>
<% end %>
</tr>
<% end %>
</table>
</div>

:app/views/reports/_searchbox.html.erb
....
<option value='BookmarkRatingResponseMap' >
Bookmark Review Report
</option>
....
<% elsif @type == "BookmarkReviewResponseMap" %>
<nowiki><h1> Bookmark review report for <%= @assignment.name%> </h1></nowiki>
....

:app/views/reports/response_report.html.haml
- elsif @type == "BookmarkRatingResponseMap"
= render :partial => 'bookmark_rating_report'

Pull request can be found [https://github.com/hosungh/expertiza/pull/10/files here]

=='''Testing Plan'''==

'''Testing from the UI'''

* Create a Bookmark Questionnaire
# After logging in as the instructor, go to Manage > Questionnaires.
# Find 'Bookmark Rating' and click the '+' to create a new questionnaire.
# Give a name for this questionnaire, leave the min and max score at 0 and 5 respectively, and click 'Create'.
# Go to Manage > Questionnaires and click on 'Bookmark Rating' to view all of the questionnaires. Click the edit icon for the questionnaire you just created.
# Select 'Add 1 more Criterion question(s)'.
# For the question, enter "Does this bookmark appear to have been used by the author?" and leave the other fields blank. This question will be helpful in determining how useful the bookmark was.
# Click 'Save bookmark rating questionnaire'. Now this questionnaire can be used in assignments.

* Enable Bookmarks
# After logging in as the instructor, go to Manage > Assignments.
# Choose an assignment that will be used for testing and have bookmarks enabled and select the edit icon under Actions.
# Under Topics Tab select 'Allow participants to create bookmarks?'.
# Go to Rubrics tab, under 'Bookmark Rating' select the Bookmark review questionnaire that was previously created to use for reviewing the bookmarks.

* Add a Bookmark to a Topic
# Log in as a student who is a participant of the assignment with bookmarks enabled and select that assignment.
# Select a "Signup sheet" to see the list of available topics.
# Choose a topic and select the 'Add bookmark to topic' icon from the Bookmarks column. The 'Add bookmark to topic' icon has a '+' sign.
# Fill in all the fields for the bookmark, including Title, Url, and Description and click 'Add new bookmark'.
# You should now see a page listing all bookmarks for this topic.

* Viewing all Bookmarks for a Topic
# Log in as a student who is a participant of the assignment with bookmarks enabled (or an instructor) and select that assignment.
# Select a "Signup sheet" to see the list of available topics.
# The number of bookmarks for each topic should be displayed visually inside the 'View topic bookmarks' icon in the bookmarks column.
# Click the 'View topic bookmarks icon' to see a list of all bookmarks for this topic.

* Editing and Destroying Bookmarks for a Topic
# Perform this test with each of the following users: an instructor, a user who is assigned to the topic, and a teammate of the user who is assigned to the topic.
## Log in with the user and select the assignment with bookmarks enabled.
## Select a "Signup sheet" to see the list of available topics.
## Click the 'View topic bookmarks icon' to see a list of all bookmarks for this topic.
## The user should see links to 'Edit Bookmark' and 'Destroy Bookmark' next to a bookmark only if the user is an instructor, the user submitted the bookmark, or the user is a teammate of the user who submitted the bookmark.

'''Automated Testing with RSpec'''

The current version of Expertiza does not have any tests for the bookmark controller or model. We intend on adding comprehensive RSpec tests for all changes we have added to controller classes and unit tests for model classes.

===Code Coverage===

=='''Application Deployment'''==

This web application deployed on VCL is located at [http://152.46.17.220:8080 http://152.46.17.220:8080]

=='''Team Information'''==
Danielle Hancock

Eric Peden

Hosung Hwang

Mentor: Abhirav Kariya

=='''References'''==
1. [https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2. [https://github.com/hosungh/expertiza/ Forked GitHub Repo]

3. [http://152.46.17.220:8080 Deployed Application]

4. [https://github.com/expertiza/expertiza/pull/1704/ Beta Branch Pull Request]

File:QuestionnaireForLastBookmark.png

2020-03-23T23:30:06Z

Hhwang4:

CSC/ECE 517 Spring 2020 - E2005. Bookmark enhancements

2020-03-23T23:27:58Z

Hhwang4: /* Code Modifications */

==E2005. Bookmark Enhancements==

=='''Introduction'''==

===About Expertiza===
[http://expertiza.ncsu.edu/ Expertiza] is an open-source project that is built using the [http://rubyonrails.org/ Ruby on Rails] framework. At its core, it is a highly versatile tool that academic institutions can use to craft learning objectives centered around team projects, peer reviews, and highly-customizable assignments.

=='''Problem Statement'''==
The purpose of this project was to add meaningful enhancements and fixes to the bookmark feature in Expertiza, entities that can be attached to a topic to aid the authors who decide to take on a certain assignment. While the major functionality of the bookmark feature was already present by the time the team embarked on this project (most notably the ability to create/edit and rate bookmarks), many desired functions were conveniently broken or left out.

===Completed Stories===
Below is a breakdown of the stories that were drawn up and completed for this project:

1. Need a way to view all responses to the bookmark questionnaires.

2. Modify permissions for deleting bookmarks.The person who creates the bookmark, the team for whom the bookmark is meant, and the instructor, should be able to delete.

3. "View bookmarks" link on student_task/view breaks if the student has not selected a topic yet.

4. Bookmark rating questionnaire should include question asking the reviewer whether or not the bookmark appears to have been used by the author. Get the bookmark questionnaire functioning and add to the bookmark list page.

5. Fix issue in which users should not be able to review their own bookmark using the questionnaire, but currently can.

6. Add a number next to/inside the icon with the number of current bookmark in order to make it clear whether a bookmark exists for a topic.

7. Add a "View bookmarks" link to the assignment view page for easier access.

8. Add rating to the bookmark questionnaire and use that rating to calculate the average instead of using the current dropdown.

9. A student should not be able to rate his/her own bookmark.

10. Add URL to bookmark list for assignment topic on the assignment page, to make viewing bookmarks easier.

11. Instructors cannot currently see bookmarks (gets an error message saying instructors cannot create bookmarks).

12. "Back" button from Bookmarks list is broken.

13. When creating a bookmark with an empty description field, the notice says the bookmark was successfully created even though it fails.

14. "Bookmark ratings" should be a type of rubric when you go to Manage > Questionnaires. Although 'Bookmark Rating' is already a type of rubric, it isn't listed when hovering over Manage... > Questionnaires

15. Create a way to mark a bookmark that was rated to be helpful by all reviewers, on average.

16. Students can add/view bookmarks when "Allow participants to create bookmarks?" box is unchecked for the assignment.

=='''Code Modifications'''==

'''Fix the "Back" button:'''
When either backing out of creating or viewing/editing a bookmark, the back functionality does not work, both prompting errors. Issue has been fixed and users can once again go back to the appropriate page.

Changed files:
:app/views/bookmarks/list.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

:app/views/bookmarks/new.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

:app/views/bookmarks/edit.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

Pull request can be found [https://github.com/hosungh/expertiza/pull/2?file-filters%5B%5D= here]

Commit for "Back" capability when updating bookmark can be found [https://github.com/hosungh/expertiza/pull/4?file-filters%5B%5D= here]

'''Check whether text field is present when creating/updating bookmark:'''
Previously, when a bookmark was created/updated and the corresponding "Title", "URL", or "Description" text fields were not filled in, the bookmark was not created or updated sans any error or warning. In fact, the user would be taken to the list of bookmarks available, forcing him/her to go back to the page corresponding to the bookmark create/edit page. This fix prompts users with an error indicating which text field needs to be filled in in order to fulfill the particular bookmark create/edit function.

[[File:CheckFieldsTitle.png]][[File:CheckFieldsUrl.png]][[File:CheckFieldsDescription.png]]

Changed files:
:app/views/bookmarks/new.html.erb
<%= label_tag 'Title' %> 
<%= text_field_tag :title, params[:title], :required => true %> 
<%= label_tag 'Url' %> 
<%= text_field_tag :url, params[:url], :required => true %> 
<%= label_tag 'Description' %> 
<%= text_area_tag :description, params[:description], :required => true %> 

:app/views/bookmarks/edit.html.erb
<%= label_tag 'Title' %> 
<%= f.text_field :title, :required => true %> 
<%= label_tag 'Url' %> 
<%= f.text_field :url, :required => true %> 
<%= label_tag 'Description' %> 
<%= f.text_area :description, :required => true %> 

Pull request can be found [https://github.com/hosungh/expertiza/pull/4?file-filters%5B%5D= here]

'''Change average bookmark rating to be based on questionnaire:'''
The rating system for the bookmarks before these changes were elementary in nature - there was a drop-down menu to choose your particular rating for a bookmark while there was an average calculator just to the left of the aforementioned column. The new changes introduced allows the "Your rating" and "Avg. rating" columns for a particular bookmark to be calculated based on the scores given to the various questions present in a given bookmark questionnaire. The "Avg. rating" is calculated based on the mean rating of all the bookmark questionnaires scored by every reviewer while "Your rating" is simply the mean of the scores that you (the user) gave to all the questions on the questionnaire.

[[File:BookmarkAvgRatings.png]]

Changed files:
:app/controllers/bookmarks_controller.rb
helper_method :specific_average_score
helper_method :total_average_score

def specific_average_score(bookmark)
if bookmark.nil?
return '-'
else
assessment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assessment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assessment.id,
reviewee_id: bookmark.id,
reviewer_id: AssignmentParticipant.find_by(user_id: current_user.id).id).flat_map {|r| Response.where(map_id: r.id) }
score = Answer.get_total_score(response: responses, questions: questions)
if score.nil?
return '-'
else
(score * 5.0 / 100.0).round(2)
end
end
end

def total_average_score(bookmark)
if bookmark.nil?
return '-'
else
assessment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assessment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assessment.id,
reviewee_id: bookmark.id).flat_map {|r| Response.where(map_id: r.id) }
totalScore = Answer.compute_scores(responses, questions)
if totalScore[:avg].nil?
return '-'
else
(totalScore[:avg] * 5.0 / 100.0).round(2)
end
end
end

:app/views/bookmarks/list.html.erb

<% totalAvg = total_average_score(bookmark) %>
<% if totalAvg != 0 %>
<%= totalAvg %>
<% else %>
<%= '-' %>
<% end %>


<% specAvg = specific_average_score(bookmark) %>
<% if specAvg != 0 %>
<%= specAvg %>
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/12?file-filters%5B%5D= here]

'''Addition of badges for exceptionally helpful bookmarks:'''
Originally, no badge system was setup for bookmarks that have proven to be helpful guides for other students taking on the same project. The new changes introduced allows bookmarks to be attached to bookmarks with exceptionally good average ratings (i.e, above a rating of 3). A badge is signified by a full star while the absence of a badge is represented by an empty star.

[[File:Bookmark list.png]]

Changed files:
:app/views/bookmarks/list.html.erb
<th class="head">Badge</th>

<td>

<% if totalAvg.to_f > 3 %>

<% else %>

<% end %>
</td>

Pull request can be found [https://github.com/hosungh/expertiza/pull/14?file-filters%5B%5D= here]

'''Users cannot rate bookmarks they've uploaded. '''
We wanted to make sure that users cannot rate bookmarks that they uploaded.

Changed files:
:app/views/bookmarks/list.html.erb
<% unless session[:user].id == bookmark.user_id %>
# ... code for rating the bookmarks
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/1/files?w=1 here]

'''Users cannot review bookmarks they've uploaded using the questionnaire. '''
We also wanted to make sure that users cannot review bookmarks that they uploaded using the questionnaires.

Changed files:
:app/views/bookmarks/list.html.erb
<% unless session[:user].id == bookmark.user_id %>
# ... code for reviewing bookmarks using the questionnaire
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/5/files?w=1 here]

'''Users should be able to see the number of bookmarks from the topics list. '''
Previously, users could add bookmarks, but could not tell how many bookmarks were provided for each topic (if any) without clicking the "View bookmarks" icon. This UI change displays the number of bookmarks for the topic inside the view bookmarks icon from the topic list view so that users don't need to click through each topic individually.

[[File:Sign up sheet bookmarks.png]]

Changed files:
:app/views/sign_up_sheet/_actions.html.erb
<nowiki></nowiki>
<nowiki><%= Bookmark.where(topic_id: topic.id).length.to_s %></nowiki>
<nowiki></nowiki>

Pull request can be found [https://github.com/hosungh/expertiza/pull/6/files here]

'''UI changes to make finding your bookmarks easier:'''
We added a "View Bookmarks" link to the student task view, that takes the student directly to the bookmarks that have been submitted for their topic. This code was then modified such that the link is greyed out if the student does not have a topic, and is hidden if bookmarks are not enabled for the assignment.

Changed files:
:app/controllers/student_task_controller.rb
:app/views/student_task/view.html.erb
<% if @use_bookmark %>
<<nowiki />li>>
<% if @topic_id and @assignment.submission_allowed(@topic_id) %>
<%= link_to "View bookmarks", :controller=>'bookmarks', :action=> 'list', :id => @topic_id %> (View bookmarks others have submitted for your topic)
<% else %>
<<nowiki />font color="gray">View bookmarks (You have to choose a topic first)
<% end %>
<<nowiki />/li>
<% end %>

Relevant commits can be found [https://github.com/hosungh/expertiza/commit/04b24b1dedd3414f58f52d394f2a5b9568e83872 here] [https://github.com/hosungh/expertiza/commit/15a775624307651755a70e63625a370478aa63b4 here] and [https://github.com/hosungh/expertiza/commit/f144594ae062369754d54288eff8959136510ccc here]

'''Grey out add/view bookmarks link on the topic page if bookmarks are not enabled.''' Previously, students could submit and view bookmarks even if bookmarks were disabled for the assignment. Now these options are hidden.

Changed files:
:app/views/sign_up_sheet/_actions.html.erb
<% if @use_bookmark %>
<<nowiki />%= link_to :controller=>'bookmarks', :action=> 'list', :id => topic.id do %>
<<nowiki />span class="fa-stack fa-md" title='View topic bookmarks'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x">
<<nowiki />p class="fa fa-stack-2x fa-inverse" style='font-size: 1.0em; padding-top: 2px; font-weight: bold;'>
<%= Bookmark.where(topic_id: topic.id).length.to_s %>
<<nowiki />/p>
<<nowiki />/span>
<% end %>
<%= link_to :controller=>'bookmarks', :action=> 'new', :id => topic.id , :assignment_id => params[:assignment_id] do %>
<<nowiki />span class="fa-stack fa-md" title='Add bookmark to topic'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x">
<<nowiki />i class="fa fa-plus fa-stack-1x fa-inverse" style='font-size: .5em'>
<<nowiki />/span>
<% end %>
<<nowiki />% else %>
<<nowiki />span class="fa-stack fa-md" title='View topic bookmarks'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x" style="opacity: 0.3;">

<% end %>

:app/views/sign_up_sheet/_table_header.html.erb
<<nowiki />th width="10%"> Bookmarks
<% unless @use_bookmark %> (disabled) <% end %>
<<nowiki />/th>

Commit can be found [https://github.com/hosungh/expertiza/commit/f0352ddf441d3773109b2e0208981f3fe122b5df here]

[[File:Disable-bookmark-links.png]]

'''Modify Bookmark delete permissions. '''
Bookmarks should be deletable by the user who created the bookmark, a teammate of the user who provided the bookmark, and the instructor.

Changed files:
:app/views/bookmarks/list.html.erb

<% is_teammate = false %>
<% team = SignedUpTeam.find_by(topic_id: @topic.id) rescue nil %>
<% if team %>
<% teams_users = TeamsUser.where(['team_id = ?', team.team_id]) %>
<% is_teammate = teams_users.select {|tu| tu.user_id == session[:user].id}.size > 0 %>
<% end %>
<% if bookmark.user_id == session[:user].id or is_teammate or ['Instructor'].include? @current_role_name %>
<nowiki><td><%= link_to 'Edit Bookmark', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy Bookmark', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/13/files here]

'''Fix the ability to create bookmark questionnaires and use in assignments.'''
Previously, questionnaires for things like Teammate Reviews could be created and used in assignments. Users could fill these out and the scores would be stored for later reference by TAs and instructors. The questionnaire for bookmark reviews was previously not functional, but now instructors can create new bookmark questionnaires and assign them to assignments.

Changed files:
:app/controllers/questionnaires_controller.rb
@questionnaire = Object.const_get(params[:model].split.join).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:model].split.join
....
if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)

:app/controllers/questionnaires_controller.rb
....
when "bookmark"
bookmark = Bookmark.find(@map.response_map.reviewee_id)
redirect_to controller: 'bookmarks', action: 'list', id: bookmark.topic_id
....
"BookmarkRatingResponseMap"

:app/models/bookmark_rating_response_map.rb
....
self.assignment.questionnaires.find_by(type: 'BookmarkRatingQuestionnaire')

:app/views/bookmarks/list.html.erb
....
<td>
<% assignment_participant = AssignmentParticipant.find_by(user_id: session[:user].id) %>
<% map = BookmarkRatingResponseMap.where(reviewed_object_id: @topic.assignment.id, reviewer_id: assignment_participant.id, reviewee_id: bookmark.id).first %>
<% if map.nil? %>
<% map = BookmarkRatingResponseMap.create(reviewed_object_id: @topic.assignment.id, reviewer_id: assignment_participant.id, reviewee_id: bookmark.id) %>
<% end %>
<% review = map.response.last %>
<% if review.nil? %>
<%= link_to "Review", {:controller => 'response', :action => 'new', :id => map.map_id, :return => "bookmark"} %>
<% else %>
<%= link_to "View", {:controller => 'response', :action => 'view', :id => review.id} %>
<%= link_to "Edit", {:controller => 'response', :action => 'edit', :id => review.id, :return => "bookmark"} %>
<% end %>
</td>
<nowiki><% if bookmark.user_id == session[:user].id %></nowiki>
<nowiki><td><%= link_to 'Edit', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<nowiki><td><%= link_to 'Edit Bookmark', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy Bookmark', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<% end %>

:app/views/response/view.html.erb
<% if !(@map.instance_of? TeammateReviewResponseMap) && !@map.survey? && !(@map.instance_of? BookmarkRatingResponseMap) %>
....

Pull request can be found [https://github.com/hosungh/expertiza/pull/3/files here]

'''Instructors should have the ability to view all bookmark responses. '''
Instructors should have a way to view all the responses to the bookmark questionnaires so that can see which bookmarks provided were deemed useful.

[[File:Bookmark response list.png]]

Changed files:
:app/helpers/report_formatter_helper.rb
def bookmark_rating_response_map(params, _session = nil)
assign_basics(params)
@reviewers = BookmarkRatingResponseMap.bookmark_response_report(@id)
@topics = @assignment.sign_up_topics
end

:app/models/bookmark_rating_response_map.rb
class BookmarkRatingResponseMap < ReviewResponseMap

def self.bookmark_response_report(id)
BookmarkRatingResponseMap.select("DISTINCT reviewer_id").where("reviewed_object_id = ?", id)
end

:app/views/reports/_bookmark_rating_report.html.erb
<%= create_report_table_header("Reviewed By" => "16%",
"Topic" => "14%",
"Bookmark Review" => "20%",
"Submitted By" => "20%",
"Last reviewed at" => "20%") %>
<%@l = -1 %>

<% @reviewers.each do |r| %>
<% @user = User.find(Participant.find(r.reviewer_id).user_id) %>
<% @bookmark_rating_response_maps = BookmarkRatingResponseMap.where(reviewer_id: r.reviewer_id, reviewed_object_id: @id) %>

<% maps = @bookmark_rating_response_maps.select { |m| !Response.where(map_id: m.id).first.blank? and m.reviewee and m.reviewee.user_id != @user.id }%>

<%@l = @l+1 %>
<% (@l % 2 == 0) ? @bgcolor = "#ffffff" : @bgcolor = "#f9f9f9" %>

<tr>

<% if maps.count > 0 %>

<td bgcolor=<%= @bgcolor %> rowspan= <%= maps.count %>>
<% @reviewer_name = @user.fullname(session[:ip]) %>
<%= link_to @reviewer_name, :controller => 'popup', :action => 'reviewer_details_popup', :id => r.reviewer_id, :assignment_id => @id %>
</td>

<% maps.each do |map| %>
<% @reviewee = map.reviewee %>

<td bgcolor=<%= @bgcolor %> align="left" colspan=1>
<% topic = SignUpTopic.find(@reviewee.topic_id) %>
<%= topic.topic_name %>
</td>


<td id = "green" bgcolor=<%= @bgcolor %> align="left" colspan=1>
<%= link_to @reviewee.title, {:controller => 'response', :action => 'view', :id => map.response.last.id}, :title => "Click here to view this bookmark review" %>
</td>


<td id = "green" bgcolor=<%= @bgcolor %> style="color:#DD3300" align="left" colspan=1>
<% reviewed_by_user = User.find(@reviewee.user_id).name %>
<%= link_to reviewed_by_user, impersonate_impersonate_path(:user => {:name => reviewed_by_user}), :method => :post, :title => "Click here to impersonate this user" %>
</td>


<td bgcolor=<%= @bgcolor %> align="left">
<% @bookmark_review_response = Response.where(map_id: map.id).first %>
<%= @bookmark_review_response.updated_at.to_time.strftime("%m/%d/%Y - %I:%M%p") %>
</td>

</tr>
<tr>
<% end %>
<% end %>
</tr>
<% end %>
</table>
</div>

:app/views/reports/_searchbox.html.erb
....
<option value='BookmarkRatingResponseMap' >
Bookmark Review Report
</option>
....
<% elsif @type == "BookmarkReviewResponseMap" %>
<nowiki><h1> Bookmark review report for <%= @assignment.name%> </h1></nowiki>
....

:app/views/reports/response_report.html.haml
- elsif @type == "BookmarkRatingResponseMap"
= render :partial => 'bookmark_rating_report'

Pull request can be found [https://github.com/hosungh/expertiza/pull/10/files here]

=='''Testing Plan'''==

'''Testing from the UI'''

* Create a Bookmark Questionnaire
# After logging in as the instructor, go to Manage > Questionnaires.
# Find 'Bookmark Rating' and click the '+' to create a new questionnaire.
# Give a name for this questionnaire, leave the min and max score at 0 and 5 respectively, and click 'Create'.
# Go to Manage > Questionnaires and click on 'Bookmark Rating' to view all of the questionnaires. Click the edit icon for the questionnaire you just created.
# Select 'Add 1 more Criterion question(s)'.
# For the question, enter "Does this bookmark appear to have been used by the author?" and leave the other fields blank. This question will be helpful in determining how useful the bookmark was.
# Click 'Save bookmark rating questionnaire'. Now this questionnaire can be used in assignments.

* Enable Bookmarks
# After logging in as the instructor, go to Manage > Assignments.
# Choose an assignment that will be used for testing and have bookmarks enabled and select the edit icon under Actions.
# Under Topics Tab select 'Allow participants to create bookmarks?'.
# Go to Rubrics tab, under 'Bookmark Rating' select the Bookmark review questionnaire that was previously created to use for reviewing the bookmarks.

* Add a Bookmark to a Topic
# Log in as a student who is a participant of the assignment with bookmarks enabled and select that assignment.
# Select a "Signup sheet" to see the list of available topics.
# Choose a topic and select the 'Add bookmark to topic' icon from the Bookmarks column. The 'Add bookmark to topic' icon has a '+' sign.
# Fill in all the fields for the bookmark, including Title, Url, and Description and click 'Add new bookmark'.
# You should now see a page listing all bookmarks for this topic.

* Viewing all Bookmarks for a Topic
# Log in as a student who is a participant of the assignment with bookmarks enabled (or an instructor) and select that assignment.
# Select a "Signup sheet" to see the list of available topics.
# The number of bookmarks for each topic should be displayed visually inside the 'View topic bookmarks' icon in the bookmarks column.
# Click the 'View topic bookmarks icon' to see a list of all bookmarks for this topic.

* Editing and Destroying Bookmarks for a Topic
# Perform this test with each of the following users: an instructor, a user who is assigned to the topic, and a teammate of the user who is assigned to the topic.
## Log in with the user and select the assignment with bookmarks enabled.
## Select a "Signup sheet" to see the list of available topics.
## Click the 'View topic bookmarks icon' to see a list of all bookmarks for this topic.
## The user should see links to 'Edit Bookmark' and 'Destroy Bookmark' next to a bookmark only if the user is an instructor, the user submitted the bookmark, or the user is a teammate of the user who submitted the bookmark.

'''Automated Testing with RSpec'''

The current version of Expertiza does not have any tests for the bookmark controller or model. We intend on adding comprehensive RSpec tests for all changes we have added to controller classes and unit tests for model classes.

===Code Coverage===

=='''Application Deployment'''==

This web application deployed on VCL is located at [http://152.46.17.220:8080 http://152.46.17.220:8080]

=='''Team Information'''==
Danielle Hancock

Eric Peden

Hosung Hwang

Mentor: Abhirav Kariya

=='''References'''==
1. [https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2. [https://github.com/hosungh/expertiza/ Forked GitHub Repo]

3. [http://152.46.17.220:8080 Deployed Application]

4. [https://github.com/expertiza/expertiza/pull/1704/ Beta Branch Pull Request]

File:BookmarkBadges.png

2020-03-23T23:26:03Z

Hhwang4:

File:BookmarkAvgRatings.png

2020-03-23T23:25:46Z

Hhwang4:

CSC/ECE 517 Spring 2020 - E2005. Bookmark enhancements

2020-03-23T23:22:37Z

Hhwang4: /* Code Modifications */

==E2005. Bookmark Enhancements==

=='''Introduction'''==

===About Expertiza===
[http://expertiza.ncsu.edu/ Expertiza] is an open-source project that is built using the [http://rubyonrails.org/ Ruby on Rails] framework. At its core, it is a highly versatile tool that academic institutions can use to craft learning objectives centered around team projects, peer reviews, and highly-customizable assignments.

=='''Problem Statement'''==
The purpose of this project was to add meaningful enhancements and fixes to the bookmark feature in Expertiza, entities that can be attached to a topic to aid the authors who decide to take on a certain assignment. While the major functionality of the bookmark feature was already present by the time the team embarked on this project (most notably the ability to create/edit and rate bookmarks), many desired functions were conveniently broken or left out.

===Completed Stories===
Below is a breakdown of the stories that were drawn up and completed for this project:

1. Need a way to view all responses to the bookmark questionnaires.

2. Modify permissions for deleting bookmarks.The person who creates the bookmark, the team for whom the bookmark is meant, and the instructor, should be able to delete.

3. "View bookmarks" link on student_task/view breaks if the student has not selected a topic yet.

4. Bookmark rating questionnaire should include question asking the reviewer whether or not the bookmark appears to have been used by the author. Get the bookmark questionnaire functioning and add to the bookmark list page.

5. Fix issue in which users should not be able to review their own bookmark using the questionnaire, but currently can.

6. Add a number next to/inside the icon with the number of current bookmark in order to make it clear whether a bookmark exists for a topic.

7. Add a "View bookmarks" link to the assignment view page for easier access.

8. Add rating to the bookmark questionnaire and use that rating to calculate the average instead of using the current dropdown.

9. A student should not be able to rate his/her own bookmark.

10. Add URL to bookmark list for assignment topic on the assignment page, to make viewing bookmarks easier.

11. Instructors cannot currently see bookmarks (gets an error message saying instructors cannot create bookmarks).

12. "Back" button from Bookmarks list is broken.

13. When creating a bookmark with an empty description field, the notice says the bookmark was successfully created even though it fails.

14. "Bookmark ratings" should be a type of rubric when you go to Manage > Questionnaires. Although 'Bookmark Rating' is already a type of rubric, it isn't listed when hovering over Manage... > Questionnaires

15. Create a way to mark a bookmark that was rated to be helpful by all reviewers, on average.

16. Students can add/view bookmarks when "Allow participants to create bookmarks?" box is unchecked for the assignment.

=='''Code Modifications'''==

'''Fix the "Back" button:'''
When either backing out of creating or viewing/editing a bookmark, the back functionality does not work, both prompting errors. Issue has been fixed and users can once again go back to the appropriate page.

Changed files:
:app/views/bookmarks/list.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

:app/views/bookmarks/new.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

:app/views/bookmarks/edit.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

Pull request can be found [https://github.com/hosungh/expertiza/pull/2?file-filters%5B%5D= here]

Commit for "Back" capability when updating bookmark can be found [https://github.com/hosungh/expertiza/pull/4?file-filters%5B%5D= here]

'''Check whether text field is present when creating/updating bookmark:'''
Previously, when a bookmark was created/updated and the corresponding "Title", "URL", or "Description" text fields were not filled in, the bookmark was not created or updated sans any error or warning. In fact, the user would be taken to the list of bookmarks available, forcing him/her to go back to the page corresponding to the bookmark create/edit page. This fix prompts users with an error indicating which text field needs to be filled in in order to fulfill the particular bookmark create/edit function.

[[File:CheckFieldsTitle.png]][[File:CheckFieldsUrl.png]][[File:CheckFieldsDescription.png]]

Changed files:
:app/views/bookmarks/new.html.erb
<%= label_tag 'Title' %> 
<%= text_field_tag :title, params[:title], :required => true %> 
<%= label_tag 'Url' %> 
<%= text_field_tag :url, params[:url], :required => true %> 
<%= label_tag 'Description' %> 
<%= text_area_tag :description, params[:description], :required => true %> 

:app/views/bookmarks/edit.html.erb
<%= label_tag 'Title' %> 
<%= f.text_field :title, :required => true %> 
<%= label_tag 'Url' %> 
<%= f.text_field :url, :required => true %> 
<%= label_tag 'Description' %> 
<%= f.text_area :description, :required => true %> 

Pull request can be found [https://github.com/hosungh/expertiza/pull/4?file-filters%5B%5D= here]

'''Change average bookmark rating to be based on questionnaire:'''
The rating system for the bookmarks before these changes were elementary in nature - there was a drop-down menu to choose your particular rating for a bookmark while there was an average calculator just to the left of the aforementioned column. The new changes introduced allows the "Your rating" and "Avg. rating" columns for a particular bookmark to be calculated based on the scores given to the various questions present in a given bookmark questionnaire. The "Avg. rating" is calculated based on the mean rating of all the bookmark questionnaires scored by every reviewer while "Your rating" is simply the mean of the scores that you (the user) gave to all the questions on the questionnaire.

[[File:Avg_Ratings_and_Badges.png]]

Changed files:
:app/controllers/bookmarks_controller.rb
helper_method :specific_average_score
helper_method :total_average_score

def specific_average_score(bookmark)
if bookmark.nil?
return '-'
else
assessment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assessment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assessment.id,
reviewee_id: bookmark.id,
reviewer_id: AssignmentParticipant.find_by(user_id: current_user.id).id).flat_map {|r| Response.where(map_id: r.id) }
score = Answer.get_total_score(response: responses, questions: questions)
if score.nil?
return '-'
else
(score * 5.0 / 100.0).round(2)
end
end
end

def total_average_score(bookmark)
if bookmark.nil?
return '-'
else
assessment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assessment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assessment.id,
reviewee_id: bookmark.id).flat_map {|r| Response.where(map_id: r.id) }
totalScore = Answer.compute_scores(responses, questions)
if totalScore[:avg].nil?
return '-'
else
(totalScore[:avg] * 5.0 / 100.0).round(2)
end
end
end

:app/views/bookmarks/list.html.erb

<% totalAvg = total_average_score(bookmark) %>
<% if totalAvg != 0 %>
<%= totalAvg %>
<% else %>
<%= '-' %>
<% end %>


<% specAvg = specific_average_score(bookmark) %>
<% if specAvg != 0 %>
<%= specAvg %>
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/12?file-filters%5B%5D= here]

'''Addition of badges for exceptionally helpful bookmarks:'''
Originally, no badge system was setup for bookmarks that have proven to be helpful guides for other students taking on the same project. The new changes introduced allows bookmarks to be attached to bookmarks with exceptionally good average ratings (i.e, above a rating of 3). A badge is signified by a full star while the absence of a badge is represented by an empty star.

[[File:Bookmark list.png]]

Changed files:
:app/views/bookmarks/list.html.erb
<th class="head">Badge</th>

<td>

<% if totalAvg.to_f > 3 %>

<% else %>

<% end %>
</td>

Pull request can be found [https://github.com/hosungh/expertiza/pull/14?file-filters%5B%5D= here]

'''Users cannot rate bookmarks they've uploaded. '''
We wanted to make sure that users cannot rate bookmarks that they uploaded.

Changed files:
:app/views/bookmarks/list.html.erb
<% unless session[:user].id == bookmark.user_id %>
# ... code for rating the bookmarks
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/1/files?w=1 here]

'''Users cannot review bookmarks they've uploaded using the questionnaire. '''
We also wanted to make sure that users cannot review bookmarks that they uploaded using the questionnaires.

Changed files:
:app/views/bookmarks/list.html.erb
<% unless session[:user].id == bookmark.user_id %>
# ... code for reviewing bookmarks using the questionnaire
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/5/files?w=1 here]

'''Users should be able to see the number of bookmarks from the topics list. '''
Previously, users could add bookmarks, but could not tell how many bookmarks were provided for each topic (if any) without clicking the "View bookmarks" icon. This UI change displays the number of bookmarks for the topic inside the view bookmarks icon from the topic list view so that users don't need to click through each topic individually.

[[File:Sign up sheet bookmarks.png]]

Changed files:
:app/views/sign_up_sheet/_actions.html.erb
<nowiki></nowiki>
<nowiki><%= Bookmark.where(topic_id: topic.id).length.to_s %></nowiki>
<nowiki></nowiki>

Pull request can be found [https://github.com/hosungh/expertiza/pull/6/files here]

'''UI changes to make finding your bookmarks easier:'''
We added a "View Bookmarks" link to the student task view, that takes the student directly to the bookmarks that have been submitted for their topic. This code was then modified such that the link is greyed out if the student does not have a topic, and is hidden if bookmarks are not enabled for the assignment.

Changed files:
:app/controllers/student_task_controller.rb
:app/views/student_task/view.html.erb
<% if @use_bookmark %>
<<nowiki />li>>
<% if @topic_id and @assignment.submission_allowed(@topic_id) %>
<%= link_to "View bookmarks", :controller=>'bookmarks', :action=> 'list', :id => @topic_id %> (View bookmarks others have submitted for your topic)
<% else %>
<<nowiki />font color="gray">View bookmarks (You have to choose a topic first)
<% end %>
<<nowiki />/li>
<% end %>

Relevant commits can be found [https://github.com/hosungh/expertiza/commit/04b24b1dedd3414f58f52d394f2a5b9568e83872 here] [https://github.com/hosungh/expertiza/commit/15a775624307651755a70e63625a370478aa63b4 here] and [https://github.com/hosungh/expertiza/commit/f144594ae062369754d54288eff8959136510ccc here]

'''Grey out add/view bookmarks link on the topic page if bookmarks are not enabled.''' Previously, students could submit and view bookmarks even if bookmarks were disabled for the assignment. Now these options are hidden.

Changed files:
:app/views/sign_up_sheet/_actions.html.erb
<% if @use_bookmark %>
<<nowiki />%= link_to :controller=>'bookmarks', :action=> 'list', :id => topic.id do %>
<<nowiki />span class="fa-stack fa-md" title='View topic bookmarks'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x">
<<nowiki />p class="fa fa-stack-2x fa-inverse" style='font-size: 1.0em; padding-top: 2px; font-weight: bold;'>
<%= Bookmark.where(topic_id: topic.id).length.to_s %>
<<nowiki />/p>
<<nowiki />/span>
<% end %>
<%= link_to :controller=>'bookmarks', :action=> 'new', :id => topic.id , :assignment_id => params[:assignment_id] do %>
<<nowiki />span class="fa-stack fa-md" title='Add bookmark to topic'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x">
<<nowiki />i class="fa fa-plus fa-stack-1x fa-inverse" style='font-size: .5em'>
<<nowiki />/span>
<% end %>
<<nowiki />% else %>
<<nowiki />span class="fa-stack fa-md" title='View topic bookmarks'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x" style="opacity: 0.3;">

<% end %>

:app/views/sign_up_sheet/_table_header.html.erb
<<nowiki />th width="10%"> Bookmarks
<% unless @use_bookmark %> (disabled) <% end %>
<<nowiki />/th>

Commit can be found [https://github.com/hosungh/expertiza/commit/f0352ddf441d3773109b2e0208981f3fe122b5df here]

'''Modify Bookmark delete permissions. '''
Bookmarks should be deletable by the user who created the bookmark, a teammate of the user who provided the bookmark, and the instructor.

Changed files:
:app/views/bookmarks/list.html.erb

<% is_teammate = false %>
<% team = SignedUpTeam.find_by(topic_id: @topic.id) rescue nil %>
<% if team %>
<% teams_users = TeamsUser.where(['team_id = ?', team.team_id]) %>
<% is_teammate = teams_users.select {|tu| tu.user_id == session[:user].id}.size > 0 %>
<% end %>
<% if bookmark.user_id == session[:user].id or is_teammate or ['Instructor'].include? @current_role_name %>
<nowiki><td><%= link_to 'Edit Bookmark', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy Bookmark', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/13/files here]

'''Fix the ability to create bookmark questionnaires and use in assignments.'''
Previously, questionnaires for things like Teammate Reviews could be created and used in assignments. Users could fill these out and the scores would be stored for later reference by TAs and instructors. The questionnaire for bookmark reviews was previously not functional, but now instructors can create new bookmark questionnaires and assign them to assignments.

Changed files:
:app/controllers/questionnaires_controller.rb
@questionnaire = Object.const_get(params[:model].split.join).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:model].split.join
....
if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)

:app/controllers/questionnaires_controller.rb
....
when "bookmark"
bookmark = Bookmark.find(@map.response_map.reviewee_id)
redirect_to controller: 'bookmarks', action: 'list', id: bookmark.topic_id
....
"BookmarkRatingResponseMap"

:app/models/bookmark_rating_response_map.rb
....
self.assignment.questionnaires.find_by(type: 'BookmarkRatingQuestionnaire')

:app/views/bookmarks/list.html.erb
....
<td>
<% assignment_participant = AssignmentParticipant.find_by(user_id: session[:user].id) %>
<% map = BookmarkRatingResponseMap.where(reviewed_object_id: @topic.assignment.id, reviewer_id: assignment_participant.id, reviewee_id: bookmark.id).first %>
<% if map.nil? %>
<% map = BookmarkRatingResponseMap.create(reviewed_object_id: @topic.assignment.id, reviewer_id: assignment_participant.id, reviewee_id: bookmark.id) %>
<% end %>
<% review = map.response.last %>
<% if review.nil? %>
<%= link_to "Review", {:controller => 'response', :action => 'new', :id => map.map_id, :return => "bookmark"} %>
<% else %>
<%= link_to "View", {:controller => 'response', :action => 'view', :id => review.id} %>
<%= link_to "Edit", {:controller => 'response', :action => 'edit', :id => review.id, :return => "bookmark"} %>
<% end %>
</td>
<nowiki><% if bookmark.user_id == session[:user].id %></nowiki>
<nowiki><td><%= link_to 'Edit', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<nowiki><td><%= link_to 'Edit Bookmark', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy Bookmark', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<% end %>

:app/views/response/view.html.erb
<% if !(@map.instance_of? TeammateReviewResponseMap) && !@map.survey? && !(@map.instance_of? BookmarkRatingResponseMap) %>
....

Pull request can be found [https://github.com/hosungh/expertiza/pull/3/files here]

'''Instructors should have the ability to view all bookmark responses. '''
Instructors should have a way to view all the responses to the bookmark questionnaires so that can see which bookmarks provided were deemed useful.

[[File:Bookmark response list.png]]

Changed files:
:app/helpers/report_formatter_helper.rb
def bookmark_rating_response_map(params, _session = nil)
assign_basics(params)
@reviewers = BookmarkRatingResponseMap.bookmark_response_report(@id)
@topics = @assignment.sign_up_topics
end

:app/models/bookmark_rating_response_map.rb
class BookmarkRatingResponseMap < ReviewResponseMap

def self.bookmark_response_report(id)
BookmarkRatingResponseMap.select("DISTINCT reviewer_id").where("reviewed_object_id = ?", id)
end

:app/views/reports/_bookmark_rating_report.html.erb
<%= create_report_table_header("Reviewed By" => "16%",
"Topic" => "14%",
"Bookmark Review" => "20%",
"Submitted By" => "20%",
"Last reviewed at" => "20%") %>
<%@l = -1 %>

<% @reviewers.each do |r| %>
<% @user = User.find(Participant.find(r.reviewer_id).user_id) %>
<% @bookmark_rating_response_maps = BookmarkRatingResponseMap.where(reviewer_id: r.reviewer_id, reviewed_object_id: @id) %>

<% maps = @bookmark_rating_response_maps.select { |m| !Response.where(map_id: m.id).first.blank? and m.reviewee and m.reviewee.user_id != @user.id }%>

<%@l = @l+1 %>
<% (@l % 2 == 0) ? @bgcolor = "#ffffff" : @bgcolor = "#f9f9f9" %>

<tr>

<% if maps.count > 0 %>

<td bgcolor=<%= @bgcolor %> rowspan= <%= maps.count %>>
<% @reviewer_name = @user.fullname(session[:ip]) %>
<%= link_to @reviewer_name, :controller => 'popup', :action => 'reviewer_details_popup', :id => r.reviewer_id, :assignment_id => @id %>
</td>

<% maps.each do |map| %>
<% @reviewee = map.reviewee %>

<td bgcolor=<%= @bgcolor %> align="left" colspan=1>
<% topic = SignUpTopic.find(@reviewee.topic_id) %>
<%= topic.topic_name %>
</td>


<td id = "green" bgcolor=<%= @bgcolor %> align="left" colspan=1>
<%= link_to @reviewee.title, {:controller => 'response', :action => 'view', :id => map.response.last.id}, :title => "Click here to view this bookmark review" %>
</td>


<td id = "green" bgcolor=<%= @bgcolor %> style="color:#DD3300" align="left" colspan=1>
<% reviewed_by_user = User.find(@reviewee.user_id).name %>
<%= link_to reviewed_by_user, impersonate_impersonate_path(:user => {:name => reviewed_by_user}), :method => :post, :title => "Click here to impersonate this user" %>
</td>


<td bgcolor=<%= @bgcolor %> align="left">
<% @bookmark_review_response = Response.where(map_id: map.id).first %>
<%= @bookmark_review_response.updated_at.to_time.strftime("%m/%d/%Y - %I:%M%p") %>
</td>

</tr>
<tr>
<% end %>
<% end %>
</tr>
<% end %>
</table>
</div>

:app/views/reports/_searchbox.html.erb
....
<option value='BookmarkRatingResponseMap' >
Bookmark Review Report
</option>
....
<% elsif @type == "BookmarkReviewResponseMap" %>
<nowiki><h1> Bookmark review report for <%= @assignment.name%> </h1></nowiki>
....

:app/views/reports/response_report.html.haml
- elsif @type == "BookmarkRatingResponseMap"
= render :partial => 'bookmark_rating_report'

Pull request can be found [https://github.com/hosungh/expertiza/pull/10/files here]

=='''Testing Plan'''==

'''Testing from the UI'''

* Create a Bookmark Questionnaire
# After logging in as the instructor, go to Manage > Questionnaires.
# Find 'Bookmark Rating' and click the '+' to create a new questionnaire.
# Give a name for this questionnaire, leave the min and max score at 0 and 5 respectively, and click 'Create'.
# Go to Manage > Questionnaires and click on 'Bookmark Rating' to view all of the questionnaires. Click the edit icon for the questionnaire you just created.
# Select 'Add 1 more Criterion question(s)'.
# For the question, enter "Does this bookmark appear to have been used by the author?" and leave the other fields blank. This question will be helpful in determining how useful the bookmark was.
# Click 'Save bookmark rating questionnaire'. Now this questionnaire can be used in assignments.

* Enable Bookmarks
# After logging in as the instructor, go to Manage > Assignments.
# Choose an assignment that will be used for testing and have bookmarks enabled and select the edit icon under Actions.
# Under Topics Tab select 'Allow participants to create bookmarks?'.
# Go to Rubrics tab, under 'Bookmark Rating' select the Bookmark review questionnaire that was previously created to use for reviewing the bookmarks.

* Add a Bookmark to a Topic
# Log in as a student who is a participant of the assignment with bookmarks enabled and select that assignment.
# Select a "Signup sheet" to see the list of available topics.
# Choose a topic and select the 'Add bookmark to topic' icon from the Bookmarks column. The 'Add bookmark to topic' icon has a '+' sign.
# Fill in all the fields for the bookmark, including Title, Url, and Description and click 'Add new bookmark'.
# You should now see a page listing all bookmarks for this topic.

* Viewing all Bookmarks for a Topic
# Log in as a student who is a participant of the assignment with bookmarks enabled (or an instructor) and select that assignment.
# Select a "Signup sheet" to see the list of available topics.
# The number of bookmarks for each topic should be displayed visually inside the 'View topic bookmarks' icon in the bookmarks column.
# Click the 'View topic bookmarks icon' to see a list of all bookmarks for this topic.

* Editing and Destroying Bookmarks for a Topic
# Perform this test with each of the following users: an instructor, a user who is assigned to the topic, and a teammate of the user who is assigned to the topic.
## Log in with the user and select the assignment with bookmarks enabled.
## Select a "Signup sheet" to see the list of available topics.
## Click the 'View topic bookmarks icon' to see a list of all bookmarks for this topic.
## The user should see links to 'Edit Bookmark' and 'Destroy Bookmark' next to a bookmark only if the user is an instructor, the user submitted the bookmark, or the user is a teammate of the user who submitted the bookmark.

'''Automated Testing with RSpec'''

The current version of Expertiza does not have any tests for the bookmark controller or model. We intend on adding comprehensive RSpec tests for all changes we have added to controller classes and unit tests for model classes.

===Code Coverage===

=='''Application Deployment'''==

This web application deployed on VCL is located at [http://152.46.17.220:8080 http://152.46.17.220:8080]

=='''Team Information'''==
Danielle Hancock

Eric Peden

Hosung Hwang

Mentor: Abhirav Kariya

=='''References'''==
1. [https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2. [https://github.com/hosungh/expertiza/ Forked GitHub Repo]

3. [http://152.46.17.220:8080 Deployed Application]

4. [https://github.com/expertiza/expertiza/pull/1704/ Beta Branch Pull Request]

File:CheckFieldsUrl.png

2020-03-23T23:21:33Z

Hhwang4:

File:CheckFieldsTitle.png

2020-03-23T23:21:16Z

Hhwang4:

File:CheckFieldsDescription.png

2020-03-23T23:18:16Z

Hhwang4:

CSC/ECE 517 Spring 2020 - E2005. Bookmark enhancements

2020-03-23T23:13:31Z

Hhwang4: /* Code Modifications */

==E2005. Bookmark Enhancements==

=='''Introduction'''==

===About Expertiza===
[http://expertiza.ncsu.edu/ Expertiza] is an open-source project that is built using the [http://rubyonrails.org/ Ruby on Rails] framework. At its core, it is a highly versatile tool that academic institutions can use to craft learning objectives centered around team projects, peer reviews, and highly-customizable assignments.

=='''Problem Statement'''==
The purpose of this project was to add meaningful enhancements and fixes to the bookmark feature in Expertiza, entities that can be attached to a topic to aid the authors who decide to take on a certain assignment. While the major functionality of the bookmark feature was already present by the time the team embarked on this project (most notably the ability to create/edit and rate bookmarks), many desired functions were conveniently broken or left out.

===Completed Stories===
Below is a breakdown of the stories that were drawn up and completed for this project:

1. Need a way to view all responses to the bookmark questionnaires.

2. Modify permissions for deleting bookmarks.The person who creates the bookmark, the team for whom the bookmark is meant, and the instructor, should be able to delete.

3. "View bookmarks" link on student_task/view breaks if the student has not selected a topic yet.

4. Bookmark rating questionnaire should include question asking the reviewer whether or not the bookmark appears to have been used by the author. Get the bookmark questionnaire functioning and add to the bookmark list page.

5. Fix issue in which users should not be able to review their own bookmark using the questionnaire, but currently can.

6. Add a number next to/inside the icon with the number of current bookmark in order to make it clear whether a bookmark exists for a topic.

7. Add a "View bookmarks" link to the assignment view page for easier access.

8. Add rating to the bookmark questionnaire and use that rating to calculate the average instead of using the current dropdown.

9. A student should not be able to rate his/her own bookmark.

10. Add URL to bookmark list for assignment topic on the assignment page, to make viewing bookmarks easier.

11. Instructors cannot currently see bookmarks (gets an error message saying instructors cannot create bookmarks).

12. "Back" button from Bookmarks list is broken.

13. When creating a bookmark with an empty description field, the notice says the bookmark was successfully created even though it fails.

14. "Bookmark ratings" should be a type of rubric when you go to Manage > Questionnaires. Although 'Bookmark Rating' is already a type of rubric, it isn't listed when hovering over Manage... > Questionnaires

15. Create a way to mark a bookmark that was rated to be helpful by all reviewers, on average.

16. Students can add/view bookmarks when "Allow participants to create bookmarks?" box is unchecked for the assignment.

=='''Code Modifications'''==

'''Fix the "Back" button:'''
When either backing out of creating or viewing/editing a bookmark, the back functionality does not work, both prompting errors. Issue has been fixed and users can once again go back to the appropriate page.

Changed files:
:app/views/bookmarks/list.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

:app/views/bookmarks/new.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

:app/views/bookmarks/edit.html.erb
<%= link_to 'Back', '#', :onclick => 'pageBack()' %>

<script>
....
function pageBack() {
history.back()
}
</script>

Pull request can be found [https://github.com/hosungh/expertiza/pull/2?file-filters%5B%5D= here]

Commit for "Back" capability when updating bookmark can be found [https://github.com/hosungh/expertiza/pull/4?file-filters%5B%5D= here]

'''Check whether text field is present when creating/updating bookmark:'''
Previously, when a bookmark was created/updated and the corresponding "Title", "URL", or "Description" text fields were not filled in, the bookmark was not created or updated sans any error or warning. In fact, the user would be taken to the list of bookmarks available, forcing him/her to go back to the page corresponding to the bookmark create/edit page. This fix prompts users with an error indicating which text field needs to be filled in in order to fulfill the particular bookmark create/edit function.

Changed files:
:app/views/bookmarks/new.html.erb
<%= label_tag 'Title' %> 
<%= text_field_tag :title, params[:title], :required => true %> 
<%= label_tag 'Url' %> 
<%= text_field_tag :url, params[:url], :required => true %> 
<%= label_tag 'Description' %> 
<%= text_area_tag :description, params[:description], :required => true %> 

:app/views/bookmarks/edit.html.erb
<%= label_tag 'Title' %> 
<%= f.text_field :title, :required => true %> 
<%= label_tag 'Url' %> 
<%= f.text_field :url, :required => true %> 
<%= label_tag 'Description' %> 
<%= f.text_area :description, :required => true %> 

Pull request can be found [https://github.com/hosungh/expertiza/pull/4?file-filters%5B%5D= here]

'''Change average bookmark rating to be based on questionnaire:'''
The rating system for the bookmarks before these changes were elementary in nature - there was a drop-down menu to choose your particular rating for a bookmark while there was an average calculator just to the left of the aforementioned column. The new changes introduced allows the "Your rating" and "Avg. rating" columns for a particular bookmark to be calculated based on the scores given to the various questions present in a given bookmark questionnaire. The "Avg. rating" is calculated based on the mean rating of all the bookmark questionnaires scored by every reviewer while "Your rating" is simply the mean of the scores that you (the user) gave to all the questions on the questionnaire.

[[File:Avg_Ratings_and_Badges.png]]

Changed files:
:app/controllers/bookmarks_controller.rb
helper_method :specific_average_score
helper_method :total_average_score

def specific_average_score(bookmark)
if bookmark.nil?
return '-'
else
assessment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assessment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assessment.id,
reviewee_id: bookmark.id,
reviewer_id: AssignmentParticipant.find_by(user_id: current_user.id).id).flat_map {|r| Response.where(map_id: r.id) }
score = Answer.get_total_score(response: responses, questions: questions)
if score.nil?
return '-'
else
(score * 5.0 / 100.0).round(2)
end
end
end

def total_average_score(bookmark)
if bookmark.nil?
return '-'
else
assessment = SignUpTopic.find(bookmark.topic_id).assignment
questions = assessment.questionnaires.where(type: 'BookmarkRatingQuestionnaire').flat_map(&:questions)
responses = BookmarkRatingResponseMap.where(
reviewed_object_id: assessment.id,
reviewee_id: bookmark.id).flat_map {|r| Response.where(map_id: r.id) }
totalScore = Answer.compute_scores(responses, questions)
if totalScore[:avg].nil?
return '-'
else
(totalScore[:avg] * 5.0 / 100.0).round(2)
end
end
end

:app/views/bookmarks/list.html.erb

<% totalAvg = total_average_score(bookmark) %>
<% if totalAvg != 0 %>
<%= totalAvg %>
<% else %>
<%= '-' %>
<% end %>


<% specAvg = specific_average_score(bookmark) %>
<% if specAvg != 0 %>
<%= specAvg %>
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/12?file-filters%5B%5D= here]

'''Addition of badges for exceptionally helpful bookmarks:'''
Originally, no badge system was setup for bookmarks that have proven to be helpful guides for other students taking on the same project. The new changes introduced allows bookmarks to be attached to bookmarks with exceptionally good average ratings (i.e, above a rating of 3). A badge is signified by a full star while the absence of a badge is represented by an empty star.

[[File:Bookmark list.png|50px]]

Changed files:
:app/views/bookmarks/list.html.erb
<th class="head">Badge</th>

<td>

<% if totalAvg.to_f > 3 %>

<% else %>

<% end %>
</td>

Pull request can be found [https://github.com/hosungh/expertiza/pull/14?file-filters%5B%5D= here]

'''Users cannot rate bookmarks they've uploaded. '''
We wanted to make sure that users cannot rate bookmarks that they uploaded.

Changed files:
:app/views/bookmarks/list.html.erb
<% unless session[:user].id == bookmark.user_id %>
# ... code for rating the bookmarks
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/1/files?w=1 here]

'''Users cannot review bookmarks they've uploaded using the questionnaire. '''
We also wanted to make sure that users cannot review bookmarks that they uploaded using the questionnaires.

Changed files:
:app/views/bookmarks/list.html.erb
<% unless session[:user].id == bookmark.user_id %>
# ... code for reviewing bookmarks using the questionnaire
<% else %>
<%= '-' %>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/5/files?w=1 here]

'''Users should be able to see the number of bookmarks from the topics list. '''
Previously, users could add bookmarks, but could not tell how many bookmarks were provided for each topic (if any) without clicking the "View bookmarks" icon. This UI change displays the number of bookmarks for the topic inside the view bookmarks icon from the topic list view so that users don't need to click through each topic individually.

[[File:Sign up sheet bookmarks.png]]

Changed files:
:app/views/sign_up_sheet/_actions.html.erb
<nowiki></nowiki>
<nowiki><%= Bookmark.where(topic_id: topic.id).length.to_s %></nowiki>
<nowiki></nowiki>

Pull request can be found [https://github.com/hosungh/expertiza/pull/6/files here]

'''UI changes to make finding your bookmarks easier:'''
We added a "View Bookmarks" link to the student task view, that takes the student directly to the bookmarks that have been submitted for their topic. This code was then modified such that the link is greyed out if the student does not have a topic, and is hidden if bookmarks are not enabled for the assignment.

Changed files:
:app/controllers/student_task_controller.rb
:app/views/student_task/view.html.erb
<% if @use_bookmark %>
<<nowiki />li>>
<% if @topic_id and @assignment.submission_allowed(@topic_id) %>
<%= link_to "View bookmarks", :controller=>'bookmarks', :action=> 'list', :id => @topic_id %> (View bookmarks others have submitted for your topic)
<% else %>
<<nowiki />font color="gray">View bookmarks (You have to choose a topic first)
<% end %>
<<nowiki />/li>
<% end %>

Relevant commits can be found [https://github.com/hosungh/expertiza/commit/04b24b1dedd3414f58f52d394f2a5b9568e83872 here] [https://github.com/hosungh/expertiza/commit/15a775624307651755a70e63625a370478aa63b4 here] and [https://github.com/hosungh/expertiza/commit/f144594ae062369754d54288eff8959136510ccc here]

'''Grey out add/view bookmarks link on the topic page if bookmarks are not enabled.''' Previously, students could submit and view bookmarks even if bookmarks were disabled for the assignment. Now these options are hidden.

Changed files:
:app/views/sign_up_sheet/_actions.html.erb
<% if @use_bookmark %>
<<nowiki />%= link_to :controller=>'bookmarks', :action=> 'list', :id => topic.id do %>
<<nowiki />span class="fa-stack fa-md" title='View topic bookmarks'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x">
<<nowiki />p class="fa fa-stack-2x fa-inverse" style='font-size: 1.0em; padding-top: 2px; font-weight: bold;'>
<%= Bookmark.where(topic_id: topic.id).length.to_s %>
<<nowiki />/p>
<<nowiki />/span>
<% end %>
<%= link_to :controller=>'bookmarks', :action=> 'new', :id => topic.id , :assignment_id => params[:assignment_id] do %>
<<nowiki />span class="fa-stack fa-md" title='Add bookmark to topic'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x">
<<nowiki />i class="fa fa-plus fa-stack-1x fa-inverse" style='font-size: .5em'>
<<nowiki />/span>
<% end %>
<<nowiki />% else %>
<<nowiki />span class="fa-stack fa-md" title='View topic bookmarks'>
<<nowiki />i class="fa fa-bookmark fa-stack-1x fa-2x" style="opacity: 0.3;">

<% end %>

:app/views/sign_up_sheet/_table_header.html.erb
<<nowiki />th width="10%"> Bookmarks
<% unless @use_bookmark %> (disabled) <% end %>
<<nowiki />/th>

Commit can be found [https://github.com/hosungh/expertiza/commit/f0352ddf441d3773109b2e0208981f3fe122b5df here]

'''Modify Bookmark delete permissions. '''
Bookmarks should be deletable by the user who created the bookmark, a teammate of the user who provided the bookmark, and the instructor.

Changed files:
:app/views/bookmarks/list.html.erb

<% is_teammate = false %>
<% team = SignedUpTeam.find_by(topic_id: @topic.id) rescue nil %>
<% if team %>
<% teams_users = TeamsUser.where(['team_id = ?', team.team_id]) %>
<% is_teammate = teams_users.select {|tu| tu.user_id == session[:user].id}.size > 0 %>
<% end %>
<% if bookmark.user_id == session[:user].id or is_teammate or ['Instructor'].include? @current_role_name %>
<nowiki><td><%= link_to 'Edit Bookmark', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy Bookmark', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<% end %>

Pull request can be found [https://github.com/hosungh/expertiza/pull/13/files here]

'''Fix the ability to create bookmark questionnaires and use in assignments.'''
Previously, questionnaires for things like Teammate Reviews could be created and used in assignments. Users could fill these out and the scores would be stored for later reference by TAs and instructors. The questionnaire for bookmark reviews was previously not functional, but now instructors can create new bookmark questionnaires and assign them to assignments.

Changed files:
:app/controllers/questionnaires_controller.rb
@questionnaire = Object.const_get(params[:model].split.join).new if Questionnaire::QUESTIONNAIRE_TYPES.include? params[:model].split.join
....
if %w[AuthorFeedback CourseSurvey TeammateReview GlobalSurvey AssignmentSurvey BookmarkRating].include?(display_type)

:app/controllers/questionnaires_controller.rb
....
when "bookmark"
bookmark = Bookmark.find(@map.response_map.reviewee_id)
redirect_to controller: 'bookmarks', action: 'list', id: bookmark.topic_id
....
"BookmarkRatingResponseMap"

:app/models/bookmark_rating_response_map.rb
....
self.assignment.questionnaires.find_by(type: 'BookmarkRatingQuestionnaire')

:app/views/bookmarks/list.html.erb
....
<td>
<% assignment_participant = AssignmentParticipant.find_by(user_id: session[:user].id) %>
<% map = BookmarkRatingResponseMap.where(reviewed_object_id: @topic.assignment.id, reviewer_id: assignment_participant.id, reviewee_id: bookmark.id).first %>
<% if map.nil? %>
<% map = BookmarkRatingResponseMap.create(reviewed_object_id: @topic.assignment.id, reviewer_id: assignment_participant.id, reviewee_id: bookmark.id) %>
<% end %>
<% review = map.response.last %>
<% if review.nil? %>
<%= link_to "Review", {:controller => 'response', :action => 'new', :id => map.map_id, :return => "bookmark"} %>
<% else %>
<%= link_to "View", {:controller => 'response', :action => 'view', :id => review.id} %>
<%= link_to "Edit", {:controller => 'response', :action => 'edit', :id => review.id, :return => "bookmark"} %>
<% end %>
</td>
<nowiki><% if bookmark.user_id == session[:user].id %></nowiki>
<nowiki><td><%= link_to 'Edit', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<nowiki><td><%= link_to 'Edit Bookmark', :action => 'edit', :id => bookmark.id %></td></nowiki>
<nowiki><td><%= link_to 'Destroy Bookmark', bookmark, :confirm => "Delete bookmark \"#{bookmark.title}\"?", :method => :delete %></td></nowiki>
<% end %>

:app/views/response/view.html.erb
<% if !(@map.instance_of? TeammateReviewResponseMap) && !@map.survey? && !(@map.instance_of? BookmarkRatingResponseMap) %>
....

Pull request can be found [https://github.com/hosungh/expertiza/pull/3/files here]

'''Instructors should have the ability to view all bookmark responses. '''
Instructors should have a way to view all the responses to the bookmark questionnaires so that can see which bookmarks provided were deemed useful.

[[File:Bookmark response list.png]]

Changed files:
:app/helpers/report_formatter_helper.rb
def bookmark_rating_response_map(params, _session = nil)
assign_basics(params)
@reviewers = BookmarkRatingResponseMap.bookmark_response_report(@id)
@topics = @assignment.sign_up_topics
end

:app/models/bookmark_rating_response_map.rb
class BookmarkRatingResponseMap < ReviewResponseMap

def self.bookmark_response_report(id)
BookmarkRatingResponseMap.select("DISTINCT reviewer_id").where("reviewed_object_id = ?", id)
end

:app/views/reports/_bookmark_rating_report.html.erb
<%= create_report_table_header("Reviewed By" => "16%",
"Topic" => "14%",
"Bookmark Review" => "20%",
"Submitted By" => "20%",
"Last reviewed at" => "20%") %>
<%@l = -1 %>

<% @reviewers.each do |r| %>
<% @user = User.find(Participant.find(r.reviewer_id).user_id) %>
<% @bookmark_rating_response_maps = BookmarkRatingResponseMap.where(reviewer_id: r.reviewer_id, reviewed_object_id: @id) %>

<% maps = @bookmark_rating_response_maps.select { |m| !Response.where(map_id: m.id).first.blank? and m.reviewee and m.reviewee.user_id != @user.id }%>

<%@l = @l+1 %>
<% (@l % 2 == 0) ? @bgcolor = "#ffffff" : @bgcolor = "#f9f9f9" %>

<tr>

<% if maps.count > 0 %>

<td bgcolor=<%= @bgcolor %> rowspan= <%= maps.count %>>
<% @reviewer_name = @user.fullname(session[:ip]) %>
<%= link_to @reviewer_name, :controller => 'popup', :action => 'reviewer_details_popup', :id => r.reviewer_id, :assignment_id => @id %>
</td>

<% maps.each do |map| %>
<% @reviewee = map.reviewee %>

<td bgcolor=<%= @bgcolor %> align="left" colspan=1>
<% topic = SignUpTopic.find(@reviewee.topic_id) %>
<%= topic.topic_name %>
</td>


<td id = "green" bgcolor=<%= @bgcolor %> align="left" colspan=1>
<%= link_to @reviewee.title, {:controller => 'response', :action => 'view', :id => map.response.last.id}, :title => "Click here to view this bookmark review" %>
</td>


<td id = "green" bgcolor=<%= @bgcolor %> style="color:#DD3300" align="left" colspan=1>
<% reviewed_by_user = User.find(@reviewee.user_id).name %>
<%= link_to reviewed_by_user, impersonate_impersonate_path(:user => {:name => reviewed_by_user}), :method => :post, :title => "Click here to impersonate this user" %>
</td>


<td bgcolor=<%= @bgcolor %> align="left">
<% @bookmark_review_response = Response.where(map_id: map.id).first %>
<%= @bookmark_review_response.updated_at.to_time.strftime("%m/%d/%Y - %I:%M%p") %>
</td>

</tr>
<tr>
<% end %>
<% end %>
</tr>
<% end %>
</table>
</div>

:app/views/reports/_searchbox.html.erb
....
<option value='BookmarkRatingResponseMap' >
Bookmark Review Report
</option>
....
<% elsif @type == "BookmarkReviewResponseMap" %>
<nowiki><h1> Bookmark review report for <%= @assignment.name%> </h1></nowiki>
....

:app/views/reports/response_report.html.haml
- elsif @type == "BookmarkRatingResponseMap"
= render :partial => 'bookmark_rating_report'

Pull request can be found [https://github.com/hosungh/expertiza/pull/10/files here]

=='''Testing Plan'''==

'''Testing from the UI'''

* Create a Bookmark Questionnaire
# After logging in as the instructor, go to Manage > Questionnaires.
# Find 'Bookmark Rating' and click the '+' to create a new questionnaire.
# Give a name for this questionnaire, leave the min and max score at 0 and 5 respectively, and click 'Create'.
# Go to Manage > Questionnaires and click on 'Bookmark Rating' to view all of the questionnaires. Click the edit icon for the questionnaire you just created.
# Select 'Add 1 more Criterion question(s)'.
# For the question, enter "Does this bookmark appear to have been used by the author?" and leave the other fields blank. This question will be helpful in determining how useful the bookmark was.
# Click 'Save bookmark rating questionnaire'. Now this questionnaire can be used in assignments.

* Enable Bookmarks
# After logging in as the instructor, go to Manage > Assignments.
# Choose an assignment that will be used for testing and have bookmarks enabled and select the edit icon under Actions.
# Under Topics Tab select 'Allow participants to create bookmarks?'.
# Go to Rubrics tab, under 'Bookmark Rating' select the Bookmark review questionnaire that was previously created to use for reviewing the bookmarks.

* Add a Bookmark to a Topic
# Log in as a student who is a participant of the assignment with bookmarks enabled and select that assignment.
# Select a "Signup sheet" to see the list of available topics.
# Choose a topic and select the 'Add bookmark to topic' icon from the Bookmarks column. The 'Add bookmark to topic' icon has a '+' sign.
# Fill in all the fields for the bookmark, including Title, Url, and Description and click 'Add new bookmark'.
# You should now see a page listing all bookmarks for this topic.

* Viewing all Bookmarks for a Topic
# Log in as a student who is a participant of the assignment with bookmarks enabled (or an instructor) and select that assignment.
# Select a "Signup sheet" to see the list of available topics.
# The number of bookmarks for each topic should be displayed visually inside the 'View topic bookmarks' icon in the bookmarks column.
# Click the 'View topic bookmarks icon' to see a list of all bookmarks for this topic.

* Editing and Destroying Bookmarks for a Topic
# Perform this test with each of the following users: an instructor, a user who is assigned to the topic, and a teammate of the user who is assigned to the topic.
## Log in with the user and select the assignment with bookmarks enabled.
## Select a "Signup sheet" to see the list of available topics.
## Click the 'View topic bookmarks icon' to see a list of all bookmarks for this topic.
## The user should see links to 'Edit Bookmark' and 'Destroy Bookmark' next to a bookmark only if the user is an instructor, the user submitted the bookmark, or the user is a teammate of the user who submitted the bookmark.

'''Automated Testing with RSpec'''

The current version of Expertiza does not have any tests for the bookmark controller or model. We intend on adding comprehensive RSpec tests for all changes we have added to controller classes and unit tests for model classes.

===Code Coverage===

=='''Application Deployment'''==

This web application deployed on VCL is located at [http://152.46.17.220:8080 http://152.46.17.220:8080]

=='''Team Information'''==
Danielle Hancock

Eric Peden

Hosung Hwang

Mentor: Abhirav Kariya

=='''References'''==
1. [https://github.com/expertiza/expertiza/ Expertiza on GitHub]

2. [https://github.com/hosungh/expertiza/ Forked GitHub Repo]

3. [http://152.46.17.220:8080 Deployed Application]

4. [https://github.com/expertiza/expertiza/pull/1704/ Beta Branch Pull Request]

File:Avg Ratings and Badges.png

2020-03-23T23:10:29Z

Hhwang4: