rubocop-performance 1.5.2 → 1.8.1

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

@@ -12,13 +12,14 @@ module RuboCop
       #
       #   # good
       #   [].reverse_each
-      class ReverseEach < Cop
+      class ReverseEach < Base
         include RangeHelp
+        extend AutoCorrector
 
         MSG = 'Use `reverse_each` instead of `reverse.each`.'
         UNDERSCORE = '_'
 
-        def_node_matcher :reverse_each?, <<-MATCHER
+        def_node_matcher :reverse_each?, <<~MATCHER
           (send $(send _ :reverse) :each)
         MATCHER
 
@@ -29,12 +30,16 @@ module RuboCop
 
             range = range_between(location_of_reverse, end_location)
 
-            add_offense(node, location: range)
+            add_offense(range) do |corrector|
+              corrector.replace(replacement_range(node), UNDERSCORE)
+            end
           end
         end
 
-        def autocorrect(node)
-          ->(corrector) { corrector.replace(node.loc.dot, UNDERSCORE) }
+        private
+
+        def replacement_range(node)
+          range_between(node.loc.dot.begin_pos, node.loc.selector.begin_pos)
         end
       end
     end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Performance
+      # This cop identifies places where `reverse.first(n)` and `reverse.first`
+      # can be replaced by `last(n).reverse` and `last`.
+      #
+      # @example
+      #
+      #   # bad
+      #   array.reverse.first(5)
+      #   array.reverse.first
+      #
+      #   # good
+      #   array.last(5).reverse
+      #   array.last
+      #
+      class ReverseFirst < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = 'Use `%<good_method>s` instead of `%<bad_method>s`.'
+
+        def_node_matcher :reverse_first_candidate?, <<~PATTERN
+          (send $(send _ :reverse) :first (int _)?)
+        PATTERN
+
+        def on_send(node)
+          reverse_first_candidate?(node) do |receiver|
+            range = correction_range(receiver, node)
+            message = build_message(node)
+
+            add_offense(range, message: message) do |corrector|
+              replacement = build_good_method(node)
+
+              corrector.replace(range, replacement)
+            end
+          end
+        end
+
+        private
+
+        def correction_range(receiver, node)
+          range_between(receiver.loc.selector.begin_pos, node.loc.expression.end_pos)
+        end
+
+        def build_message(node)
+          good_method = build_good_method(node)
+          bad_method = build_bad_method(node)
+          format(MSG, good_method: good_method, bad_method: bad_method)
+        end
+
+        def build_good_method(node)
+          if node.arguments?
+            "last(#{node.arguments.first.source}).reverse"
+          else
+            'last'
+          end
+        end
+
+        def build_bad_method(node)
+          if node.arguments?
+            "reverse.first(#{node.arguments.first.source})"
+          else
+            'reverse.first'
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -9,67 +9,65 @@ module RuboCop
       # @example
       #   # bad
       #   [1, 2, 3].count
+      #   (1..3).to_a.count
+      #   Array[*1..3].count
+      #   Array(1..3).count
       #
       #   # bad
       #   {a: 1, b: 2, c: 3}.count
+      #   [[:foo, :bar], [1, 2]].to_h.count
+      #   Hash[*('a'..'z')].count
+      #   Hash(key: :value).count
       #
       #   # good
       #   [1, 2, 3].size
+      #   (1..3).to_a.size
+      #   Array[*1..3].size
+      #   Array(1..3).size
       #
       #   # good
       #   {a: 1, b: 2, c: 3}.size
+      #   [[:foo, :bar], [1, 2]].to_h.size
+      #   Hash[*('a'..'z')].size
+      #   Hash(key: :value).size
       #
       #   # good
       #   [1, 2, 3].count { |e| e > 2 }
       # TODO: Add advanced detection of variables that could
       # have been assigned to an array or a hash.
-      class Size < Cop
-        MSG = 'Use `size` instead of `count`.'
-
-        def on_send(node)
-          return unless eligible_node?(node)
-
-          add_offense(node, location: :selector)
-        end
-
-        def autocorrect(node)
-          ->(corrector) { corrector.replace(node.loc.selector, 'size') }
-        end
-
-        private
-
-        def eligible_node?(node)
-          return false unless node.method?(:count) && !node.arguments?
-
-          eligible_receiver?(node.receiver) && !allowed_parent?(node.parent)
-        end
+      class Size < Base
+        extend AutoCorrector
 
-        def eligible_receiver?(node)
-          return false unless node
-
-          array?(node) || hash?(node)
-        end
-
-        def allowed_parent?(node)
-          node&.block_type?
-        end
-
-        def array?(node)
-          return true if node.array_type?
-          return false unless node.send_type?
-
-          _, constant = *node.receiver
-
-          constant == :Array || node.method?(:to_a)
-        end
+        MSG = 'Use `size` instead of `count`.'
 
-        def hash?(node)
-          return true if node.hash_type?
-          return false unless node.send_type?
+        def_node_matcher :array?, <<~PATTERN
+          {
+            [!nil? array_type?]
+            (send _ :to_a)
+            (send (const nil? :Array) :[] _)
+            (send nil? :Array _)
+          }
+        PATTERN
+
+        def_node_matcher :hash?, <<~PATTERN
+          {
+            [!nil? hash_type?]
+            (send _ :to_h)
+            (send (const nil? :Hash) :[] _)
+            (send nil? :Hash _)
+          }
+        PATTERN
+
+        def_node_matcher :count?, <<~PATTERN
+          (send {#array? #hash?} :count)
+        PATTERN
 
-          _, constant = *node.receiver
+        def on_send(node)
+          return if node.parent&.block_type? || !count?(node)
 
-          constant == :Hash || node.method?(:to_h)
+          add_offense(node.loc.selector) do |corrector|
+            corrector.replace(node.loc.selector, 'size')
+          end
         end
       end
     end

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