Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-12T21:08:16Z

Skanumu2:

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation of sign up topic as project topic in the Expertiza backend. Expertiza backend is being reimplemented to leverage recent updates in Ruby on Rails ecosystem. This project is part of those efforts.

==Problem Statement==
The following tasks were required for the reimplementation :
#Redesigning SignUpTopic as ProjectTopic: This involves reimplementing SignUpTopic class from the original expertiza repository as ProjectTopic within reimplementation-backend repository. This reimplementation should follow Rails best practices, use Ruby naming conventions, and adhere to the DRY principle to improve code maintainability and readability.
#Implementing Team Signup and Topic Drop Functionality: Adding methods to sign a team up for a topic and handling cases when a team drops a topic.
#Assignment Team Retrieval: Implementing a method to retrieve AssignmentTeams that are currently signed up for a specific topic, allowing for efficient tracking and management of team assignments.
#Slot Availability Management: Including methods for managing and retrieving the current number of available slots for a topic, updating as teams sign up or drop topics to reflect accurate availability.
#Writing tests for project topic model: RSpec tests have to be written for ProjectTopic Model.
#Writing Swagger UI tests for API endpoints: Swagger UI tests have to be written to test ProjectTopic and SignedUpTeam functionalities.

==Design Goal==
While reimplementing the SignUpTopic as ProjectTopic, the following design rules must be ensured:

* Maintain Functional Integrity: Validate the functionality of existing and new methods, incorporating any necessary improvements to meet updated requirements for managing topic signups, slot availability, and team assignments.

* Promote Loose Coupling and Tight Cohesion: Ensure that ProjectTopic and related classes, such as SignedUpTeam, are designed for optimal organization and maintainability, with clear separation of responsibilities to improve code quality and reduce dependencies.

* Apply the DRY Principle: Refactor any redundant code in the previous implementation, adhering to DRY principles by eliminating duplicated functionality from the Expertiza system and implementing reusable methods where possible.

* Ensure Robust Testing and Documentation: Validate the accuracy of existing test cases, updating them to reflect changes in ProjectTopic. Add comprehensive RSpec tests for new functionality, and perform Swagger UI testing on API endpoints to ensure complete coverage and reliability.

==Implementation==
Below are the methods implemented for the `project_topic` and `signed_up_team` classes. These methods handle slot availability, team sign-ups, waitlist management, topic reassignment, and data consistency. They ensure efficient topic allocation and seamless team management.
===app/models/project_topic.rb===

The `ProjectTopic` class is a pivotal component for managing team-based project topics, ensuring fairness, data consistency, and efficient slot allocation. It handles real-time slot availability, allowing teams to sign up for topics directly if slots are open while maintaining a fair waitlist for overflow through chronological assignment. The class dynamically reassigns slots when teams drop out, ensuring optimal utilization of resources. Methods like `current_available_slots` provide accurate slot tracking, while administrative functionality such as `signed_up_teams_for_topic` offers comprehensive reporting of both active and waitlisted teams. By managing these operations seamlessly, the class upholds fairness and integrity across team-topic assignments. The following methods were reimplemented in this model:

'''slot_available?''':

This method checks if there are any available slots for a team to sign up for the topic. This function is crucial for managing team assignments effectively without exceeding the maximum allowed capacity.

<pre>
# Checks if there are any slots currently available
# Returns true if the number of available slots is greater than 0, otherwise false
def slot_available?
current_available_slots > 0
end
</pre>

---

'''sign_up_team(team_id)''':

This method handles the team sign-up process for the current topic. It first checks if the team is already signed up for the topic and ensures it is not waitlisted. If slots are available, the team is assigned to the topic directly. Otherwise, the team is added to the waitlist. This method is central to managing both immediate assignments and waitlisted entries.

<pre>
# Signs up a team for the current topic.
# Checks if the team is already signed up, and if so, ensures they are not waitlisted.
# If a slot is available, assigns the topic to the team; otherwise, adds the team to the waitlist.
def signup_team(team_id)
# Check if the team has already signed up for this topic
team_signup_record = SignedUpTeam.find_by(sign_up_topic_id: self.id, team_id: team_id, is_waitlisted: false)

# If the team is already signed up, return false
if !team_signup_record.nil?
return false
end

# Create a new sign-up entry for the team
new_signup_record = SignedUpTeam.new(sign_up_topic_id: self.id, team_id: team_id)

# If there are available slots, assign the topic to the team and remove the team from the waitlist
if slot_available?
new_signup_record.update(is_waitlisted: false, sign_up_topic_id: self.id)
result = SignedUpTeam.drop_off_topic_waitlists(team_id)
else
# If no slots are available, add the team to the waitlist
result = new_signup_record.update(is_waitlisted: true, sign_up_topic_id: self.id)
end

result
end
</pre>

---

'''longest_waiting_team''':

This method retrieves the team that has been on the waitlist the longest for the current topic. It sorts the waitlisted entries by their creation time and returns the oldest entry. This is useful for assigning slots to teams in a fair and chronological manner as slots become available.

<pre>
# Retrieves the team with the earliest waitlisted record for a given topic.
# The team is determined based on the creation time of the waitlisted record.
def longest_waiting_team
SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: true).order(:created_at).first
end
</pre>

---

'''drop_team_from_topic(team_id)''':

This method removes a team from the current topic. If the removed team was not waitlisted, it reassigns the topic to the next waitlisted team, ensuring efficient utilization of available slots. The method then deletes the team's sign-up record, maintaining data consistency.

<pre>
# Removes a team from the current topic.
# If the team is not waitlisted, the next waitlisted team is reassigned to the topic.
# The team is then destroyed (removed from the sign-up record).
def drop_team_from_topic(team_id)
# Find the sign-up record for the team for this topic
signed_up_team = SignedUpTeam.find_by(team_id: team_id, sign_up_topic_id: self.id)
return nil unless signed_up_team

# If the team is not waitlisted, reassign the topic to the next waitlisted team
unless signed_up_team.is_waitlisted
next_waitlisted_team = longest_waiting_team
next_waitlisted_team&.assign_topic_to_waitlisted_team(self.id)
end

# Destroy the sign-up record for the team
signed_up_team.destroy
end
</pre>

---

'''signed_up_teams_for_topic''':

This method retrieves all teams that have signed up for the current topic, including both waitlisted and non-waitlisted teams. It provides an overview of the teams associated with a particular topic, aiding in administrative and reporting tasks.

<pre>
# Retrieves all teams that are signed up for a given topic.
def signed_up_teams_for_topic
SignedUpTeam.where(sign_up_topic_id: self.id)
end
</pre>

---

'''current_available_slots''':

This method calculates the number of available slots for the topic by subtracting the count of non-waitlisted teams from the maximum allowed capacity. It ensures the integrity of slot management by providing real-time availability data, which is critical for the sign-up and waitlisting processes.

<pre>
# Calculates the number of available slots for a topic.
# It checks how many teams have already chosen the topic and subtracts that from the maximum allowed choosers.
def current_available_slots
# Find the number of teams who have already chosen the topic and are not waitlisted
# This would give us the number of teams who have been assigned the topic
num_teams_registered = SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: false).size

# Compute the number of available slots and return
self.max_choosers.to_i - num_teams_registered
end
</pre>

===app/models/signed_up_team.rb===

The `SignedUpTeam` class is essential for managing the lifecycle of team sign-ups and their associations with topics, ensuring efficient and consistent handling of team-topic relationships. This class facilitates creating sign-up records using methods like `signup_team_for_topic`, enabling teams to associate seamlessly with topics by leveraging the `signup_team` method of the `ProjectTopic` class. It also manages waitlist operations, allowing for the removal of waitlisted entries through `drop_off_team_waitlists` and assignment of waitlisted teams to their topics via `assign_topic_to_waitlisted_team`. For robust data management, it provides functionality to clear all topic associations for a team using `delete_team_signup_records`. The class also supports administrative operations, such as retrieving team IDs for specific users via `get_team_id_for_user`, ensuring streamlined integration with other system components. By maintaining data integrity and supporting dynamic updates to team-topic relationships, the `SignedUpTeam` class plays a crucial role in the overall project management system.

'''drop_off_team_waitlists(team_id)''':

This class method removes all waitlisted entries for a specific team. It deletes all sign-up records where the team is marked as waitlisted, ensuring the team is no longer on any waitlists.

<pre>
# Removes all waitlist entries for a given team.
# This deletes all sign-up records where the team is waitlisted.
def self.drop_off_topic_waitlists(team_id)
SignedUpTeam.where(team_id: team_id, is_waitlisted: true).destroy_all
end
</pre>

---

'''signup_team_for_topic(topic_id, team_id)''':

This class method creates a sign-up record for a team by associating it with the specified topic. It retrieves the project topic by its ID and uses the `sign_up_team` method to handle the sign-up process.

<pre>
# Signs up a team for a specific project topic.
# Finds the project topic by its ID and associates the given team with the topic by calling `signup_team`.
def self.signup_team_for_topic(topic_id, team_id)
# Find the project topic by its ID
project_topic = ProjectTopic.find(topic_id)

# Sign up the team for the topic
project_topic.signup_team(team_id)
end
</pre>

---

'''get_team_id_for_user(user_id, assignment_id)''':

This class method retrieves the team ID associated with a specific user and assignment. It first identifies the teams the user belongs to and then filters the team linked to the given assignment, returning its ID.

<pre>
# Retrieves the team ID for a given user and assignment.
# This first finds the team(s) the user is associated with and then retrieves the team for the specified assignment.
# NOTE: This method is called in signed_up_teams_controller
def self.get_team_id_for_user(user_id, assignment_id)
# Get the team IDs associated with the given user
team_ids = TeamsUser.select('team_id').where(user_id: user_id)

if team_ids.empty?
return nil
end
# Find the team that matches the assignment ID and retrieve its team_id
team_id = Team.where(id: team_ids, assignment_id: assignment_id).first.id
# Return the team ID
team_id
end
</pre>

---

'''delete_team_signup_records(team_id)''':

This class method deletes all sign-up records for a given team. It removes every entry associated with the specified team, clearing all their topic associations.

<pre>
# Deletes all sign-up records for a given team.
# This removes all sign-up entries associated with the specified team.
def self.delete_team_signup_records(team_id)
SignedUpTeam.where(team_id: team_id).destroy_all
end
</pre>

---

'''assign_topic_to_waitlisted_team(topic_id)''':

This instance method assigns a waitlisted team to a given topic. It first removes the team from its current topic if they are assigned, then updates the team's waitlist status to indicate they are now assigned to the given topic.

<pre>
# Reassigns the team to a new topic by removing them from their current topic
# and marking them as no longer waitlisted for the new topic.
# NOTE: This method gets called only on a waitlisted team (See project_topic.rb -> drop_team_from_topic)
def assign_topic_to_waitlisted_team(topic_id)
# Find the team's current sign-up record where they are not waitlisted
# As this method gets called only on a waitlisted team, we need to check if the team has been assigned another topic
assigned_team = SignedUpTeam.find_by(team_id: self.team_id, is_waitlisted: false)

# If the team is already assigned to a topic, remove them from that topic
if assigned_team
project_topic = ProjectTopic.find(assigned_team.sign_up_topic_id)
project_topic.drop_team_from_topic(team_id: self.team_id)
end

# Update the team's waitlist status to false (indicating they are no longer waitlisted)
self.update(sign_up_topic_id: topic_id, is_waitlisted: false)
end
</pre>

==Testing==

'''spec/models/project_topic_spec.rb'''

These set of tests are written for Project Topic class.

1. slot_available?

This RSpec test suite validates the `#slot_available?` method of `project_topic`, ensuring it returns `true` when no teams have chosen the topic and `false` when all slots (`max_choosers`) are filled.

<pre>
describe '#slot_available?' do
context 'when no teams have chosen the topic' do
it 'returns true' do
expect(project_topic.slot_available?).to be true
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns false' do
expect(project_topic.slot_available?).to be false
end
end
end
</pre>

2. sign_up_team

This RSpec test suite validates the `#signup_team` method of `project_topic`. It ensures the method assigns the topic to a team and clears team waitlists when slots are available, adds the team to the waitlist when slots are full, and returns `false` if the team is already signed up and not waitlisted.

</pre>
describe '#signup_team' do
let(:new_team) { Team.create!(assignment_id: assignment.id) }

context 'when slot is available' do
it 'assigns the topic to the team and drops team waitlists' do
allow(SignedUpTeam).to receive(:drop_off_topic_waitlists).with(new_team.id).and_return(true)

expect(project_topic.signup_team(new_team.id)).to be true
expect(SignedUpTeam).to have_received(:drop_off_topic_waitlists).with(new_team.id)
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'adds the team to the waitlist' do
expect { project_topic.signup_team(new_team.id) }.to change { SignedUpTeam.count }.by(1)
expect(SignedUpTeam.last.is_waitlisted).to be true
end
end

context 'when the team is already signed up and not waitlisted' do
before do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team, is_waitlisted: false)
end

it 'returns false' do
expect(project_topic.signup_team(team.id)).to be false
end
end
end
</pre>

3. longest_waiting_team

This RSpec test validates the `#longest_waiting_team` method of `project_topic`, ensuring it correctly returns the team that has been on the waitlist for the longest duration.

</pre>
describe '#longest_waiting_team' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }

it 'returns the team that has been waitlisted the longest' do
expect(project_topic.longest_waiting_team).to eq(waitlisted_team)
end
end
</pre>

4. drop_team_from_topic

This RSpec test suite verifies the `#drop_team_from_topic` method of `project_topic`. It ensures the method removes a team from the topic and, if applicable, assigns the topic to the next longest-waitlisted team by updating its waitlist status.

<pre>
describe '#drop_team_from_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team) }

it 'removes the team from the topic' do
expect { project_topic.drop_team_from_topic(team.id) }.to change { SignedUpTeam.count }.by(-1)
end

context 'when the team is not waitlisted' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }

it 'assigns the topic to the next waitlisted team' do
project_topic.drop_team_from_topic(team.id)
expect(waitlisted_team.reload.is_waitlisted).to be false
end
end
end
</pre>

5. current_available_slots

This RSpec test suite validates the `#current_available_slots` method of `project_topic`. It ensures the method returns the total `max_choosers` when no teams have signed up and accurately calculates the remaining slots when some teams have already signed up.

</pre>
describe '#current_available_slots' do
context 'when no teams have signed up' do
it 'returns max_choosers as available slots' do
expect(project_topic.current_available_slots).to eq(project_topic.max_choosers)
end
end

context 'when some teams have signed up' do
before do
2.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns the remaining available slots' do
expect(project_topic.current_available_slots).to eq(1)
end
end
end
</pre>

'''spec/models/signed_up_team_spec.rb'''

These set of tests are written for Signed Up Team class

1. get_team_id_for_user

This RSpec test suite validates the `.get_team_id_for_user` class method of `SignedUpTeam`. It ensures the method returns the correct team ID for a user associated with a specific assignment and returns `nil` if the user is not associated with any team for that assignment.

</pre>
describe '.get_team_id_for_user' do
let!(:user) { User.create!(name: "Name", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id) }
let!(:teams_user) { TeamsUser.create!(team_id: team.id, user_id: user.id) }

it 'returns the correct team ID for the given user and assignment' do
expect(SignedUpTeam.get_team_id_for_user(user.id, assignment.id)).to eq(team.id)
end

it 'returns nil if the user is not associated with any team for the assignment' do
other_user = User.create!(name: "Name 2", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id)
expect(SignedUpTeam.get_team_id_for_user(other_user.id, assignment.id)).to be_nil
end
end
</pre>

2. delete_team_signup_records

This RSpec test validates the `.delete_team_signup_records` class method of `SignedUpTeam`. It ensures that the method correctly removes all sign-up records associated with a given team, reducing the count of relevant records by the expected amount.

</pre>
describe '.delete_team_signup_records' do
let!(:signup1) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team_id: team.id) }
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signup2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: true, team_id: team.id) }

it 'removes all sign-up records for the given team' do
expect { SignedUpTeam.delete_team_signup_records(team.id) }
.to change { SignedUpTeam.where(team_id: team.id).count }.by(-2)
end
end
</pre>

3. assign_topic_to_waitlisted_team

This RSpec test validates the `#assign_topic_to_waitlisted_team` method. It ensures that the method successfully reassigns a waitlisted team to a new topic, marks them as not waitlisted, and triggers the `drop_team_from_topic` method on the previous topic.

</pre>
describe '#assign_topic_to_waitlisted_team' do
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, team_id: team.id) }
let!(:signed_up_team_2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: false, team_id: team.id) }

before do
allow(ProjectTopic).to receive(:find).with(project_topic_2.id).and_return(project_topic_2)
allow(project_topic_2).to receive(:drop_team_from_topic)
end

it 'reassigns the team to a new topic and marks them as not waitlisted' do
signed_up_team.assign_topic_to_waitlisted_team(project_topic.id)
expect(signed_up_team.is_waitlisted).to be_falsey
expect(project_topic_2).to have_received(:drop_team_from_topic).with(team_id: team.id)
end
end
</pre>

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125 Pull Request 125]

==Video==
*[https://youtube.com/watch?v=oRxrtW5v05A Video]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-12T20:42:05Z

Skanumu2:

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation of sign up topic as project topic in the Expertiza backend. Expertiza backend is being reimplemented to leverage recent updates in Ruby on Rails ecosystem. This project is part of those efforts.

==Problem Statement==
The following tasks were required for the reimplementation :
#Redesigning SignUpTopic as ProjectTopic: This involves reimplementing SignUpTopic class from the original expertiza repository as ProjectTopic within reimplementation-backend repository. This reimplementation should follow Rails best practices, use Ruby naming conventions, and adhere to the DRY principle to improve code maintainability and readability.
#Implementing Team Signup and Topic Drop Functionality: Adding methods to sign a team up for a topic and handling cases when a team drops a topic.
#Assignment Team Retrieval: Implementing a method to retrieve AssignmentTeams that are currently signed up for a specific topic, allowing for efficient tracking and management of team assignments.
#Slot Availability Management: Including methods for managing and retrieving the current number of available slots for a topic, updating as teams sign up or drop topics to reflect accurate availability.
#Writing tests for project topic model: RSpec tests have to be written for ProjectTopic Model.
#Writing Swagger UI tests for API endpoints: Swagger UI tests have to be written to test ProjectTopic and SignedUpTeam functionalities.

==Design Goal==
While reimplementing the SignUpTopic as ProjectTopic, the following design rules must be ensured:

* Maintain Functional Integrity: Validate the functionality of existing and new methods, incorporating any necessary improvements to meet updated requirements for managing topic signups, slot availability, and team assignments.

* Promote Loose Coupling and Tight Cohesion: Ensure that ProjectTopic and related classes, such as SignedUpTeam, are designed for optimal organization and maintainability, with clear separation of responsibilities to improve code quality and reduce dependencies.

* Apply the DRY Principle: Refactor any redundant code in the previous implementation, adhering to DRY principles by eliminating duplicated functionality from the Expertiza system and implementing reusable methods where possible.

* Ensure Robust Testing and Documentation: Validate the accuracy of existing test cases, updating them to reflect changes in ProjectTopic. Add comprehensive RSpec tests for new functionality, and perform Swagger UI testing on API endpoints to ensure complete coverage and reliability.

==Implementation==
Below are the methods implemented for the `project_topic` and `signed_up_team` classes. These methods handle slot availability, team sign-ups, waitlist management, topic reassignment, and data consistency. They ensure efficient topic allocation and seamless team management.
===app/models/project_topic.rb===

The `ProjectTopic` class is a pivotal component for managing team-based project topics, ensuring fairness, data consistency, and efficient slot allocation. It handles real-time slot availability, allowing teams to sign up for topics directly if slots are open while maintaining a fair waitlist for overflow through chronological assignment. The class dynamically reassigns slots when teams drop out, ensuring optimal utilization of resources. Methods like `current_available_slots` provide accurate slot tracking, while administrative functionality such as `signed_up_teams_for_topic` offers comprehensive reporting of both active and waitlisted teams. By managing these operations seamlessly, the class upholds fairness and integrity across team-topic assignments. The following methods were reimplemented in this model:

'''slot_available?''':

This method checks if there are any available slots for a team to sign up for the topic. This function is crucial for managing team assignments effectively without exceeding the maximum allowed capacity.

<pre>
# Checks if there are any slots currently available
# Returns true if the number of available slots is greater than 0, otherwise false
def slot_available?
current_available_slots > 0
end
</pre>

---

'''sign_up_team(team_id)''':

This method handles the team sign-up process for the current topic. It first checks if the team is already signed up for the topic and ensures it is not waitlisted. If slots are available, the team is assigned to the topic directly. Otherwise, the team is added to the waitlist. This method is central to managing both immediate assignments and waitlisted entries.

<pre>
# Signs up a team for the current topic.
# Checks if the team is already signed up, and if so, ensures they are not waitlisted.
# If a slot is available, assigns the topic to the team; otherwise, adds the team to the waitlist.
def signup_team(team_id)
# Check if the team has already signed up for this topic
team_signup_record = SignedUpTeam.find_by(sign_up_topic_id: self.id, team_id: team_id, is_waitlisted: false)

# If the team is already signed up, return false
if !team_signup_record.nil?
return false
end

# Create a new sign-up entry for the team
new_signup_record = SignedUpTeam.new(sign_up_topic_id: self.id, team_id: team_id)

# If there are available slots, assign the topic to the team and remove the team from the waitlist
if slot_available?
new_signup_record.update(is_waitlisted: false, sign_up_topic_id: self.id)
result = SignedUpTeam.drop_off_topic_waitlists(team_id)
else
# If no slots are available, add the team to the waitlist
result = new_signup_record.update(is_waitlisted: true, sign_up_topic_id: self.id)
end

result
end
</pre>

---

'''longest_waiting_team''':

This method retrieves the team that has been on the waitlist the longest for the current topic. It sorts the waitlisted entries by their creation time and returns the oldest entry. This is useful for assigning slots to teams in a fair and chronological manner as slots become available.

<pre>
# Retrieves the team with the earliest waitlisted record for a given topic.
# The team is determined based on the creation time of the waitlisted record.
def longest_waiting_team
SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: true).order(:created_at).first
end
</pre>

---

'''drop_team_from_topic(team_id)''':

This method removes a team from the current topic. If the removed team was not waitlisted, it reassigns the topic to the next waitlisted team, ensuring efficient utilization of available slots. The method then deletes the team's sign-up record, maintaining data consistency.

<pre>
# Removes a team from the current topic.
# If the team is not waitlisted, the next waitlisted team is reassigned to the topic.
# The team is then destroyed (removed from the sign-up record).
def drop_team_from_topic(team_id)
# Find the sign-up record for the team for this topic
signed_up_team = SignedUpTeam.find_by(team_id: team_id, sign_up_topic_id: self.id)
return nil unless signed_up_team

# If the team is not waitlisted, reassign the topic to the next waitlisted team
unless signed_up_team.is_waitlisted
next_waitlisted_team = longest_waiting_team
next_waitlisted_team&.assign_topic_to_waitlisted_team(self.id)
end

# Destroy the sign-up record for the team
signed_up_team.destroy
end
</pre>

---

'''signed_up_teams_for_topic''':

This method retrieves all teams that have signed up for the current topic, including both waitlisted and non-waitlisted teams. It provides an overview of the teams associated with a particular topic, aiding in administrative and reporting tasks.

<pre>
# Retrieves all teams that are signed up for a given topic.
def signed_up_teams_for_topic
SignedUpTeam.where(sign_up_topic_id: self.id)
end
</pre>

---

'''current_available_slots''':

This method calculates the number of available slots for the topic by subtracting the count of non-waitlisted teams from the maximum allowed capacity. It ensures the integrity of slot management by providing real-time availability data, which is critical for the sign-up and waitlisting processes.

<pre>
# Calculates the number of available slots for a topic.
# It checks how many teams have already chosen the topic and subtracts that from the maximum allowed choosers.
def current_available_slots
# Find the number of teams who have already chosen the topic and are not waitlisted
# This would give us the number of teams who have been assigned the topic
num_teams_registered = SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: false).size

# Compute the number of available slots and return
self.max_choosers.to_i - num_teams_registered
end
</pre>

===app/models/signed_up_team.rb===

The `SignedUpTeam` class is essential for managing the lifecycle of team sign-ups and their associations with topics, ensuring efficient and consistent handling of team-topic relationships. This class facilitates creating sign-up records using methods like `signup_team_for_topic`, enabling teams to associate seamlessly with topics by leveraging the `signup_team` method of the `ProjectTopic` class. It also manages waitlist operations, allowing for the removal of waitlisted entries through `drop_off_team_waitlists` and assignment of waitlisted teams to their topics via `assign_topic_to_waitlisted_team`. For robust data management, it provides functionality to clear all topic associations for a team using `delete_team_signup_records`. The class also supports administrative operations, such as retrieving team IDs for specific users via `get_team_id_for_user`, ensuring streamlined integration with other system components. By maintaining data integrity and supporting dynamic updates to team-topic relationships, the `SignedUpTeam` class plays a crucial role in the overall project management system.

'''drop_off_team_waitlists(team_id)''':

This class method removes all waitlisted entries for a specific team. It deletes all sign-up records where the team is marked as waitlisted, ensuring the team is no longer on any waitlists.

<pre>
# Removes all waitlist entries for a given team.
# This deletes all sign-up records where the team is waitlisted.
def self.drop_off_topic_waitlists(team_id)
SignedUpTeam.where(team_id: team_id, is_waitlisted: true).destroy_all
end
</pre>

---

'''signup_team_for_topic(topic_id, team_id)''':

This class method creates a sign-up record for a team by associating it with the specified topic. It retrieves the project topic by its ID and uses the `sign_up_team` method to handle the sign-up process.

<pre>
# Signs up a team for a specific project topic.
# Finds the project topic by its ID and associates the given team with the topic by calling `signup_team`.
def self.signup_team_for_topic(topic_id, team_id)
# Find the project topic by its ID
project_topic = ProjectTopic.find(topic_id)

# Sign up the team for the topic
project_topic.signup_team(team_id)
end
</pre>

---

'''get_team_id_for_user(user_id, assignment_id)''':

This class method retrieves the team ID associated with a specific user and assignment. It first identifies the teams the user belongs to and then filters the team linked to the given assignment, returning its ID.

<pre>
# Retrieves the team ID for a given user and assignment.
# This first finds the team(s) the user is associated with and then retrieves the team for the specified assignment.
# NOTE: This method is called in signed_up_teams_controller
def self.get_team_id_for_user(user_id, assignment_id)
# Get the team IDs associated with the given user
team_ids = TeamsUser.select('team_id').where(user_id: user_id)

if team_ids.empty?
return nil
end
# Find the team that matches the assignment ID and retrieve its team_id
team_id = Team.where(id: team_ids, assignment_id: assignment_id).first.id
# Return the team ID
team_id
end
</pre>

---

'''delete_team_signup_records(team_id)''':

This class method deletes all sign-up records for a given team. It removes every entry associated with the specified team, clearing all their topic associations.

<pre>
# Deletes all sign-up records for a given team.
# This removes all sign-up entries associated with the specified team.
def self.delete_team_signup_records(team_id)
SignedUpTeam.where(team_id: team_id).destroy_all
end
</pre>

---

'''assign_topic_to_waitlisted_team(topic_id)''':

This instance method assigns a waitlisted team to a given topic. It first removes the team from its current topic if they are assigned, then updates the team's waitlist status to indicate they are now assigned to the given topic.

<pre>
# Reassigns the team to a new topic by removing them from their current topic
# and marking them as no longer waitlisted for the new topic.
# NOTE: This method gets called only on a waitlisted team (See project_topic.rb -> drop_team_from_topic)
def assign_topic_to_waitlisted_team(topic_id)
# Find the team's current sign-up record where they are not waitlisted
# As this method gets called only on a waitlisted team, we need to check if the team has been assigned another topic
assigned_team = SignedUpTeam.find_by(team_id: self.team_id, is_waitlisted: false)

# If the team is already assigned to a topic, remove them from that topic
if assigned_team
project_topic = ProjectTopic.find(assigned_team.sign_up_topic_id)
project_topic.drop_team_from_topic(team_id: self.team_id)
end

# Update the team's waitlist status to false (indicating they are no longer waitlisted)
self.update(sign_up_topic_id: topic_id, is_waitlisted: false)
end
</pre>

==Testing==

'''spec/models/project_topic_spec.rb'''

These set of tests are written for Project Topic class.

1. slot_available?

This method should return a boolean value indicating whether slots are available or not. Below code tests if it returns the right value when no teams have chosen the topic and when no slots are available.

<pre>
describe '#slot_available?' do
context 'when no teams have chosen the topic' do
it 'returns true' do
expect(project_topic.slot_available?).to be true
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns false' do
expect(project_topic.slot_available?).to be false
end
end
end
</pre>

2. sign_up_team

This method should sign a team up for a project. The below code as test cases for when a slot is available, when no slots are available and when the team is already signed up for the topic and not waitlisted

</pre>
describe '#signup_team' do
let(:new_team) { Team.create!(assignment_id: assignment.id) }

context 'when slot is available' do
it 'assigns the topic to the team and drops team waitlists' do
allow(SignedUpTeam).to receive(:drop_off_topic_waitlists).with(new_team.id).and_return(true)

expect(project_topic.signup_team(new_team.id)).to be true
expect(SignedUpTeam).to have_received(:drop_off_topic_waitlists).with(new_team.id)
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'adds the team to the waitlist' do
expect { project_topic.signup_team(new_team.id) }.to change { SignedUpTeam.count }.by(1)
expect(SignedUpTeam.last.is_waitlisted).to be true
end
end

context 'when the team is already signed up and not waitlisted' do
before do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team, is_waitlisted: false)
end

it 'returns false' do
expect(project_topic.signup_team(team.id)).to be false
end
end
end
</pre>

3. longest_waiting_team

This method should return the longest waiting team

</pre>
describe '#longest_waiting_team' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }

it 'returns the team that has been waitlisted the longest' do
expect(project_topic.longest_waiting_team).to eq(waitlisted_team)
end
end
</pre>

4. drop_team_from_topic

This method should drop a signed up team from a project topic. The below code tests for cases when the team is not waitlisted and when it is waitlisted.

<pre>
describe '#drop_team_from_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team) }

it 'removes the team from the topic' do
expect { project_topic.drop_team_from_topic(team.id) }.to change { SignedUpTeam.count }.by(-1)
end

context 'when the team is not waitlisted' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }

it 'assigns the topic to the next waitlisted team' do
project_topic.drop_team_from_topic(team.id)
expect(waitlisted_team.reload.is_waitlisted).to be false
end
end
end
</pre>

5. current_available_slots

This method returns the number of available slots. The below code tests for cases when no teams have signed up for the topic and when some teams have signed up for the topic.

</pre>
describe '#current_available_slots' do
context 'when no teams have signed up' do
it 'returns max_choosers as available slots' do
expect(project_topic.current_available_slots).to eq(project_topic.max_choosers)
end
end

context 'when some teams have signed up' do
before do
2.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns the remaining available slots' do
expect(project_topic.current_available_slots).to eq(1)
end
end
end
</pre>

'''spec/models/signed_up_team_spec.rb'''

These set of tests are written for Signed Up Team class

1. get_team_id_for_user

This method returns team ID given user ID and assignment ID. The below code tests for cases when the user is associated with a team and when the user is not associated with any team.

</pre>
describe '.get_team_id_for_user' do
let!(:user) { User.create!(name: "Name", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id) }
let!(:teams_user) { TeamsUser.create!(team_id: team.id, user_id: user.id) }

it 'returns the correct team ID for the given user and assignment' do
expect(SignedUpTeam.get_team_id_for_user(user.id, assignment.id)).to eq(team.id)
end

it 'returns nil if the user is not associated with any team for the assignment' do
other_user = User.create!(name: "Name 2", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id)
expect(SignedUpTeam.get_team_id_for_user(other_user.id, assignment.id)).to be_nil
end
end
</pre>

2. drop_off_team_signup_records

This method should drop off all signup records for a team.

</pre>
describe '.delete_team_signup_records' do
let!(:signup1) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team_id: team.id) }
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signup2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: true, team_id: team.id) }

it 'removes all sign-up records for the given team' do
expect { SignedUpTeam.delete_team_signup_records(team.id) }
.to change { SignedUpTeam.where(team_id: team.id).count }.by(-2)
end
end
</pre>

3. assign_topic_to_waitlisted_team

This method should reassign the topic for a given team.

</pre>
describe '#assign_topic_to_waitlisted_team' do
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, team_id: team.id) }
let!(:signed_up_team_2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: false, team_id: team.id) }

before do
allow(ProjectTopic).to receive(:find).with(project_topic_2.id).and_return(project_topic_2)
allow(project_topic_2).to receive(:drop_team_from_topic)
end

it 'reassigns the team to a new topic and marks them as not waitlisted' do
signed_up_team.assign_topic_to_waitlisted_team(project_topic.id)
expect(signed_up_team.is_waitlisted).to be_falsey
expect(project_topic_2).to have_received(:drop_team_from_topic).with(team_id: team.id)
end
end
</pre>

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125 Pull Request 125]

==Video==
*[https://youtube.com/watch?v=oRxrtW5v05A Video]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-12T20:31:01Z

Skanumu2:

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation of sign up topic as project topic in the Expertiza backend. Expertiza backend is being reimplemented to leverage recent updates in Ruby on Rails ecosystem. This project is part of those efforts.

==Problem Statement==
The following tasks were required for the reimplementation :
#Redesigning SignUpTopic as ProjectTopic: This involves reimplementing SignUpTopic class from the original expertiza repository as ProjectTopic within reimplementation-backend repository. This reimplementation should follow Rails best practices, use Ruby naming conventions, and adhere to the DRY principle to improve code maintainability and readability.
#Implementing Team Signup and Topic Drop Functionality: Adding methods to sign a team up for a topic and handling cases when a team drops a topic.
#Assignment Team Retrieval: Implementing a method to retrieve AssignmentTeams that are currently signed up for a specific topic, allowing for efficient tracking and management of team assignments.
#Slot Availability Management: Including methods for managing and retrieving the current number of available slots for a topic, updating as teams sign up or drop topics to reflect accurate availability.
#Writing tests for project topic model: RSpec tests have to be written for ProjectTopic Model.
#Writing Swagger UI tests for API endpoints: Swagger UI tests have to be written to test ProjectTopic and SignedUpTeam functionalities.

==Design Goal==
While reimplementing the SignUpTopic as ProjectTopic, the following design rules must be ensured:

* Maintain Functional Integrity: Validate the functionality of existing and new methods, incorporating any necessary improvements to meet updated requirements for managing topic signups, slot availability, and team assignments.

* Promote Loose Coupling and Tight Cohesion: Ensure that ProjectTopic and related classes, such as SignedUpTeam, are designed for optimal organization and maintainability, with clear separation of responsibilities to improve code quality and reduce dependencies.

* Apply the DRY Principle: Refactor any redundant code in the previous implementation, adhering to DRY principles by eliminating duplicated functionality from the Expertiza system and implementing reusable methods where possible.

* Ensure Robust Testing and Documentation: Validate the accuracy of existing test cases, updating them to reflect changes in ProjectTopic. Add comprehensive RSpec tests for new functionality, and perform Swagger UI testing on API endpoints to ensure complete coverage and reliability.

==Implementation==
Below are the methods implemented for the `project_topic` and `signed_up_team` classes. These methods handle slot availability, team sign-ups, waitlist management, topic reassignment, and data consistency. They ensure efficient topic allocation and seamless team management.
===app/models/project_topic.rb===

The `ProjectTopic` class is a pivotal component for managing team-based project topics, ensuring fairness, data consistency, and efficient slot allocation. It handles real-time slot availability, allowing teams to sign up for topics directly if slots are open while maintaining a fair waitlist for overflow through chronological assignment. The class dynamically reassigns slots when teams drop out, ensuring optimal utilization of resources. Methods like `current_available_slots` provide accurate slot tracking, while administrative functionality such as `signed_up_teams_for_topic` offers comprehensive reporting of both active and waitlisted teams. By managing these operations seamlessly, the class upholds fairness and integrity across team-topic assignments. The following methods were reimplemented in this model:

'''slot_available?''':

This method checks if there are any available slots for a team to sign up for the topic. This function is crucial for managing team assignments effectively without exceeding the maximum allowed capacity.

<pre>
# Checks if there are any slots currently available
# Returns true if the number of available slots is greater than 0, otherwise false
def slot_available?
current_available_slots > 0
end
</pre>

---

'''sign_up_team(team_id)''':

This method handles the team sign-up process for the current topic. It first checks if the team is already signed up for the topic and ensures it is not waitlisted. If slots are available, the team is assigned to the topic directly. Otherwise, the team is added to the waitlist. This method is central to managing both immediate assignments and waitlisted entries.

<pre>
# Signs up a team for the current topic.
# Checks if the team is already signed up, and if so, ensures they are not waitlisted.
# If a slot is available, assigns the topic to the team; otherwise, adds the team to the waitlist.
def signup_team(team_id)
# Check if the team has already signed up for this topic
team_signup_record = SignedUpTeam.find_by(sign_up_topic_id: self.id, team_id: team_id, is_waitlisted: false)

# If the team is already signed up, return false
if !team_signup_record.nil?
return false
end

# Create a new sign-up entry for the team
new_signup_record = SignedUpTeam.new(sign_up_topic_id: self.id, team_id: team_id)

# If there are available slots, assign the topic to the team and remove the team from the waitlist
if slot_available?
new_signup_record.update(is_waitlisted: false, sign_up_topic_id: self.id)
result = SignedUpTeam.drop_off_topic_waitlists(team_id)
else
# If no slots are available, add the team to the waitlist
result = new_signup_record.update(is_waitlisted: true, sign_up_topic_id: self.id)
end

result
end
</pre>

---

'''longest_waiting_team''':

This method retrieves the team that has been on the waitlist the longest for the current topic. It sorts the waitlisted entries by their creation time and returns the oldest entry. This is useful for assigning slots to teams in a fair and chronological manner as slots become available.

<pre>
# Retrieves the team with the earliest waitlisted record for a given topic.
# The team is determined based on the creation time of the waitlisted record.
def longest_waiting_team
SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: true).order(:created_at).first
end
</pre>

---

'''drop_team_from_topic(team_id)''':

This method removes a team from the current topic. If the removed team was not waitlisted, it reassigns the topic to the next waitlisted team, ensuring efficient utilization of available slots. The method then deletes the team's sign-up record, maintaining data consistency.

<pre>
# Removes a team from the current topic.
# If the team is not waitlisted, the next waitlisted team is reassigned to the topic.
# The team is then destroyed (removed from the sign-up record).
def drop_team_from_topic(team_id)
# Find the sign-up record for the team for this topic
signed_up_team = SignedUpTeam.find_by(team_id: team_id, sign_up_topic_id: self.id)
return nil unless signed_up_team

# If the team is not waitlisted, reassign the topic to the next waitlisted team
unless signed_up_team.is_waitlisted
next_waitlisted_team = longest_waiting_team
next_waitlisted_team&.assign_topic_to_waitlisted_team(self.id)
end

# Destroy the sign-up record for the team
signed_up_team.destroy
end
</pre>

---

'''signed_up_teams_for_topic''':

This method retrieves all teams that have signed up for the current topic, including both waitlisted and non-waitlisted teams. It provides an overview of the teams associated with a particular topic, aiding in administrative and reporting tasks.

<pre>
# Retrieves all teams that are signed up for a given topic.
def signed_up_teams_for_topic
SignedUpTeam.where(sign_up_topic_id: self.id)
end
</pre>

---

'''current_available_slots''':

This method calculates the number of available slots for the topic by subtracting the count of non-waitlisted teams from the maximum allowed capacity. It ensures the integrity of slot management by providing real-time availability data, which is critical for the sign-up and waitlisting processes.

<pre>
# Calculates the number of available slots for a topic.
# It checks how many teams have already chosen the topic and subtracts that from the maximum allowed choosers.
def current_available_slots
# Find the number of teams who have already chosen the topic and are not waitlisted
# This would give us the number of teams who have been assigned the topic
num_teams_registered = SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: false).size

# Compute the number of available slots and return
self.max_choosers.to_i - num_teams_registered
end
</pre>

===app/models/signed_up_team.rb===

The `SignedUpTeam` class is essential for managing the lifecycle of team sign-ups and their associations with topics, ensuring efficient and consistent handling of team-topic relationships. This class facilitates creating sign-up records using methods like `signup_team_for_topic`, enabling teams to associate seamlessly with topics by leveraging the `signup_team` method of the `ProjectTopic` class. It also manages waitlist operations, allowing for the removal of waitlisted entries through `drop_off_team_waitlists` and assignment of waitlisted teams to their topics via `assign_topic_to_waitlisted_team`. For robust data management, it provides functionality to clear all topic associations for a team using `delete_team_signup_records`. The class also supports administrative operations, such as retrieving team IDs for specific users via `get_team_id_for_user`, ensuring streamlined integration with other system components. By maintaining data integrity and supporting dynamic updates to team-topic relationships, the `SignedUpTeam` class plays a crucial role in the overall project management system.

'''drop_off_team_waitlists(team_id)''':

This class method removes all waitlisted entries for a specific team. It deletes all sign-up records where the team is marked as waitlisted, ensuring the team is no longer on any waitlists.

<pre>
# Removes all waitlist entries for a given team.
# This deletes all sign-up records where the team is waitlisted.
def self.drop_off_topic_waitlists(team_id)
SignedUpTeam.where(team_id: team_id, is_waitlisted: true).destroy_all
end
</pre>

---

'''signup_team_for_topic(topic_id, team_id)''':

This class method creates a sign-up record for a team by associating it with the specified topic. It retrieves the project topic by its ID and uses the `sign_up_team` method to handle the sign-up process.

<pre>
# Signs up a team for a specific project topic.
# Finds the project topic by its ID and associates the given team with the topic by calling `signup_team`.
def self.signup_team_for_topic(topic_id, team_id)
# Find the project topic by its ID
project_topic = ProjectTopic.find(topic_id)

# Sign up the team for the topic
project_topic.signup_team(team_id)
end
</pre>

---

'''get_team_id_for_user(user_id, assignment_id)''':

This class method retrieves the team ID associated with a specific user and assignment. It first identifies the teams the user belongs to and then filters the team linked to the given assignment, returning its ID.

<pre>
# Retrieves the team ID for a given user and assignment.
# This first finds the team(s) the user is associated with and then retrieves the team for the specified assignment.
# NOTE: This method is called in signed_up_teams_controller
def self.get_team_id_for_user(user_id, assignment_id)
# Get the team IDs associated with the given user
team_ids = TeamsUser.select('team_id').where(user_id: user_id)

if team_ids.empty?
return nil
end
# Find the team that matches the assignment ID and retrieve its team_id
team_id = Team.where(id: team_ids, assignment_id: assignment_id).first.id
# Return the team ID
team_id
end
</pre>

---

'''delete_team_signup_records(team_id)''':

This class method deletes all sign-up records for a given team. It removes every entry associated with the specified team, clearing all their topic associations.

<pre>
# Deletes all sign-up records for a given team.
# This removes all sign-up entries associated with the specified team.
def self.delete_team_signup_records(team_id)
SignedUpTeam.where(team_id: team_id).destroy_all
end
</pre>

---

'''assign_topic_to_waitlisted_team(topic_id)''':

This instance method assigns a waitlisted team to a given topic. It first removes the team from its current topic if they are assigned, then updates the team's waitlist status to indicate they are now assigned to the given topic.

<pre>
# Reassigns the team to a new topic by removing them from their current topic
# and marking them as no longer waitlisted for the new topic.
# NOTE: This method gets called only on a waitlisted team (See project_topic.rb -> drop_team_from_topic)
def assign_topic_to_waitlisted_team(topic_id)
# Find the team's current sign-up record where they are not waitlisted
# As this method gets called only on a waitlisted team, we need to check if the team has been assigned another topic
assigned_team = SignedUpTeam.find_by(team_id: self.team_id, is_waitlisted: false)

# If the team is already assigned to a topic, remove them from that topic
if assigned_team
project_topic = ProjectTopic.find(assigned_team.sign_up_topic_id)
project_topic.drop_team_from_topic(team_id: self.team_id)
end

# Update the team's waitlist status to false (indicating they are no longer waitlisted)
self.update(sign_up_topic_id: topic_id, is_waitlisted: false)
end
</pre>

==Testing==

'''spec/models/project_topic_spec.rb'''

These set of tests are written for Project Topic class.

1.slot_available?

This method should return a boolean value indicating whether slots are available or not. Below code tests if it returns the right value when no teams have chosen the topic and when no slots are available.

<pre>
describe '#slot_available?' do
context 'when no teams have chosen the topic' do
it 'returns true' do
expect(project_topic.slot_available?).to be true
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns false' do
expect(project_topic.slot_available?).to be false
end
end
end
</pre>

2.sign_up_team

This method should sign a team up for a project. The below code as test cases for when a slot is available, when no slots are available and when the team is already signed up for the topic and not waitlisted

</pre>
describe '#signup_team' do
let(:new_team) { Team.create!(assignment_id: assignment.id) }

context 'when slot is available' do
it 'assigns the topic to the team and drops team waitlists' do
allow(SignedUpTeam).to receive(:drop_off_topic_waitlists).with(new_team.id).and_return(true)

expect(project_topic.signup_team(new_team.id)).to be true
expect(SignedUpTeam).to have_received(:drop_off_topic_waitlists).with(new_team.id)
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'adds the team to the waitlist' do
expect { project_topic.signup_team(new_team.id) }.to change { SignedUpTeam.count }.by(1)
expect(SignedUpTeam.last.is_waitlisted).to be true
end
end

context 'when the team is already signed up and not waitlisted' do
before do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team, is_waitlisted: false)
end

it 'returns false' do
expect(project_topic.signup_team(team.id)).to be false
end
end
end
</pre>

3.longest_waiting_team

This method should return the longest waiting team

</pre>
describe '#longest_waiting_team' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }

it 'returns the team that has been waitlisted the longest' do
expect(project_topic.longest_waiting_team).to eq(waitlisted_team)
end
end
</pre>

4.drop_team_from_topic

This method should drop a signed up team from a project topic. The below code tests for cases when the team is not waitlisted and when it is waitlisted.

<pre>
describe '#drop_team_from_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team) }

it 'removes the team from the topic' do
expect { project_topic.drop_team_from_topic(team.id) }.to change { SignedUpTeam.count }.by(-1)
end

context 'when the team is not waitlisted' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }

it 'assigns the topic to the next waitlisted team' do
project_topic.drop_team_from_topic(team.id)
expect(waitlisted_team.reload.is_waitlisted).to be false
end
end
end
</pre>

5.current_available_slots

This method returns the number of available slots. The below code tests for cases when no teams have signed up for the topic and when some teams have signed up for the topic.

</pre>
describe '#current_available_slots' do
context 'when no teams have signed up' do
it 'returns max_choosers as available slots' do
expect(project_topic.current_available_slots).to eq(project_topic.max_choosers)
end
end

context 'when some teams have signed up' do
before do
2.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns the remaining available slots' do
expect(project_topic.current_available_slots).to eq(1)
end
end
end
</pre>

'''spec/models/signed_up_team_spec.rb'''

These set of tests are written for Signed Up Team class

1.get_team_id_for_user

This method returns team ID given user ID and assignment ID. The below code tests for cases when the user is associated with a team and when the user is not associated with any team.

</pre>
describe '.get_team_id_for_user' do
let!(:user) { User.create!(name: "Name", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id) }
let!(:teams_user) { TeamsUser.create!(team_id: team.id, user_id: user.id) }

it 'returns the correct team ID for the given user and assignment' do
expect(SignedUpTeam.get_team_id_for_user(user.id, assignment.id)).to eq(team.id)
end

it 'returns nil if the user is not associated with any team for the assignment' do
other_user = User.create!(name: "Name 2", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id)
expect(SignedUpTeam.get_team_id_for_user(other_user.id, assignment.id)).to be_nil
end
end
</pre>

2..drop_off_team_signup_records

This method should drop off all signup records for a team.

</pre>
describe '.delete_team_signup_records' do
let!(:signup1) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team_id: team.id) }
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signup2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: true, team_id: team.id) }

it 'removes all sign-up records for the given team' do
expect { SignedUpTeam.delete_team_signup_records(team.id) }
.to change { SignedUpTeam.where(team_id: team.id).count }.by(-2)
end
end
</pre>

3.assign_topic_to_waitlisted_team

This method should reassign the topic for a given team.

</pre>
describe '#assign_topic_to_waitlisted_team' do
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, team_id: team.id) }
let!(:signed_up_team_2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: false, team_id: team.id) }

before do
allow(ProjectTopic).to receive(:find).with(project_topic_2.id).and_return(project_topic_2)
allow(project_topic_2).to receive(:drop_team_from_topic)
end

it 'reassigns the team to a new topic and marks them as not waitlisted' do
signed_up_team.assign_topic_to_waitlisted_team(project_topic.id)
expect(signed_up_team.is_waitlisted).to be_falsey
expect(project_topic_2).to have_received(:drop_team_from_topic).with(team_id: team.id)
end
end
</pre>

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125 Pull Request 125]

==Video==
*[https://youtube.com/watch?v=oRxrtW5v05A Video]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-12T20:13:16Z

Skanumu2:

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation of sign up topic as project topic in the Expertiza backend. Expertiza backend is being reimplemented to leverage recent updates in Ruby on Rails ecosystem. This project is part of those efforts.

==Problem Statement==
The following tasks were required for the reimplementation :
#Redesigning SignUpTopic as ProjectTopic: This involves reimplementing SignUpTopic class from the original expertiza repository as ProjectTopic within reimplementation-backend repository. This reimplementation should follow Rails best practices, use Ruby naming conventions, and adhere to the DRY principle to improve code maintainability and readability.
#Implementing Team Signup and Topic Drop Functionality: Adding methods to sign a team up for a topic and handling cases when a team drops a topic.
#Assignment Team Retrieval: Implementing a method to retrieve AssignmentTeams that are currently signed up for a specific topic, allowing for efficient tracking and management of team assignments.
#Slot Availability Management: Including methods for managing and retrieving the current number of available slots for a topic, updating as teams sign up or drop topics to reflect accurate availability.
#Writing tests for project topic model: RSpec tests have to be written for ProjectTopic Model.
#Writing Swagger UI tests for API endpoints: Swagger UI tests have to be written to test ProjectTopic and SignedUpTeam functionalities.

==Design Goal==
While reimplementing the SignUpTopic as ProjectTopic, the following design rules must be ensured:

* Maintain Functional Integrity: Validate the functionality of existing and new methods, incorporating any necessary improvements to meet updated requirements for managing topic signups, slot availability, and team assignments.

* Promote Loose Coupling and Tight Cohesion: Ensure that ProjectTopic and related classes, such as SignedUpTeam, are designed for optimal organization and maintainability, with clear separation of responsibilities to improve code quality and reduce dependencies.

* Apply the DRY Principle: Refactor any redundant code in the previous implementation, adhering to DRY principles by eliminating duplicated functionality from the Expertiza system and implementing reusable methods where possible.

* Ensure Robust Testing and Documentation: Validate the accuracy of existing test cases, updating them to reflect changes in ProjectTopic. Add comprehensive RSpec tests for new functionality, and perform Swagger UI testing on API endpoints to ensure complete coverage and reliability.

==Implementation==
Below are the methods implemented for the `project_topic` and `signed_up_team` classes. These methods handle slot availability, team sign-ups, waitlist management, topic reassignment, and data consistency. They ensure efficient topic allocation and seamless team management.
===app/models/project_topic.rb===

The `ProjectTopic` class is a pivotal component for managing team-based project topics, ensuring fairness, data consistency, and efficient slot allocation. It handles real-time slot availability, allowing teams to sign up for topics directly if slots are open while maintaining a fair waitlist for overflow through chronological assignment. The class dynamically reassigns slots when teams drop out, ensuring optimal utilization of resources. Methods like `current_available_slots` provide accurate slot tracking, while administrative functionality such as `signed_up_teams_for_topic` offers comprehensive reporting of both active and waitlisted teams. By managing these operations seamlessly, the class upholds fairness and integrity across team-topic assignments. The following methods were reimplemented in this model:

'''slot_available?''':

This method checks if there are any available slots for a team to sign up for the topic. This function is crucial for managing team assignments effectively without exceeding the maximum allowed capacity.

<pre>
# Checks if there are any slots currently available
# Returns true if the number of available slots is greater than 0, otherwise false
def slot_available?
current_available_slots > 0
end
</pre>

---

'''sign_up_team(team_id)''':

This method handles the team sign-up process for the current topic. It first checks if the team is already signed up for the topic and ensures it is not waitlisted. If slots are available, the team is assigned to the topic directly. Otherwise, the team is added to the waitlist. This method is central to managing both immediate assignments and waitlisted entries.

<pre>
# Signs up a team for the current topic.
# Checks if the team is already signed up, and if so, ensures they are not waitlisted.
# If a slot is available, assigns the topic to the team; otherwise, adds the team to the waitlist.
def signup_team(team_id)
# Check if the team has already signed up for this topic
team_signup_record = SignedUpTeam.find_by(sign_up_topic_id: self.id, team_id: team_id, is_waitlisted: false)

# If the team is already signed up, return false
if !team_signup_record.nil?
return false
end

# Create a new sign-up entry for the team
new_signup_record = SignedUpTeam.new(sign_up_topic_id: self.id, team_id: team_id)

# If there are available slots, assign the topic to the team and remove the team from the waitlist
if slot_available?
new_signup_record.update(is_waitlisted: false, sign_up_topic_id: self.id)
result = SignedUpTeam.drop_off_topic_waitlists(team_id)
else
# If no slots are available, add the team to the waitlist
result = new_signup_record.update(is_waitlisted: true, sign_up_topic_id: self.id)
end

result
end
</pre>

---

'''longest_waiting_team''':

This method retrieves the team that has been on the waitlist the longest for the current topic. It sorts the waitlisted entries by their creation time and returns the oldest entry. This is useful for assigning slots to teams in a fair and chronological manner as slots become available.

<pre>
# Retrieves the team with the earliest waitlisted record for a given topic.
# The team is determined based on the creation time of the waitlisted record.
def longest_waiting_team
SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: true).order(:created_at).first
end
</pre>

---

'''drop_team_from_topic(team_id)''':

This method removes a team from the current topic. If the removed team was not waitlisted, it reassigns the topic to the next waitlisted team, ensuring efficient utilization of available slots. The method then deletes the team's sign-up record, maintaining data consistency.

<pre>
# Removes a team from the current topic.
# If the team is not waitlisted, the next waitlisted team is reassigned to the topic.
# The team is then destroyed (removed from the sign-up record).
def drop_team_from_topic(team_id)
# Find the sign-up record for the team for this topic
signed_up_team = SignedUpTeam.find_by(team_id: team_id, sign_up_topic_id: self.id)
return nil unless signed_up_team

# If the team is not waitlisted, reassign the topic to the next waitlisted team
unless signed_up_team.is_waitlisted
next_waitlisted_team = longest_waiting_team
next_waitlisted_team&.assign_topic_to_waitlisted_team(self.id)
end

# Destroy the sign-up record for the team
signed_up_team.destroy
end
</pre>

---

'''signed_up_teams_for_topic''':

This method retrieves all teams that have signed up for the current topic, including both waitlisted and non-waitlisted teams. It provides an overview of the teams associated with a particular topic, aiding in administrative and reporting tasks.

<pre>
# Retrieves all teams that are signed up for a given topic.
def signed_up_teams_for_topic
SignedUpTeam.where(sign_up_topic_id: self.id)
end
</pre>

---

'''current_available_slots''':

This method calculates the number of available slots for the topic by subtracting the count of non-waitlisted teams from the maximum allowed capacity. It ensures the integrity of slot management by providing real-time availability data, which is critical for the sign-up and waitlisting processes.

<pre>
# Calculates the number of available slots for a topic.
# It checks how many teams have already chosen the topic and subtracts that from the maximum allowed choosers.
def current_available_slots
# Find the number of teams who have already chosen the topic and are not waitlisted
# This would give us the number of teams who have been assigned the topic
num_teams_registered = SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: false).size

# Compute the number of available slots and return
self.max_choosers.to_i - num_teams_registered
end
</pre>

===app/models/signed_up_team.rb===

The `SignedUpTeam` class is essential for managing the lifecycle of team sign-ups and their associations with topics, ensuring efficient and consistent handling of team-topic relationships. This class facilitates creating sign-up records using methods like `create_signed_up_team`, enabling teams to associate seamlessly with topics by leveraging the `sign_up_team` method of the `ProjectTopic` class. It also manages waitlist operations, allowing for the removal of waitlisted entries through `drop_off_team_waitlists` and reassignment of teams to new topics via `reassign_topic`. For robust data management, it provides functionality to clear all topic associations for a team using `drop_off_team_signup_records`. The class also supports administrative operations, such as retrieving team IDs for specific assignments via `get_team_id`, ensuring streamlined integration with other system components. By maintaining data integrity and supporting dynamic updates to team-topic relationships, the `SignedUpTeam` class plays a crucial role in the overall project management system.

'''drop_off_team_waitlists(team_id)''':

This class method removes all waitlisted entries for a specific team. It deletes all sign-up records where the team is marked as waitlisted, ensuring the team is no longer on any waitlists.

<pre>
# Removes all waitlist entries for a given team.
# This deletes all sign-up records where the team is waitlisted.
def self.drop_off_topic_waitlists(team_id)
SignedUpTeam.where(team_id: team_id, is_waitlisted: true).destroy_all
end
</pre>

---

'''signup_team_for_topic(topic_id, team_id)''':

This class method creates a sign-up record for a team by associating it with the specified topic. It retrieves the project topic by its ID and uses the `sign_up_team` method to handle the sign-up process.

<pre>
# Signs up a team for a specific project topic.
# Finds the project topic by its ID and associates the given team with the topic by calling `signup_team`.
def self.signup_team_for_topic(topic_id, team_id)
# Find the project topic by its ID
project_topic = ProjectTopic.find(topic_id)

# Sign up the team for the topic
project_topic.signup_team(team_id)
end
</pre>

---

'''get_team_id_for_user(user_id, assignment_id)''':

This class method retrieves the team ID associated with a specific user and assignment. It first identifies the teams the user belongs to and then filters the team linked to the given assignment, returning its ID.

<pre>
# Retrieves the team ID for a given user and assignment.
# This first finds the team(s) the user is associated with and then retrieves the team for the specified assignment.
# NOTE: This method is called in signed_up_teams_controller
def self.get_team_id_for_user(user_id, assignment_id)
# Get the team IDs associated with the given user
team_ids = TeamsUser.select('team_id').where(user_id: user_id)

if team_ids.empty?
return nil
end
# Find the team that matches the assignment ID and retrieve its team_id
team_id = Team.where(id: team_ids, assignment_id: assignment_id).first.id
# Return the team ID
team_id
end
</pre>

---

'''delete_team_signup_records(team_id)''':

This class method deletes all sign-up records for a given team. It removes every entry associated with the specified team, clearing all their topic associations.

<pre>
# Deletes all sign-up records for a given team.
# This removes all sign-up entries associated with the specified team.
def self.delete_team_signup_records(team_id)
SignedUpTeam.where(team_id: team_id).destroy_all
end
</pre>

---

'''assign_topic_to_waitlisted_team(topic_id)''':

This instance method assigns a waitlisted team to a given topic. It first removes the team from its current topic if they are assigned, then updates the team's waitlist status to indicate they are now assigned to the given topic.

<pre>
# Reassigns the team to a new topic by removing them from their current topic
# and marking them as no longer waitlisted for the new topic.
# NOTE: This method gets called only on a waitlisted team (See project_topic.rb -> drop_team_from_topic)
def assign_topic_to_waitlisted_team(topic_id)
# Find the team's current sign-up record where they are not waitlisted
# As this method gets called only on a waitlisted team, we need to check if the team has been assigned another topic
assigned_team = SignedUpTeam.find_by(team_id: self.team_id, is_waitlisted: false)

# If the team is already assigned to a topic, remove them from that topic
if assigned_team
project_topic = ProjectTopic.find(assigned_team.sign_up_topic_id)
project_topic.drop_team_from_topic(team_id: self.team_id)
end

# Update the team's waitlist status to false (indicating they are no longer waitlisted)
self.update(sign_up_topic_id: topic_id, is_waitlisted: false)
end
</pre>

==Testing==

'''spec/models/project_topic_spec.rb'''

These set of tests are written for Project Topic class.

1.slot_available?

This method should return a boolean value indicating whether slots are available or not. Below code tests if it returns the right value when no teams have chosen the topic and when no slots are available.

<pre>
describe '#slot_available?' do
context 'when no teams have chosen the topic' do
it 'returns true' do
expect(project_topic.slot_available?).to be true
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns false' do
expect(project_topic.slot_available?).to be false
end
end
end
</pre>

2.sign_up_team

This method should sign a team up for a project. The below code as test cases for when a slot is available, when no slots are available and when the team is already signed up for the topic and not waitlisted

</pre>
describe '#signup_team' do
let(:new_team) { Team.create!(assignment_id: assignment.id) }

context 'when slot is available' do
it 'assigns the topic to the team and drops team waitlists' do
allow(SignedUpTeam).to receive(:drop_off_topic_waitlists).with(new_team.id).and_return(true)

expect(project_topic.signup_team(new_team.id)).to be true
expect(SignedUpTeam).to have_received(:drop_off_topic_waitlists).with(new_team.id)
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'adds the team to the waitlist' do
expect { project_topic.signup_team(new_team.id) }.to change { SignedUpTeam.count }.by(1)
expect(SignedUpTeam.last.is_waitlisted).to be true
end
end

context 'when the team is already signed up and not waitlisted' do
before do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team, is_waitlisted: false)
end

it 'returns false' do
expect(project_topic.signup_team(team.id)).to be false
end
end
end
</pre>

3.longest_waiting_team

This method should return the longest waiting team

</pre>
describe '#longest_waiting_team' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }

it 'returns the team that has been waitlisted the longest' do
expect(project_topic.longest_waiting_team).to eq(waitlisted_team)
end
end
</pre>

4.drop_team_from_topic

This method should drop a signed up team from a project topic. The below code tests for cases when the team is not waitlisted and when it is waitlisted.

<pre>
describe '#drop_team_from_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team) }

it 'removes the team from the topic' do
expect { project_topic.drop_team_from_topic(team.id) }.to change { SignedUpTeam.count }.by(-1)
end

context 'when the team is not waitlisted' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }

it 'assigns the topic to the next waitlisted team' do
project_topic.drop_team_from_topic(team.id)
expect(waitlisted_team.reload.is_waitlisted).to be false
end
end
end
</pre>

5.current_available_slots

This method returns the number of available slots. The below code tests for cases when no teams have signed up for the topic and when some teams have signed up for the topic.

</pre>
describe '#current_available_slots' do
context 'when no teams have signed up' do
it 'returns max_choosers as available slots' do
expect(project_topic.current_available_slots).to eq(project_topic.max_choosers)
end
end

context 'when some teams have signed up' do
before do
2.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns the remaining available slots' do
expect(project_topic.current_available_slots).to eq(1)
end
end
end
</pre>

'''spec/models/signed_up_team_spec.rb'''

These set of tests are written for Signed Up Team class

1.get_team_id_for_user

This method returns team ID given user ID and assignment ID. The below code tests for cases when the user is associated with a team and when the user is not associated with any team.

</pre>
describe '.get_team_id_for_user' do
let!(:user) { User.create!(name: "Name", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id) }
let!(:teams_user) { TeamsUser.create!(team_id: team.id, user_id: user.id) }

it 'returns the correct team ID for the given user and assignment' do
expect(SignedUpTeam.get_team_id_for_user(user.id, assignment.id)).to eq(team.id)
end

it 'returns nil if the user is not associated with any team for the assignment' do
other_user = User.create!(name: "Name 2", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id)
expect(SignedUpTeam.get_team_id_for_user(other_user.id, assignment.id)).to be_nil
end
end
</pre>

2..drop_off_team_signup_records

This method should drop off all signup records for a team.

</pre>
describe '.delete_team_signup_records' do
let!(:signup1) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team_id: team.id) }
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signup2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: true, team_id: team.id) }

it 'removes all sign-up records for the given team' do
expect { SignedUpTeam.delete_team_signup_records(team.id) }
.to change { SignedUpTeam.where(team_id: team.id).count }.by(-2)
end
end
</pre>

3.assign_topic_to_waitlisted_team

This method should reassign the topic for a given team.

</pre>
describe '#assign_topic_to_waitlisted_team' do
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, team_id: team.id) }
let!(:signed_up_team_2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: false, team_id: team.id) }

before do
allow(ProjectTopic).to receive(:find).with(project_topic_2.id).and_return(project_topic_2)
allow(project_topic_2).to receive(:drop_team_from_topic)
end

it 'reassigns the team to a new topic and marks them as not waitlisted' do
signed_up_team.assign_topic_to_waitlisted_team(project_topic.id)
expect(signed_up_team.is_waitlisted).to be_falsey
expect(project_topic_2).to have_received(:drop_team_from_topic).with(team_id: team.id)
end
end
</pre>

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125 Pull Request 125]

==Video==
*[https://youtube.com/watch?v=oRxrtW5v05A Video]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-12T04:21:38Z

Skanumu2: /* app/models/signed_up_team.rb */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation of sign up topic as project topic in the Expertiza backend. Expertiza backend is being reimplemented to leverage recent updates in Ruby on Rails ecosystem. This project is part of those efforts.

==Problem Statement==
The following tasks were required for the reimplementation :
#Redesigning SignUpTopic as ProjectTopic: This involves reimplementing SignUpTopic class from the original expertiza repository as ProjectTopic within reimplementation-backend repository. This reimplementation should follow Rails best practices, use Ruby naming conventions, and adhere to the DRY principle to improve code maintainability and readability.
#Implementing Team Signup and Topic Drop Functionality: Adding methods to sign a team up for a topic and handling cases when a team drops a topic.
#Assignment Team Retrieval: Implementing a method to retrieve AssignmentTeams that are currently signed up for a specific topic, allowing for efficient tracking and management of team assignments.
#Slot Availability Management: Including methods for managing and retrieving the current number of available slots for a topic, updating as teams sign up or drop topics to reflect accurate availability.
#Writing tests for project topic model: RSpec tests have to be written for ProjectTopic Model.
#Writing Swagger UI tests for API endpoints: Swagger UI tests have to be written to test ProjectTopic and SignedUpTeam functionalities.

==Design Goal==
While reimplementing the SignUpTopic as ProjectTopic, the following design rules must be ensured:

* Maintain Functional Integrity: Validate the functionality of existing and new methods, incorporating any necessary improvements to meet updated requirements for managing topic signups, slot availability, and team assignments.

* Promote Loose Coupling and Tight Cohesion: Ensure that ProjectTopic and related classes, such as SignedUpTeam, are designed for optimal organization and maintainability, with clear separation of responsibilities to improve code quality and reduce dependencies.

* Apply the DRY Principle: Refactor any redundant code in the previous implementation, adhering to DRY principles by eliminating duplicated functionality from the Expertiza system and implementing reusable methods where possible.

* Ensure Robust Testing and Documentation: Validate the accuracy of existing test cases, updating them to reflect changes in ProjectTopic. Add comprehensive RSpec tests for new functionality, and perform Swagger UI testing on API endpoints to ensure complete coverage and reliability.

==Implementation==
Below are the methods implemented for the `project_topic` and `signed_up_team` classes. These methods handle slot availability, team sign-ups, waitlist management, topic reassignment, and data consistency. They ensure efficient topic allocation and seamless team management.
===app/models/project_topic.rb===

The `ProjectTopic` class is a pivotal component for managing team-based project topics, ensuring fairness, data consistency, and efficient slot allocation. It handles real-time slot availability, allowing teams to sign up for topics directly if slots are open while maintaining a fair waitlist for overflow through chronological assignment. The class dynamically reassigns slots when teams drop out, ensuring optimal utilization of resources. Methods like `current_available_slots` provide accurate slot tracking, while administrative functionality such as `signed_up_teams_for_topic` offers comprehensive reporting of both active and waitlisted teams. By managing these operations seamlessly, the class upholds fairness and integrity across team-topic assignments. The following methods were reimplemented in this model:

'''slot_available?''':

This method checks if there are any available slots for a team to sign up for the topic. This function is crucial for managing team assignments effectively without exceeding the maximum allowed capacity.

<pre>
def slot_available?
current_available_slots > 0
end
</pre>

---

'''assign_topic_to_team(new_sign_up)''':

This method assigns the current topic to a team by updating the provided sign-up record. It removes the team from the waitlist and associates the team with this topic. This ensures that the team's assignment is finalized and marked as active, not waitlisted. It is used in scenarios where a slot is available and the team can be directly assigned to the topic.

<pre>
def assign_topic_to_team(new_sign_up)
new_sign_up.update(is_waitlisted: false, sign_up_topic_id: self.id)
end
</pre>

---

'''save_waitlist_entry(new_sign_up)''':

This method adds a team to the waitlist for the current topic by marking the sign-up record as waitlisted and associating it with this topic. This function is invoked when no slots are available, ensuring the team is placed in the queue for future assignment. It maintains fairness and order in the sign-up process.

<pre>
def save_waitlist_entry(new_sign_up)
new_sign_up.update(is_waitlisted: true, sign_up_topic_id: self.id)
end
</pre>

---

'''sign_up_team(team_id)''':

This method handles the team sign-up process for the current topic. It first checks if the team is already signed up for the topic and ensures it is not waitlisted. If slots are available, the team is assigned to the topic directly. Otherwise, the team is added to the waitlist. This method is central to managing both immediate assignments and waitlisted entries.

<pre>
def sign_up_team(team_id)
topic_id = self.id

existing_sign_up = SignedUpTeam.find_by(sign_up_topic_id: topic_id, team_id: team_id)
return false if !existing_sign_up.nil? && !existing_sign_up.is_waitlisted

new_sign_up = SignedUpTeam.new(sign_up_topic_id: topic_id, team_id: team_id)

if slot_available?
assign_topic_to_team(new_sign_up)
result = SignedUpTeam.drop_off_team_waitlists(team_id)
else
result = save_waitlist_entry(new_sign_up)
end

result
end
</pre>

---

'''longest_waiting_team''':

This method retrieves the team that has been on the waitlist the longest for the current topic. It sorts the waitlisted entries by their creation time and returns the oldest entry. This is useful for assigning slots to teams in a fair and chronological manner as slots become available.

<pre>
def longest_waiting_team
SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: true).order(:created_at).first
end
</pre>

---

'''drop_team_from_topic(team_id)''':

This method removes a team from the current topic. If the removed team was not waitlisted, it reassigns the topic to the next waitlisted team, ensuring efficient utilization of available slots. The method then deletes the team's sign-up record, maintaining data consistency.

<pre>
def drop_team_from_topic(team_id)
signed_up_team = SignedUpTeam.find_by(team_id: team_id, sign_up_topic_id: self.id)
return nil unless signed_up_team

unless signed_up_team.is_waitlisted
next_waitlisted_team = longest_waiting_team
next_waitlisted_team&.reassign_topic(self.id)
end

signed_up_team.destroy
end
</pre>

---

'''signed_up_teams_for_topic''':

This method retrieves all teams that have signed up for the current topic, including both waitlisted and non-waitlisted teams. It provides an overview of the teams associated with a particular topic, aiding in administrative and reporting tasks.

<pre>
def signed_up_teams_for_topic
SignedUpTeam.where(sign_up_topic_id: self.id)
end
</pre>

---

'''current_available_slots''':

This method calculates the number of available slots for the topic by subtracting the count of non-waitlisted teams from the maximum allowed capacity. It ensures the integrity of slot management by providing real-time availability data, which is critical for the sign-up and waitlisting processes.

<pre>
def current_available_slots
teams_who_chose_the_topic = SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: false)
self.max_choosers.to_i - teams_who_chose_the_topic.size
end
</pre>

===app/models/signed_up_team.rb===

The `SignedUpTeam` class is essential for managing the lifecycle of team sign-ups and their associations with topics, ensuring efficient and consistent handling of team-topic relationships. This class facilitates creating sign-up records using methods like `create_signed_up_team`, enabling teams to associate seamlessly with topics by leveraging the `sign_up_team` method of the `ProjectTopic` class. It also manages waitlist operations, allowing for the removal of waitlisted entries through `drop_off_team_waitlists` and reassignment of teams to new topics via `reassign_topic`. For robust data management, it provides functionality to clear all topic associations for a team using `drop_off_team_signup_records`. The class also supports administrative operations, such as retrieving team IDs for specific assignments via `get_team_id`, ensuring streamlined integration with other system components. By maintaining data integrity and supporting dynamic updates to team-topic relationships, the `SignedUpTeam` class plays a crucial role in the overall project management system.

'''drop_off_team_waitlists(team_id)''':

This class method removes all waitlisted entries for a specific team. It deletes all sign-up records where the team is marked as waitlisted, ensuring the team is no longer on any waitlists.

<pre>
def self.drop_off_team_waitlists(team_id)
SignedUpTeam.where(team_id: team_id, is_waitlisted: true).destroy_all
end
</pre>

---

'''create_signed_up_team(topic_id, team_id)''':

This class method creates a sign-up record for a team by associating it with the specified topic. It retrieves the project topic by its ID and uses the `sign_up_team` method to handle the sign-up process.

<pre>
def self.create_signed_up_team(topic_id, team_id)
project_topic = ProjectTopic.find(topic_id)
project_topic.sign_up_team(team_id)
end
</pre>

---

'''get_team_id(user_id, assignment_id)''':

This class method retrieves the team ID associated with a specific user and assignment. It first identifies the teams the user belongs to and then filters the team linked to the given assignment, returning its ID.

<pre>
def self.get_team_id(user_id, assignment_id)
team_ids = TeamsUser.select('team_id').where(user_id: user_id)
team_id = Team.where(team_id: team_ids, assignment_id: assignment_id).first.team_id
team_id
end
</pre>

---

'''drop_off_team_signup_records(team_id)''':

This class method deletes all sign-up records for a given team. It removes every entry associated with the specified team, clearing all their topic associations.

<pre>
def self.drop_off_team_signup_records(team_id)
SignedUpTeam.where(team_id: team_id).destroy_all
end
</pre>

---

'''reassign_topic(topic_id)''':

This instance method reassigns a team to a new topic. It first removes the team from its current topic if they are assigned, then updates the team's waitlist status to indicate they are now assigned to the new topic.

<pre>
def reassign_topic(topic_id)
assigned_team = SignedUpTeam.where(team_id: self.team_id, is_waitlisted: false)

unless assigned_team.nil?
project_topic = ProjectTopic.find(topic_id)
project_topic.drop_team_from_topic(team_id: self.team_id)
end

self.update(is_waitlisted: false)
end
</pre>

==Testing==

'''spec/models/project_topic_spec.rb'''

1.slot_available?

This method should return a boolean value indicating whether slots are available or not. Below code tests if it returns the right value when no teams have chosen the topic and when no slots are available.
<pre>
describe '#slot_available?' do
context 'when no teams have chosen the topic' do
it 'returns true' do
expect(project_topic.slot_available?).to be true
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns false' do
expect(project_topic.slot_available?).to be false
end
end
end

</pre>

2.assign_topic_to_team

This method should assign the topic to a team. The below test case is to check if it assigns the topic properly.
</pre>
describe '#assign_topic_to_team' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'assigns the topic to the team and updates waitlist status' do
project_topic.assign_topic_to_team(new_sign_up)
expect(new_sign_up.is_waitlisted).to be false
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

3.save_waitlist_entry

This method should save a waitlist entry for a team.
</pre>
describe '#save_waitlist_entry' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'adds a new sign-up to the waitlist' do
project_topic.save_waitlist_entry(new_sign_up)
expect(new_sign_up.is_waitlisted).to be true
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

4.sign_up_team

This method should sign a team up for a project. The below code as test cases for when a slot is available, when no slots are available and when the team is already signed up for the topic and not waitlisted
</pre>
describe '#sign_up_team' do
let(:new_team) { Team.create!(assignment_id: assignment.id) }
context 'when slot is available' do
it 'assigns the topic to the team and drops team waitlists' do
allow(SignedUpTeam).to receive(:drop_off_team_waitlists).with(new_team.id).and_return(true)
expect(project_topic.sign_up_team(new_team.id)).to be true
expect(SignedUpTeam).to have_received(:drop_off_team_waitlists).with(new_team.id)
end
end
context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'adds the team to the waitlist' do
expect { project_topic.sign_up_team(new_team.id) }.to change { SignedUpTeam.count }.by(1)
expect(SignedUpTeam.last.is_waitlisted).to be true
end
end
context 'when the team is already signed up and not waitlisted' do
before do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team, is_waitlisted: false)
end
it 'returns false' do
expect(project_topic.sign_up_team(team.id)).to be false
end
end
end
</pre>

5.longest_waiting_team

This method should return the longest waiting team
</pre>
describe '#longest_waiting_team' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'returns the team that has been waitlisted the longest' do
expect(project_topic.longest_waiting_team).to eq(waitlisted_team)
end
end
</pre>

6.drop_team_from_topic

This method should drop a signed up team from a project topic. The below code tests for cases when the team is not waitlisted and when it is waitlisted.
<pre>
describe '#drop_team_from_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team) }
it 'removes the team from the topic' do
expect { project_topic.drop_team_from_topic(team.id) }.to change { SignedUpTeam.count }.by(-1)
end
context 'when the team is not waitlisted' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'assigns the topic to the next waitlisted team' do
project_topic.drop_team_from_topic(team.id)
expect(waitlisted_team.reload.is_waitlisted).to be false
end
end
end
</pre>

7.current_available_slots

This method returns the number of available slots. The below code tests for cases when no teams have signed up for the topic and when some teams have signed up for the topic.
</pre>
describe '#current_available_slots' do
context 'when no teams have signed up' do
it 'returns max_choosers as available slots' do
expect(project_topic.current_available_slots).to eq(project_topic.max_choosers)
end
end
context 'when some teams have signed up' do
before do
2.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'returns the remaining available slots' do
expect(project_topic.current_available_slots).to eq(1)
end
end
</pre>

'''spec/models/signed_up_team_spec.rb'''

1.get_team_id

This method returns team ID given user ID and assignment ID. The below code tests for cases when the user is associated with a team and when the user is not associated with any team.
</pre>
describe '.get_team_id' do
let!(:user) { User.create!(name: "Name", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id) }
let!(:teams_user) { TeamsUser.create!(team_id: team.id, user_id: user.id) }
it 'returns the correct team ID for the given user and assignment' do
expect(SignedUpTeam.get_team_id(user.id, assignment.id)).to eq(team.id)
end
it 'returns nil if the user is not associated with any team for the assignment' do
other_user = User.create!(name: "Name 2", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id)
expect(SignedUpTeam.get_team_id(other_user.id, assignment.id)).to be_nil
end
end
</pre>

2..drop_off_team_signup_records

This method should drop off all signup records for a team.
</pre>
describe '.drop_off_team_signup_records' do
let!(:signup1) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team_id: team.id) }
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signup2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: true, team_id: team.id) }
it 'removes all sign-up records for the given team' do
expect { SignedUpTeam.drop_off_team_signup_records(team.id) }
.to change { SignedUpTeam.where(team_id: team.id).count }.by(-2)
end
end
</pre>

3.reassign_topic

This method should reassign the topic for a given team.
</pre>
describe '#reassign_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, team_id: team.id) }
before do
allow(ProjectTopic).to receive(:find).with(project_topic.id).and_return(project_topic)
allow(project_topic).to receive(:drop_team_from_topic)
end
it 'reassigns the team to a new topic and marks them as not waitlisted' do
signed_up_team.reassign_topic(project_topic.id)
expect(signed_up_team.reload.is_waitlisted).to be_falsey
expect(project_topic).to have_received(:drop_team_from_topic).with(team_id: team.id)
end
</pre>

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125 Pull Request 125]

==Video==
*[https://youtube.com/watch?v=oRxrtW5v05A Video]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-12T04:16:12Z

Skanumu2: /* app/models/project_topic.rb */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation of sign up topic as project topic in the Expertiza backend. Expertiza backend is being reimplemented to leverage recent updates in Ruby on Rails ecosystem. This project is part of those efforts.

==Problem Statement==
The following tasks were required for the reimplementation :
#Redesigning SignUpTopic as ProjectTopic: This involves reimplementing SignUpTopic class from the original expertiza repository as ProjectTopic within reimplementation-backend repository. This reimplementation should follow Rails best practices, use Ruby naming conventions, and adhere to the DRY principle to improve code maintainability and readability.
#Implementing Team Signup and Topic Drop Functionality: Adding methods to sign a team up for a topic and handling cases when a team drops a topic.
#Assignment Team Retrieval: Implementing a method to retrieve AssignmentTeams that are currently signed up for a specific topic, allowing for efficient tracking and management of team assignments.
#Slot Availability Management: Including methods for managing and retrieving the current number of available slots for a topic, updating as teams sign up or drop topics to reflect accurate availability.
#Writing tests for project topic model: RSpec tests have to be written for ProjectTopic Model.
#Writing Swagger UI tests for API endpoints: Swagger UI tests have to be written to test ProjectTopic and SignedUpTeam functionalities.

==Design Goal==
While reimplementing the SignUpTopic as ProjectTopic, the following design rules must be ensured:

* Maintain Functional Integrity: Validate the functionality of existing and new methods, incorporating any necessary improvements to meet updated requirements for managing topic signups, slot availability, and team assignments.

* Promote Loose Coupling and Tight Cohesion: Ensure that ProjectTopic and related classes, such as SignedUpTeam, are designed for optimal organization and maintainability, with clear separation of responsibilities to improve code quality and reduce dependencies.

* Apply the DRY Principle: Refactor any redundant code in the previous implementation, adhering to DRY principles by eliminating duplicated functionality from the Expertiza system and implementing reusable methods where possible.

* Ensure Robust Testing and Documentation: Validate the accuracy of existing test cases, updating them to reflect changes in ProjectTopic. Add comprehensive RSpec tests for new functionality, and perform Swagger UI testing on API endpoints to ensure complete coverage and reliability.

==Implementation==
Below are the methods implemented for the `project_topic` and `signed_up_team` classes. These methods handle slot availability, team sign-ups, waitlist management, topic reassignment, and data consistency. They ensure efficient topic allocation and seamless team management.
===app/models/project_topic.rb===

The `ProjectTopic` class is a pivotal component for managing team-based project topics, ensuring fairness, data consistency, and efficient slot allocation. It handles real-time slot availability, allowing teams to sign up for topics directly if slots are open while maintaining a fair waitlist for overflow through chronological assignment. The class dynamically reassigns slots when teams drop out, ensuring optimal utilization of resources. Methods like `current_available_slots` provide accurate slot tracking, while administrative functionality such as `signed_up_teams_for_topic` offers comprehensive reporting of both active and waitlisted teams. By managing these operations seamlessly, the class upholds fairness and integrity across team-topic assignments. The following methods were reimplemented in this model:

'''slot_available?''':

This method checks if there are any available slots for a team to sign up for the topic. This function is crucial for managing team assignments effectively without exceeding the maximum allowed capacity.

<pre>
def slot_available?
current_available_slots > 0
end
</pre>

---

'''assign_topic_to_team(new_sign_up)''':

This method assigns the current topic to a team by updating the provided sign-up record. It removes the team from the waitlist and associates the team with this topic. This ensures that the team's assignment is finalized and marked as active, not waitlisted. It is used in scenarios where a slot is available and the team can be directly assigned to the topic.

<pre>
def assign_topic_to_team(new_sign_up)
new_sign_up.update(is_waitlisted: false, sign_up_topic_id: self.id)
end
</pre>

---

'''save_waitlist_entry(new_sign_up)''':

This method adds a team to the waitlist for the current topic by marking the sign-up record as waitlisted and associating it with this topic. This function is invoked when no slots are available, ensuring the team is placed in the queue for future assignment. It maintains fairness and order in the sign-up process.

<pre>
def save_waitlist_entry(new_sign_up)
new_sign_up.update(is_waitlisted: true, sign_up_topic_id: self.id)
end
</pre>

---

'''sign_up_team(team_id)''':

This method handles the team sign-up process for the current topic. It first checks if the team is already signed up for the topic and ensures it is not waitlisted. If slots are available, the team is assigned to the topic directly. Otherwise, the team is added to the waitlist. This method is central to managing both immediate assignments and waitlisted entries.

<pre>
def sign_up_team(team_id)
topic_id = self.id

existing_sign_up = SignedUpTeam.find_by(sign_up_topic_id: topic_id, team_id: team_id)
return false if !existing_sign_up.nil? && !existing_sign_up.is_waitlisted

new_sign_up = SignedUpTeam.new(sign_up_topic_id: topic_id, team_id: team_id)

if slot_available?
assign_topic_to_team(new_sign_up)
result = SignedUpTeam.drop_off_team_waitlists(team_id)
else
result = save_waitlist_entry(new_sign_up)
end

result
end
</pre>

---

'''longest_waiting_team''':

This method retrieves the team that has been on the waitlist the longest for the current topic. It sorts the waitlisted entries by their creation time and returns the oldest entry. This is useful for assigning slots to teams in a fair and chronological manner as slots become available.

<pre>
def longest_waiting_team
SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: true).order(:created_at).first
end
</pre>

---

'''drop_team_from_topic(team_id)''':

This method removes a team from the current topic. If the removed team was not waitlisted, it reassigns the topic to the next waitlisted team, ensuring efficient utilization of available slots. The method then deletes the team's sign-up record, maintaining data consistency.

<pre>
def drop_team_from_topic(team_id)
signed_up_team = SignedUpTeam.find_by(team_id: team_id, sign_up_topic_id: self.id)
return nil unless signed_up_team

unless signed_up_team.is_waitlisted
next_waitlisted_team = longest_waiting_team
next_waitlisted_team&.reassign_topic(self.id)
end

signed_up_team.destroy
end
</pre>

---

'''signed_up_teams_for_topic''':

This method retrieves all teams that have signed up for the current topic, including both waitlisted and non-waitlisted teams. It provides an overview of the teams associated with a particular topic, aiding in administrative and reporting tasks.

<pre>
def signed_up_teams_for_topic
SignedUpTeam.where(sign_up_topic_id: self.id)
end
</pre>

---

'''current_available_slots''':

This method calculates the number of available slots for the topic by subtracting the count of non-waitlisted teams from the maximum allowed capacity. It ensures the integrity of slot management by providing real-time availability data, which is critical for the sign-up and waitlisting processes.

<pre>
def current_available_slots
teams_who_chose_the_topic = SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: false)
self.max_choosers.to_i - teams_who_chose_the_topic.size
end
</pre>

===app/models/signed_up_team.rb===

This class manages team sign-ups and associations with topics. It provides functionality for creating, modifying, and removing sign-up records while supporting seamless team-topic management and waitlist operations.

'''drop_off_team_waitlists(team_id)''':

This class method removes all waitlisted entries for a specific team. It deletes all sign-up records where the team is marked as waitlisted, ensuring the team is no longer on any waitlists.

<pre>
def self.drop_off_team_waitlists(team_id)
SignedUpTeam.where(team_id: team_id, is_waitlisted: true).destroy_all
end
</pre>

---

'''create_signed_up_team(topic_id, team_id)''':

This class method creates a sign-up record for a team by associating it with the specified topic. It retrieves the project topic by its ID and uses the `sign_up_team` method to handle the sign-up process.

<pre>
def self.create_signed_up_team(topic_id, team_id)
project_topic = ProjectTopic.find(topic_id)
project_topic.sign_up_team(team_id)
end
</pre>

---

'''get_team_id(user_id, assignment_id)''':

This class method retrieves the team ID associated with a specific user and assignment. It first identifies the teams the user belongs to and then filters the team linked to the given assignment, returning its ID.

<pre>
def self.get_team_id(user_id, assignment_id)
team_ids = TeamsUser.select('team_id').where(user_id: user_id)
team_id = Team.where(team_id: team_ids, assignment_id: assignment_id).first.team_id
team_id
end
</pre>

---

'''drop_off_team_signup_records(team_id)''':

This class method deletes all sign-up records for a given team. It removes every entry associated with the specified team, clearing all their topic associations.

<pre>
def self.drop_off_team_signup_records(team_id)
SignedUpTeam.where(team_id: team_id).destroy_all
end
</pre>

---

'''reassign_topic(topic_id)''':

This instance method reassigns a team to a new topic. It first removes the team from its current topic if they are assigned, then updates the team's waitlist status to indicate they are now assigned to the new topic.

<pre>
def reassign_topic(topic_id)
assigned_team = SignedUpTeam.where(team_id: self.team_id, is_waitlisted: false)

unless assigned_team.nil?
project_topic = ProjectTopic.find(topic_id)
project_topic.drop_team_from_topic(team_id: self.team_id)
end

self.update(is_waitlisted: false)
end
</pre>

==Testing==

'''spec/models/project_topic_spec.rb'''

1.slot_available?

This method should return a boolean value indicating whether slots are available or not. Below code tests if it returns the right value when no teams have chosen the topic and when no slots are available.
<pre>
describe '#slot_available?' do
context 'when no teams have chosen the topic' do
it 'returns true' do
expect(project_topic.slot_available?).to be true
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns false' do
expect(project_topic.slot_available?).to be false
end
end
end

</pre>

2.assign_topic_to_team

This method should assign the topic to a team. The below test case is to check if it assigns the topic properly.
</pre>
describe '#assign_topic_to_team' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'assigns the topic to the team and updates waitlist status' do
project_topic.assign_topic_to_team(new_sign_up)
expect(new_sign_up.is_waitlisted).to be false
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

3.save_waitlist_entry

This method should save a waitlist entry for a team.
</pre>
describe '#save_waitlist_entry' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'adds a new sign-up to the waitlist' do
project_topic.save_waitlist_entry(new_sign_up)
expect(new_sign_up.is_waitlisted).to be true
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

4.sign_up_team

This method should sign a team up for a project. The below code as test cases for when a slot is available, when no slots are available and when the team is already signed up for the topic and not waitlisted
</pre>
describe '#sign_up_team' do
let(:new_team) { Team.create!(assignment_id: assignment.id) }
context 'when slot is available' do
it 'assigns the topic to the team and drops team waitlists' do
allow(SignedUpTeam).to receive(:drop_off_team_waitlists).with(new_team.id).and_return(true)
expect(project_topic.sign_up_team(new_team.id)).to be true
expect(SignedUpTeam).to have_received(:drop_off_team_waitlists).with(new_team.id)
end
end
context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'adds the team to the waitlist' do
expect { project_topic.sign_up_team(new_team.id) }.to change { SignedUpTeam.count }.by(1)
expect(SignedUpTeam.last.is_waitlisted).to be true
end
end
context 'when the team is already signed up and not waitlisted' do
before do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team, is_waitlisted: false)
end
it 'returns false' do
expect(project_topic.sign_up_team(team.id)).to be false
end
end
end
</pre>

5.longest_waiting_team

This method should return the longest waiting team
</pre>
describe '#longest_waiting_team' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'returns the team that has been waitlisted the longest' do
expect(project_topic.longest_waiting_team).to eq(waitlisted_team)
end
end
</pre>

6.drop_team_from_topic

This method should drop a signed up team from a project topic. The below code tests for cases when the team is not waitlisted and when it is waitlisted.
<pre>
describe '#drop_team_from_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team) }
it 'removes the team from the topic' do
expect { project_topic.drop_team_from_topic(team.id) }.to change { SignedUpTeam.count }.by(-1)
end
context 'when the team is not waitlisted' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'assigns the topic to the next waitlisted team' do
project_topic.drop_team_from_topic(team.id)
expect(waitlisted_team.reload.is_waitlisted).to be false
end
end
end
</pre>

7.current_available_slots

This method returns the number of available slots. The below code tests for cases when no teams have signed up for the topic and when some teams have signed up for the topic.
</pre>
describe '#current_available_slots' do
context 'when no teams have signed up' do
it 'returns max_choosers as available slots' do
expect(project_topic.current_available_slots).to eq(project_topic.max_choosers)
end
end
context 'when some teams have signed up' do
before do
2.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'returns the remaining available slots' do
expect(project_topic.current_available_slots).to eq(1)
end
end
</pre>

'''spec/models/signed_up_team_spec.rb'''

1.get_team_id

This method returns team ID given user ID and assignment ID. The below code tests for cases when the user is associated with a team and when the user is not associated with any team.
</pre>
describe '.get_team_id' do
let!(:user) { User.create!(name: "Name", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id) }
let!(:teams_user) { TeamsUser.create!(team_id: team.id, user_id: user.id) }
it 'returns the correct team ID for the given user and assignment' do
expect(SignedUpTeam.get_team_id(user.id, assignment.id)).to eq(team.id)
end
it 'returns nil if the user is not associated with any team for the assignment' do
other_user = User.create!(name: "Name 2", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id)
expect(SignedUpTeam.get_team_id(other_user.id, assignment.id)).to be_nil
end
end
</pre>

2..drop_off_team_signup_records

This method should drop off all signup records for a team.
</pre>
describe '.drop_off_team_signup_records' do
let!(:signup1) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team_id: team.id) }
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signup2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: true, team_id: team.id) }
it 'removes all sign-up records for the given team' do
expect { SignedUpTeam.drop_off_team_signup_records(team.id) }
.to change { SignedUpTeam.where(team_id: team.id).count }.by(-2)
end
end
</pre>

3.reassign_topic

This method should reassign the topic for a given team.
</pre>
describe '#reassign_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, team_id: team.id) }
before do
allow(ProjectTopic).to receive(:find).with(project_topic.id).and_return(project_topic)
allow(project_topic).to receive(:drop_team_from_topic)
end
it 'reassigns the team to a new topic and marks them as not waitlisted' do
signed_up_team.reassign_topic(project_topic.id)
expect(signed_up_team.reload.is_waitlisted).to be_falsey
expect(project_topic).to have_received(:drop_team_from_topic).with(team_id: team.id)
end
</pre>

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125 Pull Request 125]

==Video==
*[https://youtube.com/watch?v=oRxrtW5v05A Video]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-11T19:06:55Z

Skanumu2:

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation of sign up topic as project topic in the Expertiza backend. Expertiza backend is being reimplemented to leverage recent updates in Ruby on Rails ecosystem. This project is part of those efforts.

==Problem Statement==
The following tasks were required for the reimplementation :
#Redesigning SignUpTopic as ProjectTopic: This involves reimplementing SignUpTopic class from the original expertiza repository as ProjectTopic within reimplementation-backend repository. This reimplementation should follow Rails best practices, use Ruby naming conventions, and adhere to the DRY principle to improve code maintainability and readability.
#Implementing Team Signup and Topic Drop Functionality: Adding methods to sign a team up for a topic and handling cases when a team drops a topic.
#Assignment Team Retrieval: Implementing a method to retrieve AssignmentTeams that are currently signed up for a specific topic, allowing for efficient tracking and management of team assignments.
#Slot Availability Management: Including methods for managing and retrieving the current number of available slots for a topic, updating as teams sign up or drop topics to reflect accurate availability.
#Writing tests for project topic model: RSpec tests have to be written for ProjectTopic Model.
#Writing Swagger UI tests for API endpoints: Swagger UI tests have to be written to test ProjectTopic and SignedUpTeam functionalities.

==Design Goal==
While reimplementing the SignUpTopic as ProjectTopic, the following design rules must be ensured:

* Maintain Functional Integrity: Validate the functionality of existing and new methods, incorporating any necessary improvements to meet updated requirements for managing topic signups, slot availability, and team assignments.

* Promote Loose Coupling and Tight Cohesion: Ensure that ProjectTopic and related classes, such as SignedUpTeam, are designed for optimal organization and maintainability, with clear separation of responsibilities to improve code quality and reduce dependencies.

* Apply the DRY Principle: Refactor any redundant code in the previous implementation, adhering to DRY principles by eliminating duplicated functionality from the Expertiza system and implementing reusable methods where possible.

* Ensure Robust Testing and Documentation: Validate the accuracy of existing test cases, updating them to reflect changes in ProjectTopic. Add comprehensive RSpec tests for new functionality, and perform Swagger UI testing on API endpoints to ensure complete coverage and reliability.

==Implementation==
Below are the methods implemented for the `project_topic` and `signed_up_team` classes. These methods handle slot availability, team sign-ups, waitlist management, topic reassignment, and data consistency. They ensure efficient topic allocation and seamless team management.
===app/models/project_topic.rb===

This class manages topics for team-based projects, handling slot availability, topic assignment, and waitlist management. It ensures that teams are efficiently allocated to topics based on availability while maintaining fairness and data consistency. Following methods were reimplemented in this model:

'''slot_available?''':

This method checks if there are any available slots for a team to sign up for the topic. This function is crucial for managing team assignments effectively without exceeding the maximum allowed capacity.

<pre>
def slot_available?
current_available_slots > 0
end
</pre>

---

'''assign_topic_to_team(new_sign_up)''':

This method assigns the current topic to a team by updating the provided sign-up record. It removes the team from the waitlist and associates the team with this topic. This ensures that the team's assignment is finalized and marked as active, not waitlisted. It is used in scenarios where a slot is available and the team can be directly assigned to the topic.

<pre>
def assign_topic_to_team(new_sign_up)
new_sign_up.update(is_waitlisted: false, sign_up_topic_id: self.id)
end
</pre>

---

'''save_waitlist_entry(new_sign_up)''':

This method adds a team to the waitlist for the current topic by marking the sign-up record as waitlisted and associating it with this topic. This function is invoked when no slots are available, ensuring the team is placed in the queue for future assignment. It maintains fairness and order in the sign-up process.

<pre>
def save_waitlist_entry(new_sign_up)
new_sign_up.update(is_waitlisted: true, sign_up_topic_id: self.id)
end
</pre>

---

'''sign_up_team(team_id)''':

This method handles the team sign-up process for the current topic. It first checks if the team is already signed up for the topic and ensures it is not waitlisted. If slots are available, the team is assigned to the topic directly. Otherwise, the team is added to the waitlist. This method is central to managing both immediate assignments and waitlisted entries.

<pre>
def sign_up_team(team_id)
topic_id = self.id

existing_sign_up = SignedUpTeam.find_by(sign_up_topic_id: topic_id, team_id: team_id)
return false if !existing_sign_up.nil? && !existing_sign_up.is_waitlisted

new_sign_up = SignedUpTeam.new(sign_up_topic_id: topic_id, team_id: team_id)

if slot_available?
assign_topic_to_team(new_sign_up)
result = SignedUpTeam.drop_off_team_waitlists(team_id)
else
result = save_waitlist_entry(new_sign_up)
end

result
end
</pre>

---

'''longest_waiting_team''':

This method retrieves the team that has been on the waitlist the longest for the current topic. It sorts the waitlisted entries by their creation time and returns the oldest entry. This is useful for assigning slots to teams in a fair and chronological manner as slots become available.

<pre>
def longest_waiting_team
SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: true).order(:created_at).first
end
</pre>

---

'''drop_team_from_topic(team_id)''':

This method removes a team from the current topic. If the removed team was not waitlisted, it reassigns the topic to the next waitlisted team, ensuring efficient utilization of available slots. The method then deletes the team's sign-up record, maintaining data consistency.

<pre>
def drop_team_from_topic(team_id)
signed_up_team = SignedUpTeam.find_by(team_id: team_id, sign_up_topic_id: self.id)
return nil unless signed_up_team

unless signed_up_team.is_waitlisted
next_waitlisted_team = longest_waiting_team
next_waitlisted_team&.reassign_topic(self.id)
end

signed_up_team.destroy
end
</pre>

---

'''signed_up_teams_for_topic''':

This method retrieves all teams that have signed up for the current topic, including both waitlisted and non-waitlisted teams. It provides an overview of the teams associated with a particular topic, aiding in administrative and reporting tasks.

<pre>
def signed_up_teams_for_topic
SignedUpTeam.where(sign_up_topic_id: self.id)
end
</pre>

---

'''current_available_slots''':

This method calculates the number of available slots for the topic by subtracting the count of non-waitlisted teams from the maximum allowed capacity. It ensures the integrity of slot management by providing real-time availability data, which is critical for the sign-up and waitlisting processes.

<pre>
def current_available_slots
teams_who_chose_the_topic = SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: false)
self.max_choosers.to_i - teams_who_chose_the_topic.size
end
</pre>

===app/models/signed_up_team.rb===

This class manages team sign-ups and associations with topics. It provides functionality for creating, modifying, and removing sign-up records while supporting seamless team-topic management and waitlist operations.

'''drop_off_team_waitlists(team_id)''':

This class method removes all waitlisted entries for a specific team. It deletes all sign-up records where the team is marked as waitlisted, ensuring the team is no longer on any waitlists.

<pre>
def self.drop_off_team_waitlists(team_id)
SignedUpTeam.where(team_id: team_id, is_waitlisted: true).destroy_all
end
</pre>

---

'''create_signed_up_team(topic_id, team_id)''':

This class method creates a sign-up record for a team by associating it with the specified topic. It retrieves the project topic by its ID and uses the `sign_up_team` method to handle the sign-up process.

<pre>
def self.create_signed_up_team(topic_id, team_id)
project_topic = ProjectTopic.find(topic_id)
project_topic.sign_up_team(team_id)
end
</pre>

---

'''get_team_id(user_id, assignment_id)''':

This class method retrieves the team ID associated with a specific user and assignment. It first identifies the teams the user belongs to and then filters the team linked to the given assignment, returning its ID.

<pre>
def self.get_team_id(user_id, assignment_id)
team_ids = TeamsUser.select('team_id').where(user_id: user_id)
team_id = Team.where(team_id: team_ids, assignment_id: assignment_id).first.team_id
team_id
end
</pre>

---

'''drop_off_team_signup_records(team_id)''':

This class method deletes all sign-up records for a given team. It removes every entry associated with the specified team, clearing all their topic associations.

<pre>
def self.drop_off_team_signup_records(team_id)
SignedUpTeam.where(team_id: team_id).destroy_all
end
</pre>

---

'''reassign_topic(topic_id)''':

This instance method reassigns a team to a new topic. It first removes the team from its current topic if they are assigned, then updates the team's waitlist status to indicate they are now assigned to the new topic.

<pre>
def reassign_topic(topic_id)
assigned_team = SignedUpTeam.where(team_id: self.team_id, is_waitlisted: false)

unless assigned_team.nil?
project_topic = ProjectTopic.find(topic_id)
project_topic.drop_team_from_topic(team_id: self.team_id)
end

self.update(is_waitlisted: false)
end
</pre>

==Testing==

'''spec/models/project_topic_spec.rb'''

1.slot_available?

This method should return a boolean value indicating whether slots are available or not. Below code tests if it returns the right value when no teams have chosen the topic and when no slots are available.
<pre>
describe '#slot_available?' do
context 'when no teams have chosen the topic' do
it 'returns true' do
expect(project_topic.slot_available?).to be true
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns false' do
expect(project_topic.slot_available?).to be false
end
end
end

</pre>

2.assign_topic_to_team

This method should assign the topic to a team. The below test case is to check if it assigns the topic properly.
</pre>
describe '#assign_topic_to_team' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'assigns the topic to the team and updates waitlist status' do
project_topic.assign_topic_to_team(new_sign_up)
expect(new_sign_up.is_waitlisted).to be false
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

3.save_waitlist_entry

This method should save a waitlist entry for a team.
</pre>
describe '#save_waitlist_entry' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'adds a new sign-up to the waitlist' do
project_topic.save_waitlist_entry(new_sign_up)
expect(new_sign_up.is_waitlisted).to be true
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

4.sign_up_team

This method should sign a team up for a project. The below code as test cases for when a slot is available, when no slots are available and when the team is already signed up for the topic and not waitlisted
</pre>
describe '#sign_up_team' do
let(:new_team) { Team.create!(assignment_id: assignment.id) }
context 'when slot is available' do
it 'assigns the topic to the team and drops team waitlists' do
allow(SignedUpTeam).to receive(:drop_off_team_waitlists).with(new_team.id).and_return(true)
expect(project_topic.sign_up_team(new_team.id)).to be true
expect(SignedUpTeam).to have_received(:drop_off_team_waitlists).with(new_team.id)
end
end
context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'adds the team to the waitlist' do
expect { project_topic.sign_up_team(new_team.id) }.to change { SignedUpTeam.count }.by(1)
expect(SignedUpTeam.last.is_waitlisted).to be true
end
end
context 'when the team is already signed up and not waitlisted' do
before do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team, is_waitlisted: false)
end
it 'returns false' do
expect(project_topic.sign_up_team(team.id)).to be false
end
end
end
</pre>

5.longest_waiting_team

This method should return the longest waiting team
</pre>
describe '#longest_waiting_team' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'returns the team that has been waitlisted the longest' do
expect(project_topic.longest_waiting_team).to eq(waitlisted_team)
end
end
</pre>

6.drop_team_from_topic

This method should drop a signed up team from a project topic. The below code tests for cases when the team is not waitlisted and when it is waitlisted.
<pre>
describe '#drop_team_from_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team) }
it 'removes the team from the topic' do
expect { project_topic.drop_team_from_topic(team.id) }.to change { SignedUpTeam.count }.by(-1)
end
context 'when the team is not waitlisted' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'assigns the topic to the next waitlisted team' do
project_topic.drop_team_from_topic(team.id)
expect(waitlisted_team.reload.is_waitlisted).to be false
end
end
end
</pre>

7.current_available_slots

This method returns the number of available slots. The below code tests for cases when no teams have signed up for the topic and when some teams have signed up for the topic.
</pre>
describe '#current_available_slots' do
context 'when no teams have signed up' do
it 'returns max_choosers as available slots' do
expect(project_topic.current_available_slots).to eq(project_topic.max_choosers)
end
end
context 'when some teams have signed up' do
before do
2.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'returns the remaining available slots' do
expect(project_topic.current_available_slots).to eq(1)
end
end
</pre>

'''spec/models/signed_up_team_spec.rb'''

1.get_team_id

This method returns team ID given user ID and assignment ID. The below code tests for cases when the user is associated with a team and when the user is not associated with any team.
</pre>
describe '.get_team_id' do
let!(:user) { User.create!(name: "Name", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id) }
let!(:teams_user) { TeamsUser.create!(team_id: team.id, user_id: user.id) }
it 'returns the correct team ID for the given user and assignment' do
expect(SignedUpTeam.get_team_id(user.id, assignment.id)).to eq(team.id)
end
it 'returns nil if the user is not associated with any team for the assignment' do
other_user = User.create!(name: "Name 2", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id)
expect(SignedUpTeam.get_team_id(other_user.id, assignment.id)).to be_nil
end
end
</pre>

2..drop_off_team_signup_records

This method should drop off all signup records for a team.
</pre>
describe '.drop_off_team_signup_records' do
let!(:signup1) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team_id: team.id) }
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signup2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: true, team_id: team.id) }
it 'removes all sign-up records for the given team' do
expect { SignedUpTeam.drop_off_team_signup_records(team.id) }
.to change { SignedUpTeam.where(team_id: team.id).count }.by(-2)
end
end
</pre>

3.reassign_topic

This method should reassign the topic for a given team.
</pre>
describe '#reassign_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, team_id: team.id) }
before do
allow(ProjectTopic).to receive(:find).with(project_topic.id).and_return(project_topic)
allow(project_topic).to receive(:drop_team_from_topic)
end
it 'reassigns the team to a new topic and marks them as not waitlisted' do
signed_up_team.reassign_topic(project_topic.id)
expect(signed_up_team.reload.is_waitlisted).to be_falsey
expect(project_topic).to have_received(:drop_team_from_topic).with(team_id: team.id)
end
</pre>

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125 Pull Request 125]

==Video==
*[https://youtube.com/watch?v=oRxrtW5v05A Video]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-11T19:03:43Z

Skanumu2:

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation of sign up topic as project topic in the Expertiza backend. Expertiza backend is being reimplemented to leverage recent updates in Ruby on Rails ecosystem. This project is part of those efforts.

==Problem Statement==
The following tasks were required for the reimplementation :
#Redesigning SignUpTopic as ProjectTopic: This involves reimplementing SignUpTopic class from the original expertiza repository as ProjectTopic within reimplementation-backend repository. This reimplementation should follow Rails best practices, use Ruby naming conventions, and adhere to the DRY principle to improve code maintainability and readability.
#Implementing Team Signup and Topic Drop Functionality: Adding methods to sign a team up for a topic and handling cases when a team drops a topic.
#Assignment Team Retrieval: Implementing a method to retrieve AssignmentTeams that are currently signed up for a specific topic, allowing for efficient tracking and management of team assignments.
#Slot Availability Management: Including methods for managing and retrieving the current number of available slots for a topic, updating as teams sign up or drop topics to reflect accurate availability.
#Writing tests for project topic model: RSpec tests have to be written for ProjectTopic Model.
#Writing Swagger UI tests for API endpoints: Swagger UI tests have to be written to test ProjectTopic and SignedUpTeam functionalities.

==Design Goal==
While reimplementing the SignUpTopic as ProjectTopic, the following design rules must be ensured:

* Maintain Functional Integrity: Validate the functionality of existing and new methods, incorporating any necessary improvements to meet updated requirements for managing topic signups, slot availability, and team assignments.

* Promote Loose Coupling and Tight Cohesion: Ensure that ProjectTopic and related classes, such as SignedUpTeam, are designed for optimal organization and maintainability, with clear separation of responsibilities to improve code quality and reduce dependencies.

* Apply the DRY Principle: Refactor any redundant code in the previous implementation, adhering to DRY principles by eliminating duplicated functionality from the Expertiza system and implementing reusable methods where possible.

* Ensure Robust Testing and Documentation: Validate the accuracy of existing test cases, updating them to reflect changes in ProjectTopic. Add comprehensive RSpec tests for new functionality, and perform Swagger UI testing on API endpoints to ensure complete coverage and reliability.

==Implementation==
Below are the methods implemented for the `project_topic` and `signed_up_team` classes. These methods handle slot availability, team sign-ups, waitlist management, topic reassignment, and data consistency. They ensure efficient topic allocation and seamless team management.
===app/models/project_topic.rb===

This class manages topics for team-based projects, handling slot availability, topic assignment, and waitlist management. It ensures that teams are efficiently allocated to topics based on availability while maintaining fairness and data consistency. Following methods were reimplemented in this model:

'''slot_available?''':

This method checks if there are any available slots for a team to sign up for the topic. This function is crucial for managing team assignments effectively without exceeding the maximum allowed capacity.

<pre>
def slot_available?
current_available_slots > 0
end
</pre>

---

'''assign_topic_to_team(new_sign_up)''':

This method assigns the current topic to a team by updating the provided sign-up record. It removes the team from the waitlist and associates the team with this topic. This ensures that the team's assignment is finalized and marked as active, not waitlisted. It is used in scenarios where a slot is available and the team can be directly assigned to the topic.

<pre>
def assign_topic_to_team(new_sign_up)
new_sign_up.update(is_waitlisted: false, sign_up_topic_id: self.id)
end
</pre>

---

'''save_waitlist_entry(new_sign_up)''':

This method adds a team to the waitlist for the current topic by marking the sign-up record as waitlisted and associating it with this topic. This function is invoked when no slots are available, ensuring the team is placed in the queue for future assignment. It maintains fairness and order in the sign-up process.

<pre>
def save_waitlist_entry(new_sign_up)
new_sign_up.update(is_waitlisted: true, sign_up_topic_id: self.id)
end
</pre>

---

'''sign_up_team(team_id)''':

This method handles the team sign-up process for the current topic. It first checks if the team is already signed up for the topic and ensures it is not waitlisted. If slots are available, the team is assigned to the topic directly. Otherwise, the team is added to the waitlist. This method is central to managing both immediate assignments and waitlisted entries.

<pre>
def sign_up_team(team_id)
topic_id = self.id

existing_sign_up = SignedUpTeam.find_by(sign_up_topic_id: topic_id, team_id: team_id)
return false if !existing_sign_up.nil? && !existing_sign_up.is_waitlisted

new_sign_up = SignedUpTeam.new(sign_up_topic_id: topic_id, team_id: team_id)

if slot_available?
assign_topic_to_team(new_sign_up)
result = SignedUpTeam.drop_off_team_waitlists(team_id)
else
result = save_waitlist_entry(new_sign_up)
end

result
end
</pre>

---

'''longest_waiting_team''':

This method retrieves the team that has been on the waitlist the longest for the current topic. It sorts the waitlisted entries by their creation time and returns the oldest entry. This is useful for assigning slots to teams in a fair and chronological manner as slots become available.

<pre>
def longest_waiting_team
SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: true).order(:created_at).first
end
</pre>

---

'''drop_team_from_topic(team_id)''':

This method removes a team from the current topic. If the removed team was not waitlisted, it reassigns the topic to the next waitlisted team, ensuring efficient utilization of available slots. The method then deletes the team's sign-up record, maintaining data consistency.

<pre>
def drop_team_from_topic(team_id)
signed_up_team = SignedUpTeam.find_by(team_id: team_id, sign_up_topic_id: self.id)
return nil unless signed_up_team

unless signed_up_team.is_waitlisted
next_waitlisted_team = longest_waiting_team
next_waitlisted_team&.reassign_topic(self.id)
end

signed_up_team.destroy
end
</pre>

---

'''signed_up_teams_for_topic''':

This method retrieves all teams that have signed up for the current topic, including both waitlisted and non-waitlisted teams. It provides an overview of the teams associated with a particular topic, aiding in administrative and reporting tasks.

<pre>
def signed_up_teams_for_topic
SignedUpTeam.where(sign_up_topic_id: self.id)
end
</pre>

---

'''current_available_slots''':

This method calculates the number of available slots for the topic by subtracting the count of non-waitlisted teams from the maximum allowed capacity. It ensures the integrity of slot management by providing real-time availability data, which is critical for the sign-up and waitlisting processes.

<pre>
def current_available_slots
teams_who_chose_the_topic = SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: false)
self.max_choosers.to_i - teams_who_chose_the_topic.size
end
</pre>

===app/models/signed_up_team.rb===

This class manages team sign-ups and associations with topics. It provides functionality for creating, modifying, and removing sign-up records while supporting seamless team-topic management and waitlist operations.

'''drop_off_team_waitlists(team_id)''':

This class method removes all waitlisted entries for a specific team. It deletes all sign-up records where the team is marked as waitlisted, ensuring the team is no longer on any waitlists.

<pre>
def self.drop_off_team_waitlists(team_id)
SignedUpTeam.where(team_id: team_id, is_waitlisted: true).destroy_all
end
</pre>

---

'''create_signed_up_team(topic_id, team_id)''':

This class method creates a sign-up record for a team by associating it with the specified topic. It retrieves the project topic by its ID and uses the `sign_up_team` method to handle the sign-up process.

<pre>
def self.create_signed_up_team(topic_id, team_id)
project_topic = ProjectTopic.find(topic_id)
project_topic.sign_up_team(team_id)
end
</pre>

---

'''get_team_id(user_id, assignment_id)''':

This class method retrieves the team ID associated with a specific user and assignment. It first identifies the teams the user belongs to and then filters the team linked to the given assignment, returning its ID.

<pre>
def self.get_team_id(user_id, assignment_id)
team_ids = TeamsUser.select('team_id').where(user_id: user_id)
team_id = Team.where(team_id: team_ids, assignment_id: assignment_id).first.team_id
team_id
end
</pre>

---

'''drop_off_team_signup_records(team_id)''':

This class method deletes all sign-up records for a given team. It removes every entry associated with the specified team, clearing all their topic associations.

<pre>
def self.drop_off_team_signup_records(team_id)
SignedUpTeam.where(team_id: team_id).destroy_all
end
</pre>

---

'''reassign_topic(topic_id)''':

This instance method reassigns a team to a new topic. It first removes the team from its current topic if they are assigned, then updates the team's waitlist status to indicate they are now assigned to the new topic.

<pre>
def reassign_topic(topic_id)
assigned_team = SignedUpTeam.where(team_id: self.team_id, is_waitlisted: false)

unless assigned_team.nil?
project_topic = ProjectTopic.find(topic_id)
project_topic.drop_team_from_topic(team_id: self.team_id)
end

self.update(is_waitlisted: false)
end
</pre>

==Testing==

'''spec/models/project_topic_spec.rb'''

1.slot_available?

This method should return a boolean value indicating whether slots are available or not. Below code tests if it returns the right value when no teams have chosen the topic and when no slots are available.
<pre>
describe '#slot_available?' do
context 'when no teams have chosen the topic' do
it 'returns true' do
expect(project_topic.slot_available?).to be true
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns false' do
expect(project_topic.slot_available?).to be false
end
end
end

</pre>

2.assign_topic_to_team

This method should assign the topic to a team. The below test case is to check if it assigns the topic properly.
</pre>
describe '#assign_topic_to_team' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'assigns the topic to the team and updates waitlist status' do
project_topic.assign_topic_to_team(new_sign_up)
expect(new_sign_up.is_waitlisted).to be false
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

3.save_waitlist_entry

This method should save a waitlist entry for a team.
</pre>
describe '#save_waitlist_entry' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'adds a new sign-up to the waitlist' do
project_topic.save_waitlist_entry(new_sign_up)
expect(new_sign_up.is_waitlisted).to be true
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

4.sign_up_team

This method should sign a team up for a project. The below code as test cases for when a slot is available, when no slots are available and when the team is already signed up for the topic and not waitlisted
</pre>
describe '#sign_up_team' do
let(:new_team) { Team.create!(assignment_id: assignment.id) }
context 'when slot is available' do
it 'assigns the topic to the team and drops team waitlists' do
allow(SignedUpTeam).to receive(:drop_off_team_waitlists).with(new_team.id).and_return(true)
expect(project_topic.sign_up_team(new_team.id)).to be true
expect(SignedUpTeam).to have_received(:drop_off_team_waitlists).with(new_team.id)
end
end
context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'adds the team to the waitlist' do
expect { project_topic.sign_up_team(new_team.id) }.to change { SignedUpTeam.count }.by(1)
expect(SignedUpTeam.last.is_waitlisted).to be true
end
end
context 'when the team is already signed up and not waitlisted' do
before do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team, is_waitlisted: false)
end
it 'returns false' do
expect(project_topic.sign_up_team(team.id)).to be false
end
end
end
</pre>

5.longest_waiting_team

This method should return the longest waiting team
</pre>
describe '#longest_waiting_team' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'returns the team that has been waitlisted the longest' do
expect(project_topic.longest_waiting_team).to eq(waitlisted_team)
end
end
</pre>

6.drop_team_from_topic

This method should drop a signed up team from a project topic. The below code tests for cases when the team is not waitlisted and when it is waitlisted.
<pre>
describe '#drop_team_from_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team) }
it 'removes the team from the topic' do
expect { project_topic.drop_team_from_topic(team.id) }.to change { SignedUpTeam.count }.by(-1)
end
context 'when the team is not waitlisted' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'assigns the topic to the next waitlisted team' do
project_topic.drop_team_from_topic(team.id)
expect(waitlisted_team.reload.is_waitlisted).to be false
end
end
end
</pre>

7.current_available_slots

This method returns the number of available slots. The below code tests for cases when no teams have signed up for the topic and when some teams have signed up for the topic.
</pre>
describe '#current_available_slots' do
context 'when no teams have signed up' do
it 'returns max_choosers as available slots' do
expect(project_topic.current_available_slots).to eq(project_topic.max_choosers)
end
end
context 'when some teams have signed up' do
before do
2.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'returns the remaining available slots' do
expect(project_topic.current_available_slots).to eq(1)
end
end
</pre>

'''spec/models/signed_up_team_spec.rb'''

1.get_team_id
</pre>
describe '.get_team_id' do
let!(:user) { User.create!(name: "Name", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id) }
let!(:teams_user) { TeamsUser.create!(team_id: team.id, user_id: user.id) }
it 'returns the correct team ID for the given user and assignment' do
expect(SignedUpTeam.get_team_id(user.id, assignment.id)).to eq(team.id)
end
it 'returns nil if the user is not associated with any team for the assignment' do
other_user = User.create!(name: "Name 2", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id)
expect(SignedUpTeam.get_team_id(other_user.id, assignment.id)).to be_nil
end
end
</pre>

2..drop_off_team_signup_records
</pre>
describe '.drop_off_team_signup_records' do
let!(:signup1) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team_id: team.id) }
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signup2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: true, team_id: team.id) }
it 'removes all sign-up records for the given team' do
expect { SignedUpTeam.drop_off_team_signup_records(team.id) }
.to change { SignedUpTeam.where(team_id: team.id).count }.by(-2)
end
end
</pre>

3.reassign_topic
</pre>
describe '#reassign_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, team_id: team.id) }
before do
allow(ProjectTopic).to receive(:find).with(project_topic.id).and_return(project_topic)
allow(project_topic).to receive(:drop_team_from_topic)
end
it 'reassigns the team to a new topic and marks them as not waitlisted' do
signed_up_team.reassign_topic(project_topic.id)
expect(signed_up_team.reload.is_waitlisted).to be_falsey
expect(project_topic).to have_received(:drop_team_from_topic).with(team_id: team.id)
end
</pre>

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125 Pull Request 125]

==Video==
*[https://youtube.com/watch?v=oRxrtW5v05A Video]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-11T18:59:22Z

Skanumu2:

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation of sign up topic as project topic in the Expertiza backend. Expertiza backend is being reimplemented to leverage recent updates in Ruby on Rails ecosystem. This project is part of those efforts.

==Problem Statement==
The following tasks were required for the reimplementation :
#Redesigning SignUpTopic as ProjectTopic: This involves reimplementing SignUpTopic class from the original expertiza repository as ProjectTopic within reimplementation-backend repository. This reimplementation should follow Rails best practices, use Ruby naming conventions, and adhere to the DRY principle to improve code maintainability and readability.
#Implementing Team Signup and Topic Drop Functionality: Adding methods to sign a team up for a topic and handling cases when a team drops a topic.
#Assignment Team Retrieval: Implementing a method to retrieve AssignmentTeams that are currently signed up for a specific topic, allowing for efficient tracking and management of team assignments.
#Slot Availability Management: Including methods for managing and retrieving the current number of available slots for a topic, updating as teams sign up or drop topics to reflect accurate availability.
#Writing tests for project topic model: RSpec tests have to be written for ProjectTopic Model.
#Writing Swagger UI tests for API endpoints: Swagger UI tests have to be written to test ProjectTopic and SignedUpTeam functionalities.

==Design Goal==
While reimplementing the SignUpTopic as ProjectTopic, the following design rules must be ensured:

* Maintain Functional Integrity: Validate the functionality of existing and new methods, incorporating any necessary improvements to meet updated requirements for managing topic signups, slot availability, and team assignments.

* Promote Loose Coupling and Tight Cohesion: Ensure that ProjectTopic and related classes, such as SignedUpTeam, are designed for optimal organization and maintainability, with clear separation of responsibilities to improve code quality and reduce dependencies.

* Apply the DRY Principle: Refactor any redundant code in the previous implementation, adhering to DRY principles by eliminating duplicated functionality from the Expertiza system and implementing reusable methods where possible.

* Ensure Robust Testing and Documentation: Validate the accuracy of existing test cases, updating them to reflect changes in ProjectTopic. Add comprehensive RSpec tests for new functionality, and perform Swagger UI testing on API endpoints to ensure complete coverage and reliability.

==Implementation==
Below are the methods implemented for the `project_topic` and `signed_up_team` classes. These methods handle slot availability, team sign-ups, waitlist management, topic reassignment, and data consistency. They ensure efficient topic allocation and seamless team management.
===app/models/project_topic.rb===

This class manages topics for team-based projects, handling slot availability, topic assignment, and waitlist management. It ensures that teams are efficiently allocated to topics based on availability while maintaining fairness and data consistency. Following methods were reimplemented in this model:

'''slot_available?''':

This method checks if there are any available slots for a team to sign up for the topic. This function is crucial for managing team assignments effectively without exceeding the maximum allowed capacity.

<pre>
def slot_available?
current_available_slots > 0
end
</pre>

---

'''assign_topic_to_team(new_sign_up)''':

This method assigns the current topic to a team by updating the provided sign-up record. It removes the team from the waitlist and associates the team with this topic. This ensures that the team's assignment is finalized and marked as active, not waitlisted. It is used in scenarios where a slot is available and the team can be directly assigned to the topic.

<pre>
def assign_topic_to_team(new_sign_up)
new_sign_up.update(is_waitlisted: false, sign_up_topic_id: self.id)
end
</pre>

---

'''save_waitlist_entry(new_sign_up)''':

This method adds a team to the waitlist for the current topic by marking the sign-up record as waitlisted and associating it with this topic. This function is invoked when no slots are available, ensuring the team is placed in the queue for future assignment. It maintains fairness and order in the sign-up process.

<pre>
def save_waitlist_entry(new_sign_up)
new_sign_up.update(is_waitlisted: true, sign_up_topic_id: self.id)
end
</pre>

---

'''sign_up_team(team_id)''':

This method handles the team sign-up process for the current topic. It first checks if the team is already signed up for the topic and ensures it is not waitlisted. If slots are available, the team is assigned to the topic directly. Otherwise, the team is added to the waitlist. This method is central to managing both immediate assignments and waitlisted entries.

<pre>
def sign_up_team(team_id)
topic_id = self.id

existing_sign_up = SignedUpTeam.find_by(sign_up_topic_id: topic_id, team_id: team_id)
return false if !existing_sign_up.nil? && !existing_sign_up.is_waitlisted

new_sign_up = SignedUpTeam.new(sign_up_topic_id: topic_id, team_id: team_id)

if slot_available?
assign_topic_to_team(new_sign_up)
result = SignedUpTeam.drop_off_team_waitlists(team_id)
else
result = save_waitlist_entry(new_sign_up)
end

result
end
</pre>

---

'''longest_waiting_team''':

This method retrieves the team that has been on the waitlist the longest for the current topic. It sorts the waitlisted entries by their creation time and returns the oldest entry. This is useful for assigning slots to teams in a fair and chronological manner as slots become available.

<pre>
def longest_waiting_team
SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: true).order(:created_at).first
end
</pre>

---

'''drop_team_from_topic(team_id)''':

This method removes a team from the current topic. If the removed team was not waitlisted, it reassigns the topic to the next waitlisted team, ensuring efficient utilization of available slots. The method then deletes the team's sign-up record, maintaining data consistency.

<pre>
def drop_team_from_topic(team_id)
signed_up_team = SignedUpTeam.find_by(team_id: team_id, sign_up_topic_id: self.id)
return nil unless signed_up_team

unless signed_up_team.is_waitlisted
next_waitlisted_team = longest_waiting_team
next_waitlisted_team&.reassign_topic(self.id)
end

signed_up_team.destroy
end
</pre>

---

'''signed_up_teams_for_topic''':

This method retrieves all teams that have signed up for the current topic, including both waitlisted and non-waitlisted teams. It provides an overview of the teams associated with a particular topic, aiding in administrative and reporting tasks.

<pre>
def signed_up_teams_for_topic
SignedUpTeam.where(sign_up_topic_id: self.id)
end
</pre>

---

'''current_available_slots''':

This method calculates the number of available slots for the topic by subtracting the count of non-waitlisted teams from the maximum allowed capacity. It ensures the integrity of slot management by providing real-time availability data, which is critical for the sign-up and waitlisting processes.

<pre>
def current_available_slots
teams_who_chose_the_topic = SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: false)
self.max_choosers.to_i - teams_who_chose_the_topic.size
end
</pre>

===app/models/signed_up_team.rb===

This class manages team sign-ups and associations with topics. It provides functionality for creating, modifying, and removing sign-up records while supporting seamless team-topic management and waitlist operations.

'''drop_off_team_waitlists(team_id)''':

This class method removes all waitlisted entries for a specific team. It deletes all sign-up records where the team is marked as waitlisted, ensuring the team is no longer on any waitlists.

<pre>
def self.drop_off_team_waitlists(team_id)
SignedUpTeam.where(team_id: team_id, is_waitlisted: true).destroy_all
end
</pre>

---

'''create_signed_up_team(topic_id, team_id)''':

This class method creates a sign-up record for a team by associating it with the specified topic. It retrieves the project topic by its ID and uses the `sign_up_team` method to handle the sign-up process.

<pre>
def self.create_signed_up_team(topic_id, team_id)
project_topic = ProjectTopic.find(topic_id)
project_topic.sign_up_team(team_id)
end
</pre>

---

'''get_team_id(user_id, assignment_id)''':

This class method retrieves the team ID associated with a specific user and assignment. It first identifies the teams the user belongs to and then filters the team linked to the given assignment, returning its ID.

<pre>
def self.get_team_id(user_id, assignment_id)
team_ids = TeamsUser.select('team_id').where(user_id: user_id)
team_id = Team.where(team_id: team_ids, assignment_id: assignment_id).first.team_id
team_id
end
</pre>

---

'''drop_off_team_signup_records(team_id)''':

This class method deletes all sign-up records for a given team. It removes every entry associated with the specified team, clearing all their topic associations.

<pre>
def self.drop_off_team_signup_records(team_id)
SignedUpTeam.where(team_id: team_id).destroy_all
end
</pre>

---

'''reassign_topic(topic_id)''':

This instance method reassigns a team to a new topic. It first removes the team from its current topic if they are assigned, then updates the team's waitlist status to indicate they are now assigned to the new topic.

<pre>
def reassign_topic(topic_id)
assigned_team = SignedUpTeam.where(team_id: self.team_id, is_waitlisted: false)

unless assigned_team.nil?
project_topic = ProjectTopic.find(topic_id)
project_topic.drop_team_from_topic(team_id: self.team_id)
end

self.update(is_waitlisted: false)
end
</pre>

==Testing==

'''spec/models/project_topic_spec.rb'''

1.slot_available?
This method should return a boolean value indicating whether slots are available or not. Below code tests if it returns the right value when no teams have chosen the topic and when no slots are available.
<pre>
describe '#slot_available?' do
context 'when no teams have chosen the topic' do
it 'returns true' do
expect(project_topic.slot_available?).to be true
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns false' do
expect(project_topic.slot_available?).to be false
end
end
end

</pre>

2.assign_topic_to_team
This method should assign the topic to a team. The below test case is to check if it assigns the topic properly.
</pre>
describe '#assign_topic_to_team' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'assigns the topic to the team and updates waitlist status' do
project_topic.assign_topic_to_team(new_sign_up)
expect(new_sign_up.is_waitlisted).to be false
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

3.save_waitlist_entry
This method should save a waitlist entry for a team.
</pre>
describe '#save_waitlist_entry' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'adds a new sign-up to the waitlist' do
project_topic.save_waitlist_entry(new_sign_up)
expect(new_sign_up.is_waitlisted).to be true
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

4.sign_up_team
This method should sign a team up for a project. The below code as test cases for when a slot is available, when no slots are available and when the team is already signed up for the topic and not waitlisted
</pre>
describe '#sign_up_team' do
let(:new_team) { Team.create!(assignment_id: assignment.id) }
context 'when slot is available' do
it 'assigns the topic to the team and drops team waitlists' do
allow(SignedUpTeam).to receive(:drop_off_team_waitlists).with(new_team.id).and_return(true)
expect(project_topic.sign_up_team(new_team.id)).to be true
expect(SignedUpTeam).to have_received(:drop_off_team_waitlists).with(new_team.id)
end
end
context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'adds the team to the waitlist' do
expect { project_topic.sign_up_team(new_team.id) }.to change { SignedUpTeam.count }.by(1)
expect(SignedUpTeam.last.is_waitlisted).to be true
end
end
context 'when the team is already signed up and not waitlisted' do
before do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team, is_waitlisted: false)
end
it 'returns false' do
expect(project_topic.sign_up_team(team.id)).to be false
end
end
end
</pre>

5.longest_waiting_team
</pre>
describe '#longest_waiting_team' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'returns the team that has been waitlisted the longest' do
expect(project_topic.longest_waiting_team).to eq(waitlisted_team)
end
end

6.drop_team_from_topic
describe '#drop_team_from_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team) }
it 'removes the team from the topic' do
expect { project_topic.drop_team_from_topic(team.id) }.to change { SignedUpTeam.count }.by(-1)
end
context 'when the team is not waitlisted' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'assigns the topic to the next waitlisted team' do
project_topic.drop_team_from_topic(team.id)
expect(waitlisted_team.reload.is_waitlisted).to be false
end
end
end
</pre>

7.current_available_slots
</pre>
describe '#current_available_slots' do
context 'when no teams have signed up' do
it 'returns max_choosers as available slots' do
expect(project_topic.current_available_slots).to eq(project_topic.max_choosers)
end
end
context 'when some teams have signed up' do
before do
2.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'returns the remaining available slots' do
expect(project_topic.current_available_slots).to eq(1)
end
end
</pre>

'''spec/models/signed_up_team_spec.rb'''

1.get_team_id
</pre>
describe '.get_team_id' do
let!(:user) { User.create!(name: "Name", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id) }
let!(:teams_user) { TeamsUser.create!(team_id: team.id, user_id: user.id) }
it 'returns the correct team ID for the given user and assignment' do
expect(SignedUpTeam.get_team_id(user.id, assignment.id)).to eq(team.id)
end
it 'returns nil if the user is not associated with any team for the assignment' do
other_user = User.create!(name: "Name 2", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id)
expect(SignedUpTeam.get_team_id(other_user.id, assignment.id)).to be_nil
end
end
</pre>

2..drop_off_team_signup_records
</pre>
describe '.drop_off_team_signup_records' do
let!(:signup1) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team_id: team.id) }
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signup2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: true, team_id: team.id) }
it 'removes all sign-up records for the given team' do
expect { SignedUpTeam.drop_off_team_signup_records(team.id) }
.to change { SignedUpTeam.where(team_id: team.id).count }.by(-2)
end
end
</pre>

3.reassign_topic
</pre>
describe '#reassign_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, team_id: team.id) }
before do
allow(ProjectTopic).to receive(:find).with(project_topic.id).and_return(project_topic)
allow(project_topic).to receive(:drop_team_from_topic)
end
it 'reassigns the team to a new topic and marks them as not waitlisted' do
signed_up_team.reassign_topic(project_topic.id)
expect(signed_up_team.reload.is_waitlisted).to be_falsey
expect(project_topic).to have_received(:drop_team_from_topic).with(team_id: team.id)
end
</pre>

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125 Pull Request 125]

==Video==
*[https://youtube.com/watch?v=oRxrtW5v05A Video]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-04T05:00:28Z

Skanumu2:

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation of sign up topic as project topic in the Expertiza backend. Expertiza backend is being reimplemented to leverage recent updates in Ruby on Rails ecosystem. This project is part of those efforts.

==Problem Statement==
The following tasks were required for the reimplementation :
#Redesigning SignUpTopic as ProjectTopic: This involves reimplementing SignUpTopic class from the original expertiza repository as ProjectTopic within reimplementation-backend repository. This reimplementation should follow Rails best practices, use Ruby naming conventions, and adhere to the DRY principle to improve code maintainability and readability.
#Implementing Team Signup and Topic Drop Functionality: Adding methods to sign a team up for a topic and handling cases when a team drops a topic.
#Assignment Team Retrieval: Implementing a method to retrieve AssignmentTeams that are currently signed up for a specific topic, allowing for efficient tracking and management of team assignments.
#Slot Availability Management: Including methods for managing and retrieving the current number of available slots for a topic, updating as teams sign up or drop topics to reflect accurate availability.
#Writing tests for project topic model: RSpec tests have to be written for ProjectTopic Model.
#Writing Swagger UI tests for API endpoints: Swagger UI tests have to be written to test ProjectTopic and SignedUpTeam functionalities.

==Design Goal==
While reimplementing the SignUpTopic as ProjectTopic, the following design rules must be ensured:

* Maintain Functional Integrity: Validate the functionality of existing and new methods, incorporating any necessary improvements to meet updated requirements for managing topic signups, slot availability, and team assignments.

* Promote Loose Coupling and Tight Cohesion: Ensure that ProjectTopic and related classes, such as SignedUpTeam, are designed for optimal organization and maintainability, with clear separation of responsibilities to improve code quality and reduce dependencies.

* Apply the DRY Principle: Refactor any redundant code in the previous implementation, adhering to DRY principles by eliminating duplicated functionality from the Expertiza system and implementing reusable methods where possible.

* Ensure Robust Testing and Documentation: Validate the accuracy of existing test cases, updating them to reflect changes in ProjectTopic. Add comprehensive RSpec tests for new functionality, and perform Swagger UI testing on API endpoints to ensure complete coverage and reliability.

==Implementation==
Below are the methods implemented for the `project_topic` and `signed_up_team` classes. These methods handle slot availability, team sign-ups, waitlist management, topic reassignment, and data consistency. They ensure efficient topic allocation and seamless team management.
===app/models/project_topic.rb===

'''slot_available?''':

This method checks if there are any available slots for a team to sign up for the topic. This function is crucial for managing team assignments effectively without exceeding the maximum allowed capacity.

<pre>
def slot_available?
current_available_slots > 0
end
</pre>

---

'''assign_topic_to_team(new_sign_up)''':

This method assigns the current topic to a team by updating the provided sign-up record. It removes the team from the waitlist and associates the team with this topic. This ensures that the team's assignment is finalized and marked as active, not waitlisted. It is used in scenarios where a slot is available and the team can be directly assigned to the topic.

<pre>
def assign_topic_to_team(new_sign_up)
new_sign_up.update(is_waitlisted: false, sign_up_topic_id: self.id)
end
</pre>

---

'''save_waitlist_entry(new_sign_up)''':

This method adds a team to the waitlist for the current topic by marking the sign-up record as waitlisted and associating it with this topic. This function is invoked when no slots are available, ensuring the team is placed in the queue for future assignment. It maintains fairness and order in the sign-up process.

<pre>
def save_waitlist_entry(new_sign_up)
new_sign_up.update(is_waitlisted: true, sign_up_topic_id: self.id)
end
</pre>

---

'''sign_up_team(team_id)''':

This method handles the team sign-up process for the current topic. It first checks if the team is already signed up for the topic and ensures it is not waitlisted. If slots are available, the team is assigned to the topic directly. Otherwise, the team is added to the waitlist. This method is central to managing both immediate assignments and waitlisted entries.

<pre>
def sign_up_team(team_id)
topic_id = self.id

existing_sign_up = SignedUpTeam.find_by(sign_up_topic_id: topic_id, team_id: team_id)
return false if !existing_sign_up.nil? && !existing_sign_up.is_waitlisted

new_sign_up = SignedUpTeam.new(sign_up_topic_id: topic_id, team_id: team_id)

if slot_available?
assign_topic_to_team(new_sign_up)
result = SignedUpTeam.drop_off_team_waitlists(team_id)
else
result = save_waitlist_entry(new_sign_up)
end

result
end
</pre>

---

'''longest_waiting_team''':

This method retrieves the team that has been on the waitlist the longest for the current topic. It sorts the waitlisted entries by their creation time and returns the oldest entry. This is useful for assigning slots to teams in a fair and chronological manner as slots become available.

<pre>
def longest_waiting_team
SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: true).order(:created_at).first
end
</pre>

---

'''drop_team_from_topic(team_id)''':

This method removes a team from the current topic. If the removed team was not waitlisted, it reassigns the topic to the next waitlisted team, ensuring efficient utilization of available slots. The method then deletes the team's sign-up record, maintaining data consistency.

<pre>
def drop_team_from_topic(team_id)
signed_up_team = SignedUpTeam.find_by(team_id: team_id, sign_up_topic_id: self.id)
return nil unless signed_up_team

unless signed_up_team.is_waitlisted
next_waitlisted_team = longest_waiting_team
next_waitlisted_team&.reassign_topic(self.id)
end

signed_up_team.destroy
end
</pre>

---

'''signed_up_teams_for_topic''':

This method retrieves all teams that have signed up for the current topic, including both waitlisted and non-waitlisted teams. It provides an overview of the teams associated with a particular topic, aiding in administrative and reporting tasks.

<pre>
def signed_up_teams_for_topic
SignedUpTeam.where(sign_up_topic_id: self.id)
end
</pre>

---

'''current_available_slots''':

This method calculates the number of available slots for the topic by subtracting the count of non-waitlisted teams from the maximum allowed capacity. It ensures the integrity of slot management by providing real-time availability data, which is critical for the sign-up and waitlisting processes.

<pre>
def current_available_slots
teams_who_chose_the_topic = SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: false)
self.max_choosers.to_i - teams_who_chose_the_topic.size
end
</pre>

===app/models/signed_up_team.rb===

'''drop_off_team_waitlists(team_id)''':

This class method removes all waitlisted entries for a specific team. It deletes all sign-up records where the team is marked as waitlisted, ensuring the team is no longer on any waitlists.

<pre>
def self.drop_off_team_waitlists(team_id)
SignedUpTeam.where(team_id: team_id, is_waitlisted: true).destroy_all
end
</pre>

---

'''create_signed_up_team(topic_id, team_id)''':

This class method creates a sign-up record for a team by associating it with the specified topic. It retrieves the project topic by its ID and uses the `sign_up_team` method to handle the sign-up process.

<pre>
def self.create_signed_up_team(topic_id, team_id)
project_topic = ProjectTopic.find(topic_id)
project_topic.sign_up_team(team_id)
end
</pre>

---

'''get_team_id(user_id, assignment_id)''':

This class method retrieves the team ID associated with a specific user and assignment. It first identifies the teams the user belongs to and then filters the team linked to the given assignment, returning its ID.

<pre>
def self.get_team_id(user_id, assignment_id)
team_ids = TeamsUser.select('team_id').where(user_id: user_id)
team_id = Team.where(team_id: team_ids, assignment_id: assignment_id).first.team_id
team_id
end
</pre>

---

'''drop_off_team_signup_records(team_id)''':

This class method deletes all sign-up records for a given team. It removes every entry associated with the specified team, clearing all their topic associations.

<pre>
def self.drop_off_team_signup_records(team_id)
SignedUpTeam.where(team_id: team_id).destroy_all
end
</pre>

---

'''reassign_topic(topic_id)''':

This instance method reassigns a team to a new topic. It first removes the team from its current topic if they are assigned, then updates the team's waitlist status to indicate they are now assigned to the new topic.

<pre>
def reassign_topic(topic_id)
assigned_team = SignedUpTeam.where(team_id: self.team_id, is_waitlisted: false)

unless assigned_team.nil?
project_topic = ProjectTopic.find(topic_id)
project_topic.drop_team_from_topic(team_id: self.team_id)
end

self.update(is_waitlisted: false)
end
</pre>

==Testing==

'''spec/models/project_topic_spec.rb'''

1.slot_available?
<pre>
describe '#slot_available?' do
context 'when no teams have chosen the topic' do
it 'returns true' do
expect(project_topic.slot_available?).to be true
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns false' do
expect(project_topic.slot_available?).to be false
end
end
end

</pre>

2.assign_topic_to_team
</pre>
describe '#assign_topic_to_team' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'assigns the topic to the team and updates waitlist status' do
project_topic.assign_topic_to_team(new_sign_up)
expect(new_sign_up.is_waitlisted).to be false
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

3.save_waitlist_entry
</pre>
describe '#save_waitlist_entry' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'adds a new sign-up to the waitlist' do
project_topic.save_waitlist_entry(new_sign_up)
expect(new_sign_up.is_waitlisted).to be true
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

4.sign_up_team
</pre>
describe '#sign_up_team' do
let(:new_team) { Team.create!(assignment_id: assignment.id) }
context 'when slot is available' do
it 'assigns the topic to the team and drops team waitlists' do
allow(SignedUpTeam).to receive(:drop_off_team_waitlists).with(new_team.id).and_return(true)
expect(project_topic.sign_up_team(new_team.id)).to be true
expect(SignedUpTeam).to have_received(:drop_off_team_waitlists).with(new_team.id)
end
end
context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'adds the team to the waitlist' do
expect { project_topic.sign_up_team(new_team.id) }.to change { SignedUpTeam.count }.by(1)
expect(SignedUpTeam.last.is_waitlisted).to be true
end
end
context 'when the team is already signed up and not waitlisted' do
before do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team, is_waitlisted: false)
end
it 'returns false' do
expect(project_topic.sign_up_team(team.id)).to be false
end
end
end
</pre>

5.longest_waiting_team
</pre>
describe '#longest_waiting_team' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'returns the team that has been waitlisted the longest' do
expect(project_topic.longest_waiting_team).to eq(waitlisted_team)
end
end

6.drop_team_from_topic
describe '#drop_team_from_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team) }
it 'removes the team from the topic' do
expect { project_topic.drop_team_from_topic(team.id) }.to change { SignedUpTeam.count }.by(-1)
end
context 'when the team is not waitlisted' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'assigns the topic to the next waitlisted team' do
project_topic.drop_team_from_topic(team.id)
expect(waitlisted_team.reload.is_waitlisted).to be false
end
end
end
</pre>

7.current_available_slots
</pre>
describe '#current_available_slots' do
context 'when no teams have signed up' do
it 'returns max_choosers as available slots' do
expect(project_topic.current_available_slots).to eq(project_topic.max_choosers)
end
end
context 'when some teams have signed up' do
before do
2.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'returns the remaining available slots' do
expect(project_topic.current_available_slots).to eq(1)
end
end
</pre>

'''spec/models/signed_up_team_spec.rb'''

1.get_team_id
</pre>
describe '.get_team_id' do
let!(:user) { User.create!(name: "Name", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id) }
let!(:teams_user) { TeamsUser.create!(team_id: team.id, user_id: user.id) }
it 'returns the correct team ID for the given user and assignment' do
expect(SignedUpTeam.get_team_id(user.id, assignment.id)).to eq(team.id)
end
it 'returns nil if the user is not associated with any team for the assignment' do
other_user = User.create!(name: "Name 2", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id)
expect(SignedUpTeam.get_team_id(other_user.id, assignment.id)).to be_nil
end
end
</pre>

2..drop_off_team_signup_records
</pre>
describe '.drop_off_team_signup_records' do
let!(:signup1) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team_id: team.id) }
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signup2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: true, team_id: team.id) }
it 'removes all sign-up records for the given team' do
expect { SignedUpTeam.drop_off_team_signup_records(team.id) }
.to change { SignedUpTeam.where(team_id: team.id).count }.by(-2)
end
end
</pre>

3.reassign_topic
</pre>
describe '#reassign_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, team_id: team.id) }
before do
allow(ProjectTopic).to receive(:find).with(project_topic.id).and_return(project_topic)
allow(project_topic).to receive(:drop_team_from_topic)
end
it 'reassigns the team to a new topic and marks them as not waitlisted' do
signed_up_team.reassign_topic(project_topic.id)
expect(signed_up_team.reload.is_waitlisted).to be_falsey
expect(project_topic).to have_received(:drop_team_from_topic).with(team_id: team.id)
end
</pre>

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125 Pull Request 125]

==Video==
*[https://youtube.com/watch?v=oRxrtW5v05A Video]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-04T04:59:40Z

Skanumu2: /* signed_up_team */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation of sign up topic as project topic in the Expertiza backend. Expertiza backend is being reimplemented to leverage recent updates in Ruby on Rails ecosystem. This project is part of those efforts.

==Problem Statement==
The following tasks were required for the reimplementation :
#Redesigning SignUpTopic as ProjectTopic: This involves reimplementing SignUpTopic class from the original expertiza repository as ProjectTopic within reimplementation-backend repository. This reimplementation should follow Rails best practices, use Ruby naming conventions, and adhere to the DRY principle to improve code maintainability and readability.
#Implementing Team Signup and Topic Drop Functionality: Adding methods to sign a team up for a topic and handling cases when a team drops a topic.
#Assignment Team Retrieval: Implementing a method to retrieve AssignmentTeams that are currently signed up for a specific topic, allowing for efficient tracking and management of team assignments.
#Slot Availability Management: Including methods for managing and retrieving the current number of available slots for a topic, updating as teams sign up or drop topics to reflect accurate availability.
#Writing tests for project topic model: RSpec tests have to be written for ProjectTopic Model.
#Writing Swagger UI tests for API endpoints: Swagger UI tests have to be written to test ProjectTopic and SignedUpTeam functionalities.

==Design Goal==
While reimplementing the SignUpTopic as ProjectTopic, the following design rules must be ensured:

* Maintain Functional Integrity: Validate the functionality of existing and new methods, incorporating any necessary improvements to meet updated requirements for managing topic signups, slot availability, and team assignments.

* Promote Loose Coupling and Tight Cohesion: Ensure that ProjectTopic and related classes, such as SignedUpTeam, are designed for optimal organization and maintainability, with clear separation of responsibilities to improve code quality and reduce dependencies.

* Apply the DRY Principle: Refactor any redundant code in the previous implementation, adhering to DRY principles by eliminating duplicated functionality from the Expertiza system and implementing reusable methods where possible.

* Ensure Robust Testing and Documentation: Validate the accuracy of existing test cases, updating them to reflect changes in ProjectTopic. Add comprehensive RSpec tests for new functionality, and perform Swagger UI testing on API endpoints to ensure complete coverage and reliability.

==Implementation==
Below are the methods implemented for the `project_topic` and `signed_up_team` classes. These methods handle slot availability, team sign-ups, waitlist management, topic reassignment, and data consistency. They ensure efficient topic allocation and seamless team management.
===app/models/project_topic.rb===

'''slot_available?''':

This method checks if there are any available slots for a team to sign up for the topic. This function is crucial for managing team assignments effectively without exceeding the maximum allowed capacity.

<pre>
def slot_available?
current_available_slots > 0
end
</pre>

---

'''assign_topic_to_team(new_sign_up)''':

This method assigns the current topic to a team by updating the provided sign-up record. It removes the team from the waitlist and associates the team with this topic. This ensures that the team's assignment is finalized and marked as active, not waitlisted. It is used in scenarios where a slot is available and the team can be directly assigned to the topic.

<pre>
def assign_topic_to_team(new_sign_up)
new_sign_up.update(is_waitlisted: false, sign_up_topic_id: self.id)
end
</pre>

---

'''save_waitlist_entry(new_sign_up)''':

This method adds a team to the waitlist for the current topic by marking the sign-up record as waitlisted and associating it with this topic. This function is invoked when no slots are available, ensuring the team is placed in the queue for future assignment. It maintains fairness and order in the sign-up process.

<pre>
def save_waitlist_entry(new_sign_up)
new_sign_up.update(is_waitlisted: true, sign_up_topic_id: self.id)
end
</pre>

---

'''sign_up_team(team_id)''':

This method handles the team sign-up process for the current topic. It first checks if the team is already signed up for the topic and ensures it is not waitlisted. If slots are available, the team is assigned to the topic directly. Otherwise, the team is added to the waitlist. This method is central to managing both immediate assignments and waitlisted entries.

<pre>
def sign_up_team(team_id)
topic_id = self.id

existing_sign_up = SignedUpTeam.find_by(sign_up_topic_id: topic_id, team_id: team_id)
return false if !existing_sign_up.nil? && !existing_sign_up.is_waitlisted

new_sign_up = SignedUpTeam.new(sign_up_topic_id: topic_id, team_id: team_id)

if slot_available?
assign_topic_to_team(new_sign_up)
result = SignedUpTeam.drop_off_team_waitlists(team_id)
else
result = save_waitlist_entry(new_sign_up)
end

result
end
</pre>

---

'''longest_waiting_team''':

This method retrieves the team that has been on the waitlist the longest for the current topic. It sorts the waitlisted entries by their creation time and returns the oldest entry. This is useful for assigning slots to teams in a fair and chronological manner as slots become available.

<pre>
def longest_waiting_team
SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: true).order(:created_at).first
end
</pre>

---

'''drop_team_from_topic(team_id)''':

This method removes a team from the current topic. If the removed team was not waitlisted, it reassigns the topic to the next waitlisted team, ensuring efficient utilization of available slots. The method then deletes the team's sign-up record, maintaining data consistency.

<pre>
def drop_team_from_topic(team_id)
signed_up_team = SignedUpTeam.find_by(team_id: team_id, sign_up_topic_id: self.id)
return nil unless signed_up_team

unless signed_up_team.is_waitlisted
next_waitlisted_team = longest_waiting_team
next_waitlisted_team&.reassign_topic(self.id)
end

signed_up_team.destroy
end
</pre>

---

'''signed_up_teams_for_topic''':

This method retrieves all teams that have signed up for the current topic, including both waitlisted and non-waitlisted teams. It provides an overview of the teams associated with a particular topic, aiding in administrative and reporting tasks.

<pre>
def signed_up_teams_for_topic
SignedUpTeam.where(sign_up_topic_id: self.id)
end
</pre>

---

'''current_available_slots''':

This method calculates the number of available slots for the topic by subtracting the count of non-waitlisted teams from the maximum allowed capacity. It ensures the integrity of slot management by providing real-time availability data, which is critical for the sign-up and waitlisting processes.

<pre>
def current_available_slots
teams_who_chose_the_topic = SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: false)
self.max_choosers.to_i - teams_who_chose_the_topic.size
end
</pre>

===app/models/signed_up_team.rb===

'''drop_off_team_waitlists(team_id)''':

This class method removes all waitlisted entries for a specific team. It deletes all sign-up records where the team is marked as waitlisted, ensuring the team is no longer on any waitlists.

<pre>
def self.drop_off_team_waitlists(team_id)
SignedUpTeam.where(team_id: team_id, is_waitlisted: true).destroy_all
end
</pre>

---

'''create_signed_up_team(topic_id, team_id)''':

This class method creates a sign-up record for a team by associating it with the specified topic. It retrieves the project topic by its ID and uses the `sign_up_team` method to handle the sign-up process.

<pre>
def self.create_signed_up_team(topic_id, team_id)
project_topic = ProjectTopic.find(topic_id)
project_topic.sign_up_team(team_id)
end
</pre>

---

'''get_team_id(user_id, assignment_id)''':

This class method retrieves the team ID associated with a specific user and assignment. It first identifies the teams the user belongs to and then filters the team linked to the given assignment, returning its ID.

<pre>
def self.get_team_id(user_id, assignment_id)
team_ids = TeamsUser.select('team_id').where(user_id: user_id)
team_id = Team.where(team_id: team_ids, assignment_id: assignment_id).first.team_id
team_id
end
</pre>

---

'''drop_off_team_signup_records(team_id)''':

This class method deletes all sign-up records for a given team. It removes every entry associated with the specified team, clearing all their topic associations.

<pre>
def self.drop_off_team_signup_records(team_id)
SignedUpTeam.where(team_id: team_id).destroy_all
end
</pre>

---

'''reassign_topic(topic_id)''':

This instance method reassigns a team to a new topic. It first removes the team from its current topic if they are assigned, then updates the team's waitlist status to indicate they are now assigned to the new topic.

<pre>
def reassign_topic(topic_id)
assigned_team = SignedUpTeam.where(team_id: self.team_id, is_waitlisted: false)

unless assigned_team.nil?
project_topic = ProjectTopic.find(topic_id)
project_topic.drop_team_from_topic(team_id: self.team_id)
end

self.update(is_waitlisted: false)
end
</pre>

==Testing==

'''spec/models/project_topic_spec.rb'''

1.slot_available?
<pre>
describe '#slot_available?' do
context 'when no teams have chosen the topic' do
it 'returns true' do
expect(project_topic.slot_available?).to be true
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns false' do
expect(project_topic.slot_available?).to be false
end
end
end

</pre>

2.assign_topic_to_team
</pre>
describe '#assign_topic_to_team' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'assigns the topic to the team and updates waitlist status' do
project_topic.assign_topic_to_team(new_sign_up)
expect(new_sign_up.is_waitlisted).to be false
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

3.save_waitlist_entry
</pre>
describe '#save_waitlist_entry' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'adds a new sign-up to the waitlist' do
project_topic.save_waitlist_entry(new_sign_up)
expect(new_sign_up.is_waitlisted).to be true
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

4.sign_up_team
</pre>
describe '#sign_up_team' do
let(:new_team) { Team.create!(assignment_id: assignment.id) }
context 'when slot is available' do
it 'assigns the topic to the team and drops team waitlists' do
allow(SignedUpTeam).to receive(:drop_off_team_waitlists).with(new_team.id).and_return(true)
expect(project_topic.sign_up_team(new_team.id)).to be true
expect(SignedUpTeam).to have_received(:drop_off_team_waitlists).with(new_team.id)
end
end
context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'adds the team to the waitlist' do
expect { project_topic.sign_up_team(new_team.id) }.to change { SignedUpTeam.count }.by(1)
expect(SignedUpTeam.last.is_waitlisted).to be true
end
end
context 'when the team is already signed up and not waitlisted' do
before do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team, is_waitlisted: false)
end
it 'returns false' do
expect(project_topic.sign_up_team(team.id)).to be false
end
end
end
</pre>

5.longest_waiting_team
</pre>
describe '#longest_waiting_team' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'returns the team that has been waitlisted the longest' do
expect(project_topic.longest_waiting_team).to eq(waitlisted_team)
end
end

6.drop_team_from_topic
describe '#drop_team_from_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team) }
it 'removes the team from the topic' do
expect { project_topic.drop_team_from_topic(team.id) }.to change { SignedUpTeam.count }.by(-1)
end
context 'when the team is not waitlisted' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'assigns the topic to the next waitlisted team' do
project_topic.drop_team_from_topic(team.id)
expect(waitlisted_team.reload.is_waitlisted).to be false
end
end
end
</pre>

7.current_available_slots
</pre>
describe '#current_available_slots' do
context 'when no teams have signed up' do
it 'returns max_choosers as available slots' do
expect(project_topic.current_available_slots).to eq(project_topic.max_choosers)
end
end
context 'when some teams have signed up' do
before do
2.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'returns the remaining available slots' do
expect(project_topic.current_available_slots).to eq(1)
end
end
</pre>

'''spec/models/signed_up_team_spec.rb'''

1.get_team_id
</pre>
describe '.get_team_id' do
let!(:user) { User.create!(name: "Name", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id) }
let!(:teams_user) { TeamsUser.create!(team_id: team.id, user_id: user.id) }
it 'returns the correct team ID for the given user and assignment' do
expect(SignedUpTeam.get_team_id(user.id, assignment.id)).to eq(team.id)
end
it 'returns nil if the user is not associated with any team for the assignment' do
other_user = User.create!(name: "Name 2", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id)
expect(SignedUpTeam.get_team_id(other_user.id, assignment.id)).to be_nil
end
end
</pre>

2..drop_off_team_signup_records
</pre>
describe '.drop_off_team_signup_records' do
let!(:signup1) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team_id: team.id) }
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signup2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: true, team_id: team.id) }
it 'removes all sign-up records for the given team' do
expect { SignedUpTeam.drop_off_team_signup_records(team.id) }
.to change { SignedUpTeam.where(team_id: team.id).count }.by(-2)
end
end
</pre>

3.reassign_topic
</pre>
describe '#reassign_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, team_id: team.id) }
before do
allow(ProjectTopic).to receive(:find).with(project_topic.id).and_return(project_topic)
allow(project_topic).to receive(:drop_team_from_topic)
end
it 'reassigns the team to a new topic and marks them as not waitlisted' do
signed_up_team.reassign_topic(project_topic.id)
expect(signed_up_team.reload.is_waitlisted).to be_falsey
expect(project_topic).to have_received(:drop_team_from_topic).with(team_id: team.id)
end
</pre>

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125 Pull Request 125]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-04T04:59:19Z

Skanumu2: /* project_topics */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation of sign up topic as project topic in the Expertiza backend. Expertiza backend is being reimplemented to leverage recent updates in Ruby on Rails ecosystem. This project is part of those efforts.

==Problem Statement==
The following tasks were required for the reimplementation :
#Redesigning SignUpTopic as ProjectTopic: This involves reimplementing SignUpTopic class from the original expertiza repository as ProjectTopic within reimplementation-backend repository. This reimplementation should follow Rails best practices, use Ruby naming conventions, and adhere to the DRY principle to improve code maintainability and readability.
#Implementing Team Signup and Topic Drop Functionality: Adding methods to sign a team up for a topic and handling cases when a team drops a topic.
#Assignment Team Retrieval: Implementing a method to retrieve AssignmentTeams that are currently signed up for a specific topic, allowing for efficient tracking and management of team assignments.
#Slot Availability Management: Including methods for managing and retrieving the current number of available slots for a topic, updating as teams sign up or drop topics to reflect accurate availability.
#Writing tests for project topic model: RSpec tests have to be written for ProjectTopic Model.
#Writing Swagger UI tests for API endpoints: Swagger UI tests have to be written to test ProjectTopic and SignedUpTeam functionalities.

==Design Goal==
While reimplementing the SignUpTopic as ProjectTopic, the following design rules must be ensured:

* Maintain Functional Integrity: Validate the functionality of existing and new methods, incorporating any necessary improvements to meet updated requirements for managing topic signups, slot availability, and team assignments.

* Promote Loose Coupling and Tight Cohesion: Ensure that ProjectTopic and related classes, such as SignedUpTeam, are designed for optimal organization and maintainability, with clear separation of responsibilities to improve code quality and reduce dependencies.

* Apply the DRY Principle: Refactor any redundant code in the previous implementation, adhering to DRY principles by eliminating duplicated functionality from the Expertiza system and implementing reusable methods where possible.

* Ensure Robust Testing and Documentation: Validate the accuracy of existing test cases, updating them to reflect changes in ProjectTopic. Add comprehensive RSpec tests for new functionality, and perform Swagger UI testing on API endpoints to ensure complete coverage and reliability.

==Implementation==
Below are the methods implemented for the `project_topic` and `signed_up_team` classes. These methods handle slot availability, team sign-ups, waitlist management, topic reassignment, and data consistency. They ensure efficient topic allocation and seamless team management.
===app/models/project_topic.rb===

'''slot_available?''':

This method checks if there are any available slots for a team to sign up for the topic. This function is crucial for managing team assignments effectively without exceeding the maximum allowed capacity.

<pre>
def slot_available?
current_available_slots > 0
end
</pre>

---

'''assign_topic_to_team(new_sign_up)''':

This method assigns the current topic to a team by updating the provided sign-up record. It removes the team from the waitlist and associates the team with this topic. This ensures that the team's assignment is finalized and marked as active, not waitlisted. It is used in scenarios where a slot is available and the team can be directly assigned to the topic.

<pre>
def assign_topic_to_team(new_sign_up)
new_sign_up.update(is_waitlisted: false, sign_up_topic_id: self.id)
end
</pre>

---

'''save_waitlist_entry(new_sign_up)''':

This method adds a team to the waitlist for the current topic by marking the sign-up record as waitlisted and associating it with this topic. This function is invoked when no slots are available, ensuring the team is placed in the queue for future assignment. It maintains fairness and order in the sign-up process.

<pre>
def save_waitlist_entry(new_sign_up)
new_sign_up.update(is_waitlisted: true, sign_up_topic_id: self.id)
end
</pre>

---

'''sign_up_team(team_id)''':

This method handles the team sign-up process for the current topic. It first checks if the team is already signed up for the topic and ensures it is not waitlisted. If slots are available, the team is assigned to the topic directly. Otherwise, the team is added to the waitlist. This method is central to managing both immediate assignments and waitlisted entries.

<pre>
def sign_up_team(team_id)
topic_id = self.id

existing_sign_up = SignedUpTeam.find_by(sign_up_topic_id: topic_id, team_id: team_id)
return false if !existing_sign_up.nil? && !existing_sign_up.is_waitlisted

new_sign_up = SignedUpTeam.new(sign_up_topic_id: topic_id, team_id: team_id)

if slot_available?
assign_topic_to_team(new_sign_up)
result = SignedUpTeam.drop_off_team_waitlists(team_id)
else
result = save_waitlist_entry(new_sign_up)
end

result
end
</pre>

---

'''longest_waiting_team''':

This method retrieves the team that has been on the waitlist the longest for the current topic. It sorts the waitlisted entries by their creation time and returns the oldest entry. This is useful for assigning slots to teams in a fair and chronological manner as slots become available.

<pre>
def longest_waiting_team
SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: true).order(:created_at).first
end
</pre>

---

'''drop_team_from_topic(team_id)''':

This method removes a team from the current topic. If the removed team was not waitlisted, it reassigns the topic to the next waitlisted team, ensuring efficient utilization of available slots. The method then deletes the team's sign-up record, maintaining data consistency.

<pre>
def drop_team_from_topic(team_id)
signed_up_team = SignedUpTeam.find_by(team_id: team_id, sign_up_topic_id: self.id)
return nil unless signed_up_team

unless signed_up_team.is_waitlisted
next_waitlisted_team = longest_waiting_team
next_waitlisted_team&.reassign_topic(self.id)
end

signed_up_team.destroy
end
</pre>

---

'''signed_up_teams_for_topic''':

This method retrieves all teams that have signed up for the current topic, including both waitlisted and non-waitlisted teams. It provides an overview of the teams associated with a particular topic, aiding in administrative and reporting tasks.

<pre>
def signed_up_teams_for_topic
SignedUpTeam.where(sign_up_topic_id: self.id)
end
</pre>

---

'''current_available_slots''':

This method calculates the number of available slots for the topic by subtracting the count of non-waitlisted teams from the maximum allowed capacity. It ensures the integrity of slot management by providing real-time availability data, which is critical for the sign-up and waitlisting processes.

<pre>
def current_available_slots
teams_who_chose_the_topic = SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: false)
self.max_choosers.to_i - teams_who_chose_the_topic.size
end
</pre>

===signed_up_team===

'''drop_off_team_waitlists(team_id)''':

This class method removes all waitlisted entries for a specific team. It deletes all sign-up records where the team is marked as waitlisted, ensuring the team is no longer on any waitlists.

<pre>
def self.drop_off_team_waitlists(team_id)
SignedUpTeam.where(team_id: team_id, is_waitlisted: true).destroy_all
end
</pre>

---

'''create_signed_up_team(topic_id, team_id)''':

This class method creates a sign-up record for a team by associating it with the specified topic. It retrieves the project topic by its ID and uses the `sign_up_team` method to handle the sign-up process.

<pre>
def self.create_signed_up_team(topic_id, team_id)
project_topic = ProjectTopic.find(topic_id)
project_topic.sign_up_team(team_id)
end
</pre>

---

'''get_team_id(user_id, assignment_id)''':

This class method retrieves the team ID associated with a specific user and assignment. It first identifies the teams the user belongs to and then filters the team linked to the given assignment, returning its ID.

<pre>
def self.get_team_id(user_id, assignment_id)
team_ids = TeamsUser.select('team_id').where(user_id: user_id)
team_id = Team.where(team_id: team_ids, assignment_id: assignment_id).first.team_id
team_id
end
</pre>

---

'''drop_off_team_signup_records(team_id)''':

This class method deletes all sign-up records for a given team. It removes every entry associated with the specified team, clearing all their topic associations.

<pre>
def self.drop_off_team_signup_records(team_id)
SignedUpTeam.where(team_id: team_id).destroy_all
end
</pre>

---

'''reassign_topic(topic_id)''':

This instance method reassigns a team to a new topic. It first removes the team from its current topic if they are assigned, then updates the team's waitlist status to indicate they are now assigned to the new topic.

<pre>
def reassign_topic(topic_id)
assigned_team = SignedUpTeam.where(team_id: self.team_id, is_waitlisted: false)

unless assigned_team.nil?
project_topic = ProjectTopic.find(topic_id)
project_topic.drop_team_from_topic(team_id: self.team_id)
end

self.update(is_waitlisted: false)
end
</pre>

==Testing==

'''spec/models/project_topic_spec.rb'''

1.slot_available?
<pre>
describe '#slot_available?' do
context 'when no teams have chosen the topic' do
it 'returns true' do
expect(project_topic.slot_available?).to be true
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns false' do
expect(project_topic.slot_available?).to be false
end
end
end

</pre>

2.assign_topic_to_team
</pre>
describe '#assign_topic_to_team' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'assigns the topic to the team and updates waitlist status' do
project_topic.assign_topic_to_team(new_sign_up)
expect(new_sign_up.is_waitlisted).to be false
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

3.save_waitlist_entry
</pre>
describe '#save_waitlist_entry' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'adds a new sign-up to the waitlist' do
project_topic.save_waitlist_entry(new_sign_up)
expect(new_sign_up.is_waitlisted).to be true
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

4.sign_up_team
</pre>
describe '#sign_up_team' do
let(:new_team) { Team.create!(assignment_id: assignment.id) }
context 'when slot is available' do
it 'assigns the topic to the team and drops team waitlists' do
allow(SignedUpTeam).to receive(:drop_off_team_waitlists).with(new_team.id).and_return(true)
expect(project_topic.sign_up_team(new_team.id)).to be true
expect(SignedUpTeam).to have_received(:drop_off_team_waitlists).with(new_team.id)
end
end
context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'adds the team to the waitlist' do
expect { project_topic.sign_up_team(new_team.id) }.to change { SignedUpTeam.count }.by(1)
expect(SignedUpTeam.last.is_waitlisted).to be true
end
end
context 'when the team is already signed up and not waitlisted' do
before do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team, is_waitlisted: false)
end
it 'returns false' do
expect(project_topic.sign_up_team(team.id)).to be false
end
end
end
</pre>

5.longest_waiting_team
</pre>
describe '#longest_waiting_team' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'returns the team that has been waitlisted the longest' do
expect(project_topic.longest_waiting_team).to eq(waitlisted_team)
end
end

6.drop_team_from_topic
describe '#drop_team_from_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team) }
it 'removes the team from the topic' do
expect { project_topic.drop_team_from_topic(team.id) }.to change { SignedUpTeam.count }.by(-1)
end
context 'when the team is not waitlisted' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'assigns the topic to the next waitlisted team' do
project_topic.drop_team_from_topic(team.id)
expect(waitlisted_team.reload.is_waitlisted).to be false
end
end
end
</pre>

7.current_available_slots
</pre>
describe '#current_available_slots' do
context 'when no teams have signed up' do
it 'returns max_choosers as available slots' do
expect(project_topic.current_available_slots).to eq(project_topic.max_choosers)
end
end
context 'when some teams have signed up' do
before do
2.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'returns the remaining available slots' do
expect(project_topic.current_available_slots).to eq(1)
end
end
</pre>

'''spec/models/signed_up_team_spec.rb'''

1.get_team_id
</pre>
describe '.get_team_id' do
let!(:user) { User.create!(name: "Name", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id) }
let!(:teams_user) { TeamsUser.create!(team_id: team.id, user_id: user.id) }
it 'returns the correct team ID for the given user and assignment' do
expect(SignedUpTeam.get_team_id(user.id, assignment.id)).to eq(team.id)
end
it 'returns nil if the user is not associated with any team for the assignment' do
other_user = User.create!(name: "Name 2", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id)
expect(SignedUpTeam.get_team_id(other_user.id, assignment.id)).to be_nil
end
end
</pre>

2..drop_off_team_signup_records
</pre>
describe '.drop_off_team_signup_records' do
let!(:signup1) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team_id: team.id) }
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signup2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: true, team_id: team.id) }
it 'removes all sign-up records for the given team' do
expect { SignedUpTeam.drop_off_team_signup_records(team.id) }
.to change { SignedUpTeam.where(team_id: team.id).count }.by(-2)
end
end
</pre>

3.reassign_topic
</pre>
describe '#reassign_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, team_id: team.id) }
before do
allow(ProjectTopic).to receive(:find).with(project_topic.id).and_return(project_topic)
allow(project_topic).to receive(:drop_team_from_topic)
end
it 'reassigns the team to a new topic and marks them as not waitlisted' do
signed_up_team.reassign_topic(project_topic.id)
expect(signed_up_team.reload.is_waitlisted).to be_falsey
expect(project_topic).to have_received(:drop_team_from_topic).with(team_id: team.id)
end
</pre>

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125 Pull Request 125]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-04T04:56:30Z

Skanumu2: /* Introduction */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation of sign up topic as project topic in the Expertiza backend. Expertiza backend is being reimplemented to leverage recent updates in Ruby on Rails ecosystem. This project is part of those efforts.

==Problem Statement==
The following tasks were required for the reimplementation :
#Redesigning SignUpTopic as ProjectTopic: This involves reimplementing SignUpTopic class from the original expertiza repository as ProjectTopic within reimplementation-backend repository. This reimplementation should follow Rails best practices, use Ruby naming conventions, and adhere to the DRY principle to improve code maintainability and readability.
#Implementing Team Signup and Topic Drop Functionality: Adding methods to sign a team up for a topic and handling cases when a team drops a topic.
#Assignment Team Retrieval: Implementing a method to retrieve AssignmentTeams that are currently signed up for a specific topic, allowing for efficient tracking and management of team assignments.
#Slot Availability Management: Including methods for managing and retrieving the current number of available slots for a topic, updating as teams sign up or drop topics to reflect accurate availability.
#Writing tests for project topic model: RSpec tests have to be written for ProjectTopic Model.
#Writing Swagger UI tests for API endpoints: Swagger UI tests have to be written to test ProjectTopic and SignedUpTeam functionalities.

==Design Goal==
While reimplementing the SignUpTopic as ProjectTopic, the following design rules must be ensured:

* Maintain Functional Integrity: Validate the functionality of existing and new methods, incorporating any necessary improvements to meet updated requirements for managing topic signups, slot availability, and team assignments.

* Promote Loose Coupling and Tight Cohesion: Ensure that ProjectTopic and related classes, such as SignedUpTeam, are designed for optimal organization and maintainability, with clear separation of responsibilities to improve code quality and reduce dependencies.

* Apply the DRY Principle: Refactor any redundant code in the previous implementation, adhering to DRY principles by eliminating duplicated functionality from the Expertiza system and implementing reusable methods where possible.

* Ensure Robust Testing and Documentation: Validate the accuracy of existing test cases, updating them to reflect changes in ProjectTopic. Add comprehensive RSpec tests for new functionality, and perform Swagger UI testing on API endpoints to ensure complete coverage and reliability.

==Implementation==
Below are the methods implemented for the `project_topic` and `signed_up_team` classes. These methods handle slot availability, team sign-ups, waitlist management, topic reassignment, and data consistency. They ensure efficient topic allocation and seamless team management.
===project_topics ===

'''slot_available?''':

This method checks if there are any available slots for a team to sign up for the topic. This function is crucial for managing team assignments effectively without exceeding the maximum allowed capacity.

<pre>
def slot_available?
current_available_slots > 0
end
</pre>

---

'''assign_topic_to_team(new_sign_up)''':

This method assigns the current topic to a team by updating the provided sign-up record. It removes the team from the waitlist and associates the team with this topic. This ensures that the team's assignment is finalized and marked as active, not waitlisted. It is used in scenarios where a slot is available and the team can be directly assigned to the topic.

<pre>
def assign_topic_to_team(new_sign_up)
new_sign_up.update(is_waitlisted: false, sign_up_topic_id: self.id)
end
</pre>

---

'''save_waitlist_entry(new_sign_up)''':

This method adds a team to the waitlist for the current topic by marking the sign-up record as waitlisted and associating it with this topic. This function is invoked when no slots are available, ensuring the team is placed in the queue for future assignment. It maintains fairness and order in the sign-up process.

<pre>
def save_waitlist_entry(new_sign_up)
new_sign_up.update(is_waitlisted: true, sign_up_topic_id: self.id)
end
</pre>

---

'''sign_up_team(team_id)''':

This method handles the team sign-up process for the current topic. It first checks if the team is already signed up for the topic and ensures it is not waitlisted. If slots are available, the team is assigned to the topic directly. Otherwise, the team is added to the waitlist. This method is central to managing both immediate assignments and waitlisted entries.

<pre>
def sign_up_team(team_id)
topic_id = self.id

existing_sign_up = SignedUpTeam.find_by(sign_up_topic_id: topic_id, team_id: team_id)
return false if !existing_sign_up.nil? && !existing_sign_up.is_waitlisted

new_sign_up = SignedUpTeam.new(sign_up_topic_id: topic_id, team_id: team_id)

if slot_available?
assign_topic_to_team(new_sign_up)
result = SignedUpTeam.drop_off_team_waitlists(team_id)
else
result = save_waitlist_entry(new_sign_up)
end

result
end
</pre>

---

'''longest_waiting_team''':

This method retrieves the team that has been on the waitlist the longest for the current topic. It sorts the waitlisted entries by their creation time and returns the oldest entry. This is useful for assigning slots to teams in a fair and chronological manner as slots become available.

<pre>
def longest_waiting_team
SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: true).order(:created_at).first
end
</pre>

---

'''drop_team_from_topic(team_id)''':

This method removes a team from the current topic. If the removed team was not waitlisted, it reassigns the topic to the next waitlisted team, ensuring efficient utilization of available slots. The method then deletes the team's sign-up record, maintaining data consistency.

<pre>
def drop_team_from_topic(team_id)
signed_up_team = SignedUpTeam.find_by(team_id: team_id, sign_up_topic_id: self.id)
return nil unless signed_up_team

unless signed_up_team.is_waitlisted
next_waitlisted_team = longest_waiting_team
next_waitlisted_team&.reassign_topic(self.id)
end

signed_up_team.destroy
end
</pre>

---

'''signed_up_teams_for_topic''':

This method retrieves all teams that have signed up for the current topic, including both waitlisted and non-waitlisted teams. It provides an overview of the teams associated with a particular topic, aiding in administrative and reporting tasks.

<pre>
def signed_up_teams_for_topic
SignedUpTeam.where(sign_up_topic_id: self.id)
end
</pre>

---

'''current_available_slots''':

This method calculates the number of available slots for the topic by subtracting the count of non-waitlisted teams from the maximum allowed capacity. It ensures the integrity of slot management by providing real-time availability data, which is critical for the sign-up and waitlisting processes.

<pre>
def current_available_slots
teams_who_chose_the_topic = SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: false)
self.max_choosers.to_i - teams_who_chose_the_topic.size
end
</pre>

===signed_up_team===

'''drop_off_team_waitlists(team_id)''':

This class method removes all waitlisted entries for a specific team. It deletes all sign-up records where the team is marked as waitlisted, ensuring the team is no longer on any waitlists.

<pre>
def self.drop_off_team_waitlists(team_id)
SignedUpTeam.where(team_id: team_id, is_waitlisted: true).destroy_all
end
</pre>

---

'''create_signed_up_team(topic_id, team_id)''':

This class method creates a sign-up record for a team by associating it with the specified topic. It retrieves the project topic by its ID and uses the `sign_up_team` method to handle the sign-up process.

<pre>
def self.create_signed_up_team(topic_id, team_id)
project_topic = ProjectTopic.find(topic_id)
project_topic.sign_up_team(team_id)
end
</pre>

---

'''get_team_id(user_id, assignment_id)''':

This class method retrieves the team ID associated with a specific user and assignment. It first identifies the teams the user belongs to and then filters the team linked to the given assignment, returning its ID.

<pre>
def self.get_team_id(user_id, assignment_id)
team_ids = TeamsUser.select('team_id').where(user_id: user_id)
team_id = Team.where(team_id: team_ids, assignment_id: assignment_id).first.team_id
team_id
end
</pre>

---

'''drop_off_team_signup_records(team_id)''':

This class method deletes all sign-up records for a given team. It removes every entry associated with the specified team, clearing all their topic associations.

<pre>
def self.drop_off_team_signup_records(team_id)
SignedUpTeam.where(team_id: team_id).destroy_all
end
</pre>

---

'''reassign_topic(topic_id)''':

This instance method reassigns a team to a new topic. It first removes the team from its current topic if they are assigned, then updates the team's waitlist status to indicate they are now assigned to the new topic.

<pre>
def reassign_topic(topic_id)
assigned_team = SignedUpTeam.where(team_id: self.team_id, is_waitlisted: false)

unless assigned_team.nil?
project_topic = ProjectTopic.find(topic_id)
project_topic.drop_team_from_topic(team_id: self.team_id)
end

self.update(is_waitlisted: false)
end
</pre>

==Testing==

'''spec/models/project_topic_spec.rb'''

1.slot_available?
<pre>
describe '#slot_available?' do
context 'when no teams have chosen the topic' do
it 'returns true' do
expect(project_topic.slot_available?).to be true
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns false' do
expect(project_topic.slot_available?).to be false
end
end
end

</pre>

2.assign_topic_to_team
</pre>
describe '#assign_topic_to_team' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'assigns the topic to the team and updates waitlist status' do
project_topic.assign_topic_to_team(new_sign_up)
expect(new_sign_up.is_waitlisted).to be false
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

3.save_waitlist_entry
</pre>
describe '#save_waitlist_entry' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'adds a new sign-up to the waitlist' do
project_topic.save_waitlist_entry(new_sign_up)
expect(new_sign_up.is_waitlisted).to be true
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

4.sign_up_team
</pre>
describe '#sign_up_team' do
let(:new_team) { Team.create!(assignment_id: assignment.id) }
context 'when slot is available' do
it 'assigns the topic to the team and drops team waitlists' do
allow(SignedUpTeam).to receive(:drop_off_team_waitlists).with(new_team.id).and_return(true)
expect(project_topic.sign_up_team(new_team.id)).to be true
expect(SignedUpTeam).to have_received(:drop_off_team_waitlists).with(new_team.id)
end
end
context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'adds the team to the waitlist' do
expect { project_topic.sign_up_team(new_team.id) }.to change { SignedUpTeam.count }.by(1)
expect(SignedUpTeam.last.is_waitlisted).to be true
end
end
context 'when the team is already signed up and not waitlisted' do
before do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team, is_waitlisted: false)
end
it 'returns false' do
expect(project_topic.sign_up_team(team.id)).to be false
end
end
end
</pre>

5.longest_waiting_team
</pre>
describe '#longest_waiting_team' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'returns the team that has been waitlisted the longest' do
expect(project_topic.longest_waiting_team).to eq(waitlisted_team)
end
end

6.drop_team_from_topic
describe '#drop_team_from_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team) }
it 'removes the team from the topic' do
expect { project_topic.drop_team_from_topic(team.id) }.to change { SignedUpTeam.count }.by(-1)
end
context 'when the team is not waitlisted' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'assigns the topic to the next waitlisted team' do
project_topic.drop_team_from_topic(team.id)
expect(waitlisted_team.reload.is_waitlisted).to be false
end
end
end
</pre>

7.current_available_slots
</pre>
describe '#current_available_slots' do
context 'when no teams have signed up' do
it 'returns max_choosers as available slots' do
expect(project_topic.current_available_slots).to eq(project_topic.max_choosers)
end
end
context 'when some teams have signed up' do
before do
2.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'returns the remaining available slots' do
expect(project_topic.current_available_slots).to eq(1)
end
end
</pre>

'''spec/models/signed_up_team_spec.rb'''

1.get_team_id
</pre>
describe '.get_team_id' do
let!(:user) { User.create!(name: "Name", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id) }
let!(:teams_user) { TeamsUser.create!(team_id: team.id, user_id: user.id) }
it 'returns the correct team ID for the given user and assignment' do
expect(SignedUpTeam.get_team_id(user.id, assignment.id)).to eq(team.id)
end
it 'returns nil if the user is not associated with any team for the assignment' do
other_user = User.create!(name: "Name 2", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id)
expect(SignedUpTeam.get_team_id(other_user.id, assignment.id)).to be_nil
end
end
</pre>

2..drop_off_team_signup_records
</pre>
describe '.drop_off_team_signup_records' do
let!(:signup1) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team_id: team.id) }
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signup2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: true, team_id: team.id) }
it 'removes all sign-up records for the given team' do
expect { SignedUpTeam.drop_off_team_signup_records(team.id) }
.to change { SignedUpTeam.where(team_id: team.id).count }.by(-2)
end
end
</pre>

3.reassign_topic
</pre>
describe '#reassign_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, team_id: team.id) }
before do
allow(ProjectTopic).to receive(:find).with(project_topic.id).and_return(project_topic)
allow(project_topic).to receive(:drop_team_from_topic)
end
it 'reassigns the team to a new topic and marks them as not waitlisted' do
signed_up_team.reassign_topic(project_topic.id)
expect(signed_up_team.reload.is_waitlisted).to be_falsey
expect(project_topic).to have_received(:drop_team_from_topic).with(team_id: team.id)
end
</pre>

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125 Pull Request 125]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-04T04:30:54Z

Skanumu2: /* Testing */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation of sign up topic as project topic in the Expertiza backend.

==Problem Statement==
The following tasks were required for the reimplementation :
#Redesigning SignUpTopic as ProjectTopic: This involves reimplementing SignUpTopic class from the original expertiza repository as ProjectTopic within reimplementation-backend repository. This reimplementation should follow Rails best practices, use Ruby naming conventions, and adhere to the DRY principle to improve code maintainability and readability.
#Implementing Team Signup and Topic Drop Functionality: Adding methods to sign a team up for a topic and handling cases when a team drops a topic.
#Assignment Team Retrieval: Implementing a method to retrieve AssignmentTeams that are currently signed up for a specific topic, allowing for efficient tracking and management of team assignments.
#Slot Availability Management: Including methods for managing and retrieving the current number of available slots for a topic, updating as teams sign up or drop topics to reflect accurate availability.
#Writing tests for project topic model: RSpec tests have to be written for ProjectTopic Model.
#Writing Swagger UI tests for API endpoints: Swagger UI tests have to be written to test ProjectTopic and SignedUpTeam functionalities.

==Design Goal==
While reimplementing the SignUpTopic as ProjectTopic, the following design rules must be ensured:

* Maintain Functional Integrity: Validate the functionality of existing and new methods, incorporating any necessary improvements to meet updated requirements for managing topic signups, slot availability, and team assignments.

* Promote Loose Coupling and Tight Cohesion: Ensure that ProjectTopic and related classes, such as SignedUpTeam, are designed for optimal organization and maintainability, with clear separation of responsibilities to improve code quality and reduce dependencies.

* Apply the DRY Principle: Refactor any redundant code in the previous implementation, adhering to DRY principles by eliminating duplicated functionality from the Expertiza system and implementing reusable methods where possible.

* Ensure Robust Testing and Documentation: Validate the accuracy of existing test cases, updating them to reflect changes in ProjectTopic. Add comprehensive RSpec tests for new functionality, and perform Swagger UI testing on API endpoints to ensure complete coverage and reliability.

==Implementation==
Below are the methods implemented for the `project_topic` and `signed_up_team` classes. These methods handle slot availability, team sign-ups, waitlist management, topic reassignment, and data consistency. They ensure efficient topic allocation and seamless team management.
===project_topics ===

'''slot_available?''':

This method checks if there are any available slots for a team to sign up for the topic. This function is crucial for managing team assignments effectively without exceeding the maximum allowed capacity.

<pre>
def slot_available?
current_available_slots > 0
end
</pre>

---

'''assign_topic_to_team(new_sign_up)''':

This method assigns the current topic to a team by updating the provided sign-up record. It removes the team from the waitlist and associates the team with this topic. This ensures that the team's assignment is finalized and marked as active, not waitlisted. It is used in scenarios where a slot is available and the team can be directly assigned to the topic.

<pre>
def assign_topic_to_team(new_sign_up)
new_sign_up.update(is_waitlisted: false, sign_up_topic_id: self.id)
end
</pre>

---

'''save_waitlist_entry(new_sign_up)''':

This method adds a team to the waitlist for the current topic by marking the sign-up record as waitlisted and associating it with this topic. This function is invoked when no slots are available, ensuring the team is placed in the queue for future assignment. It maintains fairness and order in the sign-up process.

<pre>
def save_waitlist_entry(new_sign_up)
new_sign_up.update(is_waitlisted: true, sign_up_topic_id: self.id)
end
</pre>

---

'''sign_up_team(team_id)''':

This method handles the team sign-up process for the current topic. It first checks if the team is already signed up for the topic and ensures it is not waitlisted. If slots are available, the team is assigned to the topic directly. Otherwise, the team is added to the waitlist. This method is central to managing both immediate assignments and waitlisted entries.

<pre>
def sign_up_team(team_id)
topic_id = self.id

existing_sign_up = SignedUpTeam.find_by(sign_up_topic_id: topic_id, team_id: team_id)
return false if !existing_sign_up.nil? && !existing_sign_up.is_waitlisted

new_sign_up = SignedUpTeam.new(sign_up_topic_id: topic_id, team_id: team_id)

if slot_available?
assign_topic_to_team(new_sign_up)
result = SignedUpTeam.drop_off_team_waitlists(team_id)
else
result = save_waitlist_entry(new_sign_up)
end

result
end
</pre>

---

'''longest_waiting_team''':

This method retrieves the team that has been on the waitlist the longest for the current topic. It sorts the waitlisted entries by their creation time and returns the oldest entry. This is useful for assigning slots to teams in a fair and chronological manner as slots become available.

<pre>
def longest_waiting_team
SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: true).order(:created_at).first
end
</pre>

---

'''drop_team_from_topic(team_id)''':

This method removes a team from the current topic. If the removed team was not waitlisted, it reassigns the topic to the next waitlisted team, ensuring efficient utilization of available slots. The method then deletes the team's sign-up record, maintaining data consistency.

<pre>
def drop_team_from_topic(team_id)
signed_up_team = SignedUpTeam.find_by(team_id: team_id, sign_up_topic_id: self.id)
return nil unless signed_up_team

unless signed_up_team.is_waitlisted
next_waitlisted_team = longest_waiting_team
next_waitlisted_team&.reassign_topic(self.id)
end

signed_up_team.destroy
end
</pre>

---

'''signed_up_teams_for_topic''':

This method retrieves all teams that have signed up for the current topic, including both waitlisted and non-waitlisted teams. It provides an overview of the teams associated with a particular topic, aiding in administrative and reporting tasks.

<pre>
def signed_up_teams_for_topic
SignedUpTeam.where(sign_up_topic_id: self.id)
end
</pre>

---

'''current_available_slots''':

This method calculates the number of available slots for the topic by subtracting the count of non-waitlisted teams from the maximum allowed capacity. It ensures the integrity of slot management by providing real-time availability data, which is critical for the sign-up and waitlisting processes.

<pre>
def current_available_slots
teams_who_chose_the_topic = SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: false)
self.max_choosers.to_i - teams_who_chose_the_topic.size
end
</pre>

===signed_up_team===

'''drop_off_team_waitlists(team_id)''':

This class method removes all waitlisted entries for a specific team. It deletes all sign-up records where the team is marked as waitlisted, ensuring the team is no longer on any waitlists.

<pre>
def self.drop_off_team_waitlists(team_id)
SignedUpTeam.where(team_id: team_id, is_waitlisted: true).destroy_all
end
</pre>

---

'''create_signed_up_team(topic_id, team_id)''':

This class method creates a sign-up record for a team by associating it with the specified topic. It retrieves the project topic by its ID and uses the `sign_up_team` method to handle the sign-up process.

<pre>
def self.create_signed_up_team(topic_id, team_id)
project_topic = ProjectTopic.find(topic_id)
project_topic.sign_up_team(team_id)
end
</pre>

---

'''get_team_id(user_id, assignment_id)''':

This class method retrieves the team ID associated with a specific user and assignment. It first identifies the teams the user belongs to and then filters the team linked to the given assignment, returning its ID.

<pre>
def self.get_team_id(user_id, assignment_id)
team_ids = TeamsUser.select('team_id').where(user_id: user_id)
team_id = Team.where(team_id: team_ids, assignment_id: assignment_id).first.team_id
team_id
end
</pre>

---

'''drop_off_team_signup_records(team_id)''':

This class method deletes all sign-up records for a given team. It removes every entry associated with the specified team, clearing all their topic associations.

<pre>
def self.drop_off_team_signup_records(team_id)
SignedUpTeam.where(team_id: team_id).destroy_all
end
</pre>

---

'''reassign_topic(topic_id)''':

This instance method reassigns a team to a new topic. It first removes the team from its current topic if they are assigned, then updates the team's waitlist status to indicate they are now assigned to the new topic.

<pre>
def reassign_topic(topic_id)
assigned_team = SignedUpTeam.where(team_id: self.team_id, is_waitlisted: false)

unless assigned_team.nil?
project_topic = ProjectTopic.find(topic_id)
project_topic.drop_team_from_topic(team_id: self.team_id)
end

self.update(is_waitlisted: false)
end
</pre>

==Testing==

'''spec/models/project_topic_spec.rb'''

1.slot_available?
<pre>
describe '#slot_available?' do
context 'when no teams have chosen the topic' do
it 'returns true' do
expect(project_topic.slot_available?).to be true
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns false' do
expect(project_topic.slot_available?).to be false
end
end
end

</pre>

2.assign_topic_to_team
</pre>
describe '#assign_topic_to_team' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'assigns the topic to the team and updates waitlist status' do
project_topic.assign_topic_to_team(new_sign_up)
expect(new_sign_up.is_waitlisted).to be false
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

3.save_waitlist_entry
</pre>
describe '#save_waitlist_entry' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'adds a new sign-up to the waitlist' do
project_topic.save_waitlist_entry(new_sign_up)
expect(new_sign_up.is_waitlisted).to be true
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

4.sign_up_team
</pre>
describe '#sign_up_team' do
let(:new_team) { Team.create!(assignment_id: assignment.id) }
context 'when slot is available' do
it 'assigns the topic to the team and drops team waitlists' do
allow(SignedUpTeam).to receive(:drop_off_team_waitlists).with(new_team.id).and_return(true)
expect(project_topic.sign_up_team(new_team.id)).to be true
expect(SignedUpTeam).to have_received(:drop_off_team_waitlists).with(new_team.id)
end
end
context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'adds the team to the waitlist' do
expect { project_topic.sign_up_team(new_team.id) }.to change { SignedUpTeam.count }.by(1)
expect(SignedUpTeam.last.is_waitlisted).to be true
end
end
context 'when the team is already signed up and not waitlisted' do
before do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team, is_waitlisted: false)
end
it 'returns false' do
expect(project_topic.sign_up_team(team.id)).to be false
end
end
end
</pre>

5.longest_waiting_team
</pre>
describe '#longest_waiting_team' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'returns the team that has been waitlisted the longest' do
expect(project_topic.longest_waiting_team).to eq(waitlisted_team)
end
end

6.drop_team_from_topic
describe '#drop_team_from_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team) }
it 'removes the team from the topic' do
expect { project_topic.drop_team_from_topic(team.id) }.to change { SignedUpTeam.count }.by(-1)
end
context 'when the team is not waitlisted' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'assigns the topic to the next waitlisted team' do
project_topic.drop_team_from_topic(team.id)
expect(waitlisted_team.reload.is_waitlisted).to be false
end
end
end
</pre>

7.current_available_slots
</pre>
describe '#current_available_slots' do
context 'when no teams have signed up' do
it 'returns max_choosers as available slots' do
expect(project_topic.current_available_slots).to eq(project_topic.max_choosers)
end
end
context 'when some teams have signed up' do
before do
2.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'returns the remaining available slots' do
expect(project_topic.current_available_slots).to eq(1)
end
end
</pre>

'''spec/models/signed_up_team_spec.rb'''

1.get_team_id
</pre>
describe '.get_team_id' do
let!(:user) { User.create!(name: "Name", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id) }
let!(:teams_user) { TeamsUser.create!(team_id: team.id, user_id: user.id) }
it 'returns the correct team ID for the given user and assignment' do
expect(SignedUpTeam.get_team_id(user.id, assignment.id)).to eq(team.id)
end
it 'returns nil if the user is not associated with any team for the assignment' do
other_user = User.create!(name: "Name 2", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id)
expect(SignedUpTeam.get_team_id(other_user.id, assignment.id)).to be_nil
end
end
</pre>

2..drop_off_team_signup_records
</pre>
describe '.drop_off_team_signup_records' do
let!(:signup1) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team_id: team.id) }
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signup2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: true, team_id: team.id) }
it 'removes all sign-up records for the given team' do
expect { SignedUpTeam.drop_off_team_signup_records(team.id) }
.to change { SignedUpTeam.where(team_id: team.id).count }.by(-2)
end
end
</pre>

3.reassign_topic
</pre>
describe '#reassign_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, team_id: team.id) }
before do
allow(ProjectTopic).to receive(:find).with(project_topic.id).and_return(project_topic)
allow(project_topic).to receive(:drop_team_from_topic)
end
it 'reassigns the team to a new topic and marks them as not waitlisted' do
signed_up_team.reassign_topic(project_topic.id)
expect(signed_up_team.reload.is_waitlisted).to be_falsey
expect(project_topic).to have_received(:drop_team_from_topic).with(team_id: team.id)
end
</pre>

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125 Pull Request 125]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-04T04:23:10Z

Skanumu2: /* Testing */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation of sign up topic as project topic in the Expertiza backend.

==Problem Statement==
The following tasks were required for the reimplementation :
#Redesigning SignUpTopic as ProjectTopic: This involves reimplementing SignUpTopic class from the original expertiza repository as ProjectTopic within reimplementation-backend repository. This reimplementation should follow Rails best practices, use Ruby naming conventions, and adhere to the DRY principle to improve code maintainability and readability.
#Implementing Team Signup and Topic Drop Functionality: Adding methods to sign a team up for a topic and handling cases when a team drops a topic.
#Assignment Team Retrieval: Implementing a method to retrieve AssignmentTeams that are currently signed up for a specific topic, allowing for efficient tracking and management of team assignments.
#Slot Availability Management: Including methods for managing and retrieving the current number of available slots for a topic, updating as teams sign up or drop topics to reflect accurate availability.
#Writing tests for project topic model: RSpec tests have to be written for ProjectTopic Model.
#Writing Swagger UI tests for API endpoints: Swagger UI tests have to be written to test ProjectTopic and SignedUpTeam functionalities.

==Design Goal==
While reimplementing the SignUpTopic as ProjectTopic, the following design rules must be ensured:

* Maintain Functional Integrity: Validate the functionality of existing and new methods, incorporating any necessary improvements to meet updated requirements for managing topic signups, slot availability, and team assignments.

* Promote Loose Coupling and Tight Cohesion: Ensure that ProjectTopic and related classes, such as SignedUpTeam, are designed for optimal organization and maintainability, with clear separation of responsibilities to improve code quality and reduce dependencies.

* Apply the DRY Principle: Refactor any redundant code in the previous implementation, adhering to DRY principles by eliminating duplicated functionality from the Expertiza system and implementing reusable methods where possible.

* Ensure Robust Testing and Documentation: Validate the accuracy of existing test cases, updating them to reflect changes in ProjectTopic. Add comprehensive RSpec tests for new functionality, and perform Swagger UI testing on API endpoints to ensure complete coverage and reliability.

==Implementation==
Below are the methods implemented for the `project_topic` and `signed_up_team` classes. These methods handle slot availability, team sign-ups, waitlist management, topic reassignment, and data consistency. They ensure efficient topic allocation and seamless team management.
===project_topics ===

'''slot_available?''':

This method checks if there are any available slots for a team to sign up for the topic. This function is crucial for managing team assignments effectively without exceeding the maximum allowed capacity.

<pre>
def slot_available?
current_available_slots > 0
end
</pre>

---

'''assign_topic_to_team(new_sign_up)''':

This method assigns the current topic to a team by updating the provided sign-up record. It removes the team from the waitlist and associates the team with this topic. This ensures that the team's assignment is finalized and marked as active, not waitlisted. It is used in scenarios where a slot is available and the team can be directly assigned to the topic.

<pre>
def assign_topic_to_team(new_sign_up)
new_sign_up.update(is_waitlisted: false, sign_up_topic_id: self.id)
end
</pre>

---

'''save_waitlist_entry(new_sign_up)''':

This method adds a team to the waitlist for the current topic by marking the sign-up record as waitlisted and associating it with this topic. This function is invoked when no slots are available, ensuring the team is placed in the queue for future assignment. It maintains fairness and order in the sign-up process.

<pre>
def save_waitlist_entry(new_sign_up)
new_sign_up.update(is_waitlisted: true, sign_up_topic_id: self.id)
end
</pre>

---

'''sign_up_team(team_id)''':

This method handles the team sign-up process for the current topic. It first checks if the team is already signed up for the topic and ensures it is not waitlisted. If slots are available, the team is assigned to the topic directly. Otherwise, the team is added to the waitlist. This method is central to managing both immediate assignments and waitlisted entries.

<pre>
def sign_up_team(team_id)
topic_id = self.id

existing_sign_up = SignedUpTeam.find_by(sign_up_topic_id: topic_id, team_id: team_id)
return false if !existing_sign_up.nil? && !existing_sign_up.is_waitlisted

new_sign_up = SignedUpTeam.new(sign_up_topic_id: topic_id, team_id: team_id)

if slot_available?
assign_topic_to_team(new_sign_up)
result = SignedUpTeam.drop_off_team_waitlists(team_id)
else
result = save_waitlist_entry(new_sign_up)
end

result
end
</pre>

---

'''longest_waiting_team''':

This method retrieves the team that has been on the waitlist the longest for the current topic. It sorts the waitlisted entries by their creation time and returns the oldest entry. This is useful for assigning slots to teams in a fair and chronological manner as slots become available.

<pre>
def longest_waiting_team
SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: true).order(:created_at).first
end
</pre>

---

'''drop_team_from_topic(team_id)''':

This method removes a team from the current topic. If the removed team was not waitlisted, it reassigns the topic to the next waitlisted team, ensuring efficient utilization of available slots. The method then deletes the team's sign-up record, maintaining data consistency.

<pre>
def drop_team_from_topic(team_id)
signed_up_team = SignedUpTeam.find_by(team_id: team_id, sign_up_topic_id: self.id)
return nil unless signed_up_team

unless signed_up_team.is_waitlisted
next_waitlisted_team = longest_waiting_team
next_waitlisted_team&.reassign_topic(self.id)
end

signed_up_team.destroy
end
</pre>

---

'''signed_up_teams_for_topic''':

This method retrieves all teams that have signed up for the current topic, including both waitlisted and non-waitlisted teams. It provides an overview of the teams associated with a particular topic, aiding in administrative and reporting tasks.

<pre>
def signed_up_teams_for_topic
SignedUpTeam.where(sign_up_topic_id: self.id)
end
</pre>

---

'''current_available_slots''':

This method calculates the number of available slots for the topic by subtracting the count of non-waitlisted teams from the maximum allowed capacity. It ensures the integrity of slot management by providing real-time availability data, which is critical for the sign-up and waitlisting processes.

<pre>
def current_available_slots
teams_who_chose_the_topic = SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: false)
self.max_choosers.to_i - teams_who_chose_the_topic.size
end
</pre>

===signed_up_team===

'''drop_off_team_waitlists(team_id)''':

This class method removes all waitlisted entries for a specific team. It deletes all sign-up records where the team is marked as waitlisted, ensuring the team is no longer on any waitlists.

<pre>
def self.drop_off_team_waitlists(team_id)
SignedUpTeam.where(team_id: team_id, is_waitlisted: true).destroy_all
end
</pre>

---

'''create_signed_up_team(topic_id, team_id)''':

This class method creates a sign-up record for a team by associating it with the specified topic. It retrieves the project topic by its ID and uses the `sign_up_team` method to handle the sign-up process.

<pre>
def self.create_signed_up_team(topic_id, team_id)
project_topic = ProjectTopic.find(topic_id)
project_topic.sign_up_team(team_id)
end
</pre>

---

'''get_team_id(user_id, assignment_id)''':

This class method retrieves the team ID associated with a specific user and assignment. It first identifies the teams the user belongs to and then filters the team linked to the given assignment, returning its ID.

<pre>
def self.get_team_id(user_id, assignment_id)
team_ids = TeamsUser.select('team_id').where(user_id: user_id)
team_id = Team.where(team_id: team_ids, assignment_id: assignment_id).first.team_id
team_id
end
</pre>

---

'''drop_off_team_signup_records(team_id)''':

This class method deletes all sign-up records for a given team. It removes every entry associated with the specified team, clearing all their topic associations.

<pre>
def self.drop_off_team_signup_records(team_id)
SignedUpTeam.where(team_id: team_id).destroy_all
end
</pre>

---

'''reassign_topic(topic_id)''':

This instance method reassigns a team to a new topic. It first removes the team from its current topic if they are assigned, then updates the team's waitlist status to indicate they are now assigned to the new topic.

<pre>
def reassign_topic(topic_id)
assigned_team = SignedUpTeam.where(team_id: self.team_id, is_waitlisted: false)

unless assigned_team.nil?
project_topic = ProjectTopic.find(topic_id)
project_topic.drop_team_from_topic(team_id: self.team_id)
end

self.update(is_waitlisted: false)
end
</pre>

==Testing==

spec/models/project_topic_spec.rb

1.slot_available?
<pre>
describe '#slot_available?' do
context 'when no teams have chosen the topic' do
it 'returns true' do
expect(project_topic.slot_available?).to be true
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns false' do
expect(project_topic.slot_available?).to be false
end
end
end

</pre>

2.assign_topic_to_team
</pre>
describe '#assign_topic_to_team' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'assigns the topic to the team and updates waitlist status' do
project_topic.assign_topic_to_team(new_sign_up)
expect(new_sign_up.is_waitlisted).to be false
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

3.save_waitlist_entry
</pre>
describe '#save_waitlist_entry' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'adds a new sign-up to the waitlist' do
project_topic.save_waitlist_entry(new_sign_up)
expect(new_sign_up.is_waitlisted).to be true
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

4.sign_up_team
</pre>
describe '#sign_up_team' do
let(:new_team) { Team.create!(assignment_id: assignment.id) }
context 'when slot is available' do
it 'assigns the topic to the team and drops team waitlists' do
allow(SignedUpTeam).to receive(:drop_off_team_waitlists).with(new_team.id).and_return(true)
expect(project_topic.sign_up_team(new_team.id)).to be true
expect(SignedUpTeam).to have_received(:drop_off_team_waitlists).with(new_team.id)
end
end
context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'adds the team to the waitlist' do
expect { project_topic.sign_up_team(new_team.id) }.to change { SignedUpTeam.count }.by(1)
expect(SignedUpTeam.last.is_waitlisted).to be true
end
end
context 'when the team is already signed up and not waitlisted' do
before do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team, is_waitlisted: false)
end
it 'returns false' do
expect(project_topic.sign_up_team(team.id)).to be false
end
end
end
</pre>

5.longest_waiting_team
</pre>
describe '#longest_waiting_team' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'returns the team that has been waitlisted the longest' do
expect(project_topic.longest_waiting_team).to eq(waitlisted_team)
end
end

6.drop_team_from_topic
describe '#drop_team_from_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team) }
it 'removes the team from the topic' do
expect { project_topic.drop_team_from_topic(team.id) }.to change { SignedUpTeam.count }.by(-1)
end
context 'when the team is not waitlisted' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'assigns the topic to the next waitlisted team' do
project_topic.drop_team_from_topic(team.id)
expect(waitlisted_team.reload.is_waitlisted).to be false
end
end
end
</pre>

7.current_available_slots
</pre>
describe '#current_available_slots' do
context 'when no teams have signed up' do
it 'returns max_choosers as available slots' do
expect(project_topic.current_available_slots).to eq(project_topic.max_choosers)
end
end
context 'when some teams have signed up' do
before do
2.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'returns the remaining available slots' do
expect(project_topic.current_available_slots).to eq(1)
end
end
</pre>

spec/models/signed_up_team_spec.rb

1.get_team_id
</pre>
describe '.get_team_id' do
let!(:user) { User.create!(name: "Name", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id) }
let!(:teams_user) { TeamsUser.create!(team_id: team.id, user_id: user.id) }
it 'returns the correct team ID for the given user and assignment' do
expect(SignedUpTeam.get_team_id(user.id, assignment.id)).to eq(team.id)
end
it 'returns nil if the user is not associated with any team for the assignment' do
other_user = User.create!(name: "Name 2", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id)
expect(SignedUpTeam.get_team_id(other_user.id, assignment.id)).to be_nil
end
end
</pre>

2..drop_off_team_signup_records
</pre>
describe '.drop_off_team_signup_records' do
let!(:signup1) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team_id: team.id) }
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signup2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: true, team_id: team.id) }
it 'removes all sign-up records for the given team' do
expect { SignedUpTeam.drop_off_team_signup_records(team.id) }
.to change { SignedUpTeam.where(team_id: team.id).count }.by(-2)
end
end
</pre>

3.reassign_topic
</pre>
describe '#reassign_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, team_id: team.id) }
before do
allow(ProjectTopic).to receive(:find).with(project_topic.id).and_return(project_topic)
allow(project_topic).to receive(:drop_team_from_topic)
end
it 'reassigns the team to a new topic and marks them as not waitlisted' do
signed_up_team.reassign_topic(project_topic.id)
expect(signed_up_team.reload.is_waitlisted).to be_falsey
expect(project_topic).to have_received(:drop_team_from_topic).with(team_id: team.id)
end
</pre>

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125 Pull Request 125]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-04T04:22:05Z

Skanumu2: /* Testing */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation of sign up topic as project topic in the Expertiza backend.

==Problem Statement==
The following tasks were required for the reimplementation :
#Redesigning SignUpTopic as ProjectTopic: This involves reimplementing SignUpTopic class from the original expertiza repository as ProjectTopic within reimplementation-backend repository. This reimplementation should follow Rails best practices, use Ruby naming conventions, and adhere to the DRY principle to improve code maintainability and readability.
#Implementing Team Signup and Topic Drop Functionality: Adding methods to sign a team up for a topic and handling cases when a team drops a topic.
#Assignment Team Retrieval: Implementing a method to retrieve AssignmentTeams that are currently signed up for a specific topic, allowing for efficient tracking and management of team assignments.
#Slot Availability Management: Including methods for managing and retrieving the current number of available slots for a topic, updating as teams sign up or drop topics to reflect accurate availability.
#Writing tests for project topic model: RSpec tests have to be written for ProjectTopic Model.
#Writing Swagger UI tests for API endpoints: Swagger UI tests have to be written to test ProjectTopic and SignedUpTeam functionalities.

==Design Goal==
While reimplementing the SignUpTopic as ProjectTopic, the following design rules must be ensured:

* Maintain Functional Integrity: Validate the functionality of existing and new methods, incorporating any necessary improvements to meet updated requirements for managing topic signups, slot availability, and team assignments.

* Promote Loose Coupling and Tight Cohesion: Ensure that ProjectTopic and related classes, such as SignedUpTeam, are designed for optimal organization and maintainability, with clear separation of responsibilities to improve code quality and reduce dependencies.

* Apply the DRY Principle: Refactor any redundant code in the previous implementation, adhering to DRY principles by eliminating duplicated functionality from the Expertiza system and implementing reusable methods where possible.

* Ensure Robust Testing and Documentation: Validate the accuracy of existing test cases, updating them to reflect changes in ProjectTopic. Add comprehensive RSpec tests for new functionality, and perform Swagger UI testing on API endpoints to ensure complete coverage and reliability.

==Implementation==
Below are the methods implemented for the `project_topic` and `signed_up_team` classes. These methods handle slot availability, team sign-ups, waitlist management, topic reassignment, and data consistency. They ensure efficient topic allocation and seamless team management.
===project_topics ===

'''slot_available?''':

This method checks if there are any available slots for a team to sign up for the topic. This function is crucial for managing team assignments effectively without exceeding the maximum allowed capacity.

<pre>
def slot_available?
current_available_slots > 0
end
</pre>

---

'''assign_topic_to_team(new_sign_up)''':

This method assigns the current topic to a team by updating the provided sign-up record. It removes the team from the waitlist and associates the team with this topic. This ensures that the team's assignment is finalized and marked as active, not waitlisted. It is used in scenarios where a slot is available and the team can be directly assigned to the topic.

<pre>
def assign_topic_to_team(new_sign_up)
new_sign_up.update(is_waitlisted: false, sign_up_topic_id: self.id)
end
</pre>

---

'''save_waitlist_entry(new_sign_up)''':

This method adds a team to the waitlist for the current topic by marking the sign-up record as waitlisted and associating it with this topic. This function is invoked when no slots are available, ensuring the team is placed in the queue for future assignment. It maintains fairness and order in the sign-up process.

<pre>
def save_waitlist_entry(new_sign_up)
new_sign_up.update(is_waitlisted: true, sign_up_topic_id: self.id)
end
</pre>

---

'''sign_up_team(team_id)''':

This method handles the team sign-up process for the current topic. It first checks if the team is already signed up for the topic and ensures it is not waitlisted. If slots are available, the team is assigned to the topic directly. Otherwise, the team is added to the waitlist. This method is central to managing both immediate assignments and waitlisted entries.

<pre>
def sign_up_team(team_id)
topic_id = self.id

existing_sign_up = SignedUpTeam.find_by(sign_up_topic_id: topic_id, team_id: team_id)
return false if !existing_sign_up.nil? && !existing_sign_up.is_waitlisted

new_sign_up = SignedUpTeam.new(sign_up_topic_id: topic_id, team_id: team_id)

if slot_available?
assign_topic_to_team(new_sign_up)
result = SignedUpTeam.drop_off_team_waitlists(team_id)
else
result = save_waitlist_entry(new_sign_up)
end

result
end
</pre>

---

'''longest_waiting_team''':

This method retrieves the team that has been on the waitlist the longest for the current topic. It sorts the waitlisted entries by their creation time and returns the oldest entry. This is useful for assigning slots to teams in a fair and chronological manner as slots become available.

<pre>
def longest_waiting_team
SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: true).order(:created_at).first
end
</pre>

---

'''drop_team_from_topic(team_id)''':

This method removes a team from the current topic. If the removed team was not waitlisted, it reassigns the topic to the next waitlisted team, ensuring efficient utilization of available slots. The method then deletes the team's sign-up record, maintaining data consistency.

<pre>
def drop_team_from_topic(team_id)
signed_up_team = SignedUpTeam.find_by(team_id: team_id, sign_up_topic_id: self.id)
return nil unless signed_up_team

unless signed_up_team.is_waitlisted
next_waitlisted_team = longest_waiting_team
next_waitlisted_team&.reassign_topic(self.id)
end

signed_up_team.destroy
end
</pre>

---

'''signed_up_teams_for_topic''':

This method retrieves all teams that have signed up for the current topic, including both waitlisted and non-waitlisted teams. It provides an overview of the teams associated with a particular topic, aiding in administrative and reporting tasks.

<pre>
def signed_up_teams_for_topic
SignedUpTeam.where(sign_up_topic_id: self.id)
end
</pre>

---

'''current_available_slots''':

This method calculates the number of available slots for the topic by subtracting the count of non-waitlisted teams from the maximum allowed capacity. It ensures the integrity of slot management by providing real-time availability data, which is critical for the sign-up and waitlisting processes.

<pre>
def current_available_slots
teams_who_chose_the_topic = SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: false)
self.max_choosers.to_i - teams_who_chose_the_topic.size
end
</pre>

===signed_up_team===

'''drop_off_team_waitlists(team_id)''':

This class method removes all waitlisted entries for a specific team. It deletes all sign-up records where the team is marked as waitlisted, ensuring the team is no longer on any waitlists.

<pre>
def self.drop_off_team_waitlists(team_id)
SignedUpTeam.where(team_id: team_id, is_waitlisted: true).destroy_all
end
</pre>

---

'''create_signed_up_team(topic_id, team_id)''':

This class method creates a sign-up record for a team by associating it with the specified topic. It retrieves the project topic by its ID and uses the `sign_up_team` method to handle the sign-up process.

<pre>
def self.create_signed_up_team(topic_id, team_id)
project_topic = ProjectTopic.find(topic_id)
project_topic.sign_up_team(team_id)
end
</pre>

---

'''get_team_id(user_id, assignment_id)''':

This class method retrieves the team ID associated with a specific user and assignment. It first identifies the teams the user belongs to and then filters the team linked to the given assignment, returning its ID.

<pre>
def self.get_team_id(user_id, assignment_id)
team_ids = TeamsUser.select('team_id').where(user_id: user_id)
team_id = Team.where(team_id: team_ids, assignment_id: assignment_id).first.team_id
team_id
end
</pre>

---

'''drop_off_team_signup_records(team_id)''':

This class method deletes all sign-up records for a given team. It removes every entry associated with the specified team, clearing all their topic associations.

<pre>
def self.drop_off_team_signup_records(team_id)
SignedUpTeam.where(team_id: team_id).destroy_all
end
</pre>

---

'''reassign_topic(topic_id)''':

This instance method reassigns a team to a new topic. It first removes the team from its current topic if they are assigned, then updates the team's waitlist status to indicate they are now assigned to the new topic.

<pre>
def reassign_topic(topic_id)
assigned_team = SignedUpTeam.where(team_id: self.team_id, is_waitlisted: false)

unless assigned_team.nil?
project_topic = ProjectTopic.find(topic_id)
project_topic.drop_team_from_topic(team_id: self.team_id)
end

self.update(is_waitlisted: false)
end
</pre>

==Testing==

spec/models/project_topic_spec.rb

1.slot_available?
<pre>
describe '#slot_available?' do
context 'when no teams have chosen the topic' do
it 'returns true' do
expect(project_topic.slot_available?).to be true
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns false' do
expect(project_topic.slot_available?).to be false
end
end
end

</pre>

2.assign_topic_to_team
</pre>
describe '#assign_topic_to_team' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'assigns the topic to the team and updates waitlist status' do
project_topic.assign_topic_to_team(new_sign_up)
expect(new_sign_up.is_waitlisted).to be false
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

3.save_waitlist_entry
</pre>
describe '#save_waitlist_entry' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }
it 'adds a new sign-up to the waitlist' do
project_topic.save_waitlist_entry(new_sign_up)
expect(new_sign_up.is_waitlisted).to be true
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

4.sign_up_team
</pre>
describe '#sign_up_team' do
let(:new_team) { Team.create!(assignment_id: assignment.id) }
context 'when slot is available' do
it 'assigns the topic to the team and drops team waitlists' do
allow(SignedUpTeam).to receive(:drop_off_team_waitlists).with(new_team.id).and_return(true)

expect(project_topic.sign_up_team(new_team.id)).to be true
expect(SignedUpTeam).to have_received(:drop_off_team_waitlists).with(new_team.id)
end
end
context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'adds the team to the waitlist' do
expect { project_topic.sign_up_team(new_team.id) }.to change { SignedUpTeam.count }.by(1)
expect(SignedUpTeam.last.is_waitlisted).to be true
end
end
context 'when the team is already signed up and not waitlisted' do
before do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team, is_waitlisted: false)
end
it 'returns false' do
expect(project_topic.sign_up_team(team.id)).to be false
end
end
end
</pre>

5.longest_waiting_team
</pre>
describe '#longest_waiting_team' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'returns the team that has been waitlisted the longest' do
expect(project_topic.longest_waiting_team).to eq(waitlisted_team)
end
end

6.drop_team_from_topic
describe '#drop_team_from_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team) }
it 'removes the team from the topic' do
expect { project_topic.drop_team_from_topic(team.id) }.to change { SignedUpTeam.count }.by(-1)
end
context 'when the team is not waitlisted' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }
it 'assigns the topic to the next waitlisted team' do
project_topic.drop_team_from_topic(team.id)
expect(waitlisted_team.reload.is_waitlisted).to be false
end
end
end
</pre>

7.current_available_slots
</pre>
describe '#current_available_slots' do
context 'when no teams have signed up' do
it 'returns max_choosers as available slots' do
expect(project_topic.current_available_slots).to eq(project_topic.max_choosers)
end
end
context 'when some teams have signed up' do
before do
2.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end
it 'returns the remaining available slots' do
expect(project_topic.current_available_slots).to eq(1)
end
end
</pre>

spec/models/signed_up_team_spec.rb

1.get_team_id
</pre>
describe '.get_team_id' do
let!(:user) { User.create!(name: "Name", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id) }
let!(:teams_user) { TeamsUser.create!(team_id: team.id, user_id: user.id) }
it 'returns the correct team ID for the given user and assignment' do
expect(SignedUpTeam.get_team_id(user.id, assignment.id)).to eq(team.id)
end
it 'returns nil if the user is not associated with any team for the assignment' do
other_user = User.create!(name: "Name 2", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id)
expect(SignedUpTeam.get_team_id(other_user.id, assignment.id)).to be_nil
end
end
</pre>

2..drop_off_team_signup_records
</pre>
describe '.drop_off_team_signup_records' do
let!(:signup1) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team_id: team.id) }
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signup2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: true, team_id: team.id) }
it 'removes all sign-up records for the given team' do
expect { SignedUpTeam.drop_off_team_signup_records(team.id) }
.to change { SignedUpTeam.where(team_id: team.id).count }.by(-2)
end
end
</pre>

3.reassign_topic
</pre>
describe '#reassign_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, team_id: team.id) }
before do
allow(ProjectTopic).to receive(:find).with(project_topic.id).and_return(project_topic)
allow(project_topic).to receive(:drop_team_from_topic)
end
it 'reassigns the team to a new topic and marks them as not waitlisted' do
signed_up_team.reassign_topic(project_topic.id)
expect(signed_up_team.reload.is_waitlisted).to be_falsey
expect(project_topic).to have_received(:drop_team_from_topic).with(team_id: team.id)
end
</pre>

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125 Pull Request 125]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-04T04:19:27Z

Skanumu2: /* Testing */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation of sign up topic as project topic in the Expertiza backend.

==Problem Statement==
The following tasks were required for the reimplementation :
#Redesigning SignUpTopic as ProjectTopic: This involves reimplementing SignUpTopic class from the original expertiza repository as ProjectTopic within reimplementation-backend repository. This reimplementation should follow Rails best practices, use Ruby naming conventions, and adhere to the DRY principle to improve code maintainability and readability.
#Implementing Team Signup and Topic Drop Functionality: Adding methods to sign a team up for a topic and handling cases when a team drops a topic.
#Assignment Team Retrieval: Implementing a method to retrieve AssignmentTeams that are currently signed up for a specific topic, allowing for efficient tracking and management of team assignments.
#Slot Availability Management: Including methods for managing and retrieving the current number of available slots for a topic, updating as teams sign up or drop topics to reflect accurate availability.
#Writing tests for project topic model: RSpec tests have to be written for ProjectTopic Model.
#Writing Swagger UI tests for API endpoints: Swagger UI tests have to be written to test ProjectTopic and SignedUpTeam functionalities.

==Design Goal==
While reimplementing the SignUpTopic as ProjectTopic, the following design rules must be ensured:

* Maintain Functional Integrity: Validate the functionality of existing and new methods, incorporating any necessary improvements to meet updated requirements for managing topic signups, slot availability, and team assignments.

* Promote Loose Coupling and Tight Cohesion: Ensure that ProjectTopic and related classes, such as SignedUpTeam, are designed for optimal organization and maintainability, with clear separation of responsibilities to improve code quality and reduce dependencies.

* Apply the DRY Principle: Refactor any redundant code in the previous implementation, adhering to DRY principles by eliminating duplicated functionality from the Expertiza system and implementing reusable methods where possible.

* Ensure Robust Testing and Documentation: Validate the accuracy of existing test cases, updating them to reflect changes in ProjectTopic. Add comprehensive RSpec tests for new functionality, and perform Swagger UI testing on API endpoints to ensure complete coverage and reliability.

==Implementation==
Below are the methods implemented for the `project_topic` and `signed_up_team` classes. These methods handle slot availability, team sign-ups, waitlist management, topic reassignment, and data consistency. They ensure efficient topic allocation and seamless team management.
===project_topics ===

'''slot_available?''':

This method checks if there are any available slots for a team to sign up for the topic. This function is crucial for managing team assignments effectively without exceeding the maximum allowed capacity.

<pre>
def slot_available?
current_available_slots > 0
end
</pre>

---

'''assign_topic_to_team(new_sign_up)''':

This method assigns the current topic to a team by updating the provided sign-up record. It removes the team from the waitlist and associates the team with this topic. This ensures that the team's assignment is finalized and marked as active, not waitlisted. It is used in scenarios where a slot is available and the team can be directly assigned to the topic.

<pre>
def assign_topic_to_team(new_sign_up)
new_sign_up.update(is_waitlisted: false, sign_up_topic_id: self.id)
end
</pre>

---

'''save_waitlist_entry(new_sign_up)''':

This method adds a team to the waitlist for the current topic by marking the sign-up record as waitlisted and associating it with this topic. This function is invoked when no slots are available, ensuring the team is placed in the queue for future assignment. It maintains fairness and order in the sign-up process.

<pre>
def save_waitlist_entry(new_sign_up)
new_sign_up.update(is_waitlisted: true, sign_up_topic_id: self.id)
end
</pre>

---

'''sign_up_team(team_id)''':

This method handles the team sign-up process for the current topic. It first checks if the team is already signed up for the topic and ensures it is not waitlisted. If slots are available, the team is assigned to the topic directly. Otherwise, the team is added to the waitlist. This method is central to managing both immediate assignments and waitlisted entries.

<pre>
def sign_up_team(team_id)
topic_id = self.id

existing_sign_up = SignedUpTeam.find_by(sign_up_topic_id: topic_id, team_id: team_id)
return false if !existing_sign_up.nil? && !existing_sign_up.is_waitlisted

new_sign_up = SignedUpTeam.new(sign_up_topic_id: topic_id, team_id: team_id)

if slot_available?
assign_topic_to_team(new_sign_up)
result = SignedUpTeam.drop_off_team_waitlists(team_id)
else
result = save_waitlist_entry(new_sign_up)
end

result
end
</pre>

---

'''longest_waiting_team''':

This method retrieves the team that has been on the waitlist the longest for the current topic. It sorts the waitlisted entries by their creation time and returns the oldest entry. This is useful for assigning slots to teams in a fair and chronological manner as slots become available.

<pre>
def longest_waiting_team
SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: true).order(:created_at).first
end
</pre>

---

'''drop_team_from_topic(team_id)''':

This method removes a team from the current topic. If the removed team was not waitlisted, it reassigns the topic to the next waitlisted team, ensuring efficient utilization of available slots. The method then deletes the team's sign-up record, maintaining data consistency.

<pre>
def drop_team_from_topic(team_id)
signed_up_team = SignedUpTeam.find_by(team_id: team_id, sign_up_topic_id: self.id)
return nil unless signed_up_team

unless signed_up_team.is_waitlisted
next_waitlisted_team = longest_waiting_team
next_waitlisted_team&.reassign_topic(self.id)
end

signed_up_team.destroy
end
</pre>

---

'''signed_up_teams_for_topic''':

This method retrieves all teams that have signed up for the current topic, including both waitlisted and non-waitlisted teams. It provides an overview of the teams associated with a particular topic, aiding in administrative and reporting tasks.

<pre>
def signed_up_teams_for_topic
SignedUpTeam.where(sign_up_topic_id: self.id)
end
</pre>

---

'''current_available_slots''':

This method calculates the number of available slots for the topic by subtracting the count of non-waitlisted teams from the maximum allowed capacity. It ensures the integrity of slot management by providing real-time availability data, which is critical for the sign-up and waitlisting processes.

<pre>
def current_available_slots
teams_who_chose_the_topic = SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: false)
self.max_choosers.to_i - teams_who_chose_the_topic.size
end
</pre>

===signed_up_team===

'''drop_off_team_waitlists(team_id)''':

This class method removes all waitlisted entries for a specific team. It deletes all sign-up records where the team is marked as waitlisted, ensuring the team is no longer on any waitlists.

<pre>
def self.drop_off_team_waitlists(team_id)
SignedUpTeam.where(team_id: team_id, is_waitlisted: true).destroy_all
end
</pre>

---

'''create_signed_up_team(topic_id, team_id)''':

This class method creates a sign-up record for a team by associating it with the specified topic. It retrieves the project topic by its ID and uses the `sign_up_team` method to handle the sign-up process.

<pre>
def self.create_signed_up_team(topic_id, team_id)
project_topic = ProjectTopic.find(topic_id)
project_topic.sign_up_team(team_id)
end
</pre>

---

'''get_team_id(user_id, assignment_id)''':

This class method retrieves the team ID associated with a specific user and assignment. It first identifies the teams the user belongs to and then filters the team linked to the given assignment, returning its ID.

<pre>
def self.get_team_id(user_id, assignment_id)
team_ids = TeamsUser.select('team_id').where(user_id: user_id)
team_id = Team.where(team_id: team_ids, assignment_id: assignment_id).first.team_id
team_id
end
</pre>

---

'''drop_off_team_signup_records(team_id)''':

This class method deletes all sign-up records for a given team. It removes every entry associated with the specified team, clearing all their topic associations.

<pre>
def self.drop_off_team_signup_records(team_id)
SignedUpTeam.where(team_id: team_id).destroy_all
end
</pre>

---

'''reassign_topic(topic_id)''':

This instance method reassigns a team to a new topic. It first removes the team from its current topic if they are assigned, then updates the team's waitlist status to indicate they are now assigned to the new topic.

<pre>
def reassign_topic(topic_id)
assigned_team = SignedUpTeam.where(team_id: self.team_id, is_waitlisted: false)

unless assigned_team.nil?
project_topic = ProjectTopic.find(topic_id)
project_topic.drop_team_from_topic(team_id: self.team_id)
end

self.update(is_waitlisted: false)
end
</pre>

==Testing==

spec/models/project_topic_spec.rb

1.slot_available?
<pre>
describe '#slot_available?' do
context 'when no teams have chosen the topic' do
it 'returns true' do
expect(project_topic.slot_available?).to be true
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns false' do
expect(project_topic.slot_available?).to be false
end
end
end

</pre>

2.assign_topic_to_team
</pre>
describe '#assign_topic_to_team' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }

it 'assigns the topic to the team and updates waitlist status' do
project_topic.assign_topic_to_team(new_sign_up)
expect(new_sign_up.is_waitlisted).to be false
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

3.save_waitlist_entry
</pre>
describe '#save_waitlist_entry' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }

it 'adds a new sign-up to the waitlist' do
project_topic.save_waitlist_entry(new_sign_up)
expect(new_sign_up.is_waitlisted).to be true
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

4.sign_up_team
</pre>
describe '#sign_up_team' do
let(:new_team) { Team.create!(assignment_id: assignment.id) }

context 'when slot is available' do
it 'assigns the topic to the team and drops team waitlists' do
allow(SignedUpTeam).to receive(:drop_off_team_waitlists).with(new_team.id).and_return(true)

expect(project_topic.sign_up_team(new_team.id)).to be true
expect(SignedUpTeam).to have_received(:drop_off_team_waitlists).with(new_team.id)
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'adds the team to the waitlist' do
expect { project_topic.sign_up_team(new_team.id) }.to change { SignedUpTeam.count }.by(1)
expect(SignedUpTeam.last.is_waitlisted).to be true
end
end

context 'when the team is already signed up and not waitlisted' do
before do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team, is_waitlisted: false)
end

it 'returns false' do
expect(project_topic.sign_up_team(team.id)).to be false
end
end
end
</pre>

5.longest_waiting_team
</pre>
describe '#longest_waiting_team' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }

it 'returns the team that has been waitlisted the longest' do
expect(project_topic.longest_waiting_team).to eq(waitlisted_team)
end
end

describe '#drop_team_from_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team) }

it 'removes the team from the topic' do
expect { project_topic.drop_team_from_topic(team.id) }.to change { SignedUpTeam.count }.by(-1)
end

context 'when the team is not waitlisted' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }

it 'assigns the topic to the next waitlisted team' do
project_topic.drop_team_from_topic(team.id)
expect(waitlisted_team.reload.is_waitlisted).to be false
end
end
end
</pre>

6.current_available_slots
</pre>
describe '#current_available_slots' do
context 'when no teams have signed up' do
it 'returns max_choosers as available slots' do
expect(project_topic.current_available_slots).to eq(project_topic.max_choosers)
end
end

context 'when some teams have signed up' do
before do
2.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns the remaining available slots' do
expect(project_topic.current_available_slots).to eq(1)
end
end
</pre>

spec/models/signed_up_team_spec.rb

1.get_team_id
</pre>
describe '.get_team_id' do
let!(:user) { User.create!(name: "Name", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id) }
let!(:teams_user) { TeamsUser.create!(team_id: team.id, user_id: user.id) }

it 'returns the correct team ID for the given user and assignment' do
expect(SignedUpTeam.get_team_id(user.id, assignment.id)).to eq(team.id)
end

it 'returns nil if the user is not associated with any team for the assignment' do
other_user = User.create!(name: "Name 2", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id)
expect(SignedUpTeam.get_team_id(other_user.id, assignment.id)).to be_nil
end
end
</pre>

2..drop_off_team_signup_records
</pre>
describe '.drop_off_team_signup_records' do
let!(:signup1) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team_id: team.id) }
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signup2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: true, team_id: team.id) }

it 'removes all sign-up records for the given team' do
expect { SignedUpTeam.drop_off_team_signup_records(team.id) }
.to change { SignedUpTeam.where(team_id: team.id).count }.by(-2)
end
end
</pre>

3.reassign_topic
</pre>
describe '#reassign_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, team_id: team.id) }
before do
allow(ProjectTopic).to receive(:find).with(project_topic.id).and_return(project_topic)
allow(project_topic).to receive(:drop_team_from_topic)
end

it 'reassigns the team to a new topic and marks them as not waitlisted' do
signed_up_team.reassign_topic(project_topic.id)
expect(signed_up_team.reload.is_waitlisted).to be_falsey
expect(project_topic).to have_received(:drop_team_from_topic).with(team_id: team.id)
end
</pre>

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125 Pull Request 125]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-04T04:18:45Z

Skanumu2: /* Testing */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation of sign up topic as project topic in the Expertiza backend.

==Problem Statement==
The following tasks were required for the reimplementation :
#Redesigning SignUpTopic as ProjectTopic: This involves reimplementing SignUpTopic class from the original expertiza repository as ProjectTopic within reimplementation-backend repository. This reimplementation should follow Rails best practices, use Ruby naming conventions, and adhere to the DRY principle to improve code maintainability and readability.
#Implementing Team Signup and Topic Drop Functionality: Adding methods to sign a team up for a topic and handling cases when a team drops a topic.
#Assignment Team Retrieval: Implementing a method to retrieve AssignmentTeams that are currently signed up for a specific topic, allowing for efficient tracking and management of team assignments.
#Slot Availability Management: Including methods for managing and retrieving the current number of available slots for a topic, updating as teams sign up or drop topics to reflect accurate availability.
#Writing tests for project topic model: RSpec tests have to be written for ProjectTopic Model.
#Writing Swagger UI tests for API endpoints: Swagger UI tests have to be written to test ProjectTopic and SignedUpTeam functionalities.

==Design Goal==
While reimplementing the SignUpTopic as ProjectTopic, the following design rules must be ensured:

* Maintain Functional Integrity: Validate the functionality of existing and new methods, incorporating any necessary improvements to meet updated requirements for managing topic signups, slot availability, and team assignments.

* Promote Loose Coupling and Tight Cohesion: Ensure that ProjectTopic and related classes, such as SignedUpTeam, are designed for optimal organization and maintainability, with clear separation of responsibilities to improve code quality and reduce dependencies.

* Apply the DRY Principle: Refactor any redundant code in the previous implementation, adhering to DRY principles by eliminating duplicated functionality from the Expertiza system and implementing reusable methods where possible.

* Ensure Robust Testing and Documentation: Validate the accuracy of existing test cases, updating them to reflect changes in ProjectTopic. Add comprehensive RSpec tests for new functionality, and perform Swagger UI testing on API endpoints to ensure complete coverage and reliability.

==Implementation==
Below are the methods implemented for the `project_topic` and `signed_up_team` classes. These methods handle slot availability, team sign-ups, waitlist management, topic reassignment, and data consistency. They ensure efficient topic allocation and seamless team management.
===project_topics ===

'''slot_available?''':

This method checks if there are any available slots for a team to sign up for the topic. This function is crucial for managing team assignments effectively without exceeding the maximum allowed capacity.

<pre>
def slot_available?
current_available_slots > 0
end
</pre>

---

'''assign_topic_to_team(new_sign_up)''':

This method assigns the current topic to a team by updating the provided sign-up record. It removes the team from the waitlist and associates the team with this topic. This ensures that the team's assignment is finalized and marked as active, not waitlisted. It is used in scenarios where a slot is available and the team can be directly assigned to the topic.

<pre>
def assign_topic_to_team(new_sign_up)
new_sign_up.update(is_waitlisted: false, sign_up_topic_id: self.id)
end
</pre>

---

'''save_waitlist_entry(new_sign_up)''':

This method adds a team to the waitlist for the current topic by marking the sign-up record as waitlisted and associating it with this topic. This function is invoked when no slots are available, ensuring the team is placed in the queue for future assignment. It maintains fairness and order in the sign-up process.

<pre>
def save_waitlist_entry(new_sign_up)
new_sign_up.update(is_waitlisted: true, sign_up_topic_id: self.id)
end
</pre>

---

'''sign_up_team(team_id)''':

This method handles the team sign-up process for the current topic. It first checks if the team is already signed up for the topic and ensures it is not waitlisted. If slots are available, the team is assigned to the topic directly. Otherwise, the team is added to the waitlist. This method is central to managing both immediate assignments and waitlisted entries.

<pre>
def sign_up_team(team_id)
topic_id = self.id

existing_sign_up = SignedUpTeam.find_by(sign_up_topic_id: topic_id, team_id: team_id)
return false if !existing_sign_up.nil? && !existing_sign_up.is_waitlisted

new_sign_up = SignedUpTeam.new(sign_up_topic_id: topic_id, team_id: team_id)

if slot_available?
assign_topic_to_team(new_sign_up)
result = SignedUpTeam.drop_off_team_waitlists(team_id)
else
result = save_waitlist_entry(new_sign_up)
end

result
end
</pre>

---

'''longest_waiting_team''':

This method retrieves the team that has been on the waitlist the longest for the current topic. It sorts the waitlisted entries by their creation time and returns the oldest entry. This is useful for assigning slots to teams in a fair and chronological manner as slots become available.

<pre>
def longest_waiting_team
SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: true).order(:created_at).first
end
</pre>

---

'''drop_team_from_topic(team_id)''':

This method removes a team from the current topic. If the removed team was not waitlisted, it reassigns the topic to the next waitlisted team, ensuring efficient utilization of available slots. The method then deletes the team's sign-up record, maintaining data consistency.

<pre>
def drop_team_from_topic(team_id)
signed_up_team = SignedUpTeam.find_by(team_id: team_id, sign_up_topic_id: self.id)
return nil unless signed_up_team

unless signed_up_team.is_waitlisted
next_waitlisted_team = longest_waiting_team
next_waitlisted_team&.reassign_topic(self.id)
end

signed_up_team.destroy
end
</pre>

---

'''signed_up_teams_for_topic''':

This method retrieves all teams that have signed up for the current topic, including both waitlisted and non-waitlisted teams. It provides an overview of the teams associated with a particular topic, aiding in administrative and reporting tasks.

<pre>
def signed_up_teams_for_topic
SignedUpTeam.where(sign_up_topic_id: self.id)
end
</pre>

---

'''current_available_slots''':

This method calculates the number of available slots for the topic by subtracting the count of non-waitlisted teams from the maximum allowed capacity. It ensures the integrity of slot management by providing real-time availability data, which is critical for the sign-up and waitlisting processes.

<pre>
def current_available_slots
teams_who_chose_the_topic = SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: false)
self.max_choosers.to_i - teams_who_chose_the_topic.size
end
</pre>

===signed_up_team===

'''drop_off_team_waitlists(team_id)''':

This class method removes all waitlisted entries for a specific team. It deletes all sign-up records where the team is marked as waitlisted, ensuring the team is no longer on any waitlists.

<pre>
def self.drop_off_team_waitlists(team_id)
SignedUpTeam.where(team_id: team_id, is_waitlisted: true).destroy_all
end
</pre>

---

'''create_signed_up_team(topic_id, team_id)''':

This class method creates a sign-up record for a team by associating it with the specified topic. It retrieves the project topic by its ID and uses the `sign_up_team` method to handle the sign-up process.

<pre>
def self.create_signed_up_team(topic_id, team_id)
project_topic = ProjectTopic.find(topic_id)
project_topic.sign_up_team(team_id)
end
</pre>

---

'''get_team_id(user_id, assignment_id)''':

This class method retrieves the team ID associated with a specific user and assignment. It first identifies the teams the user belongs to and then filters the team linked to the given assignment, returning its ID.

<pre>
def self.get_team_id(user_id, assignment_id)
team_ids = TeamsUser.select('team_id').where(user_id: user_id)
team_id = Team.where(team_id: team_ids, assignment_id: assignment_id).first.team_id
team_id
end
</pre>

---

'''drop_off_team_signup_records(team_id)''':

This class method deletes all sign-up records for a given team. It removes every entry associated with the specified team, clearing all their topic associations.

<pre>
def self.drop_off_team_signup_records(team_id)
SignedUpTeam.where(team_id: team_id).destroy_all
end
</pre>

---

'''reassign_topic(topic_id)''':

This instance method reassigns a team to a new topic. It first removes the team from its current topic if they are assigned, then updates the team's waitlist status to indicate they are now assigned to the new topic.

<pre>
def reassign_topic(topic_id)
assigned_team = SignedUpTeam.where(team_id: self.team_id, is_waitlisted: false)

unless assigned_team.nil?
project_topic = ProjectTopic.find(topic_id)
project_topic.drop_team_from_topic(team_id: self.team_id)
end

self.update(is_waitlisted: false)
end
</pre>

==Testing==

spec/models/project_topic_spec.rb

1.slot_available?
<pre>
describe '#slot_available?' do
context 'when no teams have chosen the topic' do
it 'returns true' do
expect(project_topic.slot_available?).to be true
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns false' do
expect(project_topic.slot_available?).to be false
end
end
end

</pre>

2.assign_topic_to_team
</pre>
describe '#assign_topic_to_team' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }

it 'assigns the topic to the team and updates waitlist status' do
project_topic.assign_topic_to_team(new_sign_up)
expect(new_sign_up.is_waitlisted).to be false
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

3.save_waitlist_entry
</pre>
describe '#save_waitlist_entry' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }

it 'adds a new sign-up to the waitlist' do
project_topic.save_waitlist_entry(new_sign_up)
expect(new_sign_up.is_waitlisted).to be true
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

4.sign_up_team
</pre>
describe '#sign_up_team' do
let(:new_team) { Team.create!(assignment_id: assignment.id) }

context 'when slot is available' do
it 'assigns the topic to the team and drops team waitlists' do
allow(SignedUpTeam).to receive(:drop_off_team_waitlists).with(new_team.id).and_return(true)

expect(project_topic.sign_up_team(new_team.id)).to be true
expect(SignedUpTeam).to have_received(:drop_off_team_waitlists).with(new_team.id)
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'adds the team to the waitlist' do
expect { project_topic.sign_up_team(new_team.id) }.to change { SignedUpTeam.count }.by(1)
expect(SignedUpTeam.last.is_waitlisted).to be true
end
end

context 'when the team is already signed up and not waitlisted' do
before do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team, is_waitlisted: false)
end

it 'returns false' do
expect(project_topic.sign_up_team(team.id)).to be false
end
end
end
</pre>

5.longest_waiting_team
</pre>
describe '#longest_waiting_team' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }

it 'returns the team that has been waitlisted the longest' do
expect(project_topic.longest_waiting_team).to eq(waitlisted_team)
end
end

describe '#drop_team_from_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team) }

it 'removes the team from the topic' do
expect { project_topic.drop_team_from_topic(team.id) }.to change { SignedUpTeam.count }.by(-1)
end

context 'when the team is not waitlisted' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }

it 'assigns the topic to the next waitlisted team' do
project_topic.drop_team_from_topic(team.id)
expect(waitlisted_team.reload.is_waitlisted).to be false
end
end
end
</pre>

6.current_available_slots
</pre>
describe '#current_available_slots' do
context 'when no teams have signed up' do
it 'returns max_choosers as available slots' do
expect(project_topic.current_available_slots).to eq(project_topic.max_choosers)
end
end

context 'when some teams have signed up' do
before do
2.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns the remaining available slots' do
expect(project_topic.current_available_slots).to eq(1)
end
end
</pre>

spec/models/signed_up_team_spec.rb

1.get_team_id
</pre>
describe '.get_team_id' do
let!(:user) { User.create!(name: "Name", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id) }
let!(:teams_user) { TeamsUser.create!(team_id: team.id, user_id: user.id) }

it 'returns the correct team ID for the given user and assignment' do
expect(SignedUpTeam.get_team_id(user.id, assignment.id)).to eq(team.id)
end

it 'returns nil if the user is not associated with any team for the assignment' do
other_user = User.create!(name: "Name 2", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id)
expect(SignedUpTeam.get_team_id(other_user.id, assignment.id)).to be_nil
end
end
</pre>

2..drop_off_team_signup_records
</pre>
describe '.drop_off_team_signup_records' do
let!(:signup1) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team_id: team.id) }
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signup2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: true, team_id: team.id) }

it 'removes all sign-up records for the given team' do
expect { SignedUpTeam.drop_off_team_signup_records(team.id) }
.to change { SignedUpTeam.where(team_id: team.id).count }.by(-2)
end
end
</pre>

3.reassign_topic
</pre>
describe '#reassign_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, team_id: team.id) }
before do
allow(ProjectTopic).to receive(:find).with(project_topic.id).and_return(project_topic)
allow(project_topic).to receive(:drop_team_from_topic)
end

it 'reassigns the team to a new topic and marks them as not waitlisted' do
signed_up_team.reassign_topic(project_topic.id)
expect(signed_up_team.reload.is_waitlisted).to be_falsey
expect(project_topic).to have_received(:drop_team_from_topic).with(team_id: team.id)
end
</pre>

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125 Pull Request 125]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-04T04:13:14Z

Skanumu2: /* Testing */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation of sign up topic as project topic in the Expertiza backend.

==Problem Statement==
The following tasks were required for the reimplementation :
#Redesigning SignUpTopic as ProjectTopic: This involves reimplementing SignUpTopic class from the original expertiza repository as ProjectTopic within reimplementation-backend repository. This reimplementation should follow Rails best practices, use Ruby naming conventions, and adhere to the DRY principle to improve code maintainability and readability.
#Implementing Team Signup and Topic Drop Functionality: Adding methods to sign a team up for a topic and handling cases when a team drops a topic.
#Assignment Team Retrieval: Implementing a method to retrieve AssignmentTeams that are currently signed up for a specific topic, allowing for efficient tracking and management of team assignments.
#Slot Availability Management: Including methods for managing and retrieving the current number of available slots for a topic, updating as teams sign up or drop topics to reflect accurate availability.
#Writing tests for project topic model: RSpec tests have to be written for ProjectTopic Model.
#Writing Swagger UI tests for API endpoints: Swagger UI tests have to be written to test ProjectTopic and SignedUpTeam functionalities.

==Design Goal==
While reimplementing the SignUpTopic as ProjectTopic, the following design rules must be ensured:

* Maintain Functional Integrity: Validate the functionality of existing and new methods, incorporating any necessary improvements to meet updated requirements for managing topic signups, slot availability, and team assignments.

* Promote Loose Coupling and Tight Cohesion: Ensure that ProjectTopic and related classes, such as SignedUpTeam, are designed for optimal organization and maintainability, with clear separation of responsibilities to improve code quality and reduce dependencies.

* Apply the DRY Principle: Refactor any redundant code in the previous implementation, adhering to DRY principles by eliminating duplicated functionality from the Expertiza system and implementing reusable methods where possible.

* Ensure Robust Testing and Documentation: Validate the accuracy of existing test cases, updating them to reflect changes in ProjectTopic. Add comprehensive RSpec tests for new functionality, and perform Swagger UI testing on API endpoints to ensure complete coverage and reliability.

==Implementation==
Below are the methods implemented for the `project_topic` and `signed_up_team` classes. These methods handle slot availability, team sign-ups, waitlist management, topic reassignment, and data consistency. They ensure efficient topic allocation and seamless team management.
===project_topics ===

'''slot_available?''':

This method checks if there are any available slots for a team to sign up for the topic. This function is crucial for managing team assignments effectively without exceeding the maximum allowed capacity.

<pre>
def slot_available?
current_available_slots > 0
end
</pre>

---

'''assign_topic_to_team(new_sign_up)''':

This method assigns the current topic to a team by updating the provided sign-up record. It removes the team from the waitlist and associates the team with this topic. This ensures that the team's assignment is finalized and marked as active, not waitlisted. It is used in scenarios where a slot is available and the team can be directly assigned to the topic.

<pre>
def assign_topic_to_team(new_sign_up)
new_sign_up.update(is_waitlisted: false, sign_up_topic_id: self.id)
end
</pre>

---

'''save_waitlist_entry(new_sign_up)''':

This method adds a team to the waitlist for the current topic by marking the sign-up record as waitlisted and associating it with this topic. This function is invoked when no slots are available, ensuring the team is placed in the queue for future assignment. It maintains fairness and order in the sign-up process.

<pre>
def save_waitlist_entry(new_sign_up)
new_sign_up.update(is_waitlisted: true, sign_up_topic_id: self.id)
end
</pre>

---

'''sign_up_team(team_id)''':

This method handles the team sign-up process for the current topic. It first checks if the team is already signed up for the topic and ensures it is not waitlisted. If slots are available, the team is assigned to the topic directly. Otherwise, the team is added to the waitlist. This method is central to managing both immediate assignments and waitlisted entries.

<pre>
def sign_up_team(team_id)
topic_id = self.id

existing_sign_up = SignedUpTeam.find_by(sign_up_topic_id: topic_id, team_id: team_id)
return false if !existing_sign_up.nil? && !existing_sign_up.is_waitlisted

new_sign_up = SignedUpTeam.new(sign_up_topic_id: topic_id, team_id: team_id)

if slot_available?
assign_topic_to_team(new_sign_up)
result = SignedUpTeam.drop_off_team_waitlists(team_id)
else
result = save_waitlist_entry(new_sign_up)
end

result
end
</pre>

---

'''longest_waiting_team''':

This method retrieves the team that has been on the waitlist the longest for the current topic. It sorts the waitlisted entries by their creation time and returns the oldest entry. This is useful for assigning slots to teams in a fair and chronological manner as slots become available.

<pre>
def longest_waiting_team
SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: true).order(:created_at).first
end
</pre>

---

'''drop_team_from_topic(team_id)''':

This method removes a team from the current topic. If the removed team was not waitlisted, it reassigns the topic to the next waitlisted team, ensuring efficient utilization of available slots. The method then deletes the team's sign-up record, maintaining data consistency.

<pre>
def drop_team_from_topic(team_id)
signed_up_team = SignedUpTeam.find_by(team_id: team_id, sign_up_topic_id: self.id)
return nil unless signed_up_team

unless signed_up_team.is_waitlisted
next_waitlisted_team = longest_waiting_team
next_waitlisted_team&.reassign_topic(self.id)
end

signed_up_team.destroy
end
</pre>

---

'''signed_up_teams_for_topic''':

This method retrieves all teams that have signed up for the current topic, including both waitlisted and non-waitlisted teams. It provides an overview of the teams associated with a particular topic, aiding in administrative and reporting tasks.

<pre>
def signed_up_teams_for_topic
SignedUpTeam.where(sign_up_topic_id: self.id)
end
</pre>

---

'''current_available_slots''':

This method calculates the number of available slots for the topic by subtracting the count of non-waitlisted teams from the maximum allowed capacity. It ensures the integrity of slot management by providing real-time availability data, which is critical for the sign-up and waitlisting processes.

<pre>
def current_available_slots
teams_who_chose_the_topic = SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: false)
self.max_choosers.to_i - teams_who_chose_the_topic.size
end
</pre>

===signed_up_team===

'''drop_off_team_waitlists(team_id)''':

This class method removes all waitlisted entries for a specific team. It deletes all sign-up records where the team is marked as waitlisted, ensuring the team is no longer on any waitlists.

<pre>
def self.drop_off_team_waitlists(team_id)
SignedUpTeam.where(team_id: team_id, is_waitlisted: true).destroy_all
end
</pre>

---

'''create_signed_up_team(topic_id, team_id)''':

This class method creates a sign-up record for a team by associating it with the specified topic. It retrieves the project topic by its ID and uses the `sign_up_team` method to handle the sign-up process.

<pre>
def self.create_signed_up_team(topic_id, team_id)
project_topic = ProjectTopic.find(topic_id)
project_topic.sign_up_team(team_id)
end
</pre>

---

'''get_team_id(user_id, assignment_id)''':

This class method retrieves the team ID associated with a specific user and assignment. It first identifies the teams the user belongs to and then filters the team linked to the given assignment, returning its ID.

<pre>
def self.get_team_id(user_id, assignment_id)
team_ids = TeamsUser.select('team_id').where(user_id: user_id)
team_id = Team.where(team_id: team_ids, assignment_id: assignment_id).first.team_id
team_id
end
</pre>

---

'''drop_off_team_signup_records(team_id)''':

This class method deletes all sign-up records for a given team. It removes every entry associated with the specified team, clearing all their topic associations.

<pre>
def self.drop_off_team_signup_records(team_id)
SignedUpTeam.where(team_id: team_id).destroy_all
end
</pre>

---

'''reassign_topic(topic_id)''':

This instance method reassigns a team to a new topic. It first removes the team from its current topic if they are assigned, then updates the team's waitlist status to indicate they are now assigned to the new topic.

<pre>
def reassign_topic(topic_id)
assigned_team = SignedUpTeam.where(team_id: self.team_id, is_waitlisted: false)

unless assigned_team.nil?
project_topic = ProjectTopic.find(topic_id)
project_topic.drop_team_from_topic(team_id: self.team_id)
end

self.update(is_waitlisted: false)
end
</pre>

==Testing==

spec/models/project_topic_spec.rb

1.slot_available?
<pre>
describe '#slot_available?' do
context 'when no teams have chosen the topic' do
it 'returns true' do
expect(project_topic.slot_available?).to be true
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns false' do
expect(project_topic.slot_available?).to be false
end
end
end
</pre>

2.assign_topic_to_team
</pre>
describe '#assign_topic_to_team' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }

it 'assigns the topic to the team and updates waitlist status' do
project_topic.assign_topic_to_team(new_sign_up)
expect(new_sign_up.is_waitlisted).to be false
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

3.save_waitlist_entry
</pre>
describe '#save_waitlist_entry' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }

it 'adds a new sign-up to the waitlist' do
project_topic.save_waitlist_entry(new_sign_up)
expect(new_sign_up.is_waitlisted).to be true
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

4.sign_up_team
</pre>
describe '#sign_up_team' do
let(:new_team) { Team.create!(assignment_id: assignment.id) }

context 'when slot is available' do
it 'assigns the topic to the team and drops team waitlists' do
allow(SignedUpTeam).to receive(:drop_off_team_waitlists).with(new_team.id).and_return(true)

expect(project_topic.sign_up_team(new_team.id)).to be true
expect(SignedUpTeam).to have_received(:drop_off_team_waitlists).with(new_team.id)
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'adds the team to the waitlist' do
expect { project_topic.sign_up_team(new_team.id) }.to change { SignedUpTeam.count }.by(1)
expect(SignedUpTeam.last.is_waitlisted).to be true
end
end

context 'when the team is already signed up and not waitlisted' do
before do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team, is_waitlisted: false)
end

it 'returns false' do
expect(project_topic.sign_up_team(team.id)).to be false
end
end
end
</pre>

5.longest_waiting_team
</pre>
describe '#longest_waiting_team' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }

it 'returns the team that has been waitlisted the longest' do
expect(project_topic.longest_waiting_team).to eq(waitlisted_team)
end
end

describe '#drop_team_from_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team) }

it 'removes the team from the topic' do
expect { project_topic.drop_team_from_topic(team.id) }.to change { SignedUpTeam.count }.by(-1)
end

context 'when the team is not waitlisted' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }

it 'assigns the topic to the next waitlisted team' do
project_topic.drop_team_from_topic(team.id)
expect(waitlisted_team.reload.is_waitlisted).to be false
end
end
end
</pre>

6.current_available_slots
</pre>
describe '#current_available_slots' do
context 'when no teams have signed up' do
it 'returns max_choosers as available slots' do
expect(project_topic.current_available_slots).to eq(project_topic.max_choosers)
end
end

context 'when some teams have signed up' do
before do
2.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns the remaining available slots' do
expect(project_topic.current_available_slots).to eq(1)
end
 end
 end
end
</pre>

spec/models/signed_up_team_spec.rb

1.get_team_id
</pre>
describe '.get_team_id' do
let!(:user) { User.create!(name: "Name", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id) }
let!(:teams_user) { TeamsUser.create!(team_id: team.id, user_id: user.id) }

it 'returns the correct team ID for the given user and assignment' do
expect(SignedUpTeam.get_team_id(user.id, assignment.id)).to eq(team.id)
end

it 'returns nil if the user is not associated with any team for the assignment' do
other_user = User.create!(name: "Name 2", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id)
expect(SignedUpTeam.get_team_id(other_user.id, assignment.id)).to be_nil
end
end
</pre>

2..drop_off_team_signup_records
</pre>
describe '.drop_off_team_signup_records' do
let!(:signup1) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team_id: team.id) }
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signup2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: true, team_id: team.id) }

it 'removes all sign-up records for the given team' do
expect { SignedUpTeam.drop_off_team_signup_records(team.id) }
.to change { SignedUpTeam.where(team_id: team.id).count }.by(-2)
end
end
</pre>

3.reassign_topic
</pre>
describe '#reassign_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, team_id: team.id) }
before do
allow(ProjectTopic).to receive(:find).with(project_topic.id).and_return(project_topic)
allow(project_topic).to receive(:drop_team_from_topic)
end

it 'reassigns the team to a new topic and marks them as not waitlisted' do
signed_up_team.reassign_topic(project_topic.id)
expect(signed_up_team.reload.is_waitlisted).to be_falsey
expect(project_topic).to have_received(:drop_team_from_topic).with(team_id: team.id)
end
 end
end
</pre>

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125 Pull Request 125]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-04T04:06:18Z

Skanumu2: /* Test Plan */

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation of sign up topic as project topic in the Expertiza backend.

==Problem Statement==
The following tasks were required for the reimplementation :
#Redesigning SignUpTopic as ProjectTopic: This involves reimplementing SignUpTopic class from the original expertiza repository as ProjectTopic within reimplementation-backend repository. This reimplementation should follow Rails best practices, use Ruby naming conventions, and adhere to the DRY principle to improve code maintainability and readability.
#Implementing Team Signup and Topic Drop Functionality: Adding methods to sign a team up for a topic and handling cases when a team drops a topic.
#Assignment Team Retrieval: Implementing a method to retrieve AssignmentTeams that are currently signed up for a specific topic, allowing for efficient tracking and management of team assignments.
#Slot Availability Management: Including methods for managing and retrieving the current number of available slots for a topic, updating as teams sign up or drop topics to reflect accurate availability.
#Writing tests for project topic model: RSpec tests have to be written for ProjectTopic Model.
#Writing Swagger UI tests for API endpoints: Swagger UI tests have to be written to test ProjectTopic and SignedUpTeam functionalities.

==Design Goal==
While reimplementing the SignUpTopic as ProjectTopic, the following design rules must be ensured:

* Maintain Functional Integrity: Validate the functionality of existing and new methods, incorporating any necessary improvements to meet updated requirements for managing topic signups, slot availability, and team assignments.

* Promote Loose Coupling and Tight Cohesion: Ensure that ProjectTopic and related classes, such as SignedUpTeam, are designed for optimal organization and maintainability, with clear separation of responsibilities to improve code quality and reduce dependencies.

* Apply the DRY Principle: Refactor any redundant code in the previous implementation, adhering to DRY principles by eliminating duplicated functionality from the Expertiza system and implementing reusable methods where possible.

* Ensure Robust Testing and Documentation: Validate the accuracy of existing test cases, updating them to reflect changes in ProjectTopic. Add comprehensive RSpec tests for new functionality, and perform Swagger UI testing on API endpoints to ensure complete coverage and reliability.

==Implementation==
Below are the methods implemented for the `project_topic` and `signed_up_team` classes. These methods handle slot availability, team sign-ups, waitlist management, topic reassignment, and data consistency. They ensure efficient topic allocation and seamless team management.
===project_topics ===

'''slot_available?''':

This method checks if there are any available slots for a team to sign up for the topic. This function is crucial for managing team assignments effectively without exceeding the maximum allowed capacity.

<pre>
def slot_available?
current_available_slots > 0
end
</pre>

---

'''assign_topic_to_team(new_sign_up)''':

This method assigns the current topic to a team by updating the provided sign-up record. It removes the team from the waitlist and associates the team with this topic. This ensures that the team's assignment is finalized and marked as active, not waitlisted. It is used in scenarios where a slot is available and the team can be directly assigned to the topic.

<pre>
def assign_topic_to_team(new_sign_up)
new_sign_up.update(is_waitlisted: false, sign_up_topic_id: self.id)
end
</pre>

---

'''save_waitlist_entry(new_sign_up)''':

This method adds a team to the waitlist for the current topic by marking the sign-up record as waitlisted and associating it with this topic. This function is invoked when no slots are available, ensuring the team is placed in the queue for future assignment. It maintains fairness and order in the sign-up process.

<pre>
def save_waitlist_entry(new_sign_up)
new_sign_up.update(is_waitlisted: true, sign_up_topic_id: self.id)
end
</pre>

---

'''sign_up_team(team_id)''':

This method handles the team sign-up process for the current topic. It first checks if the team is already signed up for the topic and ensures it is not waitlisted. If slots are available, the team is assigned to the topic directly. Otherwise, the team is added to the waitlist. This method is central to managing both immediate assignments and waitlisted entries.

<pre>
def sign_up_team(team_id)
topic_id = self.id

existing_sign_up = SignedUpTeam.find_by(sign_up_topic_id: topic_id, team_id: team_id)
return false if !existing_sign_up.nil? && !existing_sign_up.is_waitlisted

new_sign_up = SignedUpTeam.new(sign_up_topic_id: topic_id, team_id: team_id)

if slot_available?
assign_topic_to_team(new_sign_up)
result = SignedUpTeam.drop_off_team_waitlists(team_id)
else
result = save_waitlist_entry(new_sign_up)
end

result
end
</pre>

---

'''longest_waiting_team''':

This method retrieves the team that has been on the waitlist the longest for the current topic. It sorts the waitlisted entries by their creation time and returns the oldest entry. This is useful for assigning slots to teams in a fair and chronological manner as slots become available.

<pre>
def longest_waiting_team
SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: true).order(:created_at).first
end
</pre>

---

'''drop_team_from_topic(team_id)''':

This method removes a team from the current topic. If the removed team was not waitlisted, it reassigns the topic to the next waitlisted team, ensuring efficient utilization of available slots. The method then deletes the team's sign-up record, maintaining data consistency.

<pre>
def drop_team_from_topic(team_id)
signed_up_team = SignedUpTeam.find_by(team_id: team_id, sign_up_topic_id: self.id)
return nil unless signed_up_team

unless signed_up_team.is_waitlisted
next_waitlisted_team = longest_waiting_team
next_waitlisted_team&.reassign_topic(self.id)
end

signed_up_team.destroy
end
</pre>

---

'''signed_up_teams_for_topic''':

This method retrieves all teams that have signed up for the current topic, including both waitlisted and non-waitlisted teams. It provides an overview of the teams associated with a particular topic, aiding in administrative and reporting tasks.

<pre>
def signed_up_teams_for_topic
SignedUpTeam.where(sign_up_topic_id: self.id)
end
</pre>

---

'''current_available_slots''':

This method calculates the number of available slots for the topic by subtracting the count of non-waitlisted teams from the maximum allowed capacity. It ensures the integrity of slot management by providing real-time availability data, which is critical for the sign-up and waitlisting processes.

<pre>
def current_available_slots
teams_who_chose_the_topic = SignedUpTeam.where(sign_up_topic_id: self.id, is_waitlisted: false)
self.max_choosers.to_i - teams_who_chose_the_topic.size
end
</pre>

===signed_up_team===

'''drop_off_team_waitlists(team_id)''':

This class method removes all waitlisted entries for a specific team. It deletes all sign-up records where the team is marked as waitlisted, ensuring the team is no longer on any waitlists.

<pre>
def self.drop_off_team_waitlists(team_id)
SignedUpTeam.where(team_id: team_id, is_waitlisted: true).destroy_all
end
</pre>

---

'''create_signed_up_team(topic_id, team_id)''':

This class method creates a sign-up record for a team by associating it with the specified topic. It retrieves the project topic by its ID and uses the `sign_up_team` method to handle the sign-up process.

<pre>
def self.create_signed_up_team(topic_id, team_id)
project_topic = ProjectTopic.find(topic_id)
project_topic.sign_up_team(team_id)
end
</pre>

---

'''get_team_id(user_id, assignment_id)''':

This class method retrieves the team ID associated with a specific user and assignment. It first identifies the teams the user belongs to and then filters the team linked to the given assignment, returning its ID.

<pre>
def self.get_team_id(user_id, assignment_id)
team_ids = TeamsUser.select('team_id').where(user_id: user_id)
team_id = Team.where(team_id: team_ids, assignment_id: assignment_id).first.team_id
team_id
end
</pre>

---

'''drop_off_team_signup_records(team_id)''':

This class method deletes all sign-up records for a given team. It removes every entry associated with the specified team, clearing all their topic associations.

<pre>
def self.drop_off_team_signup_records(team_id)
SignedUpTeam.where(team_id: team_id).destroy_all
end
</pre>

---

'''reassign_topic(topic_id)''':

This instance method reassigns a team to a new topic. It first removes the team from its current topic if they are assigned, then updates the team's waitlist status to indicate they are now assigned to the new topic.

<pre>
def reassign_topic(topic_id)
assigned_team = SignedUpTeam.where(team_id: self.team_id, is_waitlisted: false)

unless assigned_team.nil?
project_topic = ProjectTopic.find(topic_id)
project_topic.drop_team_from_topic(team_id: self.team_id)
end

self.update(is_waitlisted: false)
end
</pre>

==Testing==

spec/models/project_topic_spec.rb

1.slot_available?
<pre>
describe '#slot_available?' do
context 'when no teams have chosen the topic' do
it 'returns true' do
expect(project_topic.slot_available?).to be true
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns false' do
expect(project_topic.slot_available?).to be false
end
end
end
</pre>

2.assign_topic_to_team
</pre>
describe '#assign_topic_to_team' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }

it 'assigns the topic to the team and updates waitlist status' do
project_topic.assign_topic_to_team(new_sign_up)
expect(new_sign_up.is_waitlisted).to be false
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

3.save_waitlist_entry
</pre>
describe '#save_waitlist_entry' do
let(:new_sign_up) { SignedUpTeam.new(sign_up_topic_id: nil, team_id: team.id) }

it 'adds a new sign-up to the waitlist' do
project_topic.save_waitlist_entry(new_sign_up)
expect(new_sign_up.is_waitlisted).to be true
expect(new_sign_up.sign_up_topic_id).to eq(project_topic.id)
end
end
</pre>

4.sign_up_team
</pre>
describe '#sign_up_team' do
let(:new_team) { Team.create!(assignment_id: assignment.id) }

context 'when slot is available' do
it 'assigns the topic to the team and drops team waitlists' do
allow(SignedUpTeam).to receive(:drop_off_team_waitlists).with(new_team.id).and_return(true)

expect(project_topic.sign_up_team(new_team.id)).to be true
expect(SignedUpTeam).to have_received(:drop_off_team_waitlists).with(new_team.id)
end
end

context 'when no slots are available' do
before do
project_topic.max_choosers.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'adds the team to the waitlist' do
expect { project_topic.sign_up_team(new_team.id) }.to change { SignedUpTeam.count }.by(1)
expect(SignedUpTeam.last.is_waitlisted).to be true
end
end

context 'when the team is already signed up and not waitlisted' do
before do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team, is_waitlisted: false)
end

it 'returns false' do
expect(project_topic.sign_up_team(team.id)).to be false
end
end
end
</pre>

5.longest_waiting_team
</pre>
describe '#longest_waiting_team' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }

it 'returns the team that has been waitlisted the longest' do
expect(project_topic.longest_waiting_team).to eq(waitlisted_team)
end
end

describe '#drop_team_from_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, team: team) }

it 'removes the team from the topic' do
expect { project_topic.drop_team_from_topic(team.id) }.to change { SignedUpTeam.count }.by(-1)
end

context 'when the team is not waitlisted' do
let!(:waitlisted_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, created_at: 1.day.ago, team: Team.create!(assignment_id: assignment.id)) }

it 'assigns the topic to the next waitlisted team' do
project_topic.drop_team_from_topic(team.id)
expect(waitlisted_team.reload.is_waitlisted).to be false
end
end
end
</pre>

6.current_available_slots
</pre>
describe '#current_available_slots' do
context 'when no teams have signed up' do
it 'returns max_choosers as available slots' do
expect(project_topic.current_available_slots).to eq(project_topic.max_choosers)
end
end

context 'when some teams have signed up' do
before do
2.times do
SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team: Team.create!(assignment_id: assignment.id))
end
end

it 'returns the remaining available slots' do
expect(project_topic.current_available_slots).to eq(1)
end
 end
 end
end
</pre>

spec/models/signed_up_team_spec.rb

1.get_team_id
</pre>
describe '.get_team_id' do
let!(:user) { User.create!(name: "Name", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id) }
let!(:teams_user) { TeamsUser.create!(team_id: team.id, user_id: user.id) }

it 'returns the correct team ID for the given user and assignment' do
expect(SignedUpTeam.get_team_id(user.id, assignment.id)).to eq(team.id)
end

it 'returns nil if the user is not associated with any team for the assignment' do
other_user = User.create!(name: "Name 2", password: "password", full_name: "Full Name", email: "email@example.com", mru_directory_path: "/dummy/path", role_id: role.id)
expect(SignedUpTeam.get_team_id(other_user.id, assignment.id)).to be_nil
end
end
</pre>

2..drop_off_team_signup_records
</pre>
describe '.drop_off_team_signup_records' do
let!(:signup1) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: false, team_id: team.id) }
let!(:project_topic_2) { ProjectTopic.create!(topic_name: "Dummy Topic 2", assignment_id: assignment.id, max_choosers: 3) }
let!(:signup2) { SignedUpTeam.create!(sign_up_topic_id: project_topic_2.id, is_waitlisted: true, team_id: team.id) }

it 'removes all sign-up records for the given team' do
expect { SignedUpTeam.drop_off_team_signup_records(team.id) }
.to change { SignedUpTeam.where(team_id: team.id).count }.by(-2)
end
end
</pre>

3.reassign_topic
</pre>
describe '#reassign_topic' do
let!(:signed_up_team) { SignedUpTeam.create!(sign_up_topic_id: project_topic.id, is_waitlisted: true, team_id: team.id) }

before do
allow(ProjectTopic).to receive(:find).with(project_topic.id).and_return(project_topic)
allow(project_topic).to receive(:drop_team_from_topic)
end

it 'reassigns the team to a new topic and marks them as not waitlisted' do
signed_up_team.reassign_topic(project_topic.id)
expect(signed_up_team.reload.is_waitlisted).to be_falsey
expect(project_topic).to have_received(:drop_team_from_topic).with(team_id: team.id)
end
 end
end
</pre>

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125 Pull Request 125]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-04T02:20:56Z

Skanumu2: /* Implementation */

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-04T02:13:59Z

Skanumu2: /* Implementation */

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-04T02:13:15Z

Skanumu2: /* Implementation */

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-12-04T02:12:31Z

Skanumu2:

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-11-13T04:39:03Z

Skanumu2:

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-11-13T04:34:19Z

Skanumu2:

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-11-13T04:32:54Z

Skanumu2:

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-11-13T03:27:19Z

Skanumu2:

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-11-13T03:12:17Z

Skanumu2:

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation of sign up topic as project topic in the Expertiza backend.

==Problem Statement==
The following tasks were required for the reimplementation :
#Redesigning SignUpTopic as ProjectTopic: This involves reimplementing SignUpTopic class from the original expertiza repository as ProjectTopic within reimplementation-backend repository. This reimplementation should follow Rails best practices, use Ruby naming conventions, and adhere to the DRY principle to improve code maintainability and readability.
#Implementing Team Signup and Topic Drop Functionality: Adding methods to sign a team up for a topic and handling cases when a team drops a topic.
#Assignment Team Retrieval: Implementing a method to retrieve AssignmentTeams that are currently signed up for a specific topic, allowing for efficient tracking and management of team assignments.
#Slot Availability Management: Including methods for managing and retrieving the current number of available slots for a topic, updating as teams sign up or drop topics to reflect accurate availability.
#Due Date Retrieval for Signup Topics: Implementing methods to collect and return signup topics with their associated submission and review due dates for a particular assignment, aiding in deadline management for teams.
#Writing tests for project topic model: RSpec tests have to be written for ProjectTopic Model.
#Writing Swagger UI tests for API endpoints: Swagger UI tests have to be written to test ProjectTopic and SignedUpTeam functionalities.

==Design Goal==
While reimplementing the SignUpTopic as ProjectTopic, the following design rules must be ensured:

* Maintain Functional Integrity: Validate the functionality of existing and new methods, incorporating any necessary improvements to meet updated requirements for managing topic signups, slot availability, and team assignments.

* Promote Loose Coupling and Tight Cohesion: Ensure that ProjectTopic and related classes, such as SignedUpTeam, are designed for optimal organization and maintainability, with clear separation of responsibilities to improve code quality and reduce dependencies.

* Apply the DRY Principle: Refactor any redundant code in the previous implementation, adhering to DRY principles by eliminating duplicated functionality from the Expertiza system and implementing reusable methods where possible.

* Ensure Robust Testing and Documentation: Validate the accuracy of existing test cases, updating them to reflect changes in ProjectTopic. Add comprehensive RSpec tests for new functionality, and perform Swagger UI testing on API endpoints to ensure complete coverage and reliability.

==Implementation Plan==

Documentation for methods that will be re-implemented and implemented as it is:

* valid_num_review
This method raises an error if more reviews are required than are allowed. But it is a single method for both reviews and meta reviews. In the reimplemented method, type of review will be a parameter.
* varying_rubrics_by_round?
This method checks whether different rubrics are being used in different rounds of review. It does it, however, by checking whether more than one rubric is listed as being used in Round 2 (used_in_round = 2). The reimplemented method will check if we have more than one rubric of a given type for an assignment.
* badge?
This method returns the value of the has_badge instance variable and this should be renamed to has_badge?.
* calibrated?
This method returns the value of the is_calibrated instance variable and should be renamed is_calibrated?.
* current_stage
his method returns the current stage (Submission, Review, Finished, etc.) potentially based on which topic the logged-in user holds. It returns a string, which is useful for printing, though a bit informal. However, since this method is quite similar to two other methods - current_stage_name and stage_deadline, these three can be combined with some modifications in the reimplementation for clarity. For these, we will create a duedate model and implement the get_next_due_date method 2 subclasses- TopicDueDate and AssignmentDueDate.
* current_stage_name
This is a convoluted method that returns the same thing as current_stage, except in a few specialized cases, such as when the assignment has topics and the user hasn’t chosen a topic. However, since this method is quite similar to two other methods - current_stage and stage_deadline, these three can be combined with some modifications in the reimplementation for clarity. For these, we will create a duedate model and implement the get_next_due_date method 2 subclasses- TopicDueDate and AssignmentDueDate.
* stage_deadline
This method is similar to current_stage, but returns the time of the next deadline unless the assignment is finished. However, since this method is quite similar to two other methods - current_stage_name and current_stage, these three can be combined with some modifications in the reimplementation for clarity. For these, we will create a duedate model and implement the get_next_due_date method 2 subclasses- TopicDueDate and AssignmentDueDate.
* num_reviews_greater?
This method checks whether the number of reviews required is greater than the number of reviews allowed. Basically, it just compares two instance variables of Assignment,but handles the special cases of reviews_allowed being null or negative. In the reimplemented method, we will check if reviews_allowed is valid or not in a separate function.
* quiz_allowed
This method returns the quiz_allowed_id field of the next due date, i.e., whether a participant is currently allowed to take a quiz. This method will be reimplemented without making a direct call to the check_condition.
* response_map_to_metareview
This method finds the “most appropriate” ResponseMap to use as the reviewed_object in a new MetareviewResponseMap. This can be made as a class method of MetareviewResponseMap and combined with the reviewer_metareviews_map method that is basically a step of this method.
* review_questionnaire_id
This method finds the questionnaire in use for reviews of work submitted for the assignment. This is a complicated method because it calculates to find the round number, instead of using number_of_current_round(...). In the reimplementation, instead of creating a new form, we can use an already existing form that is associated with the assignment. The logic behind determining a round number based on the topic can also be improved.
* reviewer_metareviews_map
This is a step in finding the response_map_to_metareview. There is no need for a separate method for finding reviewer_metareviews_map. This method can be combined with response_map_to_metareview during reimplementation.

Note : The following methods do not require specific changes and will be implemented accordingly.

* create_node
This method creates an AssignmentNode for this assignment.
* pair_programming_enabled?
This method returns the value of the enable_pair_programming instance variable.

* staggered_and_no_topic?
This method checks if the assignment is a staggered-deadline assignment and the logged-in user has not chosen a topic.

* team_assignment?
This method checks whether max_team_size > 0 (should be > 1).

* teams?
This method is used to check whether any teams exist for this assignment.
* topics?
This method is used to check whether any topics exist for this assignment.
* create_node
This method creates an AssignmentNode for this assignment.

Note : The following methods will be removed as they are no longer required in the new implementation -

Methods to be moved to another models : 

*assign_metareviewer_dynamically
*can_review
*check_condition
*find_current_stage
*find_due_dates
*find_reveiw_period
*link_for_current_stage
*metareview_allowed
*num_review_rounds
*num_of_current_round
*submission_allowed
*user_on_team?

Methods to be removed : 

*microtask?
*min_metareview
*questionnaire_ids
*remove_empty_teams

==Test Plan==

We plan to use the given test skeletons for assignment model and implement the respective Rspec test cases. The test cases for other methods will be included later as reimplementation might have methods which are combined versions of multiple other methods. The test scenarios for some for the methods are mentioned in the following table.

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || team_assignment?
|-
| 1.1 || Scenario 1: Max_team_size is greater than 0. Expected: true
|-
| 1.2 || Scenario 2: Max_team_size is equal to 0. Expected: false
|-
| 1.3 || Scenario 3: Max_team_size is less than 0. Expected: false
|-
| 2 || topics
|-
| 2.1 || Scenario 1: Sign_up_topics is empty. Expected: false
|-
| 2.2 || Scenario 2: Sign_up_topics is not empty. Expected: true
|-
| 3 || calibrated?
|-
| 3.1 || Scenario 1: The object is calibrated. Expected: true
|-
| 3.2 || Scenario 2: The object is not calibrated. Expected: false
|-
| 4 || teams
|-
| 4.1 || Scenario 1: Teams are present. Expected: true
|-
| 4.2 || Scenario 2: Teams are not present. Expected: false
|-
| 5 || valid_num_review
|-
| 5.1 || Scenario 1: Number of reviews required is greater than the number of reviews allowed. Expected: Error message
|-
| 5.2 || Scenario 2: Number of meta-reviews required is greater than the number of meta-reviews allowed. Expected: Error message
|-
| 6 || dynamic_reviewer_assignment?
|-
| 6.1 || Scenario 1: Review assignment strategy is RS_AUTO_SELECTED. Expected: true
|-
| 6.2 || Scenario 2: Review assignment strategy is not RS_AUTO_SELECTED. Expected: false
|-
| 7 || badge?
|-
| 7.1 || Scenario 1: Has_badge is nil. Expected: false
|-
| 7.2 || Scenario 2: Has_badge is true. Expected: true
|-
| 7.3 || Scenario 3: Has_badge is false. Expected: false
|-
| 8 || create_node
|-
| 8.1 || Scenario 1: Parent node exists. Expected: New node created with parent_id set.
|-
| 8.2 || Scenario 2: Parent node does not exist. Expected: New node created with no parent_id set.
|-
| 9 || varying_rubrics_by_round?
|-
| 9.1 || Scenario 1: Rubrics of a given type exist in round 2. Expected: true
|-
| 9.2 || Scenario 2: Multiple rubrics of a given type exist in round 2. Expected: true
|-
| 9.3 || Scenario 3: No rubrics of a given type exist in round 2. Expected: false
|-
| 10 || num_review_rounds
|-
| 10.1 || Scenario 1: No due dates. Expected: 0
|-
| 10.2 || Scenario 2: Single due date with round 1. Expected: 1
|-
| 10.3 || Scenario 3: Multiple due dates with different rounds. Expected: Highest round number
|-
| 10.4 || Scenario 4: Multiple due dates with the same round number. Expected: Highest round number
|-
| 11 || review_questionnaire_id
|-
| 11.1 || Scenario 1: No round_number and topic_id provided. Expected: id of the current round's review questionnaire.
|-
| 11.2 || Scenario 2: No round_number and topic_id provided, no next due date. Expected: nil
|-
| 12 || pair_programming_enabled?
|-
| 12.1 || Scenario 1: Pair programming is enabled. Expected: true
|-
| 12.2 || Scenario 2: Pair programming is disabled. Expected: false
|-
| 13 || staggered_and_no_topic?
|-
| 13.1 || Scenario 1: Staggered deadline is enabled, topic_id not provided. Expected: true
|-
| 13.2 || Scenario 2: Staggered deadline is enabled, topic_id provided. Expected: false
|}

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

== Team Members ==

* Ajith Kanumuri
* Suhas Adidela
* Ravi Chandu Bollepalli
* Mentor - Dinesh Pasupuleti
* PR Request:- https://github.com/expertiza/reimplementation-back-end/pull/125
* Project Board:- https://github.com/users/ajith05/projects/1/views/1
* Deployment Link:- http://152.7.177.8:3002/api-docs

== Project Description ==

The main goal of this project is to reimplement essential Ruby on Rails model classes—SignedUpTeam and ProjectTopic (renamed from SignUpTopic)—from the Expertiza repository in a new repository. Each of these model classes plays a critical role in managing topics and team sign-ups within course assignments, and the reimplementation aims to bring them into alignment with Rails best practices and the DRY (Don't Repeat Yourself) principle.

The SignedUpTeam model represents a team that has signed up for a specific topic within an assignment. This model manages team-specific data and oversees interactions that occur during the sign-up process. The ProjectTopic model, on the other hand, represents the topics available for sign-up within an assignment, managing essential details like slot availability and assigning teams to open topics.

Since this project is being implemented from scratch, a range of components have been developed to ensure the functionality is both streamlined and maintainable. To guarantee the reliability of each part of the reimplementation, unit test cases have been created to verify the integrity of the new design and implementation.

== Issue Description ==

* Comprehensive RSpec tests are essential for all reimplemented models to ensure correctness and reliability in functionality.

* Update all references from `sign_up_topics` to `project_topics` throughout the codebase to maintain consistency with the new naming convention.

* Address all code review feedback to improve code quality and alignment with best practices.

* Refactor methods with readability issues to make the code more maintainable and easier to understand.

* Optimize ambiguous class and instance methods to enhance reusability and improve the overall structure of the code.

* The old codebase has several instances of unnecessary calls to database, such as fetching all project topics for a user when fetching first topic would be sufficient. This effects efficiency and readability. Optimize such instances of code to streamline and increase readability.

== Design Strategy ==

* Implemented three model classes: `sign_up_team.rb` and `project_topic.rb` to address project requirements.
* Each model now has a focused role, improving maintainability and clarity.
* In signed_up_team.rb, the following functionality are being implemented:-

;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| drop_off_team_waitlists || Implemented || Removes the team from all waitlists for topics within the assignment.
|-
| find_first_existing_sign_up || Implemented || Finds the first existing sign-up entry for a given topic and team, checking for both active and waitlisted sign-ups.
|-
| create_signed_up_team || Implemented || Creates a SignedUpTeam instance with specified topic_id and team_id if the topic is available for sign-up.
|-
| get_team_id || Implemented || Retrieves the team ID associated with a given SignedUpTeam entry.
|-
| delete_signed_up_team || Implemented || Deletes the signed-up team entry for a specific topic, managing any dependent records as necessary.

|}
* Add necessary schema migrations to rename signup topic to project topic.
* In project_topic.rb, the following functionality are being implemented:-
*;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| slot_available? || Implemented || Checks if there are available slots for the topic based on the maximum allowed choosers. Returns true if available.
|-
| assign_topic_to_team || Implemented || Assigns the topic to a team by updating the sign-up entry to set is_waitlisted as false and assign the topic_id.
|-
| save_waitlist_entry || Implemented || Saves a sign-up entry as a waitlist entry by setting is_waitlisted to true and assigning the topic_id.
|-
| sign_up_team || Implemented || Manages the sign-up process for a team, checking slot availability, assigning the topic, or placing the team on the waitlist as needed
|}

== E/R Diagram ==
[[File:oodd.png |500px|center]]
Edit Button Tooltip

== Test Plan ==

*Set Up Initial Data: Create necessary records (Role, Instructor, Assignment, ProjectTopic, and Team) to establish relationships and dependencies required for testing ProjectTopic.

*Verify Slot Availability with No Teams Signed Up: Test slot_available? to ensure it returns true when no teams have chosen the topic, confirming that the method correctly identifies open slots.

*Test Topic Assignment Without Waitlisting: Use assign_topic_to_team to assign a topic to a team directly (without waitlisting) and check that is_waitlisted is set to false and the topic ID is correctly assigned.

*Simulate Slot Availability with Waitlist Clearance: Test sign_up_team when slots are available, mock drop_off_team_waitlists, and verify that the new team is assigned to the topic and the waitlist is cleared.

*Assert Expected Outcomes for Each Scenario: Validate results of each test by checking specific conditions, such as correct topic ID assignment, is_waitlisted status, and expected method calls, ensuring all methods perform accurately across various conditions.
* Test Cases for project_topic.rb model
[[File:Project_topic.jpg |1000px|center]]
Edit Button Tooltip

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-11-13T03:00:13Z

Skanumu2:

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation of sign up topic as project topic in the Expertiza backend.

==Problem Statement==
The following tasks were required for the reimplementation :
#Redesigning SignUpTopic as ProjectTopic: This involves reimplementing SignUpTopic class from the original expertiza repository as ProjectTopic within reimplementation-backend repository. This reimplementation should follow Rails best practices, use Ruby naming conventions, and adhere to the DRY principle to improve code maintainability and readability.
#Implementing Team Signup and Topic Drop Functionality: Adding methods to sign a team up for a topic and handling cases when a team drops a topic.
#Assignment Team Retrieval: Implementing a method to retrieve AssignmentTeams that are currently signed up for a specific topic, allowing for efficient tracking and management of team assignments.
#Slot Availability Management: Including methods for managing and retrieving the current number of available slots for a topic, updating as teams sign up or drop topics to reflect accurate availability.
#Due Date Retrieval for Signup Topics: Implementing methods to collect and return signup topics with their associated submission and review due dates for a particular assignment, aiding in deadline management for teams.
#Writing tests for project topic model: RSpec tests have to be written for ProjectTopic Model.
#Writing Swagger UI tests for API endpoints: Swagger UI tests have to be written to test ProjectTopic and SignedUpTeam functionalities.

==Design Goal==
While reimplementation of Assignment model and controller, the following design rules have to be ensured:
* Validate proper functioning of all existing and anticipated methods, making any required enhancements or adjustments.
* Establish loose coupling and tight cohesion for the model and controller to enhance code organization and maintainability.
* Refactor redundant code in the previous implementation's controller and model methods using DRY principle, eliminating functionality duplications already present in the expertiza system.
* Confirm the continued effectiveness of existing test cases following the aforementioned modifications and generate additional test cases as per the need.

==Implementation Plan==

Documentation for methods that will be re-implemented and implemented as it is:

* valid_num_review
This method raises an error if more reviews are required than are allowed. But it is a single method for both reviews and meta reviews. In the reimplemented method, type of review will be a parameter.
* varying_rubrics_by_round?
This method checks whether different rubrics are being used in different rounds of review. It does it, however, by checking whether more than one rubric is listed as being used in Round 2 (used_in_round = 2). The reimplemented method will check if we have more than one rubric of a given type for an assignment.
* badge?
This method returns the value of the has_badge instance variable and this should be renamed to has_badge?.
* calibrated?
This method returns the value of the is_calibrated instance variable and should be renamed is_calibrated?.
* current_stage
his method returns the current stage (Submission, Review, Finished, etc.) potentially based on which topic the logged-in user holds. It returns a string, which is useful for printing, though a bit informal. However, since this method is quite similar to two other methods - current_stage_name and stage_deadline, these three can be combined with some modifications in the reimplementation for clarity. For these, we will create a duedate model and implement the get_next_due_date method 2 subclasses- TopicDueDate and AssignmentDueDate.
* current_stage_name
This is a convoluted method that returns the same thing as current_stage, except in a few specialized cases, such as when the assignment has topics and the user hasn’t chosen a topic. However, since this method is quite similar to two other methods - current_stage and stage_deadline, these three can be combined with some modifications in the reimplementation for clarity. For these, we will create a duedate model and implement the get_next_due_date method 2 subclasses- TopicDueDate and AssignmentDueDate.
* stage_deadline
This method is similar to current_stage, but returns the time of the next deadline unless the assignment is finished. However, since this method is quite similar to two other methods - current_stage_name and current_stage, these three can be combined with some modifications in the reimplementation for clarity. For these, we will create a duedate model and implement the get_next_due_date method 2 subclasses- TopicDueDate and AssignmentDueDate.
* num_reviews_greater?
This method checks whether the number of reviews required is greater than the number of reviews allowed. Basically, it just compares two instance variables of Assignment,but handles the special cases of reviews_allowed being null or negative. In the reimplemented method, we will check if reviews_allowed is valid or not in a separate function.
* quiz_allowed
This method returns the quiz_allowed_id field of the next due date, i.e., whether a participant is currently allowed to take a quiz. This method will be reimplemented without making a direct call to the check_condition.
* response_map_to_metareview
This method finds the “most appropriate” ResponseMap to use as the reviewed_object in a new MetareviewResponseMap. This can be made as a class method of MetareviewResponseMap and combined with the reviewer_metareviews_map method that is basically a step of this method.
* review_questionnaire_id
This method finds the questionnaire in use for reviews of work submitted for the assignment. This is a complicated method because it calculates to find the round number, instead of using number_of_current_round(...). In the reimplementation, instead of creating a new form, we can use an already existing form that is associated with the assignment. The logic behind determining a round number based on the topic can also be improved.
* reviewer_metareviews_map
This is a step in finding the response_map_to_metareview. There is no need for a separate method for finding reviewer_metareviews_map. This method can be combined with response_map_to_metareview during reimplementation.

Note : The following methods do not require specific changes and will be implemented accordingly.

* create_node
This method creates an AssignmentNode for this assignment.
* pair_programming_enabled?
This method returns the value of the enable_pair_programming instance variable.

* staggered_and_no_topic?
This method checks if the assignment is a staggered-deadline assignment and the logged-in user has not chosen a topic.

* team_assignment?
This method checks whether max_team_size > 0 (should be > 1).

* teams?
This method is used to check whether any teams exist for this assignment.
* topics?
This method is used to check whether any topics exist for this assignment.
* create_node
This method creates an AssignmentNode for this assignment.

Note : The following methods will be removed as they are no longer required in the new implementation -

Methods to be moved to another models : 

*assign_metareviewer_dynamically
*can_review
*check_condition
*find_current_stage
*find_due_dates
*find_reveiw_period
*link_for_current_stage
*metareview_allowed
*num_review_rounds
*num_of_current_round
*submission_allowed
*user_on_team?

Methods to be removed : 

*microtask?
*min_metareview
*questionnaire_ids
*remove_empty_teams

==Test Plan==

We plan to use the given test skeletons for assignment model and implement the respective Rspec test cases. The test cases for other methods will be included later as reimplementation might have methods which are combined versions of multiple other methods. The test scenarios for some for the methods are mentioned in the following table.

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || team_assignment?
|-
| 1.1 || Scenario 1: Max_team_size is greater than 0. Expected: true
|-
| 1.2 || Scenario 2: Max_team_size is equal to 0. Expected: false
|-
| 1.3 || Scenario 3: Max_team_size is less than 0. Expected: false
|-
| 2 || topics
|-
| 2.1 || Scenario 1: Sign_up_topics is empty. Expected: false
|-
| 2.2 || Scenario 2: Sign_up_topics is not empty. Expected: true
|-
| 3 || calibrated?
|-
| 3.1 || Scenario 1: The object is calibrated. Expected: true
|-
| 3.2 || Scenario 2: The object is not calibrated. Expected: false
|-
| 4 || teams
|-
| 4.1 || Scenario 1: Teams are present. Expected: true
|-
| 4.2 || Scenario 2: Teams are not present. Expected: false
|-
| 5 || valid_num_review
|-
| 5.1 || Scenario 1: Number of reviews required is greater than the number of reviews allowed. Expected: Error message
|-
| 5.2 || Scenario 2: Number of meta-reviews required is greater than the number of meta-reviews allowed. Expected: Error message
|-
| 6 || dynamic_reviewer_assignment?
|-
| 6.1 || Scenario 1: Review assignment strategy is RS_AUTO_SELECTED. Expected: true
|-
| 6.2 || Scenario 2: Review assignment strategy is not RS_AUTO_SELECTED. Expected: false
|-
| 7 || badge?
|-
| 7.1 || Scenario 1: Has_badge is nil. Expected: false
|-
| 7.2 || Scenario 2: Has_badge is true. Expected: true
|-
| 7.3 || Scenario 3: Has_badge is false. Expected: false
|-
| 8 || create_node
|-
| 8.1 || Scenario 1: Parent node exists. Expected: New node created with parent_id set.
|-
| 8.2 || Scenario 2: Parent node does not exist. Expected: New node created with no parent_id set.
|-
| 9 || varying_rubrics_by_round?
|-
| 9.1 || Scenario 1: Rubrics of a given type exist in round 2. Expected: true
|-
| 9.2 || Scenario 2: Multiple rubrics of a given type exist in round 2. Expected: true
|-
| 9.3 || Scenario 3: No rubrics of a given type exist in round 2. Expected: false
|-
| 10 || num_review_rounds
|-
| 10.1 || Scenario 1: No due dates. Expected: 0
|-
| 10.2 || Scenario 2: Single due date with round 1. Expected: 1
|-
| 10.3 || Scenario 3: Multiple due dates with different rounds. Expected: Highest round number
|-
| 10.4 || Scenario 4: Multiple due dates with the same round number. Expected: Highest round number
|-
| 11 || review_questionnaire_id
|-
| 11.1 || Scenario 1: No round_number and topic_id provided. Expected: id of the current round's review questionnaire.
|-
| 11.2 || Scenario 2: No round_number and topic_id provided, no next due date. Expected: nil
|-
| 12 || pair_programming_enabled?
|-
| 12.1 || Scenario 1: Pair programming is enabled. Expected: true
|-
| 12.2 || Scenario 2: Pair programming is disabled. Expected: false
|-
| 13 || staggered_and_no_topic?
|-
| 13.1 || Scenario 1: Staggered deadline is enabled, topic_id not provided. Expected: true
|-
| 13.2 || Scenario 2: Staggered deadline is enabled, topic_id provided. Expected: false
|}

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

== Team Members ==

* Ajith Kanumuri
* Suhas Adidela
* Ravi Chandu Bollepalli
* Mentor - Dinesh Pasupuleti
* PR Request:- https://github.com/expertiza/reimplementation-back-end/pull/125
* Project Board:- https://github.com/users/ajith05/projects/1/views/1
* Deployment Link:- http://152.7.177.8:3002/api-docs

== Project Description ==

The main goal of this project is to reimplement essential Ruby on Rails model classes—SignedUpTeam and ProjectTopic (renamed from SignUpTopic)—from the Expertiza repository in a new repository. Each of these model classes plays a critical role in managing topics and team sign-ups within course assignments, and the reimplementation aims to bring them into alignment with Rails best practices and the DRY (Don't Repeat Yourself) principle.

The SignedUpTeam model represents a team that has signed up for a specific topic within an assignment. This model manages team-specific data and oversees interactions that occur during the sign-up process. The ProjectTopic model, on the other hand, represents the topics available for sign-up within an assignment, managing essential details like slot availability and assigning teams to open topics.

Since this project is being implemented from scratch, a range of components have been developed to ensure the functionality is both streamlined and maintainable. To guarantee the reliability of each part of the reimplementation, unit test cases have been created to verify the integrity of the new design and implementation.

== Issue Description ==

* Comprehensive RSpec tests are essential for all reimplemented models to ensure correctness and reliability in functionality.

* Update all references from `sign_up_topics` to `project_topics` throughout the codebase to maintain consistency with the new naming convention.

* Address all code review feedback to improve code quality and alignment with best practices.

* Refactor methods with readability issues to make the code more maintainable and easier to understand.

* Optimize ambiguous class and instance methods to enhance reusability and improve the overall structure of the code.

* The old codebase has several instances of unnecessary calls to database, such as fetching all project topics for a user when fetching first topic would be sufficient. This effects efficiency and readability. Optimize such instances of code to streamline and increase readability.

== Design Strategy ==

* Implemented three model classes: `sign_up_team.rb` and `project_topic.rb` to address project requirements.
* Each model now has a focused role, improving maintainability and clarity.
* In signed_up_team.rb, the following functionality are being implemented:-

;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| drop_off_team_waitlists || Implemented || Removes the team from all waitlists for topics within the assignment.
|-
| find_first_existing_sign_up || Implemented || Finds the first existing sign-up entry for a given topic and team, checking for both active and waitlisted sign-ups.
|-
| create_signed_up_team || Implemented || Creates a SignedUpTeam instance with specified topic_id and team_id if the topic is available for sign-up.
|-
| get_team_id || Implemented || Retrieves the team ID associated with a given SignedUpTeam entry.
|-
| delete_signed_up_team || Implemented || Deletes the signed-up team entry for a specific topic, managing any dependent records as necessary.

|}
* Add necessary schema migrations to rename signup topic to project topic.
* In project_topic.rb, the following functionality are being implemented:-
*;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| slot_available? || Implemented || Checks if there are available slots for the topic based on the maximum allowed choosers. Returns true if available.
|-
| assign_topic_to_team || Implemented || Assigns the topic to a team by updating the sign-up entry to set is_waitlisted as false and assign the topic_id.
|-
| save_waitlist_entry || Implemented || Saves a sign-up entry as a waitlist entry by setting is_waitlisted to true and assigning the topic_id.
|-
| sign_up_team || Implemented || Manages the sign-up process for a team, checking slot availability, assigning the topic, or placing the team on the waitlist as needed
|}

== E/R Diagram ==
[[File:oodd.png |500px|center]]
Edit Button Tooltip

== Test Plan ==

*Set Up Initial Data: Create necessary records (Role, Instructor, Assignment, ProjectTopic, and Team) to establish relationships and dependencies required for testing ProjectTopic.

*Verify Slot Availability with No Teams Signed Up: Test slot_available? to ensure it returns true when no teams have chosen the topic, confirming that the method correctly identifies open slots.

*Test Topic Assignment Without Waitlisting: Use assign_topic_to_team to assign a topic to a team directly (without waitlisting) and check that is_waitlisted is set to false and the topic ID is correctly assigned.

*Simulate Slot Availability with Waitlist Clearance: Test sign_up_team when slots are available, mock drop_off_team_waitlists, and verify that the new team is assigned to the topic and the waitlist is cleared.

*Assert Expected Outcomes for Each Scenario: Validate results of each test by checking specific conditions, such as correct topic ID assignment, is_waitlisted status, and expected method calls, ensuring all methods perform accurately across various conditions.
* Test Cases for project_topic.rb model
[[File:Project_topic.jpg |1000px|center]]
Edit Button Tooltip

CSC/ECE 517 Fall 2024

2024-11-13T01:47:16Z

Skanumu2:

* [[CSC/ECE 517 Fall 2024 - E2450. Refactor assignments_controller.rb]]
* [[CSC/ECE 517 Fall 2024 - E2451. Reimplement feedback_response_map.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 - E2456. Refactor teams_user.rb (Phase 2 - Design Document)]]
* [[CSC/ECE 517 Fall 2024 - E2457. GitHub metrics integration]]
* [[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]]
* [[CSC/ECE 517 Fall 2024 - E2461. UI and Backend 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 - E2473. Reimplement sign up topic.rb as project topic.rb]]
* [[CSC/ECE 517 Fall 2024 - E2474. Reimplement student_quizzes_controller.rb]]
* [[CSC/ECE 517 Fall 2024 - E2475. Reimplement student_task view]]
* [[CSC/ECE 517 Fall 2024 - E2476. Reimplement student_teams_controller.rb]]
* [[CSC/ECE 517 Fall 2024 - E2477. Reimplement suggestion_controller.rb]]
* [[CSC/ECE 517 Fall 2024 - E2478. Reimplement the Question hierarchy as Item hierarchy]]
* [[CSC/ECE 517 Fall 2024 - E2479. Reimplement teams_users_controller.rb]]
* [[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 - E2483. Reimplement Notification Controller and Model]]
* [[CSC/ECE 517 Fall 2024 - E2484. Reimplement participants_controller.rb]]
* [[CSC/ECE 517 Fall 2024 - E2485. Allow reviewers to bid on what to review]]
* [[CSC/ECE 517 Fall 2024 - E2487. Reimplement authorization_helper.rb]]
* [[CSC/ECE 517 Fall 2024 - E2488 Reimplementation of Add TA to course]]
* [[CSC/ECE 517 Fall 2024 - E2491.UI for View assignments in Courses view]]
* [[CSC/ECE 517 Fall 2024 - E2492. UI for View submissions/assign grades (except heatgrid)]]
* [[CSC/ECE 517 Fall 2024 - E2493. UI for Assign Reviewers]]
* [[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 E2473. Reimplement sign up topic.rb as project topic.rb

2024-11-13T01:46:49Z

Skanumu2: Skanumu2 moved page CSC/ECE 517 Fall 2024 E2473. Reimplement sign up topic.rb as project topic.rb to CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb: Misspelled title

#REDIRECT [[CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb]]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-11-13T01:46:49Z

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation for the assignment model and assignment controller in the Expertiza backend.

==Problem Statement==
The following tasks were required for the reimplementation :
#Enhancing Code Clarity: This involves renaming methods with ambiguous names, optimizing loops and adding comments for unclear lines of code.
#Removing unused methods Removing unused methods will reduce complexity.
#Reimplement Assignment model and controller: Reimplement the methods from Assignment model that are complex and can be implemented in a better way to reduce complexity and by not violating the DRY principles.
#Writing tests for assignment models: Tests have to be written for Assignment Model.
#Writing tests for the assignment controller: RSwag tests should be written for Assignment Controller

==Design Goal==
While reimplementation of Assignment model and controller, the following design rules have to be ensured:
* Validate proper functioning of all existing and anticipated methods, making any required enhancements or adjustments.
* Establish loose coupling and tight cohesion for the model and controller to enhance code organization and maintainability.
* Refactor redundant code in the previous implementation's controller and model methods using DRY principle, eliminating functionality duplications already present in the expertiza system.
* Confirm the continued effectiveness of existing test cases following the aforementioned modifications and generate additional test cases as per the need.

==Implementation Plan==

Documentation for methods that will be re-implemented and implemented as it is:

* valid_num_review
This method raises an error if more reviews are required than are allowed. But it is a single method for both reviews and meta reviews. In the reimplemented method, type of review will be a parameter.
* varying_rubrics_by_round?
This method checks whether different rubrics are being used in different rounds of review. It does it, however, by checking whether more than one rubric is listed as being used in Round 2 (used_in_round = 2). The reimplemented method will check if we have more than one rubric of a given type for an assignment.
* badge?
This method returns the value of the has_badge instance variable and this should be renamed to has_badge?.
* calibrated?
This method returns the value of the is_calibrated instance variable and should be renamed is_calibrated?.
* current_stage
his method returns the current stage (Submission, Review, Finished, etc.) potentially based on which topic the logged-in user holds. It returns a string, which is useful for printing, though a bit informal. However, since this method is quite similar to two other methods - current_stage_name and stage_deadline, these three can be combined with some modifications in the reimplementation for clarity. For these, we will create a duedate model and implement the get_next_due_date method 2 subclasses- TopicDueDate and AssignmentDueDate.
* current_stage_name
This is a convoluted method that returns the same thing as current_stage, except in a few specialized cases, such as when the assignment has topics and the user hasn’t chosen a topic. However, since this method is quite similar to two other methods - current_stage and stage_deadline, these three can be combined with some modifications in the reimplementation for clarity. For these, we will create a duedate model and implement the get_next_due_date method 2 subclasses- TopicDueDate and AssignmentDueDate.
* stage_deadline
This method is similar to current_stage, but returns the time of the next deadline unless the assignment is finished. However, since this method is quite similar to two other methods - current_stage_name and current_stage, these three can be combined with some modifications in the reimplementation for clarity. For these, we will create a duedate model and implement the get_next_due_date method 2 subclasses- TopicDueDate and AssignmentDueDate.
* num_reviews_greater?
This method checks whether the number of reviews required is greater than the number of reviews allowed. Basically, it just compares two instance variables of Assignment,but handles the special cases of reviews_allowed being null or negative. In the reimplemented method, we will check if reviews_allowed is valid or not in a separate function.
* quiz_allowed
This method returns the quiz_allowed_id field of the next due date, i.e., whether a participant is currently allowed to take a quiz. This method will be reimplemented without making a direct call to the check_condition.
* response_map_to_metareview
This method finds the “most appropriate” ResponseMap to use as the reviewed_object in a new MetareviewResponseMap. This can be made as a class method of MetareviewResponseMap and combined with the reviewer_metareviews_map method that is basically a step of this method.
* review_questionnaire_id
This method finds the questionnaire in use for reviews of work submitted for the assignment. This is a complicated method because it calculates to find the round number, instead of using number_of_current_round(...). In the reimplementation, instead of creating a new form, we can use an already existing form that is associated with the assignment. The logic behind determining a round number based on the topic can also be improved.
* reviewer_metareviews_map
This is a step in finding the response_map_to_metareview. There is no need for a separate method for finding reviewer_metareviews_map. This method can be combined with response_map_to_metareview during reimplementation.

Note : The following methods do not require specific changes and will be implemented accordingly.

* create_node
This method creates an AssignmentNode for this assignment.
* pair_programming_enabled?
This method returns the value of the enable_pair_programming instance variable.

* staggered_and_no_topic?
This method checks if the assignment is a staggered-deadline assignment and the logged-in user has not chosen a topic.

* team_assignment?
This method checks whether max_team_size > 0 (should be > 1).

* teams?
This method is used to check whether any teams exist for this assignment.
* topics?
This method is used to check whether any topics exist for this assignment.
* create_node
This method creates an AssignmentNode for this assignment.

Note : The following methods will be removed as they are no longer required in the new implementation -

Methods to be moved to another models : 

*assign_metareviewer_dynamically
*can_review
*check_condition
*find_current_stage
*find_due_dates
*find_reveiw_period
*link_for_current_stage
*metareview_allowed
*num_review_rounds
*num_of_current_round
*submission_allowed
*user_on_team?

Methods to be removed : 

*microtask?
*min_metareview
*questionnaire_ids
*remove_empty_teams

==Test Plan==

We plan to use the given test skeletons for assignment model and implement the respective Rspec test cases. The test cases for other methods will be included later as reimplementation might have methods which are combined versions of multiple other methods. The test scenarios for some for the methods are mentioned in the following table.

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || team_assignment?
|-
| 1.1 || Scenario 1: Max_team_size is greater than 0. Expected: true
|-
| 1.2 || Scenario 2: Max_team_size is equal to 0. Expected: false
|-
| 1.3 || Scenario 3: Max_team_size is less than 0. Expected: false
|-
| 2 || topics
|-
| 2.1 || Scenario 1: Sign_up_topics is empty. Expected: false
|-
| 2.2 || Scenario 2: Sign_up_topics is not empty. Expected: true
|-
| 3 || calibrated?
|-
| 3.1 || Scenario 1: The object is calibrated. Expected: true
|-
| 3.2 || Scenario 2: The object is not calibrated. Expected: false
|-
| 4 || teams
|-
| 4.1 || Scenario 1: Teams are present. Expected: true
|-
| 4.2 || Scenario 2: Teams are not present. Expected: false
|-
| 5 || valid_num_review
|-
| 5.1 || Scenario 1: Number of reviews required is greater than the number of reviews allowed. Expected: Error message
|-
| 5.2 || Scenario 2: Number of meta-reviews required is greater than the number of meta-reviews allowed. Expected: Error message
|-
| 6 || dynamic_reviewer_assignment?
|-
| 6.1 || Scenario 1: Review assignment strategy is RS_AUTO_SELECTED. Expected: true
|-
| 6.2 || Scenario 2: Review assignment strategy is not RS_AUTO_SELECTED. Expected: false
|-
| 7 || badge?
|-
| 7.1 || Scenario 1: Has_badge is nil. Expected: false
|-
| 7.2 || Scenario 2: Has_badge is true. Expected: true
|-
| 7.3 || Scenario 3: Has_badge is false. Expected: false
|-
| 8 || create_node
|-
| 8.1 || Scenario 1: Parent node exists. Expected: New node created with parent_id set.
|-
| 8.2 || Scenario 2: Parent node does not exist. Expected: New node created with no parent_id set.
|-
| 9 || varying_rubrics_by_round?
|-
| 9.1 || Scenario 1: Rubrics of a given type exist in round 2. Expected: true
|-
| 9.2 || Scenario 2: Multiple rubrics of a given type exist in round 2. Expected: true
|-
| 9.3 || Scenario 3: No rubrics of a given type exist in round 2. Expected: false
|-
| 10 || num_review_rounds
|-
| 10.1 || Scenario 1: No due dates. Expected: 0
|-
| 10.2 || Scenario 2: Single due date with round 1. Expected: 1
|-
| 10.3 || Scenario 3: Multiple due dates with different rounds. Expected: Highest round number
|-
| 10.4 || Scenario 4: Multiple due dates with the same round number. Expected: Highest round number
|-
| 11 || review_questionnaire_id
|-
| 11.1 || Scenario 1: No round_number and topic_id provided. Expected: id of the current round's review questionnaire.
|-
| 11.2 || Scenario 2: No round_number and topic_id provided, no next due date. Expected: nil
|-
| 12 || pair_programming_enabled?
|-
| 12.1 || Scenario 1: Pair programming is enabled. Expected: true
|-
| 12.2 || Scenario 2: Pair programming is disabled. Expected: false
|-
| 13 || staggered_and_no_topic?
|-
| 13.1 || Scenario 1: Staggered deadline is enabled, topic_id not provided. Expected: true
|-
| 13.2 || Scenario 2: Staggered deadline is enabled, topic_id provided. Expected: false
|}

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

== Team Members ==

* Ajith Kanumuri
* Suhas Adidela
* Ravi Chandu Bollepalli
* Mentor - Dinesh Pasupuleti
* PR Request:- https://github.com/expertiza/reimplementation-back-end/pull/125
* Project Board:- https://github.com/users/ajith05/projects/1/views/1
* Deployment Link:- http://152.7.177.8:3002/api-docs

== Project Description ==

The main goal of this project is to reimplement essential Ruby on Rails model classes—SignedUpTeam and ProjectTopic (renamed from SignUpTopic)—from the Expertiza repository in a new repository. Each of these model classes plays a critical role in managing topics and team sign-ups within course assignments, and the reimplementation aims to bring them into alignment with Rails best practices and the DRY (Don't Repeat Yourself) principle.

The SignedUpTeam model represents a team that has signed up for a specific topic within an assignment. This model manages team-specific data and oversees interactions that occur during the sign-up process. The ProjectTopic model, on the other hand, represents the topics available for sign-up within an assignment, managing essential details like slot availability and assigning teams to open topics.

Since this project is being implemented from scratch, a range of components have been developed to ensure the functionality is both streamlined and maintainable. To guarantee the reliability of each part of the reimplementation, unit test cases have been created to verify the integrity of the new design and implementation.

== Issue Description ==

* Comprehensive RSpec tests are essential for all reimplemented models to ensure correctness and reliability in functionality.

* Update all references from `sign_up_topics` to `project_topics` throughout the codebase to maintain consistency with the new naming convention.

* Address all code review feedback to improve code quality and alignment with best practices.

* Refactor methods with readability issues to make the code more maintainable and easier to understand.

* Optimize ambiguous class and instance methods to enhance reusability and improve the overall structure of the code.

* The old codebase has several instances of unnecessary calls to database, such as fetching all project topics for a user when fetching first topic would be sufficient. This effects efficiency and readability. Optimize such instances of code to streamline and increase readability.

== Design Strategy ==

* Implemented three model classes: `sign_up_team.rb` and `project_topic.rb` to address project requirements.
* Each model now has a focused role, improving maintainability and clarity.
* In signed_up_team.rb, the following functionality are being implemented:-

;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| drop_off_team_waitlists || Implemented || Removes the team from all waitlists for topics within the assignment.
|-
| find_first_existing_sign_up || Implemented || Finds the first existing sign-up entry for a given topic and team, checking for both active and waitlisted sign-ups.
|-
| create_signed_up_team || Implemented || Creates a SignedUpTeam instance with specified topic_id and team_id if the topic is available for sign-up.
|-
| get_team_id || Implemented || Retrieves the team ID associated with a given SignedUpTeam entry.
|-
| delete_signed_up_team || Implemented || Deletes the signed-up team entry for a specific topic, managing any dependent records as necessary.

|}
* Add necessary schema migrations to rename signup topic to project topic.
* In project_topic.rb, the following functionality are being implemented:-
*;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| slot_available? || Implemented || Checks if there are available slots for the topic based on the maximum allowed choosers. Returns true if available.
|-
| assign_topic_to_team || Implemented || Assigns the topic to a team by updating the sign-up entry to set is_waitlisted as false and assign the topic_id.
|-
| save_waitlist_entry || Implemented || Saves a sign-up entry as a waitlist entry by setting is_waitlisted to true and assigning the topic_id.
|-
| sign_up_team || Implemented || Manages the sign-up process for a team, checking slot availability, assigning the topic, or placing the team on the waitlist as needed
|}

== E/R Diagram ==
[[File:oodd.png |500px|center]]
Edit Button Tooltip

== Test Plan ==

*Set Up Initial Data: Create necessary records (Role, Instructor, Assignment, ProjectTopic, and Team) to establish relationships and dependencies required for testing ProjectTopic.

*Verify Slot Availability with No Teams Signed Up: Test slot_available? to ensure it returns true when no teams have chosen the topic, confirming that the method correctly identifies open slots.

*Test Topic Assignment Without Waitlisting: Use assign_topic_to_team to assign a topic to a team directly (without waitlisting) and check that is_waitlisted is set to false and the topic ID is correctly assigned.

*Simulate Slot Availability with Waitlist Clearance: Test sign_up_team when slots are available, mock drop_off_team_waitlists, and verify that the new team is assigned to the topic and the waitlist is cleared.

*Assert Expected Outcomes for Each Scenario: Validate results of each test by checking specific conditions, such as correct topic ID assignment, is_waitlisted status, and expected method calls, ensuring all methods perform accurately across various conditions.
* Test Cases for project_topic.rb model
[[File:Project_topic.jpg |1000px|center]]
Edit Button Tooltip

CSC/ECE 517 Fall 2024

2024-11-13T01:45:45Z

Skanumu2:

* [[CSC/ECE 517 Fall 2024 - E2450. Refactor assignments_controller.rb]]
* [[CSC/ECE 517 Fall 2024 - E2451. Reimplement feedback_response_map.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 - E2456. Refactor teams_user.rb (Phase 2 - Design Document)]]
* [[CSC/ECE 517 Fall 2024 - E2457. GitHub metrics integration]]
* [[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]]
* [[CSC/ECE 517 Fall 2024 - E2461. UI and Backend 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 E2473. Reimplement sign up topic.rb as project topic.rb]]
* [[CSC/ECE 517 Fall 2024 - E2474. Reimplement student_quizzes_controller.rb]]
* [[CSC/ECE 517 Fall 2024 - E2475. Reimplement student_task view]]
* [[CSC/ECE 517 Fall 2024 - E2476. Reimplement student_teams_controller.rb]]
* [[CSC/ECE 517 Fall 2024 - E2477. Reimplement suggestion_controller.rb]]
* [[CSC/ECE 517 Fall 2024 - E2478. Reimplement the Question hierarchy as Item hierarchy]]
* [[CSC/ECE 517 Fall 2024 - E2479. Reimplement teams_users_controller.rb]]
* [[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 - E2483. Reimplement Notification Controller and Model]]
* [[CSC/ECE 517 Fall 2024 - E2484. Reimplement participants_controller.rb]]
* [[CSC/ECE 517 Fall 2024 - E2485. Allow reviewers to bid on what to review]]
* [[CSC/ECE 517 Fall 2024 - E2487. Reimplement authorization_helper.rb]]
* [[CSC/ECE 517 Fall 2024 - E2488 Reimplementation of Add TA to course]]
* [[CSC/ECE 517 Fall 2024 - E2491.UI for View assignments in Courses view]]
* [[CSC/ECE 517 Fall 2024 - E2492. UI for View submissions/assign grades (except heatgrid)]]
* [[CSC/ECE 517 Fall 2024 - E2493. UI for Assign Reviewers]]
* [[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 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-11-13T01:44:11Z

Skanumu2:

==Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a [http://rubyonrails.org/ Ruby on Rails] based open source project. Instructors have the ability to add new projects, assignments, etc., as well as edit existing ones. Later on, they can view student submissions and grade them. Students can also use Expertiza to organize into teams to work on different projects and assignments and submit their work. They can also review other students' submissions.
==Introduction==
This project is a reimplementation for the assignment model and assignment controller in the Expertiza backend.

==Problem Statement==
The following tasks were required for the reimplementation :
#Enhancing Code Clarity: This involves renaming methods with ambiguous names, optimizing loops and adding comments for unclear lines of code.
#Removing unused methods Removing unused methods will reduce complexity.
#Reimplement Assignment model and controller: Reimplement the methods from Assignment model that are complex and can be implemented in a better way to reduce complexity and by not violating the DRY principles.
#Writing tests for assignment models: Tests have to be written for Assignment Model.
#Writing tests for the assignment controller: RSwag tests should be written for Assignment Controller

==Design Goal==
While reimplementation of Assignment model and controller, the following design rules have to be ensured:
* Validate proper functioning of all existing and anticipated methods, making any required enhancements or adjustments.
* Establish loose coupling and tight cohesion for the model and controller to enhance code organization and maintainability.
* Refactor redundant code in the previous implementation's controller and model methods using DRY principle, eliminating functionality duplications already present in the expertiza system.
* Confirm the continued effectiveness of existing test cases following the aforementioned modifications and generate additional test cases as per the need.

==Implementation Plan==

Documentation for methods that will be re-implemented and implemented as it is:

* valid_num_review
This method raises an error if more reviews are required than are allowed. But it is a single method for both reviews and meta reviews. In the reimplemented method, type of review will be a parameter.
* varying_rubrics_by_round?
This method checks whether different rubrics are being used in different rounds of review. It does it, however, by checking whether more than one rubric is listed as being used in Round 2 (used_in_round = 2). The reimplemented method will check if we have more than one rubric of a given type for an assignment.
* badge?
This method returns the value of the has_badge instance variable and this should be renamed to has_badge?.
* calibrated?
This method returns the value of the is_calibrated instance variable and should be renamed is_calibrated?.
* current_stage
his method returns the current stage (Submission, Review, Finished, etc.) potentially based on which topic the logged-in user holds. It returns a string, which is useful for printing, though a bit informal. However, since this method is quite similar to two other methods - current_stage_name and stage_deadline, these three can be combined with some modifications in the reimplementation for clarity. For these, we will create a duedate model and implement the get_next_due_date method 2 subclasses- TopicDueDate and AssignmentDueDate.
* current_stage_name
This is a convoluted method that returns the same thing as current_stage, except in a few specialized cases, such as when the assignment has topics and the user hasn’t chosen a topic. However, since this method is quite similar to two other methods - current_stage and stage_deadline, these three can be combined with some modifications in the reimplementation for clarity. For these, we will create a duedate model and implement the get_next_due_date method 2 subclasses- TopicDueDate and AssignmentDueDate.
* stage_deadline
This method is similar to current_stage, but returns the time of the next deadline unless the assignment is finished. However, since this method is quite similar to two other methods - current_stage_name and current_stage, these three can be combined with some modifications in the reimplementation for clarity. For these, we will create a duedate model and implement the get_next_due_date method 2 subclasses- TopicDueDate and AssignmentDueDate.
* num_reviews_greater?
This method checks whether the number of reviews required is greater than the number of reviews allowed. Basically, it just compares two instance variables of Assignment,but handles the special cases of reviews_allowed being null or negative. In the reimplemented method, we will check if reviews_allowed is valid or not in a separate function.
* quiz_allowed
This method returns the quiz_allowed_id field of the next due date, i.e., whether a participant is currently allowed to take a quiz. This method will be reimplemented without making a direct call to the check_condition.
* response_map_to_metareview
This method finds the “most appropriate” ResponseMap to use as the reviewed_object in a new MetareviewResponseMap. This can be made as a class method of MetareviewResponseMap and combined with the reviewer_metareviews_map method that is basically a step of this method.
* review_questionnaire_id
This method finds the questionnaire in use for reviews of work submitted for the assignment. This is a complicated method because it calculates to find the round number, instead of using number_of_current_round(...). In the reimplementation, instead of creating a new form, we can use an already existing form that is associated with the assignment. The logic behind determining a round number based on the topic can also be improved.
* reviewer_metareviews_map
This is a step in finding the response_map_to_metareview. There is no need for a separate method for finding reviewer_metareviews_map. This method can be combined with response_map_to_metareview during reimplementation.

Note : The following methods do not require specific changes and will be implemented accordingly.

* create_node
This method creates an AssignmentNode for this assignment.
* pair_programming_enabled?
This method returns the value of the enable_pair_programming instance variable.

* staggered_and_no_topic?
This method checks if the assignment is a staggered-deadline assignment and the logged-in user has not chosen a topic.

* team_assignment?
This method checks whether max_team_size > 0 (should be > 1).

* teams?
This method is used to check whether any teams exist for this assignment.
* topics?
This method is used to check whether any topics exist for this assignment.
* create_node
This method creates an AssignmentNode for this assignment.

Note : The following methods will be removed as they are no longer required in the new implementation -

Methods to be moved to another models : 

*assign_metareviewer_dynamically
*can_review
*check_condition
*find_current_stage
*find_due_dates
*find_reveiw_period
*link_for_current_stage
*metareview_allowed
*num_review_rounds
*num_of_current_round
*submission_allowed
*user_on_team?

Methods to be removed : 

*microtask?
*min_metareview
*questionnaire_ids
*remove_empty_teams

==Test Plan==

We plan to use the given test skeletons for assignment model and implement the respective Rspec test cases. The test cases for other methods will be included later as reimplementation might have methods which are combined versions of multiple other methods. The test scenarios for some for the methods are mentioned in the following table.

{| class="wikitable" style="margin-left:30px"
|-
! Sr No !! Test Description
|-
| 1 || team_assignment?
|-
| 1.1 || Scenario 1: Max_team_size is greater than 0. Expected: true
|-
| 1.2 || Scenario 2: Max_team_size is equal to 0. Expected: false
|-
| 1.3 || Scenario 3: Max_team_size is less than 0. Expected: false
|-
| 2 || topics
|-
| 2.1 || Scenario 1: Sign_up_topics is empty. Expected: false
|-
| 2.2 || Scenario 2: Sign_up_topics is not empty. Expected: true
|-
| 3 || calibrated?
|-
| 3.1 || Scenario 1: The object is calibrated. Expected: true
|-
| 3.2 || Scenario 2: The object is not calibrated. Expected: false
|-
| 4 || teams
|-
| 4.1 || Scenario 1: Teams are present. Expected: true
|-
| 4.2 || Scenario 2: Teams are not present. Expected: false
|-
| 5 || valid_num_review
|-
| 5.1 || Scenario 1: Number of reviews required is greater than the number of reviews allowed. Expected: Error message
|-
| 5.2 || Scenario 2: Number of meta-reviews required is greater than the number of meta-reviews allowed. Expected: Error message
|-
| 6 || dynamic_reviewer_assignment?
|-
| 6.1 || Scenario 1: Review assignment strategy is RS_AUTO_SELECTED. Expected: true
|-
| 6.2 || Scenario 2: Review assignment strategy is not RS_AUTO_SELECTED. Expected: false
|-
| 7 || badge?
|-
| 7.1 || Scenario 1: Has_badge is nil. Expected: false
|-
| 7.2 || Scenario 2: Has_badge is true. Expected: true
|-
| 7.3 || Scenario 3: Has_badge is false. Expected: false
|-
| 8 || create_node
|-
| 8.1 || Scenario 1: Parent node exists. Expected: New node created with parent_id set.
|-
| 8.2 || Scenario 2: Parent node does not exist. Expected: New node created with no parent_id set.
|-
| 9 || varying_rubrics_by_round?
|-
| 9.1 || Scenario 1: Rubrics of a given type exist in round 2. Expected: true
|-
| 9.2 || Scenario 2: Multiple rubrics of a given type exist in round 2. Expected: true
|-
| 9.3 || Scenario 3: No rubrics of a given type exist in round 2. Expected: false
|-
| 10 || num_review_rounds
|-
| 10.1 || Scenario 1: No due dates. Expected: 0
|-
| 10.2 || Scenario 2: Single due date with round 1. Expected: 1
|-
| 10.3 || Scenario 3: Multiple due dates with different rounds. Expected: Highest round number
|-
| 10.4 || Scenario 4: Multiple due dates with the same round number. Expected: Highest round number
|-
| 11 || review_questionnaire_id
|-
| 11.1 || Scenario 1: No round_number and topic_id provided. Expected: id of the current round's review questionnaire.
|-
| 11.2 || Scenario 2: No round_number and topic_id provided, no next due date. Expected: nil
|-
| 12 || pair_programming_enabled?
|-
| 12.1 || Scenario 1: Pair programming is enabled. Expected: true
|-
| 12.2 || Scenario 2: Pair programming is disabled. Expected: false
|-
| 13 || staggered_and_no_topic?
|-
| 13.1 || Scenario 1: Staggered deadline is enabled, topic_id not provided. Expected: true
|-
| 13.2 || Scenario 2: Staggered deadline is enabled, topic_id provided. Expected: false
|}

==Team==
=====Mentors=====
*Dinesh Pasupuleti
*Ankur Banerji

=====Members=====
*Ajith Kanumuri <skanumu2@ncsu.edu>
*Suhas Adidela <sadidel@ncsu.edu>
*Ravi Chandu Bollepalli <rbollep@ncsu.edu>

==Pull Request==
*[https://github.com/expertiza/reimplementation-back-end/pull/125]

==References==

*[https://docs.google.com/document/d/1LHVacylQmB15I6VcYUA5nuC7GRRU9szHzZhjlPcE-PA/edit#heading=h.10bl58em5q36 Project Instructions]

== Team Members ==

* Ajith Kanumuri
* Suhas Adidela
* Ravi Chandu Bollepalli
* Mentor - Dinesh Pasupuleti
* PR Request:- https://github.com/expertiza/reimplementation-back-end/pull/125
* Project Board:- https://github.com/users/ajith05/projects/1/views/1
* Deployment Link:- http://152.7.177.8:3002/api-docs

== Project Description ==

The main goal of this project is to reimplement essential Ruby on Rails model classes—SignedUpTeam and ProjectTopic (renamed from SignUpTopic)—from the Expertiza repository in a new repository. Each of these model classes plays a critical role in managing topics and team sign-ups within course assignments, and the reimplementation aims to bring them into alignment with Rails best practices and the DRY (Don't Repeat Yourself) principle.

The SignedUpTeam model represents a team that has signed up for a specific topic within an assignment. This model manages team-specific data and oversees interactions that occur during the sign-up process. The ProjectTopic model, on the other hand, represents the topics available for sign-up within an assignment, managing essential details like slot availability and assigning teams to open topics.

Since this project is being implemented from scratch, a range of components have been developed to ensure the functionality is both streamlined and maintainable. To guarantee the reliability of each part of the reimplementation, unit test cases have been created to verify the integrity of the new design and implementation.

== Issue Description ==

* Comprehensive RSpec tests are essential for all reimplemented models to ensure correctness and reliability in functionality.

* Update all references from `sign_up_topics` to `project_topics` throughout the codebase to maintain consistency with the new naming convention.

* Address all code review feedback to improve code quality and alignment with best practices.

* Refactor methods with readability issues to make the code more maintainable and easier to understand.

* Optimize ambiguous class and instance methods to enhance reusability and improve the overall structure of the code.

* The old codebase has several instances of unnecessary calls to database, such as fetching all project topics for a user when fetching first topic would be sufficient. This effects efficiency and readability. Optimize such instances of code to streamline and increase readability.

== Design Strategy ==

* Implemented three model classes: `sign_up_team.rb` and `project_topic.rb` to address project requirements.
* Each model now has a focused role, improving maintainability and clarity.
* In signed_up_team.rb, the following functionality are being implemented:-

;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| drop_off_team_waitlists || Implemented || Removes the team from all waitlists for topics within the assignment.
|-
| find_first_existing_sign_up || Implemented || Finds the first existing sign-up entry for a given topic and team, checking for both active and waitlisted sign-ups.
|-
| create_signed_up_team || Implemented || Creates a SignedUpTeam instance with specified topic_id and team_id if the topic is available for sign-up.
|-
| get_team_id || Implemented || Retrieves the team ID associated with a given SignedUpTeam entry.
|-
| delete_signed_up_team || Implemented || Deletes the signed-up team entry for a specific topic, managing any dependent records as necessary.

|}
* Add necessary schema migrations to rename signup topic to project topic.
* In project_topic.rb, the following functionality are being implemented:-
*;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| slot_available? || Implemented || Checks if there are available slots for the topic based on the maximum allowed choosers. Returns true if available.
|-
| assign_topic_to_team || Implemented || Assigns the topic to a team by updating the sign-up entry to set is_waitlisted as false and assign the topic_id.
|-
| save_waitlist_entry || Implemented || Saves a sign-up entry as a waitlist entry by setting is_waitlisted to true and assigning the topic_id.
|-
| sign_up_team || Implemented || Manages the sign-up process for a team, checking slot availability, assigning the topic, or placing the team on the waitlist as needed
|}

== E/R Diagram ==
[[File:oodd.png |500px|center]]
Edit Button Tooltip

== Test Plan ==

*Set Up Initial Data: Create necessary records (Role, Instructor, Assignment, ProjectTopic, and Team) to establish relationships and dependencies required for testing ProjectTopic.

*Verify Slot Availability with No Teams Signed Up: Test slot_available? to ensure it returns true when no teams have chosen the topic, confirming that the method correctly identifies open slots.

*Test Topic Assignment Without Waitlisting: Use assign_topic_to_team to assign a topic to a team directly (without waitlisting) and check that is_waitlisted is set to false and the topic ID is correctly assigned.

*Simulate Slot Availability with Waitlist Clearance: Test sign_up_team when slots are available, mock drop_off_team_waitlists, and verify that the new team is assigned to the topic and the waitlist is cleared.

*Assert Expected Outcomes for Each Scenario: Validate results of each test by checking specific conditions, such as correct topic ID assignment, is_waitlisted status, and expected method calls, ensuring all methods perform accurately across various conditions.
* Test Cases for project_topic.rb model
[[File:Project_topic.jpg |1000px|center]]
Edit Button Tooltip

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-10-30T04:09:47Z

Skanumu2: /* Test Plan */

== Team Members ==

* Ajith Kanumuri
* Suhas Adidela
* Ravi Chandu Bollepalli
* Mentor - Dinesh Pasupuleti
* PR Request:- https://github.com/expertiza/reimplementation-back-end/pull/125
* Project Board:- https://github.com/users/ajith05/projects/1/views/1
* Deployment Link:- http://152.7.177.8:3002/api-docs

== Project Description ==

The main goal of this project is to reimplement essential Ruby on Rails model classes—SignedUpTeam and ProjectTopic (renamed from SignUpTopic)—from the Expertiza repository in a new repository. Each of these model classes plays a critical role in managing topics and team sign-ups within course assignments, and the reimplementation aims to bring them into alignment with Rails best practices and the DRY (Don't Repeat Yourself) principle.

The SignedUpTeam model represents a team that has signed up for a specific topic within an assignment. This model manages team-specific data and oversees interactions that occur during the sign-up process. The ProjectTopic model, on the other hand, represents the topics available for sign-up within an assignment, managing essential details like slot availability and assigning teams to open topics.

Since this project is being implemented from scratch, a range of components have been developed to ensure the functionality is both streamlined and maintainable. To guarantee the reliability of each part of the reimplementation, unit test cases have been created to verify the integrity of the new design and implementation.

== Issue Description ==

* Comprehensive RSpec tests are essential for all reimplemented models to ensure correctness and reliability in functionality.

* Update all references from `sign_up_topics` to `project_topics` throughout the codebase to maintain consistency with the new naming convention.

* Address all code review feedback to improve code quality and alignment with best practices.

* Refactor methods with readability issues to make the code more maintainable and easier to understand.

* Optimize ambiguous class and instance methods to enhance reusability and improve the overall structure of the code.

* The old codebase has several instances of unnecessary calls to database, such as fetching all project topics for a user when fetching first topic would be sufficient. This effects efficiency and readability. Optimize such instances of code to streamline and increase readability.

== Design Strategy ==

* Implemented three model classes: `sign_up_team.rb` and `project_topic.rb` to address project requirements.
* Each model now has a focused role, improving maintainability and clarity.
* In signed_up_team.rb, the following functionality are being implemented:-

;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| drop_off_team_waitlists || Implemented || Removes the team from all waitlists for topics within the assignment.
|-
| find_first_existing_sign_up || Implemented || Finds the first existing sign-up entry for a given topic and team, checking for both active and waitlisted sign-ups.
|-
| create_signed_up_team || Implemented || Creates a SignedUpTeam instance with specified topic_id and team_id if the topic is available for sign-up.
|-
| get_team_id || Implemented || Retrieves the team ID associated with a given SignedUpTeam entry.
|-
| delete_signed_up_team || Implemented || Deletes the signed-up team entry for a specific topic, managing any dependent records as necessary.

|}
* Add necessary schema migrations to rename signup topic to project topic.
* In project_topic.rb, the following functionality are being implemented:-
*;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| slot_available? || Implemented || Checks if there are available slots for the topic based on the maximum allowed choosers. Returns true if available.
|-
| assign_topic_to_team || Implemented || Assigns the topic to a team by updating the sign-up entry to set is_waitlisted as false and assign the topic_id.
|-
| save_waitlist_entry || Implemented || Saves a sign-up entry as a waitlist entry by setting is_waitlisted to true and assigning the topic_id.
|-
| sign_up_team || Implemented || Manages the sign-up process for a team, checking slot availability, assigning the topic, or placing the team on the waitlist as needed
|}

== E/R Diagram ==
[[File:oodd.png |500px|center]]
Edit Button Tooltip

== Test Plan ==

*Set Up Initial Data: Create necessary records (Role, Instructor, Assignment, ProjectTopic, and Team) to establish relationships and dependencies required for testing ProjectTopic.

*Verify Slot Availability with No Teams Signed Up: Test slot_available? to ensure it returns true when no teams have chosen the topic, confirming that the method correctly identifies open slots.

*Test Topic Assignment Without Waitlisting: Use assign_topic_to_team to assign a topic to a team directly (without waitlisting) and check that is_waitlisted is set to false and the topic ID is correctly assigned.

*Simulate Slot Availability with Waitlist Clearance: Test sign_up_team when slots are available, mock drop_off_team_waitlists, and verify that the new team is assigned to the topic and the waitlist is cleared.

*Assert Expected Outcomes for Each Scenario: Validate results of each test by checking specific conditions, such as correct topic ID assignment, is_waitlisted status, and expected method calls, ensuring all methods perform accurately across various conditions.
* Test Cases for project_topic.rb model
[[File:Project_topic.jpg |1000px|center]]
Edit Button Tooltip

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-10-30T04:06:55Z

Skanumu2: /* Team Members */

== Team Members ==

* Ajith Kanumuri
* Suhas Adidela
* Ravi Chandu Bollepalli
* Mentor - Dinesh Pasupuleti
* PR Request:- https://github.com/expertiza/reimplementation-back-end/pull/125
* Project Board:- https://github.com/users/ajith05/projects/1/views/1
* Deployment Link:- http://152.7.177.8:3002/api-docs

== Project Description ==

The main goal of this project is to reimplement essential Ruby on Rails model classes—SignedUpTeam and ProjectTopic (renamed from SignUpTopic)—from the Expertiza repository in a new repository. Each of these model classes plays a critical role in managing topics and team sign-ups within course assignments, and the reimplementation aims to bring them into alignment with Rails best practices and the DRY (Don't Repeat Yourself) principle.

The SignedUpTeam model represents a team that has signed up for a specific topic within an assignment. This model manages team-specific data and oversees interactions that occur during the sign-up process. The ProjectTopic model, on the other hand, represents the topics available for sign-up within an assignment, managing essential details like slot availability and assigning teams to open topics.

Since this project is being implemented from scratch, a range of components have been developed to ensure the functionality is both streamlined and maintainable. To guarantee the reliability of each part of the reimplementation, unit test cases have been created to verify the integrity of the new design and implementation.

== Issue Description ==

* Comprehensive RSpec tests are essential for all reimplemented models to ensure correctness and reliability in functionality.

* Update all references from `sign_up_topics` to `project_topics` throughout the codebase to maintain consistency with the new naming convention.

* Address all code review feedback to improve code quality and alignment with best practices.

* Refactor methods with readability issues to make the code more maintainable and easier to understand.

* Optimize ambiguous class and instance methods to enhance reusability and improve the overall structure of the code.

* The old codebase has several instances of unnecessary calls to database, such as fetching all project topics for a user when fetching first topic would be sufficient. This effects efficiency and readability. Optimize such instances of code to streamline and increase readability.

== Design Strategy ==

* Implemented three model classes: `sign_up_team.rb` and `project_topic.rb` to address project requirements.
* Each model now has a focused role, improving maintainability and clarity.
* In signed_up_team.rb, the following functionality are being implemented:-

;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| drop_off_team_waitlists || Implemented || Removes the team from all waitlists for topics within the assignment.
|-
| find_first_existing_sign_up || Implemented || Finds the first existing sign-up entry for a given topic and team, checking for both active and waitlisted sign-ups.
|-
| create_signed_up_team || Implemented || Creates a SignedUpTeam instance with specified topic_id and team_id if the topic is available for sign-up.
|-
| get_team_id || Implemented || Retrieves the team ID associated with a given SignedUpTeam entry.
|-
| delete_signed_up_team || Implemented || Deletes the signed-up team entry for a specific topic, managing any dependent records as necessary.

|}
* Add necessary schema migrations to rename signup topic to project topic.
* In project_topic.rb, the following functionality are being implemented:-
*;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| slot_available? || Implemented || Checks if there are available slots for the topic based on the maximum allowed choosers. Returns true if available.
|-
| assign_topic_to_team || Implemented || Assigns the topic to a team by updating the sign-up entry to set is_waitlisted as false and assign the topic_id.
|-
| save_waitlist_entry || Implemented || Saves a sign-up entry as a waitlist entry by setting is_waitlisted to true and assigning the topic_id.
|-
| sign_up_team || Implemented || Manages the sign-up process for a team, checking slot availability, assigning the topic, or placing the team on the waitlist as needed
|}

== E/R Diagram ==
[[File:oodd.png |500px|center]]
Edit Button Tooltip

== Test Plan ==

*Set Up Initial Data: Create necessary records (Role, Instructor, Assignment, ProjectTopic, and Team) to establish relationships and dependencies required for testing ProjectTopic.

*Verify Slot Availability with No Teams Signed Up: Test slot_available? to ensure it returns true when no teams have chosen the topic, confirming that the method correctly identifies open slots.

*Test Topic Assignment Without Waitlisting: Use assign_topic_to_team to assign a topic to a team directly (without waitlisting) and check that is_waitlisted is set to false and the topic ID is correctly assigned.

*Simulate Slot Availability with Waitlist Clearance: Test sign_up_team when slots are available, mock drop_off_team_waitlists, and verify that the new team is assigned to the topic and the waitlist is cleared.

*Assert Expected Outcomes for Each Scenario: Validate results of each test by checking specific conditions, such as correct topic ID assignment, is_waitlisted status, and expected method calls, ensuring all methods perform accurately across various conditions.
* Test Cases for project_topic.rb model
[[File:Project_topic.png |1000px|center]]
Edit Button Tooltip

File:Project topic.jpg

2024-10-30T04:05:38Z

Skanumu2:

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-10-30T04:05:22Z

Skanumu2: /* Team Members */

== Team Members ==

* Ajith Kanumuri
* Suhas Adidela
* Ravi Chandu Bollepalli
* Mentor - Dinesh Pasupuleti
* PR Request:- https://github.com/expertiza/reimplementation-back-end/pull/125
* Project Board:- https://github.com/users/ajith05/projects/1/views/1
* Deployment Link:- http://152.7.177.8/api-docs

== Project Description ==

The main goal of this project is to reimplement essential Ruby on Rails model classes—SignedUpTeam and ProjectTopic (renamed from SignUpTopic)—from the Expertiza repository in a new repository. Each of these model classes plays a critical role in managing topics and team sign-ups within course assignments, and the reimplementation aims to bring them into alignment with Rails best practices and the DRY (Don't Repeat Yourself) principle.

The SignedUpTeam model represents a team that has signed up for a specific topic within an assignment. This model manages team-specific data and oversees interactions that occur during the sign-up process. The ProjectTopic model, on the other hand, represents the topics available for sign-up within an assignment, managing essential details like slot availability and assigning teams to open topics.

Since this project is being implemented from scratch, a range of components have been developed to ensure the functionality is both streamlined and maintainable. To guarantee the reliability of each part of the reimplementation, unit test cases have been created to verify the integrity of the new design and implementation.

== Issue Description ==

* Comprehensive RSpec tests are essential for all reimplemented models to ensure correctness and reliability in functionality.

* Update all references from `sign_up_topics` to `project_topics` throughout the codebase to maintain consistency with the new naming convention.

* Address all code review feedback to improve code quality and alignment with best practices.

* Refactor methods with readability issues to make the code more maintainable and easier to understand.

* Optimize ambiguous class and instance methods to enhance reusability and improve the overall structure of the code.

* The old codebase has several instances of unnecessary calls to database, such as fetching all project topics for a user when fetching first topic would be sufficient. This effects efficiency and readability. Optimize such instances of code to streamline and increase readability.

== Design Strategy ==

* Implemented three model classes: `sign_up_team.rb` and `project_topic.rb` to address project requirements.
* Each model now has a focused role, improving maintainability and clarity.
* In signed_up_team.rb, the following functionality are being implemented:-

;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| drop_off_team_waitlists || Implemented || Removes the team from all waitlists for topics within the assignment.
|-
| find_first_existing_sign_up || Implemented || Finds the first existing sign-up entry for a given topic and team, checking for both active and waitlisted sign-ups.
|-
| create_signed_up_team || Implemented || Creates a SignedUpTeam instance with specified topic_id and team_id if the topic is available for sign-up.
|-
| get_team_id || Implemented || Retrieves the team ID associated with a given SignedUpTeam entry.
|-
| delete_signed_up_team || Implemented || Deletes the signed-up team entry for a specific topic, managing any dependent records as necessary.

|}
* Add necessary schema migrations to rename signup topic to project topic.
* In project_topic.rb, the following functionality are being implemented:-
*;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| slot_available? || Implemented || Checks if there are available slots for the topic based on the maximum allowed choosers. Returns true if available.
|-
| assign_topic_to_team || Implemented || Assigns the topic to a team by updating the sign-up entry to set is_waitlisted as false and assign the topic_id.
|-
| save_waitlist_entry || Implemented || Saves a sign-up entry as a waitlist entry by setting is_waitlisted to true and assigning the topic_id.
|-
| sign_up_team || Implemented || Manages the sign-up process for a team, checking slot availability, assigning the topic, or placing the team on the waitlist as needed
|}

== E/R Diagram ==
[[File:oodd.png |500px|center]]
Edit Button Tooltip

== Test Plan ==

*Set Up Initial Data: Create necessary records (Role, Instructor, Assignment, ProjectTopic, and Team) to establish relationships and dependencies required for testing ProjectTopic.

*Verify Slot Availability with No Teams Signed Up: Test slot_available? to ensure it returns true when no teams have chosen the topic, confirming that the method correctly identifies open slots.

*Test Topic Assignment Without Waitlisting: Use assign_topic_to_team to assign a topic to a team directly (without waitlisting) and check that is_waitlisted is set to false and the topic ID is correctly assigned.

*Simulate Slot Availability with Waitlist Clearance: Test sign_up_team when slots are available, mock drop_off_team_waitlists, and verify that the new team is assigned to the topic and the waitlist is cleared.

*Assert Expected Outcomes for Each Scenario: Validate results of each test by checking specific conditions, such as correct topic ID assignment, is_waitlisted status, and expected method calls, ensuring all methods perform accurately across various conditions.
* Test Cases for project_topic.rb model
[[File:Project_topic.png |1000px|center]]
Edit Button Tooltip

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-10-30T04:05:09Z

Skanumu2: /* Test Plan */

== Team Members ==

* Ajith Kanumuri
* Suhas Adidela
* Ravi Chandu Bollepalli
* Mentor - Dinesh Pasupuleti
* PR Request:- https://github.com/expertiza/reimplementation-back-end/pull/125
* Project Board:- https://github.com/users/ajith05/projects/1/views/1

== Project Description ==

The main goal of this project is to reimplement essential Ruby on Rails model classes—SignedUpTeam and ProjectTopic (renamed from SignUpTopic)—from the Expertiza repository in a new repository. Each of these model classes plays a critical role in managing topics and team sign-ups within course assignments, and the reimplementation aims to bring them into alignment with Rails best practices and the DRY (Don't Repeat Yourself) principle.

The SignedUpTeam model represents a team that has signed up for a specific topic within an assignment. This model manages team-specific data and oversees interactions that occur during the sign-up process. The ProjectTopic model, on the other hand, represents the topics available for sign-up within an assignment, managing essential details like slot availability and assigning teams to open topics.

Since this project is being implemented from scratch, a range of components have been developed to ensure the functionality is both streamlined and maintainable. To guarantee the reliability of each part of the reimplementation, unit test cases have been created to verify the integrity of the new design and implementation.

== Issue Description ==

* Comprehensive RSpec tests are essential for all reimplemented models to ensure correctness and reliability in functionality.

* Update all references from `sign_up_topics` to `project_topics` throughout the codebase to maintain consistency with the new naming convention.

* Address all code review feedback to improve code quality and alignment with best practices.

* Refactor methods with readability issues to make the code more maintainable and easier to understand.

* Optimize ambiguous class and instance methods to enhance reusability and improve the overall structure of the code.

* The old codebase has several instances of unnecessary calls to database, such as fetching all project topics for a user when fetching first topic would be sufficient. This effects efficiency and readability. Optimize such instances of code to streamline and increase readability.

== Design Strategy ==

* Implemented three model classes: `sign_up_team.rb` and `project_topic.rb` to address project requirements.
* Each model now has a focused role, improving maintainability and clarity.
* In signed_up_team.rb, the following functionality are being implemented:-

;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| drop_off_team_waitlists || Implemented || Removes the team from all waitlists for topics within the assignment.
|-
| find_first_existing_sign_up || Implemented || Finds the first existing sign-up entry for a given topic and team, checking for both active and waitlisted sign-ups.
|-
| create_signed_up_team || Implemented || Creates a SignedUpTeam instance with specified topic_id and team_id if the topic is available for sign-up.
|-
| get_team_id || Implemented || Retrieves the team ID associated with a given SignedUpTeam entry.
|-
| delete_signed_up_team || Implemented || Deletes the signed-up team entry for a specific topic, managing any dependent records as necessary.

|}
* Add necessary schema migrations to rename signup topic to project topic.
* In project_topic.rb, the following functionality are being implemented:-
*;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| slot_available? || Implemented || Checks if there are available slots for the topic based on the maximum allowed choosers. Returns true if available.
|-
| assign_topic_to_team || Implemented || Assigns the topic to a team by updating the sign-up entry to set is_waitlisted as false and assign the topic_id.
|-
| save_waitlist_entry || Implemented || Saves a sign-up entry as a waitlist entry by setting is_waitlisted to true and assigning the topic_id.
|-
| sign_up_team || Implemented || Manages the sign-up process for a team, checking slot availability, assigning the topic, or placing the team on the waitlist as needed
|}

== E/R Diagram ==
[[File:oodd.png |500px|center]]
Edit Button Tooltip

== Test Plan ==

*Set Up Initial Data: Create necessary records (Role, Instructor, Assignment, ProjectTopic, and Team) to establish relationships and dependencies required for testing ProjectTopic.

*Verify Slot Availability with No Teams Signed Up: Test slot_available? to ensure it returns true when no teams have chosen the topic, confirming that the method correctly identifies open slots.

*Test Topic Assignment Without Waitlisting: Use assign_topic_to_team to assign a topic to a team directly (without waitlisting) and check that is_waitlisted is set to false and the topic ID is correctly assigned.

*Simulate Slot Availability with Waitlist Clearance: Test sign_up_team when slots are available, mock drop_off_team_waitlists, and verify that the new team is assigned to the topic and the waitlist is cleared.

*Assert Expected Outcomes for Each Scenario: Validate results of each test by checking specific conditions, such as correct topic ID assignment, is_waitlisted status, and expected method calls, ensuring all methods perform accurately across various conditions.
* Test Cases for project_topic.rb model
[[File:Project_topic.png |1000px|center]]
Edit Button Tooltip

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-10-30T04:02:36Z

Skanumu2: /* Test Plan */

== Team Members ==

* Ajith Kanumuri
* Suhas Adidela
* Ravi Chandu Bollepalli
* Mentor - Dinesh Pasupuleti
* PR Request:- https://github.com/expertiza/reimplementation-back-end/pull/125
* Project Board:- https://github.com/users/ajith05/projects/1/views/1

== Project Description ==

The main goal of this project is to reimplement essential Ruby on Rails model classes—SignedUpTeam and ProjectTopic (renamed from SignUpTopic)—from the Expertiza repository in a new repository. Each of these model classes plays a critical role in managing topics and team sign-ups within course assignments, and the reimplementation aims to bring them into alignment with Rails best practices and the DRY (Don't Repeat Yourself) principle.

The SignedUpTeam model represents a team that has signed up for a specific topic within an assignment. This model manages team-specific data and oversees interactions that occur during the sign-up process. The ProjectTopic model, on the other hand, represents the topics available for sign-up within an assignment, managing essential details like slot availability and assigning teams to open topics.

Since this project is being implemented from scratch, a range of components have been developed to ensure the functionality is both streamlined and maintainable. To guarantee the reliability of each part of the reimplementation, unit test cases have been created to verify the integrity of the new design and implementation.

== Issue Description ==

* Comprehensive RSpec tests are essential for all reimplemented models to ensure correctness and reliability in functionality.

* Update all references from `sign_up_topics` to `project_topics` throughout the codebase to maintain consistency with the new naming convention.

* Address all code review feedback to improve code quality and alignment with best practices.

* Refactor methods with readability issues to make the code more maintainable and easier to understand.

* Optimize ambiguous class and instance methods to enhance reusability and improve the overall structure of the code.

* The old codebase has several instances of unnecessary calls to database, such as fetching all project topics for a user when fetching first topic would be sufficient. This effects efficiency and readability. Optimize such instances of code to streamline and increase readability.

== Design Strategy ==

* Implemented three model classes: `sign_up_team.rb` and `project_topic.rb` to address project requirements.
* Each model now has a focused role, improving maintainability and clarity.
* In signed_up_team.rb, the following functionality are being implemented:-

;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| drop_off_team_waitlists || Implemented || Removes the team from all waitlists for topics within the assignment.
|-
| find_first_existing_sign_up || Implemented || Finds the first existing sign-up entry for a given topic and team, checking for both active and waitlisted sign-ups.
|-
| create_signed_up_team || Implemented || Creates a SignedUpTeam instance with specified topic_id and team_id if the topic is available for sign-up.
|-
| get_team_id || Implemented || Retrieves the team ID associated with a given SignedUpTeam entry.
|-
| delete_signed_up_team || Implemented || Deletes the signed-up team entry for a specific topic, managing any dependent records as necessary.

|}
* Add necessary schema migrations to rename signup topic to project topic.
* In project_topic.rb, the following functionality are being implemented:-
*;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| slot_available? || Implemented || Checks if there are available slots for the topic based on the maximum allowed choosers. Returns true if available.
|-
| assign_topic_to_team || Implemented || Assigns the topic to a team by updating the sign-up entry to set is_waitlisted as false and assign the topic_id.
|-
| save_waitlist_entry || Implemented || Saves a sign-up entry as a waitlist entry by setting is_waitlisted to true and assigning the topic_id.
|-
| sign_up_team || Implemented || Manages the sign-up process for a team, checking slot availability, assigning the topic, or placing the team on the waitlist as needed
|}

== E/R Diagram ==
[[File:oodd.png |500px|center]]
Edit Button Tooltip

== Test Plan ==

*Set Up Initial Data: Create necessary records (Role, Instructor, Assignment, ProjectTopic, and Team) to establish relationships and dependencies required for testing ProjectTopic.

*Verify Slot Availability with No Teams Signed Up: Test slot_available? to ensure it returns true when no teams have chosen the topic, confirming that the method correctly identifies open slots.

*Test Topic Assignment Without Waitlisting: Use assign_topic_to_team to assign a topic to a team directly (without waitlisting) and check that is_waitlisted is set to false and the topic ID is correctly assigned.

*Simulate Slot Availability with Waitlist Clearance: Test sign_up_team when slots are available, mock drop_off_team_waitlists, and verify that the new team is assigned to the topic and the waitlist is cleared.

*Assert Expected Outcomes for Each Scenario: Validate results of each test by checking specific conditions, such as correct topic ID assignment, is_waitlisted status, and expected method calls, ensuring all methods perform accurately across various conditions.
* Test Cases for project_topic.rb model
[[File:WhatsApp Image 2024-10-29 at 23.56.25_6b9058ad.png|900px]]

File:WhatsApp Image 2024-10-29 at 23.56.25 6b9058ad.jpg

2024-10-30T03:59:07Z

Skanumu2:

CSC/ECE 517 Spring 2024 E2473. Reimplement sign up topic.rb as project topic.rb

2024-10-30T03:55:54Z

Skanumu2: Skanumu2 moved page CSC/ECE 517 Spring 2024 E2473. Reimplement sign up topic.rb as project topic.rb to CSC/ECE 517 Fall 2024 E2473. Reimplement sign up topic.rb as project topic.rb

#REDIRECT [[CSC/ECE 517 Fall 2024 E2473. Reimplement sign up topic.rb as project topic.rb]]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-10-30T03:55:54Z

Skanumu2: Skanumu2 moved page CSC/ECE 517 Spring 2024 E2473. Reimplement sign up topic.rb as project topic.rb to CSC/ECE 517 Fall 2024 E2473. Reimplement sign up topic.rb as project topic.rb

== Team Members ==

* Ajith Kanumuri
* Suhas Adidela
* Ravi Chandu Bollepalli
* Mentor - Dinesh Pasupuleti
* PR Request:- https://github.com/expertiza/reimplementation-back-end/pull/125
* Project Board:- https://github.com/users/ajith05/projects/1/views/1

== Project Description ==

The main goal of this project is to reimplement essential Ruby on Rails model classes—SignedUpTeam and ProjectTopic (renamed from SignUpTopic)—from the Expertiza repository in a new repository. Each of these model classes plays a critical role in managing topics and team sign-ups within course assignments, and the reimplementation aims to bring them into alignment with Rails best practices and the DRY (Don't Repeat Yourself) principle.

The SignedUpTeam model represents a team that has signed up for a specific topic within an assignment. This model manages team-specific data and oversees interactions that occur during the sign-up process. The ProjectTopic model, on the other hand, represents the topics available for sign-up within an assignment, managing essential details like slot availability and assigning teams to open topics.

Since this project is being implemented from scratch, a range of components have been developed to ensure the functionality is both streamlined and maintainable. To guarantee the reliability of each part of the reimplementation, unit test cases have been created to verify the integrity of the new design and implementation.

== Issue Description ==

* Comprehensive RSpec tests are essential for all reimplemented models to ensure correctness and reliability in functionality.

* Update all references from `sign_up_topics` to `project_topics` throughout the codebase to maintain consistency with the new naming convention.

* Address all code review feedback to improve code quality and alignment with best practices.

* Refactor methods with readability issues to make the code more maintainable and easier to understand.

* Optimize ambiguous class and instance methods to enhance reusability and improve the overall structure of the code.

* The old codebase has several instances of unnecessary calls to database, such as fetching all project topics for a user when fetching first topic would be sufficient. This effects efficiency and readability. Optimize such instances of code to streamline and increase readability.

== Design Strategy ==

* Implemented three model classes: `sign_up_team.rb` and `project_topic.rb` to address project requirements.
* Each model now has a focused role, improving maintainability and clarity.
* In signed_up_team.rb, the following functionality are being implemented:-

;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| drop_off_team_waitlists || Implemented || Removes the team from all waitlists for topics within the assignment.
|-
| find_first_existing_sign_up || Implemented || Finds the first existing sign-up entry for a given topic and team, checking for both active and waitlisted sign-ups.
|-
| create_signed_up_team || Implemented || Creates a SignedUpTeam instance with specified topic_id and team_id if the topic is available for sign-up.
|-
| get_team_id || Implemented || Retrieves the team ID associated with a given SignedUpTeam entry.
|-
| delete_signed_up_team || Implemented || Deletes the signed-up team entry for a specific topic, managing any dependent records as necessary.

|}
* Add necessary schema migrations to rename signup topic to project topic.
* In project_topic.rb, the following functionality are being implemented:-
*;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| slot_available? || Implemented || Checks if there are available slots for the topic based on the maximum allowed choosers. Returns true if available.
|-
| assign_topic_to_team || Implemented || Assigns the topic to a team by updating the sign-up entry to set is_waitlisted as false and assign the topic_id.
|-
| save_waitlist_entry || Implemented || Saves a sign-up entry as a waitlist entry by setting is_waitlisted to true and assigning the topic_id.
|-
| sign_up_team || Implemented || Manages the sign-up process for a team, checking slot availability, assigning the topic, or placing the team on the waitlist as needed
|}

== E/R Diagram ==
[[File:oodd.png |500px|center]]
Edit Button Tooltip

== Test Plan ==

* Upgrade RSpec test cases for `signed_up_team.rb` to validate `delete_signed_up_team` and `get_team_participants` methods.
* Enhance and expand RSpec test cases for `project_topic.rb` to validate participant retrieval, slot availability, and assignment status handling.
* Develop RSpec test cases for `waitlist.rb` to validate adding teams to the waitlist, removing teams from the waitlist, and querying the waitlist status of a team.
* Add general RSpec test cases for error handling and ensure correct JSON serialization of data..
* Test Cases for signed_up_team.rb model
[[File:Signedup_team_rspec.png|900px]]
* Test Cases for waitlist.rb model
[[File:Waitlist_rspec.png|900px]]
* Test Cases for signup_topic.rb
[[File:Signup_topic_rspec.png|900px]]

User:CSC/ECE 517 Spring 2024 E2473. Reimplement sign up topic.rb as project topic.rb

2024-10-30T02:41:01Z

Skanumu2: Skanumu2 moved page User:CSC/ECE 517 Spring 2024 E2473. Reimplement sign up topic.rb as project topic.rb to CSC/ECE 517 Spring 2024 E2473. Reimplement sign up topic.rb as project topic.rb

#REDIRECT [[CSC/ECE 517 Spring 2024 E2473. Reimplement sign up topic.rb as project topic.rb]]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-10-30T02:41:01Z

Skanumu2: Skanumu2 moved page User:CSC/ECE 517 Spring 2024 E2473. Reimplement sign up topic.rb as project topic.rb to CSC/ECE 517 Spring 2024 E2473. Reimplement sign up topic.rb as project topic.rb

== Team Members ==

* Ajith Kanumuri
* Suhas Adidela
* Ravi Chandu Bollepalli
* Mentor - Dinesh Pasupuleti
* PR Request:- https://github.com/expertiza/reimplementation-back-end/pull/125
* Project Board:- https://github.com/users/ajith05/projects/1/views/1

== Project Description ==

The main goal of this project is to reimplement essential Ruby on Rails model classes—SignedUpTeam and ProjectTopic (renamed from SignUpTopic)—from the Expertiza repository in a new repository. Each of these model classes plays a critical role in managing topics and team sign-ups within course assignments, and the reimplementation aims to bring them into alignment with Rails best practices and the DRY (Don't Repeat Yourself) principle.

The SignedUpTeam model represents a team that has signed up for a specific topic within an assignment. This model manages team-specific data and oversees interactions that occur during the sign-up process. The ProjectTopic model, on the other hand, represents the topics available for sign-up within an assignment, managing essential details like slot availability and assigning teams to open topics.

Since this project is being implemented from scratch, a range of components have been developed to ensure the functionality is both streamlined and maintainable. To guarantee the reliability of each part of the reimplementation, unit test cases have been created to verify the integrity of the new design and implementation.

== Issue Description ==

* Comprehensive RSpec tests are essential for all reimplemented models to ensure correctness and reliability in functionality.

* Update all references from `sign_up_topics` to `project_topics` throughout the codebase to maintain consistency with the new naming convention.

* Address all code review feedback to improve code quality and alignment with best practices.

* Refactor methods with readability issues to make the code more maintainable and easier to understand.

* Optimize ambiguous class and instance methods to enhance reusability and improve the overall structure of the code.

* The old codebase has several instances of unnecessary calls to database, such as fetching all project topics for a user when fetching first topic would be sufficient. This effects efficiency and readability. Optimize such instances of code to streamline and increase readability.

== Design Strategy ==

* Implemented three model classes: `sign_up_team.rb` and `project_topic.rb` to address project requirements.
* Each model now has a focused role, improving maintainability and clarity.
* In signed_up_team.rb, the following functionality are being implemented:-

;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| drop_off_team_waitlists || Implemented || Removes the team from all waitlists for topics within the assignment.
|-
| find_first_existing_sign_up || Implemented || Finds the first existing sign-up entry for a given topic and team, checking for both active and waitlisted sign-ups.
|-
| create_signed_up_team || Implemented || Creates a SignedUpTeam instance with specified topic_id and team_id if the topic is available for sign-up.
|-
| get_team_id || Implemented || Retrieves the team ID associated with a given SignedUpTeam entry.
|-
| delete_signed_up_team || Implemented || Deletes the signed-up team entry for a specific topic, managing any dependent records as necessary.

|}
* Add necessary schema migrations to rename signup topic to project topic.
* In project_topic.rb, the following functionality are being implemented:-
*;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| slot_available? || Implemented || Checks if there are available slots for the topic based on the maximum allowed choosers. Returns true if available.
|-
| assign_topic_to_team || Implemented || Assigns the topic to a team by updating the sign-up entry to set is_waitlisted as false and assign the topic_id.
|-
| save_waitlist_entry || Implemented || Saves a sign-up entry as a waitlist entry by setting is_waitlisted to true and assigning the topic_id.
|-
| sign_up_team || Implemented || Manages the sign-up process for a team, checking slot availability, assigning the topic, or placing the team on the waitlist as needed
|}

== E/R Diagram ==
[[File:oodd.png |500px|center]]
Edit Button Tooltip

== Test Plan ==

* Upgrade RSpec test cases for `signed_up_team.rb` to validate `delete_signed_up_team` and `get_team_participants` methods.
* Enhance and expand RSpec test cases for `project_topic.rb` to validate participant retrieval, slot availability, and assignment status handling.
* Develop RSpec test cases for `waitlist.rb` to validate adding teams to the waitlist, removing teams from the waitlist, and querying the waitlist status of a team.
* Add general RSpec test cases for error handling and ensure correct JSON serialization of data..
* Test Cases for signed_up_team.rb model
[[File:Signedup_team_rspec.png|900px]]
* Test Cases for waitlist.rb model
[[File:Waitlist_rspec.png|900px]]
* Test Cases for signup_topic.rb
[[File:Signup_topic_rspec.png|900px]]

User:Skanumu2

2024-10-30T02:40:35Z

Skanumu2: Skanumu2 moved page User:Skanumu2 to User:CSC/ECE 517 Spring 2024 E2473. Reimplement sign up topic.rb as project topic.rb

#REDIRECT [[User:CSC/ECE 517 Spring 2024 E2473. Reimplement sign up topic.rb as project topic.rb]]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-10-30T02:40:35Z

Skanumu2: Skanumu2 moved page User:Skanumu2 to User:CSC/ECE 517 Spring 2024 E2473. Reimplement sign up topic.rb as project topic.rb

== Team Members ==

* Ajith Kanumuri
* Suhas Adidela
* Ravi Chandu Bollepalli
* Mentor - Dinesh Pasupuleti
* PR Request:- https://github.com/expertiza/reimplementation-back-end/pull/125
* Project Board:- https://github.com/users/ajith05/projects/1/views/1

== Project Description ==

The main goal of this project is to reimplement essential Ruby on Rails model classes—SignedUpTeam and ProjectTopic (renamed from SignUpTopic)—from the Expertiza repository in a new repository. Each of these model classes plays a critical role in managing topics and team sign-ups within course assignments, and the reimplementation aims to bring them into alignment with Rails best practices and the DRY (Don't Repeat Yourself) principle.

The SignedUpTeam model represents a team that has signed up for a specific topic within an assignment. This model manages team-specific data and oversees interactions that occur during the sign-up process. The ProjectTopic model, on the other hand, represents the topics available for sign-up within an assignment, managing essential details like slot availability and assigning teams to open topics.

Since this project is being implemented from scratch, a range of components have been developed to ensure the functionality is both streamlined and maintainable. To guarantee the reliability of each part of the reimplementation, unit test cases have been created to verify the integrity of the new design and implementation.

== Issue Description ==

* Comprehensive RSpec tests are essential for all reimplemented models to ensure correctness and reliability in functionality.

* Update all references from `sign_up_topics` to `project_topics` throughout the codebase to maintain consistency with the new naming convention.

* Address all code review feedback to improve code quality and alignment with best practices.

* Refactor methods with readability issues to make the code more maintainable and easier to understand.

* Optimize ambiguous class and instance methods to enhance reusability and improve the overall structure of the code.

* The old codebase has several instances of unnecessary calls to database, such as fetching all project topics for a user when fetching first topic would be sufficient. This effects efficiency and readability. Optimize such instances of code to streamline and increase readability.

== Design Strategy ==

* Implemented three model classes: `sign_up_team.rb` and `project_topic.rb` to address project requirements.
* Each model now has a focused role, improving maintainability and clarity.
* In signed_up_team.rb, the following functionality are being implemented:-

;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| drop_off_team_waitlists || Implemented || Removes the team from all waitlists for topics within the assignment.
|-
| find_first_existing_sign_up || Implemented || Finds the first existing sign-up entry for a given topic and team, checking for both active and waitlisted sign-ups.
|-
| create_signed_up_team || Implemented || Creates a SignedUpTeam instance with specified topic_id and team_id if the topic is available for sign-up.
|-
| get_team_id || Implemented || Retrieves the team ID associated with a given SignedUpTeam entry.
|-
| delete_signed_up_team || Implemented || Deletes the signed-up team entry for a specific topic, managing any dependent records as necessary.

|}
* Add necessary schema migrations to rename signup topic to project topic.
* In project_topic.rb, the following functionality are being implemented:-
*;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| slot_available? || Implemented || Checks if there are available slots for the topic based on the maximum allowed choosers. Returns true if available.
|-
| assign_topic_to_team || Implemented || Assigns the topic to a team by updating the sign-up entry to set is_waitlisted as false and assign the topic_id.
|-
| save_waitlist_entry || Implemented || Saves a sign-up entry as a waitlist entry by setting is_waitlisted to true and assigning the topic_id.
|-
| sign_up_team || Implemented || Manages the sign-up process for a team, checking slot availability, assigning the topic, or placing the team on the waitlist as needed
|}

== E/R Diagram ==
[[File:oodd.png |500px|center]]
Edit Button Tooltip

== Test Plan ==

* Upgrade RSpec test cases for `signed_up_team.rb` to validate `delete_signed_up_team` and `get_team_participants` methods.
* Enhance and expand RSpec test cases for `project_topic.rb` to validate participant retrieval, slot availability, and assignment status handling.
* Develop RSpec test cases for `waitlist.rb` to validate adding teams to the waitlist, removing teams from the waitlist, and querying the waitlist status of a team.
* Add general RSpec test cases for error handling and ensure correct JSON serialization of data..
* Test Cases for signed_up_team.rb model
[[File:Signedup_team_rspec.png|900px]]
* Test Cases for waitlist.rb model
[[File:Waitlist_rspec.png|900px]]
* Test Cases for signup_topic.rb
[[File:Signup_topic_rspec.png|900px]]

CSC/ECE 517 Fall 2024 - E2473. Reimplement sign up topic.rb as project topic.rb

2024-10-30T02:32:47Z

Skanumu2: Created page with "== Team Members == * Ajith Kanumuri * Suhas Adidela * Ravi Chandu Bollepalli * Mentor - Dinesh Pasupuleti * PR Request:- https://github.com/expertiza/reimplementation-back-end/pull/125 * Project Board:- https://github.com/users/ajith05/projects/1/views/1 == Project Description == The main goal of this project is to reimplement essential Ruby on Rails model classes—SignedUpTeam and ProjectTopic (renamed from SignUpTopic)—from the Expertiza repository in a new rep..."

== Team Members ==

* Ajith Kanumuri
* Suhas Adidela
* Ravi Chandu Bollepalli
* Mentor - Dinesh Pasupuleti
* PR Request:- https://github.com/expertiza/reimplementation-back-end/pull/125
* Project Board:- https://github.com/users/ajith05/projects/1/views/1

== Project Description ==

The main goal of this project is to reimplement essential Ruby on Rails model classes—SignedUpTeam and ProjectTopic (renamed from SignUpTopic)—from the Expertiza repository in a new repository. Each of these model classes plays a critical role in managing topics and team sign-ups within course assignments, and the reimplementation aims to bring them into alignment with Rails best practices and the DRY (Don't Repeat Yourself) principle.

The SignedUpTeam model represents a team that has signed up for a specific topic within an assignment. This model manages team-specific data and oversees interactions that occur during the sign-up process. The ProjectTopic model, on the other hand, represents the topics available for sign-up within an assignment, managing essential details like slot availability and assigning teams to open topics.

Since this project is being implemented from scratch, a range of components have been developed to ensure the functionality is both streamlined and maintainable. To guarantee the reliability of each part of the reimplementation, unit test cases have been created to verify the integrity of the new design and implementation.

== Issue Description ==

* Comprehensive RSpec tests are essential for all reimplemented models to ensure correctness and reliability in functionality.

* Update all references from `sign_up_topics` to `project_topics` throughout the codebase to maintain consistency with the new naming convention.

* Address all code review feedback to improve code quality and alignment with best practices.

* Refactor methods with readability issues to make the code more maintainable and easier to understand.

* Optimize ambiguous class and instance methods to enhance reusability and improve the overall structure of the code.

* The old codebase has several instances of unnecessary calls to database, such as fetching all project topics for a user when fetching first topic would be sufficient. This effects efficiency and readability. Optimize such instances of code to streamline and increase readability.

== Design Strategy ==

* Implemented three model classes: `sign_up_team.rb` and `project_topic.rb` to address project requirements.
* Each model now has a focused role, improving maintainability and clarity.
* In signed_up_team.rb, the following functionality are being implemented:-

;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| drop_off_team_waitlists || Implemented || Removes the team from all waitlists for topics within the assignment.
|-
| find_first_existing_sign_up || Implemented || Finds the first existing sign-up entry for a given topic and team, checking for both active and waitlisted sign-ups.
|-
| create_signed_up_team || Implemented || Creates a SignedUpTeam instance with specified topic_id and team_id if the topic is available for sign-up.
|-
| get_team_id || Implemented || Retrieves the team ID associated with a given SignedUpTeam entry.
|-
| delete_signed_up_team || Implemented || Deletes the signed-up team entry for a specific topic, managing any dependent records as necessary.

|}
* Add necessary schema migrations to rename signup topic to project topic.
* In project_topic.rb, the following functionality are being implemented:-
*;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| slot_available? || Implemented || Checks if there are available slots for the topic based on the maximum allowed choosers. Returns true if available.
|-
| assign_topic_to_team || Implemented || Assigns the topic to a team by updating the sign-up entry to set is_waitlisted as false and assign the topic_id.
|-
| save_waitlist_entry || Implemented || Saves a sign-up entry as a waitlist entry by setting is_waitlisted to true and assigning the topic_id.
|-
| sign_up_team || Implemented || Manages the sign-up process for a team, checking slot availability, assigning the topic, or placing the team on the waitlist as needed
|}

== E/R Diagram ==
[[File:oodd.png |500px|center]]
Edit Button Tooltip

== Test Plan ==

* Upgrade RSpec test cases for `signed_up_team.rb` to validate `delete_signed_up_team` and `get_team_participants` methods.
* Enhance and expand RSpec test cases for `project_topic.rb` to validate participant retrieval, slot availability, and assignment status handling.
* Develop RSpec test cases for `waitlist.rb` to validate adding teams to the waitlist, removing teams from the waitlist, and querying the waitlist status of a team.
* Add general RSpec test cases for error handling and ensure correct JSON serialization of data..
* Test Cases for signed_up_team.rb model
[[File:Signedup_team_rspec.png|900px]]
* Test Cases for waitlist.rb model
[[File:Waitlist_rspec.png|900px]]
* Test Cases for signup_topic.rb
[[File:Signup_topic_rspec.png|900px]]

CSC/ECE 517 Spring 2023 -

2024-10-30T02:30:14Z

Skanumu2: /* Design Strategy */

== Team Members ==

* Ajith Kanumuri
* Suhas Adidela
* Ravi Chandu Bollepalli
* Mentor - Dinesh Pasupuleti
* PR Request:- https://github.com/expertiza/reimplementation-back-end/pull/125
* Project Board:- https://github.com/users/ajith05/projects/1/views/1

== Project Description ==

The main goal of this project is to reimplement essential Ruby on Rails model classes—SignedUpTeam and ProjectTopic (renamed from SignUpTopic)—from the Expertiza repository in a new repository. Each of these model classes plays a critical role in managing topics and team sign-ups within course assignments, and the reimplementation aims to bring them into alignment with Rails best practices and the DRY (Don't Repeat Yourself) principle.

The SignedUpTeam model represents a team that has signed up for a specific topic within an assignment. This model manages team-specific data and oversees interactions that occur during the sign-up process. The ProjectTopic model, on the other hand, represents the topics available for sign-up within an assignment, managing essential details like slot availability and assigning teams to open topics.

Since this project is being implemented from scratch, a range of components have been developed to ensure the functionality is both streamlined and maintainable. To guarantee the reliability of each part of the reimplementation, unit test cases have been created to verify the integrity of the new design and implementation.

== Issue Description ==

* Comprehensive RSpec tests are essential for all reimplemented models to ensure correctness and reliability in functionality.

* Update all references from `sign_up_topics` to `project_topics` throughout the codebase to maintain consistency with the new naming convention.

* Address all code review feedback to improve code quality and alignment with best practices.

* Refactor methods with readability issues to make the code more maintainable and easier to understand.

* Optimize ambiguous class and instance methods to enhance reusability and improve the overall structure of the code.

* The old codebase has several instances of unnecessary calls to database, such as fetching all project topics for a user when fetching first topic would be sufficient. This effects efficiency and readability. Optimize such instances of code to streamline and increase readability.

== Design Strategy ==

* Implemented three model classes: `sign_up_team.rb` and `project_topic.rb` to address project requirements.
* Each model now has a focused role, improving maintainability and clarity.
* In signed_up_team.rb, the following functionality are being implemented:-

;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| drop_off_team_waitlists || Implemented || Removes the team from all waitlists for topics within the assignment.
|-
| find_first_existing_sign_up || Implemented || Finds the first existing sign-up entry for a given topic and team, checking for both active and waitlisted sign-ups.
|-
| create_signed_up_team || Implemented || Creates a SignedUpTeam instance with specified topic_id and team_id if the topic is available for sign-up.
|-
| get_team_id || Implemented || Retrieves the team ID associated with a given SignedUpTeam entry.
|-
| delete_signed_up_team || Implemented || Deletes the signed-up team entry for a specific topic, managing any dependent records as necessary.

|}
* Add necessary schema migrations to rename signup topic to project topic.
* In project_topic.rb, the following functionality are being implemented:-
*;
{| class="wikitable" style="margin-left:40px"
|-
! Method Name !! Status !! Description
|-
| slot_available? || Implemented || Checks if there are available slots for the topic based on the maximum allowed choosers. Returns true if available.
|-
| assign_topic_to_team || Implemented || Assigns the topic to a team by updating the sign-up entry to set is_waitlisted as false and assign the topic_id.
|-
| save_waitlist_entry || Implemented || Saves a sign-up entry as a waitlist entry by setting is_waitlisted to true and assigning the topic_id.
|-
| sign_up_team || Implemented || Manages the sign-up process for a team, checking slot availability, assigning the topic, or placing the team on the waitlist as needed
|}

== E/R Diagram ==
[[File:oodd.png |500px|center]]
Edit Button Tooltip

== Test Plan ==

* Upgrade RSpec test cases for `signed_up_team.rb` to validate `delete_signed_up_team` and `get_team_participants` methods.
* Enhance and expand RSpec test cases for `project_topic.rb` to validate participant retrieval, slot availability, and assignment status handling.
* Develop RSpec test cases for `waitlist.rb` to validate adding teams to the waitlist, removing teams from the waitlist, and querying the waitlist status of a team.
* Add general RSpec test cases for error handling and ensure correct JSON serialization of data..
* Test Cases for signed_up_team.rb model
[[File:Signedup_team_rspec.png|900px]]
* Test Cases for waitlist.rb model
[[File:Waitlist_rspec.png|900px]]
* Test Cases for signup_topic.rb
[[File:Signup_topic_rspec.png|900px]]