Class: RailsBestPractices::Reviews::NeedlessDeepNestingReview

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

Overview

Review config/routes.rb file to make sure not to use too deep nesting routes.

See the best practice details here rails-bestpractices.com/posts/11-needless-deep-nesting.

Implementation:

Review process:

chech all method_add_block nodes in route file.

it is a recursively check in method_add_block node,

if it is a method_add_block node,
increment @counter at the beginning of resources,
decrement @counter at the end of resrouces,
recursively check nodes in block body.

if the child node is a command_call or command node,
and the message of the node is "resources" or "resource",
and the @counter is greater than @nested_count defined,
then it is a needless deep nesting.

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

Constructor Details

#initialize(options = {}) ⇒ NeedlessDeepNestingReview

Returns a new instance of NeedlessDeepNestingReview.



34
35
36
37
38
39
 
# File 'lib/rails_best_practices/reviews/needless_deep_nesting_review.rb', line 34

def initialize(options = {})
  super()
  @counter = 0
  @nested_count = options['nested_count'] || 2
  @shallow_nodes = []
end

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_block(node) ⇒ Object

check all method_add_block node.

It is a recursively check, if it is a method_add_block node, increment @counter at the beginning of resources, decrement @counter at the end of method_add_block resources, recursively check the block body.

if the child node is a command_call or command node with message “resources” or “resource”, test if the @counter is greater than or equal to @nested_count, if so, it is a needless deep nesting.



51
52
53
54
 
# File 'lib/rails_best_practices/reviews/needless_deep_nesting_review.rb', line 51

def start_method_add_block(node)
  @file = node.file
  recursively_check(node)
end

#url ⇒ Object 



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

def url
  "http://rails-bestpractices.com/posts/11-needless-deep-nesting"
end