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-01T14:44:44Z

Akhot: /* 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 ===

'''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)

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

2020-04-17T19:56:46Z

Akhot: /* 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 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".

'''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 “status” 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-17T19:54:28Z

Akhot: /* 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 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".

'''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 “status” 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.

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-17T19:53:19Z

Akhot: /* 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 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".

'''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 “status” 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_assignemnts'

'''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.

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-14T00:46:58Z

Akhot: restructure page

== 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 '''response.html.erb''' and set a "status" 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 “status” 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.
|-
| PUBLISH || 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_assignemnts'

'''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 silimalr_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.

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-14T00:38:44Z

Akhot: /* Problem Statement */

== 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 ==

=== 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.
|-
| PUBLISH || Selected to show as example 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".

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

'''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 “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]]

'''4. 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.

'''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'''.

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

'''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.

== 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 silimalr_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]]

== Use Case Diagram ==
* Use Cases -

[[Image:UseCase.png]]

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

=== 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'''

== 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.

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-14T00:34:59Z

Akhot: /* UML Diagram */

== 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. Also,

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.

== 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 ==

=== 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.
|-
| PUBLISH || Selected to show as example 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".

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

'''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 “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]]

'''4. 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.

'''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'''.

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

'''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.

== 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 silimalr_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]]

== Use Case Diagram ==
* Use Cases -

[[Image:UseCase.png]]

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

=== 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'''

== 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.

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-14T00:33:59Z

Akhot: /* 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. Also,

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.

== 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 ==

=== 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.
|-
| PUBLISH || Selected to show as example 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".

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

'''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 “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]]

'''4. 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.

'''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'''.

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

'''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.

== 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 silimalr_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]]

== UML Diagram ==
* Use Case -

[[Image:UseCase.png]]

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

=== 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'''

== 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.

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)

File:Feature viewSample.png

2020-04-14T00:32:20Z

Akhot:

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

2020-04-14T00:27:26Z

Akhot: /* Problem Statement */

== 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. Also,

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.

== 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 ==

=== 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.
|-
| PUBLISH || Selected to show as example 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".

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

'''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 “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]]

'''4. 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.

'''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.

== 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 silimalr_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]]

== UML Diagram ==
* Use Case -

[[Image:UseCase.png]]

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

=== 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'''

== 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.

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-14T00:23:45Z

Akhot: /* 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 example 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. Also,

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.

== 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 ==

=== 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.
|-
| PUBLISH || Selected to show as example 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".

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

'''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 “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]]

'''4. 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.

'''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.

== 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 silimalr_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]]

== UML Diagram ==
* Use Case -

[[Image:UseCase.png]]

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

=== 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'''

== 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.

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-14T00:10:58Z

Akhot:

== 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 example 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. Also,

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.

== 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 ==

=== 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.
|-
| PUBLISH || Selected to show as example 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".

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

'''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 “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]]

'''4. 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.

'''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.

== 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 silimalr_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]]

== UML Diagram ==
* Use Case -

[[Image:UseCase.png]]

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

=== 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'''

== 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 ===

We are planning to write rspec tests for whatever modifications we make.

== 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)

File:Db design e2022.png

2020-04-14T00:10:09Z

Akhot: Akhot uploaded a new version of File:Db design e2022.png

File:Db design e2022.png

2020-04-14T00:08:28Z

Akhot:

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

2020-04-13T23:38:24Z

Akhot: /* 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 example 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. Also,

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.

== 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 ==

=== 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"
! 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".

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

'''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 “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]]

'''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 a column status 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.

=== 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 ===

We are planning to write rspec tests for whatever modifications we make.

== 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)

File:Feature instructor.png

2020-04-13T23:37:10Z

Akhot: Akhot uploaded a new version of File:Feature instructor.png

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

2020-04-13T23:33:05Z

Akhot: /* 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. 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 example 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. Also,

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.

== 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 ==

=== 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"
! 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".

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

'''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 “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]]

'''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 a column status 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.

=== 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 ===

We are planning to write rspec tests for whatever modifications we make.

== 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-13T23:32:08Z

Akhot: /* 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. 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 example 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. Also,

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.

== 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 ==

=== 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"
! 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".
'''Sequence Diagram:'''
[[File:feature_user.png|none|User_MarkAsPublic_sequence]]

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

'''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 “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]]

'''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 a column status 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.

=== 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 ===

We are planning to write rspec tests for whatever modifications we make.

== 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)

File:Feature instructor.png

2020-04-13T23:30:21Z

Akhot:

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

2020-04-13T23:22:21Z

Akhot: /* 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 given some example reviews. 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 example 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. Also,

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.

== 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 ==

=== 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"
! 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".

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

'''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 “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.

'''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 a column status 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.

=== 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 ===

We are planning to write rspec tests for whatever modifications we make.

== 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)

File:Feature user.png

2020-04-13T23:20:19Z

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

File:Feature user.png

2020-04-13T23:06:50Z

Akhot:

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

2020-04-08T19:12:35Z

Akhot: /* 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 ===

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 ===

'''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 - Project E2011. Refactor assignment creation spec.rb

2020-03-24T00:44:07Z

Akhot: /* Coverage */

== E2011. Refactoring assignment_creation_spec.rb ==

This page provides a description of the Expertiza based OSS project.

=== Introduction ===
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.
 

=== Problem Statement ===
The two major tasks for this project were the following:

* Refactor existing test cases to follow good coding practices. This includes variable names, following the Don't Repeat Yourself (DRY) principle, and more.
* Check coverage of assignment_creation_spec.rb and improve upon it through additional testing.

=== Current Implementation ===
The assignment_creation_spec file contains test cases that ensure proper functionality of an instructor's workflow in regards to the creation of assignments. An instructor, when logged into Expertiza, should be able to create new assignments where each assignment has it's own assigned parameters, rubrics, review strategies and due dates. At the start of this project, all logic and handling of testing this instructor workflow was handled within a single file. This single-file implementation leads to problems with maintenance, and such problems within this implementation can be abstracted into one of these forms:

*'''File is too long''': This file exceeds 250 lines of code, and should not.
*'''Block has too many lines''': Within the file, the code used to handle a certain operation is implemented with too many subroutines within one block.
*'''Similar/Exact block(s) of code found''': Across the file, there were duplicate/near-duplicate blocks of code being used.
*'''General syntax issues''': This could include unnecessary whitespace, use of deprecated classes or things of the like.

=== Refactoring Process ===
The first refactor that our team did was to extract methods from what otherwise would be duplicate code and large block sizes. The previous team had started this process, but we were able to follow it to completion. We also then moved all of these extracted methods into the helper class assignment_creation_helper.rb. Here is an example of extracted methods that the previous team had created:

<pre>
def get_questionnaire(finder_var = nil)
if finder_var.nil?
AssignmentQuestionnaire.find_by(assignment_id: @assignment.id)
else
AssignmentQuestionnaire.where(assignment_id: @assignment.id).where(questionnaire_id: get_selected_id(finder_var))
end
end

def get_selected_id(finder_var)
if finder_var == "ReviewQuestionnaire2"
ReviewQuestionnaire.find_by(name: finder_var).id
elsif finder_var == "AuthorFeedbackQuestionnaire2"
AuthorFeedbackQuestionnaire.find_by(name: finder_var).id
elsif finder_var == "TeammateReviewQuestionnaire2"
TeammateReviewQuestionnaire.find_by(name: finder_var).id
end
end

def fill_assignment_form
fill_in 'assignment_form_assignment_name', with: 'edit assignment for test'
select('Course 2', from: 'assignment_form_assignment_course_id')
fill_in 'assignment_form_assignment_directory_path', with: 'testDirectory1'
fill_in 'assignment_form_assignment_spec_location', with: 'testLocation1'
end

def assignment_creation_setup(privacy,name)
login_as("instructor6")
new_assignment_url = "/assignments/new?private=#{privacy}"
visit new_assignment_url

fill_in 'assignment_form_assignment_name', with: name
select('Course 2', from: 'assignment_form_assignment_course_id')
fill_in 'assignment_form_assignment_directory_path', with: 'testDirectory'
end
</pre>

The following is an example of how we were able to reduce block size and duplicate code with further extraction of methods into assignment_creation_helper.rb:

[[File:E2011RefactoringDiff.png]]

Another major refactor we did was to break up the one large 'describe' block in assignment_creation_spec, which contained all of the tests for that controller. Since assignment creation has many different pages, we created a separate file for testing each page or responsibility.

Beyond the creation of the helper file, assignment_creation_spec.rb was broken up into the following files:
*assignment_creation_dates_spec.rb
*assignment_creation_deadlines_spec.rb
*assignment_creation_general_tab_spec.rb
*assignment_creation_page_spec.rb
*assignment_creation_participants_spec.rb
*assignment_creation_review_strategy_spec.rb
*assignment_creation_rubrics_spec.rb
*assignment_creation_topics_spec.rb

In the relocation of assignment_creation_spec's functionality and creation of new constituent files, additional refactoring was done to ensure that trailing whitespace was deleted, files ended with a final newline character, and other unnecessary characters were removed. All of this was to remove any other problems that code climate detected.

=== Additional Code Climate Issues ===

There were a few things that code climate detected that we decided did not need to be refactored. The first was a complaint about blocks being too large, even after we divided the one large 'describe' statement into many smaller ones. This is because, in rspec, each test has its own 'it' block, but all of those must be grouped in a larger 'describe' block. I suggest that this be discussed with the teams who may refactor the other test files or have code climate to be configured to instead look just at the 'it' block size.

This is an diagram on how otherwise good ruby code may be flagged by code climate:
<pre>
'describe' block
'it' block
(23 lines of code) - Code climate: √
'it' block
(15 lines of code) - Code climate: √
'it' block
(11 lines of code) - Code climate: √
end - Code climate: X (23+15+11 = 49 lines)
</pre>

Additionally, code climate was suggesting to change DateTime to Date or Time. As assignments are due not only on a certain day but at a specific time and that this would require a large refactoring of the entire Expertiza system for tracking submission times, we decided it was beyond the scope of this refactor.

=== Testing ===
As part of the refactoring, we fixed a few broken tests in the original assignments_controller_spec.rb and created additional ones to increase coverage.

=== Additional Rspec Tests Created ===
Looking at the methods that were covered in assignments_controller.rb we decided to create the following additional test cases for assignment creation.

These are additions to the existing assignments_controller_spec.rb.

[[File:E2011NewTests.png]]

==RSpec ScreenCast==
Links to RSpec screencasts for new test cases.
# [https://drive.google.com/open?id=1AIi3MtD_TtUN5F1k3kzgqIgi8ficz_Ar Assignment Creation General Tab]
# [https://drive.google.com/open?id=1VnH_4NSLBX1x7xeYnH1Zsy6XG_nWD7Vk Assignment Creation Topic]
# [https://drive.google.com/open?id=1jUQSgXjjI5jQBTWAkD8YGhYnYIIXPtnq Assignment Creation Page]

=== Coverage ===
92.86% for assignments_controller.rb

Overall coverage increased (+28.04%) to 52.334%

== Project Mentors ==
#Dr. Edward Gehringer (efg@ncsu.edu)
#Srujana Rachakonda (srachak@ncsu.edu)

== Team Members ==
#Colin Foley (cmfoley2@ncsu.edu)
#Ayush Khot (akhot@ncsu.edu)
#Christian Morris (cgmorris@ncsu.edu)

== References ==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]

CSC/ECE 517 Spring 2020 - Project E2011. Refactor assignment creation spec.rb

2020-03-24T00:39:27Z

Akhot: /* E2011. Refactoring assignment_creation_spec.rb */

== E2011. Refactoring assignment_creation_spec.rb ==

This page provides a description of the Expertiza based OSS project.

=== Introduction ===
[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.
 

=== Problem Statement ===
The two major tasks for this project were the following:

* Refactor existing test cases to follow good coding practices. This includes variable names, following the Don't Repeat Yourself (DRY) principle, and more.
* Check coverage of assignment_creation_spec.rb and improve upon it through additional testing.

=== Current Implementation ===
The assignment_creation_spec file contains test cases that ensure proper functionality of an instructor's workflow in regards to the creation of assignments. An instructor, when logged into Expertiza, should be able to create new assignments where each assignment has it's own assigned parameters, rubrics, review strategies and due dates. At the start of this project, all logic and handling of testing this instructor workflow was handled within a single file. This single-file implementation leads to problems with maintenance, and such problems within this implementation can be abstracted into one of these forms:

*'''File is too long''': This file exceeds 250 lines of code, and should not.
*'''Block has too many lines''': Within the file, the code used to handle a certain operation is implemented with too many subroutines within one block.
*'''Similar/Exact block(s) of code found''': Across the file, there were duplicate/near-duplicate blocks of code being used.
*'''General syntax issues''': This could include unnecessary whitespace, use of deprecated classes or things of the like.

=== Refactoring Process ===
The first refactor that our team did was to extract methods from what otherwise would be duplicate code and large block sizes. The previous team had started this process, but we were able to follow it to completion. We also then moved all of these extracted methods into the helper class assignment_creation_helper.rb. Here is an example of extracted methods that the previous team had created:

<pre>
def get_questionnaire(finder_var = nil)
if finder_var.nil?
AssignmentQuestionnaire.find_by(assignment_id: @assignment.id)
else
AssignmentQuestionnaire.where(assignment_id: @assignment.id).where(questionnaire_id: get_selected_id(finder_var))
end
end

def get_selected_id(finder_var)
if finder_var == "ReviewQuestionnaire2"
ReviewQuestionnaire.find_by(name: finder_var).id
elsif finder_var == "AuthorFeedbackQuestionnaire2"
AuthorFeedbackQuestionnaire.find_by(name: finder_var).id
elsif finder_var == "TeammateReviewQuestionnaire2"
TeammateReviewQuestionnaire.find_by(name: finder_var).id
end
end

def fill_assignment_form
fill_in 'assignment_form_assignment_name', with: 'edit assignment for test'
select('Course 2', from: 'assignment_form_assignment_course_id')
fill_in 'assignment_form_assignment_directory_path', with: 'testDirectory1'
fill_in 'assignment_form_assignment_spec_location', with: 'testLocation1'
end

def assignment_creation_setup(privacy,name)
login_as("instructor6")
new_assignment_url = "/assignments/new?private=#{privacy}"
visit new_assignment_url

fill_in 'assignment_form_assignment_name', with: name
select('Course 2', from: 'assignment_form_assignment_course_id')
fill_in 'assignment_form_assignment_directory_path', with: 'testDirectory'
end
</pre>

The following is an example of how we were able to reduce block size and duplicate code with further extraction of methods into assignment_creation_helper.rb:

[[File:E2011RefactoringDiff.png]]

Another major refactor we did was to break up the one large 'describe' block in assignment_creation_spec, which contained all of the tests for that controller. Since assignment creation has many different pages, we created a separate file for testing each page or responsibility.

Beyond the creation of the helper file, assignment_creation_spec.rb was broken up into the following files:
*assignment_creation_dates_spec.rb
*assignment_creation_deadlines_spec.rb
*assignment_creation_general_tab_spec.rb
*assignment_creation_page_spec.rb
*assignment_creation_participants_spec.rb
*assignment_creation_review_strategy_spec.rb
*assignment_creation_rubrics_spec.rb
*assignment_creation_topics_spec.rb

In the relocation of assignment_creation_spec's functionality and creation of new constituent files, additional refactoring was done to ensure that trailing whitespace was deleted, files ended with a final newline character, and other unnecessary characters were removed. All of this was to remove any other problems that code climate detected.

=== Additional Code Climate Issues ===

There were a few things that code climate detected that we decided did not need to be refactored. The first was a complaint about blocks being too large, even after we divided the one large 'describe' statement into many smaller ones. This is because, in rspec, each test has its own 'it' block, but all of those must be grouped in a larger 'describe' block. I suggest that this be discussed with the teams who may refactor the other test files or have code climate to be configured to instead look just at the 'it' block size.

This is an diagram on how otherwise good ruby code may be flagged by code climate:
<pre>
'describe' block
'it' block
(23 lines of code) - Code climate: √
'it' block
(15 lines of code) - Code climate: √
'it' block
(11 lines of code) - Code climate: √
end - Code climate: X (23+15+11 = 49 lines)
</pre>

Additionally, code climate was suggesting to change DateTime to Date or Time. As assignments are due not only on a certain day but at a specific time and that this would require a large refactoring of the entire Expertiza system for tracking submission times, we decided it was beyond the scope of this refactor.

=== Testing ===
As part of the refactoring, we fixed a few broken tests in the original assignments_controller_spec.rb and created additional ones to increase coverage.

=== Additional Rspec Tests Created ===
Looking at the methods that were covered in assignments_controller.rb we decided to create the following additional test cases for assignment creation.

These are additions to the existing assignments_controller_spec.rb.

[[File:E2011NewTests.png]]

==RSpec ScreenCast==
Links to RSpec screencasts for new test cases.
# [https://drive.google.com/open?id=1AIi3MtD_TtUN5F1k3kzgqIgi8ficz_Ar Assignment Creation General Tab]
# [https://drive.google.com/open?id=1VnH_4NSLBX1x7xeYnH1Zsy6XG_nWD7Vk Assignment Creation Topic]
# [https://drive.google.com/open?id=1jUQSgXjjI5jQBTWAkD8YGhYnYIIXPtnq Assignment Creation Page]

=== Coverage ===
91.6% for assignments_controller.rb

+17.7% increase overall to 42.017%

== Project Mentors ==
#Dr. Edward Gehringer (efg@ncsu.edu)
#Srujana Rachakonda (srachak@ncsu.edu)

== Team Members ==
#Colin Foley (cmfoley2@ncsu.edu)
#Ayush Khot (akhot@ncsu.edu)
#Christian Morris (cgmorris@ncsu.edu)

== References ==

#[https://github.com/expertiza/expertiza Expertiza on GitHub]