Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2023 - E2348 Replicate Roles and Institution UIs ReactJS

2023-04-12T20:43:08Z

Nkale2: /* Designs */

CSC/ECE 517 Spring 2023 - E2348 Replicate Roles and Institution UIs ReactJS

2023-04-12T20:42:11Z

Nkale2: /* Designs */

File:Update user.jpeg

2023-04-12T20:41:50Z

Nkale2: Nkale2 uploaded a new version of File:Update user.jpeg

CSC/ECE 517 Spring 2023 - E2348 Replicate Roles and Institution UIs ReactJS

2023-04-12T20:40:36Z

Nkale2: /* Designs */

CSC/ECE 517 Spring 2023 - E2348 Replicate Roles and Institution UIs ReactJS

2023-04-12T20:39:44Z

Nkale2: /* Designs */

CSC/ECE 517 Spring 2023 - E2348 Replicate Roles and Institution UIs ReactJS

2023-04-12T20:38:54Z

Nkale2: /* Designs */

File:Update user.jpeg

2023-04-12T20:37:22Z

Nkale2:

CSC/ECE 517 Spring 2023 - E2348 Replicate Roles and Institution UIs ReactJS

2023-04-12T20:33:24Z

Nkale2: /* Testing */

CSC/ECE 517 Spring 2023 - E2348 Replicate Roles and Institution UIs ReactJS

2023-04-12T20:25:05Z

Nkale2:

CSC/ECE 517 Spring 2023 - E2348 Replicate Roles and Institution UIs ReactJS

2023-04-12T20:20:29Z

Nkale2: /* Designs */

File:Delete user.png

2023-04-12T20:19:22Z

Nkale2:

CSC/ECE 517 Spring 2023 - E2348 Replicate Roles and Institution UIs ReactJS

2023-04-12T19:57:27Z

Nkale2: /* Description of Project */

CSC/ECE 517 Spring 2023 - E2348 Replicate Roles and Institution UIs ReactJS

2023-04-06T21:09:32Z

Nkale2: /* Testing */

CSC/ECE 517 Spring 2023 - E2309. Refactor Node model and its subclasses

2023-03-23T03:47:03Z

Nkale2:

== Overview of Expertiza ==
Expertiza is a learning management system that is developed with Ruby on Rails and is accessible as open source software. It can create assignments, tests, assignment teams, and courses, among a wide range of other features and functions. It also has a thorough system for giving other teams and groups of teammates peer reviews and feedback. The files that are largely addressed in this project, such as <code>assignment_node.rb</code>, <code>course_node.rb</code>, <code>team_node.rb</code>, <code>folder_node.rb</code>, and <code>questionnaire_node.rb</code>, are essential in executing this functionality.

== Description of Project ==

The following is an Expertiza based OSS project which deals primarily with the Node model. The node model defines a tree structure containing Assignments, Courses_table, Questionnaire Types, Questionnaires, and Teams. The node model class is a superclass for the seven files namely <code>assignment_node.rb</code>, <code>course_node.rb</code>, <code>folder_node.rb</code>, <code>questionnaire_node.rb</code>, <code>questionnaire_type_node.rb</code>, <code>team_node.rb</code> and <code>team_user_node.rb</code>. Most of the methods written in <code>node.rb</code> are implemented by polymorphism in their respective subclass files.

The following changes were made: 
1. Method names were made more informative of the method wherever necessary. 
2. Some common methods in the subclasses were implemented in different ways. So the methods in the subclasses were refactored so that they are uniformly implemented. 
3. Appropriate comments were added to the existing code so that the functionality is easier to understand. 
4. A method was created to return true/false based on courses.private. 
5. Finally, tests were updated according to the changes made in the methods. 

== Files Modified ==
=== Changes to <code>app/models/assignment_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why?
|-
|1
|Redefined <code>self.get</code> method and added two new methods <code>self.get_assignment_query_conditions</code> and <code>self.get_assignments_managed_by_user</code>.
|The <code>self.get</code> method calls these two methods and creates the database query for getting the assignments. Creating two extra methods and calling them from <code>self.get</code> makes the code readable and uniform among all the files.
|-
|2
|<code>self.get_assignment_query_conditions</code> has all the conditions needed for the database query.
|It makes it easy to list all the query conditions at one place rather than in one method.
|-
|3
|<code>self.get_assignments_managed_by_user</code> manages all the user permissions with various conditions.
|It is better to maintain all the rights and accesses at one place rather than in the same method as <code>self.get</code>.
|-
|4
|Renamed the methods <code>get_max_team_size</code>, <code>get_is_intelligent</code>, <code>get_require_quiz</code>, <code>get_allow_suggestions</code> to <code>get_max_assignment_team_size</code>, <code>get_assignment_is_intelligent</code>, <code>get_assignment_require_quiz</code> <code>get_assignment_allow_suggestions</code>.
|Adding the word assignment to the methods name makes the methods more informative and adds meaning.
|-
|5
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.

|}

=== Changes to <code>app/controllers/tree_display_controller.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why?
|-
|1
|Renamed the methods that were renamed in <code>assignment_node.rb</code> above
|The methods tha renamed in <code>assignment_node.rb</code> have to be the same in controller so that when they are called, it does not give an error.

|}

=== Changes to <code>app/models/course_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why?
|-
|1
|Renamed the method <code>get_survey_distribution_id</code> to <code>get_course_survey_distribution_id</code>.
|Adding the word course to the method name makes the method more informative and adds meaning to survey distribution id.
|-
|2
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|}

=== Changes to <code>app/models/folder_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why?
|-
|1
|Renamed the method <code>get_child_type</code> to <code>get_folder_child_type</code>.
|Adding the word folder to the method name makes the method more informative and adds meaning to the child type of the folder.
|-
|2
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|}

=== Changes to <code>app/models/node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why?
|-
|1
|Changed the method name from <code>get_child_type</code> to <code>get_folder_child_type</code>
|The method name was changed in the <code>folder_node.rb</code>. Since <code>node.rb</code> is its super class, the method name in it also has to be the same
|}

=== Changes to <code>app/models/questionnaire_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why?
|-
|1
|Redefined <code>self.get</code> method and added two new methods <code>self.get_questionnaire_query_conditions</code> and <code>self.get_questionnaires_managed_by_user</code>.
|The <code>self.get</code> method calls these two methods and creates the database query for getting the assignments. Creating two extra methods and calling them from <code>self.get</code> makes the code readable and uniform among all the files.
|-
|2
|<code>self.get_questionnaire_query_conditions</code> has all the conditions needed for the database query.
|It makes it easy to list all the query conditions at one place rather than in one method.
|-
|3
|<code>self.get_questionnaires_managed_by_user</code> manages all the user permissions with various conditions.
|It is better to maintain all the rights and accesses at one place rather than in the same method as <code>self.get</code>.
|-
|4
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|}

=== Changes to <code>app/models/questionnaire_type_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why?
|-
|1
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|}

=== Changes to <code>app/models/team_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why?
|-
|1
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|}

=== Changes to <code>app/models/team_user_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why?
|-
|1
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|}

=== Changes to <code>spec/models/course_node_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why?
|-
|1
|Changed the method name from <code>get_survey_distribution_id</code> to <code>get_course_survey_distribution_id</code> in the test case where it is used
|Any changes made to the name of methods in the files should also be reflected in the test cases for them to pass successfully. If a method name is changed in a file and the same is not updated in the test case, the test case will fail
|}

== Testing ==

''' Testing was not in the scope for this project as it did not involve creating new methods or functions. However, care was taken that the existing test cases pass after refactoring the code as mentioned in the previous sections. Screenshots for all passing test cases have been attached below '''

=== Test Plan - Manual/System Test Cases ===
We ran a few system tests manually to make sure the functionality works as expected.

==== 1) Test instructor login & redirect to home page ====
Login page was displayed properly from our branch.
[[File:before_login.png|center|border|Form shown to the user before logging in to expertiza]]
After logging in user is properly redirected to the home page.
[[File:after_login.png|center|border|1400px|Page shown to the user after logging in to expertiza]]

==== 2) Test instructor logout & redirect to login page ====
Then, when the user clicks the logout button, they are correctly logged out and redirected once again to the login page as shown below.
[[File:after_logout.png|center|border|Form shown to the user after logging out of expertiza]]
==== 3) Test incorrect login ====
When the user attempts to login but enters the incorrect login information of "instructor6" and "incorrect," the user is shown the error message and then correctly redirected to the forgot password page shown below.
[[File:after_incorrect_login.png|center|border|1400px|Form shown to the user after an incorrect login attempt to expertiza]]

=== Automated Testing of <code>course_node.rb</code> ===
After refactoring the code for <code>course_node.rb</code>, all the test cases passed for it.

[[File:course_node.png|1000px|center]]

=== Automated Testing of <code>questionnaire_node.rb</code> ===
After refactoring the code for <code>questionnaire_node.rb</code>, all the test cases passed for it.

[[File:questionnaire.png|1000px|center]]

=== Automated Testing of <code>team_node.rb</code> ===
After refactoring the code for <code>team_node.rb</code>, all the test cases passed for it.

[[File:team.png|1000px|center]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/palash27/expertiza/
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2558
* '''VCL Server:''' http://152.7.177.86:8080/
Credentials

Username: instructor6

Password: password

== Contributors to this project ==
* Palash Rathod (unityid: prathod, github: palash27)
* Neha Kale (unityid: nkale2, github: nehakale8)
* Vansh Mehta (unityid: vpmehta2, github: vanshmehta-7)

CSC/ECE 517 Spring 2023 - E2309. Refactor Node model and its subclasses

2023-03-23T03:44:56Z

Nkale2: /* Changes to app/models/assignment_node.rb */

== Overview of Expertiza ==
Expertiza is a learning management system that is developed with Ruby on Rails and is accessible as open source software. It can create assignments, tests, assignment teams, and courses, among a wide range of other features and functions. It also has a thorough system for giving other teams and groups of teammates peer reviews and feedback. The files that are largely addressed in this project, such as <code>assignment_node.rb</code>, <code>course_node.rb</code>, <code>team_node.rb</code>, <code>folder_node.rb</code>, and <code>questionnaire_node.rb</code>, are essential in executing this functionality.

== Description of Project ==

The following is an Expertiza based OSS project which deals primarily with the Node model. The node model defines a tree structure containing Assignments, Courses_table, Questionnaire Types, Questionnaires, and Teams. The node model class is a superclass for the seven files namely <code>assignment_node.rb</code>, <code>course_node.rb</code>, <code>folder_node.rb</code>, <code>questionnaire_node.rb</code>, <code>questionnaire_type_node.rb</code>, <code>team_node.rb</code> and <code>team_user_node.rb</code>. Most of the methods written in <code>node.rb</code> are implemented by polymorphism in their respective subclass files.

The following changes were made: 
1. Method names were made more informative of the method wherever necessary. 
2. Some common methods in the subclasses were implemented in different ways. So the methods in the subclasses were refactored so that they are uniformly implemented. 
3. Appropriate comments were added to the existing code so that the functionality is easier to understand. 
4. A method was created to return true/false based on courses.private. 
5. Finally, tests were updated according to the changes made in the methods. 

== Files Modified ==
=== Changes to <code>app/models/assignment_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why?
|-
|1
|Redefined <code>self.get</code> method and added two new methods <code>self.get_assignment_query_conditions</code> and <code>self.get_assignments_managed_by_user</code>.
|The <code>self.get</code> method calls these two methods and creates the database query for getting the assignments. Creating two extra methods and calling them from <code>self.get</code> makes the code readable and uniform among all the files.
|-
|2
|<code>self.get_assignment_query_conditions</code> has all the conditions needed for the database query.
|It makes it easy to list all the query conditions at one place rather than in one method.
|-
|3
|<code>self.get_assignments_managed_by_user</code> manages all the user permissions with various conditions.
|It is better to maintain all the rights and accesses at one place rather than in the same method as <code>self.get</code>.
|-
|4
|Renamed the methods <code>get_max_team_size</code>, <code>get_is_intelligent</code>, <code>get_require_quiz</code>, <code>get_allow_suggestions</code> to <code>get_max_assignment_team_size</code>, <code>get_assignment_is_intelligent</code>, <code>get_assignment_require_quiz</code> <code>get_assignment_allow_suggestions</code>.
|Adding the word assignment to the methods name makes the methods more informative and adds meaning.
|-
|5
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.

|}

=== Changes to <code>app/controllers/tree_display_controller.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Renamed the methods that were renamed in <code>assignment_node.rb</code> above
|The methods tha renamed in <code>assignment_node.rb</code> have to be the same in controller so that when they are called, it does not give an error.
|[https://github.com/expertiza/expertiza/pull/2551/commits/6559afd1ca3e9cb7be4d04b76afb915bced97d71 Commit]

|}

=== Changes to <code>app/models/course_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Renamed the method <code>get_survey_distribution_id</code> to <code>get_course_survey_distribution_id</code>.
|Adding the word course to the method name makes the method more informative and adds meaning to survey distribution id.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-6ca71b9cc09704453515c71a33c834cadc95f764696a4d67f837e105610b1f5a Commit]
|-
|2
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-6ca71b9cc09704453515c71a33c834cadc95f764696a4d67f837e105610b1f5a Commit]
|}

=== Changes to <code>app/models/folder_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Renamed the method <code>get_child_type</code> to <code>get_folder_child_type</code>.
|Adding the word folder to the method name makes the method more informative and adds meaning to the child type of the folder.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-ea42e2052521f09fb3a4d2223fd3201a3970790276de2762b6c90de8809a83b5 Commit]
|-
|2
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-ea42e2052521f09fb3a4d2223fd3201a3970790276de2762b6c90de8809a83b5 Commit]
|}

=== Changes to <code>app/models/node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Changed the method name from <code>get_child_type</code> to <code>get_folder_child_type</code>
|The method name was changed in the <code>folder_node.rb</code>. Since <code>node.rb</code> is its super class, the method name in it also has to be the same
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-d521fcf96c3de2b8c810e0e8da2c12824cd1de1a7999f8b600284e8f358703c1 Commit]
|}

=== Changes to <code>app/models/questionnaire_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Redefined <code>self.get</code> method and added two new methods <code>self.get_questionnaire_query_conditions</code> and <code>self.get_questionnaires_managed_by_user</code>.
|The <code>self.get</code> method calls these two methods and creates the database query for getting the assignments. Creating two extra methods and calling them from <code>self.get</code> makes the code readable and uniform among all the files.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|-
|2
|<code>self.get_questionnaire_query_conditions</code> has all the conditions needed for the database query.
|It makes it easy to list all the query conditions at one place rather than in one method.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|-
|3
|<code>self.get_questionnaires_managed_by_user</code> manages all the user permissions with various conditions.
|It is better to maintain all the rights and accesses at one place rather than in the same method as <code>self.get</code>.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|-
|4
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|}

=== Changes to <code>app/models/questionnaire_type_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-f62cad1c50ac37ad898275c39ab1891dd5412298546d0722c57483a4c133392f Commit]
|}

=== Changes to <code>app/models/team_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-db3c2266d0ec594d628c454669f17af4e436b707ee0333659b3500e3bf96035c Commit]
|}

=== Changes to <code>app/models/team_user_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/65bc7bc0f3c4606c1d8fbabe7e1a1daef82de110#diff-3ea55478375d54fdeb8853d9537e53848e5a080a3932b41c730cf8eb44066ccf Commit]
|}

=== Changes to <code>spec/models/course_node_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Changed the method name from <code>get_survey_distribution_id</code> to <code>get_course_survey_distribution_id</code> in the test case where it is used
|Any changes made to the name of methods in the files should also be reflected in the test cases for them to pass successfully. If a method name is changed in a file and the same is not updated in the test case, the test case will fail
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-767a05e57089bb29700a6070e67d31f251ee6112293500968d6082412ad57020 Commit]
|}

== Testing ==

''' Testing was not in the scope for this project as it did not involve creating new methods or functions. However, care was taken that the existing test cases pass after refactoring the code as mentioned in the previous sections. Screenshots for all passing test cases have been attached below '''

=== Test Plan - Manual/System Test Cases ===
Along with the unit tests that we have written to test our files, we conducted a few system tests manually to verify the functionality works as expected. The <code>password_retrieval_controller.rb</code> is difficult for us to test because we don't have access to the email used to make the sample account, but the <code>auth_controller.rb</code> is very testable. Below is the tests we completed listed in the order of completion.

==== 1) Test instructor login & redirect to home page ====
When navigating to the expertiza website, our branch correctly displayed the login page as shown below.
[[File:before_login.png|center|border|Form shown to the user before logging in to expertiza]]
After typing in the sample login credentials of "instructor6" and "password," the user is then correctly logged in and redirected to the home page for instructors shown below.
[[File:after_login.png|center|border|1400px|Page shown to the user after logging in to expertiza]]
==== 2) Test instructor logout & redirect to login page ====
Then, when the user clicks the logout button, they are correctly logged out and redirected once again to the login page as shown below.
[[File:after_logout.png|center|border|Form shown to the user after logging out of expertiza]]
==== 3) Test incorrect login ====
When the user attempts to login but enters the incorrect login information of "instructor6" and "incorrect," the user is shown the error message and then correctly redirected to the forgot password page shown below.
[[File:after_incorrect_login.png|center|border|1400px|Form shown to the user after an incorrect login attempt to expertiza]]

=== Automated Testing of <code>course_node.rb</code> ===
After refactoring the code for <code>course_node.rb</code>, all the test cases passed for it.

[[File:course_node.png|1000px|center]]

=== Automated Testing of <code>questionnaire_node.rb</code> ===
After refactoring the code for <code>questionnaire_node.rb</code>, all the test cases passed for it.

[[File:questionnaire.png|1000px|center]]

=== Automated Testing of <code>team_node.rb</code> ===
After refactoring the code for <code>team_node.rb</code>, all the test cases passed for it.

[[File:team.png|1000px|center]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/palash27/expertiza/
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2558
* '''VCL Server:''' http://152.7.177.86:8080/
Credentials

Username: instructor6

Password: password

== Contributors to this project ==
* Palash Rathod (unityid: prathod, github: palash27)
* Neha Kale (unityid: nkale2, github: nehakale8)
* Vansh Mehta (unityid: vpmehta2, github: vanshmehta-7)

CSC/ECE 517 Spring 2023 - E2309. Refactor Node model and its subclasses

2023-03-23T03:40:04Z

Nkale2: /* Description of Project */

== Overview of Expertiza ==
Expertiza is a learning management system that is developed with Ruby on Rails and is accessible as open source software. It can create assignments, tests, assignment teams, and courses, among a wide range of other features and functions. It also has a thorough system for giving other teams and groups of teammates peer reviews and feedback. The files that are largely addressed in this project, such as <code>assignment_node.rb</code>, <code>course_node.rb</code>, <code>team_node.rb</code>, <code>folder_node.rb</code>, and <code>questionnaire_node.rb</code>, are essential in executing this functionality.

== Description of Project ==

The following is an Expertiza based OSS project which deals primarily with the Node model. The node model defines a tree structure containing Assignments, Courses_table, Questionnaire Types, Questionnaires, and Teams. The node model class is a superclass for the seven files namely <code>assignment_node.rb</code>, <code>course_node.rb</code>, <code>folder_node.rb</code>, <code>questionnaire_node.rb</code>, <code>questionnaire_type_node.rb</code>, <code>team_node.rb</code> and <code>team_user_node.rb</code>. Most of the methods written in <code>node.rb</code> are implemented by polymorphism in their respective subclass files.

The following changes were made: 
1. Method names were made more informative of the method wherever necessary. 
2. Some common methods in the subclasses were implemented in different ways. So the methods in the subclasses were refactored so that they are uniformly implemented. 
3. Appropriate comments were added to the existing code so that the functionality is easier to understand. 
4. A method was created to return true/false based on courses.private. 
5. Finally, tests were updated according to the changes made in the methods. 

== Files Modified ==
=== Changes to <code>app/models/assignment_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why?!! Commit Link
|-
|1
|Redefined <code>self.get</code> method and added two new methods <code>self.get_assignment_query_conditions</code> and <code>self.get_assignments_managed_by_user</code>.
|The <code>self.get</code> method calls these two methods and creates the database query for getting the assignments. Creating two extra methods and calling them from <code>self.get</code> makes the code readable and uniform among all the files.
|[https://github.com/expertiza/expertiza/pull/2551/commits/e53f28ad8143947b181dedce09a947caaefe512b Commit]
|-
|2
|<code>self.get_assignment_query_conditions</code> has all the conditions needed for the database query.
|It makes it easy to list all the query conditions at one place rather than in one method.
|[https://github.com/expertiza/expertiza/pull/2551/commits/e53f28ad8143947b181dedce09a947caaefe512b Commit]
|-
|3
|<code>self.get_assignments_managed_by_user</code> manages all the user permissions with various conditions.
|It is better to maintain all the rights and accesses at one place rather than in the same method as <code>self.get</code>.
|[https://github.com/expertiza/expertiza/pull/2551/commits/e53f28ad8143947b181dedce09a947caaefe512b Commit]
|-
|4
|Renamed the methods <code>get_max_team_size</code>, <code>get_is_intelligent</code>, <code>get_require_quiz</code>, <code>get_allow_suggestions</code> to <code>get_max_assignment_team_size</code>, <code>get_assignment_is_intelligent</code>, <code>get_assignment_require_quiz</code> <code>get_assignment_allow_suggestions</code>.
|Adding the word assignment to the methods name makes the methods more informative and adds meaning.
|[https://github.com/expertiza/expertiza/pull/2551/commits/6559afd1ca3e9cb7be4d04b76afb915bced97d71 Commit]
|-
|5
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-eb868d051fdc1ddba1cd6f85b5f34969ced671a0f2d82ccf26266efa2084f7dc Commit]

|}

=== Changes to <code>app/controllers/tree_display_controller.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Renamed the methods that were renamed in <code>assignment_node.rb</code> above
|The methods tha renamed in <code>assignment_node.rb</code> have to be the same in controller so that when they are called, it does not give an error.
|[https://github.com/expertiza/expertiza/pull/2551/commits/6559afd1ca3e9cb7be4d04b76afb915bced97d71 Commit]

|}

=== Changes to <code>app/models/course_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Renamed the method <code>get_survey_distribution_id</code> to <code>get_course_survey_distribution_id</code>.
|Adding the word course to the method name makes the method more informative and adds meaning to survey distribution id.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-6ca71b9cc09704453515c71a33c834cadc95f764696a4d67f837e105610b1f5a Commit]
|-
|2
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-6ca71b9cc09704453515c71a33c834cadc95f764696a4d67f837e105610b1f5a Commit]
|}

=== Changes to <code>app/models/folder_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Renamed the method <code>get_child_type</code> to <code>get_folder_child_type</code>.
|Adding the word folder to the method name makes the method more informative and adds meaning to the child type of the folder.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-ea42e2052521f09fb3a4d2223fd3201a3970790276de2762b6c90de8809a83b5 Commit]
|-
|2
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-ea42e2052521f09fb3a4d2223fd3201a3970790276de2762b6c90de8809a83b5 Commit]
|}

=== Changes to <code>app/models/node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Changed the method name from <code>get_child_type</code> to <code>get_folder_child_type</code>
|The method name was changed in the <code>folder_node.rb</code>. Since <code>node.rb</code> is its super class, the method name in it also has to be the same
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-d521fcf96c3de2b8c810e0e8da2c12824cd1de1a7999f8b600284e8f358703c1 Commit]
|}

=== Changes to <code>app/models/questionnaire_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Redefined <code>self.get</code> method and added two new methods <code>self.get_questionnaire_query_conditions</code> and <code>self.get_questionnaires_managed_by_user</code>.
|The <code>self.get</code> method calls these two methods and creates the database query for getting the assignments. Creating two extra methods and calling them from <code>self.get</code> makes the code readable and uniform among all the files.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|-
|2
|<code>self.get_questionnaire_query_conditions</code> has all the conditions needed for the database query.
|It makes it easy to list all the query conditions at one place rather than in one method.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|-
|3
|<code>self.get_questionnaires_managed_by_user</code> manages all the user permissions with various conditions.
|It is better to maintain all the rights and accesses at one place rather than in the same method as <code>self.get</code>.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|-
|4
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|}

=== Changes to <code>app/models/questionnaire_type_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-f62cad1c50ac37ad898275c39ab1891dd5412298546d0722c57483a4c133392f Commit]
|}

=== Changes to <code>app/models/team_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-db3c2266d0ec594d628c454669f17af4e436b707ee0333659b3500e3bf96035c Commit]
|}

=== Changes to <code>app/models/team_user_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/65bc7bc0f3c4606c1d8fbabe7e1a1daef82de110#diff-3ea55478375d54fdeb8853d9537e53848e5a080a3932b41c730cf8eb44066ccf Commit]
|}

=== Changes to <code>spec/models/course_node_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Changed the method name from <code>get_survey_distribution_id</code> to <code>get_course_survey_distribution_id</code> in the test case where it is used
|Any changes made to the name of methods in the files should also be reflected in the test cases for them to pass successfully. If a method name is changed in a file and the same is not updated in the test case, the test case will fail
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-767a05e57089bb29700a6070e67d31f251ee6112293500968d6082412ad57020 Commit]
|}

== Testing ==

''' Testing was not in the scope for this project as it did not involve creating new methods or functions. However, care was taken that the existing test cases pass after refactoring the code as mentioned in the previous sections. Screenshots for all passing test cases have been attached below '''

=== Test Plan - Manual/System Test Cases ===
Along with the unit tests that we have written to test our files, we conducted a few system tests manually to verify the functionality works as expected. The <code>password_retrieval_controller.rb</code> is difficult for us to test because we don't have access to the email used to make the sample account, but the <code>auth_controller.rb</code> is very testable. Below is the tests we completed listed in the order of completion.

==== 1) Test instructor login & redirect to home page ====
When navigating to the expertiza website, our branch correctly displayed the login page as shown below.
[[File:before_login.png|center|border|Form shown to the user before logging in to expertiza]]
After typing in the sample login credentials of "instructor6" and "password," the user is then correctly logged in and redirected to the home page for instructors shown below.
[[File:after_login.png|center|border|1400px|Page shown to the user after logging in to expertiza]]
==== 2) Test instructor logout & redirect to login page ====
Then, when the user clicks the logout button, they are correctly logged out and redirected once again to the login page as shown below.
[[File:after_logout.png|center|border|Form shown to the user after logging out of expertiza]]
==== 3) Test incorrect login ====
When the user attempts to login but enters the incorrect login information of "instructor6" and "incorrect," the user is shown the error message and then correctly redirected to the forgot password page shown below.
[[File:after_incorrect_login.png|center|border|1400px|Form shown to the user after an incorrect login attempt to expertiza]]

=== Automated Testing of <code>course_node.rb</code> ===
After refactoring the code for <code>course_node.rb</code>, all the test cases passed for it.

[[File:course_node.png|1000px|center]]

=== Automated Testing of <code>questionnaire_node.rb</code> ===
After refactoring the code for <code>questionnaire_node.rb</code>, all the test cases passed for it.

[[File:questionnaire.png|1000px|center]]

=== Automated Testing of <code>team_node.rb</code> ===
After refactoring the code for <code>team_node.rb</code>, all the test cases passed for it.

[[File:team.png|1000px|center]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/palash27/expertiza/
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2558
* '''VCL Server:''' http://152.7.177.86:8080/
Credentials

Username: instructor6

Password: password

== Contributors to this project ==
* Palash Rathod (unityid: prathod, github: palash27)
* Neha Kale (unityid: nkale2, github: nehakale8)
* Vansh Mehta (unityid: vpmehta2, github: vanshmehta-7)

CSC/ECE 517 Spring 2023 - E2309. Refactor Node model and its subclasses

2023-03-22T22:57:15Z

Nkale2: /* Description of Project */

== Overview of Expertiza ==
Expertiza is a learning management system that is available as open source software and was created using Ruby on Rails. It has a wide range of features and capabilities, including the capacity to design assignments, quizzes, assignment teams, and courses. It also includes a comprehensive mechanism for offering peer reviews and comments to other teams and groups of teammates. The files that are largely addressed in this project, such as <code>assignment_node.rb</code>, <code>course_node.rb</code>, <code>team_node.rb</code>, <code>folder_node.rb</code>, and <code>questionnaire_node.rb</code>, are essential in executing this functionality.

== Description of Project ==

The following is an Expertiza based OSS project which deals primarily with the Node model. The node model defines a tree structure containing Assignments, Courses_table, Questionnaire Types, Questionnaires, and Teams. The node model class is a superclass for the seven files namely assignment_node.rb, course_node.rb, folder_node.rb, questionnaire_node.rb, questionnaire_type_node.rb, team_node.rb and team_user_node.rb. Most of the methods written in node.rb are implemented by polymorphism in their respective subclass files.

The following changes were made: 
1. Method names were made more informative of the method wherever necessary. 
2. Some common methods in the subclasses were implemented in different ways. So the methods in the subclasses were refactored so that they are uniformly implemented. 
3. Appropriate comments were added to the existing code so that the functionality is easier to understand. 
4. A method was created to return true/false based on courses.private. 
5. Finally, tests were updated according to the changes made in the methods. 

== Files Modified ==
=== Changes to <code>app/models/assignment_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why?!! Commit Link
|-
|1
|Redefined <code>self.get</code> method and added two new methods <code>self.get_assignment_query_conditions</code> and <code>self.get_assignments_managed_by_user</code>.
|The <code>self.get</code> method calls these two methods and creates the database query for getting the assignments. Creating two extra methods and calling them from <code>self.get</code> makes the code readable and uniform among all the files.
|[https://github.com/expertiza/expertiza/pull/2551/commits/e53f28ad8143947b181dedce09a947caaefe512b Commit]
|-
|2
|<code>self.get_assignment_query_conditions</code> has all the conditions needed for the database query.
|It makes it easy to list all the query conditions at one place rather than in one method.
|[https://github.com/expertiza/expertiza/pull/2551/commits/e53f28ad8143947b181dedce09a947caaefe512b Commit]
|-
|3
|<code>self.get_assignments_managed_by_user</code> manages all the user permissions with various conditions.
|It is better to maintain all the rights and accesses at one place rather than in the same method as <code>self.get</code>.
|[https://github.com/expertiza/expertiza/pull/2551/commits/e53f28ad8143947b181dedce09a947caaefe512b Commit]
|-
|4
|Renamed the methods <code>get_max_team_size</code>, <code>get_is_intelligent</code>, <code>get_require_quiz</code>, <code>get_allow_suggestions</code> to <code>get_max_assignment_team_size</code>, <code>get_assignment_is_intelligent</code>, <code>get_assignment_require_quiz</code> <code>get_assignment_allow_suggestions</code>.
|Adding the word assignment to the methods name makes the methods more informative and adds meaning.
|[https://github.com/expertiza/expertiza/pull/2551/commits/6559afd1ca3e9cb7be4d04b76afb915bced97d71 Commit]
|-
|5
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-eb868d051fdc1ddba1cd6f85b5f34969ced671a0f2d82ccf26266efa2084f7dc Commit]

|}

=== Changes to <code>app/controllers/tree_display_controller.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Renamed the methods that were renamed in <code>assignment_node.rb</code> above
|The methods tha renamed in <code>assignment_node.rb</code> have to be the same in controller so that when they are called, it does not give an error.
|[https://github.com/expertiza/expertiza/pull/2551/commits/6559afd1ca3e9cb7be4d04b76afb915bced97d71 Commit]

|}

=== Changes to <code>app/models/course_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Renamed the method <code>get_survey_distribution_id</code> to <code>get_course_survey_distribution_id</code>.
|Adding the word course to the method name makes the method more informative and adds meaning to survey distribution id.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-6ca71b9cc09704453515c71a33c834cadc95f764696a4d67f837e105610b1f5a Commit]
|-
|2
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-6ca71b9cc09704453515c71a33c834cadc95f764696a4d67f837e105610b1f5a Commit]
|}

=== Changes to <code>app/models/folder_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Renamed the method <code>get_child_type</code> to <code>get_folder_child_type</code>.
|Adding the word folder to the method name makes the method more informative and adds meaning to the child type of the folder.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-ea42e2052521f09fb3a4d2223fd3201a3970790276de2762b6c90de8809a83b5 Commit]
|-
|2
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-ea42e2052521f09fb3a4d2223fd3201a3970790276de2762b6c90de8809a83b5 Commit]
|}

=== Changes to <code>app/models/node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Changed the method name from <code>get_child_type</code> to <code>get_folder_child_type</code>
|The method name was changed in the <code>folder_node.rb</code>. Since <code>node.rb</code> is its super class, the method name in it also has to be the same
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-d521fcf96c3de2b8c810e0e8da2c12824cd1de1a7999f8b600284e8f358703c1 Commit]
|}

=== Changes to <code>app/models/questionnaire_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Redefined <code>self.get</code> method and added two new methods <code>self.get_questionnaire_query_conditions</code> and <code>self.get_questionnaires_managed_by_user</code>.
|The <code>self.get</code> method calls these two methods and creates the database query for getting the assignments. Creating two extra methods and calling them from <code>self.get</code> makes the code readable and uniform among all the files.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|-
|2
|<code>self.get_questionnaire_query_conditions</code> has all the conditions needed for the database query.
|It makes it easy to list all the query conditions at one place rather than in one method.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|-
|3
|<code>self.get_questionnaires_managed_by_user</code> manages all the user permissions with various conditions.
|It is better to maintain all the rights and accesses at one place rather than in the same method as <code>self.get</code>.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|-
|4
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|}

=== Changes to <code>app/models/questionnaire_type_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-f62cad1c50ac37ad898275c39ab1891dd5412298546d0722c57483a4c133392f Commit]
|}

=== Changes to <code>app/models/team_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-db3c2266d0ec594d628c454669f17af4e436b707ee0333659b3500e3bf96035c Commit]
|}

=== Changes to <code>app/models/team_user_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/65bc7bc0f3c4606c1d8fbabe7e1a1daef82de110#diff-3ea55478375d54fdeb8853d9537e53848e5a080a3932b41c730cf8eb44066ccf Commit]
|}

=== Changes to <code>spec/models/course_node_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Changed the method name from <code>get_survey_distribution_id</code> to <code>get_course_survey_distribution_id</code> in the test case where it is used
|Any changes made to the name of methods in the files should also be reflected in the test cases for them to pass successfully. If a method name is changed in a file and the same is not updated in the test case, the test case will fail
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-767a05e57089bb29700a6070e67d31f251ee6112293500968d6082412ad57020 Commit]
|}

== Testing ==

'''Everything in the testing segment was beyond the scope of our work. However, we wanted to validate our code through RSpec testing before merging into the <code>main</code> Expertiza branch. In the second submission phase, we plan to further enhance the testing suite of the <code>auth_controller.rb</code> and <code>password_retrieval_controller.rb</code> through factories and fixtures.'''

=== Test Plan - Manual/System Test Cases ===
Along with the unit tests that we have written to test our files, we conducted a few system tests manually to verify the functionality works as expected. The <code>password_retrieval_controller.rb</code> is difficult for us to test because we don't have access to the email used to make the sample account, but the <code>auth_controller.rb</code> is very testable. Below is the tests we completed listed in the order of completion.

==== 1) Test instructor login & redirect to home page ====
When navigating to the expertiza website, our branch correctly displayed the login page as shown below.
[[File:before_login.png|center|border|Form shown to the user before logging in to expertiza]]
After typing in the sample login credentials of "instructor6" and "password," the user is then correctly logged in and redirected to the home page for instructors shown below.
[[File:after_login.png|center|border|1400px|Page shown to the user after logging in to expertiza]]
==== 2) Test instructor logout & redirect to login page ====
Then, when the user clicks the logout button, they are correctly logged out and redirected once again to the login page as shown below.
[[File:after_logout.png|center|border|Form shown to the user after logging out of expertiza]]
==== 3) Test incorrect login ====
When the user attempts to login but enters the incorrect login information of "instructor6" and "incorrect," the user is shown the error message and then correctly redirected to the forgot password page shown below.
[[File:after_incorrect_login.png|center|border|1400px|Form shown to the user after an incorrect login attempt to expertiza]]

=== Automated Testing of <code>auth_controller_.rb</code> ===
Before any refactoring to <code>auth_controller.rb</code> was done, we ran the rspec tests created for the controller with the following command: <code>rspec spec/controllers/auth_controller_spec.rb</code>

[[File:before_refactor_auth_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]

After making all of the above changes to <code>auth_controller.rb</code>, we ran the rspec tests for the controller again with the command: <code>rspec spec/controllers/auth_controller_spec.rb</code>

[[File:after_refactor_auth_controller.png|center|frame|rspec tests continuing to all pass after completing the refactoring]]

We have successfully preserved the passing tests after the improvements we made to the <code>auth_controller.rb</code>. Next we looked at the existing tests to see if they could be improved. As listed in the files changed above, there were a few improvements to be made to <code>auth_controller_spec.rb</code>. We improved a check for redirecting the user after logging in and added two tests to make sure the role cache was being rebuilt after both setting the current role and clearing the user info. We ran the tests again with the command: <code>rspec spec/controllers/auth_controller_spec.rb</code>

[[File:after_improving_auth_controller_spec.png|center|frame|rspec tests continuing to all pass after improving and adding to the auth_controller tests]]

Tests prior to the changes covered 91.94% of <code>auth_controller.rb</code>.
[[File:coverage_before.png|center|frame|rspec test coverage report before the improvements to the auth_controller unit tests]]

This is already a good coverage but after my changes I wanted to ensure my changes were also tested thoroughly. After adding tests, the tests covered 95.24% of <code>auth_controller.rb</code>. It improved slightly to be an even better coverage.
[[File:coverage_after.png|center|frame|rspec test coverage report after the improvements to the auth_controller unit tests]]

=== Automated Testing of <code>password_retrieval_controller.rb</code> ===
Before any refactoring to <code>passsword_retrieval_controller.rb</code> was done, we ran the rspec tests created for the controller with the following command: <code>rspec spec/controllers/password_retrieval_controller_spec.rb</code>

[[File:before_refactor_password_retrieval_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]

Tests prior to the changes covered 63.3% of <code>password_retrieval_controller.rb</code>.
[[File:E2252_password_retrieval_coverage_report_before.png|center|frame|rspec test coverage report before the refactoring was completed]]

After adding tests, the tests covered 91.1% of <code>password_retrieval_controller.rb</code>.
[[File:E2252_password_retrieval_coverage_report_after.png|center|frame|rspec test coverage report after the refactoring was completed]]

We implemented factories in the rspec test file to improve modularity and code readability. Factories provide more flexibility in generating models to meet the requirements of the test, as opposed to fixtures. As you can see from the below images, the code is significantly cleaner as many lines of hardcoded strings have been removed.
[[File:prefactory.png|center|frame|rspec tests before factories were implemented]] 
[[File:postfactory.png|center|frame|rspec tests after factories were implemented]]

The below image shows the output of the following command after all tests were added: <code>rspec spec/controllers/password_retrieval_controller_spec.rb</code>

[[File:After refactor password retrieval controller.png|center|frame|rspec tests all passing after the refactoring was completed]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/palash27/expertiza/
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2551
* '''VCL Server:''' http://152.7.98.115:8080/

== Contributors to this project ==
* Palash Rathod (unityid: prathod, github: palash27)
* Neha Kale (unityid: nkale, github: nkale)
* Vansh Mehta (unityid: vpmehta2, github: vanshmehta-7)

CSC/ECE 517 Spring 2023 - E2309. Refactor Node model and its subclasses

2023-03-22T22:56:51Z

Nkale2: /* Description of Project */

== Overview of Expertiza ==
Expertiza is a learning management system that is available as open source software and was created using Ruby on Rails. It has a wide range of features and capabilities, including the capacity to design assignments, quizzes, assignment teams, and courses. It also includes a comprehensive mechanism for offering peer reviews and comments to other teams and groups of teammates. The files that are largely addressed in this project, such as <code>assignment_node.rb</code>, <code>course_node.rb</code>, <code>team_node.rb</code>, <code>folder_node.rb</code>, and <code>questionnaire_node.rb</code>, are essential in executing this functionality.

== Description of Project ==

The following is an Expertiza based OSS project which deals primarily with the Node model. The node model defines a tree structure containing Assignments, Courses_table, Questionnaire Types, Questionnaires, and Teams. The node model class is a superclass for the seven files namely assignment_node.rb, course_node.rb, folder_node.rb, questionnaire_node.rb, questionnaire_type_node.rb, team_node.rb and team_user_node.rb. Most of the methods written in node.rb are implemented by polymorphism in their respective subclass files.

The following changes were made: 
1. Method names were made more informative of the method wherever necessary.
2. Some common methods in the subclasses were implemented in different ways. So the methods in the subclasses were refactored so that they are uniformly implemented.
3. Appropriate comments were added to the existing code so that the functionality is easier to understand.
4. A method was created to return true/false based on courses.private.
5. Finally, tests were updated according to the changes made in the methods.

== Files Modified ==
=== Changes to <code>app/models/assignment_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why?!! Commit Link
|-
|1
|Redefined <code>self.get</code> method and added two new methods <code>self.get_assignment_query_conditions</code> and <code>self.get_assignments_managed_by_user</code>.
|The <code>self.get</code> method calls these two methods and creates the database query for getting the assignments. Creating two extra methods and calling them from <code>self.get</code> makes the code readable and uniform among all the files.
|[https://github.com/expertiza/expertiza/pull/2551/commits/e53f28ad8143947b181dedce09a947caaefe512b Commit]
|-
|2
|<code>self.get_assignment_query_conditions</code> has all the conditions needed for the database query.
|It makes it easy to list all the query conditions at one place rather than in one method.
|[https://github.com/expertiza/expertiza/pull/2551/commits/e53f28ad8143947b181dedce09a947caaefe512b Commit]
|-
|3
|<code>self.get_assignments_managed_by_user</code> manages all the user permissions with various conditions.
|It is better to maintain all the rights and accesses at one place rather than in the same method as <code>self.get</code>.
|[https://github.com/expertiza/expertiza/pull/2551/commits/e53f28ad8143947b181dedce09a947caaefe512b Commit]
|-
|4
|Renamed the methods <code>get_max_team_size</code>, <code>get_is_intelligent</code>, <code>get_require_quiz</code>, <code>get_allow_suggestions</code> to <code>get_max_assignment_team_size</code>, <code>get_assignment_is_intelligent</code>, <code>get_assignment_require_quiz</code> <code>get_assignment_allow_suggestions</code>.
|Adding the word assignment to the methods name makes the methods more informative and adds meaning.
|[https://github.com/expertiza/expertiza/pull/2551/commits/6559afd1ca3e9cb7be4d04b76afb915bced97d71 Commit]
|-
|5
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-eb868d051fdc1ddba1cd6f85b5f34969ced671a0f2d82ccf26266efa2084f7dc Commit]

|}

=== Changes to <code>app/controllers/tree_display_controller.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Renamed the methods that were renamed in <code>assignment_node.rb</code> above
|The methods tha renamed in <code>assignment_node.rb</code> have to be the same in controller so that when they are called, it does not give an error.
|[https://github.com/expertiza/expertiza/pull/2551/commits/6559afd1ca3e9cb7be4d04b76afb915bced97d71 Commit]

|}

=== Changes to <code>app/models/course_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Renamed the method <code>get_survey_distribution_id</code> to <code>get_course_survey_distribution_id</code>.
|Adding the word course to the method name makes the method more informative and adds meaning to survey distribution id.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-6ca71b9cc09704453515c71a33c834cadc95f764696a4d67f837e105610b1f5a Commit]
|-
|2
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-6ca71b9cc09704453515c71a33c834cadc95f764696a4d67f837e105610b1f5a Commit]
|}

=== Changes to <code>app/models/folder_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Renamed the method <code>get_child_type</code> to <code>get_folder_child_type</code>.
|Adding the word folder to the method name makes the method more informative and adds meaning to the child type of the folder.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-ea42e2052521f09fb3a4d2223fd3201a3970790276de2762b6c90de8809a83b5 Commit]
|-
|2
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-ea42e2052521f09fb3a4d2223fd3201a3970790276de2762b6c90de8809a83b5 Commit]
|}

=== Changes to <code>app/models/node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Changed the method name from <code>get_child_type</code> to <code>get_folder_child_type</code>
|The method name was changed in the <code>folder_node.rb</code>. Since <code>node.rb</code> is its super class, the method name in it also has to be the same
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-d521fcf96c3de2b8c810e0e8da2c12824cd1de1a7999f8b600284e8f358703c1 Commit]
|}

=== Changes to <code>app/models/questionnaire_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Redefined <code>self.get</code> method and added two new methods <code>self.get_questionnaire_query_conditions</code> and <code>self.get_questionnaires_managed_by_user</code>.
|The <code>self.get</code> method calls these two methods and creates the database query for getting the assignments. Creating two extra methods and calling them from <code>self.get</code> makes the code readable and uniform among all the files.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|-
|2
|<code>self.get_questionnaire_query_conditions</code> has all the conditions needed for the database query.
|It makes it easy to list all the query conditions at one place rather than in one method.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|-
|3
|<code>self.get_questionnaires_managed_by_user</code> manages all the user permissions with various conditions.
|It is better to maintain all the rights and accesses at one place rather than in the same method as <code>self.get</code>.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|-
|4
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|}

=== Changes to <code>app/models/questionnaire_type_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-f62cad1c50ac37ad898275c39ab1891dd5412298546d0722c57483a4c133392f Commit]
|}

=== Changes to <code>app/models/team_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-db3c2266d0ec594d628c454669f17af4e436b707ee0333659b3500e3bf96035c Commit]
|}

=== Changes to <code>app/models/team_user_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/65bc7bc0f3c4606c1d8fbabe7e1a1daef82de110#diff-3ea55478375d54fdeb8853d9537e53848e5a080a3932b41c730cf8eb44066ccf Commit]
|}

=== Changes to <code>spec/models/course_node_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Changed the method name from <code>get_survey_distribution_id</code> to <code>get_course_survey_distribution_id</code> in the test case where it is used
|Any changes made to the name of methods in the files should also be reflected in the test cases for them to pass successfully. If a method name is changed in a file and the same is not updated in the test case, the test case will fail
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-767a05e57089bb29700a6070e67d31f251ee6112293500968d6082412ad57020 Commit]
|}

== Testing ==

'''Everything in the testing segment was beyond the scope of our work. However, we wanted to validate our code through RSpec testing before merging into the <code>main</code> Expertiza branch. In the second submission phase, we plan to further enhance the testing suite of the <code>auth_controller.rb</code> and <code>password_retrieval_controller.rb</code> through factories and fixtures.'''

=== Test Plan - Manual/System Test Cases ===
Along with the unit tests that we have written to test our files, we conducted a few system tests manually to verify the functionality works as expected. The <code>password_retrieval_controller.rb</code> is difficult for us to test because we don't have access to the email used to make the sample account, but the <code>auth_controller.rb</code> is very testable. Below is the tests we completed listed in the order of completion.

==== 1) Test instructor login & redirect to home page ====
When navigating to the expertiza website, our branch correctly displayed the login page as shown below.
[[File:before_login.png|center|border|Form shown to the user before logging in to expertiza]]
After typing in the sample login credentials of "instructor6" and "password," the user is then correctly logged in and redirected to the home page for instructors shown below.
[[File:after_login.png|center|border|1400px|Page shown to the user after logging in to expertiza]]
==== 2) Test instructor logout & redirect to login page ====
Then, when the user clicks the logout button, they are correctly logged out and redirected once again to the login page as shown below.
[[File:after_logout.png|center|border|Form shown to the user after logging out of expertiza]]
==== 3) Test incorrect login ====
When the user attempts to login but enters the incorrect login information of "instructor6" and "incorrect," the user is shown the error message and then correctly redirected to the forgot password page shown below.
[[File:after_incorrect_login.png|center|border|1400px|Form shown to the user after an incorrect login attempt to expertiza]]

=== Automated Testing of <code>auth_controller_.rb</code> ===
Before any refactoring to <code>auth_controller.rb</code> was done, we ran the rspec tests created for the controller with the following command: <code>rspec spec/controllers/auth_controller_spec.rb</code>

[[File:before_refactor_auth_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]

After making all of the above changes to <code>auth_controller.rb</code>, we ran the rspec tests for the controller again with the command: <code>rspec spec/controllers/auth_controller_spec.rb</code>

[[File:after_refactor_auth_controller.png|center|frame|rspec tests continuing to all pass after completing the refactoring]]

We have successfully preserved the passing tests after the improvements we made to the <code>auth_controller.rb</code>. Next we looked at the existing tests to see if they could be improved. As listed in the files changed above, there were a few improvements to be made to <code>auth_controller_spec.rb</code>. We improved a check for redirecting the user after logging in and added two tests to make sure the role cache was being rebuilt after both setting the current role and clearing the user info. We ran the tests again with the command: <code>rspec spec/controllers/auth_controller_spec.rb</code>

[[File:after_improving_auth_controller_spec.png|center|frame|rspec tests continuing to all pass after improving and adding to the auth_controller tests]]

Tests prior to the changes covered 91.94% of <code>auth_controller.rb</code>.
[[File:coverage_before.png|center|frame|rspec test coverage report before the improvements to the auth_controller unit tests]]

This is already a good coverage but after my changes I wanted to ensure my changes were also tested thoroughly. After adding tests, the tests covered 95.24% of <code>auth_controller.rb</code>. It improved slightly to be an even better coverage.
[[File:coverage_after.png|center|frame|rspec test coverage report after the improvements to the auth_controller unit tests]]

=== Automated Testing of <code>password_retrieval_controller.rb</code> ===
Before any refactoring to <code>passsword_retrieval_controller.rb</code> was done, we ran the rspec tests created for the controller with the following command: <code>rspec spec/controllers/password_retrieval_controller_spec.rb</code>

[[File:before_refactor_password_retrieval_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]

Tests prior to the changes covered 63.3% of <code>password_retrieval_controller.rb</code>.
[[File:E2252_password_retrieval_coverage_report_before.png|center|frame|rspec test coverage report before the refactoring was completed]]

After adding tests, the tests covered 91.1% of <code>password_retrieval_controller.rb</code>.
[[File:E2252_password_retrieval_coverage_report_after.png|center|frame|rspec test coverage report after the refactoring was completed]]

We implemented factories in the rspec test file to improve modularity and code readability. Factories provide more flexibility in generating models to meet the requirements of the test, as opposed to fixtures. As you can see from the below images, the code is significantly cleaner as many lines of hardcoded strings have been removed.
[[File:prefactory.png|center|frame|rspec tests before factories were implemented]] 
[[File:postfactory.png|center|frame|rspec tests after factories were implemented]]

The below image shows the output of the following command after all tests were added: <code>rspec spec/controllers/password_retrieval_controller_spec.rb</code>

[[File:After refactor password retrieval controller.png|center|frame|rspec tests all passing after the refactoring was completed]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/palash27/expertiza/
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2551
* '''VCL Server:''' http://152.7.98.115:8080/

== Contributors to this project ==
* Palash Rathod (unityid: prathod, github: palash27)
* Neha Kale (unityid: nkale, github: nkale)
* Vansh Mehta (unityid: vpmehta2, github: vanshmehta-7)

CSC/ECE 517 Spring 2023 - E2309. Refactor Node model and its subclasses

2023-03-22T22:55:38Z

Nkale2:

== Overview of Expertiza ==
Expertiza is a learning management system that is available as open source software and was created using Ruby on Rails. It has a wide range of features and capabilities, including the capacity to design assignments, quizzes, assignment teams, and courses. It also includes a comprehensive mechanism for offering peer reviews and comments to other teams and groups of teammates. The files that are largely addressed in this project, such as <code>assignment_node.rb</code>, <code>course_node.rb</code>, <code>team_node.rb</code>, <code>folder_node.rb</code>, and <code>questionnaire_node.rb</code>, are essential in executing this functionality.

== Description of Project ==

The following is an Expertiza based OSS project which deals primarily with the Node model. The node model defines a tree structure containing Assignments, Courses_table, Questionnaire Types, Questionnaires, and Teams. The node model class is a superclass for the seven files namely assignment_node.rb, course_node.rb, folder_node.rb, questionnaire_node.rb, questionnaire_type_node.rb, team_node.rb and team_user_node.rb. Most of the methods written in node.rb are implemented by polymorphism in their respective subclass files.

The following changes were made:
1) Method names were made more informative of the method wherever necessary.
2) Some common methods in the subclasses were implemented in different ways. So the methods in the subclasses were refactored so that they are uniformly implemented.
3) Appropriate comments were added to the existing code so that the functionality is easier to understand.
A method was created to return true/false based on courses.private.
Finally, tests were updated according to the changes made in the methods.

== Files Modified ==
=== Changes to <code>app/models/assignment_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why?!! Commit Link
|-
|1
|Redefined <code>self.get</code> method and added two new methods <code>self.get_assignment_query_conditions</code> and <code>self.get_assignments_managed_by_user</code>.
|The <code>self.get</code> method calls these two methods and creates the database query for getting the assignments. Creating two extra methods and calling them from <code>self.get</code> makes the code readable and uniform among all the files.
|[https://github.com/expertiza/expertiza/pull/2551/commits/e53f28ad8143947b181dedce09a947caaefe512b Commit]
|-
|2
|<code>self.get_assignment_query_conditions</code> has all the conditions needed for the database query.
|It makes it easy to list all the query conditions at one place rather than in one method.
|[https://github.com/expertiza/expertiza/pull/2551/commits/e53f28ad8143947b181dedce09a947caaefe512b Commit]
|-
|3
|<code>self.get_assignments_managed_by_user</code> manages all the user permissions with various conditions.
|It is better to maintain all the rights and accesses at one place rather than in the same method as <code>self.get</code>.
|[https://github.com/expertiza/expertiza/pull/2551/commits/e53f28ad8143947b181dedce09a947caaefe512b Commit]
|-
|4
|Renamed the methods <code>get_max_team_size</code>, <code>get_is_intelligent</code>, <code>get_require_quiz</code>, <code>get_allow_suggestions</code> to <code>get_max_assignment_team_size</code>, <code>get_assignment_is_intelligent</code>, <code>get_assignment_require_quiz</code> <code>get_assignment_allow_suggestions</code>.
|Adding the word assignment to the methods name makes the methods more informative and adds meaning.
|[https://github.com/expertiza/expertiza/pull/2551/commits/6559afd1ca3e9cb7be4d04b76afb915bced97d71 Commit]
|-
|5
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-eb868d051fdc1ddba1cd6f85b5f34969ced671a0f2d82ccf26266efa2084f7dc Commit]

|}

=== Changes to <code>app/controllers/tree_display_controller.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Renamed the methods that were renamed in <code>assignment_node.rb</code> above
|The methods tha renamed in <code>assignment_node.rb</code> have to be the same in controller so that when they are called, it does not give an error.
|[https://github.com/expertiza/expertiza/pull/2551/commits/6559afd1ca3e9cb7be4d04b76afb915bced97d71 Commit]

|}

=== Changes to <code>app/models/course_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Renamed the method <code>get_survey_distribution_id</code> to <code>get_course_survey_distribution_id</code>.
|Adding the word course to the method name makes the method more informative and adds meaning to survey distribution id.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-6ca71b9cc09704453515c71a33c834cadc95f764696a4d67f837e105610b1f5a Commit]
|-
|2
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-6ca71b9cc09704453515c71a33c834cadc95f764696a4d67f837e105610b1f5a Commit]
|}

=== Changes to <code>app/models/folder_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Renamed the method <code>get_child_type</code> to <code>get_folder_child_type</code>.
|Adding the word folder to the method name makes the method more informative and adds meaning to the child type of the folder.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-ea42e2052521f09fb3a4d2223fd3201a3970790276de2762b6c90de8809a83b5 Commit]
|-
|2
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-ea42e2052521f09fb3a4d2223fd3201a3970790276de2762b6c90de8809a83b5 Commit]
|}

=== Changes to <code>app/models/node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Changed the method name from <code>get_child_type</code> to <code>get_folder_child_type</code>
|The method name was changed in the <code>folder_node.rb</code>. Since <code>node.rb</code> is its super class, the method name in it also has to be the same
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-d521fcf96c3de2b8c810e0e8da2c12824cd1de1a7999f8b600284e8f358703c1 Commit]
|}

=== Changes to <code>app/models/questionnaire_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Redefined <code>self.get</code> method and added two new methods <code>self.get_questionnaire_query_conditions</code> and <code>self.get_questionnaires_managed_by_user</code>.
|The <code>self.get</code> method calls these two methods and creates the database query for getting the assignments. Creating two extra methods and calling them from <code>self.get</code> makes the code readable and uniform among all the files.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|-
|2
|<code>self.get_questionnaire_query_conditions</code> has all the conditions needed for the database query.
|It makes it easy to list all the query conditions at one place rather than in one method.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|-
|3
|<code>self.get_questionnaires_managed_by_user</code> manages all the user permissions with various conditions.
|It is better to maintain all the rights and accesses at one place rather than in the same method as <code>self.get</code>.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|-
|4
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|}

=== Changes to <code>app/models/questionnaire_type_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-f62cad1c50ac37ad898275c39ab1891dd5412298546d0722c57483a4c133392f Commit]
|}

=== Changes to <code>app/models/team_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-db3c2266d0ec594d628c454669f17af4e436b707ee0333659b3500e3bf96035c Commit]
|}

=== Changes to <code>app/models/team_user_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/65bc7bc0f3c4606c1d8fbabe7e1a1daef82de110#diff-3ea55478375d54fdeb8853d9537e53848e5a080a3932b41c730cf8eb44066ccf Commit]
|}

=== Changes to <code>spec/models/course_node_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Changed the method name from <code>get_survey_distribution_id</code> to <code>get_course_survey_distribution_id</code> in the test case where it is used
|Any changes made to the name of methods in the files should also be reflected in the test cases for them to pass successfully. If a method name is changed in a file and the same is not updated in the test case, the test case will fail
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-767a05e57089bb29700a6070e67d31f251ee6112293500968d6082412ad57020 Commit]
|}

== Testing ==

'''Everything in the testing segment was beyond the scope of our work. However, we wanted to validate our code through RSpec testing before merging into the <code>main</code> Expertiza branch. In the second submission phase, we plan to further enhance the testing suite of the <code>auth_controller.rb</code> and <code>password_retrieval_controller.rb</code> through factories and fixtures.'''

=== Test Plan - Manual/System Test Cases ===
Along with the unit tests that we have written to test our files, we conducted a few system tests manually to verify the functionality works as expected. The <code>password_retrieval_controller.rb</code> is difficult for us to test because we don't have access to the email used to make the sample account, but the <code>auth_controller.rb</code> is very testable. Below is the tests we completed listed in the order of completion.

==== 1) Test instructor login & redirect to home page ====
When navigating to the expertiza website, our branch correctly displayed the login page as shown below.
[[File:before_login.png|center|border|Form shown to the user before logging in to expertiza]]
After typing in the sample login credentials of "instructor6" and "password," the user is then correctly logged in and redirected to the home page for instructors shown below.
[[File:after_login.png|center|border|1400px|Page shown to the user after logging in to expertiza]]
==== 2) Test instructor logout & redirect to login page ====
Then, when the user clicks the logout button, they are correctly logged out and redirected once again to the login page as shown below.
[[File:after_logout.png|center|border|Form shown to the user after logging out of expertiza]]
==== 3) Test incorrect login ====
When the user attempts to login but enters the incorrect login information of "instructor6" and "incorrect," the user is shown the error message and then correctly redirected to the forgot password page shown below.
[[File:after_incorrect_login.png|center|border|1400px|Form shown to the user after an incorrect login attempt to expertiza]]

=== Automated Testing of <code>auth_controller_.rb</code> ===
Before any refactoring to <code>auth_controller.rb</code> was done, we ran the rspec tests created for the controller with the following command: <code>rspec spec/controllers/auth_controller_spec.rb</code>

[[File:before_refactor_auth_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]

After making all of the above changes to <code>auth_controller.rb</code>, we ran the rspec tests for the controller again with the command: <code>rspec spec/controllers/auth_controller_spec.rb</code>

[[File:after_refactor_auth_controller.png|center|frame|rspec tests continuing to all pass after completing the refactoring]]

We have successfully preserved the passing tests after the improvements we made to the <code>auth_controller.rb</code>. Next we looked at the existing tests to see if they could be improved. As listed in the files changed above, there were a few improvements to be made to <code>auth_controller_spec.rb</code>. We improved a check for redirecting the user after logging in and added two tests to make sure the role cache was being rebuilt after both setting the current role and clearing the user info. We ran the tests again with the command: <code>rspec spec/controllers/auth_controller_spec.rb</code>

[[File:after_improving_auth_controller_spec.png|center|frame|rspec tests continuing to all pass after improving and adding to the auth_controller tests]]

Tests prior to the changes covered 91.94% of <code>auth_controller.rb</code>.
[[File:coverage_before.png|center|frame|rspec test coverage report before the improvements to the auth_controller unit tests]]

This is already a good coverage but after my changes I wanted to ensure my changes were also tested thoroughly. After adding tests, the tests covered 95.24% of <code>auth_controller.rb</code>. It improved slightly to be an even better coverage.
[[File:coverage_after.png|center|frame|rspec test coverage report after the improvements to the auth_controller unit tests]]

=== Automated Testing of <code>password_retrieval_controller.rb</code> ===
Before any refactoring to <code>passsword_retrieval_controller.rb</code> was done, we ran the rspec tests created for the controller with the following command: <code>rspec spec/controllers/password_retrieval_controller_spec.rb</code>

[[File:before_refactor_password_retrieval_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]

Tests prior to the changes covered 63.3% of <code>password_retrieval_controller.rb</code>.
[[File:E2252_password_retrieval_coverage_report_before.png|center|frame|rspec test coverage report before the refactoring was completed]]

After adding tests, the tests covered 91.1% of <code>password_retrieval_controller.rb</code>.
[[File:E2252_password_retrieval_coverage_report_after.png|center|frame|rspec test coverage report after the refactoring was completed]]

We implemented factories in the rspec test file to improve modularity and code readability. Factories provide more flexibility in generating models to meet the requirements of the test, as opposed to fixtures. As you can see from the below images, the code is significantly cleaner as many lines of hardcoded strings have been removed.
[[File:prefactory.png|center|frame|rspec tests before factories were implemented]] 
[[File:postfactory.png|center|frame|rspec tests after factories were implemented]]

The below image shows the output of the following command after all tests were added: <code>rspec spec/controllers/password_retrieval_controller_spec.rb</code>

[[File:After refactor password retrieval controller.png|center|frame|rspec tests all passing after the refactoring was completed]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/palash27/expertiza/
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2551
* '''VCL Server:''' http://152.7.98.115:8080/

== Contributors to this project ==
* Palash Rathod (unityid: prathod, github: palash27)
* Neha Kale (unityid: nkale, github: nkale)
* Vansh Mehta (unityid: vpmehta2, github: vanshmehta-7)

CSC/ECE 517 Spring 2023 - E2309. Refactor Node model and its subclasses

2023-03-22T22:54:27Z

Nkale2: /* Description of Project */

== Overview of Expertiza ==
Expertiza is a learning management system that is available as open source software and was created using Ruby on Rails. It has a wide range of features and capabilities, including the capacity to design assignments, quizzes, assignment teams, and courses. It also includes a comprehensive mechanism for offering peer reviews and comments to other teams and groups of teammates. The files that are largely addressed in this project, such as <code>assignment_node.rb</code>, <code>course_node.rb</code>, <code>team_node.rb</code>, <code>folder_node.rb</code>, and <code>questionnaire_node.rb</code>, are essential in executing this functionality.

== Description of Project ==

The following is an Expertiza based OSS project which deals primarily with the Node model. The node model defines a tree structure containing Assignments, Courses_table, Questionnaire Types, Questionnaires, and Teams. The node model class is a superclass for the seven files namely assignment_node.rb, course_node.rb, folder_node.rb, questionnaire_node.rb, questionnaire_type_node.rb, team_node.rb and team_user_node.rb. Most of the methods written in node.rb are implemented by polymorphism in their respective subclass files.

The following changes were made:
Method names were made more informative of the method wherever necessary.
Some common methods in the subclasses were implemented in different ways. So the methods in the subclasses were refactored so that they are uniformly implemented.
Appropriate comments were added to the existing code so that the functionality is easier to understand.
A method was created to return true/false based on courses.private.
Finally, tests were updated according to the changes made in the methods.

== Files Modified ==
=== Changes to <code>app/models/assignment_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why?!! Commit Link
|-
|1
|Redefined <code>self.get</code> method and added two new methods <code>self.get_assignment_query_conditions</code> and <code>self.get_assignments_managed_by_user</code>.
|The <code>self.get</code> method calls these two methods and creates the database query for getting the assignments. Creating two extra methods and calling them from <code>self.get</code> makes the code readable and uniform among all the files.
|[https://github.com/expertiza/expertiza/pull/2551/commits/e53f28ad8143947b181dedce09a947caaefe512b Commit]
|-
|2
|<code>self.get_assignment_query_conditions</code> has all the conditions needed for the database query.
|It makes it easy to list all the query conditions at one place rather than in one method.
|[https://github.com/expertiza/expertiza/pull/2551/commits/e53f28ad8143947b181dedce09a947caaefe512b Commit]
|-
|3
|<code>self.get_assignments_managed_by_user</code> manages all the user permissions with various conditions.
|It is better to maintain all the rights and accesses at one place rather than in the same method as <code>self.get</code>.
|[https://github.com/expertiza/expertiza/pull/2551/commits/e53f28ad8143947b181dedce09a947caaefe512b Commit]
|-
|4
|Renamed the methods <code>get_max_team_size</code>, <code>get_is_intelligent</code>, <code>get_require_quiz</code>, <code>get_allow_suggestions</code> to <code>get_max_assignment_team_size</code>, <code>get_assignment_is_intelligent</code>, <code>get_assignment_require_quiz</code> <code>get_assignment_allow_suggestions</code>.
|Adding the word assignment to the methods name makes the methods more informative and adds meaning.
|[https://github.com/expertiza/expertiza/pull/2551/commits/6559afd1ca3e9cb7be4d04b76afb915bced97d71 Commit]
|-
|5
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-eb868d051fdc1ddba1cd6f85b5f34969ced671a0f2d82ccf26266efa2084f7dc Commit]

|}

=== Changes to <code>app/controllers/tree_display_controller.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Renamed the methods that were renamed in <code>assignment_node.rb</code> above
|The methods tha renamed in <code>assignment_node.rb</code> have to be the same in controller so that when they are called, it does not give an error.
|[https://github.com/expertiza/expertiza/pull/2551/commits/6559afd1ca3e9cb7be4d04b76afb915bced97d71 Commit]

|}

=== Changes to <code>app/models/course_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Renamed the method <code>get_survey_distribution_id</code> to <code>get_course_survey_distribution_id</code>.
|Adding the word course to the method name makes the method more informative and adds meaning to survey distribution id.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-6ca71b9cc09704453515c71a33c834cadc95f764696a4d67f837e105610b1f5a Commit]
|-
|2
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-6ca71b9cc09704453515c71a33c834cadc95f764696a4d67f837e105610b1f5a Commit]
|}

=== Changes to <code>app/models/folder_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Renamed the method <code>get_child_type</code> to <code>get_folder_child_type</code>.
|Adding the word folder to the method name makes the method more informative and adds meaning to the child type of the folder.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-ea42e2052521f09fb3a4d2223fd3201a3970790276de2762b6c90de8809a83b5 Commit]
|-
|2
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-ea42e2052521f09fb3a4d2223fd3201a3970790276de2762b6c90de8809a83b5 Commit]
|}

=== Changes to <code>app/models/node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Changed the method name from <code>get_child_type</code> to <code>get_folder_child_type</code>
|The method name was changed in the <code>folder_node.rb</code>. Since <code>node.rb</code> is its super class, the method name in it also has to be the same
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-d521fcf96c3de2b8c810e0e8da2c12824cd1de1a7999f8b600284e8f358703c1 Commit]
|}

=== Changes to <code>app/models/questionnaire_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Redefined <code>self.get</code> method and added two new methods <code>self.get_questionnaire_query_conditions</code> and <code>self.get_questionnaires_managed_by_user</code>.
|The <code>self.get</code> method calls these two methods and creates the database query for getting the assignments. Creating two extra methods and calling them from <code>self.get</code> makes the code readable and uniform among all the files.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|-
|2
|<code>self.get_questionnaire_query_conditions</code> has all the conditions needed for the database query.
|It makes it easy to list all the query conditions at one place rather than in one method.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|-
|3
|<code>self.get_questionnaires_managed_by_user</code> manages all the user permissions with various conditions.
|It is better to maintain all the rights and accesses at one place rather than in the same method as <code>self.get</code>.
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|-
|4
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-7aaa94971cee91957592cf0d993b9472c574758e4f90c68eda37a9db7021e61d Commit]
|}

=== Changes to <code>app/models/questionnaire_type_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-f62cad1c50ac37ad898275c39ab1891dd5412298546d0722c57483a4c133392f Commit]
|}

=== Changes to <code>app/models/team_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/4f8be8c92a476c81e79c06b228601c9552e9e8b4#diff-db3c2266d0ec594d628c454669f17af4e436b707ee0333659b3500e3bf96035c Commit]
|}

=== Changes to <code>app/models/team_user_node.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Added appropriate comments for all the methods of the file.
|Understanding the need of the method: A well-written comment makes it clear about what that method is supposed to do.
Code readability: Comments help to break up large blocks of code and make it easier to understand what is happening in each section.

Maintenance and updates: When the developer re-visits the code that was written months or years ago, it can be difficult to remember how each method works.

Team Work: While working with a team, comments to methods can help other coders understand your code and can facilitate collaboration.
|[https://github.com/expertiza/expertiza/pull/2551/commits/65bc7bc0f3c4606c1d8fbabe7e1a1daef82de110#diff-3ea55478375d54fdeb8853d9537e53848e5a080a3932b41c730cf8eb44066ccf Commit]
|}

=== Changes to <code>spec/models/course_node_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Why? !! Commit Link
|-
|1
|Changed the method name from <code>get_survey_distribution_id</code> to <code>get_course_survey_distribution_id</code> in the test case where it is used
|Any changes made to the name of methods in the files should also be reflected in the test cases for them to pass successfully. If a method name is changed in a file and the same is not updated in the test case, the test case will fail
|[https://github.com/expertiza/expertiza/pull/2551/commits/708e6d32c563ff6e2afe5604a7659332f60ed8bc#diff-767a05e57089bb29700a6070e67d31f251ee6112293500968d6082412ad57020 Commit]
|}

== Testing ==

'''Everything in the testing segment was beyond the scope of our work. However, we wanted to validate our code through RSpec testing before merging into the <code>main</code> Expertiza branch. In the second submission phase, we plan to further enhance the testing suite of the <code>auth_controller.rb</code> and <code>password_retrieval_controller.rb</code> through factories and fixtures.'''

=== Test Plan - Manual/System Test Cases ===
Along with the unit tests that we have written to test our files, we conducted a few system tests manually to verify the functionality works as expected. The <code>password_retrieval_controller.rb</code> is difficult for us to test because we don't have access to the email used to make the sample account, but the <code>auth_controller.rb</code> is very testable. Below is the tests we completed listed in the order of completion.

==== 1) Test instructor login & redirect to home page ====
When navigating to the expertiza website, our branch correctly displayed the login page as shown below.
[[File:before_login.png|center|border|Form shown to the user before logging in to expertiza]]
After typing in the sample login credentials of "instructor6" and "password," the user is then correctly logged in and redirected to the home page for instructors shown below.
[[File:after_login.png|center|border|1400px|Page shown to the user after logging in to expertiza]]
==== 2) Test instructor logout & redirect to login page ====
Then, when the user clicks the logout button, they are correctly logged out and redirected once again to the login page as shown below.
[[File:after_logout.png|center|border|Form shown to the user after logging out of expertiza]]
==== 3) Test incorrect login ====
When the user attempts to login but enters the incorrect login information of "instructor6" and "incorrect," the user is shown the error message and then correctly redirected to the forgot password page shown below.
[[File:after_incorrect_login.png|center|border|1400px|Form shown to the user after an incorrect login attempt to expertiza]]

=== Automated Testing of <code>auth_controller_.rb</code> ===
Before any refactoring to <code>auth_controller.rb</code> was done, we ran the rspec tests created for the controller with the following command: <code>rspec spec/controllers/auth_controller_spec.rb</code>

[[File:before_refactor_auth_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]

After making all of the above changes to <code>auth_controller.rb</code>, we ran the rspec tests for the controller again with the command: <code>rspec spec/controllers/auth_controller_spec.rb</code>

[[File:after_refactor_auth_controller.png|center|frame|rspec tests continuing to all pass after completing the refactoring]]

We have successfully preserved the passing tests after the improvements we made to the <code>auth_controller.rb</code>. Next we looked at the existing tests to see if they could be improved. As listed in the files changed above, there were a few improvements to be made to <code>auth_controller_spec.rb</code>. We improved a check for redirecting the user after logging in and added two tests to make sure the role cache was being rebuilt after both setting the current role and clearing the user info. We ran the tests again with the command: <code>rspec spec/controllers/auth_controller_spec.rb</code>

[[File:after_improving_auth_controller_spec.png|center|frame|rspec tests continuing to all pass after improving and adding to the auth_controller tests]]

Tests prior to the changes covered 91.94% of <code>auth_controller.rb</code>.
[[File:coverage_before.png|center|frame|rspec test coverage report before the improvements to the auth_controller unit tests]]

This is already a good coverage but after my changes I wanted to ensure my changes were also tested thoroughly. After adding tests, the tests covered 95.24% of <code>auth_controller.rb</code>. It improved slightly to be an even better coverage.
[[File:coverage_after.png|center|frame|rspec test coverage report after the improvements to the auth_controller unit tests]]

=== Automated Testing of <code>password_retrieval_controller.rb</code> ===
Before any refactoring to <code>passsword_retrieval_controller.rb</code> was done, we ran the rspec tests created for the controller with the following command: <code>rspec spec/controllers/password_retrieval_controller_spec.rb</code>

[[File:before_refactor_password_retrieval_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]

Tests prior to the changes covered 63.3% of <code>password_retrieval_controller.rb</code>.
[[File:E2252_password_retrieval_coverage_report_before.png|center|frame|rspec test coverage report before the refactoring was completed]]

After adding tests, the tests covered 91.1% of <code>password_retrieval_controller.rb</code>.
[[File:E2252_password_retrieval_coverage_report_after.png|center|frame|rspec test coverage report after the refactoring was completed]]

We implemented factories in the rspec test file to improve modularity and code readability. Factories provide more flexibility in generating models to meet the requirements of the test, as opposed to fixtures. As you can see from the below images, the code is significantly cleaner as many lines of hardcoded strings have been removed.
[[File:prefactory.png|center|frame|rspec tests before factories were implemented]] 
[[File:postfactory.png|center|frame|rspec tests after factories were implemented]]

The below image shows the output of the following command after all tests were added: <code>rspec spec/controllers/password_retrieval_controller_spec.rb</code>

[[File:After refactor password retrieval controller.png|center|frame|rspec tests all passing after the refactoring was completed]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/palash27/expertiza/
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2551
* '''VCL Server:''' http://152.7.98.115:8080/

== Contributors to this project ==
* Palash Rathod (unityid: prathod, github: palash27)
* Neha Kale (unityid: nkale, github: nkale)
* Vansh Mehta (unityid: vpmehta2, github: vanshmehta-7)

CSC/ECE 517 Spring 2023

2023-03-22T21:40:54Z

Nkale2: /* OSS Projects */

== OSS Projects ==
[[CSC/ECE 517 Spring_2023 -E2306. Refactor user_controller.rb, user.rb and its child classes]]

[[CSC/ECE 517 Spring_2023 - E2320. Reimplement the Question hierarchy]]

[[CSC/ECE 517 Spring_2023 - E2312 + E2313. Reimplement response.rb and responses_controller.rb]]

[[CSC/ECE 517 Spring_2023 - NTNX-1. Support provisioning MongoDb via NDB Kubernetes Operator]]

[[CSC/ECE 517 Spring_2023 - E2316. Reimplement sign_up_sheet_controller.rb]]

[[CSC/ECE 517 Spring_2023 - E2315. Reimplement signed_up_team.rb, sign_up_topic.rb, sign_up_sheet.rb]]

[[CSC/ECE 517 Spring_2023 - E2323. Refactor DueDate functionality from assignment.rb]]

[[CSC/ECE 517 Spring 2023 - E2314. Reimplement the response map hierarchy]]

[[CSC/ECE 517 Spring 2023- NTNX-4. Extend NDB operator provision postregresql aws]]

[[CSC/ECE 517 Spring 2023 - E2321. Reimplement QuestionnairesController and QuestionsController]]

[[CSC/ECE 517 Spring 2023 - E2305. Grading audit trail]]

[[CSC/ECE 517 Spring 2023 - E2309. Refactor Node model and its subclasses]]

CSC/ECE 517 Spring 2023

2023-03-22T21:40:16Z

Nkale2: /* OSS Projects */