rubocop 0.66.0 → 1.25.1

data/lib/rubocop/cop/lint/erb_new_arguments.rb

@@ -59,8 +59,10 @@ module RuboCop
       #     ERB.new(str, nil, '-', '@output_buffer')
       #   end
       #
-      class ErbNewArguments < Cop
+      class ErbNewArguments < Base
+        include RangeHelp
         extend TargetRubyVersion
+        extend AutoCorrector
 
         minimum_target_ruby_version 2.6
 
@@ -76,30 +78,83 @@ module RuboCop
           '`ERB.new(str, eoutvar: %<arg_value>s)` instead.'
         ].freeze
 
-        def_node_matcher :erb_new_with_non_keyword_arguments, <<-PATTERN
+        RESTRICT_ON_SEND = %i[new].freeze
+
+        # @!method erb_new_with_non_keyword_arguments(node)
+        def_node_matcher :erb_new_with_non_keyword_arguments, <<~PATTERN
           (send
             (const {nil? cbase} :ERB) :new $...)
         PATTERN
 
         def on_send(node)
           erb_new_with_non_keyword_arguments(node) do |arguments|
-            return if correct_arguments?(arguments)
+            return if arguments.empty? || correct_arguments?(arguments)
 
-            1.upto(3) do |i|
-              next if !arguments[i] || arguments[i].hash_type?
+            arguments[1..3].each_with_index do |argument, i|
+              next if !argument || argument.hash_type?
 
-              message = format(MESSAGES[i - 1], arg_value: arguments[i].source)
+              message = format(MESSAGES[i], arg_value: argument.source)
 
               add_offense(
-                node, location: arguments[i].source_range, message: message
-              )
+                argument.source_range, message: message
+              ) do |corrector|
+                autocorrect(corrector, node)
+              end
             end
           end
         end
 
+        private
+
+        def autocorrect(corrector, node)
+          str_arg = node.arguments[0].source
+
+          kwargs = build_kwargs(node)
+          overridden_kwargs = override_by_legacy_args(kwargs, node)
+
+          good_arguments = [str_arg, overridden_kwargs].flatten.compact.join(', ')
+
+          corrector.replace(arguments_range(node), good_arguments)
+        end
+
         def correct_arguments?(arguments)
-          arguments.size == 1 ||
-            arguments.size == 2 && arguments[1].hash_type?
+          arguments.size == 1 || (arguments.size == 2 && arguments[1].hash_type?)
+        end
+
+        def build_kwargs(node)
+          return [nil, nil] unless node.arguments.last.hash_type?
+
+          trim_mode_arg, eoutvar_arg = nil
+
+          node.arguments.last.pairs.each do |pair|
+            case pair.key.source
+            when 'trim_mode'
+              trim_mode_arg = "trim_mode: #{pair.value.source}"
+            when 'eoutvar'
+              eoutvar_arg = "eoutvar: #{pair.value.source}"
+            end
+          end
+
+          [trim_mode_arg, eoutvar_arg]
+        end
+
+        def override_by_legacy_args(kwargs, node)
+          arguments = node.arguments
+          overridden_kwargs = kwargs.dup
+
+          overridden_kwargs[0] = "trim_mode: #{arguments[2].source}" if arguments[2]
+
+          if arguments[3] && !arguments[3].hash_type?
+            overridden_kwargs[1] = "eoutvar: #{arguments[3].source}"
+          end
+
+          overridden_kwargs
+        end
+
+        def arguments_range(node)
+          arguments = node.arguments
+
+          range_between(arguments.first.source_range.begin_pos, arguments.last.source_range.end_pos)
         end
       end
     end

data/lib/rubocop/cop/lint/flip_flop.rb

@@ -3,8 +3,14 @@
 module RuboCop
   module Cop
     module Lint
-      # This cop looks for uses of flip-flop operator.
-      # flip-flop operator is deprecated since Ruby 2.6.0.
+      # This cop looks for uses of flip-flop operator
+      # based on the Ruby Style Guide.
+      #
+      # Here is the history of flip-flops in Ruby.
+      # flip-flop operator is deprecated in Ruby 2.6.0 and
+      # the deprecation has been reverted by Ruby 2.7.0 and
+      # backported to Ruby 2.6.
+      # See: https://bugs.ruby-lang.org/issues/5400
       #
       # @example
       #   # bad
@@ -16,8 +22,8 @@ module RuboCop
       #   (1..20).each do |x|
       #     puts x if (x >= 5) && (x <= 10)
       #   end
-      class FlipFlop < Cop
-        MSG = 'Avoid the use of flip-flop operators.'.freeze
+      class FlipFlop < Base
+        MSG = 'Avoid the use of flip-flop operators.'
 
         def on_iflipflop(node)
           add_offense(node)

data/lib/rubocop/cop/lint/float_comparison.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lint
+      # This cop checks for the presence of precise comparison of floating point numbers.
+      #
+      # Floating point values are inherently inaccurate, and comparing them for exact equality
+      # is almost never the desired semantics. Comparison via the `==/!=` operators checks
+      # floating-point value representation to be exactly the same, which is very unlikely
+      # if you perform any arithmetic operations involving precision loss.
+      #
+      # @example
+      #   # bad
+      #   x == 0.1
+      #   x != 0.1
+      #
+      #   # good - using BigDecimal
+      #   x.to_d == 0.1.to_d
+      #
+      #   # good
+      #   (x - 0.1).abs < Float::EPSILON
+      #
+      #   # good
+      #   tolerance = 0.0001
+      #   (x - 0.1).abs < tolerance
+      #
+      #   # Or some other epsilon based type of comparison:
+      #   # https://www.embeddeduse.com/2019/08/26/qt-compare-two-floats/
+      #
+      class FloatComparison < Base
+        MSG = 'Avoid (in)equality comparisons of floats as they are unreliable.'
+
+        EQUALITY_METHODS = %i[== != eql? equal?].freeze
+        FLOAT_RETURNING_METHODS = %i[to_f Float fdiv].freeze
+        FLOAT_INSTANCE_METHODS = %i[@- abs magnitude modulo next_float prev_float quo].to_set.freeze
+
+        RESTRICT_ON_SEND = EQUALITY_METHODS
+
+        def on_send(node)
+          lhs, _method, rhs = *node
+          add_offense(node) if float?(lhs) || float?(rhs)
+        end
+
+        private
+
+        def float?(node)
+          return false unless node
+
+          case node.type
+          when :float
+            true
+          when :send
+            check_send(node)
+          when :begin
+            float?(node.children.first)
+          else
+            false
+          end
+        end
+
+        # rubocop:disable Metrics/PerceivedComplexity
+        def check_send(node)
+          if node.arithmetic_operation?
+            lhs, _operation, rhs = *node
+            float?(lhs) || float?(rhs)
+          elsif FLOAT_RETURNING_METHODS.include?(node.method_name)
+            true
+          elsif node.receiver&.float_type?
+            if FLOAT_INSTANCE_METHODS.include?(node.method_name)
+              true
+            else
+              check_numeric_returning_method(node)
+            end
+          end
+        end
+        # rubocop:enable Metrics/PerceivedComplexity
+
+        def check_numeric_returning_method(node)
+          return false unless node.receiver
+
+          case node.method_name
+          when :angle, :arg, :phase
+            Float(node.receiver.source).negative?
+          when :ceil, :floor, :round, :truncate
+            precision = node.first_argument
+            precision&.int_type? && Integer(precision.source).positive?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/lint/float_out_of_range.rb

@@ -18,14 +18,13 @@ module RuboCop
       #   # good
       #
       #   float = 42.9
-      class FloatOutOfRange < Cop
-        MSG = 'Float out of range.'.freeze
+      class FloatOutOfRange < Base
+        MSG = 'Float out of range.'
 
         def on_float(node)
           value, = *node
 
-          return unless value.infinite? ||
-                        value.zero? && node.source =~ /[1-9]/
+          return unless value.infinite? || (value.zero? && /[1-9]/.match?(node.source))
 
           add_offense(node)
         end

data/lib/rubocop/cop/lint/format_parameter_mismatch.rb

@@ -7,6 +7,10 @@ module RuboCop
       # expected fields for format/sprintf/#% and what is actually
       # passed as arguments.
       #
+      # In addition it checks whether different formats are used in the same
+      # format string. Do not mix numbered, unnumbered, and named formats in
+      # the same format string.
+      #
       # @example
       #
       #   # bad
@@ -18,33 +22,60 @@ module RuboCop
       #   # good
       #
       #   format('A value: %s and another: %i', a_value, another)
-      class FormatParameterMismatch < Cop
+      #
+      # @example
+      #
+      #   # bad
+      #
+      #   format('Unnumbered format: %s and numbered: %2$s', a_value, another)
+      #
+      # @example
+      #
+      #   # good
+      #
+      #   format('Numbered format: %1$s and numbered %2$s', a_value, another)
+      class FormatParameterMismatch < Base
         # http://rubular.com/r/CvpbxkcTzy
         MSG = "Number of arguments (%<arg_num>i) to `%<method>s` doesn't " \
-              'match the number of fields (%<field_num>i).'.freeze
-        FIELD_REGEX =
-          /(%(([\s#+-0\*]*)(\d*)?(\.\d+)?[bBdiouxXeEfgGaAcps]|%))/.freeze
-        NAMED_FIELD_REGEX = /%\{[_a-zA-Z][_a-zA-Z]+\}/.freeze
-        KERNEL = 'Kernel'.freeze
-        SHOVEL = '<<'.freeze
-        PERCENT = '%'.freeze
-        PERCENT_PERCENT = '%%'.freeze
-        DIGIT_DOLLAR_FLAG = /%(\d+)\$/.freeze
+              'match the number of fields (%<field_num>i).'
+        MSG_INVALID = 'Format string is invalid because formatting sequence types ' \
+                      '(numbered, named or unnumbered) are mixed.'
+
+        KERNEL = 'Kernel'
+        SHOVEL = '<<'
         STRING_TYPES = %i[str dstr].freeze
-        NAMED_INTERPOLATION = /%(?:<\w+>|\{\w+\})/.freeze
+        RESTRICT_ON_SEND = %i[format sprintf %].freeze
 
         def on_send(node)
+          return unless format_string?(node)
+
+          if invalid_format_string?(node)
+            add_offense(node.loc.selector, message: MSG_INVALID)
+            return
+          end
+
           return unless offending_node?(node)
 
-          add_offense(node, location: :selector)
+          add_offense(node.loc.selector, message: message(node))
         end
 
         private
 
+        def format_string?(node)
+          called_on_string?(node) && method_with_format_args?(node)
+        end
+
+        def invalid_format_string?(node)
+          string = if sprintf?(node) || format?(node)
+                     node.first_argument.source
+                   else
+                     node.receiver.source
+                   end
+          !RuboCop::Cop::Utils::FormatString.new(string).valid?
+        end
+
         def offending_node?(node)
-          return false unless called_on_string?(node)
-          return false unless method_with_format_args?(node)
-          return false if named_mode?(node) || splat_args?(node)
+          return false if splat_args?(node)
 
           num_of_format_args, num_of_expected_fields = count_matches(node)
 
@@ -54,36 +85,23 @@ module RuboCop
         end
 
         def matched_arguments_count?(expected, passed)
-          if passed < 0
+          if passed.negative?
             expected < passed.abs
           else
             expected != passed
           end
         end
 
-        def called_on_string?(node)
-          receiver_node, _method, format_string, = *node
-          if receiver_node.nil? || receiver_node.const_type?
-            format_string && format_string.str_type?
-          else
-            receiver_node.str_type?
-          end
-        end
+        # @!method called_on_string?(node)
+        def_node_matcher :called_on_string?, <<~PATTERN
+          {(send {nil? const_type?} _ (str _) ...)
+           (send (str ...) ...)}
+        PATTERN
 
         def method_with_format_args?(node)
           sprintf?(node) || format?(node) || percent?(node)
         end
 
-        def named_mode?(node)
-          relevant_node = if sprintf?(node) || format?(node)
-                            node.first_argument
-                          elsif percent?(node)
-                            node.receiver
-                          end
-
-          !relevant_node.source.scan(NAMED_FIELD_REGEX).empty?
-        end
-
         def splat_args?(node)
           return false if percent?(node)
 
@@ -122,8 +140,7 @@ module RuboCop
         end
 
         def format_method?(name, node)
-          return false if node.const_receiver? &&
-                          !node.receiver.loc.name.is?(KERNEL)
+          return false if node.const_receiver? && !node.receiver.loc.name.is?(KERNEL)
           return false unless node.method?(name)
 
           node.arguments.size > 1 && node.first_argument.str_type?
@@ -131,28 +148,17 @@ module RuboCop
 
         def expected_fields_count(node)
           return :unknown unless node.str_type?
-          return 1 if node.source =~ NAMED_INTERPOLATION
 
-          max_digit_dollar_num = max_digit_dollar_num(node)
-          return max_digit_dollar_num if max_digit_dollar_num &&
-                                         max_digit_dollar_num.nonzero?
+          format_string = RuboCop::Cop::Utils::FormatString.new(node.source)
+          return 1 if format_string.named_interpolation?
 
-          node
-            .source
-            .scan(FIELD_REGEX)
-            .reject { |x| x.first == PERCENT_PERCENT }
-            .reduce(0) { |acc, elem| acc + arguments_count(elem[2]) }
-        end
-
-        def max_digit_dollar_num(node)
-          node.source.scan(DIGIT_DOLLAR_FLAG).map do |digit_dollar_num|
-            digit_dollar_num.first.to_i
-          end.max
-        end
+          max_digit_dollar_num = format_string.max_digit_dollar_num
+          return max_digit_dollar_num if max_digit_dollar_num&.nonzero?
 
-        # number of arguments required for the format sequence
-        def arguments_count(format)
-          format.scan('*').count + 1
+          format_string
+            .format_sequences
+            .reject(&:percent?)
+            .reduce(0) { |acc, seq| acc + seq.arity }
         end
 
         def format?(node)
@@ -167,11 +173,9 @@ module RuboCop
           receiver = node.receiver
 
           percent = node.method?(:%) &&
-                    (STRING_TYPES.include?(receiver.type) ||
-                     node.first_argument.array_type?)
+                    (STRING_TYPES.include?(receiver.type) || node.first_argument.array_type?)
 
-          return false if percent && STRING_TYPES.include?(receiver.type) &&
-                          heredoc?(node)
+          return false if percent && STRING_TYPES.include?(receiver.type) && heredoc?(node)
 
           percent
         end

data/lib/rubocop/cop/lint/hash_compare_by_identity.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lint
+      # Prefer using `Hash#compare_by_identity` rather than using `object_id`
+      # for hash keys.
+      #
+      # This cop looks for hashes being keyed by objects' `object_id`, using
+      # one of these methods: `key?`, `has_key?`, `fetch`, `[]` and `[]=`.
+      #
+      # @safety
+      #   This cop is unsafe. Although unlikely, the hash could store both object
+      #   ids and other values that need be compared by value, and thus
+      #   could be a false positive.
+      #
+      #   Furthermore, this cop cannot guarantee that the receiver of one of the
+      #   methods (`key?`, etc.) is actually a hash.
+      #
+      # @example
+      #   # bad
+      #   hash = {}
+      #   hash[foo.object_id] = :bar
+      #   hash.key?(baz.object_id)
+      #
+      #   # good
+      #   hash = {}.compare_by_identity
+      #   hash[foo] = :bar
+      #   hash.key?(baz)
+      #
+      class HashCompareByIdentity < Base
+        RESTRICT_ON_SEND = %i[key? has_key? fetch [] []=].freeze
+
+        MSG = 'Use `Hash#compare_by_identity` instead of using `object_id` for keys.'
+
+        # @!method id_as_hash_key?(node)
+        def_node_matcher :id_as_hash_key?, <<~PATTERN
+          (send _ {:key? :has_key? :fetch :[] :[]=} (send _ :object_id) ...)
+        PATTERN
+
+        def on_send(node)
+          add_offense(node) if id_as_hash_key?(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/lint/heredoc_method_call_position.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lint
+      # This cop checks for the ordering of a method call where
+      # the receiver of the call is a HEREDOC.
+      #
+      # @example
+      #   # bad
+      #
+      #      <<-SQL
+      #        bar
+      #      SQL
+      #      .strip_indent
+      #
+      #      <<-SQL
+      #        bar
+      #      SQL
+      #      .strip_indent
+      #      .trim
+      #
+      #   # good
+      #
+      #      <<~SQL
+      #        bar
+      #      SQL
+      #
+      #      <<~SQL.trim
+      #        bar
+      #      SQL
+      #
+      class HeredocMethodCallPosition < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Put a method call with a HEREDOC receiver on the same line as the HEREDOC opening.'
+
+        def on_send(node)
+          heredoc = heredoc_node_descendent_receiver(node)
+          return unless heredoc
+          return if correctly_positioned?(node, heredoc)
+
+          add_offense(call_after_heredoc_range(heredoc)) do |corrector|
+            autocorrect(corrector, node, heredoc)
+          end
+        end
+        alias on_csend on_send
+
+        private
+
+        def autocorrect(corrector, node, heredoc)
+          call_range = call_range_to_safely_reposition(node, heredoc)
+          return if call_range.nil?
+
+          call_source = call_range.source.strip
+          corrector.remove(call_range)
+          corrector.insert_after(heredoc_begin_line_range(node), call_source)
+        end
+
+        def heredoc_node_descendent_receiver(node)
+          while send_node?(node)
+            return node.receiver if heredoc_node?(node.receiver)
+
+            node = node.receiver
+          end
+        end
+
+        def send_node?(node)
+          return nil unless node
+
+          node.call_type?
+        end
+
+        def heredoc_node?(node)
+          node.respond_to?(:heredoc?) && node.heredoc?
+        end
+
+        def call_after_heredoc_range(heredoc)
+          pos = heredoc_end_pos(heredoc)
+          range_between(pos + 1, pos + 2)
+        end
+
+        def correctly_positioned?(node, heredoc)
+          heredoc_end_pos(heredoc) > call_end_pos(node)
+        end
+
+        def calls_on_multiple_lines?(node, _heredoc)
+          last_line = node.last_line
+          while send_node?(node)
+            return true unless last_line == node.last_line
+            return true unless all_on_same_line?(node.arguments)
+
+            node = node.receiver
+          end
+          false
+        end
+
+        def all_on_same_line?(nodes)
+          return true if nodes.empty?
+
+          nodes.first.first_line == nodes.last.last_line
+        end
+
+        def heredoc_end_pos(heredoc)
+          heredoc.location.heredoc_end.end_pos
+        end
+
+        def call_end_pos(node)
+          node.source_range.end_pos
+        end
+
+        def heredoc_begin_line_range(heredoc)
+          pos = heredoc.source_range.begin_pos
+          range_by_whole_lines(range_between(pos, pos))
+        end
+
+        def call_line_range(node)
+          pos = node.source_range.end_pos
+          range_by_whole_lines(range_between(pos, pos))
+        end
+
+        # Returns nil if no range can be safely repositioned.
+        def call_range_to_safely_reposition(node, heredoc)
+          return nil if calls_on_multiple_lines?(node, heredoc)
+
+          heredoc_end_pos = heredoc_end_pos(heredoc)
+          call_end_pos = call_end_pos(node)
+
+          call_range = range_between(heredoc_end_pos, call_end_pos)
+          call_line_range = call_line_range(node)
+
+          call_source = call_range.source.strip
+          call_line_source = call_line_range.source.strip
+
+          return call_range if call_source == call_line_source
+
+          if trailing_comma?(call_source, call_line_source)
+            # If there's some on the last line other than the call, e.g.
+            # a trailing comma, then we leave the "\n" following the
+            # heredoc_end in place.
+            return range_between(heredoc_end_pos, call_end_pos + 1)
+          end
+
+          nil
+        end
+
+        def trailing_comma?(call_source, call_line_source)
+          "#{call_source}," == call_line_source
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/lint/identity_comparison.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Lint
+      #
+      # Prefer `equal?` over `==` when comparing `object_id`.
+      #
+      # `Object#equal?` is provided to compare objects for identity, and in contrast
+      # `Object#==` is provided for the purpose of doing value comparison.
+      #
+      # @example
+      #   # bad
+      #   foo.object_id == bar.object_id
+      #
+      #   # good
+      #   foo.equal?(bar)
+      #
+      class IdentityComparison < Base
+        extend AutoCorrector
+
+        MSG = 'Use `equal?` instead `==` when comparing `object_id`.'
+        RESTRICT_ON_SEND = %i[==].freeze
+
+        def on_send(node)
+          return unless compare_between_object_id_by_double_equal?(node)
+
+          add_offense(node) do |corrector|
+            receiver = node.receiver.receiver
+            argument = node.first_argument.receiver
+            return unless receiver && argument
+
+            replacement = "#{receiver.source}.equal?(#{argument.source})"
+
+            corrector.replace(node, replacement)
+          end
+        end
+
+        private
+
+        def compare_between_object_id_by_double_equal?(node)
+          object_id_method?(node.receiver) && object_id_method?(node.first_argument)
+        end
+
+        def object_id_method?(node)
+          node.send_type? && node.method?(:object_id)
+        end
+      end
+    end
+  end
+end