rubocop 0.87.0 → 0.90.0

data/lib/rubocop/cop/cop.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'uri'
-require_relative 'legacy/corrections_proxy.rb'
+require_relative 'legacy/corrections_proxy'
 
 module RuboCop
   module Cop

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

@@ -29,13 +29,13 @@ module RuboCop
           end
         end
 
-        def align_end(processed_source, node, align_to)
+        def align_end(corrector, processed_source, node, align_to)
           @processed_source = processed_source
           whitespace = whitespace_range(node)
           return false unless whitespace.source.strip.empty?
 
           column = alignment_column(align_to)
-          ->(corrector) { corrector.replace(whitespace, ' ' * column) }
+          corrector.replace(whitespace, ' ' * column)
         end
 
         private
@@ -47,8 +47,8 @@ module RuboCop
           # string literals
           return if taboo_ranges.any? { |t| within?(range, t) }
 
-          if column_delta.positive?
-            corrector.insert_before(range, ' ' * column_delta) unless range.resize(1).source == "\n"
+          if column_delta.positive? && range.resize(1).source != "\n"
+            corrector.insert_before(range, ' ' * column_delta)
           elsif /\A[ \t]+\z/.match?(range.source)
             remove(range, corrector)
           end

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

@@ -5,13 +5,11 @@ module RuboCop
     # This class does condition auto-correction
     class ConditionCorrector
       class << self
-        def correct_negative_condition(node)
+        def correct_negative_condition(corrector, node)
           condition = negated_condition(node)
 
-          lambda do |corrector|
-            corrector.replace(node.loc.keyword, node.inverse_keyword)
-            corrector.replace(condition, condition.children.first.source)
-          end
+          corrector.replace(node.loc.keyword, node.inverse_keyword)
+          corrector.replace(condition, condition.children.first.source)
         end
 
         private

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

@@ -5,20 +5,19 @@ module RuboCop
     # This class does empty line auto-correction
     class EmptyLineCorrector
       class << self
-        def correct(node)
+        def correct(corrector, node)
           offense_style, range = node
-          lambda do |corrector|
-            case offense_style
-            when :no_empty_lines
-              corrector.remove(range)
-            when :empty_lines
-              corrector.insert_before(range, "\n")
-            end
+
+          case offense_style
+          when :no_empty_lines
+            corrector.remove(range)
+          when :empty_lines
+            corrector.insert_before(range, "\n")
           end
         end
 
-        def insert_before(node)
-          ->(corrector) { corrector.insert_before(node, "\n") }
+        def insert_before(corrector, node)
+          corrector.insert_before(node, "\n")
         end
       end
     end

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

@@ -16,7 +16,7 @@ module RuboCop
                                   processed_source:)
           @processed_source = processed_source
           range = first_part_of(node.to_a.last)
-          eol_comment = end_of_line_comment(node.source_range.line)
+          eol_comment = processed_source.comment_at_line(node.source_range.line)
 
           break_line_before(range: range, node: node, corrector: corrector,
                             configured_width: configured_width)
@@ -25,12 +25,12 @@ module RuboCop
           remove_semicolon(node, corrector)
         end
 
-        def break_line_before(range:, node:, corrector:, indent_steps: 1,
-                              configured_width:)
+        def break_line_before(range:, node:, corrector:, configured_width:,
+                              indent_steps: 1)
           corrector.insert_before(
             range,
-            "\n" + ' ' * (node.loc.keyword.column +
-                          indent_steps * configured_width)
+            "\n#{' ' * (node.loc.keyword.column +
+                          indent_steps * configured_width)}"
           )
         end
 
@@ -39,7 +39,7 @@ module RuboCop
 
           text = eol_comment.loc.expression.source
           corrector.insert_before(node,
-                                  text + "\n" + (' ' * node.loc.keyword.column))
+                                  "#{text}\n#{' ' * node.loc.keyword.column}")
           corrector.remove(eol_comment)
         end
 

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

@@ -8,12 +8,17 @@ module RuboCop
       include MultilineLiteralBraceLayout
       include RangeHelp
 
-      def initialize(node, processed_source)
+      def self.correct(corrector, node, processed_source)
+        new(corrector, node, processed_source).call
+      end
+
+      def initialize(corrector, node, processed_source)
+        @corrector = corrector
         @node = node
         @processed_source = processed_source
       end
 
-      def call(corrector)
+      def call
         if closing_brace_on_same_line?(node)
           correct_same_line_brace(corrector)
         else
@@ -29,7 +34,7 @@ module RuboCop
 
       private
 
-      attr_reader :node, :processed_source
+      attr_reader :corrector, :node, :processed_source
 
       def correct_same_line_brace(corrector)
         corrector.insert_before(node.loc.end, "\n")
@@ -42,8 +47,34 @@ module RuboCop
 
         corrector.insert_before(
           last_element_range_with_trailing_comma(node).end,
+          content_if_comment_present(corrector, node)
+        )
+      end
+
+      def content_if_comment_present(corrector, node)
+        range = range_with_surrounding_space(
+          range: children(node).last.source_range,
+          side: :right
+        ).end.resize(1)
+        if range.source == '#'
+          select_content_to_be_inserted_after_last_element(corrector, node)
+        else
           node.loc.end.source
+        end
+      end
+
+      def select_content_to_be_inserted_after_last_element(corrector, node)
+        range = range_between(
+          node.loc.end.begin_pos,
+          range_by_whole_lines(node.loc.expression).end.end_pos
         )
+
+        remove_trailing_content_of_comment(corrector, range)
+        range.source
+      end
+
+      def remove_trailing_content_of_comment(corrector, range)
+        corrector.remove(range)
       end
 
       def last_element_range_with_trailing_comma(node)

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

@@ -5,15 +5,12 @@ module RuboCop
     # This auto-corrects parentheses
     class ParenthesesCorrector
       class << self
-        def correct(node)
-          lambda do |corrector|
-            corrector.remove(node.loc.begin)
-            corrector.remove(node.loc.end)
+        def correct(corrector, node)
+          corrector.remove(node.loc.begin)
+          corrector.remove(node.loc.end)
+          return unless ternary_condition?(node) && next_char_is_question_mark?(node)
 
-            if ternary_condition?(node) && next_char_is_question_mark?(node)
-              corrector.insert_after(node.loc.end, ' ')
-            end
-          end
+          corrector.insert_after(node.loc.end, ' ')
         end
 
         private

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

@@ -13,23 +13,18 @@ module RuboCop
         @preferred_delimiters = preferred_delimiters
       end
 
-      def correct(node, char)
+      def correct(corrector, node, char)
         escape = escape_words?(node)
         char = char.upcase if escape
         delimiters = delimiters_for("%#{char}")
         contents = new_contents(node, escape, delimiters)
-        wrap_contents(node, contents, char, delimiters)
+        wrap_contents(corrector, node, contents, char, delimiters)
       end
 
       private
 
-      def wrap_contents(node, contents, char, delimiters)
-        lambda do |corrector|
-          corrector.replace(
-            node,
-            "%#{char}#{delimiters[0]}#{contents}#{delimiters[1]}"
-          )
-        end
+      def wrap_contents(corrector, node, contents, char, delimiters)
+        corrector.replace(node, "%#{char}#{delimiters[0]}#{contents}#{delimiters[1]}")
       end
 
       def escape_words?(node)
@@ -71,7 +66,7 @@ module RuboCop
                                     prev_line_num,
                                     base_line_num,
                                     index)
-          prev_line_num = word_node.first_line
+          prev_line_num = word_node.last_line
           content = fix_escaped_content(word_node, escape, delimiters)
           line_breaks + content
         end
@@ -110,7 +105,7 @@ module RuboCop
 
       def end_content(source)
         result = /\A(\s*)\]/.match(source.split("\n").last)
-        ("\n" + result[1]) if result
+        "\n#{result[1]}" if result
       end
     end
   end

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

@@ -5,22 +5,20 @@ module RuboCop
     # This auto-corrects punctuation
     class PunctuationCorrector
       class << self
-        def remove_space(space_before)
-          ->(corrector) { corrector.remove(space_before) }
+        def remove_space(corrector, space_before)
+          corrector.remove(space_before)
         end
 
-        def add_space(token)
-          ->(corrector) { corrector.replace(token.pos, token.pos.source + ' ') }
+        def add_space(corrector, token)
+          corrector.replace(token.pos, "#{token.pos.source} ")
         end
 
-        def swap_comma(range)
+        def swap_comma(corrector, range)
           return unless range
 
-          lambda do |corrector|
-            case range.source
-            when ',' then corrector.remove(range)
-            else          corrector.insert_after(range, ',')
-            end
+          case range.source
+          when ',' then corrector.remove(range)
+          else          corrector.insert_after(range, ',')
           end
         end
       end

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

@@ -9,33 +9,30 @@ module RuboCop
       class << self
         attr_reader :processed_source
 
-        def correct(processed_source, node)
+        def correct(corrector, processed_source, node)
           return if %i[kwarg kwoptarg].include?(node.type)
 
           @processed_source = processed_source
 
           if node.blockarg_type?
-            correct_for_blockarg_type(node)
+            correct_for_blockarg_type(corrector, node)
           else
-            lambda do |corrector|
-              variable_name = if node.optarg_type?
-                                node.node_parts[0]
-                              else
-                                # Extract only a var name without splat (`*`)
-                                node.source.gsub(/\A\*+/, '')
-                              end
-              corrector.replace(node.loc.name, "_#{variable_name}")
-            end
+            variable_name = if node.optarg_type?
+                              node.node_parts[0]
+                            else
+                              # Extract only a var name without splat (`*`)
+                              node.source.gsub(/\A\*+/, '')
+                            end
+
+            corrector.replace(node.loc.name, "_#{variable_name}")
           end
         end
 
-        def correct_for_blockarg_type(node)
-          lambda do |corrector|
-            range = range_with_surrounding_space(range: node.source_range,
-                                                 side: :left)
-            range = range_with_surrounding_comma(range, :left)
-            corrector.remove(range)
-          end
+        def correct_for_blockarg_type(corrector, node)
+          range = range_with_surrounding_space(range: node.source_range, side: :left)
+          range = range_with_surrounding_comma(range, :left)
+
+          corrector.remove(range)
         end
       end
     end

data/lib/rubocop/cop/documentation.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # Helpers for builtin documentation
+    module Documentation
+      module_function
+
+      # @api private
+      def department_to_basename(department)
+        "cops_#{department.downcase}"
+      end
+
+      # @api private
+      def url_for(cop_class)
+        base = department_to_basename(cop_class.department)
+        fragment = cop_class.cop_name.downcase.gsub(/[^a-z]/, '')
+        "https://docs.rubocop.org/rubocop/#{base}.html##{fragment}"
+      end
+    end
+  end
+end

data/lib/rubocop/cop/force.rb

@@ -11,6 +11,7 @@ module RuboCop
       end
 
       def self.inherited(subclass)
+        super
         all << subclass
       end
 

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

@@ -3,8 +3,8 @@
 module RuboCop
   module Cop
     module Gemspec
-      # Checks that `required_ruby_version` of gemspec and `TargetRubyVersion`
-      # of .rubocop.yml are equal.
+      # Checks that `required_ruby_version` of gemspec is specified and
+      # equal to `TargetRubyVersion` of .rubocop.yml.
       # Thereby, RuboCop to perform static analysis working on the version
       # required by gemspec.
       #
@@ -13,6 +13,11 @@ module RuboCop
       #
       #   # bad
       #   Gem::Specification.new do |spec|
+      #     # no `required_ruby_version` specified
+      #   end
+      #
+      #   # bad
+      #   Gem::Specification.new do |spec|
       #     spec.required_ruby_version = '>= 2.4.0'
       #   end
       #
@@ -35,18 +40,35 @@ module RuboCop
       #   Gem::Specification.new do |spec|
       #     spec.required_ruby_version = ['>= 2.5.0', '< 2.7.0']
       #   end
+      #
+      #   # good
+      #   Gem::Specification.new do |spec|
+      #     spec.required_ruby_version = '~> 2.5'
+      #   end
       class RequiredRubyVersion < Cop
-        MSG = '`required_ruby_version` (%<required_ruby_version>s, ' \
-              'declared in %<gemspec_filename>s) and `TargetRubyVersion` ' \
-              '(%<target_ruby_version>s, which may be specified in ' \
-              '.rubocop.yml) should be equal.'
+        include RangeHelp
+
+        NOT_EQUAL_MSG = '`required_ruby_version` (%<required_ruby_version>s, ' \
+                        'declared in %<gemspec_filename>s) and `TargetRubyVersion` ' \
+                        '(%<target_ruby_version>s, which may be specified in ' \
+                        '.rubocop.yml) should be equal.'
+        MISSING_MSG = '`required_ruby_version` should be specified.'
 
         def_node_search :required_ruby_version, <<~PATTERN
-          (send _ :required_ruby_version= ${(str _) (array (str _))})
+          (send _ :required_ruby_version= $_)
+        PATTERN
+
+        def_node_matcher :string_version?, <<~PATTERN
+          {(str _) (array (str _))}
         PATTERN
 
+        # rubocop:disable Metrics/AbcSize
         def investigate(processed_source)
-          required_ruby_version(processed_source.ast) do |version|
+          version = required_ruby_version(processed_source.ast).first
+
+          if version
+            return unless string_version?(version)
+
             ruby_version = extract_ruby_version(version)
 
             return if ruby_version == target_ruby_version.to_s
@@ -54,10 +76,14 @@ module RuboCop
             add_offense(
               processed_source.ast,
               location: version.loc.expression,
-              message: message(ruby_version, target_ruby_version)
+              message: not_equal_message(ruby_version, target_ruby_version)
             )
+          else
+            range = source_range(processed_source.buffer, 1, 0)
+            add_offense(nil, location: range, message: MISSING_MSG)
           end
         end
+        # rubocop:enable Metrics/AbcSize
 
         private
 
@@ -68,12 +94,12 @@ module RuboCop
             end
           end
 
-          required_ruby_version.str_content.match(/(\d\.\d)/)[1]
+          required_ruby_version.str_content.scan(/\d/).first(2).join('.')
         end
 
-        def message(required_ruby_version, target_ruby_version)
+        def not_equal_message(required_ruby_version, target_ruby_version)
           format(
-            MSG,
+            NOT_EQUAL_MSG,
             required_ruby_version: required_ruby_version,
             gemspec_filename: File.basename(processed_source.file_path),
             target_ruby_version: target_ruby_version