Module: RuboCop::Cop::Metrics::Utils::IteratingBlock

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In: `::RuboCop::Cop::Metrics::CyclomaticComplexity`, `::RuboCop::Cop::Metrics::PerceivedComplexity`, `AbcSizeCalculator`
Defined in:	lib/rubocop/cop/metrics/utils/iterating_block.rb

Overview

Used to identify iterating blocks like .map{} and .map(&:…)

KNOWN_ITERATING_METHODS =
# File 'lib/rubocop/cop/metrics/utils/iterating_block.rb', line 33
```
(Set.new(enumerable) + enumerator + array + hash).freeze
```

#block_method_name(node)

Returns the name of the method called with a block if node is a block node, or a block-pass node.
#iterating_block?(node) ⇒ Boolean

Returns nil if node is neither a block node or a block-pass node.
#iterating_method?(name) ⇒ Boolean

Returns true iff name is a known iterating type (e.g.

Returns the name of the method called with a block if node is a block node, or a block-pass node.

[ GitHub ]

# File 'lib/rubocop/cop/metrics/utils/iterating_block.rb', line 37


def block_method_name(node)
  case node.type
  when :block
    node.method_name
  when :block_pass
    node.parent.method_name
  end
end

Returns nil if node is neither a block node or a block-pass node. Otherwise returns true/false if method call is a known iterating call

[ GitHub ]

# File 'lib/rubocop/cop/metrics/utils/iterating_block.rb', line 53


def iterating_block?(node)
  name = block_method_name(node)
  name && iterating_method?(name)
end

Returns true iff name is a known iterating type (e.g. :each, :transform_values)

[ GitHub ]

# File 'lib/rubocop/cop/metrics/utils/iterating_block.rb', line 47


def iterating_method?(name)
  KNOWN_ITERATING_METHODS.include? name
end