rspec-sidekiq_pro 0.0.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab301b38f104fcdeda2a304b6f87f4d50e67ed15f01340b08c7d77643b35d98b
-  data.tar.gz: bdcf93f32eb2ec8040c286e864fa204ce01f066f88e76f6f0b5b9e61ec16cb11
+  metadata.gz: c0209fc3fe2a82f7cd7355cd0514da771926c8557b68fd4ea23680d0b5cc95e6
+  data.tar.gz: bea903392cd28942099eb2b70e6ee0111df93842c569d7a5ccba113e4e9fdb4f
 SHA512:
-  metadata.gz: e86e8d44fcdad8b55dd826ae835fabc40b235dba13c90d471dbfef38e609d3d19a18a4ea4d6b9f65ec4c42db7a9f0690d97ad9ef582aed6303ebdad41ba5ecce
-  data.tar.gz: e682c9fe04fb2e49866a11af75d052d3003127e150444af0769332f983a3fe55f1f76e153db56beaca6bd4e6cb901117be42f5974016ddbcbfd17ea1780a02f6
+  metadata.gz: fddfe519ba229d75f3c6bcd1f1a68eade0e7c23babb04ebe377484a3704857bb47feb12d6f9de213cdf0fe9a037b874bfb78692c5a69359f5cf270bb0a28f020
+  data.tar.gz: f1177195cf806d86619f027255619fdd5b47f370aba696a4d3931cccf8498197f758895c7fb7cee1a10320fe5cea94d48cc7e044a7250d9a767bcfd5252c0d2a

data/README.md

@@ -1,14 +1,182 @@
 # Rspec for Sidekiq Pro
 
+[![Gem Version](https://badge.fury.io/rb/rspec-sidekiq_pro.svg)](https://rubygems.org/gems/rspec-sidekiq_pro)
+[![CI Status](https://github.com/inkstak/rspec-sidekiq_pro/actions/workflows/ci.yml/badge.svg)](https://github.com/inkstak/rspec-sidekiq_pro/actions/workflows/ci.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/9bb8b75ea8c66b1a9c94/maintainability)](https://codeclimate.com/github/inkstak/rspec-sidekiq_pro/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/3de8ad4b1787cdb9ca20/test_coverage)](https://codeclimate.com/github/inkstak/rspec-sidekiq_pro/test_coverage)
+
 ### Installation
 
 ```bash
-bundle add rspec-sidekiq_pro
+bundle add rspec-sidekiq_pro --group=test
+```
+
+### Configuration
+
+`rspec/sidekiq_pro` requires `sidekiq/testing` by default so there is no need to include it.
+
+It also means that Sidekiq in set to `fake` mode by default. Take a look at [Sidekiq wiki](https://github.com/mperham/sidekiq/wiki/Testing) for more details.
+
+If you wish to start each spec without enqueued jobs or batches:
+
+```ruby
+require "rspec/sidekiq_pro"
+
+RSpec.configure do |config|
+  config.before do
+    Sidekiq::Queues.clear_all
+    RSpec::SidekiqPro::Batches.clear_all
+  end
+end
 ```
 
 ### Usage
 
-TODO
+Two matchers are provided:
+
+* `enqueue_sidekiq_job` supports block expectation
+* `have_enqueued_sidekiq_job` supports value expectation
+
+```ruby
+it do
+  expect { SampleJob.perform_async }.to enqueue_sidekiq_job(SampleJob)
+end
+```
+```ruby
+it do
+  SampleJob.perform_async
+  expect(SampleJob).to have_enqueued_sidekiq_job
+end
+```
+
+Both matchers provide the same chainable methods:
+
+* `.with`
+* `.once`
+* `.twice`
+* `.exactly().times`
+* `.in`
+* `.at`
+* `.within_batch`
+* `.without_batch`
+
+
+#### Checking arguments
+
+```ruby
+it do
+  expect { SampleJob.perform_async(1, 2, 3) }
+    .to enqueue_sidekiq_job(SampleJob).with(1, 2, 3)
+end
+```
+```ruby
+it do
+  SampleJob.perform_async(1, 2, 3)
+  expect(SampleJob).to have_enqueued_sidekiq_job.with(1, 2, 3)
+end
+```
+
+
+#### Checking counts
+
+```ruby
+it do
+  expect { SampleJob.perform_async }
+    .to enqueue_sidekiq_job(SampleJob).once
+end
+```
+
+```ruby
+it do
+  expect { 
+    2.times { SampleJob.perform_async }
+  }.to enqueue_sidekiq_job(SampleJob).twice
+end
+```
+
+```ruby
+it do
+  expect { 
+    3.times { SampleJob.perform_async }
+  }.to enqueue_sidekiq_job(SampleJob).exactly(3).times
+end
+```
+
+Be careful when checking both counts and arguments:
+
+```ruby
+it do
+  expect { 
+    SampleJob.perform_async.with(1)
+    SampleJob.perform_async.with(2)
+  } 
+    .to  enqueue_sidekiq_job(SampleJob).twice
+    .and enqueue_sidekiq_job(SampleJob).once.with(1)
+    .and enqueue_sidekiq_job(SampleJob).once.with(2)
+end
+```
+
+#### Checking schedules
+
+```ruby
+it do
+  expect { 
+    SampleJob.perform_in(5.minutes)
+  }.to enqueue_sidekiq_job(SampleJob).in(5.minutes)
+end
+```
+
+```ruby
+it do
+  expect { 
+    SampleJob.perform_at(10.minutes.from_now)
+  }.to enqueue_sidekiq_job(SampleJob).at(10.minutes.from_now)
+end
+```
+
+Time matching is performed to the second, if you have code that takes some time to be executed consider using [Timecop](https://github.com/travisjeffery/timecop).
+
+
+#### Batches
+
+```ruby
+it do
+  expect { 
+    SampleJob.perform_async
+  }.to enqueue_sidekiq_job(SampleJob).without_batch
+end
+```
+
+```ruby
+it do
+  expect { 
+    batch = Sidekiq::Batch.new
+    batch.jobs { SampleJob.perform_async }
+  }.to enqueue_sidekiq_job(SampleJob).within_batch
+end
+```
+
+```ruby
+it do
+  expect { start_some_complex_workflow }
+    .to enqueue_sidekiq_job(SampleJob).twice.within_batch { |batch|
+      expect(batch).to have_attributes(description: "Complex Workflow first step")
+    }
+end
+```
+
+`within_batch` and `without_batch` require `Sidekiq::Testing` to be enabled.
+
+When `Sidekiq::Testing` is enabled, every batch is pushed to `RSpec::SidekiqPro::Batches` instead of Redis.
+
+```ruby
+it do
+  batch = Sidekiq::Batch.new
+  batch.jobs { SampleJob.perform_async }
+
+  expect(RSpec::SidekiqPro::Batches.first.bid).to eq(batch.bid)
+end
+```
 
 ## Contributing
 
@@ -35,4 +203,6 @@ bundle exec rake
 
 Please see [LICENSE](https://github.com/inkstak/rspec-sidekiq_pro/blob/main/LICENSE) for further details.
 
+Inspired by the [philostler/rspec-sidekiq](https://github.com/philostler/rspec-sidekiq/) & [pirj/rspec-enqueue_sidekiq_job](https://github.com/pirj/rspec-enqueue_sidekiq_job)
+
 Contributors: [./graphs/contributors](https://github.com/inkstak/rspec-sidekiq_pro/graphs/contributors)

data/lib/rspec/sidekiq_pro/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module SidekiqPro
-    VERSION = "0.0.0"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-sidekiq_pro
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Savater Sebastien
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-17 00:00:00.000000000 Z
+date: 2022-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport