Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-26T20:47:41Z

Hson: /* Problem 8: three small classes violates the Expert pattern */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-10395a909ed1f2034b4a4c8f57c0e30382d9492e0b16bb6fe6fb91a424f6f034 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-d158325bd4fd49ca872c3468ac2193f04d7c9fbe32a0497f7181bbc74c21ed8f here]

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names
*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here]

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 link]

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc</code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''Changes Made''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here]

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy</code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove expert pattern violation, a model is newly added: <code> review_strategy.rb</code> and it includes <code>student_review_strategy</code> and <code>team_review_strategy</code> classes.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.
*'''Changes Made''':[https://github.com/expertiza/expertiza/pull/2385/files#diff-1ffe08b34487becc1b3e011ae44988b88a2e7da38462753ebc16d6a828e42d6c here]

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-1f05f505eaa5edaf0790cdeb6e774cc499685cce4edf12b253ecd358ce710582 here]

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

1. Updated Rspec files according to refactoring project:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code>/rspec/review_mapping_chart_helper_spec.rb</code>

2. Rspec Tested files: All rspec tests are passed
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code>/rspec/review_mapping_controller.rb</code>
* <code>/rspec/review_mapping_chart_helper_spec.rb</code>

*''' Functionality Tests''':

Our refactoring didn't change functionality. Functionality tests were not needed and included.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T20:28:22Z

Hson: /* Test Plan */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 Link to pull request]

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 link]

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc</code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''Changes Made''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here]

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy</code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.
*'''Changes Made''':[https://github.com/expertiza/expertiza/pull/2385/files#diff-1ffe08b34487becc1b3e011ae44988b88a2e7da38462753ebc16d6a828e42d6c here]

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-1f05f505eaa5edaf0790cdeb6e774cc499685cce4edf12b253ecd358ce710582 here]

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

1. Updated Rspec files according to refactoring project:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code>/rspec/review_mapping_chart_helper_spec.rb</code>

2. Rspec Tested files: All rspec tests are passed
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code>/rspec/review_mapping_controller.rb</code>
* <code>/rspec/review_mapping_chart_helper_spec.rb</code>

*''' Functionality Tests''':

Our refactoring didn't change functionality. Functionality tests were not needed and included.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T20:28:00Z

Hson: /* Test Plan */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 Link to pull request]

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 link]

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc</code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''Changes Made''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here]

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy</code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.
*'''Changes Made''':[https://github.com/expertiza/expertiza/pull/2385/files#diff-1ffe08b34487becc1b3e011ae44988b88a2e7da38462753ebc16d6a828e42d6c here]

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-1f05f505eaa5edaf0790cdeb6e774cc499685cce4edf12b253ecd358ce710582 here]

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

1. Updated Rspec files according to refactoring project:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code>/rspec/review_mapping_chart_helper_spec.rb</code>

2. Rspec Tested files: All rspec pass
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code>/rspec/review_mapping_controller.rb</code>
* <code>/rspec/review_mapping_chart_helper_spec.rb</code>

*''' Functionality Tests''':

Our refactoring didn't change functionality. Functionality tests were not needed and included.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T20:27:30Z

Hson: /* Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 Link to pull request]

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 link]

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc</code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''Changes Made''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here]

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy</code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.
*'''Changes Made''':[https://github.com/expertiza/expertiza/pull/2385/files#diff-1ffe08b34487becc1b3e011ae44988b88a2e7da38462753ebc16d6a828e42d6c here]

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-1f05f505eaa5edaf0790cdeb6e774cc499685cce4edf12b253ecd358ce710582 here]

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

1. Updated Rspec files according to refactoring project:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code>/rspec/review_mapping_chart_helper_spec.rb</code>

2. Rspec Tested files:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code>/rspec/review_mapping_controller.rb</code>
* <code>/rspec/review_mapping_chart_helper_spec.rb</code>

*''' Functionality Tests''':

Our refactoring didn't change functionality. Functionality tests were not needed and included.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T20:27:15Z

Hson: /* Problem 8: three small classes violates the Expert pattern */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 Link to pull request]

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 link]

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''Changes Made''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here]

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy</code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.
*'''Changes Made''':[https://github.com/expertiza/expertiza/pull/2385/files#diff-1ffe08b34487becc1b3e011ae44988b88a2e7da38462753ebc16d6a828e42d6c here]

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-1f05f505eaa5edaf0790cdeb6e774cc499685cce4edf12b253ecd358ce710582 here]

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

1. Updated Rspec files according to refactoring project:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code>/rspec/review_mapping_chart_helper_spec.rb</code>

2. Rspec Tested files:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code>/rspec/review_mapping_controller.rb</code>
* <code>/rspec/review_mapping_chart_helper_spec.rb</code>

*''' Functionality Tests''':

Our refactoring didn't change functionality. Functionality tests were not needed and included.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T20:26:47Z

Hson: /* Test Plan */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 Link to pull request]

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 link]

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''Changes Made''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here]

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.
*'''Changes Made''':[https://github.com/expertiza/expertiza/pull/2385/files#diff-1ffe08b34487becc1b3e011ae44988b88a2e7da38462753ebc16d6a828e42d6c here]

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-1f05f505eaa5edaf0790cdeb6e774cc499685cce4edf12b253ecd358ce710582 here]

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

1. Updated Rspec files according to refactoring project:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code>/rspec/review_mapping_chart_helper_spec.rb</code>

2. Rspec Tested files:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code>/rspec/review_mapping_controller.rb</code>
* <code>/rspec/review_mapping_chart_helper_spec.rb</code>

*''' Functionality Tests''':

Our refactoring didn't change functionality. Functionality tests were not needed and included.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T20:26:06Z

Hson: /* Test Plan */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 Link to pull request]

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 link]

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''Changes Made''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here]

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.
*'''Changes Made''':[https://github.com/expertiza/expertiza/pull/2385/files#diff-1ffe08b34487becc1b3e011ae44988b88a2e7da38462753ebc16d6a828e42d6c here]

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-1f05f505eaa5edaf0790cdeb6e774cc499685cce4edf12b253ecd358ce710582 here]

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

1. Updated Rspec files according to refactoring project:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code>/rspec/review_mapping_chart_helper_spec.rb</code>

2. Rspec Tested files:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code>/rspec/review_mapping_controller.rb</code>
* <code>/rspec/review_mapping_chart_helper_spec.rb</code>

*''' Functionality Tests''':

Our refactoring method didn't change functionality.
No functionality test was needed.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T20:25:47Z

Hson: /* Test Plan */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 Link to pull request]

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 link]

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''Changes Made''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here]

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.
*'''Changes Made''':[https://github.com/expertiza/expertiza/pull/2385/files#diff-1ffe08b34487becc1b3e011ae44988b88a2e7da38462753ebc16d6a828e42d6c here]

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-1f05f505eaa5edaf0790cdeb6e774cc499685cce4edf12b253ecd358ce710582 here]

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

1. Updated Rspec files according to refactoring project:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code/rspec/review_mapping_chart_helper_spec.rb</code>

2. Rspec Tested files:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code>/rspec/review_mapping_controller.rb</code>
* <code>/rspec/review_mapping_chart_helper_spec.rb</code>

*''' Functionality Tests''':

Our refactoring method didn't change functionality.
No functionality test was needed.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T20:25:29Z

Hson: /* Test Plan */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 Link to pull request]

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 link]

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''Changes Made''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here]

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.
*'''Changes Made''':[https://github.com/expertiza/expertiza/pull/2385/files#diff-1ffe08b34487becc1b3e011ae44988b88a2e7da38462753ebc16d6a828e42d6c here]

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-1f05f505eaa5edaf0790cdeb6e774cc499685cce4edf12b253ecd358ce710582 here]

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

1. Updated Rspec files according to refactoring project:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

2. Rspec Tested files:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code>/rspec/review_mapping_controller.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

*''' Functionality Tests''':

Our refactoring method didn't change functionality.
No functionality test was needed.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T20:24:02Z

Hson: /* Test Plan */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 Link to pull request]

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 link]

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''Changes Made''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here]

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.
*'''Changes Made''':[https://github.com/expertiza/expertiza/pull/2385/files#diff-1ffe08b34487becc1b3e011ae44988b88a2e7da38462753ebc16d6a828e42d6c here]

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-1f05f505eaa5edaf0790cdeb6e774cc499685cce4edf12b253ecd358ce710582 here]

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Updated Rspec files according to refactoring project:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

Rspec Tested files:
* <code>/rspec/review_mapping_helper_spec.rb</code>
- remove feedback_report_record method
- updated with the new method names
* <code>/rspec/review_mapping_controller.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

*''' Functionality Tests''':

Our refactoring method didn't change functionality.
No functionality test was needed.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T20:22:35Z

Hson: /* Test Plan */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 Link to pull request]

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 link]

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''Changes Made''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here]

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.
*'''Changes Made''':[https://github.com/expertiza/expertiza/pull/2385/files#diff-1ffe08b34487becc1b3e011ae44988b88a2e7da38462753ebc16d6a828e42d6c here]

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-1f05f505eaa5edaf0790cdeb6e774cc499685cce4edf12b253ecd358ce710582 here]

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Updated Rspec files according to refactoring project:
*- <code>/rspec/review_mapping_helper_spec.rb</code>
*- <code> /rspec/review_mapping_chart_helper_spec.rb</code>

Rspec Tested files:
* <code>/rspec/review_mapping_helper_spec.rb</code>
- remove feedback_report_record method
- updated with the new method names
* <code>/rspec/review_mapping_controller.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

*''' Functionality Tests''':

Our refactoring method didn't change functionality.
No functionality test was needed.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T20:22:21Z

Hson: /* GitHub links and Pull Request */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 Link to pull request]

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 link]

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''Changes Made''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here]

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.
*'''Changes Made''':[https://github.com/expertiza/expertiza/pull/2385/files#diff-1ffe08b34487becc1b3e011ae44988b88a2e7da38462753ebc16d6a828e42d6c here]

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-1f05f505eaa5edaf0790cdeb6e774cc499685cce4edf12b253ecd358ce710582 here]

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Updated Rspec files according to refactoring project:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

Rspec Tested files:
* <code>/rspec/review_mapping_helper_spec.rb</code>
- remove feedback_report_record method
- updated with the new method names
* <code>/rspec/review_mapping_controller.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

*''' Functionality Tests''':

Our refactoring method didn't change functionality.
No functionality test was needed.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T20:21:38Z

Hson: /* Problem 7: The method feedback_response_maps violates the Expert pattern */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 Link to pull request]

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 link]

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''Changes Made''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here]

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.
*'''Changes Made''':[https://github.com/expertiza/expertiza/pull/2385/files#diff-1ffe08b34487becc1b3e011ae44988b88a2e7da38462753ebc16d6a828e42d6c here]

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-1f05f505eaa5edaf0790cdeb6e774cc499685cce4edf12b253ecd358ce710582 here]

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Updated Rspec files according to refactoring project:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

Rspec Tested files:
* <code>/rspec/review_mapping_helper_spec.rb</code>
- remove feedback_report_record method
- updated with the new method names
* <code>/rspec/review_mapping_controller.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

*''' Functionality Tests''':

Our refactoring method didn't change functionality.
No functionality test was needed.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files#]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T20:21:27Z

Hson: /* Problem 8: three small classes violates the Expert pattern */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 Link to pull request]

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 link]

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''Changes Made''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 Here]

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.
*'''Changes Made''':[https://github.com/expertiza/expertiza/pull/2385/files#diff-1ffe08b34487becc1b3e011ae44988b88a2e7da38462753ebc16d6a828e42d6c here]

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-1f05f505eaa5edaf0790cdeb6e774cc499685cce4edf12b253ecd358ce710582 here]

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Updated Rspec files according to refactoring project:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

Rspec Tested files:
* <code>/rspec/review_mapping_helper_spec.rb</code>
- remove feedback_report_record method
- updated with the new method names
* <code>/rspec/review_mapping_controller.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

*''' Functionality Tests''':

Our refactoring method didn't change functionality.
No functionality test was needed.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files#]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T20:20:53Z

Hson: /* Problem 7: The method feedback_response_maps violates the Expert pattern */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 Link to pull request]

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 link]

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''Changes Made''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 Here]

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.
*'''Changes Made''':[https://github.com/expertiza/expertiza/pull/2385/files#diff-1ffe08b34487becc1b3e011ae44988b88a2e7da38462753ebc16d6a828e42d6c]

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-1f05f505eaa5edaf0790cdeb6e774cc499685cce4edf12b253ecd358ce710582 here]

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Updated Rspec files according to refactoring project:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

Rspec Tested files:
* <code>/rspec/review_mapping_helper_spec.rb</code>
- remove feedback_report_record method
- updated with the new method names
* <code>/rspec/review_mapping_controller.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

*''' Functionality Tests''':

Our refactoring method didn't change functionality.
No functionality test was needed.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files#]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T20:20:13Z

Hson: /* Problem 7: The method feedback_response_maps violates the Expert pattern */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 Link to pull request]

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 link]

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''Changes made''': here[https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568]

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.
*'''Changes Made''':[https://github.com/expertiza/expertiza/pull/2385/files#diff-1ffe08b34487becc1b3e011ae44988b88a2e7da38462753ebc16d6a828e42d6c]

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-1f05f505eaa5edaf0790cdeb6e774cc499685cce4edf12b253ecd358ce710582 here]

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Updated Rspec files according to refactoring project:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

Rspec Tested files:
* <code>/rspec/review_mapping_helper_spec.rb</code>
- remove feedback_report_record method
- updated with the new method names
* <code>/rspec/review_mapping_controller.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

*''' Functionality Tests''':

Our refactoring method didn't change functionality.
No functionality test was needed.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files#]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T20:18:47Z

Hson: /* Test Plan */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 Link to pull request]

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 link]

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''One thing found''': For the multiple round assignment, "Author feedback report" doesn't create appropriate table. It may require refactor <code>views/reports/feedback_report</code>.

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.
*'''Changes Made''':[https://github.com/expertiza/expertiza/pull/2385/files#diff-1ffe08b34487becc1b3e011ae44988b88a2e7da38462753ebc16d6a828e42d6c]

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-1f05f505eaa5edaf0790cdeb6e774cc499685cce4edf12b253ecd358ce710582 here]

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Updated Rspec files according to refactoring project:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

Rspec Tested files:
* <code>/rspec/review_mapping_helper_spec.rb</code>
- remove feedback_report_record method
- updated with the new method names
* <code>/rspec/review_mapping_controller.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

*''' Functionality Tests''':

Our refactoring method didn't change functionality.
No functionality test was needed.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files#]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T20:18:29Z

Hson: /* Test Plan */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 Link to pull request]

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 link]

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''One thing found''': For the multiple round assignment, "Author feedback report" doesn't create appropriate table. It may require refactor <code>views/reports/feedback_report</code>.

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.
*'''Changes Made''':[https://github.com/expertiza/expertiza/pull/2385/files#diff-1ffe08b34487becc1b3e011ae44988b88a2e7da38462753ebc16d6a828e42d6c]

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-1f05f505eaa5edaf0790cdeb6e774cc499685cce4edf12b253ecd358ce710582 here]

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Updated Rspec files according to refactoring project:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

Rspec Tested files:
* <code>/rspec/review_mapping_helper_spec.rb</code>
- remove feedback_report_record method
- updated with the new method names
* <code>/rspec/review_mapping_controller.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

*''' Functionality Tests''':

Our refactoring method didn't include functionality change.
No functionality test was needed.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files#]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T20:16:31Z

Hson: /* Test Plan */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 Link to pull request]

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 link]

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''One thing found''': For the multiple round assignment, "Author feedback report" doesn't create appropriate table. It may require refactor <code>views/reports/feedback_report</code>.

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.
*'''Changes Made''':[https://github.com/expertiza/expertiza/pull/2385/files#diff-1ffe08b34487becc1b3e011ae44988b88a2e7da38462753ebc16d6a828e42d6c]

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-1f05f505eaa5edaf0790cdeb6e774cc499685cce4edf12b253ecd358ce710582 here]

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Updated Rspec files according to refactoring project:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

Rspec Tested files:
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code>/rspec/review_mapping_controller.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

1. Case#1: Methods not included in Rspec => review the method to refactor & include it in the Rspec file.

- <code>get_data_for_review_report</code>
- <code>initialize_chart_elements</code>
- <code>display_volume_metric_chart</code>
- <code>display_tagging_interval_chart</code>
- <code>list_hyperlink_submission</code>
- <code>get_each_review_and_feedback_response_map</code>
- <code>get_certain_review_and_feedback_response_map</code>
- <code>Class ReviewStrategy </code>
- <code>Class StudentReviewStrategy</code>
- <code>Class TeamReviewStrategy</code>

2. Case #2: Refactoring may cause to break existing Rspec. => refactor Rspec as well

3. Case #3: Adding a new method => Add new Rspec scenario

4. Case #4: Removing methods => Remove from Rspec

*''' Functionality Tests''':

Functionality test will be added when our refactor causes to change in the logic. Our focus on this project is refactoring <code>review_mapping_helper.rb</code> to be more readable and understandable.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files#]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T02:32:53Z

Hson: /* Problem 8: three small classes violates the Expert pattern */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names
*''' Changes Made ''': [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 Link to pull request]

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''One thing found''': For the multiple round assignment, "Author feedback report" doesn't create appropriate table. It may require refactor <code>views/reports/feedback_report</code>.

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.
*'''Changes Made''':[https://github.com/expertiza/expertiza/pull/2385/files#diff-1ffe08b34487becc1b3e011ae44988b88a2e7da38462753ebc16d6a828e42d6c]

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

following Rspec files have updated according to refactoring
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

1. Case#1: Methods not included in Rspec => review the method to refactor & include it in the Rspec file.

- <code>get_data_for_review_report</code>
- <code>initialize_chart_elements</code>
- <code>display_volume_metric_chart</code>
- <code>display_tagging_interval_chart</code>
- <code>list_hyperlink_submission</code>
- <code>get_each_review_and_feedback_response_map</code>
- <code>get_certain_review_and_feedback_response_map</code>
- <code>Class ReviewStrategy </code>
- <code>Class StudentReviewStrategy</code>
- <code>Class TeamReviewStrategy</code>

2. Case #2: Refactoring may cause to break existing Rspec. => refactor Rspec as well

3. Case #3: Adding a new method => Add new Rspec scenario

4. Case #4: Removing methods => Remove from Rspec

*''' Functionality Tests''':

Functionality test will be added when our refactor causes to change in the logic. Our focus on this project is refactoring <code>review_mapping_helper.rb</code> to be more readable and understandable.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files#]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T02:31:35Z

Hson: /* Test Plan */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''One thing found''': For the multiple round assignment, "Author feedback report" doesn't create appropriate table. It may require refactor <code>views/reports/feedback_report</code>.

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

following Rspec files have updated according to refactoring
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code>

1. Case#1: Methods not included in Rspec => review the method to refactor & include it in the Rspec file.

- <code>get_data_for_review_report</code>
- <code>initialize_chart_elements</code>
- <code>display_volume_metric_chart</code>
- <code>display_tagging_interval_chart</code>
- <code>list_hyperlink_submission</code>
- <code>get_each_review_and_feedback_response_map</code>
- <code>get_certain_review_and_feedback_response_map</code>
- <code>Class ReviewStrategy </code>
- <code>Class StudentReviewStrategy</code>
- <code>Class TeamReviewStrategy</code>

2. Case #2: Refactoring may cause to break existing Rspec. => refactor Rspec as well

3. Case #3: Adding a new method => Add new Rspec scenario

4. Case #4: Removing methods => Remove from Rspec

*''' Functionality Tests''':

Functionality test will be added when our refactor causes to change in the logic. Our focus on this project is refactoring <code>review_mapping_helper.rb</code> to be more readable and understandable.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files#]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T02:30:59Z

Hson: /* Test Plan */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Changes: [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here], [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''One thing found''': For the multiple round assignment, "Author feedback report" doesn't create appropriate table. It may require refactor <code>views/reports/feedback_report</code>.

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Rspec file
* <code>/rspec/review_mapping_helper_spec.rb</code>
* <code> /rspec/review_mapping_chart_helper_spec.rb</code> has updated.

1. Case#1: Methods not included in Rspec => review the method to refactor & include it in the Rspec file.

- <code>get_data_for_review_report</code>
- <code>initialize_chart_elements</code>
- <code>display_volume_metric_chart</code>
- <code>display_tagging_interval_chart</code>
- <code>list_hyperlink_submission</code>
- <code>get_each_review_and_feedback_response_map</code>
- <code>get_certain_review_and_feedback_response_map</code>
- <code>Class ReviewStrategy </code>
- <code>Class StudentReviewStrategy</code>
- <code>Class TeamReviewStrategy</code>

2. Case #2: Refactoring may cause to break existing Rspec. => refactor Rspec as well

3. Case #3: Adding a new method => Add new Rspec scenario

4. Case #4: Removing methods => Remove from Rspec

*''' Functionality Tests''':

Functionality test will be added when our refactor causes to change in the logic. Our focus on this project is refactoring <code>review_mapping_helper.rb</code> to be more readable and understandable.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files#]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T02:29:20Z

Hson: /* GitHub links and Pull Request */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Change 1 - [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here]
File Change 2 - [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here]
File Change 3 - [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''One thing found''': For the multiple round assignment, "Author feedback report" doesn't create appropriate table. It may require refactor <code>views/reports/feedback_report</code>.

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Rspec file
<code>/rspec/review_mapping_helper_spec.rb</code>
<code> /rspec/review_mapping_chart_helper_spec.rb</code> has updated.

1. Case#1: Methods not included in Rspec => review the method to refactor & include it in the Rspec file.

- <code>get_data_for_review_report</code>
- <code>initialize_chart_elements</code>
- <code>display_volume_metric_chart</code>
- <code>display_tagging_interval_chart</code>
- <code>list_hyperlink_submission</code>
- <code>get_each_review_and_feedback_response_map</code>
- <code>get_certain_review_and_feedback_response_map</code>
- <code>Class ReviewStrategy </code>
- <code>Class StudentReviewStrategy</code>
- <code>Class TeamReviewStrategy</code>

2. Case #2: Refactoring may cause to break existing Rspec. => refactor Rspec as well

3. Case #3: Adding a new method => Add new Rspec scenario

4. Case #4: Removing methods => Remove from Rspec

*''' Functionality Tests''':

Functionality test will be added when our refactor causes to change in the logic. Our focus on this project is refactoring <code>review_mapping_helper.rb</code> to be more readable and understandable.

==GitHub links and Pull Request==

* GitHub link [https://github.com/andypip88/expertiza here]
* GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files#]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T02:28:55Z

Hson: /* GitHub links and Pull Request */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Change 1 - [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here]
File Change 2 - [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here]
File Change 3 - [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''One thing found''': For the multiple round assignment, "Author feedback report" doesn't create appropriate table. It may require refactor <code>views/reports/feedback_report</code>.

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Rspec file
<code>/rspec/review_mapping_helper_spec.rb</code>
<code> /rspec/review_mapping_chart_helper_spec.rb</code> has updated.

1. Case#1: Methods not included in Rspec => review the method to refactor & include it in the Rspec file.

- <code>get_data_for_review_report</code>
- <code>initialize_chart_elements</code>
- <code>display_volume_metric_chart</code>
- <code>display_tagging_interval_chart</code>
- <code>list_hyperlink_submission</code>
- <code>get_each_review_and_feedback_response_map</code>
- <code>get_certain_review_and_feedback_response_map</code>
- <code>Class ReviewStrategy </code>
- <code>Class StudentReviewStrategy</code>
- <code>Class TeamReviewStrategy</code>

2. Case #2: Refactoring may cause to break existing Rspec. => refactor Rspec as well

3. Case #3: Adding a new method => Add new Rspec scenario

4. Case #4: Removing methods => Remove from Rspec

*''' Functionality Tests''':

Functionality test will be added when our refactor causes to change in the logic. Our focus on this project is refactoring <code>review_mapping_helper.rb</code> to be more readable and understandable.

==GitHub links and Pull Request==

- GitHub link [https://github.com/andypip88/expertiza here]
- GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files#]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T02:28:37Z

Hson: /* GitHub links and Pull Request */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

*''' Changes Made ''': File Change 1 - [https://github.com/expertiza/expertiza/pull/2385/files#diff-c41058c9caa3baa134bad689e28b7903d372d6a64388daccbb2e0ced964da568 here]
File Change 2 - [https://github.com/expertiza/expertiza/pull/2385/files#diff-dd3da33cc930dd8c0ea397047960fedc8ad0ddd531fa579844c9725d23bdd003 here]
File Change 3 - [https://github.com/expertiza/expertiza/pull/2385/files#diff-6ed94fc2c563ffb24d16737ab83e290c7f9348e82209013580a0e822848947af here]

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''One thing found''': For the multiple round assignment, "Author feedback report" doesn't create appropriate table. It may require refactor <code>views/reports/feedback_report</code>.

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Rspec file
<code>/rspec/review_mapping_helper_spec.rb</code>
<code> /rspec/review_mapping_chart_helper_spec.rb</code> has updated.

1. Case#1: Methods not included in Rspec => review the method to refactor & include it in the Rspec file.

- <code>get_data_for_review_report</code>
- <code>initialize_chart_elements</code>
- <code>display_volume_metric_chart</code>
- <code>display_tagging_interval_chart</code>
- <code>list_hyperlink_submission</code>
- <code>get_each_review_and_feedback_response_map</code>
- <code>get_certain_review_and_feedback_response_map</code>
- <code>Class ReviewStrategy </code>
- <code>Class StudentReviewStrategy</code>
- <code>Class TeamReviewStrategy</code>

2. Case #2: Refactoring may cause to break existing Rspec. => refactor Rspec as well

3. Case #3: Adding a new method => Add new Rspec scenario

4. Case #4: Removing methods => Remove from Rspec

*''' Functionality Tests''':

Functionality test will be added when our refactor causes to change in the logic. Our focus on this project is refactoring <code>review_mapping_helper.rb</code> to be more readable and understandable.

==GitHub links and Pull Request==

GitHub link [https://github.com/andypip88/expertiza here]
GitHub Pull Request [https://github.com/expertiza/expertiza/pull/2385/files#]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T02:23:52Z

Hson: /* Test Plan */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''One thing found''': For the multiple round assignment, "Author feedback report" doesn't create appropriate table. It may require refactor <code>views/reports/feedback_report</code>.

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Rspec file
<code>/rspec/review_mapping_helper_spec.rb</code>
<code> /rspec/review_mapping_chart_helper_spec.rb</code> has updated.

1. Case#1: Methods not included in Rspec => review the method to refactor & include it in the Rspec file.

- <code>get_data_for_review_report</code>
- <code>initialize_chart_elements</code>
- <code>display_volume_metric_chart</code>
- <code>display_tagging_interval_chart</code>
- <code>list_hyperlink_submission</code>
- <code>get_each_review_and_feedback_response_map</code>
- <code>get_certain_review_and_feedback_response_map</code>
- <code>Class ReviewStrategy </code>
- <code>Class StudentReviewStrategy</code>
- <code>Class TeamReviewStrategy</code>

2. Case #2: Refactoring may cause to break existing Rspec. => refactor Rspec as well

3. Case #3: Adding a new method => Add new Rspec scenario

4. Case #4: Removing methods => Remove from Rspec

*''' Functionality Tests''':

Functionality test will be added when our refactor causes to change in the logic. Our focus on this project is refactoring <code>review_mapping_helper.rb</code> to be more readable and understandable.

==GitHub links and Pull Request==

GitHub link [https://github.com/andypip88/expertiza here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T02:17:40Z

Hson: /* Test Plan */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''One thing found''': For the multiple round assignment, "Author feedback report" doesn't create appropriate table. It may require refactor <code>views/reports/feedback_report</code>.

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Rspec file <code> /rspec/review_mapping_helper_spec.rb</code>
<code> /rspec/review_mapping_chart_helper_spec.rb</code> has updated.

1. Case#1: Methods not included in Rspec => review the method to refactor & include it in the Rspec file.

- <code>get_data_for_review_report</code>
- <code>initialize_chart_elements</code>
- <code>display_volume_metric_chart</code>
- <code>display_tagging_interval_chart</code>
- <code>list_hyperlink_submission</code>
- <code>get_each_review_and_feedback_response_map</code>
- <code>get_certain_review_and_feedback_response_map</code>
- <code>Class ReviewStrategy </code>
- <code>Class StudentReviewStrategy</code>
- <code>Class TeamReviewStrategy</code>

2. Case #2: Refactoring may cause to break existing Rspec. => refactor Rspec as well

3. Case #3: Adding a new method => Add new Rspec scenario

4. Case #4: Removing methods => Remove from Rspec

*''' Functionality Tests''':

Functionality test will be added when our refactor causes to change in the logic. Our focus on this project is refactoring <code>review_mapping_helper.rb</code> to be more readable and understandable.

==GitHub links and Pull Request==

GitHub link [https://github.com/andypip88/expertiza here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-25T00:32:40Z

Hson: /* Problem 7: The method feedback_response_maps violates the Expert pattern */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

*''' Solution Implemented ''': The columns of the view that were displaying the score and average score were already using partials. This logic was adopted to change the "Team Reviewed" section to use a partial as well. This included moving the code from this section of <code>_review_report.html.erb</code> into a new file in order to render the partial: <code>_team_reviewed.html.erb</code>. This new file was commented to note what it is doing, and the calling code was modified to pass necessary local variables. The code was also cleaned up to look nicer and align with how other calls in the same block of code were being done.

<td align = 'left'>
<% @response_maps.each_with_index do |reviewer_map, index| %>
<% if Team.where(id: reviewer_map.reviewee_id).length > 0 %>
<% @team = Team.find(reviewer_map.reviewee_id) %>
<%= render partial: 'team_reviewed', locals: {bgcolor: @bgcolor, team_id: @team.id, reviewer_id: reviewer.id, reviewer_map: reviewer_map, index: index, reviewer: reviewer} %>
<% end %>
<% end %>
</td>

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>, and rename it to <code>awarded_review_score?</code>
*''' Solution Implemented ''': After investigation, it was found that <code>get_awarded_review_score</code> does not actually perform any score computation, and shares very similar functionality with <code>review_metrics</code>. Both methods set instance variables that are retrieved by <code>team_score_score_awarded.html.erb</code> and <code>team_score.html.erb</code> respectively. The <code>scoring.rb</code> model and the models that include it were investigated to find code that could possibly substitute for <code>get_awarded_review_score</code>, but it was found that no comparable method exists. Ultimately, it was decided to keep <code>get_awarded_review_score</code> as-is, but rename it to <code>awarded_review_metrics?</code>, both to standardize its naming with <code>review_metrics</code> and to better reflect the fact this method is not involved in score calculation.

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific. This method should not be counting the number of review rounds, as that is calculated elsewhere in the system.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view (<code>_review_report.html.erb</code>). Need clarification if this function is being used or not.

*''' Proposed Solution ''': Investigate the validity of the method. If useless, remove it; else, document it and refactor if necessary.

*''' Solution Implemented ''': Investigation yields the purpose of this method - it adds a link to the associated files that a reviewer uploaded in association with a review (as seen in below image). As such, this is a useful function, so it remains in place. Comments were added to the method header to explain what it is doing. Additionally, the file name was changed to <code>list_review_uploaded_files</code> to better reflect its functionality.

[[File:E2239Problem6.png]]

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update. The function.

*'''One thing found''': For the multiple round assignment, "Author feedback report" doesn't create appropriate table. It may require refactor <code>views/reports/feedback_report</code>.

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*<code>team_reviewed.html.erb</code> has been added to render partials used by <code>_review_report.html.erb</code>
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Rspec file <code> /rspec/review_mapping_helper_spec.rb</code> will be updated depending on the following cases.

1. Case#1: Methods not included in Rspec => review the method to refactor & include it in the Rspec file.

- <code>get_data_for_review_report</code>
- <code>initialize_chart_elements</code>
- <code>display_volume_metric_chart</code>
- <code>display_tagging_interval_chart</code>
- <code>list_hyperlink_submission</code>
- <code>get_each_review_and_feedback_response_map</code>
- <code>get_certain_review_and_feedback_response_map</code>
- <code>Class ReviewStrategy </code>
- <code>Class StudentReviewStrategy</code>
- <code>Class TeamReviewStrategy</code>

2. Case #2: Refactoring may cause to break existing Rspec. => refactor Rspec as well

3. Case #3: Adding a new method => Add new Rspec scenario

4. Case #4: Removing methods => Remove from Rspec

*''' Functionality Tests''':

Functionality test will be added when our refactor causes to change in the logic. Our focus on this project is refactoring <code>review_mapping_helper.rb</code> to be more readable and understandable.

==GitHub links and Pull Request==

GitHub link [https://github.com/andypip88/expertiza here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-24T01:16:45Z

Hson: /* Problem 7: The method feedback_response_maps violates the Expert pattern */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed
*''' Solution Implemented ''': All method names beginning with <code>get</code> have been refactored to end with <code>?</code> to follow standard naming conventions. e.g. <code>get_team_color</code> to <code>team_color?</code>. Respective calls to these methods in various views and tests have also been refactored to use the updated names

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view. Needs clarification if this function is being used or not.

*''' Proposed Solution ''': See if there is a way to get rid of it or incorporate it into the main method.

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update.

*'''One thing found''': For the multiple round assignment, "Author feedback report" doesn't create appropriate table. It may require refactor <code>views/reports/feedback_report</code>.

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Rspec file <code> /rspec/review_mapping_helper_spec.rb</code> will be updated depending on the following cases.

1. Case#1: Methods not included in Rspec => review the method to refactor & include it in the Rspec file.

- <code>get_data_for_review_report</code>
- <code>initialize_chart_elements</code>
- <code>display_volume_metric_chart</code>
- <code>display_tagging_interval_chart</code>
- <code>list_hyperlink_submission</code>
- <code>get_each_review_and_feedback_response_map</code>
- <code>get_certain_review_and_feedback_response_map</code>
- <code>Class ReviewStrategy </code>
- <code>Class StudentReviewStrategy</code>
- <code>Class TeamReviewStrategy</code>

2. Case #2: Refactoring may cause to break existing Rspec. => refactor Rspec as well

3. Case #3: Adding a new method => Add new Rspec scenario

4. Case #4: Removing methods => Remove from Rspec

*''' Functionality Tests''':

Functionality test will be added when our refactor causes to change in the logic. Our focus on this project is refactoring <code>review_mapping_helper.rb</code> to be more readable and understandable.

==GitHub links and Pull Request==

GitHub link [https://github.com/andypip88/expertiza here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-23T19:24:00Z

Hson: /* Problem 7: The method feedback_response_maps violates the Expert pattern */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view. Needs clarification if this function is being used or not.

*''' Proposed Solution ''': See if there is a way to get rid of it or incorporate it into the main method.

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing
'''FeedbackResponseMap''' found in two places in <code>review_mapping_helper.rb</code> => will add comments to make this code understandable.

def get_certain_review_and_feedback_response_map(author)
@feedback_response_maps = '''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?', @all_review_response_ids, author.id])
end

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update.

*'''One thing found''': For the multiple round assignment, "Author feedback report" doesn't create appropriate table. It may require refactor <code>views/reports/feedback_report</code>.

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Rspec file <code> /rspec/review_mapping_helper_spec.rb</code> will be updated depending on the following cases.

1. Case#1: Methods not included in Rspec => review the method to refactor & include it in the Rspec file.

- <code>get_data_for_review_report</code>
- <code>initialize_chart_elements</code>
- <code>display_volume_metric_chart</code>
- <code>display_tagging_interval_chart</code>
- <code>list_hyperlink_submission</code>
- <code>get_each_review_and_feedback_response_map</code>
- <code>get_certain_review_and_feedback_response_map</code>
- <code>Class ReviewStrategy </code>
- <code>Class StudentReviewStrategy</code>
- <code>Class TeamReviewStrategy</code>

2. Case #2: Refactoring may cause to break existing Rspec. => refactor Rspec as well

3. Case #3: Adding a new method => Add new Rspec scenario

4. Case #4: Removing methods => Remove from Rspec

*''' Functionality Tests''':

Functionality test will be added when our refactor causes to change in the logic. Our focus on this project is refactoring <code>review_mapping_helper.rb</code> to be more readable and understandable.

==GitHub links and Pull Request==

GitHub link [https://github.com/andypip88/expertiza here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-23T19:19:04Z

Hson: /* Problem 7: The method feedback_response_maps violates the Expert pattern */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view. Needs clarification if this function is being used or not.

*''' Proposed Solution ''': See if there is a way to get rid of it or incorporate it into the main method.

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps</code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing
'''FeedbackResponseMap''' found in two places in <code>review_mapping_helper.rb</code> => will add comments to make this code understandable.

def get_certain_review_and_feedback_response_map(author)
@feedback_response_maps = '''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?', @all_review_response_ids, author.id])
end

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and the instance variable for each round is already assigned in <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update.

*'''One thing found''': For the multiple round assignment, "Author feedback report" doesn't create appropriate table. It may require refactor <code>views/reports/feedback_report</code>.

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Rspec file <code> /rspec/review_mapping_helper_spec.rb</code> will be updated depending on the following cases.

1. Case#1: Methods not included in Rspec => review the method to refactor & include it in the Rspec file.

- <code>get_data_for_review_report</code>
- <code>initialize_chart_elements</code>
- <code>display_volume_metric_chart</code>
- <code>display_tagging_interval_chart</code>
- <code>list_hyperlink_submission</code>
- <code>get_each_review_and_feedback_response_map</code>
- <code>get_certain_review_and_feedback_response_map</code>
- <code>Class ReviewStrategy </code>
- <code>Class StudentReviewStrategy</code>
- <code>Class TeamReviewStrategy</code>

2. Case #2: Refactoring may cause to break existing Rspec. => refactor Rspec as well

3. Case #3: Adding a new method => Add new Rspec scenario

4. Case #4: Removing methods => Remove from Rspec

*''' Functionality Tests''':

Functionality test will be added when our refactor causes to change in the logic. Our focus on this project is refactoring <code>review_mapping_helper.rb</code> to be more readable and understandable.

==GitHub links and Pull Request==

GitHub link [https://github.com/andypip88/expertiza here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-23T19:17:13Z

Hson: /* Problem 7: The method feedback_response_maps violates the Expert pattern */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view. Needs clarification if this function is being used or not.

*''' Proposed Solution ''': See if there is a way to get rid of it or incorporate it into the main method.

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps </code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing
'''FeedbackResponseMap''' found in two places in <code>review_mapping_helper.rb</code> => will add comments to make this code understandable.

def get_certain_review_and_feedback_response_map(author)
@feedback_response_maps = '''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?', @all_review_response_ids, author.id])
end

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and the instance variable for each round is already assigned in <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update.

*'''One thing found''': For the multiple round assignment, "Author feedback report" doesn't create appropriate table. It may require refactor <code>views/reports/feedback_report</code>.

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Rspec file <code> /rspec/review_mapping_helper_spec.rb</code> will be updated depending on the following cases.

1. Case#1: Methods not included in Rspec => review the method to refactor & include it in the Rspec file.

- <code>get_data_for_review_report</code>
- <code>initialize_chart_elements</code>
- <code>display_volume_metric_chart</code>
- <code>display_tagging_interval_chart</code>
- <code>list_hyperlink_submission</code>
- <code>get_each_review_and_feedback_response_map</code>
- <code>get_certain_review_and_feedback_response_map</code>
- <code>Class ReviewStrategy </code>
- <code>Class StudentReviewStrategy</code>
- <code>Class TeamReviewStrategy</code>

2. Case #2: Refactoring may cause to break existing Rspec. => refactor Rspec as well

3. Case #3: Adding a new method => Add new Rspec scenario

4. Case #4: Removing methods => Remove from Rspec

*''' Functionality Tests''':

Functionality test will be added when our refactor causes to change in the logic. Our focus on this project is refactoring <code>review_mapping_helper.rb</code> to be more readable and understandable.

==GitHub links and Pull Request==

GitHub link [https://github.com/andypip88/expertiza here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-23T18:58:05Z

Hson: /* Problem 7: The method feedback_response_maps violates the Expert pattern */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view. Needs clarification if this function is being used or not.

*''' Proposed Solution ''': See if there is a way to get rid of it or incorporate it into the main method.

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps </code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing
'''FeedbackResponseMap''' found in two places in <code>review_mapping_helper.rb</code> => will add comments to make this code understandable.

def get_certain_review_and_feedback_response_map(author)
@feedback_response_maps = '''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?', @all_review_response_ids, author.id])
end

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code> and the instance variable for each round is already assigned in <code>feedback_response_map</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update.

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Rspec file <code> /rspec/review_mapping_helper_spec.rb</code> will be updated depending on the following cases.

1. Case#1: Methods not included in Rspec => review the method to refactor & include it in the Rspec file.

- <code>get_data_for_review_report</code>
- <code>initialize_chart_elements</code>
- <code>display_volume_metric_chart</code>
- <code>display_tagging_interval_chart</code>
- <code>list_hyperlink_submission</code>
- <code>get_each_review_and_feedback_response_map</code>
- <code>get_certain_review_and_feedback_response_map</code>
- <code>Class ReviewStrategy </code>
- <code>Class StudentReviewStrategy</code>
- <code>Class TeamReviewStrategy</code>

2. Case #2: Refactoring may cause to break existing Rspec. => refactor Rspec as well

3. Case #3: Adding a new method => Add new Rspec scenario

4. Case #4: Removing methods => Remove from Rspec

*''' Functionality Tests''':

Functionality test will be added when our refactor causes to change in the logic. Our focus on this project is refactoring <code>review_mapping_helper.rb</code> to be more readable and understandable.

==GitHub links and Pull Request==

GitHub link [https://github.com/andypip88/expertiza here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-23T05:16:34Z

Hson: /* Problem 8: three small classes violates the Expert pattern */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view. Needs clarification if this function is being used or not.

*''' Proposed Solution ''': See if there is a way to get rid of it or incorporate it into the main method.

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps </code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing
'''FeedbackResponseMap''' found in two places in <code>review_mapping_helper.rb</code> => will add comments to make this code understandable.

def get_certain_review_and_feedback_response_map(author)
@feedback_response_maps = '''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?', @all_review_response_ids, author.id])
end

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update.

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy.rb</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy.rb</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Rspec file <code> /rspec/review_mapping_helper_spec.rb</code> will be updated depending on the following cases.

1. Case#1: Methods not included in Rspec => review the method to refactor & include it in the Rspec file.

- <code>get_data_for_review_report</code>
- <code>initialize_chart_elements</code>
- <code>display_volume_metric_chart</code>
- <code>display_tagging_interval_chart</code>
- <code>list_hyperlink_submission</code>
- <code>get_each_review_and_feedback_response_map</code>
- <code>get_certain_review_and_feedback_response_map</code>
- <code>Class ReviewStrategy </code>
- <code>Class StudentReviewStrategy</code>
- <code>Class TeamReviewStrategy</code>

2. Case #2: Refactoring may cause to break existing Rspec. => refactor Rspec as well

3. Case #3: Adding a new method => Add new Rspec scenario

4. Case #4: Removing methods => Remove from Rspec

*''' Functionality Tests''':

Functionality test will be added when our refactor causes to change in the logic. Our focus on this project is refactoring <code>review_mapping_helper.rb</code> to be more readable and understandable.

==GitHub links and Pull Request==

GitHub link [https://github.com/andypip88/expertiza here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-23T05:16:15Z

Hson: /* Problem 8: three small classes violates the Expert pattern */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view. Needs clarification if this function is being used or not.

*''' Proposed Solution ''': See if there is a way to get rid of it or incorporate it into the main method.

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps </code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing
'''FeedbackResponseMap''' found in two places in <code>review_mapping_helper.rb</code> => will add comments to make this code understandable.

def get_certain_review_and_feedback_response_map(author)
@feedback_response_maps = '''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?', @all_review_response_ids, author.id])
end

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update.

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
*'''Solution Implemented''': To remove single responsibility violation, extra model files are created: <code> review_strategy</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Rspec file <code> /rspec/review_mapping_helper_spec.rb</code> will be updated depending on the following cases.

1. Case#1: Methods not included in Rspec => review the method to refactor & include it in the Rspec file.

- <code>get_data_for_review_report</code>
- <code>initialize_chart_elements</code>
- <code>display_volume_metric_chart</code>
- <code>display_tagging_interval_chart</code>
- <code>list_hyperlink_submission</code>
- <code>get_each_review_and_feedback_response_map</code>
- <code>get_certain_review_and_feedback_response_map</code>
- <code>Class ReviewStrategy </code>
- <code>Class StudentReviewStrategy</code>
- <code>Class TeamReviewStrategy</code>

2. Case #2: Refactoring may cause to break existing Rspec. => refactor Rspec as well

3. Case #3: Adding a new method => Add new Rspec scenario

4. Case #4: Removing methods => Remove from Rspec

*''' Functionality Tests''':

Functionality test will be added when our refactor causes to change in the logic. Our focus on this project is refactoring <code>review_mapping_helper.rb</code> to be more readable and understandable.

==GitHub links and Pull Request==

GitHub link [https://github.com/andypip88/expertiza here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-23T05:15:49Z

Hson: /* Problem 8: three small classes violates the Expert pattern */

== Background ==

Within Expertiza, one of the functionalities is for one participant to review the submission of another participant (or team) by answering specific questions about the submission and leaving comments and feedback. This involves the interaction of many tables: users, assignments, teams, reviews, and review_mappings. The <code>review_mapping_controller</code> is the primary file which handles the code for reviews, but it also relies on <code>review_mapping_helper</code> for additional methods. While <code>review_mapping_controller</code> focuses mostly on CRUD operations for reviews, reviewers, and scores, <code>review_mapping_helper</code> focuses more on which data are presented and how (colors, sorting, charts, etc). This project focuses on refactoring <code>review_mapping_helper</code> and seeks to make the current code more understandable and transparent, such as by using partials, renaming methods with more standard conventions, adding additional comments, removing/modifying unnecessary methods, and making other methods more robust and useful. This project builds on the work done by E2125, which focused on simplifying some methods in <code>review_mapping_helper</code>.

== History: Previous project for refactoring <code>review_mapping_helper.rb</code> ==
* E2225 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2022_-_E2225:_Refactor_review_mapping_helper.rb]
* E2162 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Fall_2021_-_E2162._Further_refactoring_and_improvement_of_review_mapping_helper]
* E1913 [https://expertiza.csc.ncsu.edu/index.php/CSC/ECE_517_Spring_2019_-_Project_E1913._Refactor_review_mapping_helper.rb]

== Previous Methods/Classes and their Usages ==

This Chart shows each method in the <code>review_mapping_helper.rb</code> file before our changes will be implemented. Since this project is a refactor, the overall usage of the file will not change, but some methods may be combined, added, destroyed, or moved to other files. The helper file also contains inner classes that work with the <code>review_mapping_controller.rb</code>.

[[File:MethodUsage.JPG|1000px]]

== Problems and planned changes ==

=== Problem 1: The method get_data_for_review_report violates the Expert pattern ===
<code>get_data_for_review_report</code> passes back a data structure with multiple <code>response</code> objects to the <code>_review_report.html.erb</code> view. This violates the Expert pattern, because the given view does not know how to break apart the structure passed to it.

*''' Proposed Solution ''': <code>get_data_for_review_report</code> will be refactored to use partials

=== Problem 2: Several method names begin with <code>get</code> ===
This naming convention is not Ruby-like, and needs to be changed.

*''' Proposed Solution ''': All method names beginning with <code>get</code> will be refactored to use more appropriate names. e.g. <code>get_team_color</code> will be refactored into <code>team_color?</code>. Other method names beginning with verbs will also be reviewed

=== Problem 3: The method get_awarded_review_score needs to be updated ===
<code> get_awarded_review_score </code> computes an overall score based upon scores awarded in individual rounds. This is one of many places in Expertiza where scores are being calculated. Score-calculation code for multiple rounds is being standardized now, in <code> response_map.rb </code>.

*''' Proposed Solution ''': Change the method to utilize the standard code from <code> response_map.rb </code>

=== Problem 4: The method sort_reviewer_by_review_volume_desc needs to be generalized ===
<code> sort_reviewer_by_review_volume_desc </code> only sorts by review volume, which is very specific.

*''' Proposed Solution ''': Modify the method to be able to sort by multiple different metrics such as a number of suggestions, or a number of suggestions + number of problems detected. This will also justify a method name change (and possible parameter change/additions), which will have to be updated elsewhere in the app.

=== Problem 5: Several methods are used for generating charts and should be moved to another file ===
Including <code> initialize_chart_elements </code>, <code> display_volume_metric_chart </code>, <code> display_tagging_interval_chart </code>, <code> calculate_key_chart_information </code>.They are cohesive enough to just be moved to another file.

*''' Proposed Solution ''': These methods will be moved to a new helper class, <code>review_mapping_chart_helper.rb</code>. This should separate their functionality from <code>review_mapping_helper</code>, and better illustrate their independent usage by <code>review_report.html.erb</code> and <code>answer_tagging.html.erb</code>

*''' Solution Implemented ''': <code> Done 4/21/2022 </code> These methods were moved to <code>review_mapping_chart_helper.rb</code>, all related tests were also moved, comments were added to the view files to reflect changes.

=== Problem 6: Investigate the use of <code> list_review_submissions </code> ===
It is not all clear that this method is needed, though it is used in one view. Needs clarification if this function is being used or not.

*''' Proposed Solution ''': See if there is a way to get rid of it or incorporate it into the main method.

=== Problem 7: The method feedback_response_maps violates the Expert pattern ===
It is not clear why <code> feedback_response_maps </code> are here.

*''' Proposed Solution ''':
Look up the expertiza wiki for the documentation, and make it clearer what they are doing
'''FeedbackResponseMap''' found in two places in <code>review_mapping_helper.rb</code> => will add comments to make this code understandable.

def get_certain_review_and_feedback_response_map(author)
@feedback_response_maps = '''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?', @all_review_response_ids, author.id])
end

def feedback_response_map_record(author)
instance_variable_set('@feedback_response_maps_round_' + round_num,
'''FeedbackResponseMap'''.where(['reviewed_object_id IN (?) and reviewer_id = ?',
instance_variable_get('@all_review_response_ids_round_' + round_num), author.id]))
end

*'''Solution Implemented''':The method <code>feedback_response_map_record</code> is for the assignment has multiple rounds. However, the same function is already in <code>views/reports/feedback_report</code>. This method is better to be removed from this helper method for DRY. Rspec test also applied this update.

=== Problem 8: three small classes violates the Expert pattern ===
It is not clear why <code> ReviewStrategy </code>, <code>StudentReviewStrategy</code>, <code>TeamReviewStrategy</code> are here.

*''' Proposed Solution ''':
Class <code>ReviewStrategy</code> is called in <code>reveiw_mapping_controller.rb</code> => Better to move this Class to
<code>reveiw_mapping_model.rb</code>

*<code>Class ReviewStrategy</code> example in <code>reveiw_mapping_controller.rb</code>
def automatic_review_mapping_strategy()
...
if !student_review_num.zero? && submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::StudentReviewStrategy'''.new(participants, teams, student_review_num)
elsif student_review_num.zero? && !submission_review_num.zero?
review_strategy = '''ReviewMappingHelper::TeamReviewStrategy'''.new(participants, teams, submission_review_num)
end
...
end
Solution Implemented: To remove single responsibility violation, extra model files are created: <code> review_strategy</code>,<code>student_review_strategy.rb</code>.and <code>team_review_strategy</code>.
The associated method <code>automatic_reivew_mapping_startegy</code> rspec test pass with this change.

=== Problem 9: The method get_team_color begins with <code>get_</code> and another method called <code>obtain_team_color</code> exists ===
<code>get_team_color</code> violates naming conventions, <code>obtain_team_color</code> also has a similar name and is only used by <code>get_team_color</code>. <code>obtain_team_color</code> can be considered a private method, so testing could be removed if its callee is alredy being tested.

*''' Proposed Solution ''': <code>get_team_color</code> will be renamed to <code>team_color?</code>, the contents of <code>obtain_team_color</code> will be moved to <code>team_color?</code>.

*''' Solution Implemented ''': <code> Done 4/22/2022</code>. The <code> get_team_color</code> method was renamed to <code>team_color?</code>, tests and view files have been updated with the proper naming. <code>obtain_team_color</code>'s code as been moved into <code>team_color?</code>. The tests for it have also been deleted since the code was already testing the called method contents before refactoring.

==UML Diagram==
A picture of the current and proposed UML diagram is included below

[[File:517 E2239 UML Diagram.vpd.png|1000px]]

The updated schema makes these changes:

*<code>obtain_team_color</code> has been refactored into <code>team_color?</code>, as the the former was called by the latter and was not unique enough to exist as a separate method
*<code>initialze_chart_elements</code>,<code>display_volume_metric_chart</code>,<code>display_tagging_interval_chart</code>, and <code>calculate_key_chart_information</code> have been refactored into a separate helper class <code>review_mapping_chart_helper.rb</code>, as their functionality is self-contained enough to exist on their own
*<code>ReviewStrategy</code>,<code>StudentReviewStrategy</code>, and <code>TeamReviewStrategy</code> have ben refactored as inner classes of <code>review_mapping_model</code> as this is the only class that interacts with these inner-classes.
*All method names beginning with <code>get</code> have been refactored to use <code>?</code> instead of <code>get</code> in order to conform to ruby standards

==Test Plan==

*''' RSpec Unit Tests''': Refactor Aim for " Always have working Code"

Rspec file <code> /rspec/review_mapping_helper_spec.rb</code> will be updated depending on the following cases.

1. Case#1: Methods not included in Rspec => review the method to refactor & include it in the Rspec file.

- <code>get_data_for_review_report</code>
- <code>initialize_chart_elements</code>
- <code>display_volume_metric_chart</code>
- <code>display_tagging_interval_chart</code>
- <code>list_hyperlink_submission</code>
- <code>get_each_review_and_feedback_response_map</code>
- <code>get_certain_review_and_feedback_response_map</code>
- <code>Class ReviewStrategy </code>
- <code>Class StudentReviewStrategy</code>
- <code>Class TeamReviewStrategy</code>

2. Case #2: Refactoring may cause to break existing Rspec. => refactor Rspec as well

3. Case #3: Adding a new method => Add new Rspec scenario

4. Case #4: Removing methods => Remove from Rspec

*''' Functionality Tests''':

Functionality test will be added when our refactor causes to change in the logic. Our focus on this project is refactoring <code>review_mapping_helper.rb</code> to be more readable and understandable.

==GitHub links and Pull Request==

GitHub link [https://github.com/andypip88/expertiza here]

== Team Members ==

Evan Brown

Chaitanya Patel

Rachel Hyo Son

Andrew Pippin

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-22T06:58:54Z

Hson: /* Problem 7: The method feedback_response_maps violates the Expert pattern */

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-22T06:54:51Z

Hson: /* Problem 7: The method feedback_response_maps violates the Expert pattern */

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-22T06:54:28Z

Hson: /* Problem 7: The method feedback_response_maps violates the Expert pattern */

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-22T06:54:02Z

Hson: /* Problem 7: The method feedback_response_maps violates the Expert pattern */

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-22T06:53:12Z

Hson: /* Problem 7: The method feedback_response_maps violates the Expert pattern */

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-22T06:51:19Z

Hson: /* Problem 7: The method feedback_response_maps violates the Expert pattern */

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-22T05:18:09Z

Hson: /* Test Plan */

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-12T02:01:45Z

Hson: /* Test Plan */

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-12T01:59:14Z

Hson: /* Problem 7: The method feedback_response_maps violates the Expert pattern */

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-12T01:58:09Z

Hson: /* Problem 7: The method feedback_response_maps violates the Expert pattern */

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-12T01:56:47Z

Hson: /* Problem 7: The method feedback_response_maps violates the Expert pattern */

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-12T01:56:10Z

Hson: /* Problem 7: The method feedback_response_maps violates the Expert pattern */

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-12T01:34:40Z

Hson: /* Problem 8: three small classes violates the Expert pattern */

CSC/ECE 517 Spring 2022 - E2239: Further refactoring and improvement of review mapping helper.rb

2022-04-12T01:34:20Z

Hson: /* Problem 8: three small classes violates the Expert pattern */