Expertiza_Wiki - User contributions [en]

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

2019-04-27T00:59:19Z

Nparanj:

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently, the instructors write hints as a part of review questions. These hints can be instructions on how to structure your review, what to include/exclude etc. These help students write constructive reviews. But this is clearly not enough. If the students could read through some sample reviews, they would gain a better understanding of how to write reviews. This project aims to do just that. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to toggle the visibility of their reviews. When reviews are marked 'public', instructors will have the option of adding them as a 'sample review' to any assignment. When reviews are marked 'private' they will not be shown to other students as a sample.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of their assignments in the course.
# Add a feature for instructors to select a subset of 'sample' reviews and set those reviews as sample reviews for a particular assignment.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.

== Implementation Details ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== Implementation ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we added a checkbox to the review page. Checking this checkbox will make the review public. Unchecking it will make the review private. When this status changes, a message is displayed next to the checkbox saying if the status was changed successfully. 

2) '''Allow students to make a review private''': Students should be able to change the visibility of their review even after they have submitted it. A checkbox similar to the one described above was implemented where students can see the reviews they have given. If a review has been made private after an instructor has selected it as a sample review, it is still not displayed to students as an example review. 

3) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor is able to select that review to be made a sample review. If the review is already a sample review, the instructor is able to remove from the set of example reviews. If the review was private, the instructor is shown a notice that 'This review is private.' and they are not allowed to select it as a sample review. This selection can be done when the instructor is viewing the review. 

4) '''Set some of selected reviews as sample for an assignment''': Sample reviews can be identified by the assignment, reviewer (a participant) and the reviewee (a team). When editing an assignment, the instructor is able to select past assignments, select a reviewer and select the reviewee. The way in which the instructor selects the assignment is to select the from a dropdown. the assignment dropdown is populated with all the assignments that the instructor has created and all the assignments that belong to the course. When the assignment is selected, the reviewer dropdown will then be populated with the names of the reviewers whose reviews have been made public and have been selected by the instructor. Once the reviewer is selected, the reviewee dropdown will get populated with names of teams to whom the review has been given. This will identify the selected review. The instructor will be able to set it as sample review for the current assignment. This means that the instructor can even set a review from any of their earlier assignments as a sample. 

5) '''Allow students to see sample reviews''': When a student wants to review other team's work, they will be shown a list of sample reviews that the instructor has selected for them. In the list each review is a link to the full review. 

=== Files that changed ===

* Create migration to create a column called status which can take on the values 'selected' = 2, 'public' = 1 and 'private' = 0. Changes will reflect in '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
! Status
! Explanation of the value
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Created a checkbox in a view: '''views/response/response.html.erb'''. To allow students to mark their reviews as public. 

* Added code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). This will reflect the choice of the student in the database. 

* The instructors will select sample reviews from a set of public reviews. The code change will be in the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* Students will be able to view sample reviews. The code change will be in the file '''list.html.erb''' which is under the '''views/student_review''' directory. 

* In order to paginate and display a list of reviews to chose from for the instructors, we will have to create partial view files. 
 

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

[[Image:UseCase.png]]

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

== DB Design ==

=== Previous work ===
A team in the Fall 18 semester had partially done this project. As per their findings, there was no association maintained between assignments. Thus it is impossible to recognize if sample reviews from a previous session of the same course can be shown students of the current session of the course. The earlier team decided to create a model to store such an association between assignments. This model contains two columns both having different assignment IDs. This means that all the selected reviews in an assignment will be shown as sample in the other assignment 

=== Our Approach ===
1) We did not want the all selected reviews in an assignment to be shown. Instead we added a facility for instructors to select individual reviews and set them as sample. Hence we created a migration where we create a model. The model has an assignment id and a response_map_id. The assignment_id is the id of the assignment for which the sample is to be shown. The response_map_id is the id of the sample review. 
2) We also added a column called visibility to the responses model which will show if the review has been marked 'private', 'public' or 'selected'. 

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

== Test Plan ==
This shows the overall flow of what the users of the system should be able to do. We will write tests such that the entire flow will be completely tested. 
'''As a Power User (TA/Instructor/Admin/Super Admin)''' (Scenario 1)
# 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 Power User (TA/Instructor/Admin/Super Admin)''' (Scenario 2)
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click Edit for a particular assignment.
# Click on the review tab.
# Select an assignment from the dropdown
# Select a reviewer from the second dropdown.
# Select a reviewee from the third dropdown.
# Click 'Add' button to add the selected review to be shown as a sample for this assignment.
# Add as many sample reviews as you want in the same way.

'''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 sample reviews" link.
# This opens a page where the student can view all sample 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.

==Screenshots of implementation==

Students are able to toggle between private and public visibility of their review.

[[File: Making_review_private_resize.png]]

[[File: Making_review_public_resize.png]]

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample 1.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample 1.png]]

The instructor is able to select a review to be shown as sample by selecting from assignment, reviewer, reviewee dropdowns.

[[File: Dropdown_before_selection_resize.png]]

Students are able to see the sample review for an assignment.
[[File: Adding_sample_reviews_to_the_assignment_resize.png]]

== Links ==
[https://youtu.be/Q1UczIJMmcE Screencast of the project] 
Enter git pull request here 

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 
[http://wiki.expertiza.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example Previous team's documentation]

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-26T21:31:39Z

Nparanj: /* Screenshots of implementation */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently, the instructors write hints as a part of review questions. These hints can be instructions on how to structure your review, what to include/exclude etc. These help students write constructive reviews. But this is clearly not enough. If the students could read through some sample reviews, they would gain a better understanding of how to write reviews. This project aims to do just that. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to toggle the visibility of their reviews. When reviews are marked 'public', instructors will have the option of adding them as a 'sample review' to any assignment. When reviews are marked 'private' they will not be shown to other students as a sample.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of their assignments in the course.
# Add a feature for instructors to select a subset of 'sample' reviews and set those reviews as sample reviews for a particular assignment.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.

== Implementation Details ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== Implementation ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we added a checkbox to the review page. Checking this checkbox will make the review public. Unchecking it will make the review private. When this status changes, a message is displayed next to the checkbox saying if the status was changed successfully. 

2) '''Allow students to make a review private''': Students should be able to change the visibility of their review even after they have submitted it. A checkbox similar to the one described above was implemented where students can see the reviews they have given. If a review has been made private after an instructor has selected it as a sample review, it is still not displayed to students as an example review. 

3) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor is able to select that review to be made a sample review. If the review is already a sample review, the instructor is able to remove from the set of example reviews. If the review was private, the instructor is shown a notice that 'This review is private.' and they are not allowed to select it as a sample review. This selection can be done when the instructor is viewing the review. 

4) '''Set some of selected reviews as sample for an assignment''': Sample reviews can be identified by the assignment, reviewer (a participant) and the reviewee (a team). When editing an assignment, the instructor is able to select past assignments, select a reviewer and select the reviewee. The way in which the instructor selects the assignment is to select the from a dropdown. the assignment dropdown is populated with all the assignments that the instructor has created and all the assignments that belong to the course. When the assignment is selected, the reviewer dropdown will then be populated with the names of the reviewers whose reviews have been made public and have been selected by the instructor. Once the reviewer is selected, the reviewee dropdown will get populated with names of teams to whom the review has been given. This will identify the selected review. The instructor will be able to set it as sample review for the current assignment. This means that the instructor can even set a review from any of their earlier assignments as a sample. 

5) '''Allow students to see sample reviews''': When a student wants to review other team's work, they will be shown a list of sample reviews that the instructor has selected for them. In the list each review is a link to the full review. 

=== Files that changed ===

* Create migration to create a column called status which can take on the values 'selected' = 2, 'public' = 1 and 'private' = 0. Changes will reflect in '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
! Status
! Explanation of the value
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Created a checkbox in a view: '''views/response/response.html.erb'''. To allow students to mark their reviews as public. 

* Added code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). This will reflect the choice of the student in the database. 

* The instructors will select sample reviews from a set of public reviews. The code change will be in the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* Students will be able to view sample reviews. The code change will be in the file '''list.html.erb''' which is under the '''views/student_review''' directory. 

* In order to paginate and display a list of reviews to chose from for the instructors, we will have to create partial view files. 
 

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

[[Image:UseCase.png]]

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

== DB Design ==

=== Previous work ===
A team in the Fall 18 semester had partially done this project. As per their findings, there was no association maintained between assignments. Thus it is impossible to recognize if sample reviews from a previous session of the same course can be shown students of the current session of the course. The earlier team decided to create a model to store such an association between assignments. This model contains two columns both having different assignment IDs. This means that all the selected reviews in an assignment will be shown as sample in the other assignment 

=== Our Approach ===
1) We did not want the all selected reviews in an assignment to be shown. Instead we added a facility for instructors to select individual reviews and set them as sample. Hence we created a migration where we create a model. The model has an assignment id and a response_map_id. The assignment_id is the id of the assignment for which the sample is to be shown. The response_map_id is the id of the sample review. 
2) We also added a column called visibility to the responses model which will show if the review has been marked 'private', 'public' or 'selected'. 

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

== Test Plan ==
This shows the overall flow of what the users of the system should be able to do. We will write tests such that the entire flow will be completely tested. 
'''As a Power User (TA/Instructor/Admin/Super Admin)''' (Scenario 1)
# 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 Power User (TA/Instructor/Admin/Super Admin)''' (Scenario 2)
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click Edit for a particular assignment.
# Click on the review tab.
# Select an assignment from the dropdown
# Select a reviewer from the second dropdown.
# Select a reviewee from the third dropdown.
# Click 'Add' button to add the selected review to be shown as a sample for this assignment.
# Add as many sample reviews as you want in the same way.

'''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 sample reviews" link.
# This opens a page where the student can view all sample 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.

==Screenshots of implementation==

Students are able to toggle between private and public visibility of their review.

[[File: Making_review_private.png]]

[[File: Making_review_public.png]]

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample 1.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample 1.png]]

The instructor is able to select a review to be shown as sample by selecting from assignment, reviewer, reviewee dropdowns.

[[File: Dropdown_before_selection.png]]

Students are able to see the sample review for an assignment.
[[File: Adding_sample_reviews_to_the_assignment.png]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 
[http://wiki.expertiza.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example Previous team's documentation]

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

File:Adding sample reviews to the assignment.png

2019-04-26T21:31:33Z

Nparanj:

File:Dropdown before selection.png

2019-04-26T21:30:15Z

Nparanj:

File:Making review public.png

2019-04-26T21:29:56Z

Nparanj:

File:Making review private.png

2019-04-26T21:28:13Z

Nparanj:

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

2019-04-26T17:34:53Z

Nparanj: /* Implementation */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently, the instructors write hints as a part of review questions. These hints can be instructions on how to structure your review, what to include/exclude etc. These help students write constructive reviews. But this is clearly not enough. If the students could read through some sample reviews, they would gain a better understanding of how to write reviews. This project aims to do just that. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to toggle the visibility of their reviews. When reviews are marked 'public', instructors will have the option of adding them as a 'sample review' to any assignment. When reviews are marked 'private' they will not be shown to other students as a sample.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of their assignments in the course.
# Add a feature for instructors to select a subset of 'sample' reviews and set those reviews as sample reviews for a particular assignment.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.

== Implementation Details ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== Implementation ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we added a checkbox to the review page. Checking this checkbox will make the review public. Unchecking it will make the review private. When this status changes, a message is displayed next to the checkbox saying if the status was changed successfully. 

2) '''Allow students to make a review private''': Students should be able to change the visibility of their review even after they have submitted it. A checkbox similar to the one described above was implemented where students can see the reviews they have given. If a review has been made private after an instructor has selected it as a sample review, it is still not displayed to students as an example review. 

3) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor is able to select that review to be made a sample review. If the review is already a sample review, the instructor is able to remove from the set of example reviews. If the review was private, the instructor is shown a notice that 'This review is private.' and they are not allowed to select it as a sample review. This selection can be done when the instructor is viewing the review. 

4) '''Set some of selected reviews as sample for an assignment''': Sample reviews can be identified by the assignment, reviewer (a participant) and the reviewee (a team). When editing an assignment, the instructor is able to select past assignments, select a reviewer and select the reviewee. The way in which the instructor selects the assignment is to select the from a dropdown. the assignment dropdown is populated with all the assignments that the instructor has created and all the assignments that belong to the course. When the assignment is selected, the reviewer dropdown will then be populated with the names of the reviewers whose reviews have been made public and have been selected by the instructor. Once the reviewer is selected, the reviewee dropdown will get populated with names of teams to whom the review has been given. This will identify the selected review. The instructor will be able to set it as sample review for the current assignment. This means that the instructor can even set a review from any of their earlier assignments as a sample. 

5) '''Allow students to see sample reviews''': When a student wants to review other team's work, they will be shown a list of sample reviews that the instructor has selected for them. In the list each review is a link to the full review. 

=== Files that changed ===

* Create migration to create a column called status which can take on the values 'selected' = 2, 'public' = 1 and 'private' = 0. Changes will reflect in '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
! Status
! Explanation of the value
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Created a checkbox in a view: '''views/response/response.html.erb'''. To allow students to mark their reviews as public. 

* Added code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). This will reflect the choice of the student in the database. 

* The instructors will select sample reviews from a set of public reviews. The code change will be in the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* Students will be able to view sample reviews. The code change will be in the file '''list.html.erb''' which is under the '''views/student_review''' directory. 

* In order to paginate and display a list of reviews to chose from for the instructors, we will have to create partial view files. 
 

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

[[Image:UseCase.png]]

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

== DB Design ==

=== Previous work ===
A team in the Fall 18 semester had partially done this project. As per their findings, there was no association maintained between assignments. Thus it is impossible to recognize if sample reviews from a previous session of the same course can be shown students of the current session of the course. The earlier team decided to create a model to store such an association between assignments. This model contains two columns both having different assignment IDs. This means that all the selected reviews in an assignment will be shown as sample in the other assignment 

=== Our Approach ===
1) We did not want the all selected reviews in an assignment to be shown. Instead we added a facility for instructors to select individual reviews and set them as sample. Hence we created a migration where we create a model. The model has an assignment id and a response_map_id. The assignment_id is the id of the assignment for which the sample is to be shown. The response_map_id is the id of the sample review. 
2) We also added a column called visibility to the responses model which will show if the review has been marked 'private', 'public' or 'selected'. 

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

== Test Plan ==
This shows the overall flow of what the users of the system should be able to do. We will write tests such that the entire flow will be completely tested. 
'''As a Power User (TA/Instructor/Admin/Super Admin)''' (Scenario 1)
# 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 Power User (TA/Instructor/Admin/Super Admin)''' (Scenario 2)
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click Edit for a particular assignment.
# Click on the review tab.
# Select an assignment from the dropdown
# Select a reviewer from the second dropdown.
# Select a reviewee from the third dropdown.
# Click 'Add' button to add the selected review to be shown as a sample for this assignment.
# Add as many sample reviews as you want in the same way.

'''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 sample reviews" link.
# This opens a page where the student can view all sample 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.

==Screenshots of implementation==

Students are able to toggle between private and public visibility of their review.

[[File:]]

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample 1.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample 1.png]]

The instructor is able to select a review to be shown as sample by selecting from assignment, reviewer, reviewee dropdowns.

[[File:]]

Students are able to see the sample review for an assignment.
[[File:]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 
[http://wiki.expertiza.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example Previous team's documentation]

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-26T16:02:54Z

Nparanj: /* Expected Output */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently, the instructors write hints as a part of review questions. These hints can be instructions on how to structure your review, what to include/exclude etc. These help students write constructive reviews. But this is clearly not enough. If the students could read through some sample reviews, they would gain a better understanding of how to write reviews. This project aims to do just that. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to toggle the visibility of their reviews. When reviews are marked 'public', instructors will have the option of adding them as a 'sample review' to any assignment. When reviews are marked 'private' they will not be shown to other students as a sample.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of their assignments in the course.
# Add a feature for instructors to select a subset of 'sample' reviews and set those reviews as sample reviews for a particular assignment.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.

== Implementation Details ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== Implementation ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we added a checkbox to the review page. Checking this checkbox will make the review public. Unchecking it will make the review private. When this status changes, a message is displayed next to the checkbox saying if the status was changed successfully. 

2) '''Allow students to make a review private''': Students should be able to change the visibility of their review even after they have submitted it. A checkbox similar to the one described above was implemented where students can see the reviews they have given. If a review has been made private after an instructor has selected it as a sample review, it is still not displayed to students as an example review. 

3) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor is able to select that review to be made a sample review. If the review is already a sample review, the instructor is able to remove from the set of example reviews. If the review was private, the instructor is shown a notice that 'This review is private.' and they are not allowed to select it as a sample review. This selection can be done when the instructor is viewing the review. 

4) '''Set some of selected reviews as sample for an assignment''': Sample reviews can be identified by the assignment, reviewer (a participant) and the reviewee (a team). When editing an assignment, the instructor is able to select past assignments, select a reviewer and select the reviewee. This will identify the selected review. The instructor will be able to set it as sample review for the current assignment. This means that the instructor can even set a review from any of their earlier assignments as sample. 

5) '''Allow students to see sample reviews''': When a student wants to review other team's work, they will be shown a list of sample reviews that the instructor has selected for them. In the list each review is a link to the full review. 

=== Files that changed ===

* Create migration to create a column called status which can take on the values 'selected' = 2, 'public' = 1 and 'private' = 0. Changes will reflect in '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
! Status
! Explanation of the value
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Created a checkbox in a view: '''views/response/response.html.erb'''. To allow students to mark their reviews as public. 

* Added code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). This will reflect the choice of the student in the database. 

* The instructors will select sample reviews from a set of public reviews. The code change will be in the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* Students will be able to view sample reviews. The code change will be in the file '''list.html.erb''' which is under the '''views/student_review''' directory. 

* In order to paginate and display a list of reviews to chose from for the instructors, we will have to create partial view files. 
 

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

[[Image:UseCase.png]]

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

== DB Design ==

=== Previous work ===
A team in the Fall 18 semester had partially done this project. As per their findings, there was no association maintained between assignments. Thus it is impossible to recognize if sample reviews from a previous session of the same course can be shown students of the current session of the course. The earlier team decided to create a model to store such an association between assignments. This model contains two columns both having different assignment IDs. This means that all the selected reviews in an assignment will be shown as sample in the other assignment 

=== Our Approach ===
1) We did not want the all selected reviews in an assignment to be shown. Instead we added a facility for instructors to select individual reviews and set them as sample. Hence we created a migration where we create a model. The model has an assignment id and a response_map_id. The assignment_id is the id of the assignment for which the sample is to be shown. The response_map_id is the id of the sample review. 
2) We also added a column called visibility to the responses model which will show if the review has been marked 'private', 'public' or 'selected'. 

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

== Test Plan ==
This shows the overall flow of what the users of the system should be able to do. We will write tests such that the entire flow will be completely tested. 
'''As a Power User (TA/Instructor/Admin/Super Admin)''' (Scenario 1)
# 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 Power User (TA/Instructor/Admin/Super Admin)''' (Scenario 2)
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click Edit for a particular assignment.
# Click on the review tab.
# Select an assignment from the dropdown
# Select a reviewer from the second dropdown.
# Select a reviewee from the third dropdown.
# Click 'Add' button to add the selected review to be shown as a sample for this assignment.
# Add as many sample reviews as you want in the same way.

'''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 sample reviews" link.
# This opens a page where the student can view all sample 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.

==Screenshots of implementation==

Students are able to toggle between private and public visibility of their review.

[[File:]]

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample 1.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample 1.png]]

The instructor is able to select a review to be shown as sample by selecting from assignment, reviewer, reviewee dropdowns.

[[File:]]

Students are able to see the sample review for an assignment.
[[File:]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 
[http://wiki.expertiza.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example Previous team's documentation]

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-26T15:58:50Z

Nparanj: /* Test Plan */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently, the instructors write hints as a part of review questions. These hints can be instructions on how to structure your review, what to include/exclude etc. These help students write constructive reviews. But this is clearly not enough. If the students could read through some sample reviews, they would gain a better understanding of how to write reviews. This project aims to do just that. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to toggle the visibility of their reviews. When reviews are marked 'public', instructors will have the option of adding them as a 'sample review' to any assignment. When reviews are marked 'private' they will not be shown to other students as a sample.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of their assignments in the course.
# Add a feature for instructors to select a subset of 'sample' reviews and set those reviews as sample reviews for a particular assignment.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.

== Implementation Details ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== Implementation ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we added a checkbox to the review page. Checking this checkbox will make the review public. Unchecking it will make the review private. When this status changes, a message is displayed next to the checkbox saying if the status was changed successfully. 

2) '''Allow students to make a review private''': Students should be able to change the visibility of their review even after they have submitted it. A checkbox similar to the one described above was implemented where students can see the reviews they have given. If a review has been made private after an instructor has selected it as a sample review, it is still not displayed to students as an example review. 

3) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor is able to select that review to be made a sample review. If the review is already a sample review, the instructor is able to remove from the set of example reviews. If the review was private, the instructor is shown a notice that 'This review is private.' and they are not allowed to select it as a sample review. This selection can be done when the instructor is viewing the review. 

4) '''Set some of selected reviews as sample for an assignment''': Sample reviews can be identified by the assignment, reviewer (a participant) and the reviewee (a team). When editing an assignment, the instructor is able to select past assignments, select a reviewer and select the reviewee. This will identify the selected review. The instructor will be able to set it as sample review for the current assignment. This means that the instructor can even set a review from any of their earlier assignments as sample. 

5) '''Allow students to see sample reviews''': When a student wants to review other team's work, they will be shown a list of sample reviews that the instructor has selected for them. In the list each review is a link to the full review. 

=== Files that changed ===

* Create migration to create a column called status which can take on the values 'selected' = 2, 'public' = 1 and 'private' = 0. Changes will reflect in '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
! Status
! Explanation of the value
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Created a checkbox in a view: '''views/response/response.html.erb'''. To allow students to mark their reviews as public. 

* Added code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). This will reflect the choice of the student in the database. 

* The instructors will select sample reviews from a set of public reviews. The code change will be in the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* Students will be able to view sample reviews. The code change will be in the file '''list.html.erb''' which is under the '''views/student_review''' directory. 

* In order to paginate and display a list of reviews to chose from for the instructors, we will have to create partial view files. 
 

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

[[Image:UseCase.png]]

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

== DB Design ==

=== Previous work ===
A team in the Fall 18 semester had partially done this project. As per their findings, there was no association maintained between assignments. Thus it is impossible to recognize if sample reviews from a previous session of the same course can be shown students of the current session of the course. The earlier team decided to create a model to store such an association between assignments. This model contains two columns both having different assignment IDs. This means that all the selected reviews in an assignment will be shown as sample in the other assignment 

=== Our Approach ===
1) We did not want the all selected reviews in an assignment to be shown. Instead we added a facility for instructors to select individual reviews and set them as sample. Hence we created a migration where we create a model. The model has an assignment id and a response_map_id. The assignment_id is the id of the assignment for which the sample is to be shown. The response_map_id is the id of the sample review. 
2) We also added a column called visibility to the responses model which will show if the review has been marked 'private', 'public' or 'selected'. 

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

== Test Plan ==
This shows the overall flow of what the users of the system should be able to do. We will write tests such that the entire flow will be completely tested. 
'''As a Power User (TA/Instructor/Admin/Super Admin)''' (Scenario 1)
# 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 Power User (TA/Instructor/Admin/Super Admin)''' (Scenario 2)
# Log in
# Click on Manage->Assignments
# Displays a list of Assignments
# Click Edit for a particular assignment.
# Click on the review tab.
# Select an assignment from the dropdown
# Select a reviewer from the second dropdown.
# Select a reviewee from the third dropdown.
# Click 'Add' button to add the selected review to be shown as a sample for this assignment.
# Add as many sample reviews as you want in the same way.

'''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 sample reviews" link.
# This opens a page where the student can view all sample 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.

==Expected Output==

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample 1.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample 1.png]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 
[http://wiki.expertiza.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example Previous team's documentation]

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-26T15:52:25Z

Nparanj: /* DB Design */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently, the instructors write hints as a part of review questions. These hints can be instructions on how to structure your review, what to include/exclude etc. These help students write constructive reviews. But this is clearly not enough. If the students could read through some sample reviews, they would gain a better understanding of how to write reviews. This project aims to do just that. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to toggle the visibility of their reviews. When reviews are marked 'public', instructors will have the option of adding them as a 'sample review' to any assignment. When reviews are marked 'private' they will not be shown to other students as a sample.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of their assignments in the course.
# Add a feature for instructors to select a subset of 'sample' reviews and set those reviews as sample reviews for a particular assignment.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.

== Implementation Details ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== Implementation ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we added a checkbox to the review page. Checking this checkbox will make the review public. Unchecking it will make the review private. When this status changes, a message is displayed next to the checkbox saying if the status was changed successfully. 

2) '''Allow students to make a review private''': Students should be able to change the visibility of their review even after they have submitted it. A checkbox similar to the one described above was implemented where students can see the reviews they have given. If a review has been made private after an instructor has selected it as a sample review, it is still not displayed to students as an example review. 

3) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor is able to select that review to be made a sample review. If the review is already a sample review, the instructor is able to remove from the set of example reviews. If the review was private, the instructor is shown a notice that 'This review is private.' and they are not allowed to select it as a sample review. This selection can be done when the instructor is viewing the review. 

4) '''Set some of selected reviews as sample for an assignment''': Sample reviews can be identified by the assignment, reviewer (a participant) and the reviewee (a team). When editing an assignment, the instructor is able to select past assignments, select a reviewer and select the reviewee. This will identify the selected review. The instructor will be able to set it as sample review for the current assignment. This means that the instructor can even set a review from any of their earlier assignments as sample. 

5) '''Allow students to see sample reviews''': When a student wants to review other team's work, they will be shown a list of sample reviews that the instructor has selected for them. In the list each review is a link to the full review. 

=== Files that changed ===

* Create migration to create a column called status which can take on the values 'selected' = 2, 'public' = 1 and 'private' = 0. Changes will reflect in '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
! Status
! Explanation of the value
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Created a checkbox in a view: '''views/response/response.html.erb'''. To allow students to mark their reviews as public. 

* Added code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). This will reflect the choice of the student in the database. 

* The instructors will select sample reviews from a set of public reviews. The code change will be in the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* Students will be able to view sample reviews. The code change will be in the file '''list.html.erb''' which is under the '''views/student_review''' directory. 

* In order to paginate and display a list of reviews to chose from for the instructors, we will have to create partial view files. 
 

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

[[Image:UseCase.png]]

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

== DB Design ==

=== Previous work ===
A team in the Fall 18 semester had partially done this project. As per their findings, there was no association maintained between assignments. Thus it is impossible to recognize if sample reviews from a previous session of the same course can be shown students of the current session of the course. The earlier team decided to create a model to store such an association between assignments. This model contains two columns both having different assignment IDs. This means that all the selected reviews in an assignment will be shown as sample in the other assignment 

=== Our Approach ===
1) We did not want the all selected reviews in an assignment to be shown. Instead we added a facility for instructors to select individual reviews and set them as sample. Hence we created a migration where we create a model. The model has an assignment id and a response_map_id. The assignment_id is the id of the assignment for which the sample is to be shown. The response_map_id is the id of the sample review. 
2) We also added a column called visibility to the responses model which will show if the review has been marked 'private', 'public' or 'selected'. 

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

== Test Plan ==
This shows the overall flow of what the users of the system should be able to do. We will write tests such that the entire flow will be completely tested. 
'''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 sample reviews" link.
# This opens a page where the student can view all sample 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.

==Expected Output==

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample 1.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample 1.png]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 
[http://wiki.expertiza.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example Previous team's documentation]

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-26T15:33:41Z

Nparanj: /* Files that will change */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently, the instructors write hints as a part of review questions. These hints can be instructions on how to structure your review, what to include/exclude etc. These help students write constructive reviews. But this is clearly not enough. If the students could read through some sample reviews, they would gain a better understanding of how to write reviews. This project aims to do just that. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to toggle the visibility of their reviews. When reviews are marked 'public', instructors will have the option of adding them as a 'sample review' to any assignment. When reviews are marked 'private' they will not be shown to other students as a sample.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of their assignments in the course.
# Add a feature for instructors to select a subset of 'sample' reviews and set those reviews as sample reviews for a particular assignment.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.

== Implementation Details ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== Implementation ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we added a checkbox to the review page. Checking this checkbox will make the review public. Unchecking it will make the review private. When this status changes, a message is displayed next to the checkbox saying if the status was changed successfully. 

2) '''Allow students to make a review private''': Students should be able to change the visibility of their review even after they have submitted it. A checkbox similar to the one described above was implemented where students can see the reviews they have given. If a review has been made private after an instructor has selected it as a sample review, it is still not displayed to students as an example review. 

3) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor is able to select that review to be made a sample review. If the review is already a sample review, the instructor is able to remove from the set of example reviews. If the review was private, the instructor is shown a notice that 'This review is private.' and they are not allowed to select it as a sample review. This selection can be done when the instructor is viewing the review. 

4) '''Set some of selected reviews as sample for an assignment''': Sample reviews can be identified by the assignment, reviewer (a participant) and the reviewee (a team). When editing an assignment, the instructor is able to select past assignments, select a reviewer and select the reviewee. This will identify the selected review. The instructor will be able to set it as sample review for the current assignment. This means that the instructor can even set a review from any of their earlier assignments as sample. 

5) '''Allow students to see sample reviews''': When a student wants to review other team's work, they will be shown a list of sample reviews that the instructor has selected for them. In the list each review is a link to the full review. 

=== Files that changed ===

* Create migration to create a column called status which can take on the values 'selected' = 2, 'public' = 1 and 'private' = 0. Changes will reflect in '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
! Status
! Explanation of the value
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Created a checkbox in a view: '''views/response/response.html.erb'''. To allow students to mark their reviews as public. 

* Added code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). This will reflect the choice of the student in the database. 

* The instructors will select sample reviews from a set of public reviews. The code change will be in the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* Students will be able to view sample reviews. The code change will be in the file '''list.html.erb''' which is under the '''views/student_review''' directory. 

* In order to paginate and display a list of reviews to chose from for the instructors, we will have to create partial view files. 
 

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

[[Image:UseCase.png]]

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

== DB Design ==

=== Previous work ===
A team in the Fall 18 semester had partially done this project. As per their findings, there was no association maintained between assignments. Thus it is impossible to recognize if sample reviews from a previous session of the same course can be shown students of the current session of the course. The earlier team decided to create a model to store such an association between assignments. 

=== Our Approach ===
Instead of creating a whole new model (and possibly a controller) we have decided to add a column to the existing '''assignments''' model. This column called '''is_similar_to''' will be used to get sample reviews from a previous assignment. This approach saves us a major schema change. Also, if an assignment is similar to multiple assignments and wants to take sample reviews from many of those assignments, we can follow the child to parent structure in the database. For example, if we find that assignment X (parent) was the earlier version of assignment Y(child) from the database, we will also look for the parent of assignment X and so on until there are no parents. Then we will find the sample reviews from that set of assignments. 

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

== Test Plan ==
This shows the overall flow of what the users of the system should be able to do. We will write tests such that the entire flow will be completely tested. 
'''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 sample reviews" link.
# This opens a page where the student can view all sample 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.

==Expected Output==

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample 1.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample 1.png]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 
[http://wiki.expertiza.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example Previous team's documentation]

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-26T15:30:45Z

Nparanj: /* Implementation */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently, the instructors write hints as a part of review questions. These hints can be instructions on how to structure your review, what to include/exclude etc. These help students write constructive reviews. But this is clearly not enough. If the students could read through some sample reviews, they would gain a better understanding of how to write reviews. This project aims to do just that. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to toggle the visibility of their reviews. When reviews are marked 'public', instructors will have the option of adding them as a 'sample review' to any assignment. When reviews are marked 'private' they will not be shown to other students as a sample.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of their assignments in the course.
# Add a feature for instructors to select a subset of 'sample' reviews and set those reviews as sample reviews for a particular assignment.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.

== Implementation Details ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== Implementation ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we added a checkbox to the review page. Checking this checkbox will make the review public. Unchecking it will make the review private. When this status changes, a message is displayed next to the checkbox saying if the status was changed successfully. 

2) '''Allow students to make a review private''': Students should be able to change the visibility of their review even after they have submitted it. A checkbox similar to the one described above was implemented where students can see the reviews they have given. If a review has been made private after an instructor has selected it as a sample review, it is still not displayed to students as an example review. 

3) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor is able to select that review to be made a sample review. If the review is already a sample review, the instructor is able to remove from the set of example reviews. If the review was private, the instructor is shown a notice that 'This review is private.' and they are not allowed to select it as a sample review. This selection can be done when the instructor is viewing the review. 

4) '''Set some of selected reviews as sample for an assignment''': Sample reviews can be identified by the assignment, reviewer (a participant) and the reviewee (a team). When editing an assignment, the instructor is able to select past assignments, select a reviewer and select the reviewee. This will identify the selected review. The instructor will be able to set it as sample review for the current assignment. This means that the instructor can even set a review from any of their earlier assignments as sample. 

5) '''Allow students to see sample reviews''': When a student wants to review other team's work, they will be shown a list of sample reviews that the instructor has selected for them. In the list each review is a link to the full review. 

=== Files that will change ===

* Create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'. Changes '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
! Status
! Explanation of the value
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Create a checkbox in a view: '''views/response/response.html.erb'''. To allow students to mark their reviews as public. 

* Add code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). This will reflect the choice of the student in the database. 

* The instructors will select sample reviews from a set of public reviews. The code change will be in the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* Students will be able to view sample reviews. The code change will be in the file '''list.html.erb''' which is under the '''views/student_review''' directory. 

* In order to paginate and display a list of reviews to chose from for the instructors, we will have to create partial view files. 
 

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

[[Image:UseCase.png]]

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

== DB Design ==

=== Previous work ===
A team in the Fall 18 semester had partially done this project. As per their findings, there was no association maintained between assignments. Thus it is impossible to recognize if sample reviews from a previous session of the same course can be shown students of the current session of the course. The earlier team decided to create a model to store such an association between assignments. 

=== Our Approach ===
Instead of creating a whole new model (and possibly a controller) we have decided to add a column to the existing '''assignments''' model. This column called '''is_similar_to''' will be used to get sample reviews from a previous assignment. This approach saves us a major schema change. Also, if an assignment is similar to multiple assignments and wants to take sample reviews from many of those assignments, we can follow the child to parent structure in the database. For example, if we find that assignment X (parent) was the earlier version of assignment Y(child) from the database, we will also look for the parent of assignment X and so on until there are no parents. Then we will find the sample reviews from that set of assignments. 

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

== Test Plan ==
This shows the overall flow of what the users of the system should be able to do. We will write tests such that the entire flow will be completely tested. 
'''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 sample reviews" link.
# This opens a page where the student can view all sample 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.

==Expected Output==

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample 1.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample 1.png]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 
[http://wiki.expertiza.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example Previous team's documentation]

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-26T15:30:01Z

Nparanj: /* What needs to be done? */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently, the instructors write hints as a part of review questions. These hints can be instructions on how to structure your review, what to include/exclude etc. These help students write constructive reviews. But this is clearly not enough. If the students could read through some sample reviews, they would gain a better understanding of how to write reviews. This project aims to do just that. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to toggle the visibility of their reviews. When reviews are marked 'public', instructors will have the option of adding them as a 'sample review' to any assignment. When reviews are marked 'private' they will not be shown to other students as a sample.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of their assignments in the course.
# Add a feature for instructors to select a subset of 'sample' reviews and set those reviews as sample reviews for a particular assignment.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.

== Implementation ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== Implementation ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we added a checkbox to the review page. Checking this checkbox will make the review public. Unchecking it will make the review private. When this status changes, a message is displayed next to the checkbox saying if the status was changed successfully. 

2) '''Allow students to make a review private''': Students should be able to change the visibility of their review even after they have submitted it. A checkbox similar to the one described above was implemented where students can see the reviews they have given. If a review has been made private after an instructor has selected it as a sample review, it is still not displayed to students as an example review. 

3) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor is able to select that review to be made a sample review. If the review is already a sample review, the instructor is able to remove from the set of example reviews. If the review was private, the instructor is shown a notice that 'This review is private.' and they are not allowed to select it as a sample review. This selection can be done when the instructor is viewing the review. 

4) '''Set some of selected reviews as sample for an assignment''': Sample reviews can be identified by the assignment, reviewer (a participant) and the reviewee (a team). When editing an assignment, the instructor is able to select past assignments, select a reviewer and select the reviewee. This will identify the selected review. The instructor will be able to set it as sample review for the current assignment. This means that the instructor can even set a review from any of their earlier assignments as sample. 

5) '''Allow students to see sample reviews''': When a student wants to review other team's work, they will be shown a list of sample reviews that the instructor has selected for them. In the list each review is a link to the full review. 

=== Files that will change ===

* Create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'. Changes '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
! Status
! Explanation of the value
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Create a checkbox in a view: '''views/response/response.html.erb'''. To allow students to mark their reviews as public. 

* Add code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). This will reflect the choice of the student in the database. 

* The instructors will select sample reviews from a set of public reviews. The code change will be in the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* Students will be able to view sample reviews. The code change will be in the file '''list.html.erb''' which is under the '''views/student_review''' directory. 

* In order to paginate and display a list of reviews to chose from for the instructors, we will have to create partial view files. 
 

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

[[Image:UseCase.png]]

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

== DB Design ==

=== Previous work ===
A team in the Fall 18 semester had partially done this project. As per their findings, there was no association maintained between assignments. Thus it is impossible to recognize if sample reviews from a previous session of the same course can be shown students of the current session of the course. The earlier team decided to create a model to store such an association between assignments. 

=== Our Approach ===
Instead of creating a whole new model (and possibly a controller) we have decided to add a column to the existing '''assignments''' model. This column called '''is_similar_to''' will be used to get sample reviews from a previous assignment. This approach saves us a major schema change. Also, if an assignment is similar to multiple assignments and wants to take sample reviews from many of those assignments, we can follow the child to parent structure in the database. For example, if we find that assignment X (parent) was the earlier version of assignment Y(child) from the database, we will also look for the parent of assignment X and so on until there are no parents. Then we will find the sample reviews from that set of assignments. 

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

== Test Plan ==
This shows the overall flow of what the users of the system should be able to do. We will write tests such that the entire flow will be completely tested. 
'''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 sample reviews" link.
# This opens a page where the student can view all sample 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.

==Expected Output==

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample 1.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample 1.png]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 
[http://wiki.expertiza.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example Previous team's documentation]

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-26T15:00:41Z

Nparanj: /* Problem Statement */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently, the instructors write hints as a part of review questions. These hints can be instructions on how to structure your review, what to include/exclude etc. These help students write constructive reviews. But this is clearly not enough. If the students could read through some sample reviews, they would gain a better understanding of how to write reviews. This project aims to do just that. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to toggle the visibility of their reviews. When reviews are marked 'public', instructors will have the option of adding them as a 'sample review' to any assignment. When reviews are marked 'private' they will not be shown to other students as a sample.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of their assignments in the course.
# Add a feature for instructors to select a subset of 'sample' reviews and set those reviews as sample reviews for a particular assignment.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.

== Implementation ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== What needs to be done? ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we are going to add a checkbox to the review page. 

2) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor will be able to select that review to be made an example review. If the review is already an example review, the instructor will be able to remove from the set of example reviews. If the review was private, the instructor will be shown a notice that 'This review is private.' and they will not be able to select it as an example review. 

3) '''Allow students to see good reviews''': When a student wants to review other team's work, they will be shown a link to sample reviews that the instructor has selected for them. The link will show them a view of the list of all sample views. 

4) '''Sample reviews need not be from the current session of a course''': When an instructor selects sample reviews, they should be shown to students in all sessions of that course even after the original session has ended. 

5) '''Allow students to make a review private''': Students should be able to make a review private even after they have made it public. If a review has been made private after an instructor has selected it as an example review, it should still not be displayed to students as an example review. 

=== Files that will change ===

* Create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'. Changes '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
! Status
! Explanation of the value
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Create a checkbox in a view: '''views/response/response.html.erb'''. To allow students to mark their reviews as public. 

* Add code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). This will reflect the choice of the student in the database. 

* The instructors will select sample reviews from a set of public reviews. The code change will be in the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* Students will be able to view sample reviews. The code change will be in the file '''list.html.erb''' which is under the '''views/student_review''' directory. 

* In order to paginate and display a list of reviews to chose from for the instructors, we will have to create partial view files. 
 

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

[[Image:UseCase.png]]

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

== DB Design ==

=== Previous work ===
A team in the Fall 18 semester had partially done this project. As per their findings, there was no association maintained between assignments. Thus it is impossible to recognize if sample reviews from a previous session of the same course can be shown students of the current session of the course. The earlier team decided to create a model to store such an association between assignments. 

=== Our Approach ===
Instead of creating a whole new model (and possibly a controller) we have decided to add a column to the existing '''assignments''' model. This column called '''is_similar_to''' will be used to get sample reviews from a previous assignment. This approach saves us a major schema change. Also, if an assignment is similar to multiple assignments and wants to take sample reviews from many of those assignments, we can follow the child to parent structure in the database. For example, if we find that assignment X (parent) was the earlier version of assignment Y(child) from the database, we will also look for the parent of assignment X and so on until there are no parents. Then we will find the sample reviews from that set of assignments. 

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

== Test Plan ==
This shows the overall flow of what the users of the system should be able to do. We will write tests such that the entire flow will be completely tested. 
'''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 sample reviews" link.
# This opens a page where the student can view all sample 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.

==Expected Output==

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample 1.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample 1.png]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 
[http://wiki.expertiza.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example Previous team's documentation]

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-26T14:40:57Z

Nparanj: /* Introduction (Reviews in Expertiza) */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently, the instructors write hints as a part of review questions. These hints can be instructions on how to structure your review, what to include/exclude etc. These help students write constructive reviews. But this is clearly not enough. If the students could read through some sample reviews, they would gain a better understanding of how to write reviews. This project aims to do just that. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to make their reviews 'public', that is, allow other students to view them.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of his/her assignments in the course.
# Add a facility when instructors are creating
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.
# Allow the student to toggle the visibility of a review they have submitted.

== Implementation ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== What needs to be done? ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we are going to add a checkbox to the review page. 

2) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor will be able to select that review to be made an example review. If the review is already an example review, the instructor will be able to remove from the set of example reviews. If the review was private, the instructor will be shown a notice that 'This review is private.' and they will not be able to select it as an example review. 

3) '''Allow students to see good reviews''': When a student wants to review other team's work, they will be shown a link to sample reviews that the instructor has selected for them. The link will show them a view of the list of all sample views. 

4) '''Sample reviews need not be from the current session of a course''': When an instructor selects sample reviews, they should be shown to students in all sessions of that course even after the original session has ended. 

5) '''Allow students to make a review private''': Students should be able to make a review private even after they have made it public. If a review has been made private after an instructor has selected it as an example review, it should still not be displayed to students as an example review. 

=== Files that will change ===

* Create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'. Changes '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
! Status
! Explanation of the value
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Create a checkbox in a view: '''views/response/response.html.erb'''. To allow students to mark their reviews as public. 

* Add code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). This will reflect the choice of the student in the database. 

* The instructors will select sample reviews from a set of public reviews. The code change will be in the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* Students will be able to view sample reviews. The code change will be in the file '''list.html.erb''' which is under the '''views/student_review''' directory. 

* In order to paginate and display a list of reviews to chose from for the instructors, we will have to create partial view files. 
 

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

[[Image:UseCase.png]]

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

== DB Design ==

=== Previous work ===
A team in the Fall 18 semester had partially done this project. As per their findings, there was no association maintained between assignments. Thus it is impossible to recognize if sample reviews from a previous session of the same course can be shown students of the current session of the course. The earlier team decided to create a model to store such an association between assignments. 

=== Our Approach ===
Instead of creating a whole new model (and possibly a controller) we have decided to add a column to the existing '''assignments''' model. This column called '''is_similar_to''' will be used to get sample reviews from a previous assignment. This approach saves us a major schema change. Also, if an assignment is similar to multiple assignments and wants to take sample reviews from many of those assignments, we can follow the child to parent structure in the database. For example, if we find that assignment X (parent) was the earlier version of assignment Y(child) from the database, we will also look for the parent of assignment X and so on until there are no parents. Then we will find the sample reviews from that set of assignments. 

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

== Test Plan ==
This shows the overall flow of what the users of the system should be able to do. We will write tests such that the entire flow will be completely tested. 
'''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 sample reviews" link.
# This opens a page where the student can view all sample 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.

==Expected Output==

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample 1.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample 1.png]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 
[http://wiki.expertiza.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example Previous team's documentation]

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-16T00:05:37Z

Nparanj: /* Problem Statement */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently the students can only see what review their team got for their work. The instructors can see who reviewed each team and the review they gave. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to make their reviews 'public', that is, allow other students to view them.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of his/her assignments in the course.
# Add a facility when instructors are creating
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.
# Allow the student to toggle the visibility of a review they have submitted.

== Implementation ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== What needs to be done? ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we are going to add a checkbox to the review page. 

2) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor will be able to select that review to be made an example review. If the review is already an example review, the instructor will be able to remove from the set of example reviews. If the review was private, the instructor will be shown a notice that 'This review is private.' and they will not be able to select it as an example review. 

3) '''Allow students to see good reviews''': When a student wants to review other team's work, they will be shown a link to sample reviews that the instructor has selected for them. The link will show them a view of the list of all sample views. 

4) '''Sample reviews need not be from the current session of a course''': When an instructor selects sample reviews, they should be shown to students in all sessions of that course even after the original session has ended. 

5) '''Allow students to make a review private''': Students should be able to make a review private even after they have made it public. If a review has been made private after an instructor has selected it as an example review, it should still not be displayed to students as an example review. 

=== Files that will change ===

* Create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'. Changes '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
! Status
! Explanation of the value
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Create a checkbox in a view: '''views/response/response.html.erb'''. To allow students to mark their reviews as public. 

* Add code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). This will reflect the choice of the student in the database. 

* The instructors will select sample reviews from a set of public reviews. The code change will be in the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* Students will be able to view sample reviews. The code change will be in the file '''list.html.erb''' which is under the '''views/student_review''' directory. 

* In order to paginate and display a list of reviews to chose from for the instructors, we will have to create partial view files. 
 

== DB Design ==

=== Previous work ===
A team in the Fall 18 semester had partially done this project. As per their findings, there was no association maintained between assignments. Thus it is impossible to recognize if sample reviews from a previous session of the same course can be shown students of the current session of the course. The earlier team decided to create a model to store such an association between assignments. 

=== Our Approach ===
Instead of creating a whole new model (and possibly a controller) we have decided to add a column to the existing '''assignments''' model. This column called '''is_similar_to''' will be used to get sample reviews from a previous assignment. This approach saves us a major schema change. Also, if an assignment is similar to multiple assignments and wants to take sample reviews from many of those assignments, we can follow the child to parent structure in the database. For example, if we find that assignment X (parent) was the earlier version of assignment Y(child) from the database, we will also look for the parent of assignment X and so on until there are no parents. Then we will find the sample reviews from that set of assignments. 

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

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

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

'''As a Student'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# 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.

==Expected Output==

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample 1.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample 1.png]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 
[http://wiki.expertiza.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example Previous team's documentation]

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-13T03:54:41Z

Nparanj: /* Files that will change */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently the students can only see what review their team got for their work. The instructors can see who reviewed each team and the review they gave. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to make their reviews 'public', that is, allow other students to view them.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of his/her assignments in the course.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.
# Allow the student to toggle the visibility of a review they have submitted.

== Implementation ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== What needs to be done? ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we are going to add a checkbox to the review page. 

2) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor will be able to select that review to be made an example review. If the review is already an example review, the instructor will be able to remove from the set of example reviews. If the review was private, the instructor will be shown a notice that 'This review is private.' and they will not be able to select it as an example review. 

3) '''Allow students to see good reviews''': When a student wants to review other team's work, they will be shown a link to sample reviews that the instructor has selected for them. The link will show them a view of the list of all sample views. 

4) '''Sample reviews need not be from the current session of a course''': When an instructor selects sample reviews, they should be shown to students in all sessions of that course even after the original session has ended. 

5) '''Allow students to make a review private''': Students should be able to make a review private even after they have made it public. If a review has been made private after an instructor has selected it as an example review, it should still not be displayed to students as an example review. 

=== Files that will change ===

* Create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'. Changes '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
! Status
! Explanation of the value
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Create a checkbox in a view: '''views/response/response.html.erb'''. To allow students to mark their reviews as public. 

* Add code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). This will reflect the choice of the student in the database. 

* The instructors will select sample reviews from a set of public reviews. The code change will be in the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* Students will be able to view sample reviews. The code change will be in the file '''list.html.erb''' which is under the '''views/student_review''' directory. 

* In order to paginate and display a list of reviews to chose from for the instructors, we will have to create partial view files. 
 

== DB Design ==

=== Previous work ===
A team in the Fall 18 semester had partially done this project. As per their findings, there was no association maintained between assignments. Thus it is impossible to recognize if sample reviews from a previous session of the same course can be shown students of the current session of the course. The earlier team decided to create a model to store such an association between assignments. 

=== Our Approach ===
Instead of creating a whole new model (and possibly a controller) we have decided to add a column to the existing '''assignments''' model. This column called '''is_similar_to''' will be used to get sample reviews from a previous assignment. This approach saves us a major schema change. Also, if an assignment is similar to multiple assignments and wants to take sample reviews from many of those assignments, we can follow the child to parent structure in the database. For example, if we find that assignment X (parent) was the earlier version of assignment Y(child) from the database, we will also look for the parent of assignment X and so on until there are no parents. Then we will find the sample reviews from that set of assignments. 

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

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

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

'''As a Student'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# 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.

==Expected Output==

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample.png]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 
[http://wiki.expertiza.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example Earlier team's documentation]

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-13T03:54:22Z

Nparanj: /* Files that will change */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently the students can only see what review their team got for their work. The instructors can see who reviewed each team and the review they gave. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to make their reviews 'public', that is, allow other students to view them.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of his/her assignments in the course.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.
# Allow the student to toggle the visibility of a review they have submitted.

== Implementation ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== What needs to be done? ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we are going to add a checkbox to the review page. 

2) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor will be able to select that review to be made an example review. If the review is already an example review, the instructor will be able to remove from the set of example reviews. If the review was private, the instructor will be shown a notice that 'This review is private.' and they will not be able to select it as an example review. 

3) '''Allow students to see good reviews''': When a student wants to review other team's work, they will be shown a link to sample reviews that the instructor has selected for them. The link will show them a view of the list of all sample views. 

4) '''Sample reviews need not be from the current session of a course''': When an instructor selects sample reviews, they should be shown to students in all sessions of that course even after the original session has ended. 

5) '''Allow students to make a review private''': Students should be able to make a review private even after they have made it public. If a review has been made private after an instructor has selected it as an example review, it should still not be displayed to students as an example review. 

=== Files that will change ===

* Create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'. Changes '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
! Status
! Explanation of the value
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Create a checkbox in a view: '''views/response/response.html.erb'''. To allow students to mark their reviews as public. 

* Add code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). This will reflect the choice of the student in the database. 

* The instructors will select sample reviews from a set of public reviews. The code change will be in the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* Students will be able to view sample reviews. The code change will be in the file '''list.html.erb''' which is under the '''views/student_review''' directory. 

* In order to paginate and display a list of reviews to chose from for the instructors, we will have to create partial view files. 

== DB Design ==

=== Previous work ===
A team in the Fall 18 semester had partially done this project. As per their findings, there was no association maintained between assignments. Thus it is impossible to recognize if sample reviews from a previous session of the same course can be shown students of the current session of the course. The earlier team decided to create a model to store such an association between assignments. 

=== Our Approach ===
Instead of creating a whole new model (and possibly a controller) we have decided to add a column to the existing '''assignments''' model. This column called '''is_similar_to''' will be used to get sample reviews from a previous assignment. This approach saves us a major schema change. Also, if an assignment is similar to multiple assignments and wants to take sample reviews from many of those assignments, we can follow the child to parent structure in the database. For example, if we find that assignment X (parent) was the earlier version of assignment Y(child) from the database, we will also look for the parent of assignment X and so on until there are no parents. Then we will find the sample reviews from that set of assignments. 

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

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

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

'''As a Student'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# 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.

==Expected Output==

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample.png]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 
[http://wiki.expertiza.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example Earlier team's documentation]

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-13T03:53:56Z

Nparanj: /* Files that will change */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently the students can only see what review their team got for their work. The instructors can see who reviewed each team and the review they gave. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to make their reviews 'public', that is, allow other students to view them.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of his/her assignments in the course.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.
# Allow the student to toggle the visibility of a review they have submitted.

== Implementation ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== What needs to be done? ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we are going to add a checkbox to the review page. 

2) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor will be able to select that review to be made an example review. If the review is already an example review, the instructor will be able to remove from the set of example reviews. If the review was private, the instructor will be shown a notice that 'This review is private.' and they will not be able to select it as an example review. 

3) '''Allow students to see good reviews''': When a student wants to review other team's work, they will be shown a link to sample reviews that the instructor has selected for them. The link will show them a view of the list of all sample views. 

4) '''Sample reviews need not be from the current session of a course''': When an instructor selects sample reviews, they should be shown to students in all sessions of that course even after the original session has ended. 

5) '''Allow students to make a review private''': Students should be able to make a review private even after they have made it public. If a review has been made private after an instructor has selected it as an example review, it should still not be displayed to students as an example review. 

=== Files that will change ===

* Create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'. Changes '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
! Status
! Properties
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Create a checkbox in a view: '''views/response/response.html.erb'''. To allow students to mark their reviews as public. 

* Add code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). This will reflect the choice of the student in the database. 

* The instructors will select sample reviews from a set of public reviews. The code change will be in the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* Students will be able to view sample reviews. The code change will be in the file '''list.html.erb''' which is under the '''views/student_review''' directory. 

* In order to paginate and display a list of reviews to chose from for the instructors, we will have to create partial view files. 

== DB Design ==

=== Previous work ===
A team in the Fall 18 semester had partially done this project. As per their findings, there was no association maintained between assignments. Thus it is impossible to recognize if sample reviews from a previous session of the same course can be shown students of the current session of the course. The earlier team decided to create a model to store such an association between assignments. 

=== Our Approach ===
Instead of creating a whole new model (and possibly a controller) we have decided to add a column to the existing '''assignments''' model. This column called '''is_similar_to''' will be used to get sample reviews from a previous assignment. This approach saves us a major schema change. Also, if an assignment is similar to multiple assignments and wants to take sample reviews from many of those assignments, we can follow the child to parent structure in the database. For example, if we find that assignment X (parent) was the earlier version of assignment Y(child) from the database, we will also look for the parent of assignment X and so on until there are no parents. Then we will find the sample reviews from that set of assignments. 

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

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

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

'''As a Student'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# 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.

==Expected Output==

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample.png]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 
[http://wiki.expertiza.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example Earlier team's documentation]

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-13T03:52:26Z

Nparanj: /* References */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently the students can only see what review their team got for their work. The instructors can see who reviewed each team and the review they gave. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to make their reviews 'public', that is, allow other students to view them.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of his/her assignments in the course.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.
# Allow the student to toggle the visibility of a review they have submitted.

== Implementation ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== What needs to be done? ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we are going to add a checkbox to the review page. 

2) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor will be able to select that review to be made an example review. If the review is already an example review, the instructor will be able to remove from the set of example reviews. If the review was private, the instructor will be shown a notice that 'This review is private.' and they will not be able to select it as an example review. 

3) '''Allow students to see good reviews''': When a student wants to review other team's work, they will be shown a link to sample reviews that the instructor has selected for them. The link will show them a view of the list of all sample views. 

4) '''Sample reviews need not be from the current session of a course''': When an instructor selects sample reviews, they should be shown to students in all sessions of that course even after the original session has ended. 

5) '''Allow students to make a review private''': Students should be able to make a review private even after they have made it public. If a review has been made private after an instructor has selected it as an example review, it should still not be displayed to students as an example review. 

=== Files that will change ===

* Create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'. Changes '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
|+ Table showing list of status values and the properties
! Status
! Properties
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Create a checkbox in a view: '''views/response/response.html.erb'''. To allow students to mark their reviews as public. 

* Add code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). This will reflect the choice of the student in the database. 

* The instructors will select sample reviews from a set of public reviews. The code change will be in the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* Students will be able to view sample reviews. The code change will be in the file '''list.html.erb''' which is under the '''views/student_review''' directory. 

* In order to paginate and display a list of reviews to chose from for the instructors, we will have to create partial view files. 

== DB Design ==

=== Previous work ===
A team in the Fall 18 semester had partially done this project. As per their findings, there was no association maintained between assignments. Thus it is impossible to recognize if sample reviews from a previous session of the same course can be shown students of the current session of the course. The earlier team decided to create a model to store such an association between assignments. 

=== Our Approach ===
Instead of creating a whole new model (and possibly a controller) we have decided to add a column to the existing '''assignments''' model. This column called '''is_similar_to''' will be used to get sample reviews from a previous assignment. This approach saves us a major schema change. Also, if an assignment is similar to multiple assignments and wants to take sample reviews from many of those assignments, we can follow the child to parent structure in the database. For example, if we find that assignment X (parent) was the earlier version of assignment Y(child) from the database, we will also look for the parent of assignment X and so on until there are no parents. Then we will find the sample reviews from that set of assignments. 

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

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

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

'''As a Student'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# 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.

==Expected Output==

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample.png]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 
[http://wiki.expertiza.ncsu.edu/index.php/E1867_allow_reviewer_to_say_review_can_be_shown_to_class_as_an_example Earlier team's documentation]

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-13T03:40:20Z

Nparanj: /* Test Plan */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently the students can only see what review their team got for their work. The instructors can see who reviewed each team and the review they gave. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to make their reviews 'public', that is, allow other students to view them.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of his/her assignments in the course.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.
# Allow the student to toggle the visibility of a review they have submitted.

== Implementation ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== What needs to be done? ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we are going to add a checkbox to the review page. 

2) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor will be able to select that review to be made an example review. If the review is already an example review, the instructor will be able to remove from the set of example reviews. If the review was private, the instructor will be shown a notice that 'This review is private.' and they will not be able to select it as an example review. 

3) '''Allow students to see good reviews''': When a student wants to review other team's work, they will be shown a link to sample reviews that the instructor has selected for them. The link will show them a view of the list of all sample views. 

4) '''Sample reviews need not be from the current session of a course''': When an instructor selects sample reviews, they should be shown to students in all sessions of that course even after the original session has ended. 

5) '''Allow students to make a review private''': Students should be able to make a review private even after they have made it public. If a review has been made private after an instructor has selected it as an example review, it should still not be displayed to students as an example review. 

=== Files that will change ===

* Create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'. Changes '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
|+ Table showing list of status values and the properties
! Status
! Properties
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Create a checkbox in a view: '''views/response/response.html.erb'''. To allow students to mark their reviews as public. 

* Add code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). This will reflect the choice of the student in the database. 

* The instructors will select sample reviews from a set of public reviews. The code change will be in the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* Students will be able to view sample reviews. The code change will be in the file '''list.html.erb''' which is under the '''views/student_review''' directory. 

* In order to paginate and display a list of reviews to chose from for the instructors, we will have to create partial view files. 

== DB Design ==

=== Previous work ===
A team in the Fall 18 semester had partially done this project. As per their findings, there was no association maintained between assignments. Thus it is impossible to recognize if sample reviews from a previous session of the same course can be shown students of the current session of the course. The earlier team decided to create a model to store such an association between assignments. 

=== Our Approach ===
Instead of creating a whole new model (and possibly a controller) we have decided to add a column to the existing '''assignments''' model. This column called '''is_similar_to''' will be used to get sample reviews from a previous assignment. This approach saves us a major schema change. Also, if an assignment is similar to multiple assignments and wants to take sample reviews from many of those assignments, we can follow the child to parent structure in the database. For example, if we find that assignment X (parent) was the earlier version of assignment Y(child) from the database, we will also look for the parent of assignment X and so on until there are no parents. Then we will find the sample reviews from that set of assignments. 

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

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

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

'''As a Student'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# 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.

==Expected Output==

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample.png]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-13T03:37:27Z

Nparanj: /* Design Pattern */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently the students can only see what review their team got for their work. The instructors can see who reviewed each team and the review they gave. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to make their reviews 'public', that is, allow other students to view them.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of his/her assignments in the course.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.
# Allow the student to toggle the visibility of a review they have submitted.

== Implementation ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== What needs to be done? ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we are going to add a checkbox to the review page. 

2) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor will be able to select that review to be made an example review. If the review is already an example review, the instructor will be able to remove from the set of example reviews. If the review was private, the instructor will be shown a notice that 'This review is private.' and they will not be able to select it as an example review. 

3) '''Allow students to see good reviews''': When a student wants to review other team's work, they will be shown a link to sample reviews that the instructor has selected for them. The link will show them a view of the list of all sample views. 

4) '''Sample reviews need not be from the current session of a course''': When an instructor selects sample reviews, they should be shown to students in all sessions of that course even after the original session has ended. 

5) '''Allow students to make a review private''': Students should be able to make a review private even after they have made it public. If a review has been made private after an instructor has selected it as an example review, it should still not be displayed to students as an example review. 

=== Files that will change ===

* Create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'. Changes '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
|+ Table showing list of status values and the properties
! Status
! Properties
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Create a checkbox in a view: '''views/response/response.html.erb'''. To allow students to mark their reviews as public. 

* Add code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). This will reflect the choice of the student in the database. 

* The instructors will select sample reviews from a set of public reviews. The code change will be in the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* Students will be able to view sample reviews. The code change will be in the file '''list.html.erb''' which is under the '''views/student_review''' directory. 

* In order to paginate and display a list of reviews to chose from for the instructors, we will have to create partial view files. 

== DB Design ==

=== Previous work ===
A team in the Fall 18 semester had partially done this project. As per their findings, there was no association maintained between assignments. Thus it is impossible to recognize if sample reviews from a previous session of the same course can be shown students of the current session of the course. The earlier team decided to create a model to store such an association between assignments. 

=== Our Approach ===
Instead of creating a whole new model (and possibly a controller) we have decided to add a column to the existing '''assignments''' model. This column called '''is_similar_to''' will be used to get sample reviews from a previous assignment. This approach saves us a major schema change. Also, if an assignment is similar to multiple assignments and wants to take sample reviews from many of those assignments, we can follow the child to parent structure in the database. For example, if we find that assignment X (parent) was the earlier version of assignment Y(child) from the database, we will also look for the parent of assignment X and so on until there are no parents. Then we will find the sample reviews from that set of assignments. 

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

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

'''As a Student'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Show sample reviews" link.
# This opens a page where the student can view all sample reviews for that assignment.
# Use the browser's back button to go back to the Assignment review page.
# 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.

==Expected Output==

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample.png]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-13T03:37:02Z

Nparanj: /* New work (along with changes) */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently the students can only see what review their team got for their work. The instructors can see who reviewed each team and the review they gave. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to make their reviews 'public', that is, allow other students to view them.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of his/her assignments in the course.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.
# Allow the student to toggle the visibility of a review they have submitted.

== Implementation ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== What needs to be done? ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we are going to add a checkbox to the review page. 

2) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor will be able to select that review to be made an example review. If the review is already an example review, the instructor will be able to remove from the set of example reviews. If the review was private, the instructor will be shown a notice that 'This review is private.' and they will not be able to select it as an example review. 

3) '''Allow students to see good reviews''': When a student wants to review other team's work, they will be shown a link to sample reviews that the instructor has selected for them. The link will show them a view of the list of all sample views. 

4) '''Sample reviews need not be from the current session of a course''': When an instructor selects sample reviews, they should be shown to students in all sessions of that course even after the original session has ended. 

5) '''Allow students to make a review private''': Students should be able to make a review private even after they have made it public. If a review has been made private after an instructor has selected it as an example review, it should still not be displayed to students as an example review. 

=== Files that will change ===

* Create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'. Changes '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
|+ Table showing list of status values and the properties
! Status
! Properties
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Create a checkbox in a view: '''views/response/response.html.erb'''. To allow students to mark their reviews as public. 

* Add code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). This will reflect the choice of the student in the database. 

* The instructors will select sample reviews from a set of public reviews. The code change will be in the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* Students will be able to view sample reviews. The code change will be in the file '''list.html.erb''' which is under the '''views/student_review''' directory. 

* In order to paginate and display a list of reviews to chose from for the instructors, we will have to create partial view files. 

== DB Design ==

=== Previous work ===
A team in the Fall 18 semester had partially done this project. As per their findings, there was no association maintained between assignments. Thus it is impossible to recognize if sample reviews from a previous session of the same course can be shown students of the current session of the course. The earlier team decided to create a model to store such an association between assignments. 

=== Our Approach ===
Instead of creating a whole new model (and possibly a controller) we have decided to add a column to the existing '''assignments''' model. This column called '''is_similar_to''' will be used to get sample reviews from a previous assignment. This approach saves us a major schema change. Also, if an assignment is similar to multiple assignments and wants to take sample reviews from many of those assignments, we can follow the child to parent structure in the database. For example, if we find that assignment X (parent) was the earlier version of assignment Y(child) from the database, we will also look for the parent of assignment X and so on until there are no parents. Then we will find the sample reviews from that set of assignments. 

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

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

'''As a Student'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Show sample reviews" link.
# This opens a page where the student can view all sample reviews for that assignment.
# Use the browser's back button to go back to the Assignment review page.
# 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.

==Expected Output==

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample.png]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-13T03:29:50Z

Nparanj: /* Previous work */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently the students can only see what review their team got for their work. The instructors can see who reviewed each team and the review they gave. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to make their reviews 'public', that is, allow other students to view them.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of his/her assignments in the course.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.
# Allow the student to toggle the visibility of a review they have submitted.

== Implementation ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== What needs to be done? ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we are going to add a checkbox to the review page. 

2) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor will be able to select that review to be made an example review. If the review is already an example review, the instructor will be able to remove from the set of example reviews. If the review was private, the instructor will be shown a notice that 'This review is private.' and they will not be able to select it as an example review. 

3) '''Allow students to see good reviews''': When a student wants to review other team's work, they will be shown a link to sample reviews that the instructor has selected for them. The link will show them a view of the list of all sample views. 

4) '''Sample reviews need not be from the current session of a course''': When an instructor selects sample reviews, they should be shown to students in all sessions of that course even after the original session has ended. 

5) '''Allow students to make a review private''': Students should be able to make a review private even after they have made it public. If a review has been made private after an instructor has selected it as an example review, it should still not be displayed to students as an example review. 

=== Files that will change ===

* Create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'. Changes '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
|+ Table showing list of status values and the properties
! Status
! Properties
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Create a checkbox in a view: '''views/response/response.html.erb'''. To allow students to mark their reviews as public. 

* Add code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). This will reflect the choice of the student in the database. 

* The instructors will select sample reviews from a set of public reviews. The code change will be in the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* Students will be able to view sample reviews. The code change will be in the file '''list.html.erb''' which is under the '''views/student_review''' directory. 

* In order to paginate and display a list of reviews to chose from for the instructors, we will have to create partial view files. 

== DB Design ==

=== Previous work ===
A team in the Fall 18 semester had partially done this project. As per their findings, there was no association maintained between assignments. Thus it is impossible to recognize if sample reviews from a previous session of the same course can be shown students of the current session of the course. The earlier team decided to create a model to store such an association between assignments. 

=== New work (along with changes) ===

Most of the design used by the team will be used as it is but there will be some major change in the design, The change is mentioned as follows:

The previous team had created an entire table, that is made major changes in the database which lead to creating a new model, view and controller. This may lead to some major problems which can affect the other functionalities.

We are preventing that by a different approach. We have decided to use the '''assignments''' table itself and just add an extra field called '''is_similar_for'''. This will be used to get the sample reviews from previous similar assignments that were assigned to students. Accordingly, changes will be made that are related to assignments.

The advantage of using this design is that some of the code which is already available can be reused. No new code will be added that was previously existing.

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

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

'''As a Student'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Show sample reviews" link.
# This opens a page where the student can view all sample reviews for that assignment.
# Use the browser's back button to go back to the Assignment review page.
# 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.

==Expected Output==

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample.png]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-13T03:25:07Z

Nparanj: /* Files that will change */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently the students can only see what review their team got for their work. The instructors can see who reviewed each team and the review they gave. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to make their reviews 'public', that is, allow other students to view them.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of his/her assignments in the course.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.
# Allow the student to toggle the visibility of a review they have submitted.

== Implementation ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== What needs to be done? ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we are going to add a checkbox to the review page. 

2) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor will be able to select that review to be made an example review. If the review is already an example review, the instructor will be able to remove from the set of example reviews. If the review was private, the instructor will be shown a notice that 'This review is private.' and they will not be able to select it as an example review. 

3) '''Allow students to see good reviews''': When a student wants to review other team's work, they will be shown a link to sample reviews that the instructor has selected for them. The link will show them a view of the list of all sample views. 

4) '''Sample reviews need not be from the current session of a course''': When an instructor selects sample reviews, they should be shown to students in all sessions of that course even after the original session has ended. 

5) '''Allow students to make a review private''': Students should be able to make a review private even after they have made it public. If a review has been made private after an instructor has selected it as an example review, it should still not be displayed to students as an example review. 

=== Files that will change ===

* Create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'. Changes '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
|+ Table showing list of status values and the properties
! Status
! Properties
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Create a checkbox in a view: '''views/response/response.html.erb'''. To allow students to mark their reviews as public. 

* Add code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). This will reflect the choice of the student in the database. 

* The instructors will select sample reviews from a set of public reviews. The code change will be in the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* Students will be able to view sample reviews. The code change will be in the file '''list.html.erb''' which is under the '''views/student_review''' directory. 

* In order to paginate and display a list of reviews to chose from for the instructors, we will have to create partial view files. 

== DB Design ==

=== Previous work ===

Currently, the Expertiza database design does not maintain any link between different assignments. An assignment of the current semester is completely independent of any other assignment of any other course having similar or exact objectives. For example, in a course C, the assignment named A1 in a semester Sx has no association to the same assignment given in an earlier semester Sy.

Since our task involves using reviews from the past as samples for the present, we should create this association as a new table. Further, reviews may not be the only intention to associate assignments with each other, as future requirements might require associating them on other criteria too. Thus, we find it appropriate to name the table as "similar_assignments".

The table structure is defined [http://wiki.expertiza.ncsu.edu/index.php/Similar_assignments here].

This table can be visualized as a directed graph where vertices represent assignments. An edge (u,v) with a label L means u is similar to v for the intent of association, L.

Consider a row (id = x, assignment_id = Ak, is_similar_for = An, association_intent = "review"). This means, given the intent of association as "review", assignment Ak was chosen as a similar assignment for assignment An. That is, while marking some review for An as a sample, the instructor opted to have reviews of Ak as samples for An as well.

=== New work (along with changes) ===

Most of the design used by the team will be used as it is but there will be some major change in the design, The change is mentioned as follows:

The previous team had created an entire table, that is made major changes in the database which lead to creating a new model, view and controller. This may lead to some major problems which can affect the other functionalities.

We are preventing that by a different approach. We have decided to use the '''assignments''' table itself and just add an extra field called '''is_similar_for'''. This will be used to get the sample reviews from previous similar assignments that were assigned to students. Accordingly, changes will be made that are related to assignments.

The advantage of using this design is that some of the code which is already available can be reused. No new code will be added that was previously existing.

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

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

'''As a Student'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Show sample reviews" link.
# This opens a page where the student can view all sample reviews for that assignment.
# Use the browser's back button to go back to the Assignment review page.
# 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.

==Expected Output==

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample.png]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-13T03:24:33Z

Nparanj: /* Files that will change */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently the students can only see what review their team got for their work. The instructors can see who reviewed each team and the review they gave. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to make their reviews 'public', that is, allow other students to view them.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of his/her assignments in the course.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.
# Allow the student to toggle the visibility of a review they have submitted.

== Implementation ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== What needs to be done? ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we are going to add a checkbox to the review page. 

2) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor will be able to select that review to be made an example review. If the review is already an example review, the instructor will be able to remove from the set of example reviews. If the review was private, the instructor will be shown a notice that 'This review is private.' and they will not be able to select it as an example review. 

3) '''Allow students to see good reviews''': When a student wants to review other team's work, they will be shown a link to sample reviews that the instructor has selected for them. The link will show them a view of the list of all sample views. 

4) '''Sample reviews need not be from the current session of a course''': When an instructor selects sample reviews, they should be shown to students in all sessions of that course even after the original session has ended. 

5) '''Allow students to make a review private''': Students should be able to make a review private even after they have made it public. If a review has been made private after an instructor has selected it as an example review, it should still not be displayed to students as an example review. 

=== Files that will change ===

* Create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'. Changes '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
|+ Table showing list of status values and the properties
! Status
! Properties
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Create a checkbox in a view: '''views/response/response.html.erb'''. To allow students to mark their reviews as public. 

* Add code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). This will reflect the choice of the student in the database. 

* The instructors will select sample reviews from a set of public reviews. The code change will be in the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* Students will be able to view sample reviews. The code change will be in the file '''list.html.erb''' which is under the '''views/student_review''' directory. 

* In order to paginate and display a list of reviews to chose from for the instructors, we will have to create partial view files.

== DB Design ==

=== Previous work ===

Currently, the Expertiza database design does not maintain any link between different assignments. An assignment of the current semester is completely independent of any other assignment of any other course having similar or exact objectives. For example, in a course C, the assignment named A1 in a semester Sx has no association to the same assignment given in an earlier semester Sy.

Since our task involves using reviews from the past as samples for the present, we should create this association as a new table. Further, reviews may not be the only intention to associate assignments with each other, as future requirements might require associating them on other criteria too. Thus, we find it appropriate to name the table as "similar_assignments".

The table structure is defined [http://wiki.expertiza.ncsu.edu/index.php/Similar_assignments here].

This table can be visualized as a directed graph where vertices represent assignments. An edge (u,v) with a label L means u is similar to v for the intent of association, L.

Consider a row (id = x, assignment_id = Ak, is_similar_for = An, association_intent = "review"). This means, given the intent of association as "review", assignment Ak was chosen as a similar assignment for assignment An. That is, while marking some review for An as a sample, the instructor opted to have reviews of Ak as samples for An as well.

=== New work (along with changes) ===

Most of the design used by the team will be used as it is but there will be some major change in the design, The change is mentioned as follows:

The previous team had created an entire table, that is made major changes in the database which lead to creating a new model, view and controller. This may lead to some major problems which can affect the other functionalities.

We are preventing that by a different approach. We have decided to use the '''assignments''' table itself and just add an extra field called '''is_similar_for'''. This will be used to get the sample reviews from previous similar assignments that were assigned to students. Accordingly, changes will be made that are related to assignments.

The advantage of using this design is that some of the code which is already available can be reused. No new code will be added that was previously existing.

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

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

'''As a Student'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Show sample reviews" link.
# This opens a page where the student can view all sample reviews for that assignment.
# Use the browser's back button to go back to the Assignment review page.
# 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.

==Expected Output==

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample.png]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-13T03:18:17Z

Nparanj: /* Files that will change */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently the students can only see what review their team got for their work. The instructors can see who reviewed each team and the review they gave. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to make their reviews 'public', that is, allow other students to view them.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of his/her assignments in the course.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.
# Allow the student to toggle the visibility of a review they have submitted.

== Implementation ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== What needs to be done? ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we are going to add a checkbox to the review page. 

2) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor will be able to select that review to be made an example review. If the review is already an example review, the instructor will be able to remove from the set of example reviews. If the review was private, the instructor will be shown a notice that 'This review is private.' and they will not be able to select it as an example review. 

3) '''Allow students to see good reviews''': When a student wants to review other team's work, they will be shown a link to sample reviews that the instructor has selected for them. The link will show them a view of the list of all sample views. 

4) '''Sample reviews need not be from the current session of a course''': When an instructor selects sample reviews, they should be shown to students in all sessions of that course even after the original session has ended. 

5) '''Allow students to make a review private''': Students should be able to make a review private even after they have made it public. If a review has been made private after an instructor has selected it as an example review, it should still not be displayed to students as an example review. 

=== Files that will change ===

* Create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'. Changes '''db/schema.rb''' 
Status can have 3 values as listed below:

{| class="wikitable"
|+ Table showing list of status values and the properties
! Status
! Properties
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response is marked public by the student but has not been selected as a sample review by the instructors.
|-
| 2 || The response has been selected as a sample by the instructors.
|-
|}

* Create a checkbox in a view: '''views/response/response.html.erb'''. 

* Add code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). 

* For the instructors to carry out the tasks of selecting reviews, the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* For the other participants to view the sample reviews, the file '''list.html.erb''' which is under the '''views/student_review''' directory.

* A new partial file will be created in various views possibly a helper for '''response_controller.rb'''.

== DB Design ==

=== Previous work ===

Currently, the Expertiza database design does not maintain any link between different assignments. An assignment of the current semester is completely independent of any other assignment of any other course having similar or exact objectives. For example, in a course C, the assignment named A1 in a semester Sx has no association to the same assignment given in an earlier semester Sy.

Since our task involves using reviews from the past as samples for the present, we should create this association as a new table. Further, reviews may not be the only intention to associate assignments with each other, as future requirements might require associating them on other criteria too. Thus, we find it appropriate to name the table as "similar_assignments".

The table structure is defined [http://wiki.expertiza.ncsu.edu/index.php/Similar_assignments here].

This table can be visualized as a directed graph where vertices represent assignments. An edge (u,v) with a label L means u is similar to v for the intent of association, L.

Consider a row (id = x, assignment_id = Ak, is_similar_for = An, association_intent = "review"). This means, given the intent of association as "review", assignment Ak was chosen as a similar assignment for assignment An. That is, while marking some review for An as a sample, the instructor opted to have reviews of Ak as samples for An as well.

=== New work (along with changes) ===

Most of the design used by the team will be used as it is but there will be some major change in the design, The change is mentioned as follows:

The previous team had created an entire table, that is made major changes in the database which lead to creating a new model, view and controller. This may lead to some major problems which can affect the other functionalities.

We are preventing that by a different approach. We have decided to use the '''assignments''' table itself and just add an extra field called '''is_similar_for'''. This will be used to get the sample reviews from previous similar assignments that were assigned to students. Accordingly, changes will be made that are related to assignments.

The advantage of using this design is that some of the code which is already available can be reused. No new code will be added that was previously existing.

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

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

'''As a Student'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Show sample reviews" link.
# This opens a page where the student can view all sample reviews for that assignment.
# Use the browser's back button to go back to the Assignment review page.
# 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.

==Expected Output==

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample.png]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-13T03:14:38Z

Nparanj: /* What needs to be done? */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently the students can only see what review their team got for their work. The instructors can see who reviewed each team and the review they gave. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to make their reviews 'public', that is, allow other students to view them.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of his/her assignments in the course.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.
# Allow the student to toggle the visibility of a review they have submitted.

== Implementation ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== What needs to be done? ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we are going to add a checkbox to the review page. 

2) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor will be able to select that review to be made an example review. If the review is already an example review, the instructor will be able to remove from the set of example reviews. If the review was private, the instructor will be shown a notice that 'This review is private.' and they will not be able to select it as an example review. 

3) '''Allow students to see good reviews''': When a student wants to review other team's work, they will be shown a link to sample reviews that the instructor has selected for them. The link will show them a view of the list of all sample views. 

4) '''Sample reviews need not be from the current session of a course''': When an instructor selects sample reviews, they should be shown to students in all sessions of that course even after the original session has ended. 

5) '''Allow students to make a review private''': Students should be able to make a review private even after they have made it public. If a review has been made private after an instructor has selected it as an example review, it should still not be displayed to students as an example review. 

=== Files that will change ===

* Create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'. Changes '''db/schema.rb''' 

* Create a checkbox in a view: '''views/response/response.html.erb'''. 

* Add code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). 

* For the instructors to carry out the tasks of selecting reviews, the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* For the other participants to view the sample reviews, the file '''list.html.erb''' which is under the '''views/student_review''' directory.

* A new partial file will be created in various views possibly a helper for '''response_controller.rb'''.

We are also planning to add a new field in the '''responses''' table (in the database), namely, visibility.
Visibility can have 4 values as listed below:

{| class="wikitable"
|+ Table showing list of visibility values and the properties
! Visibility
! Properties
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response which was in the review has been approved as an example (that is, it has been marked as a sample)
|-
| 2 || The response which was in the review has been approved as an example (that is, it has been marked as a sample)
|-
| 3 || The response which was either in the review or approved earlier, has now been rejected as an example (it has been unmarked as a sample)
|-
|}

== DB Design ==

=== Previous work ===

Currently, the Expertiza database design does not maintain any link between different assignments. An assignment of the current semester is completely independent of any other assignment of any other course having similar or exact objectives. For example, in a course C, the assignment named A1 in a semester Sx has no association to the same assignment given in an earlier semester Sy.

Since our task involves using reviews from the past as samples for the present, we should create this association as a new table. Further, reviews may not be the only intention to associate assignments with each other, as future requirements might require associating them on other criteria too. Thus, we find it appropriate to name the table as "similar_assignments".

The table structure is defined [http://wiki.expertiza.ncsu.edu/index.php/Similar_assignments here].

This table can be visualized as a directed graph where vertices represent assignments. An edge (u,v) with a label L means u is similar to v for the intent of association, L.

Consider a row (id = x, assignment_id = Ak, is_similar_for = An, association_intent = "review"). This means, given the intent of association as "review", assignment Ak was chosen as a similar assignment for assignment An. That is, while marking some review for An as a sample, the instructor opted to have reviews of Ak as samples for An as well.

=== New work (along with changes) ===

Most of the design used by the team will be used as it is but there will be some major change in the design, The change is mentioned as follows:

The previous team had created an entire table, that is made major changes in the database which lead to creating a new model, view and controller. This may lead to some major problems which can affect the other functionalities.

We are preventing that by a different approach. We have decided to use the '''assignments''' table itself and just add an extra field called '''is_similar_for'''. This will be used to get the sample reviews from previous similar assignments that were assigned to students. Accordingly, changes will be made that are related to assignments.

The advantage of using this design is that some of the code which is already available can be reused. No new code will be added that was previously existing.

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

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

'''As a Student'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Show sample reviews" link.
# This opens a page where the student can view all sample reviews for that assignment.
# Use the browser's back button to go back to the Assignment review page.
# 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.

==Expected Output==

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample.png]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-13T03:12:12Z

Nparanj: /* Problem Statement */

== Introduction (''Reviews in Expertiza'') ==

In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently the students can only see what review their team got for their work. The instructors can see who reviewed each team and the review they gave. 

== Problem Statement ==

The objective of this project is to:
# Add a feature for students to make their reviews 'public', that is, allow other students to view them.
# Add a feature for Instructor to select a subset of 'public' reviews and make those reviews visible as sample reviews of any of his/her assignments in the course.
# Create a view where the student can see a list of sample reviews of the assignment and have a detailed view of each.
# Allow the student to toggle the visibility of a review they have submitted.

== Implementation ==

=== What is this project adding to the reviews? ===

The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

=== What needs to be done? ===

1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we are going to add a checkbox to the review page. 

2) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor will be able to select that review to be made an example review. If the review is already an example review, the instructor will be able to remove from the set of example reviews. If the review was private, the instructor will be shown a notice that 'This review is private.' and they will not be able to select it as an example review. 

3) '''Allow students to see good reviews''': When a student wants to review other team's work, they will be shown a link to sample reviews that the instructor has selected for them. 

4) '''Sample reviews need not be from the current session of a course''': When an instructor selects sample reviews, they should be shown to students in all sessions of that course even after the original session has ended. 

5) '''Allow students to make a review private''': Students should be able to make a review private even after they have made it public. If a review has been made private after an instructor has selected it as an example review, it should still not be displayed to students as an example review. 

=== Files that will change ===

* Create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'. Changes '''db/schema.rb''' 

* Create a checkbox in a view: '''views/response/response.html.erb'''. 

* Add code to check the status field from response.html.erb and update the db, in controller: '''app/controllers/response_controller.rb''' (in method "create"). 

* For the instructors to carry out the tasks of selecting reviews, the file '''team_users_popup.html.haml''' which is under the '''views/popup''' directory. 

* For the other participants to view the sample reviews, the file '''list.html.erb''' which is under the '''views/student_review''' directory.

* A new partial file will be created in various views possibly a helper for '''response_controller.rb'''.

We are also planning to add a new field in the '''responses''' table (in the database), namely, visibility.
Visibility can have 4 values as listed below:

{| class="wikitable"
|+ Table showing list of visibility values and the properties
! Visibility
! Properties
|-
| 0 || Response is private. This is the default value.
|-
| 1 || The response which was in the review has been approved as an example (that is, it has been marked as a sample)
|-
| 2 || The response which was in the review has been approved as an example (that is, it has been marked as a sample)
|-
| 3 || The response which was either in the review or approved earlier, has now been rejected as an example (it has been unmarked as a sample)
|-
|}

== DB Design ==

=== Previous work ===

Currently, the Expertiza database design does not maintain any link between different assignments. An assignment of the current semester is completely independent of any other assignment of any other course having similar or exact objectives. For example, in a course C, the assignment named A1 in a semester Sx has no association to the same assignment given in an earlier semester Sy.

Since our task involves using reviews from the past as samples for the present, we should create this association as a new table. Further, reviews may not be the only intention to associate assignments with each other, as future requirements might require associating them on other criteria too. Thus, we find it appropriate to name the table as "similar_assignments".

The table structure is defined [http://wiki.expertiza.ncsu.edu/index.php/Similar_assignments here].

This table can be visualized as a directed graph where vertices represent assignments. An edge (u,v) with a label L means u is similar to v for the intent of association, L.

Consider a row (id = x, assignment_id = Ak, is_similar_for = An, association_intent = "review"). This means, given the intent of association as "review", assignment Ak was chosen as a similar assignment for assignment An. That is, while marking some review for An as a sample, the instructor opted to have reviews of Ak as samples for An as well.

=== New work (along with changes) ===

Most of the design used by the team will be used as it is but there will be some major change in the design, The change is mentioned as follows:

The previous team had created an entire table, that is made major changes in the database which lead to creating a new model, view and controller. This may lead to some major problems which can affect the other functionalities.

We are preventing that by a different approach. We have decided to use the '''assignments''' table itself and just add an extra field called '''is_similar_for'''. This will be used to get the sample reviews from previous similar assignments that were assigned to students. Accordingly, changes will be made that are related to assignments.

The advantage of using this design is that some of the code which is already available can be reused. No new code will be added that was previously existing.

== Design Pattern ==

In our project, the implementation of a new functionality would be through a '''Delegation pattern''' which is an object-oriented design pattern that allows object composition to achieve the same code reuse as an inheritance.

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

'''As a Student'''
# Log in.
# Click on Assignments
# List of assignments is displayed.
# Click on any assignment for which the review has to be submitted.
# Assignment task page is displayed.
# Click on "Other's work" to open the reviews summary page (at /student_review).
# Below the heading "Reviews for ...", click on the "Show sample reviews" link.
# This opens a page where the student can view all sample reviews for that assignment.
# Use the browser's back button to go back to the Assignment review page.
# 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.

==Expected Output==

The screenshot below shows a button next to every review which gives an option '''Mark as Sample'''. This access will be given to instructors.

[[File:No more a sample.png]]

Once the review is marked as sample, the instructor will be given an option to '''Remove as Sample'''.

[[File:Marked as sample.png]]

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza Home] 

==Team Members==

1) Nikita Pramod Paranjape

2) Ashish Kumar Jayantilal Jain

3) Devang Upadhyay

4) Pranav Reddy Anumula

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

2019-04-09T04:03:21Z

Nparanj:

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

2019-04-09T03:58:20Z

Nparanj: /* References */

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

2019-04-06T19:34:27Z

Nparanj: /* Files that will change */

== Questions for Akanksha ==
1) Is the instructor going to be able to select only one example review or many examples? 

== Reviews in Expertiza ==
In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently the students can only see what review their team got for their work. The instructors can see who reviewed each team and the review they gave. 

== What is this project adding to the reviews? ==
The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

== What needs to be done? ==
1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we are going to add a checkbox to the review page. 
2) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor will be able to select that review to be made an example review. If the review is already an example review, the instructor will be able to remove from the set of example reviews. If the review was private, the instructor will be shown a notice that 'This review is private.' and they will not be able to select it. 
3) '''Allow students to see good reviews''': When a student wants to review other team's work, they will be shown a link to sample reviews that the instructor has selected for them. 
4) '''Sample reviews need not be from the current session of a course''': When an instructor selects sample reviews, they should be shown to students in all sessions of that course even after the original session has ended. 
5) '''Allow students to make a review private''': Students should be able to make a review private even after they have made it public. If a review has been made private after an instructor has selected it as an example review, it should still not be displayed to students as an example review. 

== Files that will change ==
* create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'. Changes db/schema.rb 
* create a checkbox in a view: views/response/response.html.erb:333.
* add code to check the status field from response.html.erb and update the db, in controller: app/controllers/response_controller.rb (in method "create").

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

2019-04-06T19:31:24Z

Nparanj: /* What needs to be done? */

== Questions for Akanksha ==
1) Is the instructor going to be able to select only one example review or many examples? 

== Reviews in Expertiza ==
In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently the students can only see what review their team got for their work. The instructors can see who reviewed each team and the review they gave. 

== What is this project adding to the reviews? ==
The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work. The students will be able to get understand what a good review looks like and what exactly is expected from them when they review any other team's work. 

== What needs to be done? ==
1) '''Creating a checkbox''': When a student submits a review, they should be able to choose if they want to make their review public or private. Thus we are going to add a checkbox to the review page. 
2) '''Allow instructors to select(remove) sample reviews''': If a review has been made public by the reviewer, the instructor will be able to select that review to be made an example review. If the review is already an example review, the instructor will be able to remove from the set of example reviews. If the review was private, the instructor will be shown a notice that 'This review is private.' and they will not be able to select it. 
3) '''Allow students to see good reviews''': When a student wants to review other team's work, they will be shown a link to sample reviews that the instructor has selected for them. 
4) '''Sample reviews need not be from the current session of a course''': When an instructor selects sample reviews, they should be shown to students in all sessions of that course even after the original session has ended. 
5) '''Allow students to make a review private''': Students should be able to make a review private even after they have made it public. If a review has been made private after an instructor has selected it as an example review, it should still not be displayed to students as an example review. 

== Files that will change ==
* create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'.
* create a status field in responses model: schema.rb.
add a column "status" in response.rb model.
* create a checkbox in a view: views/response/response.html.erb:333.
* add code to check the status field from response.html.erb and update the db, in controller: app/controllers/response_controller.rb(in method "create").

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

2019-04-06T19:19:40Z

Nparanj: /* What is this project adding to the reviews? */

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

2019-04-06T19:18:53Z

Nparanj: /* What is this project adding to the reviews? */

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

2019-04-06T19:17:27Z

Nparanj:

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

2019-04-06T19:16:36Z

Nparanj: /* What is this project adding to the reviews? */

== Reviews in Expertiza ==
In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently the students can only see what review their team got for their work. The instructors can see who reviewed each team and the review they gave. 

== What is this project adding to the reviews? ==
The goal of this project is to enable instructors to select certain reviews to show as examples to the entire class. Thus the students will be able to see good reviews that one student has submitted for another student's work.

== What needs to be done? ==
1) Creating a checkbox 
2) Allow instructors to select(remove) from public(selected) reviews to show to (hide from) the class. 
3) Allow students to see good reviews 
4) Allow current participants of the course to be shown good reviews of the earlier course sessions as well. 
5) Allow students to make a review private. 

== Files that will change ==
* create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'.
* create a status field in responses model: schema.rb.
add a column "status" in response.rb model.
* create a checkbox in a view: views/response/response.html.erb:333.
* add code to check the status field from response.html.erb and update the db, in controller: app/controllers/response_controller.rb(in method "create").

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

2019-04-06T19:13:10Z

Nparanj: /* Reviews in Expertiza */

== Reviews in Expertiza ==
In Expertiza, students can review other team's project. The instructors can create assignment specific questions based on which students can write these reviews. The questions are in rating and/or comment form. Currently the students can only see what review their team got for their work. The instructors can see who reviewed each team and the review they gave. 

== What is this project adding to the reviews? ==

== What needs to be done? ==
1) Creating a checkbox 
2) Allow instructors to select(remove) from public(selected) reviews to show to (hide from) the class. 
3) Allow students to see good reviews 
4) Allow current participants of the course to be shown good reviews of the earlier course sessions as well. 
5) Allow students to make a review private. 

== Files that will change ==
* create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'.
* create a status field in responses model: schema.rb.
add a column "status" in response.rb model.
* create a checkbox in a view: views/response/response.html.erb:333.
* add code to check the status field from response.html.erb and update the db, in controller: app/controllers/response_controller.rb(in method "create").

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

2019-04-06T18:50:57Z

Nparanj: /* what needs to be done? */

== Reviews in Expertiza ==

== What is this project adding to the reviews? ==

== What needs to be done? ==
1) Creating a checkbox 
2) Allow instructors to select(remove) from public(selected) reviews to show to (hide from) the class. 
3) Allow students to see good reviews 
4) Allow current participants of the course to be shown good reviews of the earlier course sessions as well. 
5) Allow students to make a review private. 

== Files that will change ==
1) create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'.
2) create a checkbox in a view: views/response/response.html.erb:333
3) create a status field in responses model: schema.rb

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

2019-04-06T18:46:15Z

Nparanj:

== Reviews in Expertiza ==

== What is this project adding to the reviews? ==

== what needs to be done? ==
1) Creating a checkbox
2) Allow instructors to select(remove) from public(selected) reviews to show to (hide from) the class.
3) Allow students to see good reviews

== Files that will change ==
1) create migration for the responses model called status which can take on the values 'selected', 'public' and 'private'.
2) create a checkbox in a view: views/response/response.html.erb:333
3) create a status field in responses model: schema.rb

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

2019-04-06T17:56:46Z

Nparanj: Created page with "== This page is still being edited by the project team =="

== This page is still being edited by the project team ==

E1914 Refactor users controller

2019-04-03T04:21:45Z

Nparanj: /* Manual Testing */

== About Expertiza ==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. 
This document contains the description of the changes that we made to users_controller, how we refactored it, our testing results and some design decisions that we took while making these changes.

== Separate all methods related to the workflow of a RequestedUser object ==
'''Problem''': 
The users_controller.rb file included the standard CRUD methods for a User model along with methods for other workflows. The users_controller.rb file also handled the creation and management of a RequestedUser object in addition to handling the user object. 
'''Solution''': 
Earlier, there was no controllers for a RequestedUser object and these were handled by the Users controller itself. We separated the RequestedUser workflow from the Users and we renamed the RequestedUser model to AccountRequest.
As a part of this refactoring activity, we created a new controller called the account_requests_controller to handle the workflow of an AccountRequest.
The following methods were moved from users_controller to account_requests_controller. 
1) created_approved_user 
2) list_pending_requested 
3) request_new 
4) created_requested_user_record 
5) roles_for_request_sign_up 
6) requested_user_params 

== Writing comments to make methods more understandable ==
'''Problem''': 
The users_controller included a few methods which lacked documentation. 
'''Solution:''' 
===Wrote comments for the 'foreign' method. The comments include:===
'''1) What the method does:''' This method is used to find the list of roles the current user can embody. 
'''2) Where the method is used:''' Used to display a drop-down selection of roles for the current user in the views. 

===Wrote comments for the show and show_selection methods:===
'''1) What the method does:''' 
''show():'' If the current user is a student, they should only be able to see information about themselves. All other people should be able to see information about themselves or other students. If the request to show() passes these checks, then they are shown the view 'show'. Otherwise, they are redirected to the home page. 
''show_selection():'' If the role of a user's parent is less than the current user or if the current user is requesting to see itself or if user's parent_id does not exist then the show() method is called. All these conditions boil down to whether the current user of the system is authorized to see/edit the information about the user specified in the params. If the requested user does not exist or if the current user is not authorized to see the requested user, then the current user is redirected back to the list page. 
'''2) Scenarios in which show_selection is called:''' in users/list.html.erb, a list of users is shown. On top of the list there is a functionality to search the list. When a person searches for a particular student, and selects that student, the show_selection method is called. If the person is allowed to see that student, the user is directed to the show() method. Otherwise the person stays on the list view. 
'''3) Scenarios in which show() is called:''' From the edit.html.erb, if the person wants to see the information instead of editing it. From show_selection() as described above. 

== Renaming methods to reflect their actual behavior ==
'''Problem''': 
Methods in the Users_controller were not named to convey exactly what they did. 
'''Solution:''' 
The get_role method was named more like it would be in Java. It was renamed to 'role' because that is how it would be named in ruby.
We chose to keep the method in the controller instead of moving it to the model because it does not alter the data structure and it also has selection logic.

== Make GUI changes in the form displayed after "Request Account" button is clicked ==
'''Problem''': 
The forms that come after "Request Account" button is clicked need to be changed. 
'''Solution''':
Only instructor accounts can be created, so the drop-down was removed. 
All form labels were bold-faced. 
The “Self Introduction” label was re-named to “Self-Introduction”. 
The text-box for the self-introduction field now includes a useful hint of what is expected in the text-box. The hint is "Please include a website name". 
==== Before it looked like this :====
[[File:Rsz_instructor_dropdown.png]] 

==== After it looks like this: ====
[[File:Rsz_new_instructor.png]] 

== Paginating the list of users ==
'''Problem''': 
When a list of all users are shown, the list is not paginated. So the instructors see a list of all users that have enrolled for a course over all the years that they have offered the course. 
'''Solution''': 
The existing project does not have the feature of pagination for the user list. So, currently, all the users are shown to the instructor. 
The paginate_list method is supposed to paginate the list of users. The method was not called anywhere and also the method logic was incorrect. 
With the latest implementation, the pagination is added with dropdown option - "25", "50", "100" and "ALL". 
The method "paginate_list" is corrected and called at right place. 
The default option is kept to "25" to reduce the web-page loading time. 
==== Before it looked like this: ====
[[File:Rsz_no_pagination.png]]
 

==== After it looks like this: ====
[[File:Rsz_pagination_implemented.png]]

As can be clearly seen, different pagination options are now provided at the lower part of the view.

== Test Plan ==

=== RSpec testing for account_requests_controller ===
'''Problem''': Since we created a new controller, tests for this controller did not exist. All those tests were written in the users_controller since that was where the methods were located earlier. 
'''Solution:''' 
We moved the tests from the users_controller_spec.rb file to the newly created accounts_request_controller.rb file. We also changed some tests in account_request_controller to route to their appropriate tests. 
It can be seen that all 11 test cases passed for account_request_controller. 
[[File:Rsz_test_accounts_request.png‎]] 

=== RSpec testing for users_controller ===
''' Problem: ''' 
The pagination for users_controller was not tested correctly in the previous implementation. We fixed this issue by writing a test for this.

''' Solution: ''' 
It can now be seen that all 18 test cases pass for users_controller.

[[File:Rsz test users.png]] 

== Manual Testing ==
The [http://152.46.17.33:8080 link] to our project instance. 

'''1) To view pending account requests:''' 
Login as the administrator. 
Username = administrator5 
Password = password 
Navigate to Manage(in the horizontal tab at the top of the page) -> Pending Requests. 
You will be able to see all the pending requests. The method that serves this view is in the newly created controller. So this is one way to test if the controller we wrote and the routes we configured are working. 

'''2) To test the changes in the form for Account Requests:''' 
Go to the login page. But do not log in. 
Click the Request Account button. 
You will be able to see the labels in bold and a hint of what should be entered in the last textbox. 

'''3) To test the pagination:''' 
Login as an instructor. 
username: instructor6 
password : password 
Navigate to Manage(in the horizontal tab at the top of the page) -> users. 
You will be able to see a list of users and page numbers where the list ends. You will also be able to select the number of users to show on each page using a dropdown at the top of the list. 

'''4) Other changes:''' 
To check if the build passed or not, [https://github.com/nikitaparanjape/expertiza/tree/beta this] is the repository which we forked from expertiza. If you navigate to this and scroll down to the README, you should be able to see the build status and test case coverage statistics. You should also be ble to see the build status and all checks at the end of the pull request. 
The other changes we made like renaming methods and documenting code are not so visible in the GUI and will have to be seen in the code.

== Design choices ==
''' 1) Partial Views''': 
There are some partial views which are related to displaying forms to create/edit a user in the Users view. The same partials were earlier being used for displaying forms for requesting a new account. Now that we separated the two controllers, we had the following options to deal with these duplicated partials. 
Option 1: 
Keep accessing the partials in the users view from the newly created Accounts_request view. This would make the code DRY but harder to understand. 
Option 2: 
Duplicate the partials in the accounts request view.This would make some render partial statements hard to read but would make the code DRY. 
Option 3: 
Create partial files in the views folder. Have Users_controller, Account_requests_controller access these partials. The code becomes DRY and also readable. 
We decided to go with the second option. Even though these forms contain the same code right now, due to changing requirements in the future, these views may need to be changed which would allow us to add more functionality in the future. This option gives some flexibility to the accounts_controller to modify the form without affecting the User's form. This design decision was taken after discussions with our mentor.
The partials that are now duplicated are: _email, _name, _institution, _password, and _prefs which can be found in user and account_request views. 

''' 2) Refactoring variable names''': 
We refactored the variables names from requested_users to account_requests (in views, controller actions, etc.) since requested_users is a bad naming choice for our variable. As we are referring to AccountRequest model in our controllers, such renaming makes sense here. 
For example:
account_request = AccountRequest.all
makes more sense than
requested_users = AccountRequest.all

== Important Links ==
1. Expertiza Documentation: [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Main Page] 
2. To show our design changes, we have hosted our implementation on VCL. The link is: [http://152.46.17.33:8080 VCL instance] 
3. Link to the pull request [https://github.com/expertiza/expertiza/pull/1367 Pull request.]

E1914 Refactor users controller

2019-03-29T17:38:49Z

Nparanj: /* Important Links */

== About Expertiza ==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. 
This document contains the description of the changes that we made to users_controller, how we refactored it, our testing results and some design decisions that we took while making these changes.

== Separate all methods related to the workflow of a RequestedUser object ==
'''Problem''': 
The users_controller.rb file included the standard CRUD methods for a User model along with methods for other workflows. The users_controller.rb file also handled the creation and management of a RequestedUser object in addition to handling the user object. 
'''Solution''': 
Earlier, there was no controllers for a RequestedUser object and these were handled by the Users controller itself. We separated the RequestedUser workflow from the Users and we renamed the RequestedUser model to AccountRequest.
As a part of this refactoring activity, we created a new controller called the account_requests_controller to handle the workflow of an AccountRequest.
The following methods were moved from users_controller to account_requests_controller. 
1) created_approved_user 
2) list_pending_requested 
3) request_new 
4) created_requested_user_record 
5) roles_for_request_sign_up 
6) requested_user_params 

== Writing comments to make methods more understandable ==
'''Problem''': 
The users_controller included a few methods which lacked documentation. 
'''Solution:''' 
===Wrote comments for the 'foreign' method. The comments include:===
'''1) What the method does:''' This method is used to find the list of roles the current user can embody. 
'''2) Where the method is used:''' Used to display a drop-down selection of roles for the current user in the views. 

===Wrote comments for the show and show_selection methods:===
'''1) What the method does:''' 
''show():'' If the current user is a student, they should only be able to see information about themselves. All other people should be able to see information about themselves or other students. If the request to show() passes these checks, then they are shown the view 'show'. Otherwise, they are redirected to the home page. 
''show_selection():'' If the role of a user's parent is less than the current user or if the current user is requesting to see itself or if user's parent_id does not exist then the show() method is called. All these conditions boil down to whether the current user of the system is authorized to see/edit the information about the user specified in the params. If the requested user does not exist or if the current user is not authorized to see the requested user, then the current user is redirected back to the list page. 
'''2) Scenarios in which show_selection is called:''' in users/list.html.erb, a list of users is shown. On top of the list there is a functionality to search the list. When a person searches for a particular student, and selects that student, the show_selection method is called. If the person is allowed to see that student, the user is directed to the show() method. Otherwise the person stays on the list view. 
'''3) Scenarios in which show() is called:''' From the edit.html.erb, if the person wants to see the information instead of editing it. From show_selection() as described above. 

== Renaming methods to reflect their actual behavior ==
'''Problem''': 
Methods in the Users_controller were not named to convey exactly what they did. 
'''Solution:''' 
The get_role method was named more like it would be in Java. It was renamed to 'role' because that is how it would be named in ruby.
We chose to keep the method in the controller instead of moving it to the model because it does not alter the data structure and it also has selection logic.

== Make GUI changes in the form displayed after "Request Account" button is clicked ==
'''Problem''': 
The forms that come after "Request Account" button is clicked need to be changed. 
'''Solution''':
Only instructor accounts can be created, so the drop-down was removed. 
All form labels were bold-faced. 
The “Self Introduction” label was re-named to “Self-Introduction”. 
The text-box for the self-introduction field now includes a useful hint of what is expected in the text-box. The hint is "Please include a website name". 
==== Before it looked like this :====
[[File:Rsz_instructor_dropdown.png]] 

==== After it looks like this: ====
[[File:Rsz_new_instructor.png]] 

== Paginating the list of users ==
'''Problem''': 
When a list of all users are shown, the list is not paginated. So the instructors see a list of all users that have enrolled for a course over all the years that they have offered the course. 
'''Solution''': 
The existing project does not have the feature of pagination for the user list. So, currently, all the users are shown to the instructor. 
The paginate_list method is supposed to paginate the list of users. The method was not called anywhere and also the method logic was incorrect. 
With the latest implementation, the pagination is added with dropdown option - "25", "50", "100" and "ALL". 
The method "paginate_list" is corrected and called at right place. 
The default option is kept to "25" to reduce the web-page loading time. 
==== Before it looked like this: ====
[[File:Rsz_no_pagination.png]]
 

==== After it looks like this: ====
[[File:Rsz_pagination_implemented.png]]

As can be clearly seen, different pagination options are now provided at the lower part of the view.

== Test Plan ==

=== RSpec testing for account_requests_controller ===
'''Problem''': Since we created a new controller, tests for this controller did not exist. All those tests were written in the users_controller since that was where the methods were located earlier. 
'''Solution:''' 
We moved the tests from the users_controller_spec.rb file to the newly created accounts_request_controller.rb file. We also changed some tests in account_request_controller to route to their appropriate tests. 
It can be seen that all 11 test cases passed for account_request_controller. 
[[File:Rsz_test_accounts_request.png‎]] 

=== RSpec testing for users_controller ===
''' Problem: ''' 
The pagination for users_controller was not tested correctly in the previous implementation. We fixed this issue by writing a test for this.

''' Solution: ''' 
It can now be seen that all 18 test cases pass for users_controller.

[[File:Rsz test users.png]] 

== Manual Testing ==
The [http://152.46.17.33:8080 link] to our project instance. 

'''1) To view pending account requests:''' 
Login as the administrator. 
Username = administrator5 
Password = password 
Navigate to Manage(in the horizontal tab at the top of the page) -> Pending Requests. 
You will be able to see all the pending requests. The method that serves this view is in the newly created controller. So this is one way to test if the controller we wrote and the routes we configured are working. 

'''2) To test the changes in the form for Account Requests:''' 
Go to the login page. But do not log in. 
Click the Request Account button. 
You will be able to see the labels in bold and a hint of what should be entered in the last textbox. 

'''3) To test the pagination:''' 
Login as an instructor. 
username: instructor6 
password : password 
Navigate to Manage(in the horizontal tab at the top of the page) -> users. 
You will be able to see a list of users and page numbers where the list ends. You will also be able to select the number of users to show on each page using a dropdown at the top of the list. 

'''4) Other changes:''' 
To check if the build passed or not, [https://github.com/nikitaparanjape/expertiza/tree/beta this] is the repository which we forked from expertiza. If you navigate to this and scroll down to the README, you should be able to see the build status and test case coverage statistics. 
The other changes we made like renaming methods and documenting code are not so visible in the GUI and will have to be seen in the code.

== Design choices ==
''' 1) Partial Views''': 
There are some partial views which are related to displaying forms to create/edit a user in the Users view. The same partials were earlier being used for displaying forms for requesting a new account. Now that we separated the two controllers, we had the following options to deal with these duplicated partials. 
Option 1: 
Keep accessing the partials in the users view from the newly created Accounts_request view. This would make the code DRY but harder to understand. 
Option 2: 
Duplicate the partials in the accounts request view.This would make some render partial statements hard to read but would make the code DRY. 
Option 3: 
Create partial files in the views folder. Have Users_controller, Account_requests_controller access these partials. The code becomes DRY and also readable. 
We decided to go with the second option. Even though these forms contain the same code right now, due to changing requirements in the future, these views may need to be changed which would allow us to add more functionality in the future. This option gives some flexibility to the accounts_controller to modify the form without affecting the User's form. This design decision was taken after discussions with our mentor.
The partials that are now duplicated are: _email, _name, _institution, _password, and _prefs which can be found in user and account_request views. 

''' 2) Refactoring variable names''': 
We refactored the variables names from requested_users to account_requests (in views, controller actions, etc.) since requested_users is a bad naming choice for our variable. As we are referring to AccountRequest model in our controllers, such renaming makes sense here. 
For example:
account_request = AccountRequest.all
makes more sense than
requested_users = AccountRequest.all

== Important Links ==
1. Expertiza Documentation: [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Main Page] 
2. To show our design changes, we have hosted our implementation on VCL. The link is: [http://152.46.17.33:8080 VCL instance] 
3. Link to the pull request [https://github.com/expertiza/expertiza/pull/1367 Pull request.]

E1914 Refactor users controller

2019-03-29T17:38:04Z

Nparanj: /* Design choices */

== About Expertiza ==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. 
This document contains the description of the changes that we made to users_controller, how we refactored it, our testing results and some design decisions that we took while making these changes.

== Separate all methods related to the workflow of a RequestedUser object ==
'''Problem''': 
The users_controller.rb file included the standard CRUD methods for a User model along with methods for other workflows. The users_controller.rb file also handled the creation and management of a RequestedUser object in addition to handling the user object. 
'''Solution''': 
Earlier, there was no controllers for a RequestedUser object and these were handled by the Users controller itself. We separated the RequestedUser workflow from the Users and we renamed the RequestedUser model to AccountRequest.
As a part of this refactoring activity, we created a new controller called the account_requests_controller to handle the workflow of an AccountRequest.
The following methods were moved from users_controller to account_requests_controller. 
1) created_approved_user 
2) list_pending_requested 
3) request_new 
4) created_requested_user_record 
5) roles_for_request_sign_up 
6) requested_user_params 

== Writing comments to make methods more understandable ==
'''Problem''': 
The users_controller included a few methods which lacked documentation. 
'''Solution:''' 
===Wrote comments for the 'foreign' method. The comments include:===
'''1) What the method does:''' This method is used to find the list of roles the current user can embody. 
'''2) Where the method is used:''' Used to display a drop-down selection of roles for the current user in the views. 

===Wrote comments for the show and show_selection methods:===
'''1) What the method does:''' 
''show():'' If the current user is a student, they should only be able to see information about themselves. All other people should be able to see information about themselves or other students. If the request to show() passes these checks, then they are shown the view 'show'. Otherwise, they are redirected to the home page. 
''show_selection():'' If the role of a user's parent is less than the current user or if the current user is requesting to see itself or if user's parent_id does not exist then the show() method is called. All these conditions boil down to whether the current user of the system is authorized to see/edit the information about the user specified in the params. If the requested user does not exist or if the current user is not authorized to see the requested user, then the current user is redirected back to the list page. 
'''2) Scenarios in which show_selection is called:''' in users/list.html.erb, a list of users is shown. On top of the list there is a functionality to search the list. When a person searches for a particular student, and selects that student, the show_selection method is called. If the person is allowed to see that student, the user is directed to the show() method. Otherwise the person stays on the list view. 
'''3) Scenarios in which show() is called:''' From the edit.html.erb, if the person wants to see the information instead of editing it. From show_selection() as described above. 

== Renaming methods to reflect their actual behavior ==
'''Problem''': 
Methods in the Users_controller were not named to convey exactly what they did. 
'''Solution:''' 
The get_role method was named more like it would be in Java. It was renamed to 'role' because that is how it would be named in ruby.
We chose to keep the method in the controller instead of moving it to the model because it does not alter the data structure and it also has selection logic.

== Make GUI changes in the form displayed after "Request Account" button is clicked ==
'''Problem''': 
The forms that come after "Request Account" button is clicked need to be changed. 
'''Solution''':
Only instructor accounts can be created, so the drop-down was removed. 
All form labels were bold-faced. 
The “Self Introduction” label was re-named to “Self-Introduction”. 
The text-box for the self-introduction field now includes a useful hint of what is expected in the text-box. The hint is "Please include a website name". 
==== Before it looked like this :====
[[File:Rsz_instructor_dropdown.png]] 

==== After it looks like this: ====
[[File:Rsz_new_instructor.png]] 

== Paginating the list of users ==
'''Problem''': 
When a list of all users are shown, the list is not paginated. So the instructors see a list of all users that have enrolled for a course over all the years that they have offered the course. 
'''Solution''': 
The existing project does not have the feature of pagination for the user list. So, currently, all the users are shown to the instructor. 
The paginate_list method is supposed to paginate the list of users. The method was not called anywhere and also the method logic was incorrect. 
With the latest implementation, the pagination is added with dropdown option - "25", "50", "100" and "ALL". 
The method "paginate_list" is corrected and called at right place. 
The default option is kept to "25" to reduce the web-page loading time. 
==== Before it looked like this: ====
[[File:Rsz_no_pagination.png]]
 

==== After it looks like this: ====
[[File:Rsz_pagination_implemented.png]]

As can be clearly seen, different pagination options are now provided at the lower part of the view.

== Test Plan ==

=== RSpec testing for account_requests_controller ===
'''Problem''': Since we created a new controller, tests for this controller did not exist. All those tests were written in the users_controller since that was where the methods were located earlier. 
'''Solution:''' 
We moved the tests from the users_controller_spec.rb file to the newly created accounts_request_controller.rb file. We also changed some tests in account_request_controller to route to their appropriate tests. 
It can be seen that all 11 test cases passed for account_request_controller. 
[[File:Rsz_test_accounts_request.png‎]] 

=== RSpec testing for users_controller ===
''' Problem: ''' 
The pagination for users_controller was not tested correctly in the previous implementation. We fixed this issue by writing a test for this.

''' Solution: ''' 
It can now be seen that all 18 test cases pass for users_controller.

[[File:Rsz test users.png]] 

== Manual Testing ==
The [http://152.46.17.33:8080 link] to our project instance. 

'''1) To view pending account requests:''' 
Login as the administrator. 
Username = administrator5 
Password = password 
Navigate to Manage(in the horizontal tab at the top of the page) -> Pending Requests. 
You will be able to see all the pending requests. The method that serves this view is in the newly created controller. So this is one way to test if the controller we wrote and the routes we configured are working. 

'''2) To test the changes in the form for Account Requests:''' 
Go to the login page. But do not log in. 
Click the Request Account button. 
You will be able to see the labels in bold and a hint of what should be entered in the last textbox. 

'''3) To test the pagination:''' 
Login as an instructor. 
username: instructor6 
password : password 
Navigate to Manage(in the horizontal tab at the top of the page) -> users. 
You will be able to see a list of users and page numbers where the list ends. You will also be able to select the number of users to show on each page using a dropdown at the top of the list. 

'''4) Other changes:''' 
To check if the build passed or not, [https://github.com/nikitaparanjape/expertiza/tree/beta this] is the repository which we forked from expertiza. If you navigate to this and scroll down to the README, you should be able to see the build status and test case coverage statistics. 
The other changes we made like renaming methods and documenting code are not so visible in the GUI and will have to be seen in the code.

== Design choices ==
''' 1) Partial Views''': 
There are some partial views which are related to displaying forms to create/edit a user in the Users view. The same partials were earlier being used for displaying forms for requesting a new account. Now that we separated the two controllers, we had the following options to deal with these duplicated partials. 
Option 1: 
Keep accessing the partials in the users view from the newly created Accounts_request view. This would make the code DRY but harder to understand. 
Option 2: 
Duplicate the partials in the accounts request view.This would make some render partial statements hard to read but would make the code DRY. 
Option 3: 
Create partial files in the views folder. Have Users_controller, Account_requests_controller access these partials. The code becomes DRY and also readable. 
We decided to go with the second option. Even though these forms contain the same code right now, due to changing requirements in the future, these views may need to be changed which would allow us to add more functionality in the future. This option gives some flexibility to the accounts_controller to modify the form without affecting the User's form. This design decision was taken after discussions with our mentor.
The partials that are now duplicated are: _email, _name, _institution, _password, and _prefs which can be found in user and account_request views. 

''' 2) Refactoring variable names''': 
We refactored the variables names from requested_users to account_requests (in views, controller actions, etc.) since requested_users is a bad naming choice for our variable. As we are referring to AccountRequest model in our controllers, such renaming makes sense here. 
For example:
account_request = AccountRequest.all
makes more sense than
requested_users = AccountRequest.all

== Important Links ==
1. Expertiza Main page: [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Main Page] 
2. To show our design changes, we have hosted our implementation on VCL. The link is: [http://152.46.17.33:8080 VCL instance] 
3. Link to the pull request [https://github.com/expertiza/expertiza/pull/1367 Pull request.]

E1914 Refactor users controller

2019-03-29T17:36:44Z

Nparanj: /* About Expertiza */

== About Expertiza ==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. 
This document contains the description of the changes that we made to users_controller, how we refactored it, our testing results and some design decisions that we took while making these changes.

== Separate all methods related to the workflow of a RequestedUser object ==
'''Problem''': 
The users_controller.rb file included the standard CRUD methods for a User model along with methods for other workflows. The users_controller.rb file also handled the creation and management of a RequestedUser object in addition to handling the user object. 
'''Solution''': 
Earlier, there was no controllers for a RequestedUser object and these were handled by the Users controller itself. We separated the RequestedUser workflow from the Users and we renamed the RequestedUser model to AccountRequest.
As a part of this refactoring activity, we created a new controller called the account_requests_controller to handle the workflow of an AccountRequest.
The following methods were moved from users_controller to account_requests_controller. 
1) created_approved_user 
2) list_pending_requested 
3) request_new 
4) created_requested_user_record 
5) roles_for_request_sign_up 
6) requested_user_params 

== Writing comments to make methods more understandable ==
'''Problem''': 
The users_controller included a few methods which lacked documentation. 
'''Solution:''' 
===Wrote comments for the 'foreign' method. The comments include:===
'''1) What the method does:''' This method is used to find the list of roles the current user can embody. 
'''2) Where the method is used:''' Used to display a drop-down selection of roles for the current user in the views. 

===Wrote comments for the show and show_selection methods:===
'''1) What the method does:''' 
''show():'' If the current user is a student, they should only be able to see information about themselves. All other people should be able to see information about themselves or other students. If the request to show() passes these checks, then they are shown the view 'show'. Otherwise, they are redirected to the home page. 
''show_selection():'' If the role of a user's parent is less than the current user or if the current user is requesting to see itself or if user's parent_id does not exist then the show() method is called. All these conditions boil down to whether the current user of the system is authorized to see/edit the information about the user specified in the params. If the requested user does not exist or if the current user is not authorized to see the requested user, then the current user is redirected back to the list page. 
'''2) Scenarios in which show_selection is called:''' in users/list.html.erb, a list of users is shown. On top of the list there is a functionality to search the list. When a person searches for a particular student, and selects that student, the show_selection method is called. If the person is allowed to see that student, the user is directed to the show() method. Otherwise the person stays on the list view. 
'''3) Scenarios in which show() is called:''' From the edit.html.erb, if the person wants to see the information instead of editing it. From show_selection() as described above. 

== Renaming methods to reflect their actual behavior ==
'''Problem''': 
Methods in the Users_controller were not named to convey exactly what they did. 
'''Solution:''' 
The get_role method was named more like it would be in Java. It was renamed to 'role' because that is how it would be named in ruby.
We chose to keep the method in the controller instead of moving it to the model because it does not alter the data structure and it also has selection logic.

== Make GUI changes in the form displayed after "Request Account" button is clicked ==
'''Problem''': 
The forms that come after "Request Account" button is clicked need to be changed. 
'''Solution''':
Only instructor accounts can be created, so the drop-down was removed. 
All form labels were bold-faced. 
The “Self Introduction” label was re-named to “Self-Introduction”. 
The text-box for the self-introduction field now includes a useful hint of what is expected in the text-box. The hint is "Please include a website name". 
==== Before it looked like this :====
[[File:Rsz_instructor_dropdown.png]] 

==== After it looks like this: ====
[[File:Rsz_new_instructor.png]] 

== Paginating the list of users ==
'''Problem''': 
When a list of all users are shown, the list is not paginated. So the instructors see a list of all users that have enrolled for a course over all the years that they have offered the course. 
'''Solution''': 
The existing project does not have the feature of pagination for the user list. So, currently, all the users are shown to the instructor. 
The paginate_list method is supposed to paginate the list of users. The method was not called anywhere and also the method logic was incorrect. 
With the latest implementation, the pagination is added with dropdown option - "25", "50", "100" and "ALL". 
The method "paginate_list" is corrected and called at right place. 
The default option is kept to "25" to reduce the web-page loading time. 
==== Before it looked like this: ====
[[File:Rsz_no_pagination.png]]
 

==== After it looks like this: ====
[[File:Rsz_pagination_implemented.png]]

As can be clearly seen, different pagination options are now provided at the lower part of the view.

== Test Plan ==

=== RSpec testing for account_requests_controller ===
'''Problem''': Since we created a new controller, tests for this controller did not exist. All those tests were written in the users_controller since that was where the methods were located earlier. 
'''Solution:''' 
We moved the tests from the users_controller_spec.rb file to the newly created accounts_request_controller.rb file. We also changed some tests in account_request_controller to route to their appropriate tests. 
It can be seen that all 11 test cases passed for account_request_controller. 
[[File:Rsz_test_accounts_request.png‎]] 

=== RSpec testing for users_controller ===
''' Problem: ''' 
The pagination for users_controller was not tested correctly in the previous implementation. We fixed this issue by writing a test for this.

''' Solution: ''' 
It can now be seen that all 18 test cases pass for users_controller.

[[File:Rsz test users.png]] 

== Manual Testing ==
The [http://152.46.17.33:8080 link] to our project instance. 

'''1) To view pending account requests:''' 
Login as the administrator. 
Username = administrator5 
Password = password 
Navigate to Manage(in the horizontal tab at the top of the page) -> Pending Requests. 
You will be able to see all the pending requests. The method that serves this view is in the newly created controller. So this is one way to test if the controller we wrote and the routes we configured are working. 

'''2) To test the changes in the form for Account Requests:''' 
Go to the login page. But do not log in. 
Click the Request Account button. 
You will be able to see the labels in bold and a hint of what should be entered in the last textbox. 

'''3) To test the pagination:''' 
Login as an instructor. 
username: instructor6 
password : password 
Navigate to Manage(in the horizontal tab at the top of the page) -> users. 
You will be able to see a list of users and page numbers where the list ends. You will also be able to select the number of users to show on each page using a dropdown at the top of the list. 

'''4) Other changes:''' 
To check if the build passed or not, [https://github.com/nikitaparanjape/expertiza/tree/beta this] is the repository which we forked from expertiza. If you navigate to this and scroll down to the README, you should be able to see the build status and test case coverage statistics. 
The other changes we made like renaming methods and documenting code are not so visible in the GUI and will have to be seen in the code.

== Design choices ==
''' 1) Partial Views''': 
There are some partial views which are related to displaying forms to create/edit a user in the Users view. The same partials were earlier being used for displaying forms for requesting a new account. Now that we separated the two controllers, we had the following options to deal with these duplicated partials. 
Option 1: 
Keep accessing the partials in the users view from the newly created Accounts_request view. This would make the code DRY but harder to understand. 
Option 2: 
Duplicate the partials in the accounts request view.This would make some render partial statements hard to read but would make the code DRY. 
Option 3: 
Create partial files in the views folder. Have Users_controller, Account_requests_controller access these partials. The code becomes DRY and also readable. 
We decided to go with the second option. Even though these forms contain the same code right now, due to changing requirements in the future, these views may need to be changed which would allow us to add more functionality in the future. This option gives some flexibility to the accounts_controller to modify the form without affecting the User's form. This design decision was taken with the permission our mentor.
The partials that are now duplicated are: _email, _name, _institution, _password, and _prefs which can be found in user and account_request views. 

''' 2) Refactoring variable names''': 
We refactored the variables names from requested_users to account_requests (in views, controller actions, etc.) since requested_users is a bad naming choice for our variable. As we are referring to AccountRequest model in our controllers, such renaming makes sense here. 
For example:
account_request = AccountRequest.all
makes more sense than
requested_users = AccountRequest.all

== Important Links ==
1. Expertiza Main page: [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Main Page] 
2. To show our design changes, we have hosted our implementation on VCL. The link is: [http://152.46.17.33:8080 VCL instance] 
3. Link to the pull request [https://github.com/expertiza/expertiza/pull/1367 Pull request.]

E1914 Refactor users controller

2019-03-29T17:35:40Z

Nparanj: /* Test Plan */

== About Expertiza ==
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. 
This document contains the description of the changes that we made to users_controller, how we refactored it, our testing results and some design decisions that we took while making these changes.

== Separate all methods related to the workflow of a RequestedUser object ==
'''Problem''': 
The users_controller.rb file included the standard CRUD methods for a User model along with methods for other workflows. The users_controller.rb file also handled the creation and management of a RequestedUser object in addition to handling the user object. 
'''Solution''': 
Earlier, there was no controllers for a RequestedUser object and these were handled by the Users controller itself. We separated the RequestedUser workflow from the Users and we renamed the RequestedUser model to AccountRequest.
As a part of this refactoring activity, we created a new controller called the account_requests_controller to handle the workflow of an AccountRequest.
The following methods were moved from users_controller to account_requests_controller. 
1) created_approved_user 
2) list_pending_requested 
3) request_new 
4) created_requested_user_record 
5) roles_for_request_sign_up 
6) requested_user_params 

== Writing comments to make methods more understandable ==
'''Problem''': 
The users_controller included a few methods which lacked documentation. 
'''Solution:''' 
===Wrote comments for the 'foreign' method. The comments include:===
'''1) What the method does:''' This method is used to find the list of roles the current user can embody. 
'''2) Where the method is used:''' Used to display a drop-down selection of roles for the current user in the views. 

===Wrote comments for the show and show_selection methods:===
'''1) What the method does:''' 
''show():'' If the current user is a student, they should only be able to see information about themselves. All other people should be able to see information about themselves or other students. If the request to show() passes these checks, then they are shown the view 'show'. Otherwise, they are redirected to the home page. 
''show_selection():'' If the role of a user's parent is less than the current user or if the current user is requesting to see itself or if user's parent_id does not exist then the show() method is called. All these conditions boil down to whether the current user of the system is authorized to see/edit the information about the user specified in the params. If the requested user does not exist or if the current user is not authorized to see the requested user, then the current user is redirected back to the list page. 
'''2) Scenarios in which show_selection is called:''' in users/list.html.erb, a list of users is shown. On top of the list there is a functionality to search the list. When a person searches for a particular student, and selects that student, the show_selection method is called. If the person is allowed to see that student, the user is directed to the show() method. Otherwise the person stays on the list view. 
'''3) Scenarios in which show() is called:''' From the edit.html.erb, if the person wants to see the information instead of editing it. From show_selection() as described above. 

== Renaming methods to reflect their actual behavior ==
'''Problem''': 
Methods in the Users_controller were not named to convey exactly what they did. 
'''Solution:''' 
The get_role method was named more like it would be in Java. It was renamed to 'role' because that is how it would be named in ruby.
We chose to keep the method in the controller instead of moving it to the model because it does not alter the data structure and it also has selection logic.

== Make GUI changes in the form displayed after "Request Account" button is clicked ==
'''Problem''': 
The forms that come after "Request Account" button is clicked need to be changed. 
'''Solution''':
Only instructor accounts can be created, so the drop-down was removed. 
All form labels were bold-faced. 
The “Self Introduction” label was re-named to “Self-Introduction”. 
The text-box for the self-introduction field now includes a useful hint of what is expected in the text-box. The hint is "Please include a website name". 
==== Before it looked like this :====
[[File:Rsz_instructor_dropdown.png]] 

==== After it looks like this: ====
[[File:Rsz_new_instructor.png]] 

== Paginating the list of users ==
'''Problem''': 
When a list of all users are shown, the list is not paginated. So the instructors see a list of all users that have enrolled for a course over all the years that they have offered the course. 
'''Solution''': 
The existing project does not have the feature of pagination for the user list. So, currently, all the users are shown to the instructor. 
The paginate_list method is supposed to paginate the list of users. The method was not called anywhere and also the method logic was incorrect. 
With the latest implementation, the pagination is added with dropdown option - "25", "50", "100" and "ALL". 
The method "paginate_list" is corrected and called at right place. 
The default option is kept to "25" to reduce the web-page loading time. 
==== Before it looked like this: ====
[[File:Rsz_no_pagination.png]]
 

==== After it looks like this: ====
[[File:Rsz_pagination_implemented.png]]

As can be clearly seen, different pagination options are now provided at the lower part of the view.

== Test Plan ==

=== RSpec testing for account_requests_controller ===
'''Problem''': Since we created a new controller, tests for this controller did not exist. All those tests were written in the users_controller since that was where the methods were located earlier. 
'''Solution:''' 
We moved the tests from the users_controller_spec.rb file to the newly created accounts_request_controller.rb file. We also changed some tests in account_request_controller to route to their appropriate tests. 
It can be seen that all 11 test cases passed for account_request_controller. 
[[File:Rsz_test_accounts_request.png‎]] 

=== RSpec testing for users_controller ===
''' Problem: ''' 
The pagination for users_controller was not tested correctly in the previous implementation. We fixed this issue by writing a test for this.

''' Solution: ''' 
It can now be seen that all 18 test cases pass for users_controller.

[[File:Rsz test users.png]] 

== Manual Testing ==
The [http://152.46.17.33:8080 link] to our project instance. 

'''1) To view pending account requests:''' 
Login as the administrator. 
Username = administrator5 
Password = password 
Navigate to Manage(in the horizontal tab at the top of the page) -> Pending Requests. 
You will be able to see all the pending requests. The method that serves this view is in the newly created controller. So this is one way to test if the controller we wrote and the routes we configured are working. 

'''2) To test the changes in the form for Account Requests:''' 
Go to the login page. But do not log in. 
Click the Request Account button. 
You will be able to see the labels in bold and a hint of what should be entered in the last textbox. 

'''3) To test the pagination:''' 
Login as an instructor. 
username: instructor6 
password : password 
Navigate to Manage(in the horizontal tab at the top of the page) -> users. 
You will be able to see a list of users and page numbers where the list ends. You will also be able to select the number of users to show on each page using a dropdown at the top of the list. 

'''4) Other changes:''' 
To check if the build passed or not, [https://github.com/nikitaparanjape/expertiza/tree/beta this] is the repository which we forked from expertiza. If you navigate to this and scroll down to the README, you should be able to see the build status and test case coverage statistics. 
The other changes we made like renaming methods and documenting code are not so visible in the GUI and will have to be seen in the code.

== Design choices ==
''' 1) Partial Views''': 
There are some partial views which are related to displaying forms to create/edit a user in the Users view. The same partials were earlier being used for displaying forms for requesting a new account. Now that we separated the two controllers, we had the following options to deal with these duplicated partials. 
Option 1: 
Keep accessing the partials in the users view from the newly created Accounts_request view. This would make the code DRY but harder to understand. 
Option 2: 
Duplicate the partials in the accounts request view.This would make some render partial statements hard to read but would make the code DRY. 
Option 3: 
Create partial files in the views folder. Have Users_controller, Account_requests_controller access these partials. The code becomes DRY and also readable. 
We decided to go with the second option. Even though these forms contain the same code right now, due to changing requirements in the future, these views may need to be changed which would allow us to add more functionality in the future. This option gives some flexibility to the accounts_controller to modify the form without affecting the User's form. This design decision was taken with the permission our mentor.
The partials that are now duplicated are: _email, _name, _institution, _password, and _prefs which can be found in user and account_request views. 

''' 2) Refactoring variable names''': 
We refactored the variables names from requested_users to account_requests (in views, controller actions, etc.) since requested_users is a bad naming choice for our variable. As we are referring to AccountRequest model in our controllers, such renaming makes sense here. 
For example:
account_request = AccountRequest.all
makes more sense than
requested_users = AccountRequest.all

== Important Links ==
1. Expertiza Main page: [http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Main Page] 
2. To show our design changes, we have hosted our implementation on VCL. The link is: [http://152.46.17.33:8080 VCL instance] 
3. Link to the pull request [https://github.com/expertiza/expertiza/pull/1367 Pull request.]

E1914 Refactor users controller

2019-03-28T23:38:46Z

Nparanj: /* Separate all methods related to the workflow of a RequestedUser object */

This is an Expertiza based OSS Project. 
The project is running on [http://152.46.17.33:8080 VCL instance] 
[https://github.com/expertiza/expertiza/pull/1367 The link to the pull request.] 
Each following section describes a problem that was present in the Users_controller. And the solution we implemented to solve it. 
In the last section, we defend some design decisions that we took during the process. 
== Separate all methods related to the workflow of a RequestedUser object ==
'''Problem''': 
The users_controller.rb file included the standard CRUD methods for a User model along with methods for other workflows. The users_controller.rb file also handled the creation and management of a RequestedUser object in addition to handling the user object. 
'''Solution''': 
Earlier, there was no controllers for a RequestedUser object and these were handled by the Users controller itself. We separated the RequestedUser workflow from the Users and we renamed the RequestedUser model to AccountRequest.
As a part of this refactoring activity, we created a new controller called the account_requests_controller to handle the workflow of an AccountRequest.
The following methods were moved from users_controller to account_requests_controller. 
1) created_approved_user 
2) list_pending_requested 
3) request_new 
4) created_requested_user_record 
5) roles_for_request_sign_up 
6) requested_user_params 

== RSpec testing for account_requests_controller ==
'''Problem''': Since we created a new controller, tests for this controller did not exist. All those tests were written in the users_controller since that was where the methods were located earlier. 
'''Solution:''' 
We moved the tests from the users_controller_spec.rb file to the newly created accounts_request_controller.rb file. We also had to change the tests a little to now reflect different routing expectations. 
It can be seen that all 11 test cases passed for account_request_controller. 
[[File:Rsz_test_accounts_request.png‎]]

== RSpec testing for users_controller ==
It can be seen that all 18 test cases passed for users_controller.

[[File:Rsz test users.png]]

== Writing comments to make methods more understandable ==
'''Problem''': 
The users_controller included a few methods which lacked documentation. 
'''Solution:''' 
===Wrote comments for the 'foreign' method. The comments include:===
'''1) What the method does:''' This method is used to find the list of roles the current user can embody. 
'''2) Where the method is used:''' Used to display a drop-down selection of roles for the current user in the views. 

===Wrote comments for the show and show_selection methods:===
'''1) What the method does:''' 
''show():'' If the current user is a student, they should only be able to see information about themselves. All other people should be able to see information about themselves or other students. If the request to show() passes these checks, then they are shown the view 'show'. Otherwise, they are redirected to the home page. 
''show_selection():'' If the role of a user's parent is less than the current user or if the current user is requesting to see itself or if user's parent_id does not exist then the show() method is called. All these conditions boil down to whether the current user of the system is authorized to see/edit the information about the user specified in the params. If the requested user does not exist or if the current user is not authorized to see the requested user, then the current user is redirected back to the list page. 
'''2) Scenarios in which show_selection is called:''' in users/list.html.erb, a list of users is shown. On top of the list there is a functionality to search the list. When a person searches for a particular student, and selects that student, the show_selection method is called. If the person is allowed to see that student, the user is directed to the show() method. Otherwise the person stays on the list view. 
'''3) Scenarios in which show() is called:''' From the edit.html.erb, if the person wants to see the information instead of editing it. From show_selection() as described above. 

== Renaming methods to reflect their actual behavior ==
'''Problem''': 
Methods in the Users_controller were not named to convey exactly what they did. 
'''Solution:''' 
The get_role method was named more like it would be in Java. It was renamed to 'role' because that is how it would be named in ruby.
We chose to keep the method in the controller instead of moving it to the model because it does not alter the data structure and it also has selection logic.

== Make GUI changes in the form displayed after "Request Account" button is clicked ==
'''Problem''': 
The forms that come after "Request Account" button is clicked need to be changed. 
'''Solution''':
Only instructor accounts can be created, so the drop-down was removed. 
All form labels were bold-faced. 
The “Self Introduction” label was re-named to “Self-Introduction”. 
The text-box for the self-introduction field now includes a useful hint of what is expected in the text-box. The hint is "Please include a website name". 
==== Before it looked like this :====
[[File:Rsz_instructor_dropdown.png]] 

==== After it looks like this: ====
[[File:Rsz_new_instructor.png]] 

== Paginating the list of users ==
'''Problem''': 
When a list of all users are shown, the list is not paginated. So the instructors see a list of all users that have enrolled for a course over all the years that they have offered the course. 
'''Solution''': 
The existing project does not have the feature of pagination for the user list. So, currently, all the users are shown to the instructor. 
The paginate_list method is supposed to paginate the list of users. The method was not called anywhere and also the method logic was incorrect. 
With the latest implementation, the pagination is added with dropdown option - "25", "50", "100" and "ALL". 
The method "paginate_list" is corrected and called at right place. 
The default option is kept to "25" to reduce the web-page loading time. 
==== Before it looked like this: ====
[[File:Rsz_no_pagination.png]]
 

==== After it looks like this: ====
[[File:Rsz_pagination_implemented.png]]

== Manual Testing ==
The [http://152.46.17.33:8080 link] to our project instance. 

'''1) To view pending account requests:''' 
Login as the administrator. 
Username = administrator5 
Password = password 
Navigate to Manage(in the horizontal tab at the top of the page) -> Pending Requests. 
You will be able to see all the pending requests. The method that serves this view is in the newly created controller. So this is one way to test if the controller we wrote and the routes we configured are working. 

'''2) To test the changes in the form for Account Requests:''' 
Go to the login page. But do not log in. 
Click the Request Account button. 
You will be able to see the labels in bold and a hint of what should be entered in the last textbox. 

'''3) To test the pagination:''' 
Login as an instructor. 
username: instructor6 
password : password 
Navigate to Manage(in the horizontal tab at the top of the page) -> users. 
You will be able to see a list of users and page numbers where the list ends. You will also be able to select the number of users to show on each page using a dropdown at the top of the list. 

'''4) Other changes:''' 
To check if the build passed or not, [https://github.com/nikitaparanjape/expertiza/tree/beta this] is the repository which we forked from expertiza. If you navigate to this and scroll down to the README, you should be able to see the build status and test case coverage statistics. 
The other changes we made like renaming methods and documenting code are not so visible in the GUI and will have to be seen in the code.

== Design choices ==
1.'''Partial Views''': 
There are some partial views which are related to displaying forms to create/edit a user in the Users view. The same partials were earlier being used for displaying forms for requesting a new account. Now that we separated the two controllers, we had the following options regarding what to do with the partials. 
Option 1) Keep accessing the partials in the users view from the newly created Accounts_request view. This would make the code DRY but harder to understand. 
Option 2) Duplicate the partials in the accounts request view. 
This would make some render partial statements hard to read but would make the code DRY. 
Option 3) Create partial files in the views folder. 
Have Users_controller, Account_requests_controller access these partials. The code becomes DRY and also readable. 
We decided to go with option 2. Even though the two forms happen to be the same right now, some time in the future, they may deviate. This option gives some flexibility to the accounts_controller to modify the form without affecting the User's form. 
The partials that are now duplicated are: _email, _name, _institution, _password, and _prefs. 

2.'''Refactoring variable names''': 
We refactored the variables names from requested_users to account_requests (in views, controller actions, etc.) since requested_users is a bad naming choice for our variable. As we are referring to AccountRequest model in our controllers, such renaming makes sense here. 
For example:
account_request = AccountRequest.all
makes more sense than
requested_users = AccountRequest.all

E1914 Refactor users controller

2019-03-28T23:36:08Z

Nparanj: /* Manual Testing */

This is an Expertiza based OSS Project. 
The project is running on [http://152.46.17.33:8080 VCL instance] 
[https://github.com/expertiza/expertiza/pull/1367 The link to the pull request.] 
Each following section describes a problem that was present in the Users_controller. And the solution we implemented to solve it. 
In the last section, we defend some design decisions that we took during the process. 
== Separate all methods related to the workflow of a RequestedUser object ==
'''Problem''': 
The users_controller.rb file included the standard CRUD methods for a User model along with methods for other workflows. The users_controller.rb file handled the creation and management of a RequestedUser object. 
'''Solution''': 
Earlier, there was no controllers for a RequestedUser object and these were handled by the Users controller itself. We separated the RequestedUser workflow from the Users and we renamed the RequestedUser model to AccountRequest.
As a part of this refactoring activity, we created a new controller called the account_requests_controller to handle the workflow of an AccountRequest.
The following methods were moved from users_controller to account_requests_controller. 
1) created_approved_user 
2) list_pending_requested 
3) request_new 
4) created_requested_user_record 
5) roles_for_request_sign_up 
6) requested_user_params 

== RSpec testing for account_requests_controller ==
'''Problem''': Since we created a new controller, tests for this controller did not exist. All those tests were written in the users_controller since that was where the methods were located earlier. 
'''Solution:''' 
We moved the tests from the users_controller_spec.rb file to the newly created accounts_request_controller.rb file. We also had to change the tests a little to now reflect different routing expectations. 
It can be seen that all 11 test cases passed for account_request_controller. 
[[File:Rsz_test_accounts_request.png‎]]

== RSpec testing for users_controller ==
It can be seen that all 18 test cases passed for users_controller.

[[File:Rsz test users.png]]

== Writing comments to make methods more understandable ==
'''Problem''': 
The users_controller included a few methods which lacked documentation. 
'''Solution:''' 
===Wrote comments for the 'foreign' method. The comments include:===
'''1) What the method does:''' This method is used to find the list of roles the current user can embody. 
'''2) Where the method is used:''' Used to display a drop-down selection of roles for the current user in the views. 

===Wrote comments for the show and show_selection methods:===
'''1) What the method does:''' 
''show():'' If the current user is a student, they should only be able to see information about themselves. All other people should be able to see information about themselves or other students. If the request to show() passes these checks, then they are shown the view 'show'. Otherwise, they are redirected to the home page. 
''show_selection():'' If the role of a user's parent is less than the current user or if the current user is requesting to see itself or if user's parent_id does not exist then the show() method is called. All these conditions boil down to whether the current user of the system is authorized to see/edit the information about the user specified in the params. If the requested user does not exist or if the current user is not authorized to see the requested user, then the current user is redirected back to the list page. 
'''2) Scenarios in which show_selection is called:''' in users/list.html.erb, a list of users is shown. On top of the list there is a functionality to search the list. When a person searches for a particular student, and selects that student, the show_selection method is called. If the person is allowed to see that student, the user is directed to the show() method. Otherwise the person stays on the list view. 
'''3) Scenarios in which show() is called:''' From the edit.html.erb, if the person wants to see the information instead of editing it. From show_selection() as described above. 

== Renaming methods to reflect their actual behavior ==
'''Problem''': 
Methods in the Users_controller were not named to convey exactly what they did. 
'''Solution:''' 
The get_role method was named more like it would be in Java. It was renamed to 'role' because that is how it would be named in ruby.
We chose to keep the method in the controller instead of moving it to the model because it does not alter the data structure and it also has selection logic.

== Make GUI changes in the form displayed after "Request Account" button is clicked ==
'''Problem''': 
The forms that come after "Request Account" button is clicked need to be changed. 
'''Solution''':
Only instructor accounts can be created, so the drop-down was removed. 
All form labels were bold-faced. 
The “Self Introduction” label was re-named to “Self-Introduction”. 
The text-box for the self-introduction field now includes a useful hint of what is expected in the text-box. The hint is "Please include a website name". 
==== Before it looked like this :====
[[File:Rsz_instructor_dropdown.png]] 

==== After it looks like this: ====
[[File:Rsz_new_instructor.png]] 

== Paginating the list of users ==
'''Problem''': 
When a list of all users are shown, the list is not paginated. So the instructors see a list of all users that have enrolled for a course over all the years that they have offered the course. 
'''Solution''': 
The existing project does not have the feature of pagination for the user list. So, currently, all the users are shown to the instructor. 
The paginate_list method is supposed to paginate the list of users. The method was not called anywhere and also the method logic was incorrect. 
With the latest implementation, the pagination is added with dropdown option - "25", "50", "100" and "ALL". 
The method "paginate_list" is corrected and called at right place. 
The default option is kept to "25" to reduce the web-page loading time. 
==== Before it looked like this: ====
[[File:Rsz_no_pagination.png]]
 

==== After it looks like this: ====
[[File:Rsz_pagination_implemented.png]]

== Manual Testing ==
The [http://152.46.17.33:8080 link] to our project instance. 

'''1) To view pending account requests:''' 
Login as the administrator. 
Username = administrator5 
Password = password 
Navigate to Manage(in the horizontal tab at the top of the page) -> Pending Requests. 
You will be able to see all the pending requests. The method that serves this view is in the newly created controller. So this is one way to test if the controller we wrote and the routes we configured are working. 

'''2) To test the changes in the form for Account Requests:''' 
Go to the login page. But do not log in. 
Click the Request Account button. 
You will be able to see the labels in bold and a hint of what should be entered in the last textbox. 

'''3) To test the pagination:''' 
Login as an instructor. 
username: instructor6 
password : password 
Navigate to Manage(in the horizontal tab at the top of the page) -> users. 
You will be able to see a list of users and page numbers where the list ends. You will also be able to select the number of users to show on each page using a dropdown at the top of the list. 

'''4) Other changes:''' 
To check if the build passed or not, [https://github.com/nikitaparanjape/expertiza/tree/beta this] is the repository which we forked from expertiza. If you navigate to this and scroll down to the README, you should be able to see the build status and test case coverage statistics. 
The other changes we made like renaming methods and documenting code are not so visible in the GUI and will have to be seen in the code.

== Design choices ==
1.'''Partial Views''': 
There are some partial views which are related to displaying forms to create/edit a user in the Users view. The same partials were earlier being used for displaying forms for requesting a new account. Now that we separated the two controllers, we had the following options regarding what to do with the partials. 
Option 1) Keep accessing the partials in the users view from the newly created Accounts_request view. This would make the code DRY but harder to understand. 
Option 2) Duplicate the partials in the accounts request view. 
This would make some render partial statements hard to read but would make the code DRY. 
Option 3) Create partial files in the views folder. 
Have Users_controller, Account_requests_controller access these partials. The code becomes DRY and also readable. 
We decided to go with option 2. Even though the two forms happen to be the same right now, some time in the future, they may deviate. This option gives some flexibility to the accounts_controller to modify the form without affecting the User's form. 
The partials that are now duplicated are: _email, _name, _institution, _password, and _prefs. 

2.'''Refactoring variable names''': 
We refactored the variables names from requested_users to account_requests (in views, controller actions, etc.) since requested_users is a bad naming choice for our variable. As we are referring to AccountRequest model in our controllers, such renaming makes sense here. 
For example:
account_request = AccountRequest.all
makes more sense than
requested_users = AccountRequest.all

E1914 Refactor users controller

2019-03-28T23:33:01Z

Nparanj: /* Manual Testing */

This is an Expertiza based OSS Project. 
The project is running on [http://152.46.17.33:8080 VCL instance] 
[https://github.com/expertiza/expertiza/pull/1367 The link to the pull request.] 
Each following section describes a problem that was present in the Users_controller. And the solution we implemented to solve it. 
In the last section, we defend some design decisions that we took during the process. 
== Separate all methods related to the workflow of a RequestedUser object ==
'''Problem''': 
The users_controller.rb file included the standard CRUD methods for a User model along with methods for other workflows. The users_controller.rb file handled the creation and management of a RequestedUser object. 
'''Solution''': 
Earlier, there was no controllers for a RequestedUser object and these were handled by the Users controller itself. We separated the RequestedUser workflow from the Users and we renamed the RequestedUser model to AccountRequest.
As a part of this refactoring activity, we created a new controller called the account_requests_controller to handle the workflow of an AccountRequest.
The following methods were moved from users_controller to account_requests_controller. 
1) created_approved_user 
2) list_pending_requested 
3) request_new 
4) created_requested_user_record 
5) roles_for_request_sign_up 
6) requested_user_params 

== RSpec testing for account_requests_controller ==
'''Problem''': Since we created a new controller, tests for this controller did not exist. All those tests were written in the users_controller since that was where the methods were located earlier. 
'''Solution:''' 
We moved the tests from the users_controller_spec.rb file to the newly created accounts_request_controller.rb file. We also had to change the tests a little to now reflect different routing expectations. 
It can be seen that all 11 test cases passed for account_request_controller. 
[[File:Rsz_test_accounts_request.png‎]]

== RSpec testing for users_controller ==
It can be seen that all 18 test cases passed for users_controller.

[[File:Rsz test users.png]]

== Writing comments to make methods more understandable ==
'''Problem''': 
The users_controller included a few methods which lacked documentation. 
'''Solution:''' 
===Wrote comments for the 'foreign' method. The comments include:===
'''1) What the method does:''' This method is used to find the list of roles the current user can embody. 
'''2) Where the method is used:''' Used to display a drop-down selection of roles for the current user in the views. 

===Wrote comments for the show and show_selection methods:===
'''1) What the method does:''' 
''show():'' If the current user is a student, they should only be able to see information about themselves. All other people should be able to see information about themselves or other students. If the request to show() passes these checks, then they are shown the view 'show'. Otherwise, they are redirected to the home page. 
''show_selection():'' If the role of a user's parent is less than the current user or if the current user is requesting to see itself or if user's parent_id does not exist then the show() method is called. All these conditions boil down to whether the current user of the system is authorized to see/edit the information about the user specified in the params. If the requested user does not exist or if the current user is not authorized to see the requested user, then the current user is redirected back to the list page. 
'''2) Scenarios in which show_selection is called:''' in users/list.html.erb, a list of users is shown. On top of the list there is a functionality to search the list. When a person searches for a particular student, and selects that student, the show_selection method is called. If the person is allowed to see that student, the user is directed to the show() method. Otherwise the person stays on the list view. 
'''3) Scenarios in which show() is called:''' From the edit.html.erb, if the person wants to see the information instead of editing it. From show_selection() as described above. 

== Renaming methods to reflect their actual behavior ==
'''Problem''': 
Methods in the Users_controller were not named to convey exactly what they did. 
'''Solution:''' 
The get_role method was named more like it would be in Java. It was renamed to 'role' because that is how it would be named in ruby.
We chose to keep the method in the controller instead of moving it to the model because it does not alter the data structure and it also has selection logic.

== Make GUI changes in the form displayed after "Request Account" button is clicked ==
'''Problem''': 
The forms that come after "Request Account" button is clicked need to be changed. 
'''Solution''':
Only instructor accounts can be created, so the drop-down was removed. 
All form labels were bold-faced. 
The “Self Introduction” label was re-named to “Self-Introduction”. 
The text-box for the self-introduction field now includes a useful hint of what is expected in the text-box. The hint is "Please include a website name". 
==== Before it looked like this :====
[[File:Rsz_instructor_dropdown.png]] 

==== After it looks like this: ====
[[File:Rsz_new_instructor.png]] 

== Paginating the list of users ==
'''Problem''': 
When a list of all users are shown, the list is not paginated. So the instructors see a list of all users that have enrolled for a course over all the years that they have offered the course. 
'''Solution''': 
The existing project does not have the feature of pagination for the user list. So, currently, all the users are shown to the instructor. 
The paginate_list method is supposed to paginate the list of users. The method was not called anywhere and also the method logic was incorrect. 
With the latest implementation, the pagination is added with dropdown option - "25", "50", "100" and "ALL". 
The method "paginate_list" is corrected and called at right place. 
The default option is kept to "25" to reduce the web-page loading time. 
==== Before it looked like this: ====
[[File:Rsz_no_pagination.png]]
 

==== After it looks like this: ====
[[File:Rsz_pagination_implemented.png]]

== Manual Testing ==
The [http://152.46.17.33:8080 link] to our project instance. 

'''1) To view pending account requests:''' 
Login as the administrator. 
Username = administrator5 
Password = password 
Navigate to Manage(in the horizontal tab at the top of the page) -> Pending Requests. 
You will be able to see all the pending requests. The method that serves this view is in the newly created controller. So this is one way to test if the controller we wrote and the routes we configured are working. 

'''2) To test the changes in the form for Account Requests:''' 
Go to the login page. But do not log in. 
Click the Request Account button. 
You will be able to see the labels in bold and a hint of what should be entered in the last textbox. 

'''3) To test the pagination:''' 
Login as an instructor. 
username: instructor6 
password : password 
Navigate to Manage(in the horizontal tab at the top of the page) -> users. 
You will be able to see a list of users and page numbers where the list ends. You will also be able to select the number of users to show on each page using a dropdown at the top of the list. 

'''4) Other changes:''' 
The other changes we made like renaming methods and documenting code are not so visible in the GUI and will have to be seen in the code.

== Design choices ==
1.'''Partial Views''': 
There are some partial views which are related to displaying forms to create/edit a user in the Users view. The same partials were earlier being used for displaying forms for requesting a new account. Now that we separated the two controllers, we had the following options regarding what to do with the partials. 
Option 1) Keep accessing the partials in the users view from the newly created Accounts_request view. This would make the code DRY but harder to understand. 
Option 2) Duplicate the partials in the accounts request view. 
This would make some render partial statements hard to read but would make the code DRY. 
Option 3) Create partial files in the views folder. 
Have Users_controller, Account_requests_controller access these partials. The code becomes DRY and also readable. 
We decided to go with option 2. Even though the two forms happen to be the same right now, some time in the future, they may deviate. This option gives some flexibility to the accounts_controller to modify the form without affecting the User's form. 
The partials that are now duplicated are: _email, _name, _institution, _password, and _prefs. 

2.'''Refactoring variable names''': 
We refactored the variables names from requested_users to account_requests (in views, controller actions, etc.) since requested_users is a bad naming choice for our variable. As we are referring to AccountRequest model in our controllers, such renaming makes sense here. 
For example:
account_request = AccountRequest.all
makes more sense than
requested_users = AccountRequest.all

E1914 Refactor users controller

2019-03-28T23:32:19Z

Nparanj: /* Manual Testing */

This is an Expertiza based OSS Project. 
The project is running on [http://152.46.17.33:8080 VCL instance] 
[https://github.com/expertiza/expertiza/pull/1367 The link to the pull request.] 
Each following section describes a problem that was present in the Users_controller. And the solution we implemented to solve it. 
In the last section, we defend some design decisions that we took during the process. 
== Separate all methods related to the workflow of a RequestedUser object ==
'''Problem''': 
The users_controller.rb file included the standard CRUD methods for a User model along with methods for other workflows. The users_controller.rb file handled the creation and management of a RequestedUser object. 
'''Solution''': 
Earlier, there was no controllers for a RequestedUser object and these were handled by the Users controller itself. We separated the RequestedUser workflow from the Users and we renamed the RequestedUser model to AccountRequest.
As a part of this refactoring activity, we created a new controller called the account_requests_controller to handle the workflow of an AccountRequest.
The following methods were moved from users_controller to account_requests_controller. 
1) created_approved_user 
2) list_pending_requested 
3) request_new 
4) created_requested_user_record 
5) roles_for_request_sign_up 
6) requested_user_params 

== RSpec testing for account_requests_controller ==
'''Problem''': Since we created a new controller, tests for this controller did not exist. All those tests were written in the users_controller since that was where the methods were located earlier. 
'''Solution:''' 
We moved the tests from the users_controller_spec.rb file to the newly created accounts_request_controller.rb file. We also had to change the tests a little to now reflect different routing expectations. 
It can be seen that all 11 test cases passed for account_request_controller. 
[[File:Rsz_test_accounts_request.png‎]]

== RSpec testing for users_controller ==
It can be seen that all 18 test cases passed for users_controller.

[[File:Rsz test users.png]]

== Writing comments to make methods more understandable ==
'''Problem''': 
The users_controller included a few methods which lacked documentation. 
'''Solution:''' 
===Wrote comments for the 'foreign' method. The comments include:===
'''1) What the method does:''' This method is used to find the list of roles the current user can embody. 
'''2) Where the method is used:''' Used to display a drop-down selection of roles for the current user in the views. 

===Wrote comments for the show and show_selection methods:===
'''1) What the method does:''' 
''show():'' If the current user is a student, they should only be able to see information about themselves. All other people should be able to see information about themselves or other students. If the request to show() passes these checks, then they are shown the view 'show'. Otherwise, they are redirected to the home page. 
''show_selection():'' If the role of a user's parent is less than the current user or if the current user is requesting to see itself or if user's parent_id does not exist then the show() method is called. All these conditions boil down to whether the current user of the system is authorized to see/edit the information about the user specified in the params. If the requested user does not exist or if the current user is not authorized to see the requested user, then the current user is redirected back to the list page. 
'''2) Scenarios in which show_selection is called:''' in users/list.html.erb, a list of users is shown. On top of the list there is a functionality to search the list. When a person searches for a particular student, and selects that student, the show_selection method is called. If the person is allowed to see that student, the user is directed to the show() method. Otherwise the person stays on the list view. 
'''3) Scenarios in which show() is called:''' From the edit.html.erb, if the person wants to see the information instead of editing it. From show_selection() as described above. 

== Renaming methods to reflect their actual behavior ==
'''Problem''': 
Methods in the Users_controller were not named to convey exactly what they did. 
'''Solution:''' 
The get_role method was named more like it would be in Java. It was renamed to 'role' because that is how it would be named in ruby.
We chose to keep the method in the controller instead of moving it to the model because it does not alter the data structure and it also has selection logic.

== Make GUI changes in the form displayed after "Request Account" button is clicked ==
'''Problem''': 
The forms that come after "Request Account" button is clicked need to be changed. 
'''Solution''':
Only instructor accounts can be created, so the drop-down was removed. 
All form labels were bold-faced. 
The “Self Introduction” label was re-named to “Self-Introduction”. 
The text-box for the self-introduction field now includes a useful hint of what is expected in the text-box. The hint is "Please include a website name". 
==== Before it looked like this :====
[[File:Rsz_instructor_dropdown.png]] 

==== After it looks like this: ====
[[File:Rsz_new_instructor.png]] 

== Paginating the list of users ==
'''Problem''': 
When a list of all users are shown, the list is not paginated. So the instructors see a list of all users that have enrolled for a course over all the years that they have offered the course. 
'''Solution''': 
The existing project does not have the feature of pagination for the user list. So, currently, all the users are shown to the instructor. 
The paginate_list method is supposed to paginate the list of users. The method was not called anywhere and also the method logic was incorrect. 
With the latest implementation, the pagination is added with dropdown option - "25", "50", "100" and "ALL". 
The method "paginate_list" is corrected and called at right place. 
The default option is kept to "25" to reduce the web-page loading time. 
==== Before it looked like this: ====
[[File:Rsz_no_pagination.png]]
 

==== After it looks like this: ====
[[File:Rsz_pagination_implemented.png]]

== Manual Testing ==
The [http://152.46.17.33:8080 link] to our project instance. 

'''1) To view pending account requests:''' 
Login as the administrator. 
Username = administrator5 
Password = password 
Navigate to Manage(in the horizontal tab at the top of the page) -> Pending Requests. 
You will be able to see all the pending requests. The method that serves this view is in the newly created controller. So this is one way to test if the controller we wrote and the routes we configured are working. 

'''2) To test the changes in the form for Account Requests:''' 
Go to the login page. But do not log in. 
Click the Request Account button. 
You will be able to see the labels in bold and a hint of what should be entered in the last textbox. 

'''3) To test the pagination:''' 
Login as an instructor. 
username: instructor6
password : password
Navigate to Manage(in the horizontal tab at the top of the page) -> users. 
You will be able to see a list of users and page numbers where the list ends. You will also be able to select the number of users to show on each page using a dropdown at the top of the list. 

'''4) Other changes:''' 
The other changes we made like renaming methods and documenting code are not so visible in the GUI and will have to be seen in the code.

== Design choices ==
1.'''Partial Views''': 
There are some partial views which are related to displaying forms to create/edit a user in the Users view. The same partials were earlier being used for displaying forms for requesting a new account. Now that we separated the two controllers, we had the following options regarding what to do with the partials. 
Option 1) Keep accessing the partials in the users view from the newly created Accounts_request view. This would make the code DRY but harder to understand. 
Option 2) Duplicate the partials in the accounts request view. 
This would make some render partial statements hard to read but would make the code DRY. 
Option 3) Create partial files in the views folder. 
Have Users_controller, Account_requests_controller access these partials. The code becomes DRY and also readable. 
We decided to go with option 2. Even though the two forms happen to be the same right now, some time in the future, they may deviate. This option gives some flexibility to the accounts_controller to modify the form without affecting the User's form. 
The partials that are now duplicated are: _email, _name, _institution, _password, and _prefs. 

2.'''Refactoring variable names''': 
We refactored the variables names from requested_users to account_requests (in views, controller actions, etc.) since requested_users is a bad naming choice for our variable. As we are referring to AccountRequest model in our controllers, such renaming makes sense here. 
For example:
account_request = AccountRequest.all
makes more sense than
requested_users = AccountRequest.all