rubocop 0.83.0 → 0.87.0

data/lib/rubocop/cop/corrector.rb

@@ -8,117 +8,25 @@ module RuboCop
     # Important!
     # The nodes modified by the corrections should be part of the
     # AST of the source_buffer.
-    class Corrector
+    class Corrector < ::Parser::Source::TreeRewriter
+      # @param source [Parser::Source::Buffer, or anything
+      #                leading to one via `(processed_source.)buffer`]
       #
-      # @param source_buffer [Parser::Source::Buffer]
-      # @param corrections [Array(#call)]
-      #   Array of Objects that respond to #call. They will receive the
-      #   corrector itself and should use its method to modify the source.
-      #
-      # @example
-      #
-      #   class AndOrCorrector
-      #     def initialize(node)
-      #       @node = node
-      #     end
-      #
-      #     def call(corrector)
-      #       replacement = (@node.type == :and ? '&&' : '||')
-      #       corrector.replace(@node.loc.operator, replacement)
-      #     end
-      #   end
-      #
-      #   corrections = [AndOrCorrector.new(node)]
-      #   corrector = Corrector.new(source_buffer, corrections)
-      def initialize(source_buffer, corrections = [])
-        @source_buffer = source_buffer
-        raise 'source_buffer should be a Parser::Source::Buffer' unless \
-          source_buffer.is_a? Parser::Source::Buffer
-
-        @corrections = corrections
-        @source_rewriter = Parser::Source::TreeRewriter.new(
-          source_buffer,
+      #   corrector = Corrector.new(cop)
+      def initialize(source)
+        source = self.class.source_buffer(source)
+        super(
+          source,
           different_replacements: :raise,
           swallowed_insertions: :raise,
           crossing_deletions: :accept
         )
 
-        @diagnostics = []
         # Don't print warnings to stderr if corrections conflict with each other
-        @source_rewriter.diagnostics.consumer = lambda do |diagnostic|
-          @diagnostics << diagnostic
-        end
-      end
-
-      attr_reader :corrections, :diagnostics
-
-      # Does the actual rewrite and returns string corresponding to
-      # the rewritten source.
-      #
-      # @return [String]
-      def rewrite
-        @corrections.each do |correction|
-          begin
-            @source_rewriter.transaction do
-              correction.call(self)
-            end
-          rescue ErrorWithAnalyzedFileLocation => e
-            raise e unless e.cause.is_a?(::Parser::ClobberingError)
-          end
-        end
-
-        @source_rewriter.process
-      end
-
-      # Removes the source range.
-      #
-      # @param [Parser::Source::Range, Rubocop::AST::Node] range or node
-      def remove(node_or_range)
-        range = to_range(node_or_range)
-        @source_rewriter.remove(range)
-      end
-
-      # Inserts new code before the given source range.
-      #
-      # @param [Parser::Source::Range, Rubocop::AST::Node] range or node
-      # @param [String] content
-      def insert_before(node_or_range, content)
-        range = to_range(node_or_range)
-        # TODO: Fix Cops using bad ranges instead
-        if range.end_pos > @source_buffer.source.size
-          range = range.with(end_pos: @source_buffer.source.size)
-        end
-
-        @source_rewriter.insert_before(range, content)
-      end
-
-      # Inserts new code after the given source range.
-      #
-      # @param [Parser::Source::Range, Rubocop::AST::Node] range or node
-      # @param [String] content
-      def insert_after(node_or_range, content)
-        range = to_range(node_or_range)
-        @source_rewriter.insert_after(range, content)
+        diagnostics.consumer = ->(diagnostic) {}
       end
 
-      # Wraps the given source range with the given before and after texts
-      #
-      # @param [Parser::Source::Range, Rubocop::AST::Node] range or node
-      # @param [String] before
-      # @param [String] after
-      def wrap(node_or_range, before, after)
-        range = to_range(node_or_range)
-        @source_rewriter.wrap(range, before, after)
-      end
-
-      # Replaces the code of the source range `range` with `content`.
-      #
-      # @param [Parser::Source::Range, Rubocop::AST::Node] range or node
-      # @param [String] content
-      def replace(node_or_range, content)
-        range = to_range(node_or_range)
-        @source_rewriter.replace(range, content)
-      end
+      alias rewrite process # Legacy
 
       # Removes `size` characters prior to the source range.
       #
@@ -126,10 +34,11 @@ module RuboCop
       # @param [Integer] size
       def remove_preceding(node_or_range, size)
         range = to_range(node_or_range)
-        to_remove = Parser::Source::Range.new(range.source_buffer,
-                                              range.begin_pos - size,
-                                              range.begin_pos)
-        @source_rewriter.remove(to_remove)
+        to_remove = range.with(
+          begin_pos: range.begin_pos - size,
+          end_pos:   range.begin_pos
+        )
+        remove(to_remove)
       end
 
       # Removes `size` characters from the beginning of the given range.
@@ -140,10 +49,8 @@ module RuboCop
       # @param [Integer] size
       def remove_leading(node_or_range, size)
         range = to_range(node_or_range)
-        to_remove = Parser::Source::Range.new(range.source_buffer,
-                                              range.begin_pos,
-                                              range.begin_pos + size)
-        @source_rewriter.remove(to_remove)
+        to_remove = range.with(end_pos: range.begin_pos + size)
+        remove(to_remove)
       end
 
       # Removes `size` characters from the end of the given range.
@@ -154,10 +61,22 @@ module RuboCop
       # @param [Integer] size
       def remove_trailing(node_or_range, size)
         range = to_range(node_or_range)
-        to_remove = Parser::Source::Range.new(range.source_buffer,
-                                              range.end_pos - size,
-                                              range.end_pos)
-        @source_rewriter.remove(to_remove)
+        to_remove = range.with(begin_pos: range.end_pos - size)
+        remove(to_remove)
+      end
+
+      # Duck typing for get to a ::Parser::Source::Buffer
+      def self.source_buffer(source)
+        source = source.processed_source if source.respond_to?(:processed_source)
+        source = source.buffer if source.respond_to?(:buffer)
+        source = source.source_buffer if source.respond_to?(:source_buffer)
+
+        unless source.is_a? ::Parser::Source::Buffer
+          raise TypeError, 'Expected argument to lead to a Parser::Source::Buffer ' \
+                           "but got #{source.inspect}"
+        end
+
+        source
       end
 
       private
@@ -178,8 +97,12 @@ module RuboCop
         range
       end
 
+      def check_range_validity(node_or_range)
+        super(to_range(node_or_range))
+      end
+
       def validate_buffer(buffer)
-        return if buffer == @source_buffer
+        return if buffer == source_buffer
 
         unless buffer.is_a?(::Parser::Source::Buffer)
           # actually this should be enforced by parser gem

data/lib/rubocop/cop/correctors/alignment_corrector.rb

@@ -48,9 +48,7 @@ module RuboCop
           return if taboo_ranges.any? { |t| within?(range, t) }
 
           if column_delta.positive?
-            unless range.resize(1).source == "\n"
-              corrector.insert_before(range, ' ' * column_delta)
-            end
+            corrector.insert_before(range, ' ' * column_delta) unless range.resize(1).source == "\n"
           elsif /\A[ \t]+\z/.match?(range.source)
             remove(range, corrector)
           end
@@ -92,9 +90,7 @@ module RuboCop
         end
 
         def calculate_range(expr, line_begin_pos, column_delta)
-          if column_delta.positive?
-            return range_between(line_begin_pos, line_begin_pos)
-          end
+          return range_between(line_begin_pos, line_begin_pos) if column_delta.positive?
 
           starts_with_space =
             expr.source_buffer.source[line_begin_pos].start_with?(' ')

data/lib/rubocop/cop/correctors/lambda_literal_to_method_corrector.rb

@@ -129,7 +129,7 @@ module RuboCop
       end
 
       def separating_space?
-        block_begin.source_buffer.source[block_begin.begin_pos + 2].match(/\s/)
+        block_begin.source_buffer.source[block_begin.begin_pos + 2].match?(/\s/)
       end
     end
   end

data/lib/rubocop/cop/correctors/space_corrector.rb

@@ -35,9 +35,7 @@ module RuboCop
 
         def add_space(processed_source, corrector, left_token, right_token)
           @processed_source = processed_source
-          unless left_token.space_after?
-            corrector.insert_after(left_token.pos, ' ')
-          end
+          corrector.insert_after(left_token.pos, ' ') unless left_token.space_after?
           return if right_token.space_before?
 
           corrector.insert_before(right_token.pos, ' ')

data/lib/rubocop/cop/gemspec/ordered_dependencies.rb

@@ -68,9 +68,7 @@ module RuboCop
               gem_name(current),
               gem_name(previous)
             )
-            unless get_dependency_name(previous) == get_dependency_name(current)
-              next
-            end
+            next unless get_dependency_name(previous) == get_dependency_name(current)
 
             register_offense(previous, current)
           end

data/lib/rubocop/cop/gemspec/required_ruby_version.rb

@@ -64,7 +64,7 @@ module RuboCop
         def extract_ruby_version(required_ruby_version)
           if required_ruby_version.array_type?
             required_ruby_version = required_ruby_version.children.detect do |v|
-              v.str_content =~ /[>=]/
+              /[>=]/.match?(v.str_content)
             end
           end
 

data/lib/rubocop/cop/gemspec/ruby_version_globals_usage.rb

@@ -28,7 +28,7 @@ module RuboCop
       class RubyVersionGlobalsUsage < Cop
         MSG = 'Do not use `RUBY_VERSION` in gemspec file.'
 
-        def_node_matcher :ruby_version?, '(const nil? :RUBY_VERSION)'
+        def_node_matcher :ruby_version?, '(const {cbase nil?} :RUBY_VERSION)'
 
         def_node_search :gem_specification?, <<~PATTERN
           (block

data/lib/rubocop/cop/generator.rb

@@ -54,11 +54,11 @@ module RuboCop
               #   # good
               #   good_foo_method(args)
               #
-              class %<cop_name>s < Cop
+              class %<cop_name>s < Base
                 # TODO: Implement the cop in here.
                 #
                 # In many cases, you can use a node matcher for matching node pattern.
-                # See https://github.com/rubocop-hq/rubocop/blob/master/lib/rubocop/node_pattern.rb
+                # See https://github.com/rubocop-hq/rubocop-ast/blob/master/lib/rubocop/node_pattern.rb
                 #
                 # For example
                 MSG = 'Use `#good_method` instead of `#bad_method`.'

data/lib/rubocop/cop/generator/configuration_injector.rb

@@ -58,7 +58,7 @@ module RuboCop
         end
 
         def cop_name_line?(yaml)
-          yaml !~ /^[\s#]/
+          !/^[\s#]/.match?(yaml)
         end
       end
     end

data/lib/rubocop/cop/ignored_node.rb

@@ -10,9 +10,7 @@ module RuboCop
 
       def part_of_ignored_node?(node)
         ignored_nodes.map(&:loc).any? do |ignored_loc|
-          if ignored_loc.expression.begin_pos > node.source_range.begin_pos
-            next false
-          end
+          next false if ignored_loc.expression.begin_pos > node.source_range.begin_pos
 
           ignored_end_pos = if ignored_loc.respond_to?(:heredoc_body)
                               ignored_loc.heredoc_end.end_pos

data/lib/rubocop/cop/internal_affairs/node_type_predicate.rb

@@ -13,7 +13,9 @@ module RuboCop
       #   # good
       #   node.send_type?
       #
-      class NodeTypePredicate < Cop
+      class NodeTypePredicate < Base
+        extend AutoCorrector
+
         MSG = 'Use `#%<type>s_type?` to check node type.'
 
         def_node_matcher :node_type_check, <<~PATTERN
@@ -21,21 +23,16 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          node_type_check(node) do |_receiver, node_type|
+          node_type_check(node) do |receiver, node_type|
             return unless Parser::Meta::NODE_TYPES.include?(node_type)
 
-            add_offense(node, message: format(MSG, type: node_type))
-          end
-        end
-
-        def autocorrect(node)
-          receiver, node_type = node_type_check(node)
-          range = Parser::Source::Range.new(node.source_range.source_buffer,
-                                            receiver.loc.expression.end_pos + 1,
-                                            node.loc.expression.end_pos)
-
-          lambda do |corrector|
-            corrector.replace(range, "#{node_type}_type?")
+            message = format(MSG, type: node_type)
+            add_offense(node, message: message) do |corrector|
+              range = node.loc.expression.with(
+                begin_pos: receiver.loc.expression.end_pos + 1
+              )
+              corrector.replace(range, "#{node_type}_type?")
+            end
           end
         end
       end

data/lib/rubocop/cop/layout/case_indentation.rb

@@ -3,10 +3,10 @@
 module RuboCop
   module Cop
     module Layout
-      # This cop checks how the *when*s of a *case* expression
-      # are indented in relation to its *case* or *end* keyword.
+      # This cop checks how the ``when``s of a `case` expression
+      # are indented in relation to its `case` or `end` keyword.
       #
-      # It will register a separate offense for each misaligned *when*.
+      # It will register a separate offense for each misaligned `when`.
       #
       # @example
       #   # If Layout/EndAlignment is set to keyword style (default)
@@ -67,10 +67,11 @@ module RuboCop
       #   else
       #     y / 3
       #   end
-      class CaseIndentation < Cop
+      class CaseIndentation < Base
         include Alignment
         include ConfigurableEnforcedStyle
         include RangeHelp
+        extend AutoCorrector
 
         MSG = 'Indent `when` %<depth>s `%<base>s`.'
 
@@ -82,16 +83,6 @@ module RuboCop
           end
         end
 
-        def autocorrect(node)
-          whitespace = whitespace_range(node)
-
-          return false unless whitespace.source.strip.empty?
-
-          lambda do |corrector|
-            corrector.replace(whitespace, replacement(node))
-          end
-        end
-
         private
 
         def check_when(when_node)
@@ -114,22 +105,30 @@ module RuboCop
         end
 
         def incorrect_style(when_node)
+          add_offense(when_node.loc.keyword) do |corrector|
+            detect_incorrect_style(when_node)
+
+            whitespace = whitespace_range(when_node)
+
+            corrector.replace(whitespace, replacement(when_node)) if whitespace.source.strip.empty?
+          end
+        end
+
+        def detect_incorrect_style(when_node)
           when_column = when_node.loc.keyword.column
           base_column = base_column(when_node.parent, alternative_style)
 
-          add_offense(when_node, location: :keyword, message: message(style)) do
-            if when_column == base_column
-              opposite_style_detected
-            else
-              unrecognized_style_detected
-            end
+          if when_column == base_column
+            opposite_style_detected
+          else
+            unrecognized_style_detected
           end
         end
 
-        def message(base)
+        def find_message(*)
           depth = indent_one_step? ? 'one step more than' : 'as deep as'
 
-          format(MSG, depth: depth, base: base)
+          format(MSG, depth: depth, base: style)
         end
 
         def base_column(case_node, base)

data/lib/rubocop/cop/layout/class_structure.rb

@@ -8,22 +8,24 @@ module RuboCop
       # `Categories` allows us to map macro names into a category.
       #
       # Consider an example of code style that covers the following order:
-      # - Module inclusion (include, prepend, extend)
-      # - Constants
-      # - Associations (has_one, has_many)
-      # - Public attribute macros (attr_accessor, attr_writer, attr_reader)
-      # - Other macros (validates, validate)
-      # - Public class methods
-      # - Initializer
-      # - Public instance methods
-      # - Protected attribute macros (attr_accessor, attr_writer, attr_reader)
-      # - Protected instance methods
-      # - Private attribute macros (attr_accessor, attr_writer, attr_reader)
-      # - Private instance methods
+      #
+      # * Module inclusion (include, prepend, extend)
+      # * Constants
+      # * Associations (has_one, has_many)
+      # * Public attribute macros (attr_accessor, attr_writer, attr_reader)
+      # * Other macros (validates, validate)
+      # * Public class methods
+      # * Initializer
+      # * Public instance methods
+      # * Protected attribute macros (attr_accessor, attr_writer, attr_reader)
+      # * Protected instance methods
+      # * Private attribute macros (attr_accessor, attr_writer, attr_reader)
+      # * Private instance methods
       #
       # You can configure the following order:
       #
-      # ```yaml
+      # [source,yaml]
+      # ----
       #  Layout/ClassStructure:
       #    ExpectedOrder:
       #      - module_inclusion
@@ -40,13 +42,14 @@ module RuboCop
       #      - private_attribute_macros
       #      - private_delegate
       #      - private_methods
-      # ```
+      # ----
       #
       # Instead of putting all literals in the expected order, is also
       # possible to group categories of macros. Visibility levels are handled
       # automatically.
       #
-      # ```yaml
+      # [source,yaml]
+      # ----
       #  Layout/ClassStructure:
       #    Categories:
       #      association:
@@ -63,7 +66,7 @@ module RuboCop
       #        - include
       #        - prepend
       #        - extend
-      # ```
+      # ----
       #
       # @example
       #   # bad