rubocop-petal 1.7.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 870fc02bf4650bccfe18997c81e65db68010629713a33d6d178c096ed2aa4e9d
-  data.tar.gz: 0bff5f21002f48011b4a8da4c018cf66895e2447355805c9671ae756bede81d3
+  metadata.gz: 02e763ff0683f1009a5b4e387eea9beb7e19eea47670c634f7d182b182856e41
+  data.tar.gz: 66576879ea7a772d5323fcf89aadf9a91ea1e0a25ee2679553ec5c83d2e197d7
 SHA512:
-  metadata.gz: c0ebbd343190e5efca0d1fb4bac94e8c427c066358d2af180a0d040b0f4cfc99471ac3e41c0b78e7ef7aba54ab196f86551c28e88762ff12bb9d48ba06346661
-  data.tar.gz: f748e4b3af3f1182df2bdd2d9f28ae5a8b12c30fc37a78f0c02e7bd583167181f843beff7f0d2be14eb16af315def56f3c9a248a5d9e9cc2d52d4d2341908f43
+  metadata.gz: '02790f98ebe560dec0615c66faabf2c67ec9f062ef8db564026b76ee72dbbfb695bbe63946d418f5b8b2872275e684acf3f5d31a74bae35c54f0d30d5d31950d'
+  data.tar.gz: 2a363c24244f2c6b6b451bac58ccd9a65c6c0f4e5ab6d07160720ae28a707c85a2f3e273f38116b90cb3b2bf9f3a1d089f9f58cb422cfa89be002d720543c1e1

data/config/base.yml

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

data/config/default.yml

@@ -59,6 +59,18 @@ RSpec/AggregateExamples:
     - validate_inclusion_of
     - validates_exclusion_of
 
+RSpec/AggregateFailuresTag:
+  Description: 'Checks that the `:aggregate_failures` tag is only used on examples, not on example groups.'
+  Enabled: true
+  Include:
+    - spec/**/*
+
+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 +85,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
@@ -143,12 +162,14 @@ Sidekiq/KeywordArguments:
   Enabled: true
   Include:
     - app/workers/**/*
+    - app/jobs/**/*
 
 Sidekiq/NoNilReturn:
   Description: 'Prevent early nil return in workers'
   Enabled: false
   Include:
     - app/workers/**/*
+    - app/jobs/**/*
 
 Sidekiq/PerformInline:
   Description: 'Suggest to use `perform_inline` instead of `new.perform` for Sidekiq workers.'
@@ -158,3 +179,26 @@ Sidekiq/SymbolArgument:
   Description: "Prevent passing keywords arguments in worker's perform method"
   Enabled: true
   SafeAutoCorrect: false
+
+Sidekiq/PreferJob:
+  Description: 'Prefer `Sidekiq::Job` over `Sidekiq::Worker`.'
+  Enabled: true
+  StyleGuide: https://github.com/sidekiq/sidekiq/wiki/Best-Practices#4-use-precise-terminology
+  Include:
+    - app/workers/**/*
+    - app/jobs/**/*
+
+Sidekiq/JobNaming:
+  Description: 'Job class name should end with `Job` instead of `Worker`.'
+  Enabled: true
+  StyleGuide: https://github.com/sidekiq/sidekiq/wiki/Best-Practices#4-use-precise-terminology
+  Include:
+    - app/workers/**/*
+    - app/jobs/**/*
+
+Sidekiq/JobLocation:
+  Description: 'Job class with `Job` suffix should be placed in `app/jobs` directory instead of `app/workers`.'
+  Enabled: true
+  StyleGuide: https://github.com/sidekiq/sidekiq/wiki/Best-Practices#4-use-precise-terminology
+  Include:
+    - app/workers/**/*

data/lib/rubocop/cop/grape/unnecessary_namespace.rb

@@ -18,7 +18,16 @@ module RuboCop
               'Specify endpoint name with an argument: `get :some_path`.'
         HTTP_ACTIONS = Set.new(%i[get head put post patch delete])
         GRAPE_NAMESPACE_ALIAS = Set.new(%i[namespace resource resources])
-        METHOD_JUSTIFY_NAMESPACE = Set.new(%i[route_param namespaces resource resources version])
+        METHOD_JUSTIFY_NAMESPACE = Set.new(%i[route_param
+                                              namespaces
+                                              resource
+                                              resources
+                                              version
+                                              before
+                                              after
+                                              finally
+                                              after_validation
+                                              before_validation])
 
         def_node_matcher :namespace?, <<~PATTERN
           (send nil? GRAPE_NAMESPACE_ALIAS ({sym | str} _))

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

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module RSpec
+      # Checks that the `:aggregate_failures` tag is only used on examples,
+      # not on example groups.
+      #
+      # The `:aggregate_failures` tag only works on individual examples (`it`, `specify`, etc.),
+      # not on example groups (`describe`, `context`, etc.).
+      #
+      # @example
+      #   # bad
+      #   describe '#enabled?', :aggregate_failures do
+      #     # ...
+      #   end
+      #
+      #   context 'when enabled', :aggregate_failures do
+      #     # ...
+      #   end
+      #
+      #   # good
+      #   it 'returns true', :aggregate_failures do
+      #     # ...
+      #   end
+      #
+      #   specify 'the behavior', :aggregate_failures do
+      #     # ...
+      #   end
+      #
+      class AggregateFailuresTag < Base
+        MSG = 'The `:aggregate_failures` tag should only be used on examples, not on example groups.'
+
+        EXAMPLE_METHODS = %i[
+          it
+          specify
+          example
+          scenario
+          its
+          fit
+          fspecify
+          fexample
+          fscenario
+          focus
+          xit
+          xspecify
+          xexample
+          xscenario
+          skip
+          pending
+        ].freeze
+
+        RSPEC_METHODS = %i[
+          describe
+          context
+          feature
+          example_group
+          xdescribe
+          fdescribe
+          it
+          specify
+          example
+          scenario
+          its
+          fit
+          fspecify
+          fexample
+          fscenario
+          focus
+          xit
+          xspecify
+          xexample
+          xscenario
+          skip
+          pending
+        ].freeze
+
+        def on_block(node)
+          return unless rspec_block?(node)
+          return unless aggregate_failures_tag?(node)
+          return if example_method?(node)
+
+          # Create a range that includes the method call up to and including the 'do' keyword
+          send_node = node.send_node
+          range = send_node.source_range.join(node.loc.begin)
+          add_offense(range)
+        end
+
+        private
+
+        def rspec_block?(node)
+          send_node = node.send_node
+          return false unless send_node
+          return false unless send_node.send_type?
+
+          RSPEC_METHODS.include?(send_node.method_name)
+        end
+
+        def example_method?(node)
+          send_node = node.send_node
+          return false unless send_node
+
+          EXAMPLE_METHODS.include?(send_node.method_name)
+        end
+
+        def aggregate_failures_tag?(node)
+          send_node = node.send_node
+          return false unless send_node
+
+          send_node.arguments.any? do |arg|
+            if arg.sym_type? && arg.value == :aggregate_failures
+              true
+            elsif arg.hash_type?
+              arg.pairs.any? { |pair| pair.key.sym_type? && pair.key.value == :aggregate_failures }
+            else
+              false
+            end
+          end
+        end
+      end
+    end
+  end
+end

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/cop/sidekiq/helpers.rb

@@ -7,7 +7,7 @@ module RuboCop
       module Helpers
         NODE_MATCHERS = lambda do
           def_node_matcher :sidekiq_include?, <<~PATTERN
-            (send nil? :include (const (const nil? :Sidekiq) :Worker))
+            (send nil? :include (const (const {nil? cbase} :Sidekiq) {:Worker :Job}))
           PATTERN
 
           def_node_matcher :includes_sidekiq?, <<~PATTERN

data/lib/rubocop/cop/sidekiq/job_location.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative 'helpers'
+
+module RuboCop
+  module Cop
+    module Sidekiq
+      # This cop checks that Sidekiq job classes with "Job" suffix are placed in the
+      # `app/jobs` directory instead of `app/workers` directory.
+      # This follows the modern Sidekiq convention where jobs should be organized
+      # in the appropriate directory structure.
+      #
+      # @example
+      #   # bad - Job class in app/workers directory
+      #   # app/workers/my_job.rb
+      #   class MyJob
+      #     include Sidekiq::Job
+      #   end
+      #
+      #   # good - Job class in app/jobs directory
+      #   # app/jobs/my_job.rb
+      #   class MyJob
+      #     include Sidekiq::Job
+      #   end
+      #
+      #   # good - Worker class can stay in app/workers (though not recommended)
+      #   # app/workers/my_worker.rb
+      #   class MyWorker
+      #     include Sidekiq::Worker
+      #   end
+      class JobLocation < Base
+        include Helpers
+
+        MSG = 'Job class with `Job` suffix should be placed in `app/jobs` directory instead of `app/workers`.'
+
+        def on_class(node)
+          return unless sidekiq_worker?(node)
+
+          class_name = extract_class_name(node)
+          return unless class_name
+          return unless class_name.end_with?('Job')
+
+          file_path = processed_source.buffer.name
+          return unless file_path.include?('app/workers/')
+
+          add_offense(node.children.first, message: MSG)
+        end
+
+        private
+
+        def extract_class_name(node)
+          name_node = node.children.first
+          return unless name_node&.const_type?
+
+          # Get the last part of the constant name (e.g., "EmailJob" from "MyApp::EmailJob")
+          name_node.children.last.to_s
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sidekiq/job_naming.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative 'helpers'
+
+module RuboCop
+  module Cop
+    module Sidekiq
+      # This cop checks that Sidekiq job class names end with "Job" instead of "Worker".
+      # Since Sidekiq 6.3, it is best practice to use "Job" terminology over "Worker".
+      #
+      # @example
+      #   # bad
+      #   class MyWorker
+      #     include Sidekiq::Job
+      #   end
+      #
+      #   class ProcessDataWorker
+      #     include Sidekiq::Worker
+      #   end
+      #
+      #   # good
+      #   class MyJob
+      #     include Sidekiq::Job
+      #   end
+      #
+      #   class ProcessDataJob
+      #     include Sidekiq::Job
+      #   end
+      class JobNaming < Base
+        include Helpers
+
+        MSG = 'Job class name should end with `Job` instead of `Worker`.'
+
+        def_node_matcher :class_name, <<~PATTERN
+          (class (const _ $_) ...)
+        PATTERN
+
+        def on_class(node)
+          return unless sidekiq_worker?(node)
+
+          class_name = extract_class_name(node)
+          return unless class_name
+          return unless class_name.end_with?('Worker')
+
+          add_offense(node.children.first, message: MSG)
+        end
+
+        private
+
+        def extract_class_name(node)
+          name_node = node.children.first
+          return unless name_node&.const_type?
+
+          # Get the last part of the constant name (e.g., "EmailWorker" from "MyApp::EmailWorker")
+          name_node.children.last.to_s
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/sidekiq/prefer_job.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'helpers'
+
+module RuboCop
+  module Cop
+    module Sidekiq
+      # This cop checks for the use of `Sidekiq::Worker` and suggests using `Sidekiq::Job` instead.
+      # Since Sidekiq 6.3, it is best practice to use `Sidekiq::Job` over `Sidekiq::Worker`.
+      #
+      # @example
+      #   # bad
+      #   class MyWorker
+      #     include Sidekiq::Worker
+      #   end
+      #
+      #   # good
+      #   class MyJob
+      #     include Sidekiq::Job
+      #   end
+      class PreferJob < Base
+        extend AutoCorrector
+
+        MSG = 'Prefer `Sidekiq::Job` over `Sidekiq::Worker`.'
+
+        def_node_matcher :sidekiq_worker_include?, <<~PATTERN
+          (send nil? :include (const (const {nil? cbase} :Sidekiq) :Worker))
+        PATTERN
+
+        def on_send(node)
+          return unless sidekiq_worker_include?(node)
+
+          add_offense(node, message: MSG) do |corrector|
+            corrector.replace(node.arguments.first, 'Sidekiq::Job')
+          end
+        end
+      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.9.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.9.0
 platform: ruby
 authors:
 - Jean-Francis Bastien
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-16 00:00:00.000000000 Z
+date: 2025-09-24 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,20 +145,26 @@ 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/aggregate_failures_tag.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
 - lib/rubocop/cop/sidekiq/helpers.rb
+- lib/rubocop/cop/sidekiq/job_location.rb
+- lib/rubocop/cop/sidekiq/job_naming.rb
 - lib/rubocop/cop/sidekiq/keyword_arguments.rb
 - lib/rubocop/cop/sidekiq/no_nil_return.rb
 - lib/rubocop/cop/sidekiq/perform_inline.rb
+- lib/rubocop/cop/sidekiq/prefer_job.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 +175,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