CSC/ECE 517 Fall 2017/E1771 Refactor team.rb: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
Introduction | == Introduction == | ||
- | Expertiza is an open source webapp built on Ruby on Rails stack. It provides a platform to students with various features like peer-reviewing projects, submitting work, form teams, viewing grades etc. The project is being built and maintained by students and faculty at NCSU. | ||
== About team.rb == | |||
team.rb is the default class to interact with the team table. team.rb has 2 subclasses assignment_team.rb and course_team.rb. | |||
== Issue == | |||
team.rb is a fairly complex file. It contains a lot of methods that are long and hard to understand. | |||
These methods need to be broken down into simpler and more specific methods that are easier to read/understand. Also, the few instances of code duplication that exist should be removed | |||
== Tasks accomplished == | |||
· Refactor self.randomize_all_by_parent method | |||
· Split into several simpler methods and assign reasonable names | |||
· Extract duplicated code into separate methods | |||
· Rename method and change all other places it is used | |||
· has_user → user? | |||
· get_node_type → node_type | |||
· get_author_names → author_names | |||
· Pass &:destroy as an argument to each instead of a block | |||
· L22 | |||
· Use find_by instead of dynamic method | |||
· L63, L153, L162 | |||
· Use find_by instead of where.first | |||
· L166, L181 | |||
· Complete the pending tests in team_spec.rb, and write integration tests for newly-created methods. Refactor corresponding methods, and only then finish pending tests. |
Revision as of 03:46, 28 October 2017
Introduction
Expertiza is an open source webapp built on Ruby on Rails stack. It provides a platform to students with various features like peer-reviewing projects, submitting work, form teams, viewing grades etc. The project is being built and maintained by students and faculty at NCSU.
About team.rb
team.rb is the default class to interact with the team table. team.rb has 2 subclasses assignment_team.rb and course_team.rb.
Issue
team.rb is a fairly complex file. It contains a lot of methods that are long and hard to understand. These methods need to be broken down into simpler and more specific methods that are easier to read/understand. Also, the few instances of code duplication that exist should be removed
Tasks accomplished
· Refactor self.randomize_all_by_parent method · Split into several simpler methods and assign reasonable names · Extract duplicated code into separate methods · Rename method and change all other places it is used · has_user → user? · get_node_type → node_type · get_author_names → author_names · Pass &:destroy as an argument to each instead of a block · L22 · Use find_by instead of dynamic method · L63, L153, L162 · Use find_by instead of where.first · L166, L181 · Complete the pending tests in team_spec.rb, and write integration tests for newly-created methods. Refactor corresponding methods, and only then finish pending tests.