rubocop 0.70.0 → 0.75.0

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

@@ -8,6 +8,11 @@ module RuboCop
       # parentheses using `EnforcedStyle`. Omission is only enforced when
       # removing the parentheses won't cause a different behavior.
       #
+      # `AllowSafeAssignment` option for safe assignment.
+      # By safe assignment we mean putting parentheses around
+      # an assignment to indicate "I know I'm using an assignment
+      # as a condition. It's not a mistake."
+      #
       # @example EnforcedStyle: require_no_parentheses (default)
       #   # bad
       #   foo = (bar?) ? a : b
@@ -40,6 +45,15 @@ module RuboCop
       #   foo = bar? ? a : b
       #   foo = bar.baz? ? a : b
       #   foo = (bar && baz) ? a : b
+      #
+      # @example AllowSafeAssignment: true (default)
+      #   # good
+      #   foo = (bar = baz) ? a : b
+      #
+      # @example AllowSafeAssignment: false
+      #   # bad
+      #   foo = (bar = baz) ? a : b
+      #
       class TernaryParentheses < Cop
         include SafeAssignment
         include ConfigurableEnforcedStyle
@@ -53,11 +67,16 @@ module RuboCop
           ' complex conditions.'
 
         def on_if(node)
+          return if only_closing_parenthesis_is_last_line?(node.condition)
           return unless node.ternary? && !infinite_loop? && offense?(node)
 
           add_offense(node, location: node.source_range)
         end
 
+        def only_closing_parenthesis_is_last_line?(condition)
+          condition.source.split("\n").last == ')'
+        end
+
         def autocorrect(node)
           condition = node.condition
 
@@ -108,7 +127,7 @@ module RuboCop
         end
 
         def non_complex_send?(node)
-          return false unless node.send_type?
+          return false unless node.call_type?
 
           !node.operator_method? || node.method?(:[])
         end
@@ -149,7 +168,8 @@ module RuboCop
 
         def unsafe_autocorrect?(condition)
           condition.children.any? do |child|
-            unparenthesized_method_call?(child)
+            unparenthesized_method_call?(child) ||
+              below_ternary_precedence?(child)
           end
         end
 
@@ -157,7 +177,16 @@ module RuboCop
           method_name(child) =~ /^[a-z]/i && !child.parenthesized?
         end
 
-        def_node_matcher :method_name, <<-PATTERN
+        def below_ternary_precedence?(child)
+          # Handle English "or", e.g. 'foo or bar ? a : b'
+          (child.or_type? && child.semantic_operator?) ||
+            # Handle English "and", e.g. 'foo and bar ? a : b'
+            (child.and_type? && child.semantic_operator?) ||
+            # Handle English "not", e.g. 'not foo ? a : b'
+            (child.send_type? && child.prefix_not?)
+        end
+
+        def_node_matcher :method_name, <<~PATTERN
           {($:defined? (send nil? _) ...)
            (send {_ nil?} $_ _ ...)}
         PATTERN

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

@@ -65,6 +65,10 @@ module RuboCop
           PunctuationCorrector.swap_comma(range)
         end
 
+        def self.autocorrect_incompatible_with
+          [Layout::HeredocArgumentClosingParenthesis]
+        end
+
         private
 
         def avoid_autocorrect?(args)

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

@@ -42,7 +42,7 @@ module RuboCop
         def on_def(node)
           return unless trailing_end?(node)
 
-          add_offense(node.to_a.last, location: end_token(node).pos)
+          add_offense(node, location: end_token(node).pos)
         end
 
         def autocorrect(node)
@@ -61,7 +61,7 @@ module RuboCop
         end
 
         def end_token(node)
-          @end_token ||= tokens(node).reverse.find(&:end?)
+          tokens(node).reverse.find(&:end?)
         end
 
         def body_and_end_on_same_line?(node)
@@ -69,10 +69,8 @@ module RuboCop
         end
 
         def token_before_end(node)
-          @token_before_end ||= begin
-            i = tokens(node).index(end_token(node))
-            tokens(node)[i - 1]
-          end
+          i = tokens(node).index(end_token(node))
+          tokens(node)[i - 1]
         end
 
         def break_line_before_end(node, corrector)

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/variable_interpolation.rb

@@ -16,19 +16,15 @@ module RuboCop
       #   /check #{$pattern}/
       #   "Let's go to the #{@store}"
       class VariableInterpolation < Cop
+        include Interpolation
+
         MSG = 'Replace interpolated variable `%<variable>s` ' \
               'with expression `#{%<variable>s}`.'
 
-        def on_dstr(node)
-          check_for_interpolation(node)
-        end
-
-        def on_regexp(node)
-          check_for_interpolation(node)
-        end
-
-        def on_xstr(node)
-          check_for_interpolation(node)
+        def on_node_with_interpolations(node)
+          var_nodes(node.children).each do |var_node|
+            add_offense(var_node)
+          end
         end
 
         def autocorrect(node)
@@ -39,12 +35,6 @@ module RuboCop
 
         private
 
-        def check_for_interpolation(node)
-          var_nodes(node.children).each do |var_node|
-            add_offense(var_node)
-          end
-        end
-
         def message(node)
           format(MSG, variable: node.source)
         end

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

@@ -71,8 +71,8 @@ module RuboCop
 
         def complex_content?(strings)
           strings.any? do |s|
-            string = s.str_content
-            !string.dup.force_encoding(::Encoding::UTF_8).valid_encoding? ||
+            string = s.str_content.dup.force_encoding(::Encoding::UTF_8)
+            !string.valid_encoding? ||
               string !~ word_regex || string =~ / /
           end
         end

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

@@ -7,7 +7,7 @@ module RuboCop
       # by a predicate method, such as receiver.length == 0,
       # receiver.length > 0, receiver.length != 0,
       # receiver.length < 1 and receiver.size == 0 that can be
-      # replaced by receiver.empty? and !receiver.empty.
+      # replaced by receiver.empty? and !receiver.empty?.
       #
       # @example
       #   # bad
@@ -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/cop/utils/format_string.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Utils
+      # Parses {Kernel#sprintf} format strings.
+      class FormatString
+        DIGIT_DOLLAR  = /(\d+)\$/.freeze
+        FLAG          = /[ #0+-]|#{DIGIT_DOLLAR}/.freeze
+        NUMBER_ARG    = /\*#{DIGIT_DOLLAR}?/.freeze
+        NUMBER        = /\d+|#{NUMBER_ARG}/.freeze
+        WIDTH         = /(?<width>#{NUMBER})/.freeze
+        PRECISION     = /\.(?<precision>#{NUMBER})/.freeze
+        TYPE          = /(?<type>[bBdiouxXeEfgGaAcps])/.freeze
+        NAME          = /<(?<name>\w+)>/.freeze
+        TEMPLATE_NAME = /\{(?<name>\w+)\}/.freeze
+
+        SEQUENCE = /
+            % (?<type>%)
+          | % (?<flags>#{FLAG}*)
+            (?:
+              (?: #{WIDTH}? #{PRECISION}? #{NAME}?
+                | #{WIDTH}? #{NAME} #{PRECISION}?
+                | #{NAME} (?<more_flags>#{FLAG}*) #{WIDTH}? #{PRECISION}?
+              ) #{TYPE}
+              | #{WIDTH}? #{PRECISION}? #{TEMPLATE_NAME}
+            )
+        /x.freeze
+
+        # The syntax of a format sequence is as follows.
+        #
+        # ```
+        # %[flags][width][.precision]type
+        # ```
+        #
+        # A format sequence consists of a percent sign, followed by optional
+        # flags, width, and precision indicators, then terminated with a field
+        # type character.
+        #
+        # For more complex formatting, Ruby supports a reference by name.
+        #
+        # @see https://ruby-doc.org/core-2.6.3/Kernel.html#method-i-format
+        class FormatSequence
+          attr_reader :begin_pos, :end_pos
+          attr_reader :flags, :width, :precision, :name, :type
+
+          def initialize(string, **opts)
+            @source = string
+            @begin_pos = opts[:begin_pos]
+            @end_pos = opts[:end_pos]
+            @flags = opts[:flags]
+            @width = opts[:width]
+            @precision = opts[:precision]
+            @name = opts[:name]
+            @type = opts[:type]
+          end
+
+          def percent?
+            type == '%'
+          end
+
+          def annotated?
+            name && @source.include?('<')
+          end
+
+          def template?
+            name && @source.include?('{')
+          end
+
+          # Number of arguments required for the format sequence
+          def arity
+            @source.scan('*').count + 1
+          end
+
+          def max_digit_dollar_num
+            @source.scan(DIGIT_DOLLAR).map do |(digit_dollar_num)|
+              digit_dollar_num.to_i
+            end.max
+          end
+
+          def style
+            if annotated?
+              :annotated
+            elsif template?
+              :template
+            else
+              :unannotated
+            end
+          end
+        end
+
+        def initialize(string)
+          @source = string
+        end
+
+        def format_sequences
+          @format_sequences ||= parse
+        end
+
+        def named_interpolation?
+          format_sequences.any?(&:name)
+        end
+
+        def max_digit_dollar_num
+          format_sequences.map(&:max_digit_dollar_num).max
+        end
+
+        private
+
+        def parse
+          @source.to_enum(:scan, SEQUENCE).map do
+            match = Regexp.last_match
+            FormatSequence.new(
+              match[0],
+              begin_pos: match.begin(0),
+              end_pos: match.end(0),
+              flags: match[:flags].to_s + match[:more_flags].to_s,
+              width: match[:width],
+              precision: match[:precision],
+              name: match[:name],
+              type: match[:type]
+            )
+          end
+        end
+      end
+    end
+  end
+end