Class: RailsBestPractices::Reviews::MoveFinderToNamedScopeReview

Inherits:
Review
  • Object
show all
Defined in:
lib/rails_best_practices/reviews/move_finder_to_named_scope_review.rb

Overview

Review a controller file to make sure there are no complex finder.

See the best practice details here rails-bestpractices.com/posts/1-move-finder-to-named_scope.

Implementation:

Review process:

check all method method_add_arg nodes in controller files.
if there is any call node with message find, all, first or last,
and it has a hash argument,
then it is a complex finder, and should be moved to model's named scope.

Constant Summary collapse

FINDERS = 
%w(find all first last)

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!, #initialize, interesting_files, #interesting_files, #interesting_nodes, interesting_nodes, #method_missing, #node_end, #node_start, #parse_file?, #result, #total_files_checked

Constructor Details

This class inherits a constructor from RailsBestPractices::Core::Check

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_ag node if its message is one of find, all, first or last, and it has a hash argument, then the call node is the finder that should be moved to model’s named_scope.



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

def start_method_add_arg(node)
  add_error "move finder to named_scope" if finder?(node)
end

#url ⇒ Object 



23
24
25
 
# File 'lib/rails_best_practices/reviews/move_finder_to_named_scope_review.rb', line 23

def url
  "http://rails-bestpractices.com/posts/1-move-finder-to-named_scope"
end