class RuboCop::Cop::Metrics::BlockNesting
Checks for excessive nesting of conditional and looping constructs.
You can configure if blocks are considered using the ‘CountBlocks` and `CountModifierForms` options. When both are set to `false` (the default) blocks and modifier forms are not counted towards the nesting level. Set them to `true` to include these in the nesting level calculation as well.
The maximum level of nesting allowed is configurable.
Constants
- NESTING_BLOCKS
Public Instance Methods
Source
# File lib/rubocop/cop/metrics/block_nesting.rb, line 19 def on_new_investigation return if processed_source.blank? max = cop_config['Max'] check_nesting_level(processed_source.ast, max, 0) end
Private Instance Methods
Source
# File lib/rubocop/cop/metrics/block_nesting.rb, line 28 def check_nesting_level(node, max, current_level) if consider_node?(node) current_level += 1 if count_if_block?(node) if current_level > max self.max = current_level unless part_of_ignored_node?(node) add_offense(node, message: message(max)) { ignore_node(node) } end end end node.each_child_node do |child_node| check_nesting_level(child_node, max, current_level) end end
Source
# File lib/rubocop/cop/metrics/block_nesting.rb, line 52 def consider_node?(node) return true if NESTING_BLOCKS.include?(node.type) count_blocks? && node.any_block_type? end
Source
# File lib/rubocop/cop/metrics/block_nesting.rb, line 62 def count_blocks? cop_config.fetch('CountBlocks', false) end
Source
# File lib/rubocop/cop/metrics/block_nesting.rb, line 44 def count_if_block?(node) return true unless node.if_type? return false if node.elsif? return count_modifier_forms? if node.modifier_form? true end
Source
# File lib/rubocop/cop/metrics/block_nesting.rb, line 66 def count_modifier_forms? cop_config.fetch('CountModifierForms', false) end
Source
# File lib/rubocop/cop/metrics/block_nesting.rb, line 58 def message(max) "Avoid more than #{max} levels of block nesting." end