Class: RailsBestPractices::Reviews::SimplifyRenderInControllersReview

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

Overview

Review a controller file to make sure using simplified syntax for render.

See the best practice details here rails-bestpractices.com/posts/62-simplify-render-in-controllers.

Implementation:

Review process:

check all render method commands in controller files,
if there is a key 'action', 'template' or 'file' in the argument,
then they should be replaced by simplified syntax.

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 command node in the controller file, if its message is render and the arguments contain a key action, template or file, then it should be replaced by simplified syntax.



27
28
29
30
31
32
33
34
35
 
# File 'lib/rails_best_practices/reviews/simplify_render_in_controllers_review.rb', line 27

def start_command(node)
  if "render" == node.message.to_s
    keys = node.arguments.all.first.hash_keys
    if keys && keys.size == 1 &&
       (keys.include?("action") || keys.include?("template") || keys.include?("file"))
      add_error 'simplify render in controllers'
    end
  end
end

#url ⇒ Object 



20
21
22
 
# File 'lib/rails_best_practices/reviews/simplify_render_in_controllers_review.rb', line 20

def url
  "http://rails-bestpractices.com/posts/62-simplify-render-in-controllers"
end