Sha256: a7a1766ad94c05a1e3174cf628e5398bfa1b25e5a9826796aebb313de29f0263

Contents?: true

Size: 1.66 KB

Versions: 97

Compression:

Stored size: 1.66 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    # This class auto-corrects `for` iteration to `#each` enumeration.
    class ForToEachCorrector
      extend NodePattern::Macros

      CORRECTION = '%<collection>s.each do |%<argument>s|'

      def initialize(for_node)
        @for_node        = for_node
        @variable_node   = for_node.variable
        @collection_node = for_node.collection
      end

      def call(corrector)
        corrector.replace(offending_range, correction)
      end

      private

      attr_reader :for_node, :variable_node, :collection_node

      def correction
        format(CORRECTION, collection: collection_source,
                           argument: variable_node.source)
      end

      def collection_source
        if requires_parentheses?
          "(#{collection_node.source})"
        else
          collection_node.source
        end
      end

      def requires_parentheses?
        collection_node.range_type?
      end

      def end_position
        if for_node.do?
          keyword_begin.end_pos
        else
          collection_end.end_pos
        end
      end

      def keyword_begin
        for_node.loc.begin
      end

      def collection_end
        if collection_node.begin_type?
          collection_node.loc.end
        else
          collection_node.loc.expression
        end
      end

      def offending_range
        replacement_range(end_position)
      end

      def replacement_range(end_pos)
        Parser::Source::Range.new(for_node.loc.expression.source_buffer,
                                  for_node.loc.expression.begin_pos,
                                  end_pos)
      end
    end
  end
end

Version data entries

97 entries across 77 versions & 6 rubygems

Version Path
plaid-14.13.0 vendor/bundle/ruby/3.0.0/gems/rubocop-0.91.1/lib/rubocop/cop/correctors/for_to_each_corrector.rb
plaid-14.12.1 vendor/bundle/ruby/3.0.0/gems/rubocop-0.91.1/lib/rubocop/cop/correctors/for_to_each_corrector.rb
plaid-14.12.0 vendor/bundle/ruby/2.6.0/gems/rubocop-0.91.1/lib/rubocop/cop/correctors/for_to_each_corrector.rb
plaid-14.11.1 vendor/bundle/ruby/2.6.0/gems/rubocop-0.91.1/lib/rubocop/cop/correctors/for_to_each_corrector.rb
plaid-14.10.0 vendor/bundle/ruby/2.6.0/gems/rubocop-0.91.1/lib/rubocop/cop/correctors/for_to_each_corrector.rb
plaid-14.7.0 vendor/bundle/ruby/2.6.0/gems/rubocop-0.91.1/lib/rubocop/cop/correctors/for_to_each_corrector.rb
rubocop-1.12.1 lib/rubocop/cop/correctors/for_to_each_corrector.rb
rubocop-1.12.0 lib/rubocop/cop/correctors/for_to_each_corrector.rb
rubocop-1.11.0 lib/rubocop/cop/correctors/for_to_each_corrector.rb
rubocop-1.10.0 lib/rubocop/cop/correctors/for_to_each_corrector.rb
rubocop-1.9.1 lib/rubocop/cop/correctors/for_to_each_corrector.rb
rubocop-1.9.0 lib/rubocop/cop/correctors/for_to_each_corrector.rb
rubocop-1.8.1 lib/rubocop/cop/correctors/for_to_each_corrector.rb
rubocop-1.8.0 lib/rubocop/cop/correctors/for_to_each_corrector.rb
rubocop-1.7.0 lib/rubocop/cop/correctors/for_to_each_corrector.rb
rubocop-1.6.1 lib/rubocop/cop/correctors/for_to_each_corrector.rb
rubocop-1.6.0 lib/rubocop/cop/correctors/for_to_each_corrector.rb
rubocop-1.5.2 lib/rubocop/cop/correctors/for_to_each_corrector.rb
rubocop-1.5.1 lib/rubocop/cop/correctors/for_to_each_corrector.rb
rubocop-1.5.0 lib/rubocop/cop/correctors/for_to_each_corrector.rb