class RuboCop::Cop::Style::RedundantEach
Checks for redundant ‘each`.
@safety
This cop is unsafe, as it can produce false positives if the receiver is not an `Enumerator`.
@example
# bad array.each.each { |v| do_something(v) } # good array.each { |v| do_something(v) } # bad array.each.each_with_index { |v, i| do_something(v, i) } # good array.each.with_index { |v, i| do_something(v, i) } array.each_with_index { |v, i| do_something(v, i) } # bad array.each.each_with_object { |v, o| do_something(v, o) } # good array.each.with_object { |v, o| do_something(v, o) } array.each_with_object { |v, o| do_something(v, o) }
Constants
- MSG
- MSG_WITH_INDEX
- MSG_WITH_OBJECT
- RESTRICT_ON_SEND
Public Instance Methods
on_send(node)
click to toggle source
# File lib/rubocop/cop/style/redundant_each.rb, line 43 def on_send(node) return unless (redundant_node = redundant_each_method(node)) range = range(node) add_offense(range, message: message(node)) do |corrector| case node.method_name when :each remove_redundant_each(corrector, range, redundant_node) when :each_with_index corrector.replace(node.loc.selector, 'with_index') when :each_with_object corrector.replace(node.loc.selector, 'with_object') end end end
Also aliased as: on_csend
Private Instance Methods
message(node)
click to toggle source
# File lib/rubocop/cop/style/redundant_each.rb, line 96 def message(node) case node.method_name when :each MSG when :each_with_index MSG_WITH_INDEX when :each_with_object MSG_WITH_OBJECT end end
range(node)
click to toggle source
rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
# File lib/rubocop/cop/style/redundant_each.rb, line 86 def range(node) return node.selector unless node.method?(:each) if node.parent&.call_type? node.selector.join(node.parent.loc.dot) else node.loc.dot.join(node.selector) end end
redundant_each_method(node)
click to toggle source
rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
# File lib/rubocop/cop/style/redundant_each.rb, line 64 def redundant_each_method(node) return if node.last_argument&.block_pass_type? if node.method?(:each) && !node.parent&.block_type? ancestor_node = node.each_ancestor(:send, :csend).detect do |ancestor| ancestor.receiver == node && (RESTRICT_ON_SEND.include?(ancestor.method_name) || ancestor.method?(:reverse_each)) end return ancestor_node if ancestor_node end return unless (prev_method = node.children.first) return if !prev_method.send_type? || prev_method.parent.block_type? || prev_method.last_argument&.block_pass_type? detected = prev_method.method_name.to_s.start_with?('each_') unless node.method?(:each) prev_method if detected || prev_method.method?(:reverse_each) end
remove_redundant_each(corrector, range, redundant_node)
click to toggle source
# File lib/rubocop/cop/style/redundant_each.rb, line 107 def remove_redundant_each(corrector, range, redundant_node) corrector.remove(range) if redundant_node.method?(:each_with_index) corrector.replace(redundant_node.loc.selector, 'each.with_index') elsif redundant_node.method?(:each_with_object) corrector.replace(redundant_node.loc.selector, 'each.with_object') end end