Class: RailsBestPractices::Reviews::OveruseRouteCustomizationsReview

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

Overview

Review config/routes.rb file to make sure there are no overuse route customizations.

See the best practice details here rails-bestpractices.com/posts/2010/07/22/overuse-route-customizations/

Implementation:

Review process:

check all method_add_block nodes in route file.
if the receiver of method_add_block node is with message resources,
and in the block body of method_add_block node, there are more than @customize_count command nodes,
whose message is get, post, update or delete,
then these custom routes are overuse.

Constant Summary collapse

VERBS = 
%w[get post update delete].freeze

Constants inherited from Core::Check

Core::Check::ALL_FILES, Core::Check::CAPFILE, Core::Check::CONFIG_FILES, Core::Check::CONTROLLER_FILES, Core::Check::DEPLOY_FILES, Core::Check::GEMFILE_LOCK, Core::Check::HELPER_FILES, Core::Check::INITIALIZER_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::SKIP_FILES, 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_error, debug, debug?, #errors, #is_ignored?, #is_interesting_file?, #method_missing, #parse_file?, #regex_ignored_files, #url, url

Constructor Details

#initialize(options = {}) ⇒ OveruseRouteCustomizationsReview

Returns a new instance of OveruseRouteCustomizationsReview.



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

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

Dynamic Method Handling

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