CSC/ECE 517 Spring 2023 - E2339. Reimplement signed up team.rb, sign up topic.rb, sign up sheet.rb (Project 4)

From Expertiza_Wiki
Jump to navigation Jump to search

Team Members

Project Description

The main goal of this project is to reimplement essential Ruby on Rails model classes—SignUpTeam, SignUpTopic, and SignUpSheet—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 SignUpTeam 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 SignUpTopic 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. Lastly, the SignUpSheet class serves as a module, storing the methods needed to create and manage instances of SignUpTeam for assignment 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_teams` to `signed_up_teams` 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.
  • Currently, there is no specific waitlist model to manage waitlisting, upgrading, or handling multiple registrations. This functionality needs to be considered and integrated effectively.
  • 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 `SignedUpTeam` class currently contains methods with multiple responsibilities, such as finding participants and teams, releasing topics, and removing signed-up teams. This violates the Single Responsibility Principle, making the class more challenging to understand and maintain. Separate these responsibilities for improved clarity.
  • Some methods use complex SQL queries with multiple joins, which can be challenging to read and understand. Simplify these SQL queries by leveraging ActiveRecord's query interface to enhance readability and maintainability.
  • The codebase has several instances of repeated code, such as finding signed-up teams for a given topic. This repetition violates the DRY principle, making the code harder to maintain and increasing the potential for errors. Consolidate these instances to streamline the code.

Design Strategy

  • To tackle the mentioned problem, three model class files namely sign_up_team.rb, sign_up_topic.rb and waitlist.rb are implemented.
  • sign_up_sheet.rb is removed because the class methods can be refactored into signup_topic.rb and waitlist.rb.
  • In signed_up_team.rb, the following functionality are being implemented:-
Method Name Status Description
destroy Implemented It is responsible for deleting the team from the table and delegating any changes in topic.
get_team_participants Implemented It is responsible to get participants in the team signed up for a given topic.
create_signed_up_team Implemented It is responsible for creating a SignedUpTeam instance with given topic_id and team_id if topic is available.
  • Add necessary schema migrations for backward compatibility.
  • In signup_topic.rb, the following functionality are being implemented:-
Method Name Status Description
destroy_topic Implemented It is used to destroy topic from the table.
update_topic Implemented It is used to modify the attributes like description, max_choosers or category in the table.
get_team_participants Implemented It is used to fetch participants of the team assigned to the topic.
count_filled_slots Implemented It is used to return the number of slots filled for the topic.
count_available_slots Implemented It is used to return the number of slots available for the topic.
release_team Implemented It is used to promote 1 team from the waitlist and assign the topic.
is_assigned_to_team Implemented It is used to validate if the topic is assigned to the team
get_assigned_teams Implemented It is used to retrieve all teams assigned to the topic.
is_available Implemented It is used to check if the given topic is available for selection by signed_up_teams
as_json Implemented It is responsible for serializing content of SignupTopic instance to JSON format.
  • In waitlist.rb, the following functionality are yet to be implemented in next phase:-
Method Name Status Description
count_waitlisted_teams Implemented It is used to return the number of waitlisted teams for the particular topic.
promote_teams_from_waitlist Implemented It is used to promote first N teams from the waitlist and assigns them to the topic.
  • Refactor instance methods to be more succinct (ex: find_if_topic_available to available, create_sign_up_team to sign_up_team, drop_sign_up_team to drop_team)
  • Rename model from “Sign Up Team” to “Signed Up Team” for better clarity.
  • Remove is_waitlisted attribute in favor of better querying from the Waitlist model.
  • Add tests for error conditions and exit handling.
  • Add tests to validate usage of @counter_cache used to count relations.
  • Create empty models (if non-existent) and add necessary model-association relations.
  • Integrate and delegate waitlist handling from sign_up_topic.
  • Add cascading deletes for relations to other models as appropriate.
  • Add JSON serializers for REST API responses.
  • Add tests using ‘shoulda-matchers’ for more exhaustive tests as appropriate.
  • Integrate ‘FactoryBot’ for automatic model record generation during testing.
  • Add ‘preference_priority_number’ for backward compatibility during migration.

E/R Diagram

Test Plan

  • Upgrade RSpec test cases for sign_up_team.rb to validate delete_team and get_participants.
  • Upgrade and add RSpec test cases for sign_up_topic.rb to find participants, handle slot availability and assignment status.
  • Create RSpec test cases for waitlist.rb to validate adding teams to waitlist, remove teams from waitlist and query status of team's waitlist.
  • Add general RSpec test cases for error handling and validate JSON serialization.
  • Test Cases for signed_up_team.rb model

  • Test Cases for waitlist.rb model

  • Test Cases for signup_topic.rb

Retrieved from "https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2023_-_E2339._Reimplement_signed_up_team.rb,_sign_up_topic.rb,_sign_up_sheet.rb_(Project_4)&oldid=158045"