CSC 517 S2016 E1611 Refactor team.rb, course team.rb, and assignment team.rb: Difference between revisions

From Expertiza_Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 17: Line 17:
The following tasks were accomplished in this project:
The following tasks were accomplished in this project:


* Improved the clarity of code by improving the variable and parameter names.
* Create a common method for importing and exporting teams in the team.rb file instead of having 2 separate functions in the assignment_team.rb and course_team.rb files using the [https://sourcemaking.com/design_patterns/prototype prototype pattern].
* Long character strings were taken and given appropriate names.
*Move the create_team_and_method to superclass (team.rb).
* Handled pagination by a separate helper module, which can be used by multiple controllers.
*Delete deprecated methods.
* Implemented action_allowed for access_control  to prevent unauthorized access of methods.
*Rewrite the method for checking if a team has submission.
* Prevented displaying of all versions for all users and tables when a user views the index page.
*Remove unnecessary white spaces and add comments before methods to describe what the method does.
* Added missing CRUD methods to Versions Controller
* Added RSPEC testcases for testing changes done in Versions Controller

Revision as of 01:07, 24 March 2016

E1611 Refactor team.rb, course_team.rb, and assignment_team.rb

This page provides the description of the Expertiza based OSS project on refactoring.


Introduction to Expertiza

Expertiza is an open source project developed on Ruby on Rails framework. It is primarily developed as a platform for instructors to create, assign and grade assignments and quizzes and for the students to view, submit assignments and take quizzes. Other activities involved in a course can also be done via Expertiza, like creating teams, reviewing assignments among others.


Problem Statement

The three classes in question- team, assignment team and course team, deal with teams of students that do assignments."team.rb" is the superclass; course_team is a team created for a course (if students are expected to stay in the same team all semester), and assignment_team is a team created for an assignment. Either the instructor can set up course or assignment teams (using the “Create teams” icon on the course or assignment Actions menu), or the students can, by issuing and accepting invitations. The code for 'importing', 'exporting', and 'copying' teams for assignment and course violates the DRY principle. There is a paucity of comments and there are deprecated methods and other methods that may not be used anymore, and could be deleted.

Tasks Identified

The following tasks were accomplished in this project:

  • Create a common method for importing and exporting teams in the team.rb file instead of having 2 separate functions in the assignment_team.rb and course_team.rb files using the prototype pattern.
  • Move the create_team_and_method to superclass (team.rb).
  • Delete deprecated methods.
  • Rewrite the method for checking if a team has submission.
  • Remove unnecessary white spaces and add comments before methods to describe what the method does.
Retrieved from "https://wiki.expertiza.ncsu.edu/index.php?title=CSC_517_S2016_E1611_Refactor_team.rb,_course_team.rb,_and_assignment_team.rb&oldid=101225"