Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-12-16T18:21:13Z

Smuvval: /* Issue3 */

== '''Overview of Project''' ==

In Expertiza, meta-review is a feature that enables a third party to evaluate the quality of feedback that a reviewer gives a reviewee. meta-review is an important feature that can help students become better reviewers for their peers by providing detailed feedback that is actionable and positively formulated. Unfortunately, this feature is broken and the following issues were identified.

== '''Design Pattern''' ==
Design patterns are not applicable as our task involved just modification of existing methods.

== '''Issue1 - Cannot begin/view/edit a meta-review''' ==

===Issue Description===
When a user requests a new meta-review, (s)he should be able to click on the Begin button, which should redirect him/her to the meta-review questionnaire and when the user returns back (to the page where he can view the reviews and meta-reviews, by clicking on Others’ work in his/her assignment), (s)he should be then able to see view and update links for the meta-reviews (s)he has performed.

But the issue is Begin and Edit are not working for the given scenario.

===Existing Issue===
1. Log in as instructor6, click on Manage...-> Assignments

2. Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox

3. Select "Yes" for all of the following: Submission allowed, Review allowed and Meta-review allowed in all of the deadline types

4. Navigate back to Assignment Tree View and click on "Add participant"

5. Add couple of students(say student1 and student2) to the assignment

6. Impersonate/login as student1 and make a submission

7. Impersonate/login as student2 and Request for a new review under others work, submit the review

8. Impersonate/login back as student1 and Request for a new meta review

9. When Begin is clicked following will be displayed. Instead of this, the meta review page must be displayed. 

[[File:Expertiza project3 Issue1 E1997.png]]

10. A template must be added to fix the broken link

== '''Issue2 - Count of number of meta-reviews left not reducing''' ==

===Issue Description===
The number of meta-reviews(refer to the snapshot below),should decrease when a user requests a meta-review.Also, the button to request a new meta-review should not disappear until the total number of reviews assigned has reached the allowed limit.

===Existing Issue===
<li>Log in as instructor6, click on mange...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked, the meta-review count should be decremented. Currently, as clicking the begin button is not working, we are not sure if the counter is being decremented properly.

== '''Design strategy For Issue1 and Issue 2''' ==

The flow chart below describes the design we choose to implement the above two issues

[[File:E1997_1.PNG]]

===Solution and Code Modification for Issue 1 and 2===

==== Modification 1 ====
Basically, the file named 'response.html.erb'(Exact navigation: https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/response.html.erb) is looking for a partial named 'review'

The code that expects partial is:
<%= render :partial => 'review', :locals => {:versions => @responses_versions} %>

We have created partial named _review.html.erb at https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/_review.html.erb
It is a simple partial with code as follows:

<% versions.each do |response| %>
<% rm = ResponseMap.find(response.map_id) %>
<% as = Assignment.find(rm.reviewed_object_id) %>
<% questionnaire = rm.questionnaire %>
<%= response.display_as_html() %>
<% end %>

==== Modification 2 ====
The response_controller.rb(controller that works in tandem with response.html.erb view, which was expecting partial) required a minute fix, which is,
- The existing code doesn't work if AssignmentTeam is found to be nil. Please check the below existing code:

if @response.nil? || AssignmentTeam.find(@map.reviewee_id).most_recent_submission.updated_at > @response.updated_at
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

The response is created(by Response.create) only if the 'if' condition is satisfied. The AssignmentTeam.find(@map.reviewee_id) shall return a nil(for metareviews), hence AssignmentTeam.find(@map.reviewee_id).most_recent_submission will throw an exception.

The problem is, assignment team will be nil for meta reviews. Hence, existing code won't work.

To cover this special nil case, we have modified the code as:

begin
assignment_team = AssignmentTeam.find(@map.reviewee_id)
rescue ActiveRecord::RecordNotFound => e
assignment_team = nil
end
if @response.nil? || (!assignment_team.nil? && assignment_team.most_recent_submission.updated_at > @response.updated_at)
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

==== Modification 3 ====
There's this issue of user being able to request and review more than allowed 'x' number of reviews. After user performed max allowed 'x' number of reviews, the button 'Request a new metareview to perform' shouldn't be visible. To handle this, following code change is made in file (https://github.com/VishnusRepo/expertiza/blob/master/app/views/student_review/list.html.erb)

<% if @assignment.num_metareviews_allowed - @num_metareviews_completed <= 0 %>
Note: You can not do more than <%=@assignment.num_metareviews_allowed%> metareviews according to assignment policy.
<% elsif @num_metareviews_in_progress == 0 %>
<%= render :partial => 'set_dynamic_metareview', :locals => {:assignment => @assignment} %>
<% end %>

The code in elsif block shows the button using which user can request more metareviews. By modifying the code as above, we shall not render the partial set_dynamic_metareview, which contains the request button.

By changing the code to above, we were able to handle the exceptions.

Both the Issues 1 and 2 are now solved. For the test setup we performed, following screenshot shows that we were able to do metareviews(Issue 1 done) and count of metareviews remaining is being reduced(Issue 2 done).

[[File:issue12.png]]

== '''Issue3 - View/Hide meta-review fields based on enabled/disabled status''' ==
===Background:===
An instructor can edit an assignment and can choose whether to have metareview in it or not. He can do so by following the below steps:

1) From Manage>Assignments, click on the Edit Assignment button for the appropriate assignment.

2) On the Due Date tab, the instructor can select if (s)he wants to have meta-reviews done for the assignment, by clicking on the “Use meta-review deadline” checkbox and setting a meta-review deadline below.

3) Under the “Review Strategy” tab of edit assignment, the instructor can set Allowed and Required number of meta-reviews per reviewer by checking the Has meta-review Limit? checkbox.

===Issue Description===
For an assignment, when 'Use Metareview Deadline' is unchecked, it means meta-reviews are not enabled for that assignment. The checkbox is as below

[[File:issue3_1.png]]

As said, when this box is unchecked, it means there is no meta reviewing system for this assignment. The issue is, there are some meta review related fields that show up even if the above box is unchecked. Like in below image

[[File:issue3_2.png]]

Also, when a new issue is created, the default # of meta-reviews allowed and required should be null. As soon as someone checks the Has meta-review Limit box on the “Review Strategy” tab, the UI should fill in 3 and 3 as the required and allowed number. Of course, the user can change this number before submitting it.

===Solution and Code Modification for Issue 3===

As the checkbox and the content to be displayed on clicking the checkbox are located on different pages we cannot use the regular checkbox logic, so we used the concept of local storage and event listener.

we have made changes to the below two files:

1)/expertiza/app/views/assignments/edit/_due_dates.html.erb

2)/expertiza/app/views/assignments/edit/_review_strategy.html.erb

In the _due_dates.html.erb file:

There is an existing code where on clicking the checkbox 'Use metareview deadline', a function called 'removeOrAddMetareview()' is invoked. The code snippet below shows the existing code:

[[File:Metareview1.PNG]]

The 'removeOrAddMetareview()' is called on click of the 'Use metareview deadline' checkbox. Now we implemented two new functions which are invoked inside this function they are 'hideMetaReviewLimit()' and 'showMetaReviewLimit()'. This can be seen in the below code snippet

[[File:Metareview2.PNG]]

Now on clicking the 'Use metareview deadline' checkbox, the new code will invoke the 'removeOrAddMetareview()' function which indirectly invokes the two new functions.
Now let us look at the implementation of the two new functions, we used a local storage variable called 'meta'.So based on the status of the checkbox a value is assigned to the local storage variable. For example, if the 'Use metareview deadline' checkbox is checked then the local storage variable is initialized with the value 'show' and if the 'Use metareview deadline' checkbox is Unchecked we assign with the value 'hide' to the local storage variable. Now after storing the respective values for the local storage variable, the storage event is triggered by these functions. The below code snippet shows the implementation of the two new functions:

[[File:Metareview3.PNG]]

In _review_strategy.html.erb file:

Small modifications have been made to the existing code that is the display of the table row with id 'meta' is given 'none' by default and also the status of the 'Has Meta-review Limit?' checkbox is changed to false. The below code snippet shows the modifications made:

[[File:Metareview5.PNG]]

we wrote a javascript code that handles the event triggered when the 'Use metareview deadline' checkbox has been checked or unchecked. In this javascript, the event triggered is handled by calling the 'onStorageEvent(storageEvent)' function. In this 'onStorageEvent' function we check the value in the local storage variable and based on that value we change the status of the display for the table row with id 'meta'.

[[File:Metareview4.PNG]]

Finally, the null value to the 'Has Meta-review Limit?' can be assigned during the creation of the table and on clicking the 'Has Meta-review Limit?' checkbox the UI displays '3' in the allowed number of metareviews that is num_metareviews_allowed variable is assigned '3'.

===Test Plan===
1. Ensure that when an assignment is created, the number of meta-reviews is set to null.

2. Ensure that the meta-review fields in the review strategy tab are visible only when 'Use metareview deadline' is enabled in the Due dates tab.

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-12-16T18:20:01Z

Smuvval: /* Issue2 */

== '''Overview of Project''' ==

In Expertiza, meta-review is a feature that enables a third party to evaluate the quality of feedback that a reviewer gives a reviewee. meta-review is an important feature that can help students become better reviewers for their peers by providing detailed feedback that is actionable and positively formulated. Unfortunately, this feature is broken and the following issues were identified.

== '''Design Pattern''' ==
Design patterns are not applicable as our task involved just modification of existing methods.

== '''Issue1 - Cannot begin/view/edit a meta-review''' ==

===Issue Description===
When a user requests a new meta-review, (s)he should be able to click on the Begin button, which should redirect him/her to the meta-review questionnaire and when the user returns back (to the page where he can view the reviews and meta-reviews, by clicking on Others’ work in his/her assignment), (s)he should be then able to see view and update links for the meta-reviews (s)he has performed.

But the issue is Begin and Edit are not working for the given scenario.

===Existing Issue===
1. Log in as instructor6, click on Manage...-> Assignments

2. Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox

3. Select "Yes" for all of the following: Submission allowed, Review allowed and Meta-review allowed in all of the deadline types

4. Navigate back to Assignment Tree View and click on "Add participant"

5. Add couple of students(say student1 and student2) to the assignment

6. Impersonate/login as student1 and make a submission

7. Impersonate/login as student2 and Request for a new review under others work, submit the review

8. Impersonate/login back as student1 and Request for a new meta review

9. When Begin is clicked following will be displayed. Instead of this, the meta review page must be displayed. 

[[File:Expertiza project3 Issue1 E1997.png]]

10. A template must be added to fix the broken link

== '''Issue2 - Count of number of meta-reviews left not reducing''' ==

===Issue Description===
The number of meta-reviews(refer to the snapshot below),should decrease when a user requests a meta-review.Also, the button to request a new meta-review should not disappear until the total number of reviews assigned has reached the allowed limit.

===Existing Issue===
<li>Log in as instructor6, click on mange...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked, the meta-review count should be decremented. Currently, as clicking the begin button is not working, we are not sure if the counter is being decremented properly.

== '''Design strategy For Issue1 and Issue 2''' ==

The flow chart below describes the design we choose to implement the above two issues

[[File:E1997_1.PNG]]

===Solution and Code Modification for Issue 1 and 2===

==== Modification 1 ====
Basically, the file named 'response.html.erb'(Exact navigation: https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/response.html.erb) is looking for a partial named 'review'

The code that expects partial is:
<%= render :partial => 'review', :locals => {:versions => @responses_versions} %>

We have created partial named _review.html.erb at https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/_review.html.erb
It is a simple partial with code as follows:

<% versions.each do |response| %>
<% rm = ResponseMap.find(response.map_id) %>
<% as = Assignment.find(rm.reviewed_object_id) %>
<% questionnaire = rm.questionnaire %>
<%= response.display_as_html() %>
<% end %>

==== Modification 2 ====
The response_controller.rb(controller that works in tandem with response.html.erb view, which was expecting partial) required a minute fix, which is,
- The existing code doesn't work if AssignmentTeam is found to be nil. Please check the below existing code:

if @response.nil? || AssignmentTeam.find(@map.reviewee_id).most_recent_submission.updated_at > @response.updated_at
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

The response is created(by Response.create) only if the 'if' condition is satisfied. The AssignmentTeam.find(@map.reviewee_id) shall return a nil(for metareviews), hence AssignmentTeam.find(@map.reviewee_id).most_recent_submission will throw an exception.

The problem is, assignment team will be nil for meta reviews. Hence, existing code won't work.

To cover this special nil case, we have modified the code as:

begin
assignment_team = AssignmentTeam.find(@map.reviewee_id)
rescue ActiveRecord::RecordNotFound => e
assignment_team = nil
end
if @response.nil? || (!assignment_team.nil? && assignment_team.most_recent_submission.updated_at > @response.updated_at)
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

==== Modification 3 ====
There's this issue of user being able to request and review more than allowed 'x' number of reviews. After user performed max allowed 'x' number of reviews, the button 'Request a new metareview to perform' shouldn't be visible. To handle this, following code change is made in file (https://github.com/VishnusRepo/expertiza/blob/master/app/views/student_review/list.html.erb)

<% if @assignment.num_metareviews_allowed - @num_metareviews_completed <= 0 %>
Note: You can not do more than <%=@assignment.num_metareviews_allowed%> metareviews according to assignment policy.
<% elsif @num_metareviews_in_progress == 0 %>
<%= render :partial => 'set_dynamic_metareview', :locals => {:assignment => @assignment} %>
<% end %>

The code in elsif block shows the button using which user can request more metareviews. By modifying the code as above, we shall not render the partial set_dynamic_metareview, which contains the request button.

By changing the code to above, we were able to handle the exceptions.

Both the Issues 1 and 2 are now solved. For the test setup we performed, following screenshot shows that we were able to do metareviews(Issue 1 done) and count of metareviews remaining is being reduced(Issue 2 done).

[[File:issue12.png]]

== '''Issue3''' ==
===Background:===
An instructor can edit an assignment and can choose whether to have metareview in it or not. He can do so by following the below steps:

1) From Manage>Assignments, click on the Edit Assignment button for the appropriate assignment.

2) On the Due Date tab, the instructor can select if (s)he wants to have meta-reviews done for the assignment, by clicking on the “Use meta-review deadline” checkbox and setting a meta-review deadline below.

3) Under the “Review Strategy” tab of edit assignment, the instructor can set Allowed and Required number of meta-reviews per reviewer by checking the Has meta-review Limit? checkbox.

===Issue Description===
For an assignment, when 'Use Metareview Deadline' is unchecked, it means meta-reviews are not enabled for that assignment. The checkbox is as below

[[File:issue3_1.png]]

As said, when this box is unchecked, it means there is no meta reviewing system for this assignment. The issue is, there are some meta review related fields that show up even if the above box is unchecked. Like in below image

[[File:issue3_2.png]]

Also, when a new issue is created, the default # of meta-reviews allowed and required should be null. As soon as someone checks the Has meta-review Limit box on the “Review Strategy” tab, the UI should fill in 3 and 3 as the required and allowed number. Of course, the user can change this number before submitting it.

===Solution and Code Modification for Issue 3===

As the checkbox and the content to be displayed on clicking the checkbox are located on different pages we cannot use the regular checkbox logic, so we used the concept of local storage and event listener.

we have made changes to the below two files:

1)/expertiza/app/views/assignments/edit/_due_dates.html.erb

2)/expertiza/app/views/assignments/edit/_review_strategy.html.erb

In the _due_dates.html.erb file:

There is an existing code where on clicking the checkbox 'Use metareview deadline', a function called 'removeOrAddMetareview()' is invoked. The code snippet below shows the existing code:

[[File:Metareview1.PNG]]

The 'removeOrAddMetareview()' is called on click of the 'Use metareview deadline' checkbox. Now we implemented two new functions which are invoked inside this function they are 'hideMetaReviewLimit()' and 'showMetaReviewLimit()'. This can be seen in the below code snippet

[[File:Metareview2.PNG]]

Now on clicking the 'Use metareview deadline' checkbox, the new code will invoke the 'removeOrAddMetareview()' function which indirectly invokes the two new functions.
Now let us look at the implementation of the two new functions, we used a local storage variable called 'meta'.So based on the status of the checkbox a value is assigned to the local storage variable. For example, if the 'Use metareview deadline' checkbox is checked then the local storage variable is initialized with the value 'show' and if the 'Use metareview deadline' checkbox is Unchecked we assign with the value 'hide' to the local storage variable. Now after storing the respective values for the local storage variable, the storage event is triggered by these functions. The below code snippet shows the implementation of the two new functions:

[[File:Metareview3.PNG]]

In _review_strategy.html.erb file:

Small modifications have been made to the existing code that is the display of the table row with id 'meta' is given 'none' by default and also the status of the 'Has Meta-review Limit?' checkbox is changed to false. The below code snippet shows the modifications made:

[[File:Metareview5.PNG]]

we wrote a javascript code that handles the event triggered when the 'Use metareview deadline' checkbox has been checked or unchecked. In this javascript, the event triggered is handled by calling the 'onStorageEvent(storageEvent)' function. In this 'onStorageEvent' function we check the value in the local storage variable and based on that value we change the status of the display for the table row with id 'meta'.

[[File:Metareview4.PNG]]

Finally, the null value to the 'Has Meta-review Limit?' can be assigned during the creation of the table and on clicking the 'Has Meta-review Limit?' checkbox the UI displays '3' in the allowed number of metareviews that is num_metareviews_allowed variable is assigned '3'.

===Test Plan===
1. Ensure that when an assignment is created, the number of meta-reviews is set to null.

2. Ensure that the meta-review fields in the review strategy tab are visible only when 'Use metareview deadline' is enabled in the Due dates tab.

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-12-16T18:19:24Z

Smuvval: /* Issue1 */

== '''Overview of Project''' ==

In Expertiza, meta-review is a feature that enables a third party to evaluate the quality of feedback that a reviewer gives a reviewee. meta-review is an important feature that can help students become better reviewers for their peers by providing detailed feedback that is actionable and positively formulated. Unfortunately, this feature is broken and the following issues were identified.

== '''Design Pattern''' ==
Design patterns are not applicable as our task involved just modification of existing methods.

== '''Issue1 - Cannot begin/view/edit a meta-review''' ==

===Issue Description===
When a user requests a new meta-review, (s)he should be able to click on the Begin button, which should redirect him/her to the meta-review questionnaire and when the user returns back (to the page where he can view the reviews and meta-reviews, by clicking on Others’ work in his/her assignment), (s)he should be then able to see view and update links for the meta-reviews (s)he has performed.

But the issue is Begin and Edit are not working for the given scenario.

===Existing Issue===
1. Log in as instructor6, click on Manage...-> Assignments

2. Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox

3. Select "Yes" for all of the following: Submission allowed, Review allowed and Meta-review allowed in all of the deadline types

4. Navigate back to Assignment Tree View and click on "Add participant"

5. Add couple of students(say student1 and student2) to the assignment

6. Impersonate/login as student1 and make a submission

7. Impersonate/login as student2 and Request for a new review under others work, submit the review

8. Impersonate/login back as student1 and Request for a new meta review

9. When Begin is clicked following will be displayed. Instead of this, the meta review page must be displayed. 

[[File:Expertiza project3 Issue1 E1997.png]]

10. A template must be added to fix the broken link

== '''Issue2''' ==

===Issue Description===
The number of meta-reviews(refer to the snapshot below),should decrease when a user requests a meta-review.Also, the button to request a new meta-review should not disappear until the total number of reviews assigned has reached the allowed limit.

===Existing Issue===
<li>Log in as instructor6, click on mange...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked, the meta-review count should be decremented. Currently, as clicking the begin button is not working, we are not sure if the counter is being decremented properly.

== '''Design strategy For Issue1 and Issue 2''' ==

The flow chart below describes the design we choose to implement the above two issues

[[File:E1997_1.PNG]]

===Solution and Code Modification for Issue 1 and 2===

==== Modification 1 ====
Basically, the file named 'response.html.erb'(Exact navigation: https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/response.html.erb) is looking for a partial named 'review'

The code that expects partial is:
<%= render :partial => 'review', :locals => {:versions => @responses_versions} %>

We have created partial named _review.html.erb at https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/_review.html.erb
It is a simple partial with code as follows:

<% versions.each do |response| %>
<% rm = ResponseMap.find(response.map_id) %>
<% as = Assignment.find(rm.reviewed_object_id) %>
<% questionnaire = rm.questionnaire %>
<%= response.display_as_html() %>
<% end %>

==== Modification 2 ====
The response_controller.rb(controller that works in tandem with response.html.erb view, which was expecting partial) required a minute fix, which is,
- The existing code doesn't work if AssignmentTeam is found to be nil. Please check the below existing code:

if @response.nil? || AssignmentTeam.find(@map.reviewee_id).most_recent_submission.updated_at > @response.updated_at
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

The response is created(by Response.create) only if the 'if' condition is satisfied. The AssignmentTeam.find(@map.reviewee_id) shall return a nil(for metareviews), hence AssignmentTeam.find(@map.reviewee_id).most_recent_submission will throw an exception.

The problem is, assignment team will be nil for meta reviews. Hence, existing code won't work.

To cover this special nil case, we have modified the code as:

begin
assignment_team = AssignmentTeam.find(@map.reviewee_id)
rescue ActiveRecord::RecordNotFound => e
assignment_team = nil
end
if @response.nil? || (!assignment_team.nil? && assignment_team.most_recent_submission.updated_at > @response.updated_at)
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

==== Modification 3 ====
There's this issue of user being able to request and review more than allowed 'x' number of reviews. After user performed max allowed 'x' number of reviews, the button 'Request a new metareview to perform' shouldn't be visible. To handle this, following code change is made in file (https://github.com/VishnusRepo/expertiza/blob/master/app/views/student_review/list.html.erb)

<% if @assignment.num_metareviews_allowed - @num_metareviews_completed <= 0 %>
Note: You can not do more than <%=@assignment.num_metareviews_allowed%> metareviews according to assignment policy.
<% elsif @num_metareviews_in_progress == 0 %>
<%= render :partial => 'set_dynamic_metareview', :locals => {:assignment => @assignment} %>
<% end %>

The code in elsif block shows the button using which user can request more metareviews. By modifying the code as above, we shall not render the partial set_dynamic_metareview, which contains the request button.

By changing the code to above, we were able to handle the exceptions.

Both the Issues 1 and 2 are now solved. For the test setup we performed, following screenshot shows that we were able to do metareviews(Issue 1 done) and count of metareviews remaining is being reduced(Issue 2 done).

[[File:issue12.png]]

== '''Issue3''' ==
===Background:===
An instructor can edit an assignment and can choose whether to have metareview in it or not. He can do so by following the below steps:

1) From Manage>Assignments, click on the Edit Assignment button for the appropriate assignment.

2) On the Due Date tab, the instructor can select if (s)he wants to have meta-reviews done for the assignment, by clicking on the “Use meta-review deadline” checkbox and setting a meta-review deadline below.

3) Under the “Review Strategy” tab of edit assignment, the instructor can set Allowed and Required number of meta-reviews per reviewer by checking the Has meta-review Limit? checkbox.

===Issue Description===
For an assignment, when 'Use Metareview Deadline' is unchecked, it means meta-reviews are not enabled for that assignment. The checkbox is as below

[[File:issue3_1.png]]

As said, when this box is unchecked, it means there is no meta reviewing system for this assignment. The issue is, there are some meta review related fields that show up even if the above box is unchecked. Like in below image

[[File:issue3_2.png]]

Also, when a new issue is created, the default # of meta-reviews allowed and required should be null. As soon as someone checks the Has meta-review Limit box on the “Review Strategy” tab, the UI should fill in 3 and 3 as the required and allowed number. Of course, the user can change this number before submitting it.

===Solution and Code Modification for Issue 3===

As the checkbox and the content to be displayed on clicking the checkbox are located on different pages we cannot use the regular checkbox logic, so we used the concept of local storage and event listener.

we have made changes to the below two files:

1)/expertiza/app/views/assignments/edit/_due_dates.html.erb

2)/expertiza/app/views/assignments/edit/_review_strategy.html.erb

In the _due_dates.html.erb file:

There is an existing code where on clicking the checkbox 'Use metareview deadline', a function called 'removeOrAddMetareview()' is invoked. The code snippet below shows the existing code:

[[File:Metareview1.PNG]]

The 'removeOrAddMetareview()' is called on click of the 'Use metareview deadline' checkbox. Now we implemented two new functions which are invoked inside this function they are 'hideMetaReviewLimit()' and 'showMetaReviewLimit()'. This can be seen in the below code snippet

[[File:Metareview2.PNG]]

Now on clicking the 'Use metareview deadline' checkbox, the new code will invoke the 'removeOrAddMetareview()' function which indirectly invokes the two new functions.
Now let us look at the implementation of the two new functions, we used a local storage variable called 'meta'.So based on the status of the checkbox a value is assigned to the local storage variable. For example, if the 'Use metareview deadline' checkbox is checked then the local storage variable is initialized with the value 'show' and if the 'Use metareview deadline' checkbox is Unchecked we assign with the value 'hide' to the local storage variable. Now after storing the respective values for the local storage variable, the storage event is triggered by these functions. The below code snippet shows the implementation of the two new functions:

[[File:Metareview3.PNG]]

In _review_strategy.html.erb file:

Small modifications have been made to the existing code that is the display of the table row with id 'meta' is given 'none' by default and also the status of the 'Has Meta-review Limit?' checkbox is changed to false. The below code snippet shows the modifications made:

[[File:Metareview5.PNG]]

we wrote a javascript code that handles the event triggered when the 'Use metareview deadline' checkbox has been checked or unchecked. In this javascript, the event triggered is handled by calling the 'onStorageEvent(storageEvent)' function. In this 'onStorageEvent' function we check the value in the local storage variable and based on that value we change the status of the display for the table row with id 'meta'.

[[File:Metareview4.PNG]]

Finally, the null value to the 'Has Meta-review Limit?' can be assigned during the creation of the table and on clicking the 'Has Meta-review Limit?' checkbox the UI displays '3' in the allowed number of metareviews that is num_metareviews_allowed variable is assigned '3'.

===Test Plan===
1. Ensure that when an assignment is created, the number of meta-reviews is set to null.

2. Ensure that the meta-review fields in the review strategy tab are visible only when 'Use metareview deadline' is enabled in the Due dates tab.

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-12-07T00:21:01Z

Smuvval: /* Files to be modified */

== '''Overview of Project''' ==

In Expertiza, meta-review is a feature that enables a third party to evaluate the quality of feedback that a reviewer gives a reviewee. meta-review is an important feature that can help students become better reviewers for their peers by providing detailed feedback that is actionable and positively formulated. Unfortunately, this feature is broken and the following issues were identified.

== '''Design Pattern''' ==
Design patterns are not applicable as our task involved just modification of existing methods.

== '''Issue1''' ==

===Issue Description===
When a user requests a new meta-review, (s)he should be able to click on the Begin button, which should redirect him/her to the meta-review questionnaire and when the user returns back (to the page where he can view the reviews and meta-reviews, by clicking on Others’ work in his/her assignment), (s)he should be then able to see view and update links for the meta-reviews (s)he has performed.

But the issue is Begin and Edit are not working for the given scenario.

===Existing Issue===
1. Log in as instructor6, click on Manage...-> Assignments

2. Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox

3. Select "Yes" for all of the following: Submission allowed, Review allowed and Meta-review allowed in all of the deadline types

4. Navigate back to Assignment Tree View and click on "Add participant"

5. Add couple of students(say student1 and student2) to the assignment

6. Impersonate/login as student1 and make a submission

7. Impersonate/login as student2 and Request for a new review under others work, submit the review

8. Impersonate/login back as student1 and Request for a new meta review

9. When Begin is clicked following will be displayed. Instead of this, the meta review page must be displayed. 

[[File:Expertiza project3 Issue1 E1997.png]]

10. A template must be added to fix the broken link

== '''Issue2''' ==

===Issue Description===
The number of meta-reviews(refer to the snapshot below),should decrease when a user requests a meta-review.Also, the button to request a new meta-review should not disappear until the total number of reviews assigned has reached the allowed limit.

===Existing Issue===
<li>Log in as instructor6, click on mange...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked, the meta-review count should be decremented. Currently, as clicking the begin button is not working, we are not sure if the counter is being decremented properly.

== '''Design strategy For Issue1 and Issue 2''' ==

The flow chart below describes the design we choose to implement the above two issues

[[File:E1997_1.PNG]]

===Solution and Code Modification for Issue 1 and 2===

==== Modification 1 ====
Basically, the file named 'response.html.erb'(Exact navigation: https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/response.html.erb) is looking for a partial named 'review'

The code that expects partial is:
<%= render :partial => 'review', :locals => {:versions => @responses_versions} %>

We have created partial named _review.html.erb at https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/_review.html.erb
It is a simple partial with code as follows:

<% versions.each do |response| %>
<% rm = ResponseMap.find(response.map_id) %>
<% as = Assignment.find(rm.reviewed_object_id) %>
<% questionnaire = rm.questionnaire %>
<%= response.display_as_html() %>
<% end %>

==== Modification 2 ====
The response_controller.rb(controller that works in tandem with response.html.erb view, which was expecting partial) required a minute fix, which is,
- The existing code doesn't work if AssignmentTeam is found to be nil. Please check the below existing code:

if @response.nil? || AssignmentTeam.find(@map.reviewee_id).most_recent_submission.updated_at > @response.updated_at
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

The response is created(by Response.create) only if the 'if' condition is satisfied. The AssignmentTeam.find(@map.reviewee_id) shall return a nil(for metareviews), hence AssignmentTeam.find(@map.reviewee_id).most_recent_submission will throw an exception.

The problem is, assignment team will be nil for meta reviews. Hence, existing code won't work.

To cover this special nil case, we have modified the code as:

begin
assignment_team = AssignmentTeam.find(@map.reviewee_id)
rescue ActiveRecord::RecordNotFound => e
assignment_team = nil
end
if @response.nil? || (!assignment_team.nil? && assignment_team.most_recent_submission.updated_at > @response.updated_at)
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

==== Modification 3 ====
There's this issue of user being able to request and review more than allowed 'x' number of reviews. After user performed max allowed 'x' number of reviews, the button 'Request a new metareview to perform' shouldn't be visible. To handle this, following code change is made in file (https://github.com/VishnusRepo/expertiza/blob/master/app/views/student_review/list.html.erb)

<% if @assignment.num_metareviews_allowed - @num_metareviews_completed <= 0 %>
Note: You can not do more than <%=@assignment.num_metareviews_allowed%> metareviews according to assignment policy.
<% elsif @num_metareviews_in_progress == 0 %>
<%= render :partial => 'set_dynamic_metareview', :locals => {:assignment => @assignment} %>
<% end %>

The code in elsif block shows the button using which user can request more metareviews. By modifying the code as above, we shall not render the partial set_dynamic_metareview, which contains the request button.

By changing the code to above, we were able to handle the exceptions.

Both the Issues 1 and 2 are now solved. For the test setup we performed, following screenshot shows that we were able to do metareviews(Issue 1 done) and count of metareviews remaining is being reduced(Issue 2 done).

[[File:issue12.png]]

== '''Issue3''' ==
===Background:===
An instructor can edit an assignment and can choose whether to have metareview in it or not. He can do so by following the below steps:

1) From Manage>Assignments, click on the Edit Assignment button for the appropriate assignment.

2) On the Due Date tab, the instructor can select if (s)he wants to have meta-reviews done for the assignment, by clicking on the “Use meta-review deadline” checkbox and setting a meta-review deadline below.

3) Under the “Review Strategy” tab of edit assignment, the instructor can set Allowed and Required number of meta-reviews per reviewer by checking the Has meta-review Limit? checkbox.

===Issue Description===
For an assignment, when 'Use Metareview Deadline' is unchecked, it means meta-reviews are not enabled for that assignment. The checkbox is as below

[[File:issue3_1.png]]

As said, when this box is unchecked, it means there is no meta reviewing system for this assignment. The issue is, there are some meta review related fields that show up even if the above box is unchecked. Like in below image

[[File:issue3_2.png]]

Also, when a new issue is created, the default # of meta-reviews allowed and required should be null. As soon as someone checks the Has meta-review Limit box on the “Review Strategy” tab, the UI should fill in 3 and 3 as the required and allowed number. Of course, the user can change this number before submitting it.

===Solution and Code Modification for Issue 3===

As the checkbox and the content to be displayed on clicking the checkbox are located on different pages we cannot use the regular checkbox logic, so we used the concept of local storage and event listener.

we have made changes to the below two files:

1)/expertiza/app/views/assignments/edit/_due_dates.html.erb

2)/expertiza/app/views/assignments/edit/_review_strategy.html.erb

In the _due_dates.html.erb file:

There is an existing code where on clicking the checkbox 'Use metareview deadline', a function called 'removeOrAddMetareview()' is invoked. The code snippet below shows the existing code:

[[File:Metareview1.PNG]]

The 'removeOrAddMetareview()' is called on click of the 'Use metareview deadline' checkbox. Now we implemented two new functions which are invoked inside this function they are 'hideMetaReviewLimit()' and 'showMetaReviewLimit()'. This can be seen in the below code snippet

[[File:Metareview2.PNG]]

Now on clicking the 'Use metareview deadline' checkbox, the new code will invoke the 'removeOrAddMetareview()' function which indirectly invokes the two new functions.
Now let us look at the implementation of the two new functions, we used a local storage variable called 'meta'.So based on the status of the checkbox a value is assigned to the local storage variable. For example, if the 'Use metareview deadline' checkbox is checked then the local storage variable is initialized with the value 'show' and if the 'Use metareview deadline' checkbox is Unchecked we assign with the value 'hide' to the local storage variable. Now after storing the respective values for the local storage variable, the storage event is triggered by these functions. The below code snippet shows the implementation of the two new functions:

[[File:Metareview3.PNG]]

In _review_strategy.html.erb file:

Small modifications have been made to the existing code that is the display of the table row with id 'meta' is given 'none' by default and also the status of the 'Has Meta-review Limit?' checkbox is changed to false. The below code snippet shows the modifications made:

[[File:Metareview5.PNG]]

we wrote a javascript code that handles the event triggered when the 'Use metareview deadline' checkbox has been checked or unchecked. In this javascript, the event triggered is handled by calling the 'onStorageEvent(storageEvent)' function. In this 'onStorageEvent' function we check the value in the local storage variable and based on that value we change the status of the display for the table row with id 'meta'.

[[File:Metareview4.PNG]]

Finally, the null value to the 'Has Meta-review Limit?' can be assigned during the creation of the table and on clicking the 'Has Meta-review Limit?' checkbox the UI displays '3' in the allowed number of metareviews that is num_metareviews_allowed variable is assigned '3'.

===Test Plan===
1. Ensure that when an assignment is created, the number of meta-reviews is set to null.

2. Ensure that the meta-review fields in the review strategy tab are visible only when 'Use metareview deadline' is enabled in the Due dates tab.

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-12-07T00:20:51Z

Smuvval: /* Files to be modified */

== '''Overview of Project''' ==

In Expertiza, meta-review is a feature that enables a third party to evaluate the quality of feedback that a reviewer gives a reviewee. meta-review is an important feature that can help students become better reviewers for their peers by providing detailed feedback that is actionable and positively formulated. Unfortunately, this feature is broken and the following issues were identified.

== '''Design Pattern''' ==
Design patterns are not applicable as our task involved just modification of existing methods.

== '''Issue1''' ==

===Issue Description===
When a user requests a new meta-review, (s)he should be able to click on the Begin button, which should redirect him/her to the meta-review questionnaire and when the user returns back (to the page where he can view the reviews and meta-reviews, by clicking on Others’ work in his/her assignment), (s)he should be then able to see view and update links for the meta-reviews (s)he has performed.

But the issue is Begin and Edit are not working for the given scenario.

===Existing Issue===
1. Log in as instructor6, click on Manage...-> Assignments

2. Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox

3. Select "Yes" for all of the following: Submission allowed, Review allowed and Meta-review allowed in all of the deadline types

4. Navigate back to Assignment Tree View and click on "Add participant"

5. Add couple of students(say student1 and student2) to the assignment

6. Impersonate/login as student1 and make a submission

7. Impersonate/login as student2 and Request for a new review under others work, submit the review

8. Impersonate/login back as student1 and Request for a new meta review

9. When Begin is clicked following will be displayed. Instead of this, the meta review page must be displayed. 

[[File:Expertiza project3 Issue1 E1997.png]]

10. A template must be added to fix the broken link

===Files to be modified===
response.html.erb

== '''Issue2''' ==

===Issue Description===
The number of meta-reviews(refer to the snapshot below),should decrease when a user requests a meta-review.Also, the button to request a new meta-review should not disappear until the total number of reviews assigned has reached the allowed limit.

===Existing Issue===
<li>Log in as instructor6, click on mange...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked, the meta-review count should be decremented. Currently, as clicking the begin button is not working, we are not sure if the counter is being decremented properly.

== '''Design strategy For Issue1 and Issue 2''' ==

The flow chart below describes the design we choose to implement the above two issues

[[File:E1997_1.PNG]]

===Solution and Code Modification for Issue 1 and 2===

==== Modification 1 ====
Basically, the file named 'response.html.erb'(Exact navigation: https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/response.html.erb) is looking for a partial named 'review'

The code that expects partial is:
<%= render :partial => 'review', :locals => {:versions => @responses_versions} %>

We have created partial named _review.html.erb at https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/_review.html.erb
It is a simple partial with code as follows:

<% versions.each do |response| %>
<% rm = ResponseMap.find(response.map_id) %>
<% as = Assignment.find(rm.reviewed_object_id) %>
<% questionnaire = rm.questionnaire %>
<%= response.display_as_html() %>
<% end %>

==== Modification 2 ====
The response_controller.rb(controller that works in tandem with response.html.erb view, which was expecting partial) required a minute fix, which is,
- The existing code doesn't work if AssignmentTeam is found to be nil. Please check the below existing code:

if @response.nil? || AssignmentTeam.find(@map.reviewee_id).most_recent_submission.updated_at > @response.updated_at
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

The response is created(by Response.create) only if the 'if' condition is satisfied. The AssignmentTeam.find(@map.reviewee_id) shall return a nil(for metareviews), hence AssignmentTeam.find(@map.reviewee_id).most_recent_submission will throw an exception.

The problem is, assignment team will be nil for meta reviews. Hence, existing code won't work.

To cover this special nil case, we have modified the code as:

begin
assignment_team = AssignmentTeam.find(@map.reviewee_id)
rescue ActiveRecord::RecordNotFound => e
assignment_team = nil
end
if @response.nil? || (!assignment_team.nil? && assignment_team.most_recent_submission.updated_at > @response.updated_at)
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

==== Modification 3 ====
There's this issue of user being able to request and review more than allowed 'x' number of reviews. After user performed max allowed 'x' number of reviews, the button 'Request a new metareview to perform' shouldn't be visible. To handle this, following code change is made in file (https://github.com/VishnusRepo/expertiza/blob/master/app/views/student_review/list.html.erb)

<% if @assignment.num_metareviews_allowed - @num_metareviews_completed <= 0 %>
Note: You can not do more than <%=@assignment.num_metareviews_allowed%> metareviews according to assignment policy.
<% elsif @num_metareviews_in_progress == 0 %>
<%= render :partial => 'set_dynamic_metareview', :locals => {:assignment => @assignment} %>
<% end %>

The code in elsif block shows the button using which user can request more metareviews. By modifying the code as above, we shall not render the partial set_dynamic_metareview, which contains the request button.

By changing the code to above, we were able to handle the exceptions.

Both the Issues 1 and 2 are now solved. For the test setup we performed, following screenshot shows that we were able to do metareviews(Issue 1 done) and count of metareviews remaining is being reduced(Issue 2 done).

[[File:issue12.png]]

== '''Issue3''' ==
===Background:===
An instructor can edit an assignment and can choose whether to have metareview in it or not. He can do so by following the below steps:

1) From Manage>Assignments, click on the Edit Assignment button for the appropriate assignment.

2) On the Due Date tab, the instructor can select if (s)he wants to have meta-reviews done for the assignment, by clicking on the “Use meta-review deadline” checkbox and setting a meta-review deadline below.

3) Under the “Review Strategy” tab of edit assignment, the instructor can set Allowed and Required number of meta-reviews per reviewer by checking the Has meta-review Limit? checkbox.

===Issue Description===
For an assignment, when 'Use Metareview Deadline' is unchecked, it means meta-reviews are not enabled for that assignment. The checkbox is as below

[[File:issue3_1.png]]

As said, when this box is unchecked, it means there is no meta reviewing system for this assignment. The issue is, there are some meta review related fields that show up even if the above box is unchecked. Like in below image

[[File:issue3_2.png]]

Also, when a new issue is created, the default # of meta-reviews allowed and required should be null. As soon as someone checks the Has meta-review Limit box on the “Review Strategy” tab, the UI should fill in 3 and 3 as the required and allowed number. Of course, the user can change this number before submitting it.

===Solution and Code Modification for Issue 3===

As the checkbox and the content to be displayed on clicking the checkbox are located on different pages we cannot use the regular checkbox logic, so we used the concept of local storage and event listener.

we have made changes to the below two files:

1)/expertiza/app/views/assignments/edit/_due_dates.html.erb

2)/expertiza/app/views/assignments/edit/_review_strategy.html.erb

In the _due_dates.html.erb file:

There is an existing code where on clicking the checkbox 'Use metareview deadline', a function called 'removeOrAddMetareview()' is invoked. The code snippet below shows the existing code:

[[File:Metareview1.PNG]]

The 'removeOrAddMetareview()' is called on click of the 'Use metareview deadline' checkbox. Now we implemented two new functions which are invoked inside this function they are 'hideMetaReviewLimit()' and 'showMetaReviewLimit()'. This can be seen in the below code snippet

[[File:Metareview2.PNG]]

Now on clicking the 'Use metareview deadline' checkbox, the new code will invoke the 'removeOrAddMetareview()' function which indirectly invokes the two new functions.
Now let us look at the implementation of the two new functions, we used a local storage variable called 'meta'.So based on the status of the checkbox a value is assigned to the local storage variable. For example, if the 'Use metareview deadline' checkbox is checked then the local storage variable is initialized with the value 'show' and if the 'Use metareview deadline' checkbox is Unchecked we assign with the value 'hide' to the local storage variable. Now after storing the respective values for the local storage variable, the storage event is triggered by these functions. The below code snippet shows the implementation of the two new functions:

[[File:Metareview3.PNG]]

In _review_strategy.html.erb file:

Small modifications have been made to the existing code that is the display of the table row with id 'meta' is given 'none' by default and also the status of the 'Has Meta-review Limit?' checkbox is changed to false. The below code snippet shows the modifications made:

[[File:Metareview5.PNG]]

we wrote a javascript code that handles the event triggered when the 'Use metareview deadline' checkbox has been checked or unchecked. In this javascript, the event triggered is handled by calling the 'onStorageEvent(storageEvent)' function. In this 'onStorageEvent' function we check the value in the local storage variable and based on that value we change the status of the display for the table row with id 'meta'.

[[File:Metareview4.PNG]]

Finally, the null value to the 'Has Meta-review Limit?' can be assigned during the creation of the table and on clicking the 'Has Meta-review Limit?' checkbox the UI displays '3' in the allowed number of metareviews that is num_metareviews_allowed variable is assigned '3'.

===Test Plan===
1. Ensure that when an assignment is created, the number of meta-reviews is set to null.

2. Ensure that the meta-review fields in the review strategy tab are visible only when 'Use metareview deadline' is enabled in the Due dates tab.

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-12-07T00:20:33Z

Smuvval: /* Modification 1 */

== '''Overview of Project''' ==

In Expertiza, meta-review is a feature that enables a third party to evaluate the quality of feedback that a reviewer gives a reviewee. meta-review is an important feature that can help students become better reviewers for their peers by providing detailed feedback that is actionable and positively formulated. Unfortunately, this feature is broken and the following issues were identified.

== '''Design Pattern''' ==
Design patterns are not applicable as our task involved just modification of existing methods.

== '''Issue1''' ==

===Issue Description===
When a user requests a new meta-review, (s)he should be able to click on the Begin button, which should redirect him/her to the meta-review questionnaire and when the user returns back (to the page where he can view the reviews and meta-reviews, by clicking on Others’ work in his/her assignment), (s)he should be then able to see view and update links for the meta-reviews (s)he has performed.

But the issue is Begin and Edit are not working for the given scenario.

===Existing Issue===
1. Log in as instructor6, click on Manage...-> Assignments

2. Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox

3. Select "Yes" for all of the following: Submission allowed, Review allowed and Meta-review allowed in all of the deadline types

4. Navigate back to Assignment Tree View and click on "Add participant"

5. Add couple of students(say student1 and student2) to the assignment

6. Impersonate/login as student1 and make a submission

7. Impersonate/login as student2 and Request for a new review under others work, submit the review

8. Impersonate/login back as student1 and Request for a new meta review

9. When Begin is clicked following will be displayed. Instead of this, the meta review page must be displayed. 

[[File:Expertiza project3 Issue1 E1997.png]]

10. A template must be added to fix the broken link

===Files to be modified===
response.html.erb

== '''Issue2''' ==

===Issue Description===
The number of meta-reviews(refer to the snapshot below),should decrease when a user requests a meta-review.Also, the button to request a new meta-review should not disappear until the total number of reviews assigned has reached the allowed limit.

===Existing Issue===
<li>Log in as instructor6, click on mange...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked, the meta-review count should be decremented. Currently, as clicking the begin button is not working, we are not sure if the counter is being decremented properly.

===Files to be modified===
<li>List.html.erb

== '''Design strategy For Issue1 and Issue 2''' ==

The flow chart below describes the design we choose to implement the above two issues

[[File:E1997_1.PNG]]

===Solution and Code Modification for Issue 1 and 2===

==== Modification 1 ====
Basically, the file named 'response.html.erb'(Exact navigation: https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/response.html.erb) is looking for a partial named 'review'

The code that expects partial is:
<%= render :partial => 'review', :locals => {:versions => @responses_versions} %>

We have created partial named _review.html.erb at https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/_review.html.erb
It is a simple partial with code as follows:

<% versions.each do |response| %>
<% rm = ResponseMap.find(response.map_id) %>
<% as = Assignment.find(rm.reviewed_object_id) %>
<% questionnaire = rm.questionnaire %>
<%= response.display_as_html() %>
<% end %>

==== Modification 2 ====
The response_controller.rb(controller that works in tandem with response.html.erb view, which was expecting partial) required a minute fix, which is,
- The existing code doesn't work if AssignmentTeam is found to be nil. Please check the below existing code:

if @response.nil? || AssignmentTeam.find(@map.reviewee_id).most_recent_submission.updated_at > @response.updated_at
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

The response is created(by Response.create) only if the 'if' condition is satisfied. The AssignmentTeam.find(@map.reviewee_id) shall return a nil(for metareviews), hence AssignmentTeam.find(@map.reviewee_id).most_recent_submission will throw an exception.

The problem is, assignment team will be nil for meta reviews. Hence, existing code won't work.

To cover this special nil case, we have modified the code as:

begin
assignment_team = AssignmentTeam.find(@map.reviewee_id)
rescue ActiveRecord::RecordNotFound => e
assignment_team = nil
end
if @response.nil? || (!assignment_team.nil? && assignment_team.most_recent_submission.updated_at > @response.updated_at)
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

==== Modification 3 ====
There's this issue of user being able to request and review more than allowed 'x' number of reviews. After user performed max allowed 'x' number of reviews, the button 'Request a new metareview to perform' shouldn't be visible. To handle this, following code change is made in file (https://github.com/VishnusRepo/expertiza/blob/master/app/views/student_review/list.html.erb)

<% if @assignment.num_metareviews_allowed - @num_metareviews_completed <= 0 %>
Note: You can not do more than <%=@assignment.num_metareviews_allowed%> metareviews according to assignment policy.
<% elsif @num_metareviews_in_progress == 0 %>
<%= render :partial => 'set_dynamic_metareview', :locals => {:assignment => @assignment} %>
<% end %>

The code in elsif block shows the button using which user can request more metareviews. By modifying the code as above, we shall not render the partial set_dynamic_metareview, which contains the request button.

By changing the code to above, we were able to handle the exceptions.

Both the Issues 1 and 2 are now solved. For the test setup we performed, following screenshot shows that we were able to do metareviews(Issue 1 done) and count of metareviews remaining is being reduced(Issue 2 done).

[[File:issue12.png]]

== '''Issue3''' ==
===Background:===
An instructor can edit an assignment and can choose whether to have metareview in it or not. He can do so by following the below steps:

1) From Manage>Assignments, click on the Edit Assignment button for the appropriate assignment.

2) On the Due Date tab, the instructor can select if (s)he wants to have meta-reviews done for the assignment, by clicking on the “Use meta-review deadline” checkbox and setting a meta-review deadline below.

3) Under the “Review Strategy” tab of edit assignment, the instructor can set Allowed and Required number of meta-reviews per reviewer by checking the Has meta-review Limit? checkbox.

===Issue Description===
For an assignment, when 'Use Metareview Deadline' is unchecked, it means meta-reviews are not enabled for that assignment. The checkbox is as below

[[File:issue3_1.png]]

As said, when this box is unchecked, it means there is no meta reviewing system for this assignment. The issue is, there are some meta review related fields that show up even if the above box is unchecked. Like in below image

[[File:issue3_2.png]]

Also, when a new issue is created, the default # of meta-reviews allowed and required should be null. As soon as someone checks the Has meta-review Limit box on the “Review Strategy” tab, the UI should fill in 3 and 3 as the required and allowed number. Of course, the user can change this number before submitting it.

===Solution and Code Modification for Issue 3===

As the checkbox and the content to be displayed on clicking the checkbox are located on different pages we cannot use the regular checkbox logic, so we used the concept of local storage and event listener.

we have made changes to the below two files:

1)/expertiza/app/views/assignments/edit/_due_dates.html.erb

2)/expertiza/app/views/assignments/edit/_review_strategy.html.erb

In the _due_dates.html.erb file:

There is an existing code where on clicking the checkbox 'Use metareview deadline', a function called 'removeOrAddMetareview()' is invoked. The code snippet below shows the existing code:

[[File:Metareview1.PNG]]

The 'removeOrAddMetareview()' is called on click of the 'Use metareview deadline' checkbox. Now we implemented two new functions which are invoked inside this function they are 'hideMetaReviewLimit()' and 'showMetaReviewLimit()'. This can be seen in the below code snippet

[[File:Metareview2.PNG]]

Now on clicking the 'Use metareview deadline' checkbox, the new code will invoke the 'removeOrAddMetareview()' function which indirectly invokes the two new functions.
Now let us look at the implementation of the two new functions, we used a local storage variable called 'meta'.So based on the status of the checkbox a value is assigned to the local storage variable. For example, if the 'Use metareview deadline' checkbox is checked then the local storage variable is initialized with the value 'show' and if the 'Use metareview deadline' checkbox is Unchecked we assign with the value 'hide' to the local storage variable. Now after storing the respective values for the local storage variable, the storage event is triggered by these functions. The below code snippet shows the implementation of the two new functions:

[[File:Metareview3.PNG]]

In _review_strategy.html.erb file:

Small modifications have been made to the existing code that is the display of the table row with id 'meta' is given 'none' by default and also the status of the 'Has Meta-review Limit?' checkbox is changed to false. The below code snippet shows the modifications made:

[[File:Metareview5.PNG]]

we wrote a javascript code that handles the event triggered when the 'Use metareview deadline' checkbox has been checked or unchecked. In this javascript, the event triggered is handled by calling the 'onStorageEvent(storageEvent)' function. In this 'onStorageEvent' function we check the value in the local storage variable and based on that value we change the status of the display for the table row with id 'meta'.

[[File:Metareview4.PNG]]

Finally, the null value to the 'Has Meta-review Limit?' can be assigned during the creation of the table and on clicking the 'Has Meta-review Limit?' checkbox the UI displays '3' in the allowed number of metareviews that is num_metareviews_allowed variable is assigned '3'.

===Test Plan===
1. Ensure that when an assignment is created, the number of meta-reviews is set to null.

2. Ensure that the meta-review fields in the review strategy tab are visible only when 'Use metareview deadline' is enabled in the Due dates tab.

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-12-07T00:20:23Z

Smuvval: /* Solution and Code Modification for Issue 1 and 2 */

== '''Overview of Project''' ==

In Expertiza, meta-review is a feature that enables a third party to evaluate the quality of feedback that a reviewer gives a reviewee. meta-review is an important feature that can help students become better reviewers for their peers by providing detailed feedback that is actionable and positively formulated. Unfortunately, this feature is broken and the following issues were identified.

== '''Design Pattern''' ==
Design patterns are not applicable as our task involved just modification of existing methods.

== '''Issue1''' ==

===Issue Description===
When a user requests a new meta-review, (s)he should be able to click on the Begin button, which should redirect him/her to the meta-review questionnaire and when the user returns back (to the page where he can view the reviews and meta-reviews, by clicking on Others’ work in his/her assignment), (s)he should be then able to see view and update links for the meta-reviews (s)he has performed.

But the issue is Begin and Edit are not working for the given scenario.

===Existing Issue===
1. Log in as instructor6, click on Manage...-> Assignments

2. Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox

3. Select "Yes" for all of the following: Submission allowed, Review allowed and Meta-review allowed in all of the deadline types

4. Navigate back to Assignment Tree View and click on "Add participant"

5. Add couple of students(say student1 and student2) to the assignment

6. Impersonate/login as student1 and make a submission

7. Impersonate/login as student2 and Request for a new review under others work, submit the review

8. Impersonate/login back as student1 and Request for a new meta review

9. When Begin is clicked following will be displayed. Instead of this, the meta review page must be displayed. 

[[File:Expertiza project3 Issue1 E1997.png]]

10. A template must be added to fix the broken link

===Files to be modified===
response.html.erb

== '''Issue2''' ==

===Issue Description===
The number of meta-reviews(refer to the snapshot below),should decrease when a user requests a meta-review.Also, the button to request a new meta-review should not disappear until the total number of reviews assigned has reached the allowed limit.

===Existing Issue===
<li>Log in as instructor6, click on mange...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked, the meta-review count should be decremented. Currently, as clicking the begin button is not working, we are not sure if the counter is being decremented properly.

===Files to be modified===
<li>List.html.erb

== '''Design strategy For Issue1 and Issue 2''' ==

The flow chart below describes the design we choose to implement the above two issues

[[File:E1997_1.PNG]]

===Solution and Code Modification for Issue 1 and 2===

==== Modification 1 ====
Basically, the file named 'response.html.erb'(Exact navigation: https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/response.html.erb) is looking for a partial named 'review'

The code that expects partial is:
<%= render :partial => 'review', :locals => {:versions => @responses_versions} %>

We have created partial named _review.html.erb at https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/_review.html.erb
It is a simple partial with code as follows:

<% versions.each do |response| %>
<% rm = ResponseMap.find(response.map_id) %>
<% as = Assignment.find(rm.reviewed_object_id) %>
<% questionnaire = rm.questionnaire %>
<%= response.display_as_html() %>
<% end %>

---

==== Modification 2 ====
The response_controller.rb(controller that works in tandem with response.html.erb view, which was expecting partial) required a minute fix, which is,
- The existing code doesn't work if AssignmentTeam is found to be nil. Please check the below existing code:

if @response.nil? || AssignmentTeam.find(@map.reviewee_id).most_recent_submission.updated_at > @response.updated_at
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

The response is created(by Response.create) only if the 'if' condition is satisfied. The AssignmentTeam.find(@map.reviewee_id) shall return a nil(for metareviews), hence AssignmentTeam.find(@map.reviewee_id).most_recent_submission will throw an exception.

The problem is, assignment team will be nil for meta reviews. Hence, existing code won't work.

To cover this special nil case, we have modified the code as:

begin
assignment_team = AssignmentTeam.find(@map.reviewee_id)
rescue ActiveRecord::RecordNotFound => e
assignment_team = nil
end
if @response.nil? || (!assignment_team.nil? && assignment_team.most_recent_submission.updated_at > @response.updated_at)
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

==== Modification 3 ====
There's this issue of user being able to request and review more than allowed 'x' number of reviews. After user performed max allowed 'x' number of reviews, the button 'Request a new metareview to perform' shouldn't be visible. To handle this, following code change is made in file (https://github.com/VishnusRepo/expertiza/blob/master/app/views/student_review/list.html.erb)

<% if @assignment.num_metareviews_allowed - @num_metareviews_completed <= 0 %>
Note: You can not do more than <%=@assignment.num_metareviews_allowed%> metareviews according to assignment policy.
<% elsif @num_metareviews_in_progress == 0 %>
<%= render :partial => 'set_dynamic_metareview', :locals => {:assignment => @assignment} %>
<% end %>

The code in elsif block shows the button using which user can request more metareviews. By modifying the code as above, we shall not render the partial set_dynamic_metareview, which contains the request button.

By changing the code to above, we were able to handle the exceptions.

Both the Issues 1 and 2 are now solved. For the test setup we performed, following screenshot shows that we were able to do metareviews(Issue 1 done) and count of metareviews remaining is being reduced(Issue 2 done).

[[File:issue12.png]]

== '''Issue3''' ==
===Background:===
An instructor can edit an assignment and can choose whether to have metareview in it or not. He can do so by following the below steps:

1) From Manage>Assignments, click on the Edit Assignment button for the appropriate assignment.

2) On the Due Date tab, the instructor can select if (s)he wants to have meta-reviews done for the assignment, by clicking on the “Use meta-review deadline” checkbox and setting a meta-review deadline below.

3) Under the “Review Strategy” tab of edit assignment, the instructor can set Allowed and Required number of meta-reviews per reviewer by checking the Has meta-review Limit? checkbox.

===Issue Description===
For an assignment, when 'Use Metareview Deadline' is unchecked, it means meta-reviews are not enabled for that assignment. The checkbox is as below

[[File:issue3_1.png]]

As said, when this box is unchecked, it means there is no meta reviewing system for this assignment. The issue is, there are some meta review related fields that show up even if the above box is unchecked. Like in below image

[[File:issue3_2.png]]

Also, when a new issue is created, the default # of meta-reviews allowed and required should be null. As soon as someone checks the Has meta-review Limit box on the “Review Strategy” tab, the UI should fill in 3 and 3 as the required and allowed number. Of course, the user can change this number before submitting it.

===Solution and Code Modification for Issue 3===

As the checkbox and the content to be displayed on clicking the checkbox are located on different pages we cannot use the regular checkbox logic, so we used the concept of local storage and event listener.

we have made changes to the below two files:

1)/expertiza/app/views/assignments/edit/_due_dates.html.erb

2)/expertiza/app/views/assignments/edit/_review_strategy.html.erb

In the _due_dates.html.erb file:

There is an existing code where on clicking the checkbox 'Use metareview deadline', a function called 'removeOrAddMetareview()' is invoked. The code snippet below shows the existing code:

[[File:Metareview1.PNG]]

The 'removeOrAddMetareview()' is called on click of the 'Use metareview deadline' checkbox. Now we implemented two new functions which are invoked inside this function they are 'hideMetaReviewLimit()' and 'showMetaReviewLimit()'. This can be seen in the below code snippet

[[File:Metareview2.PNG]]

Now on clicking the 'Use metareview deadline' checkbox, the new code will invoke the 'removeOrAddMetareview()' function which indirectly invokes the two new functions.
Now let us look at the implementation of the two new functions, we used a local storage variable called 'meta'.So based on the status of the checkbox a value is assigned to the local storage variable. For example, if the 'Use metareview deadline' checkbox is checked then the local storage variable is initialized with the value 'show' and if the 'Use metareview deadline' checkbox is Unchecked we assign with the value 'hide' to the local storage variable. Now after storing the respective values for the local storage variable, the storage event is triggered by these functions. The below code snippet shows the implementation of the two new functions:

[[File:Metareview3.PNG]]

In _review_strategy.html.erb file:

Small modifications have been made to the existing code that is the display of the table row with id 'meta' is given 'none' by default and also the status of the 'Has Meta-review Limit?' checkbox is changed to false. The below code snippet shows the modifications made:

[[File:Metareview5.PNG]]

we wrote a javascript code that handles the event triggered when the 'Use metareview deadline' checkbox has been checked or unchecked. In this javascript, the event triggered is handled by calling the 'onStorageEvent(storageEvent)' function. In this 'onStorageEvent' function we check the value in the local storage variable and based on that value we change the status of the display for the table row with id 'meta'.

[[File:Metareview4.PNG]]

Finally, the null value to the 'Has Meta-review Limit?' can be assigned during the creation of the table and on clicking the 'Has Meta-review Limit?' checkbox the UI displays '3' in the allowed number of metareviews that is num_metareviews_allowed variable is assigned '3'.

===Test Plan===
1. Ensure that when an assignment is created, the number of meta-reviews is set to null.

2. Ensure that the meta-review fields in the review strategy tab are visible only when 'Use metareview deadline' is enabled in the Due dates tab.

File:Issue12.png

2019-12-07T00:03:13Z

Smuvval:

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-12-07T00:03:02Z

Smuvval: /* Modification 3 */

== '''Overview of Project''' ==

In Expertiza, meta-review is a feature that enables a third party to evaluate the quality of feedback that a reviewer gives a reviewee. meta-review is an important feature that can help students become better reviewers for their peers by providing detailed feedback that is actionable and positively formulated. Unfortunately, this feature is broken and the following issues were identified.

== '''Design Pattern''' ==
Design patterns are not applicable as our task involved just modification of existing methods.

== '''Issue1''' ==

===Issue Description===
When a user requests a new meta-review, (s)he should be able to click on the Begin button, which should redirect him/her to the meta-review questionnaire and when the user returns back (to the page where he can view the reviews and meta-reviews, by clicking on Others’ work in his/her assignment), (s)he should be then able to see view and update links for the meta-reviews (s)he has performed.

But the issue is Begin and Edit are not working for the given scenario.

===Existing Issue===
1. Log in as instructor6, click on Manage...-> Assignments

2. Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox

3. Select "Yes" for all of the following: Submission allowed, Review allowed and Meta-review allowed in all of the deadline types

4. Navigate back to Assignment Tree View and click on "Add participant"

5. Add couple of students(say student1 and student2) to the assignment

6. Impersonate/login as student1 and make a submission

7. Impersonate/login as student2 and Request for a new review under others work, submit the review

8. Impersonate/login back as student1 and Request for a new meta review

9. When Begin is clicked following will be displayed. Instead of this, the meta review page must be displayed. 

[[File:Expertiza project3 Issue1 E1997.png]]

10. A template must be added to fix the broken link

===Files to be modified===
response.html.erb

== '''Issue2''' ==

===Issue Description===
The number of meta-reviews(refer to the snapshot below),should decrease when a user requests a meta-review.Also, the button to request a new meta-review should not disappear until the total number of reviews assigned has reached the allowed limit.

===Existing Issue===
<li>Log in as instructor6, click on mange...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked, the meta-review count should be decremented. Currently, as clicking the begin button is not working, we are not sure if the counter is being decremented properly.

===Files to be modified===
<li>List.html.erb

== '''Design strategy For Issue1 and Issue 2''' ==

The flow chart below describes the design we choose to implement the above two issues

[[File:E1997_1.PNG]]

===Solution and Code Modification for Issue 1 and 2===
Basically, the file named 'response.html.erb'(Exact navigation: https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/response.html.erb) is looking for a partial named 'review'

==== Modification 1 ====
The code that expects partial is:
<%= render :partial => 'review', :locals => {:versions => @responses_versions} %>

We have created partial named _review.html.erb at https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/_review.html.erb
It is a simple partial with code as follows:

<% versions.each do |response| %>
<% rm = ResponseMap.find(response.map_id) %>
<% as = Assignment.find(rm.reviewed_object_id) %>
<% questionnaire = rm.questionnaire %>
<%= response.display_as_html() %>
<% end %>

---

==== Modification 2 ====
The response_controller.rb(controller that works in tandem with response.html.erb view, which was expecting partial) required a minute fix, which is,
- The existing code doesn't work if AssignmentTeam is found to be nil. Please check the below existing code:

if @response.nil? || AssignmentTeam.find(@map.reviewee_id).most_recent_submission.updated_at > @response.updated_at
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

The response is created(by Response.create) only if the 'if' condition is satisfied. The AssignmentTeam.find(@map.reviewee_id) shall return a nil(for metareviews), hence AssignmentTeam.find(@map.reviewee_id).most_recent_submission will throw an exception.

The problem is, assignment team will be nil for meta reviews. Hence, existing code won't work.

To cover this special nil case, we have modified the code as:

begin
assignment_team = AssignmentTeam.find(@map.reviewee_id)
rescue ActiveRecord::RecordNotFound => e
assignment_team = nil
end
if @response.nil? || (!assignment_team.nil? && assignment_team.most_recent_submission.updated_at > @response.updated_at)
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

==== Modification 3 ====
There's this issue of user being able to request and review more than allowed 'x' number of reviews. After user performed max allowed 'x' number of reviews, the button 'Request a new metareview to perform' shouldn't be visible. To handle this, following code change is made in file (https://github.com/VishnusRepo/expertiza/blob/master/app/views/student_review/list.html.erb)

<% if @assignment.num_metareviews_allowed - @num_metareviews_completed <= 0 %>
Note: You can not do more than <%=@assignment.num_metareviews_allowed%> metareviews according to assignment policy.
<% elsif @num_metareviews_in_progress == 0 %>
<%= render :partial => 'set_dynamic_metareview', :locals => {:assignment => @assignment} %>
<% end %>

The code in elsif block shows the button using which user can request more metareviews. By modifying the code as above, we shall not render the partial set_dynamic_metareview, which contains the request button.

By changing the code to above, we were able to handle the exceptions.

Both the Issues 1 and 2 are now solved. For the test setup we performed, following screenshot shows that we were able to do metareviews(Issue 1 done) and count of metareviews remaining is being reduced(Issue 2 done).

[[File:issue12.png]]

== '''Issue3''' ==
===Background:===
An instructor can edit an assignment and can choose whether to have metareview in it or not. He can do so by following the below steps:

1) From Manage>Assignments, click on the Edit Assignment button for the appropriate assignment.

2) On the Due Date tab, the instructor can select if (s)he wants to have meta-reviews done for the assignment, by clicking on the “Use meta-review deadline” checkbox and setting a meta-review deadline below.

3) Under the “Review Strategy” tab of edit assignment, the instructor can set Allowed and Required number of meta-reviews per reviewer by checking the Has meta-review Limit? checkbox.

===Issue Description===
For an assignment, when 'Use Metareview Deadline' is unchecked, it means meta-reviews are not enabled for that assignment. The checkbox is as below

[[File:issue3_1.png]]

As said, when this box is unchecked, it means there is no meta reviewing system for this assignment. The issue is, there are some meta review related fields that show up even if the above box is unchecked. Like in below image

[[File:issue3_2.png]]

Also, when a new issue is created, the default # of meta-reviews allowed and required should be null. As soon as someone checks the Has meta-review Limit box on the “Review Strategy” tab, the UI should fill in 3 and 3 as the required and allowed number. Of course, the user can change this number before submitting it.

===Solution and Code Modification for Issue 3===

As the checkbox and the content to be displayed on clicking the checkbox are located on different pages we cannot use the regular checkbox logic, so we used the concept of local storage and event listener.

we have made changes to the below two files:

1)/expertiza/app/views/assignments/edit/_due_dates.html.erb

2)/expertiza/app/views/assignments/edit/_review_strategy.html.erb

In the _due_dates.html.erb file:

There is an existing code where on clicking the checkbox 'Use metareview deadline', a function called 'removeOrAddMetareview()' is invoked. The code snippet below shows the existing code:

[[File:Metareview1.PNG]]

The 'removeOrAddMetareview()' is called on click of the 'Use metareview deadline' checkbox. Now we implemented two new functions which are invoked inside this function they are 'hideMetaReviewLimit()' and 'showMetaReviewLimit()'. This can be seen in the below code snippet

[[File:Metareview2.PNG]]

Now on clicking the 'Use metareview deadline' checkbox, the new code will invoke the 'removeOrAddMetareview()' function which indirectly invokes the two new functions.
Now let us look at the implementation of the two new functions, we used a local storage variable called 'meta'.So based on the status of the checkbox a value is assigned to the local storage variable. For example, if the 'Use metareview deadline' checkbox is checked then the local storage variable is initialized with the value 'show' and if the 'Use metareview deadline' checkbox is Unchecked we assign with the value 'hide' to the local storage variable. Now after storing the respective values for the local storage variable, the storage event is triggered by these functions. The below code snippet shows the implementation of the two new functions:

[[File:Metareview3.PNG]]

In _review_strategy.html.erb file:

Small modifications have been made to the existing code that is the display of the table row with id 'meta' is given 'none' by default and also the status of the 'Has Meta-review Limit?' checkbox is changed to false. The below code snippet shows the modifications made:

[[File:Metareview5.PNG]]

we wrote a javascript code that handles the event triggered when the 'Use metareview deadline' checkbox has been checked or unchecked. In this javascript, the event triggered is handled by calling the 'onStorageEvent(storageEvent)' function. In this 'onStorageEvent' function we check the value in the local storage variable and based on that value we change the status of the display for the table row with id 'meta'.

[[File:Metareview4.PNG]]

Finally, the null value to the 'Has Meta-review Limit?' can be assigned during the creation of the table and on clicking the 'Has Meta-review Limit?' checkbox the UI displays '3' in the allowed number of metareviews that is num_metareviews_allowed variable is assigned '3'.

===Test Plan===
1. Ensure that when an assignment is created, the number of meta-reviews is set to null.

2. Ensure that the meta-review fields in the review strategy tab are visible only when 'Use metareview deadline' is enabled in the Due dates tab.

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-12-07T00:01:29Z

Smuvval: /* Solution and Code Modification for Issue 1 and 2 */

== '''Overview of Project''' ==

In Expertiza, meta-review is a feature that enables a third party to evaluate the quality of feedback that a reviewer gives a reviewee. meta-review is an important feature that can help students become better reviewers for their peers by providing detailed feedback that is actionable and positively formulated. Unfortunately, this feature is broken and the following issues were identified.

== '''Design Pattern''' ==
Design patterns are not applicable as our task involved just modification of existing methods.

== '''Issue1''' ==

===Issue Description===
When a user requests a new meta-review, (s)he should be able to click on the Begin button, which should redirect him/her to the meta-review questionnaire and when the user returns back (to the page where he can view the reviews and meta-reviews, by clicking on Others’ work in his/her assignment), (s)he should be then able to see view and update links for the meta-reviews (s)he has performed.

But the issue is Begin and Edit are not working for the given scenario.

===Existing Issue===
1. Log in as instructor6, click on Manage...-> Assignments

2. Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox

3. Select "Yes" for all of the following: Submission allowed, Review allowed and Meta-review allowed in all of the deadline types

4. Navigate back to Assignment Tree View and click on "Add participant"

5. Add couple of students(say student1 and student2) to the assignment

6. Impersonate/login as student1 and make a submission

7. Impersonate/login as student2 and Request for a new review under others work, submit the review

8. Impersonate/login back as student1 and Request for a new meta review

9. When Begin is clicked following will be displayed. Instead of this, the meta review page must be displayed. 

[[File:Expertiza project3 Issue1 E1997.png]]

10. A template must be added to fix the broken link

===Files to be modified===
response.html.erb

== '''Issue2''' ==

===Issue Description===
The number of meta-reviews(refer to the snapshot below),should decrease when a user requests a meta-review.Also, the button to request a new meta-review should not disappear until the total number of reviews assigned has reached the allowed limit.

===Existing Issue===
<li>Log in as instructor6, click on mange...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked, the meta-review count should be decremented. Currently, as clicking the begin button is not working, we are not sure if the counter is being decremented properly.

===Files to be modified===
<li>List.html.erb

== '''Design strategy For Issue1 and Issue 2''' ==

The flow chart below describes the design we choose to implement the above two issues

[[File:E1997_1.PNG]]

===Solution and Code Modification for Issue 1 and 2===
Basically, the file named 'response.html.erb'(Exact navigation: https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/response.html.erb) is looking for a partial named 'review'

==== Modification 1 ====
The code that expects partial is:
<%= render :partial => 'review', :locals => {:versions => @responses_versions} %>

We have created partial named _review.html.erb at https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/_review.html.erb
It is a simple partial with code as follows:

<% versions.each do |response| %>
<% rm = ResponseMap.find(response.map_id) %>
<% as = Assignment.find(rm.reviewed_object_id) %>
<% questionnaire = rm.questionnaire %>
<%= response.display_as_html() %>
<% end %>

---

==== Modification 2 ====
The response_controller.rb(controller that works in tandem with response.html.erb view, which was expecting partial) required a minute fix, which is,
- The existing code doesn't work if AssignmentTeam is found to be nil. Please check the below existing code:

if @response.nil? || AssignmentTeam.find(@map.reviewee_id).most_recent_submission.updated_at > @response.updated_at
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

The response is created(by Response.create) only if the 'if' condition is satisfied. The AssignmentTeam.find(@map.reviewee_id) shall return a nil(for metareviews), hence AssignmentTeam.find(@map.reviewee_id).most_recent_submission will throw an exception.

The problem is, assignment team will be nil for meta reviews. Hence, existing code won't work.

To cover this special nil case, we have modified the code as:

begin
assignment_team = AssignmentTeam.find(@map.reviewee_id)
rescue ActiveRecord::RecordNotFound => e
assignment_team = nil
end
if @response.nil? || (!assignment_team.nil? && assignment_team.most_recent_submission.updated_at > @response.updated_at)
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

==== Modification 3 ====
There's this issue of user being able to request and review more than allowed 'x' number of reviews. After user performed max allowed 'x' number of reviews, the button 'Request a new metareview to perform' shouldn't be visible. To handle this, following code change is made in file (https://github.com/VishnusRepo/expertiza/blob/master/app/views/student_review/list.html.erb)

<% if @assignment.num_metareviews_allowed - @num_metareviews_completed <= 0 %>
Note: You can not do more than <%=@assignment.num_metareviews_allowed%> metareviews according to assignment policy.
<% elsif @num_metareviews_in_progress == 0 %>
<%= render :partial => 'set_dynamic_metareview', :locals => {:assignment => @assignment} %>
<% end %>

The code in elsif block shows the button using which user can request more metareviews. By modifying the code as above, we shall not render the partial set_dynamic_metareview, which contains the request button.

By changing the code to above, we were able to handle the exceptions.

Both the Issues 1 and 2 are now solved. For the test setup we performed, following screenshot shows that we were able to do metareviews(Issue 1 done) and count of metareviews remaining is being reduced(Issue 2 done).

== '''Issue3''' ==
===Background:===
An instructor can edit an assignment and can choose whether to have metareview in it or not. He can do so by following the below steps:

1) From Manage>Assignments, click on the Edit Assignment button for the appropriate assignment.

2) On the Due Date tab, the instructor can select if (s)he wants to have meta-reviews done for the assignment, by clicking on the “Use meta-review deadline” checkbox and setting a meta-review deadline below.

3) Under the “Review Strategy” tab of edit assignment, the instructor can set Allowed and Required number of meta-reviews per reviewer by checking the Has meta-review Limit? checkbox.

===Issue Description===
For an assignment, when 'Use Metareview Deadline' is unchecked, it means meta-reviews are not enabled for that assignment. The checkbox is as below

[[File:issue3_1.png]]

As said, when this box is unchecked, it means there is no meta reviewing system for this assignment. The issue is, there are some meta review related fields that show up even if the above box is unchecked. Like in below image

[[File:issue3_2.png]]

Also, when a new issue is created, the default # of meta-reviews allowed and required should be null. As soon as someone checks the Has meta-review Limit box on the “Review Strategy” tab, the UI should fill in 3 and 3 as the required and allowed number. Of course, the user can change this number before submitting it.

===Solution and Code Modification for Issue 3===

As the checkbox and the content to be displayed on clicking the checkbox are located on different pages we cannot use the regular checkbox logic, so we used the concept of local storage and event listener.

we have made changes to the below two files:

1)/expertiza/app/views/assignments/edit/_due_dates.html.erb

2)/expertiza/app/views/assignments/edit/_review_strategy.html.erb

In the _due_dates.html.erb file:

There is an existing code where on clicking the checkbox 'Use metareview deadline', a function called 'removeOrAddMetareview()' is invoked. The code snippet below shows the existing code:

[[File:Metareview1.PNG]]

The 'removeOrAddMetareview()' is called on click of the 'Use metareview deadline' checkbox. Now we implemented two new functions which are invoked inside this function they are 'hideMetaReviewLimit()' and 'showMetaReviewLimit()'. This can be seen in the below code snippet

[[File:Metareview2.PNG]]

Now on clicking the 'Use metareview deadline' checkbox, the new code will invoke the 'removeOrAddMetareview()' function which indirectly invokes the two new functions.
Now let us look at the implementation of the two new functions, we used a local storage variable called 'meta'.So based on the status of the checkbox a value is assigned to the local storage variable. For example, if the 'Use metareview deadline' checkbox is checked then the local storage variable is initialized with the value 'show' and if the 'Use metareview deadline' checkbox is Unchecked we assign with the value 'hide' to the local storage variable. Now after storing the respective values for the local storage variable, the storage event is triggered by these functions. The below code snippet shows the implementation of the two new functions:

[[File:Metareview3.PNG]]

In _review_strategy.html.erb file:

Small modifications have been made to the existing code that is the display of the table row with id 'meta' is given 'none' by default and also the status of the 'Has Meta-review Limit?' checkbox is changed to false. The below code snippet shows the modifications made:

[[File:Metareview5.PNG]]

we wrote a javascript code that handles the event triggered when the 'Use metareview deadline' checkbox has been checked or unchecked. In this javascript, the event triggered is handled by calling the 'onStorageEvent(storageEvent)' function. In this 'onStorageEvent' function we check the value in the local storage variable and based on that value we change the status of the display for the table row with id 'meta'.

[[File:Metareview4.PNG]]

Finally, the null value to the 'Has Meta-review Limit?' can be assigned during the creation of the table and on clicking the 'Has Meta-review Limit?' checkbox the UI displays '3' in the allowed number of metareviews that is num_metareviews_allowed variable is assigned '3'.

===Test Plan===
1. Ensure that when an assignment is created, the number of meta-reviews is set to null.

2. Ensure that the meta-review fields in the review strategy tab are visible only when 'Use metareview deadline' is enabled in the Due dates tab.

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-12-06T23:51:00Z

Smuvval: /* Modification 1 */

== '''Overview of Project''' ==

In Expertiza, meta-review is a feature that enables a third party to evaluate the quality of feedback that a reviewer gives a reviewee. meta-review is an important feature that can help students become better reviewers for their peers by providing detailed feedback that is actionable and positively formulated. Unfortunately, this feature is broken and the following issues were identified.

== '''Design Pattern''' ==
Design patterns are not applicable as our task involved just modification of existing methods.

== '''Issue1''' ==

===Issue Description===
When a user requests a new meta-review, (s)he should be able to click on the Begin button, which should redirect him/her to the meta-review questionnaire and when the user returns back (to the page where he can view the reviews and meta-reviews, by clicking on Others’ work in his/her assignment), (s)he should be then able to see view and update links for the meta-reviews (s)he has performed.

But the issue is Begin and Edit are not working for the given scenario.

===Existing Issue===
1. Log in as instructor6, click on Manage...-> Assignments

2. Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox

3. Select "Yes" for all of the following: Submission allowed, Review allowed and Meta-review allowed in all of the deadline types

4. Navigate back to Assignment Tree View and click on "Add participant"

5. Add couple of students(say student1 and student2) to the assignment

6. Impersonate/login as student1 and make a submission

7. Impersonate/login as student2 and Request for a new review under others work, submit the review

8. Impersonate/login back as student1 and Request for a new meta review

9. When Begin is clicked following will be displayed. Instead of this, the meta review page must be displayed. 

[[File:Expertiza project3 Issue1 E1997.png]]

10. A template must be added to fix the broken link

===Files to be modified===
response.html.erb

== '''Issue2''' ==

===Issue Description===
The number of meta-reviews(refer to the snapshot below),should decrease when a user requests a meta-review.Also, the button to request a new meta-review should not disappear until the total number of reviews assigned has reached the allowed limit.

===Existing Issue===
<li>Log in as instructor6, click on mange...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked, the meta-review count should be decremented. Currently, as clicking the begin button is not working, we are not sure if the counter is being decremented properly.

===Files to be modified===
<li>List.html.erb

== '''Design strategy For Issue1 and Issue 2''' ==

The flow chart below describes the design we choose to implement the above two issues

[[File:E1997_1.PNG]]

===Solution and Code Modification for Issue 1 and 2===
Basically, the file named 'response.html.erb'(Exact navigation: https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/response.html.erb) is looking for a partial named 'review'

==== Modification 1 ====
The code that expects partial is:
<%= render :partial => 'review', :locals => {:versions => @responses_versions} %>

We have created partial named _review.html.erb at https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/_review.html.erb
It is a simple partial with code as follows:

<% versions.each do |response| %>
<% rm = ResponseMap.find(response.map_id) %>
<% as = Assignment.find(rm.reviewed_object_id) %>
<% questionnaire = rm.questionnaire %>
<%= response.display_as_html() %>
<% end %>

---

==== Modification 2 ====
The response_controller.rb(controller that works in tandem with response.html.erb view, which was expecting partial) required a minute fix, which is,
- The existing code doesn't work if AssignmentTeam is found to be nil. Please check the below existing code:

if @response.nil? || AssignmentTeam.find(@map.reviewee_id).most_recent_submission.updated_at > @response.updated_at
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

The response is created(by Response.create) only if the 'if' condition is satisfied. The AssignmentTeam.find(@map.reviewee_id) shall return a nil(for metareviews), hence AssignmentTeam.find(@map.reviewee_id).most_recent_submission will throw an exception.

The problem is, assignment team will be nil for meta reviews. Hence, existing code won't work.

To cover this special nil case, we have modified the code as:

begin
assignment_team = AssignmentTeam.find(@map.reviewee_id)
rescue
assignment_team = nil
end
if @response.nil? || (!assignment_team.nil? && assignment_team.most_recent_submission.updated_at > @response.updated_at)
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

By changing the code to above, we were able to handle the exceptions.

When you click other's work for an assignment, you will navigate to Reviews/metareviews page(for navigation understanding, example URL: http://152.46.16.18:8080/student_review/list?id=36223). The

== '''Issue3''' ==
===Background:===
An instructor can edit an assignment and can choose whether to have metareview in it or not. He can do so by following the below steps:

1) From Manage>Assignments, click on the Edit Assignment button for the appropriate assignment.

2) On the Due Date tab, the instructor can select if (s)he wants to have meta-reviews done for the assignment, by clicking on the “Use meta-review deadline” checkbox and setting a meta-review deadline below.

3) Under the “Review Strategy” tab of edit assignment, the instructor can set Allowed and Required number of meta-reviews per reviewer by checking the Has meta-review Limit? checkbox.

===Issue Description===
For an assignment, when 'Use Metareview Deadline' is unchecked, it means meta-reviews are not enabled for that assignment. The checkbox is as below

[[File:issue3_1.png]]

As said, when this box is unchecked, it means there is no meta reviewing system for this assignment. The issue is, there are some meta review related fields that show up even if the above box is unchecked. Like in below image

[[File:issue3_2.png]]

Also, when a new issue is created, the default # of meta-reviews allowed and required should be null. As soon as someone checks the Has meta-review Limit box on the “Review Strategy” tab, the UI should fill in 3 and 3 as the required and allowed number. Of course, the user can change this number before submitting it.

===Solution and Code Modification for Issue 3===

As the checkbox and the content to be displayed on clicking the checkbox are located on different pages we cannot use the regular checkbox logic, so we used the concept of local storage and event listener.

we have made changes to the below two files:

1)/expertiza/app/views/assignments/edit/_due_dates.html.erb

2)/expertiza/app/views/assignments/edit/_review_strategy.html.erb

In the _due_dates.html.erb file:

There is an existing code where on clicking the checkbox 'Use metareview deadline', a function called 'removeOrAddMetareview()' is invoked. The code snippet below shows the existing code:

[[File:Metareview1.PNG]]

The 'removeOrAddMetareview()' is called on click of the 'Use metareview deadline' checkbox. Now we implemented two new functions which are invoked inside this function they are 'hideMetaReviewLimit()' and 'showMetaReviewLimit()'. This can be seen in the below code snippet

[[File:Metareview2.PNG]]

Now on clicking the 'Use metareview deadline' checkbox, the new code will invoke the 'removeOrAddMetareview()' function which indirectly invokes the two new functions.
Now let us look at the implementation of the two new functions, we used a local storage variable called 'meta'.So based on the status of the checkbox a value is assigned to the local storage variable. For example, if the 'Use metareview deadline' checkbox is checked then the local storage variable is initialized with the value 'show' and if the 'Use metareview deadline' checkbox is Unchecked we assign with the value 'hide' to the local storage variable. Now after storing the respective values for the local storage variable, the storage event is triggered by these functions. The below code snippet shows the implementation of the two new functions:

[[File:Metareview3.PNG]]

In _review_strategy.html.erb file:

Small modifications have been made to the existing code that is the display of the table row with id 'meta' is given 'none' by default and also the status of the 'Has Meta-review Limit?' checkbox is changed to false. The below code snippet shows the modifications made:

[[File:Metareview5.PNG]]

we wrote a javascript code that handles the event triggered when the 'Use metareview deadline' checkbox has been checked or unchecked. In this javascript, the event triggered is handled by calling the 'onStorageEvent(storageEvent)' function. In this 'onStorageEvent' function we check the value in the local storage variable and based on that value we change the status of the display for the table row with id 'meta'.

[[File:Metareview4.PNG]]

Finally, the null value to the 'Has Meta-review Limit?' can be assigned during the creation of the table and on clicking the 'Has Meta-review Limit?' checkbox the UI displays '3' in the allowed number of metareviews that is num_metareviews_allowed variable is assigned '3'.

===Test Plan===
1. Ensure that when an assignment is created, the number of meta-reviews is set to null.

2. Ensure that the meta-review fields in the review strategy tab are visible only when 'Use metareview deadline' is enabled in the Due dates tab.

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-12-06T23:50:32Z

Smuvval: /* Modification 1 */

== '''Overview of Project''' ==

In Expertiza, meta-review is a feature that enables a third party to evaluate the quality of feedback that a reviewer gives a reviewee. meta-review is an important feature that can help students become better reviewers for their peers by providing detailed feedback that is actionable and positively formulated. Unfortunately, this feature is broken and the following issues were identified.

== '''Design Pattern''' ==
Design patterns are not applicable as our task involved just modification of existing methods.

== '''Issue1''' ==

===Issue Description===
When a user requests a new meta-review, (s)he should be able to click on the Begin button, which should redirect him/her to the meta-review questionnaire and when the user returns back (to the page where he can view the reviews and meta-reviews, by clicking on Others’ work in his/her assignment), (s)he should be then able to see view and update links for the meta-reviews (s)he has performed.

But the issue is Begin and Edit are not working for the given scenario.

===Existing Issue===
1. Log in as instructor6, click on Manage...-> Assignments

2. Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox

3. Select "Yes" for all of the following: Submission allowed, Review allowed and Meta-review allowed in all of the deadline types

4. Navigate back to Assignment Tree View and click on "Add participant"

5. Add couple of students(say student1 and student2) to the assignment

6. Impersonate/login as student1 and make a submission

7. Impersonate/login as student2 and Request for a new review under others work, submit the review

8. Impersonate/login back as student1 and Request for a new meta review

9. When Begin is clicked following will be displayed. Instead of this, the meta review page must be displayed. 

[[File:Expertiza project3 Issue1 E1997.png]]

10. A template must be added to fix the broken link

===Files to be modified===
response.html.erb

== '''Issue2''' ==

===Issue Description===
The number of meta-reviews(refer to the snapshot below),should decrease when a user requests a meta-review.Also, the button to request a new meta-review should not disappear until the total number of reviews assigned has reached the allowed limit.

===Existing Issue===
<li>Log in as instructor6, click on mange...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked, the meta-review count should be decremented. Currently, as clicking the begin button is not working, we are not sure if the counter is being decremented properly.

===Files to be modified===
<li>List.html.erb

== '''Design strategy For Issue1 and Issue 2''' ==

The flow chart below describes the design we choose to implement the above two issues

[[File:E1997_1.PNG]]

===Solution and Code Modification for Issue 1 and 2===
Basically, the file named 'response.html.erb'(Exact navigation: https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/response.html.erb) is looking for a partial named 'review'

==== Modification 1 ====
The code that expects partial is:
<%= render :partial => 'review', :locals => {:versions => @responses_versions} %>

We have created partial named _review.html.erb at https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/_review.html.erb
It is a simple partial with code as follows:

<% versions.each do |response| %>
<% rm = ResponseMap.find(response.map_id) %>
<% as = Assignment.find(rm.reviewed_object_id) %>
<% questionnaire = rm.questionnaire %>
<%= response.display_as_html()+" <hr/> " %>
<% end %>

---

==== Modification 2 ====
The response_controller.rb(controller that works in tandem with response.html.erb view, which was expecting partial) required a minute fix, which is,
- The existing code doesn't work if AssignmentTeam is found to be nil. Please check the below existing code:

if @response.nil? || AssignmentTeam.find(@map.reviewee_id).most_recent_submission.updated_at > @response.updated_at
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

The response is created(by Response.create) only if the 'if' condition is satisfied. The AssignmentTeam.find(@map.reviewee_id) shall return a nil(for metareviews), hence AssignmentTeam.find(@map.reviewee_id).most_recent_submission will throw an exception.

The problem is, assignment team will be nil for meta reviews. Hence, existing code won't work.

To cover this special nil case, we have modified the code as:

begin
assignment_team = AssignmentTeam.find(@map.reviewee_id)
rescue
assignment_team = nil
end
if @response.nil? || (!assignment_team.nil? && assignment_team.most_recent_submission.updated_at > @response.updated_at)
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

By changing the code to above, we were able to handle the exceptions.

When you click other's work for an assignment, you will navigate to Reviews/metareviews page(for navigation understanding, example URL: http://152.46.16.18:8080/student_review/list?id=36223). The

== '''Issue3''' ==
===Background:===
An instructor can edit an assignment and can choose whether to have metareview in it or not. He can do so by following the below steps:

1) From Manage>Assignments, click on the Edit Assignment button for the appropriate assignment.

2) On the Due Date tab, the instructor can select if (s)he wants to have meta-reviews done for the assignment, by clicking on the “Use meta-review deadline” checkbox and setting a meta-review deadline below.

3) Under the “Review Strategy” tab of edit assignment, the instructor can set Allowed and Required number of meta-reviews per reviewer by checking the Has meta-review Limit? checkbox.

===Issue Description===
For an assignment, when 'Use Metareview Deadline' is unchecked, it means meta-reviews are not enabled for that assignment. The checkbox is as below

[[File:issue3_1.png]]

As said, when this box is unchecked, it means there is no meta reviewing system for this assignment. The issue is, there are some meta review related fields that show up even if the above box is unchecked. Like in below image

[[File:issue3_2.png]]

Also, when a new issue is created, the default # of meta-reviews allowed and required should be null. As soon as someone checks the Has meta-review Limit box on the “Review Strategy” tab, the UI should fill in 3 and 3 as the required and allowed number. Of course, the user can change this number before submitting it.

===Solution and Code Modification for Issue 3===

As the checkbox and the content to be displayed on clicking the checkbox are located on different pages we cannot use the regular checkbox logic, so we used the concept of local storage and event listener.

we have made changes to the below two files:

1)/expertiza/app/views/assignments/edit/_due_dates.html.erb

2)/expertiza/app/views/assignments/edit/_review_strategy.html.erb

In the _due_dates.html.erb file:

There is an existing code where on clicking the checkbox 'Use metareview deadline', a function called 'removeOrAddMetareview()' is invoked. The code snippet below shows the existing code:

[[File:Metareview1.PNG]]

The 'removeOrAddMetareview()' is called on click of the 'Use metareview deadline' checkbox. Now we implemented two new functions which are invoked inside this function they are 'hideMetaReviewLimit()' and 'showMetaReviewLimit()'. This can be seen in the below code snippet

[[File:Metareview2.PNG]]

Now on clicking the 'Use metareview deadline' checkbox, the new code will invoke the 'removeOrAddMetareview()' function which indirectly invokes the two new functions.
Now let us look at the implementation of the two new functions, we used a local storage variable called 'meta'.So based on the status of the checkbox a value is assigned to the local storage variable. For example, if the 'Use metareview deadline' checkbox is checked then the local storage variable is initialized with the value 'show' and if the 'Use metareview deadline' checkbox is Unchecked we assign with the value 'hide' to the local storage variable. Now after storing the respective values for the local storage variable, the storage event is triggered by these functions. The below code snippet shows the implementation of the two new functions:

[[File:Metareview3.PNG]]

In _review_strategy.html.erb file:

Small modifications have been made to the existing code that is the display of the table row with id 'meta' is given 'none' by default and also the status of the 'Has Meta-review Limit?' checkbox is changed to false. The below code snippet shows the modifications made:

[[File:Metareview5.PNG]]

we wrote a javascript code that handles the event triggered when the 'Use metareview deadline' checkbox has been checked or unchecked. In this javascript, the event triggered is handled by calling the 'onStorageEvent(storageEvent)' function. In this 'onStorageEvent' function we check the value in the local storage variable and based on that value we change the status of the display for the table row with id 'meta'.

[[File:Metareview4.PNG]]

Finally, the null value to the 'Has Meta-review Limit?' can be assigned during the creation of the table and on clicking the 'Has Meta-review Limit?' checkbox the UI displays '3' in the allowed number of metareviews that is num_metareviews_allowed variable is assigned '3'.

===Test Plan===
1. Ensure that when an assignment is created, the number of meta-reviews is set to null.

2. Ensure that the meta-review fields in the review strategy tab are visible only when 'Use metareview deadline' is enabled in the Due dates tab.

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-12-06T23:50:10Z

Smuvval: /* Modification 1 */

== '''Overview of Project''' ==

In Expertiza, meta-review is a feature that enables a third party to evaluate the quality of feedback that a reviewer gives a reviewee. meta-review is an important feature that can help students become better reviewers for their peers by providing detailed feedback that is actionable and positively formulated. Unfortunately, this feature is broken and the following issues were identified.

== '''Design Pattern''' ==
Design patterns are not applicable as our task involved just modification of existing methods.

== '''Issue1''' ==

===Issue Description===
When a user requests a new meta-review, (s)he should be able to click on the Begin button, which should redirect him/her to the meta-review questionnaire and when the user returns back (to the page where he can view the reviews and meta-reviews, by clicking on Others’ work in his/her assignment), (s)he should be then able to see view and update links for the meta-reviews (s)he has performed.

But the issue is Begin and Edit are not working for the given scenario.

===Existing Issue===
1. Log in as instructor6, click on Manage...-> Assignments

2. Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox

3. Select "Yes" for all of the following: Submission allowed, Review allowed and Meta-review allowed in all of the deadline types

4. Navigate back to Assignment Tree View and click on "Add participant"

5. Add couple of students(say student1 and student2) to the assignment

6. Impersonate/login as student1 and make a submission

7. Impersonate/login as student2 and Request for a new review under others work, submit the review

8. Impersonate/login back as student1 and Request for a new meta review

9. When Begin is clicked following will be displayed. Instead of this, the meta review page must be displayed. 

[[File:Expertiza project3 Issue1 E1997.png]]

10. A template must be added to fix the broken link

===Files to be modified===
response.html.erb

== '''Issue2''' ==

===Issue Description===
The number of meta-reviews(refer to the snapshot below),should decrease when a user requests a meta-review.Also, the button to request a new meta-review should not disappear until the total number of reviews assigned has reached the allowed limit.

===Existing Issue===
<li>Log in as instructor6, click on mange...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked, the meta-review count should be decremented. Currently, as clicking the begin button is not working, we are not sure if the counter is being decremented properly.

===Files to be modified===
<li>List.html.erb

== '''Design strategy For Issue1 and Issue 2''' ==

The flow chart below describes the design we choose to implement the above two issues

[[File:E1997_1.PNG]]

===Solution and Code Modification for Issue 1 and 2===
Basically, the file named 'response.html.erb'(Exact navigation: https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/response.html.erb) is looking for a partial named 'review'

==== Modification 1 ====
The code that expects partial is:
<%= render :partial => 'review', :locals => {:versions => @responses_versions} %>

We have created partial named _review.html.erb at https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/_review.html.erb
It is a simple partial with code as follows:

<% versions.each do |response| %>
<% rm = ResponseMap.find(response.map_id) %>
<% as = Assignment.find(rm.reviewed_object_id) %>
<% questionnaire = rm.questionnaire %>
<%= response.display_as_html()+" <hr/> " %>
<% end %>

==== Modification 2 ====
The response_controller.rb(controller that works in tandem with response.html.erb view, which was expecting partial) required a minute fix, which is,
- The existing code doesn't work if AssignmentTeam is found to be nil. Please check the below existing code:

if @response.nil? || AssignmentTeam.find(@map.reviewee_id).most_recent_submission.updated_at > @response.updated_at
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

The response is created(by Response.create) only if the 'if' condition is satisfied. The AssignmentTeam.find(@map.reviewee_id) shall return a nil(for metareviews), hence AssignmentTeam.find(@map.reviewee_id).most_recent_submission will throw an exception.

The problem is, assignment team will be nil for meta reviews. Hence, existing code won't work.

To cover this special nil case, we have modified the code as:

begin
assignment_team = AssignmentTeam.find(@map.reviewee_id)
rescue
assignment_team = nil
end
if @response.nil? || (!assignment_team.nil? && assignment_team.most_recent_submission.updated_at > @response.updated_at)
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

By changing the code to above, we were able to handle the exceptions.

When you click other's work for an assignment, you will navigate to Reviews/metareviews page(for navigation understanding, example URL: http://152.46.16.18:8080/student_review/list?id=36223). The

== '''Issue3''' ==
===Background:===
An instructor can edit an assignment and can choose whether to have metareview in it or not. He can do so by following the below steps:

1) From Manage>Assignments, click on the Edit Assignment button for the appropriate assignment.

2) On the Due Date tab, the instructor can select if (s)he wants to have meta-reviews done for the assignment, by clicking on the “Use meta-review deadline” checkbox and setting a meta-review deadline below.

3) Under the “Review Strategy” tab of edit assignment, the instructor can set Allowed and Required number of meta-reviews per reviewer by checking the Has meta-review Limit? checkbox.

===Issue Description===
For an assignment, when 'Use Metareview Deadline' is unchecked, it means meta-reviews are not enabled for that assignment. The checkbox is as below

[[File:issue3_1.png]]

As said, when this box is unchecked, it means there is no meta reviewing system for this assignment. The issue is, there are some meta review related fields that show up even if the above box is unchecked. Like in below image

[[File:issue3_2.png]]

Also, when a new issue is created, the default # of meta-reviews allowed and required should be null. As soon as someone checks the Has meta-review Limit box on the “Review Strategy” tab, the UI should fill in 3 and 3 as the required and allowed number. Of course, the user can change this number before submitting it.

===Solution and Code Modification for Issue 3===

As the checkbox and the content to be displayed on clicking the checkbox are located on different pages we cannot use the regular checkbox logic, so we used the concept of local storage and event listener.

we have made changes to the below two files:

1)/expertiza/app/views/assignments/edit/_due_dates.html.erb

2)/expertiza/app/views/assignments/edit/_review_strategy.html.erb

In the _due_dates.html.erb file:

There is an existing code where on clicking the checkbox 'Use metareview deadline', a function called 'removeOrAddMetareview()' is invoked. The code snippet below shows the existing code:

[[File:Metareview1.PNG]]

The 'removeOrAddMetareview()' is called on click of the 'Use metareview deadline' checkbox. Now we implemented two new functions which are invoked inside this function they are 'hideMetaReviewLimit()' and 'showMetaReviewLimit()'. This can be seen in the below code snippet

[[File:Metareview2.PNG]]

Now on clicking the 'Use metareview deadline' checkbox, the new code will invoke the 'removeOrAddMetareview()' function which indirectly invokes the two new functions.
Now let us look at the implementation of the two new functions, we used a local storage variable called 'meta'.So based on the status of the checkbox a value is assigned to the local storage variable. For example, if the 'Use metareview deadline' checkbox is checked then the local storage variable is initialized with the value 'show' and if the 'Use metareview deadline' checkbox is Unchecked we assign with the value 'hide' to the local storage variable. Now after storing the respective values for the local storage variable, the storage event is triggered by these functions. The below code snippet shows the implementation of the two new functions:

[[File:Metareview3.PNG]]

In _review_strategy.html.erb file:

Small modifications have been made to the existing code that is the display of the table row with id 'meta' is given 'none' by default and also the status of the 'Has Meta-review Limit?' checkbox is changed to false. The below code snippet shows the modifications made:

[[File:Metareview5.PNG]]

we wrote a javascript code that handles the event triggered when the 'Use metareview deadline' checkbox has been checked or unchecked. In this javascript, the event triggered is handled by calling the 'onStorageEvent(storageEvent)' function. In this 'onStorageEvent' function we check the value in the local storage variable and based on that value we change the status of the display for the table row with id 'meta'.

[[File:Metareview4.PNG]]

Finally, the null value to the 'Has Meta-review Limit?' can be assigned during the creation of the table and on clicking the 'Has Meta-review Limit?' checkbox the UI displays '3' in the allowed number of metareviews that is num_metareviews_allowed variable is assigned '3'.

===Test Plan===
1. Ensure that when an assignment is created, the number of meta-reviews is set to null.

2. Ensure that the meta-review fields in the review strategy tab are visible only when 'Use metareview deadline' is enabled in the Due dates tab.

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-12-06T23:49:43Z

Smuvval: /* Modification 2 */

== '''Overview of Project''' ==

In Expertiza, meta-review is a feature that enables a third party to evaluate the quality of feedback that a reviewer gives a reviewee. meta-review is an important feature that can help students become better reviewers for their peers by providing detailed feedback that is actionable and positively formulated. Unfortunately, this feature is broken and the following issues were identified.

== '''Design Pattern''' ==
Design patterns are not applicable as our task involved just modification of existing methods.

== '''Issue1''' ==

===Issue Description===
When a user requests a new meta-review, (s)he should be able to click on the Begin button, which should redirect him/her to the meta-review questionnaire and when the user returns back (to the page where he can view the reviews and meta-reviews, by clicking on Others’ work in his/her assignment), (s)he should be then able to see view and update links for the meta-reviews (s)he has performed.

But the issue is Begin and Edit are not working for the given scenario.

===Existing Issue===
1. Log in as instructor6, click on Manage...-> Assignments

2. Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox

3. Select "Yes" for all of the following: Submission allowed, Review allowed and Meta-review allowed in all of the deadline types

4. Navigate back to Assignment Tree View and click on "Add participant"

5. Add couple of students(say student1 and student2) to the assignment

6. Impersonate/login as student1 and make a submission

7. Impersonate/login as student2 and Request for a new review under others work, submit the review

8. Impersonate/login back as student1 and Request for a new meta review

9. When Begin is clicked following will be displayed. Instead of this, the meta review page must be displayed. 

[[File:Expertiza project3 Issue1 E1997.png]]

10. A template must be added to fix the broken link

===Files to be modified===
response.html.erb

== '''Issue2''' ==

===Issue Description===
The number of meta-reviews(refer to the snapshot below),should decrease when a user requests a meta-review.Also, the button to request a new meta-review should not disappear until the total number of reviews assigned has reached the allowed limit.

===Existing Issue===
<li>Log in as instructor6, click on mange...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked, the meta-review count should be decremented. Currently, as clicking the begin button is not working, we are not sure if the counter is being decremented properly.

===Files to be modified===
<li>List.html.erb

== '''Design strategy For Issue1 and Issue 2''' ==

The flow chart below describes the design we choose to implement the above two issues

[[File:E1997_1.PNG]]

===Solution and Code Modification for Issue 1 and 2===
Basically, the file named 'response.html.erb'(Exact navigation: https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/response.html.erb) is looking for a partial named 'review'

==== Modification 1 ====
The code that expects partial is:
<%= render :partial => 'review', :locals => {:versions => @responses_versions} %>

We have created partial named _review.html.erb at https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/_review.html.erb
It is a simple partial with code as follows:

<% versions.each do |response| %>
<% rm = ResponseMap.find(response.map_id) %>
<% as = Assignment.find(rm.reviewed_object_id) %>
<% questionnaire = rm.questionnaire %>
<%= response.display_as_html()+" <hr/> " %>
<% end %>

==== Modification 2 ====
The response_controller.rb(controller that works in tandem with response.html.erb view, which was expecting partial) required a minute fix, which is,
- The existing code doesn't work if AssignmentTeam is found to be nil. Please check the below existing code:

if @response.nil? || AssignmentTeam.find(@map.reviewee_id).most_recent_submission.updated_at > @response.updated_at
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

The response is created(by Response.create) only if the 'if' condition is satisfied. The AssignmentTeam.find(@map.reviewee_id) shall return a nil(for metareviews), hence AssignmentTeam.find(@map.reviewee_id).most_recent_submission will throw an exception.

The problem is, assignment team will be nil for meta reviews. Hence, existing code won't work.

To cover this special nil case, we have modified the code as:

begin
assignment_team = AssignmentTeam.find(@map.reviewee_id)
rescue
assignment_team = nil
end
if @response.nil? || (!assignment_team.nil? && assignment_team.most_recent_submission.updated_at > @response.updated_at)
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

By changing the code to above, we were able to handle the exceptions.

When you click other's work for an assignment, you will navigate to Reviews/metareviews page(for navigation understanding, example URL: http://152.46.16.18:8080/student_review/list?id=36223). The

== '''Issue3''' ==
===Background:===
An instructor can edit an assignment and can choose whether to have metareview in it or not. He can do so by following the below steps:

1) From Manage>Assignments, click on the Edit Assignment button for the appropriate assignment.

2) On the Due Date tab, the instructor can select if (s)he wants to have meta-reviews done for the assignment, by clicking on the “Use meta-review deadline” checkbox and setting a meta-review deadline below.

3) Under the “Review Strategy” tab of edit assignment, the instructor can set Allowed and Required number of meta-reviews per reviewer by checking the Has meta-review Limit? checkbox.

===Issue Description===
For an assignment, when 'Use Metareview Deadline' is unchecked, it means meta-reviews are not enabled for that assignment. The checkbox is as below

[[File:issue3_1.png]]

As said, when this box is unchecked, it means there is no meta reviewing system for this assignment. The issue is, there are some meta review related fields that show up even if the above box is unchecked. Like in below image

[[File:issue3_2.png]]

Also, when a new issue is created, the default # of meta-reviews allowed and required should be null. As soon as someone checks the Has meta-review Limit box on the “Review Strategy” tab, the UI should fill in 3 and 3 as the required and allowed number. Of course, the user can change this number before submitting it.

===Solution and Code Modification for Issue 3===

As the checkbox and the content to be displayed on clicking the checkbox are located on different pages we cannot use the regular checkbox logic, so we used the concept of local storage and event listener.

we have made changes to the below two files:

1)/expertiza/app/views/assignments/edit/_due_dates.html.erb

2)/expertiza/app/views/assignments/edit/_review_strategy.html.erb

In the _due_dates.html.erb file:

There is an existing code where on clicking the checkbox 'Use metareview deadline', a function called 'removeOrAddMetareview()' is invoked. The code snippet below shows the existing code:

[[File:Metareview1.PNG]]

The 'removeOrAddMetareview()' is called on click of the 'Use metareview deadline' checkbox. Now we implemented two new functions which are invoked inside this function they are 'hideMetaReviewLimit()' and 'showMetaReviewLimit()'. This can be seen in the below code snippet

[[File:Metareview2.PNG]]

Now on clicking the 'Use metareview deadline' checkbox, the new code will invoke the 'removeOrAddMetareview()' function which indirectly invokes the two new functions.
Now let us look at the implementation of the two new functions, we used a local storage variable called 'meta'.So based on the status of the checkbox a value is assigned to the local storage variable. For example, if the 'Use metareview deadline' checkbox is checked then the local storage variable is initialized with the value 'show' and if the 'Use metareview deadline' checkbox is Unchecked we assign with the value 'hide' to the local storage variable. Now after storing the respective values for the local storage variable, the storage event is triggered by these functions. The below code snippet shows the implementation of the two new functions:

[[File:Metareview3.PNG]]

In _review_strategy.html.erb file:

Small modifications have been made to the existing code that is the display of the table row with id 'meta' is given 'none' by default and also the status of the 'Has Meta-review Limit?' checkbox is changed to false. The below code snippet shows the modifications made:

[[File:Metareview5.PNG]]

we wrote a javascript code that handles the event triggered when the 'Use metareview deadline' checkbox has been checked or unchecked. In this javascript, the event triggered is handled by calling the 'onStorageEvent(storageEvent)' function. In this 'onStorageEvent' function we check the value in the local storage variable and based on that value we change the status of the display for the table row with id 'meta'.

[[File:Metareview4.PNG]]

Finally, the null value to the 'Has Meta-review Limit?' can be assigned during the creation of the table and on clicking the 'Has Meta-review Limit?' checkbox the UI displays '3' in the allowed number of metareviews that is num_metareviews_allowed variable is assigned '3'.

===Test Plan===
1. Ensure that when an assignment is created, the number of meta-reviews is set to null.

2. Ensure that the meta-review fields in the review strategy tab are visible only when 'Use metareview deadline' is enabled in the Due dates tab.

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-12-06T23:48:44Z

Smuvval: /* Modification 1 */

== '''Overview of Project''' ==

In Expertiza, meta-review is a feature that enables a third party to evaluate the quality of feedback that a reviewer gives a reviewee. meta-review is an important feature that can help students become better reviewers for their peers by providing detailed feedback that is actionable and positively formulated. Unfortunately, this feature is broken and the following issues were identified.

== '''Design Pattern''' ==
Design patterns are not applicable as our task involved just modification of existing methods.

== '''Issue1''' ==

===Issue Description===
When a user requests a new meta-review, (s)he should be able to click on the Begin button, which should redirect him/her to the meta-review questionnaire and when the user returns back (to the page where he can view the reviews and meta-reviews, by clicking on Others’ work in his/her assignment), (s)he should be then able to see view and update links for the meta-reviews (s)he has performed.

But the issue is Begin and Edit are not working for the given scenario.

===Existing Issue===
1. Log in as instructor6, click on Manage...-> Assignments

2. Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox

3. Select "Yes" for all of the following: Submission allowed, Review allowed and Meta-review allowed in all of the deadline types

4. Navigate back to Assignment Tree View and click on "Add participant"

5. Add couple of students(say student1 and student2) to the assignment

6. Impersonate/login as student1 and make a submission

7. Impersonate/login as student2 and Request for a new review under others work, submit the review

8. Impersonate/login back as student1 and Request for a new meta review

9. When Begin is clicked following will be displayed. Instead of this, the meta review page must be displayed. 

[[File:Expertiza project3 Issue1 E1997.png]]

10. A template must be added to fix the broken link

===Files to be modified===
response.html.erb

== '''Issue2''' ==

===Issue Description===
The number of meta-reviews(refer to the snapshot below),should decrease when a user requests a meta-review.Also, the button to request a new meta-review should not disappear until the total number of reviews assigned has reached the allowed limit.

===Existing Issue===
<li>Log in as instructor6, click on mange...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked, the meta-review count should be decremented. Currently, as clicking the begin button is not working, we are not sure if the counter is being decremented properly.

===Files to be modified===
<li>List.html.erb

== '''Design strategy For Issue1 and Issue 2''' ==

The flow chart below describes the design we choose to implement the above two issues

[[File:E1997_1.PNG]]

===Solution and Code Modification for Issue 1 and 2===
Basically, the file named 'response.html.erb'(Exact navigation: https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/response.html.erb) is looking for a partial named 'review'

==== Modification 1 ====
The code that expects partial is:
<%= render :partial => 'review', :locals => {:versions => @responses_versions} %>

We have created partial named _review.html.erb at https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/_review.html.erb
It is a simple partial with code as follows:

<% versions.each do |response| %>
<% rm = ResponseMap.find(response.map_id) %>
<% as = Assignment.find(rm.reviewed_object_id) %>
<% questionnaire = rm.questionnaire %>
<%= response.display_as_html()+" <hr/> " %>
<% end %>

==== Modification 2 ====
The response_controller.rb(controller that works in tandem with response.html.erb view, which was expecting partial) required a minute fix, which is,
- The existing code doesn't work if AssignmentTeam is found to be nil. Please check the below existing code:

if @response.nil? || AssignmentTeam.find(@map.reviewee_id).most_recent_submission.updated_at > @response.updated_at
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

The response is created(by Response.create) only if the 'if' condition is satisfied. The AssignmentTeam.find(@map.reviewee_id) shall return a nil(for metareviews), hence AssignmentTeam.find(@map.reviewee_id).most_recent_submission will throw an exception.

The problem is, assignment team will be nil for meta reviews. Hence, existing code won't work.

To cover this special nil case, we have modified the code as:

begin
assignment_team = AssignmentTeam.find(@map.reviewee_id)
rescue
assignment_team = nil
end
if @response.nil? || (!assignment_team.nil? && assignment_team.most_recent_submission.updated_at > @response.updated_at)
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

By changing the code to above, we were able to handle the exceptions.

When you click other's work for an assignment, you will navigate to Reviews/metareviews page(for navigation understanding, example URL: http://152.46.16.18:8080/student_review/list?id=36223). The

== '''Issue3''' ==
===Background:===
An instructor can edit an assignment and can choose whether to have metareview in it or not. He can do so by following the below steps:

1) From Manage>Assignments, click on the Edit Assignment button for the appropriate assignment.

2) On the Due Date tab, the instructor can select if (s)he wants to have meta-reviews done for the assignment, by clicking on the “Use meta-review deadline” checkbox and setting a meta-review deadline below.

3) Under the “Review Strategy” tab of edit assignment, the instructor can set Allowed and Required number of meta-reviews per reviewer by checking the Has meta-review Limit? checkbox.

===Issue Description===
For an assignment, when 'Use Metareview Deadline' is unchecked, it means meta-reviews are not enabled for that assignment. The checkbox is as below

[[File:issue3_1.png]]

As said, when this box is unchecked, it means there is no meta reviewing system for this assignment. The issue is, there are some meta review related fields that show up even if the above box is unchecked. Like in below image

[[File:issue3_2.png]]

Also, when a new issue is created, the default # of meta-reviews allowed and required should be null. As soon as someone checks the Has meta-review Limit box on the “Review Strategy” tab, the UI should fill in 3 and 3 as the required and allowed number. Of course, the user can change this number before submitting it.

===Solution and Code Modification for Issue 3===

As the checkbox and the content to be displayed on clicking the checkbox are located on different pages we cannot use the regular checkbox logic, so we used the concept of local storage and event listener.

we have made changes to the below two files:

1)/expertiza/app/views/assignments/edit/_due_dates.html.erb

2)/expertiza/app/views/assignments/edit/_review_strategy.html.erb

In the _due_dates.html.erb file:

There is an existing code where on clicking the checkbox 'Use metareview deadline', a function called 'removeOrAddMetareview()' is invoked. The code snippet below shows the existing code:

[[File:Metareview1.PNG]]

The 'removeOrAddMetareview()' is called on click of the 'Use metareview deadline' checkbox. Now we implemented two new functions which are invoked inside this function they are 'hideMetaReviewLimit()' and 'showMetaReviewLimit()'. This can be seen in the below code snippet

[[File:Metareview2.PNG]]

Now on clicking the 'Use metareview deadline' checkbox, the new code will invoke the 'removeOrAddMetareview()' function which indirectly invokes the two new functions.
Now let us look at the implementation of the two new functions, we used a local storage variable called 'meta'.So based on the status of the checkbox a value is assigned to the local storage variable. For example, if the 'Use metareview deadline' checkbox is checked then the local storage variable is initialized with the value 'show' and if the 'Use metareview deadline' checkbox is Unchecked we assign with the value 'hide' to the local storage variable. Now after storing the respective values for the local storage variable, the storage event is triggered by these functions. The below code snippet shows the implementation of the two new functions:

[[File:Metareview3.PNG]]

In _review_strategy.html.erb file:

Small modifications have been made to the existing code that is the display of the table row with id 'meta' is given 'none' by default and also the status of the 'Has Meta-review Limit?' checkbox is changed to false. The below code snippet shows the modifications made:

[[File:Metareview5.PNG]]

we wrote a javascript code that handles the event triggered when the 'Use metareview deadline' checkbox has been checked or unchecked. In this javascript, the event triggered is handled by calling the 'onStorageEvent(storageEvent)' function. In this 'onStorageEvent' function we check the value in the local storage variable and based on that value we change the status of the display for the table row with id 'meta'.

[[File:Metareview4.PNG]]

Finally, the null value to the 'Has Meta-review Limit?' can be assigned during the creation of the table and on clicking the 'Has Meta-review Limit?' checkbox the UI displays '3' in the allowed number of metareviews that is num_metareviews_allowed variable is assigned '3'.

===Test Plan===
1. Ensure that when an assignment is created, the number of meta-reviews is set to null.

2. Ensure that the meta-review fields in the review strategy tab are visible only when 'Use metareview deadline' is enabled in the Due dates tab.

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-12-06T23:47:56Z

Smuvval: /* Solution and Code Modification for Issue 1 and 2 */

== '''Overview of Project''' ==

In Expertiza, meta-review is a feature that enables a third party to evaluate the quality of feedback that a reviewer gives a reviewee. meta-review is an important feature that can help students become better reviewers for their peers by providing detailed feedback that is actionable and positively formulated. Unfortunately, this feature is broken and the following issues were identified.

== '''Design Pattern''' ==
Design patterns are not applicable as our task involved just modification of existing methods.

== '''Issue1''' ==

===Issue Description===
When a user requests a new meta-review, (s)he should be able to click on the Begin button, which should redirect him/her to the meta-review questionnaire and when the user returns back (to the page where he can view the reviews and meta-reviews, by clicking on Others’ work in his/her assignment), (s)he should be then able to see view and update links for the meta-reviews (s)he has performed.

But the issue is Begin and Edit are not working for the given scenario.

===Existing Issue===
1. Log in as instructor6, click on Manage...-> Assignments

2. Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox

3. Select "Yes" for all of the following: Submission allowed, Review allowed and Meta-review allowed in all of the deadline types

4. Navigate back to Assignment Tree View and click on "Add participant"

5. Add couple of students(say student1 and student2) to the assignment

6. Impersonate/login as student1 and make a submission

7. Impersonate/login as student2 and Request for a new review under others work, submit the review

8. Impersonate/login back as student1 and Request for a new meta review

9. When Begin is clicked following will be displayed. Instead of this, the meta review page must be displayed. 

[[File:Expertiza project3 Issue1 E1997.png]]

10. A template must be added to fix the broken link

===Files to be modified===
response.html.erb

== '''Issue2''' ==

===Issue Description===
The number of meta-reviews(refer to the snapshot below),should decrease when a user requests a meta-review.Also, the button to request a new meta-review should not disappear until the total number of reviews assigned has reached the allowed limit.

===Existing Issue===
<li>Log in as instructor6, click on mange...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked, the meta-review count should be decremented. Currently, as clicking the begin button is not working, we are not sure if the counter is being decremented properly.

===Files to be modified===
<li>List.html.erb

== '''Design strategy For Issue1 and Issue 2''' ==

The flow chart below describes the design we choose to implement the above two issues

[[File:E1997_1.PNG]]

===Solution and Code Modification for Issue 1 and 2===
Basically, the file named 'response.html.erb'(Exact navigation: https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/response.html.erb) is looking for a partial named 'review'

==== Modification 1 ====
The code that expects partial is:
<%= render :partial => 'review', :locals => {:versions => @responses_versions} %>

We have created partial named _review.html.erb at https://github.com/VishnusRepo/expertiza/blob/master/app/views/response/_review.html.erb
It is a simple partial with code as follows:

<% versions.each do |response| %>
<% rm = ResponseMap.find(response.map_id) %>
<% as = Assignment.find(rm.reviewed_object_id) %>
<% questionnaire = rm.questionnaire %>
<%= response.display_as_html()+" <hr/> " %>
<% end %>

==== Modification 2 ====
The response_controller.rb(controller that works in tandem with response.html.erb view, which was expecting partial) required a minute fix, which is,
- The existing code doesn't work if AssignmentTeam is found to be nil. Please check the below existing code:

if @response.nil? || AssignmentTeam.find(@map.reviewee_id).most_recent_submission.updated_at > @response.updated_at
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

The response is created(by Response.create) only if the 'if' condition is satisfied. The AssignmentTeam.find(@map.reviewee_id) shall return a nil(for metareviews), hence AssignmentTeam.find(@map.reviewee_id).most_recent_submission will throw an exception.

The problem is, assignment team will be nil for meta reviews. Hence, existing code won't work.

To cover this special nil case, we have modified the code as:

begin
assignment_team = AssignmentTeam.find(@map.reviewee_id)
rescue
assignment_team = nil
end
if @response.nil? || (!assignment_team.nil? && assignment_team.most_recent_submission.updated_at > @response.updated_at)
@response = Response.create(map_id: @map.id, additional_comment: '', round: @current_round, is_submitted: 0)

By changing the code to above, we were able to handle the exceptions.

When you click other's work for an assignment, you will navigate to Reviews/metareviews page(for navigation understanding, example URL: http://152.46.16.18:8080/student_review/list?id=36223). The

== '''Issue3''' ==
===Background:===
An instructor can edit an assignment and can choose whether to have metareview in it or not. He can do so by following the below steps:

1) From Manage>Assignments, click on the Edit Assignment button for the appropriate assignment.

2) On the Due Date tab, the instructor can select if (s)he wants to have meta-reviews done for the assignment, by clicking on the “Use meta-review deadline” checkbox and setting a meta-review deadline below.

3) Under the “Review Strategy” tab of edit assignment, the instructor can set Allowed and Required number of meta-reviews per reviewer by checking the Has meta-review Limit? checkbox.

===Issue Description===
For an assignment, when 'Use Metareview Deadline' is unchecked, it means meta-reviews are not enabled for that assignment. The checkbox is as below

[[File:issue3_1.png]]

As said, when this box is unchecked, it means there is no meta reviewing system for this assignment. The issue is, there are some meta review related fields that show up even if the above box is unchecked. Like in below image

[[File:issue3_2.png]]

Also, when a new issue is created, the default # of meta-reviews allowed and required should be null. As soon as someone checks the Has meta-review Limit box on the “Review Strategy” tab, the UI should fill in 3 and 3 as the required and allowed number. Of course, the user can change this number before submitting it.

===Solution and Code Modification for Issue 3===

As the checkbox and the content to be displayed on clicking the checkbox are located on different pages we cannot use the regular checkbox logic, so we used the concept of local storage and event listener.

we have made changes to the below two files:

1)/expertiza/app/views/assignments/edit/_due_dates.html.erb

2)/expertiza/app/views/assignments/edit/_review_strategy.html.erb

In the _due_dates.html.erb file:

There is an existing code where on clicking the checkbox 'Use metareview deadline', a function called 'removeOrAddMetareview()' is invoked. The code snippet below shows the existing code:

[[File:Metareview1.PNG]]

The 'removeOrAddMetareview()' is called on click of the 'Use metareview deadline' checkbox. Now we implemented two new functions which are invoked inside this function they are 'hideMetaReviewLimit()' and 'showMetaReviewLimit()'. This can be seen in the below code snippet

[[File:Metareview2.PNG]]

Now on clicking the 'Use metareview deadline' checkbox, the new code will invoke the 'removeOrAddMetareview()' function which indirectly invokes the two new functions.
Now let us look at the implementation of the two new functions, we used a local storage variable called 'meta'.So based on the status of the checkbox a value is assigned to the local storage variable. For example, if the 'Use metareview deadline' checkbox is checked then the local storage variable is initialized with the value 'show' and if the 'Use metareview deadline' checkbox is Unchecked we assign with the value 'hide' to the local storage variable. Now after storing the respective values for the local storage variable, the storage event is triggered by these functions. The below code snippet shows the implementation of the two new functions:

[[File:Metareview3.PNG]]

In _review_strategy.html.erb file:

Small modifications have been made to the existing code that is the display of the table row with id 'meta' is given 'none' by default and also the status of the 'Has Meta-review Limit?' checkbox is changed to false. The below code snippet shows the modifications made:

[[File:Metareview5.PNG]]

we wrote a javascript code that handles the event triggered when the 'Use metareview deadline' checkbox has been checked or unchecked. In this javascript, the event triggered is handled by calling the 'onStorageEvent(storageEvent)' function. In this 'onStorageEvent' function we check the value in the local storage variable and based on that value we change the status of the display for the table row with id 'meta'.

[[File:Metareview4.PNG]]

Finally, the null value to the 'Has Meta-review Limit?' can be assigned during the creation of the table and on clicking the 'Has Meta-review Limit?' checkbox the UI displays '3' in the allowed number of metareviews that is num_metareviews_allowed variable is assigned '3'.

===Test Plan===
1. Ensure that when an assignment is created, the number of meta-reviews is set to null.

2. Ensure that the meta-review fields in the review strategy tab are visible only when 'Use metareview deadline' is enabled in the Due dates tab.

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-12-06T23:22:17Z

Smuvval:

== '''Overview of Project''' ==

In Expertiza, meta-review is a feature that enables a third party to evaluate the quality of feedback that a reviewer gives a reviewee. meta-review is an important feature that can help students become better reviewers for their peers by providing detailed feedback that is actionable and positively formulated. Unfortunately, this feature is broken and the following issues were identified.

== '''Design Pattern''' ==
Design patterns are not applicable as our task involved just modification of existing methods.

== '''Issue1''' ==

===Issue Description===
When a user requests a new meta-review, (s)he should be able to click on the Begin button, which should redirect him/her to the meta-review questionnaire and when the user returns back (to the page where he can view the reviews and meta-reviews, by clicking on Others’ work in his/her assignment), (s)he should be then able to see view and update links for the meta-reviews (s)he has performed.

But the issue is Begin and Edit are not working for the given scenario.

===Existing Issue===
1. Log in as instructor6, click on Manage...-> Assignments

2. Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox

3. Select "Yes" for all of the following: Submission allowed, Review allowed and Meta-review allowed in all of the deadline types

4. Navigate back to Assignment Tree View and click on "Add participant"

5. Add couple of students(say student1 and student2) to the assignment

6. Impersonate/login as student1 and make a submission

7. Impersonate/login as student2 and Request for a new review under others work, submit the review

8. Impersonate/login back as student1 and Request for a new meta review

9. When Begin is clicked following will be displayed. Instead of this, the meta review page must be displayed. 

[[File:Expertiza project3 Issue1 E1997.png]]

10. A template must be added to fix the broken link

===Files to be modified===
response.html.erb

== '''Issue2''' ==

===Issue Description===
The number of meta-reviews(refer to the snapshot below),should decrease when a user requests a meta-review.Also, the button to request a new meta-review should not disappear until the total number of reviews assigned has reached the allowed limit.

===Existing Issue===
<li>Log in as instructor6, click on mange...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked, the meta-review count should be decremented. Currently, as clicking the begin button is not working, we are not sure if the counter is being decremented properly.

===Files to be modified===
<li>List.html.erb

== '''Design strategy For Issue1 and Issue 2''' ==

The flow chart below describes the design we choose to implement the above two issues

[[File:E1997_1.PNG]]

===Solution and Code Modification for Issue 1 and 2===

== '''Issue3''' ==
===Background:===
An instructor can edit an assignment and can choose whether to have metareview in it or not. He can do so by following the below steps:

1) From Manage>Assignments, click on the Edit Assignment button for the appropriate assignment.

2) On the Due Date tab, the instructor can select if (s)he wants to have meta-reviews done for the assignment, by clicking on the “Use meta-review deadline” checkbox and setting a meta-review deadline below.

3) Under the “Review Strategy” tab of edit assignment, the instructor can set Allowed and Required number of meta-reviews per reviewer by checking the Has meta-review Limit? checkbox.

===Issue Description===
For an assignment, when 'Use Metareview Deadline' is unchecked, it means meta-reviews are not enabled for that assignment. The checkbox is as below

[[File:issue3_1.png]]

As said, when this box is unchecked, it means there is no meta reviewing system for this assignment. The issue is, there are some meta review related fields that show up even if the above box is unchecked. Like in below image

[[File:issue3_2.png]]

Also, when a new issue is created, the default # of meta-reviews allowed and required should be null. As soon as someone checks the Has meta-review Limit box on the “Review Strategy” tab, the UI should fill in 3 and 3 as the required and allowed number. Of course, the user can change this number before submitting it.

===Solution and Code Modification for Issue 3===

As the checkbox and the content to be displayed on clicking the checkbox are located on different pages we cannot use the regular checkbox logic, so we used the concept of local storage and event listener.

we have made changes to the below two files:

1)/expertiza/app/views/assignments/edit/_due_dates.html.erb

2)/expertiza/app/views/assignments/edit/_review_strategy.html.erb

In the _due_dates.html.erb file:

There is an existing code where on clicking the checkbox 'Use metareview deadline', a function called 'removeOrAddMetareview()' is invoked. The code snippet below shows the existing code:

[[File:Metareview1.PNG]]

The 'removeOrAddMetareview()' is called on click of the 'Use metareview deadline' checkbox. Now we implemented two new functions which are invoked inside this function they are 'hideMetaReviewLimit()' and 'showMetaReviewLimit()'. This can be seen in the below code snippet

[[File:Metareview2.PNG]]

Now on clicking the 'Use metareview deadline' checkbox, the new code will invoke the 'removeOrAddMetareview()' function which indirectly invokes the two new functions.
Now let us look at the implementation of the two new functions, we used a local storage variable called 'meta'.So based on the status of the checkbox a value is assigned to the local storage variable. For example, if the 'Use metareview deadline' checkbox is checked then the local storage variable is initialized with the value 'show' and if the 'Use metareview deadline' checkbox is Unchecked we assign with the value 'hide' to the local storage variable. Now after storing the respective values for the local storage variable, the storage event is triggered by these functions. The below code snippet shows the implementation of the two new functions:

[[File:Metareview3.PNG]]

In _review_strategy.html.erb file:

Small modifications have been made to the existing code that is the display of the table row with id 'meta' is given 'none' by default and also the status of the 'Has Meta-review Limit?' checkbox is changed to false. The below code snippet shows the modifications made:

[[File:Metareview5.PNG]]

we wrote a javascript code that handles the event triggered when the 'Use metareview deadline' checkbox has been checked or unchecked. In this javascript, the event triggered is handled by calling the 'onStorageEvent(storageEvent)' function. In this 'onStorageEvent' function we check the value in the local storage variable and based on that value we change the status of the display for the table row with id 'meta'.

[[File:Metareview4.PNG]]

Finally, the null value to the 'Has Meta-review Limit?' can be assigned during the creation of the table and on clicking the 'Has Meta-review Limit?' checkbox the UI displays '3' in the allowed number of metareviews that is num_metareviews_allowed variable is assigned '3'.

===Test Plan===
1. Ensure that when an assignment is created, the number of meta-reviews is set to null.

2. Ensure that the meta-review fields in the review strategy tab are visible only when 'Use metareview deadline' is enabled in the Due dates tab.

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-12-06T23:21:20Z

Smuvval: /* Solution and Code Modification */

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-12-06T23:20:48Z

Smuvval: /* Existing Issue */

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-12-06T23:19:54Z

Smuvval: /* Existing Issue */

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-12-06T23:18:52Z

Smuvval: /* Test Plan */

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-12-06T23:18:34Z

Smuvval: /* Test Plan */

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-11-11T20:55:32Z

Smuvval: /* Test Plan */

== '''Problem statement''' ==

== '''Issue1''' ==

===Issue Description===
When a user requests a new meta-review, (s)he should be able to click on the Begin button, which should redirect him/her to the meta-review questionnaire and when the user returns back (to the page where he can view the reviews and meta-reviews, by clicking on Others’ work in his/her assignment), (s)he should be then able to see view and update links for the meta-reviews (s)he has performed.

But the issue is Begin and Edit are not working for the given scenario.

===Design strategy===

===Test Plan===
<li>Log in as instructor6, click on manage...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all of the following: Submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked following will be displayed 
[[File:Expertiza project3 Issue1 E1997.png]]
<li>A template must be added to fix the broken link

===Files to be modified===
response.html.erb

== '''Issue2''' ==

===Issue Description===
The number of meta-reviews(refer to the snapshot below),should decrease when a user requests a meta-review.Also, the button to request a new meta-review should not disappear until the total number of reviews assigned has reached the allowed limit.

===Design strategy===

===Test Plan===
<li>Log in as instructor6, click on mange...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked, the meta-review count should be decremented

===Files to be modified===
<li>List.html.erb

== '''Issue3''' ==

===Issue Description===
For an assignment, when 'Use Metareview Deadline' is unchecked, it means meta reviews are not enabled for that assignment. The check box is as below

[[File:issue3_1.png]]

As said, when this box is unchecked, it means there is no meta reviewing system for this assignment. The issue is, there are some meta review related fields that show up even if the above box is unchecked. Like in below image

[[File:issue3_2.png]]

Also, when a new issue is created, the default # of meta-reviews allowed and required should be null. As soon as someone checks the Has meta-review Limit box on the “Review Strategy” tab, the UI should fill in 3 and 3 as the required and allowed number. Of course, the user can change this number before submitting.

===Design strategy===
A boolean style variable, named say 'isMetaEnabled' which reflects the metareview enabled/disabled status is needed. When user checks 'Use metareview deadline' in Due dates tab, the isMetaEnabled will be set to true and vice versa.

This isMetaEnabled shall reside and gets initialized to 'True'(metareview enabled) in the assignments_controller.rb
When user toggles the checkbox, the isMetaEnabled value shall be toggled accordingly.

In the Review Strategy tab, the metareview fields(3 of them) are conditioned to be displayed only if isMetaEnabled is set to true.

Pictorial representation of above explanation

[[File:issue3_design.png]]

===Test Plan===
1. Ensure that when an assignment is created, the number of meta reviews is set to null.
2. Ensure that the meta review fields in the review strategy tab are visible only when 'Use metareview deadline' is enabled in Due dates tab.

===Files to be modified===
1. _review_strategy.html.erb
Source file: https://github.com/expertiza/expertiza/blob/master/app/views/assignments/edit/_review_strategy.html.erb

2. _due_dates.html.erb
Source file: https://github.com/expertiza/expertiza/blob/master/app/views/assignments/edit/_due_dates.html.erb

3. assignments_controller.rb
Source file: https://github.com/expertiza/expertiza/blob/master/app/controllers/assignments_controller.rb

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-11-11T20:52:45Z

Smuvval: /* Issue Description */

== '''Problem statement''' ==

== '''Issue1''' ==

===Issue Description===
When a user requests a new meta-review, (s)he should be able to click on the Begin button, which should redirect him/her to the meta-review questionnaire and when the user returns back (to the page where he can view the reviews and meta-reviews, by clicking on Others’ work in his/her assignment), (s)he should be then able to see view and update links for the meta-reviews (s)he has performed.

But the issue is Begin and Edit are not working for the given scenario.

===Design strategy===

===Test Plan===
<li>Log in as instructor6, click on manage...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all of the following: Submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked following will be displayed 
[[File:Expertiza project3 Issue1 E1997.png]]
<li>A template must be added to fix the broken link

===Files to be modified===
response.html.erb

== '''Issue2''' ==

===Issue Description===
The number of meta-reviews(refer to the snapshot below),should decrease when a user requests a meta-review.Also, the button to request a new meta-review should not disappear until the total number of reviews assigned has reached the allowed limit.

===Design strategy===

===Test Plan===
<li>Log in as instructor6, click on mange...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked, the meta-review count should be decremented

===Files to be modified===
<li>List.html.erb

== '''Issue3''' ==

===Issue Description===
For an assignment, when 'Use Metareview Deadline' is unchecked, it means meta reviews are not enabled for that assignment. The check box is as below

[[File:issue3_1.png]]

As said, when this box is unchecked, it means there is no meta reviewing system for this assignment. The issue is, there are some meta review related fields that show up even if the above box is unchecked. Like in below image

[[File:issue3_2.png]]

Also, when a new issue is created, the default # of meta-reviews allowed and required should be null. As soon as someone checks the Has meta-review Limit box on the “Review Strategy” tab, the UI should fill in 3 and 3 as the required and allowed number. Of course, the user can change this number before submitting.

===Design strategy===
A boolean style variable, named say 'isMetaEnabled' which reflects the metareview enabled/disabled status is needed. When user checks 'Use metareview deadline' in Due dates tab, the isMetaEnabled will be set to true and vice versa.

This isMetaEnabled shall reside and gets initialized to 'True'(metareview enabled) in the assignments_controller.rb
When user toggles the checkbox, the isMetaEnabled value shall be toggled accordingly.

In the Review Strategy tab, the metareview fields(3 of them) are conditioned to be displayed only if isMetaEnabled is set to true.

Pictorial representation of above explanation

[[File:issue3_design.png]]

===Test Plan===
1. Ensure that when an assignment is created,

===Files to be modified===
1. _review_strategy.html.erb
Source file: https://github.com/expertiza/expertiza/blob/master/app/views/assignments/edit/_review_strategy.html.erb

2. _due_dates.html.erb
Source file: https://github.com/expertiza/expertiza/blob/master/app/views/assignments/edit/_due_dates.html.erb

3. assignments_controller.rb
Source file: https://github.com/expertiza/expertiza/blob/master/app/controllers/assignments_controller.rb

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-11-11T20:51:38Z

Smuvval: /* Test Plan */

== '''Problem statement''' ==

== '''Issue1''' ==

===Issue Description===
When a user requests a new meta-review, (s)he should be able to click on the Begin button, which should redirect him/her to the meta-review questionnaire and when the user returns back (to the page where he can view the reviews and meta-reviews, by clicking on Others’ work in his/her assignment), (s)he should be then able to see view and update links for the meta-reviews (s)he has performed.

But the issue is Begin and Edit are not working for the given scenario.

===Design strategy===

===Test Plan===
<li>Log in as instructor6, click on manage...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all of the following: Submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked following will be displayed 
[[File:Expertiza project3 Issue1 E1997.png]]
<li>A template must be added to fix the broken link

===Files to be modified===
response.html.erb

== '''Issue2''' ==

===Issue Description===
The number of meta-reviews(refer to the snapshot below),should decrease when a user requests a meta-review.Also, the button to request a new meta-review should not disappear until the total number of reviews assigned has reached the allowed limit.

===Design strategy===

===Test Plan===
<li>Log in as instructor6, click on mange...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked, the meta-review count should be decremented

===Files to be modified===
<li>List.html.erb

== '''Issue3''' ==

===Issue Description===
For an assignment, when 'Use Metareview Deadline' is unchecked, it means meta reviews are not enabled for that assignment. The check box is as below

[[File:issue3_1.png]]

As said, when this box is unchecked, it means there is no meta reviewing system for this assignment. The issue is, there are some meta review related fields that show up even if the above box is unchecked. Like in below image

[[File:issue3_2.png]]

===Design strategy===
A boolean style variable, named say 'isMetaEnabled' which reflects the metareview enabled/disabled status is needed. When user checks 'Use metareview deadline' in Due dates tab, the isMetaEnabled will be set to true and vice versa.

This isMetaEnabled shall reside and gets initialized to 'True'(metareview enabled) in the assignments_controller.rb
When user toggles the checkbox, the isMetaEnabled value shall be toggled accordingly.

In the Review Strategy tab, the metareview fields(3 of them) are conditioned to be displayed only if isMetaEnabled is set to true.

Pictorial representation of above explanation

[[File:issue3_design.png]]

===Test Plan===
1. Ensure that when an assignment is created,

===Files to be modified===
1. _review_strategy.html.erb
Source file: https://github.com/expertiza/expertiza/blob/master/app/views/assignments/edit/_review_strategy.html.erb

2. _due_dates.html.erb
Source file: https://github.com/expertiza/expertiza/blob/master/app/views/assignments/edit/_due_dates.html.erb

3. assignments_controller.rb
Source file: https://github.com/expertiza/expertiza/blob/master/app/controllers/assignments_controller.rb

File:Issue3 design.png

2019-11-11T20:50:45Z

Smuvval:

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-11-11T20:50:31Z

Smuvval: /* Design strategy */

== '''Problem statement''' ==

== '''Issue1''' ==

===Issue Description===
When a user requests a new meta-review, (s)he should be able to click on the Begin button, which should redirect him/her to the meta-review questionnaire and when the user returns back (to the page where he can view the reviews and meta-reviews, by clicking on Others’ work in his/her assignment), (s)he should be then able to see view and update links for the meta-reviews (s)he has performed.

But the issue is Begin and Edit are not working for the given scenario.

===Design strategy===

===Test Plan===
<li>Log in as instructor6, click on manage...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all of the following: Submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked following will be displayed 
[[File:Expertiza project3 Issue1 E1997.png]]
<li>A template must be added to fix the broken link

===Files to be modified===
response.html.erb

== '''Issue2''' ==

===Issue Description===
The number of meta-reviews(refer to the snapshot below),should decrease when a user requests a meta-review.Also, the button to request a new meta-review should not disappear until the total number of reviews assigned has reached the allowed limit.

===Design strategy===

===Test Plan===
<li>Log in as instructor6, click on mange...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked, the meta-review count should be decremented

===Files to be modified===
<li>List.html.erb

== '''Issue3''' ==

===Issue Description===
For an assignment, when 'Use Metareview Deadline' is unchecked, it means meta reviews are not enabled for that assignment. The check box is as below

[[File:issue3_1.png]]

As said, when this box is unchecked, it means there is no meta reviewing system for this assignment. The issue is, there are some meta review related fields that show up even if the above box is unchecked. Like in below image

[[File:issue3_2.png]]

===Design strategy===
A boolean style variable, named say 'isMetaEnabled' which reflects the metareview enabled/disabled status is needed. When user checks 'Use metareview deadline' in Due dates tab, the isMetaEnabled will be set to true and vice versa.

This isMetaEnabled shall reside and gets initialized to 'True'(metareview enabled) in the assignments_controller.rb
When user toggles the checkbox, the isMetaEnabled value shall be toggled accordingly.

In the Review Strategy tab, the metareview fields(3 of them) are conditioned to be displayed only if isMetaEnabled is set to true.

Pictorial representation of above explanation

[[File:issue3_design.png]]

===Test Plan===

===Files to be modified===
1. _review_strategy.html.erb
Source file: https://github.com/expertiza/expertiza/blob/master/app/views/assignments/edit/_review_strategy.html.erb

2. _due_dates.html.erb
Source file: https://github.com/expertiza/expertiza/blob/master/app/views/assignments/edit/_due_dates.html.erb

3. assignments_controller.rb
Source file: https://github.com/expertiza/expertiza/blob/master/app/controllers/assignments_controller.rb

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-11-11T20:44:56Z

Smuvval: /* Design strategy */

== '''Problem statement''' ==

== '''Issue1''' ==

===Issue Description===
When a user requests a new meta-review, (s)he should be able to click on the Begin button, which should redirect him/her to the meta-review questionnaire and when the user returns back (to the page where he can view the reviews and meta-reviews, by clicking on Others’ work in his/her assignment), (s)he should be then able to see view and update links for the meta-reviews (s)he has performed.

But the issue is Begin and Edit are not working for the given scenario.

===Design strategy===

===Test Plan===
<li>Log in as instructor6, click on manage...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all of the following: Submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked following will be displayed 
[[File:Expertiza project3 Issue1 E1997.png]]
<li>A template must be added to fix the broken link

===Files to be modified===
response.html.erb

== '''Issue2''' ==

===Issue Description===
The number of meta-reviews(refer to the snapshot below),should decrease when a user requests a meta-review.Also, the button to request a new meta-review should not disappear until the total number of reviews assigned has reached the allowed limit.

===Design strategy===

===Test Plan===
<li>Log in as instructor6, click on mange...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked, the meta-review count should be decremented

===Files to be modified===
<li>List.html.erb

== '''Issue3''' ==

===Issue Description===
For an assignment, when 'Use Metareview Deadline' is unchecked, it means meta reviews are not enabled for that assignment. The check box is as below

[[File:issue3_1.png]]

As said, when this box is unchecked, it means there is no meta reviewing system for this assignment. The issue is, there are some meta review related fields that show up even if the above box is unchecked. Like in below image

[[File:issue3_2.png]]

===Design strategy===
A boolean style variable, named say 'isMetaEnabled' which reflects the metareview enabled/disabled status is needed. When user checks 'Use metareview deadline' in Due dates tab, the isMetaEnabled will be set to true and vice versa.

This isMetaEnabled shall reside and gets initialized to 'True'(metareview enabled) in the assignments_controller.rb
When user toggles the checkbox, the isMetaEnabled value shall be toggled accordingly.

In the Review Strategy tab, the metareview fields(3 of them) are conditioned to be displayed only if isMetaEnabled is set to true.

===Test Plan===

===Files to be modified===
1. _review_strategy.html.erb
Source file: https://github.com/expertiza/expertiza/blob/master/app/views/assignments/edit/_review_strategy.html.erb

2. _due_dates.html.erb
Source file: https://github.com/expertiza/expertiza/blob/master/app/views/assignments/edit/_due_dates.html.erb

3. assignments_controller.rb
Source file: https://github.com/expertiza/expertiza/blob/master/app/controllers/assignments_controller.rb

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-11-11T20:38:45Z

Smuvval: /* Files to be modified */

== '''Problem statement''' ==

== '''Issue1''' ==

===Issue Description===
When a user requests a new meta-review, (s)he should be able to click on the Begin button, which should redirect him/her to the meta-review questionnaire and when the user returns back (to the page where he can view the reviews and meta-reviews, by clicking on Others’ work in his/her assignment), (s)he should be then able to see view and update links for the meta-reviews (s)he has performed.

But the issue is Begin and Edit are not working for the given scenario.

===Design strategy===

===Test Plan===
<li>Log in as instructor6, click on manage...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all of the following: Submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked following will be displayed 
[[File:Expertiza project3 Issue1 E1997.png]]
<li>A template must be added to fix the broken link

===Files to be modified===
response.html.erb

== '''Issue2''' ==

===Issue Description===
The number of meta-reviews(refer to the snapshot below),should decrease when a user requests a meta-review.Also, the button to request a new meta-review should not disappear until the total number of reviews assigned has reached the allowed limit.

===Design strategy===

===Test Plan===
<li>Log in as instructor6, click on mange...-> Assignments
<li>Click on edit assignment, navigate to Due Dates and check "Use meta-review deadline" checkbox
<li>Select "Yes" for all submission allowed, Review allowed and Meta-review allowed in all of the deadline types
<li>Navigate back to Assignment Tree View and click on "Add participant"
<li>Add couple of students(say student1 and student2) to the assignment
<li>Impersonate/login as student1 and make a submission
<li>Impersonate/login as student2 and Request for a new review under others work, submit the review
<li>Impersonate/login back as student1 and Request for a new meta review
<li>When Begin is clicked, the meta-review count should be decremented

===Files to be modified===
<li>List.html.erb

== '''Issue3''' ==

===Issue Description===
For an assignment, when 'Use Metareview Deadline' is unchecked, it means meta reviews are not enabled for that assignment. The check box is as below

[[File:issue3_1.png]]

As said, when this box is unchecked, it means there is no meta reviewing system for this assignment. The issue is, there are some meta review related fields that show up even if the above box is unchecked. Like in below image

[[File:issue3_2.png]]

===Design strategy===

===Test Plan===

===Files to be modified===
1. _review_strategy.html.erb
Source file: https://github.com/expertiza/expertiza/blob/master/app/views/assignments/edit/_review_strategy.html.erb

2. _due_dates.html.erb
Source file: https://github.com/expertiza/expertiza/blob/master/app/views/assignments/edit/_due_dates.html.erb

3. assignments_controller.rb
Source file: https://github.com/expertiza/expertiza/blob/master/app/controllers/assignments_controller.rb

File:Issue3 2.png

2019-11-11T20:31:57Z

Smuvval:

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-11-11T20:31:48Z

Smuvval: /* Issue Description */

File:Issue3 1.png

2019-11-11T20:29:34Z

Smuvval:

CSC/ECE 517 Fall 2019 - E1997. Issues related to meta-reviewing

2019-11-11T20:29:19Z

Smuvval: /* Issue Description */

CSC/ECE 517 Fall 2019 - E1959. Intelligent copying of assignments without topics

2019-10-29T00:45:31Z

Smuvval: /* Resolving Issue 2: */

== '''Wiki Page Description''' ==
This wiki page describes about the E1959. Intelligent copying of assignments without topics (Issue #1341). We will explain about the issue and also the steps to resolve the issue.

== '''Introduction''' ==

Expertiza is an open source web application project developed using Ruby on Rails framework. Let us list some of the functionalities that Expertiza allows us to do under different roles:

As an Instructor:

We can create new assignments, edit the existing assignments, copy the assignments and also delete the assignment. The instructor can also add participants, reviewers to a particular assignment.

As a Student:

They can form teams to work on various projects and also bid for the projects they would like to work on. They can also review other student's work and can give feedback on them. They can also submit various types of documents including the URLs and wiki pages for their project or assignment submission.

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

===Background:===
When an instructor or a TA logs in to expertiza, he can see a list of assignments under the assignment tab. An instructor or a TA can copy an assignment to use the same event in another course or as another assignment. When the user copies the assignment, the assignment is being copied without providing required flexibility to the users. Majorly, we are focused on implementing two features that shall add flexibility to the copy functionality.

===Issues:===
Issue 1:
While copying an assignment, the user (instructor or TA) is not asked whether (s)he wants to copy the topics along with the assignment or not. Currently, it is copying the topics, without providing any choice for user to not have the topics.

Issue 2:
While copying an assignment, the teams/students assigned to each topic are not getting copied. The user might want to copy the teams/students mapped to the topics as well.

===Steps to generate the issue <Existing system, without our implementation> <Requires Instructor credentials>:===
1) Login to expertiza.ncsu.edu using instructor credentials.

2) Navigate to Assignments section. (How? Hover on Manage Tab -> Click on Assignments)

3) Copy the assignment of your choice by clicking copy icon located on the right side the specific assignment.

Above steps copy the assignment. Remember that this process did not give you the flexibility of choosing whether to copy/not copy

1) Topics linked to assignment

2) Students/teams linked to each topic.

Present system copies the topics and doesn't copy the students, even if you don't want it this way. Our implementation is to provide the user with the functionality to choose copy/not copy topics linked to an assignment and students/teams linked to each topic.

== Testing our work ==
By following the below stated process, you can test the implementation that we worked on, which is:
Target 1: Provide the user with the option to select copy/not copy topics linked to an assignment.
Target 2: Provide the user with the option to select copy/not copy students/teams linked to a topic.

'''Step 1''': Visit http://152.46.17.204:8080/ . Enter the credentials; Username: instructor6 , password: password

'''Step 2''': On the top, hover on Manage tab. Click Assignments.

'''Step 3''': Choose an assignment that you want to copy. We would recommend you choosing a robust assignment which has Topics and students/teams associated with topics. OSS Projects generally have these.

If you want to check and see if an assignment has topics or not, click on Edit (pencil icon) on the right.
- If this assignment has topics, you will see a tab named Topics on the right of General tab. If there are no topics, you won't see Topics tab.
- On Clicking the Topics tab, you can see the list of topics. If students/teams are assigned to topics, you will see student names (alias representations, like student1234 student2343) under each Topic name in 'Topic name(s) column'. If you don't see any such, it means that teams/students are not assigned to topics.

'''Step 4''': After you chose the assignment that you want to copy, click on the copy icon on the right of the corresponding assignment.

Where is the copy button located? Check the image below.
[[File: Copy oss.PNG|frame|center]]

'''Step 5''': Clicking the copy button will take you to copy options page, where you can select the options for copying. The page looks like this:
[[File: oss_copy6.PNG|frame|center]]

'''Step 6''': Choose the option you wish to test. Click create. Now the assignment shall be copied with the options you provided.

'''Step 7''': After copying, the application takes you to 'Edit' page for the assignment where you can edit/view the details pertaining to the assignment. Here, you can test our implementation.
In step 6, if you chose to

- copy without topics: You won't see 'Topics' tab near General tab.

- copy with topics: You will see 'Topics' tab near General tab(As shown in image below). Navigate to Topics tab where you can see and check that the respective topics have been copied. You won't see students under each topic in 'Topic Name(s)' column(If there are topics under Topics tab in original assignment from which you created this copy).

- copy with topics and students: You will see 'Topics' tab near General tab(As shown in image below). Navigate to Topics tab where you can see and check that the respective topics have been copied. You will see students under each topic in 'Topic Name(s)' column(If there are topics and students under Topics tab in original assignment from which you created this copy).

[[File: oss_copy7.PNG|frame|center]]

'''Step 8''': Please rename the assignment to some random string of your choice. Having it as 'Copy of'.. is creating issues of duplicate names when creating a new copy (more details in the section below, named 'Our Recommendation for a separate issue'. Not required for students). If not changed, the next tester might face difficulty while testing(which we don't want to see happening :)).

'''Step 9''': This completes the testing. Reiterate from step 2, if you wish to test again.

== Code Modification ==
We have modified 5 files and mainly we have modified code in two classes they are:
assignments_controller.rb under the apps/controllers
assignment_form.rb under the apps/models

We have created a new web page that is triggered on clicking the copy icon for the assignment. The view page is the checktopicscopy.html.erb under the views/assignments folder.

== For the reviewers ==
1) Please log in using the instructor credentials they are username:instructor6 password: password

2) Then select the assignment tab under manage

3) The assignment page opens and then select the copy button of the desired assignment.[NOTE: Before copying see that the assignment already has the topics or not by selecting the edit icon of the assignment]

4) If that particular assignment does not have the topics, choose another assignment which has topics to test our functionality.

5) On clicking the copy icon you will be redirected to the web page which has options, select one of the desired options and select the create button.

5) On clicking the Create button you will be redirected to the edit page of the newly created assignment. In the edit page if the topics tab appears it means that the topics are copied and you can check whether the students under the topics are copied or not.[NOTE: if the topics tab is absent beside the General Tab it indicates that the topics are not copied with assignment]

6) Check the new assignment based on the choice you selected while creating a copy of an assignment.

== Testing ==

we have made changes to the test cases and both the assignment_form.rb in models and also the assignments_controller.rb in controllers have passed all the test cases.

== Our work ==
The code we created can be found below. We have also linked the video of our tests running with coverage to showcase the work we have done.
*[https://github.com/expertiza/expertiza/pull/1524 Pull request]
*[http://152.46.17.204:8080/ Deployed URL]

== Our Recommendation for a separate issue <For Instructors only>==

In the current system, we identified an issue and would like to bring it to your notice.

=== Existing System ===

When a user attempts to copy an assignment, the code creates a duplicate ‘assignment’ object, renames it as ‘copy of’ + <name of existing assignment>, saves the object and redirects to the ‘edit’ page where user is supposed to rename the assignment to something meaningful.

=== Issue ===

The current naming scheme as ‘copy of’ + <name of existing assignment> is creating an issue. Say you are creating a copy for some assignment named ‘OSS Project’, the copy object will be named as ‘copy of OSS Project’, saved and redirected to edit page. Had there been an existing assignment names ‘copy of OSS Project’ (which is likely), the copy attempt shall fail, putting a flash message on the screen like:

The assignment was not able to be copied. Please check the original assignment for missing information.

The above error message is in no relevance to the real reason for the error. Even though the save attempt failed, a copy is being inserted into the assignments table in the database.

=== Proposed Recommendation ===

Current naming scheme must be changed to have randomness. The name of the assignment can be given a random string, or a string like ‘copy of ’ + <name of existing assignment> + <5 digit random code>.

The user is anyway supposed to edit the information in the edit page (where the application is redirected after copying is successful). So, here, he can change the name to have some meaningful string.

== Team Information ==
1) Sai Vishnu Muvvala(smuvval)

2) Rohan Pillai(rspillai)

3) Subha Sekhar Reddy Pereddy(speredd)

Mentor : Yashad Trivedi

CSC/ECE 517 Fall 2019 - E1959. Intelligent copying of assignments without topics

2019-10-29T00:45:18Z

Smuvval: /* Testing our work */

== '''Wiki Page Description''' ==
This wiki page describes about the E1959. Intelligent copying of assignments without topics (Issue #1341). We will explain about the issue and also the steps to resolve the issue.

== '''Introduction''' ==

Expertiza is an open source web application project developed using Ruby on Rails framework. Let us list some of the functionalities that Expertiza allows us to do under different roles:

As an Instructor:

We can create new assignments, edit the existing assignments, copy the assignments and also delete the assignment. The instructor can also add participants, reviewers to a particular assignment.

As a Student:

They can form teams to work on various projects and also bid for the projects they would like to work on. They can also review other student's work and can give feedback on them. They can also submit various types of documents including the URLs and wiki pages for their project or assignment submission.

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

===Background:===
When an instructor or a TA logs in to expertiza, he can see a list of assignments under the assignment tab. An instructor or a TA can copy an assignment to use the same event in another course or as another assignment. When the user copies the assignment, the assignment is being copied without providing required flexibility to the users. Majorly, we are focused on implementing two features that shall add flexibility to the copy functionality.

===Issues:===
Issue 1:
While copying an assignment, the user (instructor or TA) is not asked whether (s)he wants to copy the topics along with the assignment or not. Currently, it is copying the topics, without providing any choice for user to not have the topics.

Issue 2:
While copying an assignment, the teams/students assigned to each topic are not getting copied. The user might want to copy the teams/students mapped to the topics as well.

===Steps to generate the issue <Existing system, without our implementation> <Requires Instructor credentials>:===
1) Login to expertiza.ncsu.edu using instructor credentials.

2) Navigate to Assignments section. (How? Hover on Manage Tab -> Click on Assignments)

3) Copy the assignment of your choice by clicking copy icon located on the right side the specific assignment.

Above steps copy the assignment. Remember that this process did not give you the flexibility of choosing whether to copy/not copy

1) Topics linked to assignment

2) Students/teams linked to each topic.

Present system copies the topics and doesn't copy the students, even if you don't want it this way. Our implementation is to provide the user with the functionality to choose copy/not copy topics linked to an assignment and students/teams linked to each topic.

== Testing our work ==
By following the below stated process, you can test the implementation that we worked on, which is:
Target 1: Provide the user with the option to select copy/not copy topics linked to an assignment.
Target 2: Provide the user with the option to select copy/not copy students/teams linked to a topic.

'''Step 1''': Visit http://152.46.17.204:8080/ . Enter the credentials; Username: instructor6 , password: password

'''Step 2''': On the top, hover on Manage tab. Click Assignments.

'''Step 3''': Choose an assignment that you want to copy. We would recommend you choosing a robust assignment which has Topics and students/teams associated with topics. OSS Projects generally have these.

If you want to check and see if an assignment has topics or not, click on Edit (pencil icon) on the right.
- If this assignment has topics, you will see a tab named Topics on the right of General tab. If there are no topics, you won't see Topics tab.
- On Clicking the Topics tab, you can see the list of topics. If students/teams are assigned to topics, you will see student names (alias representations, like student1234 student2343) under each Topic name in 'Topic name(s) column'. If you don't see any such, it means that teams/students are not assigned to topics.

'''Step 4''': After you chose the assignment that you want to copy, click on the copy icon on the right of the corresponding assignment.

Where is the copy button located? Check the image below.
[[File: Copy oss.PNG|frame|center]]

'''Step 5''': Clicking the copy button will take you to copy options page, where you can select the options for copying. The page looks like this:
[[File: oss_copy6.PNG|frame|center]]

'''Step 6''': Choose the option you wish to test. Click create. Now the assignment shall be copied with the options you provided.

'''Step 7''': After copying, the application takes you to 'Edit' page for the assignment where you can edit/view the details pertaining to the assignment. Here, you can test our implementation.
In step 6, if you chose to

- copy without topics: You won't see 'Topics' tab near General tab.

- copy with topics: You will see 'Topics' tab near General tab(As shown in image below). Navigate to Topics tab where you can see and check that the respective topics have been copied. You won't see students under each topic in 'Topic Name(s)' column(If there are topics under Topics tab in original assignment from which you created this copy).

- copy with topics and students: You will see 'Topics' tab near General tab(As shown in image below). Navigate to Topics tab where you can see and check that the respective topics have been copied. You will see students under each topic in 'Topic Name(s)' column(If there are topics and students under Topics tab in original assignment from which you created this copy).

[[File: oss_copy7.PNG|frame|center]]

'''Step 8''': Please rename the assignment to some random string of your choice. Having it as 'Copy of'.. is creating issues of duplicate names when creating a new copy (more details in the section below, named 'Our Recommendation for a separate issue'. Not required for students). If not changed, the next tester might face difficulty while testing(which we don't want to see happening :)).

'''Step 9''': This completes the testing. Reiterate from step 2, if you wish to test again.

== Resolving Issue 2: ==

1) The issue2 deals with whether the students of the topics should be copied or not. so we have decided to implement the issue1 and issue2 together to optimize and eliminate the redundancy by using the dry principle.

2) so instead of providing just 'YES' or 'NO' we added radio buttons which shows:

O copy without topics

O copy with topics

O copy with topics and teams

[[File: oss_copy6.PNG|frame|center]]

3) we can select one of the options and then we can select the create button according to our desired choice

4) The assignment will be copied successfully according to our choice.

[[File: oss_copy7.PNG|frame|center]]

== Code Modification ==
We have modified 5 files and mainly we have modified code in two classes they are:
assignments_controller.rb under the apps/controllers
assignment_form.rb under the apps/models

We have created a new web page that is triggered on clicking the copy icon for the assignment. The view page is the checktopicscopy.html.erb under the views/assignments folder.

== For the reviewers ==
1) Please log in using the instructor credentials they are username:instructor6 password: password

2) Then select the assignment tab under manage

3) The assignment page opens and then select the copy button of the desired assignment.[NOTE: Before copying see that the assignment already has the topics or not by selecting the edit icon of the assignment]

4) If that particular assignment does not have the topics, choose another assignment which has topics to test our functionality.

5) On clicking the copy icon you will be redirected to the web page which has options, select one of the desired options and select the create button.

5) On clicking the Create button you will be redirected to the edit page of the newly created assignment. In the edit page if the topics tab appears it means that the topics are copied and you can check whether the students under the topics are copied or not.[NOTE: if the topics tab is absent beside the General Tab it indicates that the topics are not copied with assignment]

6) Check the new assignment based on the choice you selected while creating a copy of an assignment.

== Testing ==

we have made changes to the test cases and both the assignment_form.rb in models and also the assignments_controller.rb in controllers have passed all the test cases.

== Our work ==
The code we created can be found below. We have also linked the video of our tests running with coverage to showcase the work we have done.
*[https://github.com/expertiza/expertiza/pull/1524 Pull request]
*[http://152.46.17.204:8080/ Deployed URL]

== Our Recommendation for a separate issue <For Instructors only>==

In the current system, we identified an issue and would like to bring it to your notice.

=== Existing System ===

When a user attempts to copy an assignment, the code creates a duplicate ‘assignment’ object, renames it as ‘copy of’ + <name of existing assignment>, saves the object and redirects to the ‘edit’ page where user is supposed to rename the assignment to something meaningful.

=== Issue ===

The current naming scheme as ‘copy of’ + <name of existing assignment> is creating an issue. Say you are creating a copy for some assignment named ‘OSS Project’, the copy object will be named as ‘copy of OSS Project’, saved and redirected to edit page. Had there been an existing assignment names ‘copy of OSS Project’ (which is likely), the copy attempt shall fail, putting a flash message on the screen like:

The assignment was not able to be copied. Please check the original assignment for missing information.

The above error message is in no relevance to the real reason for the error. Even though the save attempt failed, a copy is being inserted into the assignments table in the database.

=== Proposed Recommendation ===

Current naming scheme must be changed to have randomness. The name of the assignment can be given a random string, or a string like ‘copy of ’ + <name of existing assignment> + <5 digit random code>.

The user is anyway supposed to edit the information in the edit page (where the application is redirected after copying is successful). So, here, he can change the name to have some meaningful string.

== Team Information ==
1) Sai Vishnu Muvvala(smuvval)

2) Rohan Pillai(rspillai)

3) Subha Sekhar Reddy Pereddy(speredd)

Mentor : Yashad Trivedi

CSC/ECE 517 Fall 2019 - E1959. Intelligent copying of assignments without topics

2019-10-29T00:41:17Z

Smuvval: /* Testing our work */

== '''Wiki Page Description''' ==
This wiki page describes about the E1959. Intelligent copying of assignments without topics (Issue #1341). We will explain about the issue and also the steps to resolve the issue.

== '''Introduction''' ==

Expertiza is an open source web application project developed using Ruby on Rails framework. Let us list some of the functionalities that Expertiza allows us to do under different roles:

As an Instructor:

We can create new assignments, edit the existing assignments, copy the assignments and also delete the assignment. The instructor can also add participants, reviewers to a particular assignment.

As a Student:

They can form teams to work on various projects and also bid for the projects they would like to work on. They can also review other student's work and can give feedback on them. They can also submit various types of documents including the URLs and wiki pages for their project or assignment submission.

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

===Background:===
When an instructor or a TA logs in to expertiza, he can see a list of assignments under the assignment tab. An instructor or a TA can copy an assignment to use the same event in another course or as another assignment. When the user copies the assignment, the assignment is being copied without providing required flexibility to the users. Majorly, we are focused on implementing two features that shall add flexibility to the copy functionality.

===Issues:===
Issue 1:
While copying an assignment, the user (instructor or TA) is not asked whether (s)he wants to copy the topics along with the assignment or not. Currently, it is copying the topics, without providing any choice for user to not have the topics.

Issue 2:
While copying an assignment, the teams/students assigned to each topic are not getting copied. The user might want to copy the teams/students mapped to the topics as well.

===Steps to generate the issue <Existing system, without our implementation> <Requires Instructor credentials>:===
1) Login to expertiza.ncsu.edu using instructor credentials.

2) Navigate to Assignments section. (How? Hover on Manage Tab -> Click on Assignments)

3) Copy the assignment of your choice by clicking copy icon located on the right side the specific assignment.

Above steps copy the assignment. Remember that this process did not give you the flexibility of choosing whether to copy/not copy

1) Topics linked to assignment

2) Students/teams linked to each topic.

Present system copies the topics and doesn't copy the students, even if you don't want it this way. Our implementation is to provide the user with the functionality to choose copy/not copy topics linked to an assignment and students/teams linked to each topic.

== Testing our work ==
By following the below stated process, you can test the implementation that we worked on, which is:
Target 1: Provide the user with the option to select copy/not copy topics linked to an assignment.
Target 2: Provide the user with the option to select copy/not copy students/teams linked to a topic.

'''Step 1''': Visit http://152.46.17.204:8080/ . Enter the credentials; Username: instructor6 , password: password

'''Step 2''': On the top, hover on Manage tab. Click Assignments.

'''Step 3''': Choose an assignment that you want to copy. We would recommend you choosing a robust assignment which has Topics and students/teams associated with topics. OSS Projects generally have these.

If you want to check and see if an assignment has topics or not, click on Edit (pencil icon) on the right.
- If this assignment has topics, you will see a tab named Topics on the right of General tab. If there are no topics, you won't see Topics tab.
- On Clicking the Topics tab, you can see the list of topics. If students/teams are assigned to topics, you will see student names (alias representations, like student1234 student2343) under each Topic name in 'Topic name(s) column'. If you don't see any such, it means that teams/students are not assigned to topics.

'''Step 4''': After you chose the assignment that you want to copy, click on the copy icon on the right of the corresponding assignment.

Where is the copy button located? Check the image below.
[[File: Copy oss.PNG|frame|center]]

'''Step 5''': Clicking the copy button will take you to copy options page, where you can select the options for copying. The page looks like this:
[[File: oss_copy6.PNG|frame|center]]

'''Step 6''': Choose the option you wish to test. Click create. Now the assignment shall be copied with the options you provided.

'''Step 7''': After copying, the application takes you to 'Edit' page for the assignment where you can edit/view the details pertaining to the assignment. Here, you can test our implementation.
In step 6, if you chose to

- copy without topics: You won't see 'Topics' tab near General tab.

- copy with topics: You will see 'Topics' tab near General tab(As shown in image below). Navigate to Topics tab where you can see and check that the respective topics have been copied. You won't see students under each topic in 'Topic Name(s)' column(If there are topics under Topics tab in original assignment from which you created this copy).

- copy with topics and students: You will see 'Topics' tab near General tab(As shown in image below). Navigate to Topics tab where you can see and check that the respective topics have been copied. You will see students under each topic in 'Topic Name(s)' column(If there are topics and students under Topics tab in original assignment from which you created this copy).

[[File: oss_copy7.PNG|frame|center]]

'''Step 8''': Please rename the assignment to some random string of your choice. Having it as 'Copy of'.. is creating issues when creating a new copy (more details )

'''Step 9''': This completes the testing. Reiterate from step 2, if you wish to test again.

== Resolving Issue 2: ==

1) The issue2 deals with whether the students of the topics should be copied or not. so we have decided to implement the issue1 and issue2 together to optimize and eliminate the redundancy by using the dry principle.

2) so instead of providing just 'YES' or 'NO' we added radio buttons which shows:

O copy without topics

O copy with topics

O copy with topics and teams

[[File: oss_copy6.PNG|frame|center]]

3) we can select one of the options and then we can select the create button according to our desired choice

4) The assignment will be copied successfully according to our choice.

[[File: oss_copy7.PNG|frame|center]]

== Code Modification ==
We have modified 5 files and mainly we have modified code in two classes they are:
assignments_controller.rb under the apps/controllers
assignment_form.rb under the apps/models

We have created a new web page that is triggered on clicking the copy icon for the assignment. The view page is the checktopicscopy.html.erb under the views/assignments folder.

== For the reviewers ==
1) Please log in using the instructor credentials they are username:instructor6 password: password

2) Then select the assignment tab under manage

3) The assignment page opens and then select the copy button of the desired assignment.[NOTE: Before copying see that the assignment already has the topics or not by selecting the edit icon of the assignment]

4) If that particular assignment does not have the topics, choose another assignment which has topics to test our functionality.

5) On clicking the copy icon you will be redirected to the web page which has options, select one of the desired options and select the create button.

5) On clicking the Create button you will be redirected to the edit page of the newly created assignment. In the edit page if the topics tab appears it means that the topics are copied and you can check whether the students under the topics are copied or not.[NOTE: if the topics tab is absent beside the General Tab it indicates that the topics are not copied with assignment]

6) Check the new assignment based on the choice you selected while creating a copy of an assignment.

== Testing ==

we have made changes to the test cases and both the assignment_form.rb in models and also the assignments_controller.rb in controllers have passed all the test cases.

== Our work ==
The code we created can be found below. We have also linked the video of our tests running with coverage to showcase the work we have done.
*[https://github.com/expertiza/expertiza/pull/1524 Pull request]
*[http://152.46.17.204:8080/ Deployed URL]

== Our Recommendation for a separate issue <For Instructors only>==

In the current system, we identified an issue and would like to bring it to your notice.

=== Existing System ===

When a user attempts to copy an assignment, the code creates a duplicate ‘assignment’ object, renames it as ‘copy of’ + <name of existing assignment>, saves the object and redirects to the ‘edit’ page where user is supposed to rename the assignment to something meaningful.

=== Issue ===

The current naming scheme as ‘copy of’ + <name of existing assignment> is creating an issue. Say you are creating a copy for some assignment named ‘OSS Project’, the copy object will be named as ‘copy of OSS Project’, saved and redirected to edit page. Had there been an existing assignment names ‘copy of OSS Project’ (which is likely), the copy attempt shall fail, putting a flash message on the screen like:

The assignment was not able to be copied. Please check the original assignment for missing information.

The above error message is in no relevance to the real reason for the error. Even though the save attempt failed, a copy is being inserted into the assignments table in the database.

=== Proposed Recommendation ===

Current naming scheme must be changed to have randomness. The name of the assignment can be given a random string, or a string like ‘copy of ’ + <name of existing assignment> + <5 digit random code>.

The user is anyway supposed to edit the information in the edit page (where the application is redirected after copying is successful). So, here, he can change the name to have some meaningful string.

== Team Information ==
1) Sai Vishnu Muvvala(smuvval)

2) Rohan Pillai(rspillai)

3) Subha Sekhar Reddy Pereddy(speredd)

Mentor : Yashad Trivedi

CSC/ECE 517 Fall 2019 - E1959. Intelligent copying of assignments without topics

2019-10-29T00:39:18Z

Smuvval: /* Our Recommendation for a separate issue */

== '''Wiki Page Description''' ==
This wiki page describes about the E1959. Intelligent copying of assignments without topics (Issue #1341). We will explain about the issue and also the steps to resolve the issue.

== '''Introduction''' ==

Expertiza is an open source web application project developed using Ruby on Rails framework. Let us list some of the functionalities that Expertiza allows us to do under different roles:

As an Instructor:

We can create new assignments, edit the existing assignments, copy the assignments and also delete the assignment. The instructor can also add participants, reviewers to a particular assignment.

As a Student:

They can form teams to work on various projects and also bid for the projects they would like to work on. They can also review other student's work and can give feedback on them. They can also submit various types of documents including the URLs and wiki pages for their project or assignment submission.

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

===Background:===
When an instructor or a TA logs in to expertiza, he can see a list of assignments under the assignment tab. An instructor or a TA can copy an assignment to use the same event in another course or as another assignment. When the user copies the assignment, the assignment is being copied without providing required flexibility to the users. Majorly, we are focused on implementing two features that shall add flexibility to the copy functionality.

===Issues:===
Issue 1:
While copying an assignment, the user (instructor or TA) is not asked whether (s)he wants to copy the topics along with the assignment or not. Currently, it is copying the topics, without providing any choice for user to not have the topics.

Issue 2:
While copying an assignment, the teams/students assigned to each topic are not getting copied. The user might want to copy the teams/students mapped to the topics as well.

===Steps to generate the issue <Existing system, without our implementation> <Requires Instructor credentials>:===
1) Login to expertiza.ncsu.edu using instructor credentials.

2) Navigate to Assignments section. (How? Hover on Manage Tab -> Click on Assignments)

3) Copy the assignment of your choice by clicking copy icon located on the right side the specific assignment.

Above steps copy the assignment. Remember that this process did not give you the flexibility of choosing whether to copy/not copy

1) Topics linked to assignment

2) Students/teams linked to each topic.

Present system copies the topics and doesn't copy the students, even if you don't want it this way. Our implementation is to provide the user with the functionality to choose copy/not copy topics linked to an assignment and students/teams linked to each topic.

== Testing our work ==
By following the below stated process, you can test the implementation that we worked on, which is:
Target 1: Provide the user with the option to select copy/not copy topics linked to an assignment.
Target 2: Provide the user with the option to select copy/not copy students/teams linked to a topic.

'''Step 1''': Visit http://152.46.17.204:8080/ . Enter the credentials; Username: instructor6 , password: password

'''Step 2''': On the top, hover on Manage tab. Click Assignments.

'''Step 3''': Choose an assignment that you want to copy. We would recommend you choosing a robust assignment which has Topics and students/teams associated with topics. OSS Projects generally have these.

If you want to check and see if an assignment has topics or not, click on Edit (pencil icon) on the right.
- If this assignment has topics, you will see a tab named Topics on the right of General tab. If there are no topics, you won't see Topics tab.
- On Clicking the Topics tab, you can see the list of topics. If students/teams are assigned to topics, you will see student names (alias representations, like student1234 student2343) under each Topic name in 'Topic name(s) column'. If you don't see any such, it means that teams/students are not assigned to topics.

'''Step 4''': After you chose the assignment that you want to copy, click on the copy icon on the right of the corresponding assignment.

Where is the copy button located? Check the image below.
[[File: Copy oss.PNG|frame|center]]

'''Step 5''': Clicking the copy button will take you to copy options page, where you can select the options for copying. The page looks like this:
[[File: oss_copy6.PNG|frame|center]]

'''Step 6''': Choose the option you wish to test. Click create. Now the assignment shall be copied with the options you provided.

'''Step 7''': After copying, the application takes you to 'Edit' page for the assignment where you can edit/view the details pertaining to the assignment. Here, you can test our implementation.
In step 6, if you chose to

- copy without topics: You won't see 'Topics' tab near General tab.

- copy with topics: You will see 'Topics' tab near General tab(As shown in image below). Navigate to Topics tab where you can see and check that the respective topics have been copied. You won't see students under each topic in 'Topic Name(s)' column(If there are topics under Topics tab in original assignment from which you created this copy).

- copy with topics and students: You will see 'Topics' tab near General tab(As shown in image below). Navigate to Topics tab where you can see and check that the respective topics have been copied. You will see students under each topic in 'Topic Name(s)' column(If there are topics and students under Topics tab in original assignment from which you created this copy).

[[File: oss_copy7.PNG|frame|center]]

'''Step 8''': This completes the testing. Reiterate from step 2, if you wish to test again.

== Resolving Issue 2: ==

1) The issue2 deals with whether the students of the topics should be copied or not. so we have decided to implement the issue1 and issue2 together to optimize and eliminate the redundancy by using the dry principle.

2) so instead of providing just 'YES' or 'NO' we added radio buttons which shows:

O copy without topics

O copy with topics

O copy with topics and teams

[[File: oss_copy6.PNG|frame|center]]

3) we can select one of the options and then we can select the create button according to our desired choice

4) The assignment will be copied successfully according to our choice.

[[File: oss_copy7.PNG|frame|center]]

== Code Modification ==
We have modified 5 files and mainly we have modified code in two classes they are:
assignments_controller.rb under the apps/controllers
assignment_form.rb under the apps/models

We have created a new web page that is triggered on clicking the copy icon for the assignment. The view page is the checktopicscopy.html.erb under the views/assignments folder.

== For the reviewers ==
1) Please log in using the instructor credentials they are username:instructor6 password: password

2) Then select the assignment tab under manage

3) The assignment page opens and then select the copy button of the desired assignment.[NOTE: Before copying see that the assignment already has the topics or not by selecting the edit icon of the assignment]

4) If that particular assignment does not have the topics, choose another assignment which has topics to test our functionality.

5) On clicking the copy icon you will be redirected to the web page which has options, select one of the desired options and select the create button.

5) On clicking the Create button you will be redirected to the edit page of the newly created assignment. In the edit page if the topics tab appears it means that the topics are copied and you can check whether the students under the topics are copied or not.[NOTE: if the topics tab is absent beside the General Tab it indicates that the topics are not copied with assignment]

6) Check the new assignment based on the choice you selected while creating a copy of an assignment.

== Testing ==

we have made changes to the test cases and both the assignment_form.rb in models and also the assignments_controller.rb in controllers have passed all the test cases.

== Our work ==
The code we created can be found below. We have also linked the video of our tests running with coverage to showcase the work we have done.
*[https://github.com/expertiza/expertiza/pull/1524 Pull request]
*[http://152.46.17.204:8080/ Deployed URL]

== Our Recommendation for a separate issue <For Instructors only>==

In the current system, we identified an issue and would like to bring it to your notice.

=== Existing System ===

When a user attempts to copy an assignment, the code creates a duplicate ‘assignment’ object, renames it as ‘copy of’ + <name of existing assignment>, saves the object and redirects to the ‘edit’ page where user is supposed to rename the assignment to something meaningful.

=== Issue ===

The current naming scheme as ‘copy of’ + <name of existing assignment> is creating an issue. Say you are creating a copy for some assignment named ‘OSS Project’, the copy object will be named as ‘copy of OSS Project’, saved and redirected to edit page. Had there been an existing assignment names ‘copy of OSS Project’ (which is likely), the copy attempt shall fail, putting a flash message on the screen like:

The assignment was not able to be copied. Please check the original assignment for missing information.

The above error message is in no relevance to the real reason for the error. Even though the save attempt failed, a copy is being inserted into the assignments table in the database.

=== Proposed Recommendation ===

Current naming scheme must be changed to have randomness. The name of the assignment can be given a random string, or a string like ‘copy of ’ + <name of existing assignment> + <5 digit random code>.

The user is anyway supposed to edit the information in the edit page (where the application is redirected after copying is successful). So, here, he can change the name to have some meaningful string.

== Team Information ==
1) Sai Vishnu Muvvala(smuvval)

2) Rohan Pillai(rspillai)

3) Subha Sekhar Reddy Pereddy(speredd)

Mentor : Yashad Trivedi

CSC/ECE 517 Fall 2019 - E1959. Intelligent copying of assignments without topics

2019-10-29T00:38:41Z

Smuvval: /* Our Recommendation for a separate issue */

== '''Wiki Page Description''' ==
This wiki page describes about the E1959. Intelligent copying of assignments without topics (Issue #1341). We will explain about the issue and also the steps to resolve the issue.

== '''Introduction''' ==

Expertiza is an open source web application project developed using Ruby on Rails framework. Let us list some of the functionalities that Expertiza allows us to do under different roles:

As an Instructor:

We can create new assignments, edit the existing assignments, copy the assignments and also delete the assignment. The instructor can also add participants, reviewers to a particular assignment.

As a Student:

They can form teams to work on various projects and also bid for the projects they would like to work on. They can also review other student's work and can give feedback on them. They can also submit various types of documents including the URLs and wiki pages for their project or assignment submission.

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

===Background:===
When an instructor or a TA logs in to expertiza, he can see a list of assignments under the assignment tab. An instructor or a TA can copy an assignment to use the same event in another course or as another assignment. When the user copies the assignment, the assignment is being copied without providing required flexibility to the users. Majorly, we are focused on implementing two features that shall add flexibility to the copy functionality.

===Issues:===
Issue 1:
While copying an assignment, the user (instructor or TA) is not asked whether (s)he wants to copy the topics along with the assignment or not. Currently, it is copying the topics, without providing any choice for user to not have the topics.

Issue 2:
While copying an assignment, the teams/students assigned to each topic are not getting copied. The user might want to copy the teams/students mapped to the topics as well.

===Steps to generate the issue <Existing system, without our implementation> <Requires Instructor credentials>:===
1) Login to expertiza.ncsu.edu using instructor credentials.

2) Navigate to Assignments section. (How? Hover on Manage Tab -> Click on Assignments)

3) Copy the assignment of your choice by clicking copy icon located on the right side the specific assignment.

Above steps copy the assignment. Remember that this process did not give you the flexibility of choosing whether to copy/not copy

1) Topics linked to assignment

2) Students/teams linked to each topic.

Present system copies the topics and doesn't copy the students, even if you don't want it this way. Our implementation is to provide the user with the functionality to choose copy/not copy topics linked to an assignment and students/teams linked to each topic.

== Testing our work ==
By following the below stated process, you can test the implementation that we worked on, which is:
Target 1: Provide the user with the option to select copy/not copy topics linked to an assignment.
Target 2: Provide the user with the option to select copy/not copy students/teams linked to a topic.

'''Step 1''': Visit http://152.46.17.204:8080/ . Enter the credentials; Username: instructor6 , password: password

'''Step 2''': On the top, hover on Manage tab. Click Assignments.

'''Step 3''': Choose an assignment that you want to copy. We would recommend you choosing a robust assignment which has Topics and students/teams associated with topics. OSS Projects generally have these.

If you want to check and see if an assignment has topics or not, click on Edit (pencil icon) on the right.
- If this assignment has topics, you will see a tab named Topics on the right of General tab. If there are no topics, you won't see Topics tab.
- On Clicking the Topics tab, you can see the list of topics. If students/teams are assigned to topics, you will see student names (alias representations, like student1234 student2343) under each Topic name in 'Topic name(s) column'. If you don't see any such, it means that teams/students are not assigned to topics.

'''Step 4''': After you chose the assignment that you want to copy, click on the copy icon on the right of the corresponding assignment.

Where is the copy button located? Check the image below.
[[File: Copy oss.PNG|frame|center]]

'''Step 5''': Clicking the copy button will take you to copy options page, where you can select the options for copying. The page looks like this:
[[File: oss_copy6.PNG|frame|center]]

'''Step 6''': Choose the option you wish to test. Click create. Now the assignment shall be copied with the options you provided.

'''Step 7''': After copying, the application takes you to 'Edit' page for the assignment where you can edit/view the details pertaining to the assignment. Here, you can test our implementation.
In step 6, if you chose to

- copy without topics: You won't see 'Topics' tab near General tab.

- copy with topics: You will see 'Topics' tab near General tab(As shown in image below). Navigate to Topics tab where you can see and check that the respective topics have been copied. You won't see students under each topic in 'Topic Name(s)' column(If there are topics under Topics tab in original assignment from which you created this copy).

- copy with topics and students: You will see 'Topics' tab near General tab(As shown in image below). Navigate to Topics tab where you can see and check that the respective topics have been copied. You will see students under each topic in 'Topic Name(s)' column(If there are topics and students under Topics tab in original assignment from which you created this copy).

[[File: oss_copy7.PNG|frame|center]]

'''Step 8''': This completes the testing. Reiterate from step 2, if you wish to test again.

== Resolving Issue 2: ==

1) The issue2 deals with whether the students of the topics should be copied or not. so we have decided to implement the issue1 and issue2 together to optimize and eliminate the redundancy by using the dry principle.

2) so instead of providing just 'YES' or 'NO' we added radio buttons which shows:

O copy without topics

O copy with topics

O copy with topics and teams

[[File: oss_copy6.PNG|frame|center]]

3) we can select one of the options and then we can select the create button according to our desired choice

4) The assignment will be copied successfully according to our choice.

[[File: oss_copy7.PNG|frame|center]]

== Code Modification ==
We have modified 5 files and mainly we have modified code in two classes they are:
assignments_controller.rb under the apps/controllers
assignment_form.rb under the apps/models

We have created a new web page that is triggered on clicking the copy icon for the assignment. The view page is the checktopicscopy.html.erb under the views/assignments folder.

== For the reviewers ==
1) Please log in using the instructor credentials they are username:instructor6 password: password

2) Then select the assignment tab under manage

3) The assignment page opens and then select the copy button of the desired assignment.[NOTE: Before copying see that the assignment already has the topics or not by selecting the edit icon of the assignment]

4) If that particular assignment does not have the topics, choose another assignment which has topics to test our functionality.

5) On clicking the copy icon you will be redirected to the web page which has options, select one of the desired options and select the create button.

5) On clicking the Create button you will be redirected to the edit page of the newly created assignment. In the edit page if the topics tab appears it means that the topics are copied and you can check whether the students under the topics are copied or not.[NOTE: if the topics tab is absent beside the General Tab it indicates that the topics are not copied with assignment]

6) Check the new assignment based on the choice you selected while creating a copy of an assignment.

== Testing ==

we have made changes to the test cases and both the assignment_form.rb in models and also the assignments_controller.rb in controllers have passed all the test cases.

== Our work ==
The code we created can be found below. We have also linked the video of our tests running with coverage to showcase the work we have done.
*[https://github.com/expertiza/expertiza/pull/1524 Pull request]
*[http://152.46.17.204:8080/ Deployed URL]

== Our Recommendation for a separate issue <For Instructors reading purpose only>==

In the current system, we identified an issue and would like to bring it to your notice.

=== Existing System ===

When a user attempts to copy an assignment, the code creates a duplicate ‘assignment’ object, renames it as ‘copy of’ + <name of existing assignment>, saves the object and redirects to the ‘edit’ page where user is supposed to rename the assignment to something meaningful.

=== Issue ===

The current naming scheme as ‘copy of’ + <name of existing assignment> is creating an issue. Say you are creating a copy for some assignment named ‘OSS Project’, the copy object will be named as ‘copy of OSS Project’, saved and redirected to edit page. Had there been an existing assignment names ‘copy of OSS Project’ (which is likely), the copy attempt shall fail, putting a flash message on the screen like:

The assignment was not able to be copied. Please check the original assignment for missing information.

The above error message is in no relevance to the real reason for the error. Even though the save attempt failed, a copy is being inserted into the assignments table in the database.

=== Proposed Recommendation ===

Current naming scheme must be changed to have randomness. The name of the assignment can be given a random string, or a string like ‘copy of ’ + <name of existing assignment> + <5 digit random code>.

The user is anyway supposed to edit the information in the edit page (where the application is redirected after copying is successful). So, here, he can change the name to have some meaningful string.

== Team Information ==
1) Sai Vishnu Muvvala(smuvval)

2) Rohan Pillai(rspillai)

3) Subha Sekhar Reddy Pereddy(speredd)

Mentor : Yashad Trivedi

CSC/ECE 517 Fall 2019 - E1959. Intelligent copying of assignments without topics

2019-10-29T00:37:05Z

Smuvval: /* Testing our work */

== '''Wiki Page Description''' ==
This wiki page describes about the E1959. Intelligent copying of assignments without topics (Issue #1341). We will explain about the issue and also the steps to resolve the issue.

== '''Introduction''' ==

Expertiza is an open source web application project developed using Ruby on Rails framework. Let us list some of the functionalities that Expertiza allows us to do under different roles:

As an Instructor:

We can create new assignments, edit the existing assignments, copy the assignments and also delete the assignment. The instructor can also add participants, reviewers to a particular assignment.

As a Student:

They can form teams to work on various projects and also bid for the projects they would like to work on. They can also review other student's work and can give feedback on them. They can also submit various types of documents including the URLs and wiki pages for their project or assignment submission.

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

===Background:===
When an instructor or a TA logs in to expertiza, he can see a list of assignments under the assignment tab. An instructor or a TA can copy an assignment to use the same event in another course or as another assignment. When the user copies the assignment, the assignment is being copied without providing required flexibility to the users. Majorly, we are focused on implementing two features that shall add flexibility to the copy functionality.

===Issues:===
Issue 1:
While copying an assignment, the user (instructor or TA) is not asked whether (s)he wants to copy the topics along with the assignment or not. Currently, it is copying the topics, without providing any choice for user to not have the topics.

Issue 2:
While copying an assignment, the teams/students assigned to each topic are not getting copied. The user might want to copy the teams/students mapped to the topics as well.

===Steps to generate the issue <Existing system, without our implementation> <Requires Instructor credentials>:===
1) Login to expertiza.ncsu.edu using instructor credentials.

2) Navigate to Assignments section. (How? Hover on Manage Tab -> Click on Assignments)

3) Copy the assignment of your choice by clicking copy icon located on the right side the specific assignment.

Above steps copy the assignment. Remember that this process did not give you the flexibility of choosing whether to copy/not copy

1) Topics linked to assignment

2) Students/teams linked to each topic.

Present system copies the topics and doesn't copy the students, even if you don't want it this way. Our implementation is to provide the user with the functionality to choose copy/not copy topics linked to an assignment and students/teams linked to each topic.

== Testing our work ==
By following the below stated process, you can test the implementation that we worked on, which is:
Target 1: Provide the user with the option to select copy/not copy topics linked to an assignment.
Target 2: Provide the user with the option to select copy/not copy students/teams linked to a topic.

'''Step 1''': Visit http://152.46.17.204:8080/ . Enter the credentials; Username: instructor6 , password: password

'''Step 2''': On the top, hover on Manage tab. Click Assignments.

'''Step 3''': Choose an assignment that you want to copy. We would recommend you choosing a robust assignment which has Topics and students/teams associated with topics. OSS Projects generally have these.

If you want to check and see if an assignment has topics or not, click on Edit (pencil icon) on the right.
- If this assignment has topics, you will see a tab named Topics on the right of General tab. If there are no topics, you won't see Topics tab.
- On Clicking the Topics tab, you can see the list of topics. If students/teams are assigned to topics, you will see student names (alias representations, like student1234 student2343) under each Topic name in 'Topic name(s) column'. If you don't see any such, it means that teams/students are not assigned to topics.

'''Step 4''': After you chose the assignment that you want to copy, click on the copy icon on the right of the corresponding assignment.

Where is the copy button located? Check the image below.
[[File: Copy oss.PNG|frame|center]]

'''Step 5''': Clicking the copy button will take you to copy options page, where you can select the options for copying. The page looks like this:
[[File: oss_copy6.PNG|frame|center]]

'''Step 6''': Choose the option you wish to test. Click create. Now the assignment shall be copied with the options you provided.

'''Step 7''': After copying, the application takes you to 'Edit' page for the assignment where you can edit/view the details pertaining to the assignment. Here, you can test our implementation.
In step 6, if you chose to

- copy without topics: You won't see 'Topics' tab near General tab.

- copy with topics: You will see 'Topics' tab near General tab(As shown in image below). Navigate to Topics tab where you can see and check that the respective topics have been copied. You won't see students under each topic in 'Topic Name(s)' column(If there are topics under Topics tab in original assignment from which you created this copy).

- copy with topics and students: You will see 'Topics' tab near General tab(As shown in image below). Navigate to Topics tab where you can see and check that the respective topics have been copied. You will see students under each topic in 'Topic Name(s)' column(If there are topics and students under Topics tab in original assignment from which you created this copy).

[[File: oss_copy7.PNG|frame|center]]

'''Step 8''': This completes the testing. Reiterate from step 2, if you wish to test again.

== Resolving Issue 2: ==

1) The issue2 deals with whether the students of the topics should be copied or not. so we have decided to implement the issue1 and issue2 together to optimize and eliminate the redundancy by using the dry principle.

2) so instead of providing just 'YES' or 'NO' we added radio buttons which shows:

O copy without topics

O copy with topics

O copy with topics and teams

[[File: oss_copy6.PNG|frame|center]]

3) we can select one of the options and then we can select the create button according to our desired choice

4) The assignment will be copied successfully according to our choice.

[[File: oss_copy7.PNG|frame|center]]

== Code Modification ==
We have modified 5 files and mainly we have modified code in two classes they are:
assignments_controller.rb under the apps/controllers
assignment_form.rb under the apps/models

We have created a new web page that is triggered on clicking the copy icon for the assignment. The view page is the checktopicscopy.html.erb under the views/assignments folder.

== For the reviewers ==
1) Please log in using the instructor credentials they are username:instructor6 password: password

2) Then select the assignment tab under manage

3) The assignment page opens and then select the copy button of the desired assignment.[NOTE: Before copying see that the assignment already has the topics or not by selecting the edit icon of the assignment]

4) If that particular assignment does not have the topics, choose another assignment which has topics to test our functionality.

5) On clicking the copy icon you will be redirected to the web page which has options, select one of the desired options and select the create button.

5) On clicking the Create button you will be redirected to the edit page of the newly created assignment. In the edit page if the topics tab appears it means that the topics are copied and you can check whether the students under the topics are copied or not.[NOTE: if the topics tab is absent beside the General Tab it indicates that the topics are not copied with assignment]

6) Check the new assignment based on the choice you selected while creating a copy of an assignment.

== Testing ==

we have made changes to the test cases and both the assignment_form.rb in models and also the assignments_controller.rb in controllers have passed all the test cases.

== Our work ==
The code we created can be found below. We have also linked the video of our tests running with coverage to showcase the work we have done.
*[https://github.com/expertiza/expertiza/pull/1524 Pull request]
*[http://152.46.17.204:8080/ Deployed URL]

== Our Recommendation for a separate issue ==

In the current system, we identified an issue and would like to bring it to your notice.

=== Existing System ===

When a user attempts to copy an assignment, the code creates a duplicate ‘assignment’ object, renames it as ‘copy of’ + <name of existing assignment>, saves the object and redirects to the ‘edit’ page where user is supposed to rename the assignment to something meaningful.

=== Issue ===

The current naming scheme as ‘copy of’ + <name of existing assignment> is creating an issue. Say you are creating a copy for some assignment named ‘OSS Project’, the copy object will be named as ‘copy of OSS Project’, saved and redirected to edit page. Had there been an existing assignment names ‘copy of OSS Project’ (which is likely), the copy attempt shall fail, putting a flash message on the screen like:

The assignment was not able to be copied. Please check the original assignment for missing information.

The above error message is in no relevance to the real reason for the error. Even though the save attempt failed, a copy is being inserted into the assignments table in the database.

=== Proposed Recommendation ===

Current naming scheme must be changed to have randomness. The name of the assignment can be given a random string, or a string like ‘copy of ’ + <name of existing assignment> + <5 digit random code>.

The user is anyway supposed to edit the information in the edit page (where the application is redirected after copying is successful). So, here, he can change the name to have some meaningful string.

== Team Information ==
1) Sai Vishnu Muvvala(smuvval)

2) Rohan Pillai(rspillai)

3) Subha Sekhar Reddy Pereddy(speredd)

Mentor : Yashad Trivedi

CSC/ECE 517 Fall 2019 - E1959. Intelligent copying of assignments without topics

2019-10-29T00:34:11Z

Smuvval: /* Testing our work */

== '''Wiki Page Description''' ==
This wiki page describes about the E1959. Intelligent copying of assignments without topics (Issue #1341). We will explain about the issue and also the steps to resolve the issue.

== '''Introduction''' ==

Expertiza is an open source web application project developed using Ruby on Rails framework. Let us list some of the functionalities that Expertiza allows us to do under different roles:

As an Instructor:

We can create new assignments, edit the existing assignments, copy the assignments and also delete the assignment. The instructor can also add participants, reviewers to a particular assignment.

As a Student:

They can form teams to work on various projects and also bid for the projects they would like to work on. They can also review other student's work and can give feedback on them. They can also submit various types of documents including the URLs and wiki pages for their project or assignment submission.

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

===Background:===
When an instructor or a TA logs in to expertiza, he can see a list of assignments under the assignment tab. An instructor or a TA can copy an assignment to use the same event in another course or as another assignment. When the user copies the assignment, the assignment is being copied without providing required flexibility to the users. Majorly, we are focused on implementing two features that shall add flexibility to the copy functionality.

===Issues:===
Issue 1:
While copying an assignment, the user (instructor or TA) is not asked whether (s)he wants to copy the topics along with the assignment or not. Currently, it is copying the topics, without providing any choice for user to not have the topics.

Issue 2:
While copying an assignment, the teams/students assigned to each topic are not getting copied. The user might want to copy the teams/students mapped to the topics as well.

===Steps to generate the issue <Existing system, without our implementation> <Requires Instructor credentials>:===
1) Login to expertiza.ncsu.edu using instructor credentials.

2) Navigate to Assignments section. (How? Hover on Manage Tab -> Click on Assignments)

3) Copy the assignment of your choice by clicking copy icon located on the right side the specific assignment.

Above steps copy the assignment. Remember that this process did not give you the flexibility of choosing whether to copy/not copy

1) Topics linked to assignment

2) Students/teams linked to each topic.

Present system copies the topics and doesn't copy the students, even if you don't want it this way. Our implementation is to provide the user with the functionality to choose copy/not copy topics linked to an assignment and students/teams linked to each topic.

== Testing our work ==
By following the below stated process, you can test the implementation that we worked on, which is:
Target 1: Provide the user with the option to select copy/not copy topics linked to an assignment.
Target 2: Provide the user with the option to select copy/not copy students/teams linked to a topic.

Step 1: Visit http://152.46.17.204:8080/ . Enter the credentials; Username: instructor6 , password: password

Step 2: On the top, hover on Manage tab. Click Assignments.

Step 3: Choose an assignment that you want to copy. We would recommend you choosing a robust assignment which has Topics and students/teams associated with topics. OSS Projects generally have these.

If you want to check and see if an assignment has topics or not, click on Edit (pencil icon) on the right.
- If this assignment has topics, you will see a tab named Topics on the right of General tab. If there are no topics, you won't see Topics tab.
- On Clicking the Topics tab, you can see the list of topics. If students/teams are assigned to topics, you will see student names (alias representations, like student1234 student2343) under each Topic name in 'Topic name(s) column'. If you don't see any such, it means that teams/students are not assigned to topics.

Step 4: After you chose the assignment that you want to copy, click on the copy icon on the right of the corresponding assignment.

Where is the copy button located? Check the image below.
[[File: Copy oss.PNG|frame|center]]

Step 5: Clicking the copy button will take you to copy options page, where you can select the options for copying. The page looks like this:
[[File: oss_copy6.PNG|frame|center]]

Step 6: Choose the option you wish to test. Click create. Now the assignment shall be copied with the options you provided.

Step 7: After copying, the application takes you to 'Edit' page for the assignment where you can edit/view the details pertaining to the assignment. Here, you can test our implementation.
In step 6, if you chose to

- copy without topics: You won't see 'Topics' tab near General tab.

- copy with topics: You will see 'Topics' tab near General tab. Navigate to Topics tab where you can see and check that the respective topics have been copied. You won't see students under each topic in 'Topic Name(s)' column(If there are topics under Topics tab in original assignment from which you created this copy).

- copy with topics and students: You will see 'Topics' tab near General tab. Navigate to Topics tab where you can see and check that the respective topics have been copied. You will see students under each topic in 'Topic Name(s)' column(If there are topics and students under Topics tab in original assignment from which you created this copy).

Step 8: This completes the testing. Reiterate from step 2, if you wish to test again.

3) So if we want to copy the topics associated with the assignment we will select the 'YES' button or 'NO' button if we don't want to copy the topics associated with the assignment. if we select the YES Button, then we will have a flash message showing that the assignment was copied successfully and the topics are listed under the topics tab.
[[File: Copy3 oss.PNG|frame|center]]

[[File: Copy4 oss.PNG|frame|center]]

On clicking the topics tab we can see the list of topics under the assignment copied

[[File: Copy5 oss.PNG|frame|center]]

4) In a similar way, we can select the NO button which does not allow the assignment to be copied.

== Resolving Issue 2: ==

1) The issue2 deals with whether the students of the topics should be copied or not. so we have decided to implement the issue1 and issue2 together to optimize and eliminate the redundancy by using the dry principle.

2) so instead of providing just 'YES' or 'NO' we added radio buttons which shows:

O copy without topics

O copy with topics

O copy with topics and teams

[[File: oss_copy6.PNG|frame|center]]

3) we can select one of the options and then we can select the create button according to our desired choice

4) The assignment will be copied successfully according to our choice.

[[File: oss_copy7.PNG|frame|center]]

== Code Modification ==
We have modified 5 files and mainly we have modified code in two classes they are:
assignments_controller.rb under the apps/controllers
assignment_form.rb under the apps/models

We have created a new web page that is triggered on clicking the copy icon for the assignment. The view page is the checktopicscopy.html.erb under the views/assignments folder.

== For the reviewers ==
1) Please log in using the instructor credentials they are username:instructor6 password: password

2) Then select the assignment tab under manage

3) The assignment page opens and then select the copy button of the desired assignment.[NOTE: Before copying see that the assignment already has the topics or not by selecting the edit icon of the assignment]

4) If that particular assignment does not have the topics, choose another assignment which has topics to test our functionality.

5) On clicking the copy icon you will be redirected to the web page which has options, select one of the desired options and select the create button.

5) On clicking the Create button you will be redirected to the edit page of the newly created assignment. In the edit page if the topics tab appears it means that the topics are copied and you can check whether the students under the topics are copied or not.[NOTE: if the topics tab is absent beside the General Tab it indicates that the topics are not copied with assignment]

6) Check the new assignment based on the choice you selected while creating a copy of an assignment.

== Testing ==

we have made changes to the test cases and both the assignment_form.rb in models and also the assignments_controller.rb in controllers have passed all the test cases.

== Our work ==
The code we created can be found below. We have also linked the video of our tests running with coverage to showcase the work we have done.
*[https://github.com/expertiza/expertiza/pull/1524 Pull request]
*[http://152.46.17.204:8080/ Deployed URL]

== Our Recommendation for a separate issue ==

In the current system, we identified an issue and would like to bring it to your notice.

=== Existing System ===

When a user attempts to copy an assignment, the code creates a duplicate ‘assignment’ object, renames it as ‘copy of’ + <name of existing assignment>, saves the object and redirects to the ‘edit’ page where user is supposed to rename the assignment to something meaningful.

=== Issue ===

The current naming scheme as ‘copy of’ + <name of existing assignment> is creating an issue. Say you are creating a copy for some assignment named ‘OSS Project’, the copy object will be named as ‘copy of OSS Project’, saved and redirected to edit page. Had there been an existing assignment names ‘copy of OSS Project’ (which is likely), the copy attempt shall fail, putting a flash message on the screen like:

The assignment was not able to be copied. Please check the original assignment for missing information.

The above error message is in no relevance to the real reason for the error. Even though the save attempt failed, a copy is being inserted into the assignments table in the database.

=== Proposed Recommendation ===

Current naming scheme must be changed to have randomness. The name of the assignment can be given a random string, or a string like ‘copy of ’ + <name of existing assignment> + <5 digit random code>.

The user is anyway supposed to edit the information in the edit page (where the application is redirected after copying is successful). So, here, he can change the name to have some meaningful string.

== Team Information ==
1) Sai Vishnu Muvvala(smuvval)

2) Rohan Pillai(rspillai)

3) Subha Sekhar Reddy Pereddy(speredd)

Mentor : Yashad Trivedi

CSC/ECE 517 Fall 2019 - E1959. Intelligent copying of assignments without topics

2019-10-29T00:33:47Z

Smuvval: /* Testing our work */

== '''Wiki Page Description''' ==
This wiki page describes about the E1959. Intelligent copying of assignments without topics (Issue #1341). We will explain about the issue and also the steps to resolve the issue.

== '''Introduction''' ==

Expertiza is an open source web application project developed using Ruby on Rails framework. Let us list some of the functionalities that Expertiza allows us to do under different roles:

As an Instructor:

We can create new assignments, edit the existing assignments, copy the assignments and also delete the assignment. The instructor can also add participants, reviewers to a particular assignment.

As a Student:

They can form teams to work on various projects and also bid for the projects they would like to work on. They can also review other student's work and can give feedback on them. They can also submit various types of documents including the URLs and wiki pages for their project or assignment submission.

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

===Background:===
When an instructor or a TA logs in to expertiza, he can see a list of assignments under the assignment tab. An instructor or a TA can copy an assignment to use the same event in another course or as another assignment. When the user copies the assignment, the assignment is being copied without providing required flexibility to the users. Majorly, we are focused on implementing two features that shall add flexibility to the copy functionality.

===Issues:===
Issue 1:
While copying an assignment, the user (instructor or TA) is not asked whether (s)he wants to copy the topics along with the assignment or not. Currently, it is copying the topics, without providing any choice for user to not have the topics.

Issue 2:
While copying an assignment, the teams/students assigned to each topic are not getting copied. The user might want to copy the teams/students mapped to the topics as well.

===Steps to generate the issue <Existing system, without our implementation> <Requires Instructor credentials>:===
1) Login to expertiza.ncsu.edu using instructor credentials.

2) Navigate to Assignments section. (How? Hover on Manage Tab -> Click on Assignments)

3) Copy the assignment of your choice by clicking copy icon located on the right side the specific assignment.

Above steps copy the assignment. Remember that this process did not give you the flexibility of choosing whether to copy/not copy

1) Topics linked to assignment

2) Students/teams linked to each topic.

Present system copies the topics and doesn't copy the students, even if you don't want it this way. Our implementation is to provide the user with the functionality to choose copy/not copy topics linked to an assignment and students/teams linked to each topic.

== Testing our work ==
By following the below stated process, you can test the implementation that we worked on, which is:
Target 1: Provide the user with the option to select copy/not copy topics linked to an assignment.
Target 2: Provide the user with the option to select copy/not copy students/teams linked to a topic.

Step 1: Visit http://152.46.17.204:8080/ . Enter the credentials; Username: instructor6 , password: password

Step 2: On the top, hover on Manage tab. Click Assignments.

Step 3: Choose an assignment that you want to copy. We would recommend you choosing a robust assignment which has Topics and students/teams associated with topics. OSS Projects generally have these.

If you want to check and see if an assignment has topics or not, click on Edit (pencil icon) on the right.
- If this assignment has topics, you will see a tab named Topics on the right of General tab. If there are no topics, you won't see Topics tab.
- On Clicking the Topics tab, you can see the list of topics. If students/teams are assigned to topics, you will see student names (alias representations, like student1234 student2343) under each Topic name in 'Topic name(s) column'. If you don't see any such, it means that teams/students are not assigned to topics.

Step 4: After you chose the assignment that you want to copy, click on the copy icon on the right of the corresponding assignment.

Where is the copy button located? Check the image below.
[[File: Copy oss.PNG|frame|center]]

Step 5: Clicking the copy button will take you to copy options page, where you can select the options for copying. The page looks like this:
[[File: oss_copy6.PNG|frame|center]]

Step 6: Choose the option you wish to test. Click create. Now the assignment shall be copied with the options you provided.

Step 7: After copying, the application takes you to 'Edit' page for the assignment where you can edit/view the details pertaining to the assignment. Here, you can test our implementation.
In step 6, if you chose to

a) copy without topics: You won't see 'Topics' tab near General tab.

b) copy with topics: You will see 'Topics' tab near General tab. Navigate to Topics tab where you can see and check that the respective topics have been copied. You won't see students under each topic in 'Topic Name(s)' column(If there are topics under Topics tab in original assignment from which you created this copy).

c) copy with topics and students: You will see 'Topics' tab near General tab. Navigate to Topics tab where you can see and check that the respective topics have been copied. You will see students under each topic in 'Topic Name(s)' column(If there are topics and students under Topics tab in original assignment from which you created this copy).

Step 8: This completes the testing. Reiterate from step 2, if you wish to test again.

3) So if we want to copy the topics associated with the assignment we will select the 'YES' button or 'NO' button if we don't want to copy the topics associated with the assignment. if we select the YES Button, then we will have a flash message showing that the assignment was copied successfully and the topics are listed under the topics tab.
[[File: Copy3 oss.PNG|frame|center]]

[[File: Copy4 oss.PNG|frame|center]]

On clicking the topics tab we can see the list of topics under the assignment copied

[[File: Copy5 oss.PNG|frame|center]]

4) In a similar way, we can select the NO button which does not allow the assignment to be copied.

== Resolving Issue 2: ==

1) The issue2 deals with whether the students of the topics should be copied or not. so we have decided to implement the issue1 and issue2 together to optimize and eliminate the redundancy by using the dry principle.

2) so instead of providing just 'YES' or 'NO' we added radio buttons which shows:

O copy without topics

O copy with topics

O copy with topics and teams

[[File: oss_copy6.PNG|frame|center]]

3) we can select one of the options and then we can select the create button according to our desired choice

4) The assignment will be copied successfully according to our choice.

[[File: oss_copy7.PNG|frame|center]]

== Code Modification ==
We have modified 5 files and mainly we have modified code in two classes they are:
assignments_controller.rb under the apps/controllers
assignment_form.rb under the apps/models

We have created a new web page that is triggered on clicking the copy icon for the assignment. The view page is the checktopicscopy.html.erb under the views/assignments folder.

== For the reviewers ==
1) Please log in using the instructor credentials they are username:instructor6 password: password

2) Then select the assignment tab under manage

3) The assignment page opens and then select the copy button of the desired assignment.[NOTE: Before copying see that the assignment already has the topics or not by selecting the edit icon of the assignment]

4) If that particular assignment does not have the topics, choose another assignment which has topics to test our functionality.

5) On clicking the copy icon you will be redirected to the web page which has options, select one of the desired options and select the create button.

5) On clicking the Create button you will be redirected to the edit page of the newly created assignment. In the edit page if the topics tab appears it means that the topics are copied and you can check whether the students under the topics are copied or not.[NOTE: if the topics tab is absent beside the General Tab it indicates that the topics are not copied with assignment]

6) Check the new assignment based on the choice you selected while creating a copy of an assignment.

== Testing ==

we have made changes to the test cases and both the assignment_form.rb in models and also the assignments_controller.rb in controllers have passed all the test cases.

== Our work ==
The code we created can be found below. We have also linked the video of our tests running with coverage to showcase the work we have done.
*[https://github.com/expertiza/expertiza/pull/1524 Pull request]
*[http://152.46.17.204:8080/ Deployed URL]

== Our Recommendation for a separate issue ==

In the current system, we identified an issue and would like to bring it to your notice.

=== Existing System ===

When a user attempts to copy an assignment, the code creates a duplicate ‘assignment’ object, renames it as ‘copy of’ + <name of existing assignment>, saves the object and redirects to the ‘edit’ page where user is supposed to rename the assignment to something meaningful.

=== Issue ===

The current naming scheme as ‘copy of’ + <name of existing assignment> is creating an issue. Say you are creating a copy for some assignment named ‘OSS Project’, the copy object will be named as ‘copy of OSS Project’, saved and redirected to edit page. Had there been an existing assignment names ‘copy of OSS Project’ (which is likely), the copy attempt shall fail, putting a flash message on the screen like:

The assignment was not able to be copied. Please check the original assignment for missing information.

The above error message is in no relevance to the real reason for the error. Even though the save attempt failed, a copy is being inserted into the assignments table in the database.

=== Proposed Recommendation ===

Current naming scheme must be changed to have randomness. The name of the assignment can be given a random string, or a string like ‘copy of ’ + <name of existing assignment> + <5 digit random code>.

The user is anyway supposed to edit the information in the edit page (where the application is redirected after copying is successful). So, here, he can change the name to have some meaningful string.

== Team Information ==
1) Sai Vishnu Muvvala(smuvval)

2) Rohan Pillai(rspillai)

3) Subha Sekhar Reddy Pereddy(speredd)

Mentor : Yashad Trivedi

CSC/ECE 517 Fall 2019 - E1959. Intelligent copying of assignments without topics

2019-10-29T00:33:17Z

Smuvval: /* Testing our work */

== '''Wiki Page Description''' ==
This wiki page describes about the E1959. Intelligent copying of assignments without topics (Issue #1341). We will explain about the issue and also the steps to resolve the issue.

== '''Introduction''' ==

Expertiza is an open source web application project developed using Ruby on Rails framework. Let us list some of the functionalities that Expertiza allows us to do under different roles:

As an Instructor:

We can create new assignments, edit the existing assignments, copy the assignments and also delete the assignment. The instructor can also add participants, reviewers to a particular assignment.

As a Student:

They can form teams to work on various projects and also bid for the projects they would like to work on. They can also review other student's work and can give feedback on them. They can also submit various types of documents including the URLs and wiki pages for their project or assignment submission.

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

===Background:===
When an instructor or a TA logs in to expertiza, he can see a list of assignments under the assignment tab. An instructor or a TA can copy an assignment to use the same event in another course or as another assignment. When the user copies the assignment, the assignment is being copied without providing required flexibility to the users. Majorly, we are focused on implementing two features that shall add flexibility to the copy functionality.

===Issues:===
Issue 1:
While copying an assignment, the user (instructor or TA) is not asked whether (s)he wants to copy the topics along with the assignment or not. Currently, it is copying the topics, without providing any choice for user to not have the topics.

Issue 2:
While copying an assignment, the teams/students assigned to each topic are not getting copied. The user might want to copy the teams/students mapped to the topics as well.

===Steps to generate the issue <Existing system, without our implementation> <Requires Instructor credentials>:===
1) Login to expertiza.ncsu.edu using instructor credentials.

2) Navigate to Assignments section. (How? Hover on Manage Tab -> Click on Assignments)

3) Copy the assignment of your choice by clicking copy icon located on the right side the specific assignment.

Above steps copy the assignment. Remember that this process did not give you the flexibility of choosing whether to copy/not copy

1) Topics linked to assignment

2) Students/teams linked to each topic.

Present system copies the topics and doesn't copy the students, even if you don't want it this way. Our implementation is to provide the user with the functionality to choose copy/not copy topics linked to an assignment and students/teams linked to each topic.

== Testing our work ==
By following the below stated process, you can test the implementation that we worked on, which is:
Target 1: Provide the user with the option to select copy/not copy topics linked to an assignment.
Target 2: Provide the user with the option to select copy/not copy students/teams linked to a topic.

Step 1: Visit http://152.46.17.204:8080/ . Enter the credentials; Username: instructor6 , password: password

Step 2: On the top, hover on Manage tab. Click Assignments.

Step 3: Choose an assignment that you want to copy. We would recommend you choosing a robust assignment which has Topics and students/teams associated with topics. OSS Projects generally have these.

If you want to check and see if an assignment has topics or not, click on Edit (pencil icon) on the right.
- If this assignment has topics, you will see a tab named Topics on the right of General tab. If there are no topics, you won't see Topics tab.
- On Clicking the Topics tab, you can see the list of topics. If students/teams are assigned to topics, you will see student names (alias representations, like student1234 student2343) under each Topic name in 'Topic name(s) column'. If you don't see any such, it means that teams/students are not assigned to topics.

Step 4: After you chose the assignment that you want to copy, click on the copy icon on the right of the corresponding assignment.

Where is the copy button located? Check the image below.
[[File: Copy oss.PNG|frame|center]]

Step 5: Clicking the copy button will take you to copy options page, where you can select the options for copying. The page looks like this:
[[File: oss_copy6.PNG|frame|center]]

Step 6: Choose the option you wish to test. Click create. Now the assignment shall be copied with the options you provided.

Step 7: After copying, the application takes you to 'Edit' page for the assignment where you can edit/view the details pertaining to the assignment. Here, you can test our implementation.
In step 6, if you chose to

a) copy without topics: You won't see 'Topics' tab near General tab.

b) copy with topics: You will see 'Topics' tab near General tab. Navigate to Topics tab where you can see and check that the respective topics have been copied. You won't see students under each topic in 'Topic Name(s)' column(If there are topics under Topics tab in original assignment from which you created this copy).

c) copy with topics and students: You will see 'Topics' tab near General tab. Navigate to Topics tab where you can see and check that the respective topics have been copied. You will see students under each topic in 'Topic Name(s)' column(If there are topics and students under Topics tab in original assignment from which you created this copy).

Step 8: This completes the testing. Reiterate from step 2, if you wish to test again.

3) So if we want to copy the topics associated with the assignment we will select the 'YES' button or 'NO' button if we don't want to copy the topics associated with the assignment. if we select the YES Button, then we will have a flash message showing that the assignment was copied successfully and the topics are listed under the topics tab.
[[File: Copy3 oss.PNG|frame|center]]

[[File: Copy4 oss.PNG|frame|center]]

On clicking the topics tab we can see the list of topics under the assignment copied

[[File: Copy5 oss.PNG|frame|center]]

4) In a similar way, we can select the NO button which does not allow the assignment to be copied.

== Resolving Issue 2: ==

1) The issue2 deals with whether the students of the topics should be copied or not. so we have decided to implement the issue1 and issue2 together to optimize and eliminate the redundancy by using the dry principle.

2) so instead of providing just 'YES' or 'NO' we added radio buttons which shows:

O copy without topics

O copy with topics

O copy with topics and teams

[[File: oss_copy6.PNG|frame|center]]

3) we can select one of the options and then we can select the create button according to our desired choice

4) The assignment will be copied successfully according to our choice.

[[File: oss_copy7.PNG|frame|center]]

== Code Modification ==
We have modified 5 files and mainly we have modified code in two classes they are:
assignments_controller.rb under the apps/controllers
assignment_form.rb under the apps/models

We have created a new web page that is triggered on clicking the copy icon for the assignment. The view page is the checktopicscopy.html.erb under the views/assignments folder.

== For the reviewers ==
1) Please log in using the instructor credentials they are username:instructor6 password: password

2) Then select the assignment tab under manage

3) The assignment page opens and then select the copy button of the desired assignment.[NOTE: Before copying see that the assignment already has the topics or not by selecting the edit icon of the assignment]

4) If that particular assignment does not have the topics, choose another assignment which has topics to test our functionality.

5) On clicking the copy icon you will be redirected to the web page which has options, select one of the desired options and select the create button.

5) On clicking the Create button you will be redirected to the edit page of the newly created assignment. In the edit page if the topics tab appears it means that the topics are copied and you can check whether the students under the topics are copied or not.[NOTE: if the topics tab is absent beside the General Tab it indicates that the topics are not copied with assignment]

6) Check the new assignment based on the choice you selected while creating a copy of an assignment.

== Testing ==

we have made changes to the test cases and both the assignment_form.rb in models and also the assignments_controller.rb in controllers have passed all the test cases.

== Our work ==
The code we created can be found below. We have also linked the video of our tests running with coverage to showcase the work we have done.
*[https://github.com/expertiza/expertiza/pull/1524 Pull request]
*[http://152.46.17.204:8080/ Deployed URL]

== Our Recommendation for a separate issue ==

In the current system, we identified an issue and would like to bring it to your notice.

=== Existing System ===

When a user attempts to copy an assignment, the code creates a duplicate ‘assignment’ object, renames it as ‘copy of’ + <name of existing assignment>, saves the object and redirects to the ‘edit’ page where user is supposed to rename the assignment to something meaningful.

=== Issue ===

The current naming scheme as ‘copy of’ + <name of existing assignment> is creating an issue. Say you are creating a copy for some assignment named ‘OSS Project’, the copy object will be named as ‘copy of OSS Project’, saved and redirected to edit page. Had there been an existing assignment names ‘copy of OSS Project’ (which is likely), the copy attempt shall fail, putting a flash message on the screen like:

The assignment was not able to be copied. Please check the original assignment for missing information.

The above error message is in no relevance to the real reason for the error. Even though the save attempt failed, a copy is being inserted into the assignments table in the database.

=== Proposed Recommendation ===

Current naming scheme must be changed to have randomness. The name of the assignment can be given a random string, or a string like ‘copy of ’ + <name of existing assignment> + <5 digit random code>.

The user is anyway supposed to edit the information in the edit page (where the application is redirected after copying is successful). So, here, he can change the name to have some meaningful string.

== Team Information ==
1) Sai Vishnu Muvvala(smuvval)

2) Rohan Pillai(rspillai)

3) Subha Sekhar Reddy Pereddy(speredd)

Mentor : Yashad Trivedi

CSC/ECE 517 Fall 2019 - E1959. Intelligent copying of assignments without topics

2019-10-29T00:31:15Z

Smuvval: /* Resolving Issue 1: */

== '''Wiki Page Description''' ==
This wiki page describes about the E1959. Intelligent copying of assignments without topics (Issue #1341). We will explain about the issue and also the steps to resolve the issue.

== '''Introduction''' ==

Expertiza is an open source web application project developed using Ruby on Rails framework. Let us list some of the functionalities that Expertiza allows us to do under different roles:

As an Instructor:

We can create new assignments, edit the existing assignments, copy the assignments and also delete the assignment. The instructor can also add participants, reviewers to a particular assignment.

As a Student:

They can form teams to work on various projects and also bid for the projects they would like to work on. They can also review other student's work and can give feedback on them. They can also submit various types of documents including the URLs and wiki pages for their project or assignment submission.

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

===Background:===
When an instructor or a TA logs in to expertiza, he can see a list of assignments under the assignment tab. An instructor or a TA can copy an assignment to use the same event in another course or as another assignment. When the user copies the assignment, the assignment is being copied without providing required flexibility to the users. Majorly, we are focused on implementing two features that shall add flexibility to the copy functionality.

===Issues:===
Issue 1:
While copying an assignment, the user (instructor or TA) is not asked whether (s)he wants to copy the topics along with the assignment or not. Currently, it is copying the topics, without providing any choice for user to not have the topics.

Issue 2:
While copying an assignment, the teams/students assigned to each topic are not getting copied. The user might want to copy the teams/students mapped to the topics as well.

===Steps to generate the issue <Existing system, without our implementation> <Requires Instructor credentials>:===
1) Login to expertiza.ncsu.edu using instructor credentials.

2) Navigate to Assignments section. (How? Hover on Manage Tab -> Click on Assignments)

3) Copy the assignment of your choice by clicking copy icon located on the right side the specific assignment.

Above steps copy the assignment. Remember that this process did not give you the flexibility of choosing whether to copy/not copy

1) Topics linked to assignment

2) Students/teams linked to each topic.

Present system copies the topics and doesn't copy the students, even if you don't want it this way. Our implementation is to provide the user with the functionality to choose copy/not copy topics linked to an assignment and students/teams linked to each topic.

== Testing our work ==
By following the below stated process, you can test the implementation that we worked on, which is:
Target 1: Provide the user with the option to select copy/not copy topics linked to an assignment.
Target 2: Provide the user with the option to select copy/not copy students/teams linked to a topic.

Step 1: Visit http://152.46.17.204:8080/ . Enter the credentials; Username: instructor6 , password: password

Step 2: On the top, hover on Manage tab. Click Assignments.

Step 3: Choose an assignment that you want to copy. We would recommend you choosing a robust assignment which has Topics and students/teams associated with topics. OSS Projects generally have these.

If you want to check and see if an assignment has topics or not, click on Edit (pencil icon) on the right.
- If this assignment has topics, you will see a tab named Topics on the right of General tab. If there are no topics, you won't see Topics tab.
- On Clicking the Topics tab, you can see the list of topics. If students/teams are assigned to topics, you will see student names (alias representations, like student1234 student2343) under each Topic name in 'Topic name(s) column'. If you don't see any such, it means that teams/students are not assigned to topics.

Step 4: After you chose the assignment that you want to copy, click on the copy icon on the right of the corresponding assignment.

Where is the copy button located? Check the image below.
[[File: Copy oss.PNG|frame|center]]

Step 5: Clicking the copy button will take you to copy options page, where you can select the options for copying. The page looks like this:
[[File: Copy2 oss.PNG|frame|center]]

Step 6: Choose the option you wish to test. Click create. Now the assignment shall be copied with the options you provided.

Step 7: After copying, the application takes you to 'Edit' page for the assignment where you can edit/view the details pertaining to the assignment. Here, you can test our implementation.
In step 6, if you chose to

a) copy without topics: You won't see 'Topics' tab near General tab.

b) copy with topics: You will see 'Topics' tab near General tab. Navigate to Topics tab where you can see and check that the respective topics have been copied. You won't see students under each topic in 'Topic Name(s)' column(If there are topics under Topics tab in original assignment from which you created this copy).

c) copy with topics and students: You will see 'Topics' tab near General tab. Navigate to Topics tab where you can see and check that the respective topics have been copied. You will see students under each topic in 'Topic Name(s)' column(If there are topics and students under Topics tab in original assignment from which you created this copy).

Step 8: This completes the testing. Reiterate from step 2, if you wish to test again.

3) So if we want to copy the topics associated with the assignment we will select the 'YES' button or 'NO' button if we don't want to copy the topics associated with the assignment. if we select the YES Button, then we will have a flash message showing that the assignment was copied successfully and the topics are listed under the topics tab.
[[File: Copy3 oss.PNG|frame|center]]

[[File: Copy4 oss.PNG|frame|center]]

On clicking the topics tab we can see the list of topics under the assignment copied

[[File: Copy5 oss.PNG|frame|center]]

4) In a similar way, we can select the NO button which does not allow the assignment to be copied.

== Resolving Issue 2: ==

1) The issue2 deals with whether the students of the topics should be copied or not. so we have decided to implement the issue1 and issue2 together to optimize and eliminate the redundancy by using the dry principle.

2) so instead of providing just 'YES' or 'NO' we added radio buttons which shows:

O copy without topics

O copy with topics

O copy with topics and teams

[[File: oss_copy6.PNG|frame|center]]

3) we can select one of the options and then we can select the create button according to our desired choice

4) The assignment will be copied successfully according to our choice.

[[File: oss_copy7.PNG|frame|center]]

== Code Modification ==
We have modified 5 files and mainly we have modified code in two classes they are:
assignments_controller.rb under the apps/controllers
assignment_form.rb under the apps/models

We have created a new web page that is triggered on clicking the copy icon for the assignment. The view page is the checktopicscopy.html.erb under the views/assignments folder.

== For the reviewers ==
1) Please log in using the instructor credentials they are username:instructor6 password: password

2) Then select the assignment tab under manage

3) The assignment page opens and then select the copy button of the desired assignment.[NOTE: Before copying see that the assignment already has the topics or not by selecting the edit icon of the assignment]

4) If that particular assignment does not have the topics, choose another assignment which has topics to test our functionality.

5) On clicking the copy icon you will be redirected to the web page which has options, select one of the desired options and select the create button.

5) On clicking the Create button you will be redirected to the edit page of the newly created assignment. In the edit page if the topics tab appears it means that the topics are copied and you can check whether the students under the topics are copied or not.[NOTE: if the topics tab is absent beside the General Tab it indicates that the topics are not copied with assignment]

6) Check the new assignment based on the choice you selected while creating a copy of an assignment.

== Testing ==

we have made changes to the test cases and both the assignment_form.rb in models and also the assignments_controller.rb in controllers have passed all the test cases.

== Our work ==
The code we created can be found below. We have also linked the video of our tests running with coverage to showcase the work we have done.
*[https://github.com/expertiza/expertiza/pull/1524 Pull request]
*[http://152.46.17.204:8080/ Deployed URL]

== Our Recommendation for a separate issue ==

In the current system, we identified an issue and would like to bring it to your notice.

=== Existing System ===

When a user attempts to copy an assignment, the code creates a duplicate ‘assignment’ object, renames it as ‘copy of’ + <name of existing assignment>, saves the object and redirects to the ‘edit’ page where user is supposed to rename the assignment to something meaningful.

=== Issue ===

The current naming scheme as ‘copy of’ + <name of existing assignment> is creating an issue. Say you are creating a copy for some assignment named ‘OSS Project’, the copy object will be named as ‘copy of OSS Project’, saved and redirected to edit page. Had there been an existing assignment names ‘copy of OSS Project’ (which is likely), the copy attempt shall fail, putting a flash message on the screen like:

The assignment was not able to be copied. Please check the original assignment for missing information.

The above error message is in no relevance to the real reason for the error. Even though the save attempt failed, a copy is being inserted into the assignments table in the database.

=== Proposed Recommendation ===

Current naming scheme must be changed to have randomness. The name of the assignment can be given a random string, or a string like ‘copy of ’ + <name of existing assignment> + <5 digit random code>.

The user is anyway supposed to edit the information in the edit page (where the application is redirected after copying is successful). So, here, he can change the name to have some meaningful string.

== Team Information ==
1) Sai Vishnu Muvvala(smuvval)

2) Rohan Pillai(rspillai)

3) Subha Sekhar Reddy Pereddy(speredd)

Mentor : Yashad Trivedi

CSC/ECE 517 Fall 2019 - E1959. Intelligent copying of assignments without topics

2019-10-28T23:53:35Z

Smuvval: /* Resolving Issue 1: */

== '''Wiki Page Description''' ==
This wiki page describes about the E1959. Intelligent copying of assignments without topics (Issue #1341). We will explain about the issue and also the steps to resolve the issue.

== '''Introduction''' ==

Expertiza is an open source web application project developed using Ruby on Rails framework. Let us list some of the functionalities that Expertiza allows us to do under different roles:

As an Instructor:

We can create new assignments, edit the existing assignments, copy the assignments and also delete the assignment. The instructor can also add participants, reviewers to a particular assignment.

As a Student:

They can form teams to work on various projects and also bid for the projects they would like to work on. They can also review other student's work and can give feedback on them. They can also submit various types of documents including the URLs and wiki pages for their project or assignment submission.

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

===Background:===
When an instructor or a TA logs in to expertiza, he can see a list of assignments under the assignment tab. An instructor or a TA can copy an assignment to use the same event in another course or as another assignment. When the user copies the assignment, the assignment is being copied without providing required flexibility to the users. Majorly, we are focused on implementing two features that shall add flexibility to the copy functionality.

===Issues:===
Issue 1:
While copying an assignment, the user (instructor or TA) is not asked whether (s)he wants to copy the topics along with the assignment or not. Currently, it is copying the topics, without providing any choice for user to not have the topics.

Issue 2:
While copying an assignment, the teams/students assigned to each topic are not getting copied. The user might want to copy the teams/students mapped to the topics as well.

===Steps to generate the issue <Existing system, without our implementation> <Requires Instructor credentials>:===
1) Login to expertiza.ncsu.edu using instructor credentials.

2) Navigate to Assignments section. (How? Hover on Manage Tab -> Click on Assignments)

3) Copy the assignment of your choice by clicking copy icon located on the right side the specific assignment.

Above steps copy the assignment. Remember that this process did not give you the flexibility of choosing whether to copy/not copy

1) Topics linked to assignment

2) Students/teams linked to each topic.

Present system copies the topics and doesn't copy the students, even if you don't want it this way. Our implementation is to provide the user with the functionality to choose copy/not copy topics linked to an assignment and students/teams linked to each topic.

== Resolving Issue 1: ==
Provide the user with the option to select copy/not copy topics linked to an assignment.

1) To resolve the issue, on clicking the copy button, we will redirect the user (instructor or TA) to a new web page.
Where is the copy button located? Check the image below.
[[File: Copy oss.PNG|frame|center]]

2) On clicking the copy icon we will redirect to a new webpage which looks like:
[[File: Copy2 oss.PNG|frame|center]]

3) So if we want to copy the topics associated with the assignment we will select the 'YES' button or 'NO' button if we don't want to copy the topics associated with the assignment. if we select the YES Button, then we will have a flash message showing that the assignment was copied successfully and the topics are listed under the topics tab.
[[File: Copy3 oss.PNG|frame|center]]

[[File: Copy4 oss.PNG|frame|center]]

On clicking the topics tab we can see the list of topics under the assignment copied

[[File: Copy5 oss.PNG|frame|center]]

4) In a similar way, we can select the NO button which does not allow the assignment to be copied.

== Resolving Issue 2: ==

1) The issue2 deals with whether the students of the topics should be copied or not. so we have decided to implement the issue1 and issue2 together to optimize and eliminate the redundancy by using the dry principle.

2) so instead of providing just 'YES' or 'NO' we added radio buttons which shows:

O copy without topics

O copy with topics

O copy with topics and teams

[[File: oss_copy6.PNG|frame|center]]

3) we can select one of the options and then we can select the create button according to our desired choice

4) The assignment will be copied successfully according to our choice.

[[File: oss_copy7.PNG|frame|center]]

== Code Modification ==
We have modified 5 files and mainly we have modified code in two classes they are:
assignments_controller.rb under the apps/controllers
assignment_form.rb under the apps/models

We have created a new web page that is triggered on clicking the copy icon for the assignment. The view page is the checktopicscopy.html.erb under the views/assignments folder.

== For the reviewers ==
1) Please log in using the instructor credentials they are username:instructor6 password: password

2) Then select the assignment tab under manage

3) The assignment page opens and then select the copy button of the desired assignment.[NOTE: Before copying see that the assignment already has the topics or not by selecting the edit icon of the assignment]

4) If that particular assignment does not have the topics, choose another assignment which has topics to test our functionality.

5) On clicking the copy icon you will be redirected to the web page which has options, select one of the desired options and select the create button.

5) On clicking the Create button you will be redirected to the edit page of the newly created assignment. In the edit page if the topics tab appears it means that the topics are copied and you can check whether the students under the topics are copied or not.[NOTE: if the topics tab is absent beside the General Tab it indicates that the topics are not copied with assignment]

6) Check the new assignment based on the choice you selected while creating a copy of an assignment.

== Testing ==

we have made changes to the test cases and both the assignment_form.rb in models and also the assignments_controller.rb in controllers have passed all the test cases.

== Our work ==
The code we created can be found below. We have also linked the video of our tests running with coverage to showcase the work we have done.
*[https://github.com/expertiza/expertiza/pull/1524 Pull request]
*[http://152.46.17.204:8080/ Deployed URL]

== Our Recommendation for a separate issue ==

In the current system, we identified an issue and would like to bring it to your notice.

=== Existing System ===

When a user attempts to copy an assignment, the code creates a duplicate ‘assignment’ object, renames it as ‘copy of’ + <name of existing assignment>, saves the object and redirects to the ‘edit’ page where user is supposed to rename the assignment to something meaningful.

=== Issue ===

The current naming scheme as ‘copy of’ + <name of existing assignment> is creating an issue. Say you are creating a copy for some assignment named ‘OSS Project’, the copy object will be named as ‘copy of OSS Project’, saved and redirected to edit page. Had there been an existing assignment names ‘copy of OSS Project’ (which is likely), the copy attempt shall fail, putting a flash message on the screen like:

The assignment was not able to be copied. Please check the original assignment for missing information.

The above error message is in no relevance to the real reason for the error. Even though the save attempt failed, a copy is being inserted into the assignments table in the database.

=== Proposed Recommendation ===

Current naming scheme must be changed to have randomness. The name of the assignment can be given a random string, or a string like ‘copy of ’ + <name of existing assignment> + <5 digit random code>.

The user is anyway supposed to edit the information in the edit page (where the application is redirected after copying is successful). So, here, he can change the name to have some meaningful string.

== Team Information ==
1) Sai Vishnu Muvvala(smuvval)

2) Rohan Pillai(rspillai)

3) Subha Sekhar Reddy Pereddy(speredd)

Mentor : Yashad Trivedi

CSC/ECE 517 Fall 2019 - E1959. Intelligent copying of assignments without topics

2019-10-28T23:50:08Z

Smuvval: /* Steps to generate the issues: */

== '''Wiki Page Description''' ==
This wiki page describes about the E1959. Intelligent copying of assignments without topics (Issue #1341). We will explain about the issue and also the steps to resolve the issue.

== '''Introduction''' ==

Expertiza is an open source web application project developed using Ruby on Rails framework. Let us list some of the functionalities that Expertiza allows us to do under different roles:

As an Instructor:

We can create new assignments, edit the existing assignments, copy the assignments and also delete the assignment. The instructor can also add participants, reviewers to a particular assignment.

As a Student:

They can form teams to work on various projects and also bid for the projects they would like to work on. They can also review other student's work and can give feedback on them. They can also submit various types of documents including the URLs and wiki pages for their project or assignment submission.

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

===Background:===
When an instructor or a TA logs in to expertiza, he can see a list of assignments under the assignment tab. An instructor or a TA can copy an assignment to use the same event in another course or as another assignment. When the user copies the assignment, the assignment is being copied without providing required flexibility to the users. Majorly, we are focused on implementing two features that shall add flexibility to the copy functionality.

===Issues:===
Issue 1:
While copying an assignment, the user (instructor or TA) is not asked whether (s)he wants to copy the topics along with the assignment or not. Currently, it is copying the topics, without providing any choice for user to not have the topics.

Issue 2:
While copying an assignment, the teams/students assigned to each topic are not getting copied. The user might want to copy the teams/students mapped to the topics as well.

===Steps to generate the issue <Existing system, without our implementation> <Requires Instructor credentials>:===
1) Login to expertiza.ncsu.edu using instructor credentials.

2) Navigate to Assignments section. (How? Hover on Manage Tab -> Click on Assignments)

3) Copy the assignment of your choice by clicking copy icon located on the right side the specific assignment.

Above steps copy the assignment. Remember that this process did not give you the flexibility of choosing whether to copy/not copy

1) Topics linked to assignment

2) Students/teams linked to each topic.

Present system copies the topics and doesn't copy the students, even if you don't want it this way. Our implementation is to provide the user with the functionality to choose copy/not copy topics linked to an assignment and students/teams linked to each topic.

== Resolving Issue 1: ==

1) To resolve the issue we will redirect the user (instructor or TA) to a new web page on clicking the copy icon which is present on the right side of each project.
[[File: Copy oss.PNG|frame|center]]

2) On clicking the copy icon we will redirect to a new webpage which looks like:
[[File: Copy2 oss.PNG|frame|center]]

3) So if we want to copy the topics associated with the assignment we will select the 'YES' button or 'NO' button if we don't want to copy the topics associated with the assignment. if we select the YES Button, then we will have a flash message showing that the assignment was copied successfully and the topics are listed under the topics tab.
[[File: Copy3 oss.PNG|frame|center]]

[[File: Copy4 oss.PNG|frame|center]]

On clicking the topics tab we can see the list of topics under the assignment copied

[[File: Copy5 oss.PNG|frame|center]]

4) In a similar way, we can select the NO button which does not allow the assignment to be copied.

== Resolving Issue 2: ==

1) The issue2 deals with whether the students of the topics should be copied or not. so we have decided to implement the issue1 and issue2 together to optimize and eliminate the redundancy by using the dry principle.

2) so instead of providing just 'YES' or 'NO' we added radio buttons which shows:

O copy without topics

O copy with topics

O copy with topics and teams

[[File: oss_copy6.PNG|frame|center]]

3) we can select one of the options and then we can select the create button according to our desired choice

4) The assignment will be copied successfully according to our choice.

[[File: oss_copy7.PNG|frame|center]]

== Code Modification ==
We have modified 5 files and mainly we have modified code in two classes they are:
assignments_controller.rb under the apps/controllers
assignment_form.rb under the apps/models

We have created a new web page that is triggered on clicking the copy icon for the assignment. The view page is the checktopicscopy.html.erb under the views/assignments folder.

== For the reviewers ==
1) Please log in using the instructor credentials they are username:instructor6 password: password

2) Then select the assignment tab under manage

3) The assignment page opens and then select the copy button of the desired assignment.[NOTE: Before copying see that the assignment already has the topics or not by selecting the edit icon of the assignment]

4) If that particular assignment does not have the topics, choose another assignment which has topics to test our functionality.

5) On clicking the copy icon you will be redirected to the web page which has options, select one of the desired options and select the create button.

5) On clicking the Create button you will be redirected to the edit page of the newly created assignment. In the edit page if the topics tab appears it means that the topics are copied and you can check whether the students under the topics are copied or not.[NOTE: if the topics tab is absent beside the General Tab it indicates that the topics are not copied with assignment]

6) Check the new assignment based on the choice you selected while creating a copy of an assignment.

== Testing ==

we have made changes to the test cases and both the assignment_form.rb in models and also the assignments_controller.rb in controllers have passed all the test cases.

== Our work ==
The code we created can be found below. We have also linked the video of our tests running with coverage to showcase the work we have done.
*[https://github.com/expertiza/expertiza/pull/1524 Pull request]
*[http://152.46.17.204:8080/ Deployed URL]

== Our Recommendation for a separate issue ==

In the current system, we identified an issue and would like to bring it to your notice.

=== Existing System ===

When a user attempts to copy an assignment, the code creates a duplicate ‘assignment’ object, renames it as ‘copy of’ + <name of existing assignment>, saves the object and redirects to the ‘edit’ page where user is supposed to rename the assignment to something meaningful.

=== Issue ===

The current naming scheme as ‘copy of’ + <name of existing assignment> is creating an issue. Say you are creating a copy for some assignment named ‘OSS Project’, the copy object will be named as ‘copy of OSS Project’, saved and redirected to edit page. Had there been an existing assignment names ‘copy of OSS Project’ (which is likely), the copy attempt shall fail, putting a flash message on the screen like:

The assignment was not able to be copied. Please check the original assignment for missing information.

The above error message is in no relevance to the real reason for the error. Even though the save attempt failed, a copy is being inserted into the assignments table in the database.

=== Proposed Recommendation ===

Current naming scheme must be changed to have randomness. The name of the assignment can be given a random string, or a string like ‘copy of ’ + <name of existing assignment> + <5 digit random code>.

The user is anyway supposed to edit the information in the edit page (where the application is redirected after copying is successful). So, here, he can change the name to have some meaningful string.

== Team Information ==
1) Sai Vishnu Muvvala(smuvval)

2) Rohan Pillai(rspillai)

3) Subha Sekhar Reddy Pereddy(speredd)

Mentor : Yashad Trivedi

CSC/ECE 517 Fall 2019 - E1959. Intelligent copying of assignments without topics

2019-10-28T23:38:53Z

Smuvval: /* Issues: */

== '''Wiki Page Description''' ==
This wiki page describes about the E1959. Intelligent copying of assignments without topics (Issue #1341). We will explain about the issue and also the steps to resolve the issue.

== '''Introduction''' ==

Expertiza is an open source web application project developed using Ruby on Rails framework. Let us list some of the functionalities that Expertiza allows us to do under different roles:

As an Instructor:

We can create new assignments, edit the existing assignments, copy the assignments and also delete the assignment. The instructor can also add participants, reviewers to a particular assignment.

As a Student:

They can form teams to work on various projects and also bid for the projects they would like to work on. They can also review other student's work and can give feedback on them. They can also submit various types of documents including the URLs and wiki pages for their project or assignment submission.

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

===Background:===
When an instructor or a TA logs in to expertiza, he can see a list of assignments under the assignment tab. An instructor or a TA can copy an assignment to use the same event in another course or as another assignment. When the user copies the assignment, the assignment is being copied without providing required flexibility to the users. Majorly, we are focused on implementing two features that shall add flexibility to the copy functionality.

===Issues:===
Issue 1:
While copying an assignment, the user (instructor or TA) is not asked whether (s)he wants to copy the topics along with the assignment or not. Currently, it is copying the topics, without providing any choice for user to not have the topics.

Issue 2:
While copying an assignment, the teams/students assigned to each topic are not getting copied. The user might want to copy the teams/students mapped to the topics as well.

===Steps to generate the issues:===
1) Login as an instructor using the credentials username:instructor6 password: password

2) You will be redirected to the home page of the expertiza, Hover your cursor over the manage tab and select the assignment tab.

3) It will be redirected to the assignment page so on clicking the copy icon to the right of each assignment it will create a new assignment along with the topics and students under the topic are not copied.

== Resolving Issue 1: ==

1) To resolve the issue we will redirect the user (instructor or TA) to a new web page on clicking the copy icon which is present on the right side of each project.
[[File: Copy oss.PNG|frame|center]]

2) On clicking the copy icon we will redirect to a new webpage which looks like:
[[File: Copy2 oss.PNG|frame|center]]

3) So if we want to copy the topics associated with the assignment we will select the 'YES' button or 'NO' button if we don't want to copy the topics associated with the assignment. if we select the YES Button, then we will have a flash message showing that the assignment was copied successfully and the topics are listed under the topics tab.
[[File: Copy3 oss.PNG|frame|center]]

[[File: Copy4 oss.PNG|frame|center]]

On clicking the topics tab we can see the list of topics under the assignment copied

[[File: Copy5 oss.PNG|frame|center]]

4) In a similar way, we can select the NO button which does not allow the assignment to be copied.

== Resolving Issue 2: ==

1) The issue2 deals with whether the students of the topics should be copied or not. so we have decided to implement the issue1 and issue2 together to optimize and eliminate the redundancy by using the dry principle.

2) so instead of providing just 'YES' or 'NO' we added radio buttons which shows:

O copy without topics

O copy with topics

O copy with topics and teams

[[File: oss_copy6.PNG|frame|center]]

3) we can select one of the options and then we can select the create button according to our desired choice

4) The assignment will be copied successfully according to our choice.

[[File: oss_copy7.PNG|frame|center]]

== Code modification ==
we have modified 5 files and mainly we have modified code in two classes they are:
assignments_controller.rb under the apps/controllers
assignment_form.rb under the apps/models

we have created a new web page that is triggered on clicking the copy icon for the assignment. The view page is the checktopicscopy.html.erb under the views/assignments folder.

== For the reviewers ==
1) Please log in using the instructor credentials they are username:instructor6 password: password

2) Then select the assignment tab under manage

3) The assignment page opens and then select the copy button of the desired assignment.[NOTE: Before copying see that the assignment already has the topics or not by selecting the edit icon of the assignment]

4) If that particular assignment does not have the topics, choose another assignment which has topics to test our functionality.

5) On clicking the copy icon you will be redirected to the web page which has options, select one of the desired options and select the create button.

5) On clicking the Create button you will be redirected to the edit page of the newly created assignment. In the edit page if the topics tab appears it means that the topics are copied and you can check whether the students under the topics are copied or not.[NOTE: if the topics tab is absent beside the General Tab it indicates that the topics are not copied with assignment]

6) Check the new assignment based on the choice you selected while creating a copy of an assignment.

== Testing ==

we have made changes to the test cases and both the assignment_form.rb in models and also the assignments_controller.rb in controllers have passed all the test cases.

== Our work ==
The code we created can be found below. We have also linked the video of our tests running with coverage to showcase the work we have done.
*[https://github.com/expertiza/expertiza/pull/1524 Pull request]
*[https://github.com/expertiza/expertiza/pull/1524 Deployed URL]

== Our Recommendation for a separate issue ==

In the current system, we identified an issue and would like to bring it to your notice.

=== Existing System ===

When a user attempts to copy an assignment, the code creates a duplicate ‘assignment’ object, renames it as ‘copy of’ + <name of existing assignment>, saves the object and redirects to the ‘edit’ page where user is supposed to rename the assignment to something meaningful.

=== Issue ===

The current naming scheme as ‘copy of’ + <name of existing assignment> is creating an issue. Say you are creating a copy for some assignment named ‘OSS Project’, the copy object will be named as ‘copy of OSS Project’, saved and redirected to edit page. Had there been an existing assignment names ‘copy of OSS Project’ (which is likely), the copy attempt shall fail, putting a flash message on the screen like:

The assignment was not able to be copied. Please check the original assignment for missing information.

The above error message is in no relevance to the real reason for the error. Even though the save attempt failed, a copy is being inserted into the assignments table in the database.

=== Proposed Recommendation ===

Current naming scheme must be changed to have randomness. The name of the assignment can be given a random string, or a string like ‘copy of ’ + <name of existing assignment> + <5 digit random code>.

The user is anyway supposed to edit the information in the edit page (where the application is redirected after copying is successful). So, here, he can change the name to have some meaningful string.

== Team Information ==
1) Sai Vishnu Muvvala(smuvval)

2) Rohan Pillai(rspillai)

3) Subha Sekhar Reddy Pereddy(speredd)

Mentor : Yashad Trivedi

CSC/ECE 517 Fall 2019 - E1959. Intelligent copying of assignments without topics

2019-10-28T23:35:42Z

Smuvval: /* Background: */

== '''Wiki page Description''' ==
This wiki page describes about the E1959. Intelligent copying of assignments without topics (Issue #1341). we will explain about the issue and also the steps to resolve the issue.

== '''Introduction''' ==

Expertiza is an open source web application project developed using Ruby on Rails framework. Let us list some of the functionalities that Expertiza allows us to do under different roles

As an Instructor:

we can create new assignments, edit the existing assignments, copy the assignments and also delete the assignment. The instruct can also add participants, reviewers to a particular assignment.

As a Student:

They can form teams to work on various projects and also bid for the projects they would like to work on. They can also review other student's work and can give feedback on them. They can also submit various types of documents including the URLs and wiki pages for their project or assignment submission.

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

===Background:===
When an instructor or a TA logs in to expertiza, he can see a list of assignments under the assignment tab. An instructor or a TA can copy an assignment to use the same event in another course or as another assignment. When the user copies the assignment, the assignment is being copied without providing required flexibility to the users. Majorly, we are focused on implementing two features that shall add flexibility to the copy functionality.

===Issues:===
Issue 1:
While copying an assignment, the user (instructor or TA) is not asked whether (s)he wants to copy the topics along with the assignment or not.

Issue 2:
While copying an assignment the students are not copied for a particular topic so the user (instructor or TA) is not asked whether he wants to copy the topics with the associated students or not.

===Steps to generate the issues:===
1) Login as an instructor using the credentials username:instructor6 password: password

2) You will be redirected to the home page of the expertiza, Hover your cursor over the manage tab and select the assignment tab.

3) It will be redirected to the assignment page so on clicking the copy icon to the right of each assignment it will create a new assignment along with the topics and students under the topic are not copied.

== Resolving Issue 1: ==

1) To resolve the issue we will redirect the user (instructor or TA) to a new web page on clicking the copy icon which is present on the right side of each project.
[[File: Copy oss.PNG|frame|center]]

2) On clicking the copy icon we will redirect to a new webpage which looks like:
[[File: Copy2 oss.PNG|frame|center]]

3) So if we want to copy the topics associated with the assignment we will select the 'YES' button or 'NO' button if we don't want to copy the topics associated with the assignment. if we select the YES Button, then we will have a flash message showing that the assignment was copied successfully and the topics are listed under the topics tab.
[[File: Copy3 oss.PNG|frame|center]]

[[File: Copy4 oss.PNG|frame|center]]

On clicking the topics tab we can see the list of topics under the assignment copied

[[File: Copy5 oss.PNG|frame|center]]

4) In a similar way, we can select the NO button which does not allow the assignment to be copied.

== Resolving Issue 2: ==

1) The issue2 deals with whether the students of the topics should be copied or not. so we have decided to implement the issue1 and issue2 together to optimize and eliminate the redundancy by using the dry principle.

2) so instead of providing just 'YES' or 'NO' we added radio buttons which shows:

O copy without topics

O copy with topics

O copy with topics and teams

[[File: oss_copy6.PNG|frame|center]]

3) we can select one of the options and then we can select the create button according to our desired choice

4) The assignment will be copied successfully according to our choice.

[[File: oss_copy7.PNG|frame|center]]

== Code modification ==
we have modified 5 files and mainly we have modified code in two classes they are:
assignments_controller.rb under the apps/controllers
assignment_form.rb under the apps/models

we have created a new web page that is triggered on clicking the copy icon for the assignment. The view page is the checktopicscopy.html.erb under the views/assignments folder.

== For the reviewers ==
1) Please log in using the instructor credentials they are username:instructor6 password: password

2) Then select the assignment tab under manage

3) The assignment page opens and then select the copy button of the desired assignment.[NOTE: Before copying see that the assignment already has the topics or not by selecting the edit icon of the assignment]

4) If that particular assignment does not have the topics, choose another assignment which has topics to test our functionality.

5) On clicking the copy icon you will be redirected to the web page which has options, select one of the desired options and select the create button.

5) On clicking the Create button you will be redirected to the edit page of the newly created assignment. In the edit page if the topics tab appears it means that the topics are copied and you can check whether the students under the topics are copied or not.[NOTE: if the topics tab is absent beside the General Tab it indicates that the topics are not copied with assignment]

6) Check the new assignment based on the choice you selected while creating a copy of an assignment.

== Testing ==

we have made changes to the test cases and both the assignment_form.rb in models and also the assignments_controller.rb in controllers have passed all the test cases.

== Our work ==
The code we created can be found below. We have also linked the video of our tests running with coverage to showcase the work we have done.
*[https://github.com/expertiza/expertiza/pull/1524 Pull request]
*[https://github.com/expertiza/expertiza/pull/1524 Deployed URL]

== Our Recommendation for a separate issue ==

In the current system, we identified an issue and would like to bring it to your notice.

=== Existing System ===

When a user attempts to copy an assignment, the code creates a duplicate ‘assignment’ object, renames it as ‘copy of’ + <name of existing assignment>, saves the object and redirects to the ‘edit’ page where user is supposed to rename the assignment to something meaningful.

=== Issue ===

The current naming scheme as ‘copy of’ + <name of existing assignment> is creating an issue. Say you are creating a copy for some assignment named ‘OSS Project’, the copy object will be named as ‘copy of OSS Project’, saved and redirected to edit page. Had there been an existing assignment names ‘copy of OSS Project’ (which is likely), the copy attempt shall fail, putting a flash message on the screen like:

The assignment was not able to be copied. Please check the original assignment for missing information.

The above error message is in no relevance to the real reason for the error. Even though the save attempt failed, a copy is being inserted into the assignments table in the database.

=== Proposed Recommendation ===

Current naming scheme must be changed to have randomness. The name of the assignment can be given a random string, or a string like ‘copy of ’ + <name of existing assignment> + <5 digit random code>.

The user is anyway supposed to edit the information in the edit page (where the application is redirected after copying is successful). So, here, he can change the name to have some meaningful string.

== Team Information ==
1) Sai Vishnu Muvvala(smuvval)

2) Rohan Pillai(rspillai)

3) Subha Sekhar Reddy Pereddy(speredd)

Mentor : Yashad Trivedi

CSC/ECE 517 Fall 2019 - E1959. Intelligent copying of assignments without topics

2019-10-28T23:33:15Z

Smuvval: /* Problem Statemnet */

== '''Wiki page Description''' ==
This wiki page describes about the E1959. Intelligent copying of assignments without topics (Issue #1341). we will explain about the issue and also the steps to resolve the issue.

== '''Introduction''' ==

Expertiza is an open source web application project developed using Ruby on Rails framework. Let us list some of the functionalities that Expertiza allows us to do under different roles

As an Instructor:

we can create new assignments, edit the existing assignments, copy the assignments and also delete the assignment. The instruct can also add participants, reviewers to a particular assignment.

As a Student:

They can form teams to work on various projects and also bid for the projects they would like to work on. They can also review other student's work and can give feedback on them. They can also submit various types of documents including the URLs and wiki pages for their project or assignment submission.

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

===Background:===
When an instructor or a TA logs in to expertiza, he can see a list of assignments under the assignment tab. An instructor or a TA can copy an assignment to use the same event in another course or as another assignment. When the user copies the assignment, the assignment is copied as it is but the user may have some choices while copying the assignment.

===Issues:===
Issue 1:
While copying an assignment, the user (instructor or TA) is not asked whether (s)he wants to copy the topics along with the assignment or not.

Issue 2:
While copying an assignment the students are not copied for a particular topic so the user (instructor or TA) is not asked whether he wants to copy the topics with the associated students or not.

===Steps to generate the issues:===
1) Login as an instructor using the credentials username:instructor6 password: password

2) You will be redirected to the home page of the expertiza, Hover your cursor over the manage tab and select the assignment tab.

3) It will be redirected to the assignment page so on clicking the copy icon to the right of each assignment it will create a new assignment along with the topics and students under the topic are not copied.

== Resolving Issue 1: ==

1) To resolve the issue we will redirect the user (instructor or TA) to a new web page on clicking the copy icon which is present on the right side of each project.
[[File: Copy oss.PNG|frame|center]]

2) On clicking the copy icon we will redirect to a new webpage which looks like:
[[File: Copy2 oss.PNG|frame|center]]

3) So if we want to copy the topics associated with the assignment we will select the 'YES' button or 'NO' button if we don't want to copy the topics associated with the assignment. if we select the YES Button, then we will have a flash message showing that the assignment was copied successfully and the topics are listed under the topics tab.
[[File: Copy3 oss.PNG|frame|center]]

[[File: Copy4 oss.PNG|frame|center]]

On clicking the topics tab we can see the list of topics under the assignment copied

[[File: Copy5 oss.PNG|frame|center]]

4) In a similar way, we can select the NO button which does not allow the assignment to be copied.

== Resolving Issue 2: ==

1) The issue2 deals with whether the students of the topics should be copied or not. so we have decided to implement the issue1 and issue2 together to optimize and eliminate the redundancy by using the dry principle.

2) so instead of providing just 'YES' or 'NO' we added radio buttons which shows:

O copy without topics

O copy with topics

O copy with topics and teams

[[File: oss_copy6.PNG|frame|center]]

3) we can select one of the options and then we can select the create button according to our desired choice

4) The assignment will be copied successfully according to our choice.

[[File: oss_copy7.PNG|frame|center]]

== Code modification ==
we have modified 5 files and mainly we have modified code in two classes they are:
assignments_controller.rb under the apps/controllers
assignment_form.rb under the apps/models

we have created a new web page that is triggered on clicking the copy icon for the assignment. The view page is the checktopicscopy.html.erb under the views/assignments folder.

== For the reviewers ==
1) Please log in using the instructor credentials they are username:instructor6 password: password

2) Then select the assignment tab under manage

3) The assignment page opens and then select the copy button of the desired assignment.[NOTE: Before copying see that the assignment already has the topics or not by selecting the edit icon of the assignment]

4) If that particular assignment does not have the topics, choose another assignment which has topics to test our functionality.

5) On clicking the copy icon you will be redirected to the web page which has options, select one of the desired options and select the create button.

5) On clicking the Create button you will be redirected to the edit page of the newly created assignment. In the edit page if the topics tab appears it means that the topics are copied and you can check whether the students under the topics are copied or not.[NOTE: if the topics tab is absent beside the General Tab it indicates that the topics are not copied with assignment]

6) Check the new assignment based on the choice you selected while creating a copy of an assignment.

== Testing ==

we have made changes to the test cases and both the assignment_form.rb in models and also the assignments_controller.rb in controllers have passed all the test cases.

== Our work ==
The code we created can be found below. We have also linked the video of our tests running with coverage to showcase the work we have done.
*[https://github.com/expertiza/expertiza/pull/1524 Pull request]
*[https://github.com/expertiza/expertiza/pull/1524 Deployed URL]

== Our Recommendation for a separate issue ==

In the current system, we identified an issue and would like to bring it to your notice.

=== Existing System ===

When a user attempts to copy an assignment, the code creates a duplicate ‘assignment’ object, renames it as ‘copy of’ + <name of existing assignment>, saves the object and redirects to the ‘edit’ page where user is supposed to rename the assignment to something meaningful.

=== Issue ===

The current naming scheme as ‘copy of’ + <name of existing assignment> is creating an issue. Say you are creating a copy for some assignment named ‘OSS Project’, the copy object will be named as ‘copy of OSS Project’, saved and redirected to edit page. Had there been an existing assignment names ‘copy of OSS Project’ (which is likely), the copy attempt shall fail, putting a flash message on the screen like:

The assignment was not able to be copied. Please check the original assignment for missing information.

The above error message is in no relevance to the real reason for the error. Even though the save attempt failed, a copy is being inserted into the assignments table in the database.

=== Proposed Recommendation ===

Current naming scheme must be changed to have randomness. The name of the assignment can be given a random string, or a string like ‘copy of ’ + <name of existing assignment> + <5 digit random code>.

The user is anyway supposed to edit the information in the edit page (where the application is redirected after copying is successful). So, here, he can change the name to have some meaningful string.

== Team Information ==
1) Sai Vishnu Muvvala(smuvval)

2) Rohan Pillai(rspillai)

3) Subha Sekhar Reddy Pereddy(speredd)