From 4fac5c16d1ebaddf21c2c7753b910bf6bcddbc8d Mon Sep 17 00:00:00 2001 From: Will Spurgin Date: Tue, 1 Aug 2023 08:07:00 -0500 Subject: [PATCH] Remove have_enqueued_job and rename files/class --- README.md | 4 ---- lib/rspec/sidekiq/matchers.rb | 2 +- ...ve_enqueued_job.rb => have_enqueued_sidekiq_job.rb} | 9 ++------- spec/rspec/sidekiq/matchers/have_enqueued_job_spec.rb | 10 +++++----- 4 files changed, 8 insertions(+), 17 deletions(-) rename lib/rspec/sidekiq/matchers/{have_enqueued_job.rb => have_enqueued_sidekiq_job.rb} (95%) diff --git a/README.md b/README.md index 2503592..dc85d77 100644 --- a/README.md +++ b/README.md @@ -52,10 +52,6 @@ prevent a name clash with rspec-rails' ActiveJob matcher. AwesomeJob.perform_async 'Awesome', true # test with... expect(AwesomeJob).to have_enqueued_sidekiq_job('Awesome', true) - -# Code written with older versions of the gem may use the deprecated -# have_enqueued_job matcher. -expect(AwesomeJob).to have_enqueued_job('Awesome', true) ``` #### Testing scheduled jobs diff --git a/lib/rspec/sidekiq/matchers.rb b/lib/rspec/sidekiq/matchers.rb index f634518..0bdbce9 100644 --- a/lib/rspec/sidekiq/matchers.rb +++ b/lib/rspec/sidekiq/matchers.rb @@ -4,7 +4,7 @@ require 'rspec/sidekiq/matchers/be_processed_in' require 'rspec/sidekiq/matchers/be_retryable' require 'rspec/sidekiq/matchers/be_unique' -require 'rspec/sidekiq/matchers/have_enqueued_job' +require 'rspec/sidekiq/matchers/have_enqueued_sidekiq_job' require 'rspec/sidekiq/matchers/save_backtrace' RSpec.configure do |config| diff --git a/lib/rspec/sidekiq/matchers/have_enqueued_job.rb b/lib/rspec/sidekiq/matchers/have_enqueued_sidekiq_job.rb similarity index 95% rename from lib/rspec/sidekiq/matchers/have_enqueued_job.rb rename to lib/rspec/sidekiq/matchers/have_enqueued_sidekiq_job.rb index a42e496..009e025 100644 --- a/lib/rspec/sidekiq/matchers/have_enqueued_job.rb +++ b/lib/rspec/sidekiq/matchers/have_enqueued_sidekiq_job.rb @@ -2,12 +2,7 @@ module RSpec module Sidekiq module Matchers def have_enqueued_sidekiq_job(*expected_arguments) - HaveEnqueuedJob.new expected_arguments - end - - def have_enqueued_job(*expected_arguments) - warn "[DEPRECATION] `have_enqueued_job` is deprecated. Please use `have_enqueued_sidekiq_job` instead." - have_enqueued_sidekiq_job(*expected_arguments) + HaveEnqueuedSidekiqJob.new expected_arguments end class JobOptionParser @@ -142,7 +137,7 @@ def unwrap_jobs(jobs) end end - class HaveEnqueuedJob + class HaveEnqueuedSidekiqJob attr_reader :klass, :expected_arguments, :expected_options, :actual_jobs def initialize(expected_arguments) diff --git a/spec/rspec/sidekiq/matchers/have_enqueued_job_spec.rb b/spec/rspec/sidekiq/matchers/have_enqueued_job_spec.rb index 8f73cfc..86b7876 100644 --- a/spec/rspec/sidekiq/matchers/have_enqueued_job_spec.rb +++ b/spec/rspec/sidekiq/matchers/have_enqueued_job_spec.rb @@ -1,10 +1,10 @@ require 'spec_helper' -RSpec.describe RSpec::Sidekiq::Matchers::HaveEnqueuedJob do +RSpec.describe RSpec::Sidekiq::Matchers::HaveEnqueuedSidekiqJob do let(:tomorrow) { DateTime.now + 1 } let(:interval) { 3.minutes } - let(:argument_subject) { RSpec::Sidekiq::Matchers::HaveEnqueuedJob.new worker_args } - let(:matcher_subject) { RSpec::Sidekiq::Matchers::HaveEnqueuedJob.new [be_a(String), be_a(Integer), true, be_a(Hash)] } + let(:argument_subject) { described_class.new worker_args } + let(:matcher_subject) { described_class.new [be_a(String), be_a(Integer), true, be_a(Hash)] } let(:worker) { create_worker } let(:worker_args) { ['string', 1, true, { "key" => 'value', "bar" => "foo", "nested" => [{"hash" => true}] }] } let(:active_job) { create_active_job :mailers } @@ -109,7 +109,7 @@ describe '#have_enqueued_sidekiq_job' do it 'returns instance' do worker.perform_async *worker_args - expect(have_enqueued_sidekiq_job).to be_a RSpec::Sidekiq::Matchers::HaveEnqueuedJob + expect(have_enqueued_sidekiq_job).to be_a described_class end it 'matches the same way have_enqueued_sidekiq_job does' do @@ -142,7 +142,7 @@ context "when expected arguments is an array and multiple jobs enqueued" do let(:wrapped_args) { [worker_args] } - let(:argument_subject) { RSpec::Sidekiq::Matchers::HaveEnqueuedJob.new wrapped_args } + let(:argument_subject) { described_class.new wrapped_args } it "returns a message showing the wrapped array in expectations but each job on its own line" do jids = 2.times.map { worker.perform_async *worker_args }