Class: RailsBestPractices::Reviews::NotUseDefaultRouteReview

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

Overview

Review config/routes file to make sure not use default route that rails generated.

See the best practice details here rails-bestpractices.com/posts/12-not-use-default-route-if-you-use-restful-design

Implementation:

Review process:

check all method command_call or command node to see if it is the same as rails default route.

  map.connect ':controller/:action/:id'
  map.connect ':controller/:action/:id.:format'

or

  match ':controller(/:action(/:id(.:format)))'

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!, #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_command(node) ⇒ Object

check all command nodes, compare with rails3 default route



39
40
41
42
43
44
 
# File 'lib/rails_best_practices/reviews/not_use_default_route_review.rb', line 39

def start_command(node)
  if "match" == node.message.to_s &&
    ":controller(/:action(/:id(.:format)))" == node.arguments.all.first.to_s
    add_error "not use default route"
  end
end

#start_command_call(node) ⇒ Object

check all command call nodes, compare with rails2 default route



30
31
32
33
34
35
36
 
# File 'lib/rails_best_practices/reviews/not_use_default_route_review.rb', line 30

def start_command_call(node)
  if "map" == node.subject.to_s && "connect" == node.message.to_s &&
    (":controller/:action/:id" == node.arguments.all.first.to_s ||
     ":controller/:action/:id.:format" == node.arguments.all.first.to_s)
    add_error "not use default route"
  end
end

#url ⇒ Object 



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

def url
  "http://rails-bestpractices.com/posts/12-not-use-default-route-if-you-use-restful-design"
end