Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-05-01T16:19:13Z

Ssujal: /* Team */

== Introduction ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza] provides a feature to peer review other teams assignments/projects after the submission deadline. Peer reviewing is usually done immediately (within one or two days) after the submission deadline, so that the students get a feedback on their work as soon as they complete it. Then the students are allowed to re-submit the project based on the reviews they get. A constructive review will help students to improve their project in a better way.

Even though advice is given by instructors on how to make a good review, students sometimes find difficulty in providing a helpful review. The quality of the reviews can be improved if students are shown some example reviews while they peer review. These example reviews can either be taken from the assignment of current semester or from the same/related project of previous semesters.

== Problem Statement ==

The objective of the project is to add a feature to show some good sample reviews while the students peer review other teams work. To enable this, students while submitting their peer review give a consent on whether their reviews can be shown as an example to others.
Instructors then select a subset of these reviews to be posted as an example reviews. These example reviews are shown in the peer review page (Other's work link) to the entire class.

Additionally,

1. Students should be able to see an entire review, both text and ratings, not just a single comment.

2. The student view should not show the name of the reviewer or the reviewee. The views of power users such as TA, instructor, admin should show these names.

3. The student can remove their consent anytime, and the sample review should no longer be visible to other students.

== Previous work ==

This project was implemented twice before and it was last done in Fall 2019. Though their implementation worked from the UI perspective, there were problems in the code so it was not merged. Some of the problems of the previous work are

1. There were many unexplained code blocks. These code blocks where acquired from previous implementation and the last team seem to have retained it so that the build passes.

2. Project included many irrelevant files and included classes the team didn't understand.

3. Testing was not thorough.

We almost follow the same design as previous work, but we will do our own implementation so that the above problems are addressed.

== Design ==

=== Key Features ===

In the order of flow,

'''1. Student's Consent:'''
In each review assignment, there will be a checkbox that says "I agree to share my review as a sample for others" then students can decide to check this box or not just before they submit reviews. Similarly, the student can revert it back to 'private' anytime. This could be implemented by the simple addition of a checkbox in '''response/view.html.erb''' and set a "visibility" field to “public”of the Response object via a controller method, "toggle_permission".

'''Sequence Diagram:'''
[[File:SQ1.png|none|User_MarkAsPublic_sequence]]

'''2. Instructor's Selection:''' The instructor can select from among the "public" reviews and decides which to make visible to other students doing a particular assignment, i.e. all participants in that assignment. And this will set the “visibility” field to “publish”.
Specifically, the instructor first goes to “View review report” and clicks on one team name (in the “Team reviewed” column). Then in the popup/team_users_popup page we need to add a button (better put it at top right) named “make this review an example”. If this review has already been shown as an example, the button should be “remove this review from examples” instead.

'''Sequence Diagram:'''
[[File:feature_instructor.png|none|Instructor_MarkAsSample_sequence]]

'''3. List of Sample Reviews: ''' A participant can see these "exemplary" reviews by going to "Others' work" for the assignment in question, and clicking on one or more links that say, e.g., "Sample review". And it should be shown just below the title “Review for ...”. It could be implemented on the '''student_reviews/list.html.erb'''.

'''Sequence Diagram:'''
[[File:feature_viewSample.png|none|User_MarkAsPublic_sequence]]

== Use Case Diagram ==
* Use Cases -

[[Image:UseCase.png]]

'''Power Users:''' Instructors, TAs, Admins and Super Admins

=== Solution Approach ===

To identify the reviews to be shown as an example, we append a column to the responses table representing their respective status. The following table explains the significance of each value:

{| class="wikitable"
! Visibility
! Explanation of the value
|-
| PRIVATE || Default, private
|-
| PUBLIC || Public (selected by the student but has not been selected as a sample review by the instructors.
|-
| PUBLISHED || Selected to show as example by the instructors.
|-
|}

'''1. Schema:''' Update the schema with the following column changes via migrations.

1) Add 'visibility' column to responses

2) Add new Table 'sample_reviews'

'''2. Mapping of Reviews and Assignment:''' The example reviews can either be taken from an assignment of the current course or it could be from an assignment from a previous course. This would enable students working on OSS Project to see OSS Project reviews from a previous semester. One idea is that when clicking to “make this review an example”, it will link to a page where you can select an assignment to which you have access (the same as the list of “Assignment” in the tree_display), then the example review will be shown to all participants of that specific assignment. We also need to do the same thing for “remove this review from examples”. Since we are adding the visibility field in '''responses''' table, we maintained the mapping of each response and assignment in another table i.e. '''sample_reviews'''.

'''3. MVC Setup:''' We would need to create new partials in various views, and possibly a helper for response_controller.rb. We could achieve that by creating a MVC setup for the entire flow.

=== Code changes ===

1. '''Database changes:''' Added a column visibility in responses table.

2. Added a checkbox to select whether reviews could be shown as an example in the response views - '''/app/views/response/response.html.erb'''

3. On selecting the checkbox, update the visibility field in responses table in response controller - '''/app/controllers/response_controller.rb'''

4. The reviews which are marked as public by the students are marked with a tick mark in the review report views for the instructors. For this changes were made in the file _review_report.html.erb. A tick mark is shown if the visibility status of a response is public or published. To check for the visibility status a method visibility_public? is added in review_mapping_helper.

5. To allow instructor to select among the public reviews to shown as examples to all students a button 'Mark as an example' in the popup views. Changes corresponding to this is made in '''/app/views/popup/team_users_popup.html.haml'''

5. To enable students to see the example reviews, a link Sample reviews is added in the Other's work page. Made changes in the views of student_review - '''/app/views/student_review/list.html.erb'''

== DB Design ==

=== Previous work ===
The previous approach for DB design added two new database tables to store the status and association of sample reviews, namely, '''samplereviewmaps''' and '''similar_assignments'''. The samplereviewmaps table simple stored two foreign key associations to review_map id and to the assignment_id.

=== Our approach ===
In our approach, we are extending the existing responses table to contain an additional field, 'visibility', that stores the status of the response(review), as suggested in the above approach. This approach would prune the need to add an extra DB table, which would store redundant information. Additionally, the similar_assignments table would store the association for a response to all the assignments, the instructor/TA decide to publish for.

[[File:db.png|none|User_MarkAsPublic_sequence]]

== Test Plan ==

Our test plan includes testing through rspec tests and through GUI.

=== Manual Testing ===

'''As a Student (Scenario 1): Give consent to make their review public'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Chose to review any of the teams' assignments that are displayed.
# Select a team for review and fill in the review.
# Before submitting the review, select the checkbox that says "I agree to share this review anonymously as an example to the entire class".
# After clicking on the submit button, the review submitted has been made public.

'''As a Student (Scenario 2): Showing all the available sample reviews for respective assignment'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Sample reviews" link.
# This opens a page where the student can view all example reviews for that assignment.

'''As a Power User (TA/Instructor/Admin/Super Admin): Mark the review an example'''
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click View Report/Review for a particular assignment.
# Displays a list of reviews submitted by students.
# Click on any review with a tick mark in "team reviewed" column for a particular student.
# Displays the summary of reviews submitted by that student, with a "Make as an example" button on the right of every review.
# Click on "Make as an example" for the intended reviews, which opens a popup that displays a list of all assignments that are a part of the instructor's courses.
# From this list select all assignments for which the review has to be shown as a sample.
# Click on 'Publish Sample Reviews' after selection (this closes the popup).
# Navigate to view reviews of that particular assignment and click on "Sample Reviews".
# A new page is opened that lists out all the sample reviews of the assignment.

=== RSpec Testing ===

The following acceptance tests using the RSpec/Capybara tests to be written.

describe "user_review" do
context "user marks the review as public" do
=begin
select checkbox 'consent'
click 'submit review'
expect response.to have attribute(visibility: 'public')
=end
end

context "user marks the review as private" do
=begin
unselect checkbox 'consent'
click 'submit review'
expect response.to have attribute(visibility: 'private')
=end
end

context "user views the sample review for assignment" do
=begin
click link 'View Sample Review'
click link 'Sample Review 1'
expect page.to have content('Review')
=end
end
end

describe "instructor" do
context "instructor marks the review as sample" do
=begin
click button 'Mark as example'
expect page.to have_content('Select similar assignments')
=end
end

context "instructor selects similar assignments" do
=begin
click button 'Mark as example'
select checkbox from 'similar_assignments'
click button 'Publish Review'
expect response.to have_attribute('published')
expect Sample_reviews.to have_attribute(assignment_id: assignment.id)
=end
end
end

== Resources ==
'''Pull request:''' https://github.com/expertiza/expertiza/pull/1725 

'''Repository link:''' https://github.com/khotAyush/expertiza/tree/e2022/sample-reviews 

'''Previous Team's Work:''' https://expertiza.csc.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example 

== Team ==

'''Mentor:''' Dr. Ed Gehringer (efg@ncsu.edu)

Akanksha Bhattacharya (anbhatta@ncsu.edu) [https://github.com/akankshanb] 
Ayush Khot (akhot@ncsu.edu)[https://github.com/khotAyush] 
Jasmine Madonna Sabarimuthu (jsabari@ncsu.edu) [https://github.com/JasmineMadonna] 
Sujal (ssujal@ncsu.edu)[https://github.com/SujalAhrodia]

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-05-01T16:15:22Z

Ssujal: /* Team */

== Introduction ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza] provides a feature to peer review other teams assignments/projects after the submission deadline. Peer reviewing is usually done immediately (within one or two days) after the submission deadline, so that the students get a feedback on their work as soon as they complete it. Then the students are allowed to re-submit the project based on the reviews they get. A constructive review will help students to improve their project in a better way.

Even though advice is given by instructors on how to make a good review, students sometimes find difficulty in providing a helpful review. The quality of the reviews can be improved if students are shown some example reviews while they peer review. These example reviews can either be taken from the assignment of current semester or from the same/related project of previous semesters.

== Problem Statement ==

The objective of the project is to add a feature to show some good sample reviews while the students peer review other teams work. To enable this, students while submitting their peer review give a consent on whether their reviews can be shown as an example to others.
Instructors then select a subset of these reviews to be posted as an example reviews. These example reviews are shown in the peer review page (Other's work link) to the entire class.

Additionally,

1. Students should be able to see an entire review, both text and ratings, not just a single comment.

2. The student view should not show the name of the reviewer or the reviewee. The views of power users such as TA, instructor, admin should show these names.

3. The student can remove their consent anytime, and the sample review should no longer be visible to other students.

== Previous work ==

This project was implemented twice before and it was last done in Fall 2019. Though their implementation worked from the UI perspective, there were problems in the code so it was not merged. Some of the problems of the previous work are

1. There were many unexplained code blocks. These code blocks where acquired from previous implementation and the last team seem to have retained it so that the build passes.

2. Project included many irrelevant files and included classes the team didn't understand.

3. Testing was not thorough.

We almost follow the same design as previous work, but we will do our own implementation so that the above problems are addressed.

== Design ==

=== Key Features ===

In the order of flow,

'''1. Student's Consent:'''
In each review assignment, there will be a checkbox that says "I agree to share my review as a sample for others" then students can decide to check this box or not just before they submit reviews. Similarly, the student can revert it back to 'private' anytime. This could be implemented by the simple addition of a checkbox in '''response/view.html.erb''' and set a "visibility" field to “public”of the Response object via a controller method, "toggle_permission".

'''Sequence Diagram:'''
[[File:SQ1.png|none|User_MarkAsPublic_sequence]]

'''2. Instructor's Selection:''' The instructor can select from among the "public" reviews and decides which to make visible to other students doing a particular assignment, i.e. all participants in that assignment. And this will set the “visibility” field to “publish”.
Specifically, the instructor first goes to “View review report” and clicks on one team name (in the “Team reviewed” column). Then in the popup/team_users_popup page we need to add a button (better put it at top right) named “make this review an example”. If this review has already been shown as an example, the button should be “remove this review from examples” instead.

'''Sequence Diagram:'''
[[File:feature_instructor.png|none|Instructor_MarkAsSample_sequence]]

'''3. List of Sample Reviews: ''' A participant can see these "exemplary" reviews by going to "Others' work" for the assignment in question, and clicking on one or more links that say, e.g., "Sample review". And it should be shown just below the title “Review for ...”. It could be implemented on the '''student_reviews/list.html.erb'''.

'''Sequence Diagram:'''
[[File:feature_viewSample.png|none|User_MarkAsPublic_sequence]]

== Use Case Diagram ==
* Use Cases -

[[Image:UseCase.png]]

'''Power Users:''' Instructors, TAs, Admins and Super Admins

=== Solution Approach ===

To identify the reviews to be shown as an example, we append a column to the responses table representing their respective status. The following table explains the significance of each value:

{| class="wikitable"
! Visibility
! Explanation of the value
|-
| PRIVATE || Default, private
|-
| PUBLIC || Public (selected by the student but has not been selected as a sample review by the instructors.
|-
| PUBLISHED || Selected to show as example by the instructors.
|-
|}

'''1. Schema:''' Update the schema with the following column changes via migrations.

1) Add 'visibility' column to responses

2) Add new Table 'sample_reviews'

'''2. Mapping of Reviews and Assignment:''' The example reviews can either be taken from an assignment of the current course or it could be from an assignment from a previous course. This would enable students working on OSS Project to see OSS Project reviews from a previous semester. One idea is that when clicking to “make this review an example”, it will link to a page where you can select an assignment to which you have access (the same as the list of “Assignment” in the tree_display), then the example review will be shown to all participants of that specific assignment. We also need to do the same thing for “remove this review from examples”. Since we are adding the visibility field in '''responses''' table, we maintained the mapping of each response and assignment in another table i.e. '''sample_reviews'''.

'''3. MVC Setup:''' We would need to create new partials in various views, and possibly a helper for response_controller.rb. We could achieve that by creating a MVC setup for the entire flow.

=== Code changes ===

1. '''Database changes:''' Added a column visibility in responses table.

2. Added a checkbox to select whether reviews could be shown as an example in the response views - '''/app/views/response/response.html.erb'''

3. On selecting the checkbox, update the visibility field in responses table in response controller - '''/app/controllers/response_controller.rb'''

4. The reviews which are marked as public by the students are marked with a tick mark in the review report views for the instructors. For this changes were made in the file _review_report.html.erb. A tick mark is shown if the visibility status of a response is public or published. To check for the visibility status a method visibility_public? is added in review_mapping_helper.

5. To allow instructor to select among the public reviews to shown as examples to all students a button 'Mark as an example' in the popup views. Changes corresponding to this is made in '''/app/views/popup/team_users_popup.html.haml'''

5. To enable students to see the example reviews, a link Sample reviews is added in the Other's work page. Made changes in the views of student_review - '''/app/views/student_review/list.html.erb'''

== DB Design ==

=== Previous work ===
The previous approach for DB design added two new database tables to store the status and association of sample reviews, namely, '''samplereviewmaps''' and '''similar_assignments'''. The samplereviewmaps table simple stored two foreign key associations to review_map id and to the assignment_id.

=== Our approach ===
In our approach, we are extending the existing responses table to contain an additional field, 'visibility', that stores the status of the response(review), as suggested in the above approach. This approach would prune the need to add an extra DB table, which would store redundant information. Additionally, the similar_assignments table would store the association for a response to all the assignments, the instructor/TA decide to publish for.

[[File:db.png|none|User_MarkAsPublic_sequence]]

== Test Plan ==

Our test plan includes testing through rspec tests and through GUI.

=== Manual Testing ===

'''As a Student (Scenario 1): Give consent to make their review public'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Chose to review any of the teams' assignments that are displayed.
# Select a team for review and fill in the review.
# Before submitting the review, select the checkbox that says "I agree to share this review anonymously as an example to the entire class".
# After clicking on the submit button, the review submitted has been made public.

'''As a Student (Scenario 2): Showing all the available sample reviews for respective assignment'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Sample reviews" link.
# This opens a page where the student can view all example reviews for that assignment.

'''As a Power User (TA/Instructor/Admin/Super Admin): Mark the review an example'''
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click View Report/Review for a particular assignment.
# Displays a list of reviews submitted by students.
# Click on any review with a tick mark in "team reviewed" column for a particular student.
# Displays the summary of reviews submitted by that student, with a "Make as an example" button on the right of every review.
# Click on "Make as an example" for the intended reviews, which opens a popup that displays a list of all assignments that are a part of the instructor's courses.
# From this list select all assignments for which the review has to be shown as a sample.
# Click on 'Publish Sample Reviews' after selection (this closes the popup).
# Navigate to view reviews of that particular assignment and click on "Sample Reviews".
# A new page is opened that lists out all the sample reviews of the assignment.

=== RSpec Testing ===

The following acceptance tests using the RSpec/Capybara tests to be written.

describe "user_review" do
context "user marks the review as public" do
=begin
select checkbox 'consent'
click 'submit review'
expect response.to have attribute(visibility: 'public')
=end
end

context "user marks the review as private" do
=begin
unselect checkbox 'consent'
click 'submit review'
expect response.to have attribute(visibility: 'private')
=end
end

context "user views the sample review for assignment" do
=begin
click link 'View Sample Review'
click link 'Sample Review 1'
expect page.to have content('Review')
=end
end
end

describe "instructor" do
context "instructor marks the review as sample" do
=begin
click button 'Mark as example'
expect page.to have_content('Select similar assignments')
=end
end

context "instructor selects similar assignments" do
=begin
click button 'Mark as example'
select checkbox from 'similar_assignments'
click button 'Publish Review'
expect response.to have_attribute('published')
expect Sample_reviews.to have_attribute(assignment_id: assignment.id)
=end
end
end

== Resources ==
'''Pull request:''' https://github.com/expertiza/expertiza/pull/1725 

'''Repository link:''' https://github.com/khotAyush/expertiza/tree/e2022/sample-reviews 

'''Previous Team's Work:''' https://expertiza.csc.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example 

== Team ==

'''Mentor:''' Dr. Ed Gehringer (efg@ncsu.edu)

Akanksha Bhattacharya (anbhatta@ncsu.edu) 
Ayush Khot (akhot@ncsu.edu) 
Jasmine Madonna Sabarimuthu (jsabari@ncsu.edu) 
Sujal (ssujal@ncsu.edu)

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-05-01T16:14:42Z

Ssujal: /* Resources */

== Introduction ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza] provides a feature to peer review other teams assignments/projects after the submission deadline. Peer reviewing is usually done immediately (within one or two days) after the submission deadline, so that the students get a feedback on their work as soon as they complete it. Then the students are allowed to re-submit the project based on the reviews they get. A constructive review will help students to improve their project in a better way.

Even though advice is given by instructors on how to make a good review, students sometimes find difficulty in providing a helpful review. The quality of the reviews can be improved if students are shown some example reviews while they peer review. These example reviews can either be taken from the assignment of current semester or from the same/related project of previous semesters.

== Problem Statement ==

The objective of the project is to add a feature to show some good sample reviews while the students peer review other teams work. To enable this, students while submitting their peer review give a consent on whether their reviews can be shown as an example to others.
Instructors then select a subset of these reviews to be posted as an example reviews. These example reviews are shown in the peer review page (Other's work link) to the entire class.

Additionally,

1. Students should be able to see an entire review, both text and ratings, not just a single comment.

2. The student view should not show the name of the reviewer or the reviewee. The views of power users such as TA, instructor, admin should show these names.

3. The student can remove their consent anytime, and the sample review should no longer be visible to other students.

== Previous work ==

This project was implemented twice before and it was last done in Fall 2019. Though their implementation worked from the UI perspective, there were problems in the code so it was not merged. Some of the problems of the previous work are

1. There were many unexplained code blocks. These code blocks where acquired from previous implementation and the last team seem to have retained it so that the build passes.

2. Project included many irrelevant files and included classes the team didn't understand.

3. Testing was not thorough.

We almost follow the same design as previous work, but we will do our own implementation so that the above problems are addressed.

== Design ==

=== Key Features ===

In the order of flow,

'''1. Student's Consent:'''
In each review assignment, there will be a checkbox that says "I agree to share my review as a sample for others" then students can decide to check this box or not just before they submit reviews. Similarly, the student can revert it back to 'private' anytime. This could be implemented by the simple addition of a checkbox in '''response/view.html.erb''' and set a "visibility" field to “public”of the Response object via a controller method, "toggle_permission".

'''Sequence Diagram:'''
[[File:SQ1.png|none|User_MarkAsPublic_sequence]]

'''2. Instructor's Selection:''' The instructor can select from among the "public" reviews and decides which to make visible to other students doing a particular assignment, i.e. all participants in that assignment. And this will set the “visibility” field to “publish”.
Specifically, the instructor first goes to “View review report” and clicks on one team name (in the “Team reviewed” column). Then in the popup/team_users_popup page we need to add a button (better put it at top right) named “make this review an example”. If this review has already been shown as an example, the button should be “remove this review from examples” instead.

'''Sequence Diagram:'''
[[File:feature_instructor.png|none|Instructor_MarkAsSample_sequence]]

'''3. List of Sample Reviews: ''' A participant can see these "exemplary" reviews by going to "Others' work" for the assignment in question, and clicking on one or more links that say, e.g., "Sample review". And it should be shown just below the title “Review for ...”. It could be implemented on the '''student_reviews/list.html.erb'''.

'''Sequence Diagram:'''
[[File:feature_viewSample.png|none|User_MarkAsPublic_sequence]]

== Use Case Diagram ==
* Use Cases -

[[Image:UseCase.png]]

'''Power Users:''' Instructors, TAs, Admins and Super Admins

=== Solution Approach ===

To identify the reviews to be shown as an example, we append a column to the responses table representing their respective status. The following table explains the significance of each value:

{| class="wikitable"
! Visibility
! Explanation of the value
|-
| PRIVATE || Default, private
|-
| PUBLIC || Public (selected by the student but has not been selected as a sample review by the instructors.
|-
| PUBLISHED || Selected to show as example by the instructors.
|-
|}

'''1. Schema:''' Update the schema with the following column changes via migrations.

1) Add 'visibility' column to responses

2) Add new Table 'sample_reviews'

'''2. Mapping of Reviews and Assignment:''' The example reviews can either be taken from an assignment of the current course or it could be from an assignment from a previous course. This would enable students working on OSS Project to see OSS Project reviews from a previous semester. One idea is that when clicking to “make this review an example”, it will link to a page where you can select an assignment to which you have access (the same as the list of “Assignment” in the tree_display), then the example review will be shown to all participants of that specific assignment. We also need to do the same thing for “remove this review from examples”. Since we are adding the visibility field in '''responses''' table, we maintained the mapping of each response and assignment in another table i.e. '''sample_reviews'''.

'''3. MVC Setup:''' We would need to create new partials in various views, and possibly a helper for response_controller.rb. We could achieve that by creating a MVC setup for the entire flow.

=== Code changes ===

1. '''Database changes:''' Added a column visibility in responses table.

2. Added a checkbox to select whether reviews could be shown as an example in the response views - '''/app/views/response/response.html.erb'''

3. On selecting the checkbox, update the visibility field in responses table in response controller - '''/app/controllers/response_controller.rb'''

4. The reviews which are marked as public by the students are marked with a tick mark in the review report views for the instructors. For this changes were made in the file _review_report.html.erb. A tick mark is shown if the visibility status of a response is public or published. To check for the visibility status a method visibility_public? is added in review_mapping_helper.

5. To allow instructor to select among the public reviews to shown as examples to all students a button 'Mark as an example' in the popup views. Changes corresponding to this is made in '''/app/views/popup/team_users_popup.html.haml'''

5. To enable students to see the example reviews, a link Sample reviews is added in the Other's work page. Made changes in the views of student_review - '''/app/views/student_review/list.html.erb'''

== DB Design ==

=== Previous work ===
The previous approach for DB design added two new database tables to store the status and association of sample reviews, namely, '''samplereviewmaps''' and '''similar_assignments'''. The samplereviewmaps table simple stored two foreign key associations to review_map id and to the assignment_id.

=== Our approach ===
In our approach, we are extending the existing responses table to contain an additional field, 'visibility', that stores the status of the response(review), as suggested in the above approach. This approach would prune the need to add an extra DB table, which would store redundant information. Additionally, the similar_assignments table would store the association for a response to all the assignments, the instructor/TA decide to publish for.

[[File:db.png|none|User_MarkAsPublic_sequence]]

== Test Plan ==

Our test plan includes testing through rspec tests and through GUI.

=== Manual Testing ===

'''As a Student (Scenario 1): Give consent to make their review public'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Chose to review any of the teams' assignments that are displayed.
# Select a team for review and fill in the review.
# Before submitting the review, select the checkbox that says "I agree to share this review anonymously as an example to the entire class".
# After clicking on the submit button, the review submitted has been made public.

'''As a Student (Scenario 2): Showing all the available sample reviews for respective assignment'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Sample reviews" link.
# This opens a page where the student can view all example reviews for that assignment.

'''As a Power User (TA/Instructor/Admin/Super Admin): Mark the review an example'''
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click View Report/Review for a particular assignment.
# Displays a list of reviews submitted by students.
# Click on any review with a tick mark in "team reviewed" column for a particular student.
# Displays the summary of reviews submitted by that student, with a "Make as an example" button on the right of every review.
# Click on "Make as an example" for the intended reviews, which opens a popup that displays a list of all assignments that are a part of the instructor's courses.
# From this list select all assignments for which the review has to be shown as a sample.
# Click on 'Publish Sample Reviews' after selection (this closes the popup).
# Navigate to view reviews of that particular assignment and click on "Sample Reviews".
# A new page is opened that lists out all the sample reviews of the assignment.

=== RSpec Testing ===

The following acceptance tests using the RSpec/Capybara tests to be written.

describe "user_review" do
context "user marks the review as public" do
=begin
select checkbox 'consent'
click 'submit review'
expect response.to have attribute(visibility: 'public')
=end
end

context "user marks the review as private" do
=begin
unselect checkbox 'consent'
click 'submit review'
expect response.to have attribute(visibility: 'private')
=end
end

context "user views the sample review for assignment" do
=begin
click link 'View Sample Review'
click link 'Sample Review 1'
expect page.to have content('Review')
=end
end
end

describe "instructor" do
context "instructor marks the review as sample" do
=begin
click button 'Mark as example'
expect page.to have_content('Select similar assignments')
=end
end

context "instructor selects similar assignments" do
=begin
click button 'Mark as example'
select checkbox from 'similar_assignments'
click button 'Publish Review'
expect response.to have_attribute('published')
expect Sample_reviews.to have_attribute(assignment_id: assignment.id)
=end
end
end

== Resources ==
'''Pull request:''' https://github.com/expertiza/expertiza/pull/1725 

'''Repository link:''' https://github.com/khotAyush/expertiza/tree/e2022/sample-reviews 

'''Previous Team's Work:''' https://expertiza.csc.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example 

== Team ==

Mentor: Dr. Ed Gehringer (efg@ncsu.edu)

Ayush Khot (akhot@ncsu.edu) 
Akanksha Bhattacharya (anbhatta@ncsu.edu) 
Jasmine Madonna Sabarimuthu (jsabari@ncsu.edu) 
Sujal (ssujal@ncsu.edu)

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-05-01T16:13:29Z

Ssujal: /* Test Plan */

== Introduction ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza] provides a feature to peer review other teams assignments/projects after the submission deadline. Peer reviewing is usually done immediately (within one or two days) after the submission deadline, so that the students get a feedback on their work as soon as they complete it. Then the students are allowed to re-submit the project based on the reviews they get. A constructive review will help students to improve their project in a better way.

Even though advice is given by instructors on how to make a good review, students sometimes find difficulty in providing a helpful review. The quality of the reviews can be improved if students are shown some example reviews while they peer review. These example reviews can either be taken from the assignment of current semester or from the same/related project of previous semesters.

== Problem Statement ==

The objective of the project is to add a feature to show some good sample reviews while the students peer review other teams work. To enable this, students while submitting their peer review give a consent on whether their reviews can be shown as an example to others.
Instructors then select a subset of these reviews to be posted as an example reviews. These example reviews are shown in the peer review page (Other's work link) to the entire class.

Additionally,

1. Students should be able to see an entire review, both text and ratings, not just a single comment.

2. The student view should not show the name of the reviewer or the reviewee. The views of power users such as TA, instructor, admin should show these names.

3. The student can remove their consent anytime, and the sample review should no longer be visible to other students.

== Previous work ==

This project was implemented twice before and it was last done in Fall 2019. Though their implementation worked from the UI perspective, there were problems in the code so it was not merged. Some of the problems of the previous work are

1. There were many unexplained code blocks. These code blocks where acquired from previous implementation and the last team seem to have retained it so that the build passes.

2. Project included many irrelevant files and included classes the team didn't understand.

3. Testing was not thorough.

We almost follow the same design as previous work, but we will do our own implementation so that the above problems are addressed.

== Design ==

=== Key Features ===

In the order of flow,

'''1. Student's Consent:'''
In each review assignment, there will be a checkbox that says "I agree to share my review as a sample for others" then students can decide to check this box or not just before they submit reviews. Similarly, the student can revert it back to 'private' anytime. This could be implemented by the simple addition of a checkbox in '''response/view.html.erb''' and set a "visibility" field to “public”of the Response object via a controller method, "toggle_permission".

'''Sequence Diagram:'''
[[File:SQ1.png|none|User_MarkAsPublic_sequence]]

'''2. Instructor's Selection:''' The instructor can select from among the "public" reviews and decides which to make visible to other students doing a particular assignment, i.e. all participants in that assignment. And this will set the “visibility” field to “publish”.
Specifically, the instructor first goes to “View review report” and clicks on one team name (in the “Team reviewed” column). Then in the popup/team_users_popup page we need to add a button (better put it at top right) named “make this review an example”. If this review has already been shown as an example, the button should be “remove this review from examples” instead.

'''Sequence Diagram:'''
[[File:feature_instructor.png|none|Instructor_MarkAsSample_sequence]]

'''3. List of Sample Reviews: ''' A participant can see these "exemplary" reviews by going to "Others' work" for the assignment in question, and clicking on one or more links that say, e.g., "Sample review". And it should be shown just below the title “Review for ...”. It could be implemented on the '''student_reviews/list.html.erb'''.

'''Sequence Diagram:'''
[[File:feature_viewSample.png|none|User_MarkAsPublic_sequence]]

== Use Case Diagram ==
* Use Cases -

[[Image:UseCase.png]]

'''Power Users:''' Instructors, TAs, Admins and Super Admins

=== Solution Approach ===

To identify the reviews to be shown as an example, we append a column to the responses table representing their respective status. The following table explains the significance of each value:

{| class="wikitable"
! Visibility
! Explanation of the value
|-
| PRIVATE || Default, private
|-
| PUBLIC || Public (selected by the student but has not been selected as a sample review by the instructors.
|-
| PUBLISHED || Selected to show as example by the instructors.
|-
|}

'''1. Schema:''' Update the schema with the following column changes via migrations.

1) Add 'visibility' column to responses

2) Add new Table 'sample_reviews'

'''2. Mapping of Reviews and Assignment:''' The example reviews can either be taken from an assignment of the current course or it could be from an assignment from a previous course. This would enable students working on OSS Project to see OSS Project reviews from a previous semester. One idea is that when clicking to “make this review an example”, it will link to a page where you can select an assignment to which you have access (the same as the list of “Assignment” in the tree_display), then the example review will be shown to all participants of that specific assignment. We also need to do the same thing for “remove this review from examples”. Since we are adding the visibility field in '''responses''' table, we maintained the mapping of each response and assignment in another table i.e. '''sample_reviews'''.

'''3. MVC Setup:''' We would need to create new partials in various views, and possibly a helper for response_controller.rb. We could achieve that by creating a MVC setup for the entire flow.

=== Code changes ===

1. '''Database changes:''' Added a column visibility in responses table.

2. Added a checkbox to select whether reviews could be shown as an example in the response views - '''/app/views/response/response.html.erb'''

3. On selecting the checkbox, update the visibility field in responses table in response controller - '''/app/controllers/response_controller.rb'''

4. The reviews which are marked as public by the students are marked with a tick mark in the review report views for the instructors. For this changes were made in the file _review_report.html.erb. A tick mark is shown if the visibility status of a response is public or published. To check for the visibility status a method visibility_public? is added in review_mapping_helper.

5. To allow instructor to select among the public reviews to shown as examples to all students a button 'Mark as an example' in the popup views. Changes corresponding to this is made in '''/app/views/popup/team_users_popup.html.haml'''

5. To enable students to see the example reviews, a link Sample reviews is added in the Other's work page. Made changes in the views of student_review - '''/app/views/student_review/list.html.erb'''

== DB Design ==

=== Previous work ===
The previous approach for DB design added two new database tables to store the status and association of sample reviews, namely, '''samplereviewmaps''' and '''similar_assignments'''. The samplereviewmaps table simple stored two foreign key associations to review_map id and to the assignment_id.

=== Our approach ===
In our approach, we are extending the existing responses table to contain an additional field, 'visibility', that stores the status of the response(review), as suggested in the above approach. This approach would prune the need to add an extra DB table, which would store redundant information. Additionally, the similar_assignments table would store the association for a response to all the assignments, the instructor/TA decide to publish for.

[[File:db.png|none|User_MarkAsPublic_sequence]]

== Test Plan ==

Our test plan includes testing through rspec tests and through GUI.

=== Manual Testing ===

'''As a Student (Scenario 1): Give consent to make their review public'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Chose to review any of the teams' assignments that are displayed.
# Select a team for review and fill in the review.
# Before submitting the review, select the checkbox that says "I agree to share this review anonymously as an example to the entire class".
# After clicking on the submit button, the review submitted has been made public.

'''As a Student (Scenario 2): Showing all the available sample reviews for respective assignment'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Sample reviews" link.
# This opens a page where the student can view all example reviews for that assignment.

'''As a Power User (TA/Instructor/Admin/Super Admin): Mark the review an example'''
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click View Report/Review for a particular assignment.
# Displays a list of reviews submitted by students.
# Click on any review with a tick mark in "team reviewed" column for a particular student.
# Displays the summary of reviews submitted by that student, with a "Make as an example" button on the right of every review.
# Click on "Make as an example" for the intended reviews, which opens a popup that displays a list of all assignments that are a part of the instructor's courses.
# From this list select all assignments for which the review has to be shown as a sample.
# Click on 'Publish Sample Reviews' after selection (this closes the popup).
# Navigate to view reviews of that particular assignment and click on "Sample Reviews".
# A new page is opened that lists out all the sample reviews of the assignment.

=== RSpec Testing ===

The following acceptance tests using the RSpec/Capybara tests to be written.

describe "user_review" do
context "user marks the review as public" do
=begin
select checkbox 'consent'
click 'submit review'
expect response.to have attribute(visibility: 'public')
=end
end

context "user marks the review as private" do
=begin
unselect checkbox 'consent'
click 'submit review'
expect response.to have attribute(visibility: 'private')
=end
end

context "user views the sample review for assignment" do
=begin
click link 'View Sample Review'
click link 'Sample Review 1'
expect page.to have content('Review')
=end
end
end

describe "instructor" do
context "instructor marks the review as sample" do
=begin
click button 'Mark as example'
expect page.to have_content('Select similar assignments')
=end
end

context "instructor selects similar assignments" do
=begin
click button 'Mark as example'
select checkbox from 'similar_assignments'
click button 'Publish Review'
expect response.to have_attribute('published')
expect Sample_reviews.to have_attribute(assignment_id: assignment.id)
=end
end
end

== Resources ==

Previous Team's Work: https://expertiza.csc.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example 

Repository link: https://github.com/khotAyush/expertiza/tree/e2022/sample-reviews

== Team ==

Mentor: Dr. Ed Gehringer (efg@ncsu.edu)

Ayush Khot (akhot@ncsu.edu) 
Akanksha Bhattacharya (anbhatta@ncsu.edu) 
Jasmine Madonna Sabarimuthu (jsabari@ncsu.edu) 
Sujal (ssujal@ncsu.edu)

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-05-01T16:08:27Z

Ssujal: /* Previous work */

== Introduction ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza] provides a feature to peer review other teams assignments/projects after the submission deadline. Peer reviewing is usually done immediately (within one or two days) after the submission deadline, so that the students get a feedback on their work as soon as they complete it. Then the students are allowed to re-submit the project based on the reviews they get. A constructive review will help students to improve their project in a better way.

Even though advice is given by instructors on how to make a good review, students sometimes find difficulty in providing a helpful review. The quality of the reviews can be improved if students are shown some example reviews while they peer review. These example reviews can either be taken from the assignment of current semester or from the same/related project of previous semesters.

== Problem Statement ==

The objective of the project is to add a feature to show some good sample reviews while the students peer review other teams work. To enable this, students while submitting their peer review give a consent on whether their reviews can be shown as an example to others.
Instructors then select a subset of these reviews to be posted as an example reviews. These example reviews are shown in the peer review page (Other's work link) to the entire class.

Additionally,

1. Students should be able to see an entire review, both text and ratings, not just a single comment.

2. The student view should not show the name of the reviewer or the reviewee. The views of power users such as TA, instructor, admin should show these names.

3. The student can remove their consent anytime, and the sample review should no longer be visible to other students.

== Previous work ==

This project was implemented twice before and it was last done in Fall 2019. Though their implementation worked from the UI perspective, there were problems in the code so it was not merged. Some of the problems of the previous work are

1. There were many unexplained code blocks. These code blocks where acquired from previous implementation and the last team seem to have retained it so that the build passes.

2. Project included many irrelevant files and included classes the team didn't understand.

3. Testing was not thorough.

We almost follow the same design as previous work, but we will do our own implementation so that the above problems are addressed.

== Design ==

=== Key Features ===

In the order of flow,

'''1. Student's Consent:'''
In each review assignment, there will be a checkbox that says "I agree to share my review as a sample for others" then students can decide to check this box or not just before they submit reviews. Similarly, the student can revert it back to 'private' anytime. This could be implemented by the simple addition of a checkbox in '''response/view.html.erb''' and set a "visibility" field to “public”of the Response object via a controller method, "toggle_permission".

'''Sequence Diagram:'''
[[File:SQ1.png|none|User_MarkAsPublic_sequence]]

'''2. Instructor's Selection:''' The instructor can select from among the "public" reviews and decides which to make visible to other students doing a particular assignment, i.e. all participants in that assignment. And this will set the “visibility” field to “publish”.
Specifically, the instructor first goes to “View review report” and clicks on one team name (in the “Team reviewed” column). Then in the popup/team_users_popup page we need to add a button (better put it at top right) named “make this review an example”. If this review has already been shown as an example, the button should be “remove this review from examples” instead.

'''Sequence Diagram:'''
[[File:feature_instructor.png|none|Instructor_MarkAsSample_sequence]]

'''3. List of Sample Reviews: ''' A participant can see these "exemplary" reviews by going to "Others' work" for the assignment in question, and clicking on one or more links that say, e.g., "Sample review". And it should be shown just below the title “Review for ...”. It could be implemented on the '''student_reviews/list.html.erb'''.

'''Sequence Diagram:'''
[[File:feature_viewSample.png|none|User_MarkAsPublic_sequence]]

== Use Case Diagram ==
* Use Cases -

[[Image:UseCase.png]]

'''Power Users:''' Instructors, TAs, Admins and Super Admins

=== Solution Approach ===

To identify the reviews to be shown as an example, we append a column to the responses table representing their respective status. The following table explains the significance of each value:

{| class="wikitable"
! Visibility
! Explanation of the value
|-
| PRIVATE || Default, private
|-
| PUBLIC || Public (selected by the student but has not been selected as a sample review by the instructors.
|-
| PUBLISHED || Selected to show as example by the instructors.
|-
|}

'''1. Schema:''' Update the schema with the following column changes via migrations.

1) Add 'visibility' column to responses

2) Add new Table 'sample_reviews'

'''2. Mapping of Reviews and Assignment:''' The example reviews can either be taken from an assignment of the current course or it could be from an assignment from a previous course. This would enable students working on OSS Project to see OSS Project reviews from a previous semester. One idea is that when clicking to “make this review an example”, it will link to a page where you can select an assignment to which you have access (the same as the list of “Assignment” in the tree_display), then the example review will be shown to all participants of that specific assignment. We also need to do the same thing for “remove this review from examples”. Since we are adding the visibility field in '''responses''' table, we maintained the mapping of each response and assignment in another table i.e. '''sample_reviews'''.

'''3. MVC Setup:''' We would need to create new partials in various views, and possibly a helper for response_controller.rb. We could achieve that by creating a MVC setup for the entire flow.

=== Code changes ===

1. '''Database changes:''' Added a column visibility in responses table.

2. Added a checkbox to select whether reviews could be shown as an example in the response views - '''/app/views/response/response.html.erb'''

3. On selecting the checkbox, update the visibility field in responses table in response controller - '''/app/controllers/response_controller.rb'''

4. The reviews which are marked as public by the students are marked with a tick mark in the review report views for the instructors. For this changes were made in the file _review_report.html.erb. A tick mark is shown if the visibility status of a response is public or published. To check for the visibility status a method visibility_public? is added in review_mapping_helper.

5. To allow instructor to select among the public reviews to shown as examples to all students a button 'Mark as an example' in the popup views. Changes corresponding to this is made in '''/app/views/popup/team_users_popup.html.haml'''

5. To enable students to see the example reviews, a link Sample reviews is added in the Other's work page. Made changes in the views of student_review - '''/app/views/student_review/list.html.erb'''

== DB Design ==

=== Previous work ===
The previous approach for DB design added two new database tables to store the status and association of sample reviews, namely, '''samplereviewmaps''' and '''similar_assignments'''. The samplereviewmaps table simple stored two foreign key associations to review_map id and to the assignment_id.

=== Our approach ===
In our approach, we are extending the existing responses table to contain an additional field, 'visibility', that stores the status of the response(review), as suggested in the above approach. This approach would prune the need to add an extra DB table, which would store redundant information. Additionally, the similar_assignments table would store the association for a response to all the assignments, the instructor/TA decide to publish for.

[[File:db.png|none|User_MarkAsPublic_sequence]]

== Test Plan ==

Our test plan includes testing through rspec tests and through GUI.

=== Manual Testing ===
TODO: update scenarios with the description

'''As a Power User (TA/Instructor/Admin/Super Admin)'''
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click View Report/Review for a particular assignment.
# Displays a list of reviews submitted by students.
# Click on any review with a tick mark in "team reviewed" column for a particular student.
# Displays the summary of reviews submitted by that student, with a "Make as an example" button on the right of every review.
# Click on "Make as an example" for the intended reviews, which opens a popup that displays a list of all assignments that are a part of the instructor's courses.
# From this list select all assignments for which the review has to be shown as a sample.
# Click on 'Publish Sample Reviews' after selection (this closes the popup).
# Navigate to view reviews of that particular assignment and click on "Sample Reviews".
# A new page is opened that lists out all the sample reviews of the assignment.

'''As a Student (Scenario 1)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Sample reviews" link.
# This opens a page where the student can view all example reviews for that assignment.

'''As a Student (Scenario 2)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Chose to review any of the teams' assignments that are displayed.
# Select a team for review and fill in the review.
# Before submitting the review, select the checkbox that says "I agree to share this review anonymously as an example to the entire class".
# After clicking on the submit button, the review submitted has been made public.

=== RSpec Testing ===
TODO: add descriptions

The following acceptance tests using the RSpec/Capybara tests to be written.

describe "user_review" do
context "user marks the review as public" do
=begin
select checkbox 'consent'
click 'submit review'
expect response.to have attribute(visibility: 'public')
=end
end

context "user marks the review as private" do
=begin
unselect checkbox 'consent'
click 'submit review'
expect response.to have attribute(visibility: 'private')
=end
end

context "user views the sample review for assignment" do
=begin
click link 'View Sample Review'
click link 'Sample Review 1'
expect page.to have content('Review')
=end
end
end

describe "instructor" do
context "instructor marks the review as sample" do
=begin
click button 'Mark as example'
expect page.to have_content('Select similar assignments')
=end
end

context "instructor selects similar assignments" do
=begin
click button 'Mark as example'
select checkbox from 'similar_assignments'
click button 'Publish Review'
expect response.to have_attribute('published')
expect Sample_reviews.to have_attribute(assignment_id: assignment.id)
=end
end
end

== Resources ==

Previous Team's Work: https://expertiza.csc.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example 

Repository link: https://github.com/khotAyush/expertiza/tree/e2022/sample-reviews

== Team ==

Mentor: Dr. Ed Gehringer (efg@ncsu.edu)

Ayush Khot (akhot@ncsu.edu) 
Akanksha Bhattacharya (anbhatta@ncsu.edu) 
Jasmine Madonna Sabarimuthu (jsabari@ncsu.edu) 
Sujal (ssujal@ncsu.edu)

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-05-01T16:07:56Z

Ssujal: /* Solution Approach */

== Introduction ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza] provides a feature to peer review other teams assignments/projects after the submission deadline. Peer reviewing is usually done immediately (within one or two days) after the submission deadline, so that the students get a feedback on their work as soon as they complete it. Then the students are allowed to re-submit the project based on the reviews they get. A constructive review will help students to improve their project in a better way.

Even though advice is given by instructors on how to make a good review, students sometimes find difficulty in providing a helpful review. The quality of the reviews can be improved if students are shown some example reviews while they peer review. These example reviews can either be taken from the assignment of current semester or from the same/related project of previous semesters.

== Problem Statement ==

The objective of the project is to add a feature to show some good sample reviews while the students peer review other teams work. To enable this, students while submitting their peer review give a consent on whether their reviews can be shown as an example to others.
Instructors then select a subset of these reviews to be posted as an example reviews. These example reviews are shown in the peer review page (Other's work link) to the entire class.

Additionally,

1. Students should be able to see an entire review, both text and ratings, not just a single comment.

2. The student view should not show the name of the reviewer or the reviewee. The views of power users such as TA, instructor, admin should show these names.

3. The student can remove their consent anytime, and the sample review should no longer be visible to other students.

== Previous work ==

This project was implemented twice before and it was last done in Fall 2019. Though their implementation worked from the UI perspective, there were problems in the code so it was not merged. Some of the problems of the previous work are

1. There were many unexplained code blocks. These code blocks where acquired from previous implementation and the last team seem to have retained it so that the build passes.

2. Project included many irrelevant files and included classes the team didn't understand.

3. Testing was not thorough.

We almost follow the same design as previous work, but we will do our own implementation so that the above problems are addressed.

== Design ==

=== Key Features ===

In the order of flow,

'''1. Student's Consent:'''
In each review assignment, there will be a checkbox that says "I agree to share my review as a sample for others" then students can decide to check this box or not just before they submit reviews. Similarly, the student can revert it back to 'private' anytime. This could be implemented by the simple addition of a checkbox in '''response/view.html.erb''' and set a "visibility" field to “public”of the Response object via a controller method, "toggle_permission".

'''Sequence Diagram:'''
[[File:SQ1.png|none|User_MarkAsPublic_sequence]]

'''2. Instructor's Selection:''' The instructor can select from among the "public" reviews and decides which to make visible to other students doing a particular assignment, i.e. all participants in that assignment. And this will set the “visibility” field to “publish”.
Specifically, the instructor first goes to “View review report” and clicks on one team name (in the “Team reviewed” column). Then in the popup/team_users_popup page we need to add a button (better put it at top right) named “make this review an example”. If this review has already been shown as an example, the button should be “remove this review from examples” instead.

'''Sequence Diagram:'''
[[File:feature_instructor.png|none|Instructor_MarkAsSample_sequence]]

'''3. List of Sample Reviews: ''' A participant can see these "exemplary" reviews by going to "Others' work" for the assignment in question, and clicking on one or more links that say, e.g., "Sample review". And it should be shown just below the title “Review for ...”. It could be implemented on the '''student_reviews/list.html.erb'''.

'''Sequence Diagram:'''
[[File:feature_viewSample.png|none|User_MarkAsPublic_sequence]]

== Use Case Diagram ==
* Use Cases -

[[Image:UseCase.png]]

'''Power Users:''' Instructors, TAs, Admins and Super Admins

=== Solution Approach ===

To identify the reviews to be shown as an example, we append a column to the responses table representing their respective status. The following table explains the significance of each value:

{| class="wikitable"
! Visibility
! Explanation of the value
|-
| PRIVATE || Default, private
|-
| PUBLIC || Public (selected by the student but has not been selected as a sample review by the instructors.
|-
| PUBLISHED || Selected to show as example by the instructors.
|-
|}

'''1. Schema:''' Update the schema with the following column changes via migrations.

1) Add 'visibility' column to responses

2) Add new Table 'sample_reviews'

'''2. Mapping of Reviews and Assignment:''' The example reviews can either be taken from an assignment of the current course or it could be from an assignment from a previous course. This would enable students working on OSS Project to see OSS Project reviews from a previous semester. One idea is that when clicking to “make this review an example”, it will link to a page where you can select an assignment to which you have access (the same as the list of “Assignment” in the tree_display), then the example review will be shown to all participants of that specific assignment. We also need to do the same thing for “remove this review from examples”. Since we are adding the visibility field in '''responses''' table, we maintained the mapping of each response and assignment in another table i.e. '''sample_reviews'''.

'''3. MVC Setup:''' We would need to create new partials in various views, and possibly a helper for response_controller.rb. We could achieve that by creating a MVC setup for the entire flow.

=== Code changes ===

1. '''Database changes:''' Added a column visibility in responses table.

2. Added a checkbox to select whether reviews could be shown as an example in the response views - '''/app/views/response/response.html.erb'''

3. On selecting the checkbox, update the visibility field in responses table in response controller - '''/app/controllers/response_controller.rb'''

4. The reviews which are marked as public by the students are marked with a tick mark in the review report views for the instructors. For this changes were made in the file _review_report.html.erb. A tick mark is shown if the visibility status of a response is public or published. To check for the visibility status a method visibility_public? is added in review_mapping_helper.

5. To allow instructor to select among the public reviews to shown as examples to all students a button 'Mark as an example' in the popup views. Changes corresponding to this is made in '''/app/views/popup/team_users_popup.html.haml'''

5. To enable students to see the example reviews, a link Sample reviews is added in the Other's work page. Made changes in the views of student_review - '''/app/views/student_review/list.html.erb'''

== DB Design ==

=== Previous work ===
The previous approach for DB design added 2 new DB tables to store the status and association of sample reviews, namely, '''samplereviewmaps''' and '''similar_assignemnts'''. The samplereviewmaps table simple stored 2 fkey associations to review_map id and to the assignment_id.

=== Our approach ===
In our approach, we are extending the existing responses table to contain an additional field, 'visibility', that stores the status of the response(review), as suggested in the above approach. This approach would prune the need to add an extra DB table, which would store redundant information. Additionally, the similar_assignments table would store the association for a response to all the assignments, the instructor/TA decide to publish for.

[[File:db.png|none|User_MarkAsPublic_sequence]]

== Test Plan ==

Our test plan includes testing through rspec tests and through GUI.

=== Manual Testing ===
TODO: update scenarios with the description

'''As a Power User (TA/Instructor/Admin/Super Admin)'''
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click View Report/Review for a particular assignment.
# Displays a list of reviews submitted by students.
# Click on any review with a tick mark in "team reviewed" column for a particular student.
# Displays the summary of reviews submitted by that student, with a "Make as an example" button on the right of every review.
# Click on "Make as an example" for the intended reviews, which opens a popup that displays a list of all assignments that are a part of the instructor's courses.
# From this list select all assignments for which the review has to be shown as a sample.
# Click on 'Publish Sample Reviews' after selection (this closes the popup).
# Navigate to view reviews of that particular assignment and click on "Sample Reviews".
# A new page is opened that lists out all the sample reviews of the assignment.

'''As a Student (Scenario 1)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Sample reviews" link.
# This opens a page where the student can view all example reviews for that assignment.

'''As a Student (Scenario 2)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Chose to review any of the teams' assignments that are displayed.
# Select a team for review and fill in the review.
# Before submitting the review, select the checkbox that says "I agree to share this review anonymously as an example to the entire class".
# After clicking on the submit button, the review submitted has been made public.

=== RSpec Testing ===
TODO: add descriptions

The following acceptance tests using the RSpec/Capybara tests to be written.

describe "user_review" do
context "user marks the review as public" do
=begin
select checkbox 'consent'
click 'submit review'
expect response.to have attribute(visibility: 'public')
=end
end

context "user marks the review as private" do
=begin
unselect checkbox 'consent'
click 'submit review'
expect response.to have attribute(visibility: 'private')
=end
end

context "user views the sample review for assignment" do
=begin
click link 'View Sample Review'
click link 'Sample Review 1'
expect page.to have content('Review')
=end
end
end

describe "instructor" do
context "instructor marks the review as sample" do
=begin
click button 'Mark as example'
expect page.to have_content('Select similar assignments')
=end
end

context "instructor selects similar assignments" do
=begin
click button 'Mark as example'
select checkbox from 'similar_assignments'
click button 'Publish Review'
expect response.to have_attribute('published')
expect Sample_reviews.to have_attribute(assignment_id: assignment.id)
=end
end
end

== Resources ==

Previous Team's Work: https://expertiza.csc.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example 

Repository link: https://github.com/khotAyush/expertiza/tree/e2022/sample-reviews

== Team ==

Mentor: Dr. Ed Gehringer (efg@ncsu.edu)

Ayush Khot (akhot@ncsu.edu) 
Akanksha Bhattacharya (anbhatta@ncsu.edu) 
Jasmine Madonna Sabarimuthu (jsabari@ncsu.edu) 
Sujal (ssujal@ncsu.edu)

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-05-01T15:28:03Z

Ssujal: /* RSpec Testing */

== Introduction ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza] provides a feature to peer review other teams assignments/projects after the submission deadline. Peer reviewing is usually done immediately (within one or two days) after the submission deadline, so that the students get a feedback on their work as soon as they complete it. Then the students are allowed to re-submit the project based on the reviews they get. A constructive review will help students to improve their project in a better way.

Even though advice is given by instructors on how to make a good review, students sometimes find difficulty in providing a helpful review. The quality of the reviews can be improved if students are shown some example reviews while they peer review. These example reviews can either be taken from the assignment of current semester or from the same/related project of previous semesters.

== Problem Statement ==

The objective of the project is to add a feature to show some good sample reviews while the students peer review other teams work. To enable this, students while submitting their peer review give a consent on whether their reviews can be shown as an example to others.
Instructors then select a subset of these reviews to be posted as an example reviews. These example reviews are shown in the peer review page (Other's work link) to the entire class.

Additionally,

1. Students should be able to see an entire review, both text and ratings, not just a single comment.

2. The student view should not show the name of the reviewer or the reviewee. The views of power users such as TA, instructor, admin should show these names.

3. The student can remove their consent anytime, and the sample review should no longer be visible to other students.

== Previous work ==

This project was implemented twice before and it was last done in Fall 2019. Though their implementation worked from the UI perspective, there were problems in the code so it was not merged. Some of the problems of the previous work are

1. There were many unexplained code blocks. These code blocks where acquired from previous implementation and the last team seem to have retained it so that the build passes.

2. Project included many irrelevant files and included classes the team didn't understand.

3. Testing was not thorough.

We almost follow the same design as previous work, but we will do our own implementation so that the above problems are addressed.

== Design ==

=== Key Features ===

In the order of flow,

'''1. Student's Consent:'''
In each review assignment, there will be a checkbox that says "I agree to share my review as a sample for others" then students can decide to check this box or not just before they submit reviews. Similarly, the student can revert it back to 'private' anytime. This could be implemented by the simple addition of a checkbox in '''response/view.html.erb''' and set a "visibility" field to “public”of the Response object via a controller method, "toggle_permission".

'''Sequence Diagram:'''
[[File:SQ1.png|none|User_MarkAsPublic_sequence]]

'''2. Instructor's Selection:''' The instructor can select from among the "public" reviews and decides which to make visible to other students doing a particular assignment, i.e. all participants in that assignment. And this will set the “visibility” field to “publish”.
Specifically, the instructor first goes to “View review report” and clicks on one team name (in the “Team reviewed” column). Then in the popup/team_users_popup page we need to add a button (better put it at top right) named “make this review an example”. If this review has already been shown as an example, the button should be “remove this review from examples” instead.

'''Sequence Diagram:'''
[[File:feature_instructor.png|none|Instructor_MarkAsSample_sequence]]

'''3. List of Sample Reviews: ''' A participant can see these "exemplary" reviews by going to "Others' work" for the assignment in question, and clicking on one or more links that say, e.g., "Sample review". And it should be shown just below the title “Review for ...”. It could be implemented on the '''student_reviews/list.html.erb'''.

'''Sequence Diagram:'''
[[File:feature_viewSample.png|none|User_MarkAsPublic_sequence]]

== Use Case Diagram ==
* Use Cases -

[[Image:UseCase.png]]

'''Power Users:''' Instructors, TAs, Admins and Super Admins

=== Solution Approach ===

To identify the reviews to be shown as an example, we append a column to the responses table representing their respective status. The following table explains the significance of each value:

{| class="wikitable"
! Visibility
! Explanation of the value
|-
| PRIVATE || Default, private
|-
| PUBLIC || Public (selected by the student but has not been selected as a sample review by the instructors.
|-
| PUBLISHED || Selected to show as example by the instructors.
|-
|}

'''1. Schema:''' Update the schema with the following column changes via migrations.

1) Add 'visibility' column to responses

2) Add new Table 'sample_reviews'

'''2. Mapping of Reviews and Assignment:''' The example reviews can either be taken from an assignment of the current course or it could be from an assignment from a previous course. This would enable students working on OSS Project to see OSS Project reviews from a previous semester. One idea is that when clicking to “make this review an example”, it will link to a page where you can select an assignment to which you have access (the same as the list of “Assignment” in the tree_display), then the example review will be shown to all participants of that specific assignment. We also need to do the same thing for “remove this review from examples”
Since we already have a '''response_maps''' table, we can add a column to map it with a specific assignment. This may/may not need a change in key constraints for the table. We plan to resolve them accordingly.

'''3. MVC Setup:''' We would need to create new partials in various views, and possibly a helper for response_controller.rb. We could achieve that by creating a MVC setup for the entire flow.

=== Code changes ===

1. '''Database changes:''' Added a column visibility in responses table.

2. Added a checkbox to select whether reviews could be shown as an example in the response views - '''/app/views/response/response.html.erb'''

3. On selecting the checkbox, update the visibility field in responses table in response controller - '''/app/controllers/response_controller.rb'''

4. The reviews which are marked as public by the students are marked with a tick mark in the review report views for the instructors. For this changes were made in the file _review_report.html.erb. A tick mark is shown if the visibility status of a response is public or published. To check for the visibility status a method visibility_public? is added in review_mapping_helper.

5. To allow instructor to select among the public reviews to shown as examples to all students a button 'Mark as an example' in the popup views. Changes corresponding to this is made in '''/app/views/popup/team_users_popup.html.haml'''

5. To enable students to see the example reviews, a link Sample reviews is added in the Other's work page. Made changes in the views of student_review - '''/app/views/student_review/list.html.erb'''

== DB Design ==

=== Previous work ===
The previous approach for DB design added 2 new DB tables to store the status and association of sample reviews, namely, '''samplereviewmaps''' and '''similar_assignemnts'''. The samplereviewmaps table simple stored 2 fkey associations to review_map id and to the assignment_id.

=== Our approach ===
In our approach, we are extending the existing response_maps table to contain an additional field, 'status', that stores the status of the response(review), as suggested in the above approach. This approach would prune the need to add an extra DB table, which would store redundant information. Additionally, the similar_assignemnts table would store the association for a response to all the assignments, the instructor/TA decide to publish for.

[[File:db.png|none|User_MarkAsPublic_sequence]]

== Test Plan ==

Our test plan includes testing through rspec tests and through GUI.

=== Manual Testing ===
TODO: update scenarios with the description

'''As a Power User (TA/Instructor/Admin/Super Admin)'''
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click View Report/Review for a particular assignment.
# Displays a list of reviews submitted by students.
# Click on any review with a tick mark in "team reviewed" column for a particular student.
# Displays the summary of reviews submitted by that student, with a "Make as an example" button on the right of every review.
# Click on "Make as an example" for the intended reviews, which opens a popup that displays a list of all assignments that are a part of the instructor's courses.
# From this list select all assignments for which the review has to be shown as a sample.
# Click on 'Publish Sample Reviews' after selection (this closes the popup).
# Navigate to view reviews of that particular assignment and click on "Sample Reviews".
# A new page is opened that lists out all the sample reviews of the assignment.

'''As a Student (Scenario 1)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Sample reviews" link.
# This opens a page where the student can view all example reviews for that assignment.

'''As a Student (Scenario 2)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Chose to review any of the teams' assignments that are displayed.
# Select a team for review and fill in the review.
# Before submitting the review, select the checkbox that says "I agree to share this review anonymously as an example to the entire class".
# After clicking on the submit button, the review submitted has been made public.

=== RSpec Testing ===
TODO: add descriptions

The following acceptance tests using the RSpec/Capybara tests to be written.

describe "user_review" do
context "user marks the review as public" do
=begin
select checkbox 'consent'
click 'submit review'
expect response.to have attribute(visibility: 'public')
=end
end

context "user marks the review as private" do
=begin
unselect checkbox 'consent'
click 'submit review'
expect response.to have attribute(visibility: 'private')
=end
end

context "user views the sample review for assignment" do
=begin
click link 'View Sample Review'
click link 'Sample Review 1'
expect page.to have content('Review')
=end
end
end

describe "instructor" do
context "instructor marks the review as sample" do
=begin
click button 'Mark as example'
expect page.to have_content('Select similar assignments')
=end
end

context "instructor selects similar assignments" do
=begin
click button 'Mark as example'
select checkbox from 'similar_assignments'
click button 'Publish Review'
expect response.to have_attribute('published')
expect Sample_reviews.to have_attribute(assignment_id: assignment.id)
=end
end
end

== Resources ==

Previous Team's Work: https://expertiza.csc.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example 

Repository link: https://github.com/khotAyush/expertiza/tree/e2022/sample-reviews

== Team ==

Mentor: Dr. Ed Gehringer (efg@ncsu.edu)

Ayush Khot (akhot@ncsu.edu) 
Akanksha Bhattacharya (anbhatta@ncsu.edu) 
Jasmine Madonna Sabarimuthu (jsabari@ncsu.edu) 
Sujal (ssujal@ncsu.edu)

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-05-01T15:27:23Z

Ssujal: /* Manual Testing */

== Introduction ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza] provides a feature to peer review other teams assignments/projects after the submission deadline. Peer reviewing is usually done immediately (within one or two days) after the submission deadline, so that the students get a feedback on their work as soon as they complete it. Then the students are allowed to re-submit the project based on the reviews they get. A constructive review will help students to improve their project in a better way.

Even though advice is given by instructors on how to make a good review, students sometimes find difficulty in providing a helpful review. The quality of the reviews can be improved if students are shown some example reviews while they peer review. These example reviews can either be taken from the assignment of current semester or from the same/related project of previous semesters.

== Problem Statement ==

The objective of the project is to add a feature to show some good sample reviews while the students peer review other teams work. To enable this, students while submitting their peer review give a consent on whether their reviews can be shown as an example to others.
Instructors then select a subset of these reviews to be posted as an example reviews. These example reviews are shown in the peer review page (Other's work link) to the entire class.

Additionally,

1. Students should be able to see an entire review, both text and ratings, not just a single comment.

2. The student view should not show the name of the reviewer or the reviewee. The views of power users such as TA, instructor, admin should show these names.

3. The student can remove their consent anytime, and the sample review should no longer be visible to other students.

== Previous work ==

This project was implemented twice before and it was last done in Fall 2019. Though their implementation worked from the UI perspective, there were problems in the code so it was not merged. Some of the problems of the previous work are

1. There were many unexplained code blocks. These code blocks where acquired from previous implementation and the last team seem to have retained it so that the build passes.

2. Project included many irrelevant files and included classes the team didn't understand.

3. Testing was not thorough.

We almost follow the same design as previous work, but we will do our own implementation so that the above problems are addressed.

== Design ==

=== Key Features ===

In the order of flow,

'''1. Student's Consent:'''
In each review assignment, there will be a checkbox that says "I agree to share my review as a sample for others" then students can decide to check this box or not just before they submit reviews. Similarly, the student can revert it back to 'private' anytime. This could be implemented by the simple addition of a checkbox in '''response/view.html.erb''' and set a "visibility" field to “public”of the Response object via a controller method, "toggle_permission".

'''Sequence Diagram:'''
[[File:SQ1.png|none|User_MarkAsPublic_sequence]]

'''2. Instructor's Selection:''' The instructor can select from among the "public" reviews and decides which to make visible to other students doing a particular assignment, i.e. all participants in that assignment. And this will set the “visibility” field to “publish”.
Specifically, the instructor first goes to “View review report” and clicks on one team name (in the “Team reviewed” column). Then in the popup/team_users_popup page we need to add a button (better put it at top right) named “make this review an example”. If this review has already been shown as an example, the button should be “remove this review from examples” instead.

'''Sequence Diagram:'''
[[File:feature_instructor.png|none|Instructor_MarkAsSample_sequence]]

'''3. List of Sample Reviews: ''' A participant can see these "exemplary" reviews by going to "Others' work" for the assignment in question, and clicking on one or more links that say, e.g., "Sample review". And it should be shown just below the title “Review for ...”. It could be implemented on the '''student_reviews/list.html.erb'''.

'''Sequence Diagram:'''
[[File:feature_viewSample.png|none|User_MarkAsPublic_sequence]]

== Use Case Diagram ==
* Use Cases -

[[Image:UseCase.png]]

'''Power Users:''' Instructors, TAs, Admins and Super Admins

=== Solution Approach ===

To identify the reviews to be shown as an example, we append a column to the responses table representing their respective status. The following table explains the significance of each value:

{| class="wikitable"
! Visibility
! Explanation of the value
|-
| PRIVATE || Default, private
|-
| PUBLIC || Public (selected by the student but has not been selected as a sample review by the instructors.
|-
| PUBLISHED || Selected to show as example by the instructors.
|-
|}

'''1. Schema:''' Update the schema with the following column changes via migrations.

1) Add 'visibility' column to responses

2) Add new Table 'sample_reviews'

'''2. Mapping of Reviews and Assignment:''' The example reviews can either be taken from an assignment of the current course or it could be from an assignment from a previous course. This would enable students working on OSS Project to see OSS Project reviews from a previous semester. One idea is that when clicking to “make this review an example”, it will link to a page where you can select an assignment to which you have access (the same as the list of “Assignment” in the tree_display), then the example review will be shown to all participants of that specific assignment. We also need to do the same thing for “remove this review from examples”
Since we already have a '''response_maps''' table, we can add a column to map it with a specific assignment. This may/may not need a change in key constraints for the table. We plan to resolve them accordingly.

'''3. MVC Setup:''' We would need to create new partials in various views, and possibly a helper for response_controller.rb. We could achieve that by creating a MVC setup for the entire flow.

=== Code changes ===

1. '''Database changes:''' Added a column visibility in responses table.

2. Added a checkbox to select whether reviews could be shown as an example in the response views - '''/app/views/response/response.html.erb'''

3. On selecting the checkbox, update the visibility field in responses table in response controller - '''/app/controllers/response_controller.rb'''

4. The reviews which are marked as public by the students are marked with a tick mark in the review report views for the instructors. For this changes were made in the file _review_report.html.erb. A tick mark is shown if the visibility status of a response is public or published. To check for the visibility status a method visibility_public? is added in review_mapping_helper.

5. To allow instructor to select among the public reviews to shown as examples to all students a button 'Mark as an example' in the popup views. Changes corresponding to this is made in '''/app/views/popup/team_users_popup.html.haml'''

5. To enable students to see the example reviews, a link Sample reviews is added in the Other's work page. Made changes in the views of student_review - '''/app/views/student_review/list.html.erb'''

== DB Design ==

=== Previous work ===
The previous approach for DB design added 2 new DB tables to store the status and association of sample reviews, namely, '''samplereviewmaps''' and '''similar_assignemnts'''. The samplereviewmaps table simple stored 2 fkey associations to review_map id and to the assignment_id.

=== Our approach ===
In our approach, we are extending the existing response_maps table to contain an additional field, 'status', that stores the status of the response(review), as suggested in the above approach. This approach would prune the need to add an extra DB table, which would store redundant information. Additionally, the similar_assignemnts table would store the association for a response to all the assignments, the instructor/TA decide to publish for.

[[File:db.png|none|User_MarkAsPublic_sequence]]

== Test Plan ==

Our test plan includes testing through rspec tests and through GUI.

=== Manual Testing ===
TODO: update scenarios with the description

'''As a Power User (TA/Instructor/Admin/Super Admin)'''
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click View Report/Review for a particular assignment.
# Displays a list of reviews submitted by students.
# Click on any review with a tick mark in "team reviewed" column for a particular student.
# Displays the summary of reviews submitted by that student, with a "Make as an example" button on the right of every review.
# Click on "Make as an example" for the intended reviews, which opens a popup that displays a list of all assignments that are a part of the instructor's courses.
# From this list select all assignments for which the review has to be shown as a sample.
# Click on 'Publish Sample Reviews' after selection (this closes the popup).
# Navigate to view reviews of that particular assignment and click on "Sample Reviews".
# A new page is opened that lists out all the sample reviews of the assignment.

'''As a Student (Scenario 1)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Sample reviews" link.
# This opens a page where the student can view all example reviews for that assignment.

'''As a Student (Scenario 2)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Chose to review any of the teams' assignments that are displayed.
# Select a team for review and fill in the review.
# Before submitting the review, select the checkbox that says "I agree to share this review anonymously as an example to the entire class".
# After clicking on the submit button, the review submitted has been made public.

=== RSpec Testing ===

The following acceptance tests using the RSpec/Capybara tests to be written.

describe "user_review" do
context "user marks the review as public" do
=begin
select checkbox 'consent'
click 'submit review'
expect response.to have attribute(visibility: 'public')
=end
end

context "user marks the review as private" do
=begin
unselect checkbox 'consent'
click 'submit review'
expect response.to have attribute(visibility: 'private')
=end
end

context "user views the sample review for assignment" do
=begin
click link 'View Sample Review'
click link 'Sample Review 1'
expect page.to have content('Review')
=end
end
end

describe "instructor" do
context "instructor marks the review as sample" do
=begin
click button 'Mark as example'
expect page.to have_content('Select similar assignments')
=end
end

context "instructor selects similar assignments" do
=begin
click button 'Mark as example'
select checkbox from 'similar_assignments'
click button 'Publish Review'
expect response.to have_attribute('published')
expect Sample_reviews.to have_attribute(assignment_id: assignment.id)
=end
end
end

== Resources ==

Previous Team's Work: https://expertiza.csc.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example 

Repository link: https://github.com/khotAyush/expertiza/tree/e2022/sample-reviews

== Team ==

Mentor: Dr. Ed Gehringer (efg@ncsu.edu)

Ayush Khot (akhot@ncsu.edu) 
Akanksha Bhattacharya (anbhatta@ncsu.edu) 
Jasmine Madonna Sabarimuthu (jsabari@ncsu.edu) 
Sujal (ssujal@ncsu.edu)

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-05-01T14:48:15Z

Ssujal: /* Our approach */

== Introduction ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza] provides a feature to peer review other teams assignments/projects after the submission deadline. Peer reviewing is usually done immediately (within one or two days) after the submission deadline, so that the students get a feedback on their work as soon as they complete it. Then the students are allowed to re-submit the project based on the reviews they get. A constructive review will help students to improve their project in a better way.

Even though advice is given by instructors on how to make a good review, students sometimes find difficulty in providing a helpful review. The quality of the reviews can be improved if students are shown some example reviews while they peer review. These example reviews can either be taken from the assignment of current semester or from the same/related project of previous semesters.

== Problem Statement ==

The objective of the project is to add a feature to show some good sample reviews while the students peer review other teams work. To enable this, students while submitting their peer review give a consent on whether their reviews can be shown as an example to others.
Instructors then select a subset of these reviews to be posted as an example reviews. These example reviews are shown in the peer review page (Other's work link) to the entire class.

Additionally,

1. Students should be able to see an entire review, both text and ratings, not just a single comment.

2. The student view should not show the name of the reviewer or the reviewee. The views of power users such as TA, instructor, admin should show these names.

3. The student can remove their consent anytime, and the sample review should no longer be visible to other students.

== Previous work ==

This project was implemented twice before and it was last done in Fall 2019. Though their implementation worked from the UI perspective, there were problems in the code so it was not merged. Some of the problems of the previous work are

1. There were many unexplained code blocks. These code blocks where acquired from previous implementation and the last team seem to have retained it so that the build passes.

2. Project included many irrelevant files and included classes the team didn't understand.

3. Testing was not thorough.

We almost follow the same design as previous work, but we will do our own implementation so that the above problems are addressed.

== Design ==

=== Key Features ===

In the order of flow,

'''1. Student's Consent:'''
In each review assignment, there will be a checkbox that says "I agree to share my review as a sample for others" then students can decide to check this box or not just before they submit reviews. Similarly, the student can revert it back to 'private' anytime. This could be implemented by the simple addition of a checkbox in '''response/view.html.erb''' and set a "visibility" field to “public”of the Response object via a controller method, "toggle_permission".

'''Sequence Diagram:'''
[[File:SQ1.png|none|User_MarkAsPublic_sequence]]

'''2. Instructor's Selection:''' The instructor can select from among the "public" reviews and decides which to make visible to other students doing a particular assignment, i.e. all participants in that assignment. And this will set the “visibility” field to “publish”.
Specifically, the instructor first goes to “View review report” and clicks on one team name (in the “Team reviewed” column). Then in the popup/team_users_popup page we need to add a button (better put it at top right) named “make this review an example”. If this review has already been shown as an example, the button should be “remove this review from examples” instead.

'''Sequence Diagram:'''
[[File:feature_instructor.png|none|Instructor_MarkAsSample_sequence]]

'''3. List of Sample Reviews: ''' A participant can see these "exemplary" reviews by going to "Others' work" for the assignment in question, and clicking on one or more links that say, e.g., "Sample review". And it should be shown just below the title “Review for ...”. It could be implemented on the '''student_reviews/list.html.erb'''.

'''Sequence Diagram:'''
[[File:feature_viewSample.png|none|User_MarkAsPublic_sequence]]

== Use Case Diagram ==
* Use Cases -

[[Image:UseCase.png]]

'''Power Users:''' Instructors, TAs, Admins and Super Admins

=== Solution Approach ===

To identify the reviews to be shown as an example, we append a column to the responses table representing their respective status. The following table explains the significance of each value:

{| class="wikitable"
! Visibility
! Explanation of the value
|-
| PRIVATE || Default, private
|-
| PUBLIC || Public (selected by the student but has not been selected as a sample review by the instructors.
|-
| PUBLISHED || Selected to show as example by the instructors.
|-
|}

'''1. Schema:''' Update the schema with the following column changes via migrations.

1) Add 'visibility' column to responses

2) Add new Table 'sample_reviews'

'''2. Mapping of Reviews and Assignment:''' The example reviews can either be taken from an assignment of the current course or it could be from an assignment from a previous course. This would enable students working on OSS Project to see OSS Project reviews from a previous semester. One idea is that when clicking to “make this review an example”, it will link to a page where you can select an assignment to which you have access (the same as the list of “Assignment” in the tree_display), then the example review will be shown to all participants of that specific assignment. We also need to do the same thing for “remove this review from examples”
Since we already have a '''response_maps''' table, we can add a column to map it with a specific assignment. This may/may not need a change in key constraints for the table. We plan to resolve them accordingly.

'''3. MVC Setup:''' We would need to create new partials in various views, and possibly a helper for response_controller.rb. We could achieve that by creating a MVC setup for the entire flow.

=== Code changes ===

1. '''Database changes:''' Added a column visibility in responses table.

2. Added a checkbox to select whether reviews could be shown as an example in the response views - '''/app/views/response/response.html.erb'''

3. On selecting the checkbox, update the visibility field in responses table in response controller - '''/app/controllers/response_controller.rb'''

4. The reviews which are marked as public by the students are marked with a tick mark in the review report views for the instructors. For this changes were made in the file _review_report.html.erb. A tick mark is shown if the visibility status of a response is public or published. To check for the visibility status a method visibility_public? is added in review_mapping_helper.

5. To allow instructor to select among the public reviews to shown as examples to all students a button 'Mark as an example' in the popup views. Changes corresponding to this is made in '''/app/views/popup/team_users_popup.html.haml'''

5. To enable students to see the example reviews, a link Sample reviews is added in the Other's work page. Made changes in the views of student_review - '''/app/views/student_review/list.html.erb'''

== DB Design ==

=== Previous work ===
The previous approach for DB design added 2 new DB tables to store the status and association of sample reviews, namely, '''samplereviewmaps''' and '''similar_assignemnts'''. The samplereviewmaps table simple stored 2 fkey associations to review_map id and to the assignment_id.

=== Our approach ===
In our approach, we are extending the existing response_maps table to contain an additional field, 'status', that stores the status of the response(review), as suggested in the above approach. This approach would prune the need to add an extra DB table, which would store redundant information. Additionally, the similar_assignemnts table would store the association for a response to all the assignments, the instructor/TA decide to publish for.

[[File:db.png|none|User_MarkAsPublic_sequence]]

== Test Plan ==

Our test plan includes testing through rspec tests and through GUI.

=== Manual Testing ===

'''As a Power User (TA/Instructor/Admin/Super Admin)'''
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click View Report/Review for a particular assignment.
# Displays a list of reviews submitted by students.
# Click on any review with a tick mark in "team reviewed" column for a particular student.
# Displays the summary of reviews submitted by that student, with a "Make as an example" button on the right of every review.
# Click on "Make as an example" for the intended reviews, which opens a popup that displays a list of all assignments that are a part of the instructor's courses.
# From this list select all assignments for which the review has to be shown as a sample.
# Click on 'Submit' after selection (this closes the popup).
# Navigate to view reviews of that particular assignment and click on "Sample Reviews".
# A new page is opened that lists out all the sample reviews of the assignment.

'''As a Student (Scenario 1)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Show example reviews" link.
# This opens a page where the student can view all example reviews for that assignment.

'''As a Student (Scenario 2)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Chose to review any of the teams' assignments that are displayed.
# Select a team for review and fill in the review.
# Before submitting the review, select the checkbox that says "I agree to share this review anonymously as an example to the entire class".
# After clicking on the submit button, the review submitted has been made public.

=== RSpec Testing ===

The following acceptance tests using the RSpec/Capybara tests to be written.

describe "user_review" do
context "user marks the review as public" do
=begin
select checkbox 'consent'
click 'submit review'
expect response.to have attribute(visibility: 'public')
=end
end

context "user marks the review as private" do
=begin
unselect checkbox 'consent'
click 'submit review'
expect response.to have attribute(visibility: 'private')
=end
end

context "user views the sample review for assignment" do
=begin
click link 'View Sample Review'
click link 'Sample Review 1'
expect page.to have content('Review')
=end
end
end

describe "instructor" do
context "instructor marks the review as sample" do
=begin
click button 'Mark as example'
expect page.to have_content('Select similar assignments')
=end
end

context "instructor selects similar assignments" do
=begin
click button 'Mark as example'
select checkbox from 'similar_assignments'
click button 'Publish Review'
expect response.to have_attribute('published')
expect Sample_reviews.to have_attribute(assignment_id: assignment.id)
=end
end
end

== Resources ==

Previous Team's Work: https://expertiza.csc.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example 

Repository link: https://github.com/khotAyush/expertiza/tree/e2022/sample-reviews

== Team ==

Mentor: Dr. Ed Gehringer (efg@ncsu.edu)

Ayush Khot (akhot@ncsu.edu) 
Akanksha Bhattacharya (anbhatta@ncsu.edu) 
Jasmine Madonna Sabarimuthu (jsabari@ncsu.edu) 
Sujal (ssujal@ncsu.edu)

File:Db.png

2020-05-01T14:47:35Z

Ssujal: Ssujal uploaded a new version of File:Db.png

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-05-01T14:27:20Z

Ssujal: /* Our approach */

== Introduction ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza] provides a feature to peer review other teams assignments/projects after the submission deadline. Peer reviewing is usually done immediately (within one or two days) after the submission deadline, so that the students get a feedback on their work as soon as they complete it. Then the students are allowed to re-submit the project based on the reviews they get. A constructive review will help students to improve their project in a better way.

Even though advice is given by instructors on how to make a good review, students sometimes find difficulty in providing a helpful review. The quality of the reviews can be improved if students are shown some example reviews while they peer review. These example reviews can either be taken from the assignment of current semester or from the same/related project of previous semesters.

== Problem Statement ==

The objective of the project is to add a feature to show some good sample reviews while the students peer review other teams work. To enable this, students while submitting their peer review give a consent on whether their reviews can be shown as an example to others.
Instructors then select a subset of these reviews to be posted as an example reviews. These example reviews are shown in the peer review page (Other's work link) to the entire class.

Additionally,

1. Students should be able to see an entire review, both text and ratings, not just a single comment.

2. The student view should not show the name of the reviewer or the reviewee. The views of power users such as TA, instructor, admin should show these names.

3. The student can remove their consent anytime, and the sample review should no longer be visible to other students.

== Previous work ==

This project was implemented twice before and it was last done in Fall 2019. Though their implementation worked from the UI perspective, there were problems in the code so it was not merged. Some of the problems of the previous work are

1. There were many unexplained code blocks. These code blocks where acquired from previous implementation and the last team seem to have retained it so that the build passes.

2. Project included many irrelevant files and included classes the team didn't understand.

3. Testing was not thorough.

We almost follow the same design as previous work, but we will do our own implementation so that the above problems are addressed.

== Design ==

=== Key Features ===

In the order of flow,

'''1. Student's Consent:'''
In each review assignment, there will be a checkbox that says "I agree to share my review as a sample for others" then students can decide to check this box or not just before they submit reviews. Similarly, the student can revert it back to 'private' anytime. This could be implemented by the simple addition of a checkbox in '''response/view.html.erb''' and set a "visibility" field to “public”of the Response object via a controller method, "toggle_permission".

'''Sequence Diagram:'''
[[File:SQ1.png|none|User_MarkAsPublic_sequence]]

'''2. Instructor's Selection:''' The instructor can select from among the "public" reviews and decides which to make visible to other students doing a particular assignment, i.e. all participants in that assignment. And this will set the “visibility” field to “publish”.
Specifically, the instructor first goes to “View review report” and clicks on one team name (in the “Team reviewed” column). Then in the popup/team_users_popup page we need to add a button (better put it at top right) named “make this review an example”. If this review has already been shown as an example, the button should be “remove this review from examples” instead.

'''Sequence Diagram:'''
[[File:feature_instructor.png|none|Instructor_MarkAsSample_sequence]]

'''3. List of Sample Reviews: ''' A participant can see these "exemplary" reviews by going to "Others' work" for the assignment in question, and clicking on one or more links that say, e.g., "Sample review". And it should be shown just below the title “Review for ...”. It could be implemented on the '''student_reviews/list.html.erb'''.

'''Sequence Diagram:'''
[[File:feature_viewSample.png|none|User_MarkAsPublic_sequence]]

== Use Case Diagram ==
* Use Cases -

[[Image:UseCase.png]]

'''Power Users:''' Instructors, TAs, Admins and Super Admins

=== Solution Approach ===

To identify the reviews to be shown as an example, we append a column to the responses table representing their respective status. The following table explains the significance of each value:

{| class="wikitable"
! Visibility
! Explanation of the value
|-
| PRIVATE || Default, private
|-
| PUBLIC || Public (selected by the student but has not been selected as a sample review by the instructors.
|-
| PUBLISHED || Selected to show as example by the instructors.
|-
|}

'''1. Schema:''' Update the schema with the following column changes via migrations.

1) Add 'visibility' column to responses

2) Add new Table 'sample_reviews'

'''2. Mapping of Reviews and Assignment:''' The example reviews can either be taken from an assignment of the current course or it could be from an assignment from a previous course. This would enable students working on OSS Project to see OSS Project reviews from a previous semester. One idea is that when clicking to “make this review an example”, it will link to a page where you can select an assignment to which you have access (the same as the list of “Assignment” in the tree_display), then the example review will be shown to all participants of that specific assignment. We also need to do the same thing for “remove this review from examples”
Since we already have a '''response_maps''' table, we can add a column to map it with a specific assignment. This may/may not need a change in key constraints for the table. We plan to resolve them accordingly.

'''3. MVC Setup:''' We would need to create new partials in various views, and possibly a helper for response_controller.rb. We could achieve that by creating a MVC setup for the entire flow.

=== Code changes ===

1. '''Database changes:''' Added a column visibility in responses table.

2. Added a checkbox to select whether reviews could be shown as an example in the response views - '''/app/views/response/response.html.erb'''

3. On selecting the checkbox, update the visibility field in responses table in response controller - '''/app/controllers/response_controller.rb'''

4. The reviews which are marked as public by the students are marked with a tick mark in the review report views for the instructors. For this changes were made in the file _review_report.html.erb. A tick mark is shown if the visibility status of a response is public or published. To check for the visibility status a method visibility_public? is added in review_mapping_helper.

5. To allow instructor to select among the public reviews to shown as examples to all students a button 'Mark as an example' in the popup views. Changes corresponding to this is made in '''/app/views/popup/team_users_popup.html.haml'''

5. To enable students to see the example reviews, a link Sample reviews is added in the Other's work page. Made changes in the views of student_review - '''/app/views/student_review/list.html.erb'''

== DB Design ==

=== Previous work ===
The previous approach for DB design added 2 new DB tables to store the status and association of sample reviews, namely, '''samplereviewmaps''' and '''similar_assignemnts'''. The samplereviewmaps table simple stored 2 fkey associations to review_map id and to the assignment_id.

=== Our approach ===
In our approach, we are extending the existing response_maps table to contain an additional field, 'status', that stores the status of the response(review), as suggested in the above approach. This approach would prune the need to add an extra DB table, which would store redundant information. Additionally, the similar_assignemnts table would store the association for a response to all the assignments, the instructor/TA decide to publish for.

[[File:Db.png|none|User_MarkAsPublic_sequence]]

== Test Plan ==

Our test plan includes testing through rspec tests and through GUI.

=== Manual Testing ===

'''As a Power User (TA/Instructor/Admin/Super Admin)'''
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click View Report/Review for a particular assignment.
# Displays a list of reviews submitted by students.
# Click on any review in "team reviewed" column for a particular student.
# Displays the summary of reviews submitted by that student, with a "Make as sample" button on the right of every review.
# Click on "Make as sample" for the intended reviews, which opens a popup that displays a list of all assignments that are a part of the instructor's courses.
# From this list select all assignments for which the review has to be shown as a sample.
# Click on 'Submit' after selection (this closes the popup).
# Navigate to view reviews of that particular assignment and click on "Sample Reviews".
# A new page is opened that lists out all the sample reviews of the assignment.

'''As a Student (Scenario 1)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Show example reviews" link.
# This opens a page where the student can view all example reviews for that assignment.

'''As a Student (Scenario 2)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Chose to review any of the teams' assignments that are displayed.
# Select a team for review and fill in the review.
# Before submitting the review, select the checkbox that says "I agree to share this review anonymously as an example to the entire class".
# After clicking on the submit button, the review submitted has been made public.

=== RSpec Testing ===

The following acceptance tests using the RSpec/Capybara tests to be written.
TODO: Add comments
describe "user_review" do
context "user marks the review as public" do
..
end

context "user marks the review as private" do
..
end

context "user views the sample review for assignment" do
..
end
end

describe "instructor" do
context "instructor marks the review as sample" do
..
end

context "instructor selects similar assignments" do
..
end
end

== Resources ==

Previous Team's Work: https://expertiza.csc.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example 

Repository link: https://github.com/khotAyush/expertiza/tree/e2022/sample-reviews

== Team ==

Mentor: Dr. Ed Gehringer (efg@ncsu.edu)

Ayush Khot (akhot@ncsu.edu) 
Akanksha Bhattacharya (anbhatta@ncsu.edu) 
Jasmine Madonna Sabarimuthu (jsabari@ncsu.edu) 
Sujal (ssujal@ncsu.edu)

File:Db.png

2020-05-01T14:25:29Z

Ssujal:

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-04-25T02:09:19Z

Ssujal: /* Key Features */

== Introduction ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza] provides a feature to peer review other teams assignments/projects after the submission deadline. Peer reviewing is usually done immediately (within one or two days) after the submission deadline, so that the students get a feedback on their work as soon as they complete it. Then the students are allowed to re-submit the project based on the reviews they get. A constructive review will help students to improve their project in a better way.

Even though advice is given by instructors on how to make a good review, students sometimes find difficulty in providing a helpful review. The quality of the reviews can be improved if students are shown some example reviews while they peer review. These example reviews can either be taken from the assignment of current semester or from the same/related project of previous semesters.

== Problem Statement ==

The objective of the project is to add a feature to show some good sample reviews while the students peer review other teams work. To enable this, students while submitting their peer review give a consent on whether their reviews can be shown as an example to others.
Instructors then select a subset of these reviews to be posted as an example reviews. These example reviews are shown in the peer review page (Other's work link) to the entire class.

Additionally,

1. Students should be able to see an entire review, both text and ratings, not just a single comment.

2. The student view should not show the name of the reviewer or the reviewee. The views of power users such as TA, instructor, admin should show these names.

3. The student can remove their consent anytime, and the sample review should no longer be visible to other students.

== Previous work ==

This project was implemented twice before and it was last done in Fall 2019. Though their implementation worked from the UI perspective, there were problems in the code so it was not merged. Some of the problems of the previous work are

1. There were many unexplained code blocks. These code blocks where acquired from previous implementation and the last team seem to have retained it so that the build passes.

2. Project included many irrelevant files and included classes the team didn't understand.

3. Testing was not thorough.

We almost follow the same design as previous work, but we will do our own implementation so that the above problems are addressed.

== Design ==

=== Key Features ===

In the order of flow,

'''1. Student's Consent:'''
In each review assignment, there will be a checkbox that says "I agree to share my review as a sample for others" then students can decide to check this box or not just before they submit reviews. Similarly, the student can revert it back to 'private' anytime. This could be implemented by the simple addition of a checkbox in '''response/view.html.erb''' and set a "visibility" field to “public”of the Response object via a controller method, "toggle_permission".

'''Sequence Diagram:'''
[[File:SQ1.png|none|User_MarkAsPublic_sequence]]

'''2. Instructor's Selection:''' The instructor can select from among the "public" reviews and decides which to make visible to other students doing a particular assignment, i.e. all participants in that assignment. And this will set the “visibility” field to “publish”.
Specifically, the instructor first goes to “View review report” and clicks on one team name (in the “Team reviewed” column). Then in the popup/team_users_popup page we need to add a button (better put it at top right) named “make this review an example”. If this review has already been shown as an example, the button should be “remove this review from examples” instead.

'''Sequence Diagram:'''
[[File:feature_instructor.png|none|Instructor_MarkAsSample_sequence]]

'''3. List of Sample Reviews: ''' A participant can see these "exemplary" reviews by going to "Others' work" for the assignment in question, and clicking on one or more links that say, e.g., "Sample review". And it should be shown just below the title “Review for ...”. It could be implemented on the '''student_reviews/list.html.erb'''.

'''Sequence Diagram:'''
[[File:feature_viewSample.png|none|User_MarkAsPublic_sequence]]

== Use Case Diagram ==
* Use Cases -

[[Image:UseCase.png]]

'''Power Users:''' Instructors, TAs, Admins and Super Admins

=== Proposed Solution Approach ===

To identify the reviews to be shown as an example, we append a column to the response_maps table representing their respective status. The following table explains the significance of each value:

{| class="wikitable"
! Status
! Explanation of the value
|-
| PRIVATE || Default, private
|-
| PUBLIC || Public (selected by the student but has not been selected as a sample review by the instructors.
|-
| PUBLISHED || Selected to show as example by the instructors.
|-
|}

'''1. Schema:''' Update the schema with the following column changes via migrations.

1) Add 'status' column to responses

2) Add new Table 'sample_reviews'

'''2. Mapping of Reviews and Assignment:''' The example reviews can either be taken from an assignment of the current course or it could be from an assignment from a previous course. This would enable students working on OSS Project to see OSS Project reviews from a previous semester. One idea is that when clicking to “make this review an example”, it will link to a page where you can select an assignment to which you have access (the same as the list of “Assignment” in the tree_display), then the example review will be shown to all participants of that specific assignment. We also need to do the same thing for “remove this review from examples”
Since we already have a '''response_maps''' table, we can add a column to map it with a specific assignment. This may/may not need a change in key constraints for the table. We plan to resolve them accordingly.

'''3. MVC Setup:''' We would need to create new partials in various views, and possibly a helper for response_controller.rb. We could achieve that by creating a MVC setup for the entire flow.

=== Proposed code changes ===

1. Adding a column status in response_maps table. Changes will happen in '''db/schema.rb'''

2. Adding a checkbox to select whether reviews could be shown as an example in the response views - '''/app/views/response/response.html.erb'''

3. On selecting the checkbox, update the status field in response_maps table in response controller - '''/app/controllers/response_controller.rb'''

4. To allow instructor to select among the public reviews make changes in '''/app/views/popup/team_users_popup.html.haml'''

5. To enable students to see the example reviews, make changes in the views of student_review - '''/app/views/student_review/list.html.erb'''

== DB Design ==

=== Previous work ===
The previous approach for DB design added 2 new DB tables to store the status and association of sample reviews, namely, '''samplereviewmaps''' and '''similar_assignemnts'''. The samplereviewmaps table simple stored 2 fkey associations to review_map id and to the assignment_id.

=== Our approach ===
In our approach, we are extending the existing response_maps table to contain an additional field, 'status', that stores the status of the response(review), as suggested in the above approach. This approach would prune the need to add an extra DB table, which would store redundant information. Additionally, the similar_assignemnts table would store the association for a response to all the assignments, the instructor/TA decide to publish for.

[[File:db_design_e2022.png|none|User_MarkAsPublic_sequence]]

== Test Plan ==

Our test plan includes testing through rspec tests and through GUI.

=== Manual Testing ===

'''As a Power User (TA/Instructor/Admin/Super Admin)'''
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click View Report/Review for a particular assignment.
# Displays a list of reviews submitted by students.
# Click on any review in "team reviewed" column for a particular student.
# Displays the summary of reviews submitted by that student, with a "Make as sample" button on the right of every review.
# Click on "Make as sample" for the intended reviews, which opens a popup that displays a list of all assignments that are a part of the instructor's courses.
# From this list select all assignments for which the review has to be shown as a sample.
# Click on 'Submit' after selection (this closes the popup).
# Navigate to view reviews of that particular assignment and click on "Sample Reviews".
# A new page is opened that lists out all the sample reviews of the assignment.

'''As a Student (Scenario 1)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Show example reviews" link.
# This opens a page where the student can view all example reviews for that assignment.

'''As a Student (Scenario 2)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Chose to review any of the teams' assignments that are displayed.
# Select a team for review and fill in the review.
# Before submitting the review, select the checkbox that says "I agree to share this review anonymously as an example to the entire class".
# After clicking on the submit button, the review submitted has been made public.

=== RSpec Testing ===

The following acceptance tests using the RSpec/Capybara tests to be written.
TODO: Add comments
describe "user_review" do
context "user marks the review as public" do
..
end

context "user marks the review as private" do
..
end

context "user views the sample review for assignment" do
..
end
end

describe "instructor" do
context "instructor marks the review as sample" do
..
end

context "instructor selects similar assignments" do
..
end
end

== Resources ==

Previous Team's Work: https://expertiza.csc.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example 

Repository link: https://github.com/khotAyush/expertiza/tree/e2022/sample-reviews

== Team ==

Mentor: Dr. Ed Gehringer (efg@ncsu.edu)

Ayush Khot (akhot@ncsu.edu) 
Akanksha Bhattacharya (anbhatta@ncsu.edu) 
Jasmine Madonna Sabarimuthu (jsabari@ncsu.edu) 
Sujal (ssujal@ncsu.edu)

File:SQ1.png

2020-04-25T02:07:40Z

Ssujal:

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-04-25T02:06:06Z

Ssujal: /* Key Features */

== Introduction ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza] provides a feature to peer review other teams assignments/projects after the submission deadline. Peer reviewing is usually done immediately (within one or two days) after the submission deadline, so that the students get a feedback on their work as soon as they complete it. Then the students are allowed to re-submit the project based on the reviews they get. A constructive review will help students to improve their project in a better way.

Even though advice is given by instructors on how to make a good review, students sometimes find difficulty in providing a helpful review. The quality of the reviews can be improved if students are shown some example reviews while they peer review. These example reviews can either be taken from the assignment of current semester or from the same/related project of previous semesters.

== Problem Statement ==

The objective of the project is to add a feature to show some good sample reviews while the students peer review other teams work. To enable this, students while submitting their peer review give a consent on whether their reviews can be shown as an example to others.
Instructors then select a subset of these reviews to be posted as an example reviews. These example reviews are shown in the peer review page (Other's work link) to the entire class.

Additionally,

1. Students should be able to see an entire review, both text and ratings, not just a single comment.

2. The student view should not show the name of the reviewer or the reviewee. The views of power users such as TA, instructor, admin should show these names.

3. The student can remove their consent anytime, and the sample review should no longer be visible to other students.

== Previous work ==

This project was implemented twice before and it was last done in Fall 2019. Though their implementation worked from the UI perspective, there were problems in the code so it was not merged. Some of the problems of the previous work are

1. There were many unexplained code blocks. These code blocks where acquired from previous implementation and the last team seem to have retained it so that the build passes.

2. Project included many irrelevant files and included classes the team didn't understand.

3. Testing was not thorough.

We almost follow the same design as previous work, but we will do our own implementation so that the above problems are addressed.

== Design ==

=== Key Features ===

In the order of flow,

'''1. Student's Consent:'''
In each review assignment, there will be a checkbox that says "I agree to share my review as a sample for others" then students can decide to check this box or not just before they submit reviews. Similarly, the student can revert it back to 'private' anytime. This could be implemented by the simple addition of a checkbox in '''response/view.html.erb''' and set a "visibility" field to “public”of the Response object via a controller method, "toggle_permission".

'''Sequence Diagram:'''
[[File:Feature user.png|none|User_MarkAsPublic_sequence]]

'''2. Instructor's Selection:''' The instructor can select from among the "public" reviews and decides which to make visible to other students doing a particular assignment, i.e. all participants in that assignment. And this will set the “visibility” field to “publish”.
Specifically, the instructor first goes to “View review report” and clicks on one team name (in the “Team reviewed” column). Then in the popup/team_users_popup page we need to add a button (better put it at top right) named “make this review an example”. If this review has already been shown as an example, the button should be “remove this review from examples” instead.

'''Sequence Diagram:'''
[[File:feature_instructor.png|none|Instructor_MarkAsSample_sequence]]

'''3. List of Sample Reviews: ''' A participant can see these "exemplary" reviews by going to "Others' work" for the assignment in question, and clicking on one or more links that say, e.g., "Sample review". And it should be shown just below the title “Review for ...”. It could be implemented on the '''student_reviews/list.html.erb'''.

'''Sequence Diagram:'''
[[File:feature_viewSample.png|none|User_MarkAsPublic_sequence]]

== Use Case Diagram ==
* Use Cases -

[[Image:UseCase.png]]

'''Power Users:''' Instructors, TAs, Admins and Super Admins

=== Proposed Solution Approach ===

To identify the reviews to be shown as an example, we append a column to the response_maps table representing their respective status. The following table explains the significance of each value:

{| class="wikitable"
! Status
! Explanation of the value
|-
| PRIVATE || Default, private
|-
| PUBLIC || Public (selected by the student but has not been selected as a sample review by the instructors.
|-
| PUBLISHED || Selected to show as example by the instructors.
|-
|}

'''1. Schema:''' Update the schema with the following column changes via migrations.

1) Add 'status' column to responses

2) Add new Table 'sample_reviews'

'''2. Mapping of Reviews and Assignment:''' The example reviews can either be taken from an assignment of the current course or it could be from an assignment from a previous course. This would enable students working on OSS Project to see OSS Project reviews from a previous semester. One idea is that when clicking to “make this review an example”, it will link to a page where you can select an assignment to which you have access (the same as the list of “Assignment” in the tree_display), then the example review will be shown to all participants of that specific assignment. We also need to do the same thing for “remove this review from examples”
Since we already have a '''response_maps''' table, we can add a column to map it with a specific assignment. This may/may not need a change in key constraints for the table. We plan to resolve them accordingly.

'''3. MVC Setup:''' We would need to create new partials in various views, and possibly a helper for response_controller.rb. We could achieve that by creating a MVC setup for the entire flow.

=== Proposed code changes ===

1. Adding a column status in response_maps table. Changes will happen in '''db/schema.rb'''

2. Adding a checkbox to select whether reviews could be shown as an example in the response views - '''/app/views/response/response.html.erb'''

3. On selecting the checkbox, update the status field in response_maps table in response controller - '''/app/controllers/response_controller.rb'''

4. To allow instructor to select among the public reviews make changes in '''/app/views/popup/team_users_popup.html.haml'''

5. To enable students to see the example reviews, make changes in the views of student_review - '''/app/views/student_review/list.html.erb'''

== DB Design ==

=== Previous work ===
The previous approach for DB design added 2 new DB tables to store the status and association of sample reviews, namely, '''samplereviewmaps''' and '''similar_assignemnts'''. The samplereviewmaps table simple stored 2 fkey associations to review_map id and to the assignment_id.

=== Our approach ===
In our approach, we are extending the existing response_maps table to contain an additional field, 'status', that stores the status of the response(review), as suggested in the above approach. This approach would prune the need to add an extra DB table, which would store redundant information. Additionally, the similar_assignemnts table would store the association for a response to all the assignments, the instructor/TA decide to publish for.

[[File:db_design_e2022.png|none|User_MarkAsPublic_sequence]]

== Test Plan ==

Our test plan includes testing through rspec tests and through GUI.

=== Manual Testing ===

'''As a Power User (TA/Instructor/Admin/Super Admin)'''
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click View Report/Review for a particular assignment.
# Displays a list of reviews submitted by students.
# Click on any review in "team reviewed" column for a particular student.
# Displays the summary of reviews submitted by that student, with a "Make as sample" button on the right of every review.
# Click on "Make as sample" for the intended reviews, which opens a popup that displays a list of all assignments that are a part of the instructor's courses.
# From this list select all assignments for which the review has to be shown as a sample.
# Click on 'Submit' after selection (this closes the popup).
# Navigate to view reviews of that particular assignment and click on "Sample Reviews".
# A new page is opened that lists out all the sample reviews of the assignment.

'''As a Student (Scenario 1)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Show example reviews" link.
# This opens a page where the student can view all example reviews for that assignment.

'''As a Student (Scenario 2)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Chose to review any of the teams' assignments that are displayed.
# Select a team for review and fill in the review.
# Before submitting the review, select the checkbox that says "I agree to share this review anonymously as an example to the entire class".
# After clicking on the submit button, the review submitted has been made public.

=== RSpec Testing ===

The following acceptance tests using the RSpec/Capybara tests to be written.
TODO: Add comments
describe "user_review" do
context "user marks the review as public" do
..
end

context "user marks the review as private" do
..
end

context "user views the sample review for assignment" do
..
end
end

describe "instructor" do
context "instructor marks the review as sample" do
..
end

context "instructor selects similar assignments" do
..
end
end

== Resources ==

Previous Team's Work: https://expertiza.csc.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example 

Repository link: https://github.com/khotAyush/expertiza/tree/e2022/sample-reviews

== Team ==

Mentor: Dr. Ed Gehringer (efg@ncsu.edu)

Ayush Khot (akhot@ncsu.edu) 
Akanksha Bhattacharya (anbhatta@ncsu.edu) 
Jasmine Madonna Sabarimuthu (jsabari@ncsu.edu) 
Sujal (ssujal@ncsu.edu)

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-04-25T02:05:24Z

Ssujal: /* Key Features */

== Introduction ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza] provides a feature to peer review other teams assignments/projects after the submission deadline. Peer reviewing is usually done immediately (within one or two days) after the submission deadline, so that the students get a feedback on their work as soon as they complete it. Then the students are allowed to re-submit the project based on the reviews they get. A constructive review will help students to improve their project in a better way.

Even though advice is given by instructors on how to make a good review, students sometimes find difficulty in providing a helpful review. The quality of the reviews can be improved if students are shown some example reviews while they peer review. These example reviews can either be taken from the assignment of current semester or from the same/related project of previous semesters.

== Problem Statement ==

The objective of the project is to add a feature to show some good sample reviews while the students peer review other teams work. To enable this, students while submitting their peer review give a consent on whether their reviews can be shown as an example to others.
Instructors then select a subset of these reviews to be posted as an example reviews. These example reviews are shown in the peer review page (Other's work link) to the entire class.

Additionally,

1. Students should be able to see an entire review, both text and ratings, not just a single comment.

2. The student view should not show the name of the reviewer or the reviewee. The views of power users such as TA, instructor, admin should show these names.

3. The student can remove their consent anytime, and the sample review should no longer be visible to other students.

== Previous work ==

This project was implemented twice before and it was last done in Fall 2019. Though their implementation worked from the UI perspective, there were problems in the code so it was not merged. Some of the problems of the previous work are

1. There were many unexplained code blocks. These code blocks where acquired from previous implementation and the last team seem to have retained it so that the build passes.

2. Project included many irrelevant files and included classes the team didn't understand.

3. Testing was not thorough.

We almost follow the same design as previous work, but we will do our own implementation so that the above problems are addressed.

== Design ==

=== Key Features ===

In the order of flow,

'''1. Student's Consent:'''
In each review assignment, there will be a checkbox that says "I agree to share my review as a sample for others" then students can decide to check this box or not just before they submit reviews. Similarly, the student can revert it back to 'private' anytime. This could be implemented by the simple addition of a checkbox in '''response/view.html.erb''' and set a "visibility" field to “public”of the Response object via a controller method, "toggle_permission".

'''Sequence Diagram:'''
[[File:Feature user.png]]

[[File:feature_user.png|none|User_MarkAsPublic_sequence]]

'''2. Instructor's Selection:''' The instructor can select from among the "public" reviews and decides which to make visible to other students doing a particular assignment, i.e. all participants in that assignment. And this will set the “visibility” field to “publish”.
Specifically, the instructor first goes to “View review report” and clicks on one team name (in the “Team reviewed” column). Then in the popup/team_users_popup page we need to add a button (better put it at top right) named “make this review an example”. If this review has already been shown as an example, the button should be “remove this review from examples” instead.

'''Sequence Diagram:'''
[[File:feature_instructor.png|none|Instructor_MarkAsSample_sequence]]

'''3. List of Sample Reviews: ''' A participant can see these "exemplary" reviews by going to "Others' work" for the assignment in question, and clicking on one or more links that say, e.g., "Sample review". And it should be shown just below the title “Review for ...”. It could be implemented on the '''student_reviews/list.html.erb'''.

'''Sequence Diagram:'''
[[File:feature_viewSample.png|none|User_MarkAsPublic_sequence]]

== Use Case Diagram ==
* Use Cases -

[[Image:UseCase.png]]

'''Power Users:''' Instructors, TAs, Admins and Super Admins

=== Proposed Solution Approach ===

To identify the reviews to be shown as an example, we append a column to the response_maps table representing their respective status. The following table explains the significance of each value:

{| class="wikitable"
! Status
! Explanation of the value
|-
| PRIVATE || Default, private
|-
| PUBLIC || Public (selected by the student but has not been selected as a sample review by the instructors.
|-
| PUBLISHED || Selected to show as example by the instructors.
|-
|}

'''1. Schema:''' Update the schema with the following column changes via migrations.

1) Add 'status' column to responses

2) Add new Table 'sample_reviews'

'''2. Mapping of Reviews and Assignment:''' The example reviews can either be taken from an assignment of the current course or it could be from an assignment from a previous course. This would enable students working on OSS Project to see OSS Project reviews from a previous semester. One idea is that when clicking to “make this review an example”, it will link to a page where you can select an assignment to which you have access (the same as the list of “Assignment” in the tree_display), then the example review will be shown to all participants of that specific assignment. We also need to do the same thing for “remove this review from examples”
Since we already have a '''response_maps''' table, we can add a column to map it with a specific assignment. This may/may not need a change in key constraints for the table. We plan to resolve them accordingly.

'''3. MVC Setup:''' We would need to create new partials in various views, and possibly a helper for response_controller.rb. We could achieve that by creating a MVC setup for the entire flow.

=== Proposed code changes ===

1. Adding a column status in response_maps table. Changes will happen in '''db/schema.rb'''

2. Adding a checkbox to select whether reviews could be shown as an example in the response views - '''/app/views/response/response.html.erb'''

3. On selecting the checkbox, update the status field in response_maps table in response controller - '''/app/controllers/response_controller.rb'''

4. To allow instructor to select among the public reviews make changes in '''/app/views/popup/team_users_popup.html.haml'''

5. To enable students to see the example reviews, make changes in the views of student_review - '''/app/views/student_review/list.html.erb'''

== DB Design ==

=== Previous work ===
The previous approach for DB design added 2 new DB tables to store the status and association of sample reviews, namely, '''samplereviewmaps''' and '''similar_assignemnts'''. The samplereviewmaps table simple stored 2 fkey associations to review_map id and to the assignment_id.

=== Our approach ===
In our approach, we are extending the existing response_maps table to contain an additional field, 'status', that stores the status of the response(review), as suggested in the above approach. This approach would prune the need to add an extra DB table, which would store redundant information. Additionally, the similar_assignemnts table would store the association for a response to all the assignments, the instructor/TA decide to publish for.

[[File:db_design_e2022.png|none|User_MarkAsPublic_sequence]]

== Test Plan ==

Our test plan includes testing through rspec tests and through GUI.

=== Manual Testing ===

'''As a Power User (TA/Instructor/Admin/Super Admin)'''
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click View Report/Review for a particular assignment.
# Displays a list of reviews submitted by students.
# Click on any review in "team reviewed" column for a particular student.
# Displays the summary of reviews submitted by that student, with a "Make as sample" button on the right of every review.
# Click on "Make as sample" for the intended reviews, which opens a popup that displays a list of all assignments that are a part of the instructor's courses.
# From this list select all assignments for which the review has to be shown as a sample.
# Click on 'Submit' after selection (this closes the popup).
# Navigate to view reviews of that particular assignment and click on "Sample Reviews".
# A new page is opened that lists out all the sample reviews of the assignment.

'''As a Student (Scenario 1)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Show example reviews" link.
# This opens a page where the student can view all example reviews for that assignment.

'''As a Student (Scenario 2)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Chose to review any of the teams' assignments that are displayed.
# Select a team for review and fill in the review.
# Before submitting the review, select the checkbox that says "I agree to share this review anonymously as an example to the entire class".
# After clicking on the submit button, the review submitted has been made public.

=== RSpec Testing ===

The following acceptance tests using the RSpec/Capybara tests to be written.
TODO: Add comments
describe "user_review" do
context "user marks the review as public" do
..
end

context "user marks the review as private" do
..
end

context "user views the sample review for assignment" do
..
end
end

describe "instructor" do
context "instructor marks the review as sample" do
..
end

context "instructor selects similar assignments" do
..
end
end

== Resources ==

Previous Team's Work: https://expertiza.csc.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example 

Repository link: https://github.com/khotAyush/expertiza/tree/e2022/sample-reviews

== Team ==

Mentor: Dr. Ed Gehringer (efg@ncsu.edu)

Ayush Khot (akhot@ncsu.edu) 
Akanksha Bhattacharya (anbhatta@ncsu.edu) 
Jasmine Madonna Sabarimuthu (jsabari@ncsu.edu) 
Sujal (ssujal@ncsu.edu)

File:Feature user.png

2020-04-25T02:00:47Z

Ssujal: Ssujal uploaded a new version of File:Feature user.png

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-04-24T21:57:09Z

Ssujal: /* Resources */

== Introduction ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza] provides a feature to peer review other teams assignments/projects after the submission deadline. Peer reviewing is usually done immediately (within one or two days) after the submission deadline, so that the students get a feedback on their work as soon as they complete it. Then the students are allowed to re-submit the project based on the reviews they get. A constructive review will help students to improve their project in a better way.

Even though advice is given by instructors on how to make a good review, students sometimes find difficulty in providing a helpful review. The quality of the reviews can be improved if students are shown some example reviews while they peer review. These example reviews can either be taken from the assignment of current semester or from the same/related project of previous semesters.

== Problem Statement ==

The objective of the project is to add a feature to show some good sample reviews while the students peer review other teams work. To enable this, students while submitting their peer review give a consent on whether their reviews can be shown as an example to others.
Instructors then select a subset of these reviews to be posted as an example reviews. These example reviews are shown in the peer review page (Other's work link) to the entire class.

Additionally,

1. Students should be able to see an entire review, both text and ratings, not just a single comment.

2. The student view should not show the name of the reviewer or the reviewee. The views of power users such as TA, instructor, admin should show these names.

3. The student can remove their consent anytime, and the sample review should no longer be visible to other students.

== Previous work ==

This project was implemented twice before and it was last done in Fall 2019. Though their implementation worked from the UI perspective, there were problems in the code so it was not merged. Some of the problems of the previous work are

1. There were many unexplained code blocks. These code blocks where acquired from previous implementation and the last team seem to have retained it so that the build passes.

2. Project included many irrelevant files and included classes the team didn't understand.

3. Testing was not thorough.

We almost follow the same design as previous work, but we will do our own implementation so that the above problems are addressed.

== Design ==

=== Key Features ===

In the order of flow,

'''1. Student's Consent:'''
In each review assignment, there will be a checkbox that says "I agree to share my review as a sample for others" then students can decide to check this box or not just before they submit reviews. Similarly, the student can revert it back to 'private' anytime. This could be implemented by the simple addition of a checkbox in '''response/view.html.erb''' and set a "visibility" field to “public”of the Response object via a controller method, "toggle_permission".

'''Sequence Diagram:'''
[[File:feature_user.png|none|User_MarkAsPublic_sequence]]

'''2. Instructor's Selection:''' The instructor can select from among the "public" reviews and decides which to make visible to other students doing a particular assignment, i.e. all participants in that assignment. And this will set the “visibility” field to “publish”.
Specifically, the instructor first goes to “View review report” and clicks on one team name (in the “Team reviewed” column). Then in the popup/team_users_popup page we need to add a button (better put it at top right) named “make this review an example”. If this review has already been shown as an example, the button should be “remove this review from examples” instead.

'''Sequence Diagram:'''
[[File:feature_instructor.png|none|Instructor_MarkAsSample_sequence]]

'''3. List of Sample Reviews: ''' A participant can see these "exemplary" reviews by going to "Others' work" for the assignment in question, and clicking on one or more links that say, e.g., "Sample review". And it should be shown just below the title “Review for ...”. It could be implemented on the '''student_reviews/list.html.erb'''.

'''Sequence Diagram:'''
[[File:feature_viewSample.png|none|User_MarkAsPublic_sequence]]

== Use Case Diagram ==
* Use Cases -

[[Image:UseCase.png]]

'''Power Users:''' Instructors, TAs, Admins and Super Admins

=== Proposed Solution Approach ===

To identify the reviews to be shown as an example, we append a column to the response_maps table representing their respective status. The following table explains the significance of each value:

{| class="wikitable"
! Status
! Explanation of the value
|-
| PRIVATE || Default, private
|-
| PUBLIC || Public (selected by the student but has not been selected as a sample review by the instructors.
|-
| PUBLISHED || Selected to show as example by the instructors.
|-
|}

'''1. Schema:''' Update the schema with the following column changes via migrations.

1) Add 'status' column to responses

2) Add new Table 'sample_reviews'

'''2. Mapping of Reviews and Assignment:''' The example reviews can either be taken from an assignment of the current course or it could be from an assignment from a previous course. This would enable students working on OSS Project to see OSS Project reviews from a previous semester. One idea is that when clicking to “make this review an example”, it will link to a page where you can select an assignment to which you have access (the same as the list of “Assignment” in the tree_display), then the example review will be shown to all participants of that specific assignment. We also need to do the same thing for “remove this review from examples”
Since we already have a '''response_maps''' table, we can add a column to map it with a specific assignment. This may/may not need a change in key constraints for the table. We plan to resolve them accordingly.

'''3. MVC Setup:''' We would need to create new partials in various views, and possibly a helper for response_controller.rb. We could achieve that by creating a MVC setup for the entire flow.

=== Proposed code changes ===

1. Adding a column status in response_maps table. Changes will happen in '''db/schema.rb'''

2. Adding a checkbox to select whether reviews could be shown as an example in the response views - '''/app/views/response/response.html.erb'''

3. On selecting the checkbox, update the status field in response_maps table in response controller - '''/app/controllers/response_controller.rb'''

4. To allow instructor to select among the public reviews make changes in '''/app/views/popup/team_users_popup.html.haml'''

5. To enable students to see the example reviews, make changes in the views of student_review - '''/app/views/student_review/list.html.erb'''

== DB Design ==

=== Previous work ===
The previous approach for DB design added 2 new DB tables to store the status and association of sample reviews, namely, '''samplereviewmaps''' and '''similar_assignemnts'''. The samplereviewmaps table simple stored 2 fkey associations to review_map id and to the assignment_id.

=== Our approach ===
In our approach, we are extending the existing response_maps table to contain an additional field, 'status', that stores the status of the response(review), as suggested in the above approach. This approach would prune the need to add an extra DB table, which would store redundant information. Additionally, the similar_assignemnts table would store the association for a response to all the assignments, the instructor/TA decide to publish for.

[[File:db_design_e2022.png|none|User_MarkAsPublic_sequence]]

== Test Plan ==

Our test plan includes testing through rspec tests and through GUI.

=== Manual Testing ===

'''As a Power User (TA/Instructor/Admin/Super Admin)'''
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click View Report/Review for a particular assignment.
# Displays a list of reviews submitted by students.
# Click on any review in "team reviewed" column for a particular student.
# Displays the summary of reviews submitted by that student, with a "Make as sample" button on the right of every review.
# Click on "Make as sample" for the intended reviews, which opens a popup that displays a list of all assignments that are a part of the instructor's courses.
# From this list select all assignments for which the review has to be shown as a sample.
# Click on 'Submit' after selection (this closes the popup).
# Navigate to view reviews of that particular assignment and click on "Sample Reviews".
# A new page is opened that lists out all the sample reviews of the assignment.

'''As a Student (Scenario 1)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Show example reviews" link.
# This opens a page where the student can view all example reviews for that assignment.

'''As a Student (Scenario 2)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Chose to review any of the teams' assignments that are displayed.
# Select a team for review and fill in the review.
# Before submitting the review, select the checkbox that says "I agree to share this review anonymously as an example to the entire class".
# After clicking on the submit button, the review submitted has been made public.

=== RSpec Testing ===

The following acceptance tests using the RSpec/Capybara tests to be written.
TODO: Add comments
describe "user_review" do
context "user marks the review as public" do
..
end

context "user marks the review as private" do
..
end

context "user views the sample review for assignment" do
..
end
end

describe "instructor" do
context "instructor marks the review as sample" do
..
end

context "instructor selects similar assignments" do
..
end
end

== Resources ==

Previous Team's Work: https://expertiza.csc.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example 

Repository link: https://github.com/khotAyush/expertiza/tree/e2022/sample-reviews

== Team ==

Mentor: Dr. Ed Gehringer (efg@ncsu.edu)

Ayush Khot (akhot@ncsu.edu) 
Akanksha Bhattacharya (anbhatta@ncsu.edu) 
Jasmine Madonna Sabarimuthu (jsabari@ncsu.edu) 
Sujal (ssujal@ncsu.edu)

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-04-23T02:47:29Z

Ssujal: /* Proposed Solution Approach */

== Introduction ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza] provides a feature to peer review other teams assignments/projects after the submission deadline. Peer reviewing is usually done immediately (within one or two days) after the submission deadline, so that the students get a feedback on their work as soon as they complete it. Then the students are allowed to re-submit the project based on the reviews they get. A constructive review will help students to improve their project in a better way.

Even though advice is given by instructors on how to make a good review, students sometimes find difficulty in providing a helpful review. The quality of the reviews can be improved if students are shown some example reviews while they peer review. These example reviews can either be taken from the assignment of current semester or from the same/related project of previous semesters.

== Problem Statement ==

The objective of the project is to add a feature to show some good sample reviews while the students peer review other teams work. To enable this, students while submitting their peer review give a consent on whether their reviews can be shown as an example to others.
Instructors then select a subset of these reviews to be posted as an example reviews. These example reviews are shown in the peer review page (Other's work link) to the entire class.

Additionally,

1. Students should be able to see an entire review, both text and ratings, not just a single comment.

2. The student view should not show the name of the reviewer or the reviewee. The views of power users such as TA, instructor, admin should show these names.

3. The student can remove their consent anytime, and the sample review should no longer be visible to other students.

== Previous work ==

This project was implemented twice before and it was last done in Fall 2019. Though their implementation worked from the UI perspective, there were problems in the code so it was not merged. Some of the problems of the previous work are

1. There were many unexplained code blocks. These code blocks where acquired from previous implementation and the last team seem to have retained it so that the build passes.

2. Project included many irrelevant files and included classes the team didn't understand.

3. Testing was not thorough.

We almost follow the same design as previous work, but we will do our own implementation so that the above problems are addressed.

== Design ==

=== Key Features ===

In the order of flow,

'''1. Student's Consent:'''
In each review assignment, there will be a checkbox that says "I agree to share my review as a sample for others" then students can decide to check this box or not just before they submit reviews. Similarly, the student can revert it back to 'private' anytime. This could be implemented by the simple addition of a checkbox in '''response/view.html.erb''' and set a "visibility" field to “public”of the Response object via a controller method, "toggle_permission".

'''Sequence Diagram:'''
[[File:feature_user.png|none|User_MarkAsPublic_sequence]]

'''2. Instructor's Selection:''' The instructor can select from among the "public" reviews and decides which to make visible to other students doing a particular assignment, i.e. all participants in that assignment. And this will set the “visibility” field to “publish”.
Specifically, the instructor first goes to “View review report” and clicks on one team name (in the “Team reviewed” column). Then in the popup/team_users_popup page we need to add a button (better put it at top right) named “make this review an example”. If this review has already been shown as an example, the button should be “remove this review from examples” instead.

'''Sequence Diagram:'''
[[File:feature_instructor.png|none|Instructor_MarkAsSample_sequence]]

'''3. List of Sample Reviews: ''' A participant can see these "exemplary" reviews by going to "Others' work" for the assignment in question, and clicking on one or more links that say, e.g., "Sample review". And it should be shown just below the title “Review for ...”. It could be implemented on the '''student_reviews/list.html.erb'''.

'''Sequence Diagram:'''
[[File:feature_viewSample.png|none|User_MarkAsPublic_sequence]]

== Use Case Diagram ==
* Use Cases -

[[Image:UseCase.png]]

'''Power Users:''' Instructors, TAs, Admins and Super Admins

=== Proposed Solution Approach ===

To identify the reviews to be shown as an example, we append a column to the response_maps table representing their respective status. The following table explains the significance of each value:

{| class="wikitable"
! Status
! Explanation of the value
|-
| PRIVATE || Default, private
|-
| PUBLIC || Public (selected by the student but has not been selected as a sample review by the instructors.
|-
| PUBLISHED || Selected to show as example by the instructors.
|-
|}

'''1. Schema:''' Update the schema with the following column changes via migrations.

1) Add 'status' column to responses

2) Add new Table 'sample_reviews'

'''2. Mapping of Reviews and Assignment:''' The example reviews can either be taken from an assignment of the current course or it could be from an assignment from a previous course. This would enable students working on OSS Project to see OSS Project reviews from a previous semester. One idea is that when clicking to “make this review an example”, it will link to a page where you can select an assignment to which you have access (the same as the list of “Assignment” in the tree_display), then the example review will be shown to all participants of that specific assignment. We also need to do the same thing for “remove this review from examples”
Since we already have a '''response_maps''' table, we can add a column to map it with a specific assignment. This may/may not need a change in key constraints for the table. We plan to resolve them accordingly.

'''3. MVC Setup:''' We would need to create new partials in various views, and possibly a helper for response_controller.rb. We could achieve that by creating a MVC setup for the entire flow.

=== Proposed code changes ===

1. Adding a column status in response_maps table. Changes will happen in '''db/schema.rb'''

2. Adding a checkbox to select whether reviews could be shown as an example in the response views - '''/app/views/response/response.html.erb'''

3. On selecting the checkbox, update the status field in response_maps table in response controller - '''/app/controllers/response_controller.rb'''

4. To allow instructor to select among the public reviews make changes in '''/app/views/popup/team_users_popup.html.haml'''

5. To enable students to see the example reviews, make changes in the views of student_review - '''/app/views/student_review/list.html.erb'''

== DB Design ==

=== Previous work ===
The previous approach for DB design added 2 new DB tables to store the status and association of sample reviews, namely, '''samplereviewmaps''' and '''similar_assignemnts'''. The samplereviewmaps table simple stored 2 fkey associations to review_map id and to the assignment_id.

=== Our approach ===
In our approach, we are extending the existing response_maps table to contain an additional field, 'status', that stores the status of the response(review), as suggested in the above approach. This approach would prune the need to add an extra DB table, which would store redundant information. Additionally, the similar_assignemnts table would store the association for a response to all the assignments, the instructor/TA decide to publish for.

[[File:db_design_e2022.png|none|User_MarkAsPublic_sequence]]

== Test Plan ==

Our test plan includes testing through rspec tests and through GUI.

=== Manual Testing ===

'''As a Power User (TA/Instructor/Admin/Super Admin)'''
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click View Report/Review for a particular assignment.
# Displays a list of reviews submitted by students.
# Click on any review in "team reviewed" column for a particular student.
# Displays the summary of reviews submitted by that student, with a "Make as sample" button on the right of every review.
# Click on "Make as sample" for the intended reviews, which opens a popup that displays a list of all assignments that are a part of the instructor's courses.
# From this list select all assignments for which the review has to be shown as a sample.
# Click on 'Submit' after selection (this closes the popup).
# Navigate to view reviews of that particular assignment and click on "Sample Reviews".
# A new page is opened that lists out all the sample reviews of the assignment.

'''As a Student (Scenario 1)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Show example reviews" link.
# This opens a page where the student can view all example reviews for that assignment.

'''As a Student (Scenario 2)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Chose to review any of the teams' assignments that are displayed.
# Select a team for review and fill in the review.
# Before submitting the review, select the checkbox that says "I agree to share this review anonymously as an example to the entire class".
# After clicking on the submit button, the review submitted has been made public.

=== RSpec Testing ===

The following acceptance tests using the RSpec/Capybara tests to be written.
TODO: Add comments
describe "user_review" do
context "user marks the review as public" do
..
end

context "user marks the review as private" do
..
end

context "user views the sample review for assignment" do
..
end
end

describe "instructor" do
context "instructor marks the review as sample" do
..
end

context "instructor selects similar assignments" do
..
end
end

== Resources ==

Previous Team's Work: https://expertiza.csc.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example 

Repository link: https://github.com/SujalAhrodia/expertiza

== Team ==

Mentor: Dr. Ed Gehringer (efg@ncsu.edu)

Ayush Khot (akhot@ncsu.edu) 
Akanksha Bhattacharya (anbhatta@ncsu.edu) 
Jasmine Madonna Sabarimuthu (jsabari@ncsu.edu) 
Sujal (ssujal@ncsu.edu)

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-04-23T02:46:48Z

Ssujal: /* Key Features */

== Introduction ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza] provides a feature to peer review other teams assignments/projects after the submission deadline. Peer reviewing is usually done immediately (within one or two days) after the submission deadline, so that the students get a feedback on their work as soon as they complete it. Then the students are allowed to re-submit the project based on the reviews they get. A constructive review will help students to improve their project in a better way.

Even though advice is given by instructors on how to make a good review, students sometimes find difficulty in providing a helpful review. The quality of the reviews can be improved if students are shown some example reviews while they peer review. These example reviews can either be taken from the assignment of current semester or from the same/related project of previous semesters.

== Problem Statement ==

The objective of the project is to add a feature to show some good sample reviews while the students peer review other teams work. To enable this, students while submitting their peer review give a consent on whether their reviews can be shown as an example to others.
Instructors then select a subset of these reviews to be posted as an example reviews. These example reviews are shown in the peer review page (Other's work link) to the entire class.

Additionally,

1. Students should be able to see an entire review, both text and ratings, not just a single comment.

2. The student view should not show the name of the reviewer or the reviewee. The views of power users such as TA, instructor, admin should show these names.

3. The student can remove their consent anytime, and the sample review should no longer be visible to other students.

== Previous work ==

This project was implemented twice before and it was last done in Fall 2019. Though their implementation worked from the UI perspective, there were problems in the code so it was not merged. Some of the problems of the previous work are

1. There were many unexplained code blocks. These code blocks where acquired from previous implementation and the last team seem to have retained it so that the build passes.

2. Project included many irrelevant files and included classes the team didn't understand.

3. Testing was not thorough.

We almost follow the same design as previous work, but we will do our own implementation so that the above problems are addressed.

== Design ==

=== Key Features ===

In the order of flow,

'''1. Student's Consent:'''
In each review assignment, there will be a checkbox that says "I agree to share my review as a sample for others" then students can decide to check this box or not just before they submit reviews. Similarly, the student can revert it back to 'private' anytime. This could be implemented by the simple addition of a checkbox in '''response/view.html.erb''' and set a "visibility" field to “public”of the Response object via a controller method, "toggle_permission".

'''Sequence Diagram:'''
[[File:feature_user.png|none|User_MarkAsPublic_sequence]]

'''2. Instructor's Selection:''' The instructor can select from among the "public" reviews and decides which to make visible to other students doing a particular assignment, i.e. all participants in that assignment. And this will set the “visibility” field to “publish”.
Specifically, the instructor first goes to “View review report” and clicks on one team name (in the “Team reviewed” column). Then in the popup/team_users_popup page we need to add a button (better put it at top right) named “make this review an example”. If this review has already been shown as an example, the button should be “remove this review from examples” instead.

'''Sequence Diagram:'''
[[File:feature_instructor.png|none|Instructor_MarkAsSample_sequence]]

'''3. List of Sample Reviews: ''' A participant can see these "exemplary" reviews by going to "Others' work" for the assignment in question, and clicking on one or more links that say, e.g., "Sample review". And it should be shown just below the title “Review for ...”. It could be implemented on the '''student_reviews/list.html.erb'''.

'''Sequence Diagram:'''
[[File:feature_viewSample.png|none|User_MarkAsPublic_sequence]]

== Use Case Diagram ==
* Use Cases -

[[Image:UseCase.png]]

'''Power Users:''' Instructors, TAs, Admins and Super Admins

=== Proposed Solution Approach ===

To identify the reviews to be shown as an example, we append a column to the response_maps table representing their respective status. The following table explains the significance of each value:

{| class="wikitable"
! Status
! Explanation of the value
|-
| PRIVATE || Default, private
|-
| PUBLIC || Public (selected by the student but has not been selected as a sample review by the instructors.
|-
| PUBLISHED || Selected to show as example by the instructors.
|-
|}

'''1. Schema:''' Update the schema with the following column changes via migrations.

1) Add 'status' column to response_map

2) Add new Table 'similar_assignments'

'''2. Mapping of Reviews and Assignment:''' The example reviews can either be taken from an assignment of the current course or it could be from an assignment from a previous course. This would enable students working on OSS Project to see OSS Project reviews from a previous semester. One idea is that when clicking to “make this review an example”, it will link to a page where you can select an assignment to which you have access (the same as the list of “Assignment” in the tree_display), then the example review will be shown to all participants of that specific assignment. We also need to do the same thing for “remove this review from examples”
Since we already have a '''response_maps''' table, we can add a column to map it with a specific assignment. This may/may not need a change in key constraints for the table. We plan to resolve them accordingly.

'''3. MVC Setup:''' We would need to create new partials in various views, and possibly a helper for response_controller.rb. We could achieve that by creating a MVC setup for the entire flow.

=== Proposed code changes ===

1. Adding a column status in response_maps table. Changes will happen in '''db/schema.rb'''

2. Adding a checkbox to select whether reviews could be shown as an example in the response views - '''/app/views/response/response.html.erb'''

3. On selecting the checkbox, update the status field in response_maps table in response controller - '''/app/controllers/response_controller.rb'''

4. To allow instructor to select among the public reviews make changes in '''/app/views/popup/team_users_popup.html.haml'''

5. To enable students to see the example reviews, make changes in the views of student_review - '''/app/views/student_review/list.html.erb'''

== DB Design ==

=== Previous work ===
The previous approach for DB design added 2 new DB tables to store the status and association of sample reviews, namely, '''samplereviewmaps''' and '''similar_assignemnts'''. The samplereviewmaps table simple stored 2 fkey associations to review_map id and to the assignment_id.

=== Our approach ===
In our approach, we are extending the existing response_maps table to contain an additional field, 'status', that stores the status of the response(review), as suggested in the above approach. This approach would prune the need to add an extra DB table, which would store redundant information. Additionally, the similar_assignemnts table would store the association for a response to all the assignments, the instructor/TA decide to publish for.

[[File:db_design_e2022.png|none|User_MarkAsPublic_sequence]]

== Test Plan ==

Our test plan includes testing through rspec tests and through GUI.

=== Manual Testing ===

'''As a Power User (TA/Instructor/Admin/Super Admin)'''
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click View Report/Review for a particular assignment.
# Displays a list of reviews submitted by students.
# Click on any review in "team reviewed" column for a particular student.
# Displays the summary of reviews submitted by that student, with a "Make as sample" button on the right of every review.
# Click on "Make as sample" for the intended reviews, which opens a popup that displays a list of all assignments that are a part of the instructor's courses.
# From this list select all assignments for which the review has to be shown as a sample.
# Click on 'Submit' after selection (this closes the popup).
# Navigate to view reviews of that particular assignment and click on "Sample Reviews".
# A new page is opened that lists out all the sample reviews of the assignment.

'''As a Student (Scenario 1)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Show example reviews" link.
# This opens a page where the student can view all example reviews for that assignment.

'''As a Student (Scenario 2)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Chose to review any of the teams' assignments that are displayed.
# Select a team for review and fill in the review.
# Before submitting the review, select the checkbox that says "I agree to share this review anonymously as an example to the entire class".
# After clicking on the submit button, the review submitted has been made public.

=== RSpec Testing ===

The following acceptance tests using the RSpec/Capybara tests to be written.
TODO: Add comments
describe "user_review" do
context "user marks the review as public" do
..
end

context "user marks the review as private" do
..
end

context "user views the sample review for assignment" do
..
end
end

describe "instructor" do
context "instructor marks the review as sample" do
..
end

context "instructor selects similar assignments" do
..
end
end

== Resources ==

Previous Team's Work: https://expertiza.csc.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example 

Repository link: https://github.com/SujalAhrodia/expertiza

== Team ==

Mentor: Dr. Ed Gehringer (efg@ncsu.edu)

Ayush Khot (akhot@ncsu.edu) 
Akanksha Bhattacharya (anbhatta@ncsu.edu) 
Jasmine Madonna Sabarimuthu (jsabari@ncsu.edu) 
Sujal (ssujal@ncsu.edu)

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-04-21T00:45:42Z

Ssujal: /* Key Features */

== Introduction ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza] provides a feature to peer review other teams assignments/projects after the submission deadline. Peer reviewing is usually done immediately (within one or two days) after the submission deadline, so that the students get a feedback on their work as soon as they complete it. Then the students are allowed to re-submit the project based on the reviews they get. A constructive review will help students to improve their project in a better way.

Even though advice is given by instructors on how to make a good review, students sometimes find difficulty in providing a helpful review. The quality of the reviews can be improved if students are shown some example reviews while they peer review. These example reviews can either be taken from the assignment of current semester or from the same/related project of previous semesters.

== Problem Statement ==

The objective of the project is to add a feature to show some good sample reviews while the students peer review other teams work. To enable this, students while submitting their peer review give a consent on whether their reviews can be shown as an example to others.
Instructors then select a subset of these reviews to be posted as an example reviews. These example reviews are shown in the peer review page (Other's work link) to the entire class.

Additionally,

1. Students should be able to see an entire review, both text and ratings, not just a single comment.

2. The student view should not show the name of the reviewer or the reviewee. The views of power users such as TA, instructor, admin should show these names.

3. The student can remove their consent anytime, and the sample review should no longer be visible to other students.

== Previous work ==

This project was implemented twice before and it was last done in Fall 2019. Though their implementation worked from the UI perspective, there were problems in the code so it was not merged. Some of the problems of the previous work are

1. There were many unexplained code blocks. These code blocks where acquired from previous implementation and the last team seem to have retained it so that the build passes.

2. Project included many irrelevant files and included classes the team didn't understand.

3. Testing was not thorough.

We almost follow the same design as previous work, but we will do our own implementation so that the above problems are addressed.

== Design ==

=== Key Features ===

In the order of flow,

'''1. Student's Consent:'''
In each review assignment, there will be a checkbox that says "I agree to share this review anonymously as an example to the entire class" then students can decide to check this box or not just before they submit reviews. Similarly, the student can revert it back to 'private' anytime. This could be implemented by the simple addition of a checkbox in '''view.html.erb''' and set a "visibility" field to “public”of the Response object via a controller method, preferably "create".

'''Sequence Diagram:'''
[[File:feature_user.png|none|User_MarkAsPublic_sequence]]

'''2. Instructor's Selection:''' The instructor can select from among the "public" reviews and decides which to make visible to other students doing a particular assignment, i.e. all participants in that assignment. And this will set the “visibility” field to “publish”.
Specifically, the instructor first goes to “View review report” and clicks on one team name (in the “Team reviewed” column). Then in the popup/team_users_popup page we need to add a button (better put it at top right) named “make this review an example”. If this review has already been shown as an example, the button should be “remove this review from examples” instead.

'''Sequence Diagram:'''
[[File:feature_instructor.png|none|Instructor_MarkAsSample_sequence]]

'''3. List of Sample Reviews: ''' A participant can see these "exemplary" reviews by going to "Others' work" for the assignment in question, and clicking on one or more links that say, e.g., "Sample review". And it should be shown just below the title “Review for ...”. It could be implemented on the '''student_reviews/list.html.erb'''.

'''Sequence Diagram:'''
[[File:feature_viewSample.png|none|User_MarkAsPublic_sequence]]

== Use Case Diagram ==
* Use Cases -

[[Image:UseCase.png]]

'''Power Users:''' Instructors, TAs, Admins and Super Admins

=== Proposed Solution Approach ===

To identify the reviews to be shown as an example, we append a column to the response_maps table representing their respective status. The following table explains the significance of each value:

{| class="wikitable"
! Status
! Explanation of the value
|-
| PRIVATE || Default, private
|-
| PUBLIC || Public (selected by the student but has not been selected as a sample review by the instructors.
|-
| PUBLISHED || Selected to show as example by the instructors.
|-
|}

'''1. Schema:''' Update the schema with the following column changes via migrations.

1) Add 'status' column to response_map

2) Add new Table 'similar_assignments'

'''2. Mapping of Reviews and Assignment:''' The example reviews can either be taken from an assignment of the current course or it could be from an assignment from a previous course. This would enable students working on OSS Project to see OSS Project reviews from a previous semester. One idea is that when clicking to “make this review an example”, it will link to a page where you can select an assignment to which you have access (the same as the list of “Assignment” in the tree_display), then the example review will be shown to all participants of that specific assignment. We also need to do the same thing for “remove this review from examples”
Since we already have a '''response_maps''' table, we can add a column to map it with a specific assignment. This may/may not need a change in key constraints for the table. We plan to resolve them accordingly.

'''3. MVC Setup:''' We would need to create new partials in various views, and possibly a helper for response_controller.rb. We could achieve that by creating a MVC setup for the entire flow.

=== Proposed code changes ===

1. Adding a column status in response_maps table. Changes will happen in '''db/schema.rb'''

2. Adding a checkbox to select whether reviews could be shown as an example in the response views - '''/app/views/response/response.html.erb'''

3. On selecting the checkbox, update the status field in response_maps table in response controller - '''/app/controllers/response_controller.rb'''

4. To allow instructor to select among the public reviews make changes in '''/app/views/popup/team_users_popup.html.haml'''

5. To enable students to see the example reviews, make changes in the views of student_review - '''/app/views/student_review/list.html.erb'''

== DB Design ==

=== Previous work ===
The previous approach for DB design added 2 new DB tables to store the status and association of sample reviews, namely, '''samplereviewmaps''' and '''similar_assignemnts'''. The samplereviewmaps table simple stored 2 fkey associations to review_map id and to the assignment_id.

=== Our approach ===
In our approach, we are extending the existing response_maps table to contain an additional field, 'status', that stores the status of the response(review), as suggested in the above approach. This approach would prune the need to add an extra DB table, which would store redundant information. Additionally, the similar_assignemnts table would store the association for a response to all the assignments, the instructor/TA decide to publish for.

[[File:db_design_e2022.png|none|User_MarkAsPublic_sequence]]

== Test Plan ==

Our test plan includes testing through rspec tests and through GUI.

=== Manual Testing ===

'''As a Power User (TA/Instructor/Admin/Super Admin)'''
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click View Report/Review for a particular assignment.
# Displays a list of reviews submitted by students.
# Click on any review in "team reviewed" column for a particular student.
# Displays the summary of reviews submitted by that student, with a "Make as sample" button on the right of every review.
# Click on "Make as sample" for the intended reviews, which opens a popup that displays a list of all assignments that are a part of the instructor's courses.
# From this list select all assignments for which the review has to be shown as a sample.
# Click on 'Submit' after selection (this closes the popup).
# Navigate to view reviews of that particular assignment and click on "Sample Reviews".
# A new page is opened that lists out all the sample reviews of the assignment.

'''As a Student (Scenario 1)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Show example reviews" link.
# This opens a page where the student can view all example reviews for that assignment.

'''As a Student (Scenario 2)'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Chose to review any of the teams' assignments that are displayed.
# Select a team for review and fill in the review.
# Before submitting the review, select the checkbox that says "I agree to share this review anonymously as an example to the entire class".
# After clicking on the submit button, the review submitted has been made public.

=== RSpec Testing ===

The following acceptance tests using the RSpec/Capybara tests to be written.
TODO: Add comments
describe "user_review" do
context "user marks the review as public" do
..
end

context "user marks the review as private" do
..
end

context "user views the sample review for assignment" do
..
end
end

describe "instructor" do
context "instructor marks the review as sample" do
..
end

context "instructor selects similar assignments" do
..
end
end

== Resources ==

Previous Team's Work: https://expertiza.csc.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example 

Repository link: https://github.com/SujalAhrodia/expertiza

== Team ==

Mentor: Dr. Ed Gehringer (efg@ncsu.edu)

Ayush Khot (akhot@ncsu.edu) 
Akanksha Bhattacharya (anbhatta@ncsu.edu) 
Jasmine Madonna Sabarimuthu (jsabari@ncsu.edu) 
Sujal (ssujal@ncsu.edu)

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-04-08T21:55:37Z

Ssujal: /* Resources */

== Introduction ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza] is an open source web application project based on Ruby on rails framework. Expertiza allows instructors to add assignments and students to upload their submissions. Students can form teams through expertiza for group projects. Students can also peer review the assignments after the submission deadline.

== Problem Statement ==

It is about adding a new feature in Expertiza which enable students to learn from seeing examples of good reviews, something like the one from Eli Review. However, the desired feature is expected to differ in the following ways:

1. Students should be able to see an entire review, both text and ratings, not just a single comment.

2. The student view should not show the name of the reviewer or the reviewee. The views of power users such as TA, instructor, admin should show these names. Note that this functionality is the same as in the current views that show reviews. So we can just use response/view

== Design ==

=== Approach ===

We append a column to the response representing their respective status. The following table explains the significance of each value:

{| class="wikitable"
! Status
! Explanation of the value
|-
| PRIVATE || Default, private
|-
| PUBLIC || Public (selected by the student but has not been selected as a sample review by the instructors.
|-
| PUBLISH || Selected as a sample by the instructors.
|-
|}

=== Features ===

In the order of flow,

'''1. Schema:''' Update the schema with the following column changes via migrations

'''2. Student's Consent:'''
In each review assignment, there will be a checkbox that says "I agree to share this review anonymously as an example to the entire class" then students can decide to check this box or not just before they submit reviews. Similarly, the student can revert it back to 'private' anytime. This could be implemented by the simple addition of a checkbox in '''response.html.erb''' and set a "status" field to “public”of the Response object via a controller method, preferably "create".

'''3. Instructor's Selection:''' The instructor can select from among the "public" reviews and decides which to make visible to other students doing a particular assignment, i.e. all participants in that assignment. And this will set the “status” field to “selected”.
Specifically, the instructor first goes to “View review report” and clicks on one team name (in the “Team reviewed” column). Then in the popup/team_users_popup page we need to add a button (better put it at top right) named “make this review an example”. If this review has already been shown as an example, the button should be “remove this review from examples” instead.

'''4. Mapping of Reviews and Assignment:'''' Note that although only participants in that assignment of the current course can see those reviews, the assignment that the reviews are taken from doesn't need to be an assignment for the current course. It could be an assignment from a previous course. This would enable students working on OSS Project to see OSS Project reviews from a previous semester. One idea is that when clicking to “make this review an example”, it will link to a page where you can select an assignment to which you have access (the same as the list of “Assignment” in the tree_display), then the example review will be shown to all participants of that specific assignment. We also need to do the same thing for “remove this review from examples”
Since we already have a '''response_maps''' table, we can add a column to map it with a specific assignment. This may/may not need a change in key constraints for the table. We plan to resolve them accordingly.

'''5. List of Sample Reviews: ''' A participant can see these "exemplary" reviews by going to "Others' work" for the assignment in question, and clicking on one or more links that say, e.g., "Sample review". And it should be shown just below the title “Review for ...”. It could be implemented on the '''student_reviews/list.html.erb'''.

'''6. MVC Setup:''' We would need to create new partials in various views, and possibly a helper for response_controller.rb. We could achieve that by creating a MVC setup for the entire flow.

=== UML Diagram ===
* Use Case -

[[Image:UseCase.png]]

'''Power Users:''' Instructors, TAs, Admins and Super Admins

=== Proposed code changes ===

1. Adding two columns 'status' and 'selected' in responses table. Changes will happen in db/schema.rb

2. Adding a checkbox to select whether reviews could be shown as an example in the response views. (/app/views/response/response.html.erb)

3. On selecting the checkbox, update the status field in responses table in response controller. (/app/controllers/response_controller.rb)

4. To allow instructor to select among the public reviews make changes in /app/views/popup/team_users_popup.html.haml

5. To enable students to see the example reviews, make changes in the views of student_review. (/app/views/student_review/list.html.erb)

== Test Plan ==

Our test plan includes testing through rspec tests and through GUI.

'''As a Power User (TA/Instructor/Admin/Super Admin)'''
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click View Report/Review for a particular assignment.
# Displays a list of reviews submitted by students.
# Click on any review in "team reviewed" column for a particular student.
# Displays the summary of reviews submitted by that student, with a "Make as sample" button on the right of every review.
# Click on "Make as sample" for the intended reviews, which opens a popup that displays a list of all assignments that are a part of the instructor's courses.
# From this list select all assignments for which the review has to be shown as a sample.
# Click on 'Submit' after selection (this closes the popup).
# Navigate to view reviews of that particular assignment and click on "Sample Reviews".
# A new page is opened that lists out all the sample reviews of the assignment.

'''As a Student'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Show sample reviews" link.
# This opens a page where the student can view all sample reviews for that assignment.

== Resources ==

Previous Team's Work: https://expertiza.csc.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example 

Repository link: https://github.com/SujalAhrodia/expertiza

== Team ==

Mentor: Dr. Ed Gehringer (efg@ncsu.edu)

Ayush Khot (akhot@ncsu.edu) 
Akanksha Bhattacharya (anbhatta@ncsu.edu) 
Jasmine Madonna Sabarimuthu (jsabari@ncsu.edu) 
Sujal (ssujal@ncsu.edu)

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-04-08T21:54:04Z

Ssujal: /* Approach */

== Introduction ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza] is an open source web application project based on Ruby on rails framework. Expertiza allows instructors to add assignments and students to upload their submissions. Students can form teams through expertiza for group projects. Students can also peer review the assignments after the submission deadline.

== Problem Statement ==

It is about adding a new feature in Expertiza which enable students to learn from seeing examples of good reviews, something like the one from Eli Review. However, the desired feature is expected to differ in the following ways:

1. Students should be able to see an entire review, both text and ratings, not just a single comment.

2. The student view should not show the name of the reviewer or the reviewee. The views of power users such as TA, instructor, admin should show these names. Note that this functionality is the same as in the current views that show reviews. So we can just use response/view

== Design ==

=== Approach ===

We append a column to the response representing their respective status. The following table explains the significance of each value:

{| class="wikitable"
! Status
! Explanation of the value
|-
| PRIVATE || Default, private
|-
| PUBLIC || Public (selected by the student but has not been selected as a sample review by the instructors.
|-
| PUBLISH || Selected as a sample by the instructors.
|-
|}

=== Features ===

In the order of flow,

'''1. Schema:''' Update the schema with the following column changes via migrations

'''2. Student's Consent:'''
In each review assignment, there will be a checkbox that says "I agree to share this review anonymously as an example to the entire class" then students can decide to check this box or not just before they submit reviews. Similarly, the student can revert it back to 'private' anytime. This could be implemented by the simple addition of a checkbox in '''response.html.erb''' and set a "status" field to “public”of the Response object via a controller method, preferably "create".

'''3. Instructor's Selection:''' The instructor can select from among the "public" reviews and decides which to make visible to other students doing a particular assignment, i.e. all participants in that assignment. And this will set the “status” field to “selected”.
Specifically, the instructor first goes to “View review report” and clicks on one team name (in the “Team reviewed” column). Then in the popup/team_users_popup page we need to add a button (better put it at top right) named “make this review an example”. If this review has already been shown as an example, the button should be “remove this review from examples” instead.

'''4. Mapping of Reviews and Assignment:'''' Note that although only participants in that assignment of the current course can see those reviews, the assignment that the reviews are taken from doesn't need to be an assignment for the current course. It could be an assignment from a previous course. This would enable students working on OSS Project to see OSS Project reviews from a previous semester. One idea is that when clicking to “make this review an example”, it will link to a page where you can select an assignment to which you have access (the same as the list of “Assignment” in the tree_display), then the example review will be shown to all participants of that specific assignment. We also need to do the same thing for “remove this review from examples”
Since we already have a '''response_maps''' table, we can add a column to map it with a specific assignment. This may/may not need a change in key constraints for the table. We plan to resolve them accordingly.

'''5. List of Sample Reviews: ''' A participant can see these "exemplary" reviews by going to "Others' work" for the assignment in question, and clicking on one or more links that say, e.g., "Sample review". And it should be shown just below the title “Review for ...”. It could be implemented on the '''student_reviews/list.html.erb'''.

'''6. MVC Setup:''' We would need to create new partials in various views, and possibly a helper for response_controller.rb. We could achieve that by creating a MVC setup for the entire flow.

=== UML Diagram ===
* Use Case -

[[Image:UseCase.png]]

'''Power Users:''' Instructors, TAs, Admins and Super Admins

=== Proposed code changes ===

1. Adding two columns 'status' and 'selected' in responses table. Changes will happen in db/schema.rb

2. Adding a checkbox to select whether reviews could be shown as an example in the response views. (/app/views/response/response.html.erb)

3. On selecting the checkbox, update the status field in responses table in response controller. (/app/controllers/response_controller.rb)

4. To allow instructor to select among the public reviews make changes in /app/views/popup/team_users_popup.html.haml

5. To enable students to see the example reviews, make changes in the views of student_review. (/app/views/student_review/list.html.erb)

== Test Plan ==

Our test plan includes testing through rspec tests and through GUI.

'''As a Power User (TA/Instructor/Admin/Super Admin)'''
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click View Report/Review for a particular assignment.
# Displays a list of reviews submitted by students.
# Click on any review in "team reviewed" column for a particular student.
# Displays the summary of reviews submitted by that student, with a "Make as sample" button on the right of every review.
# Click on "Make as sample" for the intended reviews, which opens a popup that displays a list of all assignments that are a part of the instructor's courses.
# From this list select all assignments for which the review has to be shown as a sample.
# Click on 'Submit' after selection (this closes the popup).
# Navigate to view reviews of that particular assignment and click on "Sample Reviews".
# A new page is opened that lists out all the sample reviews of the assignment.

'''As a Student'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Show sample reviews" link.
# This opens a page where the student can view all sample reviews for that assignment.

== Resources ==
Repository link: https://github.com/SujalAhrodia/expertiza

== Team ==

Mentor: Dr. Ed Gehringer (efg@ncsu.edu)

Ayush Khot (akhot@ncsu.edu) 
Akanksha Bhattacharya (anbhatta@ncsu.edu) 
Jasmine Madonna Sabarimuthu (jsabari@ncsu.edu) 
Sujal (ssujal@ncsu.edu)

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-04-08T21:53:38Z

Ssujal: /* Design */

== Introduction ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza] is an open source web application project based on Ruby on rails framework. Expertiza allows instructors to add assignments and students to upload their submissions. Students can form teams through expertiza for group projects. Students can also peer review the assignments after the submission deadline.

== Problem Statement ==

It is about adding a new feature in Expertiza which enable students to learn from seeing examples of good reviews, something like the one from Eli Review. However, the desired feature is expected to differ in the following ways:

1. Students should be able to see an entire review, both text and ratings, not just a single comment.

2. The student view should not show the name of the reviewer or the reviewee. The views of power users such as TA, instructor, admin should show these names. Note that this functionality is the same as in the current views that show reviews. So we can just use response/view

== Design ==

=== Approach ===

1. We append a column to the response representing their respective status. The following table explains the significance of each value:

{| class="wikitable"
! Status
! Explanation of the value
|-
| PRIVATE || Default, private
|-
| PUBLIC || Public (selected by the student but has not been selected as a sample review by the instructors.
|-
| PUBLISH || Selected as a sample by the instructors.
|-
|}

=== Features ===

In the order of flow,

'''1. Schema:''' Update the schema with the following column changes via migrations

'''2. Student's Consent:'''
In each review assignment, there will be a checkbox that says "I agree to share this review anonymously as an example to the entire class" then students can decide to check this box or not just before they submit reviews. Similarly, the student can revert it back to 'private' anytime. This could be implemented by the simple addition of a checkbox in '''response.html.erb''' and set a "status" field to “public”of the Response object via a controller method, preferably "create".

'''3. Instructor's Selection:''' The instructor can select from among the "public" reviews and decides which to make visible to other students doing a particular assignment, i.e. all participants in that assignment. And this will set the “status” field to “selected”.
Specifically, the instructor first goes to “View review report” and clicks on one team name (in the “Team reviewed” column). Then in the popup/team_users_popup page we need to add a button (better put it at top right) named “make this review an example”. If this review has already been shown as an example, the button should be “remove this review from examples” instead.

'''4. Mapping of Reviews and Assignment:'''' Note that although only participants in that assignment of the current course can see those reviews, the assignment that the reviews are taken from doesn't need to be an assignment for the current course. It could be an assignment from a previous course. This would enable students working on OSS Project to see OSS Project reviews from a previous semester. One idea is that when clicking to “make this review an example”, it will link to a page where you can select an assignment to which you have access (the same as the list of “Assignment” in the tree_display), then the example review will be shown to all participants of that specific assignment. We also need to do the same thing for “remove this review from examples”
Since we already have a '''response_maps''' table, we can add a column to map it with a specific assignment. This may/may not need a change in key constraints for the table. We plan to resolve them accordingly.

'''5. List of Sample Reviews: ''' A participant can see these "exemplary" reviews by going to "Others' work" for the assignment in question, and clicking on one or more links that say, e.g., "Sample review". And it should be shown just below the title “Review for ...”. It could be implemented on the '''student_reviews/list.html.erb'''.

'''6. MVC Setup:''' We would need to create new partials in various views, and possibly a helper for response_controller.rb. We could achieve that by creating a MVC setup for the entire flow.

=== UML Diagram ===
* Use Case -

[[Image:UseCase.png]]

'''Power Users:''' Instructors, TAs, Admins and Super Admins

=== Proposed code changes ===

1. Adding two columns 'status' and 'selected' in responses table. Changes will happen in db/schema.rb

2. Adding a checkbox to select whether reviews could be shown as an example in the response views. (/app/views/response/response.html.erb)

3. On selecting the checkbox, update the status field in responses table in response controller. (/app/controllers/response_controller.rb)

4. To allow instructor to select among the public reviews make changes in /app/views/popup/team_users_popup.html.haml

5. To enable students to see the example reviews, make changes in the views of student_review. (/app/views/student_review/list.html.erb)

== Test Plan ==

Our test plan includes testing through rspec tests and through GUI.

'''As a Power User (TA/Instructor/Admin/Super Admin)'''
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click View Report/Review for a particular assignment.
# Displays a list of reviews submitted by students.
# Click on any review in "team reviewed" column for a particular student.
# Displays the summary of reviews submitted by that student, with a "Make as sample" button on the right of every review.
# Click on "Make as sample" for the intended reviews, which opens a popup that displays a list of all assignments that are a part of the instructor's courses.
# From this list select all assignments for which the review has to be shown as a sample.
# Click on 'Submit' after selection (this closes the popup).
# Navigate to view reviews of that particular assignment and click on "Sample Reviews".
# A new page is opened that lists out all the sample reviews of the assignment.

'''As a Student'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Show sample reviews" link.
# This opens a page where the student can view all sample reviews for that assignment.

== Resources ==
Repository link: https://github.com/SujalAhrodia/expertiza

== Team ==

Mentor: Dr. Ed Gehringer (efg@ncsu.edu)

Ayush Khot (akhot@ncsu.edu) 
Akanksha Bhattacharya (anbhatta@ncsu.edu) 
Jasmine Madonna Sabarimuthu (jsabari@ncsu.edu) 
Sujal (ssujal@ncsu.edu)

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-04-08T16:45:55Z

Ssujal:

== Introduction ==

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza] is an open source web application project based on Ruby on rails framework. Expertiza allows instructors to add assignments and students to upload their submissions. Students can form teams through expertiza for group projects. Students can also peer review the assignments after the submission deadline.

== Problem Statement ==

It is about adding a new feature in Expertiza which enable students to learn from seeing examples of good reviews, something like the one from Eli Review. However, the desired feature is expected to differ in the following ways:

1. Students should be able to see an entire review, both text and ratings, not just a single comment.

2. The student view should not show the name of the reviewer or the reviewee. The views of power users such as TA, instructor, admin should show these names. Note that this functionality is the same as in the current views that show reviews. So we can just use response/view

== Design ==

=== Approach ===

1. We append a column to the response representing their respective status. The following table explains the significance of each value:

{| class="wikitable"
! Status
! Explanation of the value
|-
| 0 || Default, private
|-
| 1 || Public (selected by the student but has not been selected as a sample review by the instructors.
|-
| 2 || Selected as a sample by the instructors.
|-
|}

=== Features ===

'''1. Student's Consent:'''
In each review assignment, there will be a checkbox that says "I agree to share this review anonymously as an example to the entire class" then students can decide to check this box or not just before they submit reviews. Similarly, the student can revert it back to 'private' anytime. This could be implemented by the simple addition of a checkbox in '''response.html.erb''' and set a "status" field to “public”of the Response object via a controller method, preferably "create".

'''2. Schema:''' Update the schema with the above column changes via migrations

'''3. Instructor's Selection:''' The instructor can select from among the "public" reviews and decides which to make visible to other students doing a particular assignment, i.e. all participants in that assignment. And this will set the “status” field to “selected”.
Specifically, the instructor first goes to “View review report” and clicks on one team name (in the “Team reviewed” column). Then in the popup/team_users_popup page we need to add a button (better put it at top right) named “make this review an example”. If this review has already been shown as an example, the button should be “remove this review from examples” instead.

'''4. List of Sample Reviews: ''' A participant can see these "exemplary" reviews by going to "Others' work" for the assignment in question, and clicking on one or more links that say, e.g., "Sample review". And it should be shown just below the title “Review for ...”. It could be implemented on the '''student_reviews/list.html.erb'''.

'''5. Mapping of Reviews and Assignment:'''' Note that although only participants in that assignment of the current course can see those reviews, the assignment that the reviews are taken from doesn't need to be an assignment for the current course. It could be an assignment from a previous course. This would enable students working on OSS Project to see OSS Project reviews from a previous semester. One idea is that when clicking to “make this review an example”, it will link to a page where you can select an assignment to which you have access (the same as the list of “Assignment” in the tree_display), then the example review will be shown to all participants of that specific assignment. We also need to do the same thing for “remove this review from examples”
Since we already have a '''response_maps''' table, we can add a column to map it with a specific assignment. This may/may not need a change in key constraints for the table. We plan to resolve them accordingly.

'''6. MVC Setup:''' We would need to create new partials in various views, and possibly a helper for response_controller.rb. We could achieve that by creating a MVC setup for the entire flow.

=== UML Diagram ===
* Use Case -

[[Image:UseCase.png]]

'''Power Users:''' Instructors, TAs, Admins and Super Admins

=== Proposed code changes ===

1. Adding two columns 'status' and 'selected' in responses table. Changes will happen in db/schema.rb

2. Adding a checkbox to select whether reviews could be shown as an example in the response views. (/app/views/response/response.html.erb)

3. On selecting the checkbox, update the status field in responses table in response controller. (/app/controllers/response_controller.rb)

4. To allow instructor to select among the public reviews make changes in /app/views/popup/team_users_popup.html.haml

5. To enable students to see the example reviews, make changes in the views of student_review. (/app/views/student_review/list.html.erb)

== Test Plan ==

Our test plan includes testing through rspec tests and through GUI.

== Resources ==
Repository link: https://github.com/SujalAhrodia/expertiza

== Team ==

Mentor: Dr. Ed Gehringer (efg@ncsu.edu)

Ayush Khot (akhot@ncsu.edu) 
Akanksha Bhattacharya (anbhatta@ncsu.edu) 
Jasmine Madonna Sabarimuthu (jsabari@ncsu.edu) 
Sujal (ssujal@ncsu.edu)

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-04-07T22:47:35Z

Ssujal:

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-04-07T21:58:29Z

Ssujal:

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-04-07T21:38:24Z

Ssujal:

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-04-07T01:58:33Z

Ssujal:

== Introduction ==

== Problem Statement ==

It is about adding a new feature in Expertiza which enable students to learn from seeing examples of good reviews, something like the one from Eli Review. However, the desired feature is expected to differ in the following ways:

1. Students should be able to see an entire review, both text and ratings, not just a single comment.

2. The student view should not show the name of the reviewer or the reviewee. The views of power users such as TA, instructor, admin should show these names. Note that this functionality is the same as in the current views that show reviews. So we can just use response/view

=== Features ===

1. In each review assignment, there will be a checkbox that says "I agree to share this review anonymously as an example to the entire class" then students can decide to check this box or not just before they submit reviews. Behind the scenes, we need to set a "status" field to “public”of the Response object.

2. The instructor can select from among the "public" reviews and decides which to make visible to other students doing a particular assignment, i.e. all participants in that assignment. And this will set the “status” field to “selected”. Specifically, the instructor first goes to “View review report” and clicks on one team name (in the “Team reviewed” column). Then in the popup/team_users_popup page we need to add a button (better put it at top right) named “make this review an example”. If this review has already been shown as an example, the button should be “remove this review from examples” instead.

3. A participant can see these "exemplary" reviews by going to "Others' work" for the assignment in question, and clicking on one or more links that say, e.g., "Sample review". And it should be shown just below the title “Review for ...”

4. Note that although only participants in that assignment of the current course can see those reviews, the assignment that the reviews are taken from doesn't need to be an assignment for the current course. It could be an assignment from a previous course. This would enable students working on OSS Project to see OSS Project reviews from a previous semester. One idea is that when clicking to “make this review an example”, it will link to a page where you can select an assignment to which you have access (the same as the list of “Assignment” in the tree_display), then the example review will be shown to all participants of that specific assignment. We also need to do the same thing for “remove this review from examples”

5. A student can also make a public review "private" and at that point, it stops being visible to other students.

6. You need to create new partials in various views, and possibly a helper for response_controller.rb.

== Design ==

== Test Plan ==

== Resources ==

== Team ==

Mentor: Dr. Ed Gehringer (efg@ncsu.edu)

Ayush Khot (akhot@ncsu.edu) 
Akanksha Bhattacharya (anbhatta@ncsu.edu) 
Jasmine Madonna Sabarimuthu (jsabari@ncsu.edu) 
Sujal (ssujal@ncsu.edu)

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-04-07T01:54:11Z

Ssujal: /* Problem Statement */

CSC/ECE 517 Spring 2020/E2022 Allow reviewer to say review can be shown to class as an example

2020-04-07T01:51:11Z

Ssujal: /* Problem Statement */

CSC/ECE 517 Spring 2020 - E2014. Refactor datetimepicker.js

2020-03-30T22:39:30Z

Ssujal:

__TOC__

== '''Abstract''' ==
Expertiza uses the jquery’s date-time picker widget for setting dates and times on various views. This is absolutely required so that all users select the date and/or time in a specified and fixed format. Instructors need to use it often while setting or modifying deadlines for various assignments in a course. Over the years, different developers used different version and formats of the date-time picker due to which there are inconsistencies across the expertiza project.

== '''Problem Statement''' ==
The main problem with the date-time picker is that the widget and the date-time formats used across the expertiza project are not consistent. Moreover, the JQuery based date-time UI widget itself is on version 0.8 which is extremely old and no longer consistent with expertiza's looks and feel. The primary task of the refactor was to find, refactor and make the date-time picker consistent at all places while exploring the possibility of updating the date-time picker to a newer version or completely replacing it by another better widget which works in conjunction with modern javascript libraries.

== '''Problem Solution''' ==
The first step in the approach was to explore the current functionality of existing date time picker. We explored the code base to understand the how 'datetimepicker.js' library was used and its respective compatibility. Simultaneously, we also studied other libraries and gems which could provide a consistent and easy alternative.
Since the existing library was no longer being maintained (inactive since mid 2015) ([https://github.com/Envek/jquery-datetimepicker-rails]), and the new gem 'bootstrap-datetimepicker' provided a relatively recent and easier implementation. So we decided to pick the latter one and replace the older one.

== '''Process''' ==
According to our solution, the existing library needed to be replaced by the new gem. The initial exploration phase helped us to extract the files where datetimepicker has been used in the codebase. The gem was included in the GemFile to make it available throughout the project. Further, necessary syntactical changes were made respective to the new gem. Another key point was to realise the use of a specific format at a specific place. For instance, a shorter format was used in pages to make efficient use of space. The following section includes specific files and the changes made in each of them.

== '''Refactors''' ==
This section discusses the changes implemented as a part of this refactor

==== Installing the required gems ====
Following gems and its dependencies have been added to the GemFile for bundled installation:
*[https://rubygems.org/gems/bootstrap3-datetimepicker-rails/versions/4.17.47 Bootstrap3-datetimepicker]
This gem packages the [https://github.com/Eonasdan/bootstrap-datetimepicker bootstrap-datetime-picker] for the Rails 3.1+ asset pipeline. It is based on bootstrap3 and requires momentjs as a dependency.

*[https://rubygems.org/gems/momentjs-rails/versions/2.9.0 MomentJS-Rails]
Moment.js is a lightweight javascript date library for parsing, manipulating, and formatting dates. This gems adds the required javascript files to the project which are used by the new Bootstrap3-datetimepicker gem.
 
Next, the CSS and javascript file provided by the gems need to be included the asset pipeline by including the following in ''application.js'' and ''application.scss'' file. The screenshots below depict the additions to the respective files:
 
[[File: Expertiza1.PNG]]
 
[[File: Expertiza2.PNG]]

==== Refactoring Date-Time Picker widget ====
The existing date-time picker widget was replaced by the new date-time picker in the following views:
 
'''1. Edit and create assignments - ''app/views/assignments/edit/_due_dates.html.erb''''' 
This contains fields to set the submission and review deadlines for different rounds. The existing JQuery call to the date time picker was replaced by the call to the new widget. Following changes were made to the file:
 
'''Before:'''
<pre>
jQuery('#datetimepicker_' + element_id).datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm:ss z',
controlType: 'select',
timezoneList: [
{ value: -000, label: 'GMT'},
{ value: -300, label: 'Eastern'},
{ value: -360, label: 'Central' },
{ value: -420, label: 'Mountain' },
{ value: -480, label: 'Pacific' }
]
});
</pre>

'''After:'''
<pre>
jQuery('#datetimepicker_' + element_id).datetimepicker({
format: 'YYYY/MM/DD hh:mm z',
sideBySide: true
});
</pre>

'''2. Topic sign up sheet - ''app/views/sign_up_sheet/_due_dates.html.erb''''' 
This page is used by the instructor to set up the topic sign up page for projects. The form includes a selection of start date and end date for signup. Following changes were made to the file:
 
'''Before:'''
<pre>
$('.datetimepicker').datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm:ss'
});
</pre>

'''After:'''
<pre>
$('.datetimepicker').datetimepicker({
format: 'YYYY/MM/DD HH:mm',
sideBySide: true
});
</pre>
 
'''3. New survey creation - ''app/views/survey_deployment/new.html.erb''''' 
The page contains the form to allow the creation of new surveys. The survey start and end dates can be set using the form. The old code used two separate inline ''onClick'' event to call the same DateTime picker. Both the calls were replaced by a single jquery call.

'''Before:'''
<pre>
<tr>
<td><label for="start_date">Start Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_start_date" name ="survey_deployment[start_date]" class="form-control width-250" onClick="$('#survey_deployment_start_date').datetimepicker()"/>
</td>
</tr>

<tr>
<td><label for="end_date">End Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_end_date" name ="survey_deployment[end_date]" class="form-control width-250"
onClick="$('#survey_deployment_end_date').datetimepicker()"/>
</td>
</tr>
</table>
</pre>

'''After:'''
<pre>
<tr>
<td><label for="start_date">Start Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_start_date" name ="survey_deployment[start_date]" class="form-control width-250" />
</td>
</tr>

<tr>
<td><label for="end_date">End Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_end_date" name ="survey_deployment[end_date]" class="form-control width-250" />
</td>
</tr>
</table>
<script type="text/javascript">
jQuery('#survey_deployment_start_date, #survey_deployment_end_date').datetimepicker({
format: 'YYYY/MM/DD HH:mm',
sideBySide: true
});
</script>
</pre>
 
'''4. Version logs - ''app/views/sign_up_sheet/_due_dates.html.erb''''' 
The version logs file which is only accessible to the admins uses the date tie picker to filter the search results using the start and the end date. Following changes were made to the file: 

'''Before:'''
<pre>
jQuery('.datetimeklass').datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm:ss z',
controlType: 'select',
timezoneList: [
{ value: -000, label: 'GMT'},
{ value: -300, label: 'Eastern'},
{ value: -360, label: 'Central' },
{ value: -420, label: 'Mountain' },
{ value: -480, label: 'Pacific' }
]
});
</pre>

'''After:'''
<pre>
jQuery('.datetimeklass').datetimepicker({
format: 'YYYY/MM/DD HH:mm z',
sideBySide: true
});
</pre>

=== Output ===
The old jquery based date-time picker was replaced by a new modern bootstrap based date-time picker as shown in the pictures below. The new bootstrap date-time picker widget also has different styles which can be implemented by changing the code as per the documentation [http://eonasdan.github.io/bootstrap-datetimepicker/ here].
 
'''Old Date-Time Picker''' 
[[File: Expertiza3.PNG]]
 
'''New Date-Time Picker''' 
[[File: Expertiza4.PNG]]

== '''Testing''' ==
=== Test Plan ===
This refactor was mainly concerned with the date-time picker widget UI. Thus most of the testing was done manually as automated testing cannot be used to test the widget. After refactoring each of the pages using the date-time widget, rigorous testing was done to check if the date-time picker selected the right date in appropriate formats. Automated testing was performed to test the models and controllers which relied on the date-time picker for its correct functioning. Code climate was used to maintain the code quality and Travis CI build checks were properly monitored for each commit.

=== Manual Testing ===
The new date-time picker widget was manually tested for correctness using the following manual steps: 
1. Create and edit assignments 
Login into instructor account -> Select Manage Assignments -> Click on the plus sign to the right -> Fill in the relevant details -> In the 'due dates' enter the submission and review deadline using the new date time picker widget -> Save -> Check if assignment with proper deadline is being created.
 
2. New survey creation 
Login into instructor account -> Select Manage assignments -> From the list of assignments select an assignment and select the 'assign survey' action-> Fill in the relevant details -> Enter the survey start and end date using the new date time picker widget -> Save -> Check if the survey is created with proper deadline.
 
3. Version logs 
Login to the Admin/Super admin account -> Open the version logs page -> Select the proper date range to filter the results -> Click 'search' -> Check if results are getting filtered according to the dates selected.

=== RSpec Testing ===
To the test the datetimepicker.js functionality, Rspec testing on an untested controller using this gem was performed.
In versions controller, search functionality uses the new datetimepicker.js gem. This controller is being given access to only admins and super-admins.

The tests check if the datetimepicker.js is correctly used and on the button click the relevant data is returned from database. Also the datetimepicker feature with start date and end date detection should work for both admins and super-admins.
 
[[File: Expertiza8.PNG]]
 

=== Travis CI Build Testing ===
Travis-CI Build Test of the beta branch after a refactored function is merged in the beta branch.
[[File: Expertiza9.PNG]]
 

== '''Files changed''' ==

1. GemFile. (https://github.com/expertiza/expertiza/pull/1694/files#diff-8b7db4d5cc4b8f6dc8feb7030baa2478) 
2. GemFile.lock (https://github.com/expertiza/expertiza/pull/1694/files#diff-e79a60dc6b85309ae70a6ea8261eaf95) 
3. application.js (https://github.com/expertiza/expertiza/pull/1694/files#diff-a9c3bd311eab80c9ebe6a69830f9ad02) 
4. application.scss (https://github.com/expertiza/expertiza/pull/1694/files#diff-f859e2848b07324f808ce1a5ccd9fcba) 
5. assignments/edit/_due_dates.html.erb (https://github.com/expertiza/expertiza/pull/1694/files#diff-540fd2bd6c34b48213716b1dd713733a) 
6. sign_up_sheet/_due_dates.html.erb (https://github.com/expertiza/expertiza/pull/1694/files#diff-7a2dff6c7ee5e0f3f4af03fc13a51a7a) 
7. survey_deployments (https://github.com/expertiza/expertiza/pull/1694/files#diff-d44102ee049545f5ad9a297b7a922e34) 
8. _row_header.html.erb (https://github.com/expertiza/expertiza/pull/1694/files#diff-0defadd3dbc65f90ba975eb0ec963ca0) 
9. search.html.erb (https://github.com/expertiza/expertiza/pull/1694/files#diff-325adffe6f7b1a0ac7400e12a5d99f3d) 
10. factories.rb (https://github.com/expertiza/expertiza/pull/1694/files#diff-3a17ddf9d828caa60f11423f20fb88a9) 
11. versions_search_spec.rb (https://github.com/expertiza/expertiza/pull/1694/files#diff-72f04cc00e26505c570aaecbbe103314) 
12. list.html.erb (https://github.com/expertiza/expertiza/pull/1694/files#diff-0256edc752068f64fd59dc0c260659db) 

== '''Useful Links''' ==

'''Github Repo:''' https://github.com/SujalAhrodia/expertiza/tree/beta
 
'''Pull Request:''' https://github.com/expertiza/expertiza/pull/1694

== '''Team Information''' ==

'''Project Mentor:'''
 Pratik Abhyankar

'''Project Members:''' 
Akanksha Bhattacharyya 
Sahil Papalkar 
Sujal

CSC/ECE 517 Spring 2020 - E2014. Refactor datetimepicker.js

2020-03-30T16:39:27Z

Ssujal:

__TOC__

== '''Abstract''' ==
Expertiza uses the jquery’s date-time picker widget for setting dates and times on various views. This is absolutely required so that all users select the date and/or time in a specified and fixed format. Instructors need to use it often while setting or modifying deadlines for various assignments in a course. Over the years, different developers used different version and formats of the date-time picker due to which there are inconsistencies across the expertiza project.

== '''Problem Statement''' ==
The main problem with the date-time picker is that the widget and the date-time formats used across the expertiza project are not consistent. Moreover, the JQuery based date-time UI widget itself is on version 0.8 which is extremely old and no longer consistent with expertiza's looks and feel. The primary task of the refactor was to find, refactor and make the date-time picker consistent at all places while exploring the possibility of updating the date-time picker to a newer version or completely replacing it by another better widget which works in conjunction with modern javascript libraries.

== '''Problem Solution''' ==
The first step in the approach was to explore the current functionality of existing date time picker. We explored the code base to understand the how 'datetimepicker.js' library was used and its respective compatibility. Simultaneously, we also studied other libraries and gems which could provide a consistent and easy alternative.
Since the existing library was no longer being maintained (inactive since mid 2015) ([https://github.com/Envek/jquery-datetimepicker-rails]), and the new gem 'bootstrap-datetimepicker' provided a relatively recent and easier implementation. So we decided to pick the latter one and replace the older one.

== '''Process''' ==
According to our solution, the existing library needed to be replaced by the new gem. The initial exploration phase helped us to extract the files where datetimepicker has been used in the codebase. The gem was included in the GemFile to make it available throughout the project. Further, necessary syntactical changes were made respective to the new gem. Another key point was to realise the use of a specific format at a specific place. For instance, a shorter format was used in pages to make efficient use of space. The following section includes specific files and the changes made in each of them.

== '''Refactors''' ==
This section discusses the changes implemented as a part of this refactor

==== Installing the required gems ====
Following gems and its dependencies have been added to the GemFile for bundled installation:
*[https://rubygems.org/gems/bootstrap3-datetimepicker-rails/versions/4.17.47 Bootstrap3-datetimepicker]
This gem packages the [https://github.com/Eonasdan/bootstrap-datetimepicker bootstrap-datetime-picker] for the Rails 3.1+ asset pipeline. It is based on bootstrap3 and requires momentjs as a dependency.

*[https://rubygems.org/gems/momentjs-rails/versions/2.9.0 MomentJS-Rails]
Moment.js is a lightweight javascript date library for parsing, manipulating, and formatting dates. This gems adds the required javascript files to the project which are used by the new Bootstrap3-datetimepicker gem.
 
Next, the CSS and javascript file provided by the gems need to be included the asset pipeline by including the following in ''application.js'' and ''application.scss'' file. The screenshots below depict the additions to the respective files:
 
[[File: Expertiza1.PNG]]
 
[[File: Expertiza2.PNG]]

==== Refactoring Date-Time Picker widget ====
The existing date-time picker widget was replaced by the new date-time picker in the following views:
 
'''1. Edit and create assignments - ''app/views/assignments/edit/_due_dates.html.erb''''' 
This contains fields to set the submission and review deadlines for different rounds. The existing JQuery call to the date time picker was replaced by the call to the new widget. Following changes were made to the file:
 
'''Before:'''
<pre>
jQuery('#datetimepicker_' + element_id).datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm:ss z',
controlType: 'select',
timezoneList: [
{ value: -000, label: 'GMT'},
{ value: -300, label: 'Eastern'},
{ value: -360, label: 'Central' },
{ value: -420, label: 'Mountain' },
{ value: -480, label: 'Pacific' }
]
});
</pre>

'''After:'''
<pre>
jQuery('#datetimepicker_' + element_id).datetimepicker({
format: 'YYYY/MM/DD hh:mm z',
sideBySide: true
});
</pre>

'''2. Topic sign up sheet - ''app/views/sign_up_sheet/_due_dates.html.erb''''' 
This page is used by the instructor to set up the topic sign up page for projects. The form includes a selection of start date and end date for signup. Following changes were made to the file:
 
'''Before:'''
<pre>
$('.datetimepicker').datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm:ss'
});
</pre>

'''After:'''
<pre>
$('.datetimepicker').datetimepicker({
format: 'YYYY/MM/DD HH:mm',
sideBySide: true
});
</pre>
 
'''3. New survey creation - ''app/views/survey_deployment/new.html.erb''''' 
The page contains the form to allow the creation of new surveys. The survey start and end dates can be set using the form. The old code used two separate inline ''onClick'' event to call the same DateTime picker. Both the calls were replaced by a single jquery call.

'''Before:'''
<pre>
<tr>
<td><label for="start_date">Start Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_start_date" name ="survey_deployment[start_date]" class="form-control width-250" onClick="$('#survey_deployment_start_date').datetimepicker()"/>
</td>
</tr>

<tr>
<td><label for="end_date">End Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_end_date" name ="survey_deployment[end_date]" class="form-control width-250"
onClick="$('#survey_deployment_end_date').datetimepicker()"/>
</td>
</tr>
</table>
</pre>

'''After:'''
<pre>
<tr>
<td><label for="start_date">Start Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_start_date" name ="survey_deployment[start_date]" class="form-control width-250" />
</td>
</tr>

<tr>
<td><label for="end_date">End Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_end_date" name ="survey_deployment[end_date]" class="form-control width-250" />
</td>
</tr>
</table>
<script type="text/javascript">
jQuery('#survey_deployment_start_date, #survey_deployment_end_date').datetimepicker({
format: 'YYYY/MM/DD HH:mm',
sideBySide: true
});
</script>
</pre>
 
'''4. Version logs - ''app/views/sign_up_sheet/_due_dates.html.erb''''' 
The version logs file which is only accessible to the admins uses the date tie picker to filter the search results using the start and the end date. Following changes were made to the file: 

'''Before:'''
<pre>
jQuery('.datetimeklass').datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm:ss z',
controlType: 'select',
timezoneList: [
{ value: -000, label: 'GMT'},
{ value: -300, label: 'Eastern'},
{ value: -360, label: 'Central' },
{ value: -420, label: 'Mountain' },
{ value: -480, label: 'Pacific' }
]
});
</pre>

'''After:'''
<pre>
jQuery('.datetimeklass').datetimepicker({
format: 'YYYY/MM/DD HH:mm z',
sideBySide: true
});
</pre>

=== Output ===
The old jquery based date-time picker was replaced by a new modern bootstrap based date-time picker as shown in the pictures below. The new bootstrap date-time picker widget also has different styles which can be implemented by changing the code as per the documentation [http://eonasdan.github.io/bootstrap-datetimepicker/ here].
 
'''Old Date-Time Picker''' 
[[File: Expertiza3.PNG]]
 
'''New Date-Time Picker''' 
[[File: Expertiza4.PNG]]

== '''Testing''' ==
=== Test Plan ===
This refactor was mainly concerned with the date-time picker widget UI. Thus most of the testing was done manually as automated testing cannot be used to test the widget. After refactoring each of the pages using the date-time widget, rigorous testing was done to check if the date-time picker selected the right date in appropriate formats. Automated testing was performed to test the models and controllers which relied on the date-time picker for its correct functioning. Code climate was used to maintain the code quality and Travis CI build checks were properly monitored for each commit.

=== Manual Testing ===
The new date-time picker widget was manually tested for correctness using the following manual steps: 
1. Create and edit assignments 
Login into instructor account -> Select Manage Assignments -> Click on the plus sign to the right -> Fill in the relevant details -> In the 'due dates' enter the submission and review deadline using the new date time picker widget -> Save -> Check if assignment with proper deadline is being created.
 
2. New survey creation 
Login into instructor account -> Select Manage assignments -> From the list of assignments select an assignment and select the 'assign survey' action-> Fill in the relevant details -> Enter the survey start and end date using the new date time picker widget -> Save -> Check if the survey is created with proper deadline.
 
3. Version logs 
Login to the Admin/Super admin account -> Open the version logs page -> Select the proper date range to filter the results -> Click 'search' -> Check if results are getting filtered according to the dates selected.

=== RSpec Testing ===
To the test the datetimepicker.js functionality, Rspec testing on an untested controller using this gem was performed.
In versions controller, search functionality uses the new datetimepicker.js gem. This controller is being given access to only admins and super-admins.

The tests check if the datetimepicker.js is correctly used and on the button click the relevant data is returned from database. Also the datetimepicker feature with start date and end date detection should work for both admins and super-admins.
 
[[File: Expertiza8.PNG]]
 

=== Travis CI Build Testing ===
Travis-CI Build Test of the beta branch after a refactored function is merged in the beta branch.
[[File: Expertiza9.PNG]]
 

=== Files changed ===

1. GemFile. (https://github.com/expertiza/expertiza/pull/1694/files#diff-8b7db4d5cc4b8f6dc8feb7030baa2478) 
2. GemFile.lock (https://github.com/expertiza/expertiza/pull/1694/files#diff-e79a60dc6b85309ae70a6ea8261eaf95) 
3. application.js (https://github.com/expertiza/expertiza/pull/1694/files#diff-a9c3bd311eab80c9ebe6a69830f9ad02) 
4. application.scss (https://github.com/expertiza/expertiza/pull/1694/files#diff-f859e2848b07324f808ce1a5ccd9fcba) 
5. assignments/edit/_due_dates.html.erb (https://github.com/expertiza/expertiza/pull/1694/files#diff-540fd2bd6c34b48213716b1dd713733a) 
6. sign_up_sheet/_due_dates.html.erb (https://github.com/expertiza/expertiza/pull/1694/files#diff-7a2dff6c7ee5e0f3f4af03fc13a51a7a) 
7. survey_deployments (https://github.com/expertiza/expertiza/pull/1694/files#diff-d44102ee049545f5ad9a297b7a922e34) 
8. _row_header.html.erb (https://github.com/expertiza/expertiza/pull/1694/files#diff-0defadd3dbc65f90ba975eb0ec963ca0) 
9. search.html.erb (https://github.com/expertiza/expertiza/pull/1694/files#diff-325adffe6f7b1a0ac7400e12a5d99f3d) 
10. factories.rb (https://github.com/expertiza/expertiza/pull/1694/files#diff-3a17ddf9d828caa60f11423f20fb88a9) 
11. versions_search_spec.rb (https://github.com/expertiza/expertiza/pull/1694/files#diff-72f04cc00e26505c570aaecbbe103314) 
12. list.html.erb (https://github.com/expertiza/expertiza/pull/1694/files#diff-0256edc752068f64fd59dc0c260659db) 

== '''Useful Links''' ==

'''Github Repo:''' https://github.com/SujalAhrodia/expertiza/tree/beta
 
'''Pull Request:''' https://github.com/expertiza/expertiza/pull/1694

== '''Team Information''' ==

'''Project Mentor:'''
 Pratik Abhyankar

'''Project Members:''' 
Akanksha Bhattacharyya 
Sahil Papalkar 
Sujal

CSC/ECE 517 Spring 2020 - E2014. Refactor datetimepicker.js

2020-03-30T16:14:07Z

Ssujal:

__TOC__

== '''Abstract''' ==
Expertiza uses the jquery’s date-time picker widget for setting dates and times on various views. This is absolutely required so that all users select the date and/or time in a specified and fixed format. Instructors need to use it often while setting or modifying deadlines for various assignments in a course. Over the years, different developers used different version and formats of the date-time picker due to which there are inconsistencies across the expertiza project.

== '''Problem Statement''' ==
The main problem with the date-time picker is that the widget and the date-time formats used across the expertiza project are not consistent. Moreover, the JQuery based date-time UI widget itself is on version 0.8 which is extremely old and no longer consistent with expertiza's looks and feel. The primary task of the refactor was to find, refactor and make the date-time picker consistent at all places while exploring the possibility of updating the date-time picker to a newer version or completely replacing it by another better widget which works in conjunction with modern javascript libraries.

== '''Problem Solution''' ==
The first step in the approach was to explore the current functionality of existing date time picker. We explored the code base to understand the how 'datetimepicker.js' library was used and its respective compatibility. Simultaneously, we also studied other libraries and gems which could provide a consistent and easy alternative.
Since the existing library was no longer being maintained (inactive since mid 2015) ([https://github.com/Envek/jquery-datetimepicker-rails]), and the new gem 'bootstrap-datetimepicker' provided a relatively recent and easier implementation. So we decided to pick the latter one and replace the older one.

== '''Process''' ==
According to our solution, the existing library needed to be replaced by the new gem. The initial exploration phase helped us to extract the files where datetimepicker has been used in the codebase. The gem was included in the GemFile to make it available throughout the project. Further, necessary syntactical changes were made respective to the new gem. Another key point was to realise the use of a specific format at a specific place. For instance, a shorter format was used in pages to make efficient use of space. The following section includes specific files and the changes made in each of them.

== '''Refactors''' ==
This section discusses the changes implemented as a part of this refactor

==== Installing the required gems ====
Following gems and its dependencies have been added to the GemFile for bundled installation:
*[https://rubygems.org/gems/bootstrap3-datetimepicker-rails/versions/4.17.47 Bootstrap3-datetimepicker]
This gem packages the [https://github.com/Eonasdan/bootstrap-datetimepicker bootstrap-datetime-picker] for the Rails 3.1+ asset pipeline. It is based on bootstrap3 and requires momentjs as a dependency.

*[https://rubygems.org/gems/momentjs-rails/versions/2.9.0 MomentJS-Rails]
Moment.js is a lightweight javascript date library for parsing, manipulating, and formatting dates. This gems adds the required javascript files to the project which are used by the new Bootstrap3-datetimepicker gem.
 
Next, the CSS and javascript file provided by the gems need to be included the asset pipeline by including the following in ''application.js'' and ''application.scss'' file. The screenshots below depict the additions to the respective files:
 
[[File: Expertiza1.PNG]]
 
[[File: Expertiza2.PNG]]

==== Refactoring Date-Time Picker widget ====
The existing date-time picker widget was replaced by the new date-time picker in the following views:
 
'''1. Edit and create assignments - ''app/views/assignments/edit/_due_dates.html.erb''''' 
This contains fields to set the submission and review deadlines for different rounds. The existing JQuery call to the date time picker was replaced by the call to the new widget. Following changes were made to the file:
 
'''Before:'''
<pre>
jQuery('#datetimepicker_' + element_id).datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm:ss z',
controlType: 'select',
timezoneList: [
{ value: -000, label: 'GMT'},
{ value: -300, label: 'Eastern'},
{ value: -360, label: 'Central' },
{ value: -420, label: 'Mountain' },
{ value: -480, label: 'Pacific' }
]
});
</pre>

'''After:'''
<pre>
jQuery('#datetimepicker_' + element_id).datetimepicker({
format: 'YYYY/MM/DD hh:mm z',
sideBySide: true
});
</pre>

'''2. Topic sign up sheet - ''app/views/sign_up_sheet/_due_dates.html.erb''''' 
This page is used by the instructor to set up the topic sign up page for projects. The form includes a selection of start date and end date for signup. Following changes were made to the file:
 
'''Before:'''
<pre>
$('.datetimepicker').datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm:ss'
});
</pre>

'''After:'''
<pre>
$('.datetimepicker').datetimepicker({
format: 'YYYY/MM/DD HH:mm',
sideBySide: true
});
</pre>
 
'''3. New survey creation - ''app/views/survey_deployment/new.html.erb''''' 
The page contains the form to allow the creation of new surveys. The survey start and end dates can be set using the form. The old code used two separate inline ''onClick'' event to call the same DateTime picker. Both the calls were replaced by a single jquery call.

'''Before:'''
<pre>
<tr>
<td><label for="start_date">Start Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_start_date" name ="survey_deployment[start_date]" class="form-control width-250" onClick="$('#survey_deployment_start_date').datetimepicker()"/>
</td>
</tr>

<tr>
<td><label for="end_date">End Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_end_date" name ="survey_deployment[end_date]" class="form-control width-250"
onClick="$('#survey_deployment_end_date').datetimepicker()"/>
</td>
</tr>
</table>
</pre>

'''After:'''
<pre>
<tr>
<td><label for="start_date">Start Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_start_date" name ="survey_deployment[start_date]" class="form-control width-250" />
</td>
</tr>

<tr>
<td><label for="end_date">End Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_end_date" name ="survey_deployment[end_date]" class="form-control width-250" />
</td>
</tr>
</table>
<script type="text/javascript">
jQuery('#survey_deployment_start_date, #survey_deployment_end_date').datetimepicker({
format: 'YYYY/MM/DD HH:mm',
sideBySide: true
});
</script>
</pre>
 
'''4. Version logs - ''app/views/sign_up_sheet/_due_dates.html.erb''''' 
The version logs file which is only accessible to the admins uses the date tie picker to filter the search results using the start and the end date. Following changes were made to the file: 

'''Before:'''
<pre>
jQuery('.datetimeklass').datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm:ss z',
controlType: 'select',
timezoneList: [
{ value: -000, label: 'GMT'},
{ value: -300, label: 'Eastern'},
{ value: -360, label: 'Central' },
{ value: -420, label: 'Mountain' },
{ value: -480, label: 'Pacific' }
]
});
</pre>

'''After:'''
<pre>
jQuery('.datetimeklass').datetimepicker({
format: 'YYYY/MM/DD HH:mm z',
sideBySide: true
});
</pre>

=== Output ===
The old jquery based date-time picker was replaced by a new modern bootstrap based date-time picker as shown in the pictures below. The new bootstrap date-time picker widget also has different styles which can be implemented by changing the code as per the documentation [http://eonasdan.github.io/bootstrap-datetimepicker/ here].
 
'''Old Date-Time Picker''' 
[[File: Expertiza3.PNG]]
 
'''New Date-Time Picker''' 
[[File: Expertiza4.PNG]]

== '''Testing''' ==
=== Test Plan ===
This refactor was mainly concerned with the date-time picker widget UI. Thus most of the testing was done manually as automated testing cannot be used to test the widget. After refactoring each of the pages using the date-time widget, rigorous testing was done to check if the date-time picker selected the right date in appropriate formats. Automated testing was performed to test the models and controllers which relied on the date-time picker for its correct functioning. Code climate was used to maintain the code quality and Travis CI build checks were properly monitored for each commit.

=== Manual Testing ===
The new date-time picker widget was manually tested for correctness using the following manual steps: 
1. Create and edit assignments 
Login into instructor account -> Select Manage Assignments -> Click on the plus sign to the right -> Fill in the relevant details -> In the 'due dates' enter the submission and review deadline using the new date time picker widget -> Save -> Check if assignment with proper deadline is being created.
 
2. New survey creation 
Login into instructor account -> Select Manage assignments -> From the list of assignments select an assignment and select the 'assign survey' action-> Fill in the relevant details -> Enter the survey start and end date using the new date time picker widget -> Save -> Check if the survey is created with proper deadline.
 
3. Version logs 
Login to the Admin/Super admin account -> Open the version logs page -> Select the proper date range to filter the results -> Click 'search' -> Check if results are getting filtered according to the dates selected.

=== RSpec Testing ===
To the test the datetimepicker.js functionality, Rspec testing on an untested controller using this gem was performed.
In versions controller, search functionality uses the new datetimepicker.js gem. This controller is being given access to only admins and super-admins.

The tests check if the datetimepicker.js is correctly used and on the button click the relevant data is returned from database. Also the datetimepicker feature with start date and end date detection should work for both admins and super-admins.
 
[[File: Expertiza8.PNG]]
 

=== Travis CI Build Testing ===
Travis-CI Build Test of the beta branch after a refactored function is merged in the beta branch.
[[File: Expertiza9.PNG]]
 

== '''Useful Links''' ==

'''Github Repo:''' https://github.com/SujalAhrodia/expertiza/tree/beta
 
'''Pull Request:''' https://github.com/expertiza/expertiza/pull/1694

== '''Team Information''' ==

'''Project Mentor:'''
 Pratik Abhyankar

'''Project Members:''' 
Akanksha Bhattacharyya 
Sahil Papalkar 
Sujal

CSC/ECE 517 Spring 2020 - E2014. Refactor datetimepicker.js

2020-03-24T00:42:24Z

Ssujal: /* Process */

__TOC__

== '''About Expertiza''' ==
Expertiza is an open-source project based on Ruby on Rails framework. It allows the instructor to create new assignments and customize new or existing assignments. The instructor is allowed to create a list of topics for the students to which they can sign up for. For working on different projects and assignments the students can form teams in Expertiza. Peer review is another feature where students can review other students' submissions. This feature is available in Expertiza. Furthermore, Expertiza supports submission across various document types, including URLs and wiki pages. It is supported by the National Science Foundation.

== '''Abstract''' ==
Expertiza uses the jquery’s date-time picker widget for setting dates and times on various views. This is absolutely required so that all users select the date and/or time in a specified and fixed format. Instructors need to use it often while setting or modifying deadlines for various assignments in a course. Over the years, different developers used different version and formats of the date-time picker due to which there are inconsistencies across the expertiza project.

== '''Problem Statement''' ==
The main problem with the date-time picker is that the widget and the date-time formats used across the expertiza project are not consistent. Moreover, the JQuery based date-time UI widget itself is on version 0.8 which is extremely old and no longer consistent with expertiza's looks and feel. The primary task of the refactor was to find, refactor and make the date-time picker consistent at all places while exploring the possibility of updating the date-time picker to a newer version or completely replacing it by another better widget which works in conjunction with modern javascript libraries.

== '''Problem Solution''' ==
The first step in the approach was to explore the current functionality of existing date time picker. We explored the code base to understand the how 'datetimepicker.js' library was used and its respective compatibility. Simultaneously, we also studied other libraries and gems which could provide a consistent and easy alternative.
Since the existing library was no longer being maintained (inactive since mid 2015) ([https://github.com/Envek/jquery-datetimepicker-rails]), and the new gem 'bootstrap-datetimepicker' provided a relatively recent and easier implementation. So we decided to pick the latter one and replace the older one.

== '''Process''' ==
According to our solution, the existing library needed to be replaced by the new gem. The initial exploration phase helped us to extract the files where datetimepicker has been used in the codebase. The gem was included in the GemFile to make it available throughout the project. Further, necessary syntactical changes were made respective to the new gem. Another key point was to realise the use of a specific format at a specific place. For instance, a shorter format was used in pages to make efficient use of space. The following section includes specific files and the changes made in each of them.

== '''Refactors''' ==
This section discusses the changes implemented as a part of this refactor

==== Installing the required gems ====
Following gems and its dependencies have been added to the GemFile for bundled installation:
*[https://rubygems.org/gems/bootstrap3-datetimepicker-rails/versions/4.17.47 Bootstrap3-datetimepicker]
This gem packages the [https://github.com/Eonasdan/bootstrap-datetimepicker bootstrap-datetime-picker] for the Rails 3.1+ asset pipeline. It is based on bootstrap3 and requires momentjs as a dependency.

*[https://rubygems.org/gems/momentjs-rails/versions/2.9.0 MomentJS-Rails]
Moment.js is a lightweight javascript date library for parsing, manipulating, and formatting dates. This gems adds the required javascript files to the project which are used by the new Bootstrap3-datetimepicker gem.
 
Next, the CSS and javascript file provided by the gems need to be included the asset pipeline by including the following in ''application.js'' and ''application.scss'' file. The screenshots below depict the additions to the respective files:
 
[[File: Expertiza1.PNG]]
 
[[File: Expertiza2.PNG]]

==== Refactoring Date-Time Picker widget ====
The existing date-time picker widget was replaced by the new date-time picker in the following views:
 
'''1. Edit and create assignments - ''app/views/assignments/edit/_due_dates.html.erb''''' 
This contains fields to set the submission and review deadlines for different rounds. The existing JQuery call to the date time picker was replaced by the call to the new widget. Following changes were made to the file:
 
'''Before:'''
<pre>
jQuery('#datetimepicker_' + element_id).datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm:ss z',
controlType: 'select',
timezoneList: [
{ value: -000, label: 'GMT'},
{ value: -300, label: 'Eastern'},
{ value: -360, label: 'Central' },
{ value: -420, label: 'Mountain' },
{ value: -480, label: 'Pacific' }
]
});
</pre>

'''After:'''
<pre>
jQuery('#datetimepicker_' + element_id).datetimepicker({
format: 'YYYY/MM/DD hh:mm z',
sideBySide: true
});
</pre>

'''2. Topic sign up sheet - ''app/views/sign_up_sheet/_due_dates.html.erb''''' 
This page is used by the instructor to set up the topic sign up page for projects. The form includes a selection of start date and end date for signup. Following changes were made to the file:
 
'''Before:'''
<pre>
$('.datetimepicker').datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm:ss'
});
</pre>

'''After:'''
<pre>
$('.datetimepicker').datetimepicker({
format: 'YYYY/MM/DD HH:mm',
sideBySide: true
});
</pre>
 
'''3. New survey creation - ''app/views/survey_deployment/new.html.erb''''' 
The page contains the form to allow the creation of new surveys. The survey start and end dates can be set using the form. The old code used two separate inline ''onClick'' event to call the same DateTime picker. Both the calls were replaced by a single jquery call.

'''Before:'''
<pre>
<tr>
<td><label for="start_date">Start Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_start_date" name ="survey_deployment[start_date]" class="form-control width-250" onClick="$('#survey_deployment_start_date').datetimepicker()"/>
</td>
</tr>

<tr>
<td><label for="end_date">End Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_end_date" name ="survey_deployment[end_date]" class="form-control width-250"
onClick="$('#survey_deployment_end_date').datetimepicker()"/>
</td>
</tr>
</table>
</pre>

'''After:'''
<pre>
<tr>
<td><label for="start_date">Start Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_start_date" name ="survey_deployment[start_date]" class="form-control width-250" />
</td>
</tr>

<tr>
<td><label for="end_date">End Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_end_date" name ="survey_deployment[end_date]" class="form-control width-250" />
</td>
</tr>
</table>
<script type="text/javascript">
jQuery('#survey_deployment_start_date, #survey_deployment_end_date').datetimepicker({
format: 'YYYY/MM/DD HH:mm',
sideBySide: true
});
</script>
</pre>
 
'''4. Version logs - ''app/views/sign_up_sheet/_due_dates.html.erb''''' 
The version logs file which is only accessible to the admins uses the date tie picker to filter the search results using the start and the end date. Following changes were made to the file: 

'''Before:'''
<pre>
jQuery('.datetimeklass').datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm:ss z',
controlType: 'select',
timezoneList: [
{ value: -000, label: 'GMT'},
{ value: -300, label: 'Eastern'},
{ value: -360, label: 'Central' },
{ value: -420, label: 'Mountain' },
{ value: -480, label: 'Pacific' }
]
});
</pre>

'''After:'''
<pre>
jQuery('.datetimeklass').datetimepicker({
format: 'YYYY/MM/DD HH:mm z',
sideBySide: true
});
</pre>

=== Output ===
The old jquery based date-time picker was replaced by a new modern bootstrap based date-time picker as shown in the pictures below. The new bootstrap date-time picker widget also has different styles which can be implemented by changing the code as per the documentation [http://eonasdan.github.io/bootstrap-datetimepicker/ here].
 
'''Old Date-Time Picker''' 
[[File: Expertiza3.PNG]]
 
'''New Date-Time Picker''' 
[[File: Expertiza4.PNG]]

== '''Testing''' ==
=== Test Plan ===
=== RSpec Testing ===
=== Travis CI Build Testing ===

== '''Useful Links''' ==

'''Github Repo:''' https://github.com/SujalAhrodia/expertiza/tree/beta
 
'''Pull Request:''' https://github.com/expertiza/expertiza/pull/1694

== '''Team Information''' ==

'''Project Mentor:'''
 Pratik Abhyankar

'''Project Members:''' 
Akanksha Bhattacharyya 
Sahil Papalkar 
Sujal

CSC/ECE 517 Spring 2020 - E2014. Refactor datetimepicker.js

2020-03-24T00:41:42Z

Ssujal: /* Process */

__TOC__

== '''About Expertiza''' ==
Expertiza is an open-source project based on Ruby on Rails framework. It allows the instructor to create new assignments and customize new or existing assignments. The instructor is allowed to create a list of topics for the students to which they can sign up for. For working on different projects and assignments the students can form teams in Expertiza. Peer review is another feature where students can review other students' submissions. This feature is available in Expertiza. Furthermore, Expertiza supports submission across various document types, including URLs and wiki pages. It is supported by the National Science Foundation.

== '''Abstract''' ==
Expertiza uses the jquery’s date-time picker widget for setting dates and times on various views. This is absolutely required so that all users select the date and/or time in a specified and fixed format. Instructors need to use it often while setting or modifying deadlines for various assignments in a course. Over the years, different developers used different version and formats of the date-time picker due to which there are inconsistencies across the expertiza project.

== '''Problem Statement''' ==
The main problem with the date-time picker is that the widget and the date-time formats used across the expertiza project are not consistent. Moreover, the JQuery based date-time UI widget itself is on version 0.8 which is extremely old and no longer consistent with expertiza's looks and feel. The primary task of the refactor was to find, refactor and make the date-time picker consistent at all places while exploring the possibility of updating the date-time picker to a newer version or completely replacing it by another better widget which works in conjunction with modern javascript libraries.

== '''Problem Solution''' ==
The first step in the approach was to explore the current functionality of existing date time picker. We explored the code base to understand the how 'datetimepicker.js' library was used and its respective compatibility. Simultaneously, we also studied other libraries and gems which could provide a consistent and easy alternative.
Since the existing library was no longer being maintained (inactive since mid 2015) ([https://github.com/Envek/jquery-datetimepicker-rails]), and the new gem 'bootstrap-datetimepicker' provided a relatively recent and easier implementation. So we decided to pick the latter one and replace the older one.

== '''Process''' ==
According to our solution, the existing library needed to be replaced by the new gem. The initial exploration phase helped us to extract the files where datetimepicker has been used in the codebase. The gem was included in the GemFile to make it available throughout the project. Further, necessary syntactical changes were made respective to the new gem. Another key point was to realise the use of a specific format at a specific place. For instance, a shorter format was used in pages to make efficient use of space.

== '''Refactors''' ==
This section discusses the changes implemented as a part of this refactor

==== Installing the required gems ====
Following gems and its dependencies have been added to the GemFile for bundled installation:
*[https://rubygems.org/gems/bootstrap3-datetimepicker-rails/versions/4.17.47 Bootstrap3-datetimepicker]
This gem packages the [https://github.com/Eonasdan/bootstrap-datetimepicker bootstrap-datetime-picker] for the Rails 3.1+ asset pipeline. It is based on bootstrap3 and requires momentjs as a dependency.

*[https://rubygems.org/gems/momentjs-rails/versions/2.9.0 MomentJS-Rails]
Moment.js is a lightweight javascript date library for parsing, manipulating, and formatting dates. This gems adds the required javascript files to the project which are used by the new Bootstrap3-datetimepicker gem.
 
Next, the CSS and javascript file provided by the gems need to be included the asset pipeline by including the following in ''application.js'' and ''application.scss'' file. The screenshots below depict the additions to the respective files:
 
[[File: Expertiza1.PNG]]
 
[[File: Expertiza2.PNG]]

==== Refactoring Date-Time Picker widget ====
The existing date-time picker widget was replaced by the new date-time picker in the following views:
 
'''1. Edit and create assignments - ''app/views/assignments/edit/_due_dates.html.erb''''' 
This contains fields to set the submission and review deadlines for different rounds. The existing JQuery call to the date time picker was replaced by the call to the new widget. Following changes were made to the file:
 
'''Before:'''
<pre>
jQuery('#datetimepicker_' + element_id).datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm:ss z',
controlType: 'select',
timezoneList: [
{ value: -000, label: 'GMT'},
{ value: -300, label: 'Eastern'},
{ value: -360, label: 'Central' },
{ value: -420, label: 'Mountain' },
{ value: -480, label: 'Pacific' }
]
});
</pre>

'''After:'''
<pre>
jQuery('#datetimepicker_' + element_id).datetimepicker({
format: 'YYYY/MM/DD hh:mm z',
sideBySide: true
});
</pre>

'''2. Topic sign up sheet - ''app/views/sign_up_sheet/_due_dates.html.erb''''' 
This page is used by the instructor to set up the topic sign up page for projects. The form includes a selection of start date and end date for signup. Following changes were made to the file:
 
'''Before:'''
<pre>
$('.datetimepicker').datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm:ss'
});
</pre>

'''After:'''
<pre>
$('.datetimepicker').datetimepicker({
format: 'YYYY/MM/DD HH:mm',
sideBySide: true
});
</pre>
 
'''3. New survey creation - ''app/views/survey_deployment/new.html.erb''''' 
The page contains the form to allow the creation of new surveys. The survey start and end dates can be set using the form. The old code used two separate inline ''onClick'' event to call the same DateTime picker. Both the calls were replaced by a single jquery call.

'''Before:'''
<pre>
<tr>
<td><label for="start_date">Start Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_start_date" name ="survey_deployment[start_date]" class="form-control width-250" onClick="$('#survey_deployment_start_date').datetimepicker()"/>
</td>
</tr>

<tr>
<td><label for="end_date">End Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_end_date" name ="survey_deployment[end_date]" class="form-control width-250"
onClick="$('#survey_deployment_end_date').datetimepicker()"/>
</td>
</tr>
</table>
</pre>

'''After:'''
<pre>
<tr>
<td><label for="start_date">Start Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_start_date" name ="survey_deployment[start_date]" class="form-control width-250" />
</td>
</tr>

<tr>
<td><label for="end_date">End Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_end_date" name ="survey_deployment[end_date]" class="form-control width-250" />
</td>
</tr>
</table>
<script type="text/javascript">
jQuery('#survey_deployment_start_date, #survey_deployment_end_date').datetimepicker({
format: 'YYYY/MM/DD HH:mm',
sideBySide: true
});
</script>
</pre>
 
'''4. Version logs - ''app/views/sign_up_sheet/_due_dates.html.erb''''' 
The version logs file which is only accessible to the admins uses the date tie picker to filter the search results using the start and the end date. Following changes were made to the file: 

'''Before:'''
<pre>
jQuery('.datetimeklass').datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm:ss z',
controlType: 'select',
timezoneList: [
{ value: -000, label: 'GMT'},
{ value: -300, label: 'Eastern'},
{ value: -360, label: 'Central' },
{ value: -420, label: 'Mountain' },
{ value: -480, label: 'Pacific' }
]
});
</pre>

'''After:'''
<pre>
jQuery('.datetimeklass').datetimepicker({
format: 'YYYY/MM/DD HH:mm z',
sideBySide: true
});
</pre>

=== Output ===
The old jquery based date-time picker was replaced by a new modern bootstrap based date-time picker as shown in the pictures below. The new bootstrap date-time picker widget also has different styles which can be implemented by changing the code as per the documentation [http://eonasdan.github.io/bootstrap-datetimepicker/ here].
 
'''Old Date-Time Picker''' 
[[File: Expertiza3.PNG]]
 
'''New Date-Time Picker''' 
[[File: Expertiza4.PNG]]

== '''Testing''' ==
=== Test Plan ===
=== RSpec Testing ===
=== Travis CI Build Testing ===

== '''Useful Links''' ==

'''Github Repo:''' https://github.com/SujalAhrodia/expertiza/tree/beta
 
'''Pull Request:''' https://github.com/expertiza/expertiza/pull/1694

== '''Team Information''' ==

'''Project Mentor:'''
 Pratik Abhyankar

'''Project Members:''' 
Akanksha Bhattacharyya 
Sahil Papalkar 
Sujal

CSC/ECE 517 Spring 2020 - E2014. Refactor datetimepicker.js

2020-03-24T00:32:50Z

Ssujal: /* Team Information */

__TOC__

== '''About Expertiza''' ==
Expertiza is an open-source project based on Ruby on Rails framework. It allows the instructor to create new assignments and customize new or existing assignments. The instructor is allowed to create a list of topics for the students to which they can sign up for. For working on different projects and assignments the students can form teams in Expertiza. Peer review is another feature where students can review other students' submissions. This feature is available in Expertiza. Furthermore, Expertiza supports submission across various document types, including URLs and wiki pages. It is supported by the National Science Foundation.

== '''Abstract''' ==
Expertiza uses the jquery’s date-time picker widget for setting dates and times on various views. This is absolutely required so that all users select the date and/or time in a specified and fixed format. Instructors need to use it often while setting or modifying deadlines for various assignments in a course. Over the years, different developers used different version and formats of the date-time picker due to which there are inconsistencies across the expertiza project.

== '''Problem Statement''' ==
The main problem with the date-time picker is that the widget and the date-time formats used across the expertiza project are not consistent. Moreover, the JQuery based date-time UI widget itself is on version 0.8 which is extremely old and no longer consistent with expertiza's looks and feel. The primary task of the refactor was to find, refactor and make the date-time picker consistent at all places while exploring the possibility of updating the date-time picker to a newer version or completely replacing it by another better widget which works in conjunction with modern javascript libraries.

== '''Problem Solution''' ==
The first step in the approach was to explore the current functionality of existing date time picker. We explored the code base to understand the how 'datetimepicker.js' library was used and its respective compatibility. Simultaneously, we also studied other libraries and gems which could provide a consistent and easy alternative.
Since the existing library was no longer being maintained (inactive since mid 2015) ([https://github.com/Envek/jquery-datetimepicker-rails]), and the new gem 'bootstrap-datetimepicker' provided a relatively recent and easier implementation. So we decided to pick the latter one and replace the older one.

== '''Process''' ==

== '''Refactors''' ==
This section discusses the changes implemented as a part of this refactor

==== Installing the required gems ====
Following gems and its dependencies have been added to the GemFile for bundled installation:
*[https://rubygems.org/gems/bootstrap3-datetimepicker-rails/versions/4.17.47 Bootstrap3-datetimepicker]
This gem packages the [https://github.com/Eonasdan/bootstrap-datetimepicker bootstrap-datetime-picker] for the Rails 3.1+ asset pipeline. It is based on bootstrap3 and requires momentjs as a dependency.

*[https://rubygems.org/gems/momentjs-rails/versions/2.9.0 MomentJS-Rails]
Moment.js is a lightweight javascript date library for parsing, manipulating, and formatting dates. This gems adds the required javascript files to the project which are used by the new Bootstrap3-datetimepicker gem.
 
Next, the CSS and javascript file provided by the gems need to be included the asset pipeline by including the following in ''application.js'' and ''application.scss'' file. The screenshots below depict the additions to the respective files:
 
[[File: Expertiza1.PNG]]
 
[[File: Expertiza2.PNG]]

==== Refactoring Date-Time Picker widget ====
The existing date-time picker widget was replaced by the new date-time picker in the following views:
 
'''1. Edit and create assignments - ''app/views/assignments/edit/_due_dates.html.erb''''' 
This contains fields to set the submission and review deadlines for different rounds. The existing JQuery call to the date time picker was replaced by the call to the new widget. Following changes were made to the file:
 
'''Before:'''
<pre>
jQuery('#datetimepicker_' + element_id).datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm:ss z',
controlType: 'select',
timezoneList: [
{ value: -000, label: 'GMT'},
{ value: -300, label: 'Eastern'},
{ value: -360, label: 'Central' },
{ value: -420, label: 'Mountain' },
{ value: -480, label: 'Pacific' }
]
});
</pre>

'''After:'''
<pre>
jQuery('#datetimepicker_' + element_id).datetimepicker({
format: 'YYYY/MM/DD hh:mm z',
sideBySide: true
});
</pre>

'''2. Topic sign up sheet - ''app/views/sign_up_sheet/_due_dates.html.erb''''' 
This page is used by the instructor to set up the topic sign up page for projects. The form includes a selection of start date and end date for signup. Following changes were made to the file:
 
'''Before:'''
<pre>
$('.datetimepicker').datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm:ss'
});
</pre>

'''After:'''
<pre>
$('.datetimepicker').datetimepicker({
format: 'YYYY/MM/DD HH:mm',
sideBySide: true
});
</pre>
 
'''3. New survey creation - ''app/views/survey_deployment/new.html.erb''''' 
The page contains the form to allow the creation of new surveys. The survey start and end dates can be set using the form. The old code used two separate inline ''onClick'' event to call the same DateTime picker. Both the calls were replaced by a single jquery call.

'''Before:'''
<pre>
<tr>
<td><label for="start_date">Start Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_start_date" name ="survey_deployment[start_date]" class="form-control width-250" onClick="$('#survey_deployment_start_date').datetimepicker()"/>
</td>
</tr>

<tr>
<td><label for="end_date">End Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_end_date" name ="survey_deployment[end_date]" class="form-control width-250"
onClick="$('#survey_deployment_end_date').datetimepicker()"/>
</td>
</tr>
</table>
</pre>

'''After:'''
<pre>
<tr>
<td><label for="start_date">Start Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_start_date" name ="survey_deployment[start_date]" class="form-control width-250" />
</td>
</tr>

<tr>
<td><label for="end_date">End Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_end_date" name ="survey_deployment[end_date]" class="form-control width-250" />
</td>
</tr>
</table>
<script type="text/javascript">
jQuery('#survey_deployment_start_date, #survey_deployment_end_date').datetimepicker({
format: 'YYYY/MM/DD HH:mm',
sideBySide: true
});
</script>
</pre>
 
'''4. Version logs - ''app/views/sign_up_sheet/_due_dates.html.erb''''' 
The version logs file which is only accessible to the admins uses the date tie picker to filter the search results using the start and the end date. Following changes were made to the file: 

'''Before:'''
<pre>
jQuery('.datetimeklass').datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm:ss z',
controlType: 'select',
timezoneList: [
{ value: -000, label: 'GMT'},
{ value: -300, label: 'Eastern'},
{ value: -360, label: 'Central' },
{ value: -420, label: 'Mountain' },
{ value: -480, label: 'Pacific' }
]
});
</pre>

'''After:'''
<pre>
jQuery('.datetimeklass').datetimepicker({
format: 'YYYY/MM/DD HH:mm z',
sideBySide: true
});
</pre>

=== Output ===
The old jquery based date-time picker was replaced by a new modern bootstrap based date-time picker as shown in the pictures below. The new bootstrap date-time picker widget also has different styles which can be implemented by changing the code as per the documentation [http://eonasdan.github.io/bootstrap-datetimepicker/ here].
 
'''Old Date-Time Picker''' 
[[File: Expertiza3.PNG]]
 
'''New Date-Time Picker''' 
[[File: Expertiza4.PNG]]

== '''Testing''' ==
=== Test Plan ===
=== RSpec Testing ===
=== Travis CI Build Testing ===

== '''Useful Links''' ==

'''Github Repo:''' https://github.com/SujalAhrodia/expertiza/tree/beta
 
'''Pull Request:''' https://github.com/expertiza/expertiza/pull/1694

== '''Team Information''' ==

'''Project Mentor:'''
 Pratik Abhyankar

'''Project Members:''' 
Akanksha Bhattacharyya 
Sahil Papalkar 
Sujal

CSC/ECE 517 Spring 2020 - E2014. Refactor datetimepicker.js

2020-03-24T00:32:10Z

Ssujal: /* Problem Solution */

__TOC__

== '''About Expertiza''' ==
Expertiza is an open-source project based on Ruby on Rails framework. It allows the instructor to create new assignments and customize new or existing assignments. The instructor is allowed to create a list of topics for the students to which they can sign up for. For working on different projects and assignments the students can form teams in Expertiza. Peer review is another feature where students can review other students' submissions. This feature is available in Expertiza. Furthermore, Expertiza supports submission across various document types, including URLs and wiki pages. It is supported by the National Science Foundation.

== '''Abstract''' ==
Expertiza uses the jquery’s date-time picker widget for setting dates and times on various views. This is absolutely required so that all users select the date and/or time in a specified and fixed format. Instructors need to use it often while setting or modifying deadlines for various assignments in a course. Over the years, different developers used different version and formats of the date-time picker due to which there are inconsistencies across the expertiza project.

== '''Problem Statement''' ==
The main problem with the date-time picker is that the widget and the date-time formats used across the expertiza project are not consistent. Moreover, the JQuery based date-time UI widget itself is on version 0.8 which is extremely old and no longer consistent with expertiza's looks and feel. The primary task of the refactor was to find, refactor and make the date-time picker consistent at all places while exploring the possibility of updating the date-time picker to a newer version or completely replacing it by another better widget which works in conjunction with modern javascript libraries.

== '''Problem Solution''' ==
The first step in the approach was to explore the current functionality of existing date time picker. We explored the code base to understand the how 'datetimepicker.js' library was used and its respective compatibility. Simultaneously, we also studied other libraries and gems which could provide a consistent and easy alternative.
Since the existing library was no longer being maintained (inactive since mid 2015) ([https://github.com/Envek/jquery-datetimepicker-rails]), and the new gem 'bootstrap-datetimepicker' provided a relatively recent and easier implementation. So we decided to pick the latter one and replace the older one.

== '''Process''' ==

== '''Refactors''' ==
This section discusses the changes implemented as a part of this refactor

==== Installing the required gems ====
Following gems and its dependencies have been added to the GemFile for bundled installation:
*[https://rubygems.org/gems/bootstrap3-datetimepicker-rails/versions/4.17.47 Bootstrap3-datetimepicker]
This gem packages the [https://github.com/Eonasdan/bootstrap-datetimepicker bootstrap-datetime-picker] for the Rails 3.1+ asset pipeline. It is based on bootstrap3 and requires momentjs as a dependency.

*[https://rubygems.org/gems/momentjs-rails/versions/2.9.0 MomentJS-Rails]
Moment.js is a lightweight javascript date library for parsing, manipulating, and formatting dates. This gems adds the required javascript files to the project which are used by the new Bootstrap3-datetimepicker gem.
 
Next, the CSS and javascript file provided by the gems need to be included the asset pipeline by including the following in ''application.js'' and ''application.scss'' file. The screenshots below depict the additions to the respective files:
 
[[File: Expertiza1.PNG]]
 
[[File: Expertiza2.PNG]]

==== Refactoring Date-Time Picker widget ====
The existing date-time picker widget was replaced by the new date-time picker in the following views:
 
'''1. Edit and create assignments - ''app/views/assignments/edit/_due_dates.html.erb''''' 
This contains fields to set the submission and review deadlines for different rounds. The existing JQuery call to the date time picker was replaced by the call to the new widget. Following changes were made to the file:
 
'''Before:'''
<pre>
jQuery('#datetimepicker_' + element_id).datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm:ss z',
controlType: 'select',
timezoneList: [
{ value: -000, label: 'GMT'},
{ value: -300, label: 'Eastern'},
{ value: -360, label: 'Central' },
{ value: -420, label: 'Mountain' },
{ value: -480, label: 'Pacific' }
]
});
</pre>

'''After:'''
<pre>
jQuery('#datetimepicker_' + element_id).datetimepicker({
format: 'YYYY/MM/DD hh:mm z',
sideBySide: true
});
</pre>

'''2. Topic sign up sheet - ''app/views/sign_up_sheet/_due_dates.html.erb''''' 
This page is used by the instructor to set up the topic sign up page for projects. The form includes a selection of start date and end date for signup. Following changes were made to the file:
 
'''Before:'''
<pre>
$('.datetimepicker').datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm:ss'
});
</pre>

'''After:'''
<pre>
$('.datetimepicker').datetimepicker({
format: 'YYYY/MM/DD HH:mm',
sideBySide: true
});
</pre>
 
'''3. New survey creation - ''app/views/survey_deployment/new.html.erb''''' 
The page contains the form to allow the creation of new surveys. The survey start and end dates can be set using the form. The old code used two separate inline ''onClick'' event to call the same DateTime picker. Both the calls were replaced by a single jquery call.

'''Before:'''
<pre>
<tr>
<td><label for="start_date">Start Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_start_date" name ="survey_deployment[start_date]" class="form-control width-250" onClick="$('#survey_deployment_start_date').datetimepicker()"/>
</td>
</tr>

<tr>
<td><label for="end_date">End Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_end_date" name ="survey_deployment[end_date]" class="form-control width-250"
onClick="$('#survey_deployment_end_date').datetimepicker()"/>
</td>
</tr>
</table>
</pre>

'''After:'''
<pre>
<tr>
<td><label for="start_date">Start Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_start_date" name ="survey_deployment[start_date]" class="form-control width-250" />
</td>
</tr>

<tr>
<td><label for="end_date">End Date:</label></td>
<td class="form-inline">
<input type="text" id="survey_deployment_end_date" name ="survey_deployment[end_date]" class="form-control width-250" />
</td>
</tr>
</table>
<script type="text/javascript">
jQuery('#survey_deployment_start_date, #survey_deployment_end_date').datetimepicker({
format: 'YYYY/MM/DD HH:mm',
sideBySide: true
});
</script>
</pre>
 
'''4. Version logs - ''app/views/sign_up_sheet/_due_dates.html.erb''''' 
The version logs file which is only accessible to the admins uses the date tie picker to filter the search results using the start and the end date. Following changes were made to the file: 

'''Before:'''
<pre>
jQuery('.datetimeklass').datetimepicker({
dateFormat: 'yy/mm/dd',
timeFormat: 'HH:mm:ss z',
controlType: 'select',
timezoneList: [
{ value: -000, label: 'GMT'},
{ value: -300, label: 'Eastern'},
{ value: -360, label: 'Central' },
{ value: -420, label: 'Mountain' },
{ value: -480, label: 'Pacific' }
]
});
</pre>

'''After:'''
<pre>
jQuery('.datetimeklass').datetimepicker({
format: 'YYYY/MM/DD HH:mm z',
sideBySide: true
});
</pre>

=== Output ===
The old jquery based date-time picker was replaced by a new modern bootstrap based date-time picker as shown in the pictures below. The new bootstrap date-time picker widget also has different styles which can be implemented by changing the code as per the documentation [http://eonasdan.github.io/bootstrap-datetimepicker/ here].
 
'''Old Date-Time Picker''' 
[[File: Expertiza3.PNG]]
 
'''New Date-Time Picker''' 
[[File: Expertiza4.PNG]]

== '''Testing''' ==
=== Test Plan ===
=== RSpec Testing ===
=== Travis CI Build Testing ===

== '''Useful Links''' ==

'''Github Repo:''' https://github.com/SujalAhrodia/expertiza/tree/beta
 
'''Pull Request:''' https://github.com/expertiza/expertiza/pull/1694

== '''Team Information''' ==

'''Project Mentor:'''
 Pratik Abhyankar

'''Project Members:''' 
Akanksha Bhattacharyya 
Sahil Papalkar 
Sujal Ahrodia