rubocop-performance 1.22.1 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f39eb7cfffa29b6374302e0fae0b46f55a1ccce24798fa2609c4f80c3dea277
-  data.tar.gz: 87b1a993f80ae214d981e95cc5a7645f4ea92dca4255f64fa53ec29f5959500e
+  metadata.gz: 1b4cdc2536f76691be677a1e203a886fae5e170f550424bed14d579f39a87e75
+  data.tar.gz: 6ea02935a50fcdeb0b07d1a5d67c4414c71115019cb02dae4746c207f798cad6
 SHA512:
-  metadata.gz: 99a4776f28e154fe3017ed3e97be8b9121a262e8f40af1aed8d4085fc5ba4e1be7499ea12fe3d76e6858ac45ff88e031dfce6dc129743b52d5fd5815da596775
-  data.tar.gz: 9160234e8fcdf23f550d41d6429910e09276806f40ec494331d52e5f8480b2d066ac8ede04bc0144c8dc9e9e3a2fce16a8b64746e9ed0c794c278e3426d76a7b
+  metadata.gz: 7bc4f69ef0a5ca779626b29d0a7c5333bf135b29d06d1be009acd4e9ffaa368873cb9977a94e9c5d5f50cb1c000d9fa243b8557badbab00756469a0b6a366662
+  data.tar.gz: 47e7f03cf61d57a3f9bd8e3cdb79f722fdaa279d300d2de5532435c1231fa06c28b1a148ab31c7b62775d1449a284fc43cee4bd36bbd16b1065145f022c8f729

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012-23 Bozhidar Batsov
+Copyright (c) 2012-25 Bozhidar Batsov
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -30,13 +30,13 @@ ways to do this:
 Put this into your `.rubocop.yml`.
 
 ```yaml
-require: rubocop-performance
+plugins: rubocop-performance
 ```
 
 Alternatively, use the following array notation when specifying multiple extensions.
 
 ```yaml
-require:
+plugins:
   - rubocop-other-extension
   - rubocop-performance
 ```
@@ -44,10 +44,13 @@ require:
 Now you can run `rubocop` and it will automatically load the RuboCop Performance
 cops together with the standard cops.
 
+> [!NOTE]
+> The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.
+
 ### Command line
 
 ```sh
-$ rubocop --require rubocop-performance
+$ rubocop --plugin rubocop-performance
 ```
 
 ### Rake task
@@ -56,7 +59,7 @@ $ rubocop --require rubocop-performance
 require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-performance'
+  task.plugins << 'rubocop-performance'
 end
 ```
 

data/config/default.yml

@@ -326,6 +326,12 @@ Performance/StartWith:
   VersionAdded: '0.36'
   VersionChanged: '1.10'
 
+Performance/StringBytesize:
+  Description: "Use `String#bytesize` instead of calculating the size of the bytes array."
+  Safe: false
+  Enabled: 'pending'
+  VersionAdded: '1.23'
+
 Performance/StringIdentifierArgument:
   Description: 'Use symbol identifier argument instead of string identifier argument.'
   Enabled: pending
@@ -375,3 +381,9 @@ Performance/UriDefaultParser:
   Description: 'Use `URI::DEFAULT_PARSER` instead of `URI::Parser.new`.'
   Enabled: true
   VersionAdded: '0.50'
+
+Performance/ZipWithoutBlock:
+  Description: 'Checks for `map { |id| [id] }` and suggests replacing it with `zip`.'
+  Enabled: pending
+  Safe: false
+  VersionAdded: '1.24'

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

@@ -44,8 +44,8 @@ module RuboCop
 
         def_node_matcher :endless_range?, <<~PATTERN
           {
-            ({irange erange} nil? (int positive?))
-            ({irange erange} (int positive?) nil?)
+            (range nil? (int positive?))
+            (range (int positive?) nil?)
           }
         PATTERN
 

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

@@ -58,6 +58,7 @@ module RuboCop
       class CaseWhenSplat < Base
         include Alignment
         include RangeHelp
+        include CommentsHelp
         extend AutoCorrector
 
         MSG = 'Reordering `when` conditions with a splat to the end of the `when` branches can improve performance.'
@@ -116,11 +117,18 @@ module RuboCop
         def reordering_correction(when_node)
           new_condition = replacement(when_node.conditions)
 
-          if same_line?(when_node, when_node.body)
-            new_condition_with_then(when_node, new_condition)
-          else
-            new_branch_without_then(when_node, new_condition)
-          end
+          condition =
+            if same_line?(when_node, when_node.body)
+              new_condition_with_then(when_node, new_condition)
+            else
+              new_branch_without_then(when_node, new_condition)
+            end
+
+          condition_comments = comments_in_range(when_node).map do |comment_node|
+            "#{indent_for(comment_node)}#{comment_node.source}"
+          end.join("\n")
+
+          "#{condition}#{condition_comments}"
         end
 
         def when_branch_range(when_node)
@@ -134,7 +142,13 @@ module RuboCop
         end
 
         def new_branch_without_then(node, new_condition)
-          "\n#{indent_for(node)}when #{new_condition}\n#{indent_for(node.body)}#{node.body.source}"
+          new_branch = "\n#{indent_for(node)}when #{new_condition}\n"
+
+          if node.body
+            "#{new_branch}#{indent_for(node.body)}#{node.body.source}"
+          else
+            new_branch
+          end
         end
 
         def indent_for(node)

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

@@ -45,6 +45,8 @@ module RuboCop
 
         RETURNS_NEW_ARRAY = (ALWAYS_RETURNS_NEW_ARRAY + RETURNS_NEW_ARRAY_WHEN_NO_BLOCK).freeze
 
+        RESTRICT_ON_SEND = RETURNS_NEW_ARRAY
+
         MSG = 'Use unchained `%<method>s` and `%<second_method>s!` ' \
               '(followed by `return array` if required) instead of chaining ' \
               '`%<method>s...%<second_method>s`.'
@@ -52,7 +54,7 @@ module RuboCop
         def_node_matcher :chain_array_allocation?, <<~PATTERN
           (send {
             (send _ $%RETURN_NEW_ARRAY_WHEN_ARGS {int lvar ivar cvar gvar send})
-            ({block numblock} (send _ $%ALWAYS_RETURNS_NEW_ARRAY) ...)
+            (any_block (send _ $%ALWAYS_RETURNS_NEW_ARRAY) ...)
             (send _ $%RETURNS_NEW_ARRAY ...)
           } $%HAS_MUTATION_ALTERNATIVE ...)
         PATTERN
@@ -73,7 +75,7 @@ module RuboCop
         def enumerable_select_method?(node)
           # NOTE: `QueryMethods#select` in Rails accepts positional arguments, whereas `Enumerable#select` does not.
           #        This difference can be utilized to reduce the knowledge requirements related to `select`.
-          (node.block_type? || node.numblock_type?) && node.send_node.arguments.empty?
+          node.any_block_type? && node.send_node.arguments.empty?
         end
       end
     end

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

@@ -65,6 +65,8 @@ module RuboCop
 
         HASH_METHODS = (ENUMERABLE_METHOD_NAMES | NONMUTATING_HASH_METHODS).to_set.freeze
 
+        RESTRICT_ON_SEND = ARRAY_METHODS + HASH_METHODS
+
         def_node_matcher :kernel_loop?, <<~PATTERN
           (block
             (send {nil? (const nil? :Kernel)} :loop)

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

@@ -18,14 +18,14 @@ module RuboCop
       #
       #   [source,ruby]
       #   ----
-      #   `Model.where(id: [1, 2, 3]).select { |m| m.method == true }.size`
+      #   Model.where(id: [1, 2, 3]).select { |m| m.method == true }.size
       #   ----
       #
       #   becomes:
       #
       #   [source,ruby]
       #   ----
-      #   `Model.where(id: [1, 2, 3]).to_a.count { |m| m.method == true }`
+      #   Model.where(id: [1, 2, 3]).to_a.count { |m| m.method == true }
       #   ----
       #
       # @example

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

@@ -75,7 +75,7 @@ module RuboCop
         end
 
         def allowed_parent?(node)
-          node && (node.casgn_type? || node.block_type?)
+          node&.type?(:casgn, :block)
         end
 
         def contains_splat?(node)

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

@@ -38,7 +38,7 @@ module RuboCop
         # (We don't even catch it if the Range is in double parens)
 
         def_node_matcher :range_include, <<~PATTERN
-          (call {irange erange (begin {irange erange})} ${:include? :member?} ...)
+          (call {range (begin range)} ${:include? :member?} ...)
         PATTERN
 
         def on_send(node)

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

@@ -72,7 +72,7 @@ module RuboCop
 
         def requires_parentheses?(arg)
           return true if arg.if_type? && arg.ternary?
-          return true if arg.and_type? || arg.or_type? || arg.range_type?
+          return true if arg.operator_keyword? || arg.range_type?
 
           call_like?(arg) && requires_parentheses_for_call_like?(arg)
         end
@@ -84,7 +84,7 @@ module RuboCop
         end
 
         def call_like?(arg)
-          arg.call_type? || arg.yield_type? || arg.super_type?
+          arg.type?(:call, :yield, :super)
         end
       end
     end

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

@@ -48,7 +48,7 @@ module RuboCop
         RESTRICT_ON_SEND = %i[[] slice first last take length size empty?].freeze
 
         def_node_matcher :redundant_chars_call?, <<~PATTERN
-          (send $(send _ :chars) $_ $...)
+          (send $(send !nil? :chars) $_ $...)
         PATTERN
 
         def on_send(node)

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

@@ -239,7 +239,7 @@ module RuboCop
 
         def scope_root(node)
           node.each_ancestor.find do |ancestor|
-            ancestor.def_type? || ancestor.defs_type? || ancestor.class_type? || ancestor.module_type?
+            ancestor.type?(:def, :defs, :class, :module)
           end
         end
 

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

@@ -46,7 +46,11 @@ module RuboCop
             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)
+              # FIXME: When requiring only RuboCop 1.70.0 and above,
+              # `dup` in `replace_str.dup` becomes unnecessary, as
+              # frozen strings are handled in the `to_string_literal`
+              # implementation. Please remove it.
+              string_literal = to_string_literal(replace_str.dup)
               new_code = "#{receiver.source}#{node.loc.dot.source}#{good_method}(#{string_literal})"
 
               corrector.replace(node, new_code)

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Performance
+      # Checks for calls to `#bytes` counting method and suggests using `bytesize` instead.
+      # The `bytesize` method is more efficient and directly returns the size in bytes,
+      # avoiding the intermediate array allocation that `bytes.size` incurs.
+      #
+      # @safety
+      #   This cop is unsafe because it assumes that the receiver
+      #   responds to `#bytesize` method.
+      #
+      # @example
+      #   # bad
+      #   string_var.bytes.count
+      #   "foobar".bytes.size
+      #
+      #   # good
+      #   string_var.bytesize
+      #   "foobar".bytesize
+      class StringBytesize < Base
+        extend AutoCorrector
+
+        MSG = 'Use `String#bytesize` instead of calculating the size of the bytes array.'
+        RESTRICT_ON_SEND = %i[size length count].freeze
+
+        def_node_matcher :string_bytes_method?, <<~MATCHER
+          (call (call !{nil? int} :bytes) {:size :length :count})
+        MATCHER
+
+        def on_send(node)
+          string_bytes_method?(node) do
+            range = node.receiver.loc.selector.begin.join(node.source_range.end)
+
+            add_offense(range) do |corrector|
+              corrector.replace(range, 'bytesize')
+            end
+          end
+        end
+        alias on_csend on_send
+      end
+    end
+  end
+end

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

@@ -159,7 +159,7 @@ module RuboCop
 
         def array_literal?(node)
           receiver = node.children.first
-          receiver&.literal? && receiver&.array_type?
+          receiver&.literal? && receiver.array_type?
         end
 
         def autocorrect(corrector, init, range)

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

@@ -36,6 +36,13 @@ module RuboCop
         MESSAGE_ONLY_IF = 'only if `%<count>s` is always 0 or more'
         RESTRICT_ON_SEND = %i[map collect].freeze
 
+        def_node_matcher :times_map_call, <<~PATTERN
+          {
+            (any_block $(call (call $!nil? :times) {:map :collect}) ...)
+            $(call (call $!nil? :times) {:map :collect} (block_pass ...))
+          }
+        PATTERN
+
         def on_send(node)
           check(node)
         end
@@ -62,7 +69,7 @@ module RuboCop
 
         def handleable_receiver?(node)
           receiver = node.receiver.receiver
-          return true if receiver.literal? && (receiver.int_type? || receiver.float_type?)
+          return true if receiver.literal? && receiver.type?(:int, :float)
 
           node.receiver.dot?
         end
@@ -75,13 +82,6 @@ module RuboCop
                      end
           format(template, count: count.source, map_or_collect: map_or_collect.method_name)
         end
-
-        def_node_matcher :times_map_call, <<~PATTERN
-          {
-            ({block numblock} $(call (call $!nil? :times) {:map :collect}) ...)
-            $(call (call $!nil? :times) {:map :collect} (block_pass ...))
-          }
-        PATTERN
       end
     end
   end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Performance
+      # Checks for `map { |id| [id] }` and suggests replacing it with `zip`.
+      #
+      # @safety
+      #   This cop is unsafe for novel definitions of `map` and `collect`
+      #   on non-Enumerable objects that do not respond to `zip`.
+      #   To make your object enumerable, define an `each` method
+      #   as described in https://ruby-doc.org/core/Enumerable.html
+      #
+      # @example
+      #   # bad
+      #   [1, 2, 3].map { |id| [id] }
+      #
+      #   # good
+      #   [1, 2, 3].zip
+      class ZipWithoutBlock < Base
+        extend AutoCorrector
+
+        MSG = 'Use `zip` without a block argument instead.'
+        RESTRICT_ON_SEND = Set.new(%i[map collect]).freeze
+
+        # @!method map_with_array?(node)
+        def_node_matcher :map_with_array?, <<~PATTERN
+          {
+            (block (call !nil? RESTRICT_ON_SEND) (args (arg _)) (array (lvar _)))
+            (numblock (call !nil? RESTRICT_ON_SEND) 1 (array (lvar _)))
+          }
+        PATTERN
+
+        def on_send(node)
+          return unless map_with_array?(node.parent)
+
+          register_offense(node)
+        end
+        alias on_csend on_send
+
+        private
+
+        def register_offense(node)
+          offense_range = offense_range(node)
+          add_offense(offense_range) do |corrector|
+            corrector.replace(offense_range, 'zip')
+          end
+        end
+
+        def offense_range(node)
+          node.loc.selector.join(node.parent.loc.end)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/performance_cops.rb

@@ -44,6 +44,7 @@ require_relative 'performance/select_map'
 require_relative 'performance/size'
 require_relative 'performance/sort_reverse'
 require_relative 'performance/squeeze'
+require_relative 'performance/string_bytesize'
 require_relative 'performance/start_with'
 require_relative 'performance/string_identifier_argument'
 require_relative 'performance/string_include'
@@ -53,3 +54,4 @@ require_relative 'performance/times_map'
 require_relative 'performance/unfreeze_string'
 require_relative 'performance/uri_default_parser'
 require_relative 'performance/chain_array_allocation'
+require_relative 'performance/zip_without_block'

data/lib/rubocop/performance/plugin.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module Performance
+    # A plugin that integrates RuboCop Performance with RuboCop's plugin system.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-performance',
+          version: Version::STRING,
+          homepage: 'https://github.com/rubocop/rubocop-performance',
+          description: 'A collection of RuboCop cops to check for performance optimizations in Ruby code.'
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        project_root = Pathname.new(__dir__).join('../../..')
+
+        ConfigObsoletion.files << project_root.join('config', 'obsoletion.yml')
+
+        LintRoller::Rules.new(type: :path, config_format: :rubocop, value: project_root.join('config', 'default.yml'))
+      end
+    end
+  end
+end

data/lib/rubocop/performance/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module Performance
     # This module holds the RuboCop Performance version information.
     module Version
-      STRING = '1.22.1'
+      STRING = '1.24.0'
 
       def self.document_version
         STRING.match('\d+\.\d+').to_s

data/lib/rubocop/performance.rb

@@ -1,14 +1,7 @@
 # frozen_string_literal: true
 
 module RuboCop
-  # RuboCop Performance project namespace
+  # RuboCop Performance project namespace.
   module Performance
-    PROJECT_ROOT = Pathname.new(__dir__).parent.parent.expand_path.freeze
-    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
-    CONFIG = YAML.safe_load(CONFIG_DEFAULT.read).freeze
-
-    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
-
-    ::RuboCop::ConfigObsoletion.files << PROJECT_ROOT.join('config', 'obsoletion.yml')
   end
 end

data/lib/rubocop-performance.rb

@@ -4,10 +4,7 @@ require 'rubocop'
 
 require_relative 'rubocop/performance'
 require_relative 'rubocop/performance/version'
-require_relative 'rubocop/performance/inject'
-
-RuboCop::Performance::Inject.defaults!
-
+require_relative 'rubocop/performance/plugin'
 require_relative 'rubocop/cop/performance_cops'
 
 RuboCop::Cop::Lint::UnusedMethodArgument.singleton_class.prepend(

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-performance
 version: !ruby/object:Gem::Version
-  version: 1.22.1
+  version: 1.24.0
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -10,15 +10,29 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-17 00:00:00.000000000 Z
+date: 2025-02-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.48.1
+        version: 1.72.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -28,7 +42,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.48.1
+        version: 1.72.1
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -38,7 +52,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.31.1
+        version: 1.38.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -48,7 +62,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.31.1
+        version: 1.38.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2.0'
@@ -112,6 +126,7 @@ files:
 - lib/rubocop/cop/performance/sort_reverse.rb
 - lib/rubocop/cop/performance/squeeze.rb
 - lib/rubocop/cop/performance/start_with.rb
+- lib/rubocop/cop/performance/string_bytesize.rb
 - lib/rubocop/cop/performance/string_identifier_argument.rb
 - lib/rubocop/cop/performance/string_include.rb
 - lib/rubocop/cop/performance/string_replacement.rb
@@ -119,9 +134,10 @@ files:
 - lib/rubocop/cop/performance/times_map.rb
 - lib/rubocop/cop/performance/unfreeze_string.rb
 - lib/rubocop/cop/performance/uri_default_parser.rb
+- lib/rubocop/cop/performance/zip_without_block.rb
 - lib/rubocop/cop/performance_cops.rb
 - lib/rubocop/performance.rb
-- lib/rubocop/performance/inject.rb
+- lib/rubocop/performance/plugin.rb
 - lib/rubocop/performance/version.rb
 homepage: https://github.com/rubocop/rubocop-performance
 licenses:
@@ -130,9 +146,10 @@ metadata:
   homepage_uri: https://docs.rubocop.org/rubocop-performance/
   changelog_uri: https://github.com/rubocop/rubocop-performance/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/rubocop/rubocop-performance/
-  documentation_uri: https://docs.rubocop.org/rubocop-performance/1.22/
+  documentation_uri: https://docs.rubocop.org/rubocop-performance/1.24/
   bug_tracker_uri: https://github.com/rubocop/rubocop-performance/issues
   rubygems_mfa_required: 'true'
+  default_lint_roller_plugin: RuboCop::Performance::Plugin
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -148,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Automatic performance checking tool for Ruby code.

data/lib/rubocop/performance/inject.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Performance
-    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
-    # bit of our configuration.
-    module Inject
-      def self.defaults!
-        path = CONFIG_DEFAULT.to_s
-        hash = ConfigLoader.send(:load_yaml_configuration, path)
-        config = Config.new(hash, path).tap(&:make_excludes_absolute)
-        puts "configuration from #{path}" if ConfigLoader.debug?
-        config = ConfigLoader.merge_with_default(config, path)
-        ConfigLoader.instance_variable_set(:@default_configuration, config)
-      end
-    end
-  end
-end