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 calls to see if there is a complex options_for_select helper.

if the message of the call node is options_for_select,
and the first argument of the call 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::CONTROLLER_FILES, Core::Check::HELPER_FILES, Core::Check::MAILER_FILES, Core::Check::MIGRATION_FILES, Core::Check::MODEL_FILES, Core::Check::NODE_TYPES, Core::Check::PARTIAL_VIEW_FILES, Core::Check::ROUTE_FILE, Core::Check::SCHEMA_FILE, Core::Check::VIEW_FILES

Instance Attribute Summary

Attributes inherited from Core::Check

#errors

Instance Method Summary collapse

Methods inherited from Review

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

Methods inherited from Core::Check

#add_error, #method_missing, #node_end, #node_start

Constructor Details

#initialize(options = {}) ⇒ MoveCodeIntoHelperReview

Returns a new instance of MoveCodeIntoHelperReview.



34
35
36
37
 
# File 'lib/rails_best_practices/reviews/move_code_into_helper_review.rb', line 34

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

#interesting_files ⇒ Object 



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

def interesting_files
  VIEW_FILES
end

#interesting_nodes ⇒ Object 



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

def interesting_nodes
  [:call]
end

#start_call(node) ⇒ Object

check call 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.



44
45
46
 
# File 'lib/rails_best_practices/reviews/move_code_into_helper_review.rb', line 44

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

#url ⇒ Object 



22
23
24
 
# File 'lib/rails_best_practices/reviews/move_code_into_helper_review.rb', line 22

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