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-27T01:34:26Z

Drupadhy: /* Links */

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

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

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

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

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

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

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

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

* 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.<br>

* 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.<br>

* 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. <br>

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

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

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

== 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.<br>
'''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] <br>
[https://github.com/expertiza/expertiza/pull/1464 GitHub Pull Request] <br>

== References ==
[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza Wiki] <br>
[https://expertiza.ncsu.edu/ Expertiza Home]<br>
[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:06:19Z

Drupadhy: /* 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.<br>

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

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

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

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

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

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

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

* 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.<br>

* 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.<br>

* 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. <br>

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

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

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

== 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.<br>
'''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] <br>
[https://expertiza.ncsu.edu/ Expertiza Home]<br>
[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:46Z

Drupadhy: /* 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.<br>

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

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

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

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

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

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

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

* 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.<br>

* 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.<br>

* 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. <br>

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

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

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

== 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.<br>
'''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] <br>
[https://expertiza.ncsu.edu/ Expertiza Home]<br>
[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:00:08Z

Drupadhy: /* 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.<br>

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

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

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

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

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

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

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

* 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.<br>

* 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.<br>

* 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. <br>

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

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

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

== 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.<br>
'''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] <br>
[https://expertiza.ncsu.edu/ Expertiza Home]<br>
[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-13T02:15:46Z

Drupadhy:

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

== 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 TA to select a subset of 'public' reviews, and make those reviews visible as sample reviews of the particular assignment.
# 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 he/she has 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. <br>

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

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

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

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

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

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

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

* 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").<br>

* 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.<br>

* 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] <br>
[https://expertiza.ncsu.edu/ Expertiza Home]<br>

==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-13T02:15:09Z

Drupadhy: /* 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.<br>

== 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 TA to select a subset of 'public' reviews, and make those reviews visible as sample reviews of the particular assignment.
# 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 he/she has 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. <br>

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

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

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

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

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

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

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

* 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").<br>

* 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.<br>

* 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] <br>
[https://expertiza.ncsu.edu/ Expertiza Home]<br>

==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-13T02:14:16Z

Drupadhy:

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

== 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 TA to select a subset of 'public' reviews, and make those reviews visible as sample reviews of the particular assignment.
# 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 he/she has 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. <br>

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

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

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

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

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

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

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

* 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").<br>

* 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.<br>

* 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] <br>
[https://expertiza.ncsu.edu/ Expertiza Home]<br>

==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-12T23:01:10Z

Drupadhy: /* 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 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.<br>

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

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

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

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

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

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

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

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

* 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").<br>

* 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.<br>

* 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] <br>
[https://expertiza.ncsu.edu/ Expertiza Home]<br>

==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-12T22:57:32Z

Drupadhy:

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

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

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

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

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

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

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

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

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

* 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").<br>

* 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.<br>

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

[[File:Marked as sample.png]]

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

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

==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-12T22:53:59Z

Drupadhy: /* 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.<br>

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

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

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

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

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

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

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

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

* 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").<br>

* 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.<br>

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

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

==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-12T22:53:36Z

Drupadhy: /* 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 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.<br>

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

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

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

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

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

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

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

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

* 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").<br>

* 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.<br>

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

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

==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-12T22:50:47Z

Drupadhy: /* DB Design */

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

2019-04-12T22:50:33Z

Drupadhy: /* DB design (new: along with changes) */

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

2019-04-12T22:50:05Z

Drupadhy: /* DB Design (Previous team) */

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

2019-04-12T22:49:19Z

Drupadhy: /* DB design(new: along with changes) */

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

2019-04-12T22:37:41Z

Drupadhy: /* DB Design */

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

2019-04-12T19:23:59Z

Drupadhy:

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

2019-04-12T19:19:30Z

Drupadhy:

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

2019-04-08T22:05:07Z

Drupadhy:

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

2019-04-08T21:51:44Z

Drupadhy: /* Team Members */

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

2019-04-08T21:51:09Z

Drupadhy: /* Implementation */

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

2019-04-08T21:50:35Z

Drupadhy:

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

2019-04-08T21:49:31Z

Drupadhy:

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

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

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

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

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

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

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

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

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

* 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").<br>

* 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.<br>

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

==References==

==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-08T21:46:45Z

Drupadhy:

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

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

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

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

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

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

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

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

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

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

* 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").<br>

* 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.<br>

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

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

2019-04-08T21:44:57Z

Drupadhy: /* Reviews in Expertiza */

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

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

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

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

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

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

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

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

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

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

* 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").<br>

* 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.<br>

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

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

2019-04-08T21:42:50Z

Drupadhy: /* Files that will change */

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

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

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

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

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

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

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

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

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

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

* 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").<br>

* 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.<br>

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

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

2019-04-08T21:42:24Z

Drupadhy: /* Files that will change */

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

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

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

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

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

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

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

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

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

* Create a checkbox in a view: '''views/response/response.html.erb''':333.<br>

* 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").<br>

* 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.<br>

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

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

2019-04-08T20:43:01Z

Drupadhy: /* 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?<br>

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

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

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

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

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

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

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

== 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 <br>
* 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 - Project E1912. Export Tagged Comments

2019-04-02T02:54:26Z

Drupadhy:

==Introduction==
===About Expertiza===
Expertiza is an Open Source Web Application Software managed by National Science Foundation. Expertiza is used by many courses including CSC 517 for assignment management. It has functionalities such as peer reviews, teammate reviews and tagging reviews in which students can provide feedback on other's work which helps peer in better developing the project.

===Motivation===
The Expertiza team currently had to manually fire queries in the database in order to get the tag submissions made by an individual user(student) on each review for a particular assignment. In this way, the team got the data from the entire class, which was then used to feed the Machine Learning algorithms. But many times it used to happen that students made random tags and the ML algorithm was not able to make good predictions out of it, hence in order to solve this issue a new idea was proposed as to select on the students which did not create outliers in the predictions and hence, therefore, it is a good proposal.

===Tasks Identified===
In order to perform this task following files were identified where the code hasbeen added.
* In _answer_tagging_report.html.erb view, a button is added for exporting the student's tagged values
* A checkbox for each row has been added in order to select students whose tags are to be exported(By default all will be selected).
* A method is written in export_file_controller.rb controller named export_tags that exports the CSV file.

==Implementation==
The workflow diagram of our implementation is shown here:

[[File:E1912flow.png]]

We have added a default select all checkbox under ''Report tags done by each user'' which enables student selection for exporting tags in the CSV file. We have added a column for the checkbox and a button named '''Export''' which on click generates the CSV file.

[[File:Eb1912Export.png]]

Below is the snippet of the same view ''_answer_tagging_report.html.erb ''

<pre>
<%= form_tag(export_tags, method: 'put',:id => 'tst') do %>
<div id="tab-summary">
<h4 align="center">Summary for each user</h4>
<table class="table table-striped sortable">
<thead>
<tr>
<th class="sorter-true">Username</th>
<th class="sorter-true">Name</th>
<th class="sorter-true">Percentage of tags done</th>
<th class="sorter-true"># tags done</th>
<th class="sorter-true"># tags not done</th>
<th class="sorter-true"># possible tags to do<img src='/assets/info.png' title='Number of answers that fulfil the prerequisite setup for each
tags (Answer of certain question types and has a length of greater than the threshold).'/></th>
<th>Tags export</th>
</tr>
</thead>
<% @user_tagging_report.each do |key, val| %>
<tr>
<td><%= val.user.name(session[:ip]) %></td>
<td><%= val.user.fullname(session[:ip]) %></td>
<td><%= val.percentage.to_s %>%</td>
<td><%= val.no_tagged.to_s %></td>
<td><%= val.no_not_tagged.to_s %></td>
<td><%= val.no_tagable %></td>
<td><%= check_box_tag 'names[]', val.user.name(session[:ip]), true %></td>
</tr>
<% end %>
</table>
</div>
<%= submit_tag "Export",:value => 'Export' ,:form => 'tst',method: 'put' %>
<% end %>
</pre>

==Screencast==
# [https://drive.google.com/open?id=1B65_N3bWwPlSyiXMhXzXypKvKLN09g0r Here] is the link to a screen recording on how to access the functionality and export the CSV file.

==Code and Snapshots==

We have written a method inside the ''export_file_controller.rb''. Once this method is called it queries on the ''name'' array passed from the view and exports the CSV file with the required data.

<pre>
def export_tags
@user_ids = User.where("name IN (?)", params[:names])
@students = AnswerTag.select('answers.*, answer_tags.*').joins(:answer).where("answer_tags.answer_id = answers.id and answer_tags.user_id IN (?)", @user_ids.pluck(:id))
attributes = %w[user_id tag_prompt_deployment_id comments value]

csv_data = CSV.generate(col_sep: ",") do |csv|
csv << attributes
@students.each do |item|
csv << item.attributes.values_at(*attributes)
end
end
filename = "Tags"

send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=#{filename}.csv"

end
</pre>

The output file has '''user_id, tag_prompt_deployment_id, comments and value'''. We can see that some comments are repeated it is because every review that is received has at least 1 tag for it. Hence we see the repetition. The value column has -1, 0 and 1 as No, not answered and Yes meaning respectively.

[[File:Eb1912csv.png]]

==Design==
The functionality for our project was to implement exporting of tagged comments from the Expertiza system. For this, we will approach the project by using the delegation pattern to add exporting capabilities to the export file controller for exporting tags.

==Teammates==
Mentor - Harsh Agrawal

* Aishwarya Subramanian (asubram7)
* Dyuti De (dde)
* Ankit Mody (amody)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Spring 2019 - Project E1912. Export Tagged Comments

2019-04-02T02:53:59Z

Drupadhy: Undo revision 123082 by Drupadhy (talk)

==Introduction==
===About Expertiza===
Expertiza is an Open Source Web Application Software managed by National Science Foundation. Expertiza is used by many courses including CSC 517 for assignment management. It has functionalities such as peer reviews, teammate reviews and tagging reviews in which students can provide feedback on other's work which helps peer in better developing the project.

===Motivation===
The Expertiza team currently had to manually fire queries in the database in order to get the tag submissions made by an individual user(student) on each review for a particular assignment. In this way, the team got the data from the entire class, which was then used to feed the Machine Learning algorithms. But many times it used to happen that students made random tags and the ML algorithm was not able to make good predictions out of it, hence in order to solve this issue a new idea was proposed as to select on the students which did not create outliers in the predictions and hence, therefore, it is a good proposal.

===Tasks Identified===
In order to perform this task following files were identified where the code hasbeen added.
* In _answer_tagging_report.html.erb view, a button is added for exporting the student's tagged values
* A checkbox for each row has been added in order to select students whose tags are to be exported(By default all will be selected).
* A method is written in export_file_controller.rb controller named export_tags that exports the CSV file.

==Implementation==
The workflow diagram of our implementation is shown here:

[[File:E1912flow.png]]

We have added a default select all checkbox under ''Report tags done by each user'' which enables student selection for exporting tags in the CSV file. We have added a column for the checkbox and a button named '''Export''' which on click generates the CSV file.

[[File:Eb1912Export.png]]

Below is the snippet of the same view ''_answer_tagging_report.html.erb ''

<pre>
<%= form_tag(export_tags, method: 'put',:id => 'tst') do %>
<div id="tab-summary">
<h4 align="center">Summary for each user</h4>
<table class="table table-striped sortable">
<thead>
<tr>
<th class="sorter-true">Username</th>
<th class="sorter-true">Name</th>
<th class="sorter-true">Percentage of tags done</th>
<th class="sorter-true"># tags done</th>
<th class="sorter-true"># tags not done</th>
<th class="sorter-true"># possible tags to do<img src='/assets/info.png' title='Number of answers that fulfil the prerequisite setup for each
tags (Answer of certain question types and has a length of greater than the threshold).'/></th>
<th>Tags export</th>
</tr>
</thead>
<% @user_tagging_report.each do |key, val| %>
<tr>
<td><%= val.user.name(session[:ip]) %></td>
<td><%= val.user.fullname(session[:ip]) %></td>
<td><%= val.percentage.to_s %>%</td>
<td><%= val.no_tagged.to_s %></td>
<td><%= val.no_not_tagged.to_s %></td>
<td><%= val.no_tagable %></td>
<td><%= check_box_tag 'names[]', val.user.name(session[:ip]), true %></td>
</tr>
<% end %>
</table>
</div>
<%= submit_tag "Export",:value => 'Export' ,:form => 'tst',method: 'put' %>
<% end %>
</pre>

==Screen Record==
# [https://drive.google.com/open?id=1B65_N3bWwPlSyiXMhXzXypKvKLN09g0r Here] is the link to a screen recording on how to access the functionality and export the CSV file.

==Code and Snapshots==

We have written a method inside the ''export_file_controller.rb''. Once this method is called it queries on the ''name'' array passed from the view and exports the CSV file with the required data.

<pre>
def export_tags
@user_ids = User.where("name IN (?)", params[:names])
@students = AnswerTag.select('answers.*, answer_tags.*').joins(:answer).where("answer_tags.answer_id = answers.id and answer_tags.user_id IN (?)", @user_ids.pluck(:id))
attributes = %w[user_id tag_prompt_deployment_id comments value]

csv_data = CSV.generate(col_sep: ",") do |csv|
csv << attributes
@students.each do |item|
csv << item.attributes.values_at(*attributes)
end
end
filename = "Tags"

send_data csv_data,
type: 'text/csv; charset=iso-8859-1; header=present',
disposition: "attachment; filename=#{filename}.csv"

end
</pre>

The output file has '''user_id, tag_prompt_deployment_id, comments and value'''. We can see that some comments are repeated it is because every review that is received has at least 1 tag for it. Hence we see the repetition. The value column has -1, 0 and 1 as No, not answered and Yes meaning respectively.

[[File:Eb1912csv.png]]

==Design==
The functionality for our project was to implement exporting of tagged comments from the Expertiza system. For this, we will approach the project by using the delegation pattern to add exporting capabilities to the export file controller for exporting tags.

==Teammates==
Mentor - Harsh Agrawal

* Aishwarya Subramanian (asubram7)
* Dyuti De (dde)
* Ankit Mody (amody)

==References==
# [https://github.com/expertiza/expertiza Github Repository for Expertiza]
# [http://wiki.expertiza.ncsu.edu/index.php/Documentation_on_Database_Tables Expertiza Documentation on Database Tables]
# [https://guides.rubyonrails.org/api_app.html Rails Guide Documentation]

CSC/ECE 517 Spring 2019 - Project E1912. Export Tagged Comments

2019-04-02T02:52:42Z

Drupadhy: /* Screen Record */

CSC/ECE 517 Spring 2019 - Project E1913. Refactor review mapping helper.rb

2019-04-02T02:45:16Z

Drupadhy:

==Introduction==
This page gives a description of the changes made for the ''review_mapping_helper.rb'' of Expertiza based OSS project.

===Expertiza Background ===
Expertiza is a web application where students can submit and peer-review learning objects (articles, codes, websites, etc). Instructors add and grade the assignments submitted by students to Expertiza. Students can be assigned in teams based on their selection of the topics. It has functionalities such as peer reviews in which students can provide feedback on other's work which helps peer in better developing the project. It is supported by the National Science Foundation.

=== Problem Statement ===

The review_mapping_helper.rb has multiple functions with a wrong naming convention, they are classic examples of bad function names. These functions are to be refactored accordingly. Few of the variables names used in the method must also be refactored to make it more relevant and understandable. In addition, some function's code is to be optimized to ensure that it follows DRY principle. Tests must be written for the functions which are modified. Also, comments must be added to all functions of the file. The create_report_table_header function contains HTML code which should be ideally placed in the view as partials, which will allow to easily reuse the code in Rails application.

==Implementation==

===Flowchart===

The following process is carried out to complete the project-

[[File:Steps for project.png]]

===Refactoring===

====Refactoring method names====
All the method names that are refactored are mentioned below-

'''Before:'''

get_each_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_each_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_certain_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_certain_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_team_name_color_in_review_report

'''After:'''

get_team_colour ''[The method suggests that team color is defined in the review report, so we do not need to put in_review_report in the method name]''

'''Before:'''

get_each_round_score_awarded_for_review_report

'''After:'''

get_awarded_review_score ''[The method gets the awarded score for review, so we do not need to put for_review_report in the method name]''

'''Before:'''

get_min_max_avg_value_for_review_report

'''After:'''

get_review_metrics ''[Since minimum, maximum and average value is the part of metrics in review report, we can replace it all by metrics]''

====Refactoring method====

The following method was not used or called in any of the files in the project. Due to that reason, the entire function was commented out.

<pre>
def get_current_round(reviewer_id)
user_id = Participant.find(reviewer_id).user.id
topic_id = SignedUpTeam.topic_id(@assignment.id, user_id)
@assignment.number_of_current_round(topic_id)
@assignment.num_review_rounds if @assignment.get_current_stage(topic_id) == "Finished" || @assignment.get_current_stage(topic_id) == "metareview"
end
</pre>

<br>
The method '''get_css_style_for_calibration_report''' had a switch case. It was refactored using a dictionary where the case numbers were keys and the outputs of each case were the corresponding values.

'''Before:'''
<pre>
def get_css_style_for_calibration_report(diff)
# diff - difference between stu's answer and instructor's answer
css_class = case diff.abs
when 0
'c5'
when 1
'c4'
when 2
'c3'
when 3
'c2'
else
'c1'
end
css_class
end
</pre>

'''After:'''
<pre>
def get_css_style_for_calibration_report(diff)
# diff - difference between stu's answer and instructor's answer
dict = {0 => 'c5',1 => 'c4',2 => 'c3',3 => 'c2'}
if dict.key?(diff.abs)
css_class = dict[diff.abs]
else
css_class = 'c1'
end
css_class
end
</pre>

===Comments added to various functions===
There were several methods which didn't have any comments or the comments weren't meaningful. In all those cases, comments have been added or changed which are mentioned as follows:

<pre>
# gets the review score awarded based on each round of the review
def get_each_round_score_awarded_for_review_report(reviewer_id, team_id)
</pre>

<pre>
# gets minimum, maximum and average value for all the reviews
def get_min_max_avg_value_for_review_report(round, team_id)
</pre>

<pre>
# sorts the reviewers by the average volume of reviews in each round, in descending order
def sort_reviewer_by_review_volume_desc
</pre>

<pre>
# displays all the average scores in round 1, 2 and 3
def display_volume_metric(overall_avg_vol, avg_vol_in_round_1, avg_vol_in_round_2, avg_vol_in_round_3)
</pre>

<pre>
# moves data of reviews in each round from a current round
def initialize_chart_elements(reviewer)
</pre>

<pre>
# The data of all the reviews is displayed in the form of a bar chart
def display_volume_metric_chart(reviewer)
</pre>

<pre>
# For assignments with 1 team member, the following method returns user's fullname else it returns "team name" that a particular reviewee belongs to.
def get_team_reviewed_link_name(max_team_size, response, reviewee_id)
</pre>

<pre>
# if the current stage is "submission" or "review", function returns the current round number otherwise
# if the current stage is "Finished" or "metareview", function returns the number of rounds of review completed
def get_current_round_for_review_report(reviewer_id)
</pre>

<pre>
# gets the response map data such as reviewer id, reviewd object id and type for the review report
def get_data_for_review_report(reviewed_object_id, reviewer_id, type)
</pre>

<pre>
# gets the team name's color according to review and assignment submission status
def get_team_name_color_in_review_report(response_map)
</pre>

<pre>
# checks if a review was submitted in every round and gives the total responses count
def response_for_each_round?(response_map)
</pre>

<pre>
# returns hyperlink of the assignment that has been submitted on the due date
def submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
</pre>

===Function placed in the view as partials===

The following method has been removed from the '''review_mapping_helper.rb''' and added to the views as partials:

<pre>
def create_report_table_header(headers = {})
table_header = "<div class = 'reviewreport'>\
<table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'>\
<tr bgcolor='#CCCCCC'>"
headers.each do |header, percentage|
table_header += if percentage
"<th width = #{percentage}>\
#{header.humanize}\
</th>"
else
"<th>\
#{header.humanize}\
</th>"
end
end
table_header += "</tr>"
table_header.html_safe
end
</pre>

The following is the code available in views in the file '''_report_table_header.html.erb''':

<pre>
<% table_header = "<div class = 'reviewreport'><table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'><tr bgcolor='#CCCCCC'>" %>
<% headers.each do |header, percentage| %>
<% table_header += if percentage %>
<% "<th width = #{percentage}> #{header.humanize} </th>" %>
<% else %>
<%"<th> #{header.humanize} </th>" %>
<% end %>
<% end %>
<% table_header += "</tr>"%>
<% return table_header.html_safe %>
</pre>

==Testing==

===Test Plan===

There were changes made in the function name as well as one of the function was added to partials. Testing was carried out to check the behavior of these functions. In one of the case, a drop-down menu was tested i.e, all the links that were accessed were tested. It was checked that clicking on every link produced the desired output in all the options of the drop-down menu. For these cases, Manual testing, as well as RSpec testing, was carried out.

===Manual Testing===

For the methods which were called in views, manual testing was carried out to check that the code was not affected after refactoring methods.

[[File:Screenshot-FunctionCalls-Final.png]]

[[File:Screenshot-Partials-Final.png]]

===RSpec Testing===

RSpec testing was carried out for the methods that had been refactored. The partial that was added had impacts on the drop-down menus. Given below is one of the snippets of the entire code written in the file '''review_mapping_helper_spec.rb'''. The file path is '''spec/features/review_mapping_helper_spec.rb'''.

<pre>
require 'rspec'

describe 'Tests Review report' do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_on 'View'
end

it "can display review metrics" do
expect(page).to have_content('Metrics')
end

it "can display review grades of each round" do
expect(page).to have_content('Score awarded')
end

it "can display reviews done" do
expect(page).to have_content('Reviews done')
end

it "can display Reviewer" do
expect(page).to have_content('Reviewer')
end

it "can display team reviewed" do
expect(page).to have_content('Team reviewed')
end
end

RSpec.describe ReviewMappingHelper, :type => :helper do
describe "test get_css_style_for_calibration_report" do
it "should return correct css for calibration report" do
expect(helper.get_css_style_for_calibration_report(1)).to eq('c4')
expect(helper.get_css_style_for_calibration_report(0)).to eq('c5')
expect(helper.get_css_style_for_calibration_report(2)).to eq('c3')
expect(helper.get_css_style_for_calibration_report(3)).to eq('c2')
expect(helper.get_css_style_for_calibration_report(4)).to eq('c1')
end
end
end
</pre>

==Design Pattern==

A design pattern is a general repeatable solution to a commonly occurring problem in software design. It is a description or template for how to solve a problem that can be used in many different situations.

During the process of refactoring methods as well as method names,'''Strategy Pattern''' was used in the implementation. The Strategy pattern is most useful when you want to provide multiple ways of processing a request, without hard-coding knowledge about those different methods into the object that handles the request. For our project Strategy Pattern was very helpful in adding functions to views as partials.

==Screencast==

To access the screencast for our project, please click [https://drive.google.com/file/d/1b06VrvYOWb7ti0DVhQS_r6LaMEbNBzTd/view?usp=sharing '''Screencast''']

==References==

1) https://www.rubyguides.com/2015/12/ruby-refactoring/

2) http://rspec.info/documentation/3.8/rspec-core/

3) http://wiki.expertiza.ncsu.edu/index.php/Main_Page

==Team Members==

Ashish Kumar Jayantilal Jain

Aishwarya Tirumala

Devang Upadhyay

CSC/ECE 517 Spring 2019 - Project E1913. Refactor review mapping helper.rb

2019-04-02T02:44:05Z

Drupadhy: /* Screencast */

==Introduction==
This page gives a description of the changes made for the ''review_mapping_helper.rb'' of Expertiza based OSS project.

===Expertiza Background ===
Expertiza is a web application where students can submit and peer-review learning objects (articles, codes, websites, etc). Instructors add and grade the assignments submitted by students to Expertiza. Students can be assigned in teams based on their selection of the topics. It has functionalities such as peer reviews in which students can provide feedback on other's work which helps peer in better developing the project. It is supported by the National Science Foundation.

=== Problem Statement ===

The review_mapping_helper.rb has multiple functions with a wrong naming convention, they are classic examples of bad function names. These functions are to be refactored accordingly. Few of the variables names used in the method must also be refactored to make it more relevant and understandable. In addition, some function's code is to be optimized to ensure that it follows DRY principle. Tests must be written for the functions which are modified. Also, comments must be added to all functions of the file. The create_report_table_header function contains HTML code which should be ideally placed in the view as partials, which will allow to easily reuse the code in Rails application.

==Implementation==

===Flowchart===

The following process is carried out to complete the project-

[[File:Steps for project.png]]

===Refactoring===

====Refactoring method names====
All the method names that are refactored are mentioned below-

'''Before:'''

get_each_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_each_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_certain_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_certain_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_team_name_color_in_review_report

'''After:'''

get_team_colour ''[The method suggests that team color is defined in the review report, so we do not need to put in_review_report in the method name]''

'''Before:'''

get_each_round_score_awarded_for_review_report

'''After:'''

get_awarded_review_score ''[The method gets the awarded score for review, so we do not need to put for_review_report in the method name]''

'''Before:'''

get_min_max_avg_value_for_review_report

'''After:'''

get_review_metrics ''[Since minimum, maximum and average value is the part of metrics in review report, we can replace it all by metrics]''

====Refactoring method====

The following method was not used or called in any of the files in the project. Due to that reason, the entire function was commented out.

<pre>
def get_current_round(reviewer_id)
user_id = Participant.find(reviewer_id).user.id
topic_id = SignedUpTeam.topic_id(@assignment.id, user_id)
@assignment.number_of_current_round(topic_id)
@assignment.num_review_rounds if @assignment.get_current_stage(topic_id) == "Finished" || @assignment.get_current_stage(topic_id) == "metareview"
end
</pre>

<br>
The method '''get_css_style_for_calibration_report''' had a switch case. It was refactored using a dictionary where the case numbers were keys and the outputs of each case were the corresponding values.

'''Before:'''
<pre>
def get_css_style_for_calibration_report(diff)
# diff - difference between stu's answer and instructor's answer
css_class = case diff.abs
when 0
'c5'
when 1
'c4'
when 2
'c3'
when 3
'c2'
else
'c1'
end
css_class
end
</pre>

'''After:'''
<pre>
def get_css_style_for_calibration_report(diff)
# diff - difference between stu's answer and instructor's answer
dict = {0 => 'c5',1 => 'c4',2 => 'c3',3 => 'c2'}
if dict.key?(diff.abs)
css_class = dict[diff.abs]
else
css_class = 'c1'
end
css_class
end
</pre>

===Comments added to various functions===
There were several methods which didn't have any comments or the comments weren't meaningful. In all those cases, comments have been added or changed which are mentioned as follows:

<pre>
# gets the review score awarded based on each round of the review
def get_each_round_score_awarded_for_review_report(reviewer_id, team_id)
</pre>

<pre>
# gets minimum, maximum and average value for all the reviews
def get_min_max_avg_value_for_review_report(round, team_id)
</pre>

<pre>
# sorts the reviewers by the average volume of reviews in each round, in descending order
def sort_reviewer_by_review_volume_desc
</pre>

<pre>
# displays all the average scores in round 1, 2 and 3
def display_volume_metric(overall_avg_vol, avg_vol_in_round_1, avg_vol_in_round_2, avg_vol_in_round_3)
</pre>

<pre>
# moves data of reviews in each round from a current round
def initialize_chart_elements(reviewer)
</pre>

<pre>
# The data of all the reviews is displayed in the form of a bar chart
def display_volume_metric_chart(reviewer)
</pre>

<pre>
# For assignments with 1 team member, the following method returns user's fullname else it returns "team name" that a particular reviewee belongs to.
def get_team_reviewed_link_name(max_team_size, response, reviewee_id)
</pre>

<pre>
# if the current stage is "submission" or "review", function returns the current round number otherwise
# if the current stage is "Finished" or "metareview", function returns the number of rounds of review completed
def get_current_round_for_review_report(reviewer_id)
</pre>

<pre>
# gets the response map data such as reviewer id, reviewd object id and type for the review report
def get_data_for_review_report(reviewed_object_id, reviewer_id, type)
</pre>

<pre>
# gets the team name's color according to review and assignment submission status
def get_team_name_color_in_review_report(response_map)
</pre>

<pre>
# checks if a review was submitted in every round and gives the total responses count
def response_for_each_round?(response_map)
</pre>

<pre>
# returns hyperlink of the assignment that has been submitted on the due date
def submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
</pre>

===Function placed in the view as partials===

The following method has been removed from the '''review_mapping_helper.rb''' and added to the views as partials:

<pre>
def create_report_table_header(headers = {})
table_header = "<div class = 'reviewreport'>\
<table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'>\
<tr bgcolor='#CCCCCC'>"
headers.each do |header, percentage|
table_header += if percentage
"<th width = #{percentage}>\
#{header.humanize}\
</th>"
else
"<th>\
#{header.humanize}\
</th>"
end
end
table_header += "</tr>"
table_header.html_safe
end
</pre>

The following is the code available in views in the file '''_report_table_header.html.erb''':

<pre>
<% table_header = "<div class = 'reviewreport'><table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'><tr bgcolor='#CCCCCC'>" %>
<% headers.each do |header, percentage| %>
<% table_header += if percentage %>
<% "<th width = #{percentage}> #{header.humanize} </th>" %>
<% else %>
<%"<th> #{header.humanize} </th>" %>
<% end %>
<% end %>
<% table_header += "</tr>"%>
<% return table_header.html_safe %>
</pre>

==Testing==

===Test Plan===

There were changes made in the function name as well as one of the function was added to partials. Testing was carried out to check the behavior of these functions. In one of the case, a drop-down menu was tested i.e, all the links that were accessed were tested. It was checked that clicking on every link produced the desired output in all the options of the drop-down menu. For these cases, Manual testing, as well as RSpec testing, was carried out.

===Manual Testing===

For the methods which were called in views, manual testing was carried out to check that the code was not affected after refactoring methods.

[[File:Screenshot-FunctionCalls-Final.png]]

[[File:Screenshot-Partials-Final.png]]

===RSpec Testing===

RSpec testing was carried out for the methods that had been refactored. The partial that was added had impacts on the drop-down menus. Given below is one of the snippets of the entire code written in the file '''review_mapping_helper_spec.rb'''. The file path is '''spec/features/review_mapping_helper_spec.rb'''.

<pre>
require 'rspec'

describe 'Tests Review report' do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_on 'View'
end

it "can display review metrics" do
expect(page).to have_content('Metrics')
end

it "can display review grades of each round" do
expect(page).to have_content('Score awarded')
end

it "can display reviews done" do
expect(page).to have_content('Reviews done')
end

it "can display Reviewer" do
expect(page).to have_content('Reviewer')
end

it "can display team reviewed" do
expect(page).to have_content('Team reviewed')
end
end

RSpec.describe ReviewMappingHelper, :type => :helper do
describe "test get_css_style_for_calibration_report" do
it "should return correct css for calibration report" do
expect(helper.get_css_style_for_calibration_report(1)).to eq('c4')
expect(helper.get_css_style_for_calibration_report(0)).to eq('c5')
expect(helper.get_css_style_for_calibration_report(2)).to eq('c3')
expect(helper.get_css_style_for_calibration_report(3)).to eq('c2')
expect(helper.get_css_style_for_calibration_report(4)).to eq('c1')
end
end
end
</pre>

==Design Pattern==

A design pattern is a general repeatable solution to a commonly occurring problem in software design. It is a description or template for how to solve a problem that can be used in many different situations.

During the process of refactoring methods as well as method names,'''Strategy Pattern''' was used in the implementation. The Strategy pattern is most useful when you want to provide multiple ways of processing a request, without hard-coding knowledge about those different methods into the object that handles the request.

==Screencast==

To access the screencast for our project, please click [https://drive.google.com/file/d/1b06VrvYOWb7ti0DVhQS_r6LaMEbNBzTd/view?usp=sharing '''Screencast''']

==References==

1) https://www.rubyguides.com/2015/12/ruby-refactoring/

2) http://rspec.info/documentation/3.8/rspec-core/

3) http://wiki.expertiza.ncsu.edu/index.php/Main_Page

==Team Members==

Ashish Kumar Jayantilal Jain

Aishwarya Tirumala

Devang Upadhyay

CSC/ECE 517 Spring 2019 - Project E1913. Refactor review mapping helper.rb

2019-04-02T02:32:57Z

Drupadhy: /* Manual Testing */

==Introduction==
This page gives a description of the changes made for the ''review_mapping_helper.rb'' of Expertiza based OSS project.

===Expertiza Background ===
Expertiza is a web application where students can submit and peer-review learning objects (articles, codes, websites, etc). Instructors add and grade the assignments submitted by students to Expertiza. Students can be assigned in teams based on their selection of the topics. It has functionalities such as peer reviews in which students can provide feedback on other's work which helps peer in better developing the project. It is supported by the National Science Foundation.

=== Problem Statement ===

The review_mapping_helper.rb has multiple functions with a wrong naming convention, they are classic examples of bad function names. These functions are to be refactored accordingly. Few of the variables names used in the method must also be refactored to make it more relevant and understandable. In addition, some function's code is to be optimized to ensure that it follows DRY principle. Tests must be written for the functions which are modified. Also, comments must be added to all functions of the file. The create_report_table_header function contains HTML code which should be ideally placed in the view as partials, which will allow to easily reuse the code in Rails application.

==Implementation==

===Flowchart===

The following process is carried out to complete the project-

[[File:Steps for project.png]]

===Refactoring===

====Refactoring method names====
All the method names that are refactored are mentioned below-

'''Before:'''

get_each_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_each_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_certain_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_certain_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_team_name_color_in_review_report

'''After:'''

get_team_colour ''[The method suggests that team color is defined in the review report, so we do not need to put in_review_report in the method name]''

'''Before:'''

get_each_round_score_awarded_for_review_report

'''After:'''

get_awarded_review_score ''[The method gets the awarded score for review, so we do not need to put for_review_report in the method name]''

'''Before:'''

get_min_max_avg_value_for_review_report

'''After:'''

get_review_metrics ''[Since minimum, maximum and average value is the part of metrics in review report, we can replace it all by metrics]''

====Refactoring method====

The following method was not used or called in any of the files in the project. Due to that reason, the entire function was commented out.

<pre>
def get_current_round(reviewer_id)
user_id = Participant.find(reviewer_id).user.id
topic_id = SignedUpTeam.topic_id(@assignment.id, user_id)
@assignment.number_of_current_round(topic_id)
@assignment.num_review_rounds if @assignment.get_current_stage(topic_id) == "Finished" || @assignment.get_current_stage(topic_id) == "metareview"
end
</pre>

<br>
The method '''get_css_style_for_calibration_report''' had a switch case. It was refactored using a dictionary where the case numbers were keys and the outputs of each case were the corresponding values.

'''Before:'''
<pre>
def get_css_style_for_calibration_report(diff)
# diff - difference between stu's answer and instructor's answer
css_class = case diff.abs
when 0
'c5'
when 1
'c4'
when 2
'c3'
when 3
'c2'
else
'c1'
end
css_class
end
</pre>

'''After:'''
<pre>
def get_css_style_for_calibration_report(diff)
# diff - difference between stu's answer and instructor's answer
dict = {0 => 'c5',1 => 'c4',2 => 'c3',3 => 'c2'}
if dict.key?(diff.abs)
css_class = dict[diff.abs]
else
css_class = 'c1'
end
css_class
end
</pre>

===Comments added to various functions===
There were several methods which didn't have any comments or the comments weren't meaningful. In all those cases, comments have been added or changed which are mentioned as follows:

<pre>
# gets the review score awarded based on each round of the review
def get_each_round_score_awarded_for_review_report(reviewer_id, team_id)
</pre>

<pre>
# gets minimum, maximum and average value for all the reviews
def get_min_max_avg_value_for_review_report(round, team_id)
</pre>

<pre>
# sorts the reviewers by the average volume of reviews in each round, in descending order
def sort_reviewer_by_review_volume_desc
</pre>

<pre>
# displays all the average scores in round 1, 2 and 3
def display_volume_metric(overall_avg_vol, avg_vol_in_round_1, avg_vol_in_round_2, avg_vol_in_round_3)
</pre>

<pre>
# moves data of reviews in each round from a current round
def initialize_chart_elements(reviewer)
</pre>

<pre>
# The data of all the reviews is displayed in the form of a bar chart
def display_volume_metric_chart(reviewer)
</pre>

<pre>
# For assignments with 1 team member, the following method returns user's fullname else it returns "team name" that a particular reviewee belongs to.
def get_team_reviewed_link_name(max_team_size, response, reviewee_id)
</pre>

<pre>
# if the current stage is "submission" or "review", function returns the current round number otherwise
# if the current stage is "Finished" or "metareview", function returns the number of rounds of review completed
def get_current_round_for_review_report(reviewer_id)
</pre>

<pre>
# gets the response map data such as reviewer id, reviewd object id and type for the review report
def get_data_for_review_report(reviewed_object_id, reviewer_id, type)
</pre>

<pre>
# gets the team name's color according to review and assignment submission status
def get_team_name_color_in_review_report(response_map)
</pre>

<pre>
# checks if a review was submitted in every round and gives the total responses count
def response_for_each_round?(response_map)
</pre>

<pre>
# returns hyperlink of the assignment that has been submitted on the due date
def submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
</pre>

===Function placed in the view as partials===

The following method has been removed from the '''review_mapping_helper.rb''' and added to the views as partials:

<pre>
def create_report_table_header(headers = {})
table_header = "<div class = 'reviewreport'>\
<table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'>\
<tr bgcolor='#CCCCCC'>"
headers.each do |header, percentage|
table_header += if percentage
"<th width = #{percentage}>\
#{header.humanize}\
</th>"
else
"<th>\
#{header.humanize}\
</th>"
end
end
table_header += "</tr>"
table_header.html_safe
end
</pre>

The following is the code available in views in the file '''_report_table_header.html.erb''':

<pre>
<% table_header = "<div class = 'reviewreport'><table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'><tr bgcolor='#CCCCCC'>" %>
<% headers.each do |header, percentage| %>
<% table_header += if percentage %>
<% "<th width = #{percentage}> #{header.humanize} </th>" %>
<% else %>
<%"<th> #{header.humanize} </th>" %>
<% end %>
<% end %>
<% table_header += "</tr>"%>
<% return table_header.html_safe %>
</pre>

==Testing==

===Test Plan===

There were changes made in the function name as well as one of the function was added to partials. Testing was carried out to check the behavior of these functions. In one of the case, a drop-down menu was tested i.e, all the links that were accessed were tested. It was checked that clicking on every link produced the desired output in all the options of the drop-down menu. For these cases, Manual testing, as well as RSpec testing, was carried out.

===Manual Testing===

For the methods which were called in views, manual testing was carried out to check that the code was not affected after refactoring methods.

[[File:Screenshot-FunctionCalls-Final.png]]

[[File:Screenshot-Partials-Final.png]]

===RSpec Testing===

RSpec testing was carried out for the methods that had been refactored. The partial that was added had impacts on the drop-down menus. Given below is one of the snippets of the entire code written in the file '''review_mapping_helper_spec.rb'''. The file path is '''spec/features/review_mapping_helper_spec.rb'''.

<pre>
require 'rspec'

describe 'Tests Review report' do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_on 'View'
end

it "can display review metrics" do
expect(page).to have_content('Metrics')
end

it "can display review grades of each round" do
expect(page).to have_content('Score awarded')
end

it "can display reviews done" do
expect(page).to have_content('Reviews done')
end

it "can display Reviewer" do
expect(page).to have_content('Reviewer')
end

it "can display team reviewed" do
expect(page).to have_content('Team reviewed')
end
end

RSpec.describe ReviewMappingHelper, :type => :helper do
describe "test get_css_style_for_calibration_report" do
it "should return correct css for calibration report" do
expect(helper.get_css_style_for_calibration_report(1)).to eq('c4')
expect(helper.get_css_style_for_calibration_report(0)).to eq('c5')
expect(helper.get_css_style_for_calibration_report(2)).to eq('c3')
expect(helper.get_css_style_for_calibration_report(3)).to eq('c2')
expect(helper.get_css_style_for_calibration_report(4)).to eq('c1')
end
end
end
</pre>

==Design Pattern==

A design pattern is a general repeatable solution to a commonly occurring problem in software design. It is a description or template for how to solve a problem that can be used in many different situations.

During the process of refactoring methods as well as method names,'''Strategy Pattern''' was used in the implementation. The Strategy pattern is most useful when you want to provide multiple ways of processing a request, without hard-coding knowledge about those different methods into the object that handles the request.

==Screencast==

To access the screencast for our project, please click the link: " "

==References==

1) https://www.rubyguides.com/2015/12/ruby-refactoring/

2) http://rspec.info/documentation/3.8/rspec-core/

3) http://wiki.expertiza.ncsu.edu/index.php/Main_Page

==Team Members==

Ashish Kumar Jayantilal Jain

Aishwarya Tirumala

Devang Upadhyay

File:Screenshot-Partials-Final.png

2019-04-02T02:32:02Z

Drupadhy:

File:Screenshot-Partials.png

2019-04-02T02:27:16Z

Drupadhy:

CSC/ECE 517 Spring 2019 - Project E1913. Refactor review mapping helper.rb

2019-04-02T02:24:56Z

Drupadhy: /* Manual Testing */

==Introduction==
This page gives a description of the changes made for the ''review_mapping_helper.rb'' of Expertiza based OSS project.

===Expertiza Background ===
Expertiza is a web application where students can submit and peer-review learning objects (articles, codes, websites, etc). Instructors add and grade the assignments submitted by students to Expertiza. Students can be assigned in teams based on their selection of the topics. It has functionalities such as peer reviews in which students can provide feedback on other's work which helps peer in better developing the project. It is supported by the National Science Foundation.

=== Problem Statement ===

The review_mapping_helper.rb has multiple functions with a wrong naming convention, they are classic examples of bad function names. These functions are to be refactored accordingly. Few of the variables names used in the method must also be refactored to make it more relevant and understandable. In addition, some function's code is to be optimized to ensure that it follows DRY principle. Tests must be written for the functions which are modified. Also, comments must be added to all functions of the file. The create_report_table_header function contains HTML code which should be ideally placed in the view as partials, which will allow to easily reuse the code in Rails application.

==Implementation==

===Flowchart===

The following process is carried out to complete the project-

[[File:Steps for project.png]]

===Refactoring===

====Refactoring method names====
All the method names that are refactored are mentioned below-

'''Before:'''

get_each_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_each_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_certain_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_certain_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_team_name_color_in_review_report

'''After:'''

get_team_colour ''[The method suggests that team color is defined in the review report, so we do not need to put in_review_report in the method name]''

'''Before:'''

get_each_round_score_awarded_for_review_report

'''After:'''

get_awarded_review_score ''[The method gets the awarded score for review, so we do not need to put for_review_report in the method name]''

'''Before:'''

get_min_max_avg_value_for_review_report

'''After:'''

get_review_metrics ''[Since minimum, maximum and average value is the part of metrics in review report, we can replace it all by metrics]''

====Refactoring method====

The following method was not used or called in any of the files in the project. Due to that reason, the entire function was commented out.

<pre>
def get_current_round(reviewer_id)
user_id = Participant.find(reviewer_id).user.id
topic_id = SignedUpTeam.topic_id(@assignment.id, user_id)
@assignment.number_of_current_round(topic_id)
@assignment.num_review_rounds if @assignment.get_current_stage(topic_id) == "Finished" || @assignment.get_current_stage(topic_id) == "metareview"
end
</pre>

<br>
The method '''get_css_style_for_calibration_report''' had a switch case. It was refactored using a dictionary where the case numbers were keys and the outputs of each case were the corresponding values.

'''Before:'''
<pre>
def get_css_style_for_calibration_report(diff)
# diff - difference between stu's answer and instructor's answer
css_class = case diff.abs
when 0
'c5'
when 1
'c4'
when 2
'c3'
when 3
'c2'
else
'c1'
end
css_class
end
</pre>

'''After:'''
<pre>
def get_css_style_for_calibration_report(diff)
# diff - difference between stu's answer and instructor's answer
dict = {0 => 'c5',1 => 'c4',2 => 'c3',3 => 'c2'}
if dict.key?(diff.abs)
css_class = dict[diff.abs]
else
css_class = 'c1'
end
css_class
end
</pre>

===Comments added to various functions===
There were several methods which didn't have any comments or the comments weren't meaningful. In all those cases, comments have been added or changed which are mentioned as follows:

<pre>
# gets the review score awarded based on each round of the review
def get_each_round_score_awarded_for_review_report(reviewer_id, team_id)
</pre>

<pre>
# gets minimum, maximum and average value for all the reviews
def get_min_max_avg_value_for_review_report(round, team_id)
</pre>

<pre>
# sorts the reviewers by the average volume of reviews in each round, in descending order
def sort_reviewer_by_review_volume_desc
</pre>

<pre>
# displays all the average scores in round 1, 2 and 3
def display_volume_metric(overall_avg_vol, avg_vol_in_round_1, avg_vol_in_round_2, avg_vol_in_round_3)
</pre>

<pre>
# moves data of reviews in each round from a current round
def initialize_chart_elements(reviewer)
</pre>

<pre>
# The data of all the reviews is displayed in the form of a bar chart
def display_volume_metric_chart(reviewer)
</pre>

<pre>
# For assignments with 1 team member, the following method returns user's fullname else it returns "team name" that a particular reviewee belongs to.
def get_team_reviewed_link_name(max_team_size, response, reviewee_id)
</pre>

<pre>
# if the current stage is "submission" or "review", function returns the current round number otherwise
# if the current stage is "Finished" or "metareview", function returns the number of rounds of review completed
def get_current_round_for_review_report(reviewer_id)
</pre>

<pre>
# gets the response map data such as reviewer id, reviewd object id and type for the review report
def get_data_for_review_report(reviewed_object_id, reviewer_id, type)
</pre>

<pre>
# gets the team name's color according to review and assignment submission status
def get_team_name_color_in_review_report(response_map)
</pre>

<pre>
# checks if a review was submitted in every round and gives the total responses count
def response_for_each_round?(response_map)
</pre>

<pre>
# returns hyperlink of the assignment that has been submitted on the due date
def submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
</pre>

===Function placed in the view as partials===

The following method has been removed from the '''review_mapping_helper.rb''' and added to the views as partials:

<pre>
def create_report_table_header(headers = {})
table_header = "<div class = 'reviewreport'>\
<table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'>\
<tr bgcolor='#CCCCCC'>"
headers.each do |header, percentage|
table_header += if percentage
"<th width = #{percentage}>\
#{header.humanize}\
</th>"
else
"<th>\
#{header.humanize}\
</th>"
end
end
table_header += "</tr>"
table_header.html_safe
end
</pre>

The following is the code available in views in the file '''_report_table_header.html.erb''':

<pre>
<% table_header = "<div class = 'reviewreport'><table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'><tr bgcolor='#CCCCCC'>" %>
<% headers.each do |header, percentage| %>
<% table_header += if percentage %>
<% "<th width = #{percentage}> #{header.humanize} </th>" %>
<% else %>
<%"<th> #{header.humanize} </th>" %>
<% end %>
<% end %>
<% table_header += "</tr>"%>
<% return table_header.html_safe %>
</pre>

==Testing==

===Test Plan===

There were changes made in the function name as well as one of the function was added to partials. Testing was carried out to check the behavior of these functions. In one of the case, a drop-down menu was tested i.e, all the links that were accessed were tested. It was checked that clicking on every link produced the desired output in all the options of the drop-down menu. For these cases, Manual testing, as well as RSpec testing, was carried out.

===Manual Testing===

For the methods which were called in views, manual testing was carried out to check that the code was not affected after refactoring methods.

[[File:Screenshot-FunctionCalls-Final.png]]

===RSpec Testing===

RSpec testing was carried out for the methods that had been refactored. The partial that was added had impacts on the drop-down menus. Given below is one of the snippets of the entire code written in the file '''review_mapping_helper_spec.rb'''. The file path is '''spec/features/review_mapping_helper_spec.rb'''.

<pre>
require 'rspec'

describe 'Tests Review report' do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_on 'View'
end

it "can display review metrics" do
expect(page).to have_content('Metrics')
end

it "can display review grades of each round" do
expect(page).to have_content('Score awarded')
end

it "can display reviews done" do
expect(page).to have_content('Reviews done')
end

it "can display Reviewer" do
expect(page).to have_content('Reviewer')
end

it "can display team reviewed" do
expect(page).to have_content('Team reviewed')
end
end

RSpec.describe ReviewMappingHelper, :type => :helper do
describe "test get_css_style_for_calibration_report" do
it "should return correct css for calibration report" do
expect(helper.get_css_style_for_calibration_report(1)).to eq('c4')
expect(helper.get_css_style_for_calibration_report(0)).to eq('c5')
expect(helper.get_css_style_for_calibration_report(2)).to eq('c3')
expect(helper.get_css_style_for_calibration_report(3)).to eq('c2')
expect(helper.get_css_style_for_calibration_report(4)).to eq('c1')
end
end
end
</pre>

==Design Pattern==

A design pattern is a general repeatable solution to a commonly occurring problem in software design. It is a description or template for how to solve a problem that can be used in many different situations.

During the process of refactoring methods as well as method names,'''Strategy Pattern''' was used in the implementation. The Strategy pattern is most useful when you want to provide multiple ways of processing a request, without hard-coding knowledge about those different methods into the object that handles the request.

==Screencast==

To access the screencast for our project, please click the link: " "

==References==

1) https://www.rubyguides.com/2015/12/ruby-refactoring/

2) http://rspec.info/documentation/3.8/rspec-core/

3) http://wiki.expertiza.ncsu.edu/index.php/Main_Page

==Team Members==

Ashish Kumar Jayantilal Jain

Aishwarya Tirumala

Devang Upadhyay

File:Screenshot-FunctionCalls-Final.png

2019-04-02T02:21:46Z

Drupadhy:

File:Screenshot-FunctionCalls.png

2019-04-02T02:13:18Z

Drupadhy:

CSC/ECE 517 Spring 2019 - Project E1913. Refactor review mapping helper.rb

2019-04-02T02:08:30Z

Drupadhy:

==Introduction==
This page gives a description of the changes made for the ''review_mapping_helper.rb'' of Expertiza based OSS project.

===Expertiza Background ===
Expertiza is a web application where students can submit and peer-review learning objects (articles, codes, websites, etc). Instructors add and grade the assignments submitted by students to Expertiza. Students can be assigned in teams based on their selection of the topics. It has functionalities such as peer reviews in which students can provide feedback on other's work which helps peer in better developing the project. It is supported by the National Science Foundation.

=== Problem Statement ===

The review_mapping_helper.rb has multiple functions with a wrong naming convention, they are classic examples of bad function names. These functions are to be refactored accordingly. Few of the variables names used in the method must also be refactored to make it more relevant and understandable. In addition, some function's code is to be optimized to ensure that it follows DRY principle. Tests must be written for the functions which are modified. Also, comments must be added to all functions of the file. The create_report_table_header function contains HTML code which should be ideally placed in the view as partials, which will allow to easily reuse the code in Rails application.

==Implementation==

===Flowchart===

The following process is carried out to complete the project-

[[File:Steps for project.png]]

===Refactoring===

====Refactoring method names====
All the method names that are refactored are mentioned below-

'''Before:'''

get_each_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_each_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_certain_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_certain_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_team_name_color_in_review_report

'''After:'''

get_team_colour ''[The method suggests that team color is defined in the review report, so we do not need to put in_review_report in the method name]''

'''Before:'''

get_each_round_score_awarded_for_review_report

'''After:'''

get_awarded_review_score ''[The method gets the awarded score for review, so we do not need to put for_review_report in the method name]''

'''Before:'''

get_min_max_avg_value_for_review_report

'''After:'''

get_review_metrics ''[Since minimum, maximum and average value is the part of metrics in review report, we can replace it all by metrics]''

====Refactoring method====

The following method was not used or called in any of the files in the project. Due to that reason, the entire function was commented out.

<pre>
def get_current_round(reviewer_id)
user_id = Participant.find(reviewer_id).user.id
topic_id = SignedUpTeam.topic_id(@assignment.id, user_id)
@assignment.number_of_current_round(topic_id)
@assignment.num_review_rounds if @assignment.get_current_stage(topic_id) == "Finished" || @assignment.get_current_stage(topic_id) == "metareview"
end
</pre>

<br>
The method '''get_css_style_for_calibration_report''' had a switch case. It was refactored using a dictionary where the case numbers were keys and the outputs of each case were the corresponding values.

'''Before:'''
<pre>
def get_css_style_for_calibration_report(diff)
# diff - difference between stu's answer and instructor's answer
css_class = case diff.abs
when 0
'c5'
when 1
'c4'
when 2
'c3'
when 3
'c2'
else
'c1'
end
css_class
end
</pre>

'''After:'''
<pre>
def get_css_style_for_calibration_report(diff)
# diff - difference between stu's answer and instructor's answer
dict = {0 => 'c5',1 => 'c4',2 => 'c3',3 => 'c2'}
if dict.key?(diff.abs)
css_class = dict[diff.abs]
else
css_class = 'c1'
end
css_class
end
</pre>

===Comments added to various functions===
There were several methods which didn't have any comments or the comments weren't meaningful. In all those cases, comments have been added or changed which are mentioned as follows:

<pre>
# gets the review score awarded based on each round of the review
def get_each_round_score_awarded_for_review_report(reviewer_id, team_id)
</pre>

<pre>
# gets minimum, maximum and average value for all the reviews
def get_min_max_avg_value_for_review_report(round, team_id)
</pre>

<pre>
# sorts the reviewers by the average volume of reviews in each round, in descending order
def sort_reviewer_by_review_volume_desc
</pre>

<pre>
# displays all the average scores in round 1, 2 and 3
def display_volume_metric(overall_avg_vol, avg_vol_in_round_1, avg_vol_in_round_2, avg_vol_in_round_3)
</pre>

<pre>
# moves data of reviews in each round from a current round
def initialize_chart_elements(reviewer)
</pre>

<pre>
# The data of all the reviews is displayed in the form of a bar chart
def display_volume_metric_chart(reviewer)
</pre>

<pre>
# For assignments with 1 team member, the following method returns user's fullname else it returns "team name" that a particular reviewee belongs to.
def get_team_reviewed_link_name(max_team_size, response, reviewee_id)
</pre>

<pre>
# if the current stage is "submission" or "review", function returns the current round number otherwise
# if the current stage is "Finished" or "metareview", function returns the number of rounds of review completed
def get_current_round_for_review_report(reviewer_id)
</pre>

<pre>
# gets the response map data such as reviewer id, reviewd object id and type for the review report
def get_data_for_review_report(reviewed_object_id, reviewer_id, type)
</pre>

<pre>
# gets the team name's color according to review and assignment submission status
def get_team_name_color_in_review_report(response_map)
</pre>

<pre>
# checks if a review was submitted in every round and gives the total responses count
def response_for_each_round?(response_map)
</pre>

<pre>
# returns hyperlink of the assignment that has been submitted on the due date
def submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
</pre>

===Function placed in the view as partials===

The following method has been removed from the '''review_mapping_helper.rb''' and added to the views as partials:

<pre>
def create_report_table_header(headers = {})
table_header = "<div class = 'reviewreport'>\
<table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'>\
<tr bgcolor='#CCCCCC'>"
headers.each do |header, percentage|
table_header += if percentage
"<th width = #{percentage}>\
#{header.humanize}\
</th>"
else
"<th>\
#{header.humanize}\
</th>"
end
end
table_header += "</tr>"
table_header.html_safe
end
</pre>

The following is the code available in views in the file '''_report_table_header.html.erb''':

<pre>
<% table_header = "<div class = 'reviewreport'><table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'><tr bgcolor='#CCCCCC'>" %>
<% headers.each do |header, percentage| %>
<% table_header += if percentage %>
<% "<th width = #{percentage}> #{header.humanize} </th>" %>
<% else %>
<%"<th> #{header.humanize} </th>" %>
<% end %>
<% end %>
<% table_header += "</tr>"%>
<% return table_header.html_safe %>
</pre>

==Testing==

===Test Plan===

There were changes made in the function name as well as one of the function was added to partials. Testing was carried out to check the behavior of these functions. In one of the case, a drop-down menu was tested i.e, all the links that were accessed were tested. It was checked that clicking on every link produced the desired output in all the options of the drop-down menu. For these cases, Manual testing, as well as RSpec testing, was carried out.

===Manual Testing===

''To be carried out''

===RSpec Testing===

RSpec testing was carried out for the methods that had been refactored. The partial that was added had impacts on the drop-down menus. Given below is one of the snippets of the entire code written in the file '''review_mapping_helper_spec.rb'''. The file path is '''spec/features/review_mapping_helper_spec.rb'''.

<pre>
require 'rspec'

describe 'Tests Review report' do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_on 'View'
end

it "can display review metrics" do
expect(page).to have_content('Metrics')
end

it "can display review grades of each round" do
expect(page).to have_content('Score awarded')
end

it "can display reviews done" do
expect(page).to have_content('Reviews done')
end

it "can display Reviewer" do
expect(page).to have_content('Reviewer')
end

it "can display team reviewed" do
expect(page).to have_content('Team reviewed')
end
end

RSpec.describe ReviewMappingHelper, :type => :helper do
describe "test get_css_style_for_calibration_report" do
it "should return correct css for calibration report" do
expect(helper.get_css_style_for_calibration_report(1)).to eq('c4')
expect(helper.get_css_style_for_calibration_report(0)).to eq('c5')
expect(helper.get_css_style_for_calibration_report(2)).to eq('c3')
expect(helper.get_css_style_for_calibration_report(3)).to eq('c2')
expect(helper.get_css_style_for_calibration_report(4)).to eq('c1')
end
end
end
</pre>

==Design Pattern==

A design pattern is a general repeatable solution to a commonly occurring problem in software design. It is a description or template for how to solve a problem that can be used in many different situations.

During the process of refactoring methods as well as method names,'''Strategy Pattern''' was used in the implementation. The Strategy pattern is most useful when you want to provide multiple ways of processing a request, without hard-coding knowledge about those different methods into the object that handles the request.

==Screencast==

To access the screencast for our project, please click the link: " "

==References==

1) https://www.rubyguides.com/2015/12/ruby-refactoring/

2) http://rspec.info/documentation/3.8/rspec-core/

3) http://wiki.expertiza.ncsu.edu/index.php/Main_Page

==Team Members==

Ashish Kumar Jayantilal Jain

Aishwarya Tirumala

Devang Upadhyay

CSC/ECE 517 Spring 2019 - Project E1913. Refactor review mapping helper.rb

2019-04-02T01:48:29Z

Drupadhy: /* RSpec Testing */

==Introduction==
This page gives a description of the changes made for the ''review_mapping_helper.rb'' of Expertiza based OSS project.

===Expertiza Background ===
Expertiza is a web application where students can submit and peer-review learning objects (articles, codes, websites, etc). Instructors add and grade the assignments submitted by students to Expertiza. Students can be assigned in teams based on their selection of the topics. It has functionalities such as peer reviews in which students can provide feedback on other's work which helps peer in better developing the project. It is supported by the National Science Foundation.

=== Problem Statement ===

The review_mapping_helper.rb has multiple functions with a wrong naming convention, they are classic examples of bad function names. These functions are to be refactored accordingly. Few of the variables names used in the method must also be refactored to make it more relevant and understandable. In addition, some function's code is to be optimized to ensure that it follows DRY principle. Tests must be written for the functions which are modified. Also, comments must be added to all functions of the file. The create_report_table_header function contains HTML code which should be ideally placed in the view as partials, which will allow to easily reuse the code in Rails application.

==Implementation==

===Flowchart===

The following process is carried out to complete the project-

[[File:Steps for project.png]]

===Refactoring===

====Refactoring method names====
All the method names that are refactored are mentioned below-

'''Before:'''

get_each_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_each_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_certain_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_certain_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_team_name_color_in_review_report

'''After:'''

get_team_colour ''[The method suggests that team color is defined in the review report, so we do not need to put in_review_report in the method name]''

'''Before:'''

get_each_round_score_awarded_for_review_report

'''After:'''

get_awarded_review_score ''[The method gets the awarded score for review, so we do not need to put for_review_report in the method name]''

'''Before:'''

get_min_max_avg_value_for_review_report

'''After:'''

get_review_metrics ''[Since minimum, maximum and average value is the part of metrics in review report, we can replace it all by metrics]''

====Refactoring method====

The following method was not used or called in any of the files in the project. Due to that reason, the entire function was commented out.

<pre>
def get_current_round(reviewer_id)
user_id = Participant.find(reviewer_id).user.id
topic_id = SignedUpTeam.topic_id(@assignment.id, user_id)
@assignment.number_of_current_round(topic_id)
@assignment.num_review_rounds if @assignment.get_current_stage(topic_id) == "Finished" || @assignment.get_current_stage(topic_id) == "metareview"
end
</pre>

<br>
The method '''get_css_style_for_calibration_report''' had a switch case. It was refactored using a dictionary where the case numbers were keys and the outputs of each case were the corresponding values.

'''Before:'''
<pre>
def get_css_style_for_calibration_report(diff)
# diff - difference between stu's answer and instructor's answer
css_class = case diff.abs
when 0
'c5'
when 1
'c4'
when 2
'c3'
when 3
'c2'
else
'c1'
end
css_class
end
</pre>

'''After:'''
<pre>
def get_css_style_for_calibration_report(diff)
# diff - difference between stu's answer and instructor's answer
dict = {0 => 'c5',1 => 'c4',2 => 'c3',3 => 'c2'}
if dict.key?(diff.abs)
css_class = dict[diff.abs]
else
css_class = 'c1'
end
css_class
end
</pre>

===Comments added to various functions===
There were several methods which didn't have any comments or the comments weren't meaningful. In all those cases, comments have been added or changed which are mentioned as follows:

<pre>
# gets the review score awarded based on each round of the review
def get_each_round_score_awarded_for_review_report(reviewer_id, team_id)
</pre>

<pre>
# gets minimum, maximum and average value for all the reviews
def get_min_max_avg_value_for_review_report(round, team_id)
</pre>

<pre>
# sorts the reviewers by the average volume of reviews in each round, in descending order
def sort_reviewer_by_review_volume_desc
</pre>

<pre>
# displays all the average scores in round 1, 2 and 3
def display_volume_metric(overall_avg_vol, avg_vol_in_round_1, avg_vol_in_round_2, avg_vol_in_round_3)
</pre>

<pre>
# moves data of reviews in each round from a current round
def initialize_chart_elements(reviewer)
</pre>

<pre>
# The data of all the reviews is displayed in the form of a bar chart
def display_volume_metric_chart(reviewer)
</pre>

<pre>
# For assignments with 1 team member, the following method returns user's fullname else it returns "team name" that a particular reviewee belongs to.
def get_team_reviewed_link_name(max_team_size, response, reviewee_id)
</pre>

<pre>
# if the current stage is "submission" or "review", function returns the current round number otherwise
# if the current stage is "Finished" or "metareview", function returns the number of rounds of review completed
def get_current_round_for_review_report(reviewer_id)
</pre>

<pre>
# gets the response map data such as reviewer id, reviewd object id and type for the review report
def get_data_for_review_report(reviewed_object_id, reviewer_id, type)
</pre>

<pre>
# gets the team name's color according to review and assignment submission status
def get_team_name_color_in_review_report(response_map)
</pre>

<pre>
# checks if a review was submitted in every round and gives the total responses count
def response_for_each_round?(response_map)
</pre>

<pre>
# returns hyperlink of the assignment that has been submitted on the due date
def submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
</pre>

===Function placed in the view as partials===

The following method has been removed from the '''review_mapping_helper.rb''' and added to the views as partials:

<pre>
def create_report_table_header(headers = {})
table_header = "<div class = 'reviewreport'>\
<table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'>\
<tr bgcolor='#CCCCCC'>"
headers.each do |header, percentage|
table_header += if percentage
"<th width = #{percentage}>\
#{header.humanize}\
</th>"
else
"<th>\
#{header.humanize}\
</th>"
end
end
table_header += "</tr>"
table_header.html_safe
end
</pre>

The following is the code available in views in the file '''_report_table_header.html.erb''':

<pre>
<% table_header = "<div class = 'reviewreport'><table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'><tr bgcolor='#CCCCCC'>" %>
<% headers.each do |header, percentage| %>
<% table_header += if percentage %>
<% "<th width = #{percentage}> #{header.humanize} </th>" %>
<% else %>
<%"<th> #{header.humanize} </th>" %>
<% end %>
<% end %>
<% table_header += "</tr>"%>
<% return table_header.html_safe %>
</pre>

==Testing==

===Test Plan===

There were changes made in the function name as well as one of the function was added to partials. Testing was carried out to check the behavior of these functions. In one of the case, a drop-down menu was tested i.e, all the links that were accessed were tested. It was checked that clicking on every link produced the desired output in all the options of the drop-down menu. For these cases, Manual testing, as well as RSpec testing, was carried out.

===Manual Testing===

''To be carried out''

===RSpec Testing===

RSpec testing was carried out for the methods that had been refactored. The partial that was added had impacts on the drop-down menus. Given below is one of the snippets of the entire code written in the file '''review_mapping_helper_spec.rb'''. The file path is '''spec/features/review_mapping_helper_spec.rb'''.

<pre>
require 'rspec'

describe 'Tests Review report' do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_on 'View'
end

it "can display review metrics" do
expect(page).to have_content('Metrics')
end

it "can display review grades of each round" do
expect(page).to have_content('Score awarded')
end

it "can display reviews done" do
expect(page).to have_content('Reviews done')
end

it "can display Reviewer" do
expect(page).to have_content('Reviewer')
end

it "can display team reviewed" do
expect(page).to have_content('Team reviewed')
end
end

RSpec.describe ReviewMappingHelper, :type => :helper do
describe "test get_css_style_for_calibration_report" do
it "should return correct css for calibration report" do
expect(helper.get_css_style_for_calibration_report(1)).to eq('c4')
expect(helper.get_css_style_for_calibration_report(0)).to eq('c5')
expect(helper.get_css_style_for_calibration_report(2)).to eq('c3')
expect(helper.get_css_style_for_calibration_report(3)).to eq('c2')
expect(helper.get_css_style_for_calibration_report(4)).to eq('c1')
end
end
end
</pre>

==Design Pattern==

A design pattern is a general repeatable solution to a commonly occurring problem in software design. It is a description or template for how to solve a problem that can be used in many different situations.

During the process of refactoring methods as well as method names,'''Strategy Pattern''' was used in the implementation. The Strategy pattern is most useful when you want to provide multiple ways of processing a request, without hard-coding knowledge about those different methods into the object that handles the request.

==References==

1) https://www.rubyguides.com/2015/12/ruby-refactoring/

2) http://rspec.info/documentation/3.8/rspec-core/

3) http://wiki.expertiza.ncsu.edu/index.php/Main_Page

==Team Members==

Ashish Kumar Jayantilal Jain

Aishwarya Tirumala

Devang Upadhyay

CSC/ECE 517 Spring 2019 - Project E1913. Refactor review mapping helper.rb

2019-04-02T01:44:25Z

Drupadhy: /* Refactoring method */

==Introduction==
This page gives a description of the changes made for the ''review_mapping_helper.rb'' of Expertiza based OSS project.

===Expertiza Background ===
Expertiza is a web application where students can submit and peer-review learning objects (articles, codes, websites, etc). Instructors add and grade the assignments submitted by students to Expertiza. Students can be assigned in teams based on their selection of the topics. It has functionalities such as peer reviews in which students can provide feedback on other's work which helps peer in better developing the project. It is supported by the National Science Foundation.

=== Problem Statement ===

The review_mapping_helper.rb has multiple functions with a wrong naming convention, they are classic examples of bad function names. These functions are to be refactored accordingly. Few of the variables names used in the method must also be refactored to make it more relevant and understandable. In addition, some function's code is to be optimized to ensure that it follows DRY principle. Tests must be written for the functions which are modified. Also, comments must be added to all functions of the file. The create_report_table_header function contains HTML code which should be ideally placed in the view as partials, which will allow to easily reuse the code in Rails application.

==Implementation==

===Flowchart===

The following process is carried out to complete the project-

[[File:Steps for project.png]]

===Refactoring===

====Refactoring method names====
All the method names that are refactored are mentioned below-

'''Before:'''

get_each_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_each_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_certain_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_certain_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_team_name_color_in_review_report

'''After:'''

get_team_colour ''[The method suggests that team color is defined in the review report, so we do not need to put in_review_report in the method name]''

'''Before:'''

get_each_round_score_awarded_for_review_report

'''After:'''

get_awarded_review_score ''[The method gets the awarded score for review, so we do not need to put for_review_report in the method name]''

'''Before:'''

get_min_max_avg_value_for_review_report

'''After:'''

get_review_metrics ''[Since minimum, maximum and average value is the part of metrics in review report, we can replace it all by metrics]''

====Refactoring method====

The following method was not used or called in any of the files in the project. Due to that reason, the entire function was commented out.

<pre>
def get_current_round(reviewer_id)
user_id = Participant.find(reviewer_id).user.id
topic_id = SignedUpTeam.topic_id(@assignment.id, user_id)
@assignment.number_of_current_round(topic_id)
@assignment.num_review_rounds if @assignment.get_current_stage(topic_id) == "Finished" || @assignment.get_current_stage(topic_id) == "metareview"
end
</pre>

<br>
The method '''get_css_style_for_calibration_report''' had a switch case. It was refactored using a dictionary where the case numbers were keys and the outputs of each case were the corresponding values.

'''Before:'''
<pre>
def get_css_style_for_calibration_report(diff)
# diff - difference between stu's answer and instructor's answer
css_class = case diff.abs
when 0
'c5'
when 1
'c4'
when 2
'c3'
when 3
'c2'
else
'c1'
end
css_class
end
</pre>

'''After:'''
<pre>
def get_css_style_for_calibration_report(diff)
# diff - difference between stu's answer and instructor's answer
dict = {0 => 'c5',1 => 'c4',2 => 'c3',3 => 'c2'}
if dict.key?(diff.abs)
css_class = dict[diff.abs]
else
css_class = 'c1'
end
css_class
end
</pre>

===Comments added to various functions===
There were several methods which didn't have any comments or the comments weren't meaningful. In all those cases, comments have been added or changed which are mentioned as follows:

<pre>
# gets the review score awarded based on each round of the review
def get_each_round_score_awarded_for_review_report(reviewer_id, team_id)
</pre>

<pre>
# gets minimum, maximum and average value for all the reviews
def get_min_max_avg_value_for_review_report(round, team_id)
</pre>

<pre>
# sorts the reviewers by the average volume of reviews in each round, in descending order
def sort_reviewer_by_review_volume_desc
</pre>

<pre>
# displays all the average scores in round 1, 2 and 3
def display_volume_metric(overall_avg_vol, avg_vol_in_round_1, avg_vol_in_round_2, avg_vol_in_round_3)
</pre>

<pre>
# moves data of reviews in each round from a current round
def initialize_chart_elements(reviewer)
</pre>

<pre>
# The data of all the reviews is displayed in the form of a bar chart
def display_volume_metric_chart(reviewer)
</pre>

<pre>
# For assignments with 1 team member, the following method returns user's fullname else it returns "team name" that a particular reviewee belongs to.
def get_team_reviewed_link_name(max_team_size, response, reviewee_id)
</pre>

<pre>
# if the current stage is "submission" or "review", function returns the current round number otherwise
# if the current stage is "Finished" or "metareview", function returns the number of rounds of review completed
def get_current_round_for_review_report(reviewer_id)
</pre>

<pre>
# gets the response map data such as reviewer id, reviewd object id and type for the review report
def get_data_for_review_report(reviewed_object_id, reviewer_id, type)
</pre>

<pre>
# gets the team name's color according to review and assignment submission status
def get_team_name_color_in_review_report(response_map)
</pre>

<pre>
# checks if a review was submitted in every round and gives the total responses count
def response_for_each_round?(response_map)
</pre>

<pre>
# returns hyperlink of the assignment that has been submitted on the due date
def submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
</pre>

===Function placed in the view as partials===

The following method has been removed from the '''review_mapping_helper.rb''' and added to the views as partials:

<pre>
def create_report_table_header(headers = {})
table_header = "<div class = 'reviewreport'>\
<table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'>\
<tr bgcolor='#CCCCCC'>"
headers.each do |header, percentage|
table_header += if percentage
"<th width = #{percentage}>\
#{header.humanize}\
</th>"
else
"<th>\
#{header.humanize}\
</th>"
end
end
table_header += "</tr>"
table_header.html_safe
end
</pre>

The following is the code available in views in the file '''_report_table_header.html.erb''':

<pre>
<% table_header = "<div class = 'reviewreport'><table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'><tr bgcolor='#CCCCCC'>" %>
<% headers.each do |header, percentage| %>
<% table_header += if percentage %>
<% "<th width = #{percentage}> #{header.humanize} </th>" %>
<% else %>
<%"<th> #{header.humanize} </th>" %>
<% end %>
<% end %>
<% table_header += "</tr>"%>
<% return table_header.html_safe %>
</pre>

==Testing==

===Test Plan===

There were changes made in the function name as well as one of the function was added to partials. Testing was carried out to check the behavior of these functions. In one of the case, a drop-down menu was tested i.e, all the links that were accessed were tested. It was checked that clicking on every link produced the desired output in all the options of the drop-down menu. For these cases, Manual testing, as well as RSpec testing, was carried out.

===Manual Testing===

''To be carried out''

===RSpec Testing===

RSpec testing was carried out for the methods that had been refactored. The partial that was added had impacts on the drop-down menus. Given below is one of the snippets of the entire code written in the file '''review_mapping_helper_spec.rb'''. The file path is '''spec/features/review_mapping_helper_spec.rb'''.

<pre>
require 'rspec'

describe 'Tests Review report' do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_on 'View'
end

it "can display review metrics" do
expect(page).to have_content('Metrics')
end

it "can display review grades of each round" do
expect(page).to have_content('Score awarded')
end

it "can display reviews done" do
expect(page).to have_content('Reviews done')
end

it "can display Reviewer" do
expect(page).to have_content('Reviewer')
end

it "can display team reviewed" do
expect(page).to have_content('Team reviewed')
end
end
</pre>

==Design Pattern==

A design pattern is a general repeatable solution to a commonly occurring problem in software design. It is a description or template for how to solve a problem that can be used in many different situations.

During the process of refactoring methods as well as method names,'''Strategy Pattern''' was used in the implementation. The Strategy pattern is most useful when you want to provide multiple ways of processing a request, without hard-coding knowledge about those different methods into the object that handles the request.

==References==

1) https://www.rubyguides.com/2015/12/ruby-refactoring/

2) http://rspec.info/documentation/3.8/rspec-core/

3) http://wiki.expertiza.ncsu.edu/index.php/Main_Page

==Team Members==

Ashish Kumar Jayantilal Jain

Aishwarya Tirumala

Devang Upadhyay

CSC/ECE 517 Spring 2019 - Project E1913. Refactor review mapping helper.rb

2019-04-02T01:43:54Z

Drupadhy: /* Refactoring method */

==Introduction==
This page gives a description of the changes made for the ''review_mapping_helper.rb'' of Expertiza based OSS project.

===Expertiza Background ===
Expertiza is a web application where students can submit and peer-review learning objects (articles, codes, websites, etc). Instructors add and grade the assignments submitted by students to Expertiza. Students can be assigned in teams based on their selection of the topics. It has functionalities such as peer reviews in which students can provide feedback on other's work which helps peer in better developing the project. It is supported by the National Science Foundation.

=== Problem Statement ===

The review_mapping_helper.rb has multiple functions with a wrong naming convention, they are classic examples of bad function names. These functions are to be refactored accordingly. Few of the variables names used in the method must also be refactored to make it more relevant and understandable. In addition, some function's code is to be optimized to ensure that it follows DRY principle. Tests must be written for the functions which are modified. Also, comments must be added to all functions of the file. The create_report_table_header function contains HTML code which should be ideally placed in the view as partials, which will allow to easily reuse the code in Rails application.

==Implementation==

===Flowchart===

The following process is carried out to complete the project-

[[File:Steps for project.png]]

===Refactoring===

====Refactoring method names====
All the method names that are refactored are mentioned below-

'''Before:'''

get_each_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_each_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_certain_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_certain_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_team_name_color_in_review_report

'''After:'''

get_team_colour ''[The method suggests that team color is defined in the review report, so we do not need to put in_review_report in the method name]''

'''Before:'''

get_each_round_score_awarded_for_review_report

'''After:'''

get_awarded_review_score ''[The method gets the awarded score for review, so we do not need to put for_review_report in the method name]''

'''Before:'''

get_min_max_avg_value_for_review_report

'''After:'''

get_review_metrics ''[Since minimum, maximum and average value is the part of metrics in review report, we can replace it all by metrics]''

====Refactoring method====

The following method was not used or called in any of the files in the project. Due to that reason, the entire function was commented out.

<pre>
def get_current_round(reviewer_id)
user_id = Participant.find(reviewer_id).user.id
topic_id = SignedUpTeam.topic_id(@assignment.id, user_id)
@assignment.number_of_current_round(topic_id)
@assignment.num_review_rounds if @assignment.get_current_stage(topic_id) == "Finished" || @assignment.get_current_stage(topic_id) == "metareview"
end
</pre>

<br>
The method '''get_css_style_for_calibration_report''' had a switch case. It was refactored using a dictionary where the case numbers were keys and the outputs of each case were the corresponding values.

Before:
<pre>
def get_css_style_for_calibration_report(diff)
# diff - difference between stu's answer and instructor's answer
css_class = case diff.abs
when 0
'c5'
when 1
'c4'
when 2
'c3'
when 3
'c2'
else
'c1'
end
css_class
end
</pre>

After:
<pre>
def get_css_style_for_calibration_report(diff)
# diff - difference between stu's answer and instructor's answer
dict = {0 => 'c5',1 => 'c4',2 => 'c3',3 => 'c2'}
if dict.key?(diff.abs)
css_class = dict[diff.abs]
else
css_class = 'c1'
end
css_class
end
</pre>

===Comments added to various functions===
There were several methods which didn't have any comments or the comments weren't meaningful. In all those cases, comments have been added or changed which are mentioned as follows:

<pre>
# gets the review score awarded based on each round of the review
def get_each_round_score_awarded_for_review_report(reviewer_id, team_id)
</pre>

<pre>
# gets minimum, maximum and average value for all the reviews
def get_min_max_avg_value_for_review_report(round, team_id)
</pre>

<pre>
# sorts the reviewers by the average volume of reviews in each round, in descending order
def sort_reviewer_by_review_volume_desc
</pre>

<pre>
# displays all the average scores in round 1, 2 and 3
def display_volume_metric(overall_avg_vol, avg_vol_in_round_1, avg_vol_in_round_2, avg_vol_in_round_3)
</pre>

<pre>
# moves data of reviews in each round from a current round
def initialize_chart_elements(reviewer)
</pre>

<pre>
# The data of all the reviews is displayed in the form of a bar chart
def display_volume_metric_chart(reviewer)
</pre>

<pre>
# For assignments with 1 team member, the following method returns user's fullname else it returns "team name" that a particular reviewee belongs to.
def get_team_reviewed_link_name(max_team_size, response, reviewee_id)
</pre>

<pre>
# if the current stage is "submission" or "review", function returns the current round number otherwise
# if the current stage is "Finished" or "metareview", function returns the number of rounds of review completed
def get_current_round_for_review_report(reviewer_id)
</pre>

<pre>
# gets the response map data such as reviewer id, reviewd object id and type for the review report
def get_data_for_review_report(reviewed_object_id, reviewer_id, type)
</pre>

<pre>
# gets the team name's color according to review and assignment submission status
def get_team_name_color_in_review_report(response_map)
</pre>

<pre>
# checks if a review was submitted in every round and gives the total responses count
def response_for_each_round?(response_map)
</pre>

<pre>
# returns hyperlink of the assignment that has been submitted on the due date
def submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
</pre>

===Function placed in the view as partials===

The following method has been removed from the '''review_mapping_helper.rb''' and added to the views as partials:

<pre>
def create_report_table_header(headers = {})
table_header = "<div class = 'reviewreport'>\
<table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'>\
<tr bgcolor='#CCCCCC'>"
headers.each do |header, percentage|
table_header += if percentage
"<th width = #{percentage}>\
#{header.humanize}\
</th>"
else
"<th>\
#{header.humanize}\
</th>"
end
end
table_header += "</tr>"
table_header.html_safe
end
</pre>

The following is the code available in views in the file '''_report_table_header.html.erb''':

<pre>
<% table_header = "<div class = 'reviewreport'><table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'><tr bgcolor='#CCCCCC'>" %>
<% headers.each do |header, percentage| %>
<% table_header += if percentage %>
<% "<th width = #{percentage}> #{header.humanize} </th>" %>
<% else %>
<%"<th> #{header.humanize} </th>" %>
<% end %>
<% end %>
<% table_header += "</tr>"%>
<% return table_header.html_safe %>
</pre>

==Testing==

===Test Plan===

There were changes made in the function name as well as one of the function was added to partials. Testing was carried out to check the behavior of these functions. In one of the case, a drop-down menu was tested i.e, all the links that were accessed were tested. It was checked that clicking on every link produced the desired output in all the options of the drop-down menu. For these cases, Manual testing, as well as RSpec testing, was carried out.

===Manual Testing===

''To be carried out''

===RSpec Testing===

RSpec testing was carried out for the methods that had been refactored. The partial that was added had impacts on the drop-down menus. Given below is one of the snippets of the entire code written in the file '''review_mapping_helper_spec.rb'''. The file path is '''spec/features/review_mapping_helper_spec.rb'''.

<pre>
require 'rspec'

describe 'Tests Review report' do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_on 'View'
end

it "can display review metrics" do
expect(page).to have_content('Metrics')
end

it "can display review grades of each round" do
expect(page).to have_content('Score awarded')
end

it "can display reviews done" do
expect(page).to have_content('Reviews done')
end

it "can display Reviewer" do
expect(page).to have_content('Reviewer')
end

it "can display team reviewed" do
expect(page).to have_content('Team reviewed')
end
end
</pre>

==Design Pattern==

A design pattern is a general repeatable solution to a commonly occurring problem in software design. It is a description or template for how to solve a problem that can be used in many different situations.

During the process of refactoring methods as well as method names,'''Strategy Pattern''' was used in the implementation. The Strategy pattern is most useful when you want to provide multiple ways of processing a request, without hard-coding knowledge about those different methods into the object that handles the request.

==References==

1) https://www.rubyguides.com/2015/12/ruby-refactoring/

2) http://rspec.info/documentation/3.8/rspec-core/

3) http://wiki.expertiza.ncsu.edu/index.php/Main_Page

==Team Members==

Ashish Kumar Jayantilal Jain

Aishwarya Tirumala

Devang Upadhyay

CSC/ECE 517 Spring 2019 - Project E1913. Refactor review mapping helper.rb

2019-04-02T01:41:46Z

Drupadhy: /* Refactoring method */

==Introduction==
This page gives a description of the changes made for the ''review_mapping_helper.rb'' of Expertiza based OSS project.

===Expertiza Background ===
Expertiza is a web application where students can submit and peer-review learning objects (articles, codes, websites, etc). Instructors add and grade the assignments submitted by students to Expertiza. Students can be assigned in teams based on their selection of the topics. It has functionalities such as peer reviews in which students can provide feedback on other's work which helps peer in better developing the project. It is supported by the National Science Foundation.

=== Problem Statement ===

The review_mapping_helper.rb has multiple functions with a wrong naming convention, they are classic examples of bad function names. These functions are to be refactored accordingly. Few of the variables names used in the method must also be refactored to make it more relevant and understandable. In addition, some function's code is to be optimized to ensure that it follows DRY principle. Tests must be written for the functions which are modified. Also, comments must be added to all functions of the file. The create_report_table_header function contains HTML code which should be ideally placed in the view as partials, which will allow to easily reuse the code in Rails application.

==Implementation==

===Flowchart===

The following process is carried out to complete the project-

[[File:Steps for project.png]]

===Refactoring===

====Refactoring method names====
All the method names that are refactored are mentioned below-

'''Before:'''

get_each_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_each_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_certain_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_certain_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_team_name_color_in_review_report

'''After:'''

get_team_colour ''[The method suggests that team color is defined in the review report, so we do not need to put in_review_report in the method name]''

'''Before:'''

get_each_round_score_awarded_for_review_report

'''After:'''

get_awarded_review_score ''[The method gets the awarded score for review, so we do not need to put for_review_report in the method name]''

'''Before:'''

get_min_max_avg_value_for_review_report

'''After:'''

get_review_metrics ''[Since minimum, maximum and average value is the part of metrics in review report, we can replace it all by metrics]''

====Refactoring method====

The following method was not used or called in any of the files in the project. Due to that reason, the entire function was commented out.

<pre>
def get_current_round(reviewer_id)
user_id = Participant.find(reviewer_id).user.id
topic_id = SignedUpTeam.topic_id(@assignment.id, user_id)
@assignment.number_of_current_round(topic_id)
@assignment.num_review_rounds if @assignment.get_current_stage(topic_id) == "Finished" || @assignment.get_current_stage(topic_id) == "metareview"
end
</pre>

<br>
The method '''get_css_style_for_calibration_report''' had a switch case. It was refactored using a dictionary where the case numbers were keys and the outputs of each case were the corresponding values. The refactored method is as follows:

<pre>
def get_css_style_for_calibration_report(diff)
# diff - difference between stu's answer and instructor's answer
dict = {0 => 'c5',1 => 'c4',2 => 'c3',3 => 'c2'}
if dict.key?(diff.abs)
css_class = dict[diff.abs]
else
css_class = 'c1'
end
css_class
end
</pre>

===Comments added to various functions===
There were several methods which didn't have any comments or the comments weren't meaningful. In all those cases, comments have been added or changed which are mentioned as follows:

<pre>
# gets the review score awarded based on each round of the review
def get_each_round_score_awarded_for_review_report(reviewer_id, team_id)
</pre>

<pre>
# gets minimum, maximum and average value for all the reviews
def get_min_max_avg_value_for_review_report(round, team_id)
</pre>

<pre>
# sorts the reviewers by the average volume of reviews in each round, in descending order
def sort_reviewer_by_review_volume_desc
</pre>

<pre>
# displays all the average scores in round 1, 2 and 3
def display_volume_metric(overall_avg_vol, avg_vol_in_round_1, avg_vol_in_round_2, avg_vol_in_round_3)
</pre>

<pre>
# moves data of reviews in each round from a current round
def initialize_chart_elements(reviewer)
</pre>

<pre>
# The data of all the reviews is displayed in the form of a bar chart
def display_volume_metric_chart(reviewer)
</pre>

<pre>
# For assignments with 1 team member, the following method returns user's fullname else it returns "team name" that a particular reviewee belongs to.
def get_team_reviewed_link_name(max_team_size, response, reviewee_id)
</pre>

<pre>
# if the current stage is "submission" or "review", function returns the current round number otherwise
# if the current stage is "Finished" or "metareview", function returns the number of rounds of review completed
def get_current_round_for_review_report(reviewer_id)
</pre>

<pre>
# gets the response map data such as reviewer id, reviewd object id and type for the review report
def get_data_for_review_report(reviewed_object_id, reviewer_id, type)
</pre>

<pre>
# gets the team name's color according to review and assignment submission status
def get_team_name_color_in_review_report(response_map)
</pre>

<pre>
# checks if a review was submitted in every round and gives the total responses count
def response_for_each_round?(response_map)
</pre>

<pre>
# returns hyperlink of the assignment that has been submitted on the due date
def submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
</pre>

===Function placed in the view as partials===

The following method has been removed from the '''review_mapping_helper.rb''' and added to the views as partials:

<pre>
def create_report_table_header(headers = {})
table_header = "<div class = 'reviewreport'>\
<table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'>\
<tr bgcolor='#CCCCCC'>"
headers.each do |header, percentage|
table_header += if percentage
"<th width = #{percentage}>\
#{header.humanize}\
</th>"
else
"<th>\
#{header.humanize}\
</th>"
end
end
table_header += "</tr>"
table_header.html_safe
end
</pre>

The following is the code available in views in the file '''_report_table_header.html.erb''':

<pre>
<% table_header = "<div class = 'reviewreport'><table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'><tr bgcolor='#CCCCCC'>" %>
<% headers.each do |header, percentage| %>
<% table_header += if percentage %>
<% "<th width = #{percentage}> #{header.humanize} </th>" %>
<% else %>
<%"<th> #{header.humanize} </th>" %>
<% end %>
<% end %>
<% table_header += "</tr>"%>
<% return table_header.html_safe %>
</pre>

==Testing==

===Test Plan===

There were changes made in the function name as well as one of the function was added to partials. Testing was carried out to check the behavior of these functions. In one of the case, a drop-down menu was tested i.e, all the links that were accessed were tested. It was checked that clicking on every link produced the desired output in all the options of the drop-down menu. For these cases, Manual testing, as well as RSpec testing, was carried out.

===Manual Testing===

''To be carried out''

===RSpec Testing===

RSpec testing was carried out for the methods that had been refactored. The partial that was added had impacts on the drop-down menus. Given below is one of the snippets of the entire code written in the file '''review_mapping_helper_spec.rb'''. The file path is '''spec/features/review_mapping_helper_spec.rb'''.

<pre>
require 'rspec'

describe 'Tests Review report' do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_on 'View'
end

it "can display review metrics" do
expect(page).to have_content('Metrics')
end

it "can display review grades of each round" do
expect(page).to have_content('Score awarded')
end

it "can display reviews done" do
expect(page).to have_content('Reviews done')
end

it "can display Reviewer" do
expect(page).to have_content('Reviewer')
end

it "can display team reviewed" do
expect(page).to have_content('Team reviewed')
end
end
</pre>

==Design Pattern==

A design pattern is a general repeatable solution to a commonly occurring problem in software design. It is a description or template for how to solve a problem that can be used in many different situations.

During the process of refactoring methods as well as method names,'''Strategy Pattern''' was used in the implementation. The Strategy pattern is most useful when you want to provide multiple ways of processing a request, without hard-coding knowledge about those different methods into the object that handles the request.

==References==

1) https://www.rubyguides.com/2015/12/ruby-refactoring/

2) http://rspec.info/documentation/3.8/rspec-core/

3) http://wiki.expertiza.ncsu.edu/index.php/Main_Page

==Team Members==

Ashish Kumar Jayantilal Jain

Aishwarya Tirumala

Devang Upadhyay

CSC/ECE 517 Spring 2019 - Project E1913. Refactor review mapping helper.rb

2019-04-01T21:31:38Z

Drupadhy: /* Testing */

==Introduction==
This page gives a description of the changes made for the ''review_mapping_helper.rb'' of Expertiza based OSS project.

===Expertiza Background ===
Expertiza is a web application where students can submit and peer-review learning objects (articles, codes, websites, etc). Instructors add and grade the assignments submitted by students to Expertiza. Students can be assigned in teams based on their selection of the topics. It has functionalities such as peer reviews in which students can provide feedback on other's work which helps peer in better developing the project. It is supported by the National Science Foundation.

=== Problem Statement ===

The review_mapping_helper.rb has multiple functions with a wrong naming convention, they are classic examples of bad function names. These functions are to be refactored accordingly. Few of the variables names used in the method must also be refactored to make it more relevant and understandable. In addition, some function's code is to be optimized to ensure that it follows DRY principle. Tests must be written for the functions which are modified. Also, comments must be added to all functions of the file. The create_report_table_header function contains HTML code which should be ideally placed in the view as partials, which will allow to easily reuse the code in Rails application.

==Implementation==

===Flowchart===

The following process is carried out to complete the project-

[[File:Steps for project.png]]

===Refactoring===

====Refactoring method names====
All the method names that are refactored are mentioned below-

'''Before:'''

get_each_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_each_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_certain_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_certain_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_team_name_color_in_review_report

'''After:'''

get_team_colour ''[The method suggests that team color is defined in the review report, so we do not need to put in_review_report in the method name]''

'''Before:'''

get_each_round_score_awarded_for_review_report

'''After:'''

get_awarded_review_score ''[The method gets the awarded score for review, so we do not need to put for_review_report in the method name]''

'''Before:'''

get_min_max_avg_value_for_review_report

'''After:'''

get_review_metrics ''[Since minimum, maximum and average value is the part of metrics in review report, we can replace it all by metrics]''

====Refactoring method====

The following method was not used or called in any of the files in the project. Due to that reason, the entire function was commented out.

<pre>
def get_current_round(reviewer_id)
user_id = Participant.find(reviewer_id).user.id
topic_id = SignedUpTeam.topic_id(@assignment.id, user_id)
@assignment.number_of_current_round(topic_id)
@assignment.num_review_rounds if @assignment.get_current_stage(topic_id) == "Finished" || @assignment.get_current_stage(topic_id) == "metareview"
end
</pre>

===Comments added to various functions===
There were several methods which didn't have any comments or the comments weren't meaningful. In all those cases, comments have been added or changed which are mentioned as follows:

<pre>
# gets the review score awarded based on each round of the review
def get_each_round_score_awarded_for_review_report(reviewer_id, team_id)
</pre>

<pre>
# gets minimum, maximum and average value for all the reviews
def get_min_max_avg_value_for_review_report(round, team_id)
</pre>

<pre>
# sorts the reviewers by the average volume of reviews in each round, in descending order
def sort_reviewer_by_review_volume_desc
</pre>

<pre>
# displays all the average scores in round 1, 2 and 3
def display_volume_metric(overall_avg_vol, avg_vol_in_round_1, avg_vol_in_round_2, avg_vol_in_round_3)
</pre>

<pre>
# moves data of reviews in each round from a current round
def initialize_chart_elements(reviewer)
</pre>

<pre>
# The data of all the reviews is displayed in the form of a bar chart
def display_volume_metric_chart(reviewer)
</pre>

<pre>
# For assignments with 1 team member, the following method returns user's fullname else it returns "team name" that a particular reviewee belongs to.
def get_team_reviewed_link_name(max_team_size, response, reviewee_id)
</pre>

<pre>
# if the current stage is "submission" or "review", function returns the current round number otherwise
# if the current stage is "Finished" or "metareview", function returns the number of rounds of review completed
def get_current_round_for_review_report(reviewer_id)
</pre>

<pre>
# gets the response map data such as reviewer id, reviewd object id and type for the review report
def get_data_for_review_report(reviewed_object_id, reviewer_id, type)
</pre>

<pre>
# gets the team name's color according to review and assignment submission status
def get_team_name_color_in_review_report(response_map)
</pre>

<pre>
# checks if a review was submitted in every round and gives the total responses count
def response_for_each_round?(response_map)
</pre>

<pre>
# returns hyperlink of the assignment that has been submitted on the due date
def submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
</pre>

===Function placed in the view as partials===

The following method has been removed from the '''review_mapping_helper.rb''' and added to the views as partials:

<pre>
def create_report_table_header(headers = {})
table_header = "<div class = 'reviewreport'>\
<table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'>\
<tr bgcolor='#CCCCCC'>"
headers.each do |header, percentage|
table_header += if percentage
"<th width = #{percentage}>\
#{header.humanize}\
</th>"
else
"<th>\
#{header.humanize}\
</th>"
end
end
table_header += "</tr>"
table_header.html_safe
end
</pre>

The following is the code available in views in the file '''_report_table_header.html.erb''':

<pre>
<% table_header = "<div class = 'reviewreport'><table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'><tr bgcolor='#CCCCCC'>" %>
<% headers.each do |header, percentage| %>
<% table_header += if percentage %>
<% "<th width = #{percentage}> #{header.humanize} </th>" %>
<% else %>
<%"<th> #{header.humanize} </th>" %>
<% end %>
<% end %>
<% table_header += "</tr>"%>
<% return table_header.html_safe %>
</pre>

==Testing==

===Test Plan===

There were changes made in the function name as well as one of the function was added to partials. Testing was carried out to check the behavior of these functions. In one of the case, a drop-down menu was tested i.e, all the links that were accessed were tested. It was checked that clicking on every link produced the desired output in all the options of the drop-down menu. For these cases, Manual testing, as well as RSpec testing, was carried out.

===Manual Testing===

''To be carried out''

===RSpec Testing===

RSpec testing was carried out for the methods that had been refactored. The partial that was added had impacts on the drop-down menus. Given below is one of the snippets of the entire code written in the file '''review_mapping_helper_spec.rb'''. The file path is '''spec/features/review_mapping_helper_spec.rb'''.

<pre>
require 'rspec'

describe 'Tests Review report' do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_on 'View'
end

it "can display review metrics" do
expect(page).to have_content('Metrics')
end

it "can display review grades of each round" do
expect(page).to have_content('Score awarded')
end

it "can display reviews done" do
expect(page).to have_content('Reviews done')
end

it "can display Reviewer" do
expect(page).to have_content('Reviewer')
end

it "can display team reviewed" do
expect(page).to have_content('Team reviewed')
end
end
</pre>

==Design Pattern==

A design pattern is a general repeatable solution to a commonly occurring problem in software design. It is a description or template for how to solve a problem that can be used in many different situations.

During the process of refactoring methods as well as method names,'''Strategy Pattern''' was used in the implementation. The Strategy pattern is most useful when you want to provide multiple ways of processing a request, without hard-coding knowledge about those different methods into the object that handles the request.

==References==

1) https://www.rubyguides.com/2015/12/ruby-refactoring/

2) http://rspec.info/documentation/3.8/rspec-core/

3) http://wiki.expertiza.ncsu.edu/index.php/Main_Page

==Team Members==

Ashish Kumar Jayantilal Jain

Aishwarya Tirumala

Devang Upadhyay

CSC/ECE 517 Spring 2019 - Project E1913. Refactor review mapping helper.rb

2019-04-01T21:16:32Z

Drupadhy: /* RSpec Testing */

==Introduction==
This page gives a description of the changes made for the ''review_mapping_helper.rb'' of Expertiza based OSS project.

===Expertiza Background ===
Expertiza is a web application where students can submit and peer-review learning objects (articles, codes, websites, etc). Instructors add and grade the assignments submitted by students to Expertiza. Students can be assigned in teams based on their selection of the topics. It has functionalities such as peer reviews in which students can provide feedback on other's work which helps peer in better developing the project. It is supported by the National Science Foundation.

=== Problem Statement ===

The review_mapping_helper.rb has multiple functions with a wrong naming convention, they are classic examples of bad function names. These functions are to be refactored accordingly. Few of the variables names used in the method must also be refactored to make it more relevant and understandable. In addition, some function's code is to be optimized to ensure that it follows DRY principle. Tests must be written for the functions which are modified. Also, comments must be added to all functions of the file. The create_report_table_header function contains HTML code which should be ideally placed in the view as partials, which will allow to easily reuse the code in Rails application.

==Implementation==

===Flowchart===

The following process is carried out to complete the project-

[[File:Steps for project.png]]

===Refactoring===

====Refactoring method names====
All the method names that are refactored are mentioned below-

'''Before:'''

get_each_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_each_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_certain_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_certain_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_team_name_color_in_review_report

'''After:'''

get_team_colour ''[The method suggests that team color is defined in the review report, so we do not need to put in_review_report in the method name]''

'''Before:'''

get_each_round_score_awarded_for_review_report

'''After:'''

get_awarded_review_score ''[The method gets the awarded score for review, so we do not need to put for_review_report in the method name]''

'''Before:'''

get_min_max_avg_value_for_review_report

'''After:'''

get_review_metrics ''[Since minimum, maximum and average value is the part of metrics in review report, we can replace it all by metrics]''

====Refactoring method====

The following method was not used or called in any of the files in the project. Due to that reason, the entire function was commented out.

<pre>
def get_current_round(reviewer_id)
user_id = Participant.find(reviewer_id).user.id
topic_id = SignedUpTeam.topic_id(@assignment.id, user_id)
@assignment.number_of_current_round(topic_id)
@assignment.num_review_rounds if @assignment.get_current_stage(topic_id) == "Finished" || @assignment.get_current_stage(topic_id) == "metareview"
end
</pre>

===Comments added to various functions===
There were several methods which didn't have any comments or the comments weren't meaningful. In all those cases, comments have been added or changed which are mentioned as follows:

<pre>
# gets the review score awarded based on each round of the review
def get_each_round_score_awarded_for_review_report(reviewer_id, team_id)
</pre>

<pre>
# gets minimum, maximum and average value for all the reviews
def get_min_max_avg_value_for_review_report(round, team_id)
</pre>

<pre>
# sorts the reviewers by the average volume of reviews in each round, in descending order
def sort_reviewer_by_review_volume_desc
</pre>

<pre>
# displays all the average scores in round 1, 2 and 3
def display_volume_metric(overall_avg_vol, avg_vol_in_round_1, avg_vol_in_round_2, avg_vol_in_round_3)
</pre>

<pre>
# moves data of reviews in each round from a current round
def initialize_chart_elements(reviewer)
</pre>

<pre>
# The data of all the reviews is displayed in the form of a bar chart
def display_volume_metric_chart(reviewer)
</pre>

<pre>
# For assignments with 1 team member, the following method returns user's fullname else it returns "team name" that a particular reviewee belongs to.
def get_team_reviewed_link_name(max_team_size, response, reviewee_id)
</pre>

<pre>
# if the current stage is "submission" or "review", function returns the current round number otherwise
# if the current stage is "Finished" or "metareview", function returns the number of rounds of review completed
def get_current_round_for_review_report(reviewer_id)
</pre>

<pre>
# gets the response map data such as reviewer id, reviewd object id and type for the review report
def get_data_for_review_report(reviewed_object_id, reviewer_id, type)
</pre>

<pre>
# gets the team name's color according to review and assignment submission status
def get_team_name_color_in_review_report(response_map)
</pre>

<pre>
# checks if a review was submitted in every round and gives the total responses count
def response_for_each_round?(response_map)
</pre>

<pre>
# returns hyperlink of the assignment that has been submitted on the due date
def submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
</pre>

===Function placed in the view as partials===

The following method has been removed from the '''review_mapping_helper.rb''' and added to the views as partials:

<pre>
def create_report_table_header(headers = {})
table_header = "<div class = 'reviewreport'>\
<table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'>\
<tr bgcolor='#CCCCCC'>"
headers.each do |header, percentage|
table_header += if percentage
"<th width = #{percentage}>\
#{header.humanize}\
</th>"
else
"<th>\
#{header.humanize}\
</th>"
end
end
table_header += "</tr>"
table_header.html_safe
end
</pre>

The following is the code available in views in the file '''_report_table_header.html.erb''':

<pre>
<% table_header = "<div class = 'reviewreport'><table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'><tr bgcolor='#CCCCCC'>" %>
<% headers.each do |header, percentage| %>
<% table_header += if percentage %>
<% "<th width = #{percentage}> #{header.humanize} </th>" %>
<% else %>
<%"<th> #{header.humanize} </th>" %>
<% end %>
<% end %>
<% table_header += "</tr>"%>
<% return table_header.html_safe %>
</pre>

==Testing==

===Manual Testing===

''To be carried out''

===RSpec Testing===

RSpec testing was carried out for the methods that had been refactored. The partial that was added had impacts on the drop-down menus. Given below is one of the snippets of the entire code written in the file '''review_mapping_helper_spec.rb'''. The file path is '''spec/features/review_mapping_helper_spec.rb'''.

<pre>
require 'rspec'

describe 'Tests Review report' do
before(:each) do
create(:instructor)
create(:assignment, course: nil, name: 'Test Assignment')
assignment_id = Assignment.where(name: 'Test Assignment')[0].id
login_as 'instructor6'
visit "/reports/response_report?id=#{assignment_id}"
click_on 'View'
end

it "can display review metrics" do
expect(page).to have_content('Metrics')
end

it "can display review grades of each round" do
expect(page).to have_content('Score awarded')
end

it "can display reviews done" do
expect(page).to have_content('Reviews done')
end

it "can display Reviewer" do
expect(page).to have_content('Reviewer')
end

it "can display team reviewed" do
expect(page).to have_content('Team reviewed')
end
end
</pre>

==Design Pattern==

A design pattern is a general repeatable solution to a commonly occurring problem in software design. It is a description or template for how to solve a problem that can be used in many different situations.

During the process of refactoring methods as well as method names,'''Strategy Pattern''' was used in the implementation. The Strategy pattern is most useful when you want to provide multiple ways of processing a request, without hard-coding knowledge about those different methods into the object that handles the request.

==References==

1) https://www.rubyguides.com/2015/12/ruby-refactoring/

2) http://rspec.info/documentation/3.8/rspec-core/

3) http://wiki.expertiza.ncsu.edu/index.php/Main_Page

==Team Members==

Ashish Kumar Jayantilal Jain

Aishwarya Tirumala

Devang Upadhyay

CSC/ECE 517 Spring 2019 - Project E1913. Refactor review mapping helper.rb

2019-04-01T19:40:45Z

Drupadhy: Created page with "==Introduction== This page gives a description of the changes made for the ''review_mapping_helper.rb'' of Expertiza based OSS project. ===Expertiza Background === Expertiza is ..."

==Introduction==
This page gives a description of the changes made for the ''review_mapping_helper.rb'' of Expertiza based OSS project.

===Expertiza Background ===
Expertiza is a web application where students can submit and peer-review learning objects (articles, codes, websites, etc). Instructors add and grade the assignments submitted by students to Expertiza. Students can be assigned in teams based on their selection of the topics. It has functionalities such as peer reviews in which students can provide feedback on other's work which helps peer in better developing the project. It is supported by the National Science Foundation.

=== Problem Statement ===

The review_mapping_helper.rb has multiple functions with a wrong naming convention, they are classic examples of bad function names. These functions are to be refactored accordingly. Few of the variables names used in the method must also be refactored to make it more relevant and understandable. In addition, some function's code is to be optimized to ensure that it follows DRY principle. Tests must be written for the functions which are modified. Also, comments must be added to all functions of the file. The create_report_table_header function contains HTML code which should be ideally placed in the view as partials, which will allow to easily reuse the code in Rails application.

==Implementation==

===Flowchart===

The following process is carried out to complete the project-

[[File:Steps for project.png]]

===Refactoring===

====Refactoring method names====
All the method names that are refactored are mentioned below-

'''Before:'''

get_each_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_each_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_certain_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_certain_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_team_name_color_in_review_report

'''After:'''

get_team_colour ''[The method suggests that team color is defined in the review report, so we do not need to put in_review_report in the method name]''

'''Before:'''

get_each_round_score_awarded_for_review_report

'''After:'''

get_awarded_review_score ''[The method gets the awarded score for review, so we do not need to put for_review_report in the method name]''

'''Before:'''

get_min_max_avg_value_for_review_report

'''After:'''

get_review_metrics ''[Since minimum, maximum and average value is the part of metrics in review report, we can replace it all by metrics]''

====Refactoring method====

The following method was not used or called in any of the files in the project. Due to that reason, the entire function was commented out.

<pre>
def get_current_round(reviewer_id)
user_id = Participant.find(reviewer_id).user.id
topic_id = SignedUpTeam.topic_id(@assignment.id, user_id)
@assignment.number_of_current_round(topic_id)
@assignment.num_review_rounds if @assignment.get_current_stage(topic_id) == "Finished" || @assignment.get_current_stage(topic_id) == "metareview"
end
</pre>

===Comments added to various functions===
There were several methods which didn't have any comments or the comments weren't meaningful. In all those cases, comments have been added or changed which are mentioned as follows:

<pre>
# gets the review score awarded based on each round of the review
def get_each_round_score_awarded_for_review_report(reviewer_id, team_id)
</pre>

<pre>
# gets minimum, maximum and average value for all the reviews
def get_min_max_avg_value_for_review_report(round, team_id)
</pre>

<pre>
# sorts the reviewers by the average volume of reviews in each round, in descending order
def sort_reviewer_by_review_volume_desc
</pre>

<pre>
# displays all the average scores in round 1, 2 and 3
def display_volume_metric(overall_avg_vol, avg_vol_in_round_1, avg_vol_in_round_2, avg_vol_in_round_3)
</pre>

<pre>
# moves data of reviews in each round from a current round
def initialize_chart_elements(reviewer)
</pre>

<pre>
# The data of all the reviews is displayed in the form of a bar chart
def display_volume_metric_chart(reviewer)
</pre>

<pre>
# For assignments with 1 team member, the following method returns user's fullname else it returns "team name" that a particular reviewee belongs to.
def get_team_reviewed_link_name(max_team_size, response, reviewee_id)
</pre>

<pre>
# if the current stage is "submission" or "review", function returns the current round number otherwise
# if the current stage is "Finished" or "metareview", function returns the number of rounds of review completed
def get_current_round_for_review_report(reviewer_id)
</pre>

<pre>
# gets the response map data such as reviewer id, reviewd object id and type for the review report
def get_data_for_review_report(reviewed_object_id, reviewer_id, type)
</pre>

<pre>
# gets the team name's color according to review and assignment submission status
def get_team_name_color_in_review_report(response_map)
</pre>

<pre>
# checks if a review was submitted in every round and gives the total responses count
def response_for_each_round?(response_map)
</pre>

<pre>
# returns hyperlink of the assignment that has been submitted on the due date
def submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
</pre>

===Function placed in the view as partials===

The following method has been removed from the '''review_mapping_helper.rb''' and added to the views as partials:

<pre>
def create_report_table_header(headers = {})
table_header = "<div class = 'reviewreport'>\
<table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'>\
<tr bgcolor='#CCCCCC'>"
headers.each do |header, percentage|
table_header += if percentage
"<th width = #{percentage}>\
#{header.humanize}\
</th>"
else
"<th>\
#{header.humanize}\
</th>"
end
end
table_header += "</tr>"
table_header.html_safe
end
</pre>

The following is the code available in views in the file '''_report_table_header.html.erb''':

<pre>
<% table_header = "<div class = 'reviewreport'><table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'><tr bgcolor='#CCCCCC'>" %>
<% headers.each do |header, percentage| %>
<% table_header += if percentage %>
<% "<th width = #{percentage}> #{header.humanize} </th>" %>
<% else %>
<%"<th> #{header.humanize} </th>" %>
<% end %>
<% end %>
<% table_header += "</tr>"%>
<% return table_header.html_safe %>
</pre>

==Testing==

===Manual Testing===

''To be carried out''

===RSpec Testing===

RSpec testing was carried out for the methods that had been refactored. Given below are the tests which are written for the functions that are modified:

<pre>
describe 'My Test Cases' do
before(:each) do
create(:instructor)
create(:role_of_student)
login_as("instructor6")
visit '/tree_display/list'
click_link 'View reports'
expect(page).to have_current_path('/reports/response_report')
click_link 'View'
end

it "can display review metrics", js: true do
expect(page).to have_content('Metrics')
end

it "can display review grades of each round", js: true do
expect(page).to have_content('Score awarded')
end

it "can display review summary", js: true do
expect(page).to have_content('Reviews done')
end

it "can display review summary", js: true do
expect(page).to have_content('Reviewer')
end

it "can display review summary", js: true do
expect(page).to have_content('Team reviewed')
end
end
</pre>

==Design Pattern==

A design pattern is a general repeatable solution to a commonly occurring problem in software design. It is a description or template for how to solve a problem that can be used in many different situations.

During the process of refactoring methods as well as method names,'''Strategy Pattern''' was used in the implementation. The Strategy pattern is most useful when you want to provide multiple ways of processing a request, without hard-coding knowledge about those different methods into the object that handles the request.

==References==

1) https://www.rubyguides.com/2015/12/ruby-refactoring/

2) http://rspec.info/documentation/3.8/rspec-core/

3) http://wiki.expertiza.ncsu.edu/index.php/Main_Page

==Team Members==

Ashish Kumar Jayantilal Jain

Aishwarya Tirumala

Devang Upadhyay

CSC/ECE 517 Spring 2019

2019-04-01T19:39:13Z

Drupadhy:

*[[CSC/ECE 517 Spring 2019 - Project E1905. Refactor questionnaires_controller.rb]]
*[[CSC/ECE 517 Spring 2019 - Project E1916. Fix Code Climate issues in controllers with names beginning with A through N]]
*[[CSC/ECE 517 Spring 2019 - Project E1906. Refactor stage deadlines in Assignment.rb]]
*[[CSC/ECE 517 Spring 2019 - Project M1901 Implement missing WebAudio automation support]]
*[[CSC/ECE 517 Spring 2019 - Project E1917. Fix Code Climate issues in controllers with names beginning with P through Z]]
*[[CSC/ECE 517 Spring 2019 - Project E1921. Write tests for popup controller.rb]]
*[[CSC/ECE 517 Spring 2019 - M1902 Refactor bluetooth support for better maintainability]]
*[[CSC/ECE 517 Spring 2019 - E1922. Write tests for assessment360 controller.rb]]
*[[CSC/ECE 517 Spring 2019 - Project E1907 Refactor response controller]]
*[[CSC/ECE_517_Spring_2019_-_Project_E1903._Create_quiz_questionnaires_controller.rb]]
*[[CSC/ECE_517_Spring_2019_-_Project_E1913. Refactor_review_mapping_helper.rb]]

E1913 refactor review mapping helper

2019-03-31T22:55:01Z

Drupadhy: /* RSpec Testing */

==Introduction==
This page gives a description of the changes made for the ''review_mapping_helper.rb'' of Expertiza based OSS project.

===Expertiza Background ===
Expertiza is a web application where students can submit and peer-review learning objects (articles, codes, websites, etc). Instructors add and grade the assignments submitted by students to Expertiza. Students can be assigned in teams based on their selection of the topics. It has functionalities such as peer reviews in which students can provide feedback on other's work which helps peer in better developing the project. It is supported by the National Science Foundation.

=== Problem Statement ===

The review_mapping_helper.rb has multiple functions with a wrong naming convention, they are classic examples of bad function names. These functions are to be refactored accordingly. Few of the variables names used in the method must also be refactored to make it more relevant and understandable. In addition, some function's code is to be optimized to ensure that it follows DRY principle. Tests must be written for the functions which are modified. Also, comments must be added to all functions of the file. The create_report_table_header function contains HTML code which should be ideally placed in the view as partials, which will allow to easily reuse the code in Rails application.

==Implementation==

===Flowchart===

The following process is carried out to complete the project-

[[File:Steps for project.png]]

===Refactoring===

====Refactoring method names====
All the method names that are refactored are mentioned below-

'''Before:'''

get_each_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_each_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_certain_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_certain_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_team_name_color_in_review_report

'''After:'''

get_team_colour ''[The method suggests that team color is defined in the review report, so we do not need to put in_review_report in the method name]''

'''Before:'''

get_each_round_score_awarded_for_review_report

'''After:'''

get_awarded_review_score ''[The method gets the awarded score for review, so we do not need to put for_review_report in the method name]''

'''Before:'''

get_min_max_avg_value_for_review_report

'''After:'''

get_review_metrics ''[Since minimum, maximum and average value is the part of metrics in review report, we can replace it all by metrics]''

====Refactoring method====

The following method was not used or called in any of the files in the project. Due to that reason, the entire function was commented out.

<pre>
def get_current_round(reviewer_id)
user_id = Participant.find(reviewer_id).user.id
topic_id = SignedUpTeam.topic_id(@assignment.id, user_id)
@assignment.number_of_current_round(topic_id)
@assignment.num_review_rounds if @assignment.get_current_stage(topic_id) == "Finished" || @assignment.get_current_stage(topic_id) == "metareview"
end
</pre>

===Comments added to various functions===
There were several methods which didn't have any comments or the comments weren't meaningful. In all those cases, comments have been added or changed which are mentioned as follows:

<pre>
# gets the review score awarded based on each round of the review
def get_each_round_score_awarded_for_review_report(reviewer_id, team_id)
</pre>

<pre>
# gets minimum, maximum and average value for all the reviews
def get_min_max_avg_value_for_review_report(round, team_id)
</pre>

<pre>
# sorts the reviewers by the average volume of reviews in each round, in descending order
def sort_reviewer_by_review_volume_desc
</pre>

<pre>
# displays all the average scores in round 1, 2 and 3
def display_volume_metric(overall_avg_vol, avg_vol_in_round_1, avg_vol_in_round_2, avg_vol_in_round_3)
</pre>

<pre>
# moves data of reviews in each round from a current round
def initialize_chart_elements(reviewer)
</pre>

<pre>
# The data of all the reviews is displayed in the form of a bar chart
def display_volume_metric_chart(reviewer)
</pre>

<pre>
# For assignments with 1 team member, the following method returns user's fullname else it returns "team name" that a particular reviewee belongs to.
def get_team_reviewed_link_name(max_team_size, response, reviewee_id)
</pre>

<pre>
# if the current stage is "submission" or "review", function returns the current round number otherwise
# if the current stage is "Finished" or "metareview", function returns the number of rounds of review completed
def get_current_round_for_review_report(reviewer_id)
</pre>

<pre>
# gets the response map data such as reviewer id, reviewd object id and type for the review report
def get_data_for_review_report(reviewed_object_id, reviewer_id, type)
</pre>

<pre>
# gets the team name's color according to review and assignment submission status
def get_team_name_color_in_review_report(response_map)
</pre>

<pre>
# checks if a review was submitted in every round and gives the total responses count
def response_for_each_round?(response_map)
</pre>

<pre>
# returns hyperlink of the assignment that has been submitted on the due date
def submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
</pre>

===Function placed in the view as partials===

The following method has been removed from the '''review_mapping_helper.rb''' and added to the views as partials:

<pre>
def create_report_table_header(headers = {})
table_header = "<div class = 'reviewreport'>\
<table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'>\
<tr bgcolor='#CCCCCC'>"
headers.each do |header, percentage|
table_header += if percentage
"<th width = #{percentage}>\
#{header.humanize}\
</th>"
else
"<th>\
#{header.humanize}\
</th>"
end
end
table_header += "</tr>"
table_header.html_safe
end
</pre>

The following is the code available in views in the file '''_report_table_header.html.erb''':

<pre>
<% table_header = "<div class = 'reviewreport'><table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'><tr bgcolor='#CCCCCC'>" %>
<% headers.each do |header, percentage| %>
<% table_header += if percentage %>
<% "<th width = #{percentage}> #{header.humanize} </th>" %>
<% else %>
<%"<th> #{header.humanize} </th>" %>
<% end %>
<% end %>
<% table_header += "</tr>"%>
<% return table_header.html_safe %>
</pre>

==Testing==

===Manual Testing===

''To be carried out''

===RSpec Testing===

RSpec testing was carried out for the methods that had been refactored. Given below are the tests which are written for the functions that are modified:

<pre>
describe 'My Test Cases' do
before(:each) do
create(:instructor)
create(:role_of_student)
login_as("instructor6")
visit '/tree_display/list'
click_link 'View reports'
expect(page).to have_current_path('/reports/response_report')
click_link 'View'
end

it "can display review metrics", js: true do
expect(page).to have_content('Metrics')
end

it "can display review grades of each round", js: true do
expect(page).to have_content('Score awarded')
end

it "can display review summary", js: true do
expect(page).to have_content('Reviews done')
end

it "can display review summary", js: true do
expect(page).to have_content('Reviewer')
end

it "can display review summary", js: true do
expect(page).to have_content('Team reviewed')
end
end
</pre>

==Design Pattern==

A design pattern is a general repeatable solution to a commonly occurring problem in software design. It is a description or template for how to solve a problem that can be used in many different situations.

During the process of refactoring methods as well as method names,'''Strategy Pattern''' was used in the implementation. The Strategy pattern is most useful when you want to provide multiple ways of processing a request, without hard-coding knowledge about those different methods into the object that handles the request.

==References==

1) https://www.rubyguides.com/2015/12/ruby-refactoring/

2) http://rspec.info/documentation/3.8/rspec-core/

3) http://wiki.expertiza.ncsu.edu/index.php/Main_Page

==Team Members==

Ashish Kumar Jayantilal Jain

Aishwarya Tirumala

Devang Upadhyay

E1913 refactor review mapping helper

2019-03-31T20:33:36Z

Drupadhy: /* Refactoring method */

==Introduction==
This page gives a description of the changes made for the ''review_mapping_helper.rb'' of Expertiza based OSS project.

===Expertiza Background ===
Expertiza is a web application where students can submit and peer-review learning objects (articles, codes, websites, etc). Instructors add and grade the assignments submitted by students to Expertiza. Students can be assigned in teams based on their selection of the topics. It has functionalities such as peer reviews in which students can provide feedback on other's work which helps peer in better developing the project. It is supported by the National Science Foundation.

=== Problem Statement ===

The review_mapping_helper.rb has multiple functions with a wrong naming convention, they are classic examples of bad function names. These functions are to be refactored accordingly. Few of the variables names used in the method must also be refactored to make it more relevant and understandable. In addition, some function's code is to be optimized to ensure that it follows DRY principle. Tests must be written for the functions which are modified. Also, comments must be added to all functions of the file. The create_report_table_header function contains HTML code which should be ideally placed in the view as partials, which will allow to easily reuse the code in Rails application.

==Implementation==

===Flowchart===

The following process is carried out to complete the project-

[[File:Steps for project.png]]

===Refactoring===

====Refactoring method names====
All the method names that are refactored are mentioned below-

'''Before:'''

get_each_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_each_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_certain_round_review_and_feedback_response_map_for_feedback_report

'''After:'''

get_certain_review_and_feedback_response_map ''[Since the method and file is already about feedback report, we do not need to put feedback_report in the method name]''

'''Before:'''

get_team_name_color_in_review_report

'''After:'''

get_team_colour ''[The method suggests that team color is defined in the review report, so we do not need to put in_review_report in the method name]''

'''Before:'''

get_each_round_score_awarded_for_review_report

'''After:'''

get_awarded_review_score ''[The method gets the awarded score for review, so we do not need to put for_review_report in the method name]''

'''Before:'''

get_min_max_avg_value_for_review_report

'''After:'''

get_review_metrics ''[Since minimum, maximum and average value is the part of metrics in review report, we can replace it all by metrics]''

====Refactoring method====

The following method was not used or called in any of the files in the project. Due to that reason, the entire function was commented out.

<pre>
def get_current_round(reviewer_id)
user_id = Participant.find(reviewer_id).user.id
topic_id = SignedUpTeam.topic_id(@assignment.id, user_id)
@assignment.number_of_current_round(topic_id)
@assignment.num_review_rounds if @assignment.get_current_stage(topic_id) == "Finished" || @assignment.get_current_stage(topic_id) == "metareview"
end
</pre>

===Comments added to various functions===
There were several methods which didn't have any comments or the comments weren't meaningful. In all those cases, comments have been added or changed which are mentioned as follows:

<pre>
# gets the review score awarded based on each round of the review
def get_each_round_score_awarded_for_review_report(reviewer_id, team_id)
</pre>

<pre>
# gets minimum, maximum and average value for all the reviews
def get_min_max_avg_value_for_review_report(round, team_id)
</pre>

<pre>
# sorts the reviewers by the average volume of reviews in each round, in descending order
def sort_reviewer_by_review_volume_desc
</pre>

<pre>
# displays all the average scores in round 1, 2 and 3
def display_volume_metric(overall_avg_vol, avg_vol_in_round_1, avg_vol_in_round_2, avg_vol_in_round_3)
</pre>

<pre>
# moves data of reviews in each round from a current round
def initialize_chart_elements(reviewer)
</pre>

<pre>
# The data of all the reviews is displayed in the form of a bar chart
def display_volume_metric_chart(reviewer)
</pre>

<pre>
# For assignments with 1 team member, the following method returns user's fullname else it returns "team name" that a particular reviewee belongs to.
def get_team_reviewed_link_name(max_team_size, response, reviewee_id)
</pre>

<pre>
# if the current stage is "submission" or "review", function returns the current round number otherwise
# if the current stage is "Finished" or "metareview", function returns the number of rounds of review completed
def get_current_round_for_review_report(reviewer_id)
</pre>

<pre>
# gets the response map data such as reviewer id, reviewd object id and type for the review report
def get_data_for_review_report(reviewed_object_id, reviewer_id, type)
</pre>

<pre>
# gets the team name's color according to review and assignment submission status
def get_team_name_color_in_review_report(response_map)
</pre>

<pre>
# checks if a review was submitted in every round and gives the total responses count
def response_for_each_round?(response_map)
</pre>

<pre>
# returns hyperlink of the assignment that has been submitted on the due date
def submitted_hyperlink(round, response_map, assignment_created, assignment_due_dates)
</pre>

===Function placed in the view as partials===

The following method has been removed from the '''review_mapping_helper.rb''' and added to the views as partials:

<pre>
def create_report_table_header(headers = {})
table_header = "<div class = 'reviewreport'>\
<table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'>\
<tr bgcolor='#CCCCCC'>"
headers.each do |header, percentage|
table_header += if percentage
"<th width = #{percentage}>\
#{header.humanize}\
</th>"
else
"<th>\
#{header.humanize}\
</th>"
end
end
table_header += "</tr>"
table_header.html_safe
end
</pre>

The following is the code available in views in the file '''_report_table_header.html.erb''':

<pre>
<% table_header = "<div class = 'reviewreport'><table width='100% cellspacing='0' cellpadding='2' border='0' class='table table-striped'><tr bgcolor='#CCCCCC'>" %>
<% headers.each do |header, percentage| %>
<% table_header += if percentage %>
<% "<th width = #{percentage}> #{header.humanize} </th>" %>
<% else %>
<%"<th> #{header.humanize} </th>" %>
<% end %>
<% end %>
<% table_header += "</tr>"%>
<% return table_header.html_safe %>
</pre>

==Testing==

===Manual Testing===

''To be carried out''

===RSpec Testing===

RSpec testing was carried out for the methods that had been refactored. Given below are the tests which are written for the functions that are modified:

<pre>
require 'rspec'

describe 'My Test Cases' do

it "can display review metrics", js: true do
create(:instructor)
create(:role_of_student)
login_as 'instructor6'
visit '/tree_display/list'
click_link 'View reports'
expect(page).to have_current_path('/reports/response_report')
click_link 'View'
expect(page).to have_content('Metrics')
end

it "can display review grades of each round", js: true do
create(:instructor)
create(:role_of_student)
login_as 'instructor6'
visit '/tree_display/list'
click_link 'View reports'
expect(page).to have_current_path('/reports/response_report')
click_link 'View'
expect(page).to have_content('Score awarded')
end

it "can display review summary", js: true do
create(:instructor)
create(:role_of_student)
login_as 'instructor6'
visit '/tree_display/list'
click_link 'View reports'
expect(page).to have_current_path('/reports/response_report')
click_link 'View'
expect(page).to have_content('Reviews done')
end

end
</pre>

==Design Pattern==

A design pattern is a general repeatable solution to a commonly occurring problem in software design. It is a description or template for how to solve a problem that can be used in many different situations.

During the process of refactoring methods as well as method names,'''Strategy Pattern''' was used in the implementation. The Strategy pattern is most useful when you want to provide multiple ways of processing a request, without hard-coding knowledge about those different methods into the object that handles the request.

==References==

1) https://www.rubyguides.com/2015/12/ruby-refactoring/

2) http://rspec.info/documentation/3.8/rspec-core/

3) http://wiki.expertiza.ncsu.edu/index.php/Main_Page

==Team Members==

Ashish Kumar Jayantilal Jain

Aishwarya Tirumala

Devang Upadhyay