rubocop 0.72.0 → 0.73.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eba7ed97b0ff87530eaaac338ed31f332f89dd4c86ca8afc3046d8141d3f1c03
-  data.tar.gz: 23a2c2e2c59efb26294495c94b33e1849feef60b8afe26e98064ff01e98cbccf
+  metadata.gz: 65d141c7453c4d515c8e6a54e88cbc82305193f9fdd078148939550973c06eef
+  data.tar.gz: 78246e2ffa87ef9a0206e73227f323bfd9d1fdf97f565660c12f52854d2e75f0
 SHA512:
-  metadata.gz: 72a13a6ca2580bc1613ee8cb5a2432f564fb6f53f68558bd716046d4f5c28b73a57535d9eb4c96542f9cbaa5f29ee1226ec71e1b66a342ac4810106b69f3ef5d
-  data.tar.gz: aa480f20807bf7d31c878eeade72cf09a4963174b7490738f77cc8a8cf5a59b2a40b2f20dbc969719863aed1c672136ef32b7173f5d231c3f387dc25a62f77ac
+  metadata.gz: 48f6c20451589a69ebf28b1dacb70193d9baa0b6a5c6a5f2c065c00df2a7df284575705ac65027f4884b0673d1b62babf862ad2c9bdb461f909c4b38cb15a138
+  data.tar.gz: ea5877d8c872db2adf5f45e6613d01881227b7a22394c8e661fb41e78b5a9d75fb2662471a1876f287718092120ef2953105f27392c2a741273f9dd131544b29

data/README.md

@@ -52,7 +52,7 @@ haven't reached version 1.0 yet). To prevent an unwanted RuboCop update you
 might want to use a conservative version lock in your `Gemfile`:
 
 ```rb
-gem 'rubocop', '~> 0.72.0', require: false
+gem 'rubocop', '~> 0.73.0', require: false
 ```
 
 ## Quickstart

data/config/default.yml

@@ -816,6 +816,8 @@ Layout/LeadingCommentSpace:
   StyleGuide: '#hash-space'
   Enabled: true
   VersionAdded: '0.49'
+  VersionChanged: '0.73'
+  AllowDoxygenCommentStyle: false
 
 Layout/MultilineArrayBraceLayout:
   Description: >-
@@ -2555,6 +2557,11 @@ Style/DocumentationMethod:
     - 'test/**/*'
   RequireForNonPublicMethods: false
 
+Style/DoubleCopDisableDirective:
+  Description: 'Checks for double rubocop:disable comments on a single line.'
+  Enabled: true
+  VersionAdded: '0.73'
+
 Style/DoubleNegation:
   Description: 'Checks for uses of double negation (!!).'
   StyleGuide: '#no-bang-bang'
@@ -3041,6 +3048,12 @@ Style/MultilineTernaryOperator:
   Enabled: true
   VersionAdded: '0.9'
 
+Style/MultilineWhenThen:
+  Description: 'Do not use then for multi-line when statement.'
+  StyleGuide: '#no-then'
+  Enabled: true
+  VersionAdded: '0.72'
+
 Style/MultipleComparison:
   Description: >-
                  Avoid comparing a variable with multiple items in a conditional,

data/lib/rubocop.rb

@@ -414,6 +414,7 @@ require_relative 'rubocop/cop/style/def_with_parentheses'
 require_relative 'rubocop/cop/style/dir'
 require_relative 'rubocop/cop/style/documentation_method'
 require_relative 'rubocop/cop/style/documentation'
+require_relative 'rubocop/cop/style/double_cop_disable_directive'
 require_relative 'rubocop/cop/style/double_negation'
 require_relative 'rubocop/cop/style/each_for_simple_loop'
 require_relative 'rubocop/cop/style/each_with_object'
@@ -466,6 +467,7 @@ require_relative 'rubocop/cop/style/multiline_if_modifier'
 require_relative 'rubocop/cop/style/multiline_method_signature'
 require_relative 'rubocop/cop/style/multiline_memoization'
 require_relative 'rubocop/cop/style/multiline_ternary_operator'
+require_relative 'rubocop/cop/style/multiline_when_then'
 require_relative 'rubocop/cop/style/multiple_comparison'
 require_relative 'rubocop/cop/style/mutable_constant'
 require_relative 'rubocop/cop/style/negated_if'

data/lib/rubocop/ast/node.rb

@@ -302,7 +302,7 @@ module RuboCop
 
       ## Destructuring
 
-      def_node_matcher :receiver, <<-PATTERN
+      def_node_matcher :receiver, <<~PATTERN
         {(send $_ ...) (block (send $_ ...) ...)}
       PATTERN
 
@@ -321,7 +321,7 @@ module RuboCop
         end
       end
 
-      def_node_matcher :defined_module0, <<-PATTERN
+      def_node_matcher :defined_module0, <<~PATTERN
         {(class (const $_ $_) ...)
          (module (const $_ $_) ...)
          (casgn $_ $_        (send (const nil? {:Class :Module}) :new ...))
@@ -367,7 +367,7 @@ module RuboCop
       end
 
       # Some cops treat the shovel operator as a kind of assignment.
-      def_node_matcher :assignment_or_similar?, <<-PATTERN
+      def_node_matcher :assignment_or_similar?, <<~PATTERN
         {assignment? (send _recv :<< ...)}
       PATTERN
 
@@ -479,11 +479,11 @@ module RuboCop
         irange_type? || erange_type?
       end
 
-      def_node_matcher :guard_clause?, <<-PATTERN
+      def_node_matcher :guard_clause?, <<~PATTERN
         [{(send nil? {:raise :fail} ...) return break next} single_line?]
       PATTERN
 
-      def_node_matcher :proc?, <<-PATTERN
+      def_node_matcher :proc?, <<~PATTERN
         {(block (send nil? :proc) ...)
          (block (send (const nil? :Proc) :new) ...)
          (send (const nil? :Proc) :new)}
@@ -492,12 +492,12 @@ module RuboCop
       def_node_matcher :lambda?, '(block (send nil? :lambda) ...)'
       def_node_matcher :lambda_or_proc?, '{lambda? proc?}'
 
-      def_node_matcher :class_constructor?, <<-PATTERN
+      def_node_matcher :class_constructor?, <<~PATTERN
         {       (send (const nil? {:Class :Module}) :new ...)
          (block (send (const nil? {:Class :Module}) :new ...) ...)}
       PATTERN
 
-      def_node_matcher :module_definition?, <<-PATTERN
+      def_node_matcher :module_definition?, <<~PATTERN
         {class module (casgn _ _ class_constructor?)}
       PATTERN
 
@@ -638,7 +638,7 @@ module RuboCop
         end
       end
 
-      def_node_matcher :new_class_or_module_block?, <<-PATTERN
+      def_node_matcher :new_class_or_module_block?, <<~PATTERN
         ^(casgn _ _ (block (send (const _ {:Class :Module}) :new) ...))
       PATTERN
     end

data/lib/rubocop/ast/node/mixin/method_dispatch_node.rb

@@ -220,13 +220,24 @@ module RuboCop
 
       private
 
-      def_node_matcher :macro_scope?, <<-PATTERN
+      def_node_matcher :macro_scope?, <<~PATTERN
         {^{({sclass class module block} ...) class_constructor?}
-         ^^{({sclass class module block} ... ({begin if} ...)) class_constructor?}
+         ^^#ascend_macro_scope?
          ^#macro_kwbegin_wrapper?
          #root_node?}
       PATTERN
 
+      def_node_matcher :wrapped_macro_scope?, <<~PATTERN
+        {({sclass class module block} ... ({begin if} ...)) class_constructor?}
+      PATTERN
+
+      def ascend_macro_scope?(ancestor)
+        return true if wrapped_macro_scope?(ancestor)
+        return false if root_node?(ancestor)
+
+        ascend_macro_scope?(ancestor.parent)
+      end
+
       # Check if a node's parent is a kwbegin wrapper within a macro scope
       #
       # @param parent [Node] parent of the node being checked
@@ -245,15 +256,15 @@ module RuboCop
         node.parent.nil?
       end
 
-      def_node_matcher :adjacent_def_modifier?, <<-PATTERN
+      def_node_matcher :adjacent_def_modifier?, <<~PATTERN
         (send nil? _ ({def defs} ...))
       PATTERN
 
-      def_node_matcher :bare_access_modifier_declaration?, <<-PATTERN
+      def_node_matcher :bare_access_modifier_declaration?, <<~PATTERN
         (send nil? {:public :protected :private :module_function})
       PATTERN
 
-      def_node_matcher :non_bare_access_modifier_declaration?, <<-PATTERN
+      def_node_matcher :non_bare_access_modifier_declaration?, <<~PATTERN
         (send nil? {:public :protected :private :module_function} _)
       PATTERN
     end

data/lib/rubocop/ast/traversal.rb

@@ -35,7 +35,7 @@ module RuboCop
       end
 
       ONE_CHILD_NODE.each do |type|
-        module_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+        module_eval(<<~RUBY, __FILE__, __LINE__ + 1)
           def on_#{type}(node)
             if (child = node.children[0])
               send(:"on_\#{child.type}", child)
@@ -45,7 +45,7 @@ module RuboCop
       end
 
       MANY_CHILD_NODES.each do |type|
-        module_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+        module_eval(<<~RUBY, __FILE__, __LINE__ + 1)
           def on_#{type}(node)
             node.children.each { |child| send(:"on_\#{child.type}", child) }
             nil
@@ -55,7 +55,7 @@ module RuboCop
 
       SECOND_CHILD_ONLY.each do |type|
         # Guard clause is for nodes nested within mlhs
-        module_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+        module_eval(<<~RUBY, __FILE__, __LINE__ + 1)
           def on_#{type}(node)
             if (child = node.children[1])
               send(:"on_\#{child.type}", child)

data/lib/rubocop/cop/autocorrect_logic.rb

@@ -5,17 +5,25 @@ module RuboCop
     # This module encapsulates the logic for autocorrect behavior for a cop.
     module AutocorrectLogic
       def autocorrect?
-        autocorrect_requested? && support_autocorrect? && autocorrect_enabled?
+        autocorrect_requested? && correctable? && autocorrect_enabled?
       end
 
       def autocorrect_requested?
         @options.fetch(:auto_correct, false)
       end
 
+      def correctable?
+        support_autocorrect? || disable_uncorrectable?
+      end
+
       def support_autocorrect?
         respond_to?(:autocorrect)
       end
 
+      def disable_uncorrectable?
+        @options[:disable_uncorrectable] == true
+      end
+
       def autocorrect_enabled?
         # allow turning off autocorrect on a cop by cop basis
         return true unless cop_config
@@ -28,6 +36,68 @@ module RuboCop
 
         true
       end
+
+      def disable_offense(node)
+        range = node.location.expression
+        eol_comment = " # rubocop:disable #{cop_name}"
+        needed_line_length = range.column +
+                             (range.source_line + eol_comment).length
+        if needed_line_length <= max_line_length
+          disable_offense_at_end_of_line(range_of_first_line(range),
+                                         eol_comment)
+        else
+          disable_offense_before_and_after(range_by_lines(range))
+        end
+      end
+
+      private
+
+      def range_of_first_line(range)
+        begin_of_first_line = range.begin_pos - range.column
+        end_of_first_line = begin_of_first_line + range.source_line.length
+
+        Parser::Source::Range.new(range.source_buffer,
+                                  begin_of_first_line,
+                                  end_of_first_line)
+      end
+
+      # Expand the given range to include all of any lines it covers. Does not
+      # include newline at end of the last line.
+      def range_by_lines(range)
+        begin_of_first_line = range.begin_pos - range.column
+
+        last_line = range.source_buffer.source_line(range.last_line)
+        last_line_offset = last_line.length - range.last_column
+        end_of_last_line = range.end_pos + last_line_offset
+
+        Parser::Source::Range.new(range.source_buffer,
+                                  begin_of_first_line,
+                                  end_of_last_line)
+      end
+
+      def max_line_length
+        config.for_cop('Metrics/LineLength')['Max'] || 80
+      end
+
+      def disable_offense_at_end_of_line(range, eol_comment)
+        ->(corrector) { corrector.insert_after(range, eol_comment) }
+      end
+
+      def disable_offense_before_and_after(range_by_lines)
+        lambda do |corrector|
+          range_with_newline = range_by_lines.resize(range_by_lines.size + 1)
+          leading_whitespace = range_by_lines.source_line[/^\s*/]
+
+          corrector.insert_before(
+            range_with_newline,
+            "#{leading_whitespace}# rubocop:disable #{cop_name}\n"
+          )
+          corrector.insert_after(
+            range_with_newline,
+            "#{leading_whitespace}# rubocop:enable #{cop_name}\n"
+          )
+        end
+      end
     end
   end
 end

data/lib/rubocop/cop/bundler/insecure_protocol_source.rb

@@ -33,7 +33,7 @@ module RuboCop
               "Please change your source to 'https://rubygems.org' " \
               "if possible, or 'http://rubygems.org' if not."
 
-        def_node_matcher :insecure_protocol_source?, <<-PATTERN
+        def_node_matcher :insecure_protocol_source?, <<~PATTERN
           (send nil? :source
             (sym ${:gemcutter :rubygems :rubyforge}))
         PATTERN

data/lib/rubocop/cop/bundler/ordered_gems.rb

@@ -64,7 +64,7 @@ module RuboCop
           declarations.to_a[node_index - 1]
         end
 
-        def_node_search :gem_declarations, <<-PATTERN
+        def_node_search :gem_declarations, <<~PATTERN
           (:send nil? :gem str ...)
         PATTERN
       end

data/lib/rubocop/cop/commissioner.rb

@@ -7,8 +7,6 @@ module RuboCop
     class Commissioner
       include RuboCop::AST::Traversal
 
-      CopError = Struct.new(:error, :line, :column)
-
       attr_reader :errors
 
       def initialize(cops, forces = [], options = {})
@@ -62,7 +60,7 @@ module RuboCop
       end
 
       def reset_errors
-        @errors = Hash.new { |hash, k| hash[k] = [] }
+        @errors = []
       end
 
       def remove_irrelevant_cops(filename)
@@ -131,12 +129,8 @@ module RuboCop
       rescue StandardError => e
         raise e if @options[:raise_error]
 
-        if node
-          line = node.first_line
-          column = node.loc.column
-        end
-        error = CopError.new(e, line, column)
-        @errors[cop] << error
+        err = ErrorWithAnalyzedFileLocation.new(cause: e, node: node, cop: cop)
+        @errors << err
       end
     end
   end

data/lib/rubocop/cop/cop.rb

@@ -31,6 +31,16 @@ module RuboCop
       include IgnoredNode
       include AutocorrectLogic
 
+      Correction = Struct.new(:lambda, :node, :cop) do
+        def call(corrector)
+          lambda.call(corrector)
+        rescue StandardError => e
+          raise ErrorWithAnalyzedFileLocation.new(
+            cause: e, node: node, cop: cop
+          )
+        end
+      end
+
       attr_reader :config, :offenses, :corrections
       attr_accessor :processed_source # TODO: Bad design.
 
@@ -141,18 +151,38 @@ module RuboCop
       end
 
       def correct(node)
-        return :unsupported unless support_autocorrect?
-        return :uncorrected unless autocorrect?
-        return :already_corrected if @corrected_nodes.key?(node)
+        reason = reason_to_not_correct(node)
+        return reason if reason
 
         @corrected_nodes[node] = true
-        correction = autocorrect(node)
-        return :uncorrected unless correction
+        if support_autocorrect?
+          correction = autocorrect(node)
+          return :uncorrected unless correction
 
-        @corrections << correction
+          @corrections << Correction.new(correction, node, self)
+        elsif disable_uncorrectable?
+          disable_uncorrectable(node)
+        end
         :corrected
       end
 
+      def reason_to_not_correct(node)
+        return :unsupported unless correctable?
+        return :uncorrected unless autocorrect?
+        return :already_corrected if @corrected_nodes.key?(node)
+
+        nil
+      end
+
+      def disable_uncorrectable(node)
+        @disabled_lines ||= {}
+        line = node.location.line
+        return if @disabled_lines.key?(line)
+
+        @disabled_lines[line] = true
+        @corrections << Correction.new(disable_offense(node), node, self)
+      end
+
       def config_to_allow_offenses
         Formatter::DisabledConfigFormatter
           .config_to_allow_offenses[cop_name] ||= {}

data/lib/rubocop/cop/corrector.rb

@@ -57,16 +57,15 @@ module RuboCop
       #
       # @return [String]
       def rewrite
-        # rubocop:disable Lint/HandleExceptions
         @corrections.each do |correction|
           begin
             @source_rewriter.transaction do
               correction.call(self)
             end
-          rescue ::Parser::ClobberingError
+          rescue ErrorWithAnalyzedFileLocation => e
+            raise e unless e.cause.is_a?(::Parser::ClobberingError)
           end
         end
-        # rubocop:enable Lint/HandleExceptions
 
         @source_rewriter.process
       end

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

@@ -9,9 +9,9 @@ module RuboCop
           offense_style, range = node
           lambda do |corrector|
             case offense_style
-            when :no_empty_lines then
+            when :no_empty_lines
               corrector.remove(range)
-            when :empty_lines then
+            when :empty_lines
               corrector.insert_before(range, "\n")
             end
           end