Expertiza_Wiki - User contributions [en]

File:SequenceDiagram TeamsParticipant.png

2024-11-11T00:10:49Z

Csingha: Csingha reverted File:SequenceDiagram TeamsParticipant.png to an old version

File:SequenceDiagram TeamsParticipant.png

2024-11-11T00:10:36Z

Csingha: Csingha reverted File:SequenceDiagram TeamsParticipant.png to an old version

CSC/ECE 517 Fall 2024 - E2456. Refactor teams user.rb (Phase 2 - Design Document)

2024-11-11T00:09:57Z

Csingha: /* Sequence Diagram */

==Expertiza==

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc).
The National Science Foundation supports the Expertiza project.
It is used in select courses at NC State and by professors at several other colleges and universities.

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project.

==Problem Statement==

The TeamsUser class in the Expertiza repository serves as a join model between the Team and Participant classes, establishing a many-to-many relationship. Its primary purpose is to manage team memberships within the context of assignments or courses, facilitating functionalities such as retrieving a user's name, deleting users or teams, and managing participant associations.

The primary issue with the TeamsUser class is that it associates teams directly with users rather than with participants. In the context of the application, participants are users who are specifically associated with an assignment or a course. Since teams are formed within the scope of assignments or courses, handling team memberships through participants is more appropriate. Almost everywhere else, an assignment uses Participant objects rather than User objects. The exception is when it comes to Teams. It would simplify the design to use TeamsParticipants instead of TeamsUsers.

==Design Goal==

==Design Pattern==

==Class Diagram==
[[File:ClassDiagram_TeamsParticipant.png|1000px]]

==Sequence Diagram==
[[File:SequenceDiagram_TeamsParticipant.png|1000px]]

==Solutions/Details of Changes Made==

===Phase 1 Improvements===

* Renamed TeamsUser to TeamsParticipant to modify application logic to join Teams with Participants instead of Users
* Updated associations in immediate neighbor classes i.e Teams, Users and Participants to ensure correctness and consistency in the data model
* Renamed method names for increased readability and removed redundant methods from the TeamsParticipant class
* Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity, improving overall maintainability of the codebase
* Renamed TeamUserNode to TeamParticipantNode for correctness, to align with the new design of Participation association in TeamsParticipant
* Added migrations to add foreign key for Participant in TeamsParticipant table and updated indexes for the same

===Phase 2 Plan===

* Update associations in all the models that were previously using TeamsUser to implement them with TeamsParticipant
* Modify implementations of all models, views, and controllers to use Participant with TeamsParticipant class instead of User
* This future involves modifying queries to retrieve participant and user objects that are passed to the TeamsParticipant class as commands to their methods
* Deprecate user_id foreign key from TeamsParticipant to completely remove the association of User from TeamsParticant, only linking Participants to Teams
* Update all the test cases to work with this implementation, including updating associations and mocking DB calls

==Files Added/Modified==

Changed files in <code>Model</code>:

==== Changes to <code>app/models/teams_user.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamsUser to TeamsParticipant
|Aligns with application logic that utilizes Participants rather than Users.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|2
|style="width: 30%"| Updated associations to reference Participants
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|3
|Removed <code>get_team_members</code> from teams_participant model
|The method was empty without any logic so it was just a placeholder method without any usage across the project.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|-
|4
|Renamed methods: <code>remove_team_if_participants_empty</code>, <code>remove_team_participant</code>, <code>first_participant_for_team</code>, <code>add_accepted_invitee_to_team</code>, <code>find_team_id</code> for clarity
|Improves code readability for new programmers.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|
|-
|5
|Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity
|To reduce Cognitive Complexity and making the model more maintainable and efficient
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==== Changes to <code>app/models/team_user_node.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamUserNode to TeamParticipantNode
|Aligns with application logic that utilizes Participants rather than Users for node associations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|2
|style="width: 30%"| Modified queries in TeamParticipantNode to use teams_participant instead of teams_user
|Aligns with the changes made in teams_participant model to add new participant association.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|3
|Updated associations to reference TeamUserNode in entire repository
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==Test Plan==

We added a new spec file for the teams_participant model which was missing and fixed team_participant_controller_spec. Also as an additional step, we fixed model and controller tests for direct associations: Team, User, and Participant.

===Code coverage===

'''Before refactoring: 0%'''

'''After refactoring: 100%'''

[[File:teams-participant-code-cov.png|800px|center|Code coverage for <code>teams_participant.rb</code>]]

*<code>'''teams_participant'''</code>

[[File:Teams_participant_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team'''</code>

[[File:Team_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user'''</code>

[[File:User_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant'''</code>

[[File:Participant_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''teams_participant_controller'''</code>

[[File:Teams_participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team_controller'''</code>

[[File:Team_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user_controller'''</code>

[[File:Users_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant_controller'''</code>

[[File:Participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

==Next Steps==
During the refactoring from TeamsUser to TeamsParticipant, we initially retained the association between teams and users (with user_id as a foreign key) in TeamsParticipant. This approach was for backward compatibility, ensuring that other classes and tests would function without immediate disruption.

The next phase will involve fully removing this direct association between teams and users. Instead, we will maintain only the teams-participant relationship in the TeamsParticipant table.

This update will require modifying all references to TeamsParticipant across models and controllers, and adjusting logic to work with Participant instead of User. Certain cases do need user-specific fields previously stored within TeamsParticipant. With the user association deprecated, these areas will need updated logic to retrieve the user associated with each participant. This ensures continued functionality and accuracy of the code. Corresponding updates will also be necessary in the spec files to align with the changes.

==Team==

====Mentor====

* Jay, Patel

====Members====

* Agarwal, Arjit
* Manbhekar, Pranav
* Singhania, Chinmay

==References==

# [https://expertiza.ncsu.edu/ Expertiza]
# [https://docs.google.com/document/d/1fB9nHsop_yptjcj3CFn80BcZjXcSDbzcWwKvBDUTVrQ/edit?tab=t.0OSS Projects on Expertiza])
# [https://github.com/expertiza/expertiza Expertiza Github]
# [https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page Expertiza Wiki]

File:SequenceDiagram TeamsParticipant.png

2024-11-11T00:09:38Z

Csingha: Csingha uploaded a new version of File:SequenceDiagram TeamsParticipant.png

CSC/ECE 517 Fall 2024 - E2456. Refactor teams user.rb (Phase 2 - Design Document)

2024-11-11T00:08:31Z

Csingha: /* Sequence Diagram */

==Expertiza==

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc).
The National Science Foundation supports the Expertiza project.
It is used in select courses at NC State and by professors at several other colleges and universities.

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project.

==Problem Statement==

The TeamsUser class in the Expertiza repository serves as a join model between the Team and Participant classes, establishing a many-to-many relationship. Its primary purpose is to manage team memberships within the context of assignments or courses, facilitating functionalities such as retrieving a user's name, deleting users or teams, and managing participant associations.

The primary issue with the TeamsUser class is that it associates teams directly with users rather than with participants. In the context of the application, participants are users who are specifically associated with an assignment or a course. Since teams are formed within the scope of assignments or courses, handling team memberships through participants is more appropriate. Almost everywhere else, an assignment uses Participant objects rather than User objects. The exception is when it comes to Teams. It would simplify the design to use TeamsParticipants instead of TeamsUsers.

==Design Goal==

==Design Pattern==

==Class Diagram==
[[File:ClassDiagram_TeamsParticipant.png|1000px]]

==Sequence Diagram==
[[File:SequenceDiagram_TeamsParticipant2.png|1000px]]

==Solutions/Details of Changes Made==

===Phase 1 Improvements===

* Renamed TeamsUser to TeamsParticipant to modify application logic to join Teams with Participants instead of Users
* Updated associations in immediate neighbor classes i.e Teams, Users and Participants to ensure correctness and consistency in the data model
* Renamed method names for increased readability and removed redundant methods from the TeamsParticipant class
* Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity, improving overall maintainability of the codebase
* Renamed TeamUserNode to TeamParticipantNode for correctness, to align with the new design of Participation association in TeamsParticipant
* Added migrations to add foreign key for Participant in TeamsParticipant table and updated indexes for the same

===Phase 2 Plan===

* Update associations in all the models that were previously using TeamsUser to implement them with TeamsParticipant
* Modify implementations of all models, views, and controllers to use Participant with TeamsParticipant class instead of User
* This future involves modifying queries to retrieve participant and user objects that are passed to the TeamsParticipant class as commands to their methods
* Deprecate user_id foreign key from TeamsParticipant to completely remove the association of User from TeamsParticant, only linking Participants to Teams
* Update all the test cases to work with this implementation, including updating associations and mocking DB calls

==Files Added/Modified==

Changed files in <code>Model</code>:

==== Changes to <code>app/models/teams_user.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamsUser to TeamsParticipant
|Aligns with application logic that utilizes Participants rather than Users.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|2
|style="width: 30%"| Updated associations to reference Participants
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|3
|Removed <code>get_team_members</code> from teams_participant model
|The method was empty without any logic so it was just a placeholder method without any usage across the project.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|-
|4
|Renamed methods: <code>remove_team_if_participants_empty</code>, <code>remove_team_participant</code>, <code>first_participant_for_team</code>, <code>add_accepted_invitee_to_team</code>, <code>find_team_id</code> for clarity
|Improves code readability for new programmers.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|
|-
|5
|Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity
|To reduce Cognitive Complexity and making the model more maintainable and efficient
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==== Changes to <code>app/models/team_user_node.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamUserNode to TeamParticipantNode
|Aligns with application logic that utilizes Participants rather than Users for node associations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|2
|style="width: 30%"| Modified queries in TeamParticipantNode to use teams_participant instead of teams_user
|Aligns with the changes made in teams_participant model to add new participant association.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|3
|Updated associations to reference TeamUserNode in entire repository
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==Test Plan==

We added a new spec file for the teams_participant model which was missing and fixed team_participant_controller_spec. Also as an additional step, we fixed model and controller tests for direct associations: Team, User, and Participant.

===Code coverage===

'''Before refactoring: 0%'''

'''After refactoring: 100%'''

[[File:teams-participant-code-cov.png|800px|center|Code coverage for <code>teams_participant.rb</code>]]

*<code>'''teams_participant'''</code>

[[File:Teams_participant_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team'''</code>

[[File:Team_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user'''</code>

[[File:User_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant'''</code>

[[File:Participant_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''teams_participant_controller'''</code>

[[File:Teams_participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team_controller'''</code>

[[File:Team_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user_controller'''</code>

[[File:Users_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant_controller'''</code>

[[File:Participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

==Next Steps==
During the refactoring from TeamsUser to TeamsParticipant, we initially retained the association between teams and users (with user_id as a foreign key) in TeamsParticipant. This approach was for backward compatibility, ensuring that other classes and tests would function without immediate disruption.

The next phase will involve fully removing this direct association between teams and users. Instead, we will maintain only the teams-participant relationship in the TeamsParticipant table.

This update will require modifying all references to TeamsParticipant across models and controllers, and adjusting logic to work with Participant instead of User. Certain cases do need user-specific fields previously stored within TeamsParticipant. With the user association deprecated, these areas will need updated logic to retrieve the user associated with each participant. This ensures continued functionality and accuracy of the code. Corresponding updates will also be necessary in the spec files to align with the changes.

==Team==

====Mentor====

* Jay, Patel

====Members====

* Agarwal, Arjit
* Manbhekar, Pranav
* Singhania, Chinmay

==References==

# [https://expertiza.ncsu.edu/ Expertiza]
# [https://docs.google.com/document/d/1fB9nHsop_yptjcj3CFn80BcZjXcSDbzcWwKvBDUTVrQ/edit?tab=t.0OSS Projects on Expertiza])
# [https://github.com/expertiza/expertiza Expertiza Github]
# [https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page Expertiza Wiki]

CSC/ECE 517 Fall 2024 - E2456. Refactor teams user.rb (Phase 2 - Design Document)

2024-11-11T00:08:12Z

Csingha: /* Sequence Diagram */

==Expertiza==

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc).
The National Science Foundation supports the Expertiza project.
It is used in select courses at NC State and by professors at several other colleges and universities.

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project.

==Problem Statement==

The TeamsUser class in the Expertiza repository serves as a join model between the Team and Participant classes, establishing a many-to-many relationship. Its primary purpose is to manage team memberships within the context of assignments or courses, facilitating functionalities such as retrieving a user's name, deleting users or teams, and managing participant associations.

The primary issue with the TeamsUser class is that it associates teams directly with users rather than with participants. In the context of the application, participants are users who are specifically associated with an assignment or a course. Since teams are formed within the scope of assignments or courses, handling team memberships through participants is more appropriate. Almost everywhere else, an assignment uses Participant objects rather than User objects. The exception is when it comes to Teams. It would simplify the design to use TeamsParticipants instead of TeamsUsers.

==Design Goal==

==Design Pattern==

==Class Diagram==
[[File:ClassDiagram_TeamsParticipant.png|1000px]]

==Sequence Diagram==
[[SequenceDiagram_TeamsParticipant2.png|1000px]]

==Solutions/Details of Changes Made==

===Phase 1 Improvements===

* Renamed TeamsUser to TeamsParticipant to modify application logic to join Teams with Participants instead of Users
* Updated associations in immediate neighbor classes i.e Teams, Users and Participants to ensure correctness and consistency in the data model
* Renamed method names for increased readability and removed redundant methods from the TeamsParticipant class
* Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity, improving overall maintainability of the codebase
* Renamed TeamUserNode to TeamParticipantNode for correctness, to align with the new design of Participation association in TeamsParticipant
* Added migrations to add foreign key for Participant in TeamsParticipant table and updated indexes for the same

===Phase 2 Plan===

* Update associations in all the models that were previously using TeamsUser to implement them with TeamsParticipant
* Modify implementations of all models, views, and controllers to use Participant with TeamsParticipant class instead of User
* This future involves modifying queries to retrieve participant and user objects that are passed to the TeamsParticipant class as commands to their methods
* Deprecate user_id foreign key from TeamsParticipant to completely remove the association of User from TeamsParticant, only linking Participants to Teams
* Update all the test cases to work with this implementation, including updating associations and mocking DB calls

==Files Added/Modified==

Changed files in <code>Model</code>:

==== Changes to <code>app/models/teams_user.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamsUser to TeamsParticipant
|Aligns with application logic that utilizes Participants rather than Users.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|2
|style="width: 30%"| Updated associations to reference Participants
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|3
|Removed <code>get_team_members</code> from teams_participant model
|The method was empty without any logic so it was just a placeholder method without any usage across the project.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|-
|4
|Renamed methods: <code>remove_team_if_participants_empty</code>, <code>remove_team_participant</code>, <code>first_participant_for_team</code>, <code>add_accepted_invitee_to_team</code>, <code>find_team_id</code> for clarity
|Improves code readability for new programmers.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|
|-
|5
|Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity
|To reduce Cognitive Complexity and making the model more maintainable and efficient
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==== Changes to <code>app/models/team_user_node.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamUserNode to TeamParticipantNode
|Aligns with application logic that utilizes Participants rather than Users for node associations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|2
|style="width: 30%"| Modified queries in TeamParticipantNode to use teams_participant instead of teams_user
|Aligns with the changes made in teams_participant model to add new participant association.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|3
|Updated associations to reference TeamUserNode in entire repository
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==Test Plan==

We added a new spec file for the teams_participant model which was missing and fixed team_participant_controller_spec. Also as an additional step, we fixed model and controller tests for direct associations: Team, User, and Participant.

===Code coverage===

'''Before refactoring: 0%'''

'''After refactoring: 100%'''

[[File:teams-participant-code-cov.png|800px|center|Code coverage for <code>teams_participant.rb</code>]]

*<code>'''teams_participant'''</code>

[[File:Teams_participant_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team'''</code>

[[File:Team_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user'''</code>

[[File:User_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant'''</code>

[[File:Participant_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''teams_participant_controller'''</code>

[[File:Teams_participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team_controller'''</code>

[[File:Team_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user_controller'''</code>

[[File:Users_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant_controller'''</code>

[[File:Participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

==Next Steps==
During the refactoring from TeamsUser to TeamsParticipant, we initially retained the association between teams and users (with user_id as a foreign key) in TeamsParticipant. This approach was for backward compatibility, ensuring that other classes and tests would function without immediate disruption.

The next phase will involve fully removing this direct association between teams and users. Instead, we will maintain only the teams-participant relationship in the TeamsParticipant table.

This update will require modifying all references to TeamsParticipant across models and controllers, and adjusting logic to work with Participant instead of User. Certain cases do need user-specific fields previously stored within TeamsParticipant. With the user association deprecated, these areas will need updated logic to retrieve the user associated with each participant. This ensures continued functionality and accuracy of the code. Corresponding updates will also be necessary in the spec files to align with the changes.

==Team==

====Mentor====

* Jay, Patel

====Members====

* Agarwal, Arjit
* Manbhekar, Pranav
* Singhania, Chinmay

==References==

# [https://expertiza.ncsu.edu/ Expertiza]
# [https://docs.google.com/document/d/1fB9nHsop_yptjcj3CFn80BcZjXcSDbzcWwKvBDUTVrQ/edit?tab=t.0OSS Projects on Expertiza])
# [https://github.com/expertiza/expertiza Expertiza Github]
# [https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page Expertiza Wiki]

CSC/ECE 517 Fall 2024 - E2456. Refactor teams user.rb (Phase 2 - Design Document)

2024-11-11T00:07:14Z

Csingha: /* Sequence Diagram */

==Expertiza==

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc).
The National Science Foundation supports the Expertiza project.
It is used in select courses at NC State and by professors at several other colleges and universities.

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project.

==Problem Statement==

The TeamsUser class in the Expertiza repository serves as a join model between the Team and Participant classes, establishing a many-to-many relationship. Its primary purpose is to manage team memberships within the context of assignments or courses, facilitating functionalities such as retrieving a user's name, deleting users or teams, and managing participant associations.

The primary issue with the TeamsUser class is that it associates teams directly with users rather than with participants. In the context of the application, participants are users who are specifically associated with an assignment or a course. Since teams are formed within the scope of assignments or courses, handling team memberships through participants is more appropriate. Almost everywhere else, an assignment uses Participant objects rather than User objects. The exception is when it comes to Teams. It would simplify the design to use TeamsParticipants instead of TeamsUsers.

==Design Goal==

==Design Pattern==

==Class Diagram==
[[File:ClassDiagram_TeamsParticipant.png|1000px]]

==Sequence Diagram==
[[File:SequenceDiagram.png|1000px]]

==Solutions/Details of Changes Made==

===Phase 1 Improvements===

* Renamed TeamsUser to TeamsParticipant to modify application logic to join Teams with Participants instead of Users
* Updated associations in immediate neighbor classes i.e Teams, Users and Participants to ensure correctness and consistency in the data model
* Renamed method names for increased readability and removed redundant methods from the TeamsParticipant class
* Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity, improving overall maintainability of the codebase
* Renamed TeamUserNode to TeamParticipantNode for correctness, to align with the new design of Participation association in TeamsParticipant
* Added migrations to add foreign key for Participant in TeamsParticipant table and updated indexes for the same

===Phase 2 Plan===

* Update associations in all the models that were previously using TeamsUser to implement them with TeamsParticipant
* Modify implementations of all models, views, and controllers to use Participant with TeamsParticipant class instead of User
* This future involves modifying queries to retrieve participant and user objects that are passed to the TeamsParticipant class as commands to their methods
* Deprecate user_id foreign key from TeamsParticipant to completely remove the association of User from TeamsParticant, only linking Participants to Teams
* Update all the test cases to work with this implementation, including updating associations and mocking DB calls

==Files Added/Modified==

Changed files in <code>Model</code>:

==== Changes to <code>app/models/teams_user.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamsUser to TeamsParticipant
|Aligns with application logic that utilizes Participants rather than Users.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|2
|style="width: 30%"| Updated associations to reference Participants
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|3
|Removed <code>get_team_members</code> from teams_participant model
|The method was empty without any logic so it was just a placeholder method without any usage across the project.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|-
|4
|Renamed methods: <code>remove_team_if_participants_empty</code>, <code>remove_team_participant</code>, <code>first_participant_for_team</code>, <code>add_accepted_invitee_to_team</code>, <code>find_team_id</code> for clarity
|Improves code readability for new programmers.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|
|-
|5
|Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity
|To reduce Cognitive Complexity and making the model more maintainable and efficient
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==== Changes to <code>app/models/team_user_node.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamUserNode to TeamParticipantNode
|Aligns with application logic that utilizes Participants rather than Users for node associations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|2
|style="width: 30%"| Modified queries in TeamParticipantNode to use teams_participant instead of teams_user
|Aligns with the changes made in teams_participant model to add new participant association.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|3
|Updated associations to reference TeamUserNode in entire repository
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==Test Plan==

We added a new spec file for the teams_participant model which was missing and fixed team_participant_controller_spec. Also as an additional step, we fixed model and controller tests for direct associations: Team, User, and Participant.

===Code coverage===

'''Before refactoring: 0%'''

'''After refactoring: 100%'''

[[File:teams-participant-code-cov.png|800px|center|Code coverage for <code>teams_participant.rb</code>]]

*<code>'''teams_participant'''</code>

[[File:Teams_participant_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team'''</code>

[[File:Team_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user'''</code>

[[File:User_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant'''</code>

[[File:Participant_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''teams_participant_controller'''</code>

[[File:Teams_participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team_controller'''</code>

[[File:Team_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user_controller'''</code>

[[File:Users_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant_controller'''</code>

[[File:Participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

==Next Steps==
During the refactoring from TeamsUser to TeamsParticipant, we initially retained the association between teams and users (with user_id as a foreign key) in TeamsParticipant. This approach was for backward compatibility, ensuring that other classes and tests would function without immediate disruption.

The next phase will involve fully removing this direct association between teams and users. Instead, we will maintain only the teams-participant relationship in the TeamsParticipant table.

This update will require modifying all references to TeamsParticipant across models and controllers, and adjusting logic to work with Participant instead of User. Certain cases do need user-specific fields previously stored within TeamsParticipant. With the user association deprecated, these areas will need updated logic to retrieve the user associated with each participant. This ensures continued functionality and accuracy of the code. Corresponding updates will also be necessary in the spec files to align with the changes.

==Team==

====Mentor====

* Jay, Patel

====Members====

* Agarwal, Arjit
* Manbhekar, Pranav
* Singhania, Chinmay

==References==

# [https://expertiza.ncsu.edu/ Expertiza]
# [https://docs.google.com/document/d/1fB9nHsop_yptjcj3CFn80BcZjXcSDbzcWwKvBDUTVrQ/edit?tab=t.0OSS Projects on Expertiza])
# [https://github.com/expertiza/expertiza Expertiza Github]
# [https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page Expertiza Wiki]

CSC/ECE 517 Fall 2024 - E2456. Refactor teams user.rb (Phase 2 - Design Document)

2024-11-11T00:03:57Z

Csingha: /* Sequence Diagram */

==Expertiza==

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc).
The National Science Foundation supports the Expertiza project.
It is used in select courses at NC State and by professors at several other colleges and universities.

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project.

==Problem Statement==

The TeamsUser class in the Expertiza repository serves as a join model between the Team and Participant classes, establishing a many-to-many relationship. Its primary purpose is to manage team memberships within the context of assignments or courses, facilitating functionalities such as retrieving a user's name, deleting users or teams, and managing participant associations.

The primary issue with the TeamsUser class is that it associates teams directly with users rather than with participants. In the context of the application, participants are users who are specifically associated with an assignment or a course. Since teams are formed within the scope of assignments or courses, handling team memberships through participants is more appropriate. Almost everywhere else, an assignment uses Participant objects rather than User objects. The exception is when it comes to Teams. It would simplify the design to use TeamsParticipants instead of TeamsUsers.

==Design Goal==

==Design Pattern==

==Class Diagram==
[[File:ClassDiagram_TeamsParticipant.png|1000px]]

==Sequence Diagram==
[[File:SequenceDiagram TeamsParticipant2.png|1000px]]

==Solutions/Details of Changes Made==

===Phase 1 Improvements===

* Renamed TeamsUser to TeamsParticipant to modify application logic to join Teams with Participants instead of Users
* Updated associations in immediate neighbor classes i.e Teams, Users and Participants to ensure correctness and consistency in the data model
* Renamed method names for increased readability and removed redundant methods from the TeamsParticipant class
* Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity, improving overall maintainability of the codebase
* Renamed TeamUserNode to TeamParticipantNode for correctness, to align with the new design of Participation association in TeamsParticipant
* Added migrations to add foreign key for Participant in TeamsParticipant table and updated indexes for the same

===Phase 2 Plan===

* Update associations in all the models that were previously using TeamsUser to implement them with TeamsParticipant
* Modify implementations of all models, views, and controllers to use Participant with TeamsParticipant class instead of User
* This future involves modifying queries to retrieve participant and user objects that are passed to the TeamsParticipant class as commands to their methods
* Deprecate user_id foreign key from TeamsParticipant to completely remove the association of User from TeamsParticant, only linking Participants to Teams
* Update all the test cases to work with this implementation, including updating associations and mocking DB calls

==Files Added/Modified==

Changed files in <code>Model</code>:

==== Changes to <code>app/models/teams_user.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamsUser to TeamsParticipant
|Aligns with application logic that utilizes Participants rather than Users.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|2
|style="width: 30%"| Updated associations to reference Participants
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|3
|Removed <code>get_team_members</code> from teams_participant model
|The method was empty without any logic so it was just a placeholder method without any usage across the project.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|-
|4
|Renamed methods: <code>remove_team_if_participants_empty</code>, <code>remove_team_participant</code>, <code>first_participant_for_team</code>, <code>add_accepted_invitee_to_team</code>, <code>find_team_id</code> for clarity
|Improves code readability for new programmers.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|
|-
|5
|Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity
|To reduce Cognitive Complexity and making the model more maintainable and efficient
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==== Changes to <code>app/models/team_user_node.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamUserNode to TeamParticipantNode
|Aligns with application logic that utilizes Participants rather than Users for node associations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|2
|style="width: 30%"| Modified queries in TeamParticipantNode to use teams_participant instead of teams_user
|Aligns with the changes made in teams_participant model to add new participant association.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|3
|Updated associations to reference TeamUserNode in entire repository
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==Test Plan==

We added a new spec file for the teams_participant model which was missing and fixed team_participant_controller_spec. Also as an additional step, we fixed model and controller tests for direct associations: Team, User, and Participant.

===Code coverage===

'''Before refactoring: 0%'''

'''After refactoring: 100%'''

[[File:teams-participant-code-cov.png|800px|center|Code coverage for <code>teams_participant.rb</code>]]

*<code>'''teams_participant'''</code>

[[File:Teams_participant_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team'''</code>

[[File:Team_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user'''</code>

[[File:User_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant'''</code>

[[File:Participant_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''teams_participant_controller'''</code>

[[File:Teams_participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team_controller'''</code>

[[File:Team_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user_controller'''</code>

[[File:Users_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant_controller'''</code>

[[File:Participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

==Next Steps==
During the refactoring from TeamsUser to TeamsParticipant, we initially retained the association between teams and users (with user_id as a foreign key) in TeamsParticipant. This approach was for backward compatibility, ensuring that other classes and tests would function without immediate disruption.

The next phase will involve fully removing this direct association between teams and users. Instead, we will maintain only the teams-participant relationship in the TeamsParticipant table.

This update will require modifying all references to TeamsParticipant across models and controllers, and adjusting logic to work with Participant instead of User. Certain cases do need user-specific fields previously stored within TeamsParticipant. With the user association deprecated, these areas will need updated logic to retrieve the user associated with each participant. This ensures continued functionality and accuracy of the code. Corresponding updates will also be necessary in the spec files to align with the changes.

==Team==

====Mentor====

* Jay, Patel

====Members====

* Agarwal, Arjit
* Manbhekar, Pranav
* Singhania, Chinmay

==References==

# [https://expertiza.ncsu.edu/ Expertiza]
# [https://docs.google.com/document/d/1fB9nHsop_yptjcj3CFn80BcZjXcSDbzcWwKvBDUTVrQ/edit?tab=t.0OSS Projects on Expertiza])
# [https://github.com/expertiza/expertiza Expertiza Github]
# [https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page Expertiza Wiki]

File:SequenceDiagram.png

2024-11-11T00:02:00Z

Csingha: Csingha uploaded a new version of File:SequenceDiagram.png

CSC/ECE 517 Fall 2024 - E2456. Refactor teams user.rb (Phase 2 - Design Document)

2024-11-11T00:00:34Z

Csingha: /* Sequence Diagram */

==Expertiza==

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc).
The National Science Foundation supports the Expertiza project.
It is used in select courses at NC State and by professors at several other colleges and universities.

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project.

==Problem Statement==

The TeamsUser class in the Expertiza repository serves as a join model between the Team and Participant classes, establishing a many-to-many relationship. Its primary purpose is to manage team memberships within the context of assignments or courses, facilitating functionalities such as retrieving a user's name, deleting users or teams, and managing participant associations.

The primary issue with the TeamsUser class is that it associates teams directly with users rather than with participants. In the context of the application, participants are users who are specifically associated with an assignment or a course. Since teams are formed within the scope of assignments or courses, handling team memberships through participants is more appropriate. Almost everywhere else, an assignment uses Participant objects rather than User objects. The exception is when it comes to Teams. It would simplify the design to use TeamsParticipants instead of TeamsUsers.

==Design Goal==

==Design Pattern==

==Class Diagram==
[[File:ClassDiagram_TeamsParticipant.png|1000px]]

==Sequence Diagram==
[[File:SequenceDiagram TeamsParticipant.png|1000px]]

==Solutions/Details of Changes Made==

===Phase 1 Improvements===

* Renamed TeamsUser to TeamsParticipant to modify application logic to join Teams with Participants instead of Users
* Updated associations in immediate neighbor classes i.e Teams, Users and Participants to ensure correctness and consistency in the data model
* Renamed method names for increased readability and removed redundant methods from the TeamsParticipant class
* Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity, improving overall maintainability of the codebase
* Renamed TeamUserNode to TeamParticipantNode for correctness, to align with the new design of Participation association in TeamsParticipant
* Added migrations to add foreign key for Participant in TeamsParticipant table and updated indexes for the same

===Phase 2 Plan===

* Update associations in all the models that were previously using TeamsUser to implement them with TeamsParticipant
* Modify implementations of all models, views, and controllers to use Participant with TeamsParticipant class instead of User
* This future involves modifying queries to retrieve participant and user objects that are passed to the TeamsParticipant class as commands to their methods
* Deprecate user_id foreign key from TeamsParticipant to completely remove the association of User from TeamsParticant, only linking Participants to Teams
* Update all the test cases to work with this implementation, including updating associations and mocking DB calls

==Files Added/Modified==

Changed files in <code>Model</code>:

==== Changes to <code>app/models/teams_user.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamsUser to TeamsParticipant
|Aligns with application logic that utilizes Participants rather than Users.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|2
|style="width: 30%"| Updated associations to reference Participants
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|3
|Removed <code>get_team_members</code> from teams_participant model
|The method was empty without any logic so it was just a placeholder method without any usage across the project.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|-
|4
|Renamed methods: <code>remove_team_if_participants_empty</code>, <code>remove_team_participant</code>, <code>first_participant_for_team</code>, <code>add_accepted_invitee_to_team</code>, <code>find_team_id</code> for clarity
|Improves code readability for new programmers.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|
|-
|5
|Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity
|To reduce Cognitive Complexity and making the model more maintainable and efficient
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==== Changes to <code>app/models/team_user_node.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamUserNode to TeamParticipantNode
|Aligns with application logic that utilizes Participants rather than Users for node associations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|2
|style="width: 30%"| Modified queries in TeamParticipantNode to use teams_participant instead of teams_user
|Aligns with the changes made in teams_participant model to add new participant association.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|3
|Updated associations to reference TeamUserNode in entire repository
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==Test Plan==

We added a new spec file for the teams_participant model which was missing and fixed team_participant_controller_spec. Also as an additional step, we fixed model and controller tests for direct associations: Team, User, and Participant.

===Code coverage===

'''Before refactoring: 0%'''

'''After refactoring: 100%'''

[[File:teams-participant-code-cov.png|800px|center|Code coverage for <code>teams_participant.rb</code>]]

*<code>'''teams_participant'''</code>

[[File:Teams_participant_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team'''</code>

[[File:Team_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user'''</code>

[[File:User_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant'''</code>

[[File:Participant_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''teams_participant_controller'''</code>

[[File:Teams_participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team_controller'''</code>

[[File:Team_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user_controller'''</code>

[[File:Users_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant_controller'''</code>

[[File:Participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

==Next Steps==
During the refactoring from TeamsUser to TeamsParticipant, we initially retained the association between teams and users (with user_id as a foreign key) in TeamsParticipant. This approach was for backward compatibility, ensuring that other classes and tests would function without immediate disruption.

The next phase will involve fully removing this direct association between teams and users. Instead, we will maintain only the teams-participant relationship in the TeamsParticipant table.

This update will require modifying all references to TeamsParticipant across models and controllers, and adjusting logic to work with Participant instead of User. Certain cases do need user-specific fields previously stored within TeamsParticipant. With the user association deprecated, these areas will need updated logic to retrieve the user associated with each participant. This ensures continued functionality and accuracy of the code. Corresponding updates will also be necessary in the spec files to align with the changes.

==Team==

====Mentor====

* Jay, Patel

====Members====

* Agarwal, Arjit
* Manbhekar, Pranav
* Singhania, Chinmay

==References==

# [https://expertiza.ncsu.edu/ Expertiza]
# [https://docs.google.com/document/d/1fB9nHsop_yptjcj3CFn80BcZjXcSDbzcWwKvBDUTVrQ/edit?tab=t.0OSS Projects on Expertiza])
# [https://github.com/expertiza/expertiza Expertiza Github]
# [https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page Expertiza Wiki]

CSC/ECE 517 Fall 2024 - E2456. Refactor teams user.rb (Phase 2 - Design Document)

2024-11-11T00:00:29Z

Csingha: /* Sequence Diagram */

==Expertiza==

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc).
The National Science Foundation supports the Expertiza project.
It is used in select courses at NC State and by professors at several other colleges and universities.

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project.

==Problem Statement==

The TeamsUser class in the Expertiza repository serves as a join model between the Team and Participant classes, establishing a many-to-many relationship. Its primary purpose is to manage team memberships within the context of assignments or courses, facilitating functionalities such as retrieving a user's name, deleting users or teams, and managing participant associations.

The primary issue with the TeamsUser class is that it associates teams directly with users rather than with participants. In the context of the application, participants are users who are specifically associated with an assignment or a course. Since teams are formed within the scope of assignments or courses, handling team memberships through participants is more appropriate. Almost everywhere else, an assignment uses Participant objects rather than User objects. The exception is when it comes to Teams. It would simplify the design to use TeamsParticipants instead of TeamsUsers.

==Design Goal==

==Design Pattern==

==Class Diagram==
[[File:ClassDiagram_TeamsParticipant.png|1000px]]

==Sequence Diagram==
[[File:SequenceDiagram TeamsParticipant.png|1000px|thumb]]

==Solutions/Details of Changes Made==

===Phase 1 Improvements===

* Renamed TeamsUser to TeamsParticipant to modify application logic to join Teams with Participants instead of Users
* Updated associations in immediate neighbor classes i.e Teams, Users and Participants to ensure correctness and consistency in the data model
* Renamed method names for increased readability and removed redundant methods from the TeamsParticipant class
* Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity, improving overall maintainability of the codebase
* Renamed TeamUserNode to TeamParticipantNode for correctness, to align with the new design of Participation association in TeamsParticipant
* Added migrations to add foreign key for Participant in TeamsParticipant table and updated indexes for the same

===Phase 2 Plan===

* Update associations in all the models that were previously using TeamsUser to implement them with TeamsParticipant
* Modify implementations of all models, views, and controllers to use Participant with TeamsParticipant class instead of User
* This future involves modifying queries to retrieve participant and user objects that are passed to the TeamsParticipant class as commands to their methods
* Deprecate user_id foreign key from TeamsParticipant to completely remove the association of User from TeamsParticant, only linking Participants to Teams
* Update all the test cases to work with this implementation, including updating associations and mocking DB calls

==Files Added/Modified==

Changed files in <code>Model</code>:

==== Changes to <code>app/models/teams_user.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamsUser to TeamsParticipant
|Aligns with application logic that utilizes Participants rather than Users.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|2
|style="width: 30%"| Updated associations to reference Participants
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|3
|Removed <code>get_team_members</code> from teams_participant model
|The method was empty without any logic so it was just a placeholder method without any usage across the project.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|-
|4
|Renamed methods: <code>remove_team_if_participants_empty</code>, <code>remove_team_participant</code>, <code>first_participant_for_team</code>, <code>add_accepted_invitee_to_team</code>, <code>find_team_id</code> for clarity
|Improves code readability for new programmers.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|
|-
|5
|Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity
|To reduce Cognitive Complexity and making the model more maintainable and efficient
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==== Changes to <code>app/models/team_user_node.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamUserNode to TeamParticipantNode
|Aligns with application logic that utilizes Participants rather than Users for node associations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|2
|style="width: 30%"| Modified queries in TeamParticipantNode to use teams_participant instead of teams_user
|Aligns with the changes made in teams_participant model to add new participant association.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|3
|Updated associations to reference TeamUserNode in entire repository
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==Test Plan==

We added a new spec file for the teams_participant model which was missing and fixed team_participant_controller_spec. Also as an additional step, we fixed model and controller tests for direct associations: Team, User, and Participant.

===Code coverage===

'''Before refactoring: 0%'''

'''After refactoring: 100%'''

[[File:teams-participant-code-cov.png|800px|center|Code coverage for <code>teams_participant.rb</code>]]

*<code>'''teams_participant'''</code>

[[File:Teams_participant_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team'''</code>

[[File:Team_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user'''</code>

[[File:User_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant'''</code>

[[File:Participant_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''teams_participant_controller'''</code>

[[File:Teams_participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team_controller'''</code>

[[File:Team_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user_controller'''</code>

[[File:Users_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant_controller'''</code>

[[File:Participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

==Next Steps==
During the refactoring from TeamsUser to TeamsParticipant, we initially retained the association between teams and users (with user_id as a foreign key) in TeamsParticipant. This approach was for backward compatibility, ensuring that other classes and tests would function without immediate disruption.

The next phase will involve fully removing this direct association between teams and users. Instead, we will maintain only the teams-participant relationship in the TeamsParticipant table.

This update will require modifying all references to TeamsParticipant across models and controllers, and adjusting logic to work with Participant instead of User. Certain cases do need user-specific fields previously stored within TeamsParticipant. With the user association deprecated, these areas will need updated logic to retrieve the user associated with each participant. This ensures continued functionality and accuracy of the code. Corresponding updates will also be necessary in the spec files to align with the changes.

==Team==

====Mentor====

* Jay, Patel

====Members====

* Agarwal, Arjit
* Manbhekar, Pranav
* Singhania, Chinmay

==References==

# [https://expertiza.ncsu.edu/ Expertiza]
# [https://docs.google.com/document/d/1fB9nHsop_yptjcj3CFn80BcZjXcSDbzcWwKvBDUTVrQ/edit?tab=t.0OSS Projects on Expertiza])
# [https://github.com/expertiza/expertiza Expertiza Github]
# [https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page Expertiza Wiki]

CSC/ECE 517 Fall 2024 - E2456. Refactor teams user.rb (Phase 2 - Design Document)

2024-11-11T00:00:21Z

Csingha: /* Sequence Diagram */

==Expertiza==

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc).
The National Science Foundation supports the Expertiza project.
It is used in select courses at NC State and by professors at several other colleges and universities.

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project.

==Problem Statement==

The TeamsUser class in the Expertiza repository serves as a join model between the Team and Participant classes, establishing a many-to-many relationship. Its primary purpose is to manage team memberships within the context of assignments or courses, facilitating functionalities such as retrieving a user's name, deleting users or teams, and managing participant associations.

The primary issue with the TeamsUser class is that it associates teams directly with users rather than with participants. In the context of the application, participants are users who are specifically associated with an assignment or a course. Since teams are formed within the scope of assignments or courses, handling team memberships through participants is more appropriate. Almost everywhere else, an assignment uses Participant objects rather than User objects. The exception is when it comes to Teams. It would simplify the design to use TeamsParticipants instead of TeamsUsers.

==Design Goal==

==Design Pattern==

==Class Diagram==
[[File:ClassDiagram_TeamsParticipant.png|1000px]]

==Sequence Diagram==
[[File:SequenceDiagram TeamsParticipant.png|1000px|left]]

==Solutions/Details of Changes Made==

===Phase 1 Improvements===

* Renamed TeamsUser to TeamsParticipant to modify application logic to join Teams with Participants instead of Users
* Updated associations in immediate neighbor classes i.e Teams, Users and Participants to ensure correctness and consistency in the data model
* Renamed method names for increased readability and removed redundant methods from the TeamsParticipant class
* Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity, improving overall maintainability of the codebase
* Renamed TeamUserNode to TeamParticipantNode for correctness, to align with the new design of Participation association in TeamsParticipant
* Added migrations to add foreign key for Participant in TeamsParticipant table and updated indexes for the same

===Phase 2 Plan===

* Update associations in all the models that were previously using TeamsUser to implement them with TeamsParticipant
* Modify implementations of all models, views, and controllers to use Participant with TeamsParticipant class instead of User
* This future involves modifying queries to retrieve participant and user objects that are passed to the TeamsParticipant class as commands to their methods
* Deprecate user_id foreign key from TeamsParticipant to completely remove the association of User from TeamsParticant, only linking Participants to Teams
* Update all the test cases to work with this implementation, including updating associations and mocking DB calls

==Files Added/Modified==

Changed files in <code>Model</code>:

==== Changes to <code>app/models/teams_user.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamsUser to TeamsParticipant
|Aligns with application logic that utilizes Participants rather than Users.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|2
|style="width: 30%"| Updated associations to reference Participants
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|3
|Removed <code>get_team_members</code> from teams_participant model
|The method was empty without any logic so it was just a placeholder method without any usage across the project.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|-
|4
|Renamed methods: <code>remove_team_if_participants_empty</code>, <code>remove_team_participant</code>, <code>first_participant_for_team</code>, <code>add_accepted_invitee_to_team</code>, <code>find_team_id</code> for clarity
|Improves code readability for new programmers.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|
|-
|5
|Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity
|To reduce Cognitive Complexity and making the model more maintainable and efficient
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==== Changes to <code>app/models/team_user_node.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamUserNode to TeamParticipantNode
|Aligns with application logic that utilizes Participants rather than Users for node associations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|2
|style="width: 30%"| Modified queries in TeamParticipantNode to use teams_participant instead of teams_user
|Aligns with the changes made in teams_participant model to add new participant association.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|3
|Updated associations to reference TeamUserNode in entire repository
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==Test Plan==

We added a new spec file for the teams_participant model which was missing and fixed team_participant_controller_spec. Also as an additional step, we fixed model and controller tests for direct associations: Team, User, and Participant.

===Code coverage===

'''Before refactoring: 0%'''

'''After refactoring: 100%'''

[[File:teams-participant-code-cov.png|800px|center|Code coverage for <code>teams_participant.rb</code>]]

*<code>'''teams_participant'''</code>

[[File:Teams_participant_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team'''</code>

[[File:Team_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user'''</code>

[[File:User_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant'''</code>

[[File:Participant_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''teams_participant_controller'''</code>

[[File:Teams_participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team_controller'''</code>

[[File:Team_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user_controller'''</code>

[[File:Users_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant_controller'''</code>

[[File:Participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

==Next Steps==
During the refactoring from TeamsUser to TeamsParticipant, we initially retained the association between teams and users (with user_id as a foreign key) in TeamsParticipant. This approach was for backward compatibility, ensuring that other classes and tests would function without immediate disruption.

The next phase will involve fully removing this direct association between teams and users. Instead, we will maintain only the teams-participant relationship in the TeamsParticipant table.

This update will require modifying all references to TeamsParticipant across models and controllers, and adjusting logic to work with Participant instead of User. Certain cases do need user-specific fields previously stored within TeamsParticipant. With the user association deprecated, these areas will need updated logic to retrieve the user associated with each participant. This ensures continued functionality and accuracy of the code. Corresponding updates will also be necessary in the spec files to align with the changes.

==Team==

====Mentor====

* Jay, Patel

====Members====

* Agarwal, Arjit
* Manbhekar, Pranav
* Singhania, Chinmay

==References==

# [https://expertiza.ncsu.edu/ Expertiza]
# [https://docs.google.com/document/d/1fB9nHsop_yptjcj3CFn80BcZjXcSDbzcWwKvBDUTVrQ/edit?tab=t.0OSS Projects on Expertiza])
# [https://github.com/expertiza/expertiza Expertiza Github]
# [https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page Expertiza Wiki]

CSC/ECE 517 Fall 2024 - E2456. Refactor teams user.rb (Phase 2 - Design Document)

2024-11-11T00:00:04Z

Csingha: /* Sequence Diagram */

==Expertiza==

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc).
The National Science Foundation supports the Expertiza project.
It is used in select courses at NC State and by professors at several other colleges and universities.

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project.

==Problem Statement==

The TeamsUser class in the Expertiza repository serves as a join model between the Team and Participant classes, establishing a many-to-many relationship. Its primary purpose is to manage team memberships within the context of assignments or courses, facilitating functionalities such as retrieving a user's name, deleting users or teams, and managing participant associations.

The primary issue with the TeamsUser class is that it associates teams directly with users rather than with participants. In the context of the application, participants are users who are specifically associated with an assignment or a course. Since teams are formed within the scope of assignments or courses, handling team memberships through participants is more appropriate. Almost everywhere else, an assignment uses Participant objects rather than User objects. The exception is when it comes to Teams. It would simplify the design to use TeamsParticipants instead of TeamsUsers.

==Design Goal==

==Design Pattern==

==Class Diagram==
[[File:ClassDiagram_TeamsParticipant.png|1000px]]

==Sequence Diagram==
[[File:SequenceDiagram TeamsParticipant.png|1000px]]

==Solutions/Details of Changes Made==

===Phase 1 Improvements===

* Renamed TeamsUser to TeamsParticipant to modify application logic to join Teams with Participants instead of Users
* Updated associations in immediate neighbor classes i.e Teams, Users and Participants to ensure correctness and consistency in the data model
* Renamed method names for increased readability and removed redundant methods from the TeamsParticipant class
* Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity, improving overall maintainability of the codebase
* Renamed TeamUserNode to TeamParticipantNode for correctness, to align with the new design of Participation association in TeamsParticipant
* Added migrations to add foreign key for Participant in TeamsParticipant table and updated indexes for the same

===Phase 2 Plan===

* Update associations in all the models that were previously using TeamsUser to implement them with TeamsParticipant
* Modify implementations of all models, views, and controllers to use Participant with TeamsParticipant class instead of User
* This future involves modifying queries to retrieve participant and user objects that are passed to the TeamsParticipant class as commands to their methods
* Deprecate user_id foreign key from TeamsParticipant to completely remove the association of User from TeamsParticant, only linking Participants to Teams
* Update all the test cases to work with this implementation, including updating associations and mocking DB calls

==Files Added/Modified==

Changed files in <code>Model</code>:

==== Changes to <code>app/models/teams_user.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamsUser to TeamsParticipant
|Aligns with application logic that utilizes Participants rather than Users.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|2
|style="width: 30%"| Updated associations to reference Participants
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|3
|Removed <code>get_team_members</code> from teams_participant model
|The method was empty without any logic so it was just a placeholder method without any usage across the project.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|-
|4
|Renamed methods: <code>remove_team_if_participants_empty</code>, <code>remove_team_participant</code>, <code>first_participant_for_team</code>, <code>add_accepted_invitee_to_team</code>, <code>find_team_id</code> for clarity
|Improves code readability for new programmers.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|
|-
|5
|Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity
|To reduce Cognitive Complexity and making the model more maintainable and efficient
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==== Changes to <code>app/models/team_user_node.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamUserNode to TeamParticipantNode
|Aligns with application logic that utilizes Participants rather than Users for node associations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|2
|style="width: 30%"| Modified queries in TeamParticipantNode to use teams_participant instead of teams_user
|Aligns with the changes made in teams_participant model to add new participant association.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|3
|Updated associations to reference TeamUserNode in entire repository
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==Test Plan==

We added a new spec file for the teams_participant model which was missing and fixed team_participant_controller_spec. Also as an additional step, we fixed model and controller tests for direct associations: Team, User, and Participant.

===Code coverage===

'''Before refactoring: 0%'''

'''After refactoring: 100%'''

[[File:teams-participant-code-cov.png|800px|center|Code coverage for <code>teams_participant.rb</code>]]

*<code>'''teams_participant'''</code>

[[File:Teams_participant_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team'''</code>

[[File:Team_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user'''</code>

[[File:User_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant'''</code>

[[File:Participant_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''teams_participant_controller'''</code>

[[File:Teams_participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team_controller'''</code>

[[File:Team_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user_controller'''</code>

[[File:Users_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant_controller'''</code>

[[File:Participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

==Next Steps==
During the refactoring from TeamsUser to TeamsParticipant, we initially retained the association between teams and users (with user_id as a foreign key) in TeamsParticipant. This approach was for backward compatibility, ensuring that other classes and tests would function without immediate disruption.

The next phase will involve fully removing this direct association between teams and users. Instead, we will maintain only the teams-participant relationship in the TeamsParticipant table.

This update will require modifying all references to TeamsParticipant across models and controllers, and adjusting logic to work with Participant instead of User. Certain cases do need user-specific fields previously stored within TeamsParticipant. With the user association deprecated, these areas will need updated logic to retrieve the user associated with each participant. This ensures continued functionality and accuracy of the code. Corresponding updates will also be necessary in the spec files to align with the changes.

==Team==

====Mentor====

* Jay, Patel

====Members====

* Agarwal, Arjit
* Manbhekar, Pranav
* Singhania, Chinmay

==References==

# [https://expertiza.ncsu.edu/ Expertiza]
# [https://docs.google.com/document/d/1fB9nHsop_yptjcj3CFn80BcZjXcSDbzcWwKvBDUTVrQ/edit?tab=t.0OSS Projects on Expertiza])
# [https://github.com/expertiza/expertiza Expertiza Github]
# [https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page Expertiza Wiki]

CSC/ECE 517 Fall 2024 - E2456. Refactor teams user.rb (Phase 2 - Design Document)

2024-11-10T23:59:50Z

Csingha: /* Sequence Diagram */

==Expertiza==

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc).
The National Science Foundation supports the Expertiza project.
It is used in select courses at NC State and by professors at several other colleges and universities.

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project.

==Problem Statement==

The TeamsUser class in the Expertiza repository serves as a join model between the Team and Participant classes, establishing a many-to-many relationship. Its primary purpose is to manage team memberships within the context of assignments or courses, facilitating functionalities such as retrieving a user's name, deleting users or teams, and managing participant associations.

The primary issue with the TeamsUser class is that it associates teams directly with users rather than with participants. In the context of the application, participants are users who are specifically associated with an assignment or a course. Since teams are formed within the scope of assignments or courses, handling team memberships through participants is more appropriate. Almost everywhere else, an assignment uses Participant objects rather than User objects. The exception is when it comes to Teams. It would simplify the design to use TeamsParticipants instead of TeamsUsers.

==Design Goal==

==Design Pattern==

==Class Diagram==
[[File:ClassDiagram_TeamsParticipant.png|1000px]]

==Sequence Diagram==
[[File:SequenceDiagram TeamsParticipant.png]]

==Solutions/Details of Changes Made==

===Phase 1 Improvements===

* Renamed TeamsUser to TeamsParticipant to modify application logic to join Teams with Participants instead of Users
* Updated associations in immediate neighbor classes i.e Teams, Users and Participants to ensure correctness and consistency in the data model
* Renamed method names for increased readability and removed redundant methods from the TeamsParticipant class
* Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity, improving overall maintainability of the codebase
* Renamed TeamUserNode to TeamParticipantNode for correctness, to align with the new design of Participation association in TeamsParticipant
* Added migrations to add foreign key for Participant in TeamsParticipant table and updated indexes for the same

===Phase 2 Plan===

* Update associations in all the models that were previously using TeamsUser to implement them with TeamsParticipant
* Modify implementations of all models, views, and controllers to use Participant with TeamsParticipant class instead of User
* This future involves modifying queries to retrieve participant and user objects that are passed to the TeamsParticipant class as commands to their methods
* Deprecate user_id foreign key from TeamsParticipant to completely remove the association of User from TeamsParticant, only linking Participants to Teams
* Update all the test cases to work with this implementation, including updating associations and mocking DB calls

==Files Added/Modified==

Changed files in <code>Model</code>:

==== Changes to <code>app/models/teams_user.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamsUser to TeamsParticipant
|Aligns with application logic that utilizes Participants rather than Users.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|2
|style="width: 30%"| Updated associations to reference Participants
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|3
|Removed <code>get_team_members</code> from teams_participant model
|The method was empty without any logic so it was just a placeholder method without any usage across the project.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|-
|4
|Renamed methods: <code>remove_team_if_participants_empty</code>, <code>remove_team_participant</code>, <code>first_participant_for_team</code>, <code>add_accepted_invitee_to_team</code>, <code>find_team_id</code> for clarity
|Improves code readability for new programmers.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|
|-
|5
|Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity
|To reduce Cognitive Complexity and making the model more maintainable and efficient
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==== Changes to <code>app/models/team_user_node.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamUserNode to TeamParticipantNode
|Aligns with application logic that utilizes Participants rather than Users for node associations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|2
|style="width: 30%"| Modified queries in TeamParticipantNode to use teams_participant instead of teams_user
|Aligns with the changes made in teams_participant model to add new participant association.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|3
|Updated associations to reference TeamUserNode in entire repository
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==Test Plan==

We added a new spec file for the teams_participant model which was missing and fixed team_participant_controller_spec. Also as an additional step, we fixed model and controller tests for direct associations: Team, User, and Participant.

===Code coverage===

'''Before refactoring: 0%'''

'''After refactoring: 100%'''

[[File:teams-participant-code-cov.png|800px|center|Code coverage for <code>teams_participant.rb</code>]]

*<code>'''teams_participant'''</code>

[[File:Teams_participant_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team'''</code>

[[File:Team_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user'''</code>

[[File:User_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant'''</code>

[[File:Participant_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''teams_participant_controller'''</code>

[[File:Teams_participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team_controller'''</code>

[[File:Team_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user_controller'''</code>

[[File:Users_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant_controller'''</code>

[[File:Participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

==Next Steps==
During the refactoring from TeamsUser to TeamsParticipant, we initially retained the association between teams and users (with user_id as a foreign key) in TeamsParticipant. This approach was for backward compatibility, ensuring that other classes and tests would function without immediate disruption.

The next phase will involve fully removing this direct association between teams and users. Instead, we will maintain only the teams-participant relationship in the TeamsParticipant table.

This update will require modifying all references to TeamsParticipant across models and controllers, and adjusting logic to work with Participant instead of User. Certain cases do need user-specific fields previously stored within TeamsParticipant. With the user association deprecated, these areas will need updated logic to retrieve the user associated with each participant. This ensures continued functionality and accuracy of the code. Corresponding updates will also be necessary in the spec files to align with the changes.

==Team==

====Mentor====

* Jay, Patel

====Members====

* Agarwal, Arjit
* Manbhekar, Pranav
* Singhania, Chinmay

==References==

# [https://expertiza.ncsu.edu/ Expertiza]
# [https://docs.google.com/document/d/1fB9nHsop_yptjcj3CFn80BcZjXcSDbzcWwKvBDUTVrQ/edit?tab=t.0OSS Projects on Expertiza])
# [https://github.com/expertiza/expertiza Expertiza Github]
# [https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page Expertiza Wiki]

File:SequenceDiagram TeamsParticipant.png

2024-11-10T23:59:33Z

Csingha:

CSC/ECE 517 Fall 2024 - E2456. Refactor teams user.rb (Phase 2 - Design Document)

2024-11-10T23:58:55Z

Csingha: /* Use Cases */

==Expertiza==

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc).
The National Science Foundation supports the Expertiza project.
It is used in select courses at NC State and by professors at several other colleges and universities.

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project.

==Problem Statement==

The TeamsUser class in the Expertiza repository serves as a join model between the Team and Participant classes, establishing a many-to-many relationship. Its primary purpose is to manage team memberships within the context of assignments or courses, facilitating functionalities such as retrieving a user's name, deleting users or teams, and managing participant associations.

The primary issue with the TeamsUser class is that it associates teams directly with users rather than with participants. In the context of the application, participants are users who are specifically associated with an assignment or a course. Since teams are formed within the scope of assignments or courses, handling team memberships through participants is more appropriate. Almost everywhere else, an assignment uses Participant objects rather than User objects. The exception is when it comes to Teams. It would simplify the design to use TeamsParticipants instead of TeamsUsers.

==Design Goal==

==Design Pattern==

==Class Diagram==
[[File:ClassDiagram_TeamsParticipant.png|1000px]]

==Sequence Diagram==

==Solutions/Details of Changes Made==

===Phase 1 Improvements===

* Renamed TeamsUser to TeamsParticipant to modify application logic to join Teams with Participants instead of Users
* Updated associations in immediate neighbor classes i.e Teams, Users and Participants to ensure correctness and consistency in the data model
* Renamed method names for increased readability and removed redundant methods from the TeamsParticipant class
* Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity, improving overall maintainability of the codebase
* Renamed TeamUserNode to TeamParticipantNode for correctness, to align with the new design of Participation association in TeamsParticipant
* Added migrations to add foreign key for Participant in TeamsParticipant table and updated indexes for the same

===Phase 2 Plan===

* Update associations in all the models that were previously using TeamsUser to implement them with TeamsParticipant
* Modify implementations of all models, views, and controllers to use Participant with TeamsParticipant class instead of User
* This future involves modifying queries to retrieve participant and user objects that are passed to the TeamsParticipant class as commands to their methods
* Deprecate user_id foreign key from TeamsParticipant to completely remove the association of User from TeamsParticant, only linking Participants to Teams
* Update all the test cases to work with this implementation, including updating associations and mocking DB calls

==Files Added/Modified==

Changed files in <code>Model</code>:

==== Changes to <code>app/models/teams_user.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamsUser to TeamsParticipant
|Aligns with application logic that utilizes Participants rather than Users.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|2
|style="width: 30%"| Updated associations to reference Participants
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|3
|Removed <code>get_team_members</code> from teams_participant model
|The method was empty without any logic so it was just a placeholder method without any usage across the project.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|-
|4
|Renamed methods: <code>remove_team_if_participants_empty</code>, <code>remove_team_participant</code>, <code>first_participant_for_team</code>, <code>add_accepted_invitee_to_team</code>, <code>find_team_id</code> for clarity
|Improves code readability for new programmers.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|
|-
|5
|Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity
|To reduce Cognitive Complexity and making the model more maintainable and efficient
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==== Changes to <code>app/models/team_user_node.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamUserNode to TeamParticipantNode
|Aligns with application logic that utilizes Participants rather than Users for node associations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|2
|style="width: 30%"| Modified queries in TeamParticipantNode to use teams_participant instead of teams_user
|Aligns with the changes made in teams_participant model to add new participant association.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|3
|Updated associations to reference TeamUserNode in entire repository
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==Test Plan==

We added a new spec file for the teams_participant model which was missing and fixed team_participant_controller_spec. Also as an additional step, we fixed model and controller tests for direct associations: Team, User, and Participant.

===Code coverage===

'''Before refactoring: 0%'''

'''After refactoring: 100%'''

[[File:teams-participant-code-cov.png|800px|center|Code coverage for <code>teams_participant.rb</code>]]

*<code>'''teams_participant'''</code>

[[File:Teams_participant_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team'''</code>

[[File:Team_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user'''</code>

[[File:User_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant'''</code>

[[File:Participant_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''teams_participant_controller'''</code>

[[File:Teams_participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team_controller'''</code>

[[File:Team_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user_controller'''</code>

[[File:Users_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant_controller'''</code>

[[File:Participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

==Next Steps==
During the refactoring from TeamsUser to TeamsParticipant, we initially retained the association between teams and users (with user_id as a foreign key) in TeamsParticipant. This approach was for backward compatibility, ensuring that other classes and tests would function without immediate disruption.

The next phase will involve fully removing this direct association between teams and users. Instead, we will maintain only the teams-participant relationship in the TeamsParticipant table.

This update will require modifying all references to TeamsParticipant across models and controllers, and adjusting logic to work with Participant instead of User. Certain cases do need user-specific fields previously stored within TeamsParticipant. With the user association deprecated, these areas will need updated logic to retrieve the user associated with each participant. This ensures continued functionality and accuracy of the code. Corresponding updates will also be necessary in the spec files to align with the changes.

==Team==

====Mentor====

* Jay, Patel

====Members====

* Agarwal, Arjit
* Manbhekar, Pranav
* Singhania, Chinmay

==References==

# [https://expertiza.ncsu.edu/ Expertiza]
# [https://docs.google.com/document/d/1fB9nHsop_yptjcj3CFn80BcZjXcSDbzcWwKvBDUTVrQ/edit?tab=t.0OSS Projects on Expertiza])
# [https://github.com/expertiza/expertiza Expertiza Github]
# [https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page Expertiza Wiki]

CSC/ECE 517 Fall 2024 - E2456. Refactor teams user.rb (Phase 2 - Design Document)

2024-11-10T23:48:20Z

Csingha: /* Class Diagram */

==Expertiza==

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc).
The National Science Foundation supports the Expertiza project.
It is used in select courses at NC State and by professors at several other colleges and universities.

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project.

==Problem Statement==

The TeamsUser class in the Expertiza repository serves as a join model between the Team and Participant classes, establishing a many-to-many relationship. Its primary purpose is to manage team memberships within the context of assignments or courses, facilitating functionalities such as retrieving a user's name, deleting users or teams, and managing participant associations.

The primary issue with the TeamsUser class is that it associates teams directly with users rather than with participants. In the context of the application, participants are users who are specifically associated with an assignment or a course. Since teams are formed within the scope of assignments or courses, handling team memberships through participants is more appropriate. Almost everywhere else, an assignment uses Participant objects rather than User objects. The exception is when it comes to Teams. It would simplify the design to use TeamsParticipants instead of TeamsUsers.

==Design Goal==

==Design Pattern==

==Class Diagram==
[[File:ClassDiagram_TeamsParticipant.png|1000px]]

==Use Cases==

==Solutions/Details of Changes Made==

===Phase 1 Improvements===

* Renamed TeamsUser to TeamsParticipant to modify application logic to join Teams with Participants instead of Users
* Updated associations in immediate neighbor classes i.e Teams, Users and Participants to ensure correctness and consistency in the data model
* Renamed method names for increased readability and removed redundant methods from the TeamsParticipant class
* Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity, improving overall maintainability of the codebase
* Renamed TeamUserNode to TeamParticipantNode for correctness, to align with the new design of Participation association in TeamsParticipant
* Added migrations to add foreign key for Participant in TeamsParticipant table and updated indexes for the same

===Phase 2 Plan===

* Update associations in all the models that were previously using TeamsUser to implement them with TeamsParticipant
* Modify implementations of all models, views, and controllers to use Participant with TeamsParticipant class instead of User
* This future involves modifying queries to retrieve participant and user objects that are passed to the TeamsParticipant class as commands to their methods
* Deprecate user_id foreign key from TeamsParticipant to completely remove the association of User from TeamsParticant, only linking Participants to Teams
* Update all the test cases to work with this implementation, including updating associations and mocking DB calls

==Files Added/Modified==

Changed files in <code>Model</code>:

==== Changes to <code>app/models/teams_user.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamsUser to TeamsParticipant
|Aligns with application logic that utilizes Participants rather than Users.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|2
|style="width: 30%"| Updated associations to reference Participants
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|3
|Removed <code>get_team_members</code> from teams_participant model
|The method was empty without any logic so it was just a placeholder method without any usage across the project.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|-
|4
|Renamed methods: <code>remove_team_if_participants_empty</code>, <code>remove_team_participant</code>, <code>first_participant_for_team</code>, <code>add_accepted_invitee_to_team</code>, <code>find_team_id</code> for clarity
|Improves code readability for new programmers.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|
|-
|5
|Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity
|To reduce Cognitive Complexity and making the model more maintainable and efficient
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==== Changes to <code>app/models/team_user_node.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamUserNode to TeamParticipantNode
|Aligns with application logic that utilizes Participants rather than Users for node associations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|2
|style="width: 30%"| Modified queries in TeamParticipantNode to use teams_participant instead of teams_user
|Aligns with the changes made in teams_participant model to add new participant association.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|3
|Updated associations to reference TeamUserNode in entire repository
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==Test Plan==

We added a new spec file for the teams_participant model which was missing and fixed team_participant_controller_spec. Also as an additional step, we fixed model and controller tests for direct associations: Team, User, and Participant.

===Code coverage===

'''Before refactoring: 0%'''

'''After refactoring: 100%'''

[[File:teams-participant-code-cov.png|800px|center|Code coverage for <code>teams_participant.rb</code>]]

*<code>'''teams_participant'''</code>

[[File:Teams_participant_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team'''</code>

[[File:Team_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user'''</code>

[[File:User_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant'''</code>

[[File:Participant_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''teams_participant_controller'''</code>

[[File:Teams_participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team_controller'''</code>

[[File:Team_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user_controller'''</code>

[[File:Users_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant_controller'''</code>

[[File:Participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

==Next Steps==
During the refactoring from TeamsUser to TeamsParticipant, we initially retained the association between teams and users (with user_id as a foreign key) in TeamsParticipant. This approach was for backward compatibility, ensuring that other classes and tests would function without immediate disruption.

The next phase will involve fully removing this direct association between teams and users. Instead, we will maintain only the teams-participant relationship in the TeamsParticipant table.

This update will require modifying all references to TeamsParticipant across models and controllers, and adjusting logic to work with Participant instead of User. Certain cases do need user-specific fields previously stored within TeamsParticipant. With the user association deprecated, these areas will need updated logic to retrieve the user associated with each participant. This ensures continued functionality and accuracy of the code. Corresponding updates will also be necessary in the spec files to align with the changes.

==Team==

====Mentor====

* Jay, Patel

====Members====

* Agarwal, Arjit
* Manbhekar, Pranav
* Singhania, Chinmay

==References==

# [https://expertiza.ncsu.edu/ Expertiza]
# [https://docs.google.com/document/d/1fB9nHsop_yptjcj3CFn80BcZjXcSDbzcWwKvBDUTVrQ/edit?tab=t.0OSS Projects on Expertiza])
# [https://github.com/expertiza/expertiza Expertiza Github]
# [https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page Expertiza Wiki]

CSC/ECE 517 Fall 2024 - E2456. Refactor teams user.rb (Phase 2 - Design Document)

2024-11-10T23:48:09Z

Csingha: /* Class Diagram */

==Expertiza==

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc).
The National Science Foundation supports the Expertiza project.
It is used in select courses at NC State and by professors at several other colleges and universities.

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project.

==Problem Statement==

The TeamsUser class in the Expertiza repository serves as a join model between the Team and Participant classes, establishing a many-to-many relationship. Its primary purpose is to manage team memberships within the context of assignments or courses, facilitating functionalities such as retrieving a user's name, deleting users or teams, and managing participant associations.

The primary issue with the TeamsUser class is that it associates teams directly with users rather than with participants. In the context of the application, participants are users who are specifically associated with an assignment or a course. Since teams are formed within the scope of assignments or courses, handling team memberships through participants is more appropriate. Almost everywhere else, an assignment uses Participant objects rather than User objects. The exception is when it comes to Teams. It would simplify the design to use TeamsParticipants instead of TeamsUsers.

==Design Goal==

==Design Pattern==

==Class Diagram==
[[File:ClassDiagram_TeamsParticipant.png|800px]]

==Use Cases==

==Solutions/Details of Changes Made==

===Phase 1 Improvements===

* Renamed TeamsUser to TeamsParticipant to modify application logic to join Teams with Participants instead of Users
* Updated associations in immediate neighbor classes i.e Teams, Users and Participants to ensure correctness and consistency in the data model
* Renamed method names for increased readability and removed redundant methods from the TeamsParticipant class
* Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity, improving overall maintainability of the codebase
* Renamed TeamUserNode to TeamParticipantNode for correctness, to align with the new design of Participation association in TeamsParticipant
* Added migrations to add foreign key for Participant in TeamsParticipant table and updated indexes for the same

===Phase 2 Plan===

* Update associations in all the models that were previously using TeamsUser to implement them with TeamsParticipant
* Modify implementations of all models, views, and controllers to use Participant with TeamsParticipant class instead of User
* This future involves modifying queries to retrieve participant and user objects that are passed to the TeamsParticipant class as commands to their methods
* Deprecate user_id foreign key from TeamsParticipant to completely remove the association of User from TeamsParticant, only linking Participants to Teams
* Update all the test cases to work with this implementation, including updating associations and mocking DB calls

==Files Added/Modified==

Changed files in <code>Model</code>:

==== Changes to <code>app/models/teams_user.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamsUser to TeamsParticipant
|Aligns with application logic that utilizes Participants rather than Users.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|2
|style="width: 30%"| Updated associations to reference Participants
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|3
|Removed <code>get_team_members</code> from teams_participant model
|The method was empty without any logic so it was just a placeholder method without any usage across the project.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|-
|4
|Renamed methods: <code>remove_team_if_participants_empty</code>, <code>remove_team_participant</code>, <code>first_participant_for_team</code>, <code>add_accepted_invitee_to_team</code>, <code>find_team_id</code> for clarity
|Improves code readability for new programmers.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|
|-
|5
|Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity
|To reduce Cognitive Complexity and making the model more maintainable and efficient
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==== Changes to <code>app/models/team_user_node.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamUserNode to TeamParticipantNode
|Aligns with application logic that utilizes Participants rather than Users for node associations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|2
|style="width: 30%"| Modified queries in TeamParticipantNode to use teams_participant instead of teams_user
|Aligns with the changes made in teams_participant model to add new participant association.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|3
|Updated associations to reference TeamUserNode in entire repository
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==Test Plan==

We added a new spec file for the teams_participant model which was missing and fixed team_participant_controller_spec. Also as an additional step, we fixed model and controller tests for direct associations: Team, User, and Participant.

===Code coverage===

'''Before refactoring: 0%'''

'''After refactoring: 100%'''

[[File:teams-participant-code-cov.png|800px|center|Code coverage for <code>teams_participant.rb</code>]]

*<code>'''teams_participant'''</code>

[[File:Teams_participant_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team'''</code>

[[File:Team_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user'''</code>

[[File:User_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant'''</code>

[[File:Participant_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''teams_participant_controller'''</code>

[[File:Teams_participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team_controller'''</code>

[[File:Team_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user_controller'''</code>

[[File:Users_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant_controller'''</code>

[[File:Participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

==Next Steps==
During the refactoring from TeamsUser to TeamsParticipant, we initially retained the association between teams and users (with user_id as a foreign key) in TeamsParticipant. This approach was for backward compatibility, ensuring that other classes and tests would function without immediate disruption.

The next phase will involve fully removing this direct association between teams and users. Instead, we will maintain only the teams-participant relationship in the TeamsParticipant table.

This update will require modifying all references to TeamsParticipant across models and controllers, and adjusting logic to work with Participant instead of User. Certain cases do need user-specific fields previously stored within TeamsParticipant. With the user association deprecated, these areas will need updated logic to retrieve the user associated with each participant. This ensures continued functionality and accuracy of the code. Corresponding updates will also be necessary in the spec files to align with the changes.

==Team==

====Mentor====

* Jay, Patel

====Members====

* Agarwal, Arjit
* Manbhekar, Pranav
* Singhania, Chinmay

==References==

# [https://expertiza.ncsu.edu/ Expertiza]
# [https://docs.google.com/document/d/1fB9nHsop_yptjcj3CFn80BcZjXcSDbzcWwKvBDUTVrQ/edit?tab=t.0OSS Projects on Expertiza])
# [https://github.com/expertiza/expertiza Expertiza Github]
# [https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page Expertiza Wiki]

CSC/ECE 517 Fall 2024 - E2456. Refactor teams user.rb (Phase 2 - Design Document)

2024-11-10T23:47:59Z

Csingha: /* Class Diagram */

==Expertiza==

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc).
The National Science Foundation supports the Expertiza project.
It is used in select courses at NC State and by professors at several other colleges and universities.

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project.

==Problem Statement==

The TeamsUser class in the Expertiza repository serves as a join model between the Team and Participant classes, establishing a many-to-many relationship. Its primary purpose is to manage team memberships within the context of assignments or courses, facilitating functionalities such as retrieving a user's name, deleting users or teams, and managing participant associations.

The primary issue with the TeamsUser class is that it associates teams directly with users rather than with participants. In the context of the application, participants are users who are specifically associated with an assignment or a course. Since teams are formed within the scope of assignments or courses, handling team memberships through participants is more appropriate. Almost everywhere else, an assignment uses Participant objects rather than User objects. The exception is when it comes to Teams. It would simplify the design to use TeamsParticipants instead of TeamsUsers.

==Design Goal==

==Design Pattern==

==Class Diagram==
[[File:ClassDiagram_TeamsParticipant.png|800px|thumb]]

==Use Cases==

==Solutions/Details of Changes Made==

===Phase 1 Improvements===

* Renamed TeamsUser to TeamsParticipant to modify application logic to join Teams with Participants instead of Users
* Updated associations in immediate neighbor classes i.e Teams, Users and Participants to ensure correctness and consistency in the data model
* Renamed method names for increased readability and removed redundant methods from the TeamsParticipant class
* Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity, improving overall maintainability of the codebase
* Renamed TeamUserNode to TeamParticipantNode for correctness, to align with the new design of Participation association in TeamsParticipant
* Added migrations to add foreign key for Participant in TeamsParticipant table and updated indexes for the same

===Phase 2 Plan===

* Update associations in all the models that were previously using TeamsUser to implement them with TeamsParticipant
* Modify implementations of all models, views, and controllers to use Participant with TeamsParticipant class instead of User
* This future involves modifying queries to retrieve participant and user objects that are passed to the TeamsParticipant class as commands to their methods
* Deprecate user_id foreign key from TeamsParticipant to completely remove the association of User from TeamsParticant, only linking Participants to Teams
* Update all the test cases to work with this implementation, including updating associations and mocking DB calls

==Files Added/Modified==

Changed files in <code>Model</code>:

==== Changes to <code>app/models/teams_user.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamsUser to TeamsParticipant
|Aligns with application logic that utilizes Participants rather than Users.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|2
|style="width: 30%"| Updated associations to reference Participants
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|3
|Removed <code>get_team_members</code> from teams_participant model
|The method was empty without any logic so it was just a placeholder method without any usage across the project.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|-
|4
|Renamed methods: <code>remove_team_if_participants_empty</code>, <code>remove_team_participant</code>, <code>first_participant_for_team</code>, <code>add_accepted_invitee_to_team</code>, <code>find_team_id</code> for clarity
|Improves code readability for new programmers.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|
|-
|5
|Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity
|To reduce Cognitive Complexity and making the model more maintainable and efficient
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==== Changes to <code>app/models/team_user_node.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamUserNode to TeamParticipantNode
|Aligns with application logic that utilizes Participants rather than Users for node associations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|2
|style="width: 30%"| Modified queries in TeamParticipantNode to use teams_participant instead of teams_user
|Aligns with the changes made in teams_participant model to add new participant association.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|3
|Updated associations to reference TeamUserNode in entire repository
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==Test Plan==

We added a new spec file for the teams_participant model which was missing and fixed team_participant_controller_spec. Also as an additional step, we fixed model and controller tests for direct associations: Team, User, and Participant.

===Code coverage===

'''Before refactoring: 0%'''

'''After refactoring: 100%'''

[[File:teams-participant-code-cov.png|800px|center|Code coverage for <code>teams_participant.rb</code>]]

*<code>'''teams_participant'''</code>

[[File:Teams_participant_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team'''</code>

[[File:Team_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user'''</code>

[[File:User_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant'''</code>

[[File:Participant_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''teams_participant_controller'''</code>

[[File:Teams_participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team_controller'''</code>

[[File:Team_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user_controller'''</code>

[[File:Users_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant_controller'''</code>

[[File:Participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

==Next Steps==
During the refactoring from TeamsUser to TeamsParticipant, we initially retained the association between teams and users (with user_id as a foreign key) in TeamsParticipant. This approach was for backward compatibility, ensuring that other classes and tests would function without immediate disruption.

The next phase will involve fully removing this direct association between teams and users. Instead, we will maintain only the teams-participant relationship in the TeamsParticipant table.

This update will require modifying all references to TeamsParticipant across models and controllers, and adjusting logic to work with Participant instead of User. Certain cases do need user-specific fields previously stored within TeamsParticipant. With the user association deprecated, these areas will need updated logic to retrieve the user associated with each participant. This ensures continued functionality and accuracy of the code. Corresponding updates will also be necessary in the spec files to align with the changes.

==Team==

====Mentor====

* Jay, Patel

====Members====

* Agarwal, Arjit
* Manbhekar, Pranav
* Singhania, Chinmay

==References==

# [https://expertiza.ncsu.edu/ Expertiza]
# [https://docs.google.com/document/d/1fB9nHsop_yptjcj3CFn80BcZjXcSDbzcWwKvBDUTVrQ/edit?tab=t.0OSS Projects on Expertiza])
# [https://github.com/expertiza/expertiza Expertiza Github]
# [https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page Expertiza Wiki]

CSC/ECE 517 Fall 2024 - E2456. Refactor teams user.rb (Phase 2 - Design Document)

2024-11-10T23:47:49Z

Csingha: /* Class Diagram */

==Expertiza==

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc).
The National Science Foundation supports the Expertiza project.
It is used in select courses at NC State and by professors at several other colleges and universities.

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project.

==Problem Statement==

The TeamsUser class in the Expertiza repository serves as a join model between the Team and Participant classes, establishing a many-to-many relationship. Its primary purpose is to manage team memberships within the context of assignments or courses, facilitating functionalities such as retrieving a user's name, deleting users or teams, and managing participant associations.

The primary issue with the TeamsUser class is that it associates teams directly with users rather than with participants. In the context of the application, participants are users who are specifically associated with an assignment or a course. Since teams are formed within the scope of assignments or courses, handling team memberships through participants is more appropriate. Almost everywhere else, an assignment uses Participant objects rather than User objects. The exception is when it comes to Teams. It would simplify the design to use TeamsParticipants instead of TeamsUsers.

==Design Goal==

==Design Pattern==

==Class Diagram==
[[File:ClassDiagram_TeamsParticipant.png|800px|thumb|left]]

==Use Cases==

==Solutions/Details of Changes Made==

===Phase 1 Improvements===

* Renamed TeamsUser to TeamsParticipant to modify application logic to join Teams with Participants instead of Users
* Updated associations in immediate neighbor classes i.e Teams, Users and Participants to ensure correctness and consistency in the data model
* Renamed method names for increased readability and removed redundant methods from the TeamsParticipant class
* Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity, improving overall maintainability of the codebase
* Renamed TeamUserNode to TeamParticipantNode for correctness, to align with the new design of Participation association in TeamsParticipant
* Added migrations to add foreign key for Participant in TeamsParticipant table and updated indexes for the same

===Phase 2 Plan===

* Update associations in all the models that were previously using TeamsUser to implement them with TeamsParticipant
* Modify implementations of all models, views, and controllers to use Participant with TeamsParticipant class instead of User
* This future involves modifying queries to retrieve participant and user objects that are passed to the TeamsParticipant class as commands to their methods
* Deprecate user_id foreign key from TeamsParticipant to completely remove the association of User from TeamsParticant, only linking Participants to Teams
* Update all the test cases to work with this implementation, including updating associations and mocking DB calls

==Files Added/Modified==

Changed files in <code>Model</code>:

==== Changes to <code>app/models/teams_user.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamsUser to TeamsParticipant
|Aligns with application logic that utilizes Participants rather than Users.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|2
|style="width: 30%"| Updated associations to reference Participants
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|3
|Removed <code>get_team_members</code> from teams_participant model
|The method was empty without any logic so it was just a placeholder method without any usage across the project.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|-
|4
|Renamed methods: <code>remove_team_if_participants_empty</code>, <code>remove_team_participant</code>, <code>first_participant_for_team</code>, <code>add_accepted_invitee_to_team</code>, <code>find_team_id</code> for clarity
|Improves code readability for new programmers.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|
|-
|5
|Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity
|To reduce Cognitive Complexity and making the model more maintainable and efficient
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==== Changes to <code>app/models/team_user_node.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamUserNode to TeamParticipantNode
|Aligns with application logic that utilizes Participants rather than Users for node associations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|2
|style="width: 30%"| Modified queries in TeamParticipantNode to use teams_participant instead of teams_user
|Aligns with the changes made in teams_participant model to add new participant association.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|3
|Updated associations to reference TeamUserNode in entire repository
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==Test Plan==

We added a new spec file for the teams_participant model which was missing and fixed team_participant_controller_spec. Also as an additional step, we fixed model and controller tests for direct associations: Team, User, and Participant.

===Code coverage===

'''Before refactoring: 0%'''

'''After refactoring: 100%'''

[[File:teams-participant-code-cov.png|800px|center|Code coverage for <code>teams_participant.rb</code>]]

*<code>'''teams_participant'''</code>

[[File:Teams_participant_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team'''</code>

[[File:Team_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user'''</code>

[[File:User_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant'''</code>

[[File:Participant_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''teams_participant_controller'''</code>

[[File:Teams_participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team_controller'''</code>

[[File:Team_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user_controller'''</code>

[[File:Users_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant_controller'''</code>

[[File:Participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

==Next Steps==
During the refactoring from TeamsUser to TeamsParticipant, we initially retained the association between teams and users (with user_id as a foreign key) in TeamsParticipant. This approach was for backward compatibility, ensuring that other classes and tests would function without immediate disruption.

The next phase will involve fully removing this direct association between teams and users. Instead, we will maintain only the teams-participant relationship in the TeamsParticipant table.

This update will require modifying all references to TeamsParticipant across models and controllers, and adjusting logic to work with Participant instead of User. Certain cases do need user-specific fields previously stored within TeamsParticipant. With the user association deprecated, these areas will need updated logic to retrieve the user associated with each participant. This ensures continued functionality and accuracy of the code. Corresponding updates will also be necessary in the spec files to align with the changes.

==Team==

====Mentor====

* Jay, Patel

====Members====

* Agarwal, Arjit
* Manbhekar, Pranav
* Singhania, Chinmay

==References==

# [https://expertiza.ncsu.edu/ Expertiza]
# [https://docs.google.com/document/d/1fB9nHsop_yptjcj3CFn80BcZjXcSDbzcWwKvBDUTVrQ/edit?tab=t.0OSS Projects on Expertiza])
# [https://github.com/expertiza/expertiza Expertiza Github]
# [https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page Expertiza Wiki]

CSC/ECE 517 Fall 2024 - E2456. Refactor teams user.rb (Phase 2 - Design Document)

2024-11-10T23:47:36Z

Csingha: /* Class Diagram */

==Expertiza==

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc).
The National Science Foundation supports the Expertiza project.
It is used in select courses at NC State and by professors at several other colleges and universities.

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project.

==Problem Statement==

The TeamsUser class in the Expertiza repository serves as a join model between the Team and Participant classes, establishing a many-to-many relationship. Its primary purpose is to manage team memberships within the context of assignments or courses, facilitating functionalities such as retrieving a user's name, deleting users or teams, and managing participant associations.

The primary issue with the TeamsUser class is that it associates teams directly with users rather than with participants. In the context of the application, participants are users who are specifically associated with an assignment or a course. Since teams are formed within the scope of assignments or courses, handling team memberships through participants is more appropriate. Almost everywhere else, an assignment uses Participant objects rather than User objects. The exception is when it comes to Teams. It would simplify the design to use TeamsParticipants instead of TeamsUsers.

==Design Goal==

==Design Pattern==

==Class Diagram==
[[File:ClassDiagram_TeamsParticipant.png|200px|thumb|left]]

==Use Cases==

==Solutions/Details of Changes Made==

===Phase 1 Improvements===

* Renamed TeamsUser to TeamsParticipant to modify application logic to join Teams with Participants instead of Users
* Updated associations in immediate neighbor classes i.e Teams, Users and Participants to ensure correctness and consistency in the data model
* Renamed method names for increased readability and removed redundant methods from the TeamsParticipant class
* Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity, improving overall maintainability of the codebase
* Renamed TeamUserNode to TeamParticipantNode for correctness, to align with the new design of Participation association in TeamsParticipant
* Added migrations to add foreign key for Participant in TeamsParticipant table and updated indexes for the same

===Phase 2 Plan===

* Update associations in all the models that were previously using TeamsUser to implement them with TeamsParticipant
* Modify implementations of all models, views, and controllers to use Participant with TeamsParticipant class instead of User
* This future involves modifying queries to retrieve participant and user objects that are passed to the TeamsParticipant class as commands to their methods
* Deprecate user_id foreign key from TeamsParticipant to completely remove the association of User from TeamsParticant, only linking Participants to Teams
* Update all the test cases to work with this implementation, including updating associations and mocking DB calls

==Files Added/Modified==

Changed files in <code>Model</code>:

==== Changes to <code>app/models/teams_user.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamsUser to TeamsParticipant
|Aligns with application logic that utilizes Participants rather than Users.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|2
|style="width: 30%"| Updated associations to reference Participants
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|3
|Removed <code>get_team_members</code> from teams_participant model
|The method was empty without any logic so it was just a placeholder method without any usage across the project.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|-
|4
|Renamed methods: <code>remove_team_if_participants_empty</code>, <code>remove_team_participant</code>, <code>first_participant_for_team</code>, <code>add_accepted_invitee_to_team</code>, <code>find_team_id</code> for clarity
|Improves code readability for new programmers.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|
|-
|5
|Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity
|To reduce Cognitive Complexity and making the model more maintainable and efficient
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==== Changes to <code>app/models/team_user_node.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamUserNode to TeamParticipantNode
|Aligns with application logic that utilizes Participants rather than Users for node associations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|2
|style="width: 30%"| Modified queries in TeamParticipantNode to use teams_participant instead of teams_user
|Aligns with the changes made in teams_participant model to add new participant association.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|3
|Updated associations to reference TeamUserNode in entire repository
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==Test Plan==

We added a new spec file for the teams_participant model which was missing and fixed team_participant_controller_spec. Also as an additional step, we fixed model and controller tests for direct associations: Team, User, and Participant.

===Code coverage===

'''Before refactoring: 0%'''

'''After refactoring: 100%'''

[[File:teams-participant-code-cov.png|800px|center|Code coverage for <code>teams_participant.rb</code>]]

*<code>'''teams_participant'''</code>

[[File:Teams_participant_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team'''</code>

[[File:Team_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user'''</code>

[[File:User_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant'''</code>

[[File:Participant_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''teams_participant_controller'''</code>

[[File:Teams_participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team_controller'''</code>

[[File:Team_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user_controller'''</code>

[[File:Users_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant_controller'''</code>

[[File:Participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

==Next Steps==
During the refactoring from TeamsUser to TeamsParticipant, we initially retained the association between teams and users (with user_id as a foreign key) in TeamsParticipant. This approach was for backward compatibility, ensuring that other classes and tests would function without immediate disruption.

The next phase will involve fully removing this direct association between teams and users. Instead, we will maintain only the teams-participant relationship in the TeamsParticipant table.

This update will require modifying all references to TeamsParticipant across models and controllers, and adjusting logic to work with Participant instead of User. Certain cases do need user-specific fields previously stored within TeamsParticipant. With the user association deprecated, these areas will need updated logic to retrieve the user associated with each participant. This ensures continued functionality and accuracy of the code. Corresponding updates will also be necessary in the spec files to align with the changes.

==Team==

====Mentor====

* Jay, Patel

====Members====

* Agarwal, Arjit
* Manbhekar, Pranav
* Singhania, Chinmay

==References==

# [https://expertiza.ncsu.edu/ Expertiza]
# [https://docs.google.com/document/d/1fB9nHsop_yptjcj3CFn80BcZjXcSDbzcWwKvBDUTVrQ/edit?tab=t.0OSS Projects on Expertiza])
# [https://github.com/expertiza/expertiza Expertiza Github]
# [https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page Expertiza Wiki]

CSC/ECE 517 Fall 2024 - E2456. Refactor teams user.rb (Phase 2 - Design Document)

2024-11-10T23:47:05Z

Csingha: /* Class Diagram */

==Expertiza==

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc).
The National Science Foundation supports the Expertiza project.
It is used in select courses at NC State and by professors at several other colleges and universities.

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project.

==Problem Statement==

The TeamsUser class in the Expertiza repository serves as a join model between the Team and Participant classes, establishing a many-to-many relationship. Its primary purpose is to manage team memberships within the context of assignments or courses, facilitating functionalities such as retrieving a user's name, deleting users or teams, and managing participant associations.

The primary issue with the TeamsUser class is that it associates teams directly with users rather than with participants. In the context of the application, participants are users who are specifically associated with an assignment or a course. Since teams are formed within the scope of assignments or courses, handling team memberships through participants is more appropriate. Almost everywhere else, an assignment uses Participant objects rather than User objects. The exception is when it comes to Teams. It would simplify the design to use TeamsParticipants instead of TeamsUsers.

==Design Goal==

==Design Pattern==

==Class Diagram==
[[File:ClassDiagram_TeamsParticipant.png]]

==Use Cases==

==Solutions/Details of Changes Made==

===Phase 1 Improvements===

* Renamed TeamsUser to TeamsParticipant to modify application logic to join Teams with Participants instead of Users
* Updated associations in immediate neighbor classes i.e Teams, Users and Participants to ensure correctness and consistency in the data model
* Renamed method names for increased readability and removed redundant methods from the TeamsParticipant class
* Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity, improving overall maintainability of the codebase
* Renamed TeamUserNode to TeamParticipantNode for correctness, to align with the new design of Participation association in TeamsParticipant
* Added migrations to add foreign key for Participant in TeamsParticipant table and updated indexes for the same

===Phase 2 Plan===

* Update associations in all the models that were previously using TeamsUser to implement them with TeamsParticipant
* Modify implementations of all models, views, and controllers to use Participant with TeamsParticipant class instead of User
* This future involves modifying queries to retrieve participant and user objects that are passed to the TeamsParticipant class as commands to their methods
* Deprecate user_id foreign key from TeamsParticipant to completely remove the association of User from TeamsParticant, only linking Participants to Teams
* Update all the test cases to work with this implementation, including updating associations and mocking DB calls

==Files Added/Modified==

Changed files in <code>Model</code>:

==== Changes to <code>app/models/teams_user.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamsUser to TeamsParticipant
|Aligns with application logic that utilizes Participants rather than Users.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|2
|style="width: 30%"| Updated associations to reference Participants
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|3
|Removed <code>get_team_members</code> from teams_participant model
|The method was empty without any logic so it was just a placeholder method without any usage across the project.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|-
|4
|Renamed methods: <code>remove_team_if_participants_empty</code>, <code>remove_team_participant</code>, <code>first_participant_for_team</code>, <code>add_accepted_invitee_to_team</code>, <code>find_team_id</code> for clarity
|Improves code readability for new programmers.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|
|-
|5
|Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity
|To reduce Cognitive Complexity and making the model more maintainable and efficient
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==== Changes to <code>app/models/team_user_node.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamUserNode to TeamParticipantNode
|Aligns with application logic that utilizes Participants rather than Users for node associations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|2
|style="width: 30%"| Modified queries in TeamParticipantNode to use teams_participant instead of teams_user
|Aligns with the changes made in teams_participant model to add new participant association.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|3
|Updated associations to reference TeamUserNode in entire repository
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==Test Plan==

We added a new spec file for the teams_participant model which was missing and fixed team_participant_controller_spec. Also as an additional step, we fixed model and controller tests for direct associations: Team, User, and Participant.

===Code coverage===

'''Before refactoring: 0%'''

'''After refactoring: 100%'''

[[File:teams-participant-code-cov.png|800px|center|Code coverage for <code>teams_participant.rb</code>]]

*<code>'''teams_participant'''</code>

[[File:Teams_participant_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team'''</code>

[[File:Team_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user'''</code>

[[File:User_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant'''</code>

[[File:Participant_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''teams_participant_controller'''</code>

[[File:Teams_participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team_controller'''</code>

[[File:Team_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user_controller'''</code>

[[File:Users_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant_controller'''</code>

[[File:Participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

==Next Steps==
During the refactoring from TeamsUser to TeamsParticipant, we initially retained the association between teams and users (with user_id as a foreign key) in TeamsParticipant. This approach was for backward compatibility, ensuring that other classes and tests would function without immediate disruption.

The next phase will involve fully removing this direct association between teams and users. Instead, we will maintain only the teams-participant relationship in the TeamsParticipant table.

This update will require modifying all references to TeamsParticipant across models and controllers, and adjusting logic to work with Participant instead of User. Certain cases do need user-specific fields previously stored within TeamsParticipant. With the user association deprecated, these areas will need updated logic to retrieve the user associated with each participant. This ensures continued functionality and accuracy of the code. Corresponding updates will also be necessary in the spec files to align with the changes.

==Team==

====Mentor====

* Jay, Patel

====Members====

* Agarwal, Arjit
* Manbhekar, Pranav
* Singhania, Chinmay

==References==

# [https://expertiza.ncsu.edu/ Expertiza]
# [https://docs.google.com/document/d/1fB9nHsop_yptjcj3CFn80BcZjXcSDbzcWwKvBDUTVrQ/edit?tab=t.0OSS Projects on Expertiza])
# [https://github.com/expertiza/expertiza Expertiza Github]
# [https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page Expertiza Wiki]

File:ClassDiagram TeamsParticipant.png

2024-11-10T23:46:38Z

Csingha:

CSC/ECE 517 Fall 2024 - E2456. Refactor teams user.rb (Phase 2 - Design Document)

2024-11-07T23:11:00Z

Csingha: Created page with "==Expertiza== Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc). The National Science Foundation supports the Expertiza project. It is used in select courses at NC State and by professors at several other colleges and universities. [http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. ==Problem Statement== The TeamsUser class in th..."

==Expertiza==

Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc).
The National Science Foundation supports the Expertiza project.
It is used in select courses at NC State and by professors at several other colleges and universities.

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project.

==Problem Statement==

The TeamsUser class in the Expertiza repository serves as a join model between the Team and Participant classes, establishing a many-to-many relationship. Its primary purpose is to manage team memberships within the context of assignments or courses, facilitating functionalities such as retrieving a user's name, deleting users or teams, and managing participant associations.

The primary issue with the TeamsUser class is that it associates teams directly with users rather than with participants. In the context of the application, participants are users who are specifically associated with an assignment or a course. Since teams are formed within the scope of assignments or courses, handling team memberships through participants is more appropriate. Almost everywhere else, an assignment uses Participant objects rather than User objects. The exception is when it comes to Teams. It would simplify the design to use TeamsParticipants instead of TeamsUsers.

==Background==

The main role of teams_user class is to handle functionalities that deal with a team associated with an assignment/course and the participants (users associated with a course/assignment) in the team. The functionalities include retrieving a user’s name, deleting a user from the team, deleting the team if no participants are left in the team, adding a member to the team, finding the team ID for a user with a specific assignment, etc. Overall, it encapsulates the logic required to manage participants’ in teams within the context of assignments/courses in Expertiza.

==Refactor==

The refactoring process involved careful analysis of existing methods, removal of redundancies, and restructuring code to maintain clarity and efficiency. Significant focus was placed on simplifying method names, enhancing documentation, and aligning with object-oriented principles.

The refactor aims to address the inappropriate association of teams directly with users rather than participants, ensuring consistency with the application's architecture. The changes involve:

* Renaming TeamsUser to TeamsParticipant.
* Updating associations and references in related models: Team, User, and Participant.
* Removing empty or unnecessary methods and renaming others for clarity.
* Reducing the code and conditional complexity of the model
* Identifying code smells and refactoring for efficiency.
* Writing tests for all of the methods.
* Ensuring adherence to SOLID and DRY principles.

===Files Modified===

Changed files in <code>Model</code>:

==== Changes to <code>app/models/teams_user.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamsUser to TeamsParticipant
|Aligns with application logic that utilizes Participants rather than Users.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|2
|style="width: 30%"| Updated associations to reference Participants
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/3de17ae82cb55d35de419d4f4b8c881e1b9f86c5 Commit]
|-
|3
|Removed <code>get_team_members</code> from teams_participant model
|The method was empty without any logic so it was just a placeholder method without any usage across the project.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|-
|4
|Renamed methods: <code>remove_team_if_participants_empty</code>, <code>remove_team_participant</code>, <code>first_participant_for_team</code>, <code>add_accepted_invitee_to_team</code>, <code>find_team_id</code> for clarity
|Improves code readability for new programmers.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|
|-
|5
|Refactored methods: <code>add_accepted_invitee_to_team</code>, and <code>find_team_id</code> for efficiency and reducing complexity
|To reduce Cognitive Complexity and making the model more maintainable and efficient
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==== Changes to <code>app/models/team_user_node.rb</code> ====
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Renamed TeamUserNode to TeamParticipantNode
|Aligns with application logic that utilizes Participants rather than Users for node associations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|2
|style="width: 30%"| Modified queries in TeamParticipantNode to use teams_participant instead of teams_user
|Aligns with the changes made in teams_participant model to add new participant association.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/d5cacfa663e1358a522f52d676f7c6cb7a7ec3f0 Commit]
|-
|3
|Updated associations to reference TeamUserNode in entire repository
|Ensures consistency across the application and correctness in related models for foreign key relations.
|[https://github.com/pranavmanbhekar-ncsu/expertiza/commit/5041383721fd3c150f3065b3b3d9646784794257 Commit]
|}

==Test Cases==

We added a new spec file for the teams_participant model which was missing and fixed team_participant_controller_spec. Also as an additional step, we fixed model and controller tests for direct associations: Team, User, and Participant.

===Code coverage===

'''Before refactoring: 0%'''

'''After refactoring: 100%'''

[[File:teams-participant-code-cov.png|800px|center|Code coverage for <code>teams_participant.rb</code>]]

*<code>'''teams_participant'''</code>

[[File:Teams_participant_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team'''</code>

[[File:Team_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user'''</code>

[[File:User_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant'''</code>

[[File:Participant_model_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''teams_participant_controller'''</code>

[[File:Teams_participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''team_controller'''</code>

[[File:Team_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''user_controller'''</code>

[[File:Users_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

*<code>'''participant_controller'''</code>

[[File:Participant_controller_spec.png|1000px|center|Test passing for <code>team_spec.rb</code>]]

==Next Steps==
During the refactoring from TeamsUser to TeamsParticipant, we initially retained the association between teams and users (with user_id as a foreign key) in TeamsParticipant. This approach was for backward compatibility, ensuring that other classes and tests would function without immediate disruption.

The next phase will involve fully removing this direct association between teams and users. Instead, we will maintain only the teams-participant relationship in the TeamsParticipant table.

This update will require modifying all references to TeamsParticipant across models and controllers, and adjusting logic to work with Participant instead of User. Certain cases do need user-specific fields previously stored within TeamsParticipant. With the user association deprecated, these areas will need updated logic to retrieve the user associated with each participant. This ensures continued functionality and accuracy of the code. Corresponding updates will also be necessary in the spec files to align with the changes.

==Team==

====Mentor====

* Jayesh, Kiron

====Members====

* Agarwal, Arjit
* Manbhekar, Pranav
* Singhania, Chinmay

==References==

# [https://expertiza.ncsu.edu/ Expertiza]
# [https://docs.google.com/document/d/1fB9nHsop_yptjcj3CFn80BcZjXcSDbzcWwKvBDUTVrQ/edit?tab=t.0OSS Projects on Expertiza])
# [https://github.com/expertiza/expertiza Expertiza Github]
# [https://wiki.expertiza.ncsu.edu/index.php?title=Main_Page Expertiza Wiki]

CSC/ECE 517 Fall 2024

2024-11-07T23:10:32Z

Csingha:

* [[CSC/ECE 517 Fall 2024 - E2450. Refactor assignments_controller.rb]]
* [[CSC/ECE 517 Fall 2024 - E2452. Refactor review_mapping_controller.rb]]
* [[CSC/ECE 517 Fall 2024 - E2453. Refactor review_mapping_helper.rb]]
* [[CSC/ECE 517 Fall 2024 - E2454. Refactor student_task.rb]]
* [[CSC/ECE 517 Fall 2024 - E2455. Refactor sign_up_sheet_controller.rb]]
* [[CSC/ECE 517 Fall 2024 - E2456. Refactor teams_user.rb]]
* [[CSC/ECE 517 Fall 2024 - E2458. User management and users table]]
* [[CSC/ECE 517 Fall 2024 - E2459. View for results of bidding]]
* [[CSC/ECE 517 Fall 2024 - E2460 Mentor-Meeting Management]]
* [[CSC/ECE 517 Fall 2024 - E2461. UI for Courses]]
* [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2024_-_E2462._UI_for_Questionnaires CSC/ECE 517 Fall 2024 - E2462. UI for Questionnaire.rb]
* [https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Fall_2024_-_E2463_Implement_Front_End_for_Student_Task_List CSC/ECE 517 Fall 2024 - E2463. UI for Student Task List]
* [[CSC/ECE 517 Fall 2024 - E2464 UI for Project Topics (was: Sign_up_Topics)]]
* [[CSC/ECE 517 Fall 2024 - E2465. UI for Institutions and Notification]]
* [[CSC/ECE 517 Fall 2024 - E2466. UI for Impersonate User]]
* [[CSC/ECE 517 Fall 2024 - E2467. UI for View Submissions]]
* [[CSC/ECE 517 Fall 2024 - E2468. Reimplement due_date]]
* [[CSC/ECE 517 Fall 2024 - E2469. Reimplement grades/view_team]]
* [[CSC/ECE 517 Fall 2024 - E2470. Reimplement grades_controller]]
* [[CSC/ECE 517 Fall 2024 - E2471. Reimplement logger]]
* [[CSC/ECE 517 Fall 2024 - E2472. Reimplement responses_controller.rb]]
* [[CSC/ECE 517 Fall 2024 - E2475. Reimplement student_task view]]
* [[CSC/ECE 517 Fall 2024 - E2478. Reimplement the Question hierarchy as Item hierarchy]]
* [[CSC/ECE 517 Fall 2024 - E2480. Implement testing for new Bookmarks Controller]]
* [[CSC/ECE 517 Fall 2024 - E2481 Reimplement response_map.rb]]
* [[CSC/ECE 517 Fall 2024 - E2482. Reimplement heatgrid for reviews]]
* [[CSC/ECE 517 Fall 2024 - G2401 Refactor Graphql API endpoint for contribution metrics]]
* [[CSC/ECE 517 Fall 2024 - G2402 Refactor Graphql API endpoint for repositories]]
* [[CSC/ECE 517 Fall 2024 - E2484. Reimplement participants_controller.rb]]
* [[CSC/ECE 517 Fall 2024 - E2456. Refactor teams_user.rb (Phase 2 - Design Document)]]

CSC/ECE 517 Fall 2024 - E2456. Refactor teams user.rb

2024-10-28T01:08:32Z

Csingha: Created page with "==Expertiza== Expertiza is a web application through which students can submit and peer-review learning objects (articles, code, web sites, etc). The National Science Foundation supports the Expertiza project. It is used in select courses at NC State and by professors at several other colleges and universities. [Expertiza](http://expertiza.ncsu.edu/) is a [Ruby on Rails](http://rubyonrails.org/) based open source project. ==Problem Statement== The teams_user.rb needs..."

CSC/ECE 517 Fall 2024

2024-10-28T00:54:48Z

Csingha:

* [[CSC/ECE 517 Fall 2024 - E2454. Refactor student_task.rb]]
* [[CSC/ECE 517 Fall 2024 - E2466. UI for Impersonate User]]
* [[CSC/ECE 517 Fall 2024 - E2456. Refactor teams_user.rb]]