Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments

2019-12-10T19:27:31Z

Dshah4: Deleted Special Note.

== ''' Introduction ''' ==
The [http://expertiza.ncsu.edu/ Expertiza] project takes advantage of peer-review among students to allow them to learn from each other. Tracking the time that a student spends on each submitted resources is meaningful to instructors to study and improve the teaching experience. Unfortunately, most peer assessment systems do not manage the content of students’ submission within the systems. They usually allow the authors submit external links to the submission (e.g. GitHub code / deployed application), which makes it difficult for the system to track the time that the reviewers spend on the submissions.

== ''' Project Description ''' ==
CSC/ECE 517 classes have helped us by “tagging” review comments over the past two years. This is important for us, because it is how we get the “labels” that we need to train our machine-learning models to recognize review comments that detect problems, make suggestions, or that are considered helpful by the authors. Our goal is to help reviewers by telling them how helpful their review will be before they submit it.

Tagging a review comment usually means sliding 4 sliders to either side, depending on which of four attributes it has. But can we trust the tags that students assign? In past semesters, our checks have revealed that some students appear not to be paying much attention to the tags they assign: the tags seem to be unrelated to the characteristic they are supposed to rate, or they follow a set pattern, like repeated patterns of one tag yes, then one tag no.
Studies on other kinds of “crowdwork” have shown that the time spent between assigning each label indicates how careful the labeling (“tagging”) has been. We believe that students who tag “too fast” are probably not paying enough attention, and want to set their tags aside to be examined by course staff and researchers..

== ''' Proposed Approach ''' ==
We would like to modify the model reflecting review tagging actions (answer_tag entity), adding new fields to track the time interval between each tagging action, as well as revise the controller to implement this interval tracking functionality. A few things to take into consideration:
A user might not tag reviews in sequence, they may jump through them and only tag the one he or she is interested
When annotator tags 1 rubric of all reviews then move onto the next, their behavior will be much different compared with those who tags 4 rubrics of each review.
Sometimes an annotator could take long breaks to refresh and relax, some even take days off, these irregularities needs to be handled.
A user may slide the slider back and forth for a number of times, then go to the next slider; they may also come back and revise a tag they made, these needs to be treated differently.
The first step would be to examine the literature on measuring the reliability of crowdwork, and determine appropriate measures to apply to review tagging. The next step would be to code these metrics and call them from report_formatter_helper.rb, so that they will be available to the course staff when it grades answer tagging. There should also be a threshold set so that any record in the answer_tags table created by a user with suspect metrics would be marked as unreliable (you can add a field for that to the answer_tags table).

We propose to use `updated_at` in `answer_tags` model for each user to calculate gaps between each tagging action, then use `report_formatter_helper` together with `reports_controller` to generate a separate review view. Filtered gaps would be presented in the form of line-chart, with the `chartjs-ror` gem connecting the `Chart.js` component in front end.

This specific project does not require a design pattern, since it only requires using same type of class in generating same type of objects.

== '''Behavior Diagram for Instructor/TA Diagram ''' ==
[[File: Behaviorv1.png]]
[[File: Answer_tag_data_flow.png]]

== '''Implementation ''' ==
To create a chart within the front end, we went through the list of already installed gems to avoid enrolling complexity to the existing environment. We did find a gem ''chartjs-ror'' and decide to bring out our implementation with the package.

What ''chartjs'' does is it takes a series of parameter and compile them into different kinds of graphs when getting called in front-end, so this project is divided into several components:
=== Preparing ===

* Extracting data
** First we would need to see what data is needed in generating report, we found that:
*** We would need student information to generate report for the specific student
*** We would need Assignment information to generate report for assignment (currently the report button is under each assignment)
*** We would need Review data to see what could be tagged
*** And we would need tagging information to generate time associated with it
* Compiling chart parameters
** This stage requires understanding of the gem, this particular gem takes two piece of information
*** Data, which include the data to be presented on the chart as well as labels associated with axis's
*** Options, which captures everything else, including size of chart and range of data to be displayed
* Calling gem to generate graph

=== Implementation ===

* Data
Data is stored across multiple tables, specifically if we need to gather Assignment, review, tagging, and user data, we would need at least Tag_prompt_deployment and answer_tags table. The report_formatter_helper file (which is in charge of generating reports) calls the assignment_tagging_progress function while generating rows (taggers) within a report, so we added a function within to calculate time intervals of everyone's tagging actions：
<pre>
def assignment_tagging_progress
teams = Team.where(parent_id: self.assignment_id)
questions = Question.where(questionnaire_id: self.questionnaire.id, type: self.question_type)
questions_ids = questions.map(&:id)
user_answer_tagging = []
unless teams.empty? or questions.empty?
teams.each do |team|
if self.assignment.varying_rubrics_by_round?
responses = []
for round in 1..self.assignment.rounds_of_reviews
responses += ReviewResponseMap.get_responses_for_team_round(team, round)
end
else
responses = ResponseMap.get_assessments_for(team)
end
responses_ids = responses.map(&:id)
answers = Answer.where(question_id: questions_ids, response_id: responses_ids)
answers = answers.where("length(comments) > ?", self.answer_length_threshold.to_s) unless self.answer_length_threshold.nil?
answers_ids = answers.map(&:id)
users = TeamsUser.where(team_id: team.id).map(&:user)
users.each do |user|
tags = AnswerTag.where(tag_prompt_deployment_id: self.id, user_id: user.id, answer_id: answers_ids)
tagged_answers_ids = tags.map(&:answer_id)

# E1993 Track_Time_Between_Successive_Tag_Assignments
# Extract time where each tag is generated / modified
tag_updated_times = tags.map(&:updated_at)
# tag_updated_times.sort_by{|time_string| Time.parse(time_string)}.reverse
tag_updated_times.sort_by{|time_string| time_string}.reverse
number_of_updated_time = tag_updated_times.length
tag_update_intervals = []
for i in 1..(number_of_updated_time -1) do
tag_update_intervals.append(tag_updated_times[i] - tag_updated_times[i-1])
end

percentage = answers.count == 0 ? "-" : format("%.1f", tags.count.to_f / answers.count * 100)
not_tagged_answers = answers.where.not(id: tagged_answers_ids)

# E1993 Adding tag_update_intervals as information that should be passed
answer_tagging = VmUserAnswerTagging.new(user, percentage, tags.count, not_tagged_answers.count, answers.count, tag_update_intervals)
user_answer_tagging.append(answer_tagging)
end
end
end
user_answer_tagging
end
end
</pre>

We extracted each student's tagging information of reviews towards a specific assignment, sorted the tagging action in order and calculated intervals between each action, this information is passed back to the report_formatter_helper in a VmUserAnswerTagging data structure, so we added a new field as well as reader and writer within it:

<pre>
class VmUserAnswerTagging
def initialize(user, percentage, no_tagged, no_not_tagged, no_tagable, tag_update_intervals)
@user = user
@percentage = percentage
@no_tagged = no_tagged
@no_not_tagged = no_not_tagged
@no_tagable = no_tagable
# E1993 Adding interval to be passed for graph plotting
@tag_update_intervals = tag_update_intervals
end

attr_accessor :user
attr_accessor :percentage
attr_accessor :no_tagged
attr_accessor :no_not_tagged
attr_accessor :no_tagable
attr_accessor :tag_update_intervals
end
</pre>
While from the front-end, the _answer_tagging_report partial who's in charge of generating report table would call the user_summery_report function within the report_formatter_helper to generate information for each user, we made sure that the interval information is passed to it and correctly evaluated:
Helper:
<pre>
def user_summary_report(line)
if @user_tagging_report[line.user.name].nil?
# E1993 Adding extra filed of interval array into data structure

@user_tagging_report[line.user.name] = VmUserAnswerTagging.new(line.user, line.percentage, line.no_tagged, line.no_not_tagged, line.no_tagable, line.tag_update_intervals)
else
@user_tagging_report[line.user.name].no_tagged += line.no_tagged
@user_tagging_report[line.user.name].no_not_tagged += line.no_not_tagged
@user_tagging_report[line.user.name].no_tagable += line.no_tagable
@user_tagging_report[line.user.name].percentage = calculate_formatted_percentage(line)
@user_tagging_report[line.user.name].tag_update_intervals = line.tag_update_intervals
# E1993 interval array doesn't gets updated by new records in TagPromptDeployment, it's once computed and final (when you generate a new report)
end
end
</pre>
Front end:
<pre>
<% report_lines.each do |report_line| %>
<tr>
<td><%= report_line.user.name(session[:ip]) %></td>
<td><%= report_line.user.fullname(session[:ip]) %></td>
<td><%= report_line.percentage.to_s %>%</td>
<td><%= report_line.no_tagged.to_s %></td>
<td><%= report_line.no_not_tagged.to_s %></td>

<td align='left'>
<%= display_tagging_interval_chart(report_line.tag_update_intervals) %>
</td>

<td><%= report_line.no_tagable %></td>
</tr>
<% end %>
</pre>
* Parameters for the chart gem
The other big component is to generate information for the gem to use
<pre>
def display_tagging_interval_chart(intervals)
# if someone did not do any tagging in 30 seconds, then ignore this interval
threshold = 30
intervals = intervals.select{|v| v < threshold}
if not intervals.empty?
interval_mean = intervals.reduce(:+) / intervals.size.to_f
end
data = {
labels: [*1..intervals.length],
datasets: [
{
backgroundColor: "rgba(255,99,132,0.8)",
data: intervals,
label: "time intervals"
},
if not intervals.empty?
{
data: Array.new(intervals.length, interval_mean),
label: "Mean time spent"
}
end
]
}
options = {
width: "200",
height: "125",
scales: {
yAxes: [{
stacked: false,
ticks: {
beginAtZero: true
}
}],
xAxes: [{
stacked: false
}]
}
}
line_chart data, options
end
</pre>
In this step, we filtered out intervals that are larger than 30 seconds, because as we were testing this function, we found having more than 30 second's interval in the graph would affect the scale of it and making smaller time intervals visually indifferent to viewers. To create a visual effect that is similar across all users, we set the y axis to always start from 0.
Besides the basics, we've also plotted a average time spent on each tag (with abnormalities filtered) to provide additional visual cue for the teaching team.
* Plotting graph
As could be seen in the code block above, we called the function as well as the implementation from the gem in our front end and plotted interval graphs for each student tagger:
<pre>
<%= display_tagging_interval_chart(report_line.tag_update_intervals) %>
</pre>

== '''Proposed Test Plan ''' ==
=== Automated Testing ===
Automated testing is not available for this specific project because:
* To test the review tagging interval one has to
** Create courses
** Create assignment
** Setup assignment dues dates as well as reviews and review tagging rubrics
** Enroll more than 2 students to the assignment
** Let students finish assignment
** Change due date to the past
** Have students review each other's work
** Change review due date to the past
** Have students tag each other's work, with time intervals (pause or sleep between each review comment, having at lease one interval longer than 3 minutes)
** Generate review tagging report
** Generate review tagging time interval line chart

And you cannot verify what's on the line chart with Rspec since it's a image, we wouldn't be able to see if the interval greater than 3 minutes is filtered

Each time this script runs, it would take minutes to test, let along having the intervals, and each time Expertiza runs a system level testing, this script would be included, adding who knows how long to the already too long testing process.

Thus we propose to verify this function in non automated ways

=== Testing ===
[[File:Tagging1993.png]]
As described, we tested this feature in the following sequence:
* As instructor
** Create courses
** Create assignment
** Setup assignment dues dates as well as reviews and review tagging rubrics
** Enroll more than 2 students to the assignment
* As Student
** Finish assignment
* As instructor
** Change due date to the past
* As Student
** Review each other's work
* As instructor
** Change review due date to the past
* As Student
** Have students tag each other's work, with time intervals both over and under 30 seconds
* As instructor
** Generate review tagging report
** Generate review tagging time interval line chart

The result is shown in the graph above, manual testing showed that intervals greater than threshold did get filtered and students without any tagging activities are dropped in graph creation.

=== Note ===
We did try to auto mate this process, but is stopped in the last step while validating the graph created, as the function is wrapped in the gem and cannot be accessed from RSepc:
[[File:1993canvastest.png]]

You may also want to see our testing video [[https://youtu.be/YxR9sitpZcs here]]

We'd also like to suggest a refactor of the code, since some old functions are spread from model to controller to view and parts of it is been run for unnecessary times, too much data is getting passed back and forth including data that shouldn't be given to the view.

== ''' Team Information ''' ==
#Anmol Desai(adesai5@ncsu.edu)
#Dhruvil Shah(dshah4@ncsu.edu)
#Jeel Sukhadia(jsukhad@ncsu.edu
#YunKai "Kai" Xiao(yxia28@ncsu.edu)

Mentor: Yunkai "Kai" Xiao (yxiao28@ncsu.edu) Mohit Jain(mjain6@ncsu.edu)

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://relishapp.com/rspec RSpec Documentation]
#[https://github.com/Galactis/expertiza Team Github]
#[https://youtu.be/YxR9sitpZcs Test video]
#[http://152.46.18.176:8080/ Live system on VCL]

File:Behaviorv1.png

2019-11-15T23:50:45Z

Dshah4:

CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments

2019-11-15T23:49:58Z

Dshah4:

CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments

2019-11-15T23:45:45Z

Dshah4: /* UML Diagram */

CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments

2019-11-15T23:24:37Z

Dshah4: /* Flow Chart */

CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments

2019-11-10T18:11:23Z

Dshah4:

CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments

2019-11-10T18:10:45Z

Dshah4: /* Proposed Approach */

File:Flowv1.png

2019-11-10T18:09:08Z

Dshah4: Flowchartv1

Flowchartv1

CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments

2019-11-10T17:12:35Z

Dshah4:

CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments

2019-11-10T17:03:56Z

Dshah4: /* Team Information */

CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments

2019-11-10T17:02:04Z

Dshah4:

CSC/ECE 517 Fall 2019

2019-11-10T16:59:03Z

Dshah4:

* [[CSC/ECE 517 Fall 2019 - Project E1947. Refactor quiz_questionnaire_controller.rb]]
* [[CSC/ECE 517 Fall 2019 - Project E1965. Review report should link to the usual view for reviews]]
* [[CSC/ECE 517 Fall 2019 - Project E1943. Refactor sign up sheet controller.rb]]
* [[CSC/ECE 517 Fall 2019 - E1972. OSS project J. Skellington: Accessing Assignment Rubrics]]
* [[CSC/ECE 517 Fall 2019 - E1961. Email notification to reviewers and instructors]]
* [[CSC/ECE 517 Fall 2019 - E1971. OSS project Finklestein: Instructors & Institutions]]
* [[CSC/ECE 517 Fall 2019 - E1953. Tagging report for student]]
* [[CSC/ECE 517 Fall 2019 - E1955.Write unit tests for student_task.rb]]
* [[CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names]]
* [[CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management]]
* [[CSC/ECE 517 Fall 2019 - E1948. Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Fall 2019 - E1959. Intelligent copying of assignments without topics]]
* [[CSC/ECE 517 Fall 2019 - E1968. Fixes for adding members to teams]]
* [[CSC/ECE 517 Fall 2019 - E1969. Fixes for reviews not being available]]
* [[CSC/ECE 517 Fall 2019 - E1951. Remove multiple topics at a time]]
* [[CSC/ECE 517 Fall 2019 - E1957. Time travel Not Allowed..!!! Restrict TAs’ ability to change their own grade + limit file-size upload]]
* [[CSC/ECE 517 Fall 2019 - E1963. Changing assignment participant role]]
* [[CSC/ECE 517 Fall 2019 - E1941. Issues related to topic deadlines]]
* [[CSC/ECE 517 Fall 2019 - E1966. Tabbed_reviews partial file refactor for displaying the alternate view of reviews]]
* [[CSC/ECE 517 Fall 2019 - E1962. Email notification upon account creation]]
* [[CSC/ECE 517 Fall 2019 - E1967. Fix glitches in author feedback]]
* [[CSC/ECE 517 Fall 2019 - E1960. Create new late policy successfully and fixing "Back" link]]
* [[CSC/ECE 517 Fall 2019 - E1939. OSS Project Juniper: Bookmark enhancements]]
* [[CSC/ECE 517 Fall 2019 - M1950. Support Asynchronous Web Assembly Compilation]]
* [[CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches]]
* [[CSC/ECE 517 Fall 2019 - M1951. Implement missing OffscreenCanvas APIs]]
* [[CSC/ECE 517 Fall 2019 - E1940. Improving email notification]]
* [[CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug]]
* [[CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb]]
* [[CSC/ECE 517 Fall 2019 - M1952. Missing DOM features project]]
* [[CSC/ECE 517 Fall 2019 - E1945. Refactor users_controller.rb]]
* [[CSC/ECE 517 Fall 2019 - E1964. Export review scores for projects]]
* [[CSC/ECE 517 Fall 2019 - E1949. Write Unit Tests for Importing assignment participants and import glitches]]
* [[CSC/ECE 517 Fall 2019 - E1944. Refactor review mapping controller]]
* [[CSC/ECE 517 Fall 2019 - E1946. Refactor Questionnaire controller]]
* [[CSC/ECE 517 Fall 2019 - E1982. Regulate changing of rubrics while projects are in progress]]
* [[CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions]]
* [[CSC/ECE 517 Fall 2019 - E1990. Integrate suggestion detection algorithm]]
* [[CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality]]
* [[CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments]]
* [[CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view]]
* [[CSC/ECE 517 Fall 2019 - E1995. Weights in grade calculation]]

CSC/ECE 517 Fall 2019

2019-11-10T16:56:35Z

Dshah4:

* [[CSC/ECE 517 Fall 2019 - Project E1947. Refactor quiz_questionnaire_controller.rb]]
* [[CSC/ECE 517 Fall 2019 - Project E1965. Review report should link to the usual view for reviews]]
* [[CSC/ECE 517 Fall 2019 - Project E1943. Refactor sign up sheet controller.rb]]
* [[CSC/ECE 517 Fall 2019 - E1972. OSS project J. Skellington: Accessing Assignment Rubrics]]
* [[CSC/ECE 517 Fall 2019 - E1961. Email notification to reviewers and instructors]]
* [[CSC/ECE 517 Fall 2019 - E1971. OSS project Finklestein: Instructors & Institutions]]
* [[CSC/ECE 517 Fall 2019 - E1953. Tagging report for student]]
* [[CSC/ECE 517 Fall 2019 - E1955.Write unit tests for student_task.rb]]
* [[CSC/ECE 517 Fall 2019 - E1954. Auto-generate submission directory names based on assignment names]]
* [[CSC/ECE 517 Fall 2019 - E1958. Two issues related to assignment management]]
* [[CSC/ECE 517 Fall 2019 - E1948. Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Fall 2019 - E1959. Intelligent copying of assignments without topics]]
* [[CSC/ECE 517 Fall 2019 - E1968. Fixes for adding members to teams]]
* [[CSC/ECE 517 Fall 2019 - E1969. Fixes for reviews not being available]]
* [[CSC/ECE 517 Fall 2019 - E1951. Remove multiple topics at a time]]
* [[CSC/ECE 517 Fall 2019 - E1957. Time travel Not Allowed..!!! Restrict TAs’ ability to change their own grade + limit file-size upload]]
* [[CSC/ECE 517 Fall 2019 - E1963. Changing assignment participant role]]
* [[CSC/ECE 517 Fall 2019 - E1941. Issues related to topic deadlines]]
* [[CSC/ECE 517 Fall 2019 - E1966. Tabbed_reviews partial file refactor for displaying the alternate view of reviews]]
* [[CSC/ECE 517 Fall 2019 - E1962. Email notification upon account creation]]
* [[CSC/ECE 517 Fall 2019 - E1967. Fix glitches in author feedback]]
* [[CSC/ECE 517 Fall 2019 - E1960. Create new late policy successfully and fixing "Back" link]]
* [[CSC/ECE 517 Fall 2019 - E1939. OSS Project Juniper: Bookmark enhancements]]
* [[CSC/ECE 517 Fall 2019 - M1950. Support Asynchronous Web Assembly Compilation]]
* [[CSC/ECE 517 Fall 2019 - E1938. OSS project Duke Blue: Fix import glitches]]
* [[CSC/ECE 517 Fall 2019 - M1951. Implement missing OffscreenCanvas APIs]]
* [[CSC/ECE 517 Fall 2019 - E1940. Improving email notification]]
* [[CSC/ECE 517 Fall 2019 - E1956. There is no shortcut to get free review points: Review Assignment Bug]]
* [[CSC/ECE 517 Fall 2019 - E1942. Refactor stage deadlines in assignment.rb]]
* [[CSC/ECE 517 Fall 2019 - M1952. Missing DOM features project]]
* [[CSC/ECE 517 Fall 2019 - E1945. Refactor users_controller.rb]]
* [[CSC/ECE 517 Fall 2019 - E1964. Export review scores for projects]]
* [[CSC/ECE 517 Fall 2019 - E1949. Write Unit Tests for Importing assignment participants and import glitches]]
* [[CSC/ECE 517 Fall 2019 - E1944. Refactor review mapping controller]]
* [[CSC/ECE 517 Fall 2019 - E1946. Refactor Questionnaire controller]]
* [[CSC/ECE 517 Fall 2019 - E1982. Regulate changing of rubrics while projects are in progress]]
* [[CSC/ECE 517 Fall 2019 - E1989. Track the time students look at other submissions]]
* [[CSC/ECE 517 Fall 2019 - E1990. Integrate suggestion detection algorithm]]
* [[CSC/ECE 517 Fall 2019 - E1995. Tests for email functionality]]
* [[CSC/ECE 517 Fall 2019 - E1979. Completion/Progress view]]
* [[CSC/ECE 517 Fall 2019 - E1995. Weights in grade calculation]]
* [[CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments]]

CSC/ECE 517 Fall 2019 - E1993 Track Time Between Successive Tag Assignments

2019-11-10T16:55:12Z

Dshah4: Created page with "Hello"

Hello

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

2019-11-07T03:50:42Z

Dshah4: /* Current Implementation */

File:Pro.png

2019-11-07T03:50:10Z

Dshah4:

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

2019-11-07T03:21:55Z

Dshah4: /* Current Implementation */

File:Process zoom.png

2019-11-07T03:21:46Z

Dshah4:

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

2019-11-07T03:14:31Z

Dshah4: /* Files modified */

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

2019-11-07T03:13:18Z

Dshah4: /* Files modified */

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

__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 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==
Problem 1: No limitation on the maximum number of peer reviews.
*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.

Problem 2: No check on duplicate submissions
* 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.

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

[[File:Process resize.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.
<pre>
context 'when assignment has topics and no topic is selected by reviewer' do
it 'shows an error message and redirects to student_review#list page' do
allow(assignment).to receive(:topics?).and_return(true)
allow(assignment).to receive(:can_choose_topic_to_review?).and_return(true)
params = {
assignment_id: 1,
reviewer_id: 1
}
post :assign_reviewer_dynamically, params
expect(flash[:error]).to eq('No topic is selected. Please go back and select a topic.')
expect(response).to redirect_to '/student_review/list?id=1'
end
end

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

context 'when number of reviews are less than the assignment policy' do
it 'redirects to student review page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(ReviewResponseMap).to receive(:where).with(reviewer_id: 1, reviewed_object_id: 1 )
.and_return([])
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
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 number of reviews are greater than the assignment policy' do
it 'shows a flash error and redirects to student review page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(ReviewResponseMap).to receive(:where).with(reviewer_id: 1, reviewed_object_id: 1 )
.and_return([1,2,3])
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
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'
expect(flash[:error]).to be_present
end
end

context 'when user has outstanding reviews less than assignment policy' do
it 'redirects to student review page' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(ReviewResponseMap).to receive(:where).with(reviewer_id: 1, reviewed_object_id: 1 )
.and_return(:review_response_map)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
allow(assignment).to receive(:max_outstanding_reviews).and_return(0)

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 user has outstanding reviews greater than assignment policy' do
it 'redirects to student review page and shows flash error' do
allow(assignment).to receive(:topics?).and_return(true)
topic = double('SignUpTopic')
allow(SignUpTopic).to receive(:find).with('1').and_return(topic)
allow(ReviewResponseMap).to receive(:where).with(reviewer_id: 1, reviewed_object_id: 1 )
.and_return(:review_response_map)
allow(assignment).to receive(:assign_reviewer_dynamically).with(participant, topic).and_return(true)
allow(assignment).to receive(:num_reviews_allowed).and_return(1)
allow(assignment).to receive(:max_outstanding_reviews).and_return(3)

params = {
assignment_id: 1,
reviewer_id: 1,
topic_id: 1
}
post :assign_reviewer_dynamically, params
expect(flash[:error]).to be_present
expect(response).to redirect_to '/student_review/list?id=1'
end
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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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

Mentor: Suraj Siddharudh

==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-07T03:08:44Z

Dshah4: /* Current Implementation */

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

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

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on the maximum number of peer reviews.
*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.

Problem 2: No check on duplicate submissions
* 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.

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

[[File:Process resize.png]]
[[File:Issue.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* The code here 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 a flash notice is sent to the student.
<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>
* 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 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.
<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>

==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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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

Mentor: Suraj Siddharudh

==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-07T03:08:21Z

Dshah4: /* Current Implementation */

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

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

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on the maximum number of peer reviews.
*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.

Problem 2: No check on duplicate submissions
* 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.

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

[[File:Process resize.png]][[File:Issue.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* The code here 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 a flash notice is sent to the student.
<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>
* 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 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.
<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>

==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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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

Mentor: Suraj Siddharudh

==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-07T03:07:58Z

Dshah4: /* Current Implementation */

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

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

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on the maximum number of peer reviews.
*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.

Problem 2: No check on duplicate submissions
* 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.

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

[[File:Process resize.png|frame]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* The code here 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 a flash notice is sent to the student.
<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>
* 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 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.
<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>

==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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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

Mentor: Suraj Siddharudh

==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-07T03:07:38Z

Dshah4: /* Current Implementation */

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

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

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on the maximum number of peer reviews.
*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.

Problem 2: No check on duplicate submissions
* 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.

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

[[File:Process resize.png|frame]][[File:Issue.png|frame]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* The code here 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 a flash notice is sent to the student.
<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>
* 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 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.
<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>

==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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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

Mentor: Suraj Siddharudh

==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-07T03:06:19Z

Dshah4: /* Current Implementation */

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

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

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on the maximum number of peer reviews.
*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.

Problem 2: No check on duplicate submissions
* 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.

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

<div style="display: inline; float: left;">
[[File:Process resize.png|frame]][[File:Issue.png|frame]]
</div>

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* The code here 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 a flash notice is sent to the student.
<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>
* 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 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.
<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>

==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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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

Mentor: Suraj Siddharudh

==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-07T03:05:41Z

Dshah4: /* Problems in Current Implementation */

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

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

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on the maximum number of peer reviews.
*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.

Problem 2: No check on duplicate submissions
* 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.

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

<div style="display: inline; float: left;">
[[File:Process resize.png|frame|center]][[File:Issue.png|frame|center]]
</div>

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* The code here 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 a flash notice is sent to the student.
<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>
* 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 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.
<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>

==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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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

Mentor: Suraj Siddharudh

==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-07T03:05:21Z

Dshah4: /* Problems in Current Implementation */

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

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

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on the maximum number of peer reviews.
*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.

Problem 2: No check on duplicate submissions
* 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.

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

<div style="display: inline; float: left;">
[[File:Process resize.png|frame|left]][[File:Issue.png|frame|left]]
</div>

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* The code here 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 a flash notice is sent to the student.
<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>
* 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 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.
<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>

==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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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

Mentor: Suraj Siddharudh

==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-07T03:01:14Z

Dshah4: /* Problems in Current Implementation */

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

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

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on the maximum number of peer reviews.
*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.

Problem 2: No check on duplicate submissions
* 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.

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

[[File:Process resize.png|frame|left|Main page]]
[[File:Issue.png|frame|right|Current Implementation Issue]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* The code here 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 a flash notice is sent to the student.
<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>
* 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 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.
<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>

==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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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

Mentor: Suraj Siddharudh

==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-07T03:00:17Z

Dshah4: /* Current Implementation */

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

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

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on the maximum number of peer reviews.
*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.

Problem 2: No check on duplicate submissions
* 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.

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

[[File:Issue.png|frame|left|Current Implementation Issue]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* The code here 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 a flash notice is sent to the student.
<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>
* 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 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.
<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>

==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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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

Mentor: Suraj Siddharudh

==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:59:55Z

Dshah4: /* Current Implementation */

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

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

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on the maximum number of peer reviews.
*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.

Problem 2: No check on duplicate submissions
* 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.

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

[[File:Issue.png|frame|centre|Current Implementation Issue]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* 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.
<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>
* 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 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.
<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>

==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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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

Mentor: Suraj Siddharudh

==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:56:49Z

Dshah4: /* Problems in Current Implementation */

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

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

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on the 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.

Problem 2: No check on duplicate submissions
* 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.

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

[[File:Issue.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* 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.
<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>
* 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 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.
<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>

==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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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

Mentor: Suraj Siddharudh

==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:56:23Z

Dshah4: /* Problems in Current Implementation */

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

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

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on the 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.

Problem 2: No check on duplicate submissions
* 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.

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

[[File:Process resize.png]][[File:Issue.png]]

==Proposed Implementation==

===Files modified===
'''review_mapping_controller.rb'''
* 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.
<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>
* 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 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.
<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>

==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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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

Mentor: Suraj Siddharudh

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

File:Process resize.png

2019-11-07T02:54:49Z

Dshah4:

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

2019-11-07T02:48:32Z

Dshah4: Grammar Check

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

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

==Problems in Current Implementation==
===Current Implementation===
Problem 1: No limitation on the 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.

Problem 2: No check on duplicate submissions
* 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.

Problem 3: There is no check on the number of outstanding reviews
*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 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.
<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'''
* 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.
<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>
* 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 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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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

Mentor: Suraj Siddharudh

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

File:Issue.png

2019-11-07T02:38:43Z

Dshah4:

File:Process.png

2019-11-07T02:38:24Z

Dshah4:

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

2019-11-07T02:29:51Z

Dshah4: /* Background */

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

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

==Problems in Current Implementation==
===Current Implementation===
Problem 1: 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.

Problem 2: No check on duplicate submissions
* 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.

Problem 3: There is no check on the number of outstanding reviews
*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 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 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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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

Mentor: Suraj Siddharudh

==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:29:05Z

Dshah4: /* Introduction */

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

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

==Problems in Current Implementation==
===Current Implementation===
Problem 1: 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.

Problem 2: No check on duplicate submissions
* 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.

Problem 3: There is no check on the number of outstanding reviews
*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 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 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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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

Mentor: Suraj Siddharudh

==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:26:14Z

Dshah4: /* Introduction */

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

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

==Problems in Current Implementation==
===Current Implementation===
Problem 1: 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.

Problem 2: No check on duplicate submissions
* 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.

Problem 3: There is no check on the number of outstanding reviews
*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 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 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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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

Mentor: Suraj Siddharudh

==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:04:59Z

Dshah4: /* Automated Test Cases For Review Limit enforcement */

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

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

==List of Changes==
===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.
* There is no check on the number of outstanding reviews that a user can have at any time.

[[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 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 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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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

Mentor: Suraj Siddharudh

==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:04:32Z

Dshah4: /* Automated Test Cases For Review pending check */

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

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

==List of Changes==
===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.
* There is no check on the number of outstanding reviews that a user can have at any time.

[[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 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 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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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 reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

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

Mentor: Suraj Siddharudh

==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:03:58Z

Dshah4: /* Automated Test Cases For Review Limit enforcement */

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

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

====Proposed Changes====
* 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 a student has selected a topic for which he wants a review or if the "I don't care" option 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 a given student, one could easily bypass the review limit by sending the same post request again and again.
* The assign_review_dynamically method also does not keep a check on the number of outstanding submissions that a student can have at any time. The code for the same has been implemented in the review_mappings_controller.rb where the user would be allowed to request for a new submission depending on the value returned by the check_outstanding_reviews method.

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

==List of Changes==
===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.
* There is no check on the number of outstanding reviews that a user can have at any time.

[[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 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 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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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 reviews when you have "+ assignment.max_outstanding_reviews + "reviews to do"]

===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. Assign Review Dynamically
::::2. Redirect to Student review page

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==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:02:12Z

Dshah4: /* Automated Test Cases For Review pending check */

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

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

====Proposed Changes====
* 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 a student has selected a topic for which he wants a review or if the "I don't care" option 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 a given student, one could easily bypass the review limit by sending the same post request again and again.
* The assign_review_dynamically method also does not keep a check on the number of outstanding submissions that a student can have at any time. The code for the same has been implemented in the review_mappings_controller.rb where the user would be allowed to request for a new submission depending on the value returned by the check_outstanding_reviews method.

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

==List of Changes==
===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.
* There is no check on the number of outstanding reviews that a user can have at any time.

[[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 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 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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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. Assign Review Dynamically
::::2. Redirect to Student review page

===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. Assign Review Dynamically
::::2. Redirect to Student review page

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==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:00:27Z

Dshah4: /* Automated Test Cases For Review Limit enforcement */

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

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

====Proposed Changes====
* 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 a student has selected a topic for which he wants a review or if the "I don't care" option 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 a given student, one could easily bypass the review limit by sending the same post request again and again.
* The assign_review_dynamically method also does not keep a check on the number of outstanding submissions that a student can have at any time. The code for the same has been implemented in the review_mappings_controller.rb where the user would be allowed to request for a new submission depending on the value returned by the check_outstanding_reviews method.

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

==List of Changes==
===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.
* There is no check on the number of outstanding reviews that a user can have at any time.

[[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 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 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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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. Assign Review Dynamically
::::2. Redirect to Student review page

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

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==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-07T01:58:00Z

Dshah4: /* Automated Test Cases For Review Limit enforcement */

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

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

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

====Proposed Changes====
* 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 a student has selected a topic for which he wants a review or if the "I don't care" option 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 a given student, one could easily bypass the review limit by sending the same post request again and again.
* The assign_review_dynamically method also does not keep a check on the number of outstanding submissions that a student can have at any time. The code for the same has been implemented in the review_mappings_controller.rb where the user would be allowed to request for a new submission depending on the value returned by the check_outstanding_reviews method.

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

==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.
* There is no check on the number of outstanding reviews a user can have.

===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.
* There is no check on the number of outstanding reviews that a user can have at any time.

[[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 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 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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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===

::1. Student has done reviews less than assignment policy:
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::2. Student has done reviews more than the assignment policy:
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

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

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==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-07T01:57:46Z

Dshah4: /* Automated Test Cases For Review Limit enforcement */

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

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

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

====Proposed Changes====
* 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 a student has selected a topic for which he wants a review or if the "I don't care" option 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 a given student, one could easily bypass the review limit by sending the same post request again and again.
* The assign_review_dynamically method also does not keep a check on the number of outstanding submissions that a student can have at any time. The code for the same has been implemented in the review_mappings_controller.rb where the user would be allowed to request for a new submission depending on the value returned by the check_outstanding_reviews method.

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

==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.
* There is no check on the number of outstanding reviews a user can have.

===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.
* There is no check on the number of outstanding reviews that a user can have at any time.

[[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 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 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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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===

::1. Student has done reviews less than assignment policy:
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

::1. Student has done reviews more than the assignment policy:
::::1. Assign Review Dynamically
::::2. Redirect to Student review page

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

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==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-07T01:38:57Z

Dshah4: /* Code Coverage */

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

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

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

====Proposed Changes====
* 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" option 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 a given student, one could easily bypass the review limit by sending the same post request again and again.

ReviewResponseMap:
::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 the maximum value allocated for the assignment and creates a flash error if the maximum review limit is exceded.

==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.
* There is no check on the number of outstanding reviews that a user can have at any time.

[[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 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 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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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===

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

==Code Coverage==
22.581%

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==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-07T00:43:50Z

Dshah4: /* Team Information */

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

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.

====Proposed Changes====
* 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" option 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 a given student, one could easily bypass the review limit by sending the same post request again and again.

ReviewResponseMap:
::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 the maximum value allocated for the assignment and creates a flash error if the maximum review limit is exceded.

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

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

==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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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===

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

==Code Coverage==

==Team Information==
Dhruvil Shah

Neel Parikh

Steve Menezes

Mentor: Suraj Siddharudh

==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-07T00:43:14Z

Dshah4:

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

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.

====Proposed Changes====
* 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" option 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 a given student, one could easily bypass the review limit by sending the same post request again and again.

ReviewResponseMap:
::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 the maximum value allocated for the assignment and creates a flash error if the maximum review limit is exceded.

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

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

==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: 
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. Go to test1->other's_work and click on request submission button continuously and wait for the response. 
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===

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

==Code Coverage==

==Team Information==
Dhruvil Shah
Neel Parikh
Steve Menezes
Mentor: Suraj Siddharudh

==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-06T20:50:27Z

Dshah4: Restructured. Added Automated testing section.