Class: RuboCop::Cop::Metrics::BlockNesting

Inherits:
Cop
  • Object
show all
Includes:
ConfigurableMax
Defined in:
lib/rubocop/cop/metrics/block_nesting.rb

Overview

This cop checks for excessive nesting of conditional and looping constructs.

You can configure if blocks are considered using the ‘CountBlocks` option. When set to `false` (the default) blocks are not counted towards the nesting level. Set to `true` to count blocks as well.

The maximum level of nesting allowed is configurable.

Constant Summary collapse

NESTING_BLOCKS = 
%i[
  case if while while_post
  until until_post for resbody
].freeze

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

This class inherits a constructor from RuboCop::Cop::Cop

Instance Method Details

#investigate(processed_source) ⇒ Object 



22
23
24
25
26
27
 
# File 'lib/rubocop/cop/metrics/block_nesting.rb', line 22

def investigate(processed_source)
  return if processed_source.blank?

  max = cop_config['Max']
  check_nesting_level(processed_source.ast, max, 0)
end