Class: RailsBestPractices::Reviews::MoveCodeIntoHelperReview

Inherits:
Review show all
Defined in:
lib/rails_best_practices/reviews/move_code_into_helper_review.rb

Overview

Review a view file to make sure there is no complex options_for_select message call.

See the best practice details here rails-bestpractices.com/posts/26-move-code-into-helper.

TODO: we need a better soluation, any suggestion?

Implementation:

Review process:

check al method method_add_arg nodes to see if there is a complex options_for_select helper.

if the message of the method_add_arg node is options_for_select,
and the first argument of the method_add_arg node is array,
and the size of the array is greater than array_count defined,
then the options_for_select method should be moved into helper.

Constant Summary

Constants inherited from Core::Check

Core::Check::ALL_FILES, Core::Check::CONTROLLER_FILES, Core::Check::DEPLOY_FILES, Core::Check::HELPER_FILES, Core::Check::MAILER_FILES, Core::Check::MIGRATION_FILES, Core::Check::MODEL_FILES, Core::Check::PARTIAL_VIEW_FILES, Core::Check::ROUTE_FILES, Core::Check::SCHEMA_FILE, Core::Check::VIEW_FILES

Instance Method Summary collapse

Methods inherited from Review

#model_associations, #model_attributes, #models, #remember_variable_use_count, #reset_variable_use_count, #variable, #variable_use_count

Methods inherited from Core::Check

add_callback, #add_error, #after_prepare, #after_review, callbacks, #errors, #increment_total_files_checked!, #interesting_files, interesting_files, interesting_nodes, #interesting_nodes, #method_missing, #node_end, #node_start, #parse_file?, #result, #total_files_checked

Constructor Details

#initialize(options = {}) ⇒ MoveCodeIntoHelperReview

Returns a new instance of MoveCodeIntoHelperReview.



29
30
31
32
 
# File 'lib/rails_best_practices/reviews/move_code_into_helper_review.rb', line 29

def initialize(options = {})
  super()
  @array_count = options['array_count'] || 3
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class RailsBestPractices::Core::Check

Instance Method Details

#start_method_add_arg(node) ⇒ Object

check method_add_arg node with message options_for_select (sorry we only check options_for_select helper now).

if the first argument of options_for_select method call is an array, and the size of the array is more than @array_count defined, then the options_for_select helper should be moved into helper.



39
40
41
 
# File 'lib/rails_best_practices/reviews/move_code_into_helper_review.rb', line 39

def start_method_add_arg(node)
  add_error "move code into helper (array_count >= #{@array_count})" if complex_select_options?(node)
end

#url ⇒ Object 



25
26
27
 
# File 'lib/rails_best_practices/reviews/move_code_into_helper_review.rb', line 25

def url
  "http://rails-bestpractices.com/posts/26-move-code-into-helper"
end