rubocop 0.72.0 → 0.73.0

data/lib/rubocop/cop/style/parentheses_around_condition.rb

@@ -60,7 +60,7 @@ module RuboCop
 
         private
 
-        def_node_matcher :control_op_condition, <<-PATTERN
+        def_node_matcher :control_op_condition, <<~PATTERN
           (begin $_ ...)
         PATTERN
 

data/lib/rubocop/cop/style/random_with_offset.rb

@@ -27,7 +27,7 @@ module RuboCop
         MSG = 'Prefer ranges when generating random numbers instead of ' \
           'integers with offsets.'
 
-        def_node_matcher :integer_op_rand?, <<-PATTERN
+        def_node_matcher :integer_op_rand?, <<~PATTERN
           (send
             int {:+ :-}
             (send
@@ -36,7 +36,7 @@ module RuboCop
               {int irange erange}))
         PATTERN
 
-        def_node_matcher :rand_op_integer?, <<-PATTERN
+        def_node_matcher :rand_op_integer?, <<~PATTERN
           (send
             (send
               {nil? (const nil? :Random) (const nil? :Kernel)}
@@ -46,7 +46,7 @@ module RuboCop
             int)
         PATTERN
 
-        def_node_matcher :rand_modified?, <<-PATTERN
+        def_node_matcher :rand_modified?, <<~PATTERN
           (send
             (send
               {nil? (const nil? :Random) (const nil? :Kernel)}
@@ -80,7 +80,7 @@ module RuboCop
 
         private
 
-        def_node_matcher :random_call, <<-PATTERN
+        def_node_matcher :random_call, <<~PATTERN
           {(send (send $_ _ $_) ...)
            (send _ _ (send $_ _ $_))}
         PATTERN
@@ -128,7 +128,7 @@ module RuboCop
           end
         end
 
-        def_node_matcher :namespace, <<-PATTERN
+        def_node_matcher :namespace, <<~PATTERN
           {$nil? (const nil? $_)}
         PATTERN
 
@@ -149,7 +149,7 @@ module RuboCop
           end
         end
 
-        def_node_matcher :to_int, <<-PATTERN
+        def_node_matcher :to_int, <<~PATTERN
           (int $_)
         PATTERN
       end

data/lib/rubocop/cop/style/redundant_conditional.rb

@@ -53,11 +53,11 @@ module RuboCop
           format(MSG, msg: msg)
         end
 
-        def_node_matcher :redundant_condition?, <<-RUBY
+        def_node_matcher :redundant_condition?, <<~RUBY
           (if (send _ {:#{COMPARISON_OPERATORS.join(' :')}} _) true false)
         RUBY
 
-        def_node_matcher :redundant_condition_inverted?, <<-RUBY
+        def_node_matcher :redundant_condition_inverted?, <<~RUBY
           (if (send _ {:#{COMPARISON_OPERATORS.join(' :')}} _) false true)
         RUBY
 

data/lib/rubocop/cop/style/redundant_exception.rb

@@ -47,11 +47,11 @@ module RuboCop
           end
         end
 
-        def_node_matcher :exploded?, <<-PATTERN
+        def_node_matcher :exploded?, <<~PATTERN
           (send nil? ${:raise :fail} (const nil? :RuntimeError) $_)
         PATTERN
 
-        def_node_matcher :compact?, <<-PATTERN
+        def_node_matcher :compact?, <<~PATTERN
           (send nil? {:raise :fail} $(send (const nil? :RuntimeError) :new $_))
         PATTERN
       end

data/lib/rubocop/cop/style/redundant_freeze.rb

@@ -51,7 +51,7 @@ module RuboCop
           end
         end
 
-        def_node_matcher :operation_produces_immutable_object?, <<-PATTERN
+        def_node_matcher :operation_produces_immutable_object?, <<~PATTERN
           {
             (begin (send {float int} {:+ :- :* :** :/ :% :<<} _))
             (begin (send !(str _) {:+ :- :* :** :/ :%} {float int}))

data/lib/rubocop/cop/style/redundant_parentheses.rb

@@ -203,11 +203,11 @@ module RuboCop
           first_send_argument?(node) || first_super_argument?(node)
         end
 
-        def_node_matcher :first_send_argument?, <<-PATTERN
+        def_node_matcher :first_send_argument?, <<~PATTERN
           ^(send _ _ equal?(%0) ...)
         PATTERN
 
-        def_node_matcher :first_super_argument?, <<-PATTERN
+        def_node_matcher :first_super_argument?, <<~PATTERN
           ^(super equal?(%0) ...)
         PATTERN
 

data/lib/rubocop/cop/style/redundant_sort_by.rb

@@ -20,7 +20,7 @@ module RuboCop
 
         MSG = 'Use `sort` instead of `sort_by { |%<var>s| %<var>s }`.'
 
-        def_node_matcher :redundant_sort_by, <<-PATTERN
+        def_node_matcher :redundant_sort_by, <<~PATTERN
           (block $(send _ :sort_by) (args (arg $_x)) (lvar _x))
         PATTERN
 

data/lib/rubocop/cop/style/rescue_standard_error.rb

@@ -80,11 +80,11 @@ module RuboCop
         MSG_EXPLICIT = 'Avoid rescuing without specifying ' \
           'an error class.'
 
-        def_node_matcher :rescue_without_error_class?, <<-PATTERN
+        def_node_matcher :rescue_without_error_class?, <<~PATTERN
           (resbody nil? _ _)
         PATTERN
 
-        def_node_matcher :rescue_standard_error?, <<-PATTERN
+        def_node_matcher :rescue_standard_error?, <<~PATTERN
           (resbody $(array (const nil? :StandardError)) _ _)
         PATTERN
 

data/lib/rubocop/cop/style/return_nil.rb

@@ -80,7 +80,7 @@ module RuboCop
         end
 
         def_node_matcher :chained_send?, '(send !nil? ...)'
-        def_node_matcher :define_method?, <<-PATTERN
+        def_node_matcher :define_method?, <<~PATTERN
           (send _ {:define_method :define_singleton_method} _)
         PATTERN
       end

data/lib/rubocop/cop/style/safe_navigation.rb

@@ -69,7 +69,7 @@ module RuboCop
 
         # if format: (if checked_variable body nil)
         # unless format: (if checked_variable nil body)
-        def_node_matcher :modifier_if_safe_navigation_candidate, <<-PATTERN
+        def_node_matcher :modifier_if_safe_navigation_candidate, <<~PATTERN
           {
             (if {
                   (send $_ {:nil? :!})

data/lib/rubocop/cop/style/sample.rb

@@ -30,7 +30,7 @@ module RuboCop
       class Sample < Cop
         MSG = 'Use `%<correct>s` instead of `%<incorrect>s`.'
 
-        def_node_matcher :sample_candidate?, <<-PATTERN
+        def_node_matcher :sample_candidate?, <<~PATTERN
           (send $(send _ :shuffle $...) ${:first :last :[] :at :slice} $...)
         PATTERN
 

data/lib/rubocop/cop/style/stderr_puts.rb

@@ -20,7 +20,7 @@ module RuboCop
         MSG =
           'Use `warn` instead of `%<bad>s` to allow such output to be disabled.'
 
-        def_node_matcher :stderr_puts?, <<-PATTERN
+        def_node_matcher :stderr_puts?, <<~PATTERN
           (send
             {(gvar #stderr_gvar?) (const nil? :STDERR)}
             :puts $_

data/lib/rubocop/cop/style/string_hash_keys.rb

@@ -15,11 +15,11 @@ module RuboCop
       class StringHashKeys < Cop
         MSG = 'Prefer symbols instead of strings as hash keys.'
 
-        def_node_matcher :string_hash_key?, <<-PATTERN
+        def_node_matcher :string_hash_key?, <<~PATTERN
           (pair (str _) _)
         PATTERN
 
-        def_node_matcher :receive_environments_method?, <<-PATTERN
+        def_node_matcher :receive_environments_method?, <<~PATTERN
           {
             ^^(send (const {nil? cbase} :IO) :popen ...)
             ^^(send (const {nil? cbase} :Open3)

data/lib/rubocop/cop/style/strip.rb

@@ -18,7 +18,7 @@ module RuboCop
 
         MSG = 'Use `strip` instead of `%<methods>s`.'
 
-        def_node_matcher :lstrip_rstrip, <<-PATTERN
+        def_node_matcher :lstrip_rstrip, <<~PATTERN
           {(send $(send _ $:rstrip) $:lstrip)
            (send $(send _ $:lstrip) $:rstrip)}
         PATTERN

data/lib/rubocop/cop/style/struct_inheritance.rb

@@ -29,9 +29,9 @@ module RuboCop
           add_offense(node, location: node.parent_class.source_range)
         end
 
-        def_node_matcher :struct_constructor?, <<-PATTERN
-           {(send (const nil? :Struct) :new ...)
-            (block (send (const nil? :Struct) :new ...) ...)}
+        def_node_matcher :struct_constructor?, <<~PATTERN
+          {(send (const nil? :Struct) :new ...)
+           (block (send (const nil? :Struct) :new ...) ...)}
         PATTERN
       end
     end

data/lib/rubocop/cop/style/symbol_proc.rb

@@ -20,7 +20,7 @@ module RuboCop
         SUPER_TYPES = %i[super zsuper].freeze
 
         def_node_matcher :proc_node?, '(send (const nil? :Proc) :new)'
-        def_node_matcher :symbol_proc?, <<-PATTERN
+        def_node_matcher :symbol_proc?, <<~PATTERN
           (block
             ${(send ...) (super ...) zsuper}
             $(args (arg _var))

data/lib/rubocop/cop/style/ternary_parentheses.rb

@@ -167,7 +167,7 @@ module RuboCop
             (child.send_type? && child.prefix_not?)
         end
 
-        def_node_matcher :method_name, <<-PATTERN
+        def_node_matcher :method_name, <<~PATTERN
           {($:defined? (send nil? _) ...)
            (send {_ nil?} $_ _ ...)}
         PATTERN

data/lib/rubocop/cop/style/trivial_accessors.rb

@@ -118,7 +118,7 @@ module RuboCop
             !allowed_method?(node) && !allowed_writer?(node.method_name)
         end
 
-        def_node_matcher :looks_like_trivial_writer?, <<-PATTERN
+        def_node_matcher :looks_like_trivial_writer?, <<~PATTERN
           {(def    _ (args (arg ...)) (ivasgn _ (lvar _)))
            (defs _ _ (args (arg ...)) (ivasgn _ (lvar _)))}
         PATTERN

data/lib/rubocop/cop/style/unneeded_sort.rb

@@ -55,7 +55,7 @@ module RuboCop
         MSG = 'Use `%<suggestion>s` instead of '\
               '`%<sorter>s...%<accessor_source>s`.'
 
-        def_node_matcher :unneeded_sort?, <<-MATCHER
+        def_node_matcher :unneeded_sort?, <<~MATCHER
           {
             (send $(send _ $:sort ...) ${:last :first})
             (send $(send _ $:sort ...) ${:[] :at :slice} {(int 0) (int -1)})

data/lib/rubocop/cop/style/unpack_first.rb

@@ -25,7 +25,7 @@ module RuboCop
         MSG = 'Use `%<receiver>s.unpack1(%<format>s)` instead of '\
           '`%<receiver>s.unpack(%<format>s)%<method>s`.'
 
-        def_node_matcher :unpack_and_first_element?, <<-PATTERN
+        def_node_matcher :unpack_and_first_element?, <<~PATTERN
           {
             (send $(send (...) :unpack $(...)) :first)
             (send $(send (...) :unpack $(...)) {:[] :slice :at} (int 0))

data/lib/rubocop/cop/style/zero_length_predicate.rb

@@ -73,14 +73,14 @@ module RuboCop
           )
         end
 
-        def_node_matcher :zero_length_predicate, <<-PATTERN
+        def_node_matcher :zero_length_predicate, <<~PATTERN
           {(send (send (...) ${:length :size}) $:== (int $0))
            (send (int $0) $:== (send (...) ${:length :size}))
            (send (send (...) ${:length :size}) $:<  (int $1))
            (send (int $1) $:> (send (...) ${:length :size}))}
         PATTERN
 
-        def_node_matcher :nonzero_length_predicate, <<-PATTERN
+        def_node_matcher :nonzero_length_predicate, <<~PATTERN
           {(send (send (...) ${:length :size}) ${:> :!=} (int $0))
            (send (int $0) ${:< :!=} (send (...) ${:length :size}))}
         PATTERN
@@ -92,14 +92,14 @@ module RuboCop
           "!#{other_receiver(node).source}.empty?"
         end
 
-        def_node_matcher :zero_length_receiver, <<-PATTERN
+        def_node_matcher :zero_length_receiver, <<~PATTERN
           {(send (send $_ _) :== (int 0))
            (send (int 0) :== (send $_ _))
            (send (send $_ _) :<  (int 1))
            (send (int 1) :> (send $_ _))}
         PATTERN
 
-        def_node_matcher :other_receiver, <<-PATTERN
+        def_node_matcher :other_receiver, <<~PATTERN
           {(send (send $_ _) _ _)
            (send _ _ (send $_ _))}
         PATTERN
@@ -107,7 +107,7 @@ module RuboCop
         # Some collection like objects in the Ruby standard library
         # implement `#size`, but not `#empty`. We ignore those to
         # reduce false positives.
-        def_node_matcher :non_polymorphic_collection?, <<-PATTERN
+        def_node_matcher :non_polymorphic_collection?, <<~PATTERN
           {(send (send (send (const nil? :File) :stat _) ...) ...)
            (send (send (send (const nil? {:Tempfile :StringIO}) {:new :open} ...) ...) ...)}
         PATTERN

data/lib/rubocop/cop/team.rb

@@ -81,6 +81,9 @@ module RuboCop
           File.open(filename, 'w') { |f| f.write(new_source) }
         end
         @updated_source_file = true
+      rescue RuboCop::ErrorWithAnalyzedFileLocation => e
+        process_errors(buffer.name, [e])
+        raise e.cause
       end
 
       private
@@ -103,8 +106,8 @@ module RuboCop
 
         other = investigate(other_cops, processed_source)
 
-        errors = autocorrect.errors.merge(other.errors)
-        process_commissioner_errors(processed_source.path, errors)
+        errors = [*autocorrect.errors, *other.errors]
+        process_errors(processed_source.path, errors)
 
         autocorrect.offenses.concat(other.offenses)
       end
@@ -149,19 +152,17 @@ module RuboCop
         end
       end
 
-      def process_commissioner_errors(file, file_errors)
-        file_errors.each do |cop, errors|
-          errors.each do |cop_error|
-            e = cop_error.error
-            line = ":#{cop_error.line}" if cop_error.line
-            column = ":#{cop_error.column}" if cop_error.column
-            location = "#{file}#{line}#{column}"
+      def process_errors(file, errors)
+        errors.each do |error|
+          line = ":#{error.line}" if error.line
+          column = ":#{error.column}" if error.column
+          location = "#{file}#{line}#{column}"
+          cause = error.cause
 
-            if e.is_a?(Warning)
-              handle_warning(e, location)
-            else
-              handle_error(e, location, cop)
-            end
+          if cause.is_a?(Warning)
+            handle_warning(cause, location)
+          else
+            handle_error(cause, location, error.cop)
           end
         end
       end

data/lib/rubocop/error.rb

@@ -8,4 +8,27 @@ module RuboCop
   class Error < StandardError; end
 
   class ValidationError < Error; end
+
+  # A wrapper to display errored location of analyzed file.
+  class ErrorWithAnalyzedFileLocation < Error
+    def initialize(cause:, node:, cop:)
+      @cause = cause
+      @cop = cop
+      @location = node.is_a?(RuboCop::AST::Node) ? node.loc : node
+    end
+
+    attr_reader :cause, :cop
+
+    def line
+      @location&.line
+    end
+
+    def column
+      @location&.column
+    end
+
+    def message
+      "cause: #{cause.inspect}"
+    end
+  end
 end

data/lib/rubocop/node_pattern.rb

@@ -612,7 +612,7 @@ module RuboCop
       end
 
       def emit_method_code
-        <<-RUBY
+        <<~RUBY
           return unless #{@match_code}
           block_given? ? #{emit_yield_capture} : (return #{emit_retval})
         RUBY
@@ -746,7 +746,7 @@ module RuboCop
 
       def node_search_body(method_name, trailing_params, prelude, match_code,
                            on_match)
-        <<-RUBY
+        <<~RUBY
           def #{method_name}(node0#{trailing_params})
             #{prelude}
             node0.each_node do |node|

data/lib/rubocop/options.rb

@@ -109,6 +109,8 @@ module RuboCop
         @validator.validate_exclude_limit_option
       end
 
+      option(opts, '--disable-uncorrectable')
+
       option(opts, '--no-offense-counts') do
         @options[:no_offense_counts] = true
       end
@@ -253,6 +255,7 @@ module RuboCop
       @options = options
     end
 
+    # rubocop:disable Metrics/AbcSize
     def validate_compatibility # rubocop:disable Metrics/MethodLength
       if only_includes_unneeded_disable?
         raise OptionArgumentError, 'Lint/UnneededCopDisableDirective can not ' \
@@ -270,6 +273,7 @@ module RuboCop
           '--display-only-fail-level-offenses'
       end
       validate_auto_gen_config
+      validate_auto_correct
       validate_parallel
 
       return if incompatible_options.size <= 1
@@ -277,6 +281,7 @@ module RuboCop
       raise OptionArgumentError, 'Incompatible cli options: ' \
                                  "#{incompatible_options.inspect}"
     end
+    # rubocop:enable Metrics/AbcSize
 
     def validate_auto_gen_config
       return if @options.key?(:auto_gen_config)
@@ -292,6 +297,15 @@ module RuboCop
       end
     end
 
+    def validate_auto_correct
+      return if @options.key?(:auto_correct)
+      return unless @options.key?(:disable_uncorrectable)
+
+      raise OptionArgumentError,
+            format('--%<flag>s can only be used together with --auto-correct.',
+                   flag: '--disable-uncorrectable')
+    end
+
     def validate_parallel
       return unless @options.key?(:parallel)
 
@@ -378,6 +392,9 @@ module RuboCop
       exclude_limit:                    ['Used together with --auto-gen-config to',
                                          'set the limit for how many Exclude',
                                          "properties to generate. Default is #{MAX_EXCL}."],
+      disable_uncorrectable:            ['Used with --auto-correct to annotate any',
+                                         'offenses that do not support autocorrect',
+                                         'with `rubocop:disable` comments.'],
       force_exclusion:                  ['Force excluding files specified in the',
                                          'configuration `Exclude` even if they are',
                                          'explicitly passed as arguments.'],