Expertiza_Wiki - User contributions [en]

CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

2023-04-26T01:15:55Z

Khrawool:

CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

2023-04-26T01:15:08Z

Khrawool: /* Implementation */

CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

2023-04-26T01:13:50Z

Khrawool: /* Implementation */

CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

2023-04-26T00:25:41Z

Khrawool: /* Previous Work */

CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

2023-04-26T00:24:24Z

Khrawool: /* Implementation */

__TOC__

== Team Contact ==
=== Team Members ===
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

=== Mentor ===
* Kartiki Bhandakkar, kbhanda3

== Description of Project ==
The <code>Course</code> 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.

The <code>CoursesController</code> 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.

==Problem Statement==
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.

==Previous Work==
{| class="wikitable" style="margin-left:40px"
|-
! Index !! Previous !! Proposed changes || Rationale
|-
| 1 || user_on_team method in course.rb model

'''
def user_on_team?(user)
teams = get_teams
users = []
teams.each do |team|
users << team.users
end
users.flatten.include? user
end
'''
|| 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
|-
| 2 || copy method present in controller

'''
# Create a copy of a course with a new submission directory
def copy
orig_course = Course.find(params[:id])
new_course = orig_course.dup
new_course.instructor_id = session[:user].id
new_course.name = 'Copy of ' + orig_course.name
new_course.directory_path = new_course.directory_path + '_copy'
begin
new_course.save!
parent_id = CourseNode.get_parent_id
if parent_id
CourseNode.create(node_object_id: new_course.id, parent_id: parent_id)
else
CourseNode.create(node_object_id: new_course.id)
end
undo_link("The course \"#{orig_course.name}\" has been successfully copied.
Warning: The submission directory path for this copy is the original course's directory path appended with the word \"_copy\".
If you do not want this to happen, change the submission directory in the new copy of the course.")
redirect_to controller: 'courses', action: 'edit', id: new_course.id
rescue StandardError
flash[:error] = 'The course was not able to be copied: ' + $ERROR_INFO
redirect_to controller: 'tree_display', action: 'list'
end
end
'''
|| 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.
|-
| 3 || action_allowed method in controller

'''
def action_allowed?
current_user_has_instructor_privileges?
end
'''
|| 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.
|-
|}

==Implementation==
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.
====Controller====

{| class="wikitable" style="margin-left:40px"
|-
! Index !! Method !! Request Type !! Description
|-
| 1 || index || GET || List all courses
|-
| 2 || show|| GET || Method to get the course with the given id
|-
| 3 || update || PUT || Method to update an existing course and save the changes to the database
|-
| 4 || copy || GET || Creates a new copy of an existing course with a new submission directory and saves it to the database
|-
| 5 || create || POST || Creates a new course and saves it to database
|-
| 6 || delete || DELETE || Method to delete an existing course
|-
| 7 || view_tas || GET || Displays all the teaching assistants for the given course
|-
| 8 || add_ta || GET|| Method to add teaching assistant to a course
|-
| 9 || remove_ta || GET|| Method to remove teaching assistant from a course
|-
|}

====Model====

{| class="wikitable" style="margin-left:40px"
|-
! Index !! Method !! Description
|-
| 1 || path || Returns the course's submission directory
|-

|}

====Ta Mapping====
We created a model ta_mapping to map the many to many relationship between Course and Teaching Assistant. The model has the following attributes of course_id and ta_id. Through ta_mapping we can keep track of all the TAs assigned to a Course.

==UML Diagram==
[[Image: UML.png]]

==Testing Plan==
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.

====Tests====
'''Course Controller'''

{| class="wikitable" style="margin-left:40px"
|-
! Test No. !! Description
|-
| 1 || Tests if the action_allowed disallows all actions when current user is student.
|-
| 2 || Tests if the action_allowed allows all course actions when current user is instructor.
|-
| 3 || Tests if create method returns a 201 Created status code if the resource is successfully created.
|-
| 4 || Tests if create method returns a 422 Unprocessable Entity status code if the resource cannot be created due to validation errors.
|-
| 5 || Tests if the delete method returns a 204 No Content status code if the resource is successfully deleted.
|-
| 6 || Tests if the delete method returns a 404 Not Found status code if the resource cannot be found.
|-
| 7 || Tests if the new method sets the private instance variable.
|-
| 8 || Tests if the update method returns a 200 OK status code if the resource is successfully updated.
|-
| 9 || Tests if the update method returns a 422 Unprocessable Entity status code if the resource cannot be updated due to validation errors.
|-
| 10 || Tests if the topic_name method returns the participant topic name when not nil.
|-
| 11 || Tests if the auto_complete_for_user_name method returns a list of users.
|-
| 12 || Tests if the copy method redirects to new course when new course id fetched successfully.
|-
| 13 || Tests if the view_teaching_assistants method returns list of TAs for the course.
|-
| 14 || Tests if the add_ta method returns a 200 OK status code if a TA added successfully to the course.
|-
| 13 || Tests if the add_ta method returns a 422 Unprocessable Entity status code if a TA cannot be added to the course.
|-
| 14 || Tests if the remove_ta method returns a 204 No Content status code if the ta is successfully removed from the course.
|-
| 15 || Tests if the remove_ta method returns a 404 Not Found status code if the ta cannot be found.
|-
| 16 || Tests if the set_course_fields method sets the course fields.
|}

'''Course Model'''

{| class="wikitable" style="margin-left:40px"
|-
! Test No. !! Description
|-
| 1 || Tests if the model validates presence of name
|-
| 2 || Tests if the model validates presence of directory_path
|-
| 3 || Tests if path method raises an error when there is no associated instructor.
|-
| 4 || Tests if path method returns a directory when there is an associated instructor.

|}

== Relevant Links ==
* '''Github Repository:''' https://github.com/ameyagv/reimplementation-back-end
* '''Pull Request:''' https://github.com/expertiza/reimplementation-back-end/pull/36
* '''Video Link:''' https://youtu.be/22wExrVX15o

== Contributors to this project ==
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

2023-04-26T00:20:39Z

Khrawool: /* Relevant Links */

CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

2023-04-07T21:36:11Z

Khrawool: /* Implementation */

__TOC__

== Team Contact ==
=== Team Members ===
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

=== Mentor ===
* Kartiki Bhandakkar, kbhanda3

== Overview of Expertiza ==
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 <code>Course</code> model and <code>CoursesController</code>, which are the classes primarily addressed in this project, are both critical components in providing this functionality.

== Description of Project ==
<code>course</code> 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.

The <code>course_team</code> 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.

==Problem Statement==

==Design Decisions==

==Implementation==
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.
====Controller====

{| class="wikitable" style="margin-left:40px"
|-
! Index !! Method !! Request Type !! Description
|-
| 1 || action_allowed || HELPER FUNCTION || Determines whether the current user has permission to perform certain actions based on their role
|-
| 2 || auto_complete_for_user_name || GET || Provides an autocomplete feature for the form input when adding a TA
|-
| 3 || new || GET || Displays the form for creating a new course
|-
| 4 || edit|| GET || Method to get the course to edit
|-
| 5 || update || PUT || Method to update an existing course based on the form input and save the changes to database
|-
| 6 || copy || GET || Creates a new copy of an existing course with a new submission directory and saves it to the database
|-
| 7 || create || POST || Creates a new course based on the form input and saves it to database
|-
| 8 || delete || DELETE || Method to delete an existing course
|-
| 9 || view_teaching_assistant || GET || Displays all the teaching assistants for a course
|-
| 10 || add_ta || POST || Method to add teaching assistant to a course
|-
| 11 || remove_ta || POST || Method to remove teaching assistant from a course
|-
| 12 || set_course_fields || POST || Called in Update and Create methods to set the fields of course
|-

|}

====Model====

{| class="wikitable" style="margin-left:40px"
|-
! Index !! Method !! Description
|-
| 1 || get_teams || Returns any predefined teams associated with a particular course object
|-
| 2 || get_participants || Returns multiple records of course participants from database given parent_id and user_id
|-
| 3 || get_participant || Returns a single record course participant from Course Participant given parent_id
|-
| 4 || add _participant || Add a new Course Participant to the course given user_name
|-
| 5 || copy_participants || Copies all the participants from a given assignment to the current course
|-
| 6 || user_on_team || Checks whether a given user is a member of any team associated with the course
|-
| 7 || path || Returns the course's submission directory
|-

|}

==Testing Plan==
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.

====Tests====
'''Course Controller'''

{| class="wikitable" style="margin-left:40px"
|-
! Test No. !! Description
|-
| 1 || Tests if the action_allowed disallows all actions when current user is student.
|-
| 2 || Tests if the action_allowed allows all course actions when current user is instructor.
|-
| 3 || Tests if create method returns a 201 Created status code if the resource is successfully created.
|-
| 4 || Tests if create method returns a 422 Unprocessable Entity status code if the resource cannot be created due to validation errors.
|-
| 5 || Tests if the delete method returns a 204 No Content status code if the resource is successfully deleted.
|-
| 6 || Tests if the delete method returns a 404 Not Found status code if the resource cannot be found.
|-
| 7 || Tests if the new method sets the private instance variable.
|-
| 8 || Tests if the update method returns a 200 OK status code if the resource is successfully updated.
|-
| 9 || Tests if the update method returns a 422 Unprocessable Entity status code if the resource cannot be updated due to validation errors.
|-
| 10 || Tests if the topic_name method returns the participant topic name when not nil.
|-
| 11 || Tests if the auto_complete_for_user_name method returns a list of users.
|-
| 12 || Tests if the copy method redirects to new course when new course id fetched successfully.
|-
| 13 || Tests if the view_teaching_assistants method returns list of TAs for the course.
|-
| 14 || Tests if the add_ta method returns a 200 OK status code if a TA added successfully to the course.
|-
| 13 || Tests if the add_ta method returns a 422 Unprocessable Entity status code if a TA cannot be added to the course.
|-
| 14 || Tests if the remove_ta method returns a 204 No Content status code if the ta is successfully removed from the course.
|-
| 15 || Tests if the remove_ta method returns a 404 Not Found status code if the ta cannot be found.
|-
| 16 || Tests if the set_course_fields method sets the course fields.
|}

'''Course Model'''

{| class="wikitable" style="margin-left:40px"
|-
! Test No. !! Description
|-
| 1 || Tests if the model validates presence of name
|-
| 2 || Tests if the model validates presence of directory_path
|-
| 3 || Tests if path method raises an error when there is no associated instructor.
|-
| 4 || Tests if path method returns a directory when there is an associated instructor.

|}

==Description==

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.

What needs to be done:
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.
As mentioned in the guideline, take reference from the User (model & 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.

== Relevant Links ==
* '''Github Repository:''' https://github.com/ameyagv/reimplementation-back-end
* '''Pull Request:'''
* '''VCL Server:'''

== Contributors to this project ==
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

2023-04-07T21:34:29Z

Khrawool: /* Testing Plan */

__TOC__

== Team Contact ==
=== Team Members ===
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

=== Mentor ===
* Kartiki Bhandakkar, kbhanda3

== Overview of Expertiza ==
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 <code>Course</code> model and <code>CoursesController</code>, which are the classes primarily addressed in this project, are both critical components in providing this functionality.

== Description of Project ==
<code>course</code> 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.

The <code>course_team</code> 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.

==Problem Statement==

==Design Decisions==

==Implementation==
====Controller====

{| class="wikitable" style="margin-left:40px"
|-
! Index !! Method !! Request Type !! Description
|-
| 1 || action_allowed || HELPER FUNCTION || Determines whether the current user has permission to perform certain actions based on their role
|-
| 2 || auto_complete_for_user_name || GET || Provides an autocomplete feature for the form input when adding a TA
|-
| 3 || new || GET || Displays the form for creating a new course
|-
| 4 || edit|| GET || Method to get the course to edit
|-
| 5 || update || PUT || Method to update an existing course based on the form input and save the changes to database
|-
| 6 || copy || GET || Creates a new copy of an existing course with a new submission directory and saves it to the database
|-
| 7 || create || POST || Creates a new course based on the form input and saves it to database
|-
| 8 || delete || DELETE || Method to delete an existing course
|-
| 9 || view_teaching_assistant || GET || Displays all the teaching assistants for a course
|-
| 10 || add_ta || POST || Method to add teaching assistant to a course
|-
| 11 || remove_ta || POST || Method to remove teaching assistant from a course
|-
| 12 || set_course_fields || POST || Called in Update and Create methods to set the fields of course
|-

|}

====Model====

{| class="wikitable" style="margin-left:40px"
|-
! Index !! Method !! Description
|-
| 1 || get_teams || Returns any predefined teams associated with a particular course object
|-
| 2 || get_participants || Returns multiple records of course participants from database given parent_id and user_id
|-
| 3 || get_participant || Returns a single record course participant from Course Participant given parent_id
|-
| 4 || add _participant || Add a new Course Participant to the course given user_name
|-
| 5 || copy_participants || Copies all the participants from a given assignment to the current course
|-
| 6 || user_on_team || Checks whether a given user is a member of any team associated with the course
|-
| 7 || path || Returns the course's submission directory
|-

|}

==Testing Plan==
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.

====Tests====
'''Course Controller'''

{| class="wikitable" style="margin-left:40px"
|-
! Test No. !! Description
|-
| 1 || Tests if the action_allowed disallows all actions when current user is student.
|-
| 2 || Tests if the action_allowed allows all course actions when current user is instructor.
|-
| 3 || Tests if create method returns a 201 Created status code if the resource is successfully created.
|-
| 4 || Tests if create method returns a 422 Unprocessable Entity status code if the resource cannot be created due to validation errors.
|-
| 5 || Tests if the delete method returns a 204 No Content status code if the resource is successfully deleted.
|-
| 6 || Tests if the delete method returns a 404 Not Found status code if the resource cannot be found.
|-
| 7 || Tests if the new method sets the private instance variable.
|-
| 8 || Tests if the update method returns a 200 OK status code if the resource is successfully updated.
|-
| 9 || Tests if the update method returns a 422 Unprocessable Entity status code if the resource cannot be updated due to validation errors.
|-
| 10 || Tests if the topic_name method returns the participant topic name when not nil.
|-
| 11 || Tests if the auto_complete_for_user_name method returns a list of users.
|-
| 12 || Tests if the copy method redirects to new course when new course id fetched successfully.
|-
| 13 || Tests if the view_teaching_assistants method returns list of TAs for the course.
|-
| 14 || Tests if the add_ta method returns a 200 OK status code if a TA added successfully to the course.
|-
| 13 || Tests if the add_ta method returns a 422 Unprocessable Entity status code if a TA cannot be added to the course.
|-
| 14 || Tests if the remove_ta method returns a 204 No Content status code if the ta is successfully removed from the course.
|-
| 15 || Tests if the remove_ta method returns a 404 Not Found status code if the ta cannot be found.
|-
| 16 || Tests if the set_course_fields method sets the course fields.
|}

'''Course Model'''

{| class="wikitable" style="margin-left:40px"
|-
! Test No. !! Description
|-
| 1 || Tests if the model validates presence of name
|-
| 2 || Tests if the model validates presence of directory_path
|-
| 3 || Tests if path method raises an error when there is no associated instructor.
|-
| 4 || Tests if path method returns a directory when there is an associated instructor.

|}

==Description==

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.

What needs to be done:
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.
As mentioned in the guideline, take reference from the User (model & 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.

== Relevant Links ==
* '''Github Repository:''' https://github.com/ameyagv/reimplementation-back-end
* '''Pull Request:'''
* '''VCL Server:'''

== Contributors to this project ==
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

2023-04-07T21:16:16Z

Khrawool: /* Model */

CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

2023-04-07T21:15:23Z

Khrawool: /* Testing Plan */

CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

2023-04-07T20:34:50Z

Khrawool: /* Testing Plan */

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-04-07T20:34:27Z

Khrawool: Undo revision 149100 by Khrawool (talk)

This wiki page is for the description of changes made under E2317 OSS assignment for Spring 2023, CSC/ECE 517

__TOC__

==About Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. It is a web application which is maintained collectively by NC State faculty and students which allows instructors to create new assignments and customize new or existing assignments. It also allows the instructors to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

==Overview of the Classes==
===participant.rb===
The participant.rb is a model class that has many associations with other models. There are many methods present in it such as fullname, name, team and handle. There is a method called delete which checks for any associations before performing the delete operation. The other methods include topic_name, mail_assigned_reviewers, able_to_review, email, authorization and self.sort_by_name. There is one more method self.export that returns the information of the participant as a CSV file.

==Backgroud of the Project==
The participant.rb model has many new changes to be implemented. The reimplementation has to make sense and while checking the original model, we realised that some of the methods were irrelevant to participants model and that it has to be implemented in some other model. The changes mainly dealt with removing, merging and replacing methods to segregate methods with a single functionality relevant to participants model. Tests were written for all of the methods that were introduced and modified. Existing tests for the methods that were unchanged were run to ensure proper functioning of the model. Comments are added to each method to enhance readability. Further information about the reimplementations are discussed below.

==Design Decisions==
The following changes were reimplemented in the participant.rb

{| class="wikitable" style="margin-left:40px"
|-
! Tasks !! Status !! Testing
|-
| Replaced force_delete method with leave_team method
|| Implemented || Completed
|-
| mail_assigned_reviewers method was removed || Implemented || N/A
|-
| able_to_review method was eliminated || Implemented || N/A
|-
| email method was removed || Implemented || N/A
|}

=== Replaced force_delete Method with leave_team Method ===
The original 'force_delete' method would delete the participant from the team and if there is only one participant in the team then it would delete the team.
[[File:E2317_force_delete.jpg | 800px]]

A new method 'leave_team' was introduced in place of 'force_delete' as 'force_delete' method is supposed to be present in the teams.rb and not participant.rb. The difference between force_delete method and this is that even if there is only one participant it wouldn't delete the team.

[[File:E2317__leave_team.jpg | 800px]]

=== mail_assigned_reviewers Method was Removed ===
The method 'Mail_assigned_reviewers' is responsible for sending an email to the assigned reviewer whenever a new submission is made. It would be more appropriate for this method to be included in teams.rb rather than participant.rb. Hence, this method was removed.

=== able_to_review Method was Removed ===
'able_to_review' method is just using can_review value. This method can be eliminated.

=== email Method was Removed ===
'email' method was removed as it was not required.

=== Merged export and export_fields Methods ===
We didn't implement this task as merging two functions became a hassle for debugging and testing and fixing errors present in the code. Instead, it is generally considered good programming practice to break down large functions into smaller, more manageable ones. This principle is commonly known as the "Single Responsibility Principle," which states that a function or module should have only one reason to change. By breaking down a large function into smaller functions, made our code more modular and easier to read, understand, and maintain.

[[File:E2317__export_exportfield.jpg | 800px]]

==Testing Plan==

The reimplementation codebase originally used Minitest to test the included models: assignment.rb, role.rb, and user.rb. But since Expertiza was originally tested with RSpec, we used RSpec to test out model. The participants.rb contains many methods and associations with other models. Hence, to test the methods in participants, the other dependent methods have to be stubbed. To deal with the models, dummy models/dummy app can be created which will act as the associated classes. We have created all the required dummy classes by scaffolding them.

To create test fixtures and to build the required models, Factory Bot has been used. Two separate files, factories.rb and factory_bot.rb was created to build the factories.

4 participants and other required fields were created as fixtures after which the tests were written.

====Note====

The dummy classes that were created and other dependencies that were specifically installed for testing have been pushed to a different branch to not let the main codebase clutter with empty models.

To run the tests, kindly pull from the [https://github.com/amarthyasa/reimplementation-back-end/tree/testing_files testing_files] branch of the repository and run bundle install to install dependencies like RSpec and Factory Bot.

====Tests====

{| class="wikitable" style="margin-left:40px"
|-
! Test No. !! Description
|-
| 1 || Tests if the team method returns the team of the participant
|-
| 2 || Tests if the leave_team method deletes a participant if no associations exist and force is nil
|-
| 3 || Tests if the leave_team method deletes a participant if no associations exist and force is true
|-
| 4 || Tests if the leave_team method deletes a participant with associations and force is true and there are multiple team users
|-
| 5 || Tests if the name method returns the name of the participant
|-
| 6 || Tests if the fullname method returns the full name of the participant
|-
| 7 || Tests if the handle method returns the handle of the participant
|-
| 8 || Tests if the sort_by_name method returns a sorted list of participants in alphabetical order
|-
| 9 || Tests if the topic_name method returns the participant topic name when nil
|-
| 10 || Tests if the topic_name method returns the participant topic name when not nil.
|-
| 11 || Tests if the authorization method returns participant when no arguments are passed.
|-
| 12 || Tests if the authorization method returns reader when no arguments are passed.
|-
| 13 || Tests if the authorization method returns submitter when no arguments are passed.
|-
| 14 || Tests if the authorization method returns reviewer when no arguments are passed.
|-
| 13 || Tests if the authorization method returns submitter when no arguments are passed.
|-
| 14 || Tests if the authorization method returns reviewer when no arguments are passed.
|-
| 15 || Tests if it returns participant data in the correct format.
|-
| 16 || Test if it exports the details of the participant correctly.

|}

The test which checks if participant and team is deleted if only one participant is on a team is deleted since that implementation has been removed from the model.

=====Test 1=====
This code is testing a method team and is expected to return the team associated with the participant. It is done by mocking the behavior of other objects that the team method relies on, specifically a user object and a team_user object. By mocking these dependencies, the test can focus on testing the behavior of the team method in isolation.

[[File:E2317_Test1.jpg | 800px]]

=====Tests 2 to 4=====
This is a set of tests for the delete method of a participant object. The first two tests check that a participant can be deleted if there are no associations, with and without the force parameter. The third test checks that a participant can be deleted even if there are associations with multiple team_users, but only if the force parameter is true. The allow method is used to set up mock behavior for the team and participant objects in the third test.

[[File:E2317_Test234.jpg | 800px]]

=====Test 5=====
This is a test block for the name method of the participant object. The test checks if calling name on a participant object returns the expected name of 'Jane'. If the method is working correctly, the test should pass.

[[File:E2317_Test5.jpg | 800px]]

=====Test 6=====
This is a test block for the fullname method of the participant object. The test checks if calling the full name on a participant object returns the expected name of 'Jane Doe'. If the method is working correctly, the test should pass.

[[File:E2317_Test6.jpg | 800px]]

=====Test 7=====
This code defines a test suite for the handle method of the participant object. The method takes a single parameter (nil in this case). The test case verifies that the handle method returns the string 'handle' when called with a nil argument.

[[File:E2317_Test7.jpg | 800px]]

=====Test 8=====
This is a test case for the sort_by_name method of the Participant class. The test checks whether the method returns a sorted list of participants in alphabetical order by their names. The test creates an array unsorted of three participant objects with unordered names and creates another array sorted of the same participants with names sorted alphabetically. The sort_by_name method is called with the unsorted array as its argument and the test expects the result to be the sorted array. If the method is implemented correctly, it should return the participants sorted by name in alphabetical order.

[[File:E2317_Test8.jpg | 800px]]

=====Tests 9 to 10=====
This is a test suite for the #topic_name method of the Participant class. The first example checks that when the participant's topic attribute is nil, the method should return a default string. The second example checks that when the participant's topic attribute is not nil, the method should return the name attribute of the associated topic object. This is done by using the allow method to stub the topic method of the participant object and return a mock topic object with a name attribute of 'Hello world!'. Overall, these examples test the behavior of the #topic_name method in returning the correct string depending on the presence or absence of a topic object associated with the participant.

[[File:E2317_Test910.jpg | 800px]]

=====Tests 11 to 14=====
This is the test suite for the authorization method of the Participant class. The authorization method returns a string representing the participant's authorization level based on their permissions to submit, review, and take quizzes. Each test case checks if the method returns the expected authorization level when certain permissions are allowed or disallowed for the participant. The first test case tests the default authorization level of the participant when no permissions are set. The second and third test cases test for reader and submitter authorization levels, respectively, when the corresponding permissions are set. The fourth test case tests for reviewer authorization level when only the can_review permission is set.

[[File:E2317_Test1114.jpg | 800px]]

=====Tests 15 to 16=====
The first block of code describes a unit test for the export_fields method of the Participant class. It sets up a hash of options for the method and expects it to return an array of field names in a specific order. The second block of code describes a unit test for the export method of the Participant class. It sets up a parent_id variable, a csv array, and some options, and then sets up mock responses for the where and user methods to simulate a participant being found. It expects the export method to return an array of arrays representing the data for the found participant, in the order specified by the export_fields method.

[[File:E2317_Test1516.jpg | 800px]]

==Relevant Links==

Github repository: https://github.com/amarthyasa/reimplementation-back-end/tree/main
 
Github repository branch for testing: https://github.com/amarthyasa/reimplementation-back-end/tree/testing_files
 
Pull request: https://github.com/expertiza/reimplementation-back-end/pull/5
 
Testing video: https://drive.google.com/file/d/1VXMF8dbJgjcj68Y9pRTgXg2cJrfL9-_6/view?usp=sharing

==Team==
===Mentor===
Rucha Kolekar

===Student Team===
Amarthya Sivakumar Annu (asivaku5@ncsu.edu) 
Ajay Krishna Raveendar (araveen@ncsu.edu) 
Kiron Jayesh (kjayesh@ncsu.edu)

CSC/ECE 517 Spring 2023 - E2317: Reimplement participant.rb

2023-04-07T20:32:10Z

Khrawool: /* Testing Plan */

CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

2023-04-07T19:14:03Z

Khrawool: /* Testing Plan */

CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

2023-04-07T19:12:29Z

Khrawool: /* Relevant Links */

CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

2023-04-07T19:11:06Z

Khrawool:

CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

2023-04-07T19:08:19Z

Khrawool:

CSC/ECE 517/Spring 2023/E2332 Refactor course.rb and course team.rb models

2023-04-05T22:22:09Z

Khrawool: Khrawool moved page CSC/ECE 517/Spring 2023/E2332 Refactor course.rb and course team.rb models to CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

#REDIRECT [[CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)]]

CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

2023-04-05T22:22:09Z

Khrawool: Khrawool moved page CSC/ECE 517/Spring 2023/E2332 Refactor course.rb and course team.rb models to CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

2023-04-05T22:21:51Z

Khrawool:

CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

2023-04-05T22:20:55Z

Khrawool: /* Description */

E2332 - Refactor course.rb and course_team.rb models

__TOC__

== Team Contact ==
=== Team Members ===
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

=== Mentor ===
* Kartiki Bhandakkar, kbhanda3

==Description==

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.

What needs to be done:
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.
As mentioned in the guideline, take reference from the User (model & 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.

== Relevant Links ==
* '''Github Repository:'''
* '''Pull Request:'''
* '''VCL Server:'''

== Contributors to this project ==
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

2023-04-05T22:20:05Z

Khrawool:

User:Khrawool

2023-04-05T22:18:28Z

Khrawool: Khrawool moved page User:Khrawool to CSC/ECE 517/Spring 2023/E2332 Refactor course.rb and course team.rb models

#REDIRECT [[CSC/ECE 517/Spring 2023/E2332 Refactor course.rb and course team.rb models]]

CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

2023-04-05T22:18:28Z

Khrawool: Khrawool moved page User:Khrawool to CSC/ECE 517/Spring 2023/E2332 Refactor course.rb and course team.rb models

E2332 - Refactor course.rb and course_team.rb models

==Background==

CSC/ECE 517/Spring 2023/E2332 Reimplement Courses (Refactor course.rb)

2023-04-05T22:16:09Z

Khrawool: Created page with "E2332 - Refactor course.rb and course_team.rb models ==Background=="

E2332 - Refactor course.rb and course_team.rb models

==Background==

CSC/ECE 517/Spring 2023/E2308. Refactor course.rb and course team.rb models

2023-03-28T03:13:55Z

Khrawool: /* Test Plan */

__TOC__

== Team Contact ==
=== Team Members ===
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

=== Mentor ===
* Kartiki Bhandakkar, kbhanda3

== Overview of Expertiza ==
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 <code>Course</code> and <code>CourseTeam</code> which are the models primarily addressed in this project are both critical components in providing this functionality.

== Description of Project ==
<code>course</code> 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.

The <code>course_team</code> 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.

== Files Modified ==
== CHANGES IN MODEL FILES ==
=== Changes to <code>app/models/course.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Checked and Removed <code>get_participant</code> method
|Checked the usage of Method through IDE whether the function is used, the only call was from <code>course_spec.rb</code> and not from anywhere else. Hence, removed from <code>course.rb</code>
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|-
|2
|style="width: 30%"| Renamed <code>copy_participants</code> method
|Renamed <code>copy_participants</code> to <code>copy_assignment_participants</code> which makes more sense and a clear idea of how method works and what is the purpose of method.
|[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]
|-
|3
|Removed <code>add_member</code> method from <code>course_team</code> model
|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.
|[https://github.com/expertiza/expertiza/pull/2548/commits/8fb9bf9a793b8c154bc2b640daa630624e008a86 Commit]
|-
|4
|Created method <code>raise_errors</code>
|To reduce Cognitive Complexity of method <code>copy_participants</code>
|[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]
|}

=== Changes to <code>app/models/course_team.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Removed <code>assignment_id</code>
|CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute <code>parent_id</code> that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for <code>assignment_id</code> in the CourseTeam class and no need for <code>course_id</code> 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.
|[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]
|-
|2
|Renamed <code>copy</code> method as <code>copy_to_assignment_team</code>
|As this method is copying a CourseTeam to an AssignmentTeam, renamed it as <code>copy_to_assignment_team</code>. A suggestion for copy method in AssignmentTeam would be to rename it as <code>copy_to_course_team</code>.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-56ab3d3b28f0be68663223f0a5ef9daa5c8d106caca412481562272ab2edfae1 Commit] 
|-
|3
|Added Import Functionality
|DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.
|[https://github.com/kartikrawool/expertiza/commit/972c66e47fbc22965490cc4da3ae69a56d076d6b Commit]
|}

=== Changes to <code>app/models/assignment_team.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> method for AssignmentTeam
|Renamed <code>copy</code> for copying current AssignmentTeam to CourseTeam as <code>copy_to_course_team</code>
|[https://github.com/kartikrawool/expertiza/commit/b93df2590a7ab52f87a1df00512afe626fa81520 Commit]
|-
|2
|Added Import Functionality
|DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.
|[https://github.com/kartikrawool/expertiza/commit/2bae1785a15caede251f81517ecf944302f80d89 Commit]
|}

=== Changes to <code>app/models/team.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Added Import Functionality
|DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.
|[https://github.com/kartikrawool/expertiza/commit/53a86107644d3a0b0bef28a42d499a0b7b386ebb Commit]
|}

== CHANGES IN RSPEC FILES ==

=== Changes to <code>spec/models/course_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Removed the test case for <code>get_paprticipant</code> method test case
|Removed the test case for <code>get_participant</code> method as the method was not used anywhere else in the code.
|[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]
|-
|2
|Renamed <code>copy_participants</code> method test case
|Renamed the respective method of <code>copy_participants</code> to <code>copy_assignment_participants</code>in rspec file as well.
|[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit] 
|}

=== Changes to <code>spec/models/course_team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>in rspec file as well.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-8b753735f47ae84fdf88f7e9f15e08b8dd13ba1bc8fd16abad11148800aa8954 Commit] 
|}

=== Changes to <code>spec/models/course_team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Import functionality changes</code>
|Test cases are added to rspec file as well for import functionality changes.
|[https://github.com/kartikrawool/expertiza/commit/972c66e47fbc22965490cc4da3ae69a56d076d6b Commit] 
|}

=== Changes to <code>spec/models/assignment_team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Import functionality changes</code>
|Test cases are added to rspec file as well for import functionality changes.
|[https://github.com/kartikrawool/expertiza/commit/2bae1785a15caede251f81517ecf944302f80d89 Commit] 
|}

=== Changes to <code>spec/models/team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Import functionality changes</code>
|Test cases are added to rspec file as well for import functionality changes.
|[https://github.com/kartikrawool/expertiza/commit/53a86107644d3a0b0bef28a42d499a0b7b386ebb#diff-638390a8686ba4d2e18c1fc9dfbef22271c8a02bb5d56bf78ded42e428fcf8b1 Commit] 
|}

== CHANGES IN CONTROLLER FILES ==

=== Changes to <code>app/controllers/teams_controller.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>
|The change was directly related to changes of copy method in <code>course_team.rb</code>.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]
|-
|}

== Test Plan ==

Manual Testing
*''' Adding Course Team member'''
** Adding member student1922 to course CSC540
[[File:Before_adding_course_team_member.png|1000px|center|Add course member to team Radical]]
[[File:After_adding_course_team_member.png|1000px|center|Succesffully added member to the team]]

All the suggested changes were made to <code>course.rb</code> and <code>course_team.rb</code>, 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. The methods were tested for edge cases and positive and negative test cases were written. The refactored methods were updated in the test cases.

*<code>'''course_team'''</code>

[[File:course_team_spec.jpg|1000px|center|Test passing for <code>course_team.rb</code>]]

*<code>'''course'''</code>

[[File:course_spec.jpg|1000px|center|Test passing for <code>course_team.rb</code>]]

*<code>'''assignment_team'''</code>

[[File:assignment_team_spec.jpg|1000px|center|Test passing for <code>course_team.rb</code>]]

*<code>'''team.rb'''</code>

[[File:team_spec_output.jpg|1000px|center|Test passing for <code>course_team.rb</code>]]

=== Coverage: ===
'''Before refactoring'''
[[File:coverage_old.jpg|center|frame|Coverage of codebase before refactoring]]

[[File:course_team_coverage.jpg|center|frame|Coverage of <code>course_team.rb</code> before refactoring]]

[[File:course_coverage.jpg|center|frame|Coverage of <code>course.rb</code> before refactoring]]

[[File:assignment_team_coverage.jpg|center|frame|Coverage of <code>assignment_team.rb</code> before refactoring]]

[[File:team_coverage.jpg|center|frame|Coverage of <code>team.rb</code> before refactoring]]

'''After refactoring'''
[[File:coverage_refactor.jpg|center|frame|Coverage of codebase after refactoring]]

[[File:course_team_coverage_refactor.jpg|center|frame|Coverage of <code>course_team.rb</code> after refactoring]]

[[File:course_coverage_refactor.jpg|center|frame|Coverage of <code>course.rb</code> after refactoring]]

[[File: assignment_team_coverage_refactor.jpg|center|frame|Coverage of <code>assignment_team.rb</code> after refactoring]]

[[File:team_coverage_refactor.jpg|center|frame|Coverage of <code>team.rb</code> after refactoring]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548
* '''VCL Server:''' http://152.7.178.105:8080/

== Contributors to this project ==
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

CSC/ECE 517/Spring 2023/E2308. Refactor course.rb and course team.rb models

2023-03-28T03:09:25Z

Khrawool: /* Test Plan */

__TOC__

== Team Contact ==
=== Team Members ===
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

=== Mentor ===
* Kartiki Bhandakkar, kbhanda3

== Overview of Expertiza ==
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 <code>Course</code> and <code>CourseTeam</code> which are the models primarily addressed in this project are both critical components in providing this functionality.

== Description of Project ==
<code>course</code> 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.

The <code>course_team</code> 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.

== Files Modified ==
== CHANGES IN MODEL FILES ==
=== Changes to <code>app/models/course.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Checked and Removed <code>get_participant</code> method
|Checked the usage of Method through IDE whether the function is used, the only call was from <code>course_spec.rb</code> and not from anywhere else. Hence, removed from <code>course.rb</code>
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|-
|2
|style="width: 30%"| Renamed <code>copy_participants</code> method
|Renamed <code>copy_participants</code> to <code>copy_assignment_participants</code> which makes more sense and a clear idea of how method works and what is the purpose of method.
|[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]
|-
|3
|Removed <code>add_member</code> method from <code>course_team</code> model
|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.
|[https://github.com/expertiza/expertiza/pull/2548/commits/8fb9bf9a793b8c154bc2b640daa630624e008a86 Commit]
|-
|4
|Created method <code>raise_errors</code>
|To reduce Cognitive Complexity of method <code>copy_participants</code>
|[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]
|}

=== Changes to <code>app/models/course_team.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Removed <code>assignment_id</code>
|CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute <code>parent_id</code> that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for <code>assignment_id</code> in the CourseTeam class and no need for <code>course_id</code> 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.
|[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]
|-
|2
|Renamed <code>copy</code> method as <code>copy_to_assignment_team</code>
|As this method is copying a CourseTeam to an AssignmentTeam, renamed it as <code>copy_to_assignment_team</code>. A suggestion for copy method in AssignmentTeam would be to rename it as <code>copy_to_course_team</code>.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-56ab3d3b28f0be68663223f0a5ef9daa5c8d106caca412481562272ab2edfae1 Commit] 
|-
|3
|Added Import Functionality
|DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.
|[https://github.com/kartikrawool/expertiza/commit/972c66e47fbc22965490cc4da3ae69a56d076d6b Commit]
|}

=== Changes to <code>app/models/assignment_team.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> method for AssignmentTeam
|Renamed <code>copy</code> for copying current AssignmentTeam to CourseTeam as <code>copy_to_course_team</code>
|[https://github.com/kartikrawool/expertiza/commit/b93df2590a7ab52f87a1df00512afe626fa81520 Commit]
|-
|2
|Added Import Functionality
|DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.
|[https://github.com/kartikrawool/expertiza/commit/2bae1785a15caede251f81517ecf944302f80d89 Commit]
|}

=== Changes to <code>app/models/team.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Added Import Functionality
|DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.
|[https://github.com/kartikrawool/expertiza/commit/53a86107644d3a0b0bef28a42d499a0b7b386ebb Commit]
|}

== CHANGES IN RSPEC FILES ==

=== Changes to <code>spec/models/course_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Removed the test case for <code>get_paprticipant</code> method test case
|Removed the test case for <code>get_participant</code> method as the method was not used anywhere else in the code.
|[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]
|-
|2
|Renamed <code>copy_participants</code> method test case
|Renamed the respective method of <code>copy_participants</code> to <code>copy_assignment_participants</code>in rspec file as well.
|[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit] 
|}

=== Changes to <code>spec/models/course_team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>in rspec file as well.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-8b753735f47ae84fdf88f7e9f15e08b8dd13ba1bc8fd16abad11148800aa8954 Commit] 
|}

=== Changes to <code>spec/models/course_team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Import functionality changes</code>
|Test cases are added to rspec file as well for import functionality changes.
|[https://github.com/kartikrawool/expertiza/commit/972c66e47fbc22965490cc4da3ae69a56d076d6b Commit] 
|}

=== Changes to <code>spec/models/assignment_team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Import functionality changes</code>
|Test cases are added to rspec file as well for import functionality changes.
|[https://github.com/kartikrawool/expertiza/commit/2bae1785a15caede251f81517ecf944302f80d89 Commit] 
|}

=== Changes to <code>spec/models/team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Import functionality changes</code>
|Test cases are added to rspec file as well for import functionality changes.
|[https://github.com/kartikrawool/expertiza/commit/53a86107644d3a0b0bef28a42d499a0b7b386ebb#diff-638390a8686ba4d2e18c1fc9dfbef22271c8a02bb5d56bf78ded42e428fcf8b1 Commit] 
|}

== CHANGES IN CONTROLLER FILES ==

=== Changes to <code>app/controllers/teams_controller.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>
|The change was directly related to changes of copy method in <code>course_team.rb</code>.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]
|-
|}

== Test Plan ==

All the suggested changes were made to <code>course.rb</code> and <code>course_team.rb</code>, 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

*<code>'''course_team'''</code>

[[File:course_team_spec.jpg|1000px|center|Test passing for <code>course_team.rb</code>]]

*<code>'''course'''</code>

[[File:course_spec.jpg|1000px|center|Test passing for <code>course_team.rb</code>]]

*<code>'''assignment_team'''</code>

[[File:assignment_team_spec.jpg|1000px|center|Test passing for <code>course_team.rb</code>]]

*<code>'''team.rb'''</code>

[[File:team_spec_output.jpg|1000px|center|Test passing for <code>course_team.rb</code>]]

=== Coverage: ===
'''Before refactoring'''
[[File:coverage_old.jpg|center|frame|Coverage of codebase before refactoring]]

[[File:course_team_coverage.jpg|center|frame|Coverage of <code>course_team.rb</code> before refactoring]]

[[File:course_coverage.jpg|center|frame|Coverage of <code>course.rb</code> before refactoring]]

[[File:assignment_team_coverage.jpg|center|frame|Coverage of <code>assignment_team.rb</code> before refactoring]]

[[File:team_coverage.jpg|center|frame|Coverage of <code>team.rb</code> before refactoring]]

'''After refactoring'''
[[File:coverage_refactor.jpg|center|frame|Coverage of codebase after refactoring]]

[[File:course_team_coverage_refactor.jpg|center|frame|Coverage of <code>course_team.rb</code> after refactoring]]

[[File:course_coverage_refactor.jpg|center|frame|Coverage of <code>course.rb</code> after refactoring]]

[[File: assignment_team_coverage_refactor.jpg|center|frame|Coverage of <code>assignment_team.rb</code> after refactoring]]

[[File:team_coverage_refactor.jpg|center|frame|Coverage of <code>team.rb</code> after refactoring]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548
* '''VCL Server:''' http://152.7.178.105:8080/

== Contributors to this project ==
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

CSC/ECE 517/Spring 2023/E2308. Refactor course.rb and course team.rb models

2023-03-28T02:56:44Z

Khrawool: /* Coverage: */

__TOC__

== Team Contact ==
=== Team Members ===
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

=== Mentor ===
* Kartiki Bhandakkar, kbhanda3

== Overview of Expertiza ==
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 <code>Course</code> and <code>CourseTeam</code> which are the models primarily addressed in this project are both critical components in providing this functionality.

== Description of Project ==
<code>course</code> 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.

The <code>course_team</code> 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.

== Files Modified ==
== CHANGES IN MODEL FILES ==
=== Changes to <code>app/models/course.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Checked and Removed <code>get_participant</code> method
|Checked the usage of Method through IDE whether the function is used, the only call was from <code>course_spec.rb</code> and not from anywhere else. Hence, removed from <code>course.rb</code>
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|-
|2
|style="width: 30%"| Renamed <code>copy_participants</code> method
|Renamed <code>copy_participants</code> to <code>copy_assignment_participants</code> which makes more sense and a clear idea of how method works and what is the purpose of method.
|[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]
|-
|3
|Removed <code>add_member</code> method from <code>course_team</code> model
|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.
|[https://github.com/expertiza/expertiza/pull/2548/commits/8fb9bf9a793b8c154bc2b640daa630624e008a86 Commit]
|-
|4
|Created method <code>raise_errors</code>
|To reduce Cognitive Complexity of method <code>copy_participants</code>
|[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]
|}

=== Changes to <code>app/models/course_team.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Removed <code>assignment_id</code>
|CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute <code>parent_id</code> that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for <code>assignment_id</code> in the CourseTeam class and no need for <code>course_id</code> 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.
|[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]
|-
|2
|Renamed <code>copy</code> method as <code>copy_to_assignment_team</code>
|As this method is copying a CourseTeam to an AssignmentTeam, renamed it as <code>copy_to_assignment_team</code>. A suggestion for copy method in AssignmentTeam would be to rename it as <code>copy_to_course_team</code>.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-56ab3d3b28f0be68663223f0a5ef9daa5c8d106caca412481562272ab2edfae1 Commit] 
|-
|3
|Added Import Functionality
|DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.
|[https://github.com/kartikrawool/expertiza/commit/972c66e47fbc22965490cc4da3ae69a56d076d6b Commit]
|}

=== Changes to <code>app/models/assignment_team.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> method for AssignmentTeam
|Renamed <code>copy</code> for copying current AssignmentTeam to CourseTeam as <code>copy_to_course_team</code>
|[https://github.com/kartikrawool/expertiza/commit/b93df2590a7ab52f87a1df00512afe626fa81520 Commit]
|-
|2
|Added Import Functionality
|DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.
|[https://github.com/kartikrawool/expertiza/commit/2bae1785a15caede251f81517ecf944302f80d89 Commit]
|}

=== Changes to <code>app/models/team.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Added Import Functionality
|DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.
|[https://github.com/kartikrawool/expertiza/commit/53a86107644d3a0b0bef28a42d499a0b7b386ebb Commit]
|}

== CHANGES IN RSPEC FILES ==

=== Changes to <code>spec/models/course_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Removed the test case for <code>get_paprticipant</code> method test case
|Removed the test case for <code>get_participant</code> method as the method was not used anywhere else in the code.
|[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]
|-
|2
|Renamed <code>copy_participants</code> method test case
|Renamed the respective method of <code>copy_participants</code> to <code>copy_assignment_participants</code>in rspec file as well.
|[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit] 
|}

=== Changes to <code>spec/models/course_team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>in rspec file as well.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-8b753735f47ae84fdf88f7e9f15e08b8dd13ba1bc8fd16abad11148800aa8954 Commit] 
|}

=== Changes to <code>spec/models/course_team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Import functionality changes</code>
|Test cases are added to rspec file as well for import functionality changes.
|[https://github.com/kartikrawool/expertiza/commit/972c66e47fbc22965490cc4da3ae69a56d076d6b Commit] 
|}

=== Changes to <code>spec/models/assignment_team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Import functionality changes</code>
|Test cases are added to rspec file as well for import functionality changes.
|[https://github.com/kartikrawool/expertiza/commit/2bae1785a15caede251f81517ecf944302f80d89 Commit] 
|}

=== Changes to <code>spec/models/team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Import functionality changes</code>
|Test cases are added to rspec file as well for import functionality changes.
|[https://github.com/kartikrawool/expertiza/commit/53a86107644d3a0b0bef28a42d499a0b7b386ebb#diff-638390a8686ba4d2e18c1fc9dfbef22271c8a02bb5d56bf78ded42e428fcf8b1 Commit] 
|}

== CHANGES IN CONTROLLER FILES ==

=== Changes to <code>app/controllers/teams_controller.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>
|The change was directly related to changes of copy method in <code>course_team.rb</code>.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]
|-
|}

== Test Plan ==

All the suggested changes were made to <code>course.rb</code> and <code>course_team.rb</code>, 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

*'''course_team'''
** Validation of presence of name and directory path
** return If directory is return when an associated instructor is p
[[File:course_team_spec.jpg|1000px|center|Test passing for <code>course_team.rb</code>]]

*'''course'''
**
[[File:course_spec.jpg|1000px|center|Test passing for <code>course_team.rb</code>]]
*'''assignment_team'''
**
[[File:assignment_team_spec.jpg|1000px|center|Test passing for <code>course_team.rb</code>]]

*'''team.rb'''
**
[[File:team_spec_output.jpg|1000px|center|Test passing for <code>course_team.rb</code>]]

=== Coverage: ===
'''Before refactoring'''
[[File:coverage_old.jpg|center|frame|Coverage of codebase before refactoring]]

[[File:course_team_coverage.jpg|center|frame|Coverage of <code>course_team.rb</code> before refactoring]]

[[File:course_coverage.jpg|center|frame|Coverage of <code>course.rb</code> before refactoring]]

[[File:assignment_team_coverage.jpg|center|frame|Coverage of <code>assignment_team.rb</code> before refactoring]]

[[File:team_coverage.jpg|center|frame|Coverage of <code>team.rb</code> before refactoring]]

'''After refactoring'''
[[File:coverage_refactor.jpg|center|frame|Coverage of codebase after refactoring]]

[[File:course_team_coverage_refactor.jpg|center|frame|Coverage of <code>course_team.rb</code> after refactoring]]

[[File:course_coverage_refactor.jpg|center|frame|Coverage of <code>course.rb</code> after refactoring]]

[[File: assignment_team_coverage_refactor.jpg|center|frame|Coverage of <code>assignment_team.rb</code> after refactoring]]

[[File:team_coverage_refactor.jpg|center|frame|Coverage of <code>team.rb</code> after refactoring]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548
* '''VCL Server:''' http://152.7.178.105:8080/

== Contributors to this project ==
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

File:Course coverage refactor.jpg

2023-03-28T02:55:43Z

Khrawool:

File:Assignment team coverage refactor.jpg

2023-03-28T02:55:07Z

Khrawool:

File:Course team coverage refactor.jpg

2023-03-28T02:53:45Z

Khrawool:

File:Team coverage refactor.jpg

2023-03-28T02:52:56Z

Khrawool:

File:Coverage refactor.jpg

2023-03-28T02:52:08Z

Khrawool:

CSC/ECE 517/Spring 2023/E2308. Refactor course.rb and course team.rb models

2023-03-28T02:46:45Z

Khrawool: /* Test Plan */

__TOC__

== Team Contact ==
=== Team Members ===
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

=== Mentor ===
* Kartiki Bhandakkar, kbhanda3

== Overview of Expertiza ==
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 <code>Course</code> and <code>CourseTeam</code> which are the models primarily addressed in this project are both critical components in providing this functionality.

== Description of Project ==
<code>course</code> 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.

The <code>course_team</code> 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.

== Files Modified ==
== CHANGES IN MODEL FILES ==
=== Changes to <code>app/models/course.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Checked and Removed <code>get_participant</code> method
|Checked the usage of Method through IDE whether the function is used, the only call was from <code>course_spec.rb</code> and not from anywhere else. Hence, removed from <code>course.rb</code>
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|-
|2
|style="width: 30%"| Renamed <code>copy_participants</code> method
|Renamed <code>copy_participants</code> to <code>copy_assignment_participants</code> which makes more sense and a clear idea of how method works and what is the purpose of method.
|[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]
|-
|3
|Removed <code>add_member</code> method from <code>course_team</code> model
|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.
|[https://github.com/expertiza/expertiza/pull/2548/commits/8fb9bf9a793b8c154bc2b640daa630624e008a86 Commit]
|-
|4
|Created method <code>raise_errors</code>
|To reduce Cognitive Complexity of method <code>copy_participants</code>
|[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]
|}

=== Changes to <code>app/models/course_team.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Removed <code>assignment_id</code>
|CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute <code>parent_id</code> that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for <code>assignment_id</code> in the CourseTeam class and no need for <code>course_id</code> 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.
|[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]
|-
|2
|Renamed <code>copy</code> method as <code>copy_to_assignment_team</code>
|As this method is copying a CourseTeam to an AssignmentTeam, renamed it as <code>copy_to_assignment_team</code>. A suggestion for copy method in AssignmentTeam would be to rename it as <code>copy_to_course_team</code>.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-56ab3d3b28f0be68663223f0a5ef9daa5c8d106caca412481562272ab2edfae1 Commit] 
|-
|3
|Added Import Functionality
|DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.
|[https://github.com/kartikrawool/expertiza/commit/972c66e47fbc22965490cc4da3ae69a56d076d6b Commit]
|}

=== Changes to <code>app/models/assignment_team.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> method for AssignmentTeam
|Renamed <code>copy</code> for copying current AssignmentTeam to CourseTeam as <code>copy_to_course_team</code>
|[https://github.com/kartikrawool/expertiza/commit/b93df2590a7ab52f87a1df00512afe626fa81520 Commit]
|-
|2
|Added Import Functionality
|DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.
|[https://github.com/kartikrawool/expertiza/commit/2bae1785a15caede251f81517ecf944302f80d89 Commit]
|}

=== Changes to <code>app/models/team.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Added Import Functionality
|DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.
|[https://github.com/kartikrawool/expertiza/commit/53a86107644d3a0b0bef28a42d499a0b7b386ebb Commit]
|}

== CHANGES IN RSPEC FILES ==

=== Changes to <code>spec/models/course_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Removed the test case for <code>get_paprticipant</code> method test case
|Removed the test case for <code>get_participant</code> method as the method was not used anywhere else in the code.
|[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]
|-
|2
|Renamed <code>copy_participants</code> method test case
|Renamed the respective method of <code>copy_participants</code> to <code>copy_assignment_participants</code>in rspec file as well.
|[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit] 
|}

=== Changes to <code>spec/models/course_team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>in rspec file as well.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-8b753735f47ae84fdf88f7e9f15e08b8dd13ba1bc8fd16abad11148800aa8954 Commit] 
|}

=== Changes to <code>spec/models/course_team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Import functionality changes</code>
|Test cases are added to rspec file as well for import functionality changes.
|[https://github.com/kartikrawool/expertiza/commit/972c66e47fbc22965490cc4da3ae69a56d076d6b Commit] 
|}

=== Changes to <code>spec/models/assignment_team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Import functionality changes</code>
|Test cases are added to rspec file as well for import functionality changes.
|[https://github.com/kartikrawool/expertiza/commit/2bae1785a15caede251f81517ecf944302f80d89 Commit] 
|}

=== Changes to <code>spec/models/team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Import functionality changes</code>
|Test cases are added to rspec file as well for import functionality changes.
|[https://github.com/kartikrawool/expertiza/commit/53a86107644d3a0b0bef28a42d499a0b7b386ebb#diff-638390a8686ba4d2e18c1fc9dfbef22271c8a02bb5d56bf78ded42e428fcf8b1 Commit] 
|}

== CHANGES IN CONTROLLER FILES ==

=== Changes to <code>app/controllers/teams_controller.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>
|The change was directly related to changes of copy method in <code>course_team.rb</code>.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]
|-
|}

== Test Plan ==

All the suggested changes were made to <code>course.rb</code> and <code>course_team.rb</code>, 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

*'''course_team'''
** Validation of presence of name and directory path
** return If directory is return when an associated instructor is p
[[File:course_team_spec.jpg|1000px|center|Test passing for <code>course_team.rb</code>]]

*'''course'''
**
[[File:course_spec.jpg|1000px|center|Test passing for <code>course_team.rb</code>]]
*'''assignment_team'''
**
[[File:assignment_team_spec.jpg|1000px|center|Test passing for <code>course_team.rb</code>]]

*'''team.rb'''
**
[[File:team_spec_output.jpg|1000px|center|Test passing for <code>course_team.rb</code>]]

=== Coverage: ===
[[File:coverage_old.jpg|center|frame|Coverage of codebase before refactoring]]

[[File:course_team_coverage.jpg|center|frame|Coverage of <code>course_team.rb</code> before refactoring]]

[[File:course_coverage.jpg|center|frame|Coverage of <code>course.rb</code> before refactoring]]

[[File:assignment_team_coverage.jpg|center|frame|Coverage of <code>assignment_team.rb</code> before refactoring]]

[[File:team_coverage.jpg|center|frame|Coverage of <code>team.rb</code> before refactoring]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548
* '''VCL Server:''' http://152.7.178.105:8080/

== Contributors to this project ==
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

File:Team spec output.jpg

2023-03-28T02:46:26Z

Khrawool:

File:Course spec.jpg

2023-03-28T02:45:09Z

Khrawool:

File:Assignment team spec.jpg

2023-03-28T02:44:36Z

Khrawool:

File:Course team spec.jpg

2023-03-28T02:40:22Z

Khrawool:

CSC/ECE 517/Spring 2023/E2308. Refactor course.rb and course team.rb models

2023-03-28T02:35:51Z

Khrawool: /* Test Plan */

__TOC__

== Team Contact ==
=== Team Members ===
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

=== Mentor ===
* Kartiki Bhandakkar, kbhanda3

== Overview of Expertiza ==
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 <code>Course</code> and <code>CourseTeam</code> which are the models primarily addressed in this project are both critical components in providing this functionality.

== Description of Project ==
<code>course</code> 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.

The <code>course_team</code> 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.

== Files Modified ==
== CHANGES IN MODEL FILES ==
=== Changes to <code>app/models/course.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Checked and Removed <code>get_participant</code> method
|Checked the usage of Method through IDE whether the function is used, the only call was from <code>course_spec.rb</code> and not from anywhere else. Hence, removed from <code>course.rb</code>
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|-
|2
|style="width: 30%"| Renamed <code>copy_participants</code> method
|Renamed <code>copy_participants</code> to <code>copy_assignment_participants</code> which makes more sense and a clear idea of how method works and what is the purpose of method.
|[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]
|-
|3
|Removed <code>add_member</code> method from <code>course_team</code> model
|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.
|[https://github.com/expertiza/expertiza/pull/2548/commits/8fb9bf9a793b8c154bc2b640daa630624e008a86 Commit]
|-
|4
|Created method <code>raise_errors</code>
|To reduce Cognitive Complexity of method <code>copy_participants</code>
|[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]
|}

=== Changes to <code>app/models/course_team.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Removed <code>assignment_id</code>
|CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute <code>parent_id</code> that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for <code>assignment_id</code> in the CourseTeam class and no need for <code>course_id</code> 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.
|[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]
|-
|2
|Renamed <code>copy</code> method as <code>copy_to_assignment_team</code>
|As this method is copying a CourseTeam to an AssignmentTeam, renamed it as <code>copy_to_assignment_team</code>. A suggestion for copy method in AssignmentTeam would be to rename it as <code>copy_to_course_team</code>.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-56ab3d3b28f0be68663223f0a5ef9daa5c8d106caca412481562272ab2edfae1 Commit] 
|-
|3
|Added Import Functionality
|DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.
|[https://github.com/kartikrawool/expertiza/commit/972c66e47fbc22965490cc4da3ae69a56d076d6b Commit]
|}

=== Changes to <code>app/models/assignment_team.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> method for AssignmentTeam
|Renamed <code>copy</code> for copying current AssignmentTeam to CourseTeam as <code>copy_to_course_team</code>
|[https://github.com/kartikrawool/expertiza/commit/b93df2590a7ab52f87a1df00512afe626fa81520 Commit]
|-
|2
|Added Import Functionality
|DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.
|[https://github.com/kartikrawool/expertiza/commit/2bae1785a15caede251f81517ecf944302f80d89 Commit]
|}

=== Changes to <code>app/models/team.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Added Import Functionality
|DESCRIPTIONNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN.
|[https://github.com/kartikrawool/expertiza/commit/53a86107644d3a0b0bef28a42d499a0b7b386ebb Commit]
|}

== CHANGES IN RSPEC FILES ==

=== Changes to <code>spec/models/course_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Removed the test case for <code>get_paprticipant</code> method test case
|Removed the test case for <code>get_participant</code> method as the method was not used anywhere else in the code.
|[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]
|-
|2
|Renamed <code>copy_participants</code> method test case
|Renamed the respective method of <code>copy_participants</code> to <code>copy_assignment_participants</code>in rspec file as well.
|[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit] 
|}

=== Changes to <code>spec/models/course_team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>in rspec file as well.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-8b753735f47ae84fdf88f7e9f15e08b8dd13ba1bc8fd16abad11148800aa8954 Commit] 
|}

=== Changes to <code>spec/models/course_team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Import functionality changes</code>
|Test cases are added to rspec file as well for import functionality changes.
|[https://github.com/kartikrawool/expertiza/commit/972c66e47fbc22965490cc4da3ae69a56d076d6b Commit] 
|}

=== Changes to <code>spec/models/assignment_team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Import functionality changes</code>
|Test cases are added to rspec file as well for import functionality changes.
|[https://github.com/kartikrawool/expertiza/commit/2bae1785a15caede251f81517ecf944302f80d89 Commit] 
|}

=== Changes to <code>spec/models/team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Import functionality changes</code>
|Test cases are added to rspec file as well for import functionality changes.
|[https://github.com/kartikrawool/expertiza/commit/53a86107644d3a0b0bef28a42d499a0b7b386ebb#diff-638390a8686ba4d2e18c1fc9dfbef22271c8a02bb5d56bf78ded42e428fcf8b1 Commit] 
|}

== CHANGES IN CONTROLLER FILES ==

=== Changes to <code>app/controllers/teams_controller.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>
|The change was directly related to changes of copy method in <code>course_team.rb</code>.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]
|-
|}

== Test Plan ==

All the suggested changes were made to <code>course.rb</code> and <code>course_team.rb</code>, 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

*'''course_team'''
** Validation of presence of name and directory path
** return If directory is return when an associated instructor is p
*'''course'''
**
*'''assignment_team'''
**

Coverage:
[[File:coverage_old.jpg|center|frame|Coverage of codebase before refactoring]]

[[File:course_team_coverage.jpg|center|frame|Coverage of <code>course_team.rb</code> before refactoring]]

[[File:course_coverage.jpg|center|frame|Coverage of <code>course.rb</code> before refactoring]]

[[File:assignment_team_coverage.jpg|center|frame|Coverage of <code>assignment_team.rb</code> before refactoring]]

[[File:team_coverage.jpg|center|frame|Coverage of <code>team.rb</code> before refactoring]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548
* '''VCL Server:''' http://152.7.178.105:8080/

== Contributors to this project ==
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

CSC/ECE 517/Spring 2023/E2308. Refactor course.rb and course team.rb models

2023-03-27T23:56:10Z

Khrawool: /* Test Plan */

__TOC__

== Team Contact ==
=== Team Members ===
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

=== Mentor ===
* Kartiki Bhandakkar, kbhanda3

== Overview of Expertiza ==
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 <code>Course</code> and <code>CourseTeam</code> which are the models primarily addressed in this project are both critical components in providing this functionality.

== Description of Project ==
<code>course</code> 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.

The <code>course_team</code> 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.

== Files Modified ==
=== Changes in Model Files ===
=== Changes to <code>app/models/course.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Checked and Removed <code>get_participant</code> method
|Checked the usage of Method through IDE whether the function is used, the only call was from <code>course_spec.rb</code> and not from anywhere else. Hence, removed from <code>course.rb</code>
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|-
|2
|style="width: 30%"| Renamed <code>copy_participants</code> method
|Renamed <code>copy_participants</code> to <code>copy_assignment_participants</code> which makes more sense and a clear idea of how method works and what is the purpose of method.
|[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]
|-
|3
|Removed <code>add_member</code> method from <code>course_team</code> model
|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.
|[https://github.com/expertiza/expertiza/pull/2548/commits/8fb9bf9a793b8c154bc2b640daa630624e008a86 Commit]
|-
|4
|Created method <code>raise_errors</code>
|To reduce Cognitive Complexity of method <code>copy_participants</code>
|[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]
|}

=== Changes to <code>app/models/course_team.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Removed <code>assignment_id</code>
|CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute <code>parent_id</code> that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for <code>assignment_id</code> in the CourseTeam class and no need for <code>course_id</code> 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.
|[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]
|-
|2
|Renamed <code>copy</code> method as <code>copy_to_assignment_team</code>
|As this method is copying a CourseTeam to an AssignmentTeam, renamed it as <code>copy_to_assignment_team</code>. A suggestion for copy method in AssignmentTeam would be to rename it as <code>copy_to_course_team</code>.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-56ab3d3b28f0be68663223f0a5ef9daa5c8d106caca412481562272ab2edfae1 Commit] 
|}

=== Changes to <code>app/models/assignment_team.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> method for AssignmentTeam
|Renamed <code>copy</code> for copying current AssignmentTeam to CourseTeam as <code>copy_to_course_team</code>
|[https://github.com/kartikrawool/expertiza/commit/b93df2590a7ab52f87a1df00512afe626fa81520 Commit]
|}

=== Changes in RSPEC Files ===

=== Changes to <code>spec/models/course_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Removed the test case for <code>get_paprticipant</code> method test case
|Removed the test case for <code>get_participant</code> method as the method was not used anywhere else in the code.
|[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]
|-
|2
|Renamed <code>copy_participants</code> method test case
|Renamed the respective method of <code>copy_participants</code> to <code>copy_assignment_participants</code>in rspec file as well.
|[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit] 
|}

=== Changes to <code>spec/models/course_team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>in rspec file as well.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-8b753735f47ae84fdf88f7e9f15e08b8dd13ba1bc8fd16abad11148800aa8954 Commit] 
|}

=== Changes in Controller Files ===

=== Changes to <code>app/controllers/teams_controller.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>
|The change was directly related to changes of copy method in <code>course_team.rb</code>.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]
|-
|}

== Test Plan ==

All the suggested changes were made to <code>course.rb</code> and <code>course_team.rb</code>, 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

*'''course_team'''
-
*'''course'''
*'''assignment_team'''

Coverage:
[[File:coverage_old.jpg|center|frame|Coverage of codebase before refactoring]]

[[File:course_team_coverage.jpg|center|frame|Coverage of <code>course_team.rb</code> before refactoring]]

[[File:course_coverage.jpg|center|frame|Coverage of <code>course.rb</code> before refactoring]]

[[File:assignment_team_coverage.jpg|center|frame|Coverage of <code>assignment_team.rb</code> before refactoring]]

[[File:team_coverage.jpg|center|frame|Coverage of <code>team.rb</code> before refactoring]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548
* '''VCL Server:''' http://152.7.178.105:8080/

== Contributors to this project ==
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

CSC/ECE 517/Spring 2023/E2308. Refactor course.rb and course team.rb models

2023-03-27T23:54:49Z

Khrawool: /* Test Plan */

__TOC__

== Team Contact ==
=== Team Members ===
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

=== Mentor ===
* Kartiki Bhandakkar, kbhanda3

== Overview of Expertiza ==
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 <code>Course</code> and <code>CourseTeam</code> which are the models primarily addressed in this project are both critical components in providing this functionality.

== Description of Project ==
<code>course</code> 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.

The <code>course_team</code> 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.

== Files Modified ==
=== Changes in Model Files ===
=== Changes to <code>app/models/course.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Checked and Removed <code>get_participant</code> method
|Checked the usage of Method through IDE whether the function is used, the only call was from <code>course_spec.rb</code> and not from anywhere else. Hence, removed from <code>course.rb</code>
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|-
|2
|style="width: 30%"| Renamed <code>copy_participants</code> method
|Renamed <code>copy_participants</code> to <code>copy_assignment_participants</code> which makes more sense and a clear idea of how method works and what is the purpose of method.
|[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]
|-
|3
|Removed <code>add_member</code> method from <code>course_team</code> model
|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.
|[https://github.com/expertiza/expertiza/pull/2548/commits/8fb9bf9a793b8c154bc2b640daa630624e008a86 Commit]
|-
|4
|Created method <code>raise_errors</code>
|To reduce Cognitive Complexity of method <code>copy_participants</code>
|[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]
|}

=== Changes to <code>app/models/course_team.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Removed <code>assignment_id</code>
|CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute <code>parent_id</code> that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for <code>assignment_id</code> in the CourseTeam class and no need for <code>course_id</code> 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.
|[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]
|-
|2
|Renamed <code>copy</code> method as <code>copy_to_assignment_team</code>
|As this method is copying a CourseTeam to an AssignmentTeam, renamed it as <code>copy_to_assignment_team</code>. A suggestion for copy method in AssignmentTeam would be to rename it as <code>copy_to_course_team</code>.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-56ab3d3b28f0be68663223f0a5ef9daa5c8d106caca412481562272ab2edfae1 Commit] 
|}

=== Changes to <code>app/models/assignment_team.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> method for AssignmentTeam
|Renamed <code>copy</code> for copying current AssignmentTeam to CourseTeam as <code>copy_to_course_team</code>
|[https://github.com/kartikrawool/expertiza/commit/b93df2590a7ab52f87a1df00512afe626fa81520 Commit]
|}

=== Changes in RSPEC Files ===

=== Changes to <code>spec/models/course_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Removed the test case for <code>get_paprticipant</code> method test case
|Removed the test case for <code>get_participant</code> method as the method was not used anywhere else in the code.
|[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]
|-
|2
|Renamed <code>copy_participants</code> method test case
|Renamed the respective method of <code>copy_participants</code> to <code>copy_assignment_participants</code>in rspec file as well.
|[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit] 
|}

=== Changes to <code>spec/models/course_team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>in rspec file as well.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-8b753735f47ae84fdf88f7e9f15e08b8dd13ba1bc8fd16abad11148800aa8954 Commit] 
|}

=== Changes in Controller Files ===

=== Changes to <code>app/controllers/teams_controller.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>
|The change was directly related to changes of copy method in <code>course_team.rb</code>.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]
|-
|}

== Test Plan ==

All the suggested changes were made to <code>course.rb</code> and <code>course_team.rb</code>, 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

*'''course_team'''
*'''course'''
*'''assignment_team'''

Coverage:
[[File:coverage_old.jpg|center|frame|Coverage of codebase before refactoring]]

[[File:course_team_coverage.jpg|center|frame|Coverage of <code>course_team.rb</code> before refactoring]]

[[File:course_coverage.jpg|center|frame|Coverage of <code>course.rb</code> before refactoring]]

[[File:assignment_team_coverage.jpg|center|frame|Coverage of <code>assignment_team.rb</code> before refactoring]]

[[File:team_coverage.jpg|center|frame|Coverage of <code>team.rb</code> before refactoring]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548
* '''VCL Server:''' http://152.7.178.105:8080/

== Contributors to this project ==
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

File:Team coverage.jpg

2023-03-27T23:54:13Z

Khrawool:

CSC/ECE 517/Spring 2023/E2308. Refactor course.rb and course team.rb models

2023-03-27T23:51:03Z

Khrawool: /* Test Plan */

__TOC__

== Team Contact ==
=== Team Members ===
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

=== Mentor ===
* Kartiki Bhandakkar, kbhanda3

== Overview of Expertiza ==
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 <code>Course</code> and <code>CourseTeam</code> which are the models primarily addressed in this project are both critical components in providing this functionality.

== Description of Project ==
<code>course</code> 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.

The <code>course_team</code> 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.

== Files Modified ==
=== Changes in Model Files ===
=== Changes to <code>app/models/course.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Checked and Removed <code>get_participant</code> method
|Checked the usage of Method through IDE whether the function is used, the only call was from <code>course_spec.rb</code> and not from anywhere else. Hence, removed from <code>course.rb</code>
|[https://github.com/kartikrawool/expertiza/commit/6403edc25cf0edde623da63f23d92a1a57d67375 Commit]
|-
|2
|style="width: 30%"| Renamed <code>copy_participants</code> method
|Renamed <code>copy_participants</code> to <code>copy_assignment_participants</code> which makes more sense and a clear idea of how method works and what is the purpose of method.
|[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit]
|-
|3
|Removed <code>add_member</code> method from <code>course_team</code> model
|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.
|[https://github.com/expertiza/expertiza/pull/2548/commits/8fb9bf9a793b8c154bc2b640daa630624e008a86 Commit]
|-
|4
|Created method <code>raise_errors</code>
|To reduce Cognitive Complexity of method <code>copy_participants</code>
|[https://github.com/kartikrawool/expertiza/commit/7c1ae764d2d64e0246422934f292b9b2fe43a031 Commit]
|}

=== Changes to <code>app/models/course_team.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Removed <code>assignment_id</code>
|CourseTeam and AssignmentTeam inherit from Team class. The teams' table has an attribute <code>parent_id</code> that helps determine whether the team is AssigmentTeam or CourseTeam. Thus, there is no need for <code>assignment_id</code> in the CourseTeam class and no need for <code>course_id</code> 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.
|[https://github.com/kartikrawool/expertiza/commit/ef9727542999c6cdbf2334f5b62ebb30fbfe8cdd Commit]
|-
|2
|Renamed <code>copy</code> method as <code>copy_to_assignment_team</code>
|As this method is copying a CourseTeam to an AssignmentTeam, renamed it as <code>copy_to_assignment_team</code>. A suggestion for copy method in AssignmentTeam would be to rename it as <code>copy_to_course_team</code>.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-56ab3d3b28f0be68663223f0a5ef9daa5c8d106caca412481562272ab2edfae1 Commit] 
|}

=== Changes to <code>app/models/assignment_team.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> method for AssignmentTeam
|Renamed <code>copy</code> for copying current AssignmentTeam to CourseTeam as <code>copy_to_course_team</code>
|[https://github.com/kartikrawool/expertiza/commit/b93df2590a7ab52f87a1df00512afe626fa81520 Commit]
|}

=== Changes in RSPEC Files ===

=== Changes to <code>spec/models/course_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Removed the test case for <code>get_paprticipant</code> method test case
|Removed the test case for <code>get_participant</code> method as the method was not used anywhere else in the code.
|[https://github.com/kartikrawool/expertiza/commit/63c62027d8cb3aebe281a6152113632aafc444ec Commit]
|-
|2
|Renamed <code>copy_participants</code> method test case
|Renamed the respective method of <code>copy_participants</code> to <code>copy_assignment_participants</code>in rspec file as well.
|[https://github.com/kartikrawool/expertiza/commit/5177376c0f9a4f1890f49879bbbbfee0b28b8263 Commit] 
|}

=== Changes to <code>spec/models/course_team_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>in rspec file as well.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b#diff-8b753735f47ae84fdf88f7e9f15e08b8dd13ba1bc8fd16abad11148800aa8954 Commit] 
|}

=== Changes in Controller Files ===

=== Changes to <code>app/controllers/teams_controller.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed <code>copy</code> to <code>copy_to_assignment_team</code>
|The change was directly related to changes of copy method in <code>course_team.rb</code>.
|[https://github.com/kartikrawool/expertiza/commit/372b8d44dfbc3b29c07f41500a5cc53d23cf577b Commit]
|-
|}

== Test Plan ==

All the suggested changes were made to <code>course.rb</code> and <code>course_team.rb</code>, 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

*'''course_team'''
*'''course'''
*'''assignment_team'''

Coverage:
[[File:course_team_coverage.jpg|center|frame|Coverage of <code>course_team.rb</code> before refactoring]]

[[File:course_coverage.jpg|center|frame|Coverage of <code>course.rb</code> before refactoring]]

[[File:assignment_team_coverage.jpg|center|frame|Coverage of <code>assignment_team.rb</code> before refactoring]]

[[File:coverage_old.jpg|center|frame|Coverage of codebase before refactoring]]

== Relevant Links ==
* '''Github Repository:''' https://github.com/kartikrawool/expertiza/tree/refactor_course
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2548
* '''VCL Server:''' http://152.7.178.105:8080/

== Contributors to this project ==
* Kartik Rawool, (unityID:khrawool, GitHub:kartikrawool)
* Ameya Vaichalkar, (unityID:agvaicha, GitHub:ameyagv)
* Vikram Pande, (unityID:vspande, GitHub:vikrampande7)

File:Coverage old.jpg

2023-03-27T23:49:46Z

Khrawool:

File:Assignment team coverage.jpg

2023-03-27T23:48:03Z

Khrawool:

File:Course coverage.jpg

2023-03-27T23:46:43Z

Khrawool:

File:Course team coverage.jpg

2023-03-27T23:42:24Z

Khrawool:

CSC/ECE 517/Spring 2023/E2308. Refactor course.rb and course team.rb models

2023-03-22T21:28:39Z

Khrawool: /* Files Modified */

CSC/ECE 517/Spring 2023/E2308. Refactor course.rb and course team.rb models

2023-03-22T19:34:23Z

Khrawool: /* Test Plan */

CSC/ECE 517/Spring 2023/E2308. Refactor course.rb and course team.rb models

2023-03-22T19:34:08Z

Khrawool: /* Test Plan */