rspec-sidekiq_pro 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0209fc3fe2a82f7cd7355cd0514da771926c8557b68fd4ea23680d0b5cc95e6
-  data.tar.gz: bea903392cd28942099eb2b70e6ee0111df93842c569d7a5ccba113e4e9fdb4f
+  metadata.gz: a19307da8e27eaf43f2ec679fde1ce55961ad0f61c48b01d13b086b408af6a71
+  data.tar.gz: 50db6bdf022a1fa024e527e7a0fa65bcbf52566a6b28e603ecf5626f4ecfa94d
 SHA512:
-  metadata.gz: fddfe519ba229d75f3c6bcd1f1a68eade0e7c23babb04ebe377484a3704857bb47feb12d6f9de213cdf0fe9a037b874bfb78692c5a69359f5cf270bb0a28f020
-  data.tar.gz: f1177195cf806d86619f027255619fdd5b47f370aba696a4d3931cccf8498197f758895c7fb7cee1a10320fe5cea94d48cc7e044a7250d9a767bcfd5252c0d2a
+  metadata.gz: c36f3fa7655fef1b047eb84b8148cd40a7eee3bf131d8966469f03bae2ce214e065d21c36088e00c170717eb737bf0265206d8ddaea4a0ca1cde307bf91c7aa2
+  data.tar.gz: cc0fc1156ebb0b69aa95e82c7e83f9b3079a6b80fe7a7b920f026a7300c66661f9aaee440a566de5ca91a9e7b1463bc3b2e42482fc01b73a1efa013c347f8e9e

data/README.md

@@ -1,8 +1,9 @@
-# Rspec for Sidekiq Pro
+# 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)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+[![Maintainability](https://api.codeclimate.com/v1/badges/3de8ad4b1787cdb9ca20/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
@@ -54,7 +55,11 @@ Both matchers provide the same chainable methods:
 * `.with`
 * `.once`
 * `.twice`
-* `.exactly().times`
+* `.exactly(n).times`
+* `.more_than(n).times`
+* `.less_than(n).times`
+* `.at_least(n).times`
+* `.at_most(n).times`
 * `.in`
 * `.at`
 * `.within_batch`
@@ -102,6 +107,14 @@ it do
 end
 ```
 
+```ruby
+it do
+  expect {
+    10.times { SampleJob.perform_async }
+  }.to enqueue_sidekiq_job(SampleJob).more_than(5).times
+end
+```
+
 Be careful when checking both counts and arguments:
 
 ```ruby
@@ -191,9 +204,10 @@ end
 ```bash
 bundle exec rspec
 bundle exec rubocop
+bundle exec standardrb
 ```
 
-Both can be run with:
+All of them can be run with:
 
 ```bash
 bundle exec rake

data/lib/rspec/sidekiq_pro/batches.rb

@@ -86,15 +86,15 @@ module Sidekiq
       if Sidekiq::Testing.disabled?
         super
       else
-        @bid  = bid || SecureRandom.urlsafe_base64(10)
+        @bid = bid || SecureRandom.urlsafe_base64(10)
         props = RSpec::SidekiqPro::Batches::Props.fetch(bid, {})
 
-        @created_at  = props.fetch("created_at", Time.now.utc).to_f
+        @created_f = @created_at = props.fetch("created_at", Time.now.utc).to_f
         @description = props["description"]
-        @parent_bid  = props["parent"]
-        @callbacks   = props.fetch("callbacks", {})
-        @jids        = props.fetch("jids", [])
-        @mutable     = props.empty?
+        @parent_bid = props["parent"]
+        @callbacks = props.fetch("callbacks", {})
+        @jids = props.fetch("jids", [])
+        @mutable = props.empty?
       end
     end
 
@@ -179,8 +179,8 @@ module Sidekiq
         callback.each do |target, options|
           klass_name, method = target.to_s.split("#")
           klass = klass_name.constantize
-          meth  = method || "on_#{event}"
-          inst  = klass.new
+          meth = method || "on_#{event}"
+          inst = klass.new
           inst.jid = SecureRandom.hex(12) if inst.respond_to?(:jid)
           inst.send(meth, status, options)
         end
@@ -192,11 +192,11 @@ module Sidekiq
         if Sidekiq::Testing.disabled?
           super
         else
-          @bid      = bid
-          @props    = RSpec::SidekiqPro::Batches::Props.fetch(bid, {})
-          @pending  = 0
+          @bid = bid
+          @props = RSpec::SidekiqPro::Batches::Props.fetch(bid, {})
+          @pending = 0
           @failures = 0
-          @total    = @props.fetch("jids", []).size
+          @total = @props.fetch("jids", []).size
         end
       end
     end

data/lib/rspec/sidekiq_pro/matchers/job_matcher.rb

@@ -12,6 +12,10 @@ module RSpec
           :expected_timestamp,
           :expected_schedule,
           :expected_count,
+          :expected_least_count,
+          :expected_most_count,
+          :expected_more_count,
+          :expected_less_count,
           :expected_without_batch,
           :expected_batch,
           :actual_jobs
@@ -20,7 +24,6 @@ module RSpec
           if block
             raise ArgumentError, "setting block to `with` is not supported for this matcher" if supports_value_expectations?
             raise ArgumentError, "setting arguments and block together in `with` is not supported" if expected_arguments.any?
-
             @expected_arguments = block
           else
             @expected_arguments = normalize_arguments(expected_arguments)
@@ -41,7 +44,7 @@ module RSpec
           raise "setting expecations with both `at` and `in` is not supported" if @expected_interval
 
           @expected_timestamp = timestamp
-          @expected_schedule  = timestamp.to_i
+          @expected_schedule = timestamp.to_i
           self
         end
 
@@ -53,8 +56,28 @@ module RSpec
           exactly(2)
         end
 
-        def exactly(times)
-          @expected_count = times
+        def exactly(count)
+          @expected_count = count
+          self
+        end
+
+        def at_least(count)
+          @expected_least_count = count
+          self
+        end
+
+        def at_most(count)
+          @expected_most_count = count
+          self
+        end
+
+        def more_than(count)
+          @expected_more_count = count
+          self
+        end
+
+        def less_than(count)
+          @expected_less_count = count
           self
         end
 
@@ -85,22 +108,38 @@ module RSpec
         end
 
         def matches?(jobs)
-          @actual_jobs  = jobs
+          @actual_jobs = jobs
           filtered_jobs = filter_jobs(actual_jobs)
 
           if expected_count
             filtered_jobs.count == expected_count
+          elsif expected_least_count
+            filtered_jobs.count >= expected_least_count
+          elsif expected_most_count
+            filtered_jobs.count <= expected_most_count
+          elsif expected_more_count
+            filtered_jobs.count > expected_more_count
+          elsif expected_less_count
+            filtered_jobs.count < expected_less_count
           else
             filtered_jobs.any?
           end
         end
 
         def does_not_match?(jobs)
-          @actual_jobs  = jobs
+          @actual_jobs = jobs
           filtered_jobs = filter_jobs(actual_jobs)
 
           if expected_count
             filtered_jobs.count != expected_count
+          elsif expected_least_count
+            raise ArgumentError, "ambiguous `at_least` matcher used with negative form"
+          elsif expected_most_count
+            raise ArgumentError, "ambiguous `at_most` matcher used with negative form"
+          elsif expected_more_count
+            filtered_jobs.count < expected_more_count
+          elsif expected_less_count
+            filtered_jobs.count > expected_less_count
           else
             filtered_jobs.empty?
           end
@@ -123,6 +162,14 @@ module RSpec
             description += " twice"
           elsif expected_count
             description += " #{expected_count} times"
+          elsif expected_least_count
+            description += " at least #{expected_least_count} times"
+          elsif expected_most_count
+            description += " at most #{expected_most_count} times"
+          elsif expected_more_count
+            description += " more than #{expected_more_count} times"
+          elsif expected_less_count
+            description += " less than #{expected_less_count} times"
           end
 
           if expected_arguments.is_a?(Proc)
@@ -135,45 +182,70 @@ module RSpec
         end
 
         def failure_message_diff
-          diff = []
-          diff << "  exactly:   #{expected_count} time(s)"       if expected_count
-          diff << "  arguments: #{expected_arguments}"           if expected_arguments
-          diff << "  in:        #{expected_interval_output}"     if expected_interval
-          diff << "  at:        #{expected_timestamp}"           if expected_timestamp
-          diff << "  batch:     #{output_batch(expected_batch)}" if expected_batch
-          diff << "  batch:     no batch"                        if expected_without_batch
-          diff << "" if diff.any?
+          message = []
+          message += expectations_in_failure_message
+          message << "" if message.any?
+          message << actual_jobs_size_in_failure_message
+
+          if expected_arguments || expected_schedule || expected_without_batch || expected_batch
+            message[-1] = "#{message[-1]}:"
+            message += actual_jobs_details_in_failure_message
+          end
+
+          message.join("\n")
+        end
 
+        def actual_jobs_size_in_failure_message
           if actual_jobs.empty?
-            diff << "no #{worker_class} found"
-          elsif !expected_arguments && !expected_schedule && !expected_without_batch && !expected_batch
-            diff << "found #{actual_jobs.size} #{worker_class}"
+            "no #{worker_class} found"
           else
-            diff << "found #{actual_jobs.size} #{worker_class}:"
-
-            actual_jobs.each do |job|
-              job_message = []
-              job_message << "arguments: #{job["args"]}"                if expected_arguments
-              job_message << "at:        #{output_schedule(job["at"])}" if expected_schedule && job["at"]
-              job_message << "at:        no schedule"                   if expected_schedule && !job["at"]
-              job_message << "batch:     #{output_batch(job["bid"])}"   if (expected_without_batch || expected_batch) && job["bid"]
-              job_message << "batch:     no batch"                      if (expected_without_batch || expected_batch) && !job["bid"]
-
-              diff += job_message.map.with_index do |line, index|
-                if actual_jobs.size == 1
-                  "  #{line}"
-                elsif index.zero?
-                  "  - #{line}"
-                else
-                  "    #{line}"
-                end
+            "found #{actual_jobs.size} #{worker_class}"
+          end
+        end
+
+        # rubocop:disable Layout/ExtraSpacing
+        # It becomes unreadable when not allowing alignement
+        def expectations_in_failure_message
+          message = []
+          message << "  exactly:   #{expected_count} time(s)"       if expected_count
+          message << "  at least:  #{expected_least_count} time(s)" if expected_least_count
+          message << "  at most:   #{expected_most_count} time(s)"  if expected_most_count
+          message << "  more than: #{expected_more_count} time(s)"  if expected_more_count
+          message << "  less than: #{expected_less_count} time(s)"  if expected_less_count
+          message << "  arguments: #{expected_arguments}"           if expected_arguments
+          message << "  in:        #{expected_interval_output}"     if expected_interval
+          message << "  at:        #{expected_timestamp}"           if expected_timestamp
+          message << "  batch:     #{output_batch(expected_batch)}" if expected_batch
+          message << "  batch:     no batch"                        if expected_without_batch
+          message
+        end
+
+        def job_details_in_failure_message(job)
+          message = []
+          message << "  arguments: #{job["args"]}"                if expected_arguments
+          message << "  at:        #{output_schedule(job["at"])}" if expected_schedule && job["at"]
+          message << "  at:        no schedule"                   if expected_schedule && !job["at"]
+          message << "  batch:     #{output_batch(job["bid"])}"   if (expected_without_batch || expected_batch) && job["bid"]
+          message << "  batch:     no batch"                      if (expected_without_batch || expected_batch) && !job["bid"]
+          message
+        end
+
+        def actual_jobs_details_in_failure_message
+          actual_jobs.flat_map do |job|
+            job_details_in_failure_message(job).map.with_index do |line, index|
+              if actual_jobs.size > 1
+                indent = "    "
+                indent = "  - " if index.zero?
+                line = "#{indent}#{line[2..]}"
               end
+
+              line
             end
           end
-
-          diff.join("\n")
         end
 
+        # rubocop:enable Layout/ExtraSpacing
+
         def expected_interval_output
           "#{expected_interval.inspect} (#{output_schedule(expected_schedule)})"
         end
@@ -184,9 +256,12 @@ module RSpec
 
         def output_batch(value)
           case value
-          when :__undef__     then "to be present"
-          when String         then "<Sidekiq::Batch bid: #{value.inspect}>"
-          when Sidekiq::Batch then "<Sidekiq::Batch bid: #{value.bid.inspect}>"
+          when :__undef__
+            "to be present"
+          when String
+            "<Sidekiq::Batch bid: #{value.inspect}>"
+          when Sidekiq::Batch
+            "<Sidekiq::Batch bid: #{value.bid.inspect}>"
           else
             if value.respond_to?(:description)
               value.description
@@ -213,10 +288,8 @@ module RSpec
             !bid.nil?
           when String
             expected_batch == bid
-
           when ::Sidekiq::Batch
             expected_batch.bid == bid
-
           else
             return unless bid
 

data/lib/rspec/sidekiq_pro/matchers.rb

@@ -18,13 +18,11 @@ module RSpec
       # expect(AwesomeWorker).to have_enqueued_sidekiq_job.in(5.minutes)
       #
       def have_enqueued_sidekiq_job
-        HaveEnqueuedSidekiqJobs.new.once
-      end
-
-      def have_enqueued_sidekiq_jobs
         HaveEnqueuedSidekiqJobs.new
       end
 
+      alias_method :have_enqueued_sidekiq_jobs, :have_enqueued_sidekiq_job
+
       # Checks if a certain job was enqueued in a block.
       #
       # expect { AwesomeWorker.perform_async }
@@ -37,12 +35,10 @@ module RSpec
       #   .to enqueue_sidekiq_job(AwesomeWorker).in(5.minutes)
       #
       def enqueue_sidekiq_job(worker_class)
-        EnqueueSidekiqJobs.new(worker_class).once
-      end
-
-      def enqueue_sidekiq_jobs(worker_class)
         EnqueueSidekiqJobs.new(worker_class)
       end
+
+      alias_method :enqueue_sidekiq_jobs, :enqueue_sidekiq_job
     end
   end
 end

data/lib/rspec/sidekiq_pro/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-sidekiq_pro
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Savater Sebastien
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-22 00:00:00.000000000 Z
+date: 2023-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -48,31 +48,57 @@ dependencies:
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: sidekiq-pro
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.5'
-description:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: A collection of RSpec matchers for Sidekiq Pro
 email: github.60k5k@simplelogin.co
 executables: []
 extensions: []
@@ -109,5 +135,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: A collection of tools and matchers for Sidekiq Pro
+summary: A collection of RSpec matchers for Sidekiq Pro
 test_files: []