Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-26T01:55:51Z

Smaraba: /* Manual Testing */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the main issue which is fixing the backlinks and the error message displayed in Late Due Policy, which is explained at detail in the coming sections. 
We checked review comments provided for the last implementation and improved upon it. Hence we will not be updating existing design patterns, and instead will be introducing refactoring within the existing code, by identifying DRY codes wherever possible and apply KISS principle if necessary. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient. 

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb
* late_policy_features_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

The code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks was fixed. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. It was added and made necessary changes wherever the <code>assignment_id</code> was being rendered. This fix is present within the current implementation. 
[[File:E2327_change0.png|500px|]] 
For the scope of our project, we identified several code areas where the code can be DRIED or KISS principles can be applied.
* We extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID and applied DRY - KISS principles. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

* To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
* To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test for flash error message on new late policy page
|-
| 2 || Test for back button interaction on new late policy page
|-
| 3 || Test for back button interaction on new late policy page while creating

|}

* To test for flash error message on new late policy page, we have written this test. It creates a new copy of the old_assignment with a different name, directory_path, and copy_flag attributes. The test ensures that the new_assignment_id is not nil, which indicates that a new copy of the old_assignment was created successfully.
<pre>
# Test for flash error message on new late policy page
it 'Flash Error Message on New Late Policy Page', js: true do
assignment = Assignment.where(name: 'assignment for late policy test').first
create(:topic, assignment_id: assignment.id)
visit "/assignments/#{assignment.id}/edit"
click_link 'Due Dates'
click_link 'New Late Policy'
fails if
expect(flash[:error]).to be('Failed to save the assignment: ')
end

</pre>

* To test for back button interaction on new late policy page, this test has been written. It verifies that the "Back" button on the new late policy page correctly takes the user back to the edit page of the Assignment. The test uses expect method to assert that the page is routed to the correct URL after clicking the "Back" button.

<pre>
#
it 'Back Button Interation on New Late Policy Page', js: true do
assignment = Assignment.where(name: 'assignment for late policy test').first
create(:topic, assignment_id: assignment.id)
visit "/assignments/#{assignment.id}/edit"
click_link 'Due Dates'
click_button 'New Late Policy'
click_button 'Back'
expect(page).to route_to("/assignments/#{assignment.id}/edit")
end

</pre>

* This test was written for back button interaction on new late policy page while creating. This test verifies that the "Back" button on the new late policy page correctly takes the user back to the edit page of the Assignment while creating a late policy. The test uses RSpec's expect method to assert that the page is routed to the correct URL after clicking the "Back" button.

<pre>
it 'Back Button Interation on New Late Policy Page while creating', js: true do
assignment = Assignment.where(name: 'assignment for late policy test').first
create(:topic, assignment_id: assignment.id)
visit "/assignments/#{assignment.id}/edit"
click_link 'Due Dates'
click_button 'New Late Policy'
fill_in "policy_name", with: 'Test Late Policy'
fill_in "penalty_per_unit", with: '15'
fill_in "max_penalty", with: '20'
click_button 'Create'
visit "/late_policies"
click_button 'Back'
expect(page).to route_to("/assignments/#{assignment.id}/edit")
end
</pre>

=== Manual Testing ===
When logging in as an instructor, use the following credentials: 
<pre>
username: administrator_star
password: password
</pre>
Please follow these steps: 
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-26T01:55:33Z

Smaraba: /* Manual Testing */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the main issue which is fixing the backlinks and the error message displayed in Late Due Policy, which is explained at detail in the coming sections. 
We checked review comments provided for the last implementation and improved upon it. Hence we will not be updating existing design patterns, and instead will be introducing refactoring within the existing code, by identifying DRY codes wherever possible and apply KISS principle if necessary. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient. 

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb
* late_policy_features_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

The code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks was fixed. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. It was added and made necessary changes wherever the <code>assignment_id</code> was being rendered. This fix is present within the current implementation. 
[[File:E2327_change0.png|500px|]] 
For the scope of our project, we identified several code areas where the code can be DRIED or KISS principles can be applied.
* We extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID and applied DRY - KISS principles. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

* To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
* To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test for flash error message on new late policy page
|-
| 2 || Test for back button interaction on new late policy page
|-
| 3 || Test for back button interaction on new late policy page while creating

|}

* To test for flash error message on new late policy page, we have written this test. It creates a new copy of the old_assignment with a different name, directory_path, and copy_flag attributes. The test ensures that the new_assignment_id is not nil, which indicates that a new copy of the old_assignment was created successfully.
<pre>
# Test for flash error message on new late policy page
it 'Flash Error Message on New Late Policy Page', js: true do
assignment = Assignment.where(name: 'assignment for late policy test').first
create(:topic, assignment_id: assignment.id)
visit "/assignments/#{assignment.id}/edit"
click_link 'Due Dates'
click_link 'New Late Policy'
fails if
expect(flash[:error]).to be('Failed to save the assignment: ')
end

</pre>

* To test for back button interaction on new late policy page, this test has been written. It verifies that the "Back" button on the new late policy page correctly takes the user back to the edit page of the Assignment. The test uses expect method to assert that the page is routed to the correct URL after clicking the "Back" button.

<pre>
#
it 'Back Button Interation on New Late Policy Page', js: true do
assignment = Assignment.where(name: 'assignment for late policy test').first
create(:topic, assignment_id: assignment.id)
visit "/assignments/#{assignment.id}/edit"
click_link 'Due Dates'
click_button 'New Late Policy'
click_button 'Back'
expect(page).to route_to("/assignments/#{assignment.id}/edit")
end

</pre>

* This test was written for back button interaction on new late policy page while creating. This test verifies that the "Back" button on the new late policy page correctly takes the user back to the edit page of the Assignment while creating a late policy. The test uses RSpec's expect method to assert that the page is routed to the correct URL after clicking the "Back" button.

<pre>
it 'Back Button Interation on New Late Policy Page while creating', js: true do
assignment = Assignment.where(name: 'assignment for late policy test').first
create(:topic, assignment_id: assignment.id)
visit "/assignments/#{assignment.id}/edit"
click_link 'Due Dates'
click_button 'New Late Policy'
fill_in "policy_name", with: 'Test Late Policy'
fill_in "penalty_per_unit", with: '15'
fill_in "max_penalty", with: '20'
click_button 'Create'
visit "/late_policies"
click_button 'Back'
expect(page).to route_to("/assignments/#{assignment.id}/edit")
end
</pre>

=== Manual Testing ===
When logging in as an instructor, use the following credentials: 
<pre>
username: administrator_star password: password 
</pre>
Please follow these steps: 
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-26T01:55:04Z

Smaraba: /* Manual Testing */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the main issue which is fixing the backlinks and the error message displayed in Late Due Policy, which is explained at detail in the coming sections. 
We checked review comments provided for the last implementation and improved upon it. Hence we will not be updating existing design patterns, and instead will be introducing refactoring within the existing code, by identifying DRY codes wherever possible and apply KISS principle if necessary. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient. 

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb
* late_policy_features_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

The code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks was fixed. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. It was added and made necessary changes wherever the <code>assignment_id</code> was being rendered. This fix is present within the current implementation. 
[[File:E2327_change0.png|500px|]] 
For the scope of our project, we identified several code areas where the code can be DRIED or KISS principles can be applied.
* We extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID and applied DRY - KISS principles. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

* To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
* To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test for flash error message on new late policy page
|-
| 2 || Test for back button interaction on new late policy page
|-
| 3 || Test for back button interaction on new late policy page while creating

|}

* To test for flash error message on new late policy page, we have written this test. It creates a new copy of the old_assignment with a different name, directory_path, and copy_flag attributes. The test ensures that the new_assignment_id is not nil, which indicates that a new copy of the old_assignment was created successfully.
<pre>
# Test for flash error message on new late policy page
it 'Flash Error Message on New Late Policy Page', js: true do
assignment = Assignment.where(name: 'assignment for late policy test').first
create(:topic, assignment_id: assignment.id)
visit "/assignments/#{assignment.id}/edit"
click_link 'Due Dates'
click_link 'New Late Policy'
fails if
expect(flash[:error]).to be('Failed to save the assignment: ')
end

</pre>

* To test for back button interaction on new late policy page, this test has been written. It verifies that the "Back" button on the new late policy page correctly takes the user back to the edit page of the Assignment. The test uses expect method to assert that the page is routed to the correct URL after clicking the "Back" button.

<pre>
#
it 'Back Button Interation on New Late Policy Page', js: true do
assignment = Assignment.where(name: 'assignment for late policy test').first
create(:topic, assignment_id: assignment.id)
visit "/assignments/#{assignment.id}/edit"
click_link 'Due Dates'
click_button 'New Late Policy'
click_button 'Back'
expect(page).to route_to("/assignments/#{assignment.id}/edit")
end

</pre>

* This test was written for back button interaction on new late policy page while creating. This test verifies that the "Back" button on the new late policy page correctly takes the user back to the edit page of the Assignment while creating a late policy. The test uses RSpec's expect method to assert that the page is routed to the correct URL after clicking the "Back" button.

<pre>
it 'Back Button Interation on New Late Policy Page while creating', js: true do
assignment = Assignment.where(name: 'assignment for late policy test').first
create(:topic, assignment_id: assignment.id)
visit "/assignments/#{assignment.id}/edit"
click_link 'Due Dates'
click_button 'New Late Policy'
fill_in "policy_name", with: 'Test Late Policy'
fill_in "penalty_per_unit", with: '15'
fill_in "max_penalty", with: '20'
click_button 'Create'
visit "/late_policies"
click_button 'Back'
expect(page).to route_to("/assignments/#{assignment.id}/edit")
end
</pre>

=== Manual Testing ===
When logging in as an instructor, use the following credentials: 
username: administrator_star password: password 
Please follow these steps: 
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-26T01:52:01Z

Smaraba: /* Files Refactored or Modified */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the main issue which is fixing the backlinks and the error message displayed in Late Due Policy, which is explained at detail in the coming sections. 
We checked review comments provided for the last implementation and improved upon it. Hence we will not be updating existing design patterns, and instead will be introducing refactoring within the existing code, by identifying DRY codes wherever possible and apply KISS principle if necessary. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient. 

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb
* late_policy_features_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

The code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks was fixed. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. It was added and made necessary changes wherever the <code>assignment_id</code> was being rendered. This fix is present within the current implementation. 
[[File:E2327_change0.png|500px|]] 
For the scope of our project, we identified several code areas where the code can be DRIED or KISS principles can be applied.
* We extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID and applied DRY - KISS principles. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

* To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
* To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test for flash error message on new late policy page
|-
| 2 || Test for back button interaction on new late policy page
|-
| 3 || Test for back button interaction on new late policy page while creating

|}

* To test for flash error message on new late policy page, we have written this test. It creates a new copy of the old_assignment with a different name, directory_path, and copy_flag attributes. The test ensures that the new_assignment_id is not nil, which indicates that a new copy of the old_assignment was created successfully.
<pre>
# Test for flash error message on new late policy page
it 'Flash Error Message on New Late Policy Page', js: true do
assignment = Assignment.where(name: 'assignment for late policy test').first
create(:topic, assignment_id: assignment.id)
visit "/assignments/#{assignment.id}/edit"
click_link 'Due Dates'
click_link 'New Late Policy'
fails if
expect(flash[:error]).to be('Failed to save the assignment: ')
end

</pre>

* To test for back button interaction on new late policy page, this test has been written. It verifies that the "Back" button on the new late policy page correctly takes the user back to the edit page of the Assignment. The test uses expect method to assert that the page is routed to the correct URL after clicking the "Back" button.

<pre>
#
it 'Back Button Interation on New Late Policy Page', js: true do
assignment = Assignment.where(name: 'assignment for late policy test').first
create(:topic, assignment_id: assignment.id)
visit "/assignments/#{assignment.id}/edit"
click_link 'Due Dates'
click_button 'New Late Policy'
click_button 'Back'
expect(page).to route_to("/assignments/#{assignment.id}/edit")
end

</pre>

* This test was written for back button interaction on new late policy page while creating. This test verifies that the "Back" button on the new late policy page correctly takes the user back to the edit page of the Assignment while creating a late policy. The test uses RSpec's expect method to assert that the page is routed to the correct URL after clicking the "Back" button.

<pre>
it 'Back Button Interation on New Late Policy Page while creating', js: true do
assignment = Assignment.where(name: 'assignment for late policy test').first
create(:topic, assignment_id: assignment.id)
visit "/assignments/#{assignment.id}/edit"
click_link 'Due Dates'
click_button 'New Late Policy'
fill_in "policy_name", with: 'Test Late Policy'
fill_in "penalty_per_unit", with: '15'
fill_in "max_penalty", with: '20'
click_button 'Create'
visit "/late_policies"
click_button 'Back'
expect(page).to route_to("/assignments/#{assignment.id}/edit")
end
</pre>

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-26T01:50:44Z

Smaraba: /* Tests */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the main issue which is fixing the backlinks and the error message displayed in Late Due Policy, which is explained at detail in the coming sections. 
We checked review comments provided for the last implementation and improved upon it. Hence we will not be updating existing design patterns, and instead will be introducing refactoring within the existing code, by identifying DRY codes wherever possible and apply KISS principle if necessary. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient. 

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

The code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks was fixed. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. It was added and made necessary changes wherever the <code>assignment_id</code> was being rendered. This fix is present within the current implementation. 
[[File:E2327_change0.png|500px|]] 
For the scope of our project, we identified several code areas where the code can be DRIED or KISS principles can be applied.
* We extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID and applied DRY - KISS principles. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

* To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
* To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test for flash error message on new late policy page
|-
| 2 || Test for back button interaction on new late policy page
|-
| 3 || Test for back button interaction on new late policy page while creating

|}

* To test for flash error message on new late policy page, we have written this test. It creates a new copy of the old_assignment with a different name, directory_path, and copy_flag attributes. The test ensures that the new_assignment_id is not nil, which indicates that a new copy of the old_assignment was created successfully.
<pre>
# Test for flash error message on new late policy page
it 'Flash Error Message on New Late Policy Page', js: true do
assignment = Assignment.where(name: 'assignment for late policy test').first
create(:topic, assignment_id: assignment.id)
visit "/assignments/#{assignment.id}/edit"
click_link 'Due Dates'
click_link 'New Late Policy'
fails if
expect(flash[:error]).to be('Failed to save the assignment: ')
end

</pre>

* To test for back button interaction on new late policy page, this test has been written. It verifies that the "Back" button on the new late policy page correctly takes the user back to the edit page of the Assignment. The test uses expect method to assert that the page is routed to the correct URL after clicking the "Back" button.

<pre>
#
it 'Back Button Interation on New Late Policy Page', js: true do
assignment = Assignment.where(name: 'assignment for late policy test').first
create(:topic, assignment_id: assignment.id)
visit "/assignments/#{assignment.id}/edit"
click_link 'Due Dates'
click_button 'New Late Policy'
click_button 'Back'
expect(page).to route_to("/assignments/#{assignment.id}/edit")
end

</pre>

* This test was written for back button interaction on new late policy page while creating. This test verifies that the "Back" button on the new late policy page correctly takes the user back to the edit page of the Assignment while creating a late policy. The test uses RSpec's expect method to assert that the page is routed to the correct URL after clicking the "Back" button.

<pre>
it 'Back Button Interation on New Late Policy Page while creating', js: true do
assignment = Assignment.where(name: 'assignment for late policy test').first
create(:topic, assignment_id: assignment.id)
visit "/assignments/#{assignment.id}/edit"
click_link 'Due Dates'
click_button 'New Late Policy'
fill_in "policy_name", with: 'Test Late Policy'
fill_in "penalty_per_unit", with: '15'
fill_in "max_penalty", with: '20'
click_button 'Create'
visit "/late_policies"
click_button 'Back'
expect(page).to route_to("/assignments/#{assignment.id}/edit")
end
</pre>

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-26T01:25:07Z

Smaraba: /* Changes made */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the main issue which is fixing the backlinks and the error message displayed in Late Due Policy, which is explained at detail in the coming sections. 
We checked review comments provided for the last implementation and improved upon it. Hence we will not be updating existing design patterns, and instead will be introducing refactoring within the existing code, by identifying DRY codes wherever possible and apply KISS principle if necessary. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient. 

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

The code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks was fixed. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. It was added and made necessary changes wherever the <code>assignment_id</code> was being rendered. This fix is present within the current implementation. 
[[File:E2327_change0.png|500px|]] 
For the scope of our project, we identified several code areas where the code can be DRIED or KISS principles can be applied.
* We extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID and applied DRY - KISS principles. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

* To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
* To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test for flash error message on new late policy page
|-
| 2 || Test for back button interaction on new late policy page
|-
| 3 || Test for back button interaction on new late policy page while creating

|}

* To the test the refactored copy method of the assignment form, we have included a unit test to mock the creation of a new assignment and trigger the copy method of Assignment object. We then verify the various fields of the copied object to ensure correctness after code refactoring.
<pre>
require 'rails_helper'

RSpec.describe Assignment, type: :model do
describe '.copy' do
let!(:user) { create(:user) }
let!(:old_assignment) { create(:assignment) }

it 'creates a copy of the assignment' do
new_assignment_id = Assignment.copy(old_assignment.id, user)

expect(new_assignment_id).not_to be_nil
expect(old_assignment.name).not_to eq(new_assignment.name)
expect(old_assignment.directory_path).not_to eq(new_assignment.directory_path)
expect(old_assignment.copy_flag).not_to eq(new_assignment.copy_flag)
end
end
end

</pre>

* In order to test the changes made within the create controller we have to introduce the following tests:
#Successful creation of an assignment and redirection to edit page
#Setting the assigment id within the session, so that it can be used in to route the 'Back' functionality
#Redirecting with error when assignment creation is invalid

<pre>
RSpec.describe AssignmentsController, type: :controller do
describe '#create' do
let(:course) { create(:course) }
let(:valid_assignment_attributes) { attributes_for(:assignment, course_id: course.id) }
let(:invalid_assignment_attributes) { attributes_for(:assignment, course_id: course.id, name: nil) }

context 'when the "Create Assignment" button is clicked and the assignment is valid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'creates a new assignment and redirects to the edit assignment page' do
expect(response).to redirect_to(edit_assignment_path(Assignment.last))
expect(flash[:success]).to eq('Assignment "Test Assignment" has been created successfully. ')
end

it 'sets the session assignment_id to the new assignment ID' do
expect(session[:assignment_id]).to eq(Assignment.last.id)
end
end
</pre>
<pre>

context 'when the "Create Assignment" button is clicked and the assignment is invalid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: invalid_assignment_attributes } }
end

it 'does not create a new assignment and redirects back to the new assignment page with an error message' do
expect(response).to redirect_to(new_assignment_path(private: 1))
expect(flash[:error]).to include('Failed to create assignment.')
expect(flash[:error]).to include('Name can\'t be blank')
end
end
</pre>
<pre>

context 'when the "Save" button is clicked' do
before do
post :create, params: { button: 'Save', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'renders the new assignment page with an undo link' do
expect(response).to render_template(:new)
expect(assigns(:undo_link)).to eq('Assignment "Test Assignment" has been created successfully. ')
end
end
end
end

</pre>

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-26T01:22:56Z

Smaraba: /* Tests */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the main issue which is fixing the backlinks and the error message displayed in Late Due Policy, which is explained at detail in the coming sections. 
We checked review comments provided for the last implementation and improved upon it. Hence we will not be updating existing design patterns, and instead will be introducing refactoring within the existing code, by identifying DRY codes wherever possible and apply KISS principle if necessary. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient. 

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

The code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks was fixed. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. It was added and made necessary changes wherever the <code>assignment_id</code> was being rendered. This fix is present within the current implementation. 
[[File:E2327_change0.png|500px|]] 
For the scope of our project, we identified several code areas where the code can be DRIED or KISS principles can be applied.
* We extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID and applied DRY - KISS principles. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

* To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
* To improve code readability in the assignment controller, we have separated the functionality of updating the assignments form parameters. The update logic is now stored within a separate function 'update_form_params_with_existing' that is called within the create method of the controller.
[[File:e2327 1.png|1000px|]] 
[[File:e2327 2.png|1000px|]] 
* To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test for flash error message on new late policy page
|-
| 2 || Test for back button interaction on new late policy page
|-
| 3 || Test for back button interaction on new late policy page while creating

|}

* To the test the refactored copy method of the assignment form, we have included a unit test to mock the creation of a new assignment and trigger the copy method of Assignment object. We then verify the various fields of the copied object to ensure correctness after code refactoring.
<pre>
require 'rails_helper'

RSpec.describe Assignment, type: :model do
describe '.copy' do
let!(:user) { create(:user) }
let!(:old_assignment) { create(:assignment) }

it 'creates a copy of the assignment' do
new_assignment_id = Assignment.copy(old_assignment.id, user)

expect(new_assignment_id).not_to be_nil
expect(old_assignment.name).not_to eq(new_assignment.name)
expect(old_assignment.directory_path).not_to eq(new_assignment.directory_path)
expect(old_assignment.copy_flag).not_to eq(new_assignment.copy_flag)
end
end
end

</pre>

* In order to test the changes made within the create controller we have to introduce the following tests:
#Successful creation of an assignment and redirection to edit page
#Setting the assigment id within the session, so that it can be used in to route the 'Back' functionality
#Redirecting with error when assignment creation is invalid

<pre>
RSpec.describe AssignmentsController, type: :controller do
describe '#create' do
let(:course) { create(:course) }
let(:valid_assignment_attributes) { attributes_for(:assignment, course_id: course.id) }
let(:invalid_assignment_attributes) { attributes_for(:assignment, course_id: course.id, name: nil) }

context 'when the "Create Assignment" button is clicked and the assignment is valid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'creates a new assignment and redirects to the edit assignment page' do
expect(response).to redirect_to(edit_assignment_path(Assignment.last))
expect(flash[:success]).to eq('Assignment "Test Assignment" has been created successfully. ')
end

it 'sets the session assignment_id to the new assignment ID' do
expect(session[:assignment_id]).to eq(Assignment.last.id)
end
end
</pre>
<pre>

context 'when the "Create Assignment" button is clicked and the assignment is invalid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: invalid_assignment_attributes } }
end

it 'does not create a new assignment and redirects back to the new assignment page with an error message' do
expect(response).to redirect_to(new_assignment_path(private: 1))
expect(flash[:error]).to include('Failed to create assignment.')
expect(flash[:error]).to include('Name can\'t be blank')
end
end
</pre>
<pre>

context 'when the "Save" button is clicked' do
before do
post :create, params: { button: 'Save', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'renders the new assignment page with an undo link' do
expect(response).to render_template(:new)
expect(assigns(:undo_link)).to eq('Assignment "Test Assignment" has been created successfully. ')
end
end
end
end

</pre>

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-13T01:46:27Z

Smaraba: /* Changes made */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the main issue which is fixing the backlinks and the error message displayed in Late Due Policy, which is explained at detail in the coming sections. 
We checked review comments provided for the last implementation and improved upon it. Hence we will not be updating existing design patterns, and instead will be introducing refactoring within the existing code, by identifying DRY codes wherever possible and apply KISS principle if necessary. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient. 

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

The code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks was fixed. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. It was added and made necessary changes wherever the <code>assignment_id</code> was being rendered. (This code was fixed in the previous PR, highlighting the modified code sections) 
[[File:E2327_change0.png|500px|]] 
Next, we identified several code areas where the code can be DRIED or KISS principles can be applied.
* We extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID and applied DRY - KISS principles. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

* To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
* To improve code readability in the assignment controller, we have separated the functionality of updating the assignments form parameters. The update logic is now stored within a separate function 'update_form_params_with_existing' that is called within the create method of the controller.
[[File:e2327 1.png|1000px|]] 
[[File:e2327 2.png|1000px|]] 
* To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test the refactoring for the copy method within the assignment_form.rb
|-
| 2 || Test successful assignment creation and redirection
|-
| 3 || Test redirection with error when assignment creation is invalid
|-
| 4 || Test setting assignment id within session
|}

* To the test the refactored copy method of the assignment form, we have included a unit test to mock the creation of a new assignment and trigger the copy method of Assignment object. We then verify the various fields of the copied object to ensure correctness after code refactoring.
<pre>
require 'rails_helper'

RSpec.describe Assignment, type: :model do
describe '.copy' do
let!(:user) { create(:user) }
let!(:old_assignment) { create(:assignment) }

it 'creates a copy of the assignment' do
new_assignment_id = Assignment.copy(old_assignment.id, user)

expect(new_assignment_id).not_to be_nil
expect(old_assignment.name).not_to eq(new_assignment.name)
expect(old_assignment.directory_path).not_to eq(new_assignment.directory_path)
expect(old_assignment.copy_flag).not_to eq(new_assignment.copy_flag)
end
end
end

</pre>

* In order to test the changes made within the create controller we have to introduce the following tests:
#Successful creation of an assignment and redirection to edit page
#Setting the assigment id within the session, so that it can be used in to route the 'Back' functionality
#Redirecting with error when assignment creation is invalid

<pre>
RSpec.describe AssignmentsController, type: :controller do
describe '#create' do
let(:course) { create(:course) }
let(:valid_assignment_attributes) { attributes_for(:assignment, course_id: course.id) }
let(:invalid_assignment_attributes) { attributes_for(:assignment, course_id: course.id, name: nil) }

context 'when the "Create Assignment" button is clicked and the assignment is valid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'creates a new assignment and redirects to the edit assignment page' do
expect(response).to redirect_to(edit_assignment_path(Assignment.last))
expect(flash[:success]).to eq('Assignment "Test Assignment" has been created successfully. ')
end

it 'sets the session assignment_id to the new assignment ID' do
expect(session[:assignment_id]).to eq(Assignment.last.id)
end
end
</pre>
<pre>

context 'when the "Create Assignment" button is clicked and the assignment is invalid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: invalid_assignment_attributes } }
end

it 'does not create a new assignment and redirects back to the new assignment page with an error message' do
expect(response).to redirect_to(new_assignment_path(private: 1))
expect(flash[:error]).to include('Failed to create assignment.')
expect(flash[:error]).to include('Name can\'t be blank')
end
end
</pre>
<pre>

context 'when the "Save" button is clicked' do
before do
post :create, params: { button: 'Save', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'renders the new assignment page with an undo link' do
expect(response).to render_template(:new)
expect(assigns(:undo_link)).to eq('Assignment "Test Assignment" has been created successfully. ')
end
end
end
end

</pre>

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-13T01:45:52Z

Smaraba: /* Changes made */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the main issue which is fixing the backlinks and the error message displayed in Late Due Policy, which is explained at detail in the coming sections. 
We checked review comments provided for the last implementation and improved upon it. Hence we will not be updating existing design patterns, and instead will be introducing refactoring within the existing code, by identifying DRY codes wherever possible and apply KISS principle if necessary. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient. 

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

The code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks was fixed. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. It was added and made necessary changes wherever the <code>assignment_id</code> was being rendered. (This code was fixed in the previous PR, highlighting the modified code sections) 
[[File:E2327_change0.png|500px|]] 
Next, we identified several code areas where the code can be DRIED or KISS principles can be applied.
* We extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID and applied DRY - KISS principles. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

* To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
* To improve code readability in the assignment controller, we have separated the functionality of updating the assignments form parameters. The update logic is now stored within a separate function 'update_form_params_with_existing' that is called within the create method of the controller.
[[File:e2327 1.png|1000px|]] 
[[File:e2327 2.png|1000px|]] 
* To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test the refactoring for the copy method within the assignment_form.rb
|-
| 2 || Test successful assignment creation and redirection
|-
| 3 || Test redirection with error when assignment creation is invalid
|-
| 4 || Test setting assignment id within session
|}

* To the test the refactored copy method of the assignment form, we have included a unit test to mock the creation of a new assignment and trigger the copy method of Assignment object. We then verify the various fields of the copied object to ensure correctness after code refactoring.
<pre>
require 'rails_helper'

RSpec.describe Assignment, type: :model do
describe '.copy' do
let!(:user) { create(:user) }
let!(:old_assignment) { create(:assignment) }

it 'creates a copy of the assignment' do
new_assignment_id = Assignment.copy(old_assignment.id, user)

expect(new_assignment_id).not_to be_nil
expect(old_assignment.name).not_to eq(new_assignment.name)
expect(old_assignment.directory_path).not_to eq(new_assignment.directory_path)
expect(old_assignment.copy_flag).not_to eq(new_assignment.copy_flag)
end
end
end

</pre>

* In order to test the changes made within the create controller we have to introduce the following tests:
#Successful creation of an assignment and redirection to edit page
#Setting the assigment id within the session, so that it can be used in to route the 'Back' functionality
#Redirecting with error when assignment creation is invalid

<pre>
RSpec.describe AssignmentsController, type: :controller do
describe '#create' do
let(:course) { create(:course) }
let(:valid_assignment_attributes) { attributes_for(:assignment, course_id: course.id) }
let(:invalid_assignment_attributes) { attributes_for(:assignment, course_id: course.id, name: nil) }

context 'when the "Create Assignment" button is clicked and the assignment is valid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'creates a new assignment and redirects to the edit assignment page' do
expect(response).to redirect_to(edit_assignment_path(Assignment.last))
expect(flash[:success]).to eq('Assignment "Test Assignment" has been created successfully. ')
end

it 'sets the session assignment_id to the new assignment ID' do
expect(session[:assignment_id]).to eq(Assignment.last.id)
end
end
</pre>
<pre>

context 'when the "Create Assignment" button is clicked and the assignment is invalid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: invalid_assignment_attributes } }
end

it 'does not create a new assignment and redirects back to the new assignment page with an error message' do
expect(response).to redirect_to(new_assignment_path(private: 1))
expect(flash[:error]).to include('Failed to create assignment.')
expect(flash[:error]).to include('Name can\'t be blank')
end
end
</pre>
<pre>

context 'when the "Save" button is clicked' do
before do
post :create, params: { button: 'Save', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'renders the new assignment page with an undo link' do
expect(response).to render_template(:new)
expect(assigns(:undo_link)).to eq('Assignment "Test Assignment" has been created successfully. ')
end
end
end
end

</pre>

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-13T01:45:36Z

Smaraba: /* Changes made */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the main issue which is fixing the backlinks and the error message displayed in Late Due Policy, which is explained at detail in the coming sections. 
We checked review comments provided for the last implementation and improved upon it. Hence we will not be updating existing design patterns, and instead will be introducing refactoring within the existing code, by identifying DRY codes wherever possible and apply KISS principle if necessary. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient. 

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

The code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks was fixed. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. It was added and made necessary changes wherever the <code>assignment_id</code> was being rendered. (This code was fixed in the previous PR, highlighting the modified code sections)
[[File:E2327_change0.png|500px|]] 
Next, we identified several code areas where the code can be DRIED or KISS principles can be applied.
* We extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID and applied DRY - KISS principles. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

* To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
* To improve code readability in the assignment controller, we have separated the functionality of updating the assignments form parameters. The update logic is now stored within a separate function 'update_form_params_with_existing' that is called within the create method of the controller.
[[File:e2327 1.png|1000px|]] 
[[File:e2327 2.png|1000px|]] 
* To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test the refactoring for the copy method within the assignment_form.rb
|-
| 2 || Test successful assignment creation and redirection
|-
| 3 || Test redirection with error when assignment creation is invalid
|-
| 4 || Test setting assignment id within session
|}

* To the test the refactored copy method of the assignment form, we have included a unit test to mock the creation of a new assignment and trigger the copy method of Assignment object. We then verify the various fields of the copied object to ensure correctness after code refactoring.
<pre>
require 'rails_helper'

RSpec.describe Assignment, type: :model do
describe '.copy' do
let!(:user) { create(:user) }
let!(:old_assignment) { create(:assignment) }

it 'creates a copy of the assignment' do
new_assignment_id = Assignment.copy(old_assignment.id, user)

expect(new_assignment_id).not_to be_nil
expect(old_assignment.name).not_to eq(new_assignment.name)
expect(old_assignment.directory_path).not_to eq(new_assignment.directory_path)
expect(old_assignment.copy_flag).not_to eq(new_assignment.copy_flag)
end
end
end

</pre>

* In order to test the changes made within the create controller we have to introduce the following tests:
#Successful creation of an assignment and redirection to edit page
#Setting the assigment id within the session, so that it can be used in to route the 'Back' functionality
#Redirecting with error when assignment creation is invalid

<pre>
RSpec.describe AssignmentsController, type: :controller do
describe '#create' do
let(:course) { create(:course) }
let(:valid_assignment_attributes) { attributes_for(:assignment, course_id: course.id) }
let(:invalid_assignment_attributes) { attributes_for(:assignment, course_id: course.id, name: nil) }

context 'when the "Create Assignment" button is clicked and the assignment is valid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'creates a new assignment and redirects to the edit assignment page' do
expect(response).to redirect_to(edit_assignment_path(Assignment.last))
expect(flash[:success]).to eq('Assignment "Test Assignment" has been created successfully. ')
end

it 'sets the session assignment_id to the new assignment ID' do
expect(session[:assignment_id]).to eq(Assignment.last.id)
end
end
</pre>
<pre>

context 'when the "Create Assignment" button is clicked and the assignment is invalid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: invalid_assignment_attributes } }
end

it 'does not create a new assignment and redirects back to the new assignment page with an error message' do
expect(response).to redirect_to(new_assignment_path(private: 1))
expect(flash[:error]).to include('Failed to create assignment.')
expect(flash[:error]).to include('Name can\'t be blank')
end
end
</pre>
<pre>

context 'when the "Save" button is clicked' do
before do
post :create, params: { button: 'Save', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'renders the new assignment page with an undo link' do
expect(response).to render_template(:new)
expect(assigns(:undo_link)).to eq('Assignment "Test Assignment" has been created successfully. ')
end
end
end
end

</pre>

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-13T01:42:41Z

Smaraba: /* Changes made */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the main issue which is fixing the backlinks and the error message displayed in Late Due Policy, which is explained at detail in the coming sections. 
We checked review comments provided for the last implementation and improved upon it. Hence we will not be updating existing design patterns, and instead will be introducing refactoring within the existing code, by identifying DRY codes wherever possible and apply KISS principle if necessary. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient. 

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

First, the code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks was fixed. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. It was added and made necessary changes wherever the <code>assignment_id</code> was being rendered.
[[File:E2327_change0.png|500px|]] 
Next, we identified several code areas where the code can be DRIED or KISS principles can be applied.
* We extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID and applied DRY - KISS principles. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

* To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
* To improve code readability in the assignment controller, we have separated the functionality of updating the assignments form parameters. The update logic is now stored within a separate function 'update_form_params_with_existing' that is called within the create method of the controller.
[[File:e2327 1.png|1000px|]] 
[[File:e2327 2.png|1000px|]] 
* To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test the refactoring for the copy method within the assignment_form.rb
|-
| 2 || Test successful assignment creation and redirection
|-
| 3 || Test redirection with error when assignment creation is invalid
|-
| 4 || Test setting assignment id within session
|}

* To the test the refactored copy method of the assignment form, we have included a unit test to mock the creation of a new assignment and trigger the copy method of Assignment object. We then verify the various fields of the copied object to ensure correctness after code refactoring.
<pre>
require 'rails_helper'

RSpec.describe Assignment, type: :model do
describe '.copy' do
let!(:user) { create(:user) }
let!(:old_assignment) { create(:assignment) }

it 'creates a copy of the assignment' do
new_assignment_id = Assignment.copy(old_assignment.id, user)

expect(new_assignment_id).not_to be_nil
expect(old_assignment.name).not_to eq(new_assignment.name)
expect(old_assignment.directory_path).not_to eq(new_assignment.directory_path)
expect(old_assignment.copy_flag).not_to eq(new_assignment.copy_flag)
end
end
end

</pre>

* In order to test the changes made within the create controller we have to introduce the following tests:
#Successful creation of an assignment and redirection to edit page
#Setting the assigment id within the session, so that it can be used in to route the 'Back' functionality
#Redirecting with error when assignment creation is invalid

<pre>
RSpec.describe AssignmentsController, type: :controller do
describe '#create' do
let(:course) { create(:course) }
let(:valid_assignment_attributes) { attributes_for(:assignment, course_id: course.id) }
let(:invalid_assignment_attributes) { attributes_for(:assignment, course_id: course.id, name: nil) }

context 'when the "Create Assignment" button is clicked and the assignment is valid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'creates a new assignment and redirects to the edit assignment page' do
expect(response).to redirect_to(edit_assignment_path(Assignment.last))
expect(flash[:success]).to eq('Assignment "Test Assignment" has been created successfully. ')
end

it 'sets the session assignment_id to the new assignment ID' do
expect(session[:assignment_id]).to eq(Assignment.last.id)
end
end

context 'when the "Create Assignment" button is clicked and the assignment is invalid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: invalid_assignment_attributes } }
end

it 'does not create a new assignment and redirects back to the new assignment page with an error message' do
expect(response).to redirect_to(new_assignment_path(private: 1))
expect(flash[:error]).to include('Failed to create assignment.')
expect(flash[:error]).to include('Name can\'t be blank')
end
end

context 'when the "Save" button is clicked' do
before do
post :create, params: { button: 'Save', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'renders the new assignment page with an undo link' do
expect(response).to render_template(:new)
expect(assigns(:undo_link)).to eq('Assignment "Test Assignment" has been created successfully. ')
end
end
end
end

</pre>

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-13T01:38:05Z

Smaraba: /* Changes made */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the main issue which is fixing the backlinks and the error message displayed in Late Due Policy, which is explained at detail in the coming sections. 
We checked review comments provided for the last implementation and improved upon it. Hence we will not be updating existing design patterns, and instead will be introducing refactoring within the existing code, by identifying DRY codes wherever possible and apply KISS principle if necessary. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient. 

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

* First, we identified & changed the code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. We added it and made necessary changes wherever the <code>assignment_id</code> was being rendered.
[[File:E2327_change0.png|500px|]] 

* Next, we extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID and applied DRY - KISS principles. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

* Later, we identified several code areas where the code can be DRIED.
* To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
* To improve code readability in the assignment controller, we have separated the functionality of updating the assignments form parameters. The update logic is now stored within a separate function 'update_form_params_with_existing' that is called within the create method of the controller.
[[File:e2327 1.png|1000px|]] 
[[File:e2327 2.png|1000px|]] 
* To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test the refactoring for the copy method within the assignment_form.rb
|-
| 2 || Test successful assignment creation and redirection
|-
| 3 || Test redirection with error when assignment creation is invalid
|-
| 4 || Test setting assignment id within session
|}

* To the test the refactored copy method of the assignment form, we have included a unit test to mock the creation of a new assignment and trigger the copy method of Assignment object. We then verify the various fields of the copied object to ensure correctness after code refactoring.
<pre>
require 'rails_helper'

RSpec.describe Assignment, type: :model do
describe '.copy' do
let!(:user) { create(:user) }
let!(:old_assignment) { create(:assignment) }

it 'creates a copy of the assignment' do
new_assignment_id = Assignment.copy(old_assignment.id, user)

expect(new_assignment_id).not_to be_nil
expect(old_assignment.name).not_to eq(new_assignment.name)
expect(old_assignment.directory_path).not_to eq(new_assignment.directory_path)
expect(old_assignment.copy_flag).not_to eq(new_assignment.copy_flag)
end
end
end

</pre>

* In order to test the changes made within the create controller we have to introduce the following tests:
#Successful creation of an assignment and redirection to edit page
#Setting the assigment id within the session, so that it can be used in to route the 'Back' functionality
#Redirecting with error when assignment creation is invalid

<pre>
RSpec.describe AssignmentsController, type: :controller do
describe '#create' do
let(:course) { create(:course) }
let(:valid_assignment_attributes) { attributes_for(:assignment, course_id: course.id) }
let(:invalid_assignment_attributes) { attributes_for(:assignment, course_id: course.id, name: nil) }

context 'when the "Create Assignment" button is clicked and the assignment is valid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'creates a new assignment and redirects to the edit assignment page' do
expect(response).to redirect_to(edit_assignment_path(Assignment.last))
expect(flash[:success]).to eq('Assignment "Test Assignment" has been created successfully. ')
end

it 'sets the session assignment_id to the new assignment ID' do
expect(session[:assignment_id]).to eq(Assignment.last.id)
end
end

context 'when the "Create Assignment" button is clicked and the assignment is invalid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: invalid_assignment_attributes } }
end

it 'does not create a new assignment and redirects back to the new assignment page with an error message' do
expect(response).to redirect_to(new_assignment_path(private: 1))
expect(flash[:error]).to include('Failed to create assignment.')
expect(flash[:error]).to include('Name can\'t be blank')
end
end

context 'when the "Save" button is clicked' do
before do
post :create, params: { button: 'Save', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'renders the new assignment page with an undo link' do
expect(response).to render_template(:new)
expect(assigns(:undo_link)).to eq('Assignment "Test Assignment" has been created successfully. ')
end
end
end
end

</pre>

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-13T01:37:19Z

Smaraba: /* Changes made */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the main issue which is fixing the backlinks and the error message displayed in Late Due Policy, which is explained at detail in the coming sections. 
We checked review comments provided for the last implementation and improved upon it. Hence we will not be updating existing design patterns, and instead will be introducing refactoring within the existing code, by identifying DRY codes wherever possible and apply KISS principle if necessary. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient. 

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

* First, we identified & changed the code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. We added it and made necessary changes wherever the <code>assignment_id</code> was being rendered.
[[File:E2327_change0.png|500px|]] 

* Next, we extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID and applied DRY - KISS principles. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

* Later, we identified several code areas where the code can be DRIED. 
* To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
* To improve code readability in the assignment controller, we have separated the functionality of updating the assignments form parameters. The update logic is now stored within a separate function 'update_form_params_with_existing' that is called within the create method of the controller.
[[File:e2327 1.png|1000px|]] 
[[File:e2327 2.png|1000px|]] 
* To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test the refactoring for the copy method within the assignment_form.rb
|-
| 2 || Test successful assignment creation and redirection
|-
| 3 || Test redirection with error when assignment creation is invalid
|-
| 4 || Test setting assignment id within session
|}

* To the test the refactored copy method of the assignment form, we have included a unit test to mock the creation of a new assignment and trigger the copy method of Assignment object. We then verify the various fields of the copied object to ensure correctness after code refactoring.
<pre>
require 'rails_helper'

RSpec.describe Assignment, type: :model do
describe '.copy' do
let!(:user) { create(:user) }
let!(:old_assignment) { create(:assignment) }

it 'creates a copy of the assignment' do
new_assignment_id = Assignment.copy(old_assignment.id, user)

expect(new_assignment_id).not_to be_nil
expect(old_assignment.name).not_to eq(new_assignment.name)
expect(old_assignment.directory_path).not_to eq(new_assignment.directory_path)
expect(old_assignment.copy_flag).not_to eq(new_assignment.copy_flag)
end
end
end

</pre>

* In order to test the changes made within the create controller we have to introduce the following tests:
#Successful creation of an assignment and redirection to edit page
#Setting the assigment id within the session, so that it can be used in to route the 'Back' functionality
#Redirecting with error when assignment creation is invalid

<pre>
RSpec.describe AssignmentsController, type: :controller do
describe '#create' do
let(:course) { create(:course) }
let(:valid_assignment_attributes) { attributes_for(:assignment, course_id: course.id) }
let(:invalid_assignment_attributes) { attributes_for(:assignment, course_id: course.id, name: nil) }

context 'when the "Create Assignment" button is clicked and the assignment is valid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'creates a new assignment and redirects to the edit assignment page' do
expect(response).to redirect_to(edit_assignment_path(Assignment.last))
expect(flash[:success]).to eq('Assignment "Test Assignment" has been created successfully. ')
end

it 'sets the session assignment_id to the new assignment ID' do
expect(session[:assignment_id]).to eq(Assignment.last.id)
end
end

context 'when the "Create Assignment" button is clicked and the assignment is invalid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: invalid_assignment_attributes } }
end

it 'does not create a new assignment and redirects back to the new assignment page with an error message' do
expect(response).to redirect_to(new_assignment_path(private: 1))
expect(flash[:error]).to include('Failed to create assignment.')
expect(flash[:error]).to include('Name can\'t be blank')
end
end

context 'when the "Save" button is clicked' do
before do
post :create, params: { button: 'Save', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'renders the new assignment page with an undo link' do
expect(response).to render_template(:new)
expect(assigns(:undo_link)).to eq('Assignment "Test Assignment" has been created successfully. ')
end
end
end
end

</pre>

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-13T01:36:23Z

Smaraba: /* Changes made */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the main issue which is fixing the backlinks and the error message displayed in Late Due Policy, which is explained at detail in the coming sections. 
We checked review comments provided for the last implementation and improved upon it. Hence we will not be updating existing design patterns, and instead will be introducing refactoring within the existing code, by identifying DRY codes wherever possible and apply KISS principle if necessary. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient. 

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

* First, we identified & changed the code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. We added it and made necessary changes wherever the <code>assignment_id</code> was being rendered.
[[File:E2327_change0.png|500px|]] 

* Next, we extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID and applied DRY - KISS principles. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

* Later, we identified several code areas where the code can be DRIED. 
* To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
* To improve code readability in the assignment controller, we have separated the functionality of updating the assignments form parameters. The update logic is now stored within a separate function 'update_form_params_with_existing' that is called within the create method of the controller.
[[File:e2327 1.png|1000px|]] 
[[File:e2327 2.png|1000px|]] 
* To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test the refactoring for the copy method within the assignment_form.rb
|-
| 2 || Test successful assignment creation and redirection
|-
| 3 || Test redirection with error when assignment creation is invalid
|-
| 4 || Test setting assignment id within session
|}

* To the test the refactored copy method of the assignment form, we have included a unit test to mock the creation of a new assignment and trigger the copy method of Assignment object. We then verify the various fields of the copied object to ensure correctness after code refactoring.
<pre>
require 'rails_helper'

RSpec.describe Assignment, type: :model do
describe '.copy' do
let!(:user) { create(:user) }
let!(:old_assignment) { create(:assignment) }

it 'creates a copy of the assignment' do
new_assignment_id = Assignment.copy(old_assignment.id, user)

expect(new_assignment_id).not_to be_nil
expect(old_assignment.name).not_to eq(new_assignment.name)
expect(old_assignment.directory_path).not_to eq(new_assignment.directory_path)
expect(old_assignment.copy_flag).not_to eq(new_assignment.copy_flag)
end
end
end

</pre>

* In order to test the changes made within the create controller we have to introduce the following tests:
#Successful creation of an assignment and redirection to edit page
#Setting the assigment id within the session, so that it can be used in to route the 'Back' functionality
#Redirecting with error when assignment creation is invalid

<pre>
RSpec.describe AssignmentsController, type: :controller do
describe '#create' do
let(:course) { create(:course) }
let(:valid_assignment_attributes) { attributes_for(:assignment, course_id: course.id) }
let(:invalid_assignment_attributes) { attributes_for(:assignment, course_id: course.id, name: nil) }

context 'when the "Create Assignment" button is clicked and the assignment is valid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'creates a new assignment and redirects to the edit assignment page' do
expect(response).to redirect_to(edit_assignment_path(Assignment.last))
expect(flash[:success]).to eq('Assignment "Test Assignment" has been created successfully. ')
end

it 'sets the session assignment_id to the new assignment ID' do
expect(session[:assignment_id]).to eq(Assignment.last.id)
end
end

context 'when the "Create Assignment" button is clicked and the assignment is invalid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: invalid_assignment_attributes } }
end

it 'does not create a new assignment and redirects back to the new assignment page with an error message' do
expect(response).to redirect_to(new_assignment_path(private: 1))
expect(flash[:error]).to include('Failed to create assignment.')
expect(flash[:error]).to include('Name can\'t be blank')
end
end

context 'when the "Save" button is clicked' do
before do
post :create, params: { button: 'Save', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'renders the new assignment page with an undo link' do
expect(response).to render_template(:new)
expect(assigns(:undo_link)).to eq('Assignment "Test Assignment" has been created successfully. ')
end
end
end
end

</pre>

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-13T01:35:59Z

Smaraba: /* Changes made */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the main issue which is fixing the backlinks and the error message displayed in Late Due Policy, which is explained at detail in the coming sections. 
We checked review comments provided for the last implementation and improved upon it. Hence we will not be updating existing design patterns, and instead will be introducing refactoring within the existing code, by identifying DRY codes wherever possible and apply KISS principle if necessary. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient. 

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

* First, we identified & changed the code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. We added it and made necessary changes wherever the <code>assignment_id</code> was being rendered.
[[File:E2327_change0.png|500px|]] 

* Next, we extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID and applied DRY - KISS principles. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

*Later, we identified several code areas where the code can be DRIED. 
*To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
*To improve code readability in the assignment controller, we have separated the functionality of updating the assignments form parameters. The update logic is now stored within a separate function 'update_form_params_with_existing' that is called within the create method of the controller.
[[File:e2327 1.png|1000px|]] 
[[File:e2327 2.png|1000px|]] 
*To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test the refactoring for the copy method within the assignment_form.rb
|-
| 2 || Test successful assignment creation and redirection
|-
| 3 || Test redirection with error when assignment creation is invalid
|-
| 4 || Test setting assignment id within session
|}

* To the test the refactored copy method of the assignment form, we have included a unit test to mock the creation of a new assignment and trigger the copy method of Assignment object. We then verify the various fields of the copied object to ensure correctness after code refactoring.
<pre>
require 'rails_helper'

RSpec.describe Assignment, type: :model do
describe '.copy' do
let!(:user) { create(:user) }
let!(:old_assignment) { create(:assignment) }

it 'creates a copy of the assignment' do
new_assignment_id = Assignment.copy(old_assignment.id, user)

expect(new_assignment_id).not_to be_nil
expect(old_assignment.name).not_to eq(new_assignment.name)
expect(old_assignment.directory_path).not_to eq(new_assignment.directory_path)
expect(old_assignment.copy_flag).not_to eq(new_assignment.copy_flag)
end
end
end

</pre>

* In order to test the changes made within the create controller we have to introduce the following tests:
#Successful creation of an assignment and redirection to edit page
#Setting the assigment id within the session, so that it can be used in to route the 'Back' functionality
#Redirecting with error when assignment creation is invalid

<pre>
RSpec.describe AssignmentsController, type: :controller do
describe '#create' do
let(:course) { create(:course) }
let(:valid_assignment_attributes) { attributes_for(:assignment, course_id: course.id) }
let(:invalid_assignment_attributes) { attributes_for(:assignment, course_id: course.id, name: nil) }

context 'when the "Create Assignment" button is clicked and the assignment is valid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'creates a new assignment and redirects to the edit assignment page' do
expect(response).to redirect_to(edit_assignment_path(Assignment.last))
expect(flash[:success]).to eq('Assignment "Test Assignment" has been created successfully. ')
end

it 'sets the session assignment_id to the new assignment ID' do
expect(session[:assignment_id]).to eq(Assignment.last.id)
end
end

context 'when the "Create Assignment" button is clicked and the assignment is invalid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: invalid_assignment_attributes } }
end

it 'does not create a new assignment and redirects back to the new assignment page with an error message' do
expect(response).to redirect_to(new_assignment_path(private: 1))
expect(flash[:error]).to include('Failed to create assignment.')
expect(flash[:error]).to include('Name can\'t be blank')
end
end

context 'when the "Save" button is clicked' do
before do
post :create, params: { button: 'Save', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'renders the new assignment page with an undo link' do
expect(response).to render_template(:new)
expect(assigns(:undo_link)).to eq('Assignment "Test Assignment" has been created successfully. ')
end
end
end
end

</pre>

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-13T01:35:00Z

Smaraba: /* Changes made */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the main issue which is fixing the backlinks and the error message displayed in Late Due Policy, which is explained at detail in the coming sections. 
We checked review comments provided for the last implementation and improved upon it. Hence we will not be updating existing design patterns, and instead will be introducing refactoring within the existing code, by identifying DRY codes wherever possible and apply KISS principle if necessary. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient. 

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

* First, we identified & changed the code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. We added it and made necessary changes wherever the <code>assignment_id</code> was being rendered.
[[File:E2327_change0.png|500px|]] 

* Next, we extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID and applied DRY - KISS principles. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

*Later, we identified several code areas where the code can be DRIED. 
To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
To improve code readability in the assignment controller, we have separated the functionality of updating the assignments form parameters. The update logic is now stored within a separate function 'update_form_params_with_existing' that is called within the create method of the controller.
[[File:e2327 1.png|1000px|]] 
[[File:e2327 2.png|1000px|]] 
To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test the refactoring for the copy method within the assignment_form.rb
|-
| 2 || Test successful assignment creation and redirection
|-
| 3 || Test redirection with error when assignment creation is invalid
|-
| 4 || Test setting assignment id within session
|}

* To the test the refactored copy method of the assignment form, we have included a unit test to mock the creation of a new assignment and trigger the copy method of Assignment object. We then verify the various fields of the copied object to ensure correctness after code refactoring.
<pre>
require 'rails_helper'

RSpec.describe Assignment, type: :model do
describe '.copy' do
let!(:user) { create(:user) }
let!(:old_assignment) { create(:assignment) }

it 'creates a copy of the assignment' do
new_assignment_id = Assignment.copy(old_assignment.id, user)

expect(new_assignment_id).not_to be_nil
expect(old_assignment.name).not_to eq(new_assignment.name)
expect(old_assignment.directory_path).not_to eq(new_assignment.directory_path)
expect(old_assignment.copy_flag).not_to eq(new_assignment.copy_flag)
end
end
end

</pre>

* In order to test the changes made within the create controller we have to introduce the following tests:
#Successful creation of an assignment and redirection to edit page
#Setting the assigment id within the session, so that it can be used in to route the 'Back' functionality
#Redirecting with error when assignment creation is invalid

<pre>
RSpec.describe AssignmentsController, type: :controller do
describe '#create' do
let(:course) { create(:course) }
let(:valid_assignment_attributes) { attributes_for(:assignment, course_id: course.id) }
let(:invalid_assignment_attributes) { attributes_for(:assignment, course_id: course.id, name: nil) }

context 'when the "Create Assignment" button is clicked and the assignment is valid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'creates a new assignment and redirects to the edit assignment page' do
expect(response).to redirect_to(edit_assignment_path(Assignment.last))
expect(flash[:success]).to eq('Assignment "Test Assignment" has been created successfully. ')
end

it 'sets the session assignment_id to the new assignment ID' do
expect(session[:assignment_id]).to eq(Assignment.last.id)
end
end

context 'when the "Create Assignment" button is clicked and the assignment is invalid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: invalid_assignment_attributes } }
end

it 'does not create a new assignment and redirects back to the new assignment page with an error message' do
expect(response).to redirect_to(new_assignment_path(private: 1))
expect(flash[:error]).to include('Failed to create assignment.')
expect(flash[:error]).to include('Name can\'t be blank')
end
end

context 'when the "Save" button is clicked' do
before do
post :create, params: { button: 'Save', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'renders the new assignment page with an undo link' do
expect(response).to render_template(:new)
expect(assigns(:undo_link)).to eq('Assignment "Test Assignment" has been created successfully. ')
end
end
end
end

</pre>

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-13T01:34:30Z

Smaraba: /* Changes made */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the main issue which is fixing the backlinks and the error message displayed in Late Due Policy, which is explained at detail in the coming sections. 
We checked review comments provided for the last implementation and improved upon it. Hence we will not be updating existing design patterns, and instead will be introducing refactoring within the existing code, by identifying DRY codes wherever possible and apply KISS principle if necessary. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient. 

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

* First, we identified & changed the code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. We added it and made necessary changes wherever the <code>assignment_id</code> was being rendered.
[[File:E2327_change0.png|500px|]] 

* Next, we extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID and applied DRY - KISS principles. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

*Later, we identified several code areas where the code can be DRIED. 
*** To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
*** To improve code readability in the assignment controller, we have separated the functionality of updating the assignments form parameters. The update logic is now stored within a separate function 'update_form_params_with_existing' that is called within the create method of the controller.
[[File:e2327 1.png|1000px|]] 
[[File:e2327 2.png|1000px|]] 
*** To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test the refactoring for the copy method within the assignment_form.rb
|-
| 2 || Test successful assignment creation and redirection
|-
| 3 || Test redirection with error when assignment creation is invalid
|-
| 4 || Test setting assignment id within session
|}

* To the test the refactored copy method of the assignment form, we have included a unit test to mock the creation of a new assignment and trigger the copy method of Assignment object. We then verify the various fields of the copied object to ensure correctness after code refactoring.
<pre>
require 'rails_helper'

RSpec.describe Assignment, type: :model do
describe '.copy' do
let!(:user) { create(:user) }
let!(:old_assignment) { create(:assignment) }

it 'creates a copy of the assignment' do
new_assignment_id = Assignment.copy(old_assignment.id, user)

expect(new_assignment_id).not_to be_nil
expect(old_assignment.name).not_to eq(new_assignment.name)
expect(old_assignment.directory_path).not_to eq(new_assignment.directory_path)
expect(old_assignment.copy_flag).not_to eq(new_assignment.copy_flag)
end
end
end

</pre>

* In order to test the changes made within the create controller we have to introduce the following tests:
#Successful creation of an assignment and redirection to edit page
#Setting the assigment id within the session, so that it can be used in to route the 'Back' functionality
#Redirecting with error when assignment creation is invalid

<pre>
RSpec.describe AssignmentsController, type: :controller do
describe '#create' do
let(:course) { create(:course) }
let(:valid_assignment_attributes) { attributes_for(:assignment, course_id: course.id) }
let(:invalid_assignment_attributes) { attributes_for(:assignment, course_id: course.id, name: nil) }

context 'when the "Create Assignment" button is clicked and the assignment is valid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'creates a new assignment and redirects to the edit assignment page' do
expect(response).to redirect_to(edit_assignment_path(Assignment.last))
expect(flash[:success]).to eq('Assignment "Test Assignment" has been created successfully. ')
end

it 'sets the session assignment_id to the new assignment ID' do
expect(session[:assignment_id]).to eq(Assignment.last.id)
end
end

context 'when the "Create Assignment" button is clicked and the assignment is invalid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: invalid_assignment_attributes } }
end

it 'does not create a new assignment and redirects back to the new assignment page with an error message' do
expect(response).to redirect_to(new_assignment_path(private: 1))
expect(flash[:error]).to include('Failed to create assignment.')
expect(flash[:error]).to include('Name can\'t be blank')
end
end

context 'when the "Save" button is clicked' do
before do
post :create, params: { button: 'Save', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'renders the new assignment page with an undo link' do
expect(response).to render_template(:new)
expect(assigns(:undo_link)).to eq('Assignment "Test Assignment" has been created successfully. ')
end
end
end
end

</pre>

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-13T01:33:59Z

Smaraba: /* Changes made */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the main issue which is fixing the backlinks and the error message displayed in Late Due Policy, which is explained at detail in the coming sections. 
We checked review comments provided for the last implementation and improved upon it. Hence we will not be updating existing design patterns, and instead will be introducing refactoring within the existing code, by identifying DRY codes wherever possible and apply KISS principle if necessary. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient. 

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

* First, we identified & changed the code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. We added it and made necessary changes wherever the <code>assignment_id</code> was being rendered.
[[File:E2327_change0.png|500px|]] 

* Next, we extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID and applied DRY - KISS principles. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

*Later, we identified several code areas where the code can be DRIED. 
** To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
** To improve code readability in the assignment controller, we have separated the functionality of updating the assignments form parameters. The update logic is now stored within a separate function 'update_form_params_with_existing' that is called within the create method of the controller.
[[File:e2327 1.png|1000px|]] 
[[File:e2327 2.png|1000px|]] 
** To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test the refactoring for the copy method within the assignment_form.rb
|-
| 2 || Test successful assignment creation and redirection
|-
| 3 || Test redirection with error when assignment creation is invalid
|-
| 4 || Test setting assignment id within session
|}

* To the test the refactored copy method of the assignment form, we have included a unit test to mock the creation of a new assignment and trigger the copy method of Assignment object. We then verify the various fields of the copied object to ensure correctness after code refactoring.
<pre>
require 'rails_helper'

RSpec.describe Assignment, type: :model do
describe '.copy' do
let!(:user) { create(:user) }
let!(:old_assignment) { create(:assignment) }

it 'creates a copy of the assignment' do
new_assignment_id = Assignment.copy(old_assignment.id, user)

expect(new_assignment_id).not_to be_nil
expect(old_assignment.name).not_to eq(new_assignment.name)
expect(old_assignment.directory_path).not_to eq(new_assignment.directory_path)
expect(old_assignment.copy_flag).not_to eq(new_assignment.copy_flag)
end
end
end

</pre>

* In order to test the changes made within the create controller we have to introduce the following tests:
#Successful creation of an assignment and redirection to edit page
#Setting the assigment id within the session, so that it can be used in to route the 'Back' functionality
#Redirecting with error when assignment creation is invalid

<pre>
RSpec.describe AssignmentsController, type: :controller do
describe '#create' do
let(:course) { create(:course) }
let(:valid_assignment_attributes) { attributes_for(:assignment, course_id: course.id) }
let(:invalid_assignment_attributes) { attributes_for(:assignment, course_id: course.id, name: nil) }

context 'when the "Create Assignment" button is clicked and the assignment is valid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'creates a new assignment and redirects to the edit assignment page' do
expect(response).to redirect_to(edit_assignment_path(Assignment.last))
expect(flash[:success]).to eq('Assignment "Test Assignment" has been created successfully. ')
end

it 'sets the session assignment_id to the new assignment ID' do
expect(session[:assignment_id]).to eq(Assignment.last.id)
end
end

context 'when the "Create Assignment" button is clicked and the assignment is invalid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: invalid_assignment_attributes } }
end

it 'does not create a new assignment and redirects back to the new assignment page with an error message' do
expect(response).to redirect_to(new_assignment_path(private: 1))
expect(flash[:error]).to include('Failed to create assignment.')
expect(flash[:error]).to include('Name can\'t be blank')
end
end

context 'when the "Save" button is clicked' do
before do
post :create, params: { button: 'Save', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'renders the new assignment page with an undo link' do
expect(response).to render_template(:new)
expect(assigns(:undo_link)).to eq('Assignment "Test Assignment" has been created successfully. ')
end
end
end
end

</pre>

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-13T01:33:32Z

Smaraba: /* Changes made */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the main issue which is fixing the backlinks and the error message displayed in Late Due Policy, which is explained at detail in the coming sections. 
We checked review comments provided for the last implementation and improved upon it. Hence we will not be updating existing design patterns, and instead will be introducing refactoring within the existing code, by identifying DRY codes wherever possible and apply KISS principle if necessary. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient. 

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

* First, we identified & changed the code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. We added it and made necessary changes wherever the <code>assignment_id</code> was being rendered.
[[File:E2327_change0.png|500px|]] 

* Next, we extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID and applied DRY - KISS principles. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

*Later, we identified several code areas where the code can be DRIED. 
* To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
* To improve code readability in the assignment controller, we have separated the functionality of updating the assignments form parameters. The update logic is now stored within a separate function 'update_form_params_with_existing' that is called within the create method of the controller.
[[File:e2327 1.png|1000px|]] 
[[File:e2327 2.png|1000px|]] 
* To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test the refactoring for the copy method within the assignment_form.rb
|-
| 2 || Test successful assignment creation and redirection
|-
| 3 || Test redirection with error when assignment creation is invalid
|-
| 4 || Test setting assignment id within session
|}

* To the test the refactored copy method of the assignment form, we have included a unit test to mock the creation of a new assignment and trigger the copy method of Assignment object. We then verify the various fields of the copied object to ensure correctness after code refactoring.
<pre>
require 'rails_helper'

RSpec.describe Assignment, type: :model do
describe '.copy' do
let!(:user) { create(:user) }
let!(:old_assignment) { create(:assignment) }

it 'creates a copy of the assignment' do
new_assignment_id = Assignment.copy(old_assignment.id, user)

expect(new_assignment_id).not_to be_nil
expect(old_assignment.name).not_to eq(new_assignment.name)
expect(old_assignment.directory_path).not_to eq(new_assignment.directory_path)
expect(old_assignment.copy_flag).not_to eq(new_assignment.copy_flag)
end
end
end

</pre>

* In order to test the changes made within the create controller we have to introduce the following tests:
#Successful creation of an assignment and redirection to edit page
#Setting the assigment id within the session, so that it can be used in to route the 'Back' functionality
#Redirecting with error when assignment creation is invalid

<pre>
RSpec.describe AssignmentsController, type: :controller do
describe '#create' do
let(:course) { create(:course) }
let(:valid_assignment_attributes) { attributes_for(:assignment, course_id: course.id) }
let(:invalid_assignment_attributes) { attributes_for(:assignment, course_id: course.id, name: nil) }

context 'when the "Create Assignment" button is clicked and the assignment is valid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'creates a new assignment and redirects to the edit assignment page' do
expect(response).to redirect_to(edit_assignment_path(Assignment.last))
expect(flash[:success]).to eq('Assignment "Test Assignment" has been created successfully. ')
end

it 'sets the session assignment_id to the new assignment ID' do
expect(session[:assignment_id]).to eq(Assignment.last.id)
end
end

context 'when the "Create Assignment" button is clicked and the assignment is invalid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: invalid_assignment_attributes } }
end

it 'does not create a new assignment and redirects back to the new assignment page with an error message' do
expect(response).to redirect_to(new_assignment_path(private: 1))
expect(flash[:error]).to include('Failed to create assignment.')
expect(flash[:error]).to include('Name can\'t be blank')
end
end

context 'when the "Save" button is clicked' do
before do
post :create, params: { button: 'Save', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'renders the new assignment page with an undo link' do
expect(response).to render_template(:new)
expect(assigns(:undo_link)).to eq('Assignment "Test Assignment" has been created successfully. ')
end
end
end
end

</pre>

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-13T01:33:10Z

Smaraba: /* Changes made */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the main issue which is fixing the backlinks and the error message displayed in Late Due Policy, which is explained at detail in the coming sections. 
We checked review comments provided for the last implementation and improved upon it. Hence we will not be updating existing design patterns, and instead will be introducing refactoring within the existing code, by identifying DRY codes wherever possible and apply KISS principle if necessary. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient. 

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

* First, we identified & changed the code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. We added it and made necessary changes wherever the <code>assignment_id</code> was being rendered.
[[File:E2327_change0.png|500px|]] 

* Next, we extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID and applied DRY - KISS principles. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

*Later, we identified several code areas where the code can be DRIED. 
** To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
** To improve code readability in the assignment controller, we have separated the functionality of updating the assignments form parameters. The update logic is now stored within a separate function 'update_form_params_with_existing' that is called within the create method of the controller.
[[File:e2327 1.png|1000px|]] 
[[File:e2327 2.png|1000px|]] 
** To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test the refactoring for the copy method within the assignment_form.rb
|-
| 2 || Test successful assignment creation and redirection
|-
| 3 || Test redirection with error when assignment creation is invalid
|-
| 4 || Test setting assignment id within session
|}

* To the test the refactored copy method of the assignment form, we have included a unit test to mock the creation of a new assignment and trigger the copy method of Assignment object. We then verify the various fields of the copied object to ensure correctness after code refactoring.
<pre>
require 'rails_helper'

RSpec.describe Assignment, type: :model do
describe '.copy' do
let!(:user) { create(:user) }
let!(:old_assignment) { create(:assignment) }

it 'creates a copy of the assignment' do
new_assignment_id = Assignment.copy(old_assignment.id, user)

expect(new_assignment_id).not_to be_nil
expect(old_assignment.name).not_to eq(new_assignment.name)
expect(old_assignment.directory_path).not_to eq(new_assignment.directory_path)
expect(old_assignment.copy_flag).not_to eq(new_assignment.copy_flag)
end
end
end

</pre>

* In order to test the changes made within the create controller we have to introduce the following tests:
#Successful creation of an assignment and redirection to edit page
#Setting the assigment id within the session, so that it can be used in to route the 'Back' functionality
#Redirecting with error when assignment creation is invalid

<pre>
RSpec.describe AssignmentsController, type: :controller do
describe '#create' do
let(:course) { create(:course) }
let(:valid_assignment_attributes) { attributes_for(:assignment, course_id: course.id) }
let(:invalid_assignment_attributes) { attributes_for(:assignment, course_id: course.id, name: nil) }

context 'when the "Create Assignment" button is clicked and the assignment is valid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'creates a new assignment and redirects to the edit assignment page' do
expect(response).to redirect_to(edit_assignment_path(Assignment.last))
expect(flash[:success]).to eq('Assignment "Test Assignment" has been created successfully. ')
end

it 'sets the session assignment_id to the new assignment ID' do
expect(session[:assignment_id]).to eq(Assignment.last.id)
end
end

context 'when the "Create Assignment" button is clicked and the assignment is invalid' do
before do
post :create, params: { button: 'Create Assignment', assignment_form: { assignment: invalid_assignment_attributes } }
end

it 'does not create a new assignment and redirects back to the new assignment page with an error message' do
expect(response).to redirect_to(new_assignment_path(private: 1))
expect(flash[:error]).to include('Failed to create assignment.')
expect(flash[:error]).to include('Name can\'t be blank')
end
end

context 'when the "Save" button is clicked' do
before do
post :create, params: { button: 'Save', assignment_form: { assignment: valid_assignment_attributes } }
end

it 'renders the new assignment page with an undo link' do
expect(response).to render_template(:new)
expect(assigns(:undo_link)).to eq('Assignment "Test Assignment" has been created successfully. ')
end
end
end
end

</pre>

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-13T01:29:30Z

Smaraba: /* Design Principle */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the main issue which is fixing the backlinks and the error message displayed in Late Due Policy, which is explained at detail in the coming sections. 
We checked review comments provided for the last implementation and improved upon it. Hence we will not be updating existing design patterns, and instead will be introducing refactoring within the existing code, by identifying DRY codes wherever possible and apply KISS principle if necessary. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient. 

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

* First, we identified & changed the code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. We added it and made necessary changes wherever the <code>assignment_id</code> was being rendered.
[[File:E2327_change0.png|500px|]] 

* Next, we extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID and applied DRY - KISS principles. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

* To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
* To improve code readability in the assignment controller, we have separated the functionality of updating the assignments form parameters. The update logic is now stored within a separate function 'update_form_params_with_existing' that is called within the create method of the controller.
[[File:e2327 1.png|1000px|]] 
[[File:e2327 2.png|1000px|]] 
* To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test the refactoring for the copy method within the assignment_form.rb
|-
| 2 || Test to create assignment and check Back button functionality
|-
| 3 || Test to check Back button functionality without creation
|}

* To the test the refactored copy method of the assignment form, we have included a unit test to mock the creation of a new assignment and trigger the copy method of Assignment object. We then verify the various fields of the copied object to ensure correctness after code refactoring.
<pre>
require 'rails_helper'

RSpec.describe Assignment, type: :model do
describe '.copy' do
let!(:user) { create(:user) }
let!(:old_assignment) { create(:assignment) }

it 'creates a copy of the assignment' do
new_assignment_id = Assignment.copy(old_assignment.id, user)

expect(new_assignment_id).not_to be_nil
expect(old_assignment.name).not_to eq(new_assignment.name)
expect(old_assignment.directory_path).not_to eq(new_assignment.directory_path)
expect(old_assignment.copy_flag).not_to eq(new_assignment.copy_flag)
end
end
end

</pre>

=== Test Screenshots ===

Will be added soon.

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-13T01:24:22Z

Smaraba: /* Changes made */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the review comments provided for the last implementation. Hence we will not be updating existing design patters, and instead will be introducing Refactoring within the existing code. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient.

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

* First, we identified & changed the code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. We added it and made necessary changes wherever the <code>assignment_id</code> was being rendered.
[[File:E2327_change0.png|500px|]] 

* Next, we extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID and applied DRY - KISS principles. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

* To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
* To improve code readability in the assignment controller, we have separated the functionality of updating the assignments form parameters. The update logic is now stored within a separate function 'update_form_params_with_existing' that is called within the create method of the controller.
[[File:e2327 1.png|1000px|]] 
[[File:e2327 2.png|1000px|]] 
* To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test the refactoring for the copy method within the assignment_form.rb
|-
| 2 || Test to create assignment and check Back button functionality
|-
| 3 || Test to check Back button functionality without creation
|}

* To the test the refactored copy method of the assignment form, we have included a unit test to mock the creation of a new assignment and trigger the copy method of Assignment object. We then verify the various fields of the copied object to ensure correctness after code refactoring.
<pre>
require 'rails_helper'

RSpec.describe Assignment, type: :model do
describe '.copy' do
let!(:user) { create(:user) }
let!(:old_assignment) { create(:assignment) }

it 'creates a copy of the assignment' do
new_assignment_id = Assignment.copy(old_assignment.id, user)

expect(new_assignment_id).not_to be_nil
expect(old_assignment.name).not_to eq(new_assignment.name)
expect(old_assignment.directory_path).not_to eq(new_assignment.directory_path)
expect(old_assignment.copy_flag).not_to eq(new_assignment.copy_flag)
end
end
end

</pre>

=== Test Screenshots ===

Will be added soon.

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-13T01:19:06Z

Smaraba: /* Changes made */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the review comments provided for the last implementation. Hence we will not be updating existing design patters, and instead will be introducing Refactoring within the existing code. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient.

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

* First, we identified & changed the code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks. The error was due to the parameter <code>assignment_id</code> not being present in session parameter list. We added it and made necessary changes wherever the <code>assignment_id</code> was being rendered.
[[File:E2327_change0.png|500px|]] 

* Next, we extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

* To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
* To improve code readability in the assignment controller, we have separated the functionality of updating the assignments form parameters. The update logic is now stored within a separate function 'update_form_params_with_existing' that is called within the create method of the controller.
[[File:e2327 1.png|1000px|]] 
[[File:e2327 2.png|1000px|]] 
* To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test the refactoring for the copy method within the assignment_form.rb
|-
| 2 || Test to create assignment and check Back button functionality
|-
| 3 || Test to check Back button functionality without creation
|}

* To the test the refactored copy method of the assignment form, we have included a unit test to mock the creation of a new assignment and trigger the copy method of Assignment object. We then verify the various fields of the copied object to ensure correctness after code refactoring.
<pre>
require 'rails_helper'

RSpec.describe Assignment, type: :model do
describe '.copy' do
let!(:user) { create(:user) }
let!(:old_assignment) { create(:assignment) }

it 'creates a copy of the assignment' do
new_assignment_id = Assignment.copy(old_assignment.id, user)

expect(new_assignment_id).not_to be_nil
expect(old_assignment.name).not_to eq(new_assignment.name)
expect(old_assignment.directory_path).not_to eq(new_assignment.directory_path)
expect(old_assignment.copy_flag).not_to eq(new_assignment.copy_flag)
end
end
end

</pre>

=== Test Screenshots ===

Will be added soon.

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-13T01:13:19Z

Smaraba: /* Changes made */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the review comments provided for the last implementation. Hence we will not be updating existing design patters, and instead will be introducing Refactoring within the existing code. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient.

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

* First, we identified & changed the code in <code>assignments_controller.rb</code> that is displaying an error in New late policy & breaking the backlinks.
[[File:E2327_change0.png|500px|]] 

* Next, we extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

* To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
* To improve code readability in the assignment controller, we have separated the functionality of updating the assignments form parameters. The update logic is now stored within a separate function 'update_form_params_with_existing' that is called within the create method of the controller.
[[File:e2327 1.png|1000px|]] 
[[File:e2327 2.png|1000px|]] 
* To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test the refactoring for the copy method within the assignment_form.rb
|-
| 2 || Test to create assignment and check Back button functionality
|-
| 3 || Test to check Back button functionality without creation
|}

* To the test the refactored copy method of the assignment form, we have included a unit test to mock the creation of a new assignment and trigger the copy method of Assignment object. We then verify the various fields of the copied object to ensure correctness after code refactoring.
<pre>
require 'rails_helper'

RSpec.describe Assignment, type: :model do
describe '.copy' do
let!(:user) { create(:user) }
let!(:old_assignment) { create(:assignment) }

it 'creates a copy of the assignment' do
new_assignment_id = Assignment.copy(old_assignment.id, user)

expect(new_assignment_id).not_to be_nil
expect(old_assignment.name).not_to eq(new_assignment.name)
expect(old_assignment.directory_path).not_to eq(new_assignment.directory_path)
expect(old_assignment.copy_flag).not_to eq(new_assignment.copy_flag)
end
end
end

</pre>

=== Test Screenshots ===

Will be added soon.

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-13T01:11:53Z

Smaraba: /* Changes made */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the review comments provided for the last implementation. Hence we will not be updating existing design patters, and instead will be introducing Refactoring within the existing code. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient.

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

* First, we identified the code in <code> assignments_controller.rb </code> that is breaking the backlinks and changed it here.
[[File:E2327_change0.png|500px|]] 

* Next, we extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

* To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
* To improve code readability in the assignment controller, we have separated the functionality of updating the assignments form parameters. The update logic is now stored within a separate function 'update_form_params_with_existing' that is called within the create method of the controller.
[[File:e2327 1.png|1000px|]] 
[[File:e2327 2.png|1000px|]] 
* To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test the refactoring for the copy method within the assignment_form.rb
|-
| 2 || Test to create assignment and check Back button functionality
|-
| 3 || Test to check Back button functionality without creation
|}

* To the test the refactored copy method of the assignment form, we have included a unit test to mock the creation of a new assignment and trigger the copy method of Assignment object. We then verify the various fields of the copied object to ensure correctness after code refactoring.
<pre>
require 'rails_helper'

RSpec.describe Assignment, type: :model do
describe '.copy' do
let!(:user) { create(:user) }
let!(:old_assignment) { create(:assignment) }

it 'creates a copy of the assignment' do
new_assignment_id = Assignment.copy(old_assignment.id, user)

expect(new_assignment_id).not_to be_nil
expect(old_assignment.name).not_to eq(new_assignment.name)
expect(old_assignment.directory_path).not_to eq(new_assignment.directory_path)
expect(old_assignment.copy_flag).not_to eq(new_assignment.copy_flag)
end
end
end

</pre>

=== Test Screenshots ===

Will be added soon.

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-13T01:11:15Z

Smaraba: /* Changes made */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the review comments provided for the last implementation. Hence we will not be updating existing design patters, and instead will be introducing Refactoring within the existing code. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient.

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

* First, we identified the code in <code> assignments_controller.rb </code> that is breaking the backlinks and changed it here.
[[File:E2327_change0.png|1000px|]] 

* Next, we extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

* To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
* To improve code readability in the assignment controller, we have separated the functionality of updating the assignments form parameters. The update logic is now stored within a separate function 'update_form_params_with_existing' that is called within the create method of the controller.
[[File:e2327 1.png|1000px|]] 
[[File:e2327 2.png|1000px|]] 
* To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test the refactoring for the copy method within the assignment_form.rb
|-
| 2 || Test to create assignment and check Back button functionality
|-
| 3 || Test to check Back button functionality without creation
|}

* To the test the refactored copy method of the assignment form, we have included a unit test to mock the creation of a new assignment and trigger the copy method of Assignment object. We then verify the various fields of the copied object to ensure correctness after code refactoring.
<pre>
require 'rails_helper'

RSpec.describe Assignment, type: :model do
describe '.copy' do
let!(:user) { create(:user) }
let!(:old_assignment) { create(:assignment) }

it 'creates a copy of the assignment' do
new_assignment_id = Assignment.copy(old_assignment.id, user)

expect(new_assignment_id).not_to be_nil
expect(old_assignment.name).not_to eq(new_assignment.name)
expect(old_assignment.directory_path).not_to eq(new_assignment.directory_path)
expect(old_assignment.copy_flag).not_to eq(new_assignment.copy_flag)
end
end
end

</pre>

=== Test Screenshots ===

Will be added soon.

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-13T01:10:39Z

Smaraba: /* Changes made */

==Problem Description==

=== Project Overview ===
Expertiza was created as an online platform to assist in peer reviewing and submission of academic work, which can include articles, codes, and websites. With this application, instructors are given the ability to add assignments, grade them, and allocate students into teams based on their preferred topics.
The Expertiza platform provides a 'Late Policy' feature that can be applied to any assignment, so that points are automatically deducted if a student submits or reviews projects or assignments late after the due date has passed.The Late Policy feature is implemented by applying the policy to an assignment through the Due Dates tab during creation or editing of an assignment.
The goal of this project is to address certain comments and issues associated with the solutions to the problems related to "Back" link on the "New Late Policy" page by making appropriate modifications and adding comprehensive test cases that cover all possible scenarios.

==Project Scope==

=== Aim of this Project ===
Te aim of this project is listed as follows:

# Improving code structure and documentation via refactoring
# Adding code comments for parts of code refactored or improved
# Improving code readability
# Writing tests for any changes made
# Removing redundant or unused code

=== Problems Resolved in the Current Implementation ===
==== Work Flow Diagram ====
[[File:Project_Scope_late.png]]

==== Issues ====
The following problems have been covered and corrected in the current implementation:

===== '''Issue 1: Removing Error Message''' =====
Under the “Due Date” tab when click on the "New late policy" link an error message shows up.
[[File:Issue-1.png|800px|]]
====='''Issue 2: Fixing Back Link''' =====
When creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue2WhenBackisclicked.png|800px]]
====='''Issue 3: Fixing Back Link upon creation''' =====
After creating a late policy, the “back” link does not take the user back to editing the assignment.
[[File:Issue-3FromList.png|800px|]]

==== Resolution ====
The following are the screenshots after the issues were resolved within the current implementation:

* '''Issue 1''' - Resolution where the error message doesn't show up.
[[File: Assignmentse2327.png|800px|]] 
[[File: Betterediting.png|800px|]] 
* '''Issue 2''' - Displaying back link takes back to late policies
[[File: Latepolicy.png|800px]]
* '''Issue 3''' - After creation of late policy, back link takes back to late policies
[[File: Newlatepolicy.png|800px|]] 
[[File: Latepolicy.png|800px]]

== Design Principle ==
The aim of our project is to improve upon the existing implementation by addressing the review comments provided for the last implementation. Hence we will not be updating existing design patters, and instead will be introducing Refactoring within the existing code. 
Refactoring is the process of improving the structure, design, and/or implementation of an existing codebase without changing its external behavior. It involves making small, incremental changes to the code to make it more maintainable, easier to understand, and more efficient.

== Solution and Files Refactored ==
=== Files Refactored or Modified ===
* assignment_form.rb
* assignments_controller.rb
* late_policy_spec.rb

=== Changes made ===
We made the following refactorings within the existing solution to improve code readability and maintain sound workflow.

* First, we identified the code that is breaking the backlinks and changed it here.
[[File:E2327_change0.png|1000px|]] 

* Next, we extracted the method that is responsible for maintaining a check on duplicate assignment name and directory path for a given course ID. To ensure that the create method is readable and responsible for carrying out only a single responsibility of creating the assignment, we have separated the checking responsibilities from the code:
[[File:Change1 e2327.png|1000px|]] 

[[File:Change12 e2327.png|1000px|]] 

* To improve the correctness of the code and avoid any illegal modifications of error messages, we have change the access modifier for the attribute error messages:
[[File:Change2 e2327.png|1000px|]] 
* To improve code readability in the assignment controller, we have separated the functionality of updating the assignments form parameters. The update logic is now stored within a separate function 'update_form_params_with_existing' that is called within the create method of the controller.
[[File:e2327 1.png|1000px|]] 
[[File:e2327 2.png|1000px|]] 
* To improve the code readability, we have refactored the local variable names used within the assignment form as follows:
[[File:e2327 3.png|1000px|]] 
[[File:e2327 4.png|1000px|]] 

== Testing ==

=== RSpec Unit Tests ===

We plan to provide RSpec Unit Tests within the Late Policy Spec page on top of the existing tests in the form of simple unit tests to ensure that our changes and modifications do not break the working logic of the existing implementation.

====Tests====

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || Test the refactoring for the copy method within the assignment_form.rb
|-
| 2 || Test to create assignment and check Back button functionality
|-
| 3 || Test to check Back button functionality without creation
|}

* To the test the refactored copy method of the assignment form, we have included a unit test to mock the creation of a new assignment and trigger the copy method of Assignment object. We then verify the various fields of the copied object to ensure correctness after code refactoring.
<pre>
require 'rails_helper'

RSpec.describe Assignment, type: :model do
describe '.copy' do
let!(:user) { create(:user) }
let!(:old_assignment) { create(:assignment) }

it 'creates a copy of the assignment' do
new_assignment_id = Assignment.copy(old_assignment.id, user)

expect(new_assignment_id).not_to be_nil
expect(old_assignment.name).not_to eq(new_assignment.name)
expect(old_assignment.directory_path).not_to eq(new_assignment.directory_path)
expect(old_assignment.copy_flag).not_to eq(new_assignment.copy_flag)
end
end
end

</pre>

=== Test Screenshots ===

Will be added soon.

=== Manual Testing ===
*When logging in as an instructor:
1. Edit an assignment by clicking on edit logo under the “Action” column. 
2. Under the “Due Date” tab click on the "New late policy" link. 
3. In “New late policy” fill in the required details. 
4. Clicks “Create” to save the policy, to go to page which shows all late policies. 
5. Clicks “Back” to redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 
Or 
4. Clicking “Back”, should redirect the instructor back to the “Due Date” tab of the assignment which was being edited. 

==Team==
===Mentor ===
Divyang Doshi(ddoshi2@ncsu.edu)

===Team Members ===
Amisha Bipin Waghela (awaghel@ncsu.edu) 
Sasank Marabattula (smaraba@ncsu.edu) 
Srilekha Gudipati (sngudipa@ncsu.edu)

=='''Reference'''==
[https://github.com/expertiza/expertiza/pull/2564 Github PR for E2327]

[http://wiki.expertiza.ncsu.edu/index.php/Main_Page Expertiza_wiki]

[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza Documentation]

[https://github.com/expertiza/expertiza Expertiza Github]

File:E2327 change0.png

2023-04-13T01:09:04Z

Smaraba:

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-08T19:07:21Z

Smaraba: /* Team Members */

CSC/ECE 517 Spring 2023 - E2327. Fix Back link on New Late Policy page

2023-04-07T20:44:16Z

Smaraba: Created page with "CSC/ECE 517 Spring 2023 - E2327. Fix "Back" link on “New Late Policy” page"

CSC/ECE 517 Spring 2023 - E2327. Fix "Back" link on “New Late Policy” page

CSC/ECE 517 Spring 2023 - E2303 Refactor teams controller.rb

2023-03-27T22:17:36Z

Smaraba: /* Test Coverage */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.

==Introduction==

In this project we refactored teams_controller.rb and some associated files with it. Some duplicate code was removed. We added some comments for readability. Also, the hindi yml file was modified to enhance it.

==Issues Fixed==

# Refactored code in <code>teams_controller.rb</code>
#* Added more comments and briefly explained the functionality of all methods
#* Found areas in the code where the DRY principle can be applied
#* Refactored the function <code>bequeath_all</code> to improve readability by including function <code>copy_teams</code>
#* Refactored function <code>copy_teams</code> that calls <code>choose_copy_type</code>, which calls <code>bequeath_copy</code> or <code>inherit_copy</code> based on bequeath
# Refactored code in <code>team.rb</code>
#* Added more comments to some methods in the code
#* Found areas in the code where the DRY principle can be applied
# Made changes to <code>hi_IN.yml</code> file, by adding more annotations and some grammatical errors
# Added more coverage to test by modifying <code>teams_controller_spec.rb</code>

==Files Changed==

* app/controllers/teams_controller.rb
* app/models/team.rb
* config/locales/hi_IN.yml
* spec/controllers/teams_controller_spec.rb
* expertiza/app/views/teams/list.html.erb

==Changes==

===Fix #1===

The code in <code>teams_controller.rb</code> for function <code>bequeath_all</code> was too long, which would make it unreadable. To achieve it, a function <code>copy_teams</code> was added to the code.
<nowiki>
# Handovers all teams to the course that contains the corresponding assignment
# The team and team members are all copied.
def bequeath_all
if session[:team_type] == Team.allowed_types[1]
flash[:error] = 'Invalid team type for bequeath all'
redirect_to controller: 'teams', action: 'list', id: params[:id]
else
copy_teams(Team.team_operation[:bequeath])
end
end
</nowiki>

The function <code>copy_teams</code> is refactored further to improve it. The function <code>choose_copy_type</code> is refactored further to either perform <code>bequeath_copy</code> or <code>inherit_copy</code> based on team operation.
<nowiki>
# Method to abstract the functionality to copy teams.
def copy_teams(operation)
assignment = Assignment.find(params[:id])
if assignment.course_id
choose_copy_type(assignment, operation)
else
flash[:error] = 'No course was found for this assignment.'
end
redirect_to controller: 'teams', action: 'list', id: assignment.id
end

# Abstraction over different methods
def choose_copy_type(assignment, operation)
course = Course.find(assignment.course_id)
if operation == Team.team_operation[:bequeath]
bequeath_copy(assignment, course)
else
inherit_copy(assignment, course)
end
end

# Method to perform a copy of assignment teams to course
def bequeath_copy(assignment, course)
teams = assignment.teams
if course.course_teams.any?
flash[:error] = 'The course already has associated teams'
else
Team.copy_content(teams, course)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + course.name + '"'
end
end

# Method to inherit teams from course by copying
def inherit_copy(assignment, course)
teams = course.course_teams
if teams.empty?
flash[:error] = 'No teams were found when trying to inherit.'
else
Team.copy_content(teams, assignment)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + assignment.name + '"'
end
end

</nowiki>

===Fix #2===

The file <code>teams.rb</code> had an area where DRY principle could be applied. Function <code>randomize_all_by_parent</code> was modified to decrease the number of lines of code. The snippet to find teams still need team members and users who are not in any team has been modified, below is the code snippet.

<code>
teams = Team.where(parent_id: parent.id, type: parent.class.to_s + 'Team').to_a
teams.each { |team| TeamsUser.where(team_id: team.id).each { |teams_user| users.delete(User.find(teams_user.user_id)) } }
teams.reject! { |team| Team.size(team.id) >= min_team_size }</code>

===Fix #3===

The file <code>hi_IN.yml</code> has some formatting in annotations that needed to be taken care of. For example, in Hindi, a sentence ending is indicated by the symbol "|", but it is given as "." everywhere. This was taken care of in the code, wherever Hindi annotations are available. Also, some additional annotations were added for <code>datetime->distance_in_words</code> key, where the annotations were modified to maintain uniformity throughout this key.

==Test Plan==

The teams controller testing document has been covered well by the previous teams, however after detailed analysis of the test file, we found more edge cases that need to be tested, hence we added two new test cases. There was a test which was commented, it is found to be not required, and hence it was removed, while some of them had to be modified to correction.

===Test Coverage===

Coverage has slightly improved, as evident from the below image.Firstly, we have added new tests to cover more edge cases and Secondly, the number of lines in team.rb file has decreased as a result of refactoring.
[[File:Coverage.png]]

======Added Tests======

'''1.''' In the test <code>edit method</code>, we added a test for when team with given id that exists. We also added a code when team with given id does not exist.

[[File:added_tests1.png]]

Also, for test <code>create teams method</code>, added a test case for when incorrect parameters are passed.

[[File:incorrect_parameters.png]]

======Modified Tests======

'''2.''' In the test <code> create method</code>, there was a test case which was redundant, because a create method will ideally be called with a team that doesn't exist. Therefore, we removed this test.

[[File:removed_nonworking_test.png]]

'''3.''' There was some confusion about the function <code>choose_copy_type, bequeath_copy and inherit_copy</code>. In the test <code>inherit method</code>, the function <code>inherit_copy</code> was tested under <code>inherit method</code> (lines 180 - 220). Similarly, <code>bequeath_copy</code> was tested under <code>#bequeath_all</code> (lines 222 - 266).

'''4.''' In the test <code> delete method</code>, some redundant comments were made, that was removed as well.

'''5.''' Some minor changes were made to some of the test cases.

==Contributors==
This project was done as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Sasank Marabattula, Srilekha Gudipati and Varun Deepak Gudhe. Our project mentor was Divyang Doshi.

File:Incorrect parameters.png

2023-03-27T22:16:23Z

Smaraba: Smaraba uploaded a new version of File:Incorrect parameters.png

CSC/ECE 517 Spring 2023 - E2303 Refactor teams controller.rb

2023-03-27T22:15:44Z

Smaraba: /* Added Tests */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.

==Introduction==

In this project we refactored teams_controller.rb and some associated files with it. Some duplicate code was removed. We added some comments for readability. Also, the hindi yml file was modified to enhance it.

==Issues Fixed==

# Refactored code in <code>teams_controller.rb</code>
#* Added more comments and briefly explained the functionality of all methods
#* Found areas in the code where the DRY principle can be applied
#* Refactored the function <code>bequeath_all</code> to improve readability by including function <code>copy_teams</code>
#* Refactored function <code>copy_teams</code> that calls <code>choose_copy_type</code>, which calls <code>bequeath_copy</code> or <code>inherit_copy</code> based on bequeath
# Refactored code in <code>team.rb</code>
#* Added more comments to some methods in the code
#* Found areas in the code where the DRY principle can be applied
# Made changes to <code>hi_IN.yml</code> file, by adding more annotations and some grammatical errors
# Added more coverage to test by modifying <code>teams_controller_spec.rb</code>

==Files Changed==

* app/controllers/teams_controller.rb
* app/models/team.rb
* config/locales/hi_IN.yml
* spec/controllers/teams_controller_spec.rb
* expertiza/app/views/teams/list.html.erb

==Changes==

===Fix #1===

The code in <code>teams_controller.rb</code> for function <code>bequeath_all</code> was too long, which would make it unreadable. To achieve it, a function <code>copy_teams</code> was added to the code.
<nowiki>
# Handovers all teams to the course that contains the corresponding assignment
# The team and team members are all copied.
def bequeath_all
if session[:team_type] == Team.allowed_types[1]
flash[:error] = 'Invalid team type for bequeath all'
redirect_to controller: 'teams', action: 'list', id: params[:id]
else
copy_teams(Team.team_operation[:bequeath])
end
end
</nowiki>

The function <code>copy_teams</code> is refactored further to improve it. The function <code>choose_copy_type</code> is refactored further to either perform <code>bequeath_copy</code> or <code>inherit_copy</code> based on team operation.
<nowiki>
# Method to abstract the functionality to copy teams.
def copy_teams(operation)
assignment = Assignment.find(params[:id])
if assignment.course_id
choose_copy_type(assignment, operation)
else
flash[:error] = 'No course was found for this assignment.'
end
redirect_to controller: 'teams', action: 'list', id: assignment.id
end

# Abstraction over different methods
def choose_copy_type(assignment, operation)
course = Course.find(assignment.course_id)
if operation == Team.team_operation[:bequeath]
bequeath_copy(assignment, course)
else
inherit_copy(assignment, course)
end
end

# Method to perform a copy of assignment teams to course
def bequeath_copy(assignment, course)
teams = assignment.teams
if course.course_teams.any?
flash[:error] = 'The course already has associated teams'
else
Team.copy_content(teams, course)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + course.name + '"'
end
end

# Method to inherit teams from course by copying
def inherit_copy(assignment, course)
teams = course.course_teams
if teams.empty?
flash[:error] = 'No teams were found when trying to inherit.'
else
Team.copy_content(teams, assignment)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + assignment.name + '"'
end
end

</nowiki>

===Fix #2===

The file <code>teams.rb</code> had an area where DRY principle could be applied. Function <code>randomize_all_by_parent</code> was modified to decrease the number of lines of code. The snippet to find teams still need team members and users who are not in any team has been modified, below is the code snippet.

<code>
teams = Team.where(parent_id: parent.id, type: parent.class.to_s + 'Team').to_a
teams.each { |team| TeamsUser.where(team_id: team.id).each { |teams_user| users.delete(User.find(teams_user.user_id)) } }
teams.reject! { |team| Team.size(team.id) >= min_team_size }</code>

===Fix #3===

The file <code>hi_IN.yml</code> has some formatting in annotations that needed to be taken care of. For example, in Hindi, a sentence ending is indicated by the symbol "|", but it is given as "." everywhere. This was taken care of in the code, wherever Hindi annotations are available. Also, some additional annotations were added for <code>datetime->distance_in_words</code> key, where the annotations were modified to maintain uniformity throughout this key.

==Test Plan==

The teams controller testing document has been covered well by the previous teams, however after detailed analysis of the test file, we found more edge cases that need to be tested, hence we added two new test cases. There was a test which was commented, it is found to be not required, and hence it was removed, while some of them had to be modified to correction.

===Test Coverage===

Coverage has slightly improved, as evident from the below image.
[[File:Coverage.png]]

======Added Tests======

'''1.''' In the test <code>edit method</code>, we added a test for when team with given id that exists. We also added a code when team with given id does not exist.

[[File:added_tests1.png]]

Also, for test <code>create teams method</code>, added a test case for when incorrect parameters are passed.

[[File:incorrect_parameters.png]]

======Modified Tests======

'''2.''' In the test <code> create method</code>, there was a test case which was redundant, because a create method will ideally be called with a team that doesn't exist. Therefore, we removed this test.

[[File:removed_nonworking_test.png]]

'''3.''' There was some confusion about the function <code>choose_copy_type, bequeath_copy and inherit_copy</code>. In the test <code>inherit method</code>, the function <code>inherit_copy</code> was tested under <code>inherit method</code> (lines 180 - 220). Similarly, <code>bequeath_copy</code> was tested under <code>#bequeath_all</code> (lines 222 - 266).

'''4.''' In the test <code> delete method</code>, some redundant comments were made, that was removed as well.

'''5.''' Some minor changes were made to some of the test cases.

==Contributors==
This project was done as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Sasank Marabattula, Srilekha Gudipati and Varun Deepak Gudhe. Our project mentor was Divyang Doshi.

File:Incorrect parameters.png

2023-03-27T22:13:41Z

Smaraba:

CSC/ECE 517 Spring 2023 - E2303 Refactor teams controller.rb

2023-03-27T22:12:14Z

Smaraba: /* Added Tests */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.

==Introduction==

In this project we refactored teams_controller.rb and some associated files with it. Some duplicate code was removed. We added some comments for readability. Also, the hindi yml file was modified to enhance it.

==Issues Fixed==

# Refactored code in <code>teams_controller.rb</code>
#* Added more comments and briefly explained the functionality of all methods
#* Found areas in the code where the DRY principle can be applied
#* Refactored the function <code>bequeath_all</code> to improve readability by including function <code>copy_teams</code>
#* Refactored function <code>copy_teams</code> that calls <code>choose_copy_type</code>, which calls <code>bequeath_copy</code> or <code>inherit_copy</code> based on bequeath
# Refactored code in <code>team.rb</code>
#* Added more comments to some methods in the code
#* Found areas in the code where the DRY principle can be applied
# Made changes to <code>hi_IN.yml</code> file, by adding more annotations and some grammatical errors
# Added more coverage to test by modifying <code>teams_controller_spec.rb</code>

==Files Changed==

* app/controllers/teams_controller.rb
* app/models/team.rb
* config/locales/hi_IN.yml
* spec/controllers/teams_controller_spec.rb
* expertiza/app/views/teams/list.html.erb

==Changes==

===Fix #1===

The code in <code>teams_controller.rb</code> for function <code>bequeath_all</code> was too long, which would make it unreadable. To achieve it, a function <code>copy_teams</code> was added to the code.
<nowiki>
# Handovers all teams to the course that contains the corresponding assignment
# The team and team members are all copied.
def bequeath_all
if session[:team_type] == Team.allowed_types[1]
flash[:error] = 'Invalid team type for bequeath all'
redirect_to controller: 'teams', action: 'list', id: params[:id]
else
copy_teams(Team.team_operation[:bequeath])
end
end
</nowiki>

The function <code>copy_teams</code> is refactored further to improve it. The function <code>choose_copy_type</code> is refactored further to either perform <code>bequeath_copy</code> or <code>inherit_copy</code> based on team operation.
<nowiki>
# Method to abstract the functionality to copy teams.
def copy_teams(operation)
assignment = Assignment.find(params[:id])
if assignment.course_id
choose_copy_type(assignment, operation)
else
flash[:error] = 'No course was found for this assignment.'
end
redirect_to controller: 'teams', action: 'list', id: assignment.id
end

# Abstraction over different methods
def choose_copy_type(assignment, operation)
course = Course.find(assignment.course_id)
if operation == Team.team_operation[:bequeath]
bequeath_copy(assignment, course)
else
inherit_copy(assignment, course)
end
end

# Method to perform a copy of assignment teams to course
def bequeath_copy(assignment, course)
teams = assignment.teams
if course.course_teams.any?
flash[:error] = 'The course already has associated teams'
else
Team.copy_content(teams, course)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + course.name + '"'
end
end

# Method to inherit teams from course by copying
def inherit_copy(assignment, course)
teams = course.course_teams
if teams.empty?
flash[:error] = 'No teams were found when trying to inherit.'
else
Team.copy_content(teams, assignment)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + assignment.name + '"'
end
end

</nowiki>

===Fix #2===

The file <code>teams.rb</code> had an area where DRY principle could be applied. Function <code>randomize_all_by_parent</code> was modified to decrease the number of lines of code. The snippet to find teams still need team members and users who are not in any team has been modified, below is the code snippet.

<code>
teams = Team.where(parent_id: parent.id, type: parent.class.to_s + 'Team').to_a
teams.each { |team| TeamsUser.where(team_id: team.id).each { |teams_user| users.delete(User.find(teams_user.user_id)) } }
teams.reject! { |team| Team.size(team.id) >= min_team_size }</code>

===Fix #3===

The file <code>hi_IN.yml</code> has some formatting in annotations that needed to be taken care of. For example, in Hindi, a sentence ending is indicated by the symbol "|", but it is given as "." everywhere. This was taken care of in the code, wherever Hindi annotations are available. Also, some additional annotations were added for <code>datetime->distance_in_words</code> key, where the annotations were modified to maintain uniformity throughout this key.

==Test Plan==

The teams controller testing document has been covered well by the previous teams, however after detailed analysis of the test file, we found more edge cases that need to be tested, hence we added two new test cases. There was a test which was commented, it is found to be not required, and hence it was removed, while some of them had to be modified to correction.

===Test Coverage===

Coverage has slightly improved, as evident from the below image.
[[File:Coverage.png]]

======Added Tests======

'''1.''' In the test <code>edit method</code>, we added a test for incorrect parameters passed into the method. We also added a code when team with given id does not exist.

[[File:added_tests1.png]]

Also, for test <code>create teams method</code>, added a test case for when incorrect parameters are passed.

[[File:incorrect_parameters.png]]

======Modified Tests======

'''2.''' In the test <code> create method</code>, there was a test case which was redundant, because a create method will ideally be called with a team that doesn't exist. Therefore, we removed this test.

[[File:removed_nonworking_test.png]]

'''3.''' There was some confusion about the function <code>choose_copy_type, bequeath_copy and inherit_copy</code>. In the test <code>inherit method</code>, the function <code>inherit_copy</code> was tested under <code>inherit method</code> (lines 180 - 220). Similarly, <code>bequeath_copy</code> was tested under <code>#bequeath_all</code> (lines 222 - 266).

'''4.''' In the test <code> delete method</code>, some redundant comments were made, that was removed as well.

'''5.''' Some minor changes were made to some of the test cases.

==Contributors==
This project was done as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Sasank Marabattula, Srilekha Gudipati and Varun Deepak Gudhe. Our project mentor was Divyang Doshi.

CSC/ECE 517 Spring 2023 - E2303 Refactor teams controller.rb

2023-03-27T22:09:43Z

Smaraba: /* Test Coverage */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.

==Introduction==

In this project we refactored teams_controller.rb and some associated files with it. Some duplicate code was removed. We added some comments for readability. Also, the hindi yml file was modified to enhance it.

==Issues Fixed==

# Refactored code in <code>teams_controller.rb</code>
#* Added more comments and briefly explained the functionality of all methods
#* Found areas in the code where the DRY principle can be applied
#* Refactored the function <code>bequeath_all</code> to improve readability by including function <code>copy_teams</code>
#* Refactored function <code>copy_teams</code> that calls <code>choose_copy_type</code>, which calls <code>bequeath_copy</code> or <code>inherit_copy</code> based on bequeath
# Refactored code in <code>team.rb</code>
#* Added more comments to some methods in the code
#* Found areas in the code where the DRY principle can be applied
# Made changes to <code>hi_IN.yml</code> file, by adding more annotations and some grammatical errors
# Added more coverage to test by modifying <code>teams_controller_spec.rb</code>

==Files Changed==

* app/controllers/teams_controller.rb
* app/models/team.rb
* config/locales/hi_IN.yml
* spec/controllers/teams_controller_spec.rb
* expertiza/app/views/teams/list.html.erb

==Changes==

===Fix #1===

The code in <code>teams_controller.rb</code> for function <code>bequeath_all</code> was too long, which would make it unreadable. To achieve it, a function <code>copy_teams</code> was added to the code.
<nowiki>
# Handovers all teams to the course that contains the corresponding assignment
# The team and team members are all copied.
def bequeath_all
if session[:team_type] == Team.allowed_types[1]
flash[:error] = 'Invalid team type for bequeath all'
redirect_to controller: 'teams', action: 'list', id: params[:id]
else
copy_teams(Team.team_operation[:bequeath])
end
end
</nowiki>

The function <code>copy_teams</code> is refactored further to improve it. The function <code>choose_copy_type</code> is refactored further to either perform <code>bequeath_copy</code> or <code>inherit_copy</code> based on team operation.
<nowiki>
# Method to abstract the functionality to copy teams.
def copy_teams(operation)
assignment = Assignment.find(params[:id])
if assignment.course_id
choose_copy_type(assignment, operation)
else
flash[:error] = 'No course was found for this assignment.'
end
redirect_to controller: 'teams', action: 'list', id: assignment.id
end

# Abstraction over different methods
def choose_copy_type(assignment, operation)
course = Course.find(assignment.course_id)
if operation == Team.team_operation[:bequeath]
bequeath_copy(assignment, course)
else
inherit_copy(assignment, course)
end
end

# Method to perform a copy of assignment teams to course
def bequeath_copy(assignment, course)
teams = assignment.teams
if course.course_teams.any?
flash[:error] = 'The course already has associated teams'
else
Team.copy_content(teams, course)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + course.name + '"'
end
end

# Method to inherit teams from course by copying
def inherit_copy(assignment, course)
teams = course.course_teams
if teams.empty?
flash[:error] = 'No teams were found when trying to inherit.'
else
Team.copy_content(teams, assignment)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + assignment.name + '"'
end
end

</nowiki>

===Fix #2===

The file <code>teams.rb</code> had an area where DRY principle could be applied. Function <code>randomize_all_by_parent</code> was modified to decrease the number of lines of code. The snippet to find teams still need team members and users who are not in any team has been modified, below is the code snippet.

<code>
teams = Team.where(parent_id: parent.id, type: parent.class.to_s + 'Team').to_a
teams.each { |team| TeamsUser.where(team_id: team.id).each { |teams_user| users.delete(User.find(teams_user.user_id)) } }
teams.reject! { |team| Team.size(team.id) >= min_team_size }</code>

===Fix #3===

The file <code>hi_IN.yml</code> has some formatting in annotations that needed to be taken care of. For example, in Hindi, a sentence ending is indicated by the symbol "|", but it is given as "." everywhere. This was taken care of in the code, wherever Hindi annotations are available. Also, some additional annotations were added for <code>datetime->distance_in_words</code> key, where the annotations were modified to maintain uniformity throughout this key.

==Test Plan==

The teams controller testing document has been covered well by the previous teams, however after detailed analysis of the test file, we found more edge cases that need to be tested, hence we added two new test cases. There was a test which was commented, it is found to be not required, and hence it was removed, while some of them had to be modified to correction.

===Test Coverage===

Coverage has slightly improved, as evident from the below image.
[[File:Coverage.png]]

======Added Tests======

'''1.''' In the test <code>create teams method</code>, we added a test for incorrect parameters passed into the method. We also added a code when team with given id does not exist.

[[File:added_tests1.png]]

======Modified Tests======

'''2.''' In the test <code> create method</code>, there was a test case which was redundant, because a create method will ideally be called with a team that doesn't exist. Therefore, we removed this test.

[[File:removed_nonworking_test.png]]

'''3.''' There was some confusion about the function <code>choose_copy_type, bequeath_copy and inherit_copy</code>. In the test <code>inherit method</code>, the function <code>inherit_copy</code> was tested under <code>inherit method</code> (lines 180 - 220). Similarly, <code>bequeath_copy</code> was tested under <code>#bequeath_all</code> (lines 222 - 266).

'''4.''' In the test <code> delete method</code>, some redundant comments were made, that was removed as well.

'''5.''' Some minor changes were made to some of the test cases.

==Contributors==
This project was done as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Sasank Marabattula, Srilekha Gudipati and Varun Deepak Gudhe. Our project mentor was Divyang Doshi.

CSC/ECE 517 Spring 2023 - E2303 Refactor teams controller.rb

2023-03-27T22:01:08Z

Smaraba: /* Test Plan */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.

==Introduction==

In this project we refactored teams_controller.rb and some associated files with it. Some duplicate code was removed. We added some comments for readability. Also, the hindi yml file was modified to enhance it.

==Issues Fixed==

# Refactored code in <code>teams_controller.rb</code>
#* Added more comments and briefly explained the functionality of all methods
#* Found areas in the code where the DRY principle can be applied
#* Refactored the function <code>bequeath_all</code> to improve readability by including function <code>copy_teams</code>
#* Refactored function <code>copy_teams</code> that calls <code>choose_copy_type</code>, which calls <code>bequeath_copy</code> or <code>inherit_copy</code> based on bequeath
# Refactored code in <code>team.rb</code>
#* Added more comments to some methods in the code
#* Found areas in the code where the DRY principle can be applied
# Made changes to <code>hi_IN.yml</code> file, by adding more annotations and some grammatical errors
# Added more coverage to test by modifying <code>teams_controller_spec.rb</code>

==Files Changed==

* app/controllers/teams_controller.rb
* app/models/team.rb
* config/locales/hi_IN.yml
* spec/controllers/teams_controller_spec.rb
* expertiza/app/views/teams/list.html.erb

==Changes==

===Fix #1===

The code in <code>teams_controller.rb</code> for function <code>bequeath_all</code> was too long, which would make it unreadable. To achieve it, a function <code>copy_teams</code> was added to the code.
<nowiki>
# Handovers all teams to the course that contains the corresponding assignment
# The team and team members are all copied.
def bequeath_all
if session[:team_type] == Team.allowed_types[1]
flash[:error] = 'Invalid team type for bequeath all'
redirect_to controller: 'teams', action: 'list', id: params[:id]
else
copy_teams(Team.team_operation[:bequeath])
end
end
</nowiki>

The function <code>copy_teams</code> is refactored further to improve it. The function <code>choose_copy_type</code> is refactored further to either perform <code>bequeath_copy</code> or <code>inherit_copy</code> based on team operation.
<nowiki>
# Method to abstract the functionality to copy teams.
def copy_teams(operation)
assignment = Assignment.find(params[:id])
if assignment.course_id
choose_copy_type(assignment, operation)
else
flash[:error] = 'No course was found for this assignment.'
end
redirect_to controller: 'teams', action: 'list', id: assignment.id
end

# Abstraction over different methods
def choose_copy_type(assignment, operation)
course = Course.find(assignment.course_id)
if operation == Team.team_operation[:bequeath]
bequeath_copy(assignment, course)
else
inherit_copy(assignment, course)
end
end

# Method to perform a copy of assignment teams to course
def bequeath_copy(assignment, course)
teams = assignment.teams
if course.course_teams.any?
flash[:error] = 'The course already has associated teams'
else
Team.copy_content(teams, course)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + course.name + '"'
end
end

# Method to inherit teams from course by copying
def inherit_copy(assignment, course)
teams = course.course_teams
if teams.empty?
flash[:error] = 'No teams were found when trying to inherit.'
else
Team.copy_content(teams, assignment)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + assignment.name + '"'
end
end

</nowiki>

===Fix #2===

The file <code>teams.rb</code> had an area where DRY principle could be applied. Function <code>randomize_all_by_parent</code> was modified to decrease the number of lines of code. The snippet to find teams still need team members and users who are not in any team has been modified, below is the code snippet.

<code>
teams = Team.where(parent_id: parent.id, type: parent.class.to_s + 'Team').to_a
teams.each { |team| TeamsUser.where(team_id: team.id).each { |teams_user| users.delete(User.find(teams_user.user_id)) } }
teams.reject! { |team| Team.size(team.id) >= min_team_size }</code>

===Fix #3===

The file <code>hi_IN.yml</code> has some formatting in annotations that needed to be taken care of. For example, in Hindi, a sentence ending is indicated by the symbol "|", but it is given as "." everywhere. This was taken care of in the code, wherever Hindi annotations are available. Also, some additional annotations were added for <code>datetime->distance_in_words</code> key, where the annotations were modified to maintain uniformity throughout this key.

==Test Plan==

The teams controller testing document has been covered well by the previous teams, however after detailed analysis of the test file, we found more edge cases that need to be tested, hence we added two new test cases. There was a test which was commented, it is found to be not required, and hence it was removed, while some of them had to be modified to correction.

===Test Coverage===

Coverage has slightly improved, as the number of lines in team.rb file has decreased as a result of refactoring.

[[File:Coverage.png]]

======Added Tests======

'''1.''' In the test <code>create teams method</code>, we added a test for incorrect parameters passed into the method. We also added a code when team with given id does not exist.

[[File:added_tests1.png]]

======Modified Tests======

'''2.''' In the test <code> create method</code>, there was a test case which was redundant, because a create method will ideally be called with a team that doesn't exist. Therefore, we removed this test.

[[File:removed_nonworking_test.png]]

'''3.''' There was some confusion about the function <code>choose_copy_type, bequeath_copy and inherit_copy</code>. In the test <code>inherit method</code>, the function <code>inherit_copy</code> was tested under <code>inherit method</code> (lines 180 - 220). Similarly, <code>bequeath_copy</code> was tested under <code>#bequeath_all</code> (lines 222 - 266).

'''4.''' In the test <code> delete method</code>, some redundant comments were made, that was removed as well.

'''5.''' Some minor changes were made to some of the test cases.

==Contributors==
This project was done as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Sasank Marabattula, Srilekha Gudipati and Varun Deepak Gudhe. Our project mentor was Divyang Doshi.

File:Coverage.png

2023-03-27T21:59:41Z

Smaraba: Smaraba uploaded a new version of File:Coverage.png

CSC/ECE 517 Spring 2023 - E2303 Refactor teams controller.rb

2023-03-27T21:56:35Z

Smaraba: /* Test Plan */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.

==Introduction==

In this project we refactored teams_controller.rb and some associated files with it. Some duplicate code was removed. We added some comments for readability. Also, the hindi yml file was modified to enhance it.

==Issues Fixed==

# Refactored code in <code>teams_controller.rb</code>
#* Added more comments and briefly explained the functionality of all methods
#* Found areas in the code where the DRY principle can be applied
#* Refactored the function <code>bequeath_all</code> to improve readability by including function <code>copy_teams</code>
#* Refactored function <code>copy_teams</code> that calls <code>choose_copy_type</code>, which calls <code>bequeath_copy</code> or <code>inherit_copy</code> based on bequeath
# Refactored code in <code>team.rb</code>
#* Added more comments to some methods in the code
#* Found areas in the code where the DRY principle can be applied
# Made changes to <code>hi_IN.yml</code> file, by adding more annotations and some grammatical errors
# Added more coverage to test by modifying <code>teams_controller_spec.rb</code>

==Files Changed==

* app/controllers/teams_controller.rb
* app/models/team.rb
* config/locales/hi_IN.yml
* spec/controllers/teams_controller_spec.rb
* expertiza/app/views/teams/list.html.erb

==Changes==

===Fix #1===

The code in <code>teams_controller.rb</code> for function <code>bequeath_all</code> was too long, which would make it unreadable. To achieve it, a function <code>copy_teams</code> was added to the code.
<nowiki>
# Handovers all teams to the course that contains the corresponding assignment
# The team and team members are all copied.
def bequeath_all
if session[:team_type] == Team.allowed_types[1]
flash[:error] = 'Invalid team type for bequeath all'
redirect_to controller: 'teams', action: 'list', id: params[:id]
else
copy_teams(Team.team_operation[:bequeath])
end
end
</nowiki>

The function <code>copy_teams</code> is refactored further to improve it. The function <code>choose_copy_type</code> is refactored further to either perform <code>bequeath_copy</code> or <code>inherit_copy</code> based on team operation.
<nowiki>
# Method to abstract the functionality to copy teams.
def copy_teams(operation)
assignment = Assignment.find(params[:id])
if assignment.course_id
choose_copy_type(assignment, operation)
else
flash[:error] = 'No course was found for this assignment.'
end
redirect_to controller: 'teams', action: 'list', id: assignment.id
end

# Abstraction over different methods
def choose_copy_type(assignment, operation)
course = Course.find(assignment.course_id)
if operation == Team.team_operation[:bequeath]
bequeath_copy(assignment, course)
else
inherit_copy(assignment, course)
end
end

# Method to perform a copy of assignment teams to course
def bequeath_copy(assignment, course)
teams = assignment.teams
if course.course_teams.any?
flash[:error] = 'The course already has associated teams'
else
Team.copy_content(teams, course)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + course.name + '"'
end
end

# Method to inherit teams from course by copying
def inherit_copy(assignment, course)
teams = course.course_teams
if teams.empty?
flash[:error] = 'No teams were found when trying to inherit.'
else
Team.copy_content(teams, assignment)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + assignment.name + '"'
end
end

</nowiki>

===Fix #2===

The file <code>teams.rb</code> had an area where DRY principle could be applied. Function <code>randomize_all_by_parent</code> was modified to decrease the number of lines of code. The snippet to find teams still need team members and users who are not in any team has been modified, below is the code snippet.

<code>
teams = Team.where(parent_id: parent.id, type: parent.class.to_s + 'Team').to_a
teams.each { |team| TeamsUser.where(team_id: team.id).each { |teams_user| users.delete(User.find(teams_user.user_id)) } }
teams.reject! { |team| Team.size(team.id) >= min_team_size }</code>

===Fix #3===

The file <code>hi_IN.yml</code> has some formatting in annotations that needed to be taken care of. For example, in Hindi, a sentence ending is indicated by the symbol "|", but it is given as "." everywhere. This was taken care of in the code, wherever Hindi annotations are available. Also, some additional annotations were added for <code>datetime->distance_in_words</code> key, where the annotations were modified to maintain uniformity throughout this key.

==Test Plan==

The teams controller testing document has been covered well by the previous teams, however after detailed analysis of the test file, we found more edge cases that need to be tested, hence we added two new test cases. There was a test which was commented, it is found to be not required, and hence it was removed, while some of them had to be modified to correction.

===Test Coverage===

Coverage has slightly improved, as the number of lines in team.rb file has decreased as a result of refactoring.

======Added Tests======

'''1.''' In the test <code>create teams method</code>, we added a test for incorrect parameters passed into the method. We also added a code when team with given id does not exist.

[[File:added_tests1.png]]

======Modified Tests======

'''2.''' In the test <code> create method</code>, there was a test case which was redundant, because a create method will ideally be called with a team that doesn't exist. Therefore, we removed this test.

[[File:removed_nonworking_test.png]]

'''3.''' There was some confusion about the function <code>choose_copy_type, bequeath_copy and inherit_copy</code>. In the test <code>inherit method</code>, the function <code>inherit_copy</code> was tested under <code>inherit method</code> (lines 180 - 220). Similarly, <code>bequeath_copy</code> was tested under <code>#bequeath_all</code> (lines 222 - 266).

'''4.''' In the test <code> delete method</code>, some redundant comments were made, that was removed as well.

'''5.''' Some minor changes were made to some of the test cases.

==Contributors==
This project was done as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Sasank Marabattula, Srilekha Gudipati and Varun Deepak Gudhe. Our project mentor was Divyang Doshi.

CSC/ECE 517 Spring 2023 - E2303 Refactor teams controller.rb

2023-03-27T21:54:18Z

Smaraba: /* Test Plan */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.

==Introduction==

In this project we refactored teams_controller.rb and some associated files with it. Some duplicate code was removed. We added some comments for readability. Also, the hindi yml file was modified to enhance it.

==Issues Fixed==

# Refactored code in <code>teams_controller.rb</code>
#* Added more comments and briefly explained the functionality of all methods
#* Found areas in the code where the DRY principle can be applied
#* Refactored the function <code>bequeath_all</code> to improve readability by including function <code>copy_teams</code>
#* Refactored function <code>copy_teams</code> that calls <code>choose_copy_type</code>, which calls <code>bequeath_copy</code> or <code>inherit_copy</code> based on bequeath
# Refactored code in <code>team.rb</code>
#* Added more comments to some methods in the code
#* Found areas in the code where the DRY principle can be applied
# Made changes to <code>hi_IN.yml</code> file, by adding more annotations and some grammatical errors
# Added more coverage to test by modifying <code>teams_controller_spec.rb</code>

==Files Changed==

* app/controllers/teams_controller.rb
* app/models/team.rb
* config/locales/hi_IN.yml
* spec/controllers/teams_controller_spec.rb
* expertiza/app/views/teams/list.html.erb

==Changes==

===Fix #1===

The code in <code>teams_controller.rb</code> for function <code>bequeath_all</code> was too long, which would make it unreadable. To achieve it, a function <code>copy_teams</code> was added to the code.
<nowiki>
# Handovers all teams to the course that contains the corresponding assignment
# The team and team members are all copied.
def bequeath_all
if session[:team_type] == Team.allowed_types[1]
flash[:error] = 'Invalid team type for bequeath all'
redirect_to controller: 'teams', action: 'list', id: params[:id]
else
copy_teams(Team.team_operation[:bequeath])
end
end
</nowiki>

The function <code>copy_teams</code> is refactored further to improve it. The function <code>choose_copy_type</code> is refactored further to either perform <code>bequeath_copy</code> or <code>inherit_copy</code> based on team operation.
<nowiki>
# Method to abstract the functionality to copy teams.
def copy_teams(operation)
assignment = Assignment.find(params[:id])
if assignment.course_id
choose_copy_type(assignment, operation)
else
flash[:error] = 'No course was found for this assignment.'
end
redirect_to controller: 'teams', action: 'list', id: assignment.id
end

# Abstraction over different methods
def choose_copy_type(assignment, operation)
course = Course.find(assignment.course_id)
if operation == Team.team_operation[:bequeath]
bequeath_copy(assignment, course)
else
inherit_copy(assignment, course)
end
end

# Method to perform a copy of assignment teams to course
def bequeath_copy(assignment, course)
teams = assignment.teams
if course.course_teams.any?
flash[:error] = 'The course already has associated teams'
else
Team.copy_content(teams, course)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + course.name + '"'
end
end

# Method to inherit teams from course by copying
def inherit_copy(assignment, course)
teams = course.course_teams
if teams.empty?
flash[:error] = 'No teams were found when trying to inherit.'
else
Team.copy_content(teams, assignment)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + assignment.name + '"'
end
end

</nowiki>

===Fix #2===

The file <code>teams.rb</code> had an area where DRY principle could be applied. Function <code>randomize_all_by_parent</code> was modified to decrease the number of lines of code. The snippet to find teams still need team members and users who are not in any team has been modified, below is the code snippet.

<code>
teams = Team.where(parent_id: parent.id, type: parent.class.to_s + 'Team').to_a
teams.each { |team| TeamsUser.where(team_id: team.id).each { |teams_user| users.delete(User.find(teams_user.user_id)) } }
teams.reject! { |team| Team.size(team.id) >= min_team_size }</code>

===Fix #3===

The file <code>hi_IN.yml</code> has some formatting in annotations that needed to be taken care of. For example, in Hindi, a sentence ending is indicated by the symbol "|", but it is given as "." everywhere. This was taken care of in the code, wherever Hindi annotations are available. Also, some additional annotations were added for <code>datetime->distance_in_words</code> key, where the annotations were modified to maintain uniformity throughout this key.

==Test Plan==

The teams controller testing document has been covered well by the previous teams, however after detailed analysis of the test file, we found more edge cases that need to be tested, hence we added two new test cases. There was a test which was commented, it is found to be not required, and hence it was removed, while some of them had to be modified to correction.

===Test Coverage===

Coverage has slightly improved, as the number of lines in team.rb file has decreased as a result of refactoring.

======Added Tests======

'''1.''' In the test <code>create teams method</code>, we added a test for incorrect parameters passed into the method. We also added a code when team with given id does not exist.

[[File:added_tests1.png]]

======Modified Tests======

'''2.''' In the test <code> create method</code>, there was a test case which was redundant, because a create method will ideally be called with a team that doesn't exist. Therefore, we removed this test.

[[File:removed_nonworking_test.png]]

'''3.''' There was some confusion about the function <code>choose_copy_type, bequeath_copy and inherit_copy</code>. In the test <code>inherit method</code>, the function <code>inherit_copy</code> was tested under <code>called when assignment belongs to course and team is not empty</code> (lines 180 - 220). Similarly, <code>bequeath_copy</code> was tested under <code>called when assignment belongs to course but team is empty</code> (lines 222 - 266).

'''4.''' In the test <code> delete method</code>, some redundant comments were made, that was removed as well.

'''5.''' Some minor changes were made to some of the test cases.

==Contributors==
This project was done as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Sasank Marabattula, Srilekha Gudipati and Varun Deepak Gudhe. Our project mentor was Divyang Doshi.

CSC/ECE 517 Spring 2023 - E2303 Refactor teams controller.rb

2023-03-27T21:52:11Z

Smaraba: /* Test Plan */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.

==Introduction==

In this project we refactored teams_controller.rb and some associated files with it. Some duplicate code was removed. We added some comments for readability. Also, the hindi yml file was modified to enhance it.

==Issues Fixed==

# Refactored code in <code>teams_controller.rb</code>
#* Added more comments and briefly explained the functionality of all methods
#* Found areas in the code where the DRY principle can be applied
#* Refactored the function <code>bequeath_all</code> to improve readability by including function <code>copy_teams</code>
#* Refactored function <code>copy_teams</code> that calls <code>choose_copy_type</code>, which calls <code>bequeath_copy</code> or <code>inherit_copy</code> based on bequeath
# Refactored code in <code>team.rb</code>
#* Added more comments to some methods in the code
#* Found areas in the code where the DRY principle can be applied
# Made changes to <code>hi_IN.yml</code> file, by adding more annotations and some grammatical errors
# Added more coverage to test by modifying <code>teams_controller_spec.rb</code>

==Files Changed==

* app/controllers/teams_controller.rb
* app/models/team.rb
* config/locales/hi_IN.yml
* spec/controllers/teams_controller_spec.rb
* expertiza/app/views/teams/list.html.erb

==Changes==

===Fix #1===

The code in <code>teams_controller.rb</code> for function <code>bequeath_all</code> was too long, which would make it unreadable. To achieve it, a function <code>copy_teams</code> was added to the code.
<nowiki>
# Handovers all teams to the course that contains the corresponding assignment
# The team and team members are all copied.
def bequeath_all
if session[:team_type] == Team.allowed_types[1]
flash[:error] = 'Invalid team type for bequeath all'
redirect_to controller: 'teams', action: 'list', id: params[:id]
else
copy_teams(Team.team_operation[:bequeath])
end
end
</nowiki>

The function <code>copy_teams</code> is refactored further to improve it. The function <code>choose_copy_type</code> is refactored further to either perform <code>bequeath_copy</code> or <code>inherit_copy</code> based on team operation.
<nowiki>
# Method to abstract the functionality to copy teams.
def copy_teams(operation)
assignment = Assignment.find(params[:id])
if assignment.course_id
choose_copy_type(assignment, operation)
else
flash[:error] = 'No course was found for this assignment.'
end
redirect_to controller: 'teams', action: 'list', id: assignment.id
end

# Abstraction over different methods
def choose_copy_type(assignment, operation)
course = Course.find(assignment.course_id)
if operation == Team.team_operation[:bequeath]
bequeath_copy(assignment, course)
else
inherit_copy(assignment, course)
end
end

# Method to perform a copy of assignment teams to course
def bequeath_copy(assignment, course)
teams = assignment.teams
if course.course_teams.any?
flash[:error] = 'The course already has associated teams'
else
Team.copy_content(teams, course)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + course.name + '"'
end
end

# Method to inherit teams from course by copying
def inherit_copy(assignment, course)
teams = course.course_teams
if teams.empty?
flash[:error] = 'No teams were found when trying to inherit.'
else
Team.copy_content(teams, assignment)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + assignment.name + '"'
end
end

</nowiki>

===Fix #2===

The file <code>teams.rb</code> had an area where DRY principle could be applied. Function <code>randomize_all_by_parent</code> was modified to decrease the number of lines of code. The snippet to find teams still need team members and users who are not in any team has been modified, below is the code snippet.

<code>
teams = Team.where(parent_id: parent.id, type: parent.class.to_s + 'Team').to_a
teams.each { |team| TeamsUser.where(team_id: team.id).each { |teams_user| users.delete(User.find(teams_user.user_id)) } }
teams.reject! { |team| Team.size(team.id) >= min_team_size }</code>

===Fix #3===

The file <code>hi_IN.yml</code> has some formatting in annotations that needed to be taken care of. For example, in Hindi, a sentence ending is indicated by the symbol "|", but it is given as "." everywhere. This was taken care of in the code, wherever Hindi annotations are available. Also, some additional annotations were added for <code>datetime->distance_in_words</code> key, where the annotations were modified to maintain uniformity throughout this key.

==Test Plan==

The teams controller testing document has been covered well by the previous teams, however after detailed analysis of the test file, we found more edge cases that need to be tested, hence we added two new test cases. There was a test which was commented, it is found to be not required, and hence it was removed, while some of them had to be modified to correction.

===Test Coverage===

Coverage has slightly improved, as the number of lines in team.rb file has decreased as a result of refactoring.

======Added Tests======

'''1.''' In the test <code>create teams method</code>, we added a test for incorrect parameters passed into the method. We also added a code when team with given id does not exist.

[[File:added_tests1.png]]

======Modified Tests======

'''2.''' In the test <code> create method</code>, there was a test case which looked redundant, as it wasn't working earlier as well and it was already covered in the test file.

[[File:removed_nonworking_test.png]]

'''3.''' There was some confusion about the function <code>choose_copy_type, bequeath_copy and inherit_copy</code>. In the test <code>inherit method</code>, the function <code>inherit_copy</code> was tested under <code>called when assignment belongs to course and team is not empty</code>. Similarly, <code>bequeath_copy</code> was tested under <code>called when assignment belongs to course but team is empty</code>.

[[File:inherit_confusion_test.png]]

'''4.''' In the test <code> delete method</code>, some redundant comments were made, that was removed as well.

'''5.''' Some minor changes were made to some of the test cases.

==Contributors==
This project was done as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Sasank Marabattula, Srilekha Gudipati and Varun Deepak Gudhe. Our project mentor was Divyang Doshi.

File:Added tests1.png

2023-03-27T21:51:48Z

Smaraba:

File:Added tests.png

2023-03-27T21:50:50Z

Smaraba: Smaraba uploaded a new version of File:Added tests.png

File:Added tests.png

2023-03-27T21:49:47Z

Smaraba: Smaraba uploaded a new version of File:Added tests.png

CSC/ECE 517 Spring 2023 - E2303 Refactor teams controller.rb

2023-03-27T21:49:31Z

Smaraba: /* Test Plan */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.

==Introduction==

In this project we refactored teams_controller.rb and some associated files with it. Some duplicate code was removed. We added some comments for readability. Also, the hindi yml file was modified to enhance it.

==Issues Fixed==

# Refactored code in <code>teams_controller.rb</code>
#* Added more comments and briefly explained the functionality of all methods
#* Found areas in the code where the DRY principle can be applied
#* Refactored the function <code>bequeath_all</code> to improve readability by including function <code>copy_teams</code>
#* Refactored function <code>copy_teams</code> that calls <code>choose_copy_type</code>, which calls <code>bequeath_copy</code> or <code>inherit_copy</code> based on bequeath
# Refactored code in <code>team.rb</code>
#* Added more comments to some methods in the code
#* Found areas in the code where the DRY principle can be applied
# Made changes to <code>hi_IN.yml</code> file, by adding more annotations and some grammatical errors
# Added more coverage to test by modifying <code>teams_controller_spec.rb</code>

==Files Changed==

* app/controllers/teams_controller.rb
* app/models/team.rb
* config/locales/hi_IN.yml
* spec/controllers/teams_controller_spec.rb
* expertiza/app/views/teams/list.html.erb

==Changes==

===Fix #1===

The code in <code>teams_controller.rb</code> for function <code>bequeath_all</code> was too long, which would make it unreadable. To achieve it, a function <code>copy_teams</code> was added to the code.
<nowiki>
# Handovers all teams to the course that contains the corresponding assignment
# The team and team members are all copied.
def bequeath_all
if session[:team_type] == Team.allowed_types[1]
flash[:error] = 'Invalid team type for bequeath all'
redirect_to controller: 'teams', action: 'list', id: params[:id]
else
copy_teams(Team.team_operation[:bequeath])
end
end
</nowiki>

The function <code>copy_teams</code> is refactored further to improve it. The function <code>choose_copy_type</code> is refactored further to either perform <code>bequeath_copy</code> or <code>inherit_copy</code> based on team operation.
<nowiki>
# Method to abstract the functionality to copy teams.
def copy_teams(operation)
assignment = Assignment.find(params[:id])
if assignment.course_id
choose_copy_type(assignment, operation)
else
flash[:error] = 'No course was found for this assignment.'
end
redirect_to controller: 'teams', action: 'list', id: assignment.id
end

# Abstraction over different methods
def choose_copy_type(assignment, operation)
course = Course.find(assignment.course_id)
if operation == Team.team_operation[:bequeath]
bequeath_copy(assignment, course)
else
inherit_copy(assignment, course)
end
end

# Method to perform a copy of assignment teams to course
def bequeath_copy(assignment, course)
teams = assignment.teams
if course.course_teams.any?
flash[:error] = 'The course already has associated teams'
else
Team.copy_content(teams, course)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + course.name + '"'
end
end

# Method to inherit teams from course by copying
def inherit_copy(assignment, course)
teams = course.course_teams
if teams.empty?
flash[:error] = 'No teams were found when trying to inherit.'
else
Team.copy_content(teams, assignment)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + assignment.name + '"'
end
end

</nowiki>

===Fix #2===

The file <code>teams.rb</code> had an area where DRY principle could be applied. Function <code>randomize_all_by_parent</code> was modified to decrease the number of lines of code. The snippet to find teams still need team members and users who are not in any team has been modified, below is the code snippet.

<code>
teams = Team.where(parent_id: parent.id, type: parent.class.to_s + 'Team').to_a
teams.each { |team| TeamsUser.where(team_id: team.id).each { |teams_user| users.delete(User.find(teams_user.user_id)) } }
teams.reject! { |team| Team.size(team.id) >= min_team_size }</code>

===Fix #3===

The file <code>hi_IN.yml</code> has some formatting in annotations that needed to be taken care of. For example, in Hindi, a sentence ending is indicated by the symbol "|", but it is given as "." everywhere. This was taken care of in the code, wherever Hindi annotations are available. Also, some additional annotations were added for <code>datetime->distance_in_words</code> key, where the annotations were modified to maintain uniformity throughout this key.

==Test Plan==

The teams controller testing document has been covered well by the previous teams, however after detailed analysis of the test file, we found more edge cases that need to be tested, hence we added two new test cases. There was a test which was commented, it is found to be not required, and hence it was removed, while some of them had to be modified to correction.

===Test Coverage===

Coverage has slightly improved, as the number of lines in team.rb file has decreased as a result of refactoring.

======Added Tests======

'''1.''' In the test <code>create teams method</code>, we added a test for incorrect parameters passed into the method. We also added a code when team with given id does not exist.

[[File:added_tests.png]]

======Modified Tests======

'''2.''' In the test <code> create method</code>, there was a test case which looked redundant, as it wasn't working earlier as well and it was already covered in the test file.

[[File:removed_nonworking_test.png]]

'''3.''' There was some confusion about the function <code>choose_copy_type, bequeath_copy and inherit_copy</code>. In the test <code>inherit method</code>, the function <code>inherit_copy</code> was tested under <code>called when assignment belongs to course and team is not empty</code>. Similarly, <code>bequeath_copy</code> was tested under <code>called when assignment belongs to course but team is empty</code>.

[[File:inherit_confusion_test.png]]

'''4.''' In the test <code> delete method</code>, some redundant comments were made, that was removed as well.

'''5.''' Some minor changes were made to some of the test cases.

==Contributors==
This project was done as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Sasank Marabattula, Srilekha Gudipati and Varun Deepak Gudhe. Our project mentor was Divyang Doshi.

CSC/ECE 517 Spring 2023 - E2303 Refactor teams controller.rb

2023-03-27T21:06:12Z

Smaraba: /* Fix #2 */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.

==Introduction==

In this project we refactored teams_controller.rb and some associated files with it. Some duplicate code was removed. We added some comments for readability. Also, the hindi yml file was modified to enhance it.

==Issues Fixed==

# Refactored code in <code>teams_controller.rb</code>
#* Added more comments and briefly explained the functionality of all methods
#* Found areas in the code where the DRY principle can be applied
#* Refactored the function <code>bequeath_all</code> to improve readability by including function <code>copy_teams</code>
#* Refactored function <code>copy_teams</code> that calls <code>choose_copy_type</code>, which calls <code>bequeath_copy</code> or <code>inherit_copy</code> based on bequeath
# Refactored code in <code>team.rb</code>
#* Added more comments to some methods in the code
#* Found areas in the code where the DRY principle can be applied
# Made changes to <code>hi_IN.yml</code> file, by adding more annotations and some grammatical errors
# Added more coverage to test by modifying <code>teams_controller_spec.rb</code>

==Files Changed==

* app/controllers/teams_controller.rb
* app/models/team.rb
* config/locales/hi_IN.yml
* spec/controllers/teams_controller_spec.rb
* expertiza/app/views/teams/list.html.erb

==Changes==

===Fix #1===

The code in <code>teams_controller.rb</code> for function <code>bequeath_all</code> was too long, which would make it unreadable. To achieve it, a function <code>copy_teams</code> was added to the code.
<nowiki>
# Handovers all teams to the course that contains the corresponding assignment
# The team and team members are all copied.
def bequeath_all
if session[:team_type] == Team.allowed_types[1]
flash[:error] = 'Invalid team type for bequeath all'
redirect_to controller: 'teams', action: 'list', id: params[:id]
else
copy_teams(Team.team_operation[:bequeath])
end
end
</nowiki>

The function <code>copy_teams</code> is refactored further to improve it. The function <code>choose_copy_type</code> is refactored further to either perform <code>bequeath_copy</code> or <code>inherit_copy</code> based on team operation.
<nowiki>
# Method to abstract the functionality to copy teams.
def copy_teams(operation)
assignment = Assignment.find(params[:id])
if assignment.course_id
choose_copy_type(assignment, operation)
else
flash[:error] = 'No course was found for this assignment.'
end
redirect_to controller: 'teams', action: 'list', id: assignment.id
end

# Abstraction over different methods
def choose_copy_type(assignment, operation)
course = Course.find(assignment.course_id)
if operation == Team.team_operation[:bequeath]
bequeath_copy(assignment, course)
else
inherit_copy(assignment, course)
end
end

# Method to perform a copy of assignment teams to course
def bequeath_copy(assignment, course)
teams = assignment.teams
if course.course_teams.any?
flash[:error] = 'The course already has associated teams'
else
Team.copy_content(teams, course)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + course.name + '"'
end
end

# Method to inherit teams from course by copying
def inherit_copy(assignment, course)
teams = course.course_teams
if teams.empty?
flash[:error] = 'No teams were found when trying to inherit.'
else
Team.copy_content(teams, assignment)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + assignment.name + '"'
end
end

</nowiki>

===Fix #2===

The file <code>teams.rb</code> had an area where DRY principle could be applied. Function <code>randomize_all_by_parent</code> was modified to decrease the number of lines of code. The snippet to find teams still need team members and users who are not in any team has been modified, below is the code snippet.

<code>
teams = Team.where(parent_id: parent.id, type: parent.class.to_s + 'Team').to_a
teams.each { |team| TeamsUser.where(team_id: team.id).each { |teams_user| users.delete(User.find(teams_user.user_id)) } }
teams.reject! { |team| Team.size(team.id) >= min_team_size }</code>

===Fix #3===

The file <code>hi_IN.yml</code> has some formatting in annotations that needed to be taken care of. For example, in Hindi, a sentence ending is indicated by the symbol "|", but it is given as "." everywhere. This was taken care of in the code, wherever Hindi annotations are available. Also, some additional annotations were added for <code>datetime->distance_in_words</code> key, where the annotations were modified to maintain uniformity throughout this key.

==Test Plan==

The teams controller testing document has been covered well by the previous teams, however after detailed analysis of the test file, new test cases were added, some test cases had to be removed, while some of them had to be modified to correction.

===Test Coverage===

Coverage has slightly improved, as the number of lines in team.rb file has decreased as a result of refactoring.

======Added Tests======

'''1.''' In the test <code>create teams method</code>, we added a test for incorrect parameters passed into the method. Below is the change
[[File:added_tests.png]]

======Modified Tests======

'''2.''' In the test <code> create method</code>, there was a test case which looked redundant, as it wasn't working earlier as well and it was already covered in the test file.

[[File:removed_nonworking_test.png]]

'''3.''' There was some confusion about the function <code>choose_copy_type, bequeath_copy and inherit_copy</code>. In the test <code>inherit method</code>, the function <code>inherit_copy</code> was tested under <code>called when assignment belongs to course and team is not empty</code>. Similarly, <code>bequeath_copy</code> was tested under <code>called when assignment belongs to course but team is empty</code>.

[[File:inherit_confusion_test.png]]

'''4.''' In the test <code> delete method</code>, some redundant comments were made, that was removed as well.

'''5.''' Some minor changes were made to some of the test cases.

==Contributors==
This project was done as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Sasank Marabattula, Srilekha Gudipati and Varun Deepak Gudhe. Our project mentor was Divyang Doshi.

CSC/ECE 517 Spring 2023 - E2303 Refactor teams controller.rb

2023-03-27T21:05:00Z

Smaraba: /* Fix #2 */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.

==Introduction==

In this project we refactored teams_controller.rb and some associated files with it. Some duplicate code was removed. We added some comments for readability. Also, the hindi yml file was modified to enhance it.

==Issues Fixed==

# Refactored code in <code>teams_controller.rb</code>
#* Added more comments and briefly explained the functionality of all methods
#* Found areas in the code where the DRY principle can be applied
#* Refactored the function <code>bequeath_all</code> to improve readability by including function <code>copy_teams</code>
#* Refactored function <code>copy_teams</code> that calls <code>choose_copy_type</code>, which calls <code>bequeath_copy</code> or <code>inherit_copy</code> based on bequeath
# Refactored code in <code>team.rb</code>
#* Added more comments to some methods in the code
#* Found areas in the code where the DRY principle can be applied
# Made changes to <code>hi_IN.yml</code> file, by adding more annotations and some grammatical errors
# Added more coverage to test by modifying <code>teams_controller_spec.rb</code>

==Files Changed==

* app/controllers/teams_controller.rb
* app/models/team.rb
* config/locales/hi_IN.yml
* spec/controllers/teams_controller_spec.rb
* expertiza/app/views/teams/list.html.erb

==Changes==

===Fix #1===

The code in <code>teams_controller.rb</code> for function <code>bequeath_all</code> was too long, which would make it unreadable. To achieve it, a function <code>copy_teams</code> was added to the code.
<nowiki>
# Handovers all teams to the course that contains the corresponding assignment
# The team and team members are all copied.
def bequeath_all
if session[:team_type] == Team.allowed_types[1]
flash[:error] = 'Invalid team type for bequeath all'
redirect_to controller: 'teams', action: 'list', id: params[:id]
else
copy_teams(Team.team_operation[:bequeath])
end
end
</nowiki>

The function <code>copy_teams</code> is refactored further to improve it. The function <code>choose_copy_type</code> is refactored further to either perform <code>bequeath_copy</code> or <code>inherit_copy</code> based on team operation.
<nowiki>
# Method to abstract the functionality to copy teams.
def copy_teams(operation)
assignment = Assignment.find(params[:id])
if assignment.course_id
choose_copy_type(assignment, operation)
else
flash[:error] = 'No course was found for this assignment.'
end
redirect_to controller: 'teams', action: 'list', id: assignment.id
end

# Abstraction over different methods
def choose_copy_type(assignment, operation)
course = Course.find(assignment.course_id)
if operation == Team.team_operation[:bequeath]
bequeath_copy(assignment, course)
else
inherit_copy(assignment, course)
end
end

# Method to perform a copy of assignment teams to course
def bequeath_copy(assignment, course)
teams = assignment.teams
if course.course_teams.any?
flash[:error] = 'The course already has associated teams'
else
Team.copy_content(teams, course)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + course.name + '"'
end
end

# Method to inherit teams from course by copying
def inherit_copy(assignment, course)
teams = course.course_teams
if teams.empty?
flash[:error] = 'No teams were found when trying to inherit.'
else
Team.copy_content(teams, assignment)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + assignment.name + '"'
end
end

</nowiki>

===Fix #2===

The file <code>teams.rb</code> had an area where DRY principle could be applied. Function <code>randomize_all_by_parent</code> was modified to decrease the number of lines of code. The snippet to find teams still need team members and users who are not in any team has been modified, below is the code snippet.
<code>#find teams still need team members and users who are not in any team
teams = Team.where(parent_id: parent.id, type: parent.class.to_s + 'Team').to_a
teams.each { |team| TeamsUser.where(team_id: team.id).each { |teams_user| users.delete(User.find(teams_user.user_id)) } }
teams.reject! { |team| Team.size(team.id) >= min_team_size }</code>

===Fix #3===

The file <code>hi_IN.yml</code> has some formatting in annotations that needed to be taken care of. For example, in Hindi, a sentence ending is indicated by the symbol "|", but it is given as "." everywhere. This was taken care of in the code, wherever Hindi annotations are available. Also, some additional annotations were added for <code>datetime->distance_in_words</code> key, where the annotations were modified to maintain uniformity throughout this key.

==Test Plan==

The teams controller testing document has been covered well by the previous teams, however after detailed analysis of the test file, new test cases were added, some test cases had to be removed, while some of them had to be modified to correction.

===Test Coverage===

Coverage has slightly improved, as the number of lines in team.rb file has decreased as a result of refactoring.

======Added Tests======

'''1.''' In the test <code>create teams method</code>, we added a test for incorrect parameters passed into the method. Below is the change
[[File:added_tests.png]]

======Modified Tests======

'''2.''' In the test <code> create method</code>, there was a test case which looked redundant, as it wasn't working earlier as well and it was already covered in the test file.

[[File:removed_nonworking_test.png]]

'''3.''' There was some confusion about the function <code>choose_copy_type, bequeath_copy and inherit_copy</code>. In the test <code>inherit method</code>, the function <code>inherit_copy</code> was tested under <code>called when assignment belongs to course and team is not empty</code>. Similarly, <code>bequeath_copy</code> was tested under <code>called when assignment belongs to course but team is empty</code>.

[[File:inherit_confusion_test.png]]

'''4.''' In the test <code> delete method</code>, some redundant comments were made, that was removed as well.

'''5.''' Some minor changes were made to some of the test cases.

==Contributors==
This project was done as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Sasank Marabattula, Srilekha Gudipati and Varun Deepak Gudhe. Our project mentor was Divyang Doshi.

CSC/ECE 517 Spring 2023 - E2303 Refactor teams controller.rb

2023-03-27T21:04:33Z

Smaraba: /* Files Changed */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.

==Introduction==

In this project we refactored teams_controller.rb and some associated files with it. Some duplicate code was removed. We added some comments for readability. Also, the hindi yml file was modified to enhance it.

==Issues Fixed==

# Refactored code in <code>teams_controller.rb</code>
#* Added more comments and briefly explained the functionality of all methods
#* Found areas in the code where the DRY principle can be applied
#* Refactored the function <code>bequeath_all</code> to improve readability by including function <code>copy_teams</code>
#* Refactored function <code>copy_teams</code> that calls <code>choose_copy_type</code>, which calls <code>bequeath_copy</code> or <code>inherit_copy</code> based on bequeath
# Refactored code in <code>team.rb</code>
#* Added more comments to some methods in the code
#* Found areas in the code where the DRY principle can be applied
# Made changes to <code>hi_IN.yml</code> file, by adding more annotations and some grammatical errors
# Added more coverage to test by modifying <code>teams_controller_spec.rb</code>

==Files Changed==

* app/controllers/teams_controller.rb
* app/models/team.rb
* config/locales/hi_IN.yml
* spec/controllers/teams_controller_spec.rb
* expertiza/app/views/teams/list.html.erb

==Changes==

===Fix #1===

The code in <code>teams_controller.rb</code> for function <code>bequeath_all</code> was too long, which would make it unreadable. To achieve it, a function <code>copy_teams</code> was added to the code.
<nowiki>
# Handovers all teams to the course that contains the corresponding assignment
# The team and team members are all copied.
def bequeath_all
if session[:team_type] == Team.allowed_types[1]
flash[:error] = 'Invalid team type for bequeath all'
redirect_to controller: 'teams', action: 'list', id: params[:id]
else
copy_teams(Team.team_operation[:bequeath])
end
end
</nowiki>

The function <code>copy_teams</code> is refactored further to improve it. The function <code>choose_copy_type</code> is refactored further to either perform <code>bequeath_copy</code> or <code>inherit_copy</code> based on team operation.
<nowiki>
# Method to abstract the functionality to copy teams.
def copy_teams(operation)
assignment = Assignment.find(params[:id])
if assignment.course_id
choose_copy_type(assignment, operation)
else
flash[:error] = 'No course was found for this assignment.'
end
redirect_to controller: 'teams', action: 'list', id: assignment.id
end

# Abstraction over different methods
def choose_copy_type(assignment, operation)
course = Course.find(assignment.course_id)
if operation == Team.team_operation[:bequeath]
bequeath_copy(assignment, course)
else
inherit_copy(assignment, course)
end
end

# Method to perform a copy of assignment teams to course
def bequeath_copy(assignment, course)
teams = assignment.teams
if course.course_teams.any?
flash[:error] = 'The course already has associated teams'
else
Team.copy_content(teams, course)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + course.name + '"'
end
end

# Method to inherit teams from course by copying
def inherit_copy(assignment, course)
teams = course.course_teams
if teams.empty?
flash[:error] = 'No teams were found when trying to inherit.'
else
Team.copy_content(teams, assignment)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + assignment.name + '"'
end
end

</nowiki>

===Fix #2===

The file <code>teams.rb</code> had an area where DRY principle could be applied. Function <code>randomize_all_by_parent</code> was modified to decrease the number of lines of code. The snippet to find teams still need team members and users who are not in any team has been modified, below is the code snippet.
<code>
# find teams still need team members and users who are not in any team
teams = Team.where(parent_id: parent.id, type: parent.class.to_s + 'Team').to_a
teams.each { |team| TeamsUser.where(team_id: team.id).each { |teams_user| users.delete(User.find(teams_user.user_id)) } }
teams.reject! { |team| Team.size(team.id) >= min_team_size }</code>

===Fix #3===

The file <code>hi_IN.yml</code> has some formatting in annotations that needed to be taken care of. For example, in Hindi, a sentence ending is indicated by the symbol "|", but it is given as "." everywhere. This was taken care of in the code, wherever Hindi annotations are available. Also, some additional annotations were added for <code>datetime->distance_in_words</code> key, where the annotations were modified to maintain uniformity throughout this key.

==Test Plan==

The teams controller testing document has been covered well by the previous teams, however after detailed analysis of the test file, new test cases were added, some test cases had to be removed, while some of them had to be modified to correction.

===Test Coverage===

Coverage has slightly improved, as the number of lines in team.rb file has decreased as a result of refactoring.

======Added Tests======

'''1.''' In the test <code>create teams method</code>, we added a test for incorrect parameters passed into the method. Below is the change
[[File:added_tests.png]]

======Modified Tests======

'''2.''' In the test <code> create method</code>, there was a test case which looked redundant, as it wasn't working earlier as well and it was already covered in the test file.

[[File:removed_nonworking_test.png]]

'''3.''' There was some confusion about the function <code>choose_copy_type, bequeath_copy and inherit_copy</code>. In the test <code>inherit method</code>, the function <code>inherit_copy</code> was tested under <code>called when assignment belongs to course and team is not empty</code>. Similarly, <code>bequeath_copy</code> was tested under <code>called when assignment belongs to course but team is empty</code>.

[[File:inherit_confusion_test.png]]

'''4.''' In the test <code> delete method</code>, some redundant comments were made, that was removed as well.

'''5.''' Some minor changes were made to some of the test cases.

==Contributors==
This project was done as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Sasank Marabattula, Srilekha Gudipati and Varun Deepak Gudhe. Our project mentor was Divyang Doshi.

CSC/ECE 517 Spring 2023 - E2303 Refactor teams controller.rb

2023-03-27T21:04:21Z

Smaraba: /* Issues Fixed */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.

==Introduction==

In this project we refactored teams_controller.rb and some associated files with it. Some duplicate code was removed. We added some comments for readability. Also, the hindi yml file was modified to enhance it.

==Issues Fixed==

# Refactored code in <code>teams_controller.rb</code>
#* Added more comments and briefly explained the functionality of all methods
#* Found areas in the code where the DRY principle can be applied
#* Refactored the function <code>bequeath_all</code> to improve readability by including function <code>copy_teams</code>
#* Refactored function <code>copy_teams</code> that calls <code>choose_copy_type</code>, which calls <code>bequeath_copy</code> or <code>inherit_copy</code> based on bequeath
# Refactored code in <code>team.rb</code>
#* Added more comments to some methods in the code
#* Found areas in the code where the DRY principle can be applied
# Made changes to <code>hi_IN.yml</code> file, by adding more annotations and some grammatical errors
# Added more coverage to test by modifying <code>teams_controller_spec.rb</code>

==Files Changed==

* app/controllers/teams_controller.rb
* app/models/teams.rb
* config/locales/hi_IN.yml
* spec/controllers/teams_controller_spec.rb
* expertiza/app/views/teams/list.html.erb

==Changes==

===Fix #1===

The code in <code>teams_controller.rb</code> for function <code>bequeath_all</code> was too long, which would make it unreadable. To achieve it, a function <code>copy_teams</code> was added to the code.
<nowiki>
# Handovers all teams to the course that contains the corresponding assignment
# The team and team members are all copied.
def bequeath_all
if session[:team_type] == Team.allowed_types[1]
flash[:error] = 'Invalid team type for bequeath all'
redirect_to controller: 'teams', action: 'list', id: params[:id]
else
copy_teams(Team.team_operation[:bequeath])
end
end
</nowiki>

The function <code>copy_teams</code> is refactored further to improve it. The function <code>choose_copy_type</code> is refactored further to either perform <code>bequeath_copy</code> or <code>inherit_copy</code> based on team operation.
<nowiki>
# Method to abstract the functionality to copy teams.
def copy_teams(operation)
assignment = Assignment.find(params[:id])
if assignment.course_id
choose_copy_type(assignment, operation)
else
flash[:error] = 'No course was found for this assignment.'
end
redirect_to controller: 'teams', action: 'list', id: assignment.id
end

# Abstraction over different methods
def choose_copy_type(assignment, operation)
course = Course.find(assignment.course_id)
if operation == Team.team_operation[:bequeath]
bequeath_copy(assignment, course)
else
inherit_copy(assignment, course)
end
end

# Method to perform a copy of assignment teams to course
def bequeath_copy(assignment, course)
teams = assignment.teams
if course.course_teams.any?
flash[:error] = 'The course already has associated teams'
else
Team.copy_content(teams, course)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + course.name + '"'
end
end

# Method to inherit teams from course by copying
def inherit_copy(assignment, course)
teams = course.course_teams
if teams.empty?
flash[:error] = 'No teams were found when trying to inherit.'
else
Team.copy_content(teams, assignment)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + assignment.name + '"'
end
end

</nowiki>

===Fix #2===

The file <code>teams.rb</code> had an area where DRY principle could be applied. Function <code>randomize_all_by_parent</code> was modified to decrease the number of lines of code. The snippet to find teams still need team members and users who are not in any team has been modified, below is the code snippet.
<code>
# find teams still need team members and users who are not in any team
teams = Team.where(parent_id: parent.id, type: parent.class.to_s + 'Team').to_a
teams.each { |team| TeamsUser.where(team_id: team.id).each { |teams_user| users.delete(User.find(teams_user.user_id)) } }
teams.reject! { |team| Team.size(team.id) >= min_team_size }</code>

===Fix #3===

The file <code>hi_IN.yml</code> has some formatting in annotations that needed to be taken care of. For example, in Hindi, a sentence ending is indicated by the symbol "|", but it is given as "." everywhere. This was taken care of in the code, wherever Hindi annotations are available. Also, some additional annotations were added for <code>datetime->distance_in_words</code> key, where the annotations were modified to maintain uniformity throughout this key.

==Test Plan==

The teams controller testing document has been covered well by the previous teams, however after detailed analysis of the test file, new test cases were added, some test cases had to be removed, while some of them had to be modified to correction.

===Test Coverage===

Coverage has slightly improved, as the number of lines in team.rb file has decreased as a result of refactoring.

======Added Tests======

'''1.''' In the test <code>create teams method</code>, we added a test for incorrect parameters passed into the method. Below is the change
[[File:added_tests.png]]

======Modified Tests======

'''2.''' In the test <code> create method</code>, there was a test case which looked redundant, as it wasn't working earlier as well and it was already covered in the test file.

[[File:removed_nonworking_test.png]]

'''3.''' There was some confusion about the function <code>choose_copy_type, bequeath_copy and inherit_copy</code>. In the test <code>inherit method</code>, the function <code>inherit_copy</code> was tested under <code>called when assignment belongs to course and team is not empty</code>. Similarly, <code>bequeath_copy</code> was tested under <code>called when assignment belongs to course but team is empty</code>.

[[File:inherit_confusion_test.png]]

'''4.''' In the test <code> delete method</code>, some redundant comments were made, that was removed as well.

'''5.''' Some minor changes were made to some of the test cases.

==Contributors==
This project was done as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Sasank Marabattula, Srilekha Gudipati and Varun Deepak Gudhe. Our project mentor was Divyang Doshi.

CSC/ECE 517 Spring 2023 - E2303 Refactor teams controller.rb

2023-03-27T21:03:54Z

Smaraba: /* Test Plan */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.

==Introduction==

In this project we refactored teams_controller.rb and some associated files with it. Some duplicate code was removed. We added some comments for readability. Also, the hindi yml file was modified to enhance it.

==Issues Fixed==

# Refactored code in <code>teams_controller.rb</code>
#* Added more comments and briefly explained the functionality of all methods
#* Found areas in the code where the DRY principle can be applied
#* Refactored the function <code>bequeath_all</code> to improve readability by including function <code>copy_teams</code>
#* Refactored function <code>copy_teams</code> that calls <code>choose_copy_type</code>, which calls <code>bequeath_copy</code> or <code>inherit_copy</code> based on bequeath
# Refactored code in <code>teams.rb</code>
#* Added more comments to some methods in the code
#* Found areas in the code where the DRY principle can be applied
# Made changes to <code>hi_IN.yml</code> file, by adding more annotations and some grammatical errors
# Added more coverage to test by modifying <code>teams_controller_spec.rb</code>

==Files Changed==

* app/controllers/teams_controller.rb
* app/models/teams.rb
* config/locales/hi_IN.yml
* spec/controllers/teams_controller_spec.rb
* expertiza/app/views/teams/list.html.erb

==Changes==

===Fix #1===

The code in <code>teams_controller.rb</code> for function <code>bequeath_all</code> was too long, which would make it unreadable. To achieve it, a function <code>copy_teams</code> was added to the code.
<nowiki>
# Handovers all teams to the course that contains the corresponding assignment
# The team and team members are all copied.
def bequeath_all
if session[:team_type] == Team.allowed_types[1]
flash[:error] = 'Invalid team type for bequeath all'
redirect_to controller: 'teams', action: 'list', id: params[:id]
else
copy_teams(Team.team_operation[:bequeath])
end
end
</nowiki>

The function <code>copy_teams</code> is refactored further to improve it. The function <code>choose_copy_type</code> is refactored further to either perform <code>bequeath_copy</code> or <code>inherit_copy</code> based on team operation.
<nowiki>
# Method to abstract the functionality to copy teams.
def copy_teams(operation)
assignment = Assignment.find(params[:id])
if assignment.course_id
choose_copy_type(assignment, operation)
else
flash[:error] = 'No course was found for this assignment.'
end
redirect_to controller: 'teams', action: 'list', id: assignment.id
end

# Abstraction over different methods
def choose_copy_type(assignment, operation)
course = Course.find(assignment.course_id)
if operation == Team.team_operation[:bequeath]
bequeath_copy(assignment, course)
else
inherit_copy(assignment, course)
end
end

# Method to perform a copy of assignment teams to course
def bequeath_copy(assignment, course)
teams = assignment.teams
if course.course_teams.any?
flash[:error] = 'The course already has associated teams'
else
Team.copy_content(teams, course)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + course.name + '"'
end
end

# Method to inherit teams from course by copying
def inherit_copy(assignment, course)
teams = course.course_teams
if teams.empty?
flash[:error] = 'No teams were found when trying to inherit.'
else
Team.copy_content(teams, assignment)
flash[:note] = teams.length.to_s + ' teams were successfully copied to "' + assignment.name + '"'
end
end

</nowiki>

===Fix #2===

The file <code>teams.rb</code> had an area where DRY principle could be applied. Function <code>randomize_all_by_parent</code> was modified to decrease the number of lines of code. The snippet to find teams still need team members and users who are not in any team has been modified, below is the code snippet.
<code>
# find teams still need team members and users who are not in any team
teams = Team.where(parent_id: parent.id, type: parent.class.to_s + 'Team').to_a
teams.each { |team| TeamsUser.where(team_id: team.id).each { |teams_user| users.delete(User.find(teams_user.user_id)) } }
teams.reject! { |team| Team.size(team.id) >= min_team_size }</code>

===Fix #3===

The file <code>hi_IN.yml</code> has some formatting in annotations that needed to be taken care of. For example, in Hindi, a sentence ending is indicated by the symbol "|", but it is given as "." everywhere. This was taken care of in the code, wherever Hindi annotations are available. Also, some additional annotations were added for <code>datetime->distance_in_words</code> key, where the annotations were modified to maintain uniformity throughout this key.

==Test Plan==

The teams controller testing document has been covered well by the previous teams, however after detailed analysis of the test file, new test cases were added, some test cases had to be removed, while some of them had to be modified to correction.

===Test Coverage===

Coverage has slightly improved, as the number of lines in team.rb file has decreased as a result of refactoring.

======Added Tests======

'''1.''' In the test <code>create teams method</code>, we added a test for incorrect parameters passed into the method. Below is the change
[[File:added_tests.png]]

======Modified Tests======

'''2.''' In the test <code> create method</code>, there was a test case which looked redundant, as it wasn't working earlier as well and it was already covered in the test file.

[[File:removed_nonworking_test.png]]

'''3.''' There was some confusion about the function <code>choose_copy_type, bequeath_copy and inherit_copy</code>. In the test <code>inherit method</code>, the function <code>inherit_copy</code> was tested under <code>called when assignment belongs to course and team is not empty</code>. Similarly, <code>bequeath_copy</code> was tested under <code>called when assignment belongs to course but team is empty</code>.

[[File:inherit_confusion_test.png]]

'''4.''' In the test <code> delete method</code>, some redundant comments were made, that was removed as well.

'''5.''' Some minor changes were made to some of the test cases.

==Contributors==
This project was done as part of Dr. Edward Gehringer's "CSC/ECE 517: Object-Oriented Design and Development" class, Spring 2023. The contributors were: Sasank Marabattula, Srilekha Gudipati and Varun Deepak Gudhe. Our project mentor was Divyang Doshi.