rubocop-performance 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5e13aa59742e803b8445a8149c382c50fdbaab1d
-  data.tar.gz: 55d59fd7bb03179a9055e46613a3d1f2d2888967
+SHA256:
+  metadata.gz: 111d420207542c8522d9f34b5b8bf24356572b5fbcf0c11dfcb1e7f738a4c76f
+  data.tar.gz: 97632031f51e154320bc3d585da448740596436882b67277f1b5d26ddfe55fba
 SHA512:
-  metadata.gz: 01a28951033ec2b751828d6df2a80f63a5a2d9e9d9576a2228c12b645087b2a631c3676757bd5037e3eecc22d89a7ef28765194545393210a9068da92931d065
-  data.tar.gz: 79b46ec046a4c1bade7e1e9dd07a5fd892f25280565adb6a91d8dddcce3931722cecf93fb72d4d0e32b7d40441829d26883973b11b5139389b6cebf91bdca435
+  metadata.gz: a36e6950e6fe7847303c87862df76767d32c4f68640c229ad4ceb6115d4ae2093be18a8296c2e49324c67e8eb06dd99db42f8823586f1b572e10a74693b831d1
+  data.tar.gz: 782352b1a7c420ac3c5498aeff749577e6280fb35d6e36844ae875511e9b6b44becfd9a2789d1b4c672cb71a91b8ab1cc63c89ec41abda8d1f34f1dacd26a07c

data/README.md

@@ -74,7 +74,7 @@ Performance/Size:
 
 ## Documentation
 
-You can read a lot more about RuboCop Performance in its [official docs](https://docs.rubocop.org/projects/performance/).
+You can read a lot more about RuboCop Performance in its [official docs](https://docs.rubocop.org/rubocop-performance/).
 
 ## Contributing
 

data/config/default.yml

@@ -58,11 +58,13 @@ Performance/Count:
 Performance/DeletePrefix:
   Description: 'Use `delete_prefix` instead of `gsub`.'
   Enabled: true
+  SafeMultiline: true
   VersionAdded: '1.6'
 
 Performance/DeleteSuffix:
   Description: 'Use `delete_suffix` instead of `gsub`.'
   Enabled: true
+  SafeMultiline: true
   VersionAdded: '1.6'
 
 Performance/Detect:
@@ -99,8 +101,9 @@ Performance/EndWith:
   SafeAutoCorrect: false
   AutoCorrect: false
   Enabled: true
+  SafeMultiline: true
   VersionAdded: '0.36'
-  VersionChanged: '0.44'
+  VersionChanged: '1.6'
 
 Performance/FixedSize:
   Description: 'Do not compute the size of statically sized objects except in constants.'
@@ -193,8 +196,9 @@ Performance/StartWith:
   SafeAutoCorrect: false
   AutoCorrect: false
   Enabled: true
+  SafeMultiline: true
   VersionAdded: '0.36'
-  VersionChanged: '0.44'
+  VersionChanged: '1.6'
 
 Performance/StringReplacement:
   Description: >-

data/lib/rubocop/cop/mixin/regexp_metacharacter.rb

@@ -4,21 +4,52 @@ module RuboCop
   module Cop
     # Common functionality for handling regexp metacharacters.
     module RegexpMetacharacter
-      def literal_at_start?(regex_str)
+      private
+
+      def literal_at_start?(regexp)
+        return true if literal_at_start_with_backslash_a?(regexp)
+
+        !safe_multiline? && literal_at_start_with_caret?(regexp)
+      end
+
+      def literal_at_end?(regexp)
+        return true if literal_at_end_with_backslash_z?(regexp)
+
+        !safe_multiline? && literal_at_end_with_dollar?(regexp)
+      end
+
+      def literal_at_start_with_backslash_a?(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.)
+        /\A\\A(?:#{Util::LITERAL_REGEX})+\z/.match?(regex_str)
+      end
+
+      def literal_at_start_with_caret?(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|\^)(?:#{Util::LITERAL_REGEX})+\z/
+        /\A\^(?:#{Util::LITERAL_REGEX})+\z/.match?(regex_str)
       end
 
-      def literal_at_end?(regex_str)
+      def literal_at_end_with_backslash_z?(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 end of the string?
-        regex_str =~ /\A(?:#{Util::LITERAL_REGEX})+(\\z|\$)\z/
+        /\A(?:#{Util::LITERAL_REGEX})+\\z\z/.match?(regex_str)
+      end
+
+      def literal_at_end_with_dollar?(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 end of the string?
+        /\A(?:#{Util::LITERAL_REGEX})+\$\z/.match?(regex_str)
       end
 
       def drop_start_metacharacter(regexp_string)
@@ -36,6 +67,10 @@ module RuboCop
           regexp_string.chop # drop `$` anchor
         end
       end
+
+      def safe_multiline?
+        cop_config.fetch('SafeMultiline', true)
+      end
     end
   end
 end

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

@@ -5,24 +5,44 @@ module RuboCop
     module Performance
       # In Ruby 2.5, `String#delete_prefix` has been added.
       #
-      # This cop identifies places where `gsub(/\Aprefix/, '')`
+      # This cop identifies places where `gsub(/\Aprefix/, '')` and `sub(/\Aprefix/, '')`
       # can be replaced by `delete_prefix('prefix')`.
       #
-      # The `delete_prefix('prefix')` method is faster than
-      # `gsub(/\Aprefix/, '')`.
+      # This cop has `SafeMultiline` configuration option that `true` by default because
+      # `^prefix` is unsafe as it will behave incompatible with `delete_prefix`
+      # for receiver is multiline string.
+      #
+      # The `delete_prefix('prefix')` method is faster than `gsub(/\Aprefix/, '')`.
       #
       # @example
       #
       #   # bad
       #   str.gsub(/\Aprefix/, '')
       #   str.gsub!(/\Aprefix/, '')
-      #   str.gsub(/^prefix/, '')
-      #   str.gsub!(/^prefix/, '')
+      #
+      #   str.sub(/\Aprefix/, '')
+      #   str.sub!(/\Aprefix/, '')
       #
       #   # good
       #   str.delete_prefix('prefix')
       #   str.delete_prefix!('prefix')
       #
+      # @example SafeMultiline: true (default)
+      #
+      #   # good
+      #   str.gsub(/^prefix/, '')
+      #   str.gsub!(/^prefix/, '')
+      #   str.sub(/^prefix/, '')
+      #   str.sub!(/^prefix/, '')
+      #
+      # @example SafeMultiline: false
+      #
+      #   # bad
+      #   str.gsub(/^prefix/, '')
+      #   str.gsub!(/^prefix/, '')
+      #   str.sub(/^prefix/, '')
+      #   str.sub!(/^prefix/, '')
+      #
       class DeletePrefix < Cop
         extend TargetRubyVersion
         include RegexpMetacharacter
@@ -33,15 +53,17 @@ module RuboCop
 
         PREFERRED_METHODS = {
           gsub: :delete_prefix,
-          gsub!: :delete_prefix!
+          gsub!: :delete_prefix!,
+          sub: :delete_prefix,
+          sub!: :delete_prefix!
         }.freeze
 
-        def_node_matcher :gsub_method?, <<~PATTERN
-          (send $!nil? ${:gsub :gsub!} (regexp (str $#literal_at_start?) (regopt)) (str $_))
+        def_node_matcher :delete_prefix_candidate?, <<~PATTERN
+          (send $!nil? ${:gsub :gsub! :sub :sub!} (regexp (str $#literal_at_start?) (regopt)) (str $_))
         PATTERN
 
         def on_send(node)
-          gsub_method?(node) do |_, bad_method, _, replace_string|
+          delete_prefix_candidate?(node) do |_, bad_method, _, replace_string|
             return unless replace_string.blank?
 
             good_method = PREFERRED_METHODS[bad_method]
@@ -53,7 +75,7 @@ module RuboCop
         end
 
         def autocorrect(node)
-          gsub_method?(node) do |receiver, bad_method, regexp_str, _|
+          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)
@@ -62,7 +84,9 @@ module RuboCop
 
               new_code = "#{receiver.source}.#{good_method}(#{string_literal})"
 
-              corrector.replace(node, new_code)
+              # 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
           end
         end

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

@@ -5,24 +5,44 @@ 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')
       #
+      # @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 < Cop
         extend TargetRubyVersion
         include RegexpMetacharacter
@@ -33,15 +53,17 @@ 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|
+          delete_suffix_candidate?(node) do |_, bad_method, _, replace_string|
             return unless replace_string.blank?
 
             good_method = PREFERRED_METHODS[bad_method]
@@ -53,7 +75,7 @@ module RuboCop
         end
 
         def autocorrect(node)
-          gsub_method?(node) do |receiver, bad_method, regexp_str, _|
+          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)
@@ -62,7 +84,9 @@ module RuboCop
 
               new_code = "#{receiver.source}.#{good_method}(#{string_literal})"
 
-              corrector.replace(node, new_code)
+              # 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
           end
         end

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,22 @@ 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$/
+      #   /bc$/ =~ 'abc'
+      #   'abc'.match(/bc$/)
+      #   /bc$/.match('abc')
+      #
+      # @example SafeMultiline: false
+      #
+      #   # bad
       #   'abc'.match?(/bc$/)
       #   /bc$/.match?('abc')
       #   'abc' =~ /bc$/
@@ -22,8 +41,6 @@ module RuboCop
       #   'abc'.match(/bc$/)
       #   /bc$/.match('abc')
       #
-      #   # good
-      #   'abc'.end_with?('bc')
       class EndWith < Cop
         include RegexpMetacharacter
 

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
@@ -15,6 +18,22 @@ module RuboCop
       #   'abc'.match(/\Aab/)
       #   /\Aab/.match('abc')
       #
+      #   # good
+      #   'abc'.start_with?('ab')
+      #
+      # @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/
@@ -22,8 +41,6 @@ module RuboCop
       #   'abc'.match(/^ab/)
       #   /^ab/.match('abc')
       #
-      #   # good
-      #   'abc'.start_with?('ab')
       class StartWith < Cop
         include RegexpMetacharacter
 

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

@@ -7,7 +7,7 @@ module RuboCop
       # literal instead of `String#dup` and `String.new`.
       # Unary plus operator is faster than `String#dup`.
       #
-      # Note: `String.new` (without operator) is not exactly the same as `+''`.
+      # NOTE: `String.new` (without operator) is not exactly the same as `+''`.
       # These differ in encoding. `String.new.encoding` is always `ASCII-8BIT`.
       # However, `(+'').encoding` is the same as script encoding(e.g. `UTF-8`).
       # So, if you expect `ASCII-8BIT` encoding, disable this cop.

data/lib/rubocop/performance/version.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Performance
     module Version
-      STRING = '1.6.0'
+      STRING = '1.6.1'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-performance
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2020-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -91,10 +91,10 @@ homepage: https://github.com/rubocop-hq/rubocop-performance
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://docs.rubocop.org/projects/performance/
+  homepage_uri: https://docs.rubocop.org/rubocop-performance/
   changelog_uri: https://github.com/rubocop-hq/rubocop-performance/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/rubocop-hq/rubocop-performance/
-  documentation_uri: https://docs.rubocop.org/projects/performance/
+  documentation_uri: https://docs.rubocop.org/rubocop-performance/
   bug_tracker_uri: https://github.com/rubocop-hq/rubocop-performance/issues
 post_install_message: 
 rdoc_options: []
@@ -111,8 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.4
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Automatic performance checking tool for Ruby code.