Expertiza_Wiki - User contributions [en]

E2157. Fix issues related to deadlines and late policies

2021-12-03T18:55:01Z

Alunava: /* Milestones */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The following issues have been raised in the current implementation:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

====Refactoring and Design Patterns====
Since our goal is to fix existing functionalities we will not be updating the existing design patterns being employed in the code. Yet, we would like to discuss what makes these refactoring important. Refactoring is a systematic process of improving code without creating new functionality. Thus, a key to the success of our project is ensuring everything that was working before our changes work even after our changes have been added. To ensure this, we will continue to test the system after each issue has been fixed. This will allow us to ensure two things:

* We are only changing what we set out to change when fixing a particular issue.
* We are not breaking what was working before we deployed our fix.

We believe at the end our changes will increase the quality of Expertiza and improve the experience for users an developers alike.

==Project Scope==
[[File:Rsz late policy.png|600px]]
<br>
All the issues raised mainly exist in the "Due Dates" tab on the "Edit Assignment" page.
* '''Issue 1''' - Change "penalty policy" to "late policy" on all the relevant UI screens (app/views/late_policies).
* '''Issue 2''' - Analyze and fix required function and write appropriate test cases (late_policies_controller.rb).
* '''Issue 3''' - Analyze and fix required function and write appropriate test cases (late_policies_controller.rb).
* '''Issue 4''' - Analyze and fix required function and write appropriate test cases (late_policies_controller.rb).
* '''Issue 5''' - Write new test cases for late_policies_controller.rb and late_policy.rb.

==Problem description, Approach & Fix==

<h4> Issue 1: Renaming penalty policy to late policy</h4>
'''Problem Description: ''' Usage of different terms for the same thing causes ambiguity and can lead to unfortunate errors. In this instance having two different terms for "late policy" will cause confusion when instructors are creating assignments.

'''Fix:''' To avoid confusion, use “late policy” exclusively.

'''Code Snippet : '''

[[File:Issue1A.png]]

<h4> Issue 2: Issue 2: Late policies cannot be created without raising an error </h4>
'''Problem Description: ''' The current implementation throws errors whenever late policies are created. Most of these errors are from the end of the system and not users. This is not desirable from our system as it should be able to handle internal errors and throw error messages only when they are absolutely required.

'''Fix:'''
<ul>
<li>Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.0</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>
'''Code Snippet : '''

[[File:Issue2A.png]]

<h4> Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h4>
'''Problem Description: ''' The "back" button functionality is broken. In an extensive system like ours, such issues can make our users irritable and do not provide them with the best user experience. These navigation buttons are an important part of the system and should take the users to correct pages.

'''Fix:''' Ensure that on click of the back button, the user is taken back to the assignment page. To achieve this, we have added the assignment reference in the current session.

'''Code Snippet : '''

[[File:issue3A.png]]

<h4>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h4>
'''Problem Description: ''' If I create an assignment by copying an old assignment, the due dates are copied too. It is likely that I want the same increment between due dates as in the old assignment (e.g., two days for the review phase, three days for resubmission, etc.). To avoid the need to edit all the deadlines manually, Expertiza has a date updater. Currently, the broken "+" and "-" button make it hard for our users to take full advantage of this functionality.

'''Fix:''' Editing the code linked to these button should allow us to ensure that users can increment and decrement between dates as per requirements.We found out that this functionality is already working, however we added an information icon so that it is well understood by the user how to use this.

'''Code Snippet : '''

[[File:issue4A.png]]

<h4>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h4>
'''Problem Description: ''' The purpose of a test case is to determine if different features within a system are performing as expected and to confirm that the system satisfies all related standards, guidelines, and customer requirements. The process of writing a test case can also help reveal errors or defects within the system.

'''Fix:'''
<ul>
<li>Added test file for late_policies_controller_spec.rb with appropriate test cases</li>
<li>Added test file for late_policies_spec.rb with appropriate test cases
</ul>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

#[https://drive.google.com/file/d/1gpW2Y6mw-ctg5EZE4JZoSLS5mjJuIg1S/view?usp=sharing Working Demo Video]

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''''After fix'''''

The new code changes does not break existing functionality. Please check out below video which shows how all the five issues are being addressed :

#[https://drive.google.com/file/d/1gpW2Y6mw-ctg5EZE4JZoSLS5mjJuIg1S/view?usp=sharing Working Demo]

'''Automated Testing Using RSpec'''

We created two new test files, late_policy_spec.rb and late_policies_controller_spec.rb which cover test scenarios for late_policy.rb and late_policies_controller.rb repesctively.

'''late_policy_spec.rb'''

This test suite covers the two functions available in the model. Our test ensures that the model functions as expected. Most of the corner cases are being covered by controller test and thus the key to this test suite is ensuring all functionalities function as expected.

[[File:Test_1.png|600px]]

The first function in the model is for checking if for a particular instructor, the policy name already exists. For this scenario, there are two possible outcomes :
* Policy name already exists under an instructor.
* Policy name does not exists under an instructor.

Our test cases cover both of these scenarios.

[[File:Test_2.png|600px]]
[[File:Test_3.png|600px]]

The second method in this controller checks if penalty points are being updated correctly or not. One key aspect to testing this function was the mocking of the helper method. Our model depends on a helper file to update penalty points based on certain factors. Since the functionality of the model should be independent of helper behavior, we have mocked that call. The calculation of penalty is based on the type of the deadline which can have 4 possible values :
* nil
* 1
* 2
* 5

Based on each none or one of the penalty points from submission, review or meta_review gets updated. Our test suite goes through each and ensures the correct one is being updated.

'''late_policies_controller_spec.rb'''
Our controller test ensures that the controller works as expected. We have covered the test cases for each method present in the controller, Moreover, we tried to cover most of the corner cases. We have total of 14 controller test case and detailed test cases can be checked out in our pull request (#[https://github.com/expertiza/expertiza/pull/2127 Pull Request]).

Following are few test cases :

1.) This test case covers the scenario where the penalty per unit exceeds the max penalty for an assignment.

[[File:MaxPenaltyLess.png]]

2.) Trying to create/update policy which already exists.

[[File:SamePolicy.png]]

[[File:createSamePolicy.png]]

3.) Delete the policy.

[[File:DestroyPolicy.png]]

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

Test coverage has been increased by 0.6 percentage :

[[File:Coverage.png]]

==Milestones==
'''10/25''' – Project Selection

'''11/03''' – Develop Project Design Document

'''11/06''' – Update Project Design Document based on feedback from Round 1

'''11/10''' – Divided tasks and started implementation

'''11/14''' – First review of implementation and discussion on future work

'''11/22''' – Follow up review and start with documentation update

'''11/28''' – Work completion followed by video creation

'''11/29''' – Final submission

==Project Mentors==
*Tirth Patel

==Team Members==
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
===E2157===
#[https://github.com/wshubham/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/pull/2127 Pull Request]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

E2157. Fix issues related to deadlines and late policies

2021-12-03T18:51:17Z

Alunava: /* Problem description, Approach & Fix */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The following issues have been raised in the current implementation:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

====Refactoring and Design Patterns====
Since our goal is to fix existing functionalities we will not be updating the existing design patterns being employed in the code. Yet, we would like to discuss what makes these refactoring important. Refactoring is a systematic process of improving code without creating new functionality. Thus, a key to the success of our project is ensuring everything that was working before our changes work even after our changes have been added. To ensure this, we will continue to test the system after each issue has been fixed. This will allow us to ensure two things:

* We are only changing what we set out to change when fixing a particular issue.
* We are not breaking what was working before we deployed our fix.

We believe at the end our changes will increase the quality of Expertiza and improve the experience for users an developers alike.

==Project Scope==
[[File:Rsz late policy.png|600px]]
<br>
All the issues raised mainly exist in the "Due Dates" tab on the "Edit Assignment" page.
* '''Issue 1''' - Change "penalty policy" to "late policy" on all the relevant UI screens (app/views/late_policies).
* '''Issue 2''' - Analyze and fix required function and write appropriate test cases (late_policies_controller.rb).
* '''Issue 3''' - Analyze and fix required function and write appropriate test cases (late_policies_controller.rb).
* '''Issue 4''' - Analyze and fix required function and write appropriate test cases (late_policies_controller.rb).
* '''Issue 5''' - Write new test cases for late_policies_controller.rb and late_policy.rb.

==Problem description, Approach & Fix==

<h4> Issue 1: Renaming penalty policy to late policy</h4>
'''Problem Description: ''' Usage of different terms for the same thing causes ambiguity and can lead to unfortunate errors. In this instance having two different terms for "late policy" will cause confusion when instructors are creating assignments.

'''Fix:''' To avoid confusion, use “late policy” exclusively.

'''Code Snippet : '''

[[File:Issue1A.png]]

<h4> Issue 2: Issue 2: Late policies cannot be created without raising an error </h4>
'''Problem Description: ''' The current implementation throws errors whenever late policies are created. Most of these errors are from the end of the system and not users. This is not desirable from our system as it should be able to handle internal errors and throw error messages only when they are absolutely required.

'''Fix:'''
<ul>
<li>Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.0</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>
'''Code Snippet : '''

[[File:Issue2A.png]]

<h4> Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h4>
'''Problem Description: ''' The "back" button functionality is broken. In an extensive system like ours, such issues can make our users irritable and do not provide them with the best user experience. These navigation buttons are an important part of the system and should take the users to correct pages.

'''Fix:''' Ensure that on click of the back button, the user is taken back to the assignment page. To achieve this, we have added the assignment reference in the current session.

'''Code Snippet : '''

[[File:issue3A.png]]

<h4>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h4>
'''Problem Description: ''' If I create an assignment by copying an old assignment, the due dates are copied too. It is likely that I want the same increment between due dates as in the old assignment (e.g., two days for the review phase, three days for resubmission, etc.). To avoid the need to edit all the deadlines manually, Expertiza has a date updater. Currently, the broken "+" and "-" button make it hard for our users to take full advantage of this functionality.

'''Fix:''' Editing the code linked to these button should allow us to ensure that users can increment and decrement between dates as per requirements.We found out that this functionality is already working, however we added an information icon so that it is well understood by the user how to use this.

'''Code Snippet : '''

[[File:issue4A.png]]

<h4>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h4>
'''Problem Description: ''' The purpose of a test case is to determine if different features within a system are performing as expected and to confirm that the system satisfies all related standards, guidelines, and customer requirements. The process of writing a test case can also help reveal errors or defects within the system.

'''Fix:'''
<ul>
<li>Added test file for late_policies_controller_spec.rb with appropriate test cases</li>
<li>Added test file for late_policies_spec.rb with appropriate test cases
</ul>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

#[https://drive.google.com/file/d/1gpW2Y6mw-ctg5EZE4JZoSLS5mjJuIg1S/view?usp=sharing Working Demo Video]

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''''After fix'''''

The new code changes does not break existing functionality. Please check out below video which shows how all the five issues are being addressed :

#[https://drive.google.com/file/d/1gpW2Y6mw-ctg5EZE4JZoSLS5mjJuIg1S/view?usp=sharing Working Demo]

'''Automated Testing Using RSpec'''

We created two new test files, late_policy_spec.rb and late_policies_controller_spec.rb which cover test scenarios for late_policy.rb and late_policies_controller.rb repesctively.

'''late_policy_spec.rb'''

This test suite covers the two functions available in the model. Our test ensures that the model functions as expected. Most of the corner cases are being covered by controller test and thus the key to this test suite is ensuring all functionalities function as expected.

[[File:Test_1.png|600px]]

The first function in the model is for checking if for a particular instructor, the policy name already exists. For this scenario, there are two possible outcomes :
* Policy name already exists under an instructor.
* Policy name does not exists under an instructor.

Our test cases cover both of these scenarios.

[[File:Test_2.png|600px]]
[[File:Test_3.png|600px]]

The second method in this controller checks if penalty points are being updated correctly or not. One key aspect to testing this function was the mocking of the helper method. Our model depends on a helper file to update penalty points based on certain factors. Since the functionality of the model should be independent of helper behavior, we have mocked that call. The calculation of penalty is based on the type of the deadline which can have 4 possible values :
* nil
* 1
* 2
* 5

Based on each none or one of the penalty points from submission, review or meta_review gets updated. Our test suite goes through each and ensures the correct one is being updated.

'''late_policies_controller_spec.rb'''
Our controller test ensures that the controller works as expected. We have covered the test cases for each method present in the controller, Moreover, we tried to cover most of the corner cases. We have total of 14 controller test case and detailed test cases can be checked out in our pull request (#[https://github.com/expertiza/expertiza/pull/2127 Pull Request]).

Following are few test cases :

1.) This test case covers the scenario where the penalty per unit exceeds the max penalty for an assignment.

[[File:MaxPenaltyLess.png]]

2.) Trying to create/update policy which already exists.

[[File:SamePolicy.png]]

[[File:createSamePolicy.png]]

3.) Delete the policy.

[[File:DestroyPolicy.png]]

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

Test coverage has been increased by 0.6 percentage :

[[File:Coverage.png]]

==Milestones==
'''10/25''' – Project Selection

'''11/03''' – Develop Project Design Document

'''11/06''' – Update Project Design Document based on feedback from Round 1

==Project Mentors==
*Tirth Patel

==Team Members==
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
===E2157===
#[https://github.com/wshubham/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/pull/2127 Pull Request]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

E2157. Fix issues related to deadlines and late policies

2021-11-27T02:48:11Z

Alunava: /* Test Plan */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The following issues have been raised in the current implementation:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

====Refactoring and Design Patterns====
Since our goal is to fix existing functionalities we will not be updating the existing design patterns being employed in the code. Yet, we would like to discuss what makes these refactoring important. Refactoring is a systematic process of improving code without creating new functionality. Thus, a key to the success of our project is ensuring everything that was working before our changes work even after our changes have been added. To ensure this, we will continue to test the system after each issue has been fixed. This will allow us to ensure two things:

* We are only changing what we set out to change when fixing a particular issue.
* We are not breaking what was working before we deployed our fix.

We believe at the end our changes will increase the quality of Expertiza and improve the experience for users an developers alike.

==Project Scope==
[[File:Rsz late policy.png|600px]]
<br>
All the issues raised mainly exist in the "Due Dates" tab on the "Edit Assignment" page.
* '''Issue 1''' - Change "penalty policy" to "late policy" on all the relevant UI screens (app/views/late_policies).
* '''Issue 2''' - Analyze and fix required function and write appropriate test cases (late_policies_controller.rb).
* '''Issue 3''' - Analyze and fix required function and write appropriate test cases (late_policies_controller.rb).
* '''Issue 4''' - Analyze and fix required function and write appropriate test cases (late_policies_controller.rb).
* '''Issue 5''' - Write new test cases for late_policies_controller.rb and late_policy.rb.

==Problem description, Approach & Fix==

<h3> Issue 1: Renaming penalty policy to late policy</h3>
'''Problem Description: ''' Usage of different terms for the same thing causes ambiguity and can lead to unfortunate errors. In this instance having two different terms for "late policy" will cause confusion when instructors are creating assignments.

'''Fix:''' To avoid confusion, use “late policy” exclusively.

<h3> Issue 2: Issue 2: Late policies cannot be created without raising an error </h3>
'''Problem Description: ''' The current implementation throws errors whenever late policies are created. Most of these errors are from the end of the system and not users. This is not desirable from our system as it should be able to handle internal errors and throw error messages only when they are absolutely required.

'''Fix:'''
<ul>
<li>Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.0</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>

<h3> Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h3>
'''Problem Description: ''' The "back" button functionality is broken. In an extensive system like ours, such issues can make our users irritable and do not provide them with the best user experience. These navigation buttons are an important part of the system and should take the users to correct pages.

'''Fix:''' Ensure that on click of the back button, the user is taken back to the assignment page.

<h3>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h3>
'''Problem Description: ''' If I create an assignment by copying an old assignment, the due dates are copied too. It is likely that I want the same increment between due dates as in the old assignment (e.g., two days for the review phase, three days for resubmission, etc.). To avoid the need to edit all the deadlines manually, Expertiza has a date updater. Currently, the broken "+" and "-" button make it hard for our users to take full advantage of this functionality.

'''Fix:''' Editing the code linked to these button should allow us to ensure that users can increment and decrement between dates as per requirements.

<h3>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h3>
'''Problem Description: ''' The purpose of a test case is to determine if different features within a system are performing as expected and to confirm that the system satisfies all related standards, guidelines, and customer requirements. The process of writing a test case can also help reveal errors or defects within the system.

'''Fix:'''
<ul>
<li>Add test file for late_policies_controller_spec.rb with appropriate test cases</li>
<li>Add test file for late_policies_spec.rb with appropriate test cases
</ul>

==Expected Results==
We expect the new code changes should not break existing functionality and the following results upon completion:
<br>
* '''Issue 1''' - Once this issue is fixed, the Due Dates tab while editing an assignment will have no ambiguity between "late policy" and "penalty policy", as "late policy" will be used exclusively.
<br>
[[File:Hitissue11.png|650px]]
<br>
* '''Issue 2''' - Once this issue is fixed, late policies can be created and saved successfully without raising the "The following error occurred while saving the penalty policy:" error.
<br>
[[File:Hitissue2.png|650px]]
<br>
* '''Issue 3''' - Once this issue is fixed, the back link after creating a late policy will rightly take the user to the General tab on the Edit Assignment page.
<br>
[[File:Hitissue3.png|650px]]
<br>
* '''Issue 4''' - Once this issue is fixed, "+" and "-" buttons for Show/Hide Date Updater will work and update all the dates relative to the first date keeping the days gap between all the dates the same as before.
<br>
[[File:Hitissue4.png|650px]]
<br>
* '''Issue 5''' - The code coverage will increase once tests for late_policy.rb and late_policies_controller.rb are written.
<br>
[[File:Hitissue5.png|650px]]
<br>

<br>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''''After fix'''''
<br>
<br>

'''Automated Testing Using RSpec'''

We created two new test files, late_policy_spec.rb and late_policies_controller_spec.rb which cover test scenarios for late_policy.rb and late_policies_controller.rb repesctively.

'''late_policy_spec.rb'''

This test suite covers the two functions available in the model. Our test ensures that the model functions as expected. Most of the corner cases are being covered by controller test and thus the key to this test suite is ensuring all functionalities function as expected.

[[File:Test_1.png|600px]]

The first function in the model is for checking if for a particular instructor, the policy name already exists. For this scenario, there are two possible outcomes :
* Policy name already exists under an instructor.
* Policy name does not exists under an instructor.

Our test cases cover both of these scenarios.

[[File:Test_2.png|600px]]
[[File:Test_3.png|600px]]

The second method in this controller checks if penalty points are being updated correctly or not. One key aspect to testing this function was the mocking of the helper method. Our model depends on a helper file to update penalty points based on certain factors. Since the functionality of the model should be independent of helper behavior, we have mocked that call. The calculation of penalty is based on the type of the deadline which can have 4 possible values :
* nil
* 1
* 2
* 5

Based on each none or one of the penalty points from submission, review or meta_review gets updated. Our test suite goes through each and ensures the correct one is being updated.

'''Automated Testing Using Capybara'''

We plan to create UI test framework using Capybara with Cucumber that automates the manual testing path and saves time and repetitive effort. These tests will be written prior to code and define the expected behavior of policy controller.

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

==Milestones==
'''10/25''' – Project Selection

'''11/03''' – Develop Project Design Document

'''11/06''' – Update Project Design Document based on feedback from Round 1

==Project Mentors==
*Tirth Patel

==Team Members==
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
===E2157===
#[https://github.com/wshubham/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/pull/2127 Pull Request]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

File:Test 3.png

2021-11-27T02:36:48Z

Alunava:

File:Test 2.png

2021-11-27T02:36:38Z

Alunava:

File:Test 1.png

2021-11-27T02:36:28Z

Alunava:

E2157. Fix issues related to deadlines and late policies

2021-11-07T16:39:44Z

Alunava: /* Project Scope */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The following issues have been raised in the current implementation:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

====Refactoring and Design Patterns====
Since our goal is to fix existing functionalities we will not be updating the existing design patterns being employed in the code. Yet, we would like to discuss what makes these refactoring important. Refactoring is a systematic process of improving code without creating new functionality. Thus, a key to the success of our project is ensuring everything that was working before our changes work even after our changes have been added. To ensure this, we will continue to test the system after each issue has been fixed. This will allow us to ensure two things:

* We are only changing what we set out to change when fixing a particular issue.
* We are not breaking what was working before we deployed our fix.

We believe at the end our changes will increase the quality of Expertiza and improve the experience for users an developers alike.

==Project Scope==
[[File:Rsz late policy.png|600px]]
<br>
All the issues raised mainly exist in the "Due Dates" tab on the "Edit Assignment" page.
* '''Issue 1''' - Change "penalty policy" to "late policy" on all the relevant UI screens (app/views/late_policies).
* '''Issue 2''' - Analyze and fix required function and write appropriate test cases (late_policies_controller.rb).
* '''Issue 3''' - Analyze and fix required function and write appropriate test cases (late_policies_controller.rb).
* '''Issue 4''' - Analyze and fix required function and write appropriate test cases (late_policies_controller.rb).
* '''Issue 5''' - Write new test cases for late_policies_controller.rb and late_policy.rb.

==Problem description, Approach & Fix==

<h3> Issue 1: Renaming penalty policy to late policy</h3>
'''Problem Description: ''' Usage of different terms for the same thing causes ambiguity and can lead to unfortunate errors. In this instance having two different terms for "late policy" will cause confusion when instructors are creating assignments.

'''Fix:''' To avoid confusion, use “late policy” exclusively.

<h3> Issue 2: Issue 2: Late policies cannot be created without raising an error </h3>
'''Problem Description: ''' The current implementation throws errors whenever late policies are created. Most of these errors are from the end of the system and not users. This is not desirable from our system as it should be able to handle internal errors and throw error messages only when they are absolutely required.

'''Fix:'''
<ul>
<li>Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.0</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>

<h3> Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h3>
'''Problem Description: ''' The "back" button functionality is broken. In an extensive system like ours, such issues can make our users irritable and do not provide them with the best user experience. These navigation buttons are an important part of the system and should take the users to correct pages.

'''Fix:''' Ensure that on click of the back button, the user is taken back to the assignment page.

<h3>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h3>
'''Problem Description: ''' If I create an assignment by copying an old assignment, the due dates are copied too. It is likely that I want the same increment between due dates as in the old assignment (e.g., two days for the review phase, three days for resubmission, etc.). To avoid the need to edit all the deadlines manually, Expertiza has a date updater. Currently, the broken "+" and "-" button make it hard for our users to take full advantage of this functionality.

'''Fix:''' Editing the code linked to these button should allow us to ensure that users can increment and decrement between dates as per requirements.

<h3>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h3>
'''Problem Description: ''' The purpose of a test case is to determine if different features within a system are performing as expected and to confirm that the system satisfies all related standards, guidelines, and customer requirements. The process of writing a test case can also help reveal errors or defects within the system.

'''Fix:'''
<ul>
<li>Add test file for late_policies_controller_spec.rb with appropriate test cases</li>
<li>Add test file for late_policies_spec.rb with appropriate test cases
</ul>

==Expected Results==
We expect the new code changes should not break existing functionality and the following results upon completion:
<br>
* '''Issue 1''' - Once this issue is fixed, the Due Dates tab while editing an assignment will have no ambiguity between "late policy" and "penalty policy", as "late policy" will be used exclusively.
<br>
[[File:Hitissue11.png|650px]]
<br>
* '''Issue 2''' - Once this issue is fixed, late policies can be created and saved successfully without raising the "The following error occurred while saving the penalty policy:" error.
<br>
[[File:Hitissue2.png|650px]]
<br>
* '''Issue 3''' - Once this issue is fixed, the back link after creating a late policy will rightly take the user to the General tab on the Edit Assignment page.
<br>
[[File:Hitissue3.png|650px]]
<br>
* '''Issue 4''' - Once this issue is fixed, "+" and "-" buttons for Show/Hide Date Updater will work and update all the dates relative to the first date keeping the days gap between all the dates the same as before.
<br>
[[File:Hitissue4.png|650px]]
<br>
* '''Issue 5''' - The code coverage will increase once tests for late_policy.rb and late_policies_controller.rb are written.
<br>
[[File:Hitissue5.png|650px]]
<br>

<br>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''Automated Testing Using RSpec'''

We plan to create two new files, late_policy_spec.rb and late_policies_controller_spec.rb to write tests for late_policy.rb and late_policies_controller.rb repesctively.

'''Automated Testing Using Capybara'''

We plan to create UI test framework using Capybara with Cucumber that automates the manual testing path and saves time and repetitive effort. These tests will be written prior to code and define the expected behavior of policy controller.

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

==Milestones==
'''10/25''' – Project Selection

'''11/03''' – Develop Project Design Document

'''11/06''' – Update Project Design Document based on feedback from Round 1

==Project Mentors==
*Tirth Patel

==Team Members==
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
===E2157===
#[https://github.com/wshubham/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/pull/2127 Pull Request]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

E2157. Fix issues related to deadlines and late policies

2021-11-07T16:35:43Z

Alunava:

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The following issues have been raised in the current implementation:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

====Refactoring and Design Patterns====
Since our goal is to fix existing functionalities we will not be updating the existing design patterns being employed in the code. Yet, we would like to discuss what makes these refactoring important. Refactoring is a systematic process of improving code without creating new functionality. Thus, a key to the success of our project is ensuring everything that was working before our changes work even after our changes have been added. To ensure this, we will continue to test the system after each issue has been fixed. This will allow us to ensure two things:

* We are only changing what we set out to change when fixing a particular issue.
* We are not breaking what was working before we deployed our fix.

We believe at the end our changes will increase the quality of Expertiza and improve the experience for users an developers alike.

==Project Scope==
[[File:Rsz late policy.png|600px]]
<br>
Issues described in the above section all exist in the Due Dates tab on the Edit Assignment page.
* '''Issue 1''' - The scope of this issue is to change "penalty policy" to "late policy" on all the relevant UI screens (app/views/late_policies).
* '''Issue 2''' - The scope of this issue is to fix the function in ruby and write appropriate test cases (late_policies_controller.rb).
* '''Issue 3''' - The scope of this issue is to fix the function in ruby and write appropriate test cases (late_policies_controller.rb).
* '''Issue 4''' - The scope of this issue is to fix the function in ruby and write appropriate test cases (late_policies_controller.rb).
* '''Issue 5''' - The scope of this issue is to write test cases for late_policies_controller.rb and late_policy.rb.

==Problem description, Approach & Fix==

<h3> Issue 1: Renaming penalty policy to late policy</h3>
'''Problem Description: ''' Usage of different terms for the same thing causes ambiguity and can lead to unfortunate errors. In this instance having two different terms for "late policy" will cause confusion when instructors are creating assignments.

'''Fix:''' To avoid confusion, use “late policy” exclusively.

<h3> Issue 2: Issue 2: Late policies cannot be created without raising an error </h3>
'''Problem Description: ''' The current implementation throws errors whenever late policies are created. Most of these errors are from the end of the system and not users. This is not desirable from our system as it should be able to handle internal errors and throw error messages only when they are absolutely required.

'''Fix:'''
<ul>
<li>Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.0</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>

<h3> Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h3>
'''Problem Description: ''' The "back" button functionality is broken. In an extensive system like ours, such issues can make our users irritable and do not provide them with the best user experience. These navigation buttons are an important part of the system and should take the users to correct pages.

'''Fix:''' Ensure that on click of the back button, the user is taken back to the assignment page.

<h3>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h3>
'''Problem Description: ''' If I create an assignment by copying an old assignment, the due dates are copied too. It is likely that I want the same increment between due dates as in the old assignment (e.g., two days for the review phase, three days for resubmission, etc.). To avoid the need to edit all the deadlines manually, Expertiza has a date updater. Currently, the broken "+" and "-" button make it hard for our users to take full advantage of this functionality.

'''Fix:''' Editing the code linked to these button should allow us to ensure that users can increment and decrement between dates as per requirements.

<h3>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h3>
'''Problem Description: ''' The purpose of a test case is to determine if different features within a system are performing as expected and to confirm that the system satisfies all related standards, guidelines, and customer requirements. The process of writing a test case can also help reveal errors or defects within the system.

'''Fix:'''
<ul>
<li>Add test file for late_policies_controller_spec.rb with appropriate test cases</li>
<li>Add test file for late_policies_spec.rb with appropriate test cases
</ul>

==Expected Results==
We expect the new code changes should not break existing functionality and the following results upon completion:
<br>
* '''Issue 1''' - Once this issue is fixed, the Due Dates tab while editing an assignment will have no ambiguity between "late policy" and "penalty policy", as "late policy" will be used exclusively.
<br>
[[File:Hitissue11.png|650px]]
<br>
* '''Issue 2''' - Once this issue is fixed, late policies can be created and saved successfully without raising the "The following error occurred while saving the penalty policy:" error.
<br>
[[File:Hitissue2.png|650px]]
<br>
* '''Issue 3''' - Once this issue is fixed, the back link after creating a late policy will rightly take the user to the General tab on the Edit Assignment page.
<br>
[[File:Hitissue3.png|650px]]
<br>
* '''Issue 4''' - Once this issue is fixed, "+" and "-" buttons for Show/Hide Date Updater will work and update all the dates relative to the first date keeping the days gap between all the dates the same as before.
<br>
[[File:Hitissue4.png|650px]]
<br>
* '''Issue 5''' - The code coverage will increase once tests for late_policy.rb and late_policies_controller.rb are written.
<br>
[[File:Hitissue5.png|650px]]
<br>

<br>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''Automated Testing Using RSpec'''

We plan to create two new files, late_policy_spec.rb and late_policies_controller_spec.rb to write tests for late_policy.rb and late_policies_controller.rb repesctively.

'''Automated Testing Using Capybara'''

We plan to create UI test framework using Capybara with Cucumber that automates the manual testing path and saves time and repetitive effort. These tests will be written prior to code and define the expected behavior of policy controller.

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

==Milestones==
'''10/25''' – Project Selection

'''11/03''' – Develop Project Design Document

'''11/06''' – Update Project Design Document based on feedback from Round 1

==Project Mentors==
*Tirth Patel

==Team Members==
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
===E2157===
#[https://github.com/wshubham/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/pull/2127 Pull Request]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

E2157. Fix issues related to deadlines and late policies

2021-11-07T16:07:22Z

Alunava: /* Problem Description */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The following issues have been raised in the current implementation:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

====Refactoring and Design Patterns====
Since our goal is to fix existing functionalities we will not be updating the existing design patterns being employed in the code. Yet, we would like to discuss what makes these refactoring important. Refactoring is a systematic process of improving code without creating new functionality. Thus, a key to the success of our project is ensuring everything that was working before our changes work even after our changes have been added. To ensure this, we will continue to test the system after each issue has been fixed. This will allow us to ensure two things:

* We are only changing what we set out to change when fixing a particular issue.
* We are not breaking what was working before we deployed our fix.

We believe at the end our changes will increase the quality of Expertiza and improve the experience for users an developers alike.

==Problem description, Approach & Fix==

<h3> Issue 1: Renaming penalty policy to late policy</h3>
'''Problem Description: ''' Usage of different terms for the same thing causes ambiguity and can lead to unfortunate errors. In this instance having two different terms for "late policy" will cause confusion when instructors are creating assignments.

'''Fix:''' To avoid confusion, use “late policy” exclusively.

<h3> Issue 2: Issue 2: Late policies cannot be created without raising an error </h3>
'''Problem Description: ''' The current implementation throws errors whenever late policies are created. Most of these errors are from the end of the system and not users. This is not desirable from our system as it should be able to handle internal errors and throw error messages only when they are absolutely required.

'''Fix:'''
<ul>
<li>Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.0</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>

<h3> Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h3>
'''Problem Description: ''' The "back" button functionality is broken. In an extensive system like ours, such issues can make our users irritable and do not provide them with the best user experience. These navigation buttons are an important part of the system and should take the users to correct pages.

'''Fix:''' Ensure that on click of the back button, the user is taken back to the assignment page.

<h3>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h3>
'''Problem Description: ''' If I create an assignment by copying an old assignment, the due dates are copied too. It is likely that I want the same increment between due dates as in the old assignment (e.g., two days for the review phase, three days for resubmission, etc.). To avoid the need to edit all the deadlines manually, Expertiza has a date updater. Currently, the broken "+" and "-" button make it hard for our users to take full advantage of this functionality.

'''Fix:''' Editing the code linked to these button should allow us to ensure that users can increment and decrement between dates as per requirements.

<h3>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h3>
'''Problem Description: ''' The purpose of a test case is to determine if different features within a system are performing as expected and to confirm that the system satisfies all related standards, guidelines, and customer requirements. The process of writing a test case can also help reveal errors or defects within the system.

'''Fix:'''
<ul>
<li>Add test file for late_policies_controller_spec.rb with appropriate test cases</li>
<li>Add test file for late_policies_spec.rb with appropriate test cases
</ul>

==Expected Results==
We expect the new code changes should not break existing functionality and the following results upon completion:
<br>
* '''Issue 1''' - Once this issue is fixed, the Due Dates tab while editing an assignment will have no ambiguity between "late policy" and "penalty policy", as "late policy" will be used exclusively.
<br>
[[File:Hitissue11.png|650px]]
<br>
* '''Issue 2''' - Once this issue is fixed, late policies can be created and saved successfully without raising the "The following error occurred while saving the penalty policy:" error.
<br>
[[File:Hitissue2.png|650px]]
<br>
* '''Issue 3''' - Once this issue is fixed, the back link after creating a late policy will rightly take the user to the General tab on the Edit Assignment page.
<br>
[[File:Hitissue3.png|650px]]
<br>
* '''Issue 4''' - Once this issue is fixed, "+" and "-" buttons for Show/Hide Date Updater will work and update all the dates relative to the first date keeping the days gap between all the dates the same as before.
<br>
[[File:Hitissue4.png|650px]]
<br>
* '''Issue 5''' - The code coverage will increase once tests for late_policy.rb and late_policies_controller.rb are written.
<br>
[[File:Hitissue5.png|650px]]
<br>

<br>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''Automated Testing Using RSpec'''

We plan to create two new files, late_policy_spec.rb and late_policies_controller_spec.rb to write tests for late_policy.rb and late_policies_controller.rb repesctively.

'''Automated Testing Using Capybara'''

We plan to create UI test framework using Capybara with Cucumber that automates the manual testing path and saves time and repetitive effort. These tests will be written prior to code and define the expected behavior of policy controller.

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

==Milestones==
'''10/25''' – Project Selection

'''11/03''' – Develop Project Design Document

'''11/06''' – Update Project Design Document based on feedback from Round 1

==Project Mentors==
*Tirth Patel

==Team Members==
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
===E2157===
#[https://github.com/wshubham/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/pull/2127 Pull Request]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

E2157. Fix issues related to deadlines and late policies

2021-11-07T16:06:25Z

Alunava: /* Problem Description */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The following issues have been raised in the current implementation:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

====Refactoring and Design Patterns====
Since our goal is to fix existing functionalities we will not be updating the existing design patterns being employed in the code. Yet, we would like to discuss what makes these refactoring important. Refactoring is a systematic process of improving code without creating new functionality. Thus, a key to the success of our project is ensuring everything that was working before our changes work even after our changes have been added. To ensure this, we will continue to test the system after each issue has been fixed. This will allow us to ensure two things:

* We are only changing what we set out to change when fixing a particular issue.
* We are not breaking what was working before we deployed our fix.

We believe at the end our changes will increase the quality of Expertiza and improve the experience for users an developer alike.

==Problem description, Approach & Fix==

<h3> Issue 1: Renaming penalty policy to late policy</h3>
'''Problem Description: ''' Usage of different terms for the same thing causes ambiguity and can lead to unfortunate errors. In this instance having two different terms for "late policy" will cause confusion when instructors are creating assignments.

'''Fix:''' To avoid confusion, use “late policy” exclusively.

<h3> Issue 2: Issue 2: Late policies cannot be created without raising an error </h3>
'''Problem Description: ''' The current implementation throws errors whenever late policies are created. Most of these errors are from the end of the system and not users. This is not desirable from our system as it should be able to handle internal errors and throw error messages only when they are absolutely required.

'''Fix:'''
<ul>
<li>Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.0</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>

<h3> Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h3>
'''Problem Description: ''' The "back" button functionality is broken. In an extensive system like ours, such issues can make our users irritable and do not provide them with the best user experience. These navigation buttons are an important part of the system and should take the users to correct pages.

'''Fix:''' Ensure that on click of the back button, the user is taken back to the assignment page.

<h3>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h3>
'''Problem Description: ''' If I create an assignment by copying an old assignment, the due dates are copied too. It is likely that I want the same increment between due dates as in the old assignment (e.g., two days for the review phase, three days for resubmission, etc.). To avoid the need to edit all the deadlines manually, Expertiza has a date updater. Currently, the broken "+" and "-" button make it hard for our users to take full advantage of this functionality.

'''Fix:''' Editing the code linked to these button should allow us to ensure that users can increment and decrement between dates as per requirements.

<h3>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h3>
'''Problem Description: ''' The purpose of a test case is to determine if different features within a system are performing as expected and to confirm that the system satisfies all related standards, guidelines, and customer requirements. The process of writing a test case can also help reveal errors or defects within the system.

'''Fix:'''
<ul>
<li>Add test file for late_policies_controller_spec.rb with appropriate test cases</li>
<li>Add test file for late_policies_spec.rb with appropriate test cases
</ul>

==Expected Results==
We expect the new code changes should not break existing functionality and the following results upon completion:
<br>
* '''Issue 1''' - Once this issue is fixed, the Due Dates tab while editing an assignment will have no ambiguity between "late policy" and "penalty policy", as "late policy" will be used exclusively.
<br>
[[File:Hitissue11.png|650px]]
<br>
* '''Issue 2''' - Once this issue is fixed, late policies can be created and saved successfully without raising the "The following error occurred while saving the penalty policy:" error.
<br>
[[File:Hitissue2.png|650px]]
<br>
* '''Issue 3''' - Once this issue is fixed, the back link after creating a late policy will rightly take the user to the General tab on the Edit Assignment page.
<br>
[[File:Hitissue3.png|650px]]
<br>
* '''Issue 4''' - Once this issue is fixed, "+" and "-" buttons for Show/Hide Date Updater will work and update all the dates relative to the first date keeping the days gap between all the dates the same as before.
<br>
[[File:Hitissue4.png|650px]]
<br>
* '''Issue 5''' - The code coverage will increase once tests for late_policy.rb and late_policies_controller.rb are written.
<br>
[[File:Hitissue5.png|650px]]
<br>

<br>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''Automated Testing Using RSpec'''

We plan to create two new files, late_policy_spec.rb and late_policies_controller_spec.rb to write tests for late_policy.rb and late_policies_controller.rb repesctively.

'''Automated Testing Using Capybara'''

We plan to create UI test framework using Capybara with Cucumber that automates the manual testing path and saves time and repetitive effort. These tests will be written prior to code and define the expected behavior of policy controller.

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

==Milestones==
'''10/25''' – Project Selection

'''11/03''' – Develop Project Design Document

'''11/06''' – Update Project Design Document based on feedback from Round 1

==Project Mentors==
*Tirth Patel

==Team Members==
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
===E2157===
#[https://github.com/wshubham/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/pull/2127 Pull Request]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

CSC/ECE 517 Fall 2021

2021-11-07T15:49:01Z

Alunava: /* Final Projects */

== OSS Projects ==

* [[CSC/ECE 517 Fall 2021 - E2117. Refactor questionaires_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2128. Refactor student_quizzes_controller.rb & late_policies_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2129. Refactor auth_controller.rb & password_retrieval_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2132. Add tests cases for review mapping helper.rb]]
* [[CSC/ECE 517 Fall 2021 - E2134. Write unit tests for admin_controller.rb and institution_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2138. Auto-generate submission directory names based on assignment]]
* [[CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications]]
* [[CSC/ECE 517 Fall 2021 - E2133. Write tests for popup_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2120. Refactor reputation_web_service_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2139. Remove multiple topics at a time]]
* [[CSC/ECE 517 Fall 2021 - E2131. Improve assessment360_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2121. Refactor suggestion_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2122. Refactor impersonate_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2123. Refactor sign_up_sheet_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2126. Refactor account_request_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2124. Refactor review_mapping_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2125. Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Fall 2021 - E2127. Refactor teams_controller]]
* [[CSC/ECE 517 Fall 2021 - E2130. Refactor submitted_content_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2140. Create new late policy successfully and fix Bank link]]
* [[CSC/ECE 517 Fall 2021 - E2141. OSS project Finklestein: Instructors & Institutions]]
* [[CSC/ECE 517 Fall 2021 - E2144. Refactor delayed mailer and scheduled task]]
* [[CSC/ECE 517 Fall 2021 - E2147. Role-based reviewing]]
* [[CSC/ECE 517 Fall 2021 - E2145. OSS Project Beige]]
* [[CSC/ECE 517 Fall 2021 - E2146. Introduce a Student View for instructors]]
* [[CSC/ECE 517 Fall 2021 - Refactor Evaluation of SQL Queries]]
* [[CSC/ECE 517 Fall 2021 - E2135. Email notification to reviewers and instructors]]
* [[CSC/ECE 517 Fall 2021 - E2149. Finish Github metrics integration - Reputations]]

== Final Projects ==
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2166._Testing_-_Scoring_%26_Grades#Description_about_project CSC/ECE 517 Fall 2021 - E2166. Testing - Scoring_and_Grades]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2150._Integrate_suggestion_detection_algorithm#Description_about_project CSC/ECE 517 Fall 2021 - E2150. Integrate suggestion detection algorithm]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2151._Allow_reviewers_to_bid_on_what_to_review CSC/ECE 517 Fall 2021 - E2151. Allow reviewers to bid on what to review]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2152._Revision_planning_tool#Description_about_project CSC/ECE 517 Fall 2021 - E2152. Revision_planning_tool]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2170._Testing_-_Response_Maps#Description_about_project CSC/ECE 517 Fall 2021 - E2170. Testing - Response Maps]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2153._Improving_search_facility_in_Expertiza#Description_about_project CSC/ECE 517 Fall 2021 - E2153. Improving search facility in Expertiza]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper CSC/ECE 517 Fall 2021 - E2162. Further refactoring and improvement of review mapping helper]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2163._Refactor_waitlist_functionality CSC/ECE 517 Fall 2021 - E2163. Refactor waitlist functionality]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2165._Fix_teammate-review_view CSC/ECE 517 Fall 2021 - E2165. Fix teammate review view ]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2155._Calibration_submissions_should_be_copied_along_with_calibration_assignments CSC/ECE 517 Fall 2021 - E2155. Calibration submissions should be copied along with calibration assignments]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2148._Completion/Progress_View CSC/ECE 517 Fall 2021 - E2148. Completion/Progress view]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2158._Grading_audit_trail CSC/ECE 517 Fall 2021 - E2158. Grading audit trail ]
*[https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2159._Expertiza_internationalization CSC/ECE 517 Fall 2021 - E2159. Expertiza internationalization]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2160._Implementing_and_testing_import_export_controllers#Description_about_project CSC/ECE 517 Fall 2021 - E2160. Implementing and testing import and export controllers]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2164._Heatgrid_fixes_and_improvements#Description_about_project CSC/ECE 517 Fall 2021 - E2164. Heatgrid fixes and improvements]
* [[CSC/ECE 517 Fall 2021 - E2168. Testing - Reputations]]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2126._Testing_-_Team_Related_Files#Description_about_project CSC/ECE 517 Fall 2021 - E2126. Testing - Team Related Files]
* [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2156._Issues_related_to_meta-reviewing#Description_about_project CSC/ECE 517 Fall 2021 - E2156. Issues related to meta-reviewing]
* [[CSC/ECE 517 Fall 2021 - E2169. Testing - Answer Tagging]]
* [[E2157. Fix issues related to deadlines and late policies]]

E2157. Fix issues related to deadlines and late policies

2021-11-07T15:45:07Z

Alunava: /* Expected Results */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The following issues have been raised in the current implementation:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

==Problem description, Approach & Fix==

<h3> Issue 1: Renaming penalty policy to late policy</h3>
'''Problem Description: ''' Usage of different terms for the same thing causes ambiguity and can lead to unfortunate errors. In this instance having two different terms for "late policy" will cause confusion when instructors are creating assignments.

'''Fix:''' To avoid confusion, use “late policy” exclusively.

<h3> Issue 2: Issue 2: Late policies cannot be created without raising an error </h3>
'''Problem Description: ''' The current implementation throws errors whenever late policies are created. Most of these errors are from the end of the system and not users. This is not desirable from our system as it should be able to handle internal errors and throw error messages only when they are absolutely required.

'''Fix:'''
<ul>
<li>Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.0</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>

<h3> Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h3>
'''Problem Description: ''' The "back" button functionality is broken. In an extensive system like ours, such issues can make our users irritable and do not provide them with the best user experience. These navigation buttons are an important part of the system and should take the users to correct pages.

'''Fix:''' Ensure that on click of the back button, the user is taken back to the assignment page.

<h3>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h3>
'''Problem Description: ''' If I create an assignment by copying an old assignment, the due dates are copied too. It is likely that I want the same increment between due dates as in the old assignment (e.g., two days for the review phase, three days for resubmission, etc.). To avoid the need to edit all the deadlines manually, Expertiza has a date updater. Currently, the broken "+" and "-" button make it hard for our users to take full advantage of this functionality.

'''Fix:''' Editing the code linked to these button should allow us to ensure that users can increment and decrement between dates as per requirements.

<h3>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h3>
'''Problem Description: ''' The purpose of a test case is to determine if different features within a system are performing as expected and to confirm that the system satisfies all related standards, guidelines, and customer requirements. The process of writing a test case can also help reveal errors or defects within the system.

'''Fix:'''
<ul>
<li>Add test file for late_policies_controller_spec.rb with appropriate test cases</li>
<li>Add test file for late_policies_spec.rb with appropriate test cases
</ul>

==Expected Results==
We expect the new code changes should not break existing functionality and the following results upon completion:
<br>
* '''Issue 1''' - Once this issue is fixed, the Due Dates tab while editing an assignment will have no ambiguity between "late policy" and "penalty policy", as "late policy" will be used exclusively.
<br>
[[File:Hitissue11.png|650px]]
<br>
* '''Issue 2''' - Once this issue is fixed, late policies can be created and saved successfully without raising the "The following error occurred while saving the penalty policy:" error.
<br>
[[File:Hitissue2.png|650px]]
<br>
* '''Issue 3''' - Once this issue is fixed, the back link after creating a late policy will rightly take the user to the General tab on the Edit Assignment page.
<br>
[[File:Hitissue3.png|650px]]
<br>
* '''Issue 4''' - Once this issue is fixed, "+" and "-" buttons for Show/Hide Date Updater will work and update all the dates relative to the first date keeping the days gap between all the dates the same as before.
<br>
[[File:Hitissue4.png|650px]]
<br>
* '''Issue 5''' - The code coverage will increase once tests for late_policy.rb and late_policies_controller.rb are written.
<br>
[[File:Hitissue5.png|650px]]
<br>

<br>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''Automated Testing Using RSpec'''

We plan to create two new files, late_policy_spec.rb and late_policies_controller_spec.rb to write tests for late_policy.rb and late_policies_controller.rb repesctively.

'''Automated Testing Using Capybara'''

We plan to create UI test framework using Capybara with Cucumber that automates the manual testing path and saves time and repetitive effort. These tests will be written prior to code and define the expected behavior of policy controller.

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

==Milestones==
'''10/25''' – Project Selection

'''11/03''' – Develop Project Design Document

'''11/06''' – Update Project Design Document based on feedback from Round 1

==Project Mentors==
*Tirth Patel

==Team Members==
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
===E2157===
#[https://github.com/wshubham/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/pull/2127 Pull Request]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

E2157. Fix issues related to deadlines and late policies

2021-11-07T15:40:35Z

Alunava: /* Milestones */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The following issues have been raised in the current implementation:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

==Problem description, Approach & Fix==

<h3> Issue 1: Renaming penalty policy to late policy</h3>
'''Problem Description: ''' Usage of different terms for the same thing causes ambiguity and can lead to unfortunate errors. In this instance having two different terms for "late policy" will cause confusion when instructors are creating assignments.

'''Fix:''' To avoid confusion, use “late policy” exclusively.

<h3> Issue 2: Issue 2: Late policies cannot be created without raising an error </h3>
'''Problem Description: ''' The current implementation throws errors whenever late policies are created. Most of these errors are from the end of the system and not users. This is not desirable from our system as it should be able to handle internal errors and throw error messages only when they are absolutely required.

'''Fix:'''
<ul>
<li>Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.0</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>

<h3> Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h3>
'''Problem Description: ''' The "back" button functionality is broken. In an extensive system like ours, such issues can make our users irritable and do not provide them with the best user experience. These navigation buttons are an important part of the system and should take the users to correct pages.

'''Fix:''' Ensure that on click of the back button, the user is taken back to the assignment page.

<h3>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h3>
'''Problem Description: ''' If I create an assignment by copying an old assignment, the due dates are copied too. It is likely that I want the same increment between due dates as in the old assignment (e.g., two days for the review phase, three days for resubmission, etc.). To avoid the need to edit all the deadlines manually, Expertiza has a date updater. Currently, the broken "+" and "-" button make it hard for our users to take full advantage of this functionality.

'''Fix:''' Editing the code linked to these button should allow us to ensure that users can increment and decrement between dates as per requirements.

<h3>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h3>
'''Problem Description: ''' The purpose of a test case is to determine if different features within a system are performing as expected and to confirm that the system satisfies all related standards, guidelines, and customer requirements. The process of writing a test case can also help reveal errors or defects within the system.

'''Fix:'''
<ul>
<li>Add test file for late_policies_controller_spec.rb with appropriate test cases</li>
<li>Add test file for late_policies_spec.rb with appropriate test cases
</ul>

==Expected Results==
We expect the new code changes should not break existing functionality and the following results upon completion:
<br>
<br>
* '''Issue 1''' - Once this issue is fixed, the Due Dates tab while editing an assignment will have no ambiguity between "late policy" and "penalty policy", as "late policy" will be used exclusively.
<br>
[[File:Hitissue11.png|650px]]
<br>
* '''Issue 2''' - Once this issue is fixed, late policies can be created and saved successfully without raising the "The following error occurred while saving the penalty policy:" error.
<br>
[[File:Hitissue2.png|650px]]
<br>
* '''Issue 3''' - Once this issue is fixed, the back link after creating a late policy will rightly take the user to the General tab on the Edit Assignment page.
<br>
[[File:Hitissue3.png|650px]]
<br>
* '''Issue 4''' - Once this issue is fixed, "+" and "-" buttons for Show/Hide Date Updater will work and update all the dates relative to the first date keeping the days gap between all the dates the same as before.
<br>
[[File:Hitissue4.png|650px]]
<br>
* '''Issue 5''' - The code coverage will increase once tests for late_policy.rb and late_policies_controller.rb are written.
<br>
[[File:Hitissue5.png|650px]]
<br>

<br>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''Automated Testing Using RSpec'''

We plan to create two new files, late_policy_spec.rb and late_policies_controller_spec.rb to write tests for late_policy.rb and late_policies_controller.rb repesctively.

'''Automated Testing Using Capybara'''

We plan to create UI test framework using Capybara with Cucumber that automates the manual testing path and saves time and repetitive effort. These tests will be written prior to code and define the expected behavior of policy controller.

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

==Milestones==
'''10/25''' – Project Selection

'''11/03''' – Develop Project Design Document

'''11/06''' – Update Project Design Document based on feedback from Round 1

==Project Mentors==
*Tirth Patel

==Team Members==
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
===E2157===
#[https://github.com/wshubham/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/pull/2127 Pull Request]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

E2157. Fix issues related to deadlines and late policies

2021-11-07T15:38:29Z

Alunava: /* Problem description, Approach & Fix */

E2157. Fix issues related to deadlines and late policies

2021-11-07T15:38:11Z

Alunava: /* Problem description, Approach & Fix */

E2157. Fix issues related to deadlines and late policies

2021-11-07T15:24:59Z

Alunava: /* Problem Description */

E2157. Fix issues related to deadlines and late policies

2021-11-07T15:20:03Z

Alunava: /* Expected Results */

E2157. Fix issues related to deadlines and late policies

2021-11-07T15:06:36Z

Alunava: /* Approach & Fix */

E2157. Fix issues related to deadlines and late policies

2021-11-07T14:51:17Z

Alunava: /* Issues with the Current Implementation */

E2157. Fix issues related to deadlines and late policies

2021-11-07T14:51:04Z

Alunava: /* Problem Description */

E2157. Fix issues related to deadlines and late policies

2021-11-01T17:20:40Z

Alunava: /* Expected Results */

E2157. Fix issues related to deadlines and late policies

2021-11-01T17:17:09Z

Alunava: /* Approach & Fix */

E2157. Fix issues related to deadlines and late policies

2021-11-01T17:16:44Z

Alunava: /* What needs to be done */

E2157. Fix issues related to deadlines and late policies

2021-11-01T17:16:34Z

Alunava: /* Approach & Fix */

E2157. Fix issues related to deadlines and late policies

2021-11-01T17:08:32Z

Alunava: /* Issues with the Current Implementation */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The following issues have been raised in the current implementation:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

=== What needs to be done ===
We will resolve each of these issues in the following manner:
* To avoid confusion, use “late policy” exclusively.
* Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.
* Ensure that on click of the back button, the user is taken back to the assignment page.
* Expertiza has a way to adjust the dates on assignments. This is especially helpful when an assignment is copied from another and the dates get copied too. We need to ensure the "+" and "-" buttons update the dates accordingly.
* Add test cases for late_policy.rb and late_policies_controller.rb. This will further be discussed in the Test Plan section of the page.

==Approach & Fix==
<h4>Issue 1: Renaming penalty policy to late policy</h4>

<ul>
<li>Renaming done on the UI as well as on the backend</li>
<li>Varible names refactored appropritely</li>
<li>Flash messages changed accordingly</li>
</ul>

<h4>Issue 2: Late policies cannot be created without raising an error</h4>

<p>The error which is raised is due to the following validation present in the model late_policy.rb.
<br>
<h6>validates :max_penalty, numericality: {less_than: 50}</h6>
</p>

<ul>
<li>After discussing with professor we have decided to increase the max penalty limit to 100</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>
if params[:late_policy][:max_penalty].to_i>=100
flash[:error] = "Maximum penalty cannot be greater than or equal to 100"
invalid_max_penalty = true;
end

<h4>Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h4>

<ul>
<li>Added a back link in which redirects the user to edit assignment page.</li>
<li>Saved the assignment object in a session variable when the user clicks on the the edit asignment icon</li>
<li>We also added a back button on index page since there was no direct way of going back to edit assignment page once a late policy was created.</li>
<li>We also added padding between the edit and delete links on index page</li>
</ul>
<%= link_to 'Back', :controller=> 'assignments', :action => 'edit', :id => session[:assignment] %>

<h4>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h4>

<p>While testing this issue we noticed that the functionality was working perfectly fine, however, it was not user friendly.</p>
<ul>
<li>We decided to add a tooltip icon explaining how this functionality works</li>
<li>We also inproved its UI by adding the alignment and padding.</li>
</ul>

<h4>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h4>
<ul>
<li>Added test file late_policies_controller_spec.rb with appropriate test cases</li>
<li>Added test file late_policies_spec.rb with appropriate test cases
</ul>

<br>

==Expected Results==
Each Issue is described with the predicted fix and a screenshot showing the issue fixed.
<br>
<br>
* '''Issue 1''' - Once this issue is fixed, the Due Dates tab while editing an assignment will have no ambiguity between "late policy" and "penalty policy", as "late policy" will be used exclusively.
<br>
[[File:Hitissue11.png|650px]]
<br>
* '''Issue 2''' - Once this issue is fixed, late policies can be created and saved successfully without raising the "The following error occurred while saving the penalty policy:" error.
<br>
[[File:Hitissue2.png|650px]]
<br>
* '''Issue 3''' - Once this issue is fixed, the back link after creating a late policy will rightly take the user to the General tab on the Edit Assignment page.
<br>
[[File:Hitissue3.png|650px]]
<br>
* '''Issue 4''' - Once this issue is fixed, "+" and "-" buttons for Show/Hide Date Updater will work and update all the dates relative to the first date keeping the days gap between all the dates the same as before.
<br>
[[File:Hitissue4.png|650px]]
<br>
* '''Issue 5''' - The code coverage will definitely increase once tests for late_policy.rb and late_policies_controller.rb are written.
<br>
[[File:Hitissue5.png|650px]]
<br>

<br>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''Automated Testing Using RSpec'''

We plan to create two new files, late_policy_spec.rb and late_policies_controller_spec.rb to write tests for late_policy.rb and late_policies_controller.rb repesctively.

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

<br>
'''''Afterfix'''''
<br>

To test the controller 'late_policies_controller.rb' and model 'late_policy.rb' we created 2 test files late_policy_spec.rb and late_policies_controller_spec.rb. To write test cases we used rspec functions and tested the functions on the basis of :
<ul>
<li>What they returned</li>
<li>Which page got rendered</li>
<li>Which flash error got produced</li>
<li>Which method got called</li>
</ul>
We also used stubbing and mocking functions to carry out our tests. After executing our tests we got an increase in the overall code coverage of over 0.5% for each file.
<br>
<br>
Here are the results of SimpleCov gem highlighting the code coverage of our tests.
<br>
[[File:Testplanyess.png]]
<br>

==Milestones==
'''10/25''' – Project Selection

'''10/26''' – Develop Project Design Document

==Project Mentors==
*Tirth Patel

==Team Members==
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
===E2157===
#[https://github.com/Natansh21/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/compare/beta...Natansh21:beta?expand=1 Pull Request]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

E2157. Fix issues related to deadlines and late policies

2021-11-01T17:06:27Z

Alunava: /* Problem Description */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The team found some issues in the current implementation which either cause errors are completely not functional. The goal of this project is to eliminate these issues by making necessary changes and adding new test cases which cover all scenarios.

====Issues with the Current Implementation====
The current implementation of Expertiza has the following Issues:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

=== What needs to be done ===
We will resolve each of these issues in the following manner:
* To avoid confusion, use “late policy” exclusively.
* Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.
* Ensure that on click of the back button, the user is taken back to the assignment page.
* Expertiza has a way to adjust the dates on assignments. This is especially helpful when an assignment is copied from another and the dates get copied too. We need to ensure the "+" and "-" buttons update the dates accordingly.
* Add test cases for late_policy.rb and late_policies_controller.rb. This will further be discussed in the Test Plan section of the page.

==Approach & Fix==
<h4>Issue 1: Renaming penalty policy to late policy</h4>

<ul>
<li>Renaming done on the UI as well as on the backend</li>
<li>Varible names refactored appropritely</li>
<li>Flash messages changed accordingly</li>
</ul>

<h4>Issue 2: Late policies cannot be created without raising an error</h4>

<p>The error which is raised is due to the following validation present in the model late_policy.rb.
<br>
<h6>validates :max_penalty, numericality: {less_than: 50}</h6>
</p>

<ul>
<li>After discussing with professor we have decided to increase the max penalty limit to 100</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>
if params[:late_policy][:max_penalty].to_i>=100
flash[:error] = "Maximum penalty cannot be greater than or equal to 100"
invalid_max_penalty = true;
end

<h4>Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h4>

<ul>
<li>Added a back link in which redirects the user to edit assignment page.</li>
<li>Saved the assignment object in a session variable when the user clicks on the the edit asignment icon</li>
<li>We also added a back button on index page since there was no direct way of going back to edit assignment page once a late policy was created.</li>
<li>We also added padding between the edit and delete links on index page</li>
</ul>
<%= link_to 'Back', :controller=> 'assignments', :action => 'edit', :id => session[:assignment] %>

<h4>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h4>

<p>While testing this issue we noticed that the functionality was working perfectly fine, however, it was not user friendly.</p>
<ul>
<li>We decided to add a tooltip icon explaining how this functionality works</li>
<li>We also inproved its UI by adding the alignment and padding.</li>
</ul>

<h4>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h4>
<ul>
<li>Added test file late_policies_controller_spec.rb with appropriate test cases</li>
<li>Added test file late_policies_spec.rb with appropriate test cases
</ul>

<br>

==Expected Results==
Each Issue is described with the predicted fix and a screenshot showing the issue fixed.
<br>
<br>
* '''Issue 1''' - Once this issue is fixed, the Due Dates tab while editing an assignment will have no ambiguity between "late policy" and "penalty policy", as "late policy" will be used exclusively.
<br>
[[File:Hitissue11.png|650px]]
<br>
* '''Issue 2''' - Once this issue is fixed, late policies can be created and saved successfully without raising the "The following error occurred while saving the penalty policy:" error.
<br>
[[File:Hitissue2.png|650px]]
<br>
* '''Issue 3''' - Once this issue is fixed, the back link after creating a late policy will rightly take the user to the General tab on the Edit Assignment page.
<br>
[[File:Hitissue3.png|650px]]
<br>
* '''Issue 4''' - Once this issue is fixed, "+" and "-" buttons for Show/Hide Date Updater will work and update all the dates relative to the first date keeping the days gap between all the dates the same as before.
<br>
[[File:Hitissue4.png|650px]]
<br>
* '''Issue 5''' - The code coverage will definitely increase once tests for late_policy.rb and late_policies_controller.rb are written.
<br>
[[File:Hitissue5.png|650px]]
<br>

<br>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''Automated Testing Using RSpec'''

We plan to create two new files, late_policy_spec.rb and late_policies_controller_spec.rb to write tests for late_policy.rb and late_policies_controller.rb repesctively.

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

<br>
'''''Afterfix'''''
<br>

To test the controller 'late_policies_controller.rb' and model 'late_policy.rb' we created 2 test files late_policy_spec.rb and late_policies_controller_spec.rb. To write test cases we used rspec functions and tested the functions on the basis of :
<ul>
<li>What they returned</li>
<li>Which page got rendered</li>
<li>Which flash error got produced</li>
<li>Which method got called</li>
</ul>
We also used stubbing and mocking functions to carry out our tests. After executing our tests we got an increase in the overall code coverage of over 0.5% for each file.
<br>
<br>
Here are the results of SimpleCov gem highlighting the code coverage of our tests.
<br>
[[File:Testplanyess.png]]
<br>

==Milestones==
'''10/25''' – Project Selection

'''10/26''' – Develop Project Design Document

==Project Mentors==
*Tirth Patel

==Team Members==
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
===E2157===
#[https://github.com/Natansh21/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/compare/beta...Natansh21:beta?expand=1 Pull Request]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

E2157. Fix issues related to deadlines and late policies

2021-11-01T17:03:46Z

Alunava: /* E2157 */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The current implementation of this feature has issues

====Issues with the Current Implementation====
The current implementation of Expertiza has the following Issues:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

=== What needs to be done ===
We will resolve each of these issues in the following manner:
* To avoid confusion, use “late policy” exclusively.
* Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.
* Ensure that on click of the back button, the user is taken back to the assignment page.
* Expertiza has a way to adjust the dates on assignments. This is especially helpful when an assignment is copied from another and the dates get copied too. We need to ensure the "+" and "-" buttons update the dates accordingly.
* Add test cases for late_policy.rb and late_policies_controller.rb. This will further be discussed in the Test Plan section of the page.

==Approach & Fix==
<h4>Issue 1: Renaming penalty policy to late policy</h4>

<ul>
<li>Renaming done on the UI as well as on the backend</li>
<li>Varible names refactored appropritely</li>
<li>Flash messages changed accordingly</li>
</ul>

<h4>Issue 2: Late policies cannot be created without raising an error</h4>

<p>The error which is raised is due to the following validation present in the model late_policy.rb.
<br>
<h6>validates :max_penalty, numericality: {less_than: 50}</h6>
</p>

<ul>
<li>After discussing with professor we have decided to increase the max penalty limit to 100</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>
if params[:late_policy][:max_penalty].to_i>=100
flash[:error] = "Maximum penalty cannot be greater than or equal to 100"
invalid_max_penalty = true;
end

<h4>Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h4>

<ul>
<li>Added a back link in which redirects the user to edit assignment page.</li>
<li>Saved the assignment object in a session variable when the user clicks on the the edit asignment icon</li>
<li>We also added a back button on index page since there was no direct way of going back to edit assignment page once a late policy was created.</li>
<li>We also added padding between the edit and delete links on index page</li>
</ul>
<%= link_to 'Back', :controller=> 'assignments', :action => 'edit', :id => session[:assignment] %>

<h4>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h4>

<p>While testing this issue we noticed that the functionality was working perfectly fine, however, it was not user friendly.</p>
<ul>
<li>We decided to add a tooltip icon explaining how this functionality works</li>
<li>We also inproved its UI by adding the alignment and padding.</li>
</ul>

<h4>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h4>
<ul>
<li>Added test file late_policies_controller_spec.rb with appropriate test cases</li>
<li>Added test file late_policies_spec.rb with appropriate test cases
</ul>

<br>

==Expected Results==
Each Issue is described with the predicted fix and a screenshot showing the issue fixed.
<br>
<br>
* '''Issue 1''' - Once this issue is fixed, the Due Dates tab while editing an assignment will have no ambiguity between "late policy" and "penalty policy", as "late policy" will be used exclusively.
<br>
[[File:Hitissue11.png|650px]]
<br>
* '''Issue 2''' - Once this issue is fixed, late policies can be created and saved successfully without raising the "The following error occurred while saving the penalty policy:" error.
<br>
[[File:Hitissue2.png|650px]]
<br>
* '''Issue 3''' - Once this issue is fixed, the back link after creating a late policy will rightly take the user to the General tab on the Edit Assignment page.
<br>
[[File:Hitissue3.png|650px]]
<br>
* '''Issue 4''' - Once this issue is fixed, "+" and "-" buttons for Show/Hide Date Updater will work and update all the dates relative to the first date keeping the days gap between all the dates the same as before.
<br>
[[File:Hitissue4.png|650px]]
<br>
* '''Issue 5''' - The code coverage will definitely increase once tests for late_policy.rb and late_policies_controller.rb are written.
<br>
[[File:Hitissue5.png|650px]]
<br>

<br>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''Automated Testing Using RSpec'''

We plan to create two new files, late_policy_spec.rb and late_policies_controller_spec.rb to write tests for late_policy.rb and late_policies_controller.rb repesctively.

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

<br>
'''''Afterfix'''''
<br>

To test the controller 'late_policies_controller.rb' and model 'late_policy.rb' we created 2 test files late_policy_spec.rb and late_policies_controller_spec.rb. To write test cases we used rspec functions and tested the functions on the basis of :
<ul>
<li>What they returned</li>
<li>Which page got rendered</li>
<li>Which flash error got produced</li>
<li>Which method got called</li>
</ul>
We also used stubbing and mocking functions to carry out our tests. After executing our tests we got an increase in the overall code coverage of over 0.5% for each file.
<br>
<br>
Here are the results of SimpleCov gem highlighting the code coverage of our tests.
<br>
[[File:Testplanyess.png]]
<br>

==Milestones==
'''10/25''' – Project Selection

'''10/26''' – Develop Project Design Document

==Project Mentors==
*Tirth Patel

==Team Members==
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
===E2157===
#[https://github.com/Natansh21/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/compare/beta...Natansh21:beta?expand=1 Pull Request]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

E2157. Fix issues related to deadlines and late policies

2021-11-01T17:03:04Z

Alunava: /* Problem Description */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The current implementation of this feature has issues

====Issues with the Current Implementation====
The current implementation of Expertiza has the following Issues:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

=== What needs to be done ===
We will resolve each of these issues in the following manner:
* To avoid confusion, use “late policy” exclusively.
* Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.
* Ensure that on click of the back button, the user is taken back to the assignment page.
* Expertiza has a way to adjust the dates on assignments. This is especially helpful when an assignment is copied from another and the dates get copied too. We need to ensure the "+" and "-" buttons update the dates accordingly.
* Add test cases for late_policy.rb and late_policies_controller.rb. This will further be discussed in the Test Plan section of the page.

==Approach & Fix==
<h4>Issue 1: Renaming penalty policy to late policy</h4>

<ul>
<li>Renaming done on the UI as well as on the backend</li>
<li>Varible names refactored appropritely</li>
<li>Flash messages changed accordingly</li>
</ul>

<h4>Issue 2: Late policies cannot be created without raising an error</h4>

<p>The error which is raised is due to the following validation present in the model late_policy.rb.
<br>
<h6>validates :max_penalty, numericality: {less_than: 50}</h6>
</p>

<ul>
<li>After discussing with professor we have decided to increase the max penalty limit to 100</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>
if params[:late_policy][:max_penalty].to_i>=100
flash[:error] = "Maximum penalty cannot be greater than or equal to 100"
invalid_max_penalty = true;
end

<h4>Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h4>

<ul>
<li>Added a back link in which redirects the user to edit assignment page.</li>
<li>Saved the assignment object in a session variable when the user clicks on the the edit asignment icon</li>
<li>We also added a back button on index page since there was no direct way of going back to edit assignment page once a late policy was created.</li>
<li>We also added padding between the edit and delete links on index page</li>
</ul>
<%= link_to 'Back', :controller=> 'assignments', :action => 'edit', :id => session[:assignment] %>

<h4>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h4>

<p>While testing this issue we noticed that the functionality was working perfectly fine, however, it was not user friendly.</p>
<ul>
<li>We decided to add a tooltip icon explaining how this functionality works</li>
<li>We also inproved its UI by adding the alignment and padding.</li>
</ul>

<h4>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h4>
<ul>
<li>Added test file late_policies_controller_spec.rb with appropriate test cases</li>
<li>Added test file late_policies_spec.rb with appropriate test cases
</ul>

<br>

==Expected Results==
Each Issue is described with the predicted fix and a screenshot showing the issue fixed.
<br>
<br>
* '''Issue 1''' - Once this issue is fixed, the Due Dates tab while editing an assignment will have no ambiguity between "late policy" and "penalty policy", as "late policy" will be used exclusively.
<br>
[[File:Hitissue11.png|650px]]
<br>
* '''Issue 2''' - Once this issue is fixed, late policies can be created and saved successfully without raising the "The following error occurred while saving the penalty policy:" error.
<br>
[[File:Hitissue2.png|650px]]
<br>
* '''Issue 3''' - Once this issue is fixed, the back link after creating a late policy will rightly take the user to the General tab on the Edit Assignment page.
<br>
[[File:Hitissue3.png|650px]]
<br>
* '''Issue 4''' - Once this issue is fixed, "+" and "-" buttons for Show/Hide Date Updater will work and update all the dates relative to the first date keeping the days gap between all the dates the same as before.
<br>
[[File:Hitissue4.png|650px]]
<br>
* '''Issue 5''' - The code coverage will definitely increase once tests for late_policy.rb and late_policies_controller.rb are written.
<br>
[[File:Hitissue5.png|650px]]
<br>

<br>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''Automated Testing Using RSpec'''

We plan to create two new files, late_policy_spec.rb and late_policies_controller_spec.rb to write tests for late_policy.rb and late_policies_controller.rb repesctively.

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

<br>
'''''Afterfix'''''
<br>

To test the controller 'late_policies_controller.rb' and model 'late_policy.rb' we created 2 test files late_policy_spec.rb and late_policies_controller_spec.rb. To write test cases we used rspec functions and tested the functions on the basis of :
<ul>
<li>What they returned</li>
<li>Which page got rendered</li>
<li>Which flash error got produced</li>
<li>Which method got called</li>
</ul>
We also used stubbing and mocking functions to carry out our tests. After executing our tests we got an increase in the overall code coverage of over 0.5% for each file.
<br>
<br>
Here are the results of SimpleCov gem highlighting the code coverage of our tests.
<br>
[[File:Testplanyess.png]]
<br>

==Milestones==
'''10/25''' – Project Selection

'''10/26''' – Develop Project Design Document

==Project Mentors==
*Tirth Patel

==Team Members==
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
===E2157===
#[https://github.com/Natansh21/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/compare/beta...Natansh21:beta?expand=1 Pull Request]
#[http://152.46.16.30:8080 Deployed Expertiza Environment]
#[https://youtu.be/HLK_XaW_6dA Screencast video on YouTube]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

E2157. Fix issues related to deadlines and late policies

2021-11-01T17:02:56Z

Alunava: /* Problem Description */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing). The current implementation of this feature has issues

====Issues with the Current Implementation====
The current implementation of Expertiza has the following Issues:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

=== What needs to be done ===
We will resolve each of these issues in the following manner:
* To avoid confusion, use “late policy” exclusively.
* Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.
* Ensure that on click of the back button, the user is taken back to the assignment page.
* Expertiza has a way to adjust the dates on assignments. This is especially helpful when an assignment is copied from another and the dates get copied too. We need to ensure the "+" and "-" buttons update the dates accordingly.
* Add test cases for late_policy.rb and late_policies_controller.rb. This will further be discussed in the Test Plan section of the page.

==Approach & Fix==
<h4>Issue 1: Renaming penalty policy to late policy</h4>

<ul>
<li>Renaming done on the UI as well as on the backend</li>
<li>Varible names refactored appropritely</li>
<li>Flash messages changed accordingly</li>
</ul>

<h4>Issue 2: Late policies cannot be created without raising an error</h4>

<p>The error which is raised is due to the following validation present in the model late_policy.rb.
<br>
<h6>validates :max_penalty, numericality: {less_than: 50}</h6>
</p>

<ul>
<li>After discussing with professor we have decided to increase the max penalty limit to 100</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>
if params[:late_policy][:max_penalty].to_i>=100
flash[:error] = "Maximum penalty cannot be greater than or equal to 100"
invalid_max_penalty = true;
end

<h4>Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h4>

<ul>
<li>Added a back link in which redirects the user to edit assignment page.</li>
<li>Saved the assignment object in a session variable when the user clicks on the the edit asignment icon</li>
<li>We also added a back button on index page since there was no direct way of going back to edit assignment page once a late policy was created.</li>
<li>We also added padding between the edit and delete links on index page</li>
</ul>
<%= link_to 'Back', :controller=> 'assignments', :action => 'edit', :id => session[:assignment] %>

<h4>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h4>

<p>While testing this issue we noticed that the functionality was working perfectly fine, however, it was not user friendly.</p>
<ul>
<li>We decided to add a tooltip icon explaining how this functionality works</li>
<li>We also inproved its UI by adding the alignment and padding.</li>
</ul>

<h4>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h4>
<ul>
<li>Added test file late_policies_controller_spec.rb with appropriate test cases</li>
<li>Added test file late_policies_spec.rb with appropriate test cases
</ul>

<br>

==Expected Results==
Each Issue is described with the predicted fix and a screenshot showing the issue fixed.
<br>
<br>
* '''Issue 1''' - Once this issue is fixed, the Due Dates tab while editing an assignment will have no ambiguity between "late policy" and "penalty policy", as "late policy" will be used exclusively.
<br>
[[File:Hitissue11.png|650px]]
<br>
* '''Issue 2''' - Once this issue is fixed, late policies can be created and saved successfully without raising the "The following error occurred while saving the penalty policy:" error.
<br>
[[File:Hitissue2.png|650px]]
<br>
* '''Issue 3''' - Once this issue is fixed, the back link after creating a late policy will rightly take the user to the General tab on the Edit Assignment page.
<br>
[[File:Hitissue3.png|650px]]
<br>
* '''Issue 4''' - Once this issue is fixed, "+" and "-" buttons for Show/Hide Date Updater will work and update all the dates relative to the first date keeping the days gap between all the dates the same as before.
<br>
[[File:Hitissue4.png|650px]]
<br>
* '''Issue 5''' - The code coverage will definitely increase once tests for late_policy.rb and late_policies_controller.rb are written.
<br>
[[File:Hitissue5.png|650px]]
<br>

<br>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''Automated Testing Using RSpec'''

We plan to create two new files, late_policy_spec.rb and late_policies_controller_spec.rb to write tests for late_policy.rb and late_policies_controller.rb repesctively.

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

<br>
'''''Afterfix'''''
<br>

To test the controller 'late_policies_controller.rb' and model 'late_policy.rb' we created 2 test files late_policy_spec.rb and late_policies_controller_spec.rb. To write test cases we used rspec functions and tested the functions on the basis of :
<ul>
<li>What they returned</li>
<li>Which page got rendered</li>
<li>Which flash error got produced</li>
<li>Which method got called</li>
</ul>
We also used stubbing and mocking functions to carry out our tests. After executing our tests we got an increase in the overall code coverage of over 0.5% for each file.
<br>
<br>
Here are the results of SimpleCov gem highlighting the code coverage of our tests.
<br>
[[File:Testplanyess.png]]
<br>

==Milestones==
'''10/25''' – Project Selection

'''10/26''' – Develop Project Design Document

==Project Mentors==
*Tirth Patel

==Team Members==
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
===E2157===
#[https://github.com/Natansh21/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/compare/beta...Natansh21:beta?expand=1 Pull Request]
#[http://152.46.16.30:8080 Deployed Expertiza Environment]
#[https://youtu.be/HLK_XaW_6dA Screencast video on YouTube]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

E2157. Fix issues related to deadlines and late policies

2021-11-01T16:54:25Z

Alunava: /* Milestones */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing).

====Issues with the Current Implementation====
----
The current implementation of Expertiza has the following Issues:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

=== What needs to be done ===
We will resolve each of these issues in the following manner:
* To avoid confusion, use “late policy” exclusively.
* Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.
* Ensure that on click of the back button, the user is taken back to the assignment page.
* Expertiza has a way to adjust the dates on assignments. This is especially helpful when an assignment is copied from another and the dates get copied too. We need to ensure the "+" and "-" buttons update the dates accordingly.
* Add test cases for late_policy.rb and late_policies_controller.rb. This will further be discussed in the Test Plan section of the page.

==Approach & Fix==
<h4>Issue 1: Renaming penalty policy to late policy</h4>

<ul>
<li>Renaming done on the UI as well as on the backend</li>
<li>Varible names refactored appropritely</li>
<li>Flash messages changed accordingly</li>
</ul>

<h4>Issue 2: Late policies cannot be created without raising an error</h4>

<p>The error which is raised is due to the following validation present in the model late_policy.rb.
<br>
<h6>validates :max_penalty, numericality: {less_than: 50}</h6>
</p>

<ul>
<li>After discussing with professor we have decided to increase the max penalty limit to 100</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>
if params[:late_policy][:max_penalty].to_i>=100
flash[:error] = "Maximum penalty cannot be greater than or equal to 100"
invalid_max_penalty = true;
end

<h4>Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h4>

<ul>
<li>Added a back link in which redirects the user to edit assignment page.</li>
<li>Saved the assignment object in a session variable when the user clicks on the the edit asignment icon</li>
<li>We also added a back button on index page since there was no direct way of going back to edit assignment page once a late policy was created.</li>
<li>We also added padding between the edit and delete links on index page</li>
</ul>
<%= link_to 'Back', :controller=> 'assignments', :action => 'edit', :id => session[:assignment] %>

<h4>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h4>

<p>While testing this issue we noticed that the functionality was working perfectly fine, however, it was not user friendly.</p>
<ul>
<li>We decided to add a tooltip icon explaining how this functionality works</li>
<li>We also inproved its UI by adding the alignment and padding.</li>
</ul>

<h4>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h4>
<ul>
<li>Added test file late_policies_controller_spec.rb with appropriate test cases</li>
<li>Added test file late_policies_spec.rb with appropriate test cases
</ul>

<br>

==Expected Results==
Each Issue is described with the predicted fix and a screenshot showing the issue fixed.
<br>
<br>
* '''Issue 1''' - Once this issue is fixed, the Due Dates tab while editing an assignment will have no ambiguity between "late policy" and "penalty policy", as "late policy" will be used exclusively.
<br>
[[File:Hitissue11.png|650px]]
<br>
* '''Issue 2''' - Once this issue is fixed, late policies can be created and saved successfully without raising the "The following error occurred while saving the penalty policy:" error.
<br>
[[File:Hitissue2.png|650px]]
<br>
* '''Issue 3''' - Once this issue is fixed, the back link after creating a late policy will rightly take the user to the General tab on the Edit Assignment page.
<br>
[[File:Hitissue3.png|650px]]
<br>
* '''Issue 4''' - Once this issue is fixed, "+" and "-" buttons for Show/Hide Date Updater will work and update all the dates relative to the first date keeping the days gap between all the dates the same as before.
<br>
[[File:Hitissue4.png|650px]]
<br>
* '''Issue 5''' - The code coverage will definitely increase once tests for late_policy.rb and late_policies_controller.rb are written.
<br>
[[File:Hitissue5.png|650px]]
<br>

<br>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''Automated Testing Using RSpec'''

We plan to create two new files, late_policy_spec.rb and late_policies_controller_spec.rb to write tests for late_policy.rb and late_policies_controller.rb repesctively.

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

<br>
'''''Afterfix'''''
<br>

To test the controller 'late_policies_controller.rb' and model 'late_policy.rb' we created 2 test files late_policy_spec.rb and late_policies_controller_spec.rb. To write test cases we used rspec functions and tested the functions on the basis of :
<ul>
<li>What they returned</li>
<li>Which page got rendered</li>
<li>Which flash error got produced</li>
<li>Which method got called</li>
</ul>
We also used stubbing and mocking functions to carry out our tests. After executing our tests we got an increase in the overall code coverage of over 0.5% for each file.
<br>
<br>
Here are the results of SimpleCov gem highlighting the code coverage of our tests.
<br>
[[File:Testplanyess.png]]
<br>

==Milestones==
'''10/25''' – Project Selection

'''10/26''' – Develop Project Design Document

==Project Mentors==
*Tirth Patel

==Team Members==
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
===E2157===
#[https://github.com/Natansh21/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/compare/beta...Natansh21:beta?expand=1 Pull Request]
#[http://152.46.16.30:8080 Deployed Expertiza Environment]
#[https://youtu.be/HLK_XaW_6dA Screencast video on YouTube]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

E2157. Fix issues related to deadlines and late policies

2021-11-01T16:54:16Z

Alunava: /* Project Mentors */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing).

====Issues with the Current Implementation====
----
The current implementation of Expertiza has the following Issues:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

=== What needs to be done ===
We will resolve each of these issues in the following manner:
* To avoid confusion, use “late policy” exclusively.
* Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.
* Ensure that on click of the back button, the user is taken back to the assignment page.
* Expertiza has a way to adjust the dates on assignments. This is especially helpful when an assignment is copied from another and the dates get copied too. We need to ensure the "+" and "-" buttons update the dates accordingly.
* Add test cases for late_policy.rb and late_policies_controller.rb. This will further be discussed in the Test Plan section of the page.

==Approach & Fix==
<h4>Issue 1: Renaming penalty policy to late policy</h4>

<ul>
<li>Renaming done on the UI as well as on the backend</li>
<li>Varible names refactored appropritely</li>
<li>Flash messages changed accordingly</li>
</ul>

<h4>Issue 2: Late policies cannot be created without raising an error</h4>

<p>The error which is raised is due to the following validation present in the model late_policy.rb.
<br>
<h6>validates :max_penalty, numericality: {less_than: 50}</h6>
</p>

<ul>
<li>After discussing with professor we have decided to increase the max penalty limit to 100</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>
if params[:late_policy][:max_penalty].to_i>=100
flash[:error] = "Maximum penalty cannot be greater than or equal to 100"
invalid_max_penalty = true;
end

<h4>Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h4>

<ul>
<li>Added a back link in which redirects the user to edit assignment page.</li>
<li>Saved the assignment object in a session variable when the user clicks on the the edit asignment icon</li>
<li>We also added a back button on index page since there was no direct way of going back to edit assignment page once a late policy was created.</li>
<li>We also added padding between the edit and delete links on index page</li>
</ul>
<%= link_to 'Back', :controller=> 'assignments', :action => 'edit', :id => session[:assignment] %>

<h4>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h4>

<p>While testing this issue we noticed that the functionality was working perfectly fine, however, it was not user friendly.</p>
<ul>
<li>We decided to add a tooltip icon explaining how this functionality works</li>
<li>We also inproved its UI by adding the alignment and padding.</li>
</ul>

<h4>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h4>
<ul>
<li>Added test file late_policies_controller_spec.rb with appropriate test cases</li>
<li>Added test file late_policies_spec.rb with appropriate test cases
</ul>

<br>

==Expected Results==
Each Issue is described with the predicted fix and a screenshot showing the issue fixed.
<br>
<br>
* '''Issue 1''' - Once this issue is fixed, the Due Dates tab while editing an assignment will have no ambiguity between "late policy" and "penalty policy", as "late policy" will be used exclusively.
<br>
[[File:Hitissue11.png|650px]]
<br>
* '''Issue 2''' - Once this issue is fixed, late policies can be created and saved successfully without raising the "The following error occurred while saving the penalty policy:" error.
<br>
[[File:Hitissue2.png|650px]]
<br>
* '''Issue 3''' - Once this issue is fixed, the back link after creating a late policy will rightly take the user to the General tab on the Edit Assignment page.
<br>
[[File:Hitissue3.png|650px]]
<br>
* '''Issue 4''' - Once this issue is fixed, "+" and "-" buttons for Show/Hide Date Updater will work and update all the dates relative to the first date keeping the days gap between all the dates the same as before.
<br>
[[File:Hitissue4.png|650px]]
<br>
* '''Issue 5''' - The code coverage will definitely increase once tests for late_policy.rb and late_policies_controller.rb are written.
<br>
[[File:Hitissue5.png|650px]]
<br>

<br>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''Automated Testing Using RSpec'''

We plan to create two new files, late_policy_spec.rb and late_policies_controller_spec.rb to write tests for late_policy.rb and late_policies_controller.rb repesctively.

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

<br>
'''''Afterfix'''''
<br>

To test the controller 'late_policies_controller.rb' and model 'late_policy.rb' we created 2 test files late_policy_spec.rb and late_policies_controller_spec.rb. To write test cases we used rspec functions and tested the functions on the basis of :
<ul>
<li>What they returned</li>
<li>Which page got rendered</li>
<li>Which flash error got produced</li>
<li>Which method got called</li>
</ul>
We also used stubbing and mocking functions to carry out our tests. After executing our tests we got an increase in the overall code coverage of over 0.5% for each file.
<br>
<br>
Here are the results of SimpleCov gem highlighting the code coverage of our tests.
<br>
[[File:Testplanyess.png]]
<br>

==Milestones==
'''10/25''' – Project Selection

'''10/26''' – Develop Project Design Document

<br>

==Project Mentors==
*Tirth Patel

==Team Members==
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
===E2157===
#[https://github.com/Natansh21/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/compare/beta...Natansh21:beta?expand=1 Pull Request]
#[http://152.46.16.30:8080 Deployed Expertiza Environment]
#[https://youtu.be/HLK_XaW_6dA Screencast video on YouTube]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

E2157. Fix issues related to deadlines and late policies

2021-11-01T16:54:06Z

Alunava: /* Useful Links */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing).

====Issues with the Current Implementation====
----
The current implementation of Expertiza has the following Issues:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

=== What needs to be done ===
We will resolve each of these issues in the following manner:
* To avoid confusion, use “late policy” exclusively.
* Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.
* Ensure that on click of the back button, the user is taken back to the assignment page.
* Expertiza has a way to adjust the dates on assignments. This is especially helpful when an assignment is copied from another and the dates get copied too. We need to ensure the "+" and "-" buttons update the dates accordingly.
* Add test cases for late_policy.rb and late_policies_controller.rb. This will further be discussed in the Test Plan section of the page.

==Approach & Fix==
<h4>Issue 1: Renaming penalty policy to late policy</h4>

<ul>
<li>Renaming done on the UI as well as on the backend</li>
<li>Varible names refactored appropritely</li>
<li>Flash messages changed accordingly</li>
</ul>

<h4>Issue 2: Late policies cannot be created without raising an error</h4>

<p>The error which is raised is due to the following validation present in the model late_policy.rb.
<br>
<h6>validates :max_penalty, numericality: {less_than: 50}</h6>
</p>

<ul>
<li>After discussing with professor we have decided to increase the max penalty limit to 100</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>
if params[:late_policy][:max_penalty].to_i>=100
flash[:error] = "Maximum penalty cannot be greater than or equal to 100"
invalid_max_penalty = true;
end

<h4>Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h4>

<ul>
<li>Added a back link in which redirects the user to edit assignment page.</li>
<li>Saved the assignment object in a session variable when the user clicks on the the edit asignment icon</li>
<li>We also added a back button on index page since there was no direct way of going back to edit assignment page once a late policy was created.</li>
<li>We also added padding between the edit and delete links on index page</li>
</ul>
<%= link_to 'Back', :controller=> 'assignments', :action => 'edit', :id => session[:assignment] %>

<h4>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h4>

<p>While testing this issue we noticed that the functionality was working perfectly fine, however, it was not user friendly.</p>
<ul>
<li>We decided to add a tooltip icon explaining how this functionality works</li>
<li>We also inproved its UI by adding the alignment and padding.</li>
</ul>

<h4>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h4>
<ul>
<li>Added test file late_policies_controller_spec.rb with appropriate test cases</li>
<li>Added test file late_policies_spec.rb with appropriate test cases
</ul>

<br>

==Expected Results==
Each Issue is described with the predicted fix and a screenshot showing the issue fixed.
<br>
<br>
* '''Issue 1''' - Once this issue is fixed, the Due Dates tab while editing an assignment will have no ambiguity between "late policy" and "penalty policy", as "late policy" will be used exclusively.
<br>
[[File:Hitissue11.png|650px]]
<br>
* '''Issue 2''' - Once this issue is fixed, late policies can be created and saved successfully without raising the "The following error occurred while saving the penalty policy:" error.
<br>
[[File:Hitissue2.png|650px]]
<br>
* '''Issue 3''' - Once this issue is fixed, the back link after creating a late policy will rightly take the user to the General tab on the Edit Assignment page.
<br>
[[File:Hitissue3.png|650px]]
<br>
* '''Issue 4''' - Once this issue is fixed, "+" and "-" buttons for Show/Hide Date Updater will work and update all the dates relative to the first date keeping the days gap between all the dates the same as before.
<br>
[[File:Hitissue4.png|650px]]
<br>
* '''Issue 5''' - The code coverage will definitely increase once tests for late_policy.rb and late_policies_controller.rb are written.
<br>
[[File:Hitissue5.png|650px]]
<br>

<br>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''Automated Testing Using RSpec'''

We plan to create two new files, late_policy_spec.rb and late_policies_controller_spec.rb to write tests for late_policy.rb and late_policies_controller.rb repesctively.

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

<br>
'''''Afterfix'''''
<br>

To test the controller 'late_policies_controller.rb' and model 'late_policy.rb' we created 2 test files late_policy_spec.rb and late_policies_controller_spec.rb. To write test cases we used rspec functions and tested the functions on the basis of :
<ul>
<li>What they returned</li>
<li>Which page got rendered</li>
<li>Which flash error got produced</li>
<li>Which method got called</li>
</ul>
We also used stubbing and mocking functions to carry out our tests. After executing our tests we got an increase in the overall code coverage of over 0.5% for each file.
<br>
<br>
Here are the results of SimpleCov gem highlighting the code coverage of our tests.
<br>
[[File:Testplanyess.png]]
<br>

==Milestones==
'''10/25''' – Project Selection

'''10/26''' – Develop Project Design Document

<br>

==Project Mentors==
*Tirth Patel

<br>

==Team Members==
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
===E2157===
#[https://github.com/Natansh21/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/compare/beta...Natansh21:beta?expand=1 Pull Request]
#[http://152.46.16.30:8080 Deployed Expertiza Environment]
#[https://youtu.be/HLK_XaW_6dA Screencast video on YouTube]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

E2157. Fix issues related to deadlines and late policies

2021-11-01T16:53:50Z

Alunava: /* Team Members */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing).

====Issues with the Current Implementation====
----
The current implementation of Expertiza has the following Issues:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

=== What needs to be done ===
We will resolve each of these issues in the following manner:
* To avoid confusion, use “late policy” exclusively.
* Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.
* Ensure that on click of the back button, the user is taken back to the assignment page.
* Expertiza has a way to adjust the dates on assignments. This is especially helpful when an assignment is copied from another and the dates get copied too. We need to ensure the "+" and "-" buttons update the dates accordingly.
* Add test cases for late_policy.rb and late_policies_controller.rb. This will further be discussed in the Test Plan section of the page.

==Approach & Fix==
<h4>Issue 1: Renaming penalty policy to late policy</h4>

<ul>
<li>Renaming done on the UI as well as on the backend</li>
<li>Varible names refactored appropritely</li>
<li>Flash messages changed accordingly</li>
</ul>

<h4>Issue 2: Late policies cannot be created without raising an error</h4>

<p>The error which is raised is due to the following validation present in the model late_policy.rb.
<br>
<h6>validates :max_penalty, numericality: {less_than: 50}</h6>
</p>

<ul>
<li>After discussing with professor we have decided to increase the max penalty limit to 100</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>
if params[:late_policy][:max_penalty].to_i>=100
flash[:error] = "Maximum penalty cannot be greater than or equal to 100"
invalid_max_penalty = true;
end

<h4>Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h4>

<ul>
<li>Added a back link in which redirects the user to edit assignment page.</li>
<li>Saved the assignment object in a session variable when the user clicks on the the edit asignment icon</li>
<li>We also added a back button on index page since there was no direct way of going back to edit assignment page once a late policy was created.</li>
<li>We also added padding between the edit and delete links on index page</li>
</ul>
<%= link_to 'Back', :controller=> 'assignments', :action => 'edit', :id => session[:assignment] %>

<h4>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h4>

<p>While testing this issue we noticed that the functionality was working perfectly fine, however, it was not user friendly.</p>
<ul>
<li>We decided to add a tooltip icon explaining how this functionality works</li>
<li>We also inproved its UI by adding the alignment and padding.</li>
</ul>

<h4>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h4>
<ul>
<li>Added test file late_policies_controller_spec.rb with appropriate test cases</li>
<li>Added test file late_policies_spec.rb with appropriate test cases
</ul>

<br>

==Expected Results==
Each Issue is described with the predicted fix and a screenshot showing the issue fixed.
<br>
<br>
* '''Issue 1''' - Once this issue is fixed, the Due Dates tab while editing an assignment will have no ambiguity between "late policy" and "penalty policy", as "late policy" will be used exclusively.
<br>
[[File:Hitissue11.png|650px]]
<br>
* '''Issue 2''' - Once this issue is fixed, late policies can be created and saved successfully without raising the "The following error occurred while saving the penalty policy:" error.
<br>
[[File:Hitissue2.png|650px]]
<br>
* '''Issue 3''' - Once this issue is fixed, the back link after creating a late policy will rightly take the user to the General tab on the Edit Assignment page.
<br>
[[File:Hitissue3.png|650px]]
<br>
* '''Issue 4''' - Once this issue is fixed, "+" and "-" buttons for Show/Hide Date Updater will work and update all the dates relative to the first date keeping the days gap between all the dates the same as before.
<br>
[[File:Hitissue4.png|650px]]
<br>
* '''Issue 5''' - The code coverage will definitely increase once tests for late_policy.rb and late_policies_controller.rb are written.
<br>
[[File:Hitissue5.png|650px]]
<br>

<br>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''Automated Testing Using RSpec'''

We plan to create two new files, late_policy_spec.rb and late_policies_controller_spec.rb to write tests for late_policy.rb and late_policies_controller.rb repesctively.

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

<br>
'''''Afterfix'''''
<br>

To test the controller 'late_policies_controller.rb' and model 'late_policy.rb' we created 2 test files late_policy_spec.rb and late_policies_controller_spec.rb. To write test cases we used rspec functions and tested the functions on the basis of :
<ul>
<li>What they returned</li>
<li>Which page got rendered</li>
<li>Which flash error got produced</li>
<li>Which method got called</li>
</ul>
We also used stubbing and mocking functions to carry out our tests. After executing our tests we got an increase in the overall code coverage of over 0.5% for each file.
<br>
<br>
Here are the results of SimpleCov gem highlighting the code coverage of our tests.
<br>
[[File:Testplanyess.png]]
<br>

==Milestones==
'''10/25''' – Project Selection

'''10/26''' – Develop Project Design Document

<br>

==Project Mentors==
*Tirth Patel

<br>

==Team Members==
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
----
===E1978===
#[https://github.com/Natansh21/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/compare/beta...Natansh21:beta?expand=1 Pull Request]
#[http://152.46.16.30:8080 Deployed Expertiza Environment]
#[https://youtu.be/HLK_XaW_6dA Screencast video on YouTube]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

E2157. Fix issues related to deadlines and late policies

2021-11-01T16:53:39Z

Alunava: /* Milestones */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing).

====Issues with the Current Implementation====
----
The current implementation of Expertiza has the following Issues:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

=== What needs to be done ===
We will resolve each of these issues in the following manner:
* To avoid confusion, use “late policy” exclusively.
* Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.
* Ensure that on click of the back button, the user is taken back to the assignment page.
* Expertiza has a way to adjust the dates on assignments. This is especially helpful when an assignment is copied from another and the dates get copied too. We need to ensure the "+" and "-" buttons update the dates accordingly.
* Add test cases for late_policy.rb and late_policies_controller.rb. This will further be discussed in the Test Plan section of the page.

==Approach & Fix==
<h4>Issue 1: Renaming penalty policy to late policy</h4>

<ul>
<li>Renaming done on the UI as well as on the backend</li>
<li>Varible names refactored appropritely</li>
<li>Flash messages changed accordingly</li>
</ul>

<h4>Issue 2: Late policies cannot be created without raising an error</h4>

<p>The error which is raised is due to the following validation present in the model late_policy.rb.
<br>
<h6>validates :max_penalty, numericality: {less_than: 50}</h6>
</p>

<ul>
<li>After discussing with professor we have decided to increase the max penalty limit to 100</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>
if params[:late_policy][:max_penalty].to_i>=100
flash[:error] = "Maximum penalty cannot be greater than or equal to 100"
invalid_max_penalty = true;
end

<h4>Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h4>

<ul>
<li>Added a back link in which redirects the user to edit assignment page.</li>
<li>Saved the assignment object in a session variable when the user clicks on the the edit asignment icon</li>
<li>We also added a back button on index page since there was no direct way of going back to edit assignment page once a late policy was created.</li>
<li>We also added padding between the edit and delete links on index page</li>
</ul>
<%= link_to 'Back', :controller=> 'assignments', :action => 'edit', :id => session[:assignment] %>

<h4>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h4>

<p>While testing this issue we noticed that the functionality was working perfectly fine, however, it was not user friendly.</p>
<ul>
<li>We decided to add a tooltip icon explaining how this functionality works</li>
<li>We also inproved its UI by adding the alignment and padding.</li>
</ul>

<h4>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h4>
<ul>
<li>Added test file late_policies_controller_spec.rb with appropriate test cases</li>
<li>Added test file late_policies_spec.rb with appropriate test cases
</ul>

<br>

==Expected Results==
Each Issue is described with the predicted fix and a screenshot showing the issue fixed.
<br>
<br>
* '''Issue 1''' - Once this issue is fixed, the Due Dates tab while editing an assignment will have no ambiguity between "late policy" and "penalty policy", as "late policy" will be used exclusively.
<br>
[[File:Hitissue11.png|650px]]
<br>
* '''Issue 2''' - Once this issue is fixed, late policies can be created and saved successfully without raising the "The following error occurred while saving the penalty policy:" error.
<br>
[[File:Hitissue2.png|650px]]
<br>
* '''Issue 3''' - Once this issue is fixed, the back link after creating a late policy will rightly take the user to the General tab on the Edit Assignment page.
<br>
[[File:Hitissue3.png|650px]]
<br>
* '''Issue 4''' - Once this issue is fixed, "+" and "-" buttons for Show/Hide Date Updater will work and update all the dates relative to the first date keeping the days gap between all the dates the same as before.
<br>
[[File:Hitissue4.png|650px]]
<br>
* '''Issue 5''' - The code coverage will definitely increase once tests for late_policy.rb and late_policies_controller.rb are written.
<br>
[[File:Hitissue5.png|650px]]
<br>

<br>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''Automated Testing Using RSpec'''

We plan to create two new files, late_policy_spec.rb and late_policies_controller_spec.rb to write tests for late_policy.rb and late_policies_controller.rb repesctively.

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

<br>
'''''Afterfix'''''
<br>

To test the controller 'late_policies_controller.rb' and model 'late_policy.rb' we created 2 test files late_policy_spec.rb and late_policies_controller_spec.rb. To write test cases we used rspec functions and tested the functions on the basis of :
<ul>
<li>What they returned</li>
<li>Which page got rendered</li>
<li>Which flash error got produced</li>
<li>Which method got called</li>
</ul>
We also used stubbing and mocking functions to carry out our tests. After executing our tests we got an increase in the overall code coverage of over 0.5% for each file.
<br>
<br>
Here are the results of SimpleCov gem highlighting the code coverage of our tests.
<br>
[[File:Testplanyess.png]]
<br>

==Milestones==
'''10/25''' – Project Selection

'''10/26''' – Develop Project Design Document

<br>

==Project Mentors==
*Tirth Patel

<br>

==Team Members==
----
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
----
===E1978===
#[https://github.com/Natansh21/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/compare/beta...Natansh21:beta?expand=1 Pull Request]
#[http://152.46.16.30:8080 Deployed Expertiza Environment]
#[https://youtu.be/HLK_XaW_6dA Screencast video on YouTube]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

E2157. Fix issues related to deadlines and late policies

2021-11-01T16:45:02Z

Alunava: /* Expected Results */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing).

====Issues with the Current Implementation====
----
The current implementation of Expertiza has the following Issues:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

=== What needs to be done ===
We will resolve each of these issues in the following manner:
* To avoid confusion, use “late policy” exclusively.
* Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.
* Ensure that on click of the back button, the user is taken back to the assignment page.
* Expertiza has a way to adjust the dates on assignments. This is especially helpful when an assignment is copied from another and the dates get copied too. We need to ensure the "+" and "-" buttons update the dates accordingly.
* Add test cases for late_policy.rb and late_policies_controller.rb. This will further be discussed in the Test Plan section of the page.

==Approach & Fix==
<h4>Issue 1: Renaming penalty policy to late policy</h4>

<ul>
<li>Renaming done on the UI as well as on the backend</li>
<li>Varible names refactored appropritely</li>
<li>Flash messages changed accordingly</li>
</ul>

<h4>Issue 2: Late policies cannot be created without raising an error</h4>

<p>The error which is raised is due to the following validation present in the model late_policy.rb.
<br>
<h6>validates :max_penalty, numericality: {less_than: 50}</h6>
</p>

<ul>
<li>After discussing with professor we have decided to increase the max penalty limit to 100</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>
if params[:late_policy][:max_penalty].to_i>=100
flash[:error] = "Maximum penalty cannot be greater than or equal to 100"
invalid_max_penalty = true;
end

<h4>Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h4>

<ul>
<li>Added a back link in which redirects the user to edit assignment page.</li>
<li>Saved the assignment object in a session variable when the user clicks on the the edit asignment icon</li>
<li>We also added a back button on index page since there was no direct way of going back to edit assignment page once a late policy was created.</li>
<li>We also added padding between the edit and delete links on index page</li>
</ul>
<%= link_to 'Back', :controller=> 'assignments', :action => 'edit', :id => session[:assignment] %>

<h4>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h4>

<p>While testing this issue we noticed that the functionality was working perfectly fine, however, it was not user friendly.</p>
<ul>
<li>We decided to add a tooltip icon explaining how this functionality works</li>
<li>We also inproved its UI by adding the alignment and padding.</li>
</ul>

<h4>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h4>
<ul>
<li>Added test file late_policies_controller_spec.rb with appropriate test cases</li>
<li>Added test file late_policies_spec.rb with appropriate test cases
</ul>

<br>

==Expected Results==
Each Issue is described with the predicted fix and a screenshot showing the issue fixed.
<br>
<br>
* '''Issue 1''' - Once this issue is fixed, the Due Dates tab while editing an assignment will have no ambiguity between "late policy" and "penalty policy", as "late policy" will be used exclusively.
<br>
[[File:Hitissue11.png|650px]]
<br>
* '''Issue 2''' - Once this issue is fixed, late policies can be created and saved successfully without raising the "The following error occurred while saving the penalty policy:" error.
<br>
[[File:Hitissue2.png|650px]]
<br>
* '''Issue 3''' - Once this issue is fixed, the back link after creating a late policy will rightly take the user to the General tab on the Edit Assignment page.
<br>
[[File:Hitissue3.png|650px]]
<br>
* '''Issue 4''' - Once this issue is fixed, "+" and "-" buttons for Show/Hide Date Updater will work and update all the dates relative to the first date keeping the days gap between all the dates the same as before.
<br>
[[File:Hitissue4.png|650px]]
<br>
* '''Issue 5''' - The code coverage will definitely increase once tests for late_policy.rb and late_policies_controller.rb are written.
<br>
[[File:Hitissue5.png|650px]]
<br>

<br>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''Automated Testing Using RSpec'''

We plan to create two new files, late_policy_spec.rb and late_policies_controller_spec.rb to write tests for late_policy.rb and late_policies_controller.rb repesctively.

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

<br>
'''''Afterfix'''''
<br>

To test the controller 'late_policies_controller.rb' and model 'late_policy.rb' we created 2 test files late_policy_spec.rb and late_policies_controller_spec.rb. To write test cases we used rspec functions and tested the functions on the basis of :
<ul>
<li>What they returned</li>
<li>Which page got rendered</li>
<li>Which flash error got produced</li>
<li>Which method got called</li>
</ul>
We also used stubbing and mocking functions to carry out our tests. After executing our tests we got an increase in the overall code coverage of over 0.5% for each file.
<br>
<br>
Here are the results of SimpleCov gem highlighting the code coverage of our tests.
<br>
[[File:Testplanyess.png]]
<br>

==Milestones==
'''11/01''' – Project Selection

'''11/11''' – Create Design Doc

'''11/15''' – setting up project environment and updating Design Doc

'''11/25''' – Fix Issues 1,2 and 3 with well-defined test cases

'''11/30''' – Fix issues 4 and 5 with well-defined test cases

'''12/04''' – Update design doc and create & upload video

'''12/06''' – Write tests for edge cases.

<br>

==Project Mentors==
*Tirth Patel

<br>

==Team Members==
----
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
----
===E1978===
#[https://github.com/Natansh21/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/compare/beta...Natansh21:beta?expand=1 Pull Request]
#[http://152.46.16.30:8080 Deployed Expertiza Environment]
#[https://youtu.be/HLK_XaW_6dA Screencast video on YouTube]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

E2157. Fix issues related to deadlines and late policies

2021-11-01T16:44:47Z

Alunava: /* Approach & Fix */

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing).

====Issues with the Current Implementation====
----
The current implementation of Expertiza has the following Issues:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

=== What needs to be done ===
We will resolve each of these issues in the following manner:
* To avoid confusion, use “late policy” exclusively.
* Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.
* Ensure that on click of the back button, the user is taken back to the assignment page.
* Expertiza has a way to adjust the dates on assignments. This is especially helpful when an assignment is copied from another and the dates get copied too. We need to ensure the "+" and "-" buttons update the dates accordingly.
* Add test cases for late_policy.rb and late_policies_controller.rb. This will further be discussed in the Test Plan section of the page.

==Approach & Fix==
<h4>Issue 1: Renaming penalty policy to late policy</h4>

<ul>
<li>Renaming done on the UI as well as on the backend</li>
<li>Varible names refactored appropritely</li>
<li>Flash messages changed accordingly</li>
</ul>

<h4>Issue 2: Late policies cannot be created without raising an error</h4>

<p>The error which is raised is due to the following validation present in the model late_policy.rb.
<br>
<h6>validates :max_penalty, numericality: {less_than: 50}</h6>
</p>

<ul>
<li>After discussing with professor we have decided to increase the max penalty limit to 100</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>
if params[:late_policy][:max_penalty].to_i>=100
flash[:error] = "Maximum penalty cannot be greater than or equal to 100"
invalid_max_penalty = true;
end

<h4>Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h4>

<ul>
<li>Added a back link in which redirects the user to edit assignment page.</li>
<li>Saved the assignment object in a session variable when the user clicks on the the edit asignment icon</li>
<li>We also added a back button on index page since there was no direct way of going back to edit assignment page once a late policy was created.</li>
<li>We also added padding between the edit and delete links on index page</li>
</ul>
<%= link_to 'Back', :controller=> 'assignments', :action => 'edit', :id => session[:assignment] %>

<h4>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h4>

<p>While testing this issue we noticed that the functionality was working perfectly fine, however, it was not user friendly.</p>
<ul>
<li>We decided to add a tooltip icon explaining how this functionality works</li>
<li>We also inproved its UI by adding the alignment and padding.</li>
</ul>

<h4>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h4>
<ul>
<li>Added test file late_policies_controller_spec.rb with appropriate test cases</li>
<li>Added test file late_policies_spec.rb with appropriate test cases
</ul>

<br>

==Expected Results==
----
Each Issue is described with the predicted fix and a screenshot showing the issue fixed.
<br>
<br>
* '''Issue 1''' - Once this issue is fixed, the Due Dates tab while editing an assignment will have no ambiguity between "late policy" and "penalty policy", as "late policy" will be used exclusively.
<br>
[[File:Hitissue11.png|650px]]
<br>
* '''Issue 2''' - Once this issue is fixed, late policies can be created and saved successfully without raising the "The following error occurred while saving the penalty policy:" error.
<br>
[[File:Hitissue2.png|650px]]
<br>
* '''Issue 3''' - Once this issue is fixed, the back link after creating a late policy will rightly take the user to the General tab on the Edit Assignment page.
<br>
[[File:Hitissue3.png|650px]]
<br>
* '''Issue 4''' - Once this issue is fixed, "+" and "-" buttons for Show/Hide Date Updater will work and update all the dates relative to the first date keeping the days gap between all the dates the same as before.
<br>
[[File:Hitissue4.png|650px]]
<br>
* '''Issue 5''' - The code coverage will definitely increase once tests for late_policy.rb and late_policies_controller.rb are written.
<br>
[[File:Hitissue5.png|650px]]
<br>

<br>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''Automated Testing Using RSpec'''

We plan to create two new files, late_policy_spec.rb and late_policies_controller_spec.rb to write tests for late_policy.rb and late_policies_controller.rb repesctively.

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

<br>
'''''Afterfix'''''
<br>

To test the controller 'late_policies_controller.rb' and model 'late_policy.rb' we created 2 test files late_policy_spec.rb and late_policies_controller_spec.rb. To write test cases we used rspec functions and tested the functions on the basis of :
<ul>
<li>What they returned</li>
<li>Which page got rendered</li>
<li>Which flash error got produced</li>
<li>Which method got called</li>
</ul>
We also used stubbing and mocking functions to carry out our tests. After executing our tests we got an increase in the overall code coverage of over 0.5% for each file.
<br>
<br>
Here are the results of SimpleCov gem highlighting the code coverage of our tests.
<br>
[[File:Testplanyess.png]]
<br>
==Milestones==
'''11/01''' – Project Selection

'''11/11''' – Create Design Doc

'''11/15''' – setting up project environment and updating Design Doc

'''11/25''' – Fix Issues 1,2 and 3 with well-defined test cases

'''11/30''' – Fix issues 4 and 5 with well-defined test cases

'''12/04''' – Update design doc and create & upload video

'''12/06''' – Write tests for edge cases.

<br>

==Project Mentors==
*Tirth Patel

<br>

==Team Members==
----
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
----
===E1978===
#[https://github.com/Natansh21/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/compare/beta...Natansh21:beta?expand=1 Pull Request]
#[http://152.46.16.30:8080 Deployed Expertiza Environment]
#[https://youtu.be/HLK_XaW_6dA Screencast video on YouTube]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

E2157. Fix issues related to deadlines and late policies

2021-11-01T16:43:50Z

Alunava:

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing).

====Issues with the Current Implementation====
----
The current implementation of Expertiza has the following Issues:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png|650px]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png|650px]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png|650px]]

[[File:Qissue32.png|650px]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png|650px]]

[[File:Issue42.png|650px]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

=== What needs to be done ===
We will resolve each of these issues in the following manner:
* To avoid confusion, use “late policy” exclusively.
* Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.
* Ensure that on click of the back button, the user is taken back to the assignment page.
* Expertiza has a way to adjust the dates on assignments. This is especially helpful when an assignment is copied from another and the dates get copied too. We need to ensure the "+" and "-" buttons update the dates accordingly.
* Add test cases for late_policy.rb and late_policies_controller.rb. This will further be discussed in the Test Plan section of the page.

==Approach & Fix==

----
<h4>Issue 1: Renaming penalty policy to late policy</h4>

<ul>
<li>Renaming done on the UI as well as on the backend</li>
<li>Varible names refactored appropritely</li>
<li>Flash messages changed accordingly</li>
</ul>

<h4>Issue 2: Late policies cannot be created without raising an error</h4>

<p>The error which is raised is due to the following validation present in the model late_policy.rb.
<br>
<h6>validates :max_penalty, numericality: {less_than: 50}</h6>
</p>

<ul>
<li>After discussing with professor we have decided to increase the max penalty limit to 100</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>
if params[:late_policy][:max_penalty].to_i>=100
flash[:error] = "Maximum penalty cannot be greater than or equal to 100"
invalid_max_penalty = true;
end

<h4>Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h4>

<ul>
<li>Added a back link in which redirects the user to edit assignment page.</li>
<li>Saved the assignment object in a session variable when the user clicks on the the edit asignment icon</li>
<li>We also added a back button on index page since there was no direct way of going back to edit assignment page once a late policy was created.</li>
<li>We also added padding between the edit and delete links on index page</li>
</ul>
<%= link_to 'Back', :controller=> 'assignments', :action => 'edit', :id => session[:assignment] %>

<h4>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h4>

<p>While testing this issue we noticed that the functionality was working perfectly fine, however, it was not user friendly.</p>
<ul>
<li>We decided to add a tooltip icon explaining how this functionality works</li>
<li>We also inproved its UI by adding the alignment and padding.</li>
</ul>

<h4>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h4>
<ul>
<li>Added test file late_policies_controller_spec.rb with appropriate test cases</li>
<li>Added test file late_policies_spec.rb with appropriate test cases
</ul>

<br>

==Expected Results==
----
Each Issue is described with the predicted fix and a screenshot showing the issue fixed.
<br>
<br>
* '''Issue 1''' - Once this issue is fixed, the Due Dates tab while editing an assignment will have no ambiguity between "late policy" and "penalty policy", as "late policy" will be used exclusively.
<br>
[[File:Hitissue11.png|650px]]
<br>
* '''Issue 2''' - Once this issue is fixed, late policies can be created and saved successfully without raising the "The following error occurred while saving the penalty policy:" error.
<br>
[[File:Hitissue2.png|650px]]
<br>
* '''Issue 3''' - Once this issue is fixed, the back link after creating a late policy will rightly take the user to the General tab on the Edit Assignment page.
<br>
[[File:Hitissue3.png|650px]]
<br>
* '''Issue 4''' - Once this issue is fixed, "+" and "-" buttons for Show/Hide Date Updater will work and update all the dates relative to the first date keeping the days gap between all the dates the same as before.
<br>
[[File:Hitissue4.png|650px]]
<br>
* '''Issue 5''' - The code coverage will definitely increase once tests for late_policy.rb and late_policies_controller.rb are written.
<br>
[[File:Hitissue5.png|650px]]
<br>

<br>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''Automated Testing Using RSpec'''

We plan to create two new files, late_policy_spec.rb and late_policies_controller_spec.rb to write tests for late_policy.rb and late_policies_controller.rb repesctively.

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

<br>
'''''Afterfix'''''
<br>

To test the controller 'late_policies_controller.rb' and model 'late_policy.rb' we created 2 test files late_policy_spec.rb and late_policies_controller_spec.rb. To write test cases we used rspec functions and tested the functions on the basis of :
<ul>
<li>What they returned</li>
<li>Which page got rendered</li>
<li>Which flash error got produced</li>
<li>Which method got called</li>
</ul>
We also used stubbing and mocking functions to carry out our tests. After executing our tests we got an increase in the overall code coverage of over 0.5% for each file.
<br>
<br>
Here are the results of SimpleCov gem highlighting the code coverage of our tests.
<br>
[[File:Testplanyess.png]]
<br>
==Milestones==
'''11/01''' – Project Selection

'''11/11''' – Create Design Doc

'''11/15''' – setting up project environment and updating Design Doc

'''11/25''' – Fix Issues 1,2 and 3 with well-defined test cases

'''11/30''' – Fix issues 4 and 5 with well-defined test cases

'''12/04''' – Update design doc and create & upload video

'''12/06''' – Write tests for edge cases.

<br>

==Project Mentors==
*Tirth Patel

<br>

==Team Members==
----
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
----
===E1978===
#[https://github.com/Natansh21/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/compare/beta...Natansh21:beta?expand=1 Pull Request]
#[http://152.46.16.30:8080 Deployed Expertiza Environment]
#[https://youtu.be/HLK_XaW_6dA Screencast video on YouTube]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

E2157. Fix issues related to deadlines and late policies

2021-10-31T15:50:30Z

Alunava:

__TOC__

==Problem Description==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing).

====Issues with the Current Implementation====
----
The current implementation of Expertiza has the following Issues:
* '''Issue 1''' - In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.

[[File:Qissue1.png]]

* '''Issue 2''' - Late policies cannot be created without raising an error.

[[File:Qissue2.png]]

* '''Issue 3''' - After creating a late policy, the “back” link does not take the user back to editing the assignment.

[[File:Qissue31.png]]

[[File:Qissue32.png]]

* '''Issue 4''' - The "+" and "-" buttons for Show/Hide Date Updater do not work.

[[File:Issue41.png]]

[[File:Issue42.png]]

* '''Issue 5''' - Neither late_policy.rb nor late_policies_controller.rb have any tests at all.

=== What needs to be done ===
We will resolve each of these issues in the following manner:
* To avoid confusion, use “late policy” exclusively.
* Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.
* Ensure that on click of the back button, the user is taken back to the assignment page.
* Expertiza has a way to adjust the dates on assignments. This is especially helpful when an assignment is copied from another and the dates get copied too. We need to ensure the "+" and "-" buttons update the dates accordingly.
* Add test cases for late_policy.rb and late_policies_controller.rb. This will further be discussed in the Test Plan section of the page.

==Approach & Fix==

----
<h4>Issue 1: Renaming penalty policy to late policy</h4>

<ul>
<li>Renaming done on the UI as well as on the backend</li>
<li>Varible names refactored appropritely</li>
<li>Flash messages changed accordingly</li>
</ul>

<h4>Issue 2: Late policies cannot be created without raising an error</h4>

<p>The error which is raised is due to the following validation present in the model late_policy.rb.
<br>
<h6>validates :max_penalty, numericality: {less_than: 50}</h6>
</p>

<ul>
<li>After discussing with professor we have decided to increase the max penalty limit to 100</li>
<li>Added a flash error message in the create function of late_policies_controller.rb</li>
</ul>
if params[:late_policy][:max_penalty].to_i>=100
flash[:error] = "Maximum penalty cannot be greater than or equal to 100"
invalid_max_penalty = true;
end

<h4>Issue 3: After creating a late policy, the “back” link does not take the user back to editing the assignment.</h4>

<ul>
<li>Added a back link in which redirects the user to edit assignment page.</li>
<li>Saved the assignment object in a session variable when the user clicks on the the edit asignment icon</li>
<li>We also added a back button on index page since there was no direct way of going back to edit assignment page once a late policy was created.</li>
<li>We also added padding between the edit and delete links on index page</li>
</ul>
<%= link_to 'Back', :controller=> 'assignments', :action => 'edit', :id => session[:assignment] %>

<h4>Issue 4: The "+" and "-" buttons for Show/Hide Date Updater do not work.</h4>

<p>While testing this issue we noticed that the functionality was working perfectly fine, however, it was not user friendly.</p>
<ul>
<li>We decided to add a tooltip icon explaining how this functionality works</li>
<li>We also inproved its UI by adding the alignment and padding.</li>
</ul>

<h4>Issue 5: Neither late_policy.rb nor late_policies_controller.rb have any tests at all. Define a test plan, and write appropriate tests for these classes.</h4>
<ul>
<li>Added test file late_policies_controller_spec.rb with appropriate test cases</li>
<li>Added test file late_policies_spec.rb with appropriate test cases
</ul>

<br>

==Expected Results==
----
Each Issue is described with the predicted fix and a screenshot showing the issue fixed.
<br>
<br>
* '''Issue 1''' - Once this issue is fixed, the Due Dates tab while editing an assignment will have no ambiguity between "late policy" and "penalty policy", as "late policy" will be used exclusively.
<br>
[[File:Hitissue11.png]]
<br>
* '''Issue 2''' - Once this issue is fixed, late policies can be created and saved successfully without raising the "The following error occurred while saving the penalty policy:" error.
<br>
[[File:Hitissue2.png]]
<br>
* '''Issue 3''' - Once this issue is fixed, the back link after creating a late policy will rightly take the user to the General tab on the Edit Assignment page.
<br>
[[File:Hitissue3.png]]
<br>
* '''Issue 4''' - Once this issue is fixed, "+" and "-" buttons for Show/Hide Date Updater will work and update all the dates relative to the first date keeping the days gap between all the dates the same as before.
<br>
[[File:Hitissue4.png]]
<br>
* '''Issue 5''' - The code coverage will definitely increase once tests for late_policy.rb and late_policies_controller.rb are written.
<br>
[[File:Hitissue5.png]]
<br>

<br>

===Test Plan===
----
'''''Before fix'''''
<br>
<br>
'''Manual Testing ()'''

Log in to Expertiza as an Instructor by entering the credentials: Username: instructor6, Password: password

The following route is common to testing all the issues:

Welcome page -> Manage Assignments -> Select a Course -> Select Edit option for any assignment -> Edit Assignment (General) ->

'''Issue 1''' - <pre> Due Dates -> No 'penalty policy' on the page. </pre>

'''Issue 2''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Late policy is successfully created and saved. </pre>

'''Issue 3''' - <pre> Due Dates -> New late policy -> Enter information and Create -> Back -> Edit Assignment (General) </pre>

'''Issue 4''' - <pre> Due Dates -> Show/Hide Date Updater -> Enter number of days -> Hit + / - </pre>

'''Automated Testing Using RSpec'''

We plan to create two new files, late_policy_spec.rb and late_policies_controller_spec.rb to write tests for late_policy.rb and late_policies_controller.rb repesctively.

'''Coverage'''

To make sure we are covering all of our code with test cases we will use the Ruby Code Coverage plugin of RubyMine and SimpleCov gem. After manually running the test file, the SimpleCov gem will highlight the lines of code which are being covered by our test cases in green color, and for those which are not being covered in red.

<br>
'''''Afterfix'''''
<br>

To test the controller 'late_policies_controller.rb' and model 'late_policy.rb' we created 2 test files late_policy_spec.rb and late_policies_controller_spec.rb. To write test cases we used rspec functions and tested the functions on the basis of :
<ul>
<li>What they returned</li>
<li>Which page got rendered</li>
<li>Which flash error got produced</li>
<li>Which method got called</li>
</ul>
We also used stubbing and mocking functions to carry out our tests. After executing our tests we got an increase in the overall code coverage of over 0.5% for each file.
<br>
<br>
Here are the results of SimpleCov gem highlighting the code coverage of our tests.
<br>
[[File:Testplanyess.png]]
<br>
==Milestones==
'''11/01''' – Project Selection

'''11/11''' – Create Design Doc

'''11/15''' – setting up project environment and updating Design Doc

'''11/25''' – Fix Issues 1,2 and 3 with well-defined test cases

'''11/30''' – Fix issues 4 and 5 with well-defined test cases

'''12/04''' – Update design doc and create & upload video

'''12/06''' – Write tests for edge cases.

<br>

==Project Mentors==

<br>

==Team Members==
----
* Anmol Lunavat

* Shubham Waghe

* Vishal Sharma

==Useful Links==
----
===E1978===
#[https://github.com/Natansh21/expertiza/tree/beta GitHub forked repository]
#[https://github.com/expertiza/expertiza/compare/beta...Natansh21:beta?expand=1 Pull Request]
#[http://152.46.16.30:8080 Deployed Expertiza Environment]
#[https://youtu.be/HLK_XaW_6dA Screencast video on YouTube]

===Expertiza===
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[http://expertiza.ncsu.edu/ Live Expertiza website]

E2157. Fix issues related to deadlines and late policies

2021-10-31T15:34:26Z

Alunava:

__TOC__
=== Team Members ===
* Anmol Lunavat
* Shubham Waghe
* Vishal Sharma

== Video walk through ==
A link to the video on completion of the project will be added here

== Problem Statement ==
Expertiza can automatically deduct points if a student is late in performing some action (e.g., submitting or reviewing). This is implemented by defining a new “late policy” and applying it to the assignment. Late policies are managed on the Due dates tab of assignment creation (or editing):

[[File:Late_policy.PNG]]

There are a few bugs in the current implementation and a few checks missing. The aim of this project is to resolve known bugs and ensure seamless functionality.
== The Plan ==
The project mainly deals with fixing known bugs in the functionality and UI. At the end of the project, the following should be resolved:
* In the UI, the policy is sometimes called a “late policy” and sometimes a “penalty policy”.
* Late policies cannot be created without raising an error.
* After creating a late policy, the “back” link does not take the user back to editing the assignment.
* The "+" and "-" buttons for Show/Hide Date Updater do not work.
* Missing test cases for late_policy.rb and late_policies_controller.rb.
=== What needs to be done ===
We will resolve each of these issues in the following manner:
* To avoid confusion, use “late policy” exclusively.
* Ensure that all errors being raised are fixed. This will be achieved by modifying existing code and bringing new checks as and when required.
* Ensure that on click of the back button, the user is taken back to the assignment page.
* Expertiza has a way to adjust the dates on assignments. This is especially helpful when an assignment is copied from another and the dates get copied too. We need to ensure the "+" and "-" buttons update the dates accordingly.
* Add test cases for late_policy.rb and late_policies_controller.rb. This will further be discussed in the Test Plan section of the page.

== Workflow Diagram ==
The main workflow of the mentor management for assignments without topics is outline below.
[[File:Mentor management.png|thumb|center|border|520px|]]

== Logic Design ==
The following main logic components are described below. Each block of logic is to be independent from one another, in order to avoid DRY and de-couple code responsibility.
===='''selectMentor()'''====
In order to assign a mentor to a group, we must first choose a mentor wisely in the system. The requirements document suggests "Mentors should be evenly assigned to teams, so a good strategy is to assign the mentor who has the fewest teams to mentor so far." This can be implemented using a min-heap-based priority queue, where a mentor's priority is the count of the number of teams to which they're assigned.

===='''updateMentorStates()'''====
The responsibility of this function will be to check if the team satisfy the conditions for the auto assign of mentor. This method will utilize the selectMentor() if the conditions are met. It will use the existing methods in the Team.rb that coded by expertiza team to add the mentor.
===='''notifyTeam()'''====
This is going to be a simple function that takes care of sending an email to a) the mentor, and b) the project teammates to:
# Notify the team they have been assigned a mentor and pass along their contact information
# Pass along the contact information for the team members to the mentor

== UI Design ==
A simplistic UI design approach is to be implemented. Below is a mock rendering of the new information that will appear on the <code>student_teams/view?student_id=</code> expertiza page. The value will be only present if the mentor has been automatically assigned.
[[File:Team student view.png|thumb|center|520px|]]

The instructor view will also need to have visibility of what mentors the teams have. Below is a mock rendering of the new information that will appear on the <code>/teams/list?type=Course&id=</code> expertiza page. The role column will be added.
[[File:Team admin view.png|thumb|center|520px|]]

== Code Modifications ==
=== Controllers ===
==== Files ====
# [https://github.com/expertiza/expertiza/pull/1957/files?file-filters%5B%5D=#diff-88d9bf9a58c1b9896848beeb69f9eb362428ad6f8f5999ca3dd78e2b2f7bb28e app/controllers/teams_users_controller.rb]
==== Code Snippets ====
[[File:teams_user_controller.png|thumb|center|520px|]]
==== Explanation ====
This code will Kick off the Mentor Management workflow from the perspective of the instructor when adding members. This is not supported for CourseTeams which is why the other half of this if block does not include the same code. This code can be further enhanced by consolidating where members get added to a single place.

=== Models ===
==== Files and Code Snippets ====
# [https://github.com/expertiza/expertiza/pull/1957/files?file-filters%5B%5D=#diff-45779566bc2430be219713f18b2aad5dfea8b24708eeab7d8436787ec2e422a8 app/models/participant.rb] [[File:participate.png|thumb|center|520px|]]
# [https://github.com/expertiza/expertiza/pull/1957/files?file-filters%5B%5D=#diff-f75b174cbda975a5b5b98509b36d2ee7619ce19ea5b9b2f439f4ef159cc46c1a app/models/mentor_management.rb] [[File:part1.png|thumb|center|520px|]] [[File:part2.png|thumb|center|520px|]]
# [https://github.com/expertiza/expertiza/pull/1957/files?file-filters%5B%5D=#diff-dfe026d6f5d01abbea59eaf5f3935355410368e3522f27ca9092ad626675d04b app/models/assignment_form.rb] [[File:assignment_form.png|thumb|center|520px|]]
# [https://github.com/expertiza/expertiza/pull/1957/files?file-filters%5B%5D=#diff-c899291de1875b0c2483c0f132ed4503e6c33be63148d6e5d1f4235bfeb1c331 app/models/invitation.rb] [[File:invitation.png|thumb|center|520px|]]

==== Explanation ====
===== participant.rb =====
A string constant called DUTY_MENTOR was added to the Participant model, since the duty column of the participants table was used to hold this title. The constant name is prefixed with DUTY_ in the event that other duty titles are added in the future.

===== mentor_management.rb =====
Lastly the mentor management class is the main logic for the feature. This class essentially implements the Singleton pattern, but rather than using the <code>Singleton</code> module it is just a set of class methods.

====== #select_mentor ======
The select mentor method selects a mentor using the following algorithm:
# Find all assignment participants for the assignment with id [assignment_id] whose duty is the same as [Particpant#DUTY_MENTOR].
# Count the number of teams those participants are a part of, acting as a proxy for the number of teams they mentor.
# Return the mentor with the fewest number of teams they're currently mentoring.,This method's runtime is O(n lg n) due to the call to, Hash sort_by. This assertion assumes that the database management system is capable of fetching the required rows at least as quickly.

====== #assign_mentor ======
The auto_assign_mentor method is the main entrypoint in to the mentor management workflow.

In Expertiza, team members can be added in two ways:
# A user accepts an invitation to join a team
# A user with high enough privileges (e.g. an instructor) manually adds a user to a team

These two events happen in two different places in the code: invitation.rb and teams_controller.rb respectively. In both cases, assign_mentor is called.

The following preconditions must be met for a mentor to be added to a team:
* The assignment must have the auto_assign_mentor flag enabled (i.e. set to <code>true</code>)
* Neither the assignment nor the team can have topics assigned to them
* The newly added team member must increase the team size to strictly greater than 50% of the maximum team capacity for the assignment
* The team cannot already have a mentor assigned to the team

If these conditions are met, assign_mentor calls #select_mentor to choose a mentor from the pool of mentors, and then assigns them to the team. If this is successful then a notification email is sent out to all current team members, and the new mentor at the same time so everyone knows how to contact everyone else.

===== assignment_form.rb =====
The assignment form needed a new :auto_assign_mentor flag added to its model. This will allow for the auto assign mentor feature to be disabled if the instructor does not want the work flow executed for the assignment.

===== invitation.rb =====
One trigger had to be added to invitation.rb so when users accept invitations to join a team the mentor management logic can execute.

=== Views ===
==== Files and Code Snippets ====
# [https://github.com/expertiza/expertiza/pull/1957/files?file-filters%5B%5D=#diff-25229b4f0807107f2f4289bcbfff7bfe4028fb0aada5896dd147e9f703f52758 app/views/assignments/edit/_general.html.erb] [[File:general.png|thumb|center|520px|]]
# [https://github.com/expertiza/expertiza/pull/1957/files?file-filters%5B%5D=#diff-4ba1a3986521a5504ac067e8200851895115a0b30f4d8a31514d2221d4c0d8b2 app/views/student_teams/view.html.erb] [[File:view_html.png|thumb|center|520px|]]
# [https://github.com/expertiza/expertiza/pull/1957/files?file-filters%5B%5D=#diff-03c8e92504f472a4b2e3775e571fb395a4cebf408f130d21a619a83b7183d873 app/models/teams_user.rb] [[File:team_user.png|thumb|center|520px|]]

==== Explanation ====
Two views were updated in the Expertiza application to allow the user to see who the mentor is on their team. The Expertiza application makes use of plenty of view partials to compose the UI. We tried to find the least intrusive place among the pile of view partials where we could add a new column for displaying the duty title for mentors. This also had to be done in two places, since the instructor view of a team is different than the student's view of the same team. For the former, teams_user.rb was updated to append <code>(Mentor)</code> to a user's name in the view.

=== Database ===
==== Files ====
# [https://github.com/expertiza/expertiza/pull/1957/files?file-filters%5B%5D=#diff-20561383413b93d6001df218448415d212cb5161253bbfc8f172da6bbf12d4b8 db/migrate/20210422185445_add_auto_assign_mentor_column.rb]
# [https://github.com/expertiza/expertiza/pull/1957/files?file-filters%5B%5D=#diff-cbf8b25d6d853acf58fa9057841f407d29ffe90649c75cf9e3f51b2d6e3aa1d3 db/schema.rb]
==== Code Snippets ====
[[File:add_auto_assign_mentor.png|thumb|center|520px|]]
==== Explanation ====
Our team tried to avoid any database changes, but in order to add a flag for disabling the mentor management functionality we added a new boolean column to the assignments table called auto_assign_mentor.

=== Test Files ===
==== Files ====
* [https://github.com/expertiza/expertiza/pull/1957/files?file-filters%5B%5D= spec/factories/factories.rb]
: Update the assignment factory to include a default value for the new auto_assign_mentor flag for testing.
* [https://github.com/expertiza/expertiza/pull/1957/files?file-filters%5B%5D= spec/models/invitation_spec.rb]
: Update invitation_spec.rb to resolve failing tests after the addition of code to trigger mentor management in invitation.rb.
* [https://github.com/expertiza/expertiza/pull/1957/files?file-filters%5B%5D= spec/models/mentor_management_spec.rb]
: Implement tests for the <code>MentorManagement</code> class.

== Manual Testing instruction ==
# Login as instructor6, using 'password' as password and find the '''Rock on Assignment'''
# Check the paticipants for this assignment, make sure there are some students attempting this assignment.
#* You can add your own students to the assignment if you want.
# Impersonate the student account you found.If there is no team, create one by inviting other student to your team, or create a team using the admin control.
# By toggling the '''Auto assign mentors when team hits > 50% capacity?''' in the assignment configuration page you will be able to:
#* Enable the functionarities and logics that our team implemented.
#* Disable the functionarities and logics that our team implemented to allow an admin to assign mentor manully.

==== Two Observations (Trigger Enabled) ====
# Add team members to any team under the '''Rock on Assignment''' using any following way:
#* Invitate/Accept the team invitation using impersonated student accounts.
#* Add student to team by using the admin control.
# Observe that when the member size passing the capacity (3 for this Rock on assignment), a mentor called '''Student6801''' will be added to the assignment team.
# Remove the mentor and the added students of the assignment team using the admin control.
# Observe that when the member size below the capacity (e.g. the second team member added), a mentor will not be added to the assignment team.
# You should also be able to see that mentor is showing on the team list.

==== Two Observations (Trigger Disabled) ====
# By doing similar step as we mentioned above, you should not see any of the following:
#* A mentor is added to the team after the team size changed.
#* A mentor is displaying on the team list unless this mentor account: '''Student6801''' is manually added or invited.

== Test Plan ==
Based on the the workflow diagram we propose, we should be including a minimum of 5 tests: 1 for <code>addMentor</code>, 1 for <code>removeMentor</code>, 1 for <code>selectMentor</code>, and 2 more to exercise the paths through our workflow diagram.

# A team will have a mentor after <code>addMentor</code> is called.
# A team will have a mentor removed after <code>removeMentor</code> is called.
# The mentor with lowest number of team assigned will be return after <code>selectMentor</code> is called.
# The <code>selectMentor</code> except not to receive any message if a team already has a mentor.
# The <code>selectMentor</code> except not to receive any message if a team has size < 50% of the maximum size.

File:Late policy.PNG

2021-10-31T15:20:49Z

Alunava:

E2157. Fix issues related to deadlines and late policies

2021-10-31T15:15:41Z

Alunava: Created blank page

CSC/ECE 517 Fall 2021 - E2145. OSS Project Beige

2021-10-24T15:39:45Z

Alunava:

''This has contributions from Anmol Lunavat, Shubham Waghe and Vishal Sharma''

This wiki page provides description of changes made under E2145 OSS assignment for Fall 2021, CSC/ECE 517.

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

==Problem Statement==
When a participant updates the submission after the reading the review comments, the reviewer will have to review it again when the second review cycle starts. However, since the reviewer may have multiple submissions to review, some of which are updated, and some that are not, it becomes difficult for the reviewer to identify the updated submissions that need attention. Currently there is no way of identifying the difference between updated and stale submissions.

==Proposed Solution==
For identifying the submission status of the project in next review cycle, the reviewer should be able to quickly identify the submissions that need attention. This can be done in the UI of the reviewer’s page. The submissions can be color-coded using a scheme like the one used in the “Review Report” page.
* <span style="color:red">Red</span> – If the review has not been started
* <span style="color:orange">Orange</span> – If the review was started, but not completed
* <span style="color:brown">Brown</span> – Submission has been reviewed

This solution will allows reviewers to identify and prioritize their work without having to dig deep into individual submissions.

[[File:Workflow-Diagram.PNG|600px]]

The following diagram illustrates how the control would flow. As the user acts on a review, the status of the review changes.

==Tasks==
The following would be the key tasks:
* Add a new model to track the status of a review
* Upon change of review stage, update the data in the database.
* Change color in the UI based on the status of the review.

==Implementation==
===List of Changes===
We came up with the following model to capture the status of a review.

[[File:Review Status Map.PNG|1000px]]

We will keep a track of the stage a review is in. The following would be the three stages of a review:
*Ready : As soon as a student requests for a new review.
*Started : Once a student has started the review.
*Completed : Once a review has been submitted.

This will allow us to designate a unique color for each stage and update accordingly.

[[File:Ready.PNG|1000px]]

'''As soon as a review is assigned to a user, create a new entry in the Review Status table with the status of "Ready".'''

[[File:Started.PNG|1000px]]
[[File:Started1.PNG|1000px]]

'''Once a student starts doing the review, we fetch the record from Review Status table and update the status to "Started".'''

[[File:Completed.PNG|1000px]]
[[File:Completed1.PNG|1000px]]

'''Once a review is submitted from student's end we mark the status of the review to be "Completed".'''

==Testing==
Since our code changes were mostly linear, we can rely on existing test cases to cover all edge cases. The key check for us was to ensure a new entry to the Review Status Map is created as soon as a review has been requested.
===Rspec===
[[File:Test_Ready.PNG|600px]]

This basic test checks that a review gets status as "Ready" when the user requests for a new review.

Since we did not add new controllers and are relying on existing implementation to help us update the status of the review, we have not added any other tests. A video of testing has been uploaded and one can follow Manual Testing steps to review/verify the changes.

----

'''Manual Testing'''

Please follow the below steps for manual testing:
*Login using id: instructor6 password: password.
*Navigate to the Assignments tab under Manage.
*Create a new Assignment and assign to the following student ids : student2150, student2151, student2152.
*Navigate to Impersonate User under Manage.
*Impersonate as one of the users at a time and make a dummy submission.
*Once that is done and the stage of the assignment has changed to Review, go to Other's work tab and Request a new submission.
*A new review gets added to page and you should see the color as Red.
*Now click on Begin. Once satisfied click Save and hit back.
*Now you should see the highlighted color change to Orange.
*Once satisfied click View/Edit review and submit it.
*Now you should see the highlighted color change to Brown.

''Please set the deadlines correctly and you should be good. Our code does not control the stages or deadlines and thus you will have to be careful in order to test everything.''

==References==
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2021 - E2145. OSS Project Beige

2021-10-24T15:37:19Z

Alunava: /* Implementation */

''This has contributions from Anmol Lunavat, Shubham Waghe and Vishal Sharma''

This wiki page provides description of changes made under E2145 OSS assignment for Fall 2021, CSC/ECE 517.

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

==Problem Statement==
When a participant updates the submission after the reading the review comments, the reviewer will have to review it again when the second review cycle starts. However, since the reviewer may have multiple submissions to review, some of which are updated, and some that are not, it becomes difficult for the reviewer to identify the updated submissions that need attention. Currently there is no way of identifying the difference between updated and stale submissions.

==Proposed Solution==
For identifying the submission status of the project in next review cycle, the reviewer should be able to quickly identify the submissions that need attention. This can be done in the UI of the reviewer’s page. The submissions can be color-coded using a scheme like the one used in the “Review Report” page.
* <span style="color:red">Red</span> – If the review has not been started
* <span style="color:orange">Orange</span> – If the review was started, but not completed
* <span style="color:brown">Brown</span> – Submission has been reviewed

This solution will allows reviewers to identify and prioritize their work without having to dig deep into individual submissions.

[[File:Workflow-Diagram.PNG|600px]]

The following diagram illustrates how the control would flow. As the user acts on a review, the status of the review changes.

==Tasks==
The following would be the key tasks:
* Add a new model to track the status of a review
* Upon change of review stage, update the data in the database.
* Change color in the UI based on the status of the review.

==Implementation==
===List of Changes===
We came up with the following model to capture the status of a review.

[[File:Review Status Map.PNG|1000px]]

We will keep a track of the stage a review is in. The following would be the three stages of a review:
*Ready : As soon as a student requests for a new review.
*Started : Once a student has started the review.
*Completed : Once a review has been submitted.

This will allow us to designate a unique color for each stage and update accordingly.

[[File:Ready.PNG|1000px]]

'''As soon as a review is assigned to a user, create a new entry in the Review Status table with the status of "Ready".'''

[[File:Started.PNG|1000px]]
[[File:Started1.PNG|1000px]]

'''Once a student starts doing the review, we fetch the record from Review Status table and update the status to "Started".'''

[[File:Completed.PNG|1000px]]
[[File:Completed1.PNG|1000px]]

'''Once a review is submitted from student's end we mark the status of the review to be "Completed".'''

==Testing==
===Rspec===
[[File:Test_Ready.PNG|600px]]

This basic test checks that a review gets status as "Ready" when the user requests for a new review.

Since we did not add new controllers and are relying on existing implementation to help us update the status of the review, we have not added any other tests. A video of testing has been uploaded and one can follow Manual Testing steps to review/verify the changes.

----

'''Manual Testing'''

Please follow the below steps for manual testing:
*Login using id: instructor6 password: password.
*Navigate to the Assignments tab under Manage.
*Create a new Assignment and assign to the following student ids : student2150, student2151, student2152.
*Navigate to Impersonate User under Manage.
*Impersonate as one of the users at a time and make a dummy submission.
*Once that is done and the stage of the assignment has changed to Review, go to Other's work tab and Request a new submission.
*A new review gets added to page and you should see the color as Red.
*Now click on Begin. Once satisfied click Save and hit back.
*Now you should see the highlighted color change to Orange.
*Once satisfied click View/Edit review and submit it.
*Now you should see the highlighted color change to Brown.

''Please set the deadlines correctly and you should be good. Our code does not control the stages or deadlines and thus you will have to be careful in order to test everything.''

==References==
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2021 - E2145. OSS Project Beige

2021-10-24T15:34:25Z

Alunava:

''This has contributions from Anmol Lunavat, Shubham Waghe and Vishal Sharma''

This wiki page provides description of changes made under E2145 OSS assignment for Fall 2021, CSC/ECE 517.

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

==Problem Statement==
When a participant updates the submission after the reading the review comments, the reviewer will have to review it again when the second review cycle starts. However, since the reviewer may have multiple submissions to review, some of which are updated, and some that are not, it becomes difficult for the reviewer to identify the updated submissions that need attention. Currently there is no way of identifying the difference between updated and stale submissions.

==Proposed Solution==
For identifying the submission status of the project in next review cycle, the reviewer should be able to quickly identify the submissions that need attention. This can be done in the UI of the reviewer’s page. The submissions can be color-coded using a scheme like the one used in the “Review Report” page.
* <span style="color:red">Red</span> – If the review has not been started
* <span style="color:orange">Orange</span> – If the review was started, but not completed
* <span style="color:brown">Brown</span> – Submission has been reviewed

This solution will allows reviewers to identify and prioritize their work without having to dig deep into individual submissions.

[[File:Workflow-Diagram.PNG|600px]]

The following diagram illustrates how the control would flow. As the user acts on a review, the status of the review changes.

==Tasks==
The following would be the key tasks:
* Add a new model to track the status of a review
* Upon change of review stage, update the data in the database.
* Change color in the UI based on the status of the review.

==Implementation==
===List of Changes===
We came up with the following model to capture the status of a review.

[[File:Review Status Map.PNG|1000px]]

We will keep of the stage a review is in. The following would be the three stages of a review:
*Ready : As soon as a student requests for a new review.
*Started : Once a student has started the review.
*Completed : Once a review has been submitted.

This will allow us to designate a unique color to each stage and update accordingly.

[[File:Ready.PNG|1000px]]

'''As soon as a review is assigned to a user, create a new entry in the Review Status table with the status of "Ready".'''

[[File:Started.PNG|1000px]]
[[File:Started1.PNG|1000px]]

'''Once a student starts doing the review, we fetch the record from Review Status table and update the status to "Started".'''

[[File:Completed.PNG|1000px]]
[[File:Completed1.PNG|1000px]]

'''Once a review is submitted from student's end we mark the status of the review to be "Completed".'''

==Testing==
===Rspec===
[[File:Test_Ready.PNG|600px]]

This basic test checks that a review gets status as "Ready" when the user requests for a new review.

Since we did not add new controllers and are relying on existing implementation to help us update the status of the review, we have not added any other tests. A video of testing has been uploaded and one can follow Manual Testing steps to review/verify the changes.

----

'''Manual Testing'''

Please follow the below steps for manual testing:
*Login using id: instructor6 password: password.
*Navigate to the Assignments tab under Manage.
*Create a new Assignment and assign to the following student ids : student2150, student2151, student2152.
*Navigate to Impersonate User under Manage.
*Impersonate as one of the users at a time and make a dummy submission.
*Once that is done and the stage of the assignment has changed to Review, go to Other's work tab and Request a new submission.
*A new review gets added to page and you should see the color as Red.
*Now click on Begin. Once satisfied click Save and hit back.
*Now you should see the highlighted color change to Orange.
*Once satisfied click View/Edit review and submit it.
*Now you should see the highlighted color change to Brown.

''Please set the deadlines correctly and you should be good. Our code does not control the stages or deadlines and thus you will have to be careful in order to test everything.''

==References==
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2021 - E2145. OSS Project Beige

2021-10-24T01:28:32Z

Alunava:

''This has contributions from Anmol Lunavat, Shubham Waghe and Vishal Sharma''

This wiki page provides description of changes made under E2145 OSS assignment for Fall 2021, CSC/ECE 517.

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

==Problem Statement==
When a participant updates the submission after the reading the review comments, the reviewer will have to review it again when the second review cycle starts. However, since the reviewer may have multiple submissions to review, some of which are updated, and some that are not, it becomes difficult for the reviewer to identify the updated submissions that need attention. Currently there is no way of identifying the difference between updated and stale submissions.

==Proposed Solution==
For identifying the submission status of the project in next review cycle, the reviewer should be able to quickly identify the submissions that need attention. This can be done in the UI of the reviewer’s page. The submissions can be color-coded using a scheme like the one used in the “Review Report” page.
* <span style="color:red">Red</span> – If the review has not been started
* <span style="color:orange">Orange</span> – If the review was started, but not completed
* <span style="color:brown">Brown</span> – Submission has been reviewed

This solution will allows reviewers to identify and prioritize their work without having to dig deep into individual submissions.

[[File:Workflow-Diagram.PNG|600px]]

The following diagram illustrates how the control would flow. As the user acts on a review, the status of the review changes.

==Tasks==
The following would be the key tasks:
* Add a new model to track the status of a review
* Upon change of review stage, update the data in the database.
* Change color in the UI based on the status of the review.

==Implementation==
===List of Changes===
We came up with the following model to capture the status of a review.
[[File:Review Status Map.PNG|1000px]]

We will keep of the stage a review is in. The following would be the three stages of a review:
*Ready : As soon as a student requests for a new review.
*Started : Once a student has started the review.
*Completed : Once a review has been submitted.

This will allow us to designate a unique color to each stage and update accordingly.

[[File:Ready.PNG|1000px]]

'''As soon as a review is assigned to a user, create a new entry in the Review Status table with the status of "Ready".'''

[[File:Started.PNG|1000px]]
[[File:Started1.PNG|1000px]]

'''Once a student starts doing the review, we fetch the record from Review Status table and update the status to "Started".'''

[[File:Completed.PNG|1000px]]
[[File:Completed1.PNG|1000px]]

'''Once a review is submitted from student's end we mark the status of the review to be "Completed".'''

==Testing==
===Rspec===
[[File:Test_Ready.PNG|600px]]

This basic test checks that a review gets status as "Ready" when the user requests for a new review.

==References==
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2021 - E2145. OSS Project Beige

2021-10-24T01:26:08Z

Alunava:

''This has contributions from Anmol Lunavat, Shubham Waghe and Vishal Sharma''
This wiki page provides description of changes made under E2145 OSS assignment for Fall 2021, CSC/ECE 517.

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

==Problem Statement==
When a participant updates the submission after the reading the review comments, the reviewer will have to review it again when the second review cycle starts. However, since the reviewer may have multiple submissions to review, some of which are updated, and some that are not, it becomes difficult for the reviewer to identify the updated submissions that need attention. Currently there is no way of identifying the difference between updated and stale submissions.

==Proposed Solution==
For identifying the submission status of the project in next review cycle, the reviewer should be able to quickly identify the submissions that need attention. This can be done in the UI of the reviewer’s page. The submissions can be color-coded using a scheme like the one used in the “Review Report” page.
* <span style="color:red">Red</span> – If the review has not been started
* <span style="color:orange">Orange</span> – If the review was started, but not completed
* <span style="color:brown">Brown</span> – Submission has been reviewed

This solution will allows reviewers to identify and prioritize their work without having to dig deep into individual submissions.

[[File:Workflow-Diagram.PNG|600px]]

The following diagram illustrates how the control would flow. As the user acts on a review, the status of the review changes.

==Tasks==
The following would be the key tasks:
* Add a new model to track the status of a review
* Upon change of review stage, update the data in the database.
* Change color in the UI based on the status of the review.

==Implementation==
===List of Changes===
We came up with the following model to capture the status of a review.
[[File:Review Status Map.PNG|1000px]]

We will keep of the stage a review is in. The following would be the three stages of a review:
*Ready : As soon as a student requests for a new review.
*Started : Once a student has started the review.
*Completed : Once a review has been submitted.

This will allow us to designate a unique color to each stage and update accordingly.

[[File:Ready.PNG|1000px]]

'''As soon as a review is assigned to a user, create a new entry in the Review Status table with the status of "Ready".'''

[[File:Started.PNG|1000px]]
[[File:Started1.PNG|1000px]]

'''Once a student starts doing the review, we fetch the record from Review Status table and update the status to "Started".'''

[[File:Completed.PNG|1000px]]
[[File:Completed1.PNG|1000px]]

'''Once a review is submitted from student's end we mark the status of the review to be "Completed".'''

==Testing==
===Rspec===
[[File:Test_Ready.PNG|600px]]

This basic test checks that a review gets status as "Ready" when the user requests for a new review.

==References==
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]

CSC/ECE 517 Fall 2021

2021-10-20T23:09:41Z

Alunava: /* OSS Projects */

== OSS Projects ==
* [[CSC/ECE 517 Fall 2021 - {$num}. {$desc.title}]]
* [[CSC/ECE 517 Fall 2021 - E2128. Refactor student_quizzes_controller.rb & late_policies_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2132. Add tests cases for review mapping helper.rb]]
* [[CSC/ECE 517 Fall 2021 - E2134. Write unit tests for admin_controller.rb and institution_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2138. Auto-generate submission directory names based on assignment]]
* [[CSC/ECE 517 Fall 2021 - E2142. Improve e-mail notifications]]
* [[CSC/ECE 517 Fall 2021 - E2133. Write tests for popup_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2120. Refactor reputation_web_service_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2139. Remove multiple topics at a time]]
* [[CSC/ECE 517 Fall 2021 - E2131. Improve assessment360_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2121. Refactor suggestion_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2122. Refactor impersonate_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2126. Refactor account_request_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2124. Refactor review_mapping_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2125. Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Fall 2021 - E2127. Refactor teams_controller]]
* [[CSC/ECE 517 Fall 2021 - E2130. Refactor submitted_content_controller.rb]]
* [[CSC/ECE 517 Fall 2021 - E2141. OSS project Finklestein: Instructors & Institutions]]
* [[CSC/ECE 517 Fall 2021 - E2147. Role-based reviewing]]
* [[CSC/ECE 517 Fall 2021 - E2145. OSS Project Beige]]

CSC/ECE 517 Fall 2021 - E2145. OSS Project Beige

2021-10-20T23:09:02Z

Alunava: CSC/ECE 517 Fall 2021 - E2145. OSS Project Beige

This wiki page provides description of changes made under E2145 OSS assignment for Fall 2021, CSC/ECE 517.

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

==Problem Statement==
When a participant updates the submission after the reading the review comments, the reviewer will have to review it again when the second review cycle starts. However, since the reviewer may have multiple submissions to review, some of which are updated, and some that are not, it becomes difficult for the reviewer to identify the updated submissions that need attention. Currently there is no way of identifying the difference between updated and stale submissions.

==Proposed Solution==
For identifying the submission status of the project in next review cycle, the reviewer should be able to quickly identify the submissions that need attention. This can be done in the UI of the reviewer’s page. The submissions can be color-coded using a scheme like the one used in the “Review Report” page.
* <span style="color:red">Red</span> – If the review has not been started
* <span style="color:orange">Orange</span> – If the review was started, but not completed
* <span style="color:brown">Brown</span> – Submission has been reviewed

This solution will allows reviewers to identify and prioritize their work without having to dig deep into individual submissions.

[[File:Workflow-Diagram.PNG|600px]]

The following diagram illustrates how the control would flow. As the user acts on a review, the status of the review changes.

==Tasks==
The following would be the key tasks:
* Add a new model to track the status of a review
* Upon change of review stage, update the data in the database.
* Change color in the UI based on the status of the review.

==Implementation==
===List of Changes===
We came up with the following model to capture the status of a review.
[[File:Review Status Map.PNG|1000px]]

We will keep of the stage a review is in. The following would be the three stages of a review:
*Ready : As soon as a student requests for a new review.
*Started : Once a student has started the review.
*Completed : Once a review has been submitted.

This will allow us to designate a unique color to each stage and update accordingly.

[[File:Ready.PNG|1000px]]

'''As soon as a review is assigned to a user, create a new entry in the Review Status table with the status of "Ready".'''

[[File:Started.PNG|1000px]]
[[File:Started1.PNG|1000px]]

'''Once a student starts doing the review, we fetch the record from Review Status table and update the status to "Started".'''

[[File:Completed.PNG|1000px]]
[[File:Completed1.PNG|1000px]]

'''Once a review is submitted from student's end we mark the status of the review to be "Completed".'''

==Testing==
===Rspec===
[[File:Test_Ready.PNG|600px]]

This basic test checks that a review gets status as "Ready" when the user requests for a new review.

==References==
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]

E2145. OSS Project Beige

2021-10-19T02:05:23Z

Alunava: /* Rspec */

This wiki page provides description of changes made under E2145 OSS assignment for Fall 2021, CSC/ECE 517.

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

==Problem Statement==
When a participant updates the submission after the reading the review comments, the reviewer will have to review it again when the second review cycle starts. However, since the reviewer may have multiple submissions to review, some of which are updated, and some that are not, it becomes difficult for the reviewer to identify the updated submissions that need attention. Currently there is no way of identifying the difference between updated and stale submissions.

==Proposed Solution==
For identifying the submission status of the project in next review cycle, the reviewer should be able to quickly identify the submissions that need attention. This can be done in the UI of the reviewer’s page. The submissions can be color-coded using a scheme like the one used in the “Review Report” page.
* <span style="color:red">Red</span> – If the review has not been started
* <span style="color:orange">Orange</span> – If the review was started, but not completed
* <span style="color:brown">Brown</span> – Submission has been reviewed

This solution will allows reviewers to identify and prioritize their work without having to dig deep into individual submissions.

[[File:Workflow-Diagram.PNG|600px]]

The following diagram illustrates how the control would flow. As the user acts on a review, the status of the review changes.

==Tasks==
The following would be the key tasks:
* Add a new model to track the status of a review
* Upon change of review stage, update the data in the database.
* Change color in the UI based on the status of the review.

==Implementation==
===List of Changes===
We came up with the following model to capture the status of a review.
[[File:Review Status Map.PNG|1000px]]

We will keep of the stage a review is in. The following would be the three stages of a review:
*Ready : As soon as a student requests for a new review.
*Started : Once a student has started the review.
*Completed : Once a review has been submitted.

This will allow us to designate a unique color to each stage and update accordingly.

[[File:Ready.PNG|1000px]]

'''As soon as a review is assigned to a user, create a new entry in the Review Status table with the status of "Ready".'''

[[File:Started.PNG|1000px]]
[[File:Started1.PNG|1000px]]

'''Once a student starts doing the review, we fetch the record from Review Status table and update the status to "Started".'''

[[File:Completed.PNG|1000px]]
[[File:Completed1.PNG|1000px]]

'''Once a review is submitted from student's end we mark the status of the review to be "Completed".'''

==Testing==
===Rspec===
[[File:Test_Ready.PNG|600px]]

This basic test checks that a review gets status as "Ready" when the user requests for a new review.

===UI Testing===
WIP

==References==
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]

File:Test Ready.PNG

2021-10-19T02:04:01Z

Alunava: