rspec-sidekiq 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb94abca8e805aa88d9c84deb0ddb22746542845b48cde790c4da9ae58f48ca0
-  data.tar.gz: 646f1ee2cc023cd988f29b50250c6794cb7563a78c35a397f1f3290cbf9df97b
+  metadata.gz: a4f0ece401056914cf478dc4657d19aad569156ebf40ee29ee85c36fc430cfc3
+  data.tar.gz: 858c2c49ae54497a5201eab4cb3d9179fbe21a1684b11663719dfd17dd198cb2
 SHA512:
-  metadata.gz: 0d0b4a026d3e28f55e03076023b83eb11334cd2759514837f0fd37ce74d01279bf0aa53236e84185eb89e949ad429f21c40e09d1858c5a0beb622f5001617311
-  data.tar.gz: 42c83b796648b68262a689f6fabe441719347e9464505ca4ade74ebab9cad748e51896af223b441adda74fe9b6300cb9ecb1f1974843fa45cf225dcbefc996ca
+  metadata.gz: 831dfa10d07623e001f2253072b6d8e5311a0d887661421ba3eb914fce8f5020b73e5c7bda02264ebf4be6b6f23c2b02f8082a149d7ff5836895525ae61d697c
+  data.tar.gz: fda99d4e3bd9b43fb55ed60e96f77fd0ca54156bc6dcc42df3f1d2fb9323fff9fc63f5495a595766e937d0214fff10736ef18b9b468fccf4b97b91b2aae5e296

data/CHANGES.md

@@ -1,3 +1,18 @@
+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)
+
+4.0.1
+---
+* Restore the old normalizing expected args behavior with symbols (#205)
+  * fixes an unintentional breaking change in 4.0.0
+
 4.0.0
 ---
 * [BREAKING] Dropped support for matching jobs on ActiveJob's private API args, (e.g. `_aj_globalid` and `_aj_ruby2_keywords`). `_aj_globalid` can be replaced with the object itself, e.g. `have_enqueued_sidekiq_job(user)`.

data/README.md

@@ -1,6 +1,6 @@
 **Welcome @wspurgin as new maintainer for `rspec-sidekiq`!**
 
-[![RubyGems][gem_version_badge]][ruby_gems]
+[![Gem Version](https://badge.fury.io/rb/rspec-sidekiq.svg)](https://badge.fury.io/rb/rspec-sidekiq)
 [![Github Actions CI][github_actions_badge]][github_actions]
 
 Simple testing of Sidekiq jobs via a collection of matchers and helpers.
@@ -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
@@ -341,11 +357,7 @@ Please do! If there's a feature missing that you'd love to see then get in on th
 
 Issues/Pull Requests/Comments all welcome...
 
-[gem_version_badge]: https://badge.fury.io/rb/rspec-sidekiq.svg
 [github]: http://github.com/wspurgin/rspec-sidekiq
-[ruby_doc]: http://rubydoc.info/gems/rspec-sidekiq/frames
-[ruby_gems]: http://rubygems.org/gems/rspec-sidekiq
-[ruby_toolbox]: http://www.ruby-toolbox.com/projects/rspec-sidekiq
 [github_actions]: https://github.com/wspurgin/rspec-sidekiq/actions
 [github_actions_badge]: https://github.com/wspurgin/rspec-sidekiq/actions/workflows/main.yml/badge.svg
 

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
 
@@ -171,7 +172,7 @@ module RSpec
         end
 
         def with(*expected_arguments)
-          @expected_arguments = expected_arguments
+          @expected_arguments = normalize_arguments(expected_arguments)
           self
         end
 
@@ -185,6 +186,11 @@ module RSpec
           self
         end
 
+        def immediately
+          @expected_options["at"] = nil
+          self
+        end
+
         def on(queue)
           @expected_options["queue"] = queue
           self
@@ -237,18 +243,17 @@ module RSpec
           RSpec::Support::ObjectFormatter.format(thing)
         end
 
-        def jsonified_expected_arguments
-          # We would just cast-to-parse-json, but we need to support
-          # RSpec matcher args like #kind_of
-          @jsonified_expected_arguments ||= begin
-            expected_arguments.map do |arg|
-              case arg.class
-              when Symbol then arg.to_s
-              when Hash then JSON.parse(arg.to_json)
-              else
-                arg
-              end
+        def normalize_arguments(args)
+          if args.is_a?(Array)
+            args.map{ |x| normalize_arguments(x) }
+          elsif args.is_a?(Hash)
+            args.each_with_object({}) do |(key, value), hash|
+              hash[key.to_s] = normalize_arguments(value)
             end
+          elsif args.is_a?(Symbol)
+            args.to_s
+          else
+            args
           end
         end
       end

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

@@ -9,7 +9,7 @@ module RSpec
       class HaveEnqueuedSidekiqJob < Base
         def initialize(expected_arguments)
           super()
-          @expected_arguments = expected_arguments
+          @expected_arguments = normalize_arguments(expected_arguments)
         end
 
         def matches?(job_class)
@@ -17,7 +17,7 @@ module RSpec
 
           @actual_jobs = EnqueuedJobs.new(klass)
 
-          actual_jobs.includes?(jsonified_expected_arguments, expected_options)
+          actual_jobs.includes?(expected_arguments, expected_options)
         end
       end
     end

data/lib/rspec/sidekiq/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Sidekiq
-    VERSION = "4.0.0"
+    VERSION = "4.1.0"
   end
 end

data/lib/rspec-sidekiq.rb

@@ -1,3 +1,5 @@
+require 'forwardable'
+
 require 'sidekiq'
 require 'sidekiq/testing'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-sidekiq
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Aidan Coyle
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-15 00:00:00.000000000 Z
+date: 2023-10-27 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:
   - - ">="