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 call to see if any method call 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::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, #initialize, #method_missing, #node_end, #node_start

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

#interesting_files ⇒ Object 



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

def interesting_files
  ROUTE_FILE
end

#interesting_nodes ⇒ Object 



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

def interesting_nodes
  [:call]
end

#start_call(node) ⇒ Object

check all method calls, it just compare with rails default route

rails2

s(:call, s(:lvar, :map), :connect,
  s(:arglist, s(:str, ":controller/:action/:id"))
)
s(:call, s(:lvar, :map), :connect,
  s(:arglist, s(:str, ":controller/:action/:id.:format"))
)

rails3

s(:call, nil, :match,
  s(:arglist, s(:str, ":controller(/:action(/:id(.:format)))"))
)



50
51
52
53
54
55
56
 
# File 'lib/rails_best_practices/reviews/not_use_default_route_review.rb', line 50

def start_call(node)
  if s(:call, s(:lvar, :map), :connect, s(:arglist, s(:str, ":controller/:action/:id"))) == node ||
     s(:call, s(:lvar, :map), :connect, s(:arglist, s(:str, ":controller/:action/:id.:format"))) == node ||
     s(:call, nil, :match, s(:arglist, s(:str, ":controller(/:action(/:id(.:format)))"))) == node
    add_error "not use default route"
  end
end

#url ⇒ Object 



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

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