rubocop-performance 1.6.0 → 1.8.1

data/lib/rubocop/cop/performance/delete_suffix.rb

@@ -5,27 +5,48 @@ module RuboCop
     module Performance
       # In Ruby 2.5, `String#delete_suffix` has been added.
       #
-      # This cop identifies places where `gsub(/suffix\z/, '')`
+      # This cop identifies places where `gsub(/suffix\z/, '')` and `sub(/suffix\z/, '')`
       # can be replaced by `delete_suffix('suffix')`.
       #
-      # The `delete_suffix('suffix')` method is faster than
-      # `gsub(/suffix\z/, '')`.
+      # This cop has `SafeMultiline` configuration option that `true` by default because
+      # `suffix$` is unsafe as it will behave incompatible with `delete_suffix?`
+      # for receiver is multiline string.
+      #
+      # The `delete_suffix('suffix')` method is faster than `gsub(/suffix\z/, '')`.
       #
       # @example
       #
       #   # bad
       #   str.gsub(/suffix\z/, '')
       #   str.gsub!(/suffix\z/, '')
-      #   str.gsub(/suffix$/, '')
-      #   str.gsub!(/suffix$/, '')
+      #
+      #   str.sub(/suffix\z/, '')
+      #   str.sub!(/suffix\z/, '')
       #
       #   # good
       #   str.delete_suffix('suffix')
       #   str.delete_suffix!('suffix')
       #
-      class DeleteSuffix < Cop
-        extend TargetRubyVersion
+      # @example SafeMultiline: true (default)
+      #
+      #   # good
+      #   str.gsub(/suffix$/, '')
+      #   str.gsub!(/suffix$/, '')
+      #   str.sub(/suffix$/, '')
+      #   str.sub!(/suffix$/, '')
+      #
+      # @example SafeMultiline: false
+      #
+      #   # bad
+      #   str.gsub(/suffix$/, '')
+      #   str.gsub!(/suffix$/, '')
+      #   str.sub(/suffix$/, '')
+      #   str.sub!(/suffix$/, '')
+      #
+      class DeleteSuffix < Base
         include RegexpMetacharacter
+        extend AutoCorrector
+        extend TargetRubyVersion
 
         minimum_target_ruby_version 2.5
 
@@ -33,37 +54,31 @@ module RuboCop
 
         PREFERRED_METHODS = {
           gsub: :delete_suffix,
-          gsub!: :delete_suffix!
+          gsub!: :delete_suffix!,
+          sub: :delete_suffix,
+          sub!: :delete_suffix!
         }.freeze
 
-        def_node_matcher :gsub_method?, <<~PATTERN
-          (send $!nil? ${:gsub :gsub!} (regexp (str $#literal_at_end?) (regopt)) (str $_))
+        def_node_matcher :delete_suffix_candidate?, <<~PATTERN
+          (send $!nil? ${:gsub :gsub! :sub :sub!} (regexp (str $#literal_at_end?) (regopt)) (str $_))
         PATTERN
 
         def on_send(node)
-          gsub_method?(node) do |_, bad_method, _, replace_string|
-            return unless replace_string.blank?
-
-            good_method = PREFERRED_METHODS[bad_method]
+          return unless (receiver, bad_method, regexp_str, replace_string = delete_suffix_candidate?(node))
+          return unless replace_string.blank?
 
-            message = format(MSG, current: bad_method, prefer: good_method)
+          good_method = PREFERRED_METHODS[bad_method]
 
-            add_offense(node, location: :selector, message: message)
-          end
-        end
+          message = format(MSG, current: bad_method, prefer: good_method)
 
-        def autocorrect(node)
-          gsub_method?(node) do |receiver, bad_method, regexp_str, _|
-            lambda do |corrector|
-              good_method = PREFERRED_METHODS[bad_method]
-              regexp_str = drop_end_metacharacter(regexp_str)
-              regexp_str = interpret_string_escapes(regexp_str)
-              string_literal = to_string_literal(regexp_str)
+          add_offense(node.loc.selector, message: message) do |corrector|
+            regexp_str = drop_end_metacharacter(regexp_str)
+            regexp_str = interpret_string_escapes(regexp_str)
+            string_literal = to_string_literal(regexp_str)
 
-              new_code = "#{receiver.source}.#{good_method}(#{string_literal})"
+            new_code = "#{receiver.source}.#{good_method}(#{string_literal})"
 
-              corrector.replace(node, new_code)
-            end
+            corrector.replace(node, new_code)
           end
         end
       end

data/lib/rubocop/cop/performance/detect.rb

@@ -3,8 +3,8 @@
 module RuboCop
   module Cop
     module Performance
-      # This cop is used to identify usages of
-      # `select.first`, `select.last`, `find_all.first`, and `find_all.last`
+      # This cop is used to identify usages of `first`, `last`, `[0]` or `[-1]`
+      # chained to `select`, `find_all`, or `find_all`
       # and change them to use `detect` instead.
       #
       # @example
@@ -13,6 +13,10 @@ module RuboCop
       #   [].select { |item| true }.last
       #   [].find_all { |item| true }.first
       #   [].find_all { |item| true }.last
+      #   [].filter { |item| true }.first
+      #   [].filter { |item| true }.last
+      #   [].filter { |item| true }[0]
+      #   [].filter { |item| true }[-1]
       #
       #   # good
       #   [].detect { |item| true }
@@ -22,47 +26,43 @@ module RuboCop
       # `ActiveRecord` does not implement a `detect` method and `find` has its
       # own meaning. Correcting ActiveRecord methods with this cop should be
       # considered unsafe.
-      class Detect < Cop
+      class Detect < Base
+        extend AutoCorrector
+
+        CANDIDATE_METHODS = Set[:select, :find_all, :filter].freeze
+
         MSG = 'Use `%<prefer>s` instead of ' \
               '`%<first_method>s.%<second_method>s`.'
         REVERSE_MSG = 'Use `reverse.%<prefer>s` instead of ' \
                       '`%<first_method>s.%<second_method>s`.'
+        INDEX_MSG = 'Use `%<prefer>s` instead of ' \
+              '`%<first_method>s[%<index>i]`.'
+        INDEX_REVERSE_MSG = 'Use `reverse.%<prefer>s` instead of ' \
+              '`%<first_method>s[%<index>i]`.'
 
         def_node_matcher :detect_candidate?, <<~PATTERN
           {
-            (send $(block (send _ {:select :find_all}) ...) ${:first :last} $...)
-            (send $(send _ {:select :find_all} ...) ${:first :last} $...)
+            (send $(block (send _ %CANDIDATE_METHODS) ...) ${:first :last} $...)
+            (send $(block (send _ %CANDIDATE_METHODS) ...) $:[] (int ${0 -1}))
+            (send $(send _ %CANDIDATE_METHODS ...) ${:first :last} $...)
+            (send $(send _ %CANDIDATE_METHODS ...) $:[] (int ${0 -1}))
           }
         PATTERN
 
         def on_send(node)
           detect_candidate?(node) do |receiver, second_method, args|
+            if second_method == :[]
+              index = args
+              args = {}
+            end
+
             return unless args.empty?
             return unless receiver
 
             receiver, _args, body = *receiver if receiver.block_type?
             return if accept_first_call?(receiver, body)
 
-            register_offense(node, receiver, second_method)
-          end
-        end
-
-        def autocorrect(node)
-          receiver, first_method = *node
-
-          replacement = if first_method == :last
-                          "reverse.#{preferred_method}"
-                        else
-                          preferred_method
-                        end
-
-          first_range = receiver.source_range.end.join(node.loc.selector)
-
-          receiver, _args, _body = *receiver if receiver.block_type?
-
-          lambda do |corrector|
-            corrector.remove(first_range)
-            corrector.replace(receiver.loc.selector, replacement)
+            register_offense(node, receiver, second_method, index)
           end
         end
 
@@ -77,21 +77,53 @@ module RuboCop
           lazy?(caller)
         end
 
-        def register_offense(node, receiver, second_method)
+        def register_offense(node, receiver, second_method, index)
           _caller, first_method, _args = *receiver
           range = receiver.loc.selector.join(node.loc.selector)
 
-          message = second_method == :last ? REVERSE_MSG : MSG
+          message = message_for_method(second_method, index)
           formatted_message = format(message, prefer: preferred_method,
                                               first_method: first_method,
-                                              second_method: second_method)
+                                              second_method: second_method,
+                                              index: index)
+
+          add_offense(range, message: formatted_message) do |corrector|
+            autocorrect(corrector, node, replacement(second_method, index))
+          end
+        end
 
-          add_offense(node, location: range, message: formatted_message)
+        def replacement(method, index)
+          if method == :last || method == :[] && index == -1
+            "reverse.#{preferred_method}"
+          else
+            preferred_method
+          end
+        end
+
+        def autocorrect(corrector, node, replacement)
+          receiver, _first_method = *node
+
+          first_range = receiver.source_range.end.join(node.loc.selector)
+
+          receiver, _args, _body = *receiver if receiver.block_type?
+
+          corrector.remove(first_range)
+          corrector.replace(receiver.loc.selector, replacement)
+        end
+
+        def message_for_method(method, index)
+          case method
+          when :[]
+            index == -1 ? INDEX_REVERSE_MSG : INDEX_MSG
+          when :last
+            REVERSE_MSG
+          else
+            MSG
+          end
         end
 
         def preferred_method
-          config.for_cop('Style/CollectionMethods') \
-            ['PreferredMethods']['detect'] || 'detect'
+          config.for_cop('Style/CollectionMethods')['PreferredMethods']['detect'] || 'detect'
         end
 
         def lazy?(node)

data/lib/rubocop/cop/performance/double_start_end_with.rb

@@ -17,39 +17,34 @@ module RuboCop
       #   str.start_with?("a", Some::CONST)
       #   str.start_with?("a", "b", "c")
       #   str.end_with?(var1, var2)
-      class DoubleStartEndWith < Cop
+      class DoubleStartEndWith < Base
+        extend AutoCorrector
+
         MSG = 'Use `%<receiver>s.%<method>s(%<combined_args>s)` ' \
               'instead of `%<original_code>s`.'
 
         def on_or(node)
-          receiver,
-          method,
-          first_call_args,
-          second_call_args = process_source(node)
+          receiver, method, first_call_args, second_call_args = process_source(node)
 
           return unless receiver && second_call_args.all?(&:pure?)
 
           combined_args = combine_args(first_call_args, second_call_args)
 
-          add_offense_for_double_call(node, receiver, method, combined_args)
+          add_offense(node, message: message(node, receiver, method, combined_args)) do |corrector|
+            autocorrect(corrector, first_call_args, second_call_args, combined_args)
+          end
         end
 
-        def autocorrect(node)
-          _receiver, _method,
-          first_call_args, second_call_args = process_source(node)
+        private
 
-          combined_args = combine_args(first_call_args, second_call_args)
+        def autocorrect(corrector, first_call_args, second_call_args, combined_args)
           first_argument = first_call_args.first.loc.expression
           last_argument = second_call_args.last.loc.expression
           range = first_argument.join(last_argument)
 
-          lambda do |corrector|
-            corrector.replace(range, combined_args)
-          end
+          corrector.replace(range, combined_args)
         end
 
-        private
-
         def process_source(node)
           if check_for_active_support_aliases?
             check_with_active_support_aliases(node)
@@ -58,17 +53,14 @@ module RuboCop
           end
         end
 
-        def combine_args(first_call_args, second_call_args)
-          (first_call_args + second_call_args).map(&:source).join(', ')
+        def message(node, receiver, method, combined_args)
+          format(
+            MSG, receiver: receiver.source, method: method, combined_args: combined_args, original_code: node.source
+          )
         end
 
-        def add_offense_for_double_call(node, receiver, method, combined_args)
-          msg = format(MSG, receiver: receiver.source,
-                            method: method,
-                            combined_args: combined_args,
-                            original_code: node.source)
-
-          add_offense(node, message: msg)
+        def combine_args(first_call_args, second_call_args)
+          (first_call_args + second_call_args).map(&:source).join(', ')
         end
 
         def check_for_active_support_aliases?

data/lib/rubocop/cop/performance/end_with.rb

@@ -3,8 +3,11 @@
 module RuboCop
   module Cop
     module Performance
-      # This cop identifies unnecessary use of a regex where `String#end_with?`
-      # would suffice.
+      # This cop identifies unnecessary use of a regex where `String#end_with?` would suffice.
+      #
+      # This cop has `SafeMultiline` configuration option that `true` by default because
+      # `end$` is unsafe as it will behave incompatible with `end_with?`
+      # for receiver is multiline string.
       #
       # @example
       #   # bad
@@ -15,6 +18,12 @@ module RuboCop
       #   'abc'.match(/bc\Z/)
       #   /bc\Z/.match('abc')
       #
+      #   # good
+      #   'abc'.end_with?('bc')
+      #
+      # @example SafeMultiline: true (default)
+      #
+      #   # good
       #   'abc'.match?(/bc$/)
       #   /bc$/.match?('abc')
       #   'abc' =~ /bc$/
@@ -22,10 +31,19 @@ module RuboCop
       #   'abc'.match(/bc$/)
       #   /bc$/.match('abc')
       #
-      #   # good
-      #   'abc'.end_with?('bc')
-      class EndWith < Cop
+      # @example SafeMultiline: false
+      #
+      #   # bad
+      #   'abc'.match?(/bc$/)
+      #   /bc$/.match?('abc')
+      #   'abc' =~ /bc$/
+      #   /bc$/ =~ 'abc'
+      #   'abc'.match(/bc$/)
+      #   /bc$/.match('abc')
+      #
+      class EndWith < Base
         include RegexpMetacharacter
+        extend AutoCorrector
 
         MSG = 'Use `String#end_with?` instead of a regex match anchored to ' \
               'the end of the string.'
@@ -37,25 +55,19 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          return unless redundant_regex?(node)
+          return unless (receiver, regex_str = redundant_regex?(node))
 
-          add_offense(node)
-        end
-        alias on_match_with_lvasgn on_send
-
-        def autocorrect(node)
-          redundant_regex?(node) do |receiver, regex_str|
+          add_offense(node) do |corrector|
             receiver, regex_str = regex_str, receiver if receiver.is_a?(String)
             regex_str = drop_end_metacharacter(regex_str)
             regex_str = interpret_string_escapes(regex_str)
 
-            lambda do |corrector|
-              new_source = receiver.source + '.end_with?(' +
-                           to_string_literal(regex_str) + ')'
-              corrector.replace(node.source_range, new_source)
-            end
+            new_source = "#{receiver.source}.end_with?(#{to_string_literal(regex_str)})"
+
+            corrector.replace(node.source_range, new_source)
           end
         end
+        alias on_match_with_lvasgn on_send
       end
     end
   end

data/lib/rubocop/cop/performance/fixed_size.rb

@@ -45,7 +45,7 @@ module RuboCop
       #   waldo = { a: corge, b: grault }
       #   waldo.size
       #
-      class FixedSize < Cop
+      class FixedSize < Base
         MSG = 'Do not compute the size of statically sized objects.'
 
         def_node_matcher :counter, <<~MATCHER

data/lib/rubocop/cop/performance/flat_map.rb

@@ -14,8 +14,9 @@ module RuboCop
       #   [1, 2, 3, 4].flat_map { |e| [e, e] }
       #   [1, 2, 3, 4].map { |e| [e, e] }.flatten
       #   [1, 2, 3, 4].collect { |e| [e, e] }.flatten
-      class FlatMap < Cop
+      class FlatMap < Base
         include RangeHelp
+        extend AutoCorrector
 
         MSG = 'Use `flat_map` instead of `%<method>s...%<flatten>s`.'
         FLATTEN_MULTIPLE_LEVELS = ' Beware, `flat_map` only flattens 1 level ' \
@@ -44,25 +45,11 @@ module RuboCop
           end
         end
 
-        def autocorrect(node)
-          map_node, _first_method, _flatten, params = flat_map_candidate?(node)
-          flatten_level, = *params.first
-
-          return unless flatten_level
-
-          range = range_between(node.loc.dot.begin_pos,
-                                node.source_range.end_pos)
-
-          lambda do |corrector|
-            corrector.remove(range)
-            corrector.replace(map_node.loc.selector, 'flat_map')
-          end
-        end
-
         private
 
         def offense_for_levels(node, map_node, first_method, flatten)
           message = MSG + FLATTEN_MULTIPLE_LEVELS
+
           register_offense(node, map_node, first_method, flatten, message)
         end
 
@@ -71,13 +58,24 @@ module RuboCop
         end
 
         def register_offense(node, map_node, first_method, flatten, message)
-          range = range_between(map_node.loc.selector.begin_pos,
-                                node.loc.expression.end_pos)
+          range = range_between(map_node.loc.selector.begin_pos, node.loc.expression.end_pos)
+          message = format(message, method: first_method, flatten: flatten)
+
+          add_offense(range, message: message) do |corrector|
+            autocorrect(corrector, node)
+          end
+        end
+
+        def autocorrect(corrector, node)
+          map_node, _first_method, _flatten, params = flat_map_candidate?(node)
+          flatten_level, = *params.first
+
+          return unless flatten_level
+
+          range = range_between(node.loc.dot.begin_pos, node.source_range.end_pos)
 
-          add_offense(node,
-                      location: range,
-                      message: format(message, method: first_method,
-                                               flatten: flatten))
+          corrector.remove(range)
+          corrector.replace(map_node.loc.selector, 'flat_map')
         end
       end
     end