CSC/ECE 517 Spring 2016/Refactor review mapping controller.rb: Difference between revisions
| Line 13: | Line 13: | ||
==='''Code Improvements'''=== | ==='''Code Improvements'''=== | ||
1. Unused variables and arguments | 1. Unused variables and arguments | ||
There are unused variables in the methods which use the stack unnecessarily. So, it is better to remove the unused variables or at the least indicate that a variable is unused. | |||
For suppose when both keys and values are not used in a hash but are given as arguments, then the unused variables can be indicated by adding a "_" infront of the name or replaced with "_" to represent it as unused variable but allow them arguments. | For suppose when both keys and values are not used in a hash but are given as arguments, then the unused variables can be indicated by adding a "_" infront of the name or replaced with "_" to represent it as unused variable but allow them arguments. | ||
| Line 27: | Line 29: | ||
2. Use sample instead of shuffle | 2. Use sample instead of shuffle | ||
When sample is used, the elements are chosen by using random and unique indices in the array so that the elements doesn't repeat in the array. This cannot be guaranteed in shuffle. | When sample is used, the elements are chosen by using random and unique indices in the array so that the elements doesn't repeat in the array. This cannot be guaranteed in shuffle. | ||
Revision as of 02:36, 24 March 2016
E1615. Refactoring the Review Mapping Controller
This page provides details about the OSS project which was based on refactoring one of controllers related to peer reviewing strategies used in Expertiza.
About Review mapping controller
Review mapping controller contains methods related to peer reviewing strategies. It contains methods to add a reviewer, delete a reviewer, selecting a reviewer. Depending on the number of students and number of submissions, the topics to be reviewed are assigned to the students automatically. If a user wants to look for the team for a submission , it returns the team by comparing the submission id's with the team id's. Also, it assigns quizzes dynamically. Generation of review report, feedback report and teammate review is done.
Code Improvements
1. Unused variables and arguments
There are unused variables in the methods which use the stack unnecessarily. So, it is better to remove the unused variables or at the least indicate that a variable is unused.
For suppose when both keys and values are not used in a hash but are given as arguments, then the unused variables can be indicated by adding a "_" infront of the name or replaced with "_" to represent it as unused variable but allow them arguments.
Previous Code: teams_hash = unsorted_teams_hash.sort_by{|k, v| v}.to_h
After Changing the code: teams_hash = unsorted_teams_hash.sort_by{|_, v| v}.to_h
In the above case teams_hash should consist of a hash with both keys and values but the sorting is done based on values. So the key is replaced with a "_" so that the user may deem it unused in the implementation of the process.
2. Use sample instead of shuffle
When sample is used, the elements are chosen by using random and unique indices in the array so that the elements doesn't repeat in the array. This cannot be guaranteed in shuffle.
Previous Code: assignment_team = assignment_teams.to_a.shuffle[0] rescue nil topic = assignment.candidate_topics_to_review(reviewer).to_a.shuffle[0] rescue nil
After Changing the code: assignment_team = assignment_teams.to_a.sample rescue nil topic = assignment.candidate_topics_to_review(reviewer).to_a.sample rescue nil