CSC/ECE 517 Fall 2014/OSS E1452 slj: Difference between revisions
| Line 21: | Line 21: | ||
=Introduction= | =Introduction= | ||
The AssignmentTeam and CourseTeam models, as sibling subclasses of the Team model, tended to share certain functionality. This assignment called for refactoring those classes to make them better conform to ruby convention and to support the DRY ("Don't Repeat Yourself") principle of avoiding duplicate code. | |||
A quick skim of the code turned up a few places where the AssignmentTeam and CourseTeam models had similar functionality, as well as multiple methods and variables that needed better names. | |||
=Project Design and Approach= | =Project Design and Approach= | ||
=UML Class Diagram= | =UML Class Diagram= | ||
Revision as of 01:56, 31 October 2014
E1452: Refactoring AssignmentTeam and CourseTeam models
The requirements provided for the Open Source System project of Expertiza were as follows:
Classes:
- AssignmentTeam.rb
- CourseTeam.rb
- Team.rb
What they do: The AssignmentTeam model checks whether a team has participants for an assignment, whether a topic has been picked by the team and reviews has be given for a particular team and adds, deletes and retrieves participants in a team. The CourseTeam model gives the paticipants in a course and allows to add and delete participants in a course. This is for the use by the instructor.
What is needed: Check if we need two methods participant and get_participant as they may be similar. If so, refactor to make one method. Rename create_team_and_node method as create method (follow Ruby style) Rename includes? method to has_participant? Remove duplicate code from these 2 sublcasses of Team. Assignment_Team class too long (235 lines)
Introduction
The AssignmentTeam and CourseTeam models, as sibling subclasses of the Team model, tended to share certain functionality. This assignment called for refactoring those classes to make them better conform to ruby convention and to support the DRY ("Don't Repeat Yourself") principle of avoiding duplicate code.
A quick skim of the code turned up a few places where the AssignmentTeam and CourseTeam models had similar functionality, as well as multiple methods and variables that needed better names.