have_enqueued_good_job matcher

[stephannv]

I started using GoodJob today (awesome gem, btw) and I noticed have_enqueued_job (default rspec-rails matcher) doesn't work with queue_adapter = :good_job, it works only with queue_adapter = :test. So I started creating a custom matcher:

module CustomMatchers
  def have_enqueued_good_job(job_class = nil)
    HaveEnqueuedGoodJob.new(job_class)
  end
  alias_method :enqueue_good_job, :have_enqueued_good_job
  
  class HaveEnqueuedGoodJob
    attr_reader :job_class, :args

    def initialize(job_class = nil)
      @job_class = job_class
    end

    def matches?(proc)
      unless Proc === proc
        raise ArgumentError, "`have_enqueued_good_job` and `enqueue_good_job` only support block expectations"
      end

      old_execution_ids = GoodJob::Execution.pluck(:id)
      proc.call
      scope = GoodJob::Execution.where.not(id: old_execution_ids) 

      scope = scope.where(job_class: job_class.to_s) if job_class

      if args
        scope = scope.where("serialized_params -> 'arguments' = ?::jsonb", ActiveJob::Arguments.serialize(args).to_json)
      end

      scope.any?
    end

    def description
      "lorem ipsum"
    end

    def failure_message
      "lorem ipsum"
    end

    def with(*args)
      @args = args

      self
    end
    ruby2_keywords(:with)

    def supports_block_expectations? = true
  end
end

RSpec.configure do |config|
  config.include CustomMatchers
end

Usage:

expect { some_method }.to have_enqueued_good_job 

expect { some_method }.to have_enqueued_good_job(MyJob)

expect { some_method }.to have_enqueued_good_job(MyJob).with(id: 123)

expect { some_method }.to have_enqueued_good_job(MyJob).with(123)

expect { some_method }.to enqueue_good_job 

I'm not using queue priority and scheduling yet, so I did not create an API to test those features.

[bensheldon]

This is great! 🎉

I have a couple of small tweaks I'd suggest, mainly using GoodJob::Job instead of GoodJob::Execution.

Also, I would accept a PR if you wanted to have the GoodJob::Adapter implement an #enqueued_jobs method. That would make this implementation look a lot closer to the regular enqueued_jobs test helper/matcher which asks the Adapter for what jobs were enqueued.

[stephannv]

Thanks @bensheldon, I will open a PR using the suggestions.