Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-12-18T00:23:41Z

Nnparik2: /* Test from UI */

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-12-17T17:34:42Z

Nnparik2: /* Test from UI */

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-12-07T04:07:48Z

Nnparik2: /* Issue 3 */

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-12-07T04:02:49Z

Nnparik2: /* Issue 2 */

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-12-07T03:45:26Z

Nnparik2: /* Issue 1 */

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-12-07T03:44:39Z

Nnparik2: /* Issue 1 */

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-12-07T01:17:58Z

Nnparik2: /* Test Plan */

<font size="2">
This wiki page describes the changes made according to the specification of E1980 OSS final project for Fall 2019.
----
== ''' Introduction ''' ==
* In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide feedback for this review, called “author feedback.” While grading peer reviews, it would be nice for the instructors to include the author feedback, since it shows how helpful the peer review actually was to the author of the project.

== ''' Problem Statement ''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, the average should be made sortable by using the same existing sort library.

== UML ==

<div class="center" style="width: auto;font-size:135%; margin-left: auto; margin-right: auto;">'''Workflow'''</div>

[[File:UML1.png]]

== Issue 1 ==
=== Problem ===
We have to sort “Review done”, “Team reviewed”, “Score awarded/Avg score”. in the “view review report” table. The sort button should work on all browsers, not only chrome.

[[File:Issue1980.PNG]]

===Solution:===
We will be using tablesorter function of jQuery to sort the table.To sort the columns that have constraints, custom scripts will be created. Tablesorter supports custom sorting. According to the problem type, we are supposed to perform three kinds of sorting. We need to make changes in the table head tag. By default the sorting is disabled on the columns, we must enable sorting on those columns in order to make it sortable. Three types of scenarios may arise:

1. Sorting by columns alphabetically - To sort the columns alphabetically, the table-head attribute must include sorter-true class with it.

2. Sorting by date - Sorting by date includes creating a generic format for all dates(mmddyyyy). This generic format will be used to parse dates and sorting will be done based on this format.

3. Sorting by the first number followed by the second number - It will require splitting up of the data into two parts separated by '/' and then sorting the first part, followed by the second part.

== Issue 2 ==
=== Problem ===
For “Author feedback report” table, we have to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date.

===Solution:===
We will use tablesorter function of jQuery to sort the table. To sort the columns that have constraints, custom parser will be created and used on top of tablesorter. The approach is similar to the first issue.

[[File:OldAuthorfeedbackformat.PNG]]

== Issue 3 ==
=== Problem ===
For “Teammate review report” table,we have to sort "Reviewer" and "Teammate reviewed" as string(alphabetically) , sort “"# teammate review done"” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last reviewed at” as date.

===Solution:===
We will use tablesorter function of jQuery to sort the table. To sort the columns that have constraints, custom parser will be created and used on top of tablesorter. The approach is similar to the first issue.

[[File:OldTeammatereviewsort.PNG]]

== Issue 4 ==
=== Problem ===
When the user clicks on the “View reports” icon, a page appears with a dropdown. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top.

===Solution:===
We will add header on top of Dropdown menu. For this we already have assignment name in the _searchbox.html.erb partial. We will use that above the search box to display the name of assignment.

[[File:Issue3ass.PNG]]

== Issue 5 ==

=== Problem ===
For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback.

[[File:Issuehorizontal.png]]

===Solution:===
In file _feedback_report.html.erb
The main issue behind the unusual horizontal format of all rows (student ID) is due to the value of rowspan=0 when there are no reviews.
This causes all new potential rows being viewed on same single row.
So to solve this issue, we will change @rspan variable value in review_mapping_helper.rb. We will add a condition to check the value of @rspan. If @rspan is 0, we will change it to 1. This will make one entry of student per row in the table.

<div class="center" style="width: auto;font-size:135%; margin-left: auto; margin-right: auto;">[[File:ISSUE3FLOW.png]]</div>

== Modification of Files ==
* app/assets/stylesheets/table_sorter.scss (issue 1) <br>
* app/controllers/tree_display_controller.rb (issue 1) <br>
* app/helpers/review_mapping_helper.rb (issue 5) <br>
* app/views/reports/_feedback_report.html.erb (issue 2) <br>
* app/views/reports/_review_report.html.erb (issue 1) <br>
* app/views/reports/_searchbox.html.erb (issue 4) <br>
* app/views/reports/_teammate_review_report.html.erb (issue 3) <br>
* spec/features/review_mapping_helper_spec.rb (issue 5) <br>

=='''Solutions Implemented'''==
=== Issue 1 ===
We have modified the app/views/reports/_review_report.html.erb by adding the tablesorter class in the table tag. Then with the table head, we added suitable classes and added scripts at the top of the file to sort the table contents within the file.
Added the following script to the file.

[[File:ReviewReport.PNG]]

Then we changed the style of the table to the given requirement.

[[File:Reviewreporthtml.PNG]]

Then we also changed the structure of the table to fit the tablesorter class.
<pre>
<th width="16%" class="sorter-true">Reviewer<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="10%" class="sorter-true">Reviews done<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="24%" class="sorter-true">Team reviewed<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="13%" class="sorter-true">Score awarded / Avg. score<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="13%" class="sorter-true">Metrics<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-false">Assign grade and write comments <span></span></th>
</pre>

[[File:Issue1980_1_solution.PNG]]

=== Issue 2 ===
We have modified the app/views/reports/_feedback_report.html.erb by adding the tablesorter class in the table tag. Then with the table head, we added suitable classes and added scripts at the top of the file to sort the table contents within the file. We had to add custom parsers for date based sorting and we had to implement visibility functionality for proper rendition of table after the complete sorting.
Added the following script to the file.
<pre>
<script>
$(function () {
/*E: 1980Function for sorting the table */
$("#feedbacktable").tablesorter({
dateFormat : "mmddyyyy", //E1980: set the default date format
sortList: [[0,0]] // E1980: sort First Column by default when page loads
});
});
function changeVisibilityToVisible() {
$('.changeVisibility').css({"visibility": "visible"});
}
function changeVisibilityToCollapse() {
$('.changeVisibility').css({"visibility": "collapse"});
}
</script>
<style>
.changeVisibility{
visibility: collapse;
}
</style>
</pre>

Also we had to change the structure of the table .
<pre>
<table id= "feedbacktable" cellspacing='0' cellpadding='2' border=0 class="table table-striped">
<thead>

<tr bgcolor='#CCCCCC'>
<th class="sorter-true" onclick="changeVisibilityToCollapse()">Rejoinder<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()"># author feedbacks done<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Review responded to<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Last responded at<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
</tr>
</thead>
</pre>

Also we needed to include the round count, total reviews and total iterations to completely sort the given columns. We also removed extra <tr> and <td> tags.
<pre>
<% @roundCount = instance_variable_get("@rspan_round_#{round}") %>
<% @totalreviews = @roundCount #ISSUE1980%>
<% @totalIteration=0 ## ISSSUE-1980%>
</pre>
This was a more complex implementation as we also had to consider the round in which the review was given. Also we were facing troubles for edge cases where in the data was absent for multiple columns in which sorting was implemented but due to the absence of the data the sort function would throw error. To handle such issues we included reviewer name and teammate reviews done for each and every response by that reviewer.
<pre>
<%if @totalIteration < @totalreviews-1 %>
</tr>
<tr>
<td class = changeVisibility>
<%= link_to @reviewer_name, :controller => 'popup', :action => 'reviewer_details_popup', :id => r.id, :assignment_id => @id %>
</td>

<td bgcolor=<%= @bgcolor %> align="left">
<%= @count_certain_round %>/<%= @rspan_certain_round %></td>
<% @totalIteration=@totalIteration+1 %>
<%else%>
</tr>
<%end%>
<%end%>
</pre>

[[File:Issue1980_2_solution.PNG]]

=== Issue 3 ===
We have modified the app/views/reports/_teammate_review_report.html.erb by adding the tablesorter class in the table tag. Then with the table head, we added suitable classes and added scripts at the top of the file to sort the table contents within the file.This was much harder to implement because of some issues and the code was highly unstructured. Also, the JavaScript was not proper in terms of usability and there were some elements which were not working properly as the code was static. We had to add custom parsers for date based sorting and we had to implement visibility functionality for proper rendition of table after the complete sorting.
Added the following script to the file.The script contained style elements as well to render the table after sorting.
<pre>
<script>
$.tablesorter.addParser({
id: "eudate",
is: function (s) {
return false;
},
format: function (s, table) {
s = s.replace(/\-/g, "/");
s = s.replace(/(\d{1,2})[\/\.](\d{1,2})[\/\.](\d{4})/, "$3/$1/$2");
s = s.split(" ")[0];
$('#test').html(s);
return $.tablesorter.formatFloat(new Date(s).getTime());
},
type: "numeric"
});
$(function () {
/*E: 1980Function for sorting the table */
$("#teammateReviewTable").tablesorter({
dateFormat: "mmddyyyy", //E1980: set the default date format
dateFormat: "mm/dd/yyyy", //E1980: set the default date format
headers: {
3: {sorter: 'eudate'}
},
sortList: [[0, 0]] // E1980: sort First Column by default when page loads
});
});
function changeVisibilityToVisible() {
$('.changeVisibility').css({"visibility": "visible"});
}
function changeVisibilityToCollapse() {
$('.changeVisibility').css({"visibility": "collapse"});
}
</script>
<style>
.changeVisibility{
visibility: collapse;
}
</style>
</pre>
After this the table structure was also changed based on requirements of tablesorter class.
<pre>
<thead>

<tr bgcolor='#CCCCCC'>
<th class="sorter-true" onclick="changeVisibilityToCollapse()">Reviewer<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToCollapse()"># teammate reviews done<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Teammate reviewed<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Last reviewed at<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
</tr>
</thead>
</pre>
Here we faced multiple issue with rendering because of responses received so we implemented a responsecount to keep a track of the number of responses and render the sorted table keeping that in mind. we also removed unnecessary <tr> tags and rowspan and colspan elements.

[[File:Issue1980_3_solution.PNG]]

=== Issue 4 ===
We added a header on top of Dropdown menu. For this we already had assignment name in the _searchbox.html.erb partial. We used that above the search box to display the name of assignment.
<pre>
<h1>Report for <%=@assignment.name %></h1>
</pre>

[[File:Issue1980_4_solution.PNG]]

=== Issue 5 ===
We changed in app/helpers/review_mapping_helper.rb for this issue firstly we found out the cases for which rspan was coming to be 0 and then changed the rspan value to 1.
<pre>
def get_certain_round_review_and_feedback_response_map_for_feedback_report(author)
@feedback_response_maps = FeedbackResponseMap.where(["reviewed_object_id IN (?) and reviewer_id = ?", @all_review_response_ids, author.id])
@team_id = TeamsUser.team_id(@id.to_i, author.user_id)
@review_response_map_ids = ReviewResponseMap.where(["reviewed_object_id = ? and reviewee_id = ?", @id, @team_id]).pluck("id")
@review_responses = Response.where(["map_id IN (?)", @review_response_map_ids])
@rspan = @review_responses.length
if @rspan == 0
@rspan = 1
end
</pre>

[[File:Issue1980_5_solution.PNG]]

== Test Plan ==

=== Test from UI ===
'''For issue 1'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Select Review Report from Drop-down menu.

5. Sort the columns by Clicking on it.

'''For issue 2'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Select Author Feedback report from Drop-down menu.

5. Sort the columns by Clicking on it.

'''For issue 3'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Select teammate review report from Drop-down menu.

5. Sort the columns by Clicking on it.

'''For issue 4'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Name of assignment should be displayed above the drop-down menu.

'''For issue 5'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. From drop-down menu select Author Feedback Report.

5. Students will be displayed in proper format.

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-12-07T00:55:48Z

Nnparik2: /* Solution: */

<font size="2">
This wiki page describes the changes made according to the specification of E1980 OSS final project for Fall 2019.
----
== ''' Introduction ''' ==
* In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide feedback for this review, called “author feedback.” While grading peer reviews, it would be nice for the instructors to include the author feedback, since it shows how helpful the peer review actually was to the author of the project.

== ''' Problem Statement ''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, the average should be made sortable by using the same existing sort library.

== UML ==

<div class="center" style="width: auto;font-size:135%; margin-left: auto; margin-right: auto;">'''Workflow'''</div>

[[File:UML1.png]]

== Issue 1 ==
=== Problem ===
We have to sort “Review done”, “Team reviewed”, “Score awarded/Avg score”. in the “view review report” table. The sort button should work on all browsers, not only chrome.

[[File:Issue1980.PNG]]

===Solution:===
We will be using tablesorter function of jQuery to sort the table.To sort the columns that have constraints, custom scripts will be created. Tablesorter supports custom sorting. According to the problem type, we are supposed to perform three kinds of sorting. We need to make changes in the table head tag. By default the sorting is disabled on the columns, we must enable sorting on those columns in order to make it sortable. Three types of scenarios may arise:

1. Sorting by columns alphabetically - To sort the columns alphabetically, the table-head attribute must include sorter-true class with it.

2. Sorting by date - Sorting by date includes creating a generic format for all dates(mmddyyyy). This generic format will be used to parse dates and sorting will be done based on this format.

3. Sorting by the first number followed by the second number - It will require splitting up of the data into two parts separated by '/' and then sorting the first part, followed by the second part.

== Issue 2 ==
=== Problem ===
For “Author feedback report” table, we have to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date.

===Solution:===
We will use tablesorter function of jQuery to sort the table. To sort the columns that have constraints, custom parser will be created and used on top of tablesorter. The approach is similar to the first issue.

[[File:OldAuthorfeedbackformat.PNG]]

== Issue 3 ==
=== Problem ===
For “Teammate review report” table,we have to sort "Reviewer" and "Teammate reviewed" as string(alphabetically) , sort “"# teammate review done"” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last reviewed at” as date.

===Solution:===
We will use tablesorter function of jQuery to sort the table. To sort the columns that have constraints, custom parser will be created and used on top of tablesorter. The approach is similar to the first issue.

[[File:OldTeammatereviewsort.PNG]]

== Issue 4 ==
=== Problem ===
When the user clicks on the “View reports” icon, a page appears with a dropdown. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top.

===Solution:===
We will add header on top of Dropdown menu. For this we already have assignment name in the _searchbox.html.erb partial. We will use that above the search box to display the name of assignment.

[[File:Issue3ass.PNG]]

== Issue 5 ==

=== Problem ===
For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback.

[[File:Issuehorizontal.png]]

===Solution:===
In file _feedback_report.html.erb
The main issue behind the unusual horizontal format of all rows (student ID) is due to the value of rowspan=0 when there are no reviews.
This causes all new potential rows being viewed on same single row.
So to solve this issue, we will change @rspan variable value in review_mapping_helper.rb. We will add a condition to check the value of @rspan. If @rspan is 0, we will change it to 1. This will make one entry of student per row in the table.

<div class="center" style="width: auto;font-size:135%; margin-left: auto; margin-right: auto;">[[File:ISSUE3FLOW.png]]</div>

== Modification of Files ==
* app/assets/stylesheets/table_sorter.scss (issue 1) <br>
* app/controllers/tree_display_controller.rb (issue 1) <br>
* app/helpers/review_mapping_helper.rb (issue 5) <br>
* app/views/reports/_feedback_report.html.erb (issue 2) <br>
* app/views/reports/_review_report.html.erb (issue 1) <br>
* app/views/reports/_searchbox.html.erb (issue 4) <br>
* app/views/reports/_teammate_review_report.html.erb (issue 3) <br>
* spec/features/review_mapping_helper_spec.rb (issue 5) <br>

=='''Solutions Implemented'''==
=== Issue 1 ===
We have modified the app/views/reports/_review_report.html.erb by adding the tablesorter class in the table tag. Then with the table head, we added suitable classes and added scripts at the top of the file to sort the table contents within the file.
Added the following script to the file.
<pre>
$(function () {
/*Function for sorting the table */
$("#reviewReport").tablesorter({
sortList: [[0, 0]], //sort First Column by default when page loads
widgets: ['zebra'], // Make sure to update the css when column is sorted
headers: {
4: {
sorter: 'customParser' //custom Parser to parse Metrics data for the custom parser
}
}
});
</pre>
Then we changed the style of the table to the given requirement.
<pre>
<style>
table,tr {
border: 1px solid black;
}
th,td{
padding: 0px 2px 0px 2px;
border: 1px black solid;
}
</style>
</pre>
Then we also changed the structure of the table to fit the tablesorter class.
<pre>
<th width="16%" class="sorter-true">Reviewer<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="10%" class="sorter-true">Reviews done<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="24%" class="sorter-true">Team reviewed<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="13%" class="sorter-true">Score awarded / Avg. score<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="13%" class="sorter-true">Metrics<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-false">Assign grade and write comments <span></span></th>
</pre>

[[File:Issue1980_1_solution.PNG]]

=== Issue 2 ===
We have modified the app/views/reports/_feedback_report.html.erb by adding the tablesorter class in the table tag. Then with the table head, we added suitable classes and added scripts at the top of the file to sort the table contents within the file. We had to add custom parsers for date based sorting and we had to implement visibility functionality for proper rendition of table after the complete sorting.
Added the following script to the file.
<pre>
<script>
$(function () {
/*E: 1980Function for sorting the table */
$("#feedbacktable").tablesorter({
dateFormat : "mmddyyyy", //E1980: set the default date format
sortList: [[0,0]] // E1980: sort First Column by default when page loads
});
});
function changeVisibilityToVisible() {
$('.changeVisibility').css({"visibility": "visible"});
}
function changeVisibilityToCollapse() {
$('.changeVisibility').css({"visibility": "collapse"});
}
</script>
<style>
.changeVisibility{
visibility: collapse;
}
</style>
</pre>

Also we had to change the structure of the table .
<pre>
<table id= "feedbacktable" cellspacing='0' cellpadding='2' border=0 class="table table-striped">
<thead>

<tr bgcolor='#CCCCCC'>
<th class="sorter-true" onclick="changeVisibilityToCollapse()">Rejoinder<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()"># author feedbacks done<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Review responded to<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Last responded at<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
</tr>
</thead>
</pre>

Also we needed to include the round count, total reviews and total iterations to completely sort the given columns. We also removed extra <tr> and <td> tags.
<pre>
<% @roundCount = instance_variable_get("@rspan_round_#{round}") %>
<% @totalreviews = @roundCount #ISSUE1980%>
<% @totalIteration=0 ## ISSSUE-1980%>
</pre>
This was a more complex implementation as we also had to consider the round in which the review was given. Also we were facing troubles for edge cases where in the data was absent for multiple columns in which sorting was implemented but due to the absence of the data the sort function would throw error. To handle such issues we included reviewer name and teammate reviews done for each and every response by that reviewer.
<pre>
<%if @totalIteration < @totalreviews-1 %>
</tr>
<tr>
<td class = changeVisibility>
<%= link_to @reviewer_name, :controller => 'popup', :action => 'reviewer_details_popup', :id => r.id, :assignment_id => @id %>
</td>

<td bgcolor=<%= @bgcolor %> align="left">
<%= @count_certain_round %>/<%= @rspan_certain_round %></td>
<% @totalIteration=@totalIteration+1 %>
<%else%>
</tr>
<%end%>
<%end%>
</pre>

[[File:Issue1980_2_solution.PNG]]

=== Issue 3 ===
We have modified the app/views/reports/_teammate_review_report.html.erb by adding the tablesorter class in the table tag. Then with the table head, we added suitable classes and added scripts at the top of the file to sort the table contents within the file.This was much harder to implement because of some issues and the code was highly unstructured. Also, the JavaScript was not proper in terms of usability and there were some elements which were not working properly as the code was static. We had to add custom parsers for date based sorting and we had to implement visibility functionality for proper rendition of table after the complete sorting.
Added the following script to the file.The script contained style elements as well to render the table after sorting.
<pre>
<script>
$.tablesorter.addParser({
id: "eudate",
is: function (s) {
return false;
},
format: function (s, table) {
s = s.replace(/\-/g, "/");
s = s.replace(/(\d{1,2})[\/\.](\d{1,2})[\/\.](\d{4})/, "$3/$1/$2");
s = s.split(" ")[0];
$('#test').html(s);
return $.tablesorter.formatFloat(new Date(s).getTime());
},
type: "numeric"
});
$(function () {
/*E: 1980Function for sorting the table */
$("#teammateReviewTable").tablesorter({
dateFormat: "mmddyyyy", //E1980: set the default date format
dateFormat: "mm/dd/yyyy", //E1980: set the default date format
headers: {
3: {sorter: 'eudate'}
},
sortList: [[0, 0]] // E1980: sort First Column by default when page loads
});
});
function changeVisibilityToVisible() {
$('.changeVisibility').css({"visibility": "visible"});
}
function changeVisibilityToCollapse() {
$('.changeVisibility').css({"visibility": "collapse"});
}
</script>
<style>
.changeVisibility{
visibility: collapse;
}
</style>
</pre>
After this the table structure was also changed based on requirements of tablesorter class.
<pre>
<thead>

<tr bgcolor='#CCCCCC'>
<th class="sorter-true" onclick="changeVisibilityToCollapse()">Reviewer<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToCollapse()"># teammate reviews done<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Teammate reviewed<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Last reviewed at<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
</tr>
</thead>
</pre>
Here we faced multiple issue with rendering because of responses received so we implemented a responsecount to keep a track of the number of responses and render the sorted table keeping that in mind. we also removed unnecessary <tr> tags and rowspan and colspan elements.

[[File:Issue1980_3_solution.PNG]]

=== Issue 4 ===
We added a header on top of Dropdown menu. For this we already had assignment name in the _searchbox.html.erb partial. We used that above the search box to display the name of assignment.
<pre>
<h1>Report for <%=@assignment.name %></h1>
</pre>

[[File:Issue1980_4_solution.PNG]]

=== Issue 5 ===
We changed in app/helpers/review_mapping_helper.rb for this issue firstly we found out the cases for which rspan was coming to be 0 and then changed the rspan value to 1.
<pre>
def get_certain_round_review_and_feedback_response_map_for_feedback_report(author)
@feedback_response_maps = FeedbackResponseMap.where(["reviewed_object_id IN (?) and reviewer_id = ?", @all_review_response_ids, author.id])
@team_id = TeamsUser.team_id(@id.to_i, author.user_id)
@review_response_map_ids = ReviewResponseMap.where(["reviewed_object_id = ? and reviewee_id = ?", @id, @team_id]).pluck("id")
@review_responses = Response.where(["map_id IN (?)", @review_response_map_ids])
@rspan = @review_responses.length
if @rspan == 0
@rspan = 1
end
</pre>

[[File:Issue1980_5_solution.PNG]]

== Test Plan ==
'''To make sure the functionality work correctly, we need to run the original Rspec test code and add some new test. Besides, we are plaining to test from UI to make sure all the features work. The test results are shown below.'''

* Run and pass existing RSpec Tests after refactoring
* Develop New RSpec Tests for the new features
* UI testing on the deployed project

=== Test from UI ===
'''For issue 1'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Select Review Report from Drop-down menu.

5. Sort the columns by Clicking on it.

'''For issue 2'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Select Author Feedback report from Drop-down menu.

5. Sort the columns by Clicking on it.

'''For issue 3'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Select teammate review report from Drop-down menu.

5. Sort the columns by Clicking on it.

'''For issue 4'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Name of assignment should be displayed above the drop-down menu.

'''For issue 5'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. From drop-down menu select Author Feedback Report.

5. Students will be displayed in proper format.

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-12-07T00:52:41Z

Nnparik2: /* Solution: */

<font size="2">
This wiki page describes the changes made according to the specification of E1980 OSS final project for Fall 2019.
----
== ''' Introduction ''' ==
* In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide feedback for this review, called “author feedback.” While grading peer reviews, it would be nice for the instructors to include the author feedback, since it shows how helpful the peer review actually was to the author of the project.

== ''' Problem Statement ''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, the average should be made sortable by using the same existing sort library.

== UML ==

<div class="center" style="width: auto;font-size:135%; margin-left: auto; margin-right: auto;">'''Workflow'''</div>

[[File:UML1.png]]

== Issue 1 ==
=== Problem ===
We have to sort “Review done”, “Team reviewed”, “Score awarded/Avg score”. in the “view review report” table. The sort button should work on all browsers, not only chrome.

[[File:Issue1980.PNG]]

===Solution:===
We will be using tablesorter function of jQuery to sort the table.To sort the columns that have constraints, custom scripts will be created. Tablesorter supports custom sorting. According to the problem type, we are supposed to perform three kinds of sorting. We need to make changes in the table head tag. By default the sorting is disabled on the columns, we must enable sorting on those columns in order to make it sortable. Three types of scenarios may arise:

1. Sorting by columns alphabetically - To sort the columns alphabetically, the table-head attribute must include sorter-true class with it.

2. Sorting by date - Sorting by date includes creating a generic format for all dates(mmddyyyy). This generic format will be used to parse dates and sorting will be done based on this format.

3. Sorting by the first number followed by the second number - It will require splitting up of the data into two parts separated by '/' and then sorting the first part, followed by the second part.

== Issue 2 ==
=== Problem ===
For “Author feedback report” table, we have to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date.

===Solution:===
We will use tablesorter function of jQuery to sort the table. To sort the columns that have constraints, custom parser will be created and used on top of tablesorter. The approach is similar to the first issue.

[[File:OldAuthorfeedbackformat.PNG]]

== Issue 3 ==
=== Problem ===
For “Teammate review report” table,we have to sort "Reviewer" and "Teammate reviewed" as string(alphabetically) , sort “"# teammate review done"” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last reviewed at” as date.

===Solution:===
We will be using already implemented function tablesorter of jQuery to sort the table. For table columns which have constraints on them for sorting, we will be creating custom scripts which tablesorter function supports to sort those columns. Similar approach to first and second issue.

[[File:OldTeammatereviewsort.PNG]]

== Issue 4 ==
=== Problem ===
When the user clicks on the “View reports” icon, a page appears with a dropdown. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top.

===Solution:===
We will add header on top of Dropdown menu. For this we already have assignment name in the _searchbox.html.erb partial. We will use that above the search box to display the name of assignment.

[[File:Issue3ass.PNG]]

== Issue 5 ==

=== Problem ===
For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback.

[[File:Issuehorizontal.png]]

===Solution:===
In file _feedback_report.html.erb
The main issue behind the unusual horizontal format of all rows (student ID) is due to the value of rowspan=0 when there are no reviews.
This causes all new potential rows being viewed on same single row.
So to solve this issue, we will change @rspan variable value in review_mapping_helper.rb. We will add a condition to check the value of @rspan. If @rspan is 0, we will change it to 1. This will make one entry of student per row in the table.

<div class="center" style="width: auto;font-size:135%; margin-left: auto; margin-right: auto;">[[File:ISSUE3FLOW.png]]</div>

== Modification of Files ==
* app/assets/stylesheets/table_sorter.scss (issue 1) <br>
* app/controllers/tree_display_controller.rb (issue 1) <br>
* app/helpers/review_mapping_helper.rb (issue 5) <br>
* app/views/reports/_feedback_report.html.erb (issue 2) <br>
* app/views/reports/_review_report.html.erb (issue 1) <br>
* app/views/reports/_searchbox.html.erb (issue 4) <br>
* app/views/reports/_teammate_review_report.html.erb (issue 3) <br>
* spec/features/review_mapping_helper_spec.rb (issue 5) <br>

=='''Solutions Implemented'''==
=== Issue 1 ===
We have modified the app/views/reports/_review_report.html.erb by adding the tablesorter class in the table tag. Then with the table head, we added suitable classes and added scripts at the top of the file to sort the table contents within the file.
Added the following script to the file.
<pre>
$(function () {
/*Function for sorting the table */
$("#reviewReport").tablesorter({
sortList: [[0, 0]], //sort First Column by default when page loads
widgets: ['zebra'], // Make sure to update the css when column is sorted
headers: {
4: {
sorter: 'customParser' //custom Parser to parse Metrics data for the custom parser
}
}
});
</pre>
Then we changed the style of the table to the given requirement.
<pre>
<style>
table,tr {
border: 1px solid black;
}
th,td{
padding: 0px 2px 0px 2px;
border: 1px black solid;
}
</style>
</pre>
Then we also changed the structure of the table to fit the tablesorter class.
<pre>
<th width="16%" class="sorter-true">Reviewer<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="10%" class="sorter-true">Reviews done<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="24%" class="sorter-true">Team reviewed<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="13%" class="sorter-true">Score awarded / Avg. score<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="13%" class="sorter-true">Metrics<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-false">Assign grade and write comments <span></span></th>
</pre>

[[File:Issue1980_1_solution.PNG]]

=== Issue 2 ===
We have modified the app/views/reports/_feedback_report.html.erb by adding the tablesorter class in the table tag. Then with the table head, we added suitable classes and added scripts at the top of the file to sort the table contents within the file. We had to add custom parsers for date based sorting and we had to implement visibility functionality for proper rendition of table after the complete sorting.
Added the following script to the file.
<pre>
<script>
$(function () {
/*E: 1980Function for sorting the table */
$("#feedbacktable").tablesorter({
dateFormat : "mmddyyyy", //E1980: set the default date format
sortList: [[0,0]] // E1980: sort First Column by default when page loads
});
});
function changeVisibilityToVisible() {
$('.changeVisibility').css({"visibility": "visible"});
}
function changeVisibilityToCollapse() {
$('.changeVisibility').css({"visibility": "collapse"});
}
</script>
<style>
.changeVisibility{
visibility: collapse;
}
</style>
</pre>

Also we had to change the structure of the table .
<pre>
<table id= "feedbacktable" cellspacing='0' cellpadding='2' border=0 class="table table-striped">
<thead>

<tr bgcolor='#CCCCCC'>
<th class="sorter-true" onclick="changeVisibilityToCollapse()">Rejoinder<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()"># author feedbacks done<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Review responded to<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Last responded at<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
</tr>
</thead>
</pre>

Also we needed to include the round count, total reviews and total iterations to completely sort the given columns. We also removed extra <tr> and <td> tags.
<pre>
<% @roundCount = instance_variable_get("@rspan_round_#{round}") %>
<% @totalreviews = @roundCount #ISSUE1980%>
<% @totalIteration=0 ## ISSSUE-1980%>
</pre>
This was a more complex implementation as we also had to consider the round in which the review was given. Also we were facing troubles for edge cases where in the data was absent for multiple columns in which sorting was implemented but due to the absence of the data the sort function would throw error. To handle such issues we included reviewer name and teammate reviews done for each and every response by that reviewer.
<pre>
<%if @totalIteration < @totalreviews-1 %>
</tr>
<tr>
<td class = changeVisibility>
<%= link_to @reviewer_name, :controller => 'popup', :action => 'reviewer_details_popup', :id => r.id, :assignment_id => @id %>
</td>

<td bgcolor=<%= @bgcolor %> align="left">
<%= @count_certain_round %>/<%= @rspan_certain_round %></td>
<% @totalIteration=@totalIteration+1 %>
<%else%>
</tr>
<%end%>
<%end%>
</pre>

[[File:Issue1980_2_solution.PNG]]

=== Issue 3 ===
We have modified the app/views/reports/_teammate_review_report.html.erb by adding the tablesorter class in the table tag. Then with the table head, we added suitable classes and added scripts at the top of the file to sort the table contents within the file.This was much harder to implement because of some issues and the code was highly unstructured. Also, the JavaScript was not proper in terms of usability and there were some elements which were not working properly as the code was static. We had to add custom parsers for date based sorting and we had to implement visibility functionality for proper rendition of table after the complete sorting.
Added the following script to the file.The script contained style elements as well to render the table after sorting.
<pre>
<script>
$.tablesorter.addParser({
id: "eudate",
is: function (s) {
return false;
},
format: function (s, table) {
s = s.replace(/\-/g, "/");
s = s.replace(/(\d{1,2})[\/\.](\d{1,2})[\/\.](\d{4})/, "$3/$1/$2");
s = s.split(" ")[0];
$('#test').html(s);
return $.tablesorter.formatFloat(new Date(s).getTime());
},
type: "numeric"
});
$(function () {
/*E: 1980Function for sorting the table */
$("#teammateReviewTable").tablesorter({
dateFormat: "mmddyyyy", //E1980: set the default date format
dateFormat: "mm/dd/yyyy", //E1980: set the default date format
headers: {
3: {sorter: 'eudate'}
},
sortList: [[0, 0]] // E1980: sort First Column by default when page loads
});
});
function changeVisibilityToVisible() {
$('.changeVisibility').css({"visibility": "visible"});
}
function changeVisibilityToCollapse() {
$('.changeVisibility').css({"visibility": "collapse"});
}
</script>
<style>
.changeVisibility{
visibility: collapse;
}
</style>
</pre>
After this the table structure was also changed based on requirements of tablesorter class.
<pre>
<thead>

<tr bgcolor='#CCCCCC'>
<th class="sorter-true" onclick="changeVisibilityToCollapse()">Reviewer<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToCollapse()"># teammate reviews done<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Teammate reviewed<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Last reviewed at<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
</tr>
</thead>
</pre>
Here we faced multiple issue with rendering because of responses received so we implemented a responsecount to keep a track of the number of responses and render the sorted table keeping that in mind. we also removed unnecessary <tr> tags and rowspan and colspan elements.

[[File:Issue1980_3_solution.PNG]]

=== Issue 4 ===
We added a header on top of Dropdown menu. For this we already had assignment name in the _searchbox.html.erb partial. We used that above the search box to display the name of assignment.
<pre>
<h1>Report for <%=@assignment.name %></h1>
</pre>

[[File:Issue1980_4_solution.PNG]]

=== Issue 5 ===
We changed in app/helpers/review_mapping_helper.rb for this issue firstly we found out the cases for which rspan was coming to be 0 and then changed the rspan value to 1.
<pre>
def get_certain_round_review_and_feedback_response_map_for_feedback_report(author)
@feedback_response_maps = FeedbackResponseMap.where(["reviewed_object_id IN (?) and reviewer_id = ?", @all_review_response_ids, author.id])
@team_id = TeamsUser.team_id(@id.to_i, author.user_id)
@review_response_map_ids = ReviewResponseMap.where(["reviewed_object_id = ? and reviewee_id = ?", @id, @team_id]).pluck("id")
@review_responses = Response.where(["map_id IN (?)", @review_response_map_ids])
@rspan = @review_responses.length
if @rspan == 0
@rspan = 1
end
</pre>

[[File:Issue1980_5_solution.PNG]]

== Test Plan ==
'''To make sure the functionality work correctly, we need to run the original Rspec test code and add some new test. Besides, we are plaining to test from UI to make sure all the features work. The test results are shown below.'''

* Run and pass existing RSpec Tests after refactoring
* Develop New RSpec Tests for the new features
* UI testing on the deployed project

=== Test from UI ===
'''For issue 1'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Select Review Report from Drop-down menu.

5. Sort the columns by Clicking on it.

'''For issue 2'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Select Author Feedback report from Drop-down menu.

5. Sort the columns by Clicking on it.

'''For issue 3'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Select teammate review report from Drop-down menu.

5. Sort the columns by Clicking on it.

'''For issue 4'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Name of assignment should be displayed above the drop-down menu.

'''For issue 5'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. From drop-down menu select Author Feedback Report.

5. Students will be displayed in proper format.

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-12-07T00:45:42Z

Nnparik2: /* Solution: */

<font size="2">
This wiki page describes the changes made according to the specification of E1980 OSS final project for Fall 2019.
----
== ''' Introduction ''' ==
* In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide feedback for this review, called “author feedback.” While grading peer reviews, it would be nice for the instructors to include the author feedback, since it shows how helpful the peer review actually was to the author of the project.

== ''' Problem Statement ''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, the average should be made sortable by using the same existing sort library.

== UML ==

<div class="center" style="width: auto;font-size:135%; margin-left: auto; margin-right: auto;">'''Workflow'''</div>

[[File:UML1.png]]

== Issue 1 ==
=== Problem ===
We have to sort “Review done”, “Team reviewed”, “Score awarded/Avg score”. in the “view review report” table. The sort button should work on all browsers, not only chrome.

[[File:Issue1980.PNG]]

===Solution:===
We will be using tablesorter function of jQuery to sort the table.To sort the columns that have constraints, custom scripts will be created. Tablesorter supports custom sorting. According to the problem type, we are supposed to perform three kinds of sorting. We need to make changes in the table head tag. By default the sorting is disabled on the columns, we must enable sorting on those columns in order to make it sortable. Three types of scenarios may arise:

1. Sorting by columns alphabetically - To sort the columns alphabetically, the table-head attribute must include sorter-true class with it.

2. Sorting by date - Sorting by date includes creating a generic format for all dates(mmddyyyy). This generic format will be used to parse dates and sorting will be done based on this format.

3. Sorting by the first number followed by the second number - It will require splitting up of the data into two parts separated by '/' and then sorting the first part, followed by the second part.

== Issue 2 ==
=== Problem ===
For “Author feedback report” table, we have to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date.

===Solution:===
We will be using already implemented function tablesorter of jQuery to sort the table. For table columns which have constraints on them for sorting, we will be creating custom scripts which tablesorter function supports to sort those columns. Similar approach to first issue.

[[File:OldAuthorfeedbackformat.PNG]]

== Issue 3 ==
=== Problem ===
For “Teammate review report” table,we have to sort "Reviewer" and "Teammate reviewed" as string(alphabetically) , sort “"# teammate review done"” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last reviewed at” as date.

===Solution:===
We will be using already implemented function tablesorter of jQuery to sort the table. For table columns which have constraints on them for sorting, we will be creating custom scripts which tablesorter function supports to sort those columns. Similar approach to first and second issue.

[[File:OldTeammatereviewsort.PNG]]

== Issue 4 ==
=== Problem ===
When the user clicks on the “View reports” icon, a page appears with a dropdown. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top.

===Solution:===
We will add header on top of Dropdown menu. For this we already have assignment name in the _searchbox.html.erb partial. We will use that above the search box to display the name of assignment.

[[File:Issue3ass.PNG]]

== Issue 5 ==

=== Problem ===
For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback.

[[File:Issuehorizontal.png]]

===Solution:===
In file _feedback_report.html.erb
The main issue behind the unusual horizontal format of all rows (student ID) is due to the value of rowspan=0 when there are no reviews.
This causes all new potential rows being viewed on same single row.
So to solve this issue, we will change @rspan variable value in review_mapping_helper.rb. We will add a condition to check the value of @rspan. If @rspan is 0, we will change it to 1. This will make one entry of student per row in the table.

<div class="center" style="width: auto;font-size:135%; margin-left: auto; margin-right: auto;">[[File:ISSUE3FLOW.png]]</div>

== Modification of Files ==
* app/assets/stylesheets/table_sorter.scss (issue 1) <br>
* app/controllers/tree_display_controller.rb (issue 1) <br>
* app/helpers/review_mapping_helper.rb (issue 5) <br>
* app/views/reports/_feedback_report.html.erb (issue 2) <br>
* app/views/reports/_review_report.html.erb (issue 1) <br>
* app/views/reports/_searchbox.html.erb (issue 4) <br>
* app/views/reports/_teammate_review_report.html.erb (issue 3) <br>
* spec/features/review_mapping_helper_spec.rb (issue 5) <br>

=='''Solutions Implemented'''==
=== Issue 1 ===
We have modified the app/views/reports/_review_report.html.erb by adding the tablesorter class in the table tag. Then with the table head, we added suitable classes and added scripts at the top of the file to sort the table contents within the file.
Added the following script to the file.
<pre>
$(function () {
/*Function for sorting the table */
$("#reviewReport").tablesorter({
sortList: [[0, 0]], //sort First Column by default when page loads
widgets: ['zebra'], // Make sure to update the css when column is sorted
headers: {
4: {
sorter: 'customParser' //custom Parser to parse Metrics data for the custom parser
}
}
});
</pre>
Then we changed the style of the table to the given requirement.
<pre>
<style>
table,tr {
border: 1px solid black;
}
th,td{
padding: 0px 2px 0px 2px;
border: 1px black solid;
}
</style>
</pre>
Then we also changed the structure of the table to fit the tablesorter class.
<pre>
<th width="16%" class="sorter-true">Reviewer<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="10%" class="sorter-true">Reviews done<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="24%" class="sorter-true">Team reviewed<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="13%" class="sorter-true">Score awarded / Avg. score<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="13%" class="sorter-true">Metrics<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-false">Assign grade and write comments <span></span></th>
</pre>

[[File:Issue1980_1_solution.PNG]]

=== Issue 2 ===
We have modified the app/views/reports/_feedback_report.html.erb by adding the tablesorter class in the table tag. Then with the table head, we added suitable classes and added scripts at the top of the file to sort the table contents within the file. We had to add custom parsers for date based sorting and we had to implement visibility functionality for proper rendition of table after the complete sorting.
Added the following script to the file.
<pre>
<script>
$(function () {
/*E: 1980Function for sorting the table */
$("#feedbacktable").tablesorter({
dateFormat : "mmddyyyy", //E1980: set the default date format
sortList: [[0,0]] // E1980: sort First Column by default when page loads
});
});
function changeVisibilityToVisible() {
$('.changeVisibility').css({"visibility": "visible"});
}
function changeVisibilityToCollapse() {
$('.changeVisibility').css({"visibility": "collapse"});
}
</script>
<style>
.changeVisibility{
visibility: collapse;
}
</style>
</pre>

Also we had to change the structure of the table .
<pre>
<table id= "feedbacktable" cellspacing='0' cellpadding='2' border=0 class="table table-striped">
<thead>

<tr bgcolor='#CCCCCC'>
<th class="sorter-true" onclick="changeVisibilityToCollapse()">Rejoinder<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()"># author feedbacks done<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Review responded to<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Last responded at<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
</tr>
</thead>
</pre>

Also we needed to include the round count, total reviews and total iterations to completely sort the given columns. We also removed extra <tr> and <td> tags.
<pre>
<% @roundCount = instance_variable_get("@rspan_round_#{round}") %>
<% @totalreviews = @roundCount #ISSUE1980%>
<% @totalIteration=0 ## ISSSUE-1980%>
</pre>
This was a more complex implementation as we also had to consider the round in which the review was given. Also we were facing troubles for edge cases where in the data was absent for multiple columns in which sorting was implemented but due to the absence of the data the sort function would throw error. To handle such issues we included reviewer name and teammate reviews done for each and every response by that reviewer.
<pre>
<%if @totalIteration < @totalreviews-1 %>
</tr>
<tr>
<td class = changeVisibility>
<%= link_to @reviewer_name, :controller => 'popup', :action => 'reviewer_details_popup', :id => r.id, :assignment_id => @id %>
</td>

<td bgcolor=<%= @bgcolor %> align="left">
<%= @count_certain_round %>/<%= @rspan_certain_round %></td>
<% @totalIteration=@totalIteration+1 %>
<%else%>
</tr>
<%end%>
<%end%>
</pre>

[[File:Issue1980_2_solution.PNG]]

=== Issue 3 ===
We have modified the app/views/reports/_teammate_review_report.html.erb by adding the tablesorter class in the table tag. Then with the table head, we added suitable classes and added scripts at the top of the file to sort the table contents within the file.This was much harder to implement because of some issues and the code was highly unstructured. Also, the JavaScript was not proper in terms of usability and there were some elements which were not working properly as the code was static. We had to add custom parsers for date based sorting and we had to implement visibility functionality for proper rendition of table after the complete sorting.
Added the following script to the file.The script contained style elements as well to render the table after sorting.
<pre>
<script>
$.tablesorter.addParser({
id: "eudate",
is: function (s) {
return false;
},
format: function (s, table) {
s = s.replace(/\-/g, "/");
s = s.replace(/(\d{1,2})[\/\.](\d{1,2})[\/\.](\d{4})/, "$3/$1/$2");
s = s.split(" ")[0];
$('#test').html(s);
return $.tablesorter.formatFloat(new Date(s).getTime());
},
type: "numeric"
});
$(function () {
/*E: 1980Function for sorting the table */
$("#teammateReviewTable").tablesorter({
dateFormat: "mmddyyyy", //E1980: set the default date format
dateFormat: "mm/dd/yyyy", //E1980: set the default date format
headers: {
3: {sorter: 'eudate'}
},
sortList: [[0, 0]] // E1980: sort First Column by default when page loads
});
});
function changeVisibilityToVisible() {
$('.changeVisibility').css({"visibility": "visible"});
}
function changeVisibilityToCollapse() {
$('.changeVisibility').css({"visibility": "collapse"});
}
</script>
<style>
.changeVisibility{
visibility: collapse;
}
</style>
</pre>
After this the table structure was also changed based on requirements of tablesorter class.
<pre>
<thead>

<tr bgcolor='#CCCCCC'>
<th class="sorter-true" onclick="changeVisibilityToCollapse()">Reviewer<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToCollapse()"># teammate reviews done<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Teammate reviewed<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Last reviewed at<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
</tr>
</thead>
</pre>
Here we faced multiple issue with rendering because of responses received so we implemented a responsecount to keep a track of the number of responses and render the sorted table keeping that in mind. we also removed unnecessary <tr> tags and rowspan and colspan elements.

[[File:Issue1980_3_solution.PNG]]

=== Issue 4 ===
We added a header on top of Dropdown menu. For this we already had assignment name in the _searchbox.html.erb partial. We used that above the search box to display the name of assignment.
<pre>
<h1>Report for <%=@assignment.name %></h1>
</pre>

[[File:Issue1980_4_solution.PNG]]

=== Issue 5 ===
We changed in app/helpers/review_mapping_helper.rb for this issue firstly we found out the cases for which rspan was coming to be 0 and then changed the rspan value to 1.
<pre>
def get_certain_round_review_and_feedback_response_map_for_feedback_report(author)
@feedback_response_maps = FeedbackResponseMap.where(["reviewed_object_id IN (?) and reviewer_id = ?", @all_review_response_ids, author.id])
@team_id = TeamsUser.team_id(@id.to_i, author.user_id)
@review_response_map_ids = ReviewResponseMap.where(["reviewed_object_id = ? and reviewee_id = ?", @id, @team_id]).pluck("id")
@review_responses = Response.where(["map_id IN (?)", @review_response_map_ids])
@rspan = @review_responses.length
if @rspan == 0
@rspan = 1
end
</pre>

[[File:Issue1980_5_solution.PNG]]

== Test Plan ==
'''To make sure the functionality work correctly, we need to run the original Rspec test code and add some new test. Besides, we are plaining to test from UI to make sure all the features work. The test results are shown below.'''

* Run and pass existing RSpec Tests after refactoring
* Develop New RSpec Tests for the new features
* UI testing on the deployed project

=== Test from UI ===
'''For issue 1'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Select Review Report from Drop-down menu.

5. Sort the columns by Clicking on it.

'''For issue 2'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Select Author Feedback report from Drop-down menu.

5. Sort the columns by Clicking on it.

'''For issue 3'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Select teammate review report from Drop-down menu.

5. Sort the columns by Clicking on it.

'''For issue 4'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Name of assignment should be displayed above the drop-down menu.

'''For issue 5'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. From drop-down menu select Author Feedback Report.

5. Students will be displayed in proper format.

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-12-07T00:43:36Z

Nnparik2: /* Solution: */

<font size="2">
This wiki page describes the changes made according to the specification of E1980 OSS final project for Fall 2019.
----
== ''' Introduction ''' ==
* In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide feedback for this review, called “author feedback.” While grading peer reviews, it would be nice for the instructors to include the author feedback, since it shows how helpful the peer review actually was to the author of the project.

== ''' Problem Statement ''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, the average should be made sortable by using the same existing sort library.

== UML ==

<div class="center" style="width: auto;font-size:135%; margin-left: auto; margin-right: auto;">'''Workflow'''</div>

[[File:UML1.png]]

== Issue 1 ==
=== Problem ===
We have to sort “Review done”, “Team reviewed”, “Score awarded/Avg score”. in the “view review report” table. The sort button should work on all browsers, not only chrome.

[[File:Issue1980.PNG]]

===Solution:===
We will be using tablesorter function of jQuery to sort the table. For columns that have constraints, custom scripts will be created to sort them. Tablesorter supports custom scripts. According to the problem type, we are supposed to perform three kinds of sorting. We need to make changes in the table head tag. By default the sorting is disabled on the columns, we must set sorting to true on those columns in order to make it sortable. Three types of scenarios may arise:

1. Sorting by columns alphabetically - To sort the columns alphabetically, the table-head attribute must include sorter-true class with it.

2. Sorting by date - Sorting by date includes creating a generic format for all dates(mmddyyyy). This generic format will be used to parse dates and sorting will be done based on this format.

3. Sorting by the first number followed by the second number - It will require splitting up of the data into two parts separated by '/' and then sorting the first part, followed by the second part.

== Issue 2 ==
=== Problem ===
For “Author feedback report” table, we have to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date.

===Solution:===
We will be using already implemented function tablesorter of jQuery to sort the table. For table columns which have constraints on them for sorting, we will be creating custom scripts which tablesorter function supports to sort those columns. Similar approach to first issue.

[[File:OldAuthorfeedbackformat.PNG]]

== Issue 3 ==
=== Problem ===
For “Teammate review report” table,we have to sort "Reviewer" and "Teammate reviewed" as string(alphabetically) , sort “"# teammate review done"” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last reviewed at” as date.

===Solution:===
We will be using already implemented function tablesorter of jQuery to sort the table. For table columns which have constraints on them for sorting, we will be creating custom scripts which tablesorter function supports to sort those columns. Similar approach to first and second issue.

[[File:OldTeammatereviewsort.PNG]]

== Issue 4 ==
=== Problem ===
When the user clicks on the “View reports” icon, a page appears with a dropdown. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top.

===Solution:===
We will add header on top of Dropdown menu. For this we already have assignment name in the _searchbox.html.erb partial. We will use that above the search box to display the name of assignment.

[[File:Issue3ass.PNG]]

== Issue 5 ==

=== Problem ===
For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback.

[[File:Issuehorizontal.png]]

===Solution:===
In file _feedback_report.html.erb
The main issue behind the unusual horizontal format of all rows (student ID) is due to the value of rowspan=0 when there are no reviews.
This causes all new potential rows being viewed on same single row.
So to solve this issue, we will change @rspan variable value in review_mapping_helper.rb. We will add a condition to check the value of @rspan. If @rspan is 0, we will change it to 1. This will make one entry of student per row in the table.

<div class="center" style="width: auto;font-size:135%; margin-left: auto; margin-right: auto;">[[File:ISSUE3FLOW.png]]</div>

== Modification of Files ==
* app/assets/stylesheets/table_sorter.scss (issue 1) <br>
* app/controllers/tree_display_controller.rb (issue 1) <br>
* app/helpers/review_mapping_helper.rb (issue 5) <br>
* app/views/reports/_feedback_report.html.erb (issue 2) <br>
* app/views/reports/_review_report.html.erb (issue 1) <br>
* app/views/reports/_searchbox.html.erb (issue 4) <br>
* app/views/reports/_teammate_review_report.html.erb (issue 3) <br>
* spec/features/review_mapping_helper_spec.rb (issue 5) <br>

=='''Solutions Implemented'''==
=== Issue 1 ===
We have modified the app/views/reports/_review_report.html.erb by adding the tablesorter class in the table tag. Then with the table head, we added suitable classes and added scripts at the top of the file to sort the table contents within the file.
Added the following script to the file.
<pre>
$(function () {
/*Function for sorting the table */
$("#reviewReport").tablesorter({
sortList: [[0, 0]], //sort First Column by default when page loads
widgets: ['zebra'], // Make sure to update the css when column is sorted
headers: {
4: {
sorter: 'customParser' //custom Parser to parse Metrics data for the custom parser
}
}
});
</pre>
Then we changed the style of the table to the given requirement.
<pre>
<style>
table,tr {
border: 1px solid black;
}
th,td{
padding: 0px 2px 0px 2px;
border: 1px black solid;
}
</style>
</pre>
Then we also changed the structure of the table to fit the tablesorter class.
<pre>
<th width="16%" class="sorter-true">Reviewer<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="10%" class="sorter-true">Reviews done<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="24%" class="sorter-true">Team reviewed<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="13%" class="sorter-true">Score awarded / Avg. score<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="13%" class="sorter-true">Metrics<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-false">Assign grade and write comments <span></span></th>
</pre>

[[File:Issue1980_1_solution.PNG]]

=== Issue 2 ===
We have modified the app/views/reports/_feedback_report.html.erb by adding the tablesorter class in the table tag. Then with the table head, we added suitable classes and added scripts at the top of the file to sort the table contents within the file. We had to add custom parsers for date based sorting and we had to implement visibility functionality for proper rendition of table after the complete sorting.
Added the following script to the file.
<pre>
<script>
$(function () {
/*E: 1980Function for sorting the table */
$("#feedbacktable").tablesorter({
dateFormat : "mmddyyyy", //E1980: set the default date format
sortList: [[0,0]] // E1980: sort First Column by default when page loads
});
});
function changeVisibilityToVisible() {
$('.changeVisibility').css({"visibility": "visible"});
}
function changeVisibilityToCollapse() {
$('.changeVisibility').css({"visibility": "collapse"});
}
</script>
<style>
.changeVisibility{
visibility: collapse;
}
</style>
</pre>

Also we had to change the structure of the table .
<pre>
<table id= "feedbacktable" cellspacing='0' cellpadding='2' border=0 class="table table-striped">
<thead>

<tr bgcolor='#CCCCCC'>
<th class="sorter-true" onclick="changeVisibilityToCollapse()">Rejoinder<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()"># author feedbacks done<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Review responded to<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Last responded at<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
</tr>
</thead>
</pre>

Also we needed to include the round count, total reviews and total iterations to completely sort the given columns. We also removed extra <tr> and <td> tags.
<pre>
<% @roundCount = instance_variable_get("@rspan_round_#{round}") %>
<% @totalreviews = @roundCount #ISSUE1980%>
<% @totalIteration=0 ## ISSSUE-1980%>
</pre>
This was a more complex implementation as we also had to consider the round in which the review was given. Also we were facing troubles for edge cases where in the data was absent for multiple columns in which sorting was implemented but due to the absence of the data the sort function would throw error. To handle such issues we included reviewer name and teammate reviews done for each and every response by that reviewer.
<pre>
<%if @totalIteration < @totalreviews-1 %>
</tr>
<tr>
<td class = changeVisibility>
<%= link_to @reviewer_name, :controller => 'popup', :action => 'reviewer_details_popup', :id => r.id, :assignment_id => @id %>
</td>

<td bgcolor=<%= @bgcolor %> align="left">
<%= @count_certain_round %>/<%= @rspan_certain_round %></td>
<% @totalIteration=@totalIteration+1 %>
<%else%>
</tr>
<%end%>
<%end%>
</pre>

[[File:Issue1980_2_solution.PNG]]

=== Issue 3 ===
We have modified the app/views/reports/_teammate_review_report.html.erb by adding the tablesorter class in the table tag. Then with the table head, we added suitable classes and added scripts at the top of the file to sort the table contents within the file.This was much harder to implement because of some issues and the code was highly unstructured. Also, the JavaScript was not proper in terms of usability and there were some elements which were not working properly as the code was static. We had to add custom parsers for date based sorting and we had to implement visibility functionality for proper rendition of table after the complete sorting.
Added the following script to the file.The script contained style elements as well to render the table after sorting.
<pre>
<script>
$.tablesorter.addParser({
id: "eudate",
is: function (s) {
return false;
},
format: function (s, table) {
s = s.replace(/\-/g, "/");
s = s.replace(/(\d{1,2})[\/\.](\d{1,2})[\/\.](\d{4})/, "$3/$1/$2");
s = s.split(" ")[0];
$('#test').html(s);
return $.tablesorter.formatFloat(new Date(s).getTime());
},
type: "numeric"
});
$(function () {
/*E: 1980Function for sorting the table */
$("#teammateReviewTable").tablesorter({
dateFormat: "mmddyyyy", //E1980: set the default date format
dateFormat: "mm/dd/yyyy", //E1980: set the default date format
headers: {
3: {sorter: 'eudate'}
},
sortList: [[0, 0]] // E1980: sort First Column by default when page loads
});
});
function changeVisibilityToVisible() {
$('.changeVisibility').css({"visibility": "visible"});
}
function changeVisibilityToCollapse() {
$('.changeVisibility').css({"visibility": "collapse"});
}
</script>
<style>
.changeVisibility{
visibility: collapse;
}
</style>
</pre>
After this the table structure was also changed based on requirements of tablesorter class.
<pre>
<thead>

<tr bgcolor='#CCCCCC'>
<th class="sorter-true" onclick="changeVisibilityToCollapse()">Reviewer<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToCollapse()"># teammate reviews done<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Teammate reviewed<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Last reviewed at<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
</tr>
</thead>
</pre>
Here we faced multiple issue with rendering because of responses received so we implemented a responsecount to keep a track of the number of responses and render the sorted table keeping that in mind. we also removed unnecessary <tr> tags and rowspan and colspan elements.

[[File:Issue1980_3_solution.PNG]]

=== Issue 4 ===
We added a header on top of Dropdown menu. For this we already had assignment name in the _searchbox.html.erb partial. We used that above the search box to display the name of assignment.
<pre>
<h1>Report for <%=@assignment.name %></h1>
</pre>

[[File:Issue1980_4_solution.PNG]]

=== Issue 5 ===
We changed in app/helpers/review_mapping_helper.rb for this issue firstly we found out the cases for which rspan was coming to be 0 and then changed the rspan value to 1.
<pre>
def get_certain_round_review_and_feedback_response_map_for_feedback_report(author)
@feedback_response_maps = FeedbackResponseMap.where(["reviewed_object_id IN (?) and reviewer_id = ?", @all_review_response_ids, author.id])
@team_id = TeamsUser.team_id(@id.to_i, author.user_id)
@review_response_map_ids = ReviewResponseMap.where(["reviewed_object_id = ? and reviewee_id = ?", @id, @team_id]).pluck("id")
@review_responses = Response.where(["map_id IN (?)", @review_response_map_ids])
@rspan = @review_responses.length
if @rspan == 0
@rspan = 1
end
</pre>

[[File:Issue1980_5_solution.PNG]]

== Test Plan ==
'''To make sure the functionality work correctly, we need to run the original Rspec test code and add some new test. Besides, we are plaining to test from UI to make sure all the features work. The test results are shown below.'''

* Run and pass existing RSpec Tests after refactoring
* Develop New RSpec Tests for the new features
* UI testing on the deployed project

=== Test from UI ===
'''For issue 1'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Select Review Report from Drop-down menu.

5. Sort the columns by Clicking on it.

'''For issue 2'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Select Author Feedback report from Drop-down menu.

5. Sort the columns by Clicking on it.

'''For issue 3'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Select teammate review report from Drop-down menu.

5. Sort the columns by Clicking on it.

'''For issue 4'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Name of assignment should be displayed above the drop-down menu.

'''For issue 5'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. From drop-down menu select Author Feedback Report.

5. Students will be displayed in proper format.

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-12-07T00:25:13Z

Nnparik2: /* Problem */

<font size="2">
This wiki page describes the changes made according to the specification of E1980 OSS final project for Fall 2019.
----
== ''' Introduction ''' ==
* In Expertiza, peer reviews are used as a metric to evaluate someone’s project. Once someone has peer reviewed a project, the authors of the project can also provide feedback for this review, called “author feedback.” While grading peer reviews, it would be nice for the instructors to include the author feedback, since it shows how helpful the peer review actually was to the author of the project.

== ''' Problem Statement ''' ==

Expertiza allows instructors to view kinds of reports of assignments in their courses such as submissions, scores, and review reports. To improve the report views, some table columns such as team name, score, the average should be made sortable by using the same existing sort library.

== UML ==

<div class="center" style="width: auto;font-size:135%; margin-left: auto; margin-right: auto;">'''Workflow'''</div>

[[File:UML1.png]]

== Issue 1 ==
=== Problem ===
We have to sort “Review done”, “Team reviewed”, “Score awarded/Avg score”. in the “view review report” table. The sort button should work on all browsers, not only chrome.

[[File:Issue1980.PNG]]

===Solution:===
We will be using already implemented function tablesorter of jQuery to sort the table. For table columns which have constraints on them for sorting, we will be creating custom scripts which tablesorter function supports to sort those columns. According to the problem type, we are supposed to perform three kinds of sorting. All have one thing in common, adding up the tablesorter script in the body before using them. After including the script, we are supposed to do some modifications in the table tag by including the class. Three types of scenarios may arise:

1. Sorting by columns alphabetically - To sort the columns alphabetically, the table-head attribute must include sorter-true class with it to enable the sorting alphabetically.

2. Sorting by date - It includes adding of a date default format in the script to denote the sorter type that must be used to sort the column of the date.

3. Sorting by the first number followed by the second number - It will require splitting up of the data into two parts separated by '/' and then sorting the first part, followed by the second part.

== Issue 2 ==
=== Problem ===
For “Author feedback report” table, we have to change the header name “Review response rejoined” to “Review responded to” and “Last rejoined at” to “Last responded at”. Then, sort “Rejoinder” and “Review “Review responded to” as string (alphabetically), sort “# author feedbacks done” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last responded at” as date.

===Solution:===
We will be using already implemented function tablesorter of jQuery to sort the table. For table columns which have constraints on them for sorting, we will be creating custom scripts which tablesorter function supports to sort those columns. Similar approach to first issue.

[[File:OldAuthorfeedbackformat.PNG]]

== Issue 3 ==
=== Problem ===
For “Teammate review report” table,we have to sort "Reviewer" and "Teammate reviewed" as string(alphabetically) , sort “"# teammate review done"” by the first number then the second number (same as “Review done” in the “View review report” table) and sort “Last reviewed at” as date.

===Solution:===
We will be using already implemented function tablesorter of jQuery to sort the table. For table columns which have constraints on them for sorting, we will be creating custom scripts which tablesorter function supports to sort those columns. Similar approach to first and second issue.

[[File:OldTeammatereviewsort.PNG]]

== Issue 4 ==
=== Problem ===
When the user clicks on the “View reports” icon, a page appears with a dropdown. However, that page does not say what assignment’s reports are being viewed. Add a header, “Reports for [name of assignment]” at the top.

===Solution:===
We will add header on top of Dropdown menu. For this we already have assignment name in the _searchbox.html.erb partial. We will use that above the search box to display the name of assignment.

[[File:Issue3ass.PNG]]

== Issue 5 ==

=== Problem ===
For Author feedback reports, when no feedback has been submitted by any student, the names of the participants appear in a strange horizontal format. Fix this so that the formatting is correct, regardless of how many participants have done author feedback.

[[File:Issuehorizontal.png]]

===Solution:===
In file _feedback_report.html.erb
The main issue behind the unusual horizontal format of all rows (student ID) is due to the value of rowspan=0 when there are no reviews.
This causes all new potential rows being viewed on same single row.
So to solve this issue, we will change @rspan variable value in review_mapping_helper.rb. We will add a condition to check the value of @rspan. If @rspan is 0, we will change it to 1. This will make one entry of student per row in the table.

<div class="center" style="width: auto;font-size:135%; margin-left: auto; margin-right: auto;">[[File:ISSUE3FLOW.png]]</div>

== Modification of Files ==
* app/assets/stylesheets/table_sorter.scss (issue 1) <br>
* app/controllers/tree_display_controller.rb (issue 1) <br>
* app/helpers/review_mapping_helper.rb (issue 5) <br>
* app/views/reports/_feedback_report.html.erb (issue 2) <br>
* app/views/reports/_review_report.html.erb (issue 1) <br>
* app/views/reports/_searchbox.html.erb (issue 4) <br>
* app/views/reports/_teammate_review_report.html.erb (issue 3) <br>
* spec/features/review_mapping_helper_spec.rb (issue 5) <br>

=='''Solutions Implemented'''==
=== Issue 1 ===
We have modified the app/views/reports/_review_report.html.erb by adding the tablesorter class in the table tag. Then with the table head, we added suitable classes and added scripts at the top of the file to sort the table contents within the file.
Added the following script to the file.
<pre>
$(function () {
/*Function for sorting the table */
$("#reviewReport").tablesorter({
sortList: [[0, 0]], //sort First Column by default when page loads
widgets: ['zebra'], // Make sure to update the css when column is sorted
headers: {
4: {
sorter: 'customParser' //custom Parser to parse Metrics data for the custom parser
}
}
});
</pre>
Then we changed the style of the table to the given requirement.
<pre>
<style>
table,tr {
border: 1px solid black;
}
th,td{
padding: 0px 2px 0px 2px;
border: 1px black solid;
}
</style>
</pre>
Then we also changed the structure of the table to fit the tablesorter class.
<pre>
<th width="16%" class="sorter-true">Reviewer<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="10%" class="sorter-true">Reviews done<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="24%" class="sorter-true">Team reviewed<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="13%" class="sorter-true">Score awarded / Avg. score<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th width="13%" class="sorter-true">Metrics<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-false">Assign grade and write comments <span></span></th>
</pre>

[[File:Issue1980_1_solution.PNG]]

=== Issue 2 ===
We have modified the app/views/reports/_feedback_report.html.erb by adding the tablesorter class in the table tag. Then with the table head, we added suitable classes and added scripts at the top of the file to sort the table contents within the file. We had to add custom parsers for date based sorting and we had to implement visibility functionality for proper rendition of table after the complete sorting.
Added the following script to the file.
<pre>
<script>
$(function () {
/*E: 1980Function for sorting the table */
$("#feedbacktable").tablesorter({
dateFormat : "mmddyyyy", //E1980: set the default date format
sortList: [[0,0]] // E1980: sort First Column by default when page loads
});
});
function changeVisibilityToVisible() {
$('.changeVisibility').css({"visibility": "visible"});
}
function changeVisibilityToCollapse() {
$('.changeVisibility').css({"visibility": "collapse"});
}
</script>
<style>
.changeVisibility{
visibility: collapse;
}
</style>
</pre>

Also we had to change the structure of the table .
<pre>
<table id= "feedbacktable" cellspacing='0' cellpadding='2' border=0 class="table table-striped">
<thead>

<tr bgcolor='#CCCCCC'>
<th class="sorter-true" onclick="changeVisibilityToCollapse()">Rejoinder<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()"># author feedbacks done<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Review responded to<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Last responded at<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
</tr>
</thead>
</pre>

Also we needed to include the round count, total reviews and total iterations to completely sort the given columns. We also removed extra <tr> and <td> tags.
<pre>
<% @roundCount = instance_variable_get("@rspan_round_#{round}") %>
<% @totalreviews = @roundCount #ISSUE1980%>
<% @totalIteration=0 ## ISSSUE-1980%>
</pre>
This was a more complex implementation as we also had to consider the round in which the review was given. Also we were facing troubles for edge cases where in the data was absent for multiple columns in which sorting was implemented but due to the absence of the data the sort function would throw error. To handle such issues we included reviewer name and teammate reviews done for each and every response by that reviewer.
<pre>
<%if @totalIteration < @totalreviews-1 %>
</tr>
<tr>
<td class = changeVisibility>
<%= link_to @reviewer_name, :controller => 'popup', :action => 'reviewer_details_popup', :id => r.id, :assignment_id => @id %>
</td>

<td bgcolor=<%= @bgcolor %> align="left">
<%= @count_certain_round %>/<%= @rspan_certain_round %></td>
<% @totalIteration=@totalIteration+1 %>
<%else%>
</tr>
<%end%>
<%end%>
</pre>

[[File:Issue1980_2_solution.PNG]]

=== Issue 3 ===
We have modified the app/views/reports/_teammate_review_report.html.erb by adding the tablesorter class in the table tag. Then with the table head, we added suitable classes and added scripts at the top of the file to sort the table contents within the file.This was much harder to implement because of some issues and the code was highly unstructured. Also, the JavaScript was not proper in terms of usability and there were some elements which were not working properly as the code was static. We had to add custom parsers for date based sorting and we had to implement visibility functionality for proper rendition of table after the complete sorting.
Added the following script to the file.The script contained style elements as well to render the table after sorting.
<pre>
<script>
$.tablesorter.addParser({
id: "eudate",
is: function (s) {
return false;
},
format: function (s, table) {
s = s.replace(/\-/g, "/");
s = s.replace(/(\d{1,2})[\/\.](\d{1,2})[\/\.](\d{4})/, "$3/$1/$2");
s = s.split(" ")[0];
$('#test').html(s);
return $.tablesorter.formatFloat(new Date(s).getTime());
},
type: "numeric"
});
$(function () {
/*E: 1980Function for sorting the table */
$("#teammateReviewTable").tablesorter({
dateFormat: "mmddyyyy", //E1980: set the default date format
dateFormat: "mm/dd/yyyy", //E1980: set the default date format
headers: {
3: {sorter: 'eudate'}
},
sortList: [[0, 0]] // E1980: sort First Column by default when page loads
});
});
function changeVisibilityToVisible() {
$('.changeVisibility').css({"visibility": "visible"});
}
function changeVisibilityToCollapse() {
$('.changeVisibility').css({"visibility": "collapse"});
}
</script>
<style>
.changeVisibility{
visibility: collapse;
}
</style>
</pre>
After this the table structure was also changed based on requirements of tablesorter class.
<pre>
<thead>

<tr bgcolor='#CCCCCC'>
<th class="sorter-true" onclick="changeVisibilityToCollapse()">Reviewer<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToCollapse()"># teammate reviews done<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Teammate reviewed<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
<th class="sorter-true" onclick="changeVisibilityToVisible()">Last reviewed at<span class="glyphicon glyphicon-sort" data-reactid=".0.1.0.$table2.3.0.0.2.1"></span></th>
</tr>
</thead>
</pre>
Here we faced multiple issue with rendering because of responses received so we implemented a responsecount to keep a track of the number of responses and render the sorted table keeping that in mind. we also removed unnecessary <tr> tags and rowspan and colspan elements.

[[File:Issue1980_3_solution.PNG]]

=== Issue 4 ===
We added a header on top of Dropdown menu. For this we already had assignment name in the _searchbox.html.erb partial. We used that above the search box to display the name of assignment.
<pre>
<h1>Report for <%=@assignment.name %></h1>
</pre>

[[File:Issue1980_4_solution.PNG]]

=== Issue 5 ===
We changed in app/helpers/review_mapping_helper.rb for this issue firstly we found out the cases for which rspan was coming to be 0 and then changed the rspan value to 1.
<pre>
def get_certain_round_review_and_feedback_response_map_for_feedback_report(author)
@feedback_response_maps = FeedbackResponseMap.where(["reviewed_object_id IN (?) and reviewer_id = ?", @all_review_response_ids, author.id])
@team_id = TeamsUser.team_id(@id.to_i, author.user_id)
@review_response_map_ids = ReviewResponseMap.where(["reviewed_object_id = ? and reviewee_id = ?", @id, @team_id]).pluck("id")
@review_responses = Response.where(["map_id IN (?)", @review_response_map_ids])
@rspan = @review_responses.length
if @rspan == 0
@rspan = 1
end
</pre>

[[File:Issue1980_5_solution.PNG]]

== Test Plan ==
'''To make sure the functionality work correctly, we need to run the original Rspec test code and add some new test. Besides, we are plaining to test from UI to make sure all the features work. The test results are shown below.'''

* Run and pass existing RSpec Tests after refactoring
* Develop New RSpec Tests for the new features
* UI testing on the deployed project

=== Test from UI ===
'''For issue 1'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Select Review Report from Drop-down menu.

5. Sort the columns by Clicking on it.

'''For issue 2'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Select Author Feedback report from Drop-down menu.

5. Sort the columns by Clicking on it.

'''For issue 3'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Select teammate review report from Drop-down menu.

5. Sort the columns by Clicking on it.

'''For issue 4'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. Name of assignment should be displayed above the drop-down menu.

'''For issue 5'''

1. Login to expertiza using the above credentials.

2. Under Manage Notifications tab click on Assignments.

3. Under Assignments click view report.

4. From drop-down menu select Author Feedback Report.

5. Students will be displayed in proper format.

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-11-25T01:35:25Z

Nnparik2: /* Solution: */

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-11-25T01:29:47Z

Nnparik2: /* Solution: */

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-11-25T01:28:56Z

Nnparik2: /* Solution: */

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-11-25T01:26:38Z

Nnparik2: /* Solution: */

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-11-15T23:00:48Z

Nnparik2: /* Solution: */

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-11-15T22:57:19Z

Nnparik2: /* Test from UI */

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-11-15T22:49:36Z

Nnparik2: /* Test from UI */

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-11-15T22:49:18Z

Nnparik2: /* TEST PLAN */

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-11-15T22:49:01Z

Nnparik2: /* ISSUE 3 */

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-11-15T22:48:52Z

Nnparik2: /* ISSUE 2 */

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-11-15T22:48:41Z

Nnparik2: /* ISSUE 1 */

CSC/ECE 517 Fall 2019 - E1980. Sort instructor reports by name, ID, score, etc.

2019-11-15T22:48:04Z

Nnparik2: /* Test from UI */

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-12T15:18:11Z

Nnparik2: /* Code Coverage */

==<b>E1956. There is no shortcut to get free review points: Review Assignment Bug</b>==

__TOC__

===About Expertiza===

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

==Project Description==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

====Issue 1====
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
====Issue 2====
*There is no check to see if the submission is already assigned to the student.
====Issue 3====
*There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project, in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open-source project and learn further about software deployment etc.

Currently, there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy. Also, there is no check to see if the user has submitted enough reviews for that assignment before getting a new review.

==Current Implementation==
<b>Problem 1: No limitation on the maximum number of peer reviews.</b>
*There is no check in the backend that limits the number of reviews assigned to a student. There is a check in the UI, but one could evade the limit by typing in a URL to make the same post request. One can also evade it by clicking multiple times on "Request a review for submission" button in UI.

<b>Problem 2: No check on duplicate submissions</b>
* There is no check to see if the submission is already assigned to a student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

<b>Problem 3: There is no check on the number of outstanding reviews</b>
*A user can request for submissions even if the current outstanding ones are pending.

[[File:Pro.png]]
[[File:Issue.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* The is_reviews_allowed method checks the number of reviews assigned to a student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then it returns False.
<pre>
def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end
</pre>
* The check_outstanding_reviews checks the number of outstanding assignment reviews a user can have at a time. The check_outstanding_reviews keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_reviews returns True.
<pre>
def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < assignment.max_outstanding_reviews
end
end
</pre>

'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where a new check was added. This check fetches the number of reviews done by a student currently from ReviewResponseMap table. To adapt to those changes, two new mocks were added to the review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
* To test number of reviews, we added new tests. The code works on size of object returned by querying reviewer_id and reviewed_object_id. To avoid database call, ReviewResponseMap is mocked to return empty list and a list of values. Empty list indicates that student has not done any review and therefore must be allowed. List of values is returned to check if the size of list is greater than allowed number of reviews according to assignment policy.
* To test outstanding number of reviews, we added new tests. The code works on number of reviews completed. If the number of reviews completed are less than assignment's max outstanding reviews, then student must not be allowed new review. To test the functionality we mocked ReviewResponseMap to return an object.
*For one of the test cases we mocked the assignment's max outstanding reviews to be 0, which means without doing even a single review he can request as many reviews as he wants. For the other test case we mocked assignment's max outstanding reviews to be 2 and hence without doing two reviews he can't ask for more. We mocked ReviewResposneMap to have one object.

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes:<br/>
1. Login as instructor.<br/>
2. Go to Manage->Assignments and navigate to assignment name 'test1'. <br/>
3. Click on add participants. This will give a list of all participants. <br/>
4. Now click on any student username in order to impersonate. <br/>
5. Go to test1->other's_work and click on request submission button continuously and wait for the response.<br/>
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

To test outstanding number of reviews:<br/>
Follow the steps above, you will get 2 reviews at first.<br/>
1. Fill up one of the review, You will get the button to request again.<br/>
2. Click on button continuously.<br/>
3. It should be noted that despite continuous request, user will not get any more reviews than difference of max outstanding review and completed reviews.<br/>

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
24.317%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

<b>Mentor: Suraj Siddharudh</b>

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

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T04:07:17Z

Nnparik2: /* Testing from UI */

==<b>E1956. There is no shortcut to get free review points: Review Assignment Bug</b>==

__TOC__

===About Expertiza===

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

==Project Description==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

====Issue 1====
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
====Issue 2====
*There is no check to see if the submission is already assigned to the student.
====Issue 3====
*There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project, in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open-source project and learn further about software deployment etc.

Currently, there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy. Also, there is no check to see if the user has submitted enough reviews for that assignment before getting a new review.

==Current Implementation==
<b>Problem 1: No limitation on the maximum number of peer reviews.</b>
*There is no check in the backend that limits the number of reviews assigned to a student. There is a check in the UI, but one could evade the limit by typing in a URL to make the same post request. One can also evade it by clicking multiple times on "Request a review for submission" button in UI.

<b>Problem 2: No check on duplicate submissions</b>
* There is no check to see if the submission is already assigned to a student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

<b>Problem 3: There is no check on the number of outstanding reviews</b>
*A user can request for submissions even if the current outstanding ones are pending.

[[File:Pro.png]]
[[File:Issue.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* The is_reviews_allowed method checks the number of reviews assigned to a student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then it returns False.
<pre>
def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end
</pre>
* The check_outstanding_reviews checks the number of outstanding assignment reviews a user can have at a time. The check_outstanding_reviews keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_reviews returns True.
<pre>
def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < assignment.max_outstanding_reviews
end
end
</pre>

'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where a new check was added. This check fetches the number of reviews done by a student currently from ReviewResponseMap table. To adapt to those changes, two new mocks were added to the review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
* To test number of reviews, we added new tests. The code works on size of object returned by querying reviewer_id and reviewed_object_id. To avoid database call, ReviewResponseMap is mocked to return empty list and a list of values. Empty list indicates that student has not done any review and therefore must be allowed. List of values is returned to check if the size of list is greater than allowed number of reviews according to assignment policy.
* To test outstanding number of reviews, we added new tests. The code works on number of reviews completed. If the number of reviews completed are less than assignment's max outstanding reviews, then student must not be allowed new review. To test the functionality we mocked ReviewResponseMap to return an object.
*For one of the test cases we mocked the assignment's max outstanding reviews to be 0, which means without doing even a single review he can request as many reviews as he wants. For the other test case we mocked assignment's max outstanding reviews to be 2 and hence without doing two reviews he can't ask for more. We mocked ReviewResposneMap to have one object.

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes:<br/>
1. Login as instructor.<br/>
2. Go to Manage->Assignments and navigate to assignment name 'test1'. <br/>
3. Click on add participants. This will give a list of all participants. <br/>
4. Now click on any student username in order to impersonate. <br/>
5. Go to test1->other's_work and click on request submission button continuously and wait for the response.<br/>
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

To test outstanding number of reviews:<br/>
Follow the steps above, you will get 2 reviews at first.<br/>
1. Fill up one of the review, You will get the button to request again.<br/>
2. Click on button continuously.<br/>
3. It should be noted that despite continuous request, user will not get any more reviews than difference of max outstanding review and completed reviews.<br/>

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

<b>Mentor: Suraj Siddharudh</b>

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

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T04:06:48Z

Nnparik2: /* Testing from UI */

==<b>E1956. There is no shortcut to get free review points: Review Assignment Bug</b>==

__TOC__

===About Expertiza===

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

==Project Description==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

====Issue 1====
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
====Issue 2====
*There is no check to see if the submission is already assigned to the student.
====Issue 3====
*There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project, in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open-source project and learn further about software deployment etc.

Currently, there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy. Also, there is no check to see if the user has submitted enough reviews for that assignment before getting a new review.

==Current Implementation==
<b>Problem 1: No limitation on the maximum number of peer reviews.</b>
*There is no check in the backend that limits the number of reviews assigned to a student. There is a check in the UI, but one could evade the limit by typing in a URL to make the same post request. One can also evade it by clicking multiple times on "Request a review for submission" button in UI.

<b>Problem 2: No check on duplicate submissions</b>
* There is no check to see if the submission is already assigned to a student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

<b>Problem 3: There is no check on the number of outstanding reviews</b>
*A user can request for submissions even if the current outstanding ones are pending.

[[File:Pro.png]]
[[File:Issue.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* The is_reviews_allowed method checks the number of reviews assigned to a student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then it returns False.
<pre>
def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end
</pre>
* The check_outstanding_reviews checks the number of outstanding assignment reviews a user can have at a time. The check_outstanding_reviews keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_reviews returns True.
<pre>
def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < assignment.max_outstanding_reviews
end
end
</pre>

'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where a new check was added. This check fetches the number of reviews done by a student currently from ReviewResponseMap table. To adapt to those changes, two new mocks were added to the review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
* To test number of reviews, we added new tests. The code works on size of object returned by querying reviewer_id and reviewed_object_id. To avoid database call, ReviewResponseMap is mocked to return empty list and a list of values. Empty list indicates that student has not done any review and therefore must be allowed. List of values is returned to check if the size of list is greater than allowed number of reviews according to assignment policy.
* To test outstanding number of reviews, we added new tests. The code works on number of reviews completed. If the number of reviews completed are less than assignment's max outstanding reviews, then student must not be allowed new review. To test the functionality we mocked ReviewResponseMap to return an object.
*For one of the test cases we mocked the assignment's max outstanding reviews to be 0, which means without doing even a single review he can request as many reviews as he wants. For the other test case we mocked assignment's max outstanding reviews to be 2 and hence without doing two reviews he can't ask for more. We mocked ReviewResposneMap to have one object.

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes:<br/>
1. Login as instructor.<br/>
2. Go to Manage->Assignments and navigate to assignment name 'test1'. <br/>
3. Click on add participants. This will give a list of all participants. <br/>
4. Now click on any student username in order to impersonate. <br/>
5. Go to test1->other's_work and click on request submission button continuously and wait for the response.<br/>
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

To test outstanding number of reviews:
Follow the steps above, you will get 2 reviews at first.
1. Fill up one of the review, You will get the button to request again.
2. Click on button continuously.
3. It should be noted that despite continuous request, user will not get any more reviews than difference of max outstanding review and completed reviews.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

<b>Mentor: Suraj Siddharudh</b>

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

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T04:01:19Z

Nnparik2: /* Files modified */

==<b>E1956. There is no shortcut to get free review points: Review Assignment Bug</b>==

__TOC__

===About Expertiza===

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

==Project Description==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

====Issue 1====
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
====Issue 2====
*There is no check to see if the submission is already assigned to the student.
====Issue 3====
*There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project, in particular intends that the students collaborate and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open-source project and learn further about software deployment etc.

Currently, there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy. Also, there is no check to see if the user has submitted enough reviews for that assignment before getting a new review.

==Current Implementation==
<b>Problem 1: No limitation on the maximum number of peer reviews.</b>
*There is no check in the backend that limits the number of reviews assigned to a student. There is a check in the UI, but one could evade the limit by typing in a URL to make the same post request. One can also evade it by clicking multiple times on "Request a review for submission" button in UI.

<b>Problem 2: No check on duplicate submissions</b>
* There is no check to see if the submission is already assigned to a student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

<b>Problem 3: There is no check on the number of outstanding reviews</b>
*A user can request for submissions even if the current outstanding ones are pending.

[[File:Pro.png]]
[[File:Issue.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* The is_reviews_allowed method checks the number of reviews assigned to a student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then it returns False.
<pre>
def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end
</pre>
* The check_outstanding_reviews checks the number of outstanding assignment reviews a user can have at a time. The check_outstanding_reviews keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_reviews returns True.
<pre>
def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < assignment.max_outstanding_reviews
end
end
</pre>

'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where a new check was added. This check fetches the number of reviews done by a student currently from ReviewResponseMap table. To adapt to those changes, two new mocks were added to the review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
* To test number of reviews, we added new tests. The code works on size of object returned by querying reviewer_id and reviewed_object_id. To avoid database call, ReviewResponseMap is mocked to return empty list and a list of values. Empty list indicates that student has not done any review and therefore must be allowed. List of values is returned to check if the size of list is greater than allowed number of reviews according to assignment policy.
* To test outstanding number of reviews, we added new tests. The code works on number of reviews completed. If the number of reviews completed are less than assignment's max outstanding reviews, then student must not be allowed new review. To test the functionality we mocked ReviewResponseMap to return an object.
*For one of the test cases we mocked the assignment's max outstanding reviews to be 0, which means without doing even a single review he can request as many reviews as he wants. For the other test case we mocked assignment's max outstanding reviews to be 2 and hence without doing two reviews he can't ask for more. We mocked ReviewResposneMap to have one object.

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes:<br/>
1. Login as instructor.<br/>
2. Go to Manage->Assignments and navigate to assignment name 'test1'. <br/>
3. Click on add participants. This will give a list of all participants. <br/>
4. Now click on any student username in order to impersonate. <br/>
5. Go to test1->other's_work and click on request submission button continuously and wait for the response.<br/>
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

<b>Mentor: Suraj Siddharudh</b>

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

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-11-07T02:34:36Z

Nnparik2: /* Motivation */

==<b>E1956. There is no shortcut to get free review points: Review Assignment Bug</b>==

__TOC__

===About Expertiza===

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

==Introduction==

===Problem Statement===
E1956. There is no shortcut to get free review points: Review Assignment Bug
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

=====Issue 1=====
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
=====Issue 2=====
*There is no check to see if the submission is already assigned to the student.
=====Issue 3=====
*There is no check on the number of outstanding reviews a user can have.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy. Also, there is no check to see if the user has submitted enough number of reviews for that assignment before getting new review.

==Problems in Current Implementation==
===Current Implementation===
<b>Problem 1: No limitation on maximum number of peer reviews.</b>
*There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.

<b>Problem 2: No check on duplicate submissions</b>
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

<b>Problem 3: There is no check on the number of outstanding reviews</b>
*A user can request for submissions even if the current outstanding ones are pending

[[File:Merged.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where a new check was added. This check fetches the number of reviews done by a student currently from ReviewResponseMap table. To adapt to those changes, two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy then a flash notice is sent to the student.
* Also there is a check on the number of outstanding assignment reviews a user can have at a time. The check_outstanding_review keeps a count of the number of reviews in progress as well as the number of reviews currently completed by the user and returns a Boolean value depending upon whether the former is less than the maximum outstanding reviews allowed as per the assignment policy or not. The user can only request for a submission if the check_outstanding_review returns True.

<pre>
def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if is_review_allowed?(assignment, reviewer)
if check_outstanding_reviews?(assignment, reviewer)
# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end
end
end
else
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"
end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

def is_review_allowed?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
assignment.num_reviews_allowed > @review_mappings.size
end

def check_outstanding_reviews?(assignment, reviewer)
@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id, reviewed_object_id: assignment.id)
@num_reviews_total = @review_mappings.size
if @num_reviews_total == 0
true
else
@num_reviews_completed = 0
@review_mappings.each do |map|
@num_reviews_completed += 1 if !map.response.empty? && map.response.last.is_submitted
end
@num_reviews_in_progress = @num_reviews_total - @num_reviews_completed
@num_reviews_in_progress < Assignment.max_outstanding_reviews
end
end

</pre>

==Test Plan==
For users intending to view the deployed Expertiza associated with this assignment, the credentials are below: Instructor Login: username -> instructor6, password -> password
===Testing from UI===
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes:<br/>
1. Login as instructor.<br/>
2. Go to Manage->Assignments and navigate to assignment name 'test1'. <br/>
3. Click on add participants. This will give a list of all participants. <br/>
4. Now click on any student username in order to impersonate. <br/>
5. Go to test1->other's_work and click on request submission button continuously and wait for the response.<br/>
6. It would be noted that the request would never exceed the number of submissions mentioned in the assignment policy.

===Automated Test Cases For Review Limit enforcement===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has done reviews less than assignment policy: <pre>context 'when number of reviews are less than the assignment policy'</pre>
::::1. Assign Review Dynamically.
::::2. Redirect to Student review page.

::2. Student has done reviews more than the assignment policy: <pre>context 'when number of reviews are greater than the assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"]

===Automated Test Cases For Review pending check===

All the test cases have been automated in the review_mapping_controller_spec File

::1. Student has pending reviews less than assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews less than assignment policy'</pre>
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy [default 2 pending reviews at most]: <pre>context 'when user has outstanding reviews greater than assignment policy'</pre>
::::1. Redirect to Student review page.
::::2. Show Flash Error. [flash[:error] = "You cannot do more reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

<b>Mentor: Suraj Siddharudh</b>

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

2.[https://github.com/dhruvil009/expertiza GitHub Project Repository Fork]

3.[http://expertiza.ncsu.edu/ Live Expertiza website]

4.[http://152.46.19.135:8080/ Demo Link]

5.[http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2019_-_E1956._There_is_no_shortcut_to_get_free_review_points:_Review_Assignment_Bug Project documentation wiki]

6.[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-10-29T01:32:30Z

Nnparik2: /* Motivation */

==<b>E1956. There is no shortcut to get free review points: Review Assignment Bug</b>==

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

__TOC__

===About Expertiza===

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

==Introduction==
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

Currently there is no check in the backend that limits the number of reviews a student can be assigned. Students can get more peer reviews than assignment policy.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student.

===Current Implementation===

* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

[[File:Merged.png]]

==New Implementation==

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy than a flash notice is sent to the student.
<pre>

def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id)
if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if @review_mappings.size >= assignment.num_reviews_allowed
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"

else

# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end

end
end
# rescue Exception => e
# flash[:error] = (e.nil?) ? $! : e
# end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

</pre>

====Changes Implemented====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student.
The code in order to assign reviews in a dynamic fashion has been implemented in the review_mappings_controller.rb. The method assign_review_dynamically, checks initially if student has selected a topic for which he wants a review or if the "I don't care" is selected. Based on the selection the method would then select a submission which is
::1. Not assigned previously to given student
::2. Is not his own submission

However, since the code did not have a check for how many reviews already are allocated to given student, one could easily bypass the review limit by sending the same post request again and again.

<b>ReviewResponseMap:</b>
::Creates a mapping from the student to assigned submission for reviewing as soon as assign_review_dynamically assigns a submission to student for review.

We decided to get all the reviews assigned to given student from ReviewResponseMap (where(reviewer_id: reviewer.id)) and then check if the size of the reviews assigned to the given reviewer is more than maximum allocated for the assignment and creates a flash error if the maximum review limit is exceded.

==Testing from UI:==
Use the given link: http://152.46.19.135:8080/

Follow the instructions below to test the implemented changes:
1. Login as instructor.
2. Go to Manage->Assignments and navigate to assignment name 'test1'.
3. Click on add participants. This will give a list of all participants.
4. Now click on any student username in order to impersonate.
5. Next look for 'test1' and go to test1->your_work. Enter a new link for the project (say google.com) and click upload.

==Scope for Future Improvement==
1. Currently there is no check on whether a user has completely submitted the previous two reviews before requesting for additional reviews. So one of the future tasks would be to allow a user to request for a new submission if and only if the previously requested submissions have been completed.

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-10-29T01:10:29Z

Nnparik2:

==<b>E1956. There is no shortcut to get free review points: Review Assignment Bug</b>==

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

__TOC__

===About Expertiza===

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

==Introduction==
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student.

===Current Implementation===

* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

::'''Click this button multiple times without stopping.'''
[[File:Submit_review_button.png]]

::'''Result after multiple clicks'''
[[File:result_1956.png]]

===New Implementation===

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy than a flash notice is sent to the student.
<pre>

def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id)
if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if @review_mappings.size >= assignment.num_reviews_allowed
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"

else

# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end

end
end
# rescue Exception => e
# flash[:error] = (e.nil?) ? $! : e
# end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

</pre>

====Changes Implemented====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student.
The code in order to assign reviews in a dynamic fashion has been implemented in the review_mappings_controller.rb. The method assign_review_dynamically, checks initially if student has selected a topic for which he wants a review or if the "I don't care" is selected. Based on the selection the method would then select a submission which is
::1. Not assigned previously to given student
::2. Is not his own submission

However, since the code did not have a check for how many reviews already are allocated to given student, one could easily bypass the review limit by sending the same post request again and again.

<b>ReviewResponseMap:</b>
::Creates a mapping from the student to assigned submission for reviewing as soon as assign_review_dynamically assigns a submission to student for review.

We decided to get all the reviews assigned to given student from ReviewResponseMap (where(reviewer_id: reviewer.id)) and then check if the size of the reviews assigned to the given reviewer is more than maximum allocated for the assignment and creates a flash error if the maximum review limit is exceded.

==Scope for Future Improvement==
1. Currently there is no check on whether a user has completely submitted the previous two reviews before requesting for additional reviews. So one of the future tasks would be to allow a user to request for a new submission if and only if the previously requested submissions have been completed.

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-10-29T01:09:43Z

Nnparik2:

==<b>E1956. There is no shortcut to get free review points: Review Assignment Bug</b>==

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

__TOC__

===About Expertiza===

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

==Introduction==
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student.

===Current Implementation===

* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

::'''Click this button multiple times without stopping.'''
[[File:Submit_review_button.png]]

::'''Result after multiple clicks'''
[[File:result_1956.png]]

===New Implementation===

===Files modified===
'''review_mapping_controller_spec.rb'''
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
'''review_mapping_controller.rb'''
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy than a flash notice is sent to the student.
<pre>

def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id)
if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if @review_mappings.size >= assignment.num_reviews_allowed
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"

else

# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end

end
end
# rescue Exception => e
# flash[:error] = (e.nil?) ? $! : e
# end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

</pre>

====Changes Implemented====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student.
The code in order to assign reviews in a dynamic fashion has been implemented in the review_mappings_controller.rb. The method assign_review_dynamically, checks initially if student has selected a topic for which he wants a review or if the "I don't care" is selected. Based on the selection the method would then select a submission which is
::1. Not assigned previously to given student
::2. Is not his own submission

However, since the code did not have a check for how many reviews already are allocated to given student, one could easily bypass the review limit by sending the same post request again and again.

<b>ReviewResponseMap:</b>
::Creates a mapping from the student to assigned submission for reviewing as soon as assign_review_dynamically assigns a submission to student for review.

We decided to get all the reviews assigned to given student from ReviewResponseMap (where(reviewer_id: reviewer.id)) and then check if the size of the reviews assigned to the given reviewer is more than maximum allocated for the assignment and creates a flash error if the maximum review limit is exceded.

==Scope for Future Improvement==
1. Currently there is no check on whether a user has completely submitted the previous two reviews before requesting for additional reviews. So one of the future tasks would be to allow a user to request for a new submission if and only if the previously requested submissions have been completed.

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-10-29T01:09:12Z

Nnparik2:

==<b>E1956. There is no shortcut to get free review points: Review Assignment Bug</b>==

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

__TOC__

===About Expertiza===

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

==Introduction==
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student.

===Current Implementation===

* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

::'''Click this button multiple times without stopping.'''
[[File:Submit_review_button.png]]

::'''Result after multiple clicks'''
[[File:result_1956.png]]

===New Implementation===

===Files modified===
* review_mapping_controller_spec.rb
* Change has been done in the implementation of review_mapping_controller.rb where new check was added. This check fetches number of reviews done by the student currently from ReviewResponseMap table. To adapt to those changes two new mocks were added to review_mapping_controller_spec.rb.
* ReviewResponseMap is mocked to return 0. This is the number of reviews that a student has done so far.
* Assignment is mocked to return 1 as number of reviews allowed for the assignment.
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
* review_mapping_controller.rb
* A new check was added to find the number of reviews done by the student. Whenever a student ask for review, a new entry is done in the ReviewResponseMap table in the database.
* The code here checks the number of reviews assigned to the student and then compares it with the maximum number of reviews allowed as per assignment policy. If the student is asking for more reviews than the assignment policy than a flash notice is sent to the student.
<pre>

def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id)
if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if @review_mappings.size >= assignment.num_reviews_allowed
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"

else

# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end

end
end
# rescue Exception => e
# flash[:error] = (e.nil?) ? $! : e
# end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

</pre>

====Changes Implemented====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student.
The code in order to assign reviews in a dynamic fashion has been implemented in the review_mappings_controller.rb. The method assign_review_dynamically, checks initially if student has selected a topic for which he wants a review or if the "I don't care" is selected. Based on the selection the method would then select a submission which is
::1. Not assigned previously to given student
::2. Is not his own submission

However, since the code did not have a check for how many reviews already are allocated to given student, one could easily bypass the review limit by sending the same post request again and again.

<b>ReviewResponseMap:</b>
::Creates a mapping from the student to assigned submission for reviewing as soon as assign_review_dynamically assigns a submission to student for review.

We decided to get all the reviews assigned to given student from ReviewResponseMap (where(reviewer_id: reviewer.id)) and then check if the size of the reviews assigned to the given reviewer is more than maximum allocated for the assignment and creates a flash error if the maximum review limit is exceded.

==Scope for Future Improvement==
1. Currently there is no check on whether a user has completely submitted the previous two reviews before requesting for additional reviews. So one of the future tasks would be to allow a user to request for a new submission if and only if the previously requested submissions have been completed.

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-10-29T00:52:28Z

Nnparik2:

==<b>E1956. There is no shortcut to get free review points: Review Assignment Bug</b>==

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

__TOC__

===About Expertiza===

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

==Introduction==
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student.

===Current Implementation===

* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

::'''Click this button multiple times without stopping.'''
[[File:Submit_review_button.png]]

::'''Result after multiple clicks'''
[[File:result_1956.png]]

===New Implementation===

===Files modified===
* review_mapping_controller_spec.rb
<pre>
context 'when assignment has topics and a topic is selected by reviewer' do
it 'assigns reviewer dynamically and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end

context 'when assignment does not have topics' do
it 'runs another algorithms and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(false)
team1 = double('AssignmentTeam')
team2 = double('AssignmentTeam')
teams = [team1, team2]
allow(assignment).to receive(:candidate_assignment_teams_to_review).with(participant).and_return(teams)
allow(teams).to receive_message_chain(:to_a, :sample).and_return(team2)
allow(assignment).to receive(:assign_reviewer_dynamically_no_topic).with(participant, team2).and_return(true)
allow(ReviewResponseMap).to receive(:reviewer_id).with(1).and_return(0)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(response).to redirect_to '/student_review/list?id=1'
end
end
end

</pre>
* review_mapping_controller.rb
<pre>

def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id)
if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if @review_mappings.size >= assignment.num_reviews_allowed
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"

else

# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end

end
end
# rescue Exception => e
# flash[:error] = (e.nil?) ? $! : e
# end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

</pre>

====Changes Implemented====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student.
The code in order to assign reviews in a dynamic fashion has been implemented in the review_mappings_controller.rb. The method assign_review_dynamically, checks initially if student has selected a topic for which he wants a review or if the "I don't care" is selected. Based on the selection the method would then select a submission which is
::1. Not assigned previously to given student
::2. Is not his own submission

However, since the code did not have a check for how many reviews already are allocated to given student, one could easily bypass the review limit by sending the same post request again and again.

<b>ReviewResponseMap:</b>
::Creates a mapping from the student to assigned submission for reviewing as soon as assign_review_dynamically assigns a submission to student for review.

We decided to get all the reviews assigned to given student from ReviewResponseMap (where(reviewer_id: reviewer.id)) and then check if the size of the reviews assigned to the given reviewer is more than maximum allocated for the assignment and creates a flash error if the maximum review limit is exceded.

==Future Implementation==
Currently there is no check on whether a user has completely submitted the previous two reviews before requesting for additional reviews. So one of the future tasks would be to allow a user to request for a new submission if and only if the previously requested submissions have been completed.

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-10-29T00:33:52Z

Nnparik2:

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-10-29T00:30:30Z

Nnparik2:

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-10-29T00:29:18Z

Nnparik2:

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-10-29T00:28:22Z

Nnparik2:

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-10-29T00:24:05Z

Nnparik2:

==<b>E1956. There is no shortcut to get free review points: Review Assignment Bug</b>==

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

__TOC__

===About Expertiza===

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

==Introduction==
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).

===Current Implementation===

* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

::'''Click this button multiple times without stopping.'''
[[File:Submit_review_button.png]]

::'''Result after multiple clicks'''
[[File:result_1956.png]]

===Files modified===
* review_mapping_controller_spec.rb
<pre>

</pre>
* review_mapping_controller.rb
<pre>

def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else

# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end

end
end
# rescue Exception => e
# flash[:error] = (e.nil?) ? $! : e
# end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

</pre>

===New Implementation===

===Files modified===
* review_mapping_controller_spec.rb
<pre>

</pre>
* review_mapping_controller.rb
<pre>

def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id)
if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if @review_mappings.size >= assignment.num_reviews_allowed
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"

else

# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end

end
end
# rescue Exception => e
# flash[:error] = (e.nil?) ? $! : e
# end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

</pre>

====Changes Implemented====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student. In order to implement this functionality, we created an instance variable 'review_mappings' that contains the reviews done by a particular 'reviewer.id'. The 'if' condition checks whether the number of tuples in 'review_mappings' is less than the number of reviews allowed for that submission. If yes, then the student is allowed to make an additonal review. Otherwise, a flash message would be generated saying that no more submissions are allowed for the current user.

==Future Implementation==
Currently there is no check on whether a user has completely submitted the previous two reviews before requesting for additional reviews. So one of the future tasks would be to allow a user to request for a new submission if and only if the previously requested submissions have been completed.

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-10-29T00:22:06Z

Nnparik2: /* Functionality */

==<b>E1956. There is no shortcut to get free review points: Review Assignment Bug</b>==

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

__TOC__

===About Expertiza===

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

==Introduction==
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).

===Current Implementation===

=====Functionality=====
* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

::'''Click this button multiple times without stopping.'''
[[File:Submit_review_button.png]]

::'''Result after multiple clicks'''
[[File:result_1956.png]]

===Files modified===
* review_mapping_controller_spec.rb
<pre>

</pre>
* review_mapping_controller.rb
<pre>

def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else

# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end

end
end
# rescue Exception => e
# flash[:error] = (e.nil?) ? $! : e
# end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

</pre>

===Current Implementation===

===Files modified===
* review_mapping_controller_spec.rb
<pre>

</pre>
* review_mapping_controller.rb
<pre>

def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id)
if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if @review_mappings.size >= assignment.num_reviews_allowed
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"

else

# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end

end
end
# rescue Exception => e
# flash[:error] = (e.nil?) ? $! : e
# end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

</pre>

====Changes Implemented====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student. In order to implement this functionality, we created an instance variable 'review_mappings' that contains the reviews done by a particular 'reviewer.id'. The 'if' condition checks whether the number of tuples in 'review_mappings' is less than the number of reviews allowed for that submission. If yes, then the student is allowed to make an additonal review. Otherwise, a flash message would be generated saying that no more submissions are allowed for the current user.

==Future Implementation==
Currently there is no check on whether a user has completely submitted the previous two reviews before requesting for additional reviews. So one of the future tasks would be to allow a user to request for a new submission if and only if the previously requested submissions have been completed.

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-10-29T00:21:01Z

Nnparik2: /* Functionality */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

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

__TOC__

===About Expertiza===

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

==Introduction==
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).

===Current Implementation===

=====Functionality=====
* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

::Click this button multiple times without stopping.
[[File:Submit_review_button.png]]

::Result after multiple clicks
[[File:result_1956.png]]

===Files modified===
* review_mapping_controller_spec.rb
<pre>

</pre>
* review_mapping_controller.rb
<pre>

def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else

# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end

end
end
# rescue Exception => e
# flash[:error] = (e.nil?) ? $! : e
# end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

</pre>

===Current Implementation===

===Files modified===
* review_mapping_controller_spec.rb
<pre>

</pre>
* review_mapping_controller.rb
<pre>

def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

'''@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id)'''
if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
'''if @review_mappings.size >= assignment.num_reviews_allowed
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"'''

else

# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end

end
end
# rescue Exception => e
# flash[:error] = (e.nil?) ? $! : e
# end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

</pre>

====Changes Implemented====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student. In order to implement this functionality, we created an instance variable 'review_mappings' that contains the reviews done by a particular 'reviewer.id'. The 'if' condition checks whether the number of tuples in 'review_mappings' is less than the number of reviews allowed for that submission. If yes, then the student is allowed to make an additonal review. Otherwise, a flash message would be generated saying that no more submissions are allowed for the current user.

==Future Implementation==
Currently there is no check on whether a user has completely submitted the previous two reviews before requesting for additional reviews. So one of the future tasks would be to allow a user to request for a new submission if and only if the previously requested submissions have been completed.

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-10-29T00:20:45Z

Nnparik2: /* Functionality */

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

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

__TOC__

===About Expertiza===

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

==Introduction==
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).

===Current Implementation===

=====Functionality=====
* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

* ::Click this button multiple times without stopping.
[[File:Submit_review_button.png]]

* ::Result after multiple clicks
[[File:result_1956.png]]

===Files modified===
* review_mapping_controller_spec.rb
<pre>

</pre>
* review_mapping_controller.rb
<pre>

def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else

# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end

end
end
# rescue Exception => e
# flash[:error] = (e.nil?) ? $! : e
# end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

</pre>

===Current Implementation===

===Files modified===
* review_mapping_controller_spec.rb
<pre>

</pre>
* review_mapping_controller.rb
<pre>

def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

'''@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id)'''
if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
'''if @review_mappings.size >= assignment.num_reviews_allowed
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"'''

else

# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end

end
end
# rescue Exception => e
# flash[:error] = (e.nil?) ? $! : e
# end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

</pre>

====Changes Implemented====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student. In order to implement this functionality, we created an instance variable 'review_mappings' that contains the reviews done by a particular 'reviewer.id'. The 'if' condition checks whether the number of tuples in 'review_mappings' is less than the number of reviews allowed for that submission. If yes, then the student is allowed to make an additonal review. Otherwise, a flash message would be generated saying that no more submissions are allowed for the current user.

==Future Implementation==
Currently there is no check on whether a user has completely submitted the previous two reviews before requesting for additional reviews. So one of the future tasks would be to allow a user to request for a new submission if and only if the previously requested submissions have been completed.

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-10-29T00:20:02Z

Nnparik2:

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

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

__TOC__

===About Expertiza===

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

==Introduction==
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).

===Current Implementation===

=====Functionality=====
* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

* Click this button multiple times without stopping.
[[File:Submit_review_button.png]]

* Result after multiple clicks
[[File:result_1956.png]]

===Files modified===
* review_mapping_controller_spec.rb
<pre>

</pre>
* review_mapping_controller.rb
<pre>

def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else

# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end

end
end
# rescue Exception => e
# flash[:error] = (e.nil?) ? $! : e
# end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

</pre>

===Current Implementation===

===Files modified===
* review_mapping_controller_spec.rb
<pre>

</pre>
* review_mapping_controller.rb
<pre>

def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

'''@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id)'''
if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
'''if @review_mappings.size >= assignment.num_reviews_allowed
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"'''

else

# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end

end
end
# rescue Exception => e
# flash[:error] = (e.nil?) ? $! : e
# end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

</pre>

====Changes Implemented====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student. In order to implement this functionality, we created an instance variable 'review_mappings' that contains the reviews done by a particular 'reviewer.id'. The 'if' condition checks whether the number of tuples in 'review_mappings' is less than the number of reviews allowed for that submission. If yes, then the student is allowed to make an additonal review. Otherwise, a flash message would be generated saying that no more submissions are allowed for the current user.

==Future Implementation==
Currently there is no check on whether a user has completely submitted the previous two reviews before requesting for additional reviews. So one of the future tasks would be to allow a user to request for a new submission if and only if the previously requested submissions have been completed.

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-10-29T00:19:44Z

Nnparik2:

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

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

__TOC__

===About Expertiza===

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

==Introduction==
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).

===Current Implementation===

=====Functionality=====
* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

* Click this button multiple times without stopping.
[[File:Submit_review_button.png]]

* Result after multiple clicks
[[File:result_2956.png]]

===Files modified===
* review_mapping_controller_spec.rb
<pre>

</pre>
* review_mapping_controller.rb
<pre>

def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else

# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end

end
end
# rescue Exception => e
# flash[:error] = (e.nil?) ? $! : e
# end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

</pre>

===Current Implementation===

===Files modified===
* review_mapping_controller_spec.rb
<pre>

</pre>
* review_mapping_controller.rb
<pre>

def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

'''@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id)'''
if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
'''if @review_mappings.size >= assignment.num_reviews_allowed
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"'''

else

# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end

end
end
# rescue Exception => e
# flash[:error] = (e.nil?) ? $! : e
# end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

</pre>

====Changes Implemented====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student. In order to implement this functionality, we created an instance variable 'review_mappings' that contains the reviews done by a particular 'reviewer.id'. The 'if' condition checks whether the number of tuples in 'review_mappings' is less than the number of reviews allowed for that submission. If yes, then the student is allowed to make an additonal review. Otherwise, a flash message would be generated saying that no more submissions are allowed for the current user.

==Future Implementation==
Currently there is no check on whether a user has completely submitted the previous two reviews before requesting for additional reviews. So one of the future tasks would be to allow a user to request for a new submission if and only if the previously requested submissions have been completed.

File:Result 1956.png

2019-10-29T00:18:24Z

Nnparik2:

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-10-29T00:17:43Z

Nnparik2:

'''Bold text'''==E1956. There is no shortcut to get free review points: Review Assignment Bug==

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

__TOC__

===About Expertiza===

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

==Introduction==
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).

===Current Implementation===

=====Functionality=====
* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

* Click this button multiple times without stopping.
[[File:Submit_review_button.png]]

===Files modified===
* review_mapping_controller_spec.rb
<pre>

</pre>
* review_mapping_controller.rb
<pre>

def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else

# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end

end
end
# rescue Exception => e
# flash[:error] = (e.nil?) ? $! : e
# end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

</pre>

===Current Implementation===

===Files modified===
* review_mapping_controller_spec.rb
<pre>

</pre>
* review_mapping_controller.rb
<pre>

def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

'''@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id)'''
if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
'''if @review_mappings.size >= assignment.num_reviews_allowed
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"'''

else

# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end

end
end
# rescue Exception => e
# flash[:error] = (e.nil?) ? $! : e
# end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

</pre>

====Changes Implemented====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student. In order to implement this functionality, we created an instance variable 'review_mappings' that contains the reviews done by a particular 'reviewer.id'. The 'if' condition checks whether the number of tuples in 'review_mappings' is less than the number of reviews allowed for that submission. If yes, then the student is allowed to make an additonal review. Otherwise, a flash message would be generated saying that no more submissions are allowed for the current user.

==Future Implementation==

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-10-29T00:08:34Z

Nnparik2:

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

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

__TOC__

===About Expertiza===

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

==Introduction==
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).

===Current Implementation===

=====Functionality=====
* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.
[[File:Submit_review_button.png]]

===Files modified===
* review_mapping_controller_spec.rb
<pre>

</pre>
* review_mapping_controller.rb
<pre>

def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id)
if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if @review_mappings.size >= assignment.num_reviews_allowed
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"

else

# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end

end
end
# rescue Exception => e
# flash[:error] = (e.nil?) ? $! : e
# end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

</pre>
====Changes Implemented====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student. In order to implement this functionality, we created an instance variable 'review_mappings' that contains the reviews done by a particular 'reviewer.id'. The 'if' condition checks whether the number of tuples in 'review_mappings' is less than the number of reviews allowed for that submission. If yes, then the student is allowed to make an additonal review. Otherwise, a flash message would be generated saying that no more submissions are allowed for the current user.

==Future Implementation==

File:Submit review button.png

2019-10-29T00:05:41Z

Nnparik2:

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-10-29T00:04:48Z

Nnparik2:

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

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

__TOC__

===About Expertiza===

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

==Introduction==
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).

===Current Implementation===

=====Functionality=====
* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.

===Files modified===
* review_mapping_controller_spec.rb
<pre>

</pre>
* review_mapping_controller.rb
<pre>

def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id)
if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if @review_mappings.size >= assignment.num_reviews_allowed
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"

else

# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end

end
end
# rescue Exception => e
# flash[:error] = (e.nil?) ? $! : e
# end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

</pre>
====Changes Implemented====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student. In order to implement this functionality, we created an instance variable 'review_mappings' that contains the reviews done by a particular 'reviewer.id'. The 'if' condition checks whether the number of tuples in 'review_mappings' is less than the number of reviews allowed for that submission. If yes, then the student is allowed to make an additonal review. Otherwise, a flash message would be generated saying that no more submissions are allowed for the current user.

==Future Implementation==

CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug

2019-10-28T23:58:47Z

Nnparik2:

==E1956. There is no shortcut to get free review points: Review Assignment Bug==

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

__TOC__

===About Expertiza===

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

==Introduction==
===Background===
Each assignment contains an assignment policy. We can generally submit n reviews according to assignment policy. For an assignment with topics, a student has an option to choose a submission to review or can say “I don’t care” and the system chooses any available topic for review.

===Motivation===

This project in particular intends that the students collaborate with each other and work on making enhancements to the code base by applying the concepts of Rails,RSpec, DRY code,Test driven development etc. This provides an opportunity for students to contribute to an open source project and learn further about software deployment etc.

==List of Changes==
===Issues Presented===
*The number of reviews done by any student is not checked in the back-end with the maximum number of submissions allowed as per the assignment policy.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).

===Current Implementation===

=====Functionality=====
* No limitation on maximum number of peer reviews.
::There is no check in the backend that limits the number of reviews a student can be assigned. There is a check in the UI, but you could evade the limit by typing in a URL to make the same post request. You can also evade it by clicking multiple times on "Request a review for submission" button in UI.
* There is no check to see if the submission is already assigned to the student (on consulting the TA, it was made known that the feature was working correctly without editing any of the code and thus no refactoring was performed for this task).
* If the same request is re-sent, the system adds the same submission for review a second time.
===Files modified===
* review_mapping_controller_spec.rb
<pre>

</pre>
* review_mapping_controller.rb
<pre>

def assign_reviewer_dynamically
assignment = Assignment.find(params[:assignment_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment.id).first

@review_mappings = ReviewResponseMap.where(reviewer_id: reviewer.id)
if params[:i_dont_care].nil? && params[:topic_id].nil? && assignment.topics? && assignment.can_choose_topic_to_review?
flash[:error] = "No topic is selected. Please go back and select a topic."
else
if @review_mappings.size >= assignment.num_reviews_allowed
flash[:notice] = "You cannot do more than " + assignment.num_reviews_allowed.to_s + " reviews based on assignment policy"

else

# begin
if assignment.topics? # assignment with topics
topic = if params[:topic_id]
SignUpTopic.find(params[:topic_id])
else
assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil
end
if topic.nil?
flash[:error] = "No topics are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically(reviewer, topic)
end

else # assignment without topic -Yang
assignment_teams = assignment.candidate_assignment_teams_to_review(reviewer)
assignment_team = assignment_teams.to_a.sample rescue nil
if assignment_team.nil?
flash[:error] = "No artifacts are available to review at this time. Please try later."
else
assignment.assign_reviewer_dynamically_no_topic(reviewer, assignment_team)
end

end
end
# rescue Exception => e
# flash[:error] = (e.nil?) ? $! : e
# end
end
redirect_to controller: 'student_review', action: 'list', id: reviewer.id
end

</pre>
====Changes Implemented====
* The assign_review_dynamically method was previously not keeping a track of the number of assignments reviewed by a student. In order to implement this functionality, we created an instance variable 'review_mappings' that contains the reviews done by a particular 'reviewer.id'. The 'if' condition checks whether the number of tuples in 'review_mappings' is less than the number of reviews allowed for that submission. If yes, then the student is allowed to make an additonal review. Otherwise, a flash message would be generated saying that no more submissions are allowed for the current user.

==Future Implementation==