123456789_123456789_123456789_123456789_123456789_

Class: ActiveJob::QueueAdapters::TestAdapter

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, AbstractAdapter
Instance Chain:
self, AbstractAdapter
Inherits: ActiveJob::QueueAdapters::AbstractAdapter
Defined in: activejob/lib/active_job/queue_adapters/test_adapter.rb

Overview

Test adapter for Active Job

The test adapter should be used only in testing. Along with ::ActiveJob::TestCase and ::ActiveJob::TestHelper it makes a great tool to test your Rails application.

To use the test adapter set queue_adapter config to :test.

Rails.application.config.active_job.queue_adapter = :test

Class Method Summary

Instance Attribute Summary

AbstractAdapter - Inherited

#enqueue_after_transaction_commit?

Defines whether enqueuing should happen implicitly to after commit when called from inside a transaction.

Instance Method Summary

AbstractAdapter - Inherited

#enqueue, #enqueue_at

Constructor Details

.new(enqueue_after_transaction_commit: true) ⇒ TestAdapter

[ GitHub ] 

  


# File 'activejob/lib/active_job/queue_adapters/test_adapter.rb', line 18



def initialize(enqueue_after_transaction_commit: true)
  @enqueue_after_transaction_commit = enqueue_after_transaction_commit
end


  







Instance Attribute Details



  

    #at   (rw)
  

  [ GitHub ]


  

  


# File 'activejob/lib/active_job/queue_adapters/test_adapter.rb', line 15



attr_accessor(:perform_enqueued_jobs, :perform_enqueued_at_jobs, :filter, :reject, :queue, :at, :enqueue_after_transaction_commit)


  








  

    #enqueue_after_transaction_commit   (rw)
  

  [ GitHub ]


  

  


# File 'activejob/lib/active_job/queue_adapters/test_adapter.rb', line 15



attr_accessor(:perform_enqueued_jobs, :perform_enqueued_at_jobs, :filter, :reject, :queue, :at, :enqueue_after_transaction_commit)


  








  

    #enqueued_jobs   (rw)
  



  

    

Provides a store of all the enqueued jobs with the TestAdapter so you can check them.


  



  [ GitHub ]


  

  


# File 'activejob/lib/active_job/queue_adapters/test_adapter.rb', line 27



def enqueued_jobs
  @enqueued_jobs ||= []
end


  








  

    #enqueued_jobs=(value)   (rw)
  

  [ GitHub ]


  

  


# File 'activejob/lib/active_job/queue_adapters/test_adapter.rb', line 16



attr_writer(:enqueued_jobs, :performed_jobs)


  








  

    #filter   (rw)
  

  [ GitHub ]


  

  


# File 'activejob/lib/active_job/queue_adapters/test_adapter.rb', line 15



attr_accessor(:perform_enqueued_jobs, :perform_enqueued_at_jobs, :filter, :reject, :queue, :at, :enqueue_after_transaction_commit)


  








  

    #perform_enqueued_at_jobs   (rw)
  

  [ GitHub ]


  

  


# File 'activejob/lib/active_job/queue_adapters/test_adapter.rb', line 15



attr_accessor(:perform_enqueued_jobs, :perform_enqueued_at_jobs, :filter, :reject, :queue, :at, :enqueue_after_transaction_commit)


  








  

    #perform_enqueued_jobs   (rw)
  

  [ GitHub ]


  

  


# File 'activejob/lib/active_job/queue_adapters/test_adapter.rb', line 15



attr_accessor(:perform_enqueued_jobs, :perform_enqueued_at_jobs, :filter, :reject, :queue, :at, :enqueue_after_transaction_commit)


  








  

    #performed_jobs   (rw)
  



  

    

Provides a store of all the performed jobs with the TestAdapter so you can check them.


  



  [ GitHub ]


  

  


# File 'activejob/lib/active_job/queue_adapters/test_adapter.rb', line 32



def performed_jobs
  @performed_jobs ||= []
end


  








  

    #performed_jobs=(value)   (rw)
  

  [ GitHub ]


  

  


# File 'activejob/lib/active_job/queue_adapters/test_adapter.rb', line 16



attr_writer(:enqueued_jobs, :performed_jobs)


  








  

    #queue   (rw)
  

  [ GitHub ]


  

  


# File 'activejob/lib/active_job/queue_adapters/test_adapter.rb', line 15



attr_accessor(:perform_enqueued_jobs, :perform_enqueued_at_jobs, :filter, :reject, :queue, :at, :enqueue_after_transaction_commit)


  








  

    #reject   (rw)
  

  [ GitHub ]


  

  


# File 'activejob/lib/active_job/queue_adapters/test_adapter.rb', line 15



attr_accessor(:perform_enqueued_jobs, :perform_enqueued_at_jobs, :filter, :reject, :queue, :at, :enqueue_after_transaction_commit)