https://wiki.expertiza.ncsu.edu/api.php?action=feedcontributions&feedformat=atom&user=Vspande 2026-05-18T01:00:35Z User contributions MediaWiki 1.41.0 https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2332_Reimplement_Courses_(Refactor_course.rb)&diff=149739 2023-04-14T14:35:58Z

<p>Vspande: /* Implementation */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails, which functions as a learning management software system. It has many different functions and abilities, including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and a list of operations that can be performed on the course model. The &lt;code&gt;Course&lt;/code&gt; model and &lt;code&gt;CoursesController&lt;/code&gt;, which are the classes primarily addressed in this project, are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> The &lt;code&gt;Course&lt;/code&gt; model stores information about the instructor and institution it belongs to, and it is associated with other models such as User, Assignment, etc. The course model is responsible for completing a variety of tasks, including returning the submission directory for the course, viewing students enrolled in the course, and adding a student to the course, etc.<br /> <br /> The &lt;code&gt;CoursesController&lt;/code&gt; is responsible for managing courses. It performs CRUD operations on the Course model. It is responsible for creating, editing, deleting courses, and adding/removing teaching assistants to the course. The controller also returns a list of Teaching assistants associated with the course.<br /> <br /> ==Problem Statement==<br /> The problem statement requires us to re-implement the Course model and CoursesController in a Rails application, with the goal of managing courses by allowing admins to create, edit, update, and delete courses, as well as create copies of existing courses. The re-implementation should follow RESTful conventions, including appropriate HTTP response codes and status codes for each endpoint. We are required to write RSpec tests for the Course model and the CoursesController, covering all endpoints and including appropriate HTTP response codes for every method. Tests for the controller will be made compatible with RSwag to generate API documentation and test REST APIs from the Swagger UI.<br /> <br /> ==Previous Work==<br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Index !! Previous !! Proposed changes || Rationale<br /> |-<br /> | 1 || user_on_team method in course.rb model <br /> <br /> '''<br /> def user_on_team?(user)<br /> teams = get_teams<br /> users = []<br /> teams.each do |team|<br /> users &lt;&lt; team.users<br /> end<br /> users.flatten.include? user<br /> end<br /> '''<br /> || user_on_team method in team.rb || The functionality to check whether a user is a member of any team is associated with team model, follows Single Responsibility Principle <br /> |-<br /> | 2 || copy method present in controller <br /> <br /> '''<br /> # Create a copy of a course with a new submission directory<br /> def copy<br /> orig_course = Course.find(params[:id])<br /> new_course = orig_course.dup<br /> new_course.instructor_id = session[:user].id<br /> new_course.name = 'Copy of ' + orig_course.name<br /> new_course.directory_path = new_course.directory_path + '_copy'<br /> begin<br /> new_course.save!<br /> parent_id = CourseNode.get_parent_id<br /> if parent_id<br /> CourseNode.create(node_object_id: new_course.id, parent_id: parent_id)<br /> else<br /> CourseNode.create(node_object_id: new_course.id)<br /> end<br /> undo_link(&quot;The course \&quot;#{orig_course.name}\&quot; has been successfully copied.<br /> Warning: The submission directory path for this copy is the original course's directory path appended with the word \&quot;_copy\&quot;.<br /> If you do not want this to happen, change the submission directory in the new copy of the course.&quot;)<br /> redirect_to controller: 'courses', action: 'edit', id: new_course.id<br /> rescue StandardError<br /> flash[:error] = 'The course was not able to be copied: ' + $ERROR_INFO<br /> redirect_to controller: 'tree_display', action: 'list'<br /> end<br /> end<br /> '''<br /> || copy method should be added in the model as well || The controller should not have the logic of copying the course attributes, instead, the controller should call the copy method defined in the model to create a copy of a course.<br /> |-<br /> | 3 || action_allowed method in controller <br /> <br /> '''<br /> def action_allowed?<br /> current_user_has_instructor_privileges?<br /> end<br /> '''<br /> || action_allowed method should be in a model which deals with authorization || The course model class does not have the responsibility to check whether the user has instructor privileges.<br /> |-<br /> |}<br /> <br /> ==Implementation==<br /> Based on the current functionality of the Course model and controller we have defined the following RESTful endpoints with their Request type which would be implemented in the controller. The Strategy Pattern will be followed in the context of a controller, this pattern can be used to encapsulate the actions that the controller can perform and make them easily extensible and usable.<br /> ====Controller====<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Index !! Method !! Request Type !! Description <br /> |-<br /> | 1 || action_allowed || HELPER FUNCTION || Determines whether the current user has permission to perform certain actions based on their role<br /> |-<br /> | 2 || auto_complete_for_user_name || GET || Provides an autocomplete feature for the form input when adding a TA<br /> |-<br /> | 3 || new || GET || Displays the form for creating a new course<br /> |-<br /> | 4 || edit|| GET || Method to get the course to edit<br /> |-<br /> | 5 || update || PUT || Method to update an existing course based on the form input and save the changes to database<br /> |-<br /> | 6 || copy || GET || Creates a new copy of an existing course with a new submission directory and saves it to the database<br /> |-<br /> | 7 || create || POST || Creates a new course based on the form input and saves it to database<br /> |-<br /> | 8 || delete || DELETE || Method to delete an existing course<br /> |-<br /> | 9 || view_teaching_assistant || GET || Displays all the teaching assistants for a course<br /> |-<br /> | 10 || add_ta || POST || Method to add teaching assistant to a course<br /> |-<br /> | 11 || remove_ta || POST || Method to remove teaching assistant from a course<br /> |-<br /> | 12 || set_course_fields || POST || Called in Update and Create methods to set the fields of course<br /> |-<br /> <br /> |}<br /> <br /> <br /> ====Model====<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Index !! Method !! Description <br /> |-<br /> | 1 || get_teams || Returns any predefined teams associated with a particular course object<br /> |-<br /> | 2 || get_participants || Returns multiple records of course participants from database given parent_id and user_id<br /> |-<br /> | 3 || get_participant || Returns a single record course participant from Course Participant given parent_id<br /> |-<br /> | 4 || add _participant || Add a new Course Participant to the course given user_name<br /> |-<br /> | 5 || copy_participants || Copies all the participants from a given assignment to the current course<br /> |-<br /> | 6 || user_on_team || Checks whether a given user is a member of any team associated with the course<br /> |-<br /> | 7 || path || Returns the course's submission directory<br /> |-<br /> <br /> |}<br /> <br /> ==UML Diagram==<br /> [[Image: UML.png]]<br /> <br /> ==Testing Plan==<br /> The Course model and controller will be tested using Rspec. FactoryBot will be utilized to create test fixtures and to build the required models. As the methods in the controller are defined as RESTful endpoints. The test take into consideration that the methods return the correct status codes for the output. Based on the current functionality of Course model and controller we have defined the following test which would implemented to test the reimplemented code of course model and controller. <br /> <br /> ====Tests====<br /> '''Course Controller'''<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Test No. !! Description <br /> |-<br /> | 1 || Tests if the action_allowed disallows all actions when current user is student.<br /> |-<br /> | 2 || Tests if the action_allowed allows all course actions when current user is instructor.<br /> |-<br /> | 3 || Tests if create method returns a 201 Created status code if the resource is successfully created.<br /> |-<br /> | 4 || Tests if create method returns a 422 Unprocessable Entity status code if the resource cannot be created due to validation errors.<br /> |-<br /> | 5 || Tests if the delete method returns a 204 No Content status code if the resource is successfully deleted.<br /> |-<br /> | 6 || Tests if the delete method returns a 404 Not Found status code if the resource cannot be found.<br /> |-<br /> | 7 || Tests if the new method sets the private instance variable.<br /> |-<br /> | 8 || Tests if the update method returns a 200 OK status code if the resource is successfully updated.<br /> |-<br /> | 9 || Tests if the update method returns a 422 Unprocessable Entity status code if the resource cannot be updated due to validation errors.<br /> |-<br /> | 10 || Tests if the topic_name method returns the participant topic name when not nil.<br /> |-<br /> | 11 || Tests if the auto_complete_for_user_name method returns a list of users.<br /> |-<br /> | 12 || Tests if the copy method redirects to new course when new course id fetched successfully.<br /> |-<br /> | 13 || Tests if the view_teaching_assistants method returns list of TAs for the course.<br /> |-<br /> | 14 || Tests if the add_ta method returns a 200 OK status code if a TA added successfully to the course.<br /> |-<br /> | 13 || Tests if the add_ta method returns a 422 Unprocessable Entity status code if a TA cannot be added to the course.<br /> |-<br /> | 14 || Tests if the remove_ta method returns a 204 No Content status code if the ta is successfully removed from the course.<br /> |-<br /> | 15 || Tests if the remove_ta method returns a 404 Not Found status code if the ta cannot be found.<br /> |-<br /> | 16 || Tests if the set_course_fields method sets the course fields.<br /> |}<br /> <br /> '''Course Model'''<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Test No. !! Description <br /> |-<br /> | 1 || Tests if the model validates presence of name<br /> |-<br /> | 2 || Tests if the model validates presence of directory_path<br /> |-<br /> | 3 || Tests if path method raises an error when there is no associated instructor.<br /> |-<br /> | 4 || Tests if path method returns a directory when there is an associated instructor.<br /> <br /> |}<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/ameyagv/reimplementation-back-end<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2332_Reimplement_Courses_(Refactor_course.rb)&diff=149705 2023-04-13T02:28:27Z

<p>Vspande: </p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails, which functions as a learning management software system. It has many different functions and abilities, including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and a list of operations that can be performed on the course model. The &lt;code&gt;Course&lt;/code&gt; model and &lt;code&gt;CoursesController&lt;/code&gt;, which are the classes primarily addressed in this project, are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> The &lt;code&gt;Course&lt;/code&gt; model stores information about the instructor and institution it belongs to, and it is associated with other models such as User, Assignment, etc. The course model is responsible for completing a variety of tasks, including returning the submission directory for the course, viewing students enrolled in the course, and adding a student to the course, etc.<br /> <br /> The &lt;code&gt;CoursesController&lt;/code&gt; is responsible for managing courses. It performs CRUD operations on the Course model. It is responsible for creating, editing, deleting courses, and adding/removing teaching assistants to the course. The controller also returns a list of Teaching assistants associated with the course.<br /> <br /> ==Problem Statement==<br /> The problem statement requires us to re-implement the Course model and CoursesController in a Rails application, with the goal of managing courses by allowing admins to create, edit, update, and delete courses, as well as create copies of existing courses. The re-implementation should follow RESTful conventions, including appropriate HTTP response codes and status codes for each endpoint. We are required to write RSpec tests for the Course model and the CoursesController, covering all endpoints and including appropriate HTTP response codes for every method. Tests for the controller will be made compatible with RSwag to generate API documentation and test REST APIs from the Swagger UI.<br /> <br /> ==Previous Work==<br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Index !! Previous !! Proposed || Rationale<br /> |-<br /> | 1 || user_on_team method in course.rb model || user_on_team method in team.rb || The functionality to check whether a user is a member of any team is associated with team model, follows Single Responsibility Principle <br /> |-<br /> | 2 || copy method present in controller || copy method should be added in model as well || <br /> |-<br /> | 3 || action_allowed method in controller || action_allowed method should be in user.rb || It should belong to Authorization part.<br /> |-<br /> |} <br /> <br /> ==Implementation==<br /> Based on the current functionality of Course model and controller we have defined the following RESTful endpoints with their Request type which would be implemented in the controller.<br /> ====Controller====<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Index !! Method !! Request Type !! Description <br /> |-<br /> | 1 || action_allowed || HELPER FUNCTION || Determines whether the current user has permission to perform certain actions based on their role<br /> |-<br /> | 2 || auto_complete_for_user_name || GET || Provides an autocomplete feature for the form input when adding a TA<br /> |-<br /> | 3 || new || GET || Displays the form for creating a new course<br /> |-<br /> | 4 || edit|| GET || Method to get the course to edit<br /> |-<br /> | 5 || update || PUT || Method to update an existing course based on the form input and save the changes to database<br /> |-<br /> | 6 || copy || GET || Creates a new copy of an existing course with a new submission directory and saves it to the database<br /> |-<br /> | 7 || create || POST || Creates a new course based on the form input and saves it to database<br /> |-<br /> | 8 || delete || DELETE || Method to delete an existing course<br /> |-<br /> | 9 || view_teaching_assistant || GET || Displays all the teaching assistants for a course<br /> |-<br /> | 10 || add_ta || POST || Method to add teaching assistant to a course<br /> |-<br /> | 11 || remove_ta || POST || Method to remove teaching assistant from a course<br /> |-<br /> | 12 || set_course_fields || POST || Called in Update and Create methods to set the fields of course<br /> |-<br /> <br /> |}<br /> <br /> <br /> ====Model====<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Index !! Method !! Description <br /> |-<br /> | 1 || get_teams || Returns any predefined teams associated with a particular course object<br /> |-<br /> | 2 || get_participants || Returns multiple records of course participants from database given parent_id and user_id<br /> |-<br /> | 3 || get_participant || Returns a single record course participant from Course Participant given parent_id<br /> |-<br /> | 4 || add _participant || Add a new Course Participant to the course given user_name<br /> |-<br /> | 5 || copy_participants || Copies all the participants from a given assignment to the current course<br /> |-<br /> | 6 || user_on_team || Checks whether a given user is a member of any team associated with the course<br /> |-<br /> | 7 || path || Returns the course's submission directory<br /> |-<br /> <br /> |}<br /> <br /> <br /> ==UML Diagram==<br /> [[Image: UML.png]]<br /> <br /> ==Testing Plan==<br /> The Course model and controller will be tested using Rspec. FactoryBot will be utilized to create test fixtures and to build the required models. As the methods in the controller are defined as RESTful endpoints. The test take into consideration that the methods return the correct status codes for the output. Based on the current functionality of Course model and controller we have defined the following test which would implemented to test the reimplemented code of course model and controller. <br /> <br /> ====Tests====<br /> '''Course Controller'''<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Test No. !! Description <br /> |-<br /> | 1 || Tests if the action_allowed disallows all actions when current user is student.<br /> |-<br /> | 2 || Tests if the action_allowed allows all course actions when current user is instructor.<br /> |-<br /> | 3 || Tests if create method returns a 201 Created status code if the resource is successfully created.<br /> |-<br /> | 4 || Tests if create method returns a 422 Unprocessable Entity status code if the resource cannot be created due to validation errors.<br /> |-<br /> | 5 || Tests if the delete method returns a 204 No Content status code if the resource is successfully deleted.<br /> |-<br /> | 6 || Tests if the delete method returns a 404 Not Found status code if the resource cannot be found.<br /> |-<br /> | 7 || Tests if the new method sets the private instance variable.<br /> |-<br /> | 8 || Tests if the update method returns a 200 OK status code if the resource is successfully updated.<br /> |-<br /> | 9 || Tests if the update method returns a 422 Unprocessable Entity status code if the resource cannot be updated due to validation errors.<br /> |-<br /> | 10 || Tests if the topic_name method returns the participant topic name when not nil.<br /> |-<br /> | 11 || Tests if the auto_complete_for_user_name method returns a list of users.<br /> |-<br /> | 12 || Tests if the copy method redirects to new course when new course id fetched successfully.<br /> |-<br /> | 13 || Tests if the view_teaching_assistants method returns list of TAs for the course.<br /> |-<br /> | 14 || Tests if the add_ta method returns a 200 OK status code if a TA added successfully to the course.<br /> |-<br /> | 13 || Tests if the add_ta method returns a 422 Unprocessable Entity status code if a TA cannot be added to the course.<br /> |-<br /> | 14 || Tests if the remove_ta method returns a 204 No Content status code if the ta is successfully removed from the course.<br /> |-<br /> | 15 || Tests if the remove_ta method returns a 404 Not Found status code if the ta cannot be found.<br /> |-<br /> | 16 || Tests if the set_course_fields method sets the course fields.<br /> |}<br /> <br /> '''Course Model'''<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Test No. !! Description <br /> |-<br /> | 1 || Tests if the model validates presence of name<br /> |-<br /> | 2 || Tests if the model validates presence of directory_path<br /> |-<br /> | 3 || Tests if path method raises an error when there is no associated instructor.<br /> |-<br /> | 4 || Tests if path method returns a directory when there is an associated instructor.<br /> <br /> |}<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/ameyagv/reimplementation-back-end<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2332_Reimplement_Courses_(Refactor_course.rb)&diff=149503 2023-04-12T21:28:03Z

<p>Vspande: </p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails, which functions as a learning management software system. It has many different functions and abilities, including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and a list of operations that can be performed on the course model. The &lt;code&gt;Course&lt;/code&gt; model and &lt;code&gt;CoursesController&lt;/code&gt;, which are the classes primarily addressed in this project, are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> The &lt;code&gt;Course&lt;/code&gt; model stores information about the instructor and institution it belongs to, and it is associated with other models such as User, Assignment, etc. The course model is responsible for completing a variety of tasks, including returning the submission directory for the course, viewing students enrolled in the course, and adding a student to the course, etc.<br /> <br /> The &lt;code&gt;CoursesController&lt;/code&gt; is responsible for managing courses. It performs CRUD operations on the Course model. It is responsible for creating, editing, deleting courses, and adding/removing teaching assistants to the course. The controller also returns a list of Teaching assistants associated with the course.<br /> <br /> ==Problem Statement==<br /> The problem statement requires us to re-implement the Course model and CoursesController in a Rails application, with the goal of managing courses by allowing admins to create, edit, update, and delete courses, as well as create copies of existing courses. The re-implementation should follow RESTful conventions, including appropriate HTTP response codes and status codes for each endpoint. We are required to write RSpec tests for the Course model and the CoursesController, covering all endpoints and including appropriate HTTP response codes for every method. Tests for the controller will be made compatible with RSwag to generate API documentation and test REST APIs from the Swagger UI.<br /> <br /> ==Previous Work==<br /> <br /> ==Implementation==<br /> Based on the current functionality of Course model and controller we have defined the following RESTful endpoints with their Request type which would be implemented in the controller.<br /> ====Controller====<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Index !! Method !! Request Type !! Description <br /> |-<br /> | 1 || action_allowed || HELPER FUNCTION || Determines whether the current user has permission to perform certain actions based on their role<br /> |-<br /> | 2 || auto_complete_for_user_name || GET || Provides an autocomplete feature for the form input when adding a TA<br /> |-<br /> | 3 || new || GET || Displays the form for creating a new course<br /> |-<br /> | 4 || edit|| GET || Method to get the course to edit<br /> |-<br /> | 5 || update || PUT || Method to update an existing course based on the form input and save the changes to database<br /> |-<br /> | 6 || copy || GET || Creates a new copy of an existing course with a new submission directory and saves it to the database<br /> |-<br /> | 7 || create || POST || Creates a new course based on the form input and saves it to database<br /> |-<br /> | 8 || delete || DELETE || Method to delete an existing course<br /> |-<br /> | 9 || view_teaching_assistant || GET || Displays all the teaching assistants for a course<br /> |-<br /> | 10 || add_ta || POST || Method to add teaching assistant to a course<br /> |-<br /> | 11 || remove_ta || POST || Method to remove teaching assistant from a course<br /> |-<br /> | 12 || set_course_fields || POST || Called in Update and Create methods to set the fields of course<br /> |-<br /> <br /> |}<br /> <br /> <br /> ====Model====<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Index !! Method !! Description <br /> |-<br /> | 1 || get_teams || Returns any predefined teams associated with a particular course object<br /> |-<br /> | 2 || get_participants || Returns multiple records of course participants from database given parent_id and user_id<br /> |-<br /> | 3 || get_participant || Returns a single record course participant from Course Participant given parent_id<br /> |-<br /> | 4 || add _participant || Add a new Course Participant to the course given user_name<br /> |-<br /> | 5 || copy_participants || Copies all the participants from a given assignment to the current course<br /> |-<br /> | 6 || user_on_team || Checks whether a given user is a member of any team associated with the course<br /> |-<br /> | 7 || path || Returns the course's submission directory<br /> |-<br /> <br /> |}<br /> <br /> <br /> ==UML Diagram==<br /> [[Image: UML.png]]<br /> <br /> ==Testing Plan==<br /> The Course model and controller will be tested using Rspec. FactoryBot will be utilized to create test fixtures and to build the required models. As the methods in the controller are defined as RESTful endpoints. The test take into consideration that the methods return the correct status codes for the output. Based on the current functionality of Course model and controller we have defined the following test which would implemented to test the reimplemented code of course model and controller. <br /> <br /> ====Tests====<br /> '''Course Controller'''<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Test No. !! Description <br /> |-<br /> | 1 || Tests if the action_allowed disallows all actions when current user is student.<br /> |-<br /> | 2 || Tests if the action_allowed allows all course actions when current user is instructor.<br /> |-<br /> | 3 || Tests if create method returns a 201 Created status code if the resource is successfully created.<br /> |-<br /> | 4 || Tests if create method returns a 422 Unprocessable Entity status code if the resource cannot be created due to validation errors.<br /> |-<br /> | 5 || Tests if the delete method returns a 204 No Content status code if the resource is successfully deleted.<br /> |-<br /> | 6 || Tests if the delete method returns a 404 Not Found status code if the resource cannot be found.<br /> |-<br /> | 7 || Tests if the new method sets the private instance variable.<br /> |-<br /> | 8 || Tests if the update method returns a 200 OK status code if the resource is successfully updated.<br /> |-<br /> | 9 || Tests if the update method returns a 422 Unprocessable Entity status code if the resource cannot be updated due to validation errors.<br /> |-<br /> | 10 || Tests if the topic_name method returns the participant topic name when not nil.<br /> |-<br /> | 11 || Tests if the auto_complete_for_user_name method returns a list of users.<br /> |-<br /> | 12 || Tests if the copy method redirects to new course when new course id fetched successfully.<br /> |-<br /> | 13 || Tests if the view_teaching_assistants method returns list of TAs for the course.<br /> |-<br /> | 14 || Tests if the add_ta method returns a 200 OK status code if a TA added successfully to the course.<br /> |-<br /> | 13 || Tests if the add_ta method returns a 422 Unprocessable Entity status code if a TA cannot be added to the course.<br /> |-<br /> | 14 || Tests if the remove_ta method returns a 204 No Content status code if the ta is successfully removed from the course.<br /> |-<br /> | 15 || Tests if the remove_ta method returns a 404 Not Found status code if the ta cannot be found.<br /> |-<br /> | 16 || Tests if the set_course_fields method sets the course fields.<br /> |}<br /> <br /> '''Course Model'''<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Test No. !! Description <br /> |-<br /> | 1 || Tests if the model validates presence of name<br /> |-<br /> | 2 || Tests if the model validates presence of directory_path<br /> |-<br /> | 3 || Tests if path method raises an error when there is no associated instructor.<br /> |-<br /> | 4 || Tests if path method returns a directory when there is an associated instructor.<br /> <br /> |}<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/ameyagv/reimplementation-back-end<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2332_Reimplement_Courses_(Refactor_course.rb)&diff=149372 2023-04-10T03:49:30Z

<p>Vspande: </p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails, which functions as a learning management software system. It has many different functions and abilities, including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and a list of operations that can be performed on the course model. The &lt;code&gt;Course&lt;/code&gt; model and &lt;code&gt;CoursesController&lt;/code&gt;, which are the classes primarily addressed in this project, are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> The &lt;code&gt;Course&lt;/code&gt; model stores information about the instructor and institution it belongs to, and it is associated with other models such as User, Assignment, etc. The course model is responsible for completing a variety of tasks, including returning the submission directory for the course, viewing students enrolled in the course, and adding a student to the course, etc.<br /> <br /> The &lt;code&gt;CoursesController&lt;/code&gt; is responsible for managing courses. It performs CRUD operations on the Course model. It is responsible for creating, editing, deleting courses, and adding/removing teaching assistants to the course. The controller also returns a list of Teaching assistants associated with the course.<br /> <br /> ==Problem Statement==<br /> The problem statement requires us to re-implement the Course model and CoursesController in a Rails application, with the goal of managing courses by allowing admins to create, edit, update, and delete courses, as well as create copies of existing courses. The re-implementation should follow RESTful conventions, including appropriate HTTP response codes and status codes for each endpoint. We are required to write RSpec tests for the Course model and the CoursesController, covering all endpoints and including appropriate HTTP response codes for every method. Tests for the controller will be made compatible with RSwag to generate API documentation and test REST APIs from the Swagger UI.<br /> <br /> ==Implementation==<br /> Based on the current functionality of Course model and controller we have defined the following RESTful endpoints with their Request type which would be implemented in the controller.<br /> ====Controller====<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Index !! Method !! Request Type !! Description <br /> |-<br /> | 1 || action_allowed || HELPER FUNCTION || Determines whether the current user has permission to perform certain actions based on their role<br /> |-<br /> | 2 || auto_complete_for_user_name || GET || Provides an autocomplete feature for the form input when adding a TA<br /> |-<br /> | 3 || new || GET || Displays the form for creating a new course<br /> |-<br /> | 4 || edit|| GET || Method to get the course to edit<br /> |-<br /> | 5 || update || PUT || Method to update an existing course based on the form input and save the changes to database<br /> |-<br /> | 6 || copy || GET || Creates a new copy of an existing course with a new submission directory and saves it to the database<br /> |-<br /> | 7 || create || POST || Creates a new course based on the form input and saves it to database<br /> |-<br /> | 8 || delete || DELETE || Method to delete an existing course<br /> |-<br /> | 9 || view_teaching_assistant || GET || Displays all the teaching assistants for a course<br /> |-<br /> | 10 || add_ta || POST || Method to add teaching assistant to a course<br /> |-<br /> | 11 || remove_ta || POST || Method to remove teaching assistant from a course<br /> |-<br /> | 12 || set_course_fields || POST || Called in Update and Create methods to set the fields of course<br /> |-<br /> <br /> |}<br /> <br /> <br /> ====Model====<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Index !! Method !! Description <br /> |-<br /> | 1 || get_teams || Returns any predefined teams associated with a particular course object<br /> |-<br /> | 2 || get_participants || Returns multiple records of course participants from database given parent_id and user_id<br /> |-<br /> | 3 || get_participant || Returns a single record course participant from Course Participant given parent_id<br /> |-<br /> | 4 || add _participant || Add a new Course Participant to the course given user_name<br /> |-<br /> | 5 || copy_participants || Copies all the participants from a given assignment to the current course<br /> |-<br /> | 6 || user_on_team || Checks whether a given user is a member of any team associated with the course<br /> |-<br /> | 7 || path || Returns the course's submission directory<br /> |-<br /> <br /> |}<br /> <br /> <br /> ==UML Diagram==<br /> [[Image: UML.png]]<br /> <br /> ==Testing Plan==<br /> The Course model and controller will be tested using Rspec. FactoryBot will be utilized to create test fixtures and to build the required models. As the methods in the controller are defined as RESTful endpoints. The test take into consideration that the methods return the correct status codes for the output. Based on the current functionality of Course model and controller we have defined the following test which would implemented to test the reimplemented code of course model and controller. <br /> <br /> ====Tests====<br /> '''Course Controller'''<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Test No. !! Description <br /> |-<br /> | 1 || Tests if the action_allowed disallows all actions when current user is student.<br /> |-<br /> | 2 || Tests if the action_allowed allows all course actions when current user is instructor.<br /> |-<br /> | 3 || Tests if create method returns a 201 Created status code if the resource is successfully created.<br /> |-<br /> | 4 || Tests if create method returns a 422 Unprocessable Entity status code if the resource cannot be created due to validation errors.<br /> |-<br /> | 5 || Tests if the delete method returns a 204 No Content status code if the resource is successfully deleted.<br /> |-<br /> | 6 || Tests if the delete method returns a 404 Not Found status code if the resource cannot be found.<br /> |-<br /> | 7 || Tests if the new method sets the private instance variable.<br /> |-<br /> | 8 || Tests if the update method returns a 200 OK status code if the resource is successfully updated.<br /> |-<br /> | 9 || Tests if the update method returns a 422 Unprocessable Entity status code if the resource cannot be updated due to validation errors.<br /> |-<br /> | 10 || Tests if the topic_name method returns the participant topic name when not nil.<br /> |-<br /> | 11 || Tests if the auto_complete_for_user_name method returns a list of users.<br /> |-<br /> | 12 || Tests if the copy method redirects to new course when new course id fetched successfully.<br /> |-<br /> | 13 || Tests if the view_teaching_assistants method returns list of TAs for the course.<br /> |-<br /> | 14 || Tests if the add_ta method returns a 200 OK status code if a TA added successfully to the course.<br /> |-<br /> | 13 || Tests if the add_ta method returns a 422 Unprocessable Entity status code if a TA cannot be added to the course.<br /> |-<br /> | 14 || Tests if the remove_ta method returns a 204 No Content status code if the ta is successfully removed from the course.<br /> |-<br /> | 15 || Tests if the remove_ta method returns a 404 Not Found status code if the ta cannot be found.<br /> |-<br /> | 16 || Tests if the set_course_fields method sets the course fields.<br /> |}<br /> <br /> '''Course Model'''<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Test No. !! Description <br /> |-<br /> | 1 || Tests if the model validates presence of name<br /> |-<br /> | 2 || Tests if the model validates presence of directory_path<br /> |-<br /> | 3 || Tests if path method raises an error when there is no associated instructor.<br /> |-<br /> | 4 || Tests if path method returns a directory when there is an associated instructor.<br /> <br /> |}<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/ameyagv/reimplementation-back-end<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=File:UML.png&diff=149371 2023-04-10T03:48:22Z

<p>Vspande: Vspande uploaded a new version of File:UML.png</p> <hr /> <div></div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2332_Reimplement_Courses_(Refactor_course.rb)&diff=149370 2023-04-10T03:47:47Z

<p>Vspande: </p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails, which functions as a learning management software system. It has many different functions and abilities, including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and a list of operations that can be performed on the course model. The &lt;code&gt;Course&lt;/code&gt; model and &lt;code&gt;CoursesController&lt;/code&gt;, which are the classes primarily addressed in this project, are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> The &lt;code&gt;Course&lt;/code&gt; model stores information about the instructor and institution it belongs to, and it is associated with other models such as User, Assignment, etc. The course model is responsible for completing a variety of tasks, including returning the submission directory for the course, viewing students enrolled in the course, and adding a student to the course, etc.<br /> <br /> The &lt;code&gt;CoursesController&lt;/code&gt; is responsible for managing courses. It performs CRUD operations on the Course model. It is responsible for creating, editing, deleting courses, and adding/removing teaching assistants to the course. The controller also returns a list of Teaching assistants associated with the course.<br /> <br /> ==Problem Statement==<br /> The problem statement requires us to re-implement the Course model and CoursesController in a Rails application, with the goal of managing courses by allowing admins to create, edit, update, and delete courses, as well as create copies of existing courses. The re-implementation should follow RESTful conventions, including appropriate HTTP response codes and status codes for each endpoint. We are required to write RSpec tests for the Course model and the CoursesController, covering all endpoints and including appropriate HTTP response codes for every method. Tests for the controller will be made compatible with RSwag to generate API documentation and test REST APIs from the Swagger UI.<br /> <br /> ==Implementation==<br /> Based on the current functionality of Course model and controller we have defined the following RESTful endpoints with their Request type which would be implemented in the controller.<br /> ====Controller====<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Index !! Method !! Request Type !! Description <br /> |-<br /> | 1 || action_allowed || HELPER FUNCTION || Determines whether the current user has permission to perform certain actions based on their role<br /> |-<br /> | 2 || auto_complete_for_user_name || GET || Provides an autocomplete feature for the form input when adding a TA<br /> |-<br /> | 3 || new || GET || Displays the form for creating a new course<br /> |-<br /> | 4 || edit|| GET || Method to get the course to edit<br /> |-<br /> | 5 || update || PUT || Method to update an existing course based on the form input and save the changes to database<br /> |-<br /> | 6 || copy || GET || Creates a new copy of an existing course with a new submission directory and saves it to the database<br /> |-<br /> | 7 || create || POST || Creates a new course based on the form input and saves it to database<br /> |-<br /> | 8 || delete || DELETE || Method to delete an existing course<br /> |-<br /> | 9 || view_teaching_assistant || GET || Displays all the teaching assistants for a course<br /> |-<br /> | 10 || add_ta || POST || Method to add teaching assistant to a course<br /> |-<br /> | 11 || remove_ta || POST || Method to remove teaching assistant from a course<br /> |-<br /> | 12 || set_course_fields || POST || Called in Update and Create methods to set the fields of course<br /> |-<br /> <br /> |}<br /> <br /> <br /> ====Model====<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Index !! Method !! Description <br /> |-<br /> | 1 || get_teams || Returns any predefined teams associated with a particular course object<br /> |-<br /> | 2 || get_participants || Returns multiple records of course participants from database given parent_id and user_id<br /> |-<br /> | 3 || get_participant || Returns a single record course participant from Course Participant given parent_id<br /> |-<br /> | 4 || add _participant || Add a new Course Participant to the course given user_name<br /> |-<br /> | 5 || copy_participants || Copies all the participants from a given assignment to the current course<br /> |-<br /> | 6 || user_on_team || Checks whether a given user is a member of any team associated with the course<br /> |-<br /> | 7 || path || Returns the course's submission directory<br /> |-<br /> <br /> |}<br /> <br /> <br /> ==UML Diagram==<br /> <br /> <br /> ==Testing Plan==<br /> The Course model and controller will be tested using Rspec. FactoryBot will be utilized to create test fixtures and to build the required models. As the methods in the controller are defined as RESTful endpoints. The test take into consideration that the methods return the correct status codes for the output. Based on the current functionality of Course model and controller we have defined the following test which would implemented to test the reimplemented code of course model and controller. <br /> <br /> ====Tests====<br /> '''Course Controller'''<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Test No. !! Description <br /> |-<br /> | 1 || Tests if the action_allowed disallows all actions when current user is student.<br /> |-<br /> | 2 || Tests if the action_allowed allows all course actions when current user is instructor.<br /> |-<br /> | 3 || Tests if create method returns a 201 Created status code if the resource is successfully created.<br /> |-<br /> | 4 || Tests if create method returns a 422 Unprocessable Entity status code if the resource cannot be created due to validation errors.<br /> |-<br /> | 5 || Tests if the delete method returns a 204 No Content status code if the resource is successfully deleted.<br /> |-<br /> | 6 || Tests if the delete method returns a 404 Not Found status code if the resource cannot be found.<br /> |-<br /> | 7 || Tests if the new method sets the private instance variable.<br /> |-<br /> | 8 || Tests if the update method returns a 200 OK status code if the resource is successfully updated.<br /> |-<br /> | 9 || Tests if the update method returns a 422 Unprocessable Entity status code if the resource cannot be updated due to validation errors.<br /> |-<br /> | 10 || Tests if the topic_name method returns the participant topic name when not nil.<br /> |-<br /> | 11 || Tests if the auto_complete_for_user_name method returns a list of users.<br /> |-<br /> | 12 || Tests if the copy method redirects to new course when new course id fetched successfully.<br /> |-<br /> | 13 || Tests if the view_teaching_assistants method returns list of TAs for the course.<br /> |-<br /> | 14 || Tests if the add_ta method returns a 200 OK status code if a TA added successfully to the course.<br /> |-<br /> | 13 || Tests if the add_ta method returns a 422 Unprocessable Entity status code if a TA cannot be added to the course.<br /> |-<br /> | 14 || Tests if the remove_ta method returns a 204 No Content status code if the ta is successfully removed from the course.<br /> |-<br /> | 15 || Tests if the remove_ta method returns a 404 Not Found status code if the ta cannot be found.<br /> |-<br /> | 16 || Tests if the set_course_fields method sets the course fields.<br /> |}<br /> <br /> '''Course Model'''<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Test No. !! Description <br /> |-<br /> | 1 || Tests if the model validates presence of name<br /> |-<br /> | 2 || Tests if the model validates presence of directory_path<br /> |-<br /> | 3 || Tests if path method raises an error when there is no associated instructor.<br /> |-<br /> | 4 || Tests if path method returns a directory when there is an associated instructor.<br /> <br /> |}<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/ameyagv/reimplementation-back-end<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2332_Reimplement_Courses_(Refactor_course.rb)&diff=149099 2023-04-07T20:32:03Z

<p>Vspande: /* Implementation */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails, which functions as a learning management software system. It has many different functions and abilities, including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and a list of operations that can be performed on the course model. The &lt;code&gt;Course&lt;/code&gt; model and &lt;code&gt;CoursesController&lt;/code&gt;, which are the classes primarily addressed in this project, are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;course&lt;/code&gt; model stores information about the instructor and institution and is associated with other models such as User, CourseParticipant, CourseTeam, Assignment, AssignmentParticipant, and Notification. The course model is responsible for completing a variety of tasks, including returning course teams, returning the submission directory for the course, viewing participants enrolled in the course, adding a participant to the course, copying the Assignment Participants to Course Participants, and checking whether a user is part of any CourseTeam. The problem description lists code smells that need to be fixed. We fixed some issues, such as deleting the unused methods and renaming methods to indicate their action. The renaming problem required us to change a few methods calls where the function to be renamed was used. Also, to reduce the cognitive complexity of the copy_assignment_participants method, we created a method to separate the raising error functionality. Comments were added to indicate the action of the methods.<br /> <br /> The &lt;code&gt;course_team&lt;/code&gt; is a subclass of the team class. CourseTeams are a type of team that an instructor can use throughout an entire semester, providing consistency in team membership over time. The course_team model is responsible for completing various tasks, including returning the course of the team, adding a participant to the CourseTeam, and copying the CourseTeam Participants to AssignmentTeam Participants. There are methods for importing and exporting data to/from CSV files for CourseTeam objects. The problem description lists code smells/issues that need to be fixed. The issues that we fixed were deleting unused methods, renaming methods, and changing method calls, changing rspec expectations, adding meaningful comments. To refactor methods, DRY principles were used. In addition, analogous changes were made in the assignment_team model.<br /> <br /> ==Problem Statement==<br /> <br /> ==Design Decisions==<br /> <br /> ==Implementation==<br /> ====Controller====<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Index !! Method !! Request Type !! Description <br /> |-<br /> | 1 || action_allowed || HELPER FUNCTION || Determines whether the current user has permission to perform certain actions based on their role<br /> |-<br /> | 2 || auto_complete_for_user_name || GET || Provides an autocomplete feature for the form input when adding a TA<br /> |-<br /> | 3 || new || GET || Displays the form for creating a new course<br /> |-<br /> | 4 || edit|| GET || Method to get the course to edit<br /> |-<br /> | 5 || update || PUT || Method to update an existing course based on the form input and save the changes to database<br /> |-<br /> | 6 || copy || GET || Creates a new copy of an existing course with a new submission directory and saves it to the database<br /> |-<br /> | 7 || create || POST || Creates a new course based on the form input and saves it to database<br /> |-<br /> | 8 || delete || DELETE || Method to delete an existing course<br /> |-<br /> | 9 || view_teaching_assistant || GET || Displays all the teaching assistants for a course<br /> |-<br /> | 10 || add_ta || POST || Method to add teaching assistant to a course<br /> |-<br /> | 11 || remove_ta || POST || Method to remove teaching assistant from a course<br /> |-<br /> | 12 || set_course_fields || POST || Called in Update and Create methods to set the fields of course<br /> |-<br /> <br /> |}<br /> <br /> <br /> ====Model====<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Index !! Method !! Description <br /> |-<br /> | 1 || get_teams || Returns any predefined teams associated with a particular course object<br /> |-<br /> | 2 || get_participants || Returns multiple records of course participants from database given parent_id and user_id<br /> |-<br /> | 3 || get_participant || Returns a single record course participant from Course Participant given parent_id<br /> |-<br /> | 4 || add _participant || Add a new Course Participant to the course given user_name<br /> |-<br /> | 5 || copy_participants || Copies all the participants from a given assignment to the current course<br /> |-<br /> | 6 || user_on_team || Checks whether a given user is a member of any team associated with the course<br /> |-<br /> |}<br /> <br /> ==Testing Plan==<br /> ====Tests====<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Test No. !! Description <br /> |-<br /> | 1 || Tests if the team method returns the team of the participant<br /> |-<br /> | 2 || Tests if the leave_team method deletes a participant if no associations exist and force is nil<br /> |-<br /> | 3 || Tests if the leave_team method deletes a participant if no associations exist and force is true<br /> |-<br /> | 4 || Tests if the leave_team method deletes a participant with associations and force is true and there are multiple team users<br /> |-<br /> | 5 || Tests if the name method returns the name of the participant<br /> |-<br /> | 6 || Tests if the fullname method returns the full name of the participant<br /> |-<br /> | 7 || Tests if the handle method returns the handle of the participant<br /> |-<br /> | 8 || Tests if the sort_by_name method returns a sorted list of participants in alphabetical order<br /> |-<br /> | 9 || Tests if the topic_name method returns the participant topic name when nil<br /> |-<br /> | 10 || Tests if the topic_name method returns the participant topic name when not nil.<br /> |-<br /> | 11 || Tests if the authorization method returns participant when no arguments are passed.<br /> |-<br /> | 12 || Tests if the authorization method returns reader when no arguments are passed.<br /> |-<br /> | 13 || Tests if the authorization method returns submitter when no arguments are passed.<br /> |-<br /> | 14 || Tests if the authorization method returns reviewer when no arguments are passed.<br /> |-<br /> | 13 || Tests if the authorization method returns submitter when no arguments are passed.<br /> |-<br /> | 14 || Tests if the authorization method returns reviewer when no arguments are passed.<br /> |-<br /> | 15 || Tests if it returns participant data in the correct format.<br /> |-<br /> | 16 || Test if it exports the details of the participant correctly.<br /> <br /> |}<br /> <br /> ==Description==<br /> <br /> What it does: The Course model and CoursesController is responsible for managing the courses. This system allows admin to create a new course, edit the course and update the existing course. It also allows you to create a copy of an existing course, etc.<br /> <br /> What needs to be done:<br /> You have to exactly follow the reimplementation guidelines as stated on top and make sure that you have covered all the functionality that is required for the Courses. You will be responsible for the entire functionality of the Courses, the model and controller, and the detailed rspec test, testing all the pass and fail scenarios, for the rest endpoints are compulsory. <br /> As mentioned in the guideline, take reference from the User (model &amp; controller) implementation and look at roles_rspec.rb for the test, roles_rspec is not complete and there is potential for better testing but you can use that as a starting point.<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/ameyagv/reimplementation-back-end<br /> * '''Pull Request:''' <br /> * '''VCL Server:'''<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2332_Reimplement_Courses_(Refactor_course.rb)&diff=149096 2023-04-07T20:16:49Z

<p>Vspande: /* Controller */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails, which functions as a learning management software system. It has many different functions and abilities, including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and a list of operations that can be performed on the course model. The &lt;code&gt;Course&lt;/code&gt; model and &lt;code&gt;CoursesController&lt;/code&gt;, which are the classes primarily addressed in this project, are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;course&lt;/code&gt; model stores information about the instructor and institution and is associated with other models such as User, CourseParticipant, CourseTeam, Assignment, AssignmentParticipant, and Notification. The course model is responsible for completing a variety of tasks, including returning course teams, returning the submission directory for the course, viewing participants enrolled in the course, adding a participant to the course, copying the Assignment Participants to Course Participants, and checking whether a user is part of any CourseTeam. The problem description lists code smells that need to be fixed. We fixed some issues, such as deleting the unused methods and renaming methods to indicate their action. The renaming problem required us to change a few methods calls where the function to be renamed was used. Also, to reduce the cognitive complexity of the copy_assignment_participants method, we created a method to separate the raising error functionality. Comments were added to indicate the action of the methods.<br /> <br /> The &lt;code&gt;course_team&lt;/code&gt; is a subclass of the team class. CourseTeams are a type of team that an instructor can use throughout an entire semester, providing consistency in team membership over time. The course_team model is responsible for completing various tasks, including returning the course of the team, adding a participant to the CourseTeam, and copying the CourseTeam Participants to AssignmentTeam Participants. There are methods for importing and exporting data to/from CSV files for CourseTeam objects. The problem description lists code smells/issues that need to be fixed. The issues that we fixed were deleting unused methods, renaming methods, and changing method calls, changing rspec expectations, adding meaningful comments. To refactor methods, DRY principles were used. In addition, analogous changes were made in the assignment_team model.<br /> <br /> ==Problem Statement==<br /> <br /> ==Design Decisions==<br /> <br /> ==Implementation==<br /> ====Controller====<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Index !! Method !! Request Type !! Description <br /> |-<br /> | 1 || action_allowed || HELPER FUNCTION || Determines whether the current user has permission to perform certain actions based on their role<br /> |-<br /> | 2 || auto_complete_for_user_name || GET || Provides an autocomplete feature for the form input wen adding a TA<br /> |-<br /> | 3 || new || GET || Displays the form for creating a new course<br /> |-<br /> | 4 || edit|| GET || Method to get the course to edit<br /> |-<br /> | 5 || update || PUT || Method to update an existing course based on the form input and save the changes to database<br /> |-<br /> | 6 || copy || GET || Creates a new copy of an existing course with a new submission directory and saves it to the database<br /> |-<br /> | 7 || create || POST || Creates a new course based on the form input and saves it to database<br /> |-<br /> | 8 || delete || DELETE || Method to delete an existing course<br /> |-<br /> | 9 || view_teaching_assistant || GET || Displays all the teaching assistants for a course<br /> |-<br /> | 10 || add_ta || POST || Method to add teaching assistant to a course<br /> |-<br /> | 11 || remove_ta || POST || Method to remove teaching assistant from a course<br /> |-<br /> | 12 || set_course_fields || POST || Called in Update and Create methods to set the fields of course<br /> |-<br /> <br /> |}<br /> <br /> ==Testing Plan==<br /> ====Tests====<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Test No. !! Description <br /> |-<br /> | 1 || Tests if the team method returns the team of the participant<br /> |-<br /> | 2 || Tests if the leave_team method deletes a participant if no associations exist and force is nil<br /> |-<br /> | 3 || Tests if the leave_team method deletes a participant if no associations exist and force is true<br /> |-<br /> | 4 || Tests if the leave_team method deletes a participant with associations and force is true and there are multiple team users<br /> |-<br /> | 5 || Tests if the name method returns the name of the participant<br /> |-<br /> | 6 || Tests if the fullname method returns the full name of the participant<br /> |-<br /> | 7 || Tests if the handle method returns the handle of the participant<br /> |-<br /> | 8 || Tests if the sort_by_name method returns a sorted list of participants in alphabetical order<br /> |-<br /> | 9 || Tests if the topic_name method returns the participant topic name when nil<br /> |-<br /> | 10 || Tests if the topic_name method returns the participant topic name when not nil.<br /> |-<br /> | 11 || Tests if the authorization method returns participant when no arguments are passed.<br /> |-<br /> | 12 || Tests if the authorization method returns reader when no arguments are passed.<br /> |-<br /> | 13 || Tests if the authorization method returns submitter when no arguments are passed.<br /> |-<br /> | 14 || Tests if the authorization method returns reviewer when no arguments are passed.<br /> |-<br /> | 13 || Tests if the authorization method returns submitter when no arguments are passed.<br /> |-<br /> | 14 || Tests if the authorization method returns reviewer when no arguments are passed.<br /> |-<br /> | 15 || Tests if it returns participant data in the correct format.<br /> |-<br /> | 16 || Test if it exports the details of the participant correctly.<br /> <br /> |}<br /> <br /> ==Description==<br /> <br /> What it does: The Course model and CoursesController is responsible for managing the courses. This system allows admin to create a new course, edit the course and update the existing course. It also allows you to create a copy of an existing course, etc.<br /> <br /> What needs to be done:<br /> You have to exactly follow the reimplementation guidelines as stated on top and make sure that you have covered all the functionality that is required for the Courses. You will be responsible for the entire functionality of the Courses, the model and controller, and the detailed rspec test, testing all the pass and fail scenarios, for the rest endpoints are compulsory. <br /> As mentioned in the guideline, take reference from the User (model &amp; controller) implementation and look at roles_rspec.rb for the test, roles_rspec is not complete and there is potential for better testing but you can use that as a starting point.<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/ameyagv/reimplementation-back-end<br /> * '''Pull Request:''' <br /> * '''VCL Server:'''<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2332_Reimplement_Courses_(Refactor_course.rb)&diff=149095 2023-04-07T20:15:53Z

<p>Vspande: /* Implementation */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails, which functions as a learning management software system. It has many different functions and abilities, including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and a list of operations that can be performed on the course model. The &lt;code&gt;Course&lt;/code&gt; model and &lt;code&gt;CoursesController&lt;/code&gt;, which are the classes primarily addressed in this project, are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;course&lt;/code&gt; model stores information about the instructor and institution and is associated with other models such as User, CourseParticipant, CourseTeam, Assignment, AssignmentParticipant, and Notification. The course model is responsible for completing a variety of tasks, including returning course teams, returning the submission directory for the course, viewing participants enrolled in the course, adding a participant to the course, copying the Assignment Participants to Course Participants, and checking whether a user is part of any CourseTeam. The problem description lists code smells that need to be fixed. We fixed some issues, such as deleting the unused methods and renaming methods to indicate their action. The renaming problem required us to change a few methods calls where the function to be renamed was used. Also, to reduce the cognitive complexity of the copy_assignment_participants method, we created a method to separate the raising error functionality. Comments were added to indicate the action of the methods.<br /> <br /> The &lt;code&gt;course_team&lt;/code&gt; is a subclass of the team class. CourseTeams are a type of team that an instructor can use throughout an entire semester, providing consistency in team membership over time. The course_team model is responsible for completing various tasks, including returning the course of the team, adding a participant to the CourseTeam, and copying the CourseTeam Participants to AssignmentTeam Participants. There are methods for importing and exporting data to/from CSV files for CourseTeam objects. The problem description lists code smells/issues that need to be fixed. The issues that we fixed were deleting unused methods, renaming methods, and changing method calls, changing rspec expectations, adding meaningful comments. To refactor methods, DRY principles were used. In addition, analogous changes were made in the assignment_team model.<br /> <br /> ==Problem Statement==<br /> <br /> ==Design Decisions==<br /> <br /> ==Implementation==<br /> ====Controller====<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Index !! Method !! Request Type !! Description <br /> |-<br /> | 1 || action_allowed || HELPER FUNCTION || Determines whether the current user has permission to perform certain actions based on their role<br /> |-<br /> | 2 || auto_complete_for_user_name || GET || Provides an autocomplete feature for the form input wen adding a TA<br /> |-<br /> | 3 || new || GET || Displays the form for creating a new course<br /> |-<br /> | 4 || edit|| GET || Method to get the course to edit<br /> |-<br /> | 5 || update || PUT || Method to update an existing course based on the form input and save the changes to database<br /> |-<br /> | 6 || copy || GET || Creates a new copy of an existing course with a new submission directory and saves it to the database<br /> |-<br /> | 7 || create || POST || Creates a new course based on the form input and saves it to database<br /> |-<br /> | 8 || delete || DELETE || Method to delete an existing course<br /> |-<br /> | 9 || view_teaching_assistant || GET || Displays all the teacu=hing assistants for a course<br /> |-<br /> | 10 || add_ta || POST || Method to add teaching assistant to a course<br /> |-<br /> | 11 || remove_ta || POST || Method to remove teaching assistant from a course<br /> |-<br /> | 12 || set_course_fields || POST || Called in Update and Create methods to set the fields of course<br /> |-<br /> <br /> |}<br /> <br /> ==Testing Plan==<br /> ====Tests====<br /> <br /> {| class=&quot;wikitable&quot; style=&quot;margin-left:40px&quot;<br /> |-<br /> ! Test No. !! Description <br /> |-<br /> | 1 || Tests if the team method returns the team of the participant<br /> |-<br /> | 2 || Tests if the leave_team method deletes a participant if no associations exist and force is nil<br /> |-<br /> | 3 || Tests if the leave_team method deletes a participant if no associations exist and force is true<br /> |-<br /> | 4 || Tests if the leave_team method deletes a participant with associations and force is true and there are multiple team users<br /> |-<br /> | 5 || Tests if the name method returns the name of the participant<br /> |-<br /> | 6 || Tests if the fullname method returns the full name of the participant<br /> |-<br /> | 7 || Tests if the handle method returns the handle of the participant<br /> |-<br /> | 8 || Tests if the sort_by_name method returns a sorted list of participants in alphabetical order<br /> |-<br /> | 9 || Tests if the topic_name method returns the participant topic name when nil<br /> |-<br /> | 10 || Tests if the topic_name method returns the participant topic name when not nil.<br /> |-<br /> | 11 || Tests if the authorization method returns participant when no arguments are passed.<br /> |-<br /> | 12 || Tests if the authorization method returns reader when no arguments are passed.<br /> |-<br /> | 13 || Tests if the authorization method returns submitter when no arguments are passed.<br /> |-<br /> | 14 || Tests if the authorization method returns reviewer when no arguments are passed.<br /> |-<br /> | 13 || Tests if the authorization method returns submitter when no arguments are passed.<br /> |-<br /> | 14 || Tests if the authorization method returns reviewer when no arguments are passed.<br /> |-<br /> | 15 || Tests if it returns participant data in the correct format.<br /> |-<br /> | 16 || Test if it exports the details of the participant correctly.<br /> <br /> |}<br /> <br /> ==Description==<br /> <br /> What it does: The Course model and CoursesController is responsible for managing the courses. This system allows admin to create a new course, edit the course and update the existing course. It also allows you to create a copy of an existing course, etc.<br /> <br /> What needs to be done:<br /> You have to exactly follow the reimplementation guidelines as stated on top and make sure that you have covered all the functionality that is required for the Courses. You will be responsible for the entire functionality of the Courses, the model and controller, and the detailed rspec test, testing all the pass and fail scenarios, for the rest endpoints are compulsory. <br /> As mentioned in the guideline, take reference from the User (model &amp; controller) implementation and look at roles_rspec.rb for the test, roles_rspec is not complete and there is potential for better testing but you can use that as a starting point.<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/ameyagv/reimplementation-back-end<br /> * '''Pull Request:''' <br /> * '''VCL Server:'''<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=148542 2023-03-28T01:51:50Z

<p>Vspande: /* CHANGES IN RSPEC FILES */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;course&lt;/code&gt; model stores information about the instructor and institution and is associated with other models such as User, CourseParticipant, CourseTeam, Assignment, AssignmentParticipant, and Notification. The course model is responsible for completing a variety of tasks, including returning course teams, returning the submission directory for the course, viewing participants enrolled in the course, adding a participant to the course, copying the Assignment Participants to Course Participants, and checking whether a user is part of any CourseTeam. The problem description lists code smells that need to be fixed. We fixed some issues, such as deleting the unused methods and renaming methods to indicate their action. The renaming problem required us to change a few methods calls where the function to be renamed was used. Also, to reduce the cognitive complexity of the copy_assignment_participants method, we created a method to separate the raising error functionality. Comments were added to indicate the action of the methods.<br /> <br /> The &lt;code&gt;course_team&lt;/code&gt; is a subclass of the team class. CourseTeams are a type of team that an instructor can use throughout an entire semester, providing consistency in team membership over time. The course_team model is responsible for completing various tasks, including returning the course of the team, adding a participant to the CourseTeam, and copying the CourseTeam Participants to AssignmentTeam Participants. There are methods for importing and exporting data to/from CSV files for CourseTeam objects. The problem description lists code smells/issues that need to be fixed. The issues that we fixed were deleting unused methods, renaming methods, and changing method calls, changing rspec expectations, adding meaningful comments. To refactor methods, DRY principles were used. In addition, analogous changes were made in the assignment_team model.<br /> <br /> == Files Modified ==<br /> == CHANGES IN MODEL FILES ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Removed &lt;code&gt;add_member&lt;/code&gt; method from &lt;code&gt;course_team&lt;/code&gt; model<br /> |Assignment_team and Course_team are subclasses of Team. Both should follow the similar logic of adding members of respective teams. As of for, add_participants, usage is different for course.rb and course_team.rb, hence it should be present in both. However, to make the code more consistent among classes, team, course_team, and assignment_team, the add_member method should only be present in the team class.<br /> |[https://github.com/expertiza/expertiza/pull/2548/commits/8fb9bf9a793b8c154bc2b640daa630624e008a86 Commit]<br /> |-<br /> |4<br /> |Created method &lt;code&gt;raise_errors&lt;/code&gt;<br /> |To reduce Cognitive Complexity of method &lt;code&gt;copy_participants&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed &lt;code&gt;assignment_id&lt;/code&gt; <br /> |CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute &lt;code&gt;parent_id&lt;/code&gt; that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for &lt;code&gt;assignment_id&lt;/code&gt; in the CourseTeam class and no need for &lt;code&gt;course_id&lt;/code&gt; in AssignmentTeam class. It will be a bad coding practice to call the assignment_id method on the CourseTeam object, calling the course_id method on the AssignmentTeam object as it would be inappropriate.<br /> |[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; method as &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |As this method is copying a CourseTeam to an AssignmentTeam, renamed it as &lt;code&gt;copy_to_assignment_team&lt;/code&gt;. A suggestion for copy method in AssignmentTeam would be to rename it as &lt;code&gt;copy_to_course_team&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-56ab3d3b28f0be68663223f0a5ef9daa5c8d106caca412481562272ab2edfae1 Commit]&lt;br&gt;<br /> |-<br /> |3<br /> |Added Import Functionality <br /> |DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.<br /> |[https://github.com/kartikrawool/expertiza/commit/972c66e47fbc22965490cc4da3ae69a56d076d6b Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/assignment_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; method for AssignmentTeam <br /> |Renamed &lt;code&gt;copy&lt;/code&gt; for copying current AssignmentTeam to CourseTeam as &lt;code&gt;copy_to_course_team&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/b93df2590a7ab52f87a1df00512afe626fa81520 Commit]<br /> |-<br /> |2<br /> |Added Import Functionality <br /> |DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.<br /> |[https://github.com/kartikrawool/expertiza/commit/2bae1785a15caede251f81517ecf944302f80d89 Commit]<br /> |}<br /> <br /> <br /> <br /> === Changes to &lt;code&gt;app/models/team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Added Import Functionality <br /> |DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.<br /> |[https://github.com/kartikrawool/expertiza/commit/53a86107644d3a0b0bef28a42d499a0b7b386ebb Commit]<br /> |}<br /> <br /> == CHANGES IN RSPEC FILES ==<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-8b753735f47ae84fdf88f7e9f15e08b8dd13ba1bc8fd16abad11148800aa8954 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Import functionality changes&lt;/code&gt;<br /> |Test cases are added to rspec file as well for import functionality changes.<br /> |[https://github.com/kartikrawool/expertiza/commit/972c66e47fbc22965490cc4da3ae69a56d076d6b Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/assignment_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Import functionality changes&lt;/code&gt;<br /> |Test cases are added to rspec file as well for import functionality changes.<br /> |[https://github.com/kartikrawool/expertiza/commit/2bae1785a15caede251f81517ecf944302f80d89 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Import functionality changes&lt;/code&gt;<br /> |Test cases are added to rspec file as well for import functionality changes.<br /> |[https://github.com/kartikrawool/expertiza/commit/53a86107644d3a0b0bef28a42d499a0b7b386ebb#diff-638390a8686ba4d2e18c1fc9dfbef22271c8a02bb5d56bf78ded42e428fcf8b1 Commit]&lt;br&gt;<br /> |}<br /> <br /> == CHANGES IN CONTROLLER FILES ==<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course_team.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Test Plan ==<br /> <br /> All the suggested changes were made to &lt;code&gt;course.rb&lt;/code&gt; and &lt;code&gt;course_team.rb&lt;/code&gt;, all these models were amended and as a result we need to update the tests. We added or amended tests in their respective .spec files<br /> <br /> *'''course_team'''<br /> -<br /> *'''course'''<br /> *'''assignment_team'''<br /> <br /> <br /> Coverage:<br /> [[File:coverage_old.jpg|center|frame|Coverage of codebase before refactoring]]<br /> <br /> <br /> [[File:course_team_coverage.jpg|center|frame|Coverage of &lt;code&gt;course_team.rb&lt;/code&gt; before refactoring]]<br /> <br /> <br /> [[File:course_coverage.jpg|center|frame|Coverage of &lt;code&gt;course.rb&lt;/code&gt; before refactoring]]<br /> <br /> <br /> [[File:assignment_team_coverage.jpg|center|frame|Coverage of &lt;code&gt;assignment_team.rb&lt;/code&gt; before refactoring]]<br /> <br /> <br /> [[File:team_coverage.jpg|center|frame|Coverage of &lt;code&gt;team.rb&lt;/code&gt; before refactoring]]<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=148537 2023-03-28T01:45:39Z

<p>Vspande: /* CHANGES IN MODEL FILES */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;course&lt;/code&gt; model stores information about the instructor and institution and is associated with other models such as User, CourseParticipant, CourseTeam, Assignment, AssignmentParticipant, and Notification. The course model is responsible for completing a variety of tasks, including returning course teams, returning the submission directory for the course, viewing participants enrolled in the course, adding a participant to the course, copying the Assignment Participants to Course Participants, and checking whether a user is part of any CourseTeam. The problem description lists code smells that need to be fixed. We fixed some issues, such as deleting the unused methods and renaming methods to indicate their action. The renaming problem required us to change a few methods calls where the function to be renamed was used. Also, to reduce the cognitive complexity of the copy_assignment_participants method, we created a method to separate the raising error functionality. Comments were added to indicate the action of the methods.<br /> <br /> The &lt;code&gt;course_team&lt;/code&gt; is a subclass of the team class. CourseTeams are a type of team that an instructor can use throughout an entire semester, providing consistency in team membership over time. The course_team model is responsible for completing various tasks, including returning the course of the team, adding a participant to the CourseTeam, and copying the CourseTeam Participants to AssignmentTeam Participants. There are methods for importing and exporting data to/from CSV files for CourseTeam objects. The problem description lists code smells/issues that need to be fixed. The issues that we fixed were deleting unused methods, renaming methods, and changing method calls, changing rspec expectations, adding meaningful comments. To refactor methods, DRY principles were used. In addition, analogous changes were made in the assignment_team model.<br /> <br /> == Files Modified ==<br /> == CHANGES IN MODEL FILES ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Removed &lt;code&gt;add_member&lt;/code&gt; method from &lt;code&gt;course_team&lt;/code&gt; model<br /> |Assignment_team and Course_team are subclasses of Team. Both should follow the similar logic of adding members of respective teams. As of for, add_participants, usage is different for course.rb and course_team.rb, hence it should be present in both. However, to make the code more consistent among classes, team, course_team, and assignment_team, the add_member method should only be present in the team class.<br /> |[https://github.com/expertiza/expertiza/pull/2548/commits/8fb9bf9a793b8c154bc2b640daa630624e008a86 Commit]<br /> |-<br /> |4<br /> |Created method &lt;code&gt;raise_errors&lt;/code&gt;<br /> |To reduce Cognitive Complexity of method &lt;code&gt;copy_participants&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed &lt;code&gt;assignment_id&lt;/code&gt; <br /> |CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute &lt;code&gt;parent_id&lt;/code&gt; that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for &lt;code&gt;assignment_id&lt;/code&gt; in the CourseTeam class and no need for &lt;code&gt;course_id&lt;/code&gt; in AssignmentTeam class. It will be a bad coding practice to call the assignment_id method on the CourseTeam object, calling the course_id method on the AssignmentTeam object as it would be inappropriate.<br /> |[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; method as &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |As this method is copying a CourseTeam to an AssignmentTeam, renamed it as &lt;code&gt;copy_to_assignment_team&lt;/code&gt;. A suggestion for copy method in AssignmentTeam would be to rename it as &lt;code&gt;copy_to_course_team&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-56ab3d3b28f0be68663223f0a5ef9daa5c8d106caca412481562272ab2edfae1 Commit]&lt;br&gt;<br /> |-<br /> |3<br /> |Added Import Functionality <br /> |DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.<br /> |[https://github.com/kartikrawool/expertiza/commit/972c66e47fbc22965490cc4da3ae69a56d076d6b Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/assignment_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; method for AssignmentTeam <br /> |Renamed &lt;code&gt;copy&lt;/code&gt; for copying current AssignmentTeam to CourseTeam as &lt;code&gt;copy_to_course_team&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/b93df2590a7ab52f87a1df00512afe626fa81520 Commit]<br /> |-<br /> |2<br /> |Added Import Functionality <br /> |DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.<br /> |[https://github.com/kartikrawool/expertiza/commit/2bae1785a15caede251f81517ecf944302f80d89 Commit]<br /> |}<br /> <br /> <br /> <br /> === Changes to &lt;code&gt;app/models/team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Added Import Functionality <br /> |DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.<br /> |[https://github.com/kartikrawool/expertiza/commit/53a86107644d3a0b0bef28a42d499a0b7b386ebb Commit]<br /> |}<br /> <br /> == CHANGES IN RSPEC FILES ==<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-8b753735f47ae84fdf88f7e9f15e08b8dd13ba1bc8fd16abad11148800aa8954 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Import functionality changes&lt;/code&gt;<br /> |Test cases are added to rspec file as well for import functionality changes.<br /> |[https://github.com/kartikrawool/expertiza/commit/53a86107644d3a0b0bef28a42d499a0b7b386ebb#diff-638390a8686ba4d2e18c1fc9dfbef22271c8a02bb5d56bf78ded42e428fcf8b1 Commit]&lt;br&gt;<br /> |}<br /> <br /> == CHANGES IN CONTROLLER FILES ==<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course_team.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Test Plan ==<br /> <br /> All the suggested changes were made to &lt;code&gt;course.rb&lt;/code&gt; and &lt;code&gt;course_team.rb&lt;/code&gt;, all these models were amended and as a result we need to update the tests. We added or amended tests in their respective .spec files<br /> <br /> *'''course_team'''<br /> -<br /> *'''course'''<br /> *'''assignment_team'''<br /> <br /> <br /> Coverage:<br /> [[File:coverage_old.jpg|center|frame|Coverage of codebase before refactoring]]<br /> <br /> <br /> [[File:course_team_coverage.jpg|center|frame|Coverage of &lt;code&gt;course_team.rb&lt;/code&gt; before refactoring]]<br /> <br /> <br /> [[File:course_coverage.jpg|center|frame|Coverage of &lt;code&gt;course.rb&lt;/code&gt; before refactoring]]<br /> <br /> <br /> [[File:assignment_team_coverage.jpg|center|frame|Coverage of &lt;code&gt;assignment_team.rb&lt;/code&gt; before refactoring]]<br /> <br /> <br /> [[File:team_coverage.jpg|center|frame|Coverage of &lt;code&gt;team.rb&lt;/code&gt; before refactoring]]<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=148529 2023-03-28T01:40:12Z

<p>Vspande: /* Files Modified */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;course&lt;/code&gt; model stores information about the instructor and institution and is associated with other models such as User, CourseParticipant, CourseTeam, Assignment, AssignmentParticipant, and Notification. The course model is responsible for completing a variety of tasks, including returning course teams, returning the submission directory for the course, viewing participants enrolled in the course, adding a participant to the course, copying the Assignment Participants to Course Participants, and checking whether a user is part of any CourseTeam. The problem description lists code smells that need to be fixed. We fixed some issues, such as deleting the unused methods and renaming methods to indicate their action. The renaming problem required us to change a few methods calls where the function to be renamed was used. Also, to reduce the cognitive complexity of the copy_assignment_participants method, we created a method to separate the raising error functionality. Comments were added to indicate the action of the methods.<br /> <br /> The &lt;code&gt;course_team&lt;/code&gt; is a subclass of the team class. CourseTeams are a type of team that an instructor can use throughout an entire semester, providing consistency in team membership over time. The course_team model is responsible for completing various tasks, including returning the course of the team, adding a participant to the CourseTeam, and copying the CourseTeam Participants to AssignmentTeam Participants. There are methods for importing and exporting data to/from CSV files for CourseTeam objects. The problem description lists code smells/issues that need to be fixed. The issues that we fixed were deleting unused methods, renaming methods, and changing method calls, changing rspec expectations, adding meaningful comments. To refactor methods, DRY principles were used. In addition, analogous changes were made in the assignment_team model.<br /> <br /> == Files Modified ==<br /> == CHANGES IN MODEL FILES ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Removed &lt;code&gt;add_member&lt;/code&gt; method from &lt;code&gt;course_team&lt;/code&gt; model<br /> |Assignment_team and Course_team are subclasses of Team. Both should follow the similar logic of adding members of respective teams. As of for, add_participants, usage is different for course.rb and course_team.rb, hence it should be present in both. However, to make the code more consistent among classes, team, course_team, and assignment_team, the add_member method should only be present in the team class.<br /> |[https://github.com/expertiza/expertiza/pull/2548/commits/8fb9bf9a793b8c154bc2b640daa630624e008a86 Commit]<br /> |-<br /> |4<br /> |Created method &lt;code&gt;raise_errors&lt;/code&gt;<br /> |To reduce Cognitive Complexity of method &lt;code&gt;copy_participants&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed &lt;code&gt;assignment_id&lt;/code&gt; <br /> |CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute &lt;code&gt;parent_id&lt;/code&gt; that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for &lt;code&gt;assignment_id&lt;/code&gt; in the CourseTeam class and no need for &lt;code&gt;course_id&lt;/code&gt; in AssignmentTeam class. It will be a bad coding practice to call the assignment_id method on the CourseTeam object, calling the course_id method on the AssignmentTeam object as it would be inappropriate.<br /> |[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; method as &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |As this method is copying a CourseTeam to an AssignmentTeam, renamed it as &lt;code&gt;copy_to_assignment_team&lt;/code&gt;. A suggestion for copy method in AssignmentTeam would be to rename it as &lt;code&gt;copy_to_course_team&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-56ab3d3b28f0be68663223f0a5ef9daa5c8d106caca412481562272ab2edfae1 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/assignment_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; method for AssignmentTeam <br /> |Renamed &lt;code&gt;copy&lt;/code&gt; for copying current AssignmentTeam to CourseTeam as &lt;code&gt;copy_to_course_team&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/b93df2590a7ab52f87a1df00512afe626fa81520 Commit]<br /> |}<br /> <br /> <br /> === Changes to &lt;code&gt;app/models/team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Added Import Functionality <br /> |DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.<br /> |[https://github.com/kartikrawool/expertiza/commit/53a86107644d3a0b0bef28a42d499a0b7b386ebb Commit]<br /> |}<br /> <br /> <br /> == CHANGES IN RSPEC FILES ==<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-8b753735f47ae84fdf88f7e9f15e08b8dd13ba1bc8fd16abad11148800aa8954 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Import functionality changes&lt;/code&gt;<br /> |Test cases are added to rspec file as well for import functionality changes.<br /> |[https://github.com/kartikrawool/expertiza/commit/53a86107644d3a0b0bef28a42d499a0b7b386ebb#diff-638390a8686ba4d2e18c1fc9dfbef22271c8a02bb5d56bf78ded42e428fcf8b1 Commit]&lt;br&gt;<br /> |}<br /> <br /> == CHANGES IN CONTROLLER FILES ==<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course_team.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Test Plan ==<br /> <br /> All the suggested changes were made to &lt;code&gt;course.rb&lt;/code&gt; and &lt;code&gt;course_team.rb&lt;/code&gt;, all these models were amended and as a result we need to update the tests. We added or amended tests in their respective .spec files<br /> <br /> *'''course_team'''<br /> -<br /> *'''course'''<br /> *'''assignment_team'''<br /> <br /> <br /> Coverage:<br /> [[File:coverage_old.jpg|center|frame|Coverage of codebase before refactoring]]<br /> <br /> <br /> [[File:course_team_coverage.jpg|center|frame|Coverage of &lt;code&gt;course_team.rb&lt;/code&gt; before refactoring]]<br /> <br /> <br /> [[File:course_coverage.jpg|center|frame|Coverage of &lt;code&gt;course.rb&lt;/code&gt; before refactoring]]<br /> <br /> <br /> [[File:assignment_team_coverage.jpg|center|frame|Coverage of &lt;code&gt;assignment_team.rb&lt;/code&gt; before refactoring]]<br /> <br /> <br /> [[File:team_coverage.jpg|center|frame|Coverage of &lt;code&gt;team.rb&lt;/code&gt; before refactoring]]<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=148526 2023-03-28T01:38:05Z

<p>Vspande: /* Files Modified */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;course&lt;/code&gt; model stores information about the instructor and institution and is associated with other models such as User, CourseParticipant, CourseTeam, Assignment, AssignmentParticipant, and Notification. The course model is responsible for completing a variety of tasks, including returning course teams, returning the submission directory for the course, viewing participants enrolled in the course, adding a participant to the course, copying the Assignment Participants to Course Participants, and checking whether a user is part of any CourseTeam. The problem description lists code smells that need to be fixed. We fixed some issues, such as deleting the unused methods and renaming methods to indicate their action. The renaming problem required us to change a few methods calls where the function to be renamed was used. Also, to reduce the cognitive complexity of the copy_assignment_participants method, we created a method to separate the raising error functionality. Comments were added to indicate the action of the methods.<br /> <br /> The &lt;code&gt;course_team&lt;/code&gt; is a subclass of the team class. CourseTeams are a type of team that an instructor can use throughout an entire semester, providing consistency in team membership over time. The course_team model is responsible for completing various tasks, including returning the course of the team, adding a participant to the CourseTeam, and copying the CourseTeam Participants to AssignmentTeam Participants. There are methods for importing and exporting data to/from CSV files for CourseTeam objects. The problem description lists code smells/issues that need to be fixed. The issues that we fixed were deleting unused methods, renaming methods, and changing method calls, changing rspec expectations, adding meaningful comments. To refactor methods, DRY principles were used. In addition, analogous changes were made in the assignment_team model.<br /> <br /> == Files Modified ==<br /> === CHANGES IN MODEL FILES ===<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Removed &lt;code&gt;add_member&lt;/code&gt; method from &lt;code&gt;course_team&lt;/code&gt; model<br /> |Assignment_team and Course_team are subclasses of Team. Both should follow the similar logic of adding members of respective teams. As of for, add_participants, usage is different for course.rb and course_team.rb, hence it should be present in both. However, to make the code more consistent among classes, team, course_team, and assignment_team, the add_member method should only be present in the team class.<br /> |[https://github.com/expertiza/expertiza/pull/2548/commits/8fb9bf9a793b8c154bc2b640daa630624e008a86 Commit]<br /> |-<br /> |4<br /> |Created method &lt;code&gt;raise_errors&lt;/code&gt;<br /> |To reduce Cognitive Complexity of method &lt;code&gt;copy_participants&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed &lt;code&gt;assignment_id&lt;/code&gt; <br /> |CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute &lt;code&gt;parent_id&lt;/code&gt; that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for &lt;code&gt;assignment_id&lt;/code&gt; in the CourseTeam class and no need for &lt;code&gt;course_id&lt;/code&gt; in AssignmentTeam class. It will be a bad coding practice to call the assignment_id method on the CourseTeam object, calling the course_id method on the AssignmentTeam object as it would be inappropriate.<br /> |[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; method as &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |As this method is copying a CourseTeam to an AssignmentTeam, renamed it as &lt;code&gt;copy_to_assignment_team&lt;/code&gt;. A suggestion for copy method in AssignmentTeam would be to rename it as &lt;code&gt;copy_to_course_team&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-56ab3d3b28f0be68663223f0a5ef9daa5c8d106caca412481562272ab2edfae1 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/assignment_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; method for AssignmentTeam <br /> |Renamed &lt;code&gt;copy&lt;/code&gt; for copying current AssignmentTeam to CourseTeam as &lt;code&gt;copy_to_course_team&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/b93df2590a7ab52f87a1df00512afe626fa81520 Commit]<br /> |}<br /> <br /> <br /> === Changes to &lt;code&gt;app/models/team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Added Import Functionality <br /> |DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.<br /> |[https://github.com/kartikrawool/expertiza/commit/53a86107644d3a0b0bef28a42d499a0b7b386ebb Commit]<br /> |}<br /> <br /> <br /> === CHANGES IN RSPEC FILES ===<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-8b753735f47ae84fdf88f7e9f15e08b8dd13ba1bc8fd16abad11148800aa8954 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Import functionality changes&lt;/code&gt;<br /> |Test cases are added to rspec file as well for import functionality changes.<br /> |[https://github.com/kartikrawool/expertiza/commit/53a86107644d3a0b0bef28a42d499a0b7b386ebb#diff-638390a8686ba4d2e18c1fc9dfbef22271c8a02bb5d56bf78ded42e428fcf8b1 Commit]&lt;br&gt;<br /> |}<br /> <br /> === CHANGES IN CONTROLLER FILES ===<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course_team.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Test Plan ==<br /> <br /> All the suggested changes were made to &lt;code&gt;course.rb&lt;/code&gt; and &lt;code&gt;course_team.rb&lt;/code&gt;, all these models were amended and as a result we need to update the tests. We added or amended tests in their respective .spec files<br /> <br /> *'''course_team'''<br /> -<br /> *'''course'''<br /> *'''assignment_team'''<br /> <br /> <br /> Coverage:<br /> [[File:coverage_old.jpg|center|frame|Coverage of codebase before refactoring]]<br /> <br /> <br /> [[File:course_team_coverage.jpg|center|frame|Coverage of &lt;code&gt;course_team.rb&lt;/code&gt; before refactoring]]<br /> <br /> <br /> [[File:course_coverage.jpg|center|frame|Coverage of &lt;code&gt;course.rb&lt;/code&gt; before refactoring]]<br /> <br /> <br /> [[File:assignment_team_coverage.jpg|center|frame|Coverage of &lt;code&gt;assignment_team.rb&lt;/code&gt; before refactoring]]<br /> <br /> <br /> [[File:team_coverage.jpg|center|frame|Coverage of &lt;code&gt;team.rb&lt;/code&gt; before refactoring]]<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147970 2023-03-22T21:32:00Z

<p>Vspande: /* Files Modified */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;course&lt;/code&gt; model stores information about the instructor and institution and is associated with other models such as User, CourseParticipant, CourseTeam, Assignment, AssignmentParticipant, and Notification. The course model is responsible for completing a variety of tasks, including returning course teams, returning the submission directory for the course, viewing participants enrolled in the course, adding a participant to the course, copying the Assignment Participants to Course Participants, and checking whether a user is part of any CourseTeam. The problem description lists code smells that need to be fixed. We fixed some issues, such as deleting the unused methods and renaming methods to indicate their action. The remaining problem required us to change a few method calls where the function to be renamed was used. Also, to reduce the cognitive complexity of the copy_assignment_participants method, we created a method to separate the raising error functionality. Comments were added to indicate the action of the method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes in Model Files ===<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Removed &lt;code&gt;add_member&lt;/code&gt; method from &lt;code&gt;course_team&lt;/code&gt; model<br /> |Assignment_team and Course_team are subclasses of Team. Both should follow the similar logic of adding members of respective teams. As of for, add_participants, usage is different for course.rb and course_team.rb, hence it should be present in both. However, to make the code more consistent among classes, team, course_team, and assignment_team, the add_member method should only be present in the team class.<br /> |[https://github.com/expertiza/expertiza/pull/2548/commits/8fb9bf9a793b8c154bc2b640daa630624e008a86 Commit]<br /> |-<br /> |4<br /> |Created method &lt;code&gt;raise_errors&lt;/code&gt;<br /> |To reduce Cognitive Complexity of method &lt;code&gt;copy_participants&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed &lt;code&gt;assignment_id&lt;/code&gt; <br /> |CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute &lt;code&gt;parent_id&lt;/code&gt; that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for &lt;code&gt;assignment_id&lt;/code&gt; in the CourseTeam class and no need for &lt;code&gt;course_id&lt;/code&gt; in AssignmentTeam class. It will be a bad coding practice to call the assignment_id method on the CourseTeam object, calling the course_id method on the AssignmentTeam object as it would be inappropriate.<br /> |[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; method as &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |As this method is copying a CourseTeam to an AssignmentTeam, renamed it as &lt;code&gt;copy_to_assignment_team&lt;/code&gt;. A suggestion for copy method in AssignmentTeam would be to rename it as &lt;code&gt;copy_to_course_team&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-56ab3d3b28f0be68663223f0a5ef9daa5c8d106caca412481562272ab2edfae1 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/assignment_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; method for AssignmentTeam <br /> |Renamed &lt;code&gt;copy&lt;/code&gt; for copying current AssignmentTeam to CourseTeam as &lt;code&gt;copy_to_course_team&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/b93df2590a7ab52f87a1df00512afe626fa81520 Commit]<br /> |}<br /> <br /> === Changes in RSPEC Files ===<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-8b753735f47ae84fdf88f7e9f15e08b8dd13ba1bc8fd16abad11148800aa8954 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes in Controller Files ===<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course_team.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Test Plan ==<br /> <br /> All the suggested changes were made to &lt;code&gt;course.rb&lt;/code&gt; and &lt;code&gt;course_team.rb&lt;/code&gt;, all these models were amended and as a result we need to update the tests. We added or amended tests in their respective .spec files<br /> <br /> *'''course_team'''<br /> *'''course'''<br /> *'''assignment_team'''<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147964 2023-03-22T21:27:25Z

<p>Vspande: /* Files Modified */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;course&lt;/code&gt; model stores information about the instructor and institution and is associated with other models such as User, CourseParticipant, CourseTeam, Assignment, AssignmentParticipant, and Notification. The course model is responsible for completing a variety of tasks, including returning course teams, returning the submission directory for the course, viewing participants enrolled in the course, adding a participant to the course, copying the Assignment Participants to Course Participants, and checking whether a user is part of any CourseTeam. The problem description lists code smells that need to be fixed. We fixed some issues, such as deleting the unused methods and renaming methods to indicate their action. The remaining problem required us to change a few method calls where the function to be renamed was used. Also, to reduce the cognitive complexity of the copy_assignment_participants method, we created a method to separate the raising error functionality. Comments were added to indicate the action of the method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Removed &lt;code&gt;add_member&lt;/code&gt; method from &lt;code&gt;course_team&lt;/code&gt; model<br /> |Assignment_team and Course_team are subclasses of Team. Both should follow the similar logic of adding members of respective teams. As of for, add_participants, usage is different for course.rb and course_team.rb, hence it should be present in both. However, to make the code more consistent among classes, team, course_team, and assignment_team, the add_member method should only be present in the team class.<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed &lt;code&gt;assignment_id&lt;/code&gt; <br /> |CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute &lt;code&gt;parent_id&lt;/code&gt; that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for &lt;code&gt;assignment_id&lt;/code&gt; in the CourseTeam class and no need for &lt;code&gt;course_id&lt;/code&gt; in AssignmentTeam class. It will be a bad coding practice to call the assignment_id method on the CourseTeam object, calling the course_id method on the AssignmentTeam object as it would be inappropriate.<br /> |[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; method as &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |As this method is copying a CourseTeam to an AssignmentTeam, renamed it as &lt;code&gt;copy_to_assignment_team&lt;/code&gt;. A suggestion for copy method in AssignmentTeam would be to rename it as &lt;code&gt;copy_to_course_team&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-56ab3d3b28f0be68663223f0a5ef9daa5c8d106caca412481562272ab2edfae1 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/assignment_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; method for AssignmentTeam <br /> |Renamed &lt;code&gt;copy&lt;/code&gt; for copying current AssignmentTeam to CourseTeam as &lt;code&gt;copy_to_course_team&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/b93df2590a7ab52f87a1df00512afe626fa81520 Commit]<br /> |}<br /> <br /> <br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-8b753735f47ae84fdf88f7e9f15e08b8dd13ba1bc8fd16abad11148800aa8954 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course_team.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Test Plan ==<br /> <br /> All the suggested changes were made to &lt;code&gt;course.rb&lt;/code&gt; and &lt;code&gt;course_team.rb&lt;/code&gt;, all these models were amended and as a result we need to update the tests. We added or amended tests in their respective .spec files<br /> <br /> *'''course_team'''<br /> *'''course'''<br /> *'''assignment_team'''<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147908 2023-03-22T19:50:42Z

<p>Vspande: /* Changes to spec/models/course_team_spec.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Removed &lt;code&gt;add_member&lt;/code&gt; method from &lt;code&gt;course_team&lt;/code&gt; model<br /> |Assignment_team and Course_team are subclasses of Team. Both should follow the similar logic of adding members of respective teams. As of for, add_participants, usage is different for course.rb and course_team.rb, hence it should be present in both. However, to make the code more consistent among classes, team, course_team, and assignment_team, the add_member method should only be present in the team class.<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed &lt;code&gt;assignment_id&lt;/code&gt; <br /> |CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute &lt;code&gt;parent_id&lt;/code&gt; that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for &lt;code&gt;assignment_id&lt;/code&gt; in the CourseTeam class and no need for &lt;code&gt;course_id&lt;/code&gt; in AssignmentTeam class. It will be a bad coding practice to call the assignment_id method on the CourseTeam object, calling the course_id method on the AssignmentTeam object as it would be inappropriate.<br /> |[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; method as &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |As this method is copying a CourseTeam to an AssignmentTeam, renamed it as &lt;code&gt;copy_to_assignment_team&lt;/code&gt;. A suggestion for copy method in AssignmentTeam would be to rename it as &lt;code&gt;copy_to_course_team&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-56ab3d3b28f0be68663223f0a5ef9daa5c8d106caca412481562272ab2edfae1 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-8b753735f47ae84fdf88f7e9f15e08b8dd13ba1bc8fd16abad11148800aa8954 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course_team.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Test Plan ==<br /> <br /> All the suggested changes were made to &lt;code&gt;course.rb&lt;/code&gt; and &lt;code&gt;course_team.rb&lt;/code&gt;, all these models were amended and as a result we need to update the tests. We added or amended tests in their respective .spec files<br /> <br /> *'''course_team'''<br /> *'''course'''<br /> *'''assignment_team'''<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147907 2023-03-22T19:50:31Z

<p>Vspande: /* Changes to spec/models/course_spec.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Removed &lt;code&gt;add_member&lt;/code&gt; method from &lt;code&gt;course_team&lt;/code&gt; model<br /> |Assignment_team and Course_team are subclasses of Team. Both should follow the similar logic of adding members of respective teams. As of for, add_participants, usage is different for course.rb and course_team.rb, hence it should be present in both. However, to make the code more consistent among classes, team, course_team, and assignment_team, the add_member method should only be present in the team class.<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed &lt;code&gt;assignment_id&lt;/code&gt; <br /> |CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute &lt;code&gt;parent_id&lt;/code&gt; that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for &lt;code&gt;assignment_id&lt;/code&gt; in the CourseTeam class and no need for &lt;code&gt;course_id&lt;/code&gt; in AssignmentTeam class. It will be a bad coding practice to call the assignment_id method on the CourseTeam object, calling the course_id method on the AssignmentTeam object as it would be inappropriate.<br /> |[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; method as &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |As this method is copying a CourseTeam to an AssignmentTeam, renamed it as &lt;code&gt;copy_to_assignment_team&lt;/code&gt;. A suggestion for copy method in AssignmentTeam would be to rename it as &lt;code&gt;copy_to_course_team&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-56ab3d3b28f0be68663223f0a5ef9daa5c8d106caca412481562272ab2edfae1 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-8b753735f47ae84fdf88f7e9f15e08b8dd13ba1bc8fd16abad11148800aa8954 Commit]&lt;br&gt;<br /> |<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course_team.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Test Plan ==<br /> <br /> All the suggested changes were made to &lt;code&gt;course.rb&lt;/code&gt; and &lt;code&gt;course_team.rb&lt;/code&gt;, all these models were amended and as a result we need to update the tests. We added or amended tests in their respective .spec files<br /> <br /> *'''course_team'''<br /> *'''course'''<br /> *'''assignment_team'''<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147906 2023-03-22T19:50:18Z

<p>Vspande: /* Changes to app/models/course_team.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Removed &lt;code&gt;add_member&lt;/code&gt; method from &lt;code&gt;course_team&lt;/code&gt; model<br /> |Assignment_team and Course_team are subclasses of Team. Both should follow the similar logic of adding members of respective teams. As of for, add_participants, usage is different for course.rb and course_team.rb, hence it should be present in both. However, to make the code more consistent among classes, team, course_team, and assignment_team, the add_member method should only be present in the team class.<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed &lt;code&gt;assignment_id&lt;/code&gt; <br /> |CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute &lt;code&gt;parent_id&lt;/code&gt; that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for &lt;code&gt;assignment_id&lt;/code&gt; in the CourseTeam class and no need for &lt;code&gt;course_id&lt;/code&gt; in AssignmentTeam class. It will be a bad coding practice to call the assignment_id method on the CourseTeam object, calling the course_id method on the AssignmentTeam object as it would be inappropriate.<br /> |[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; method as &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |As this method is copying a CourseTeam to an AssignmentTeam, renamed it as &lt;code&gt;copy_to_assignment_team&lt;/code&gt;. A suggestion for copy method in AssignmentTeam would be to rename it as &lt;code&gt;copy_to_course_team&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-56ab3d3b28f0be68663223f0a5ef9daa5c8d106caca412481562272ab2edfae1 Commit]&lt;br&gt;<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-8b753735f47ae84fdf88f7e9f15e08b8dd13ba1bc8fd16abad11148800aa8954 Commit]&lt;br&gt;<br /> |<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course_team.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Test Plan ==<br /> <br /> All the suggested changes were made to &lt;code&gt;course.rb&lt;/code&gt; and &lt;code&gt;course_team.rb&lt;/code&gt;, all these models were amended and as a result we need to update the tests. We added or amended tests in their respective .spec files<br /> <br /> *'''course_team'''<br /> *'''course'''<br /> *'''assignment_team'''<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147905 2023-03-22T19:48:33Z

<p>Vspande: /* Changes to app/models/course_team.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Removed &lt;code&gt;add_member&lt;/code&gt; method from &lt;code&gt;course_team&lt;/code&gt; model<br /> |Assignment_team and Course_team are subclasses of Team. Both should follow the similar logic of adding members of respective teams. As of for, add_participants, usage is different for course.rb and course_team.rb, hence it should be present in both. However, to make the code more consistent among classes, team, course_team, and assignment_team, the add_member method should only be present in the team class.<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed &lt;code&gt;assignment_id&lt;/code&gt; <br /> |CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute &lt;code&gt;parent_id&lt;/code&gt; that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for &lt;code&gt;assignment_id&lt;/code&gt; in the CourseTeam class and no need for &lt;code&gt;course_id&lt;/code&gt; in AssignmentTeam class. It will be a bad coding practice to call the assignment_id method on the CourseTeam object, calling the course_id method on the AssignmentTeam object as it would be inappropriate.<br /> |[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; method as &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |As this method is copying a CourseTeam to an AssignmentTeam, renamed it as &lt;code&gt;copy_to_assignment_team&lt;/code&gt;. A suggestion for copy method in AssignmentTeam would be to rename it as &lt;code&gt;copy_to_course_team&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-56ab3d3b28f0be68663223f0a5ef9daa5c8d106caca412481562272ab2edfae1 Commit]&lt;br&gt;<br /> |<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-8b753735f47ae84fdf88f7e9f15e08b8dd13ba1bc8fd16abad11148800aa8954 Commit]&lt;br&gt;<br /> |<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course_team.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Test Plan ==<br /> <br /> All the suggested changes were made to &lt;code&gt;course.rb&lt;/code&gt; and &lt;code&gt;course_team.rb&lt;/code&gt;, all these models were amended and as a result we need to update the tests. We added or amended tests in their respective .spec files<br /> <br /> *'''course_team'''<br /> *'''course'''<br /> *'''assignment_team'''<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147904 2023-03-22T19:47:13Z

<p>Vspande: /* Changes to app/models/course_team.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Removed &lt;code&gt;add_member&lt;/code&gt; method from &lt;code&gt;course_team&lt;/code&gt; model<br /> |Assignment_team and Course_team are subclasses of Team. Both should follow the similar logic of adding members of respective teams. As of for, add_participants, usage is different for course.rb and course_team.rb, hence it should be present in both. However, to make the code more consistent among classes, team, course_team, and assignment_team, the add_member method should only be present in the team class.<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed &lt;code&gt;assignment_id&lt;/code&gt; <br /> |CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute &lt;code&gt;parent_id&lt;/code&gt; that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for &lt;code&gt;assignment_id&lt;/code&gt; in the CourseTeam class and no need for &lt;code&gt;course_id&lt;/code&gt; in AssignmentTeam class. It will be a bad coding practice to call the assignment_id method on the CourseTeam object, calling the course_id method on the AssignmentTeam object as it would be inappropriate.<br /> |[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]<br /> |2<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; method as &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |As this method is copying a CourseTeam to an AssignmentTeam, renamed it as &lt;code&gt;copy_to_assignment_team&lt;/code&gt;. A suggestion for copy method in AssignmentTeam would be to rename it as &lt;code&gt;copy_to_course_team&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-56ab3d3b28f0be68663223f0a5ef9daa5c8d106caca412481562272ab2edfae1 Commit]&lt;br&gt;<br /> |<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-8b753735f47ae84fdf88f7e9f15e08b8dd13ba1bc8fd16abad11148800aa8954 Commit]&lt;br&gt;<br /> |<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course_team.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Test Plan ==<br /> <br /> All the suggested changes were made to &lt;code&gt;course.rb&lt;/code&gt; and &lt;code&gt;course_team.rb&lt;/code&gt;, all these models were amended and as a result we need to update the tests. We added or amended tests in their respective .spec files<br /> <br /> *'''course_team'''<br /> *'''course'''<br /> *'''assignment_team'''<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147903 2023-03-22T19:40:06Z

<p>Vspande: /* Changes to spec/models/course_team_spec.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Removed &lt;code&gt;add_member&lt;/code&gt; method from &lt;code&gt;course_team&lt;/code&gt; model<br /> |Assignment_team and Course_team are subclasses of Team. Both should follow the similar logic of adding members of respective teams. As of for, add_participants, usage is different for course.rb and course_team.rb, hence it should be present in both. However, to make the code more consistent among classes, team, course_team, and assignment_team, the add_member method should only be present in the team class.<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed &lt;code&gt;assignment_id&lt;/code&gt; <br /> |CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute &lt;code&gt;parent_id&lt;/code&gt; that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for &lt;code&gt;assignment_id&lt;/code&gt; in the CourseTeam class and no need for &lt;code&gt;course_id&lt;/code&gt; in AssignmentTeam class. It will be a bad coding practice to call assignment_id method on the CourseTeam object, calling the course_id method on the AssignmentTeam object as it would be inappropriate.<br /> |[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-8b753735f47ae84fdf88f7e9f15e08b8dd13ba1bc8fd16abad11148800aa8954 Commit]&lt;br&gt;<br /> |<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course_team.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Test Plan ==<br /> <br /> All the suggested changes were made to &lt;code&gt;course.rb&lt;/code&gt; and &lt;code&gt;course_team.rb&lt;/code&gt;, all these models were amended and as a result we need to update the tests. We added or amended tests in their respective .spec files<br /> <br /> *'''course_team'''<br /> *'''course'''<br /> *'''assignment_team'''<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147902 2023-03-22T19:37:02Z

<p>Vspande: /* Changes to app/controllers/teams_controller.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Removed &lt;code&gt;add_member&lt;/code&gt; method from &lt;code&gt;course_team&lt;/code&gt; model<br /> |Assignment_team and Course_team are subclasses of Team. Both should follow the similar logic of adding members of respective teams. As of for, add_participants, usage is different for course.rb and course_team.rb, hence it should be present in both. However, to make the code more consistent among classes, team, course_team, and assignment_team, the add_member method should only be present in the team class.<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed &lt;code&gt;assignment_id&lt;/code&gt; <br /> |CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute &lt;code&gt;parent_id&lt;/code&gt; that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for &lt;code&gt;assignment_id&lt;/code&gt; in the CourseTeam class and no need for &lt;code&gt;course_id&lt;/code&gt; in AssignmentTeam class. It will be a bad coding practice to call assignment_id method on the CourseTeam object, calling the course_id method on the AssignmentTeam object as it would be inappropriate.<br /> |[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course_team.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Test Plan ==<br /> <br /> All the suggested changes were made to &lt;code&gt;course.rb&lt;/code&gt; and &lt;code&gt;course_team.rb&lt;/code&gt;, all these models were amended and as a result we need to update the tests. We added or amended tests in their respective .spec files<br /> <br /> *'''course_team'''<br /> *'''course'''<br /> *'''assignment_team'''<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147901 2023-03-22T19:34:48Z

<p>Vspande: /* Changes to spec/models/course_spec.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Removed &lt;code&gt;add_member&lt;/code&gt; method from &lt;code&gt;course_team&lt;/code&gt; model<br /> |Assignment_team and Course_team are subclasses of Team. Both should follow the similar logic of adding members of respective teams. As of for, add_participants, usage is different for course.rb and course_team.rb, hence it should be present in both. However, to make the code more consistent among classes, team, course_team, and assignment_team, the add_member method should only be present in the team class.<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed &lt;code&gt;assignment_id&lt;/code&gt; <br /> |CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute &lt;code&gt;parent_id&lt;/code&gt; that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for &lt;code&gt;assignment_id&lt;/code&gt; in the CourseTeam class and no need for &lt;code&gt;course_id&lt;/code&gt; in AssignmentTeam class. It will be a bad coding practice to call assignment_id method on the CourseTeam object, calling the course_id method on the AssignmentTeam object as it would be inappropriate.<br /> |[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Test Plan ==<br /> <br /> All the suggested changes were made to &lt;code&gt;course.rb&lt;/code&gt; and &lt;code&gt;course_team.rb&lt;/code&gt;, all these models were amended and as a result we need to update the tests. We added or amended tests in their respective .spec files<br /> <br /> *'''course_team'''<br /> *'''course'''<br /> *'''assignment_team'''<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147900 2023-03-22T19:34:31Z

<p>Vspande: /* Changes to spec/models/course_spec.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Removed &lt;code&gt;add_member&lt;/code&gt; method from &lt;code&gt;course_team&lt;/code&gt; model<br /> |Assignment_team and Course_team are subclasses of Team. Both should follow the similar logic of adding members of respective teams. As of for, add_participants, usage is different for course.rb and course_team.rb, hence it should be present in both. However, to make the code more consistent among classes, team, course_team, and assignment_team, the add_member method should only be present in the team class.<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed &lt;code&gt;assignment_id&lt;/code&gt; <br /> |CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute &lt;code&gt;parent_id&lt;/code&gt; that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for &lt;code&gt;assignment_id&lt;/code&gt; in the CourseTeam class and no need for &lt;code&gt;course_id&lt;/code&gt; in AssignmentTeam class. It will be a bad coding practice to call assignment_id method on the CourseTeam object, calling the course_id method on the AssignmentTeam object as it would be inappropriate.<br /> |[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |1<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Test Plan ==<br /> <br /> All the suggested changes were made to &lt;code&gt;course.rb&lt;/code&gt; and &lt;code&gt;course_team.rb&lt;/code&gt;, all these models were amended and as a result we need to update the tests. We added or amended tests in their respective .spec files<br /> <br /> *'''course_team'''<br /> *'''course'''<br /> *'''assignment_team'''<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147897 2023-03-22T19:32:49Z

<p>Vspande: /* Changes to spec/models/course_team_spec.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Removed &lt;code&gt;add_member&lt;/code&gt; method from &lt;code&gt;course_team&lt;/code&gt; model<br /> |Assignment_team and Course_team are subclasses of Team. Both should follow the similar logic of adding members of respective teams. As of for, add_participants, usage is different for course.rb and course_team.rb, hence it should be present in both. However, to make the code more consistent among classes, team, course_team, and assignment_team, the add_member method should only be present in the team class.<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed &lt;code&gt;assignment_id&lt;/code&gt; <br /> |CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute &lt;code&gt;parent_id&lt;/code&gt; that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for &lt;code&gt;assignment_id&lt;/code&gt; in the CourseTeam class and no need for &lt;code&gt;course_id&lt;/code&gt; in AssignmentTeam class. It will be a bad coding practice to call assignment_id method on the CourseTeam object, calling the course_id method on the AssignmentTeam object as it would be inappropriate.<br /> |[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Test Plan ==<br /> '''Note: Code Climate was not running on Expertiza's beta branch for the last four days of the project. We have done the best we could to removed extraneous lines and white spaces.''' <br /> <br /> All the suggested changes were made to &lt;code&gt;course.rb&lt;/code&gt; and &lt;code&gt;course_team.rb&lt;/code&gt;<br /> All these models have an ::import method that we amended and as a result we need to update the tests. We added or amended tests in their respective .spec files to make sure that the ::import method has 100% coverage. <br /> <br /> *'''assignment_participant'''<br /> *'''assignment_team'''<br /> *'''course_participant'''<br /> *'''course_team'''<br /> *'''team'''<br /> *'''metareview_response_map'''<br /> *'''review_response_map'''<br /> *'''sign_up_topic'''<br /> *'''user'''<br /> <br /> There is one failing test about exporting and we have not touched export functionality. There is another failing test about a review tab that we didn't touch.<br /> <br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147896 2023-03-22T19:31:54Z

<p>Vspande: /* Changes to spec/models/course_team_spec.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Removed &lt;code&gt;add_member&lt;/code&gt; method from &lt;code&gt;course_team&lt;/code&gt; model<br /> |Assignment_team and Course_team are subclasses of Team. Both should follow the similar logic of adding members of respective teams. As of for, add_participants, usage is different for course.rb and course_team.rb, hence it should be present in both. However, to make the code more consistent among classes, team, course_team, and assignment_team, the add_member method should only be present in the team class.<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed &lt;code&gt;assignment_id&lt;/code&gt; <br /> |CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute &lt;code&gt;parent_id&lt;/code&gt; that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for &lt;code&gt;assignment_id&lt;/code&gt; in the CourseTeam class and no need for &lt;code&gt;course_id&lt;/code&gt; in AssignmentTeam class. It will be a bad coding practice to call assignment_id method on the CourseTeam object, calling the course_id method on the AssignmentTeam object as it would be inappropriate.<br /> |[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Test Plan ==<br /> '''Note: Code Climate was not running on Expertiza's beta branch for the last four days of the project. We have done the best we could to removed extraneous lines and white spaces.''' <br /> <br /> All the suggested changes were made to &lt;code&gt;course.rb&lt;/code&gt; and &lt;code&gt;course_team.rb&lt;/code&gt;<br /> All these models have an ::import method that we amended and as a result we need to update the tests. We added or amended tests in their respective .spec files to make sure that the ::import method has 100% coverage. <br /> <br /> *'''assignment_participant'''<br /> *'''assignment_team'''<br /> *'''course_participant'''<br /> *'''course_team'''<br /> *'''team'''<br /> *'''metareview_response_map'''<br /> *'''review_response_map'''<br /> *'''sign_up_topic'''<br /> *'''user'''<br /> <br /> There is one failing test about exporting and we have not touched export functionality. There is another failing test about a review tab that we didn't touch.<br /> <br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147895 2023-03-22T19:31:07Z

<p>Vspande: /* Changes to spec/models/course_spec.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Removed &lt;code&gt;add_member&lt;/code&gt; method from &lt;code&gt;course_team&lt;/code&gt; model<br /> |Assignment_team and Course_team are subclasses of Team. Both should follow the similar logic of adding members of respective teams. As of for, add_participants, usage is different for course.rb and course_team.rb, hence it should be present in both. However, to make the code more consistent among classes, team, course_team, and assignment_team, the add_member method should only be present in the team class.<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed &lt;code&gt;assignment_id&lt;/code&gt; <br /> |CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute &lt;code&gt;parent_id&lt;/code&gt; that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for &lt;code&gt;assignment_id&lt;/code&gt; in the CourseTeam class and no need for &lt;code&gt;course_id&lt;/code&gt; in AssignmentTeam class. It will be a bad coding practice to call assignment_id method on the CourseTeam object, calling the course_id method on the AssignmentTeam object as it would be inappropriate.<br /> |[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Test Plan ==<br /> '''Note: Code Climate was not running on Expertiza's beta branch for the last four days of the project. We have done the best we could to removed extraneous lines and white spaces.''' <br /> <br /> All the suggested changes were made to &lt;code&gt;course.rb&lt;/code&gt; and &lt;code&gt;course_team.rb&lt;/code&gt;<br /> All these models have an ::import method that we amended and as a result we need to update the tests. We added or amended tests in their respective .spec files to make sure that the ::import method has 100% coverage. <br /> <br /> *'''assignment_participant'''<br /> *'''assignment_team'''<br /> *'''course_participant'''<br /> *'''course_team'''<br /> *'''team'''<br /> *'''metareview_response_map'''<br /> *'''review_response_map'''<br /> *'''sign_up_topic'''<br /> *'''user'''<br /> <br /> There is one failing test about exporting and we have not touched export functionality. There is another failing test about a review tab that we didn't touch.<br /> <br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147894 2023-03-22T19:29:12Z

<p>Vspande: /* Changes to app/models/course_team.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Removed &lt;code&gt;add_member&lt;/code&gt; method from &lt;code&gt;course_team&lt;/code&gt; model<br /> |Assignment_team and Course_team are subclasses of Team. Both should follow the similar logic of adding members of respective teams. As of for, add_participants, usage is different for course.rb and course_team.rb, hence it should be present in both. However, to make the code more consistent among classes, team, course_team, and assignment_team, the add_member method should only be present in the team class.<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed &lt;code&gt;assignment_id&lt;/code&gt; <br /> |CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute &lt;code&gt;parent_id&lt;/code&gt; that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for &lt;code&gt;assignment_id&lt;/code&gt; in the CourseTeam class and no need for &lt;code&gt;course_id&lt;/code&gt; in AssignmentTeam class. It will be a bad coding practice to call assignment_id method on the CourseTeam object, calling the course_id method on the AssignmentTeam object as it would be inappropriate.<br /> |[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Test Plan ==<br /> '''Note: Code Climate was not running on Expertiza's beta branch for the last four days of the project. We have done the best we could to removed extraneous lines and white spaces.''' <br /> <br /> All the suggested changes were made to &lt;code&gt;course.rb&lt;/code&gt; and &lt;code&gt;course_team.rb&lt;/code&gt;<br /> All these models have an ::import method that we amended and as a result we need to update the tests. We added or amended tests in their respective .spec files to make sure that the ::import method has 100% coverage. <br /> <br /> *'''assignment_participant'''<br /> *'''assignment_team'''<br /> *'''course_participant'''<br /> *'''course_team'''<br /> *'''team'''<br /> *'''metareview_response_map'''<br /> *'''review_response_map'''<br /> *'''sign_up_topic'''<br /> *'''user'''<br /> <br /> There is one failing test about exporting and we have not touched export functionality. There is another failing test about a review tab that we didn't touch.<br /> <br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147892 2023-03-22T19:22:00Z

<p>Vspande: /* Changes to app/models/course_team.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Removed &lt;code&gt;add_member&lt;/code&gt; method from &lt;code&gt;course_team&lt;/code&gt; model<br /> |Assignment_team and Course_team are subclasses of Team. Both should follow the similar logic of adding members of respective teams. As of for, add_participants, usage is different for course.rb and course_team.rb, hence it should be present in both. However, to make the code more consistent among classes, team, course_team, and assignment_team, the add_member method should only be present in the team class.<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed &lt;code&gt;assignment_id&lt;/code&gt; <br /> |Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either &lt;code&gt;before_action&lt;/code&gt; or &lt;code&gt;after_action&lt;/code&gt; blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |-<br /> |2<br /> |*Not in required chagnes* Replaced repeated code for re-caching the user role<br /> |We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called &lt;code&gt;self.rebuild_role_cache&lt;/code&gt;.<br /> |[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]<br /> |-<br /> |3<br /> |Improved helper function names<br /> |Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.<br /> |[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147889 2023-03-22T19:07:27Z

<p>Vspande: /* Changes to app/models/course.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Removed &lt;code&gt;add_member&lt;/code&gt; method from &lt;code&gt;course_team&lt;/code&gt; model<br /> |Assignment_team and Course_team are subclasses of Team. Both should follow the similar logic of adding members of respective teams. As of for, add_participants, usage is different for course.rb and course_team.rb, hence it should be present in both. However, to make the code more consistent among classes, team, course_team, and assignment_team, the add_member method should only be present in the team class.<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Move logger messages to &lt;code&gt;before_action&lt;/code&gt; blocks wherever possible<br /> |Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either &lt;code&gt;before_action&lt;/code&gt; or &lt;code&gt;after_action&lt;/code&gt; blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |-<br /> |2<br /> |*Not in required chagnes* Replaced repeated code for re-caching the user role<br /> |We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called &lt;code&gt;self.rebuild_role_cache&lt;/code&gt;.<br /> |[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]<br /> |-<br /> |3<br /> |Improved helper function names<br /> |Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.<br /> |[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147886 2023-03-22T19:05:27Z

<p>Vspande: /* Changes to app/models/course.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Removed &lt;code&gt;add_member&lt;/code&gt; method from &lt;code&gt;course_team&lt;/code&gt; model<br /> |Assignment_team and Course_team are subclasses of Team. Both should follow the similar logic of adding members of respective teams. As of for, add_participants, usage is different for course.rb and course_team.rb, hence it should be present in both. However, to make the code more consistent among classes, team, course_team, and assignment_team, the add_member method should only be present in the team class.<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |-<br /> |4<br /> |Bugfix: Reload page if email is nil or empty on &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view<br /> |An empty email parameter was causing the send password button to freeze. This was beyond the scope of our work but we wanted to improve the page functionality. <br /> |[https://github.com/expertiza/expertiza/commit/70f77ac851b234f840709859dc1ee9d6725c34fc Commit]<br /> |-<br /> |5<br /> |Improve overall comments and rewrite error messages<br /> |The comments and error messages in the controller need to be more meaningful, specific and clear.<br /> |[https://github.com/expertiza/expertiza/commit/1af745dc3b59641cb0266ebe49ee996718381fd0 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Move logger messages to &lt;code&gt;before_action&lt;/code&gt; blocks wherever possible<br /> |Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either &lt;code&gt;before_action&lt;/code&gt; or &lt;code&gt;after_action&lt;/code&gt; blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |-<br /> |2<br /> |*Not in required chagnes* Replaced repeated code for re-caching the user role<br /> |We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called &lt;code&gt;self.rebuild_role_cache&lt;/code&gt;.<br /> |[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]<br /> |-<br /> |3<br /> |Improved helper function names<br /> |Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.<br /> |[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147769 2023-03-22T03:57:53Z

<p>Vspande: /* Changes to app/models/course_team.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Change token expiration time to constant in line 41<br /> |This time should not be hardwired; it should be a constant or a parameter. <br /> |[https://github.com/expertiza/expertiza/commit/3f0b51f6f2f106df8338483396a95d4068e39c7f Commit]<br /> |-<br /> |4<br /> |Bugfix: Reload page if email is nil or empty on &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view<br /> |An empty email parameter was causing the send password button to freeze. This was beyond the scope of our work but we wanted to improve the page functionality. <br /> |[https://github.com/expertiza/expertiza/commit/70f77ac851b234f840709859dc1ee9d6725c34fc Commit]<br /> |-<br /> |5<br /> |Improve overall comments and rewrite error messages<br /> |The comments and error messages in the controller need to be more meaningful, specific and clear.<br /> |[https://github.com/expertiza/expertiza/commit/1af745dc3b59641cb0266ebe49ee996718381fd0 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Move logger messages to &lt;code&gt;before_action&lt;/code&gt; blocks wherever possible<br /> |Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either &lt;code&gt;before_action&lt;/code&gt; or &lt;code&gt;after_action&lt;/code&gt; blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.<br /> |[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]<br /> |-<br /> |2<br /> |*Not in required chagnes* Replaced repeated code for re-caching the user role<br /> |We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called &lt;code&gt;self.rebuild_role_cache&lt;/code&gt;.<br /> |[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]<br /> |-<br /> |3<br /> |Improved helper function names<br /> |Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.<br /> |[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147723 2023-03-22T01:47:16Z

<p>Vspande: /* Changes to app/controllers/teams_controller.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Change token expiration time to constant in line 41<br /> |This time should not be hardwired; it should be a constant or a parameter. <br /> |[https://github.com/expertiza/expertiza/commit/3f0b51f6f2f106df8338483396a95d4068e39c7f Commit]<br /> |-<br /> |4<br /> |Bugfix: Reload page if email is nil or empty on &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view<br /> |An empty email parameter was causing the send password button to freeze. This was beyond the scope of our work but we wanted to improve the page functionality. <br /> |[https://github.com/expertiza/expertiza/commit/70f77ac851b234f840709859dc1ee9d6725c34fc Commit]<br /> |-<br /> |5<br /> |Improve overall comments and rewrite error messages<br /> |The comments and error messages in the controller need to be more meaningful, specific and clear.<br /> |[https://github.com/expertiza/expertiza/commit/1af745dc3b59641cb0266ebe49ee996718381fd0 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Move logger messages to &lt;code&gt;before_action&lt;/code&gt; blocks wherever possible<br /> |Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either &lt;code&gt;before_action&lt;/code&gt; or &lt;code&gt;after_action&lt;/code&gt; blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.<br /> |[https://github.com/greyfiles/expertiza/commit/7069f5d3cbfa2b7259e85e39dbfbf6fb41a0ce1d Commit]<br /> |-<br /> |2<br /> |*Not in required chagnes* Replaced repeated code for re-caching the user role<br /> |We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called &lt;code&gt;self.rebuild_role_cache&lt;/code&gt;.<br /> |[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]<br /> |-<br /> |3<br /> |Improved helper function names<br /> |Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.<br /> |[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Renamed &lt;code&gt;copy&lt;/code&gt; to &lt;code&gt;copy_to_assignment_team&lt;/code&gt; <br /> |The change was directly related to changes of copy method in &lt;code&gt;course.rb&lt;/code&gt;.<br /> |[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]<br /> |-<br /> |}<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147715 2023-03-22T01:34:53Z

<p>Vspande: /* Changes to spec/models/course_spec.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Change token expiration time to constant in line 41<br /> |This time should not be hardwired; it should be a constant or a parameter. <br /> |[https://github.com/expertiza/expertiza/commit/3f0b51f6f2f106df8338483396a95d4068e39c7f Commit]<br /> |-<br /> |4<br /> |Bugfix: Reload page if email is nil or empty on &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view<br /> |An empty email parameter was causing the send password button to freeze. This was beyond the scope of our work but we wanted to improve the page functionality. <br /> |[https://github.com/expertiza/expertiza/commit/70f77ac851b234f840709859dc1ee9d6725c34fc Commit]<br /> |-<br /> |5<br /> |Improve overall comments and rewrite error messages<br /> |The comments and error messages in the controller need to be more meaningful, specific and clear.<br /> |[https://github.com/expertiza/expertiza/commit/1af745dc3b59641cb0266ebe49ee996718381fd0 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Move logger messages to &lt;code&gt;before_action&lt;/code&gt; blocks wherever possible<br /> |Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either &lt;code&gt;before_action&lt;/code&gt; or &lt;code&gt;after_action&lt;/code&gt; blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.<br /> |[https://github.com/greyfiles/expertiza/commit/7069f5d3cbfa2b7259e85e39dbfbf6fb41a0ce1d Commit]<br /> |-<br /> |2<br /> |*Not in required chagnes* Replaced repeated code for re-caching the user role<br /> |We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called &lt;code&gt;self.rebuild_role_cache&lt;/code&gt;.<br /> |[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]<br /> |-<br /> |3<br /> |Improved helper function names<br /> |Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.<br /> |[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method test case<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; method test case<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Created a file to host the &lt;code&gt;password_retrieval_controller_spec.rb&lt;/code&gt; fixtures<br /> |We implemented factories in the rspec test file to improve modularity and code readability.<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]<br /> |-<br /> |}<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147714 2023-03-22T01:33:30Z

<p>Vspande: /* Changes to spec/models/course_spec.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Change token expiration time to constant in line 41<br /> |This time should not be hardwired; it should be a constant or a parameter. <br /> |[https://github.com/expertiza/expertiza/commit/3f0b51f6f2f106df8338483396a95d4068e39c7f Commit]<br /> |-<br /> |4<br /> |Bugfix: Reload page if email is nil or empty on &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view<br /> |An empty email parameter was causing the send password button to freeze. This was beyond the scope of our work but we wanted to improve the page functionality. <br /> |[https://github.com/expertiza/expertiza/commit/70f77ac851b234f840709859dc1ee9d6725c34fc Commit]<br /> |-<br /> |5<br /> |Improve overall comments and rewrite error messages<br /> |The comments and error messages in the controller need to be more meaningful, specific and clear.<br /> |[https://github.com/expertiza/expertiza/commit/1af745dc3b59641cb0266ebe49ee996718381fd0 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Move logger messages to &lt;code&gt;before_action&lt;/code&gt; blocks wherever possible<br /> |Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either &lt;code&gt;before_action&lt;/code&gt; or &lt;code&gt;after_action&lt;/code&gt; blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.<br /> |[https://github.com/greyfiles/expertiza/commit/7069f5d3cbfa2b7259e85e39dbfbf6fb41a0ce1d Commit]<br /> |-<br /> |2<br /> |*Not in required chagnes* Replaced repeated code for re-caching the user role<br /> |We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called &lt;code&gt;self.rebuild_role_cache&lt;/code&gt;.<br /> |[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]<br /> |-<br /> |3<br /> |Improved helper function names<br /> |Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.<br /> |[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; in RSPEC<br /> |Renamed the respective method of &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt;in rspec file as well.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]&lt;br&gt;<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Created a file to host the &lt;code&gt;password_retrieval_controller_spec.rb&lt;/code&gt; fixtures<br /> |We implemented factories in the rspec test file to improve modularity and code readability.<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]<br /> |-<br /> |}<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147713 2023-03-22T01:30:13Z

<p>Vspande: /* Changes to app/models/course.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Renamed &lt;code&gt;copy_participants&lt;/code&gt; method<br /> |Renamed &lt;code&gt;copy_participants&lt;/code&gt; to &lt;code&gt;copy_assignment_participants&lt;/code&gt; which makes more sense and a clear idea of how method works and what is the purpose of method.<br /> |[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]<br /> |-<br /> |3<br /> |Change token expiration time to constant in line 41<br /> |This time should not be hardwired; it should be a constant or a parameter. <br /> |[https://github.com/expertiza/expertiza/commit/3f0b51f6f2f106df8338483396a95d4068e39c7f Commit]<br /> |-<br /> |4<br /> |Bugfix: Reload page if email is nil or empty on &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view<br /> |An empty email parameter was causing the send password button to freeze. This was beyond the scope of our work but we wanted to improve the page functionality. <br /> |[https://github.com/expertiza/expertiza/commit/70f77ac851b234f840709859dc1ee9d6725c34fc Commit]<br /> |-<br /> |5<br /> |Improve overall comments and rewrite error messages<br /> |The comments and error messages in the controller need to be more meaningful, specific and clear.<br /> |[https://github.com/expertiza/expertiza/commit/1af745dc3b59641cb0266ebe49ee996718381fd0 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Move logger messages to &lt;code&gt;before_action&lt;/code&gt; blocks wherever possible<br /> |Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either &lt;code&gt;before_action&lt;/code&gt; or &lt;code&gt;after_action&lt;/code&gt; blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.<br /> |[https://github.com/greyfiles/expertiza/commit/7069f5d3cbfa2b7259e85e39dbfbf6fb41a0ce1d Commit]<br /> |-<br /> |2<br /> |*Not in required chagnes* Replaced repeated code for re-caching the user role<br /> |We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called &lt;code&gt;self.rebuild_role_cache&lt;/code&gt;.<br /> |[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]<br /> |-<br /> |3<br /> |Improved helper function names<br /> |Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.<br /> |[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Added two new RSpec tests for the &lt;code&gt;send_password&lt;/code&gt; method to check nil or blank input for email<br /> |There were no tests for the &lt;code&gt;send_password&lt;/code&gt; method pertaining to checking invalid inputs in the request params<br /> |[https://github.com/greyfiles/expertiza/commit/1d2d2d94ef730ab427bb326049bc5ec800a0dfc9 Commit]&lt;br&gt;[https://github.com/greyfiles/expertiza/commit/781d6f42ca37829e0e514de8bcef1c85b2a035a2 Commit]<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Created a file to host the &lt;code&gt;password_retrieval_controller_spec.rb&lt;/code&gt; fixtures<br /> |We implemented factories in the rspec test file to improve modularity and code readability.<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]<br /> |-<br /> |}<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147703 2023-03-22T01:19:37Z

<p>Vspande: /* Files Modified */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Replaced repeated code in lines 35-36 and 62-63<br /> |The use of repeated code violates the DRY principle and so it was moved to a new method.<br /> |[https://github.com/expertiza/expertiza/commit/5429abd6fcb39f7bdbb0aaa1813f19c8101d7e25 Commit]<br /> |-<br /> |3<br /> |Change token expiration time to constant in line 41<br /> |This time should not be hardwired; it should be a constant or a parameter. <br /> |[https://github.com/expertiza/expertiza/commit/3f0b51f6f2f106df8338483396a95d4068e39c7f Commit]<br /> |-<br /> |4<br /> |Bugfix: Reload page if email is nil or empty on &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view<br /> |An empty email parameter was causing the send password button to freeze. This was beyond the scope of our work but we wanted to improve the page functionality. <br /> |[https://github.com/expertiza/expertiza/commit/70f77ac851b234f840709859dc1ee9d6725c34fc Commit]<br /> |-<br /> |5<br /> |Improve overall comments and rewrite error messages<br /> |The comments and error messages in the controller need to be more meaningful, specific and clear.<br /> |[https://github.com/expertiza/expertiza/commit/1af745dc3b59641cb0266ebe49ee996718381fd0 Commit]<br /> |}<br /> <br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Move logger messages to &lt;code&gt;before_action&lt;/code&gt; blocks wherever possible<br /> |Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either &lt;code&gt;before_action&lt;/code&gt; or &lt;code&gt;after_action&lt;/code&gt; blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.<br /> |[https://github.com/greyfiles/expertiza/commit/7069f5d3cbfa2b7259e85e39dbfbf6fb41a0ce1d Commit]<br /> |-<br /> |2<br /> |*Not in required chagnes* Replaced repeated code for re-caching the user role<br /> |We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called &lt;code&gt;self.rebuild_role_cache&lt;/code&gt;.<br /> |[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]<br /> |-<br /> |3<br /> |Improved helper function names<br /> |Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.<br /> |[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Added two new RSpec tests for the &lt;code&gt;send_password&lt;/code&gt; method to check nil or blank input for email<br /> |There were no tests for the &lt;code&gt;send_password&lt;/code&gt; method pertaining to checking invalid inputs in the request params<br /> |[https://github.com/greyfiles/expertiza/commit/1d2d2d94ef730ab427bb326049bc5ec800a0dfc9 Commit]&lt;br&gt;[https://github.com/greyfiles/expertiza/commit/781d6f42ca37829e0e514de8bcef1c85b2a035a2 Commit]<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Created a file to host the &lt;code&gt;password_retrieval_controller_spec.rb&lt;/code&gt; fixtures<br /> |We implemented factories in the rspec test file to improve modularity and code readability.<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]<br /> |-<br /> |}<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147699 2023-03-22T01:13:32Z

<p>Vspande: /* Files Modified */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Replaced repeated code in lines 35-36 and 62-63<br /> |The use of repeated code violates the DRY principle and so it was moved to a new method.<br /> |[https://github.com/expertiza/expertiza/commit/5429abd6fcb39f7bdbb0aaa1813f19c8101d7e25 Commit]<br /> |-<br /> |3<br /> |Change token expiration time to constant in line 41<br /> |This time should not be hardwired; it should be a constant or a parameter. <br /> |[https://github.com/expertiza/expertiza/commit/3f0b51f6f2f106df8338483396a95d4068e39c7f Commit]<br /> |-<br /> |4<br /> |Bugfix: Reload page if email is nil or empty on &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view<br /> |An empty email parameter was causing the send password button to freeze. This was beyond the scope of our work but we wanted to improve the page functionality. <br /> |[https://github.com/expertiza/expertiza/commit/70f77ac851b234f840709859dc1ee9d6725c34fc Commit]<br /> |-<br /> |5<br /> |Improve overall comments and rewrite error messages<br /> |The comments and error messages in the controller need to be more meaningful, specific and clear.<br /> |[https://github.com/expertiza/expertiza/commit/1af745dc3b59641cb0266ebe49ee996718381fd0 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Added two new RSpec tests for the &lt;code&gt;send_password&lt;/code&gt; method to check nil or blank input for email<br /> |There were no tests for the &lt;code&gt;send_password&lt;/code&gt; method pertaining to checking invalid inputs in the request params<br /> |[https://github.com/greyfiles/expertiza/commit/1d2d2d94ef730ab427bb326049bc5ec800a0dfc9 Commit]&lt;br&gt;[https://github.com/greyfiles/expertiza/commit/781d6f42ca37829e0e514de8bcef1c85b2a035a2 Commit]<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Created a file to host the &lt;code&gt;password_retrieval_controller_spec.rb&lt;/code&gt; fixtures<br /> |We implemented factories in the rspec test file to improve modularity and code readability.<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Move logger messages to &lt;code&gt;before_action&lt;/code&gt; blocks wherever possible<br /> |Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either &lt;code&gt;before_action&lt;/code&gt; or &lt;code&gt;after_action&lt;/code&gt; blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.<br /> |[https://github.com/greyfiles/expertiza/commit/7069f5d3cbfa2b7259e85e39dbfbf6fb41a0ce1d Commit]<br /> |-<br /> |2<br /> |*Not in required chagnes* Replaced repeated code for re-caching the user role<br /> |We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called &lt;code&gt;self.rebuild_role_cache&lt;/code&gt;.<br /> |[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]<br /> |-<br /> |3<br /> |Improved helper function names<br /> |Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.<br /> |[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147697 2023-03-22T01:12:21Z

<p>Vspande: /* Changes to spec/controllers/auth_controller_spec.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Replaced repeated code in lines 35-36 and 62-63<br /> |The use of repeated code violates the DRY principle and so it was moved to a new method.<br /> |[https://github.com/expertiza/expertiza/commit/5429abd6fcb39f7bdbb0aaa1813f19c8101d7e25 Commit]<br /> |-<br /> |3<br /> |Change token expiration time to constant in line 41<br /> |This time should not be hardwired; it should be a constant or a parameter. <br /> |[https://github.com/expertiza/expertiza/commit/3f0b51f6f2f106df8338483396a95d4068e39c7f Commit]<br /> |-<br /> |4<br /> |Bugfix: Reload page if email is nil or empty on &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view<br /> |An empty email parameter was causing the send password button to freeze. This was beyond the scope of our work but we wanted to improve the page functionality. <br /> |[https://github.com/expertiza/expertiza/commit/70f77ac851b234f840709859dc1ee9d6725c34fc Commit]<br /> |-<br /> |5<br /> |Improve overall comments and rewrite error messages<br /> |The comments and error messages in the controller need to be more meaningful, specific and clear.<br /> |[https://github.com/expertiza/expertiza/commit/1af745dc3b59641cb0266ebe49ee996718381fd0 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Added two new RSpec tests for the &lt;code&gt;send_password&lt;/code&gt; method to check nil or blank input for email<br /> |There were no tests for the &lt;code&gt;send_password&lt;/code&gt; method pertaining to checking invalid inputs in the request params<br /> |[https://github.com/greyfiles/expertiza/commit/1d2d2d94ef730ab427bb326049bc5ec800a0dfc9 Commit]&lt;br&gt;[https://github.com/greyfiles/expertiza/commit/781d6f42ca37829e0e514de8bcef1c85b2a035a2 Commit]<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Created a file to host the &lt;code&gt;password_retrieval_controller_spec.rb&lt;/code&gt; fixtures<br /> |We implemented factories in the rspec test file to improve modularity and code readability.<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;config/routes.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Updated URL path and controller action to updated method name &lt;code&gt;check_token_validity&lt;/code&gt;<br /> |The action and URL path must be renamed to generate pathing to the controller method and views.<br /> |[https://github.com/expertiza/expertiza/commit/3f9f63ab51e90743dfab0b860574aa9b673f2717 Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Move logger messages to &lt;code&gt;before_action&lt;/code&gt; blocks wherever possible<br /> |Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either &lt;code&gt;before_action&lt;/code&gt; or &lt;code&gt;after_action&lt;/code&gt; blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.<br /> |[https://github.com/greyfiles/expertiza/commit/7069f5d3cbfa2b7259e85e39dbfbf6fb41a0ce1d Commit]<br /> |-<br /> |2<br /> |*Not in required chagnes* Replaced repeated code for re-caching the user role<br /> |We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called &lt;code&gt;self.rebuild_role_cache&lt;/code&gt;.<br /> |[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]<br /> |-<br /> |3<br /> |Improved helper function names<br /> |Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.<br /> |[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_team_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147696 2023-03-22T01:11:45Z

<p>Vspande: /* Changes to app/controllers/auth_controller.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Replaced repeated code in lines 35-36 and 62-63<br /> |The use of repeated code violates the DRY principle and so it was moved to a new method.<br /> |[https://github.com/expertiza/expertiza/commit/5429abd6fcb39f7bdbb0aaa1813f19c8101d7e25 Commit]<br /> |-<br /> |3<br /> |Change token expiration time to constant in line 41<br /> |This time should not be hardwired; it should be a constant or a parameter. <br /> |[https://github.com/expertiza/expertiza/commit/3f0b51f6f2f106df8338483396a95d4068e39c7f Commit]<br /> |-<br /> |4<br /> |Bugfix: Reload page if email is nil or empty on &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view<br /> |An empty email parameter was causing the send password button to freeze. This was beyond the scope of our work but we wanted to improve the page functionality. <br /> |[https://github.com/expertiza/expertiza/commit/70f77ac851b234f840709859dc1ee9d6725c34fc Commit]<br /> |-<br /> |5<br /> |Improve overall comments and rewrite error messages<br /> |The comments and error messages in the controller need to be more meaningful, specific and clear.<br /> |[https://github.com/expertiza/expertiza/commit/1af745dc3b59641cb0266ebe49ee996718381fd0 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Added two new RSpec tests for the &lt;code&gt;send_password&lt;/code&gt; method to check nil or blank input for email<br /> |There were no tests for the &lt;code&gt;send_password&lt;/code&gt; method pertaining to checking invalid inputs in the request params<br /> |[https://github.com/greyfiles/expertiza/commit/1d2d2d94ef730ab427bb326049bc5ec800a0dfc9 Commit]&lt;br&gt;[https://github.com/greyfiles/expertiza/commit/781d6f42ca37829e0e514de8bcef1c85b2a035a2 Commit]<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Created a file to host the &lt;code&gt;password_retrieval_controller_spec.rb&lt;/code&gt; fixtures<br /> |We implemented factories in the rspec test file to improve modularity and code readability.<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;config/routes.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Updated URL path and controller action to updated method name &lt;code&gt;check_token_validity&lt;/code&gt;<br /> |The action and URL path must be renamed to generate pathing to the controller method and views.<br /> |[https://github.com/expertiza/expertiza/commit/3f9f63ab51e90743dfab0b860574aa9b673f2717 Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/models/course_team.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Move logger messages to &lt;code&gt;before_action&lt;/code&gt; blocks wherever possible<br /> |Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either &lt;code&gt;before_action&lt;/code&gt; or &lt;code&gt;after_action&lt;/code&gt; blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.<br /> |[https://github.com/greyfiles/expertiza/commit/7069f5d3cbfa2b7259e85e39dbfbf6fb41a0ce1d Commit]<br /> |-<br /> |2<br /> |*Not in required chagnes* Replaced repeated code for re-caching the user role<br /> |We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called &lt;code&gt;self.rebuild_role_cache&lt;/code&gt;.<br /> |[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]<br /> |-<br /> |3<br /> |Improved helper function names<br /> |Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.<br /> |[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/controllers/auth_controller_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147695 2023-03-22T01:10:14Z

<p>Vspande: /* Changes to spec/factories/password_retrieval_factory.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Replaced repeated code in lines 35-36 and 62-63<br /> |The use of repeated code violates the DRY principle and so it was moved to a new method.<br /> |[https://github.com/expertiza/expertiza/commit/5429abd6fcb39f7bdbb0aaa1813f19c8101d7e25 Commit]<br /> |-<br /> |3<br /> |Change token expiration time to constant in line 41<br /> |This time should not be hardwired; it should be a constant or a parameter. <br /> |[https://github.com/expertiza/expertiza/commit/3f0b51f6f2f106df8338483396a95d4068e39c7f Commit]<br /> |-<br /> |4<br /> |Bugfix: Reload page if email is nil or empty on &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view<br /> |An empty email parameter was causing the send password button to freeze. This was beyond the scope of our work but we wanted to improve the page functionality. <br /> |[https://github.com/expertiza/expertiza/commit/70f77ac851b234f840709859dc1ee9d6725c34fc Commit]<br /> |-<br /> |5<br /> |Improve overall comments and rewrite error messages<br /> |The comments and error messages in the controller need to be more meaningful, specific and clear.<br /> |[https://github.com/expertiza/expertiza/commit/1af745dc3b59641cb0266ebe49ee996718381fd0 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Added two new RSpec tests for the &lt;code&gt;send_password&lt;/code&gt; method to check nil or blank input for email<br /> |There were no tests for the &lt;code&gt;send_password&lt;/code&gt; method pertaining to checking invalid inputs in the request params<br /> |[https://github.com/greyfiles/expertiza/commit/1d2d2d94ef730ab427bb326049bc5ec800a0dfc9 Commit]&lt;br&gt;[https://github.com/greyfiles/expertiza/commit/781d6f42ca37829e0e514de8bcef1c85b2a035a2 Commit]<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/teams_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Created a file to host the &lt;code&gt;password_retrieval_controller_spec.rb&lt;/code&gt; fixtures<br /> |We implemented factories in the rspec test file to improve modularity and code readability.<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;config/routes.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Updated URL path and controller action to updated method name &lt;code&gt;check_token_validity&lt;/code&gt;<br /> |The action and URL path must be renamed to generate pathing to the controller method and views.<br /> |[https://github.com/expertiza/expertiza/commit/3f9f63ab51e90743dfab0b860574aa9b673f2717 Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/auth_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Move logger messages to &lt;code&gt;before_action&lt;/code&gt; blocks wherever possible<br /> |Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either &lt;code&gt;before_action&lt;/code&gt; or &lt;code&gt;after_action&lt;/code&gt; blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.<br /> |[https://github.com/greyfiles/expertiza/commit/7069f5d3cbfa2b7259e85e39dbfbf6fb41a0ce1d Commit]<br /> |-<br /> |2<br /> |*Not in required chagnes* Replaced repeated code for re-caching the user role<br /> |We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called &lt;code&gt;self.rebuild_role_cache&lt;/code&gt;.<br /> |[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]<br /> |-<br /> |3<br /> |Improved helper function names<br /> |Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.<br /> |[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/controllers/auth_controller_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147693 2023-03-22T00:54:46Z

<p>Vspande: /* Contributors to this project */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Replaced repeated code in lines 35-36 and 62-63<br /> |The use of repeated code violates the DRY principle and so it was moved to a new method.<br /> |[https://github.com/expertiza/expertiza/commit/5429abd6fcb39f7bdbb0aaa1813f19c8101d7e25 Commit]<br /> |-<br /> |3<br /> |Change token expiration time to constant in line 41<br /> |This time should not be hardwired; it should be a constant or a parameter. <br /> |[https://github.com/expertiza/expertiza/commit/3f0b51f6f2f106df8338483396a95d4068e39c7f Commit]<br /> |-<br /> |4<br /> |Bugfix: Reload page if email is nil or empty on &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view<br /> |An empty email parameter was causing the send password button to freeze. This was beyond the scope of our work but we wanted to improve the page functionality. <br /> |[https://github.com/expertiza/expertiza/commit/70f77ac851b234f840709859dc1ee9d6725c34fc Commit]<br /> |-<br /> |5<br /> |Improve overall comments and rewrite error messages<br /> |The comments and error messages in the controller need to be more meaningful, specific and clear.<br /> |[https://github.com/expertiza/expertiza/commit/1af745dc3b59641cb0266ebe49ee996718381fd0 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Added two new RSpec tests for the &lt;code&gt;send_password&lt;/code&gt; method to check nil or blank input for email<br /> |There were no tests for the &lt;code&gt;send_password&lt;/code&gt; method pertaining to checking invalid inputs in the request params<br /> |[https://github.com/greyfiles/expertiza/commit/1d2d2d94ef730ab427bb326049bc5ec800a0dfc9 Commit]&lt;br&gt;[https://github.com/greyfiles/expertiza/commit/781d6f42ca37829e0e514de8bcef1c85b2a035a2 Commit]<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/factories/password_retrieval_factory.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Created a file to host the &lt;code&gt;password_retrieval_controller_spec.rb&lt;/code&gt; fixtures<br /> |We implemented factories in the rspec test file to improve modularity and code readability.<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;config/routes.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Updated URL path and controller action to updated method name &lt;code&gt;check_token_validity&lt;/code&gt;<br /> |The action and URL path must be renamed to generate pathing to the controller method and views.<br /> |[https://github.com/expertiza/expertiza/commit/3f9f63ab51e90743dfab0b860574aa9b673f2717 Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/auth_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Move logger messages to &lt;code&gt;before_action&lt;/code&gt; blocks wherever possible<br /> |Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either &lt;code&gt;before_action&lt;/code&gt; or &lt;code&gt;after_action&lt;/code&gt; blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.<br /> |[https://github.com/greyfiles/expertiza/commit/7069f5d3cbfa2b7259e85e39dbfbf6fb41a0ce1d Commit]<br /> |-<br /> |2<br /> |*Not in required chagnes* Replaced repeated code for re-caching the user role<br /> |We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called &lt;code&gt;self.rebuild_role_cache&lt;/code&gt;.<br /> |[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]<br /> |-<br /> |3<br /> |Improved helper function names<br /> |Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.<br /> |[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/controllers/auth_controller_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147691 2023-03-22T00:51:25Z

<p>Vspande: /* Relevant Links */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Replaced repeated code in lines 35-36 and 62-63<br /> |The use of repeated code violates the DRY principle and so it was moved to a new method.<br /> |[https://github.com/expertiza/expertiza/commit/5429abd6fcb39f7bdbb0aaa1813f19c8101d7e25 Commit]<br /> |-<br /> |3<br /> |Change token expiration time to constant in line 41<br /> |This time should not be hardwired; it should be a constant or a parameter. <br /> |[https://github.com/expertiza/expertiza/commit/3f0b51f6f2f106df8338483396a95d4068e39c7f Commit]<br /> |-<br /> |4<br /> |Bugfix: Reload page if email is nil or empty on &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view<br /> |An empty email parameter was causing the send password button to freeze. This was beyond the scope of our work but we wanted to improve the page functionality. <br /> |[https://github.com/expertiza/expertiza/commit/70f77ac851b234f840709859dc1ee9d6725c34fc Commit]<br /> |-<br /> |5<br /> |Improve overall comments and rewrite error messages<br /> |The comments and error messages in the controller need to be more meaningful, specific and clear.<br /> |[https://github.com/expertiza/expertiza/commit/1af745dc3b59641cb0266ebe49ee996718381fd0 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Added two new RSpec tests for the &lt;code&gt;send_password&lt;/code&gt; method to check nil or blank input for email<br /> |There were no tests for the &lt;code&gt;send_password&lt;/code&gt; method pertaining to checking invalid inputs in the request params<br /> |[https://github.com/greyfiles/expertiza/commit/1d2d2d94ef730ab427bb326049bc5ec800a0dfc9 Commit]&lt;br&gt;[https://github.com/greyfiles/expertiza/commit/781d6f42ca37829e0e514de8bcef1c85b2a035a2 Commit]<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/factories/password_retrieval_factory.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Created a file to host the &lt;code&gt;password_retrieval_controller_spec.rb&lt;/code&gt; fixtures<br /> |We implemented factories in the rspec test file to improve modularity and code readability.<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;config/routes.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Updated URL path and controller action to updated method name &lt;code&gt;check_token_validity&lt;/code&gt;<br /> |The action and URL path must be renamed to generate pathing to the controller method and views.<br /> |[https://github.com/expertiza/expertiza/commit/3f9f63ab51e90743dfab0b860574aa9b673f2717 Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/auth_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Move logger messages to &lt;code&gt;before_action&lt;/code&gt; blocks wherever possible<br /> |Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either &lt;code&gt;before_action&lt;/code&gt; or &lt;code&gt;after_action&lt;/code&gt; blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.<br /> |[https://github.com/greyfiles/expertiza/commit/7069f5d3cbfa2b7259e85e39dbfbf6fb41a0ce1d Commit]<br /> |-<br /> |2<br /> |*Not in required chagnes* Replaced repeated code for re-caching the user role<br /> |We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called &lt;code&gt;self.rebuild_role_cache&lt;/code&gt;.<br /> |[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]<br /> |-<br /> |3<br /> |Improved helper function names<br /> |Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.<br /> |[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/controllers/auth_controller_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548<br /> * '''VCL Server:''' http://152.7.178.105:8080/<br /> <br /> == Contributors to this project ==<br /> * Grey Files (unityid: mgfiles, github: greyfiles)<br /> * Colin O'Dowd (unityid: cdodowd, github: colin-odowd)<br /> * Pradyumna Khawas (unityid: ppkhawas, github: therealppk)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147685 2023-03-22T00:42:17Z

<p>Vspande: </p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Replaced repeated code in lines 35-36 and 62-63<br /> |The use of repeated code violates the DRY principle and so it was moved to a new method.<br /> |[https://github.com/expertiza/expertiza/commit/5429abd6fcb39f7bdbb0aaa1813f19c8101d7e25 Commit]<br /> |-<br /> |3<br /> |Change token expiration time to constant in line 41<br /> |This time should not be hardwired; it should be a constant or a parameter. <br /> |[https://github.com/expertiza/expertiza/commit/3f0b51f6f2f106df8338483396a95d4068e39c7f Commit]<br /> |-<br /> |4<br /> |Bugfix: Reload page if email is nil or empty on &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view<br /> |An empty email parameter was causing the send password button to freeze. This was beyond the scope of our work but we wanted to improve the page functionality. <br /> |[https://github.com/expertiza/expertiza/commit/70f77ac851b234f840709859dc1ee9d6725c34fc Commit]<br /> |-<br /> |5<br /> |Improve overall comments and rewrite error messages<br /> |The comments and error messages in the controller need to be more meaningful, specific and clear.<br /> |[https://github.com/expertiza/expertiza/commit/1af745dc3b59641cb0266ebe49ee996718381fd0 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Added two new RSpec tests for the &lt;code&gt;send_password&lt;/code&gt; method to check nil or blank input for email<br /> |There were no tests for the &lt;code&gt;send_password&lt;/code&gt; method pertaining to checking invalid inputs in the request params<br /> |[https://github.com/greyfiles/expertiza/commit/1d2d2d94ef730ab427bb326049bc5ec800a0dfc9 Commit]&lt;br&gt;[https://github.com/greyfiles/expertiza/commit/781d6f42ca37829e0e514de8bcef1c85b2a035a2 Commit]<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/factories/password_retrieval_factory.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Created a file to host the &lt;code&gt;password_retrieval_controller_spec.rb&lt;/code&gt; fixtures<br /> |We implemented factories in the rspec test file to improve modularity and code readability.<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;config/routes.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Updated URL path and controller action to updated method name &lt;code&gt;check_token_validity&lt;/code&gt;<br /> |The action and URL path must be renamed to generate pathing to the controller method and views.<br /> |[https://github.com/expertiza/expertiza/commit/3f9f63ab51e90743dfab0b860574aa9b673f2717 Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/auth_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Move logger messages to &lt;code&gt;before_action&lt;/code&gt; blocks wherever possible<br /> |Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either &lt;code&gt;before_action&lt;/code&gt; or &lt;code&gt;after_action&lt;/code&gt; blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.<br /> |[https://github.com/greyfiles/expertiza/commit/7069f5d3cbfa2b7259e85e39dbfbf6fb41a0ce1d Commit]<br /> |-<br /> |2<br /> |*Not in required chagnes* Replaced repeated code for re-caching the user role<br /> |We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called &lt;code&gt;self.rebuild_role_cache&lt;/code&gt;.<br /> |[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]<br /> |-<br /> |3<br /> |Improved helper function names<br /> |Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.<br /> |[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/controllers/auth_controller_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/greyfiles/expertiza<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2460<br /> * '''VCL Server:''' http://152.7.98.115:8080/<br /> <br /> == Contributors to this project ==<br /> * Grey Files (unityid: mgfiles, github: greyfiles)<br /> * Colin O'Dowd (unityid: cdodowd, github: colin-odowd)<br /> * Pradyumna Khawas (unityid: ppkhawas, github: therealppk)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147419 2023-03-19T17:23:00Z

<p>Vspande: /* Files Modified */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt; and not from anywhere else. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Replaced repeated code in lines 35-36 and 62-63<br /> |The use of repeated code violates the DRY principle and so it was moved to a new method.<br /> |[https://github.com/expertiza/expertiza/commit/5429abd6fcb39f7bdbb0aaa1813f19c8101d7e25 Commit]<br /> |-<br /> |3<br /> |Change token expiration time to constant in line 41<br /> |This time should not be hardwired; it should be a constant or a parameter. <br /> |[https://github.com/expertiza/expertiza/commit/3f0b51f6f2f106df8338483396a95d4068e39c7f Commit]<br /> |-<br /> |4<br /> |Bugfix: Reload page if email is nil or empty on &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view<br /> |An empty email parameter was causing the send password button to freeze. This was beyond the scope of our work but we wanted to improve the page functionality. <br /> |[https://github.com/expertiza/expertiza/commit/70f77ac851b234f840709859dc1ee9d6725c34fc Commit]<br /> |-<br /> |5<br /> |Improve overall comments and rewrite error messages<br /> |The comments and error messages in the controller need to be more meaningful, specific and clear.<br /> |[https://github.com/expertiza/expertiza/commit/1af745dc3b59641cb0266ebe49ee996718381fd0 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Added two new RSpec tests for the &lt;code&gt;send_password&lt;/code&gt; method to check nil or blank input for email<br /> |There were no tests for the &lt;code&gt;send_password&lt;/code&gt; method pertaining to checking invalid inputs in the request params<br /> |[https://github.com/greyfiles/expertiza/commit/1d2d2d94ef730ab427bb326049bc5ec800a0dfc9 Commit]&lt;br&gt;[https://github.com/greyfiles/expertiza/commit/781d6f42ca37829e0e514de8bcef1c85b2a035a2 Commit]<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/factories/password_retrieval_factory.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Created a file to host the &lt;code&gt;password_retrieval_controller_spec.rb&lt;/code&gt; fixtures<br /> |We implemented factories in the rspec test file to improve modularity and code readability.<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;config/routes.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Updated URL path and controller action to updated method name &lt;code&gt;check_token_validity&lt;/code&gt;<br /> |The action and URL path must be renamed to generate pathing to the controller method and views.<br /> |[https://github.com/expertiza/expertiza/commit/3f9f63ab51e90743dfab0b860574aa9b673f2717 Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/auth_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Move logger messages to &lt;code&gt;before_action&lt;/code&gt; blocks wherever possible<br /> |Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either &lt;code&gt;before_action&lt;/code&gt; or &lt;code&gt;after_action&lt;/code&gt; blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.<br /> |[https://github.com/greyfiles/expertiza/commit/7069f5d3cbfa2b7259e85e39dbfbf6fb41a0ce1d Commit]<br /> |-<br /> |2<br /> |*Not in required chagnes* Replaced repeated code for re-caching the user role<br /> |We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called &lt;code&gt;self.rebuild_role_cache&lt;/code&gt;.<br /> |[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]<br /> |-<br /> |3<br /> |Improved helper function names<br /> |Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.<br /> |[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/controllers/auth_controller_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> == Testing ==<br /> <br /> '''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 &lt;code&gt;main&lt;/code&gt; Expertiza branch. In the second submission phase, we plan to further enhance the testing suite of the &lt;code&gt;auth_controller.rb&lt;/code&gt; and &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt; through factories and fixtures.''' <br /> <br /> === Test Plan - Manual/System Test Cases ===<br /> 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 &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt; is difficult for us to test because we don't have access to the email used to make the sample account, but the &lt;code&gt;auth_controller.rb&lt;/code&gt; is very testable. Below is the tests we completed listed in the order of completion.<br /> <br /> ==== 1) Test instructor login &amp; redirect to home page ====<br /> When navigating to the expertiza website, our branch correctly displayed the login page as shown below.<br /> [[File:before_login.png|center|border|Form shown to the user before logging in to expertiza]]<br /> After typing in the sample login credentials of &quot;instructor6&quot; and &quot;password,&quot; the user is then correctly logged in and redirected to the home page for instructors shown below.<br /> [[File:after_login.png|center|border|1400px|Page shown to the user after logging in to expertiza]]<br /> ==== 2) Test instructor logout &amp; redirect to login page ====<br /> Then, when the user clicks the logout button, they are correctly logged out and redirected once again to the login page as shown below.<br /> [[File:after_logout.png|center|border|Form shown to the user after logging out of expertiza]]<br /> ==== 3) Test incorrect login ====<br /> When the user attempts to login but enters the incorrect login information of &quot;instructor6&quot; and &quot;incorrect,&quot; the user is shown the error message and then correctly redirected to the forgot password page shown below.<br /> [[File:after_incorrect_login.png|center|border|1400px|Form shown to the user after an incorrect login attempt to expertiza]]<br /> <br /> <br /> === Automated Testing of &lt;code&gt;auth_controller_.rb&lt;/code&gt; ===<br /> Before any refactoring to &lt;code&gt;auth_controller.rb&lt;/code&gt; was done, we ran the rspec tests created for the controller with the following command: &lt;code&gt;rspec spec/controllers/auth_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:before_refactor_auth_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]<br /> <br /> After making all of the above changes to &lt;code&gt;auth_controller.rb&lt;/code&gt;, we ran the rspec tests for the controller again with the command: &lt;code&gt;rspec spec/controllers/auth_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:after_refactor_auth_controller.png|center|frame|rspec tests continuing to all pass after completing the refactoring]]<br /> <br /> We have successfully preserved the passing tests after the improvements we made to the &lt;code&gt;auth_controller.rb&lt;/code&gt;. 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 &lt;code&gt;auth_controller_spec.rb&lt;/code&gt;. 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: &lt;code&gt;rspec spec/controllers/auth_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:after_improving_auth_controller_spec.png|center|frame|rspec tests continuing to all pass after improving and adding to the auth_controller tests]]<br /> <br /> Tests prior to the changes covered 91.94% of &lt;code&gt;auth_controller.rb&lt;/code&gt;.<br /> [[File:coverage_before.png|center|frame|rspec test coverage report before the improvements to the auth_controller unit tests]]<br /> <br /> 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 &lt;code&gt;auth_controller.rb&lt;/code&gt;. It improved slightly to be an even better coverage.<br /> [[File:coverage_after.png|center|frame|rspec test coverage report after the improvements to the auth_controller unit tests]]<br /> <br /> === Automated Testing of &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt; ===<br /> Before any refactoring to &lt;code&gt;passsword_retrieval_controller.rb&lt;/code&gt; was done, we ran the rspec tests created for the controller with the following command: &lt;code&gt;rspec spec/controllers/password_retrieval_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:before_refactor_password_retrieval_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]<br /> <br /> Tests prior to the changes covered 63.3% of &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt;.<br /> [[File:E2252_password_retrieval_coverage_report_before.png|center|frame|rspec test coverage report before the refactoring was completed]]<br /> <br /> After adding tests, the tests covered 91.1% of &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt;.<br /> [[File:E2252_password_retrieval_coverage_report_after.png|center|frame|rspec test coverage report after the refactoring was completed]]<br /> <br /> 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. <br /> [[File:prefactory.png|center|frame|rspec tests before factories were implemented]] &lt;br&gt;<br /> [[File:postfactory.png|center|frame|rspec tests after factories were implemented]]<br /> <br /> The below image shows the output of the following command after all tests were added: &lt;code&gt;rspec spec/controllers/password_retrieval_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:After refactor password retrieval controller.png|center|frame|rspec tests all passing after the refactoring was completed]]<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/greyfiles/expertiza<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2460<br /> * '''VCL Server:''' http://152.7.98.115:8080/<br /> <br /> == Contributors to this project ==<br /> * Grey Files (unityid: mgfiles, github: greyfiles)<br /> * Colin O'Dowd (unityid: cdodowd, github: colin-odowd)<br /> * Pradyumna Khawas (unityid: ppkhawas, github: therealppk)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147418 2023-03-19T17:21:55Z

<p>Vspande: /* Changes to spec/controllers/password_retrieval_controller_spec.rb */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt;. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Replaced repeated code in lines 35-36 and 62-63<br /> |The use of repeated code violates the DRY principle and so it was moved to a new method.<br /> |[https://github.com/expertiza/expertiza/commit/5429abd6fcb39f7bdbb0aaa1813f19c8101d7e25 Commit]<br /> |-<br /> |3<br /> |Change token expiration time to constant in line 41<br /> |This time should not be hardwired; it should be a constant or a parameter. <br /> |[https://github.com/expertiza/expertiza/commit/3f0b51f6f2f106df8338483396a95d4068e39c7f Commit]<br /> |-<br /> |4<br /> |Bugfix: Reload page if email is nil or empty on &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view<br /> |An empty email parameter was causing the send password button to freeze. This was beyond the scope of our work but we wanted to improve the page functionality. <br /> |[https://github.com/expertiza/expertiza/commit/70f77ac851b234f840709859dc1ee9d6725c34fc Commit]<br /> |-<br /> |5<br /> |Improve overall comments and rewrite error messages<br /> |The comments and error messages in the controller need to be more meaningful, specific and clear.<br /> |[https://github.com/expertiza/expertiza/commit/1af745dc3b59641cb0266ebe49ee996718381fd0 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/models/course_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Removed the test case for &lt;code&gt;get_paprticipant&lt;/code&gt; method<br /> |Removed the test case for &lt;code&gt;get_participant&lt;/code&gt; method as the method was not used anywhere else in the code.<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |Added two new RSpec tests for the &lt;code&gt;send_password&lt;/code&gt; method to check nil or blank input for email<br /> |There were no tests for the &lt;code&gt;send_password&lt;/code&gt; method pertaining to checking invalid inputs in the request params<br /> |[https://github.com/greyfiles/expertiza/commit/1d2d2d94ef730ab427bb326049bc5ec800a0dfc9 Commit]&lt;br&gt;[https://github.com/greyfiles/expertiza/commit/781d6f42ca37829e0e514de8bcef1c85b2a035a2 Commit]<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/factories/password_retrieval_factory.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Created a file to host the &lt;code&gt;password_retrieval_controller_spec.rb&lt;/code&gt; fixtures<br /> |We implemented factories in the rspec test file to improve modularity and code readability.<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;config/routes.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Updated URL path and controller action to updated method name &lt;code&gt;check_token_validity&lt;/code&gt;<br /> |The action and URL path must be renamed to generate pathing to the controller method and views.<br /> |[https://github.com/expertiza/expertiza/commit/3f9f63ab51e90743dfab0b860574aa9b673f2717 Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/auth_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Move logger messages to &lt;code&gt;before_action&lt;/code&gt; blocks wherever possible<br /> |Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either &lt;code&gt;before_action&lt;/code&gt; or &lt;code&gt;after_action&lt;/code&gt; blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.<br /> |[https://github.com/greyfiles/expertiza/commit/7069f5d3cbfa2b7259e85e39dbfbf6fb41a0ce1d Commit]<br /> |-<br /> |2<br /> |*Not in required chagnes* Replaced repeated code for re-caching the user role<br /> |We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called &lt;code&gt;self.rebuild_role_cache&lt;/code&gt;.<br /> |[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]<br /> |-<br /> |3<br /> |Improved helper function names<br /> |Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.<br /> |[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/controllers/auth_controller_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> == Testing ==<br /> <br /> '''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 &lt;code&gt;main&lt;/code&gt; Expertiza branch. In the second submission phase, we plan to further enhance the testing suite of the &lt;code&gt;auth_controller.rb&lt;/code&gt; and &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt; through factories and fixtures.''' <br /> <br /> === Test Plan - Manual/System Test Cases ===<br /> 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 &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt; is difficult for us to test because we don't have access to the email used to make the sample account, but the &lt;code&gt;auth_controller.rb&lt;/code&gt; is very testable. Below is the tests we completed listed in the order of completion.<br /> <br /> ==== 1) Test instructor login &amp; redirect to home page ====<br /> When navigating to the expertiza website, our branch correctly displayed the login page as shown below.<br /> [[File:before_login.png|center|border|Form shown to the user before logging in to expertiza]]<br /> After typing in the sample login credentials of &quot;instructor6&quot; and &quot;password,&quot; the user is then correctly logged in and redirected to the home page for instructors shown below.<br /> [[File:after_login.png|center|border|1400px|Page shown to the user after logging in to expertiza]]<br /> ==== 2) Test instructor logout &amp; redirect to login page ====<br /> Then, when the user clicks the logout button, they are correctly logged out and redirected once again to the login page as shown below.<br /> [[File:after_logout.png|center|border|Form shown to the user after logging out of expertiza]]<br /> ==== 3) Test incorrect login ====<br /> When the user attempts to login but enters the incorrect login information of &quot;instructor6&quot; and &quot;incorrect,&quot; the user is shown the error message and then correctly redirected to the forgot password page shown below.<br /> [[File:after_incorrect_login.png|center|border|1400px|Form shown to the user after an incorrect login attempt to expertiza]]<br /> <br /> <br /> === Automated Testing of &lt;code&gt;auth_controller_.rb&lt;/code&gt; ===<br /> Before any refactoring to &lt;code&gt;auth_controller.rb&lt;/code&gt; was done, we ran the rspec tests created for the controller with the following command: &lt;code&gt;rspec spec/controllers/auth_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:before_refactor_auth_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]<br /> <br /> After making all of the above changes to &lt;code&gt;auth_controller.rb&lt;/code&gt;, we ran the rspec tests for the controller again with the command: &lt;code&gt;rspec spec/controllers/auth_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:after_refactor_auth_controller.png|center|frame|rspec tests continuing to all pass after completing the refactoring]]<br /> <br /> We have successfully preserved the passing tests after the improvements we made to the &lt;code&gt;auth_controller.rb&lt;/code&gt;. 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 &lt;code&gt;auth_controller_spec.rb&lt;/code&gt;. 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: &lt;code&gt;rspec spec/controllers/auth_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:after_improving_auth_controller_spec.png|center|frame|rspec tests continuing to all pass after improving and adding to the auth_controller tests]]<br /> <br /> Tests prior to the changes covered 91.94% of &lt;code&gt;auth_controller.rb&lt;/code&gt;.<br /> [[File:coverage_before.png|center|frame|rspec test coverage report before the improvements to the auth_controller unit tests]]<br /> <br /> 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 &lt;code&gt;auth_controller.rb&lt;/code&gt;. It improved slightly to be an even better coverage.<br /> [[File:coverage_after.png|center|frame|rspec test coverage report after the improvements to the auth_controller unit tests]]<br /> <br /> === Automated Testing of &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt; ===<br /> Before any refactoring to &lt;code&gt;passsword_retrieval_controller.rb&lt;/code&gt; was done, we ran the rspec tests created for the controller with the following command: &lt;code&gt;rspec spec/controllers/password_retrieval_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:before_refactor_password_retrieval_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]<br /> <br /> Tests prior to the changes covered 63.3% of &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt;.<br /> [[File:E2252_password_retrieval_coverage_report_before.png|center|frame|rspec test coverage report before the refactoring was completed]]<br /> <br /> After adding tests, the tests covered 91.1% of &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt;.<br /> [[File:E2252_password_retrieval_coverage_report_after.png|center|frame|rspec test coverage report after the refactoring was completed]]<br /> <br /> 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. <br /> [[File:prefactory.png|center|frame|rspec tests before factories were implemented]] &lt;br&gt;<br /> [[File:postfactory.png|center|frame|rspec tests after factories were implemented]]<br /> <br /> The below image shows the output of the following command after all tests were added: &lt;code&gt;rspec spec/controllers/password_retrieval_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:After refactor password retrieval controller.png|center|frame|rspec tests all passing after the refactoring was completed]]<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/greyfiles/expertiza<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2460<br /> * '''VCL Server:''' http://152.7.98.115:8080/<br /> <br /> == Contributors to this project ==<br /> * Grey Files (unityid: mgfiles, github: greyfiles)<br /> * Colin O'Dowd (unityid: cdodowd, github: colin-odowd)<br /> * Pradyumna Khawas (unityid: ppkhawas, github: therealppk)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147417 2023-03-19T17:12:35Z

<p>Vspande: /* Files Modified */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt;. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Replaced repeated code in lines 35-36 and 62-63<br /> |The use of repeated code violates the DRY principle and so it was moved to a new method.<br /> |[https://github.com/expertiza/expertiza/commit/5429abd6fcb39f7bdbb0aaa1813f19c8101d7e25 Commit]<br /> |-<br /> |3<br /> |Change token expiration time to constant in line 41<br /> |This time should not be hardwired; it should be a constant or a parameter. <br /> |[https://github.com/expertiza/expertiza/commit/3f0b51f6f2f106df8338483396a95d4068e39c7f Commit]<br /> |-<br /> |4<br /> |Bugfix: Reload page if email is nil or empty on &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view<br /> |An empty email parameter was causing the send password button to freeze. This was beyond the scope of our work but we wanted to improve the page functionality. <br /> |[https://github.com/expertiza/expertiza/commit/70f77ac851b234f840709859dc1ee9d6725c34fc Commit]<br /> |-<br /> |5<br /> |Improve overall comments and rewrite error messages<br /> |The comments and error messages in the controller need to be more meaningful, specific and clear.<br /> |[https://github.com/expertiza/expertiza/commit/1af745dc3b59641cb0266ebe49ee996718381fd0 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/controllers/password_retrieval_controller_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Added two new RSpec tests for the &lt;code&gt;update_password&lt;/code&gt; method<br /> |There were no tests for the &lt;code&gt;update_password&lt;/code&gt; method. We wanted to enhance the test suite of this controller by increasing the coverage of its Rspec tests.<br /> |[https://github.com/expertiza/expertiza/commit/a90b1aada9878c7cdf7319dd022432cca8eadd2f Commit]<br /> |-<br /> |2<br /> |Added two new RSpec tests for the &lt;code&gt;send_password&lt;/code&gt; method to check nil or blank input for email<br /> |There were no tests for the &lt;code&gt;send_password&lt;/code&gt; method pertaining to checking invalid inputs in the request params<br /> |[https://github.com/greyfiles/expertiza/commit/1d2d2d94ef730ab427bb326049bc5ec800a0dfc9 Commit]&lt;br&gt;[https://github.com/greyfiles/expertiza/commit/781d6f42ca37829e0e514de8bcef1c85b2a035a2 Commit]<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/factories/password_retrieval_factory.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Created a file to host the &lt;code&gt;password_retrieval_controller_spec.rb&lt;/code&gt; fixtures<br /> |We implemented factories in the rspec test file to improve modularity and code readability.<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;config/routes.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Updated URL path and controller action to updated method name &lt;code&gt;check_token_validity&lt;/code&gt;<br /> |The action and URL path must be renamed to generate pathing to the controller method and views.<br /> |[https://github.com/expertiza/expertiza/commit/3f9f63ab51e90743dfab0b860574aa9b673f2717 Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/auth_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Move logger messages to &lt;code&gt;before_action&lt;/code&gt; blocks wherever possible<br /> |Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either &lt;code&gt;before_action&lt;/code&gt; or &lt;code&gt;after_action&lt;/code&gt; blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.<br /> |[https://github.com/greyfiles/expertiza/commit/7069f5d3cbfa2b7259e85e39dbfbf6fb41a0ce1d Commit]<br /> |-<br /> |2<br /> |*Not in required chagnes* Replaced repeated code for re-caching the user role<br /> |We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called &lt;code&gt;self.rebuild_role_cache&lt;/code&gt;.<br /> |[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]<br /> |-<br /> |3<br /> |Improved helper function names<br /> |Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.<br /> |[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/controllers/auth_controller_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> == Testing ==<br /> <br /> '''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 &lt;code&gt;main&lt;/code&gt; Expertiza branch. In the second submission phase, we plan to further enhance the testing suite of the &lt;code&gt;auth_controller.rb&lt;/code&gt; and &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt; through factories and fixtures.''' <br /> <br /> === Test Plan - Manual/System Test Cases ===<br /> 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 &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt; is difficult for us to test because we don't have access to the email used to make the sample account, but the &lt;code&gt;auth_controller.rb&lt;/code&gt; is very testable. Below is the tests we completed listed in the order of completion.<br /> <br /> ==== 1) Test instructor login &amp; redirect to home page ====<br /> When navigating to the expertiza website, our branch correctly displayed the login page as shown below.<br /> [[File:before_login.png|center|border|Form shown to the user before logging in to expertiza]]<br /> After typing in the sample login credentials of &quot;instructor6&quot; and &quot;password,&quot; the user is then correctly logged in and redirected to the home page for instructors shown below.<br /> [[File:after_login.png|center|border|1400px|Page shown to the user after logging in to expertiza]]<br /> ==== 2) Test instructor logout &amp; redirect to login page ====<br /> Then, when the user clicks the logout button, they are correctly logged out and redirected once again to the login page as shown below.<br /> [[File:after_logout.png|center|border|Form shown to the user after logging out of expertiza]]<br /> ==== 3) Test incorrect login ====<br /> When the user attempts to login but enters the incorrect login information of &quot;instructor6&quot; and &quot;incorrect,&quot; the user is shown the error message and then correctly redirected to the forgot password page shown below.<br /> [[File:after_incorrect_login.png|center|border|1400px|Form shown to the user after an incorrect login attempt to expertiza]]<br /> <br /> <br /> === Automated Testing of &lt;code&gt;auth_controller_.rb&lt;/code&gt; ===<br /> Before any refactoring to &lt;code&gt;auth_controller.rb&lt;/code&gt; was done, we ran the rspec tests created for the controller with the following command: &lt;code&gt;rspec spec/controllers/auth_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:before_refactor_auth_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]<br /> <br /> After making all of the above changes to &lt;code&gt;auth_controller.rb&lt;/code&gt;, we ran the rspec tests for the controller again with the command: &lt;code&gt;rspec spec/controllers/auth_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:after_refactor_auth_controller.png|center|frame|rspec tests continuing to all pass after completing the refactoring]]<br /> <br /> We have successfully preserved the passing tests after the improvements we made to the &lt;code&gt;auth_controller.rb&lt;/code&gt;. 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 &lt;code&gt;auth_controller_spec.rb&lt;/code&gt;. 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: &lt;code&gt;rspec spec/controllers/auth_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:after_improving_auth_controller_spec.png|center|frame|rspec tests continuing to all pass after improving and adding to the auth_controller tests]]<br /> <br /> Tests prior to the changes covered 91.94% of &lt;code&gt;auth_controller.rb&lt;/code&gt;.<br /> [[File:coverage_before.png|center|frame|rspec test coverage report before the improvements to the auth_controller unit tests]]<br /> <br /> 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 &lt;code&gt;auth_controller.rb&lt;/code&gt;. It improved slightly to be an even better coverage.<br /> [[File:coverage_after.png|center|frame|rspec test coverage report after the improvements to the auth_controller unit tests]]<br /> <br /> === Automated Testing of &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt; ===<br /> Before any refactoring to &lt;code&gt;passsword_retrieval_controller.rb&lt;/code&gt; was done, we ran the rspec tests created for the controller with the following command: &lt;code&gt;rspec spec/controllers/password_retrieval_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:before_refactor_password_retrieval_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]<br /> <br /> Tests prior to the changes covered 63.3% of &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt;.<br /> [[File:E2252_password_retrieval_coverage_report_before.png|center|frame|rspec test coverage report before the refactoring was completed]]<br /> <br /> After adding tests, the tests covered 91.1% of &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt;.<br /> [[File:E2252_password_retrieval_coverage_report_after.png|center|frame|rspec test coverage report after the refactoring was completed]]<br /> <br /> 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. <br /> [[File:prefactory.png|center|frame|rspec tests before factories were implemented]] &lt;br&gt;<br /> [[File:postfactory.png|center|frame|rspec tests after factories were implemented]]<br /> <br /> The below image shows the output of the following command after all tests were added: &lt;code&gt;rspec spec/controllers/password_retrieval_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:After refactor password retrieval controller.png|center|frame|rspec tests all passing after the refactoring was completed]]<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/greyfiles/expertiza<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2460<br /> * '''VCL Server:''' http://152.7.98.115:8080/<br /> <br /> == Contributors to this project ==<br /> * Grey Files (unityid: mgfiles, github: greyfiles)<br /> * Colin O'Dowd (unityid: cdodowd, github: colin-odowd)<br /> * Pradyumna Khawas (unityid: ppkhawas, github: therealppk)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147416 2023-03-19T17:11:34Z

<p>Vspande: /* Files Modified */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Checked and Removed &lt;code&gt;get_participant&lt;/code&gt; method name to <br /> |Checked the usage of Method through IDE whether the function is used, the only call was from &lt;code&gt;course_spec.rb&lt;/code&gt;. Hence, removed from &lt;code&gt;course.rb&lt;/code&gt;<br /> |[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Replaced repeated code in lines 35-36 and 62-63<br /> |The use of repeated code violates the DRY principle and so it was moved to a new method.<br /> |[https://github.com/expertiza/expertiza/commit/5429abd6fcb39f7bdbb0aaa1813f19c8101d7e25 Commit]<br /> |-<br /> |3<br /> |Change token expiration time to constant in line 41<br /> |This time should not be hardwired; it should be a constant or a parameter. <br /> |[https://github.com/expertiza/expertiza/commit/3f0b51f6f2f106df8338483396a95d4068e39c7f Commit]<br /> |-<br /> |4<br /> |Bugfix: Reload page if email is nil or empty on &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view<br /> |An empty email parameter was causing the send password button to freeze. This was beyond the scope of our work but we wanted to improve the page functionality. <br /> |[https://github.com/expertiza/expertiza/commit/70f77ac851b234f840709859dc1ee9d6725c34fc Commit]<br /> |-<br /> |5<br /> |Improve overall comments and rewrite error messages<br /> |The comments and error messages in the controller need to be more meaningful, specific and clear.<br /> |[https://github.com/expertiza/expertiza/commit/1af745dc3b59641cb0266ebe49ee996718381fd0 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/controllers/password_retrieval_controller_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Added two new RSpec tests for the &lt;code&gt;update_password&lt;/code&gt; method<br /> |There were no tests for the &lt;code&gt;update_password&lt;/code&gt; method. We wanted to enhance the test suite of this controller by increasing the coverage of its Rspec tests.<br /> |[https://github.com/expertiza/expertiza/commit/a90b1aada9878c7cdf7319dd022432cca8eadd2f Commit]<br /> |-<br /> |2<br /> |Added two new RSpec tests for the &lt;code&gt;send_password&lt;/code&gt; method to check nil or blank input for email<br /> |There were no tests for the &lt;code&gt;send_password&lt;/code&gt; method pertaining to checking invalid inputs in the request params<br /> |[https://github.com/greyfiles/expertiza/commit/1d2d2d94ef730ab427bb326049bc5ec800a0dfc9 Commit]&lt;br&gt;[https://github.com/greyfiles/expertiza/commit/781d6f42ca37829e0e514de8bcef1c85b2a035a2 Commit]<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/factories/password_retrieval_factory.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Created a file to host the &lt;code&gt;password_retrieval_controller_spec.rb&lt;/code&gt; fixtures<br /> |We implemented factories in the rspec test file to improve modularity and code readability.<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;config/routes.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Updated URL path and controller action to updated method name &lt;code&gt;check_token_validity&lt;/code&gt;<br /> |The action and URL path must be renamed to generate pathing to the controller method and views.<br /> |[https://github.com/expertiza/expertiza/commit/3f9f63ab51e90743dfab0b860574aa9b673f2717 Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/auth_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Move logger messages to &lt;code&gt;before_action&lt;/code&gt; blocks wherever possible<br /> |Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either &lt;code&gt;before_action&lt;/code&gt; or &lt;code&gt;after_action&lt;/code&gt; blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.<br /> |[https://github.com/greyfiles/expertiza/commit/7069f5d3cbfa2b7259e85e39dbfbf6fb41a0ce1d Commit]<br /> |-<br /> |2<br /> |*Not in required chagnes* Replaced repeated code for re-caching the user role<br /> |We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called &lt;code&gt;self.rebuild_role_cache&lt;/code&gt;.<br /> |[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]<br /> |-<br /> |3<br /> |Improved helper function names<br /> |Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.<br /> |[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/controllers/auth_controller_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> == Testing ==<br /> <br /> '''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 &lt;code&gt;main&lt;/code&gt; Expertiza branch. In the second submission phase, we plan to further enhance the testing suite of the &lt;code&gt;auth_controller.rb&lt;/code&gt; and &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt; through factories and fixtures.''' <br /> <br /> === Test Plan - Manual/System Test Cases ===<br /> 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 &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt; is difficult for us to test because we don't have access to the email used to make the sample account, but the &lt;code&gt;auth_controller.rb&lt;/code&gt; is very testable. Below is the tests we completed listed in the order of completion.<br /> <br /> ==== 1) Test instructor login &amp; redirect to home page ====<br /> When navigating to the expertiza website, our branch correctly displayed the login page as shown below.<br /> [[File:before_login.png|center|border|Form shown to the user before logging in to expertiza]]<br /> After typing in the sample login credentials of &quot;instructor6&quot; and &quot;password,&quot; the user is then correctly logged in and redirected to the home page for instructors shown below.<br /> [[File:after_login.png|center|border|1400px|Page shown to the user after logging in to expertiza]]<br /> ==== 2) Test instructor logout &amp; redirect to login page ====<br /> Then, when the user clicks the logout button, they are correctly logged out and redirected once again to the login page as shown below.<br /> [[File:after_logout.png|center|border|Form shown to the user after logging out of expertiza]]<br /> ==== 3) Test incorrect login ====<br /> When the user attempts to login but enters the incorrect login information of &quot;instructor6&quot; and &quot;incorrect,&quot; the user is shown the error message and then correctly redirected to the forgot password page shown below.<br /> [[File:after_incorrect_login.png|center|border|1400px|Form shown to the user after an incorrect login attempt to expertiza]]<br /> <br /> <br /> === Automated Testing of &lt;code&gt;auth_controller_.rb&lt;/code&gt; ===<br /> Before any refactoring to &lt;code&gt;auth_controller.rb&lt;/code&gt; was done, we ran the rspec tests created for the controller with the following command: &lt;code&gt;rspec spec/controllers/auth_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:before_refactor_auth_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]<br /> <br /> After making all of the above changes to &lt;code&gt;auth_controller.rb&lt;/code&gt;, we ran the rspec tests for the controller again with the command: &lt;code&gt;rspec spec/controllers/auth_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:after_refactor_auth_controller.png|center|frame|rspec tests continuing to all pass after completing the refactoring]]<br /> <br /> We have successfully preserved the passing tests after the improvements we made to the &lt;code&gt;auth_controller.rb&lt;/code&gt;. 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 &lt;code&gt;auth_controller_spec.rb&lt;/code&gt;. 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: &lt;code&gt;rspec spec/controllers/auth_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:after_improving_auth_controller_spec.png|center|frame|rspec tests continuing to all pass after improving and adding to the auth_controller tests]]<br /> <br /> Tests prior to the changes covered 91.94% of &lt;code&gt;auth_controller.rb&lt;/code&gt;.<br /> [[File:coverage_before.png|center|frame|rspec test coverage report before the improvements to the auth_controller unit tests]]<br /> <br /> 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 &lt;code&gt;auth_controller.rb&lt;/code&gt;. It improved slightly to be an even better coverage.<br /> [[File:coverage_after.png|center|frame|rspec test coverage report after the improvements to the auth_controller unit tests]]<br /> <br /> === Automated Testing of &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt; ===<br /> Before any refactoring to &lt;code&gt;passsword_retrieval_controller.rb&lt;/code&gt; was done, we ran the rspec tests created for the controller with the following command: &lt;code&gt;rspec spec/controllers/password_retrieval_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:before_refactor_password_retrieval_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]<br /> <br /> Tests prior to the changes covered 63.3% of &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt;.<br /> [[File:E2252_password_retrieval_coverage_report_before.png|center|frame|rspec test coverage report before the refactoring was completed]]<br /> <br /> After adding tests, the tests covered 91.1% of &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt;.<br /> [[File:E2252_password_retrieval_coverage_report_after.png|center|frame|rspec test coverage report after the refactoring was completed]]<br /> <br /> 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. <br /> [[File:prefactory.png|center|frame|rspec tests before factories were implemented]] &lt;br&gt;<br /> [[File:postfactory.png|center|frame|rspec tests after factories were implemented]]<br /> <br /> The below image shows the output of the following command after all tests were added: &lt;code&gt;rspec spec/controllers/password_retrieval_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:After refactor password retrieval controller.png|center|frame|rspec tests all passing after the refactoring was completed]]<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/greyfiles/expertiza<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2460<br /> * '''VCL Server:''' http://152.7.98.115:8080/<br /> <br /> == Contributors to this project ==<br /> * Grey Files (unityid: mgfiles, github: greyfiles)<br /> * Colin O'Dowd (unityid: cdodowd, github: colin-odowd)<br /> * Pradyumna Khawas (unityid: ppkhawas, github: therealppk)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147415 2023-03-19T17:01:24Z

<p>Vspande: /* Files Modified */</p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/models/course.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Updated &lt;code&gt;check_reset_url&lt;/code&gt; method name to &lt;code&gt;check_token_validity&lt;/code&gt;<br /> |The method validates that the password reset token is valid and present. The updated method name provides a more functionally descriptive name. <br /> |[https://github.com/expertiza/expertiza/commit/3f9f63ab51e90743dfab0b860574aa9b673f2717 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Replaced repeated code in lines 35-36 and 62-63<br /> |The use of repeated code violates the DRY principle and so it was moved to a new method.<br /> |[https://github.com/expertiza/expertiza/commit/5429abd6fcb39f7bdbb0aaa1813f19c8101d7e25 Commit]<br /> |-<br /> |3<br /> |Change token expiration time to constant in line 41<br /> |This time should not be hardwired; it should be a constant or a parameter. <br /> |[https://github.com/expertiza/expertiza/commit/3f0b51f6f2f106df8338483396a95d4068e39c7f Commit]<br /> |-<br /> |4<br /> |Bugfix: Reload page if email is nil or empty on &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view<br /> |An empty email parameter was causing the send password button to freeze. This was beyond the scope of our work but we wanted to improve the page functionality. <br /> |[https://github.com/expertiza/expertiza/commit/70f77ac851b234f840709859dc1ee9d6725c34fc Commit]<br /> |-<br /> |5<br /> |Improve overall comments and rewrite error messages<br /> |The comments and error messages in the controller need to be more meaningful, specific and clear.<br /> |[https://github.com/expertiza/expertiza/commit/1af745dc3b59641cb0266ebe49ee996718381fd0 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/controllers/password_retrieval_controller_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Added two new RSpec tests for the &lt;code&gt;update_password&lt;/code&gt; method<br /> |There were no tests for the &lt;code&gt;update_password&lt;/code&gt; method. We wanted to enhance the test suite of this controller by increasing the coverage of its Rspec tests.<br /> |[https://github.com/expertiza/expertiza/commit/a90b1aada9878c7cdf7319dd022432cca8eadd2f Commit]<br /> |-<br /> |2<br /> |Added two new RSpec tests for the &lt;code&gt;send_password&lt;/code&gt; method to check nil or blank input for email<br /> |There were no tests for the &lt;code&gt;send_password&lt;/code&gt; method pertaining to checking invalid inputs in the request params<br /> |[https://github.com/greyfiles/expertiza/commit/1d2d2d94ef730ab427bb326049bc5ec800a0dfc9 Commit]&lt;br&gt;[https://github.com/greyfiles/expertiza/commit/781d6f42ca37829e0e514de8bcef1c85b2a035a2 Commit]<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/factories/password_retrieval_factory.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Created a file to host the &lt;code&gt;password_retrieval_controller_spec.rb&lt;/code&gt; fixtures<br /> |We implemented factories in the rspec test file to improve modularity and code readability.<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;config/routes.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Updated URL path and controller action to updated method name &lt;code&gt;check_token_validity&lt;/code&gt;<br /> |The action and URL path must be renamed to generate pathing to the controller method and views.<br /> |[https://github.com/expertiza/expertiza/commit/3f9f63ab51e90743dfab0b860574aa9b673f2717 Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/auth_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Move logger messages to &lt;code&gt;before_action&lt;/code&gt; blocks wherever possible<br /> |Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either &lt;code&gt;before_action&lt;/code&gt; or &lt;code&gt;after_action&lt;/code&gt; blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.<br /> |[https://github.com/greyfiles/expertiza/commit/7069f5d3cbfa2b7259e85e39dbfbf6fb41a0ce1d Commit]<br /> |-<br /> |2<br /> |*Not in required chagnes* Replaced repeated code for re-caching the user role<br /> |We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called &lt;code&gt;self.rebuild_role_cache&lt;/code&gt;.<br /> |[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]<br /> |-<br /> |3<br /> |Improved helper function names<br /> |Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.<br /> |[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/controllers/auth_controller_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> == Testing ==<br /> <br /> '''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 &lt;code&gt;main&lt;/code&gt; Expertiza branch. In the second submission phase, we plan to further enhance the testing suite of the &lt;code&gt;auth_controller.rb&lt;/code&gt; and &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt; through factories and fixtures.''' <br /> <br /> === Test Plan - Manual/System Test Cases ===<br /> 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 &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt; is difficult for us to test because we don't have access to the email used to make the sample account, but the &lt;code&gt;auth_controller.rb&lt;/code&gt; is very testable. Below is the tests we completed listed in the order of completion.<br /> <br /> ==== 1) Test instructor login &amp; redirect to home page ====<br /> When navigating to the expertiza website, our branch correctly displayed the login page as shown below.<br /> [[File:before_login.png|center|border|Form shown to the user before logging in to expertiza]]<br /> After typing in the sample login credentials of &quot;instructor6&quot; and &quot;password,&quot; the user is then correctly logged in and redirected to the home page for instructors shown below.<br /> [[File:after_login.png|center|border|1400px|Page shown to the user after logging in to expertiza]]<br /> ==== 2) Test instructor logout &amp; redirect to login page ====<br /> Then, when the user clicks the logout button, they are correctly logged out and redirected once again to the login page as shown below.<br /> [[File:after_logout.png|center|border|Form shown to the user after logging out of expertiza]]<br /> ==== 3) Test incorrect login ====<br /> When the user attempts to login but enters the incorrect login information of &quot;instructor6&quot; and &quot;incorrect,&quot; the user is shown the error message and then correctly redirected to the forgot password page shown below.<br /> [[File:after_incorrect_login.png|center|border|1400px|Form shown to the user after an incorrect login attempt to expertiza]]<br /> <br /> <br /> === Automated Testing of &lt;code&gt;auth_controller_.rb&lt;/code&gt; ===<br /> Before any refactoring to &lt;code&gt;auth_controller.rb&lt;/code&gt; was done, we ran the rspec tests created for the controller with the following command: &lt;code&gt;rspec spec/controllers/auth_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:before_refactor_auth_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]<br /> <br /> After making all of the above changes to &lt;code&gt;auth_controller.rb&lt;/code&gt;, we ran the rspec tests for the controller again with the command: &lt;code&gt;rspec spec/controllers/auth_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:after_refactor_auth_controller.png|center|frame|rspec tests continuing to all pass after completing the refactoring]]<br /> <br /> We have successfully preserved the passing tests after the improvements we made to the &lt;code&gt;auth_controller.rb&lt;/code&gt;. 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 &lt;code&gt;auth_controller_spec.rb&lt;/code&gt;. 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: &lt;code&gt;rspec spec/controllers/auth_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:after_improving_auth_controller_spec.png|center|frame|rspec tests continuing to all pass after improving and adding to the auth_controller tests]]<br /> <br /> Tests prior to the changes covered 91.94% of &lt;code&gt;auth_controller.rb&lt;/code&gt;.<br /> [[File:coverage_before.png|center|frame|rspec test coverage report before the improvements to the auth_controller unit tests]]<br /> <br /> 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 &lt;code&gt;auth_controller.rb&lt;/code&gt;. It improved slightly to be an even better coverage.<br /> [[File:coverage_after.png|center|frame|rspec test coverage report after the improvements to the auth_controller unit tests]]<br /> <br /> === Automated Testing of &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt; ===<br /> Before any refactoring to &lt;code&gt;passsword_retrieval_controller.rb&lt;/code&gt; was done, we ran the rspec tests created for the controller with the following command: &lt;code&gt;rspec spec/controllers/password_retrieval_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:before_refactor_password_retrieval_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]<br /> <br /> Tests prior to the changes covered 63.3% of &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt;.<br /> [[File:E2252_password_retrieval_coverage_report_before.png|center|frame|rspec test coverage report before the refactoring was completed]]<br /> <br /> After adding tests, the tests covered 91.1% of &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt;.<br /> [[File:E2252_password_retrieval_coverage_report_after.png|center|frame|rspec test coverage report after the refactoring was completed]]<br /> <br /> 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. <br /> [[File:prefactory.png|center|frame|rspec tests before factories were implemented]] &lt;br&gt;<br /> [[File:postfactory.png|center|frame|rspec tests after factories were implemented]]<br /> <br /> The below image shows the output of the following command after all tests were added: &lt;code&gt;rspec spec/controllers/password_retrieval_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:After refactor password retrieval controller.png|center|frame|rspec tests all passing after the refactoring was completed]]<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/greyfiles/expertiza<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2460<br /> * '''VCL Server:''' http://152.7.98.115:8080/<br /> <br /> == Contributors to this project ==<br /> * Grey Files (unityid: mgfiles, github: greyfiles)<br /> * Colin O'Dowd (unityid: cdodowd, github: colin-odowd)<br /> * Pradyumna Khawas (unityid: ppkhawas, github: therealppk)</div>

Vspande https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517/Spring_2023/E2308._Refactor_course.rb_and_course_team.rb_models&diff=147414 2023-03-19T16:48:54Z

<p>Vspande: </p> <hr /> <div><br /> <br /> __TOC__<br /> <br /> == Team Contact ==<br /> === Team Members ===<br /> * Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)<br /> * Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)<br /> * Vikram Pande, (unityID:vspande, GitHub:vikrampande7)<br /> <br /> === Mentor ===<br /> * Kartiki Bhandakkar, kbhanda3<br /> <br /> == Overview of Expertiza ==<br /> Expertiza is an open-source software written using Ruby on Rails which functions as a learning management software system. It has many different functions and abilities including the ability to create assignments, quizzes, assignment groups, and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system containing information about the course and its associated teams respectively. The &lt;code&gt;Course&lt;/code&gt; and &lt;code&gt;CourseTeam&lt;/code&gt; which are the models primarily addressed in this project are both critical components in providing this functionality.<br /> <br /> == Description of Project ==<br /> &lt;code&gt;auth_controller&lt;/code&gt; is used for authentication purposes. The controller completes a variety of tasks including handling the correct user logins, incorrect passwords, unknown users, and making sure the session and role information is updated at all points in that process. The original problem description listed three issues, two of which had since been corrected by other code changes since the document was written. The remaining problem was that some logger messages were included in methods that could be placed more cleanly in &lt;code&gt;before_action&lt;/code&gt; methods. Also, I personally noticed that there was a few lines of repeated code involved in resetting the role cache that needed to be combined into a shared private method.<br /> <br /> The &lt;code&gt;password_retrieval_controller&lt;/code&gt; deals with the process of updating and resetting a user password. The &lt;code&gt;send_password&lt;/code&gt; method generates a token and appends it to a password reset URL. If a user submits a valid email address on the &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the &lt;code&gt;password_retrieval/reset_password&lt;/code&gt; view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that validate the functionality of the &lt;code&gt;update_password&lt;/code&gt; and &lt;code&gt;send_password&lt;/code&gt; methods.<br /> <br /> == Files Modified ==<br /> === Changes to &lt;code&gt;app/controllers/password_retrieval_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Updated &lt;code&gt;check_reset_url&lt;/code&gt; method name to &lt;code&gt;check_token_validity&lt;/code&gt;<br /> |The method validates that the password reset token is valid and present. The updated method name provides a more functionally descriptive name. <br /> |[https://github.com/expertiza/expertiza/commit/3f9f63ab51e90743dfab0b860574aa9b673f2717 Commit]<br /> |-<br /> |2<br /> |style=&quot;width: 30%&quot;| Replaced repeated code in lines 35-36 and 62-63<br /> |The use of repeated code violates the DRY principle and so it was moved to a new method.<br /> |[https://github.com/expertiza/expertiza/commit/5429abd6fcb39f7bdbb0aaa1813f19c8101d7e25 Commit]<br /> |-<br /> |3<br /> |Change token expiration time to constant in line 41<br /> |This time should not be hardwired; it should be a constant or a parameter. <br /> |[https://github.com/expertiza/expertiza/commit/3f0b51f6f2f106df8338483396a95d4068e39c7f Commit]<br /> |-<br /> |4<br /> |Bugfix: Reload page if email is nil or empty on &lt;code&gt;password_retrieval/forgotten&lt;/code&gt; view<br /> |An empty email parameter was causing the send password button to freeze. This was beyond the scope of our work but we wanted to improve the page functionality. <br /> |[https://github.com/expertiza/expertiza/commit/70f77ac851b234f840709859dc1ee9d6725c34fc Commit]<br /> |-<br /> |5<br /> |Improve overall comments and rewrite error messages<br /> |The comments and error messages in the controller need to be more meaningful, specific and clear.<br /> |[https://github.com/expertiza/expertiza/commit/1af745dc3b59641cb0266ebe49ee996718381fd0 Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/controllers/password_retrieval_controller_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Added two new RSpec tests for the &lt;code&gt;update_password&lt;/code&gt; method<br /> |There were no tests for the &lt;code&gt;update_password&lt;/code&gt; method. We wanted to enhance the test suite of this controller by increasing the coverage of its Rspec tests.<br /> |[https://github.com/expertiza/expertiza/commit/a90b1aada9878c7cdf7319dd022432cca8eadd2f Commit]<br /> |-<br /> |2<br /> |Added two new RSpec tests for the &lt;code&gt;send_password&lt;/code&gt; method to check nil or blank input for email<br /> |There were no tests for the &lt;code&gt;send_password&lt;/code&gt; method pertaining to checking invalid inputs in the request params<br /> |[https://github.com/greyfiles/expertiza/commit/1d2d2d94ef730ab427bb326049bc5ec800a0dfc9 Commit]&lt;br&gt;[https://github.com/greyfiles/expertiza/commit/781d6f42ca37829e0e514de8bcef1c85b2a035a2 Commit]<br /> |-<br /> |3<br /> |Added &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; factories and removed hardcoded variables<br /> |Cleaned up hardcoded &lt;code&gt;User&lt;/code&gt; and &lt;code&gt;PasswordReset&lt;/code&gt; models with premade factories to improve readability of the code<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]&lt;br&gt;[https://github.com/expertiza/expertiza/commit/96376e0b633e6b6e08d472a4cb4600d20e0c024f Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/factories/password_retrieval_factory.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Created a file to host the &lt;code&gt;password_retrieval_controller_spec.rb&lt;/code&gt; fixtures<br /> |We implemented factories in the rspec test file to improve modularity and code readability.<br /> |[https://github.com/expertiza/expertiza/commit/e946533235846a853ee42908b15e75d628552f9e Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;config/routes.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Updated URL path and controller action to updated method name &lt;code&gt;check_token_validity&lt;/code&gt;<br /> |The action and URL path must be renamed to generate pathing to the controller method and views.<br /> |[https://github.com/expertiza/expertiza/commit/3f9f63ab51e90743dfab0b860574aa9b673f2717 Commit]<br /> |-<br /> |}<br /> <br /> === Changes to &lt;code&gt;app/controllers/auth_controller.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Move logger messages to &lt;code&gt;before_action&lt;/code&gt; blocks wherever possible<br /> |Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either &lt;code&gt;before_action&lt;/code&gt; or &lt;code&gt;after_action&lt;/code&gt; blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.<br /> |[https://github.com/greyfiles/expertiza/commit/7069f5d3cbfa2b7259e85e39dbfbf6fb41a0ce1d Commit]<br /> |-<br /> |2<br /> |*Not in required chagnes* Replaced repeated code for re-caching the user role<br /> |We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called &lt;code&gt;self.rebuild_role_cache&lt;/code&gt;.<br /> |[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]<br /> |-<br /> |3<br /> |Improved helper function names<br /> |Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.<br /> |[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]<br /> |}<br /> <br /> === Changes to &lt;code&gt;spec/controllers/auth_controller_spec.rb&lt;/code&gt; ===<br /> {| class=&quot;wikitable&quot; style=&quot;width: 100%;<br /> ! &amp;nbsp;#&amp;nbsp; !! Change !! Rationale !! Commit Link<br /> |-<br /> |1<br /> |Improved existing tests for &lt;code&gt;after_login&lt;/code&gt; to explicitly test for a redirect<br /> |When looking over the existing test cases, I noticed that the test that was verifying that the &lt;code&gt;after_login&lt;/code&gt; method would redirect the user only &quot;allowed&quot; the redirect and did not &quot;expect&quot; it. I changed it to &quot;expect&quot; the redirect to ensure that functionality is working.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |2<br /> |Added a test for &lt;code&gt;set_current_role&lt;/code&gt; when the role is found to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;set_current_role&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the current role was set.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |-<br /> |3<br /> |Added a test for &lt;code&gt;clear_user_info&lt;/code&gt; to make sure it rebuilds the role cache<br /> |In the unit tests for the &lt;code&gt;clear_user_info&lt;/code&gt; method, my new addition of a private helper method allowed us to ensure that the role cache was being rebuilt when the user's info was cleared.<br /> |[https://github.com/greyfiles/expertiza/commit/23b3eaa888810f93a4af18c2ca6904ab21580a4b Commit]<br /> |}<br /> <br /> == Testing ==<br /> <br /> '''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 &lt;code&gt;main&lt;/code&gt; Expertiza branch. In the second submission phase, we plan to further enhance the testing suite of the &lt;code&gt;auth_controller.rb&lt;/code&gt; and &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt; through factories and fixtures.''' <br /> <br /> === Test Plan - Manual/System Test Cases ===<br /> 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 &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt; is difficult for us to test because we don't have access to the email used to make the sample account, but the &lt;code&gt;auth_controller.rb&lt;/code&gt; is very testable. Below is the tests we completed listed in the order of completion.<br /> <br /> ==== 1) Test instructor login &amp; redirect to home page ====<br /> When navigating to the expertiza website, our branch correctly displayed the login page as shown below.<br /> [[File:before_login.png|center|border|Form shown to the user before logging in to expertiza]]<br /> After typing in the sample login credentials of &quot;instructor6&quot; and &quot;password,&quot; the user is then correctly logged in and redirected to the home page for instructors shown below.<br /> [[File:after_login.png|center|border|1400px|Page shown to the user after logging in to expertiza]]<br /> ==== 2) Test instructor logout &amp; redirect to login page ====<br /> Then, when the user clicks the logout button, they are correctly logged out and redirected once again to the login page as shown below.<br /> [[File:after_logout.png|center|border|Form shown to the user after logging out of expertiza]]<br /> ==== 3) Test incorrect login ====<br /> When the user attempts to login but enters the incorrect login information of &quot;instructor6&quot; and &quot;incorrect,&quot; the user is shown the error message and then correctly redirected to the forgot password page shown below.<br /> [[File:after_incorrect_login.png|center|border|1400px|Form shown to the user after an incorrect login attempt to expertiza]]<br /> <br /> <br /> === Automated Testing of &lt;code&gt;auth_controller_.rb&lt;/code&gt; ===<br /> Before any refactoring to &lt;code&gt;auth_controller.rb&lt;/code&gt; was done, we ran the rspec tests created for the controller with the following command: &lt;code&gt;rspec spec/controllers/auth_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:before_refactor_auth_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]<br /> <br /> After making all of the above changes to &lt;code&gt;auth_controller.rb&lt;/code&gt;, we ran the rspec tests for the controller again with the command: &lt;code&gt;rspec spec/controllers/auth_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:after_refactor_auth_controller.png|center|frame|rspec tests continuing to all pass after completing the refactoring]]<br /> <br /> We have successfully preserved the passing tests after the improvements we made to the &lt;code&gt;auth_controller.rb&lt;/code&gt;. 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 &lt;code&gt;auth_controller_spec.rb&lt;/code&gt;. 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: &lt;code&gt;rspec spec/controllers/auth_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:after_improving_auth_controller_spec.png|center|frame|rspec tests continuing to all pass after improving and adding to the auth_controller tests]]<br /> <br /> Tests prior to the changes covered 91.94% of &lt;code&gt;auth_controller.rb&lt;/code&gt;.<br /> [[File:coverage_before.png|center|frame|rspec test coverage report before the improvements to the auth_controller unit tests]]<br /> <br /> 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 &lt;code&gt;auth_controller.rb&lt;/code&gt;. It improved slightly to be an even better coverage.<br /> [[File:coverage_after.png|center|frame|rspec test coverage report after the improvements to the auth_controller unit tests]]<br /> <br /> === Automated Testing of &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt; ===<br /> Before any refactoring to &lt;code&gt;passsword_retrieval_controller.rb&lt;/code&gt; was done, we ran the rspec tests created for the controller with the following command: &lt;code&gt;rspec spec/controllers/password_retrieval_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:before_refactor_password_retrieval_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]<br /> <br /> Tests prior to the changes covered 63.3% of &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt;.<br /> [[File:E2252_password_retrieval_coverage_report_before.png|center|frame|rspec test coverage report before the refactoring was completed]]<br /> <br /> After adding tests, the tests covered 91.1% of &lt;code&gt;password_retrieval_controller.rb&lt;/code&gt;.<br /> [[File:E2252_password_retrieval_coverage_report_after.png|center|frame|rspec test coverage report after the refactoring was completed]]<br /> <br /> 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. <br /> [[File:prefactory.png|center|frame|rspec tests before factories were implemented]] &lt;br&gt;<br /> [[File:postfactory.png|center|frame|rspec tests after factories were implemented]]<br /> <br /> The below image shows the output of the following command after all tests were added: &lt;code&gt;rspec spec/controllers/password_retrieval_controller_spec.rb&lt;/code&gt;<br /> <br /> [[File:After refactor password retrieval controller.png|center|frame|rspec tests all passing after the refactoring was completed]]<br /> <br /> == Relevant Links ==<br /> * '''Github Repository:''' https://github.com/greyfiles/expertiza<br /> * '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2460<br /> * '''VCL Server:''' http://152.7.98.115:8080/<br /> <br /> == Contributors to this project ==<br /> * Grey Files (unityid: mgfiles, github: greyfiles)<br /> * Colin O'Dowd (unityid: cdodowd, github: colin-odowd)<br /> * Pradyumna Khawas (unityid: ppkhawas, github: therealppk)</div>

Vspande