rspec-sidekiq 4.0.2 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb2a5b25d191b39f3f9a8780b01c04c635e1218b9c0079fdc993d5069a43129b
-  data.tar.gz: a5cd5585a407a4d40f9e31643f5ee5ab14839d80bbdf8cf2bcbb9dd30104bfd0
+  metadata.gz: 545725855a34595908bcd584dfcee30045ad1519fbd8295bf5fbf6aed7fdd254
+  data.tar.gz: 26905978185b4e101e0f3d40b2318c0c47143d92a4a762286e5951be92942824
 SHA512:
-  metadata.gz: 773e7f3b63d3ad5165ccff805c54040905e42e3769bde2e1605d1e4620024dfcd39b8bd1aac5691b91efd0e70ea38f4f72a7af97ebf75f60930dd5b498c0c7ec
-  data.tar.gz: 75072507499d9c8835c039e5175b6672a2f184f080f260dad3fe02a53d995efa8a16f5ad07252fa97d6a7e0eb6ee86e10fdfca3189bbbd89c638d4327188b9ce
+  metadata.gz: 2f9c854985b82b12fdcd32fa0a3ec68185e1ad22ebc554f3f1e7a4b0d29d1c399706e31eef4155de6805fe61628c670a91634386eb05cf9de6762693369f3276
+  data.tar.gz: a0033e0cd3b6a6e03f5042dd04931393e87806adca9f7e78cd3bf034c2018cf89da309826e78e7a067e5a5950e86ff3aef79a2e55bb6ede116a37392000123fa

data/CHANGES.md

@@ -1,3 +1,17 @@
+Unreleased
+---
+
+4.2.0
+---
+* Add warning about `have_enqueued_sidekiq_job` with no arguments (default will
+  change in next major release) (#216, #217)
+
+4.1.0
+---
+* Add Composable support to `enqueue_sidekiq_job` and
+  `have_enqueued_sidekiq_job` (#211)
+* Add `immediately` to specify that a job should be enqueued without any delay (#210)
+
 4.0.2
 ---
 * Explicitly require forwardable (#204)

data/README.md

@@ -75,11 +75,17 @@ expect { AwesomeJob.perform_at(specific_time, "Awesome!") }.to(
   .on("default")
   .at(specific_time)
 )
+
+# Also composable
+expect do
+  AwesomeJob.perform_async
+  OtherJob.perform_async
+end.to enqueue_sidekiq_job(AwesomeJob).and enqueue_sidekiq_job(OtherJob)
 ```
 
 ### have_enqueued_sidekiq_job
-*Describes that there should be an enqueued job with the **specified
-arguments***
+
+Describes that there should be an enqueued job with the **specified arguments**
 
 ```ruby
 AwesomeJob.perform_async 'Awesome', true
@@ -95,11 +101,14 @@ AwesomeJob.perform_async({"something" => "Awesome", "extra" => "stuff"})
 expect(AwesomeJob).to have_enqueued_sidekiq_job(hash_including("something" => "Awesome"))
 expect(AwesomeJob).to have_enqueued_sidekiq_job(any_args)
 expect(AwesomeJob).to have_enqueued_sidekiq_job(hash_excluding("bad_stuff" => anything))
+
+# composable as well
+expect(AwesomeJob).to have_enqueued_sidekiq_job(any_args).and have_enqueued_sidekiq_job(hash_including("something" => "Awesome"))
 ```
 
 #### Testing scheduled jobs
 
-*Use chainable matchers `#at` and `#in`*
+*Use chainable matchers `#at`, `#in` and `#immediately`*
 
 ```ruby
 time = 5.minutes.from_now
@@ -113,6 +122,13 @@ AwesomeJob.perform_in 5.minutes, 'Awesome', true
 expect(AwesomeJob).to have_enqueued_sidekiq_job('Awesome', true).in(5.minutes)
 ```
 
+```ruby
+# Job scheduled for a date in the past are enqueued immediately.
+AwesomeJob.perform_later 5.minutes.ago, 'Awesome', true # equivalent to: AwesomeJob.perform_async 'Awesome', true
+# test with...
+expect(AwesomeJob).to have_enqueued_sidekiq_job('Awesome', true).immediately
+```
+
 #### Testing queue set for job
 
 Use the chainable `#on` matcher

data/lib/rspec/sidekiq/configuration.rb

@@ -1,4 +1,5 @@
 require "rubygems"
+require "set"
 
 module RSpec
   module Sidekiq
@@ -14,11 +15,20 @@ module RSpec
         # Functional settings defaults
         @clear_all_enqueued_jobs = true
         @warn_when_jobs_not_processed_by_sidekiq = true
+        @silence_warnings = Set.new
       end
 
       def sidekiq_gte_7?
         Gem::Version.new(::Sidekiq::VERSION) >= Gem::Version.new("7.0.0")
       end
+
+      def silence_warning(symbol)
+        @silence_warnings << symbol
+      end
+
+      def warn_for?(symbol)
+        !@silence_warnings.include?(symbol)
+      end
     end
   end
 end

data/lib/rspec/sidekiq/matchers/base.rb

@@ -16,7 +16,7 @@ module RSpec
         private
 
         def at_evaluator(value)
-          return false if job["at"].to_s.empty?
+          return value.nil? if job["at"].to_s.empty?
           value == Time.at(job["at"]).to_i
         end
 
@@ -162,6 +162,7 @@ module RSpec
       # @api private
       class Base
         include RSpec::Mocks::ArgumentMatchers
+        include RSpec::Matchers::Composable
 
         attr_reader :expected_arguments, :expected_options, :klass, :actual_jobs
 
@@ -185,6 +186,11 @@ module RSpec
           self
         end
 
+        def immediately
+          @expected_options["at"] = nil
+          self
+        end
+
         def on(queue)
           @expected_options["queue"] = queue
           self

data/lib/rspec/sidekiq/matchers/enqueue_sidekiq_job.rb

@@ -56,7 +56,8 @@ module RSpec
       #
       # Passes if a Job is enqueued as the result of a block. Chainable `with`
       # for arguments, `on` for queue, `at` for queued for a specific time, and
-      # `in` for a specific interval delay to being queued
+      # `in` for a specific interval delay to being queued, `immediately` for
+      # queued without delay.
       #
       # @example
       #
@@ -79,6 +80,17 @@ module RSpec
       #   freeze_time do
       #     expect { AwesomeJob.perform_in(1.hour) }.to enqueue_sidekiq_job.in(1.hour)
       #   end
+      #
+      #   # Without any delay
+      #   expect { AwesomeJob.perform_async }.to enqueue_sidekiq_job.immediately
+      #   expect { AwesomeJob.perform_at(1.hour.ago) }.to enqueue_sidekiq_job.immediately
+      #
+      #   ## Composable
+      #
+      #   expect do
+      #     AwesomeJob.perform_async
+      #     OtherJob.perform_async
+      #   end.to enqueue_sidekiq_job(AwesomeJob).and enqueue_sidekiq_job(OtherJob)
       def enqueue_sidekiq_job(job_class = nil)
         EnqueueSidekiqJob.new(job_class)
       end

data/lib/rspec/sidekiq/matchers/have_enqueued_sidekiq_job.rb

@@ -7,8 +7,18 @@ module RSpec
 
       # @api private
       class HaveEnqueuedSidekiqJob < Base
+        DEPRECATION = [
+          "[WARNING] `have_enqueued_sidekiq_job()` without arguments default behavior will change in next major release.",
+          "Use `have_enqueued_sidekiq_job(no_args)` to maintain legacy behavior.",
+          "More available here: https://github.com/wspurgin/rspec-sidekiq/wiki/have_enqueued_sidekiq_job-without-argument-default-behavior"
+        ].join(" ").freeze
+
         def initialize(expected_arguments)
           super()
+
+          if expected_arguments == [] && RSpec::Sidekiq.configuration.warn_for?(:have_enqueued_sidekiq_job_default)
+            Kernel.warn(DEPRECATION, uplevel: 3)
+          end
           @expected_arguments = normalize_arguments(expected_arguments)
         end
 
@@ -16,7 +26,6 @@ module RSpec
           @klass = job_class
 
           @actual_jobs = EnqueuedJobs.new(klass)
-
           actual_jobs.includes?(expected_arguments, expected_options)
         end
       end

data/lib/rspec/sidekiq/matchers.rb

@@ -1,4 +1,5 @@
 require "rspec/core"
+require "rspec/matchers"
 require "rspec/mocks/argument_list_matcher"
 require "rspec/mocks/argument_matchers"
 

data/lib/rspec/sidekiq/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Sidekiq
-    VERSION = "4.0.2"
+    VERSION = "4.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-sidekiq
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.2.0
 platform: ruby
 authors:
 - Aidan Coyle
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-25 00:00:00.000000000 Z
+date: 2024-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -266,7 +266,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="