rubocop-petal 1.7.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 870fc02bf4650bccfe18997c81e65db68010629713a33d6d178c096ed2aa4e9d
-  data.tar.gz: 0bff5f21002f48011b4a8da4c018cf66895e2447355805c9671ae756bede81d3
+  metadata.gz: cf2f66c07fd9f7e2d26db32b9ab5a5fc704293066bf6e8519b6fdec8cec71128
+  data.tar.gz: 3f4a7fef3bde079552b9bcffc43665a93422d3bf4dacda37a754540787dd4773
 SHA512:
-  metadata.gz: c0ebbd343190e5efca0d1fb4bac94e8c427c066358d2af180a0d040b0f4cfc99471ac3e41c0b78e7ef7aba54ab196f86551c28e88762ff12bb9d48ba06346661
-  data.tar.gz: f748e4b3af3f1182df2bdd2d9f28ae5a8b12c30fc37a78f0c02e7bd583167181f843beff7f0d2be14eb16af315def56f3c9a248a5d9e9cc2d52d4d2341908f43
+  metadata.gz: 70fe73e240f643f554767029a2cffbb4e298b80706c823c2dda8eccb2470da549aba51847241e68f7871aedabd6a0702f37ed97ed771c2aa703aabe6c03c9b93
+  data.tar.gz: 77d30ff3b03bf663b6546f3a243a90cde664a854467879e0ef3d47f2856f860eddec31ac39a8f9b723450e642f3f9f2593c1ad1cfae59baa5fea8e1b3e67e3e6

data/config/base.yml

@@ -1,4 +1,4 @@
-require:
+plugins:
   - rubocop-performance
   - rubocop-petal
   - rubocop-rails

data/config/default.yml

@@ -59,6 +59,12 @@ RSpec/AggregateExamples:
     - validate_inclusion_of
     - validates_exclusion_of
 
+RSpec/ChewyStrategy:
+  Description: 'Prevent using Chewy strategy in tests.'
+  Enabled: true
+  Include:
+    - spec/**/*
+
 RSpec/CreateListMax:
   Description: 'Prevent creating to most records with `FactoryBot.create_list`.'
   Enabled: true
@@ -73,6 +79,13 @@ RSpec/SidekiqInline:
   Include:
     - spec/**/*
 
+RSpec/SidekiqPerformMatcher:
+  Description: 'Prevent using `receive(:perform_async)` in favor of rspec-sidekiq matcher'
+  StyleGuide: https://github.com/wspurgin/rspec-sidekiq
+  Enabled: true
+  Include:
+    - spec/**/*
+
 RSpec/StubProducts:
   Description: 'Suggest to use stub_products instead of veil/unveil_product.'
   Enabled: true

data/lib/rubocop/cop/rspec/chewy_strategy.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Prevent to change the Chewy strategy in tests.
+      # Setting the strategy to atomic may try to import unnecessary data
+      # for the test which result to a slower test suite.
+      #
+      # @example
+      #   # bad
+      #   let(:user) { Chewy.strategy(:atomic) { create(:user) } }
+      #
+      #   # good
+      #   let(:user) { create(:user) }
+      #   before { UserIndex.import! user }
+      #
+      class ChewyStrategy < Base
+        MSG = 'Do not use Chewy.strategy in tests. Import data explicitly instead.'
+        RESTRICT_ON_SEND = %i[strategy].freeze
+
+        # @!method chewy_strategy?(node)
+        def_node_matcher :chewy_strategy?, <<~PATTERN
+          (send (const nil? :Chewy) :strategy ...)
+        PATTERN
+
+        def on_send(node)
+          return unless chewy_strategy?(node)
+
+          add_offense(node)
+        end
+        alias on_csend on_send
+      end
+    end
+  end
+end

data/lib/rubocop/cop/rspec/sidekiq_perform_matcher.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Prevent the use of `receive(:perform_async)` matcher to
+      # use instead rspec-sidekiq matcher like `enqueue_sidekiq_job`.
+      #
+      # @example
+      #   # bad
+      #   expect(MyWorker).to receive(:perform_async).with(args)
+      #   expect(MyWorker).to receive(:perform_in).with(5.seconds, args)
+      #   expect(MyWorker).to receive(:perform_at).with(specific_time, args)
+      #   expect(MyWorker).to receive(:perform_bulk)
+      #
+      #   # good
+      #   expect(MyWorker).to have_enqueued_sidekiq_job.with(args)
+      #   expect(MyWorker).to have_enqueued_sidekiq_job.in(1.seconds).with(args)
+      #   expect(MyWorker).to have_enqueued_sidekiq_job.at(specific_time).with(args)
+      #   expect(MyWorker).to have_enqueued_sidekiq_job
+      #
+      class SidekiqPerformMatcher < Base
+        MSG = 'Use `have_enqueued_sidekiq_job` instead of `receive(:perform_%s)`.'
+        RESTRICT_ON_SEND = %i[receive].freeze
+
+        # @!method perform_matcher?(node)
+        def_node_matcher :perform_matcher?, <<~PATTERN
+          (send nil? :receive (sym {:perform_async :perform_in :perform_at :perform_bulk}))
+        PATTERN
+
+        def on_send(node)
+          return unless perform_matcher?(node)
+
+          perform_method = node.first_argument.value.to_s.sub('perform_', '')
+
+          add_offense(node, message: format(MSG, perform_method))
+        end
+        alias on_csend on_send
+      end
+    end
+  end
+end

data/lib/rubocop/petal/plugin.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'lint_roller'
+
+module RuboCop
+  module Petal
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-petal',
+          version: VERSION,
+          homepage: 'https://github.com/petalmd/rubocop-petal',
+          description: 'Petal global cops configuration'
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: Pathname.new(__dir__).join('../../../config/default.yml')
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/petal/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Petal
-    VERSION = '1.7.1'
+    VERSION = '1.8.0'
   end
 end

data/lib/rubocop-petal.rb

@@ -4,8 +4,5 @@ require 'rubocop'
 
 require_relative 'rubocop/petal'
 require_relative 'rubocop/petal/version'
-require_relative 'rubocop/petal/inject'
-
-RuboCop::Petal::Inject.defaults!
-
+require_relative 'rubocop/petal/plugin'
 require_relative 'rubocop/cop/petal_cops'

metadata

@@ -1,99 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-petal
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.0
 platform: ruby
 authors:
 - Jean-Francis Bastien
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-16 00:00:00.000000000 Z
+date: 2025-04-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.70'
+        version: '1.75'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.70'
+        version: '1.75'
 - !ruby/object:Gem::Dependency
   name: rubocop-factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.26'
+        version: '2.27'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.26'
+        version: '2.27'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.23'
+        version: '1.25'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.23'
+        version: '1.25'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.28'
+        version: '2.31'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.28'
+        version: '2.31'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec_rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.30'
+        version: '2.31'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.30'
+        version: '2.31'
 description:
 email:
 - jfbastien@petalmd.com
@@ -131,10 +145,12 @@ files:
 - lib/rubocop/cop/rspec/aggregate_examples/matchers_with_side_effects.rb
 - lib/rubocop/cop/rspec/aggregate_examples/metadata_helpers.rb
 - lib/rubocop/cop/rspec/aggregate_examples/node_matchers.rb
+- lib/rubocop/cop/rspec/chewy_strategy.rb
 - lib/rubocop/cop/rspec/create_list_max.rb
 - lib/rubocop/cop/rspec/json_response.rb
 - lib/rubocop/cop/rspec/multiple_expectations_auto_correct.rb
 - lib/rubocop/cop/rspec/sidekiq_inline.rb
+- lib/rubocop/cop/rspec/sidekiq_perform_matcher.rb
 - lib/rubocop/cop/rspec/stub_products.rb
 - lib/rubocop/cop/sidekiq/const_argument.rb
 - lib/rubocop/cop/sidekiq/date_time_argument.rb
@@ -144,7 +160,7 @@ files:
 - lib/rubocop/cop/sidekiq/perform_inline.rb
 - lib/rubocop/cop/sidekiq/symbol_argument.rb
 - lib/rubocop/petal.rb
-- lib/rubocop/petal/inject.rb
+- lib/rubocop/petal/plugin.rb
 - lib/rubocop/petal/version.rb
 homepage: https://github.com/petalmd/rubocop-petal
 licenses:
@@ -155,6 +171,7 @@ metadata:
   source_code_uri: https://github.com/petalmd/rubocop-petal
   bug_tracker_uri: https://github.com/petalmd/rubocop-petal/issues
   rubygems_mfa_required: 'true'
+  default_lint_roller_plugin: RuboCop::Petal::Plugin
 post_install_message:
 rdoc_options: []
 require_paths:

data/lib/rubocop/petal/inject.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-# The original code is from https://github.com/rubocop-hq/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
-# See https://github.com/rubocop-hq/rubocop-rspec/blob/master/MIT-LICENSE.md
-module RuboCop
-  module Petal
-    # 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