activejob 5.0.7.2 → 5.1.0.beta1

data/lib/active_job/queue_adapters/backburner_adapter.rb

@@ -1,4 +1,4 @@
-require 'backburner'
+require "backburner"
 
 module ActiveJob
   module QueueAdapters

data/lib/active_job/queue_adapters/delayed_job_adapter.rb

@@ -1,4 +1,4 @@
-require 'delayed_job'
+require "delayed_job"
 
 module ActiveJob
   module QueueAdapters

data/lib/active_job/queue_adapters/qu_adapter.rb

@@ -1,4 +1,4 @@
-require 'qu'
+require "qu"
 
 module ActiveJob
   module QueueAdapters
@@ -20,7 +20,7 @@ module ActiveJob
         qu_job = Qu::Payload.new(klass: JobWrapper, args: [job.serialize]).tap do |payload|
           payload.instance_variable_set(:@queue, job.queue_name)
         end.push
-        
+
         # qu_job can be nil depending on the configured backend
         job.provider_job_id = qu_job.id unless qu_job.nil?
         qu_job
@@ -32,7 +32,7 @@ module ActiveJob
 
       class JobWrapper < Qu::Job #:nodoc:
         def initialize(job_data)
-          @job_data  = job_data
+          @job_data = job_data
         end
 
         def perform

data/lib/active_job/queue_adapters/que_adapter.rb

@@ -1,4 +1,4 @@
-require 'que'
+require "que"
 
 module ActiveJob
   module QueueAdapters

data/lib/active_job/queue_adapters/queue_classic_adapter.rb

@@ -1,4 +1,4 @@
-require 'queue_classic'
+require "queue_classic"
 
 module ActiveJob
   module QueueAdapters
@@ -26,9 +26,9 @@ module ActiveJob
       def enqueue_at(job, timestamp) #:nodoc:
         queue = build_queue(job.queue_name)
         unless queue.respond_to?(:enqueue_at)
-          raise NotImplementedError, 'To be able to schedule jobs with queue_classic ' \
-            'the QC::Queue needs to respond to `enqueue_at(timestamp, method, *args)`. ' \
-            'You can implement this yourself or you can use the queue_classic-later gem.'
+          raise NotImplementedError, "To be able to schedule jobs with queue_classic " \
+            "the QC::Queue needs to respond to `enqueue_at(timestamp, method, *args)`. " \
+            "You can implement this yourself or you can use the queue_classic-later gem."
         end
         qc_job = queue.enqueue_at(timestamp, "#{JobWrapper.name}.perform", job.serialize)
         job.provider_job_id = qc_job["id"] if qc_job.is_a?(Hash)

data/lib/active_job/queue_adapters/resque_adapter.rb

@@ -1,12 +1,12 @@
-require 'resque'
-require 'active_support/core_ext/enumerable'
-require 'active_support/core_ext/array/access'
+require "resque"
+require "active_support/core_ext/enumerable"
+require "active_support/core_ext/array/access"
 
 begin
-  require 'resque-scheduler'
+  require "resque-scheduler"
 rescue LoadError
   begin
-    require 'resque_scheduler'
+    require "resque_scheduler"
   rescue LoadError
     false
   end

data/lib/active_job/queue_adapters/sidekiq_adapter.rb

@@ -1,4 +1,4 @@
-require 'sidekiq'
+require "sidekiq"
 
 module ActiveJob
   module QueueAdapters
@@ -18,26 +18,26 @@ module ActiveJob
       def enqueue(job) #:nodoc:
         #Sidekiq::Client does not support symbols as keys
         job.provider_job_id = Sidekiq::Client.push \
-          'class'   => JobWrapper,
-          'wrapped' => job.class.to_s,
-          'queue'   => job.queue_name,
-          'args'    => [ job.serialize ]
+          "class"   => JobWrapper,
+          "wrapped" => job.class.to_s,
+          "queue"   => job.queue_name,
+          "args"    => [ job.serialize ]
       end
 
       def enqueue_at(job, timestamp) #:nodoc:
         job.provider_job_id = Sidekiq::Client.push \
-          'class'   => JobWrapper,
-          'wrapped' => job.class.to_s,
-          'queue'   => job.queue_name,
-          'args'    => [ job.serialize ],
-          'at'      => timestamp
+          "class"   => JobWrapper,
+          "wrapped" => job.class.to_s,
+          "queue"   => job.queue_name,
+          "args"    => [ job.serialize ],
+          "at"      => timestamp
       end
 
       class JobWrapper #:nodoc:
         include Sidekiq::Worker
 
         def perform(job_data)
-          Base.execute job_data.merge('provider_job_id' => jid)
+          Base.execute job_data.merge("provider_job_id" => jid)
         end
       end
     end

data/lib/active_job/queue_adapters/sneakers_adapter.rb

@@ -1,5 +1,5 @@
-require 'sneakers'
-require 'monitor'
+require "sneakers"
+require "monitor"
 
 module ActiveJob
   module QueueAdapters
@@ -33,7 +33,7 @@ module ActiveJob
 
       class JobWrapper #:nodoc:
         include Sneakers::Worker
-        from_queue 'default'
+        from_queue "default"
 
         def work(msg)
           job_data = ActiveSupport::JSON.decode(msg)

data/lib/active_job/queue_adapters/sucker_punch_adapter.rb

@@ -1,11 +1,11 @@
-require 'sucker_punch'
+require "sucker_punch"
 
 module ActiveJob
   module QueueAdapters
     # == Sucker Punch adapter for Active Job
     #
     # Sucker Punch is a single-process Ruby asynchronous processing library.
-    # This reduces the cost of of hosting on a service like Heroku along
+    # This reduces the cost of hosting on a service like Heroku along
     # with the memory footprint of having to maintain additional jobs if
     # hosting on a dedicated server. All queues can run within a
     # single application (eg. Rails, Sinatra, etc.) process.
@@ -31,7 +31,7 @@ module ActiveJob
           delay = timestamp - Time.current.to_f
           JobWrapper.perform_in delay, job.serialize
         else
-          raise NotImplementedError, 'sucker_punch 1.0 does not support `enqueued_at`. Please upgrade to version ~> 2.0.0 to enable this behavior.'
+          raise NotImplementedError, "sucker_punch 1.0 does not support `enqueued_at`. Please upgrade to version ~> 2.0.0 to enable this behavior."
         end
       end
 

data/lib/active_job/queue_adapters/test_adapter.rb

@@ -24,37 +24,33 @@ module ActiveJob
       end
 
       def enqueue(job) #:nodoc:
-        return if filtered?(job)
-
         job_data = job_to_hash(job)
         enqueue_or_perform(perform_enqueued_jobs, job, job_data)
       end
 
       def enqueue_at(job, timestamp) #:nodoc:
-        return if filtered?(job)
-
         job_data = job_to_hash(job, at: timestamp)
         enqueue_or_perform(perform_enqueued_at_jobs, job, job_data)
       end
 
       private
 
-      def job_to_hash(job, extras = {})
-        { job: job.class, args: job.serialize.fetch('arguments'), queue: job.queue_name }.merge!(extras)
-      end
+        def job_to_hash(job, extras = {})
+          { job: job.class, args: job.serialize.fetch("arguments"), queue: job.queue_name }.merge!(extras)
+        end
 
-      def enqueue_or_perform(perform, job, job_data)
-        if perform
-          performed_jobs << job_data
-          Base.execute job.serialize
-        else
-          enqueued_jobs << job_data
+        def enqueue_or_perform(perform, job, job_data)
+          if !perform || filtered?(job)
+            enqueued_jobs << job_data
+          else
+            performed_jobs << job_data
+            Base.execute job.serialize
+          end
         end
-      end
 
-      def filtered?(job)
-        filter && !Array(filter).include?(job.class)
-      end
+        def filtered?(job)
+          filter && !Array(filter).include?(job.class)
+        end
     end
   end
 end

data/lib/active_job/queue_name.rb

@@ -16,7 +16,7 @@ module ActiveJob
       #       post.to_feed!
       #     end
       #   end
-      def queue_as(part_name=nil, &block)
+      def queue_as(part_name = nil, &block)
         if block_given?
           self.queue_name = block
         else
@@ -36,7 +36,7 @@ module ActiveJob
       class_attribute :queue_name_delimiter, instance_accessor: false
 
       self.queue_name = default_queue_name
-      self.queue_name_delimiter = '_' # set default delimiter to '_'
+      self.queue_name_delimiter = "_" # set default delimiter to '_'
     end
 
     # Returns the name of the queue the job will be run on.
@@ -46,6 +46,5 @@ module ActiveJob
       end
       @queue_name
     end
-
   end
 end

data/lib/active_job/queue_priority.rb

@@ -17,7 +17,7 @@ module ActiveJob
       #   end
       #
       # Specify either an argument or a block.
-      def queue_with_priority(priority=nil, &block)
+      def queue_with_priority(priority = nil, &block)
         if block_given?
           self.priority = block
         else
@@ -39,6 +39,5 @@ module ActiveJob
       end
       @priority
     end
-
   end
 end

data/lib/active_job/railtie.rb

@@ -1,12 +1,12 @@
-require 'global_id/railtie'
-require 'active_job'
+require "global_id/railtie"
+require "active_job"
 
 module ActiveJob
   # = Active Job Railtie
   class Railtie < Rails::Railtie # :nodoc:
     config.active_job = ActiveSupport::OrderedOptions.new
 
-    initializer 'active_job.logger' do
+    initializer "active_job.logger" do
       ActiveSupport.on_load(:active_job) { self.logger = ::Rails.logger }
     end
 
@@ -15,7 +15,7 @@ module ActiveJob
       options.queue_adapter ||= :async
 
       ActiveSupport.on_load(:active_job) do
-        options.each { |k,v| send("#{k}=", v) }
+        options.each { |k, v| send("#{k}=", v) }
       end
     end
 

data/lib/active_job/test_case.rb

@@ -1,4 +1,4 @@
-require 'active_support/test_case'
+require "active_support/test_case"
 
 module ActiveJob
   class TestCase < ActiveSupport::TestCase

data/lib/active_job/test_helper.rb

@@ -1,5 +1,5 @@
-require 'active_support/core_ext/class/subclasses'
-require 'active_support/core_ext/hash/keys'
+require "active_support/core_ext/class/subclasses"
+require "active_support/core_ext/hash/keys"
 
 module ActiveJob
   # Provides helper methods for testing Active Job
@@ -8,16 +8,35 @@ module ActiveJob
       :performed_jobs, :performed_jobs=,
       to: :queue_adapter
 
+    module TestQueueAdapter
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :_test_adapter, instance_accessor: false, instance_predicate: false
+      end
+
+      module ClassMethods
+        def queue_adapter
+          self._test_adapter.nil? ? super : self._test_adapter
+        end
+
+        def disable_test_adapter
+          self._test_adapter = nil
+        end
+
+        def enable_test_adapter(test_adapter)
+          self._test_adapter = test_adapter
+        end
+      end
+    end
+
+    ActiveJob::Base.include(TestQueueAdapter)
+
     def before_setup # :nodoc:
       test_adapter = queue_adapter_for_test
 
-      @old_queue_adapters = (ActiveJob::Base.descendants << ActiveJob::Base).select do |klass|
-        # only override explicitly set adapters, a quirk of `class_attribute`
-        klass.singleton_class.public_instance_methods(false).include?(:_queue_adapter)
-      end.map do |klass|
-        [klass, klass.queue_adapter].tap do
-          klass.queue_adapter = test_adapter
-        end
+      queue_adapter_changed_jobs.each do |klass|
+        klass.enable_test_adapter(test_adapter)
       end
 
       clear_enqueued_jobs
@@ -27,9 +46,8 @@ module ActiveJob
 
     def after_teardown # :nodoc:
       super
-      @old_queue_adapters.each do |(klass, adapter)|
-        klass.queue_adapter = adapter
-      end
+
+      queue_adapter_changed_jobs.each { |klass| klass.disable_test_adapter }
     end
 
     # Specifies the queue adapter to use with all active job test helpers.
@@ -55,7 +73,7 @@ module ActiveJob
     #     assert_enqueued_jobs 2
     #   end
     #
-    # If a block is passed, that block should cause the specified number of
+    # If a block is passed, that block will cause the specified number of
     # jobs to be enqueued.
     #
     #   def test_jobs_again
@@ -77,14 +95,23 @@ module ActiveJob
     #       HelloJob.perform_later('jeremy')
     #     end
     #   end
-    def assert_enqueued_jobs(number, only: nil)
+    #
+    # The number of times a job is enqueued to a specific queue can also be asserted.
+    #
+    #   def test_logging_job
+    #     assert_enqueued_jobs 2, queue: 'default' do
+    #       LoggingJob.perform_later
+    #       HelloJob.perform_later('elfassy')
+    #     end
+    #   end
+    def assert_enqueued_jobs(number, only: nil, queue: nil)
       if block_given?
-        original_count = enqueued_jobs_size(only: only)
+        original_count = enqueued_jobs_size(only: only, queue: queue)
         yield
-        new_count = enqueued_jobs_size(only: only)
+        new_count = enqueued_jobs_size(only: only, queue: queue)
         assert_equal number, new_count - original_count, "#{number} jobs expected, but #{new_count - original_count} were enqueued"
       else
-        actual_count = enqueued_jobs_size(only: only)
+        actual_count = enqueued_jobs_size(only: only, queue: queue)
         assert_equal number, actual_count, "#{number} jobs expected, but #{actual_count} were enqueued"
       end
     end
@@ -232,16 +259,16 @@ module ActiveJob
     #       MyJob.set(wait_until: Date.tomorrow.noon).perform_later
     #     end
     #   end
-    def assert_enqueued_with(args = {})
+    def assert_enqueued_with(job: nil, args: nil, at: nil, queue: nil)
       original_enqueued_jobs_count = enqueued_jobs.count
-      args.assert_valid_keys(:job, :args, :at, :queue)
-      serialized_args = serialize_args_for_assertion(args)
+      expected = { job: job, args: args, at: at, queue: queue }.compact
+      serialized_args = serialize_args_for_assertion(expected)
       yield
       in_block_jobs = enqueued_jobs.drop(original_enqueued_jobs_count)
-      matching_job = in_block_jobs.find do |job|
-        serialized_args.all? { |key, value| value == job[key] }
+      matching_job = in_block_jobs.find do |in_block_job|
+        serialized_args.all? { |key, value| value == in_block_job[key] }
       end
-      assert matching_job, "No enqueued job found with #{args}"
+      assert matching_job, "No enqueued job found with #{expected}"
       instantiate_job(matching_job)
     end
 
@@ -256,16 +283,16 @@ module ActiveJob
     #       MyJob.set(wait_until: Date.tomorrow.noon).perform_later
     #     end
     #   end
-    def assert_performed_with(args = {})
+    def assert_performed_with(job: nil, args: nil, at: nil, queue: nil)
       original_performed_jobs_count = performed_jobs.count
-      args.assert_valid_keys(:job, :args, :at, :queue)
-      serialized_args = serialize_args_for_assertion(args)
+      expected = { job: job, args: args, at: at, queue: queue }.compact
+      serialized_args = serialize_args_for_assertion(expected)
       perform_enqueued_jobs { yield }
       in_block_jobs = performed_jobs.drop(original_performed_jobs_count)
-      matching_job = in_block_jobs.find do |job|
-        serialized_args.all? { |key, value| value == job[key] }
+      matching_job = in_block_jobs.find do |in_block_job|
+        serialized_args.all? { |key, value| value == in_block_job[key] }
       end
-      assert matching_job, "No performed job found with #{args}"
+      assert matching_job, "No performed job found with #{expected}"
       instantiate_job(matching_job)
     end
 
@@ -284,7 +311,7 @@ module ActiveJob
     #   def test_perform_enqueued_jobs_with_only
     #     perform_enqueued_jobs(only: MyJob) do
     #       MyJob.perform_later(1, 2, 3) # will be performed
-    #       HelloJob.perform_later(1, 2, 3) # will not be perfomed
+    #       HelloJob.perform_later(1, 2, 3) # will not be performed
     #     end
     #     assert_performed_jobs 1
     #   end
@@ -315,34 +342,46 @@ module ActiveJob
     end
 
     private
-      def clear_enqueued_jobs # :nodoc:
+      def clear_enqueued_jobs
         enqueued_jobs.clear
       end
 
-      def clear_performed_jobs # :nodoc:
+      def clear_performed_jobs
         performed_jobs.clear
       end
 
-      def enqueued_jobs_size(only: nil) # :nodoc:
-        if only
-          enqueued_jobs.count { |job| Array(only).include?(job.fetch(:job)) }
-        else
-          enqueued_jobs.count
+      def enqueued_jobs_size(only: nil, queue: nil)
+        enqueued_jobs.count do |job|
+          job_class = job.fetch(:job)
+          if only
+            next false unless Array(only).include?(job_class)
+          end
+          if queue
+            next false unless queue.to_s == job.fetch(:queue, job_class.queue_name)
+          end
+          true
         end
       end
 
-      def serialize_args_for_assertion(args) # :nodoc:
+      def serialize_args_for_assertion(args)
         args.dup.tap do |serialized_args|
           serialized_args[:args] = ActiveJob::Arguments.serialize(serialized_args[:args]) if serialized_args[:args]
           serialized_args[:at]   = serialized_args[:at].to_f if serialized_args[:at]
         end
       end
 
-      def instantiate_job(payload) # :nodoc:
+      def instantiate_job(payload)
         job = payload[:job].new(*payload[:args])
         job.scheduled_at = Time.at(payload[:at]) if payload.key?(:at)
         job.queue_name = payload[:queue]
         job
       end
+
+      def queue_adapter_changed_jobs
+        (ActiveJob::Base.descendants << ActiveJob::Base).select do |klass|
+          # only override explicitly set adapters, a quirk of `class_attribute`
+          klass.singleton_class.public_instance_methods(false).include?(:_queue_adapter)
+        end
+      end
   end
 end