rubocop-performance 1.6.1 → 1.9.0

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Performance
+      # This cop finds regular expressions with dynamic components that are all constants.
+      #
+      # Ruby allocates a new Regexp object every time it executes a code containing such
+      # a regular expression. It is more efficient to extract it into a constant
+      # or add an `/o` option to perform `#{}` interpolation only once and reuse that
+      # Regexp object.
+      #
+      # @example
+      #
+      #   # bad
+      #   def tokens(pattern)
+      #     pattern.scan(TOKEN).reject { |token| token.match?(/\A#{SEPARATORS}\Z/) }
+      #   end
+      #
+      #   # good
+      #   ALL_SEPARATORS = /\A#{SEPARATORS}\Z/
+      #   def tokens(pattern)
+      #     pattern.scan(TOKEN).reject { |token| token.match?(ALL_SEPARATORS) }
+      #   end
+      #
+      #   # good
+      #   def tokens(pattern)
+      #     pattern.scan(TOKEN).reject { |token| token.match?(/\A#{SEPARATORS}\Z/o) }
+      #   end
+      #
+      class ConstantRegexp < Base
+        extend AutoCorrector
+
+        MSG = 'Extract this regexp into a constant or append an `/o` option to its options.'
+
+        def on_regexp(node)
+          return if within_const_assignment?(node) ||
+                    !include_interpolated_const?(node) ||
+                    node.single_interpolation?
+
+          add_offense(node) do |corrector|
+            corrector.insert_after(node, 'o')
+          end
+        end
+
+        private
+
+        def within_const_assignment?(node)
+          node.each_ancestor(:casgn).any?
+        end
+
+        def_node_matcher :regexp_escape?, <<~PATTERN
+          (send
+            (const nil? :Regexp) :escape const_type?)
+        PATTERN
+
+        def include_interpolated_const?(node)
+          return false unless node.interpolation?
+
+          node.each_child_node(:begin).all? do |begin_node|
+            inner_node = begin_node.children.first
+            inner_node && (inner_node.const_type? || regexp_escape?(inner_node))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -4,7 +4,7 @@ module RuboCop
   module Cop
     module Performance
       # This cop is used to identify usages of `count` on an `Enumerable` that
-      # follow calls to `select` or `reject`. Querying logic can instead be
+      # follow calls to `select`, `find_all`, `filter` or `reject`. Querying logic can instead be
       # passed to the `count` call.
       #
       # @example
@@ -37,15 +37,17 @@ module RuboCop
       #   becomes:
       #
       #   `Model.where(id: [1, 2, 3]).to_a.count { |m| m.method == true }`
-      class Count < Cop
+      class Count < Base
         include RangeHelp
+        extend AutoCorrector
 
         MSG = 'Use `count` instead of `%<selector>s...%<counter>s`.'
+        RESTRICT_ON_SEND = %i[count length size].freeze
 
         def_node_matcher :count_candidate?, <<~PATTERN
           {
-            (send (block $(send _ ${:select :reject}) ...) ${:count :length :size})
-            (send $(send _ ${:select :reject} (:block_pass _)) ${:count :length :size})
+            (send (block $(send _ ${:select :filter :find_all :reject}) ...) ${:count :length :size})
+            (send $(send _ ${:select :filter :find_all :reject} (:block_pass _)) ${:count :length :size})
           }
         PATTERN
 
@@ -57,29 +59,25 @@ module RuboCop
               selector_node.loc.selector.begin_pos
             end
 
-            add_offense(node,
-                        location: range,
-                        message: format(MSG, selector: selector,
-                                             counter: counter))
+            add_offense(range, message: format(MSG, selector: selector, counter: counter)) do |corrector|
+              autocorrect(corrector, node, selector_node, selector)
+            end
           end
         end
 
-        def autocorrect(node)
-          selector_node, selector, _counter = count_candidate?(node)
+        private
+
+        def autocorrect(corrector, node, selector_node, selector)
           selector_loc = selector_node.loc.selector
 
           return if selector == :reject
 
           range = source_starting_at(node) { |n| n.loc.dot.begin_pos }
 
-          lambda do |corrector|
-            corrector.remove(range)
-            corrector.replace(selector_loc, 'count')
-          end
+          corrector.remove(range)
+          corrector.replace(selector_loc, 'count')
         end
 
-        private
-
         def eligible_node?(node)
           !(node.parent && node.parent.block_type?)
         end

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

@@ -43,13 +43,15 @@ module RuboCop
       #   str.sub(/^prefix/, '')
       #   str.sub!(/^prefix/, '')
       #
-      class DeletePrefix < Cop
-        extend TargetRubyVersion
+      class DeletePrefix < Base
         include RegexpMetacharacter
+        extend AutoCorrector
+        extend TargetRubyVersion
 
         minimum_target_ruby_version 2.5
 
         MSG = 'Use `%<prefer>s` instead of `%<current>s`.'
+        RESTRICT_ON_SEND = %i[gsub gsub! sub sub!].freeze
 
         PREFERRED_METHODS = {
           gsub: :delete_prefix,
@@ -63,31 +65,21 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          delete_prefix_candidate?(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_prefix_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)
-          delete_prefix_candidate?(node) do |receiver, bad_method, regexp_str, _|
-            lambda do |corrector|
-              good_method = PREFERRED_METHODS[bad_method]
-              regexp_str = drop_start_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_start_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})"
 
-              # TODO: `source_range` is no longer required when RuboCop 0.81 or lower support will be dropped.
-              # https://github.com/rubocop-hq/rubocop/commit/82eb350d2cba16
-              corrector.replace(node.source_range, new_code)
-            end
+            corrector.replace(node, new_code)
           end
         end
       end

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

@@ -43,13 +43,15 @@ module RuboCop
       #   str.sub(/suffix$/, '')
       #   str.sub!(/suffix$/, '')
       #
-      class DeleteSuffix < Cop
-        extend TargetRubyVersion
+      class DeleteSuffix < Base
         include RegexpMetacharacter
+        extend AutoCorrector
+        extend TargetRubyVersion
 
         minimum_target_ruby_version 2.5
 
         MSG = 'Use `%<prefer>s` instead of `%<current>s`.'
+        RESTRICT_ON_SEND = %i[gsub gsub! sub sub!].freeze
 
         PREFERRED_METHODS = {
           gsub: :delete_suffix,
@@ -63,31 +65,21 @@ module RuboCop
         PATTERN
 
         def on_send(node)
-          delete_suffix_candidate?(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)
-          delete_suffix_candidate?(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})"
 
-              # TODO: `source_range` is no longer required when RuboCop 0.81 or lower support will be dropped.
-              # https://github.com/rubocop-hq/rubocop/commit/82eb350d2cba16
-              corrector.replace(node.source_range, new_code)
-            end
+            corrector.replace(node, new_code)
           end
         end
       end

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

@@ -3,9 +3,9 @@
 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`
-      # and change them to use `detect` instead.
+      # This cop is used to identify usages of `first`, `last`, `[0]` or `[-1]`
+      # chained to `select`, `find_all` or `filter` and change them to use
+      # `detect` instead.
       #
       # @example
       #   # bad
@@ -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,44 @@ 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]`.'
+        RESTRICT_ON_SEND = %i[first last []].freeze
 
         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 +78,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?