rubocop-performance 1.5.2 → 1.8.0

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Performance
+      # This cop identifies places where `sort { |a, b| b <=> a }`
+      # can be replaced by a faster `sort.reverse`.
+      #
+      # @example
+      #   # bad
+      #   array.sort { |a, b| b <=> a }
+      #
+      #   # good
+      #   array.sort.reverse
+      #
+      class SortReverse < Base
+        include SortBlock
+        extend AutoCorrector
+
+        MSG = 'Use `sort.reverse` instead of `%<bad_method>s`.'
+
+        def on_block(node)
+          sort_with_block?(node) do |send, var_a, var_b, body|
+            replaceable_body?(body, var_b, var_a) do
+              range = sort_range(send, node)
+
+              add_offense(range, message: message(var_a, var_b)) do |corrector|
+                replacement = 'sort.reverse'
+
+                corrector.replace(range, replacement)
+              end
+            end
+          end
+        end
+
+        private
+
+        def message(var_a, var_b)
+          bad_method = "sort { |#{var_a}, #{var_b}| #{var_b} <=> #{var_a} }"
+          format(MSG, bad_method: bad_method)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Performance
+      # This cop identifies places where `gsub(/a+/, 'a')` and `gsub!(/a+/, 'a')`
+      # can be replaced by `squeeze('a')` and `squeeze!('a')`.
+      #
+      # The `squeeze('a')` method is faster than `gsub(/a+/, 'a')`.
+      #
+      # @example
+      #
+      #   # bad
+      #   str.gsub(/a+/, 'a')
+      #   str.gsub!(/a+/, 'a')
+      #
+      #   # good
+      #   str.squeeze('a')
+      #   str.squeeze!('a')
+      #
+      class Squeeze < Base
+        extend AutoCorrector
+
+        MSG = 'Use `%<prefer>s` instead of `%<current>s`.'
+
+        PREFERRED_METHODS = {
+          gsub: :squeeze,
+          gsub!: :squeeze!
+        }.freeze
+
+        def_node_matcher :squeeze_candidate?, <<~PATTERN
+          (send
+            $!nil? ${:gsub :gsub!}
+            (regexp
+              (str $#repeating_literal?)
+              (regopt))
+            (str $_))
+        PATTERN
+
+        def on_send(node)
+          squeeze_candidate?(node) do |receiver, bad_method, regexp_str, replace_str|
+            regexp_str = regexp_str[0..-2] # delete '+' from the end
+            regexp_str = interpret_string_escapes(regexp_str)
+            return unless replace_str == regexp_str
+
+            good_method = PREFERRED_METHODS[bad_method]
+            message = format(MSG, current: bad_method, prefer: good_method)
+
+            add_offense(node.loc.selector, message: message) do |corrector|
+              string_literal = to_string_literal(replace_str)
+              new_code = "#{receiver.source}.#{good_method}(#{string_literal})"
+
+              corrector.replace(node.source_range, new_code)
+            end
+          end
+        end
+
+        private
+
+        def repeating_literal?(regex_str)
+          regex_str.match?(/\A(?:#{Util::LITERAL_REGEX})\+\z/)
+        end
+      end
+    end
+  end
+end

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

@@ -3,8 +3,11 @@
 module RuboCop
   module Cop
     module Performance
-      # This cop identifies unnecessary use of a regex where
-      # `String#start_with?` would suffice.
+      # This cop identifies unnecessary use of a regex where `String#start_with?` would suffice.
+      #
+      # This cop has `SafeMultiline` configuration option that `true` by default because
+      # `^start` is unsafe as it will behave incompatible with `start_with?`
+      # for receiver is multiline string.
       #
       # @example
       #   # bad
@@ -17,47 +20,54 @@ module RuboCop
       #
       #   # good
       #   'abc'.start_with?('ab')
-      class StartWith < Cop
+      #
+      # @example SafeMultiline: true (default)
+      #
+      #   # good
+      #   'abc'.match?(/^ab/)
+      #   /^ab/.match?('abc')
+      #   'abc' =~ /^ab/
+      #   /^ab/ =~ 'abc'
+      #   'abc'.match(/^ab/)
+      #   /^ab/.match('abc')
+      #
+      # @example SafeMultiline: false
+      #
+      #   # bad
+      #   'abc'.match?(/^ab/)
+      #   /^ab/.match?('abc')
+      #   'abc' =~ /^ab/
+      #   /^ab/ =~ 'abc'
+      #   'abc'.match(/^ab/)
+      #   /^ab/.match('abc')
+      #
+      class StartWith < Base
+        include RegexpMetacharacter
+        extend AutoCorrector
+
         MSG = 'Use `String#start_with?` instead of a regex match anchored to ' \
               'the beginning of the string.'
-        SINGLE_QUOTE = "'"
 
-        def_node_matcher :redundant_regex?, <<-PATTERN
+        def_node_matcher :redundant_regex?, <<~PATTERN
           {(send $!nil? {:match :=~ :match?} (regexp (str $#literal_at_start?) (regopt)))
            (send (regexp (str $#literal_at_start?) (regopt)) {:match :match?} $_)
            (match-with-lvasgn (regexp (str $#literal_at_start?) (regopt)) $_)}
         PATTERN
 
-        def literal_at_start?(regex_str)
-          # is this regexp 'literal' in the sense of only matching literal
-          # chars, rather than using metachars like `.` and `*` and so on?
-          # also, is it anchored at the start of the string?
-          # (tricky: \s, \d, and so on are metacharacters, but other characters
-          #  escaped with a slash are just literals. LITERAL_REGEX takes all
-          #  that into account.)
-          regex_str =~ /\A\\A(?:#{LITERAL_REGEX})+\z/
-        end
-
         def on_send(node)
-          return unless redundant_regex?(node)
-
-          add_offense(node)
-        end
-        alias on_match_with_lvasgn on_send
+          return unless (receiver, regex_str = redundant_regex?(node))
 
-        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 = regex_str[2..-1] # drop \A anchor
+            regex_str = drop_start_metacharacter(regex_str)
             regex_str = interpret_string_escapes(regex_str)
 
-            lambda do |corrector|
-              new_source = receiver.source + '.start_with?(' +
-                           to_string_literal(regex_str) + ')'
-              corrector.replace(node.source_range, new_source)
-            end
+            new_source = "#{receiver.source}.start_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/string_include.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Performance
+      # This cop identifies unnecessary use of a regex where
+      # `String#include?` would suffice.
+      #
+      # This cop's offenses are not safe to auto-correct if a receiver is nil.
+      #
+      # @example
+      #   # bad
+      #   'abc'.match?(/ab/)
+      #   /ab/.match?('abc')
+      #   'abc' =~ /ab/
+      #   /ab/ =~ 'abc'
+      #   'abc'.match(/ab/)
+      #   /ab/.match('abc')
+      #
+      #   # good
+      #   'abc'.include?('ab')
+      class StringInclude < Base
+        extend AutoCorrector
+
+        MSG = 'Use `String#include?` instead of a regex match with literal-only pattern.'
+
+        def_node_matcher :redundant_regex?, <<~PATTERN
+          {(send $!nil? {:match :=~ :match?} (regexp (str $#literal?) (regopt)))
+           (send (regexp (str $#literal?) (regopt)) {:match :match?} $str)
+           (match-with-lvasgn (regexp (str $#literal?) (regopt)) $_)}
+        PATTERN
+
+        def on_send(node)
+          return unless (receiver, regex_str = redundant_regex?(node))
+
+          add_offense(node) do |corrector|
+            receiver, regex_str = regex_str, receiver if receiver.is_a?(String)
+            regex_str = interpret_string_escapes(regex_str)
+
+            new_source = "#{receiver.source}.include?(#{to_string_literal(regex_str)})"
+
+            corrector.replace(node.source_range, new_source)
+          end
+        end
+        alias on_match_with_lvasgn on_send
+
+        private
+
+        def literal?(regex_str)
+          regex_str.match?(/\A#{Util::LITERAL_REGEX}+\z/)
+        end
+      end
+    end
+  end
+end

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

@@ -18,17 +18,17 @@ module RuboCop
       #   'abc'.gsub(/a+/, 'd')
       #   'abc'.tr('b', 'd')
       #   'a b c'.delete(' ')
-      class StringReplacement < Cop
+      class StringReplacement < Base
         include RangeHelp
+        extend AutoCorrector
 
         MSG = 'Use `%<prefer>s` instead of `%<current>s`.'
         DETERMINISTIC_REGEX = /\A(?:#{LITERAL_REGEX})+\Z/.freeze
         DELETE = 'delete'
         TR = 'tr'
         BANG = '!'
-        SINGLE_QUOTE = "'"
 
-        def_node_matcher :string_replacement?, <<-PATTERN
+        def_node_matcher :string_replacement?, <<~PATTERN
           (send _ {:gsub :gsub!}
                     ${regexp str (send (const nil? :Regexp) {:new :compile} _)}
                     $str)
@@ -43,37 +43,37 @@ module RuboCop
           end
         end
 
-        def autocorrect(node)
-          _string, _method, first_param, second_param = *node
+        private
+
+        def offense(node, first_param, second_param)
           first_source, = first_source(first_param)
+          first_source = interpret_string_escapes(first_source) unless first_param.str_type?
           second_source, = *second_param
+          message = message(node, first_source, second_source)
 
-          unless first_param.str_type?
-            first_source = interpret_string_escapes(first_source)
+          add_offense(range(node), message: message) do |corrector|
+            autocorrect(corrector, node)
           end
+        end
 
-          replacement_method =
-            replacement_method(node, first_source, second_source)
+        def autocorrect(corrector, node)
+          _string, _method, first_param, second_param = *node
+          first_source, = first_source(first_param)
+          second_source, = *second_param
 
-          replace_method(node, first_source, second_source, first_param,
-                         replacement_method)
-        end
+          first_source = interpret_string_escapes(first_source) unless first_param.str_type?
 
-        def replace_method(node, first, second, first_param, replacement)
-          lambda do |corrector|
-            corrector.replace(node.loc.selector, replacement)
-            unless first_param.str_type?
-              corrector.replace(first_param.source_range,
-                                to_string_literal(first))
-            end
-
-            if second.empty? && first.length == 1
-              remove_second_param(corrector, node, first_param)
-            end
-          end
+          replace_method(corrector, node, first_source, second_source, first_param)
         end
 
-        private
+        def replace_method(corrector, node, first_source, second_source, first_param)
+          replacement_method = replacement_method(node, first_source, second_source)
+
+          corrector.replace(node.loc.selector, replacement_method)
+          corrector.replace(first_param.source_range, to_string_literal(first_source)) unless first_param.str_type?
+
+          remove_second_param(corrector, node, first_param) if second_source.empty? && first_source.length == 1
+        end
 
         def accept_second_param?(second_param)
           second_source, = *second_param
@@ -97,17 +97,6 @@ module RuboCop
           first_source.length != 1
         end
 
-        def offense(node, first_param, second_param)
-          first_source, = first_source(first_param)
-          unless first_param.str_type?
-            first_source = interpret_string_escapes(first_source)
-          end
-          second_source, = *second_param
-          message = message(node, first_source, second_source)
-
-          add_offense(node, location: range(node), message: message)
-        end
-
         def first_source(first_param)
           case first_param.type
           when :regexp

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

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Performance
+      # This cop identifies places where custom code finding the sum of elements
+      # in some Enumerable object can be replaced by `Enumerable#sum` method.
+      #
+      # @example
+      #   # bad
+      #   [1, 2, 3].inject(:+)
+      #   [1, 2, 3].reduce(10, :+)
+      #   [1, 2, 3].reduce { |acc, elem| acc + elem }
+      #
+      #   # good
+      #   [1, 2, 3].sum
+      #   [1, 2, 3].sum(10)
+      #   [1, 2, 3].sum
+      #
+      class Sum < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Use `%<good_method>s` instead of `%<bad_method>s`.'
+
+        def_node_matcher :sum_candidate?, <<~PATTERN
+          (send _ ${:inject :reduce} $_init ? (sym :+))
+        PATTERN
+
+        def_node_matcher :sum_with_block_candidate?, <<~PATTERN
+          (block
+            $(send _ {:inject :reduce} $_init ?)
+            (args (arg $_acc) (arg $_elem))
+            $send)
+        PATTERN
+
+        def_node_matcher :acc_plus_elem?, <<~PATTERN
+          (send (lvar %1) :+ (lvar %2))
+        PATTERN
+        alias elem_plus_acc? acc_plus_elem?
+
+        def on_send(node)
+          sum_candidate?(node) do |method, init|
+            range = sum_method_range(node)
+            message = build_method_message(method, init)
+
+            add_offense(range, message: message) do |corrector|
+              autocorrect(corrector, init, range)
+            end
+          end
+        end
+
+        def on_block(node)
+          sum_with_block_candidate?(node) do |send, init, var_acc, var_elem, body|
+            if acc_plus_elem?(body, var_acc, var_elem) || elem_plus_acc?(body, var_elem, var_acc)
+              range = sum_block_range(send, node)
+              message = build_block_message(send, init, var_acc, var_elem, body)
+
+              add_offense(range, message: message) do |corrector|
+                autocorrect(corrector, init, range)
+              end
+            end
+          end
+        end
+
+        private
+
+        def autocorrect(corrector, init, range)
+          return if init.empty?
+
+          replacement = build_good_method(init)
+
+          corrector.replace(range, replacement)
+        end
+
+        def sum_method_range(node)
+          range_between(node.loc.selector.begin_pos, node.loc.end.end_pos)
+        end
+
+        def sum_block_range(send, node)
+          range_between(send.loc.selector.begin_pos, node.loc.end.end_pos)
+        end
+
+        def build_method_message(method, init)
+          good_method = build_good_method(init)
+          bad_method = build_method_bad_method(init, method)
+          format(MSG, good_method: good_method, bad_method: bad_method)
+        end
+
+        def build_block_message(send, init, var_acc, var_elem, body)
+          good_method = build_good_method(init)
+          bad_method = build_block_bad_method(send.method_name, init, var_acc, var_elem, body)
+          format(MSG, good_method: good_method, bad_method: bad_method)
+        end
+
+        def build_good_method(init)
+          good_method = 'sum'
+
+          unless init.empty?
+            init = init.first
+            good_method += "(#{init.source})" if init.source.to_i != 0
+          end
+          good_method
+        end
+
+        def build_method_bad_method(init, method)
+          bad_method = "#{method}("
+          unless init.empty?
+            init = init.first
+            bad_method += "#{init.source}, "
+          end
+          bad_method += ':+)'
+          bad_method
+        end
+
+        def build_block_bad_method(method, init, var_acc, var_elem, body)
+          bad_method = method.to_s
+
+          unless init.empty?
+            init = init.first
+            bad_method += "(#{init.source})"
+          end
+          bad_method += " { |#{var_acc}, #{var_elem}| #{body.source} }"
+          bad_method
+        end
+      end
+    end
+  end
+end