activejob 4.2.0.beta4 → 4.2.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7f0d0bb6e1251caa7d81084bb08533b08fad421
-  data.tar.gz: 68455756afb12ee46fd20d005339f53b429ffc06
+  metadata.gz: e0a61dc5a6408052bac810485af089a5c1477c39
+  data.tar.gz: af2e846dd9d0dfb548af8d181f30d8bb023c597f
 SHA512:
-  metadata.gz: ad1b0d84c6ef53c2f1c9e0859d7dc1b4d1a08dd24f2eca11c181b433cfd318984216b63e9f32330f9bbabf5581a1e4c7f7d8dd897cebab16f40f3ab05a0c484c
-  data.tar.gz: af98007efc01844df75eade2e77443043f543a120fbdc58319aa95340bcec5f5a1fac82162d098dff3de90e7fc2d680192d4094d8d41663d9de6f7425912c2f9
+  metadata.gz: 879f7096af7b18d69247b03177c43c580add3cca004f8bbaf478d44d50f30bea247a0a188f36100a072874d321312f50c2684e31ea781f0dedb265c2713fc415
+  data.tar.gz: 3f46dffac8950c8ddb2b120c1cc52ab14174d3b1782227de98edf91c75cc522471774a57f3bebee1fa1406aa624fdeb9406e42dc21dfb6195da0252f8c255198

data/README.md

@@ -5,7 +5,7 @@ of queueing backends. These jobs can be everything from regularly scheduled
 clean-ups, to billing charges, to mailings. Anything that can be chopped up into
 small units of work and run in parallel, really.
 
-It also serves as the backend for ActionMailer's #deliver_later functionality
+It also serves as the backend for Action Mailer's #deliver_later functionality
 that makes it easy to turn any mailing into a job for running later. That's
 one of the most common jobs in a modern web application: Sending emails outside
 of the request-response cycle, so the user doesn't have to wait on it.
@@ -26,7 +26,8 @@ Set the queue adapter for Active Job:
 ActiveJob::Base.queue_adapter = :inline # default queue adapter
 ```
 Note: To learn how to use your preferred queueing backend see its adapter
-documentation at ActiveJob::QueueAdapters.
+documentation at
+[ActiveJob::QueueAdapters](http://api.rubyonrails.org/classes/ActiveJob/QueueAdapters.html).
 
 Declare a job like so:
 
@@ -110,7 +111,7 @@ Source code can be downloaded as part of the Rails project on GitHub
 
 ## License
 
-ActiveJob is released under the MIT license:
+Active Job is released under the MIT license:
 
 * http://www.opensource.org/licenses/MIT
 
@@ -128,5 +129,3 @@ Bug reports can be filed for the Ruby on Rails project here:
 Feature requests should be discussed on the rails-core mailing list here:
 
 * https://groups.google.com/forum/?fromgroups#!forum/rubyonrails-core
-
-

data/lib/active_job/base.rb

@@ -32,7 +32,7 @@ module ActiveJob #:nodoc:
   #   end
   #
   # Records that are passed in are serialized/deserialized using Global
-  # Id. More information can be found in Arguments.
+  # ID. More information can be found in Arguments.
   #
   # To enqueue a job to be performed as soon the queueing system is free:
   #

data/lib/active_job/callbacks.rb

@@ -22,6 +22,8 @@ module ActiveJob
       define_callbacks :enqueue
     end
 
+    # These methods will be included into any Active Job object, adding
+    # callbacks for +perform+ and +enqueue+ methods.
     module ClassMethods
       # Defines a callback that will get called right before the
       # job's perform method is executed.

data/lib/active_job/core.rb

@@ -17,6 +17,8 @@ module ActiveJob
       attr_writer :queue_name
     end
 
+    # These methods will be included into any Active Job object, adding
+    # helpers for de/serialization and creation of job instances.
     module ClassMethods
       # Creates a new job instance from a hash created with +serialize+
       def deserialize(job_data)
@@ -48,8 +50,8 @@ module ActiveJob
       end
     end
 
-    # Creates a new job instance. Takes as arguments the arguments that
-    # will be passed to the perform method.
+    # Creates a new job instance. Takes the arguments that will be
+    # passed to the perform method.
     def initialize(*arguments)
       @arguments  = arguments
       @job_id     = SecureRandom.uuid
@@ -84,6 +86,3 @@ module ActiveJob
       end
   end
 end
-
-
-

data/lib/active_job/enqueuing.rb

@@ -4,6 +4,7 @@ module ActiveJob
   module Enqueuing
     extend ActiveSupport::Concern
 
+    # Includes the +perform_later+ method for job initialization.
     module ClassMethods
       # Push a job onto the queue. The arguments must be legal JSON types
       # (string, int, float, nil, true, false, hash or array) or
@@ -22,7 +23,7 @@ module ActiveJob
         end
     end
 
-    # Reschedule the job to be re-executed. This is useful in combination
+    # Reschedules the job to be re-executed. This is useful in combination
     # with the +rescue_from+ option. When you rescue an exception from your job
     # you can ask Active Job to retry performing your job.
     #
@@ -37,6 +38,7 @@ module ActiveJob
     #    rescue_from(ErrorLoadingSite) do
     #      retry_job queue: :low_priority
     #    end
+    #
     #    def perform(*args)
     #      # raise ErrorLoadingSite if cannot scrape
     #    end

data/lib/active_job/execution.rb

@@ -6,6 +6,7 @@ module ActiveJob
     extend ActiveSupport::Concern
     include ActiveSupport::Rescuable
 
+    # Includes methods for executing and performing jobs instantly.
     module ClassMethods
       # Performs the job immediately.
       #

data/lib/active_job/gem_version.rb

@@ -8,7 +8,7 @@ module ActiveJob
     MAJOR = 4
     MINOR = 2
     TINY  = 0
-    PRE   = "beta4"
+    PRE   = "rc1"
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/active_job/logging.rb

@@ -75,7 +75,7 @@ module ActiveJob
       def perform(event)
         info do
           job = event.payload[:job]
-          "Performed #{job.class.name} from #{queue_name(event)} in #{event.duration.round(2).to_s}ms"
+          "Performed #{job.class.name} from #{queue_name(event)} in #{event.duration.round(2)}ms"
         end
       end
 

data/lib/active_job/queue_adapter.rb

@@ -2,9 +2,12 @@ require 'active_job/queue_adapters/inline_adapter'
 require 'active_support/core_ext/string/inflections'
 
 module ActiveJob
+  # The <tt>ActionJob::QueueAdapter</tt> module is used to load the 
+  # correct adapter. The default queue adapter is the :inline queue.
   module QueueAdapter #:nodoc:
     extend ActiveSupport::Concern
 
+    # Includes the setter method for changing the active queue adapter.
     module ClassMethods
       mattr_reader(:queue_adapter) { ActiveJob::QueueAdapters::InlineAdapter }
 

data/lib/active_job/queue_adapters.rb

@@ -13,12 +13,13 @@ module ActiveJob
   # * {Sneakers}[https://github.com/jondot/sneakers]
   # * {Sucker Punch}[https://github.com/brandonhilkert/sucker_punch]
   #
-  # #### Backends Features
+  # === Backends Features
   #
   #   |                   | Async | Queues | Delayed   | Priorities | Timeout | Retries |
   #   |-------------------|-------|--------|-----------|------------|---------|---------|
   #   | Backburner        | Yes   | Yes    | Yes       | Yes        | Job     | Global  |
   #   | Delayed Job       | Yes   | Yes    | Yes       | Job        | Global  | Global  |
+  #   | Qu                | Yes   | Yes    | No        | No         | No      | Global  |
   #   | Que               | Yes   | Yes    | Yes       | Job        | No      | Job     |
   #   | queue_classic     | Yes   | Yes    | No*       | No         | No      | No      |
   #   | Resque            | Yes   | Yes    | Yes (Gem) | Queue      | Global  | Yes     |

data/lib/active_job/queue_adapters/delayed_job_adapter.rb

@@ -6,10 +6,10 @@ module ActiveJob
     #
     # Delayed::Job (or DJ) encapsulates the common pattern of asynchronously
     # executing longer tasks in the background. Although DJ can have many
-    # storage backends one of the most used is based on Active Record.
+    # storage backends, one of the most used is based on Active Record.
     # Read more about Delayed Job {here}[https://github.com/collectiveidea/delayed_job].
     #
-    # To use Delayed Job set the queue_adapter config to +:delayed_job+.
+    # To use Delayed Job, set the queue_adapter config to +:delayed_job+.
     #
     #   Rails.application.config.active_job.queue_adapter = :delayed_job
     class DelayedJobAdapter

data/lib/active_job/queue_name.rb

@@ -2,6 +2,7 @@ module ActiveJob
   module QueueName
     extend ActiveSupport::Concern
 
+    # Includes the ability to override the default queue name and prefix.
     module ClassMethods
       mattr_accessor(:queue_name_prefix)
       mattr_accessor(:default_queue_name) { "default" }

data/lib/active_job/test_helper.rb

@@ -53,7 +53,7 @@ module ActiveJob
         end
       end
 
-      # Assert that no job have been enqueued.
+      # Asserts that no jobs have been enqueued.
       #
       #   def test_jobs
       #     assert_no_enqueued_jobs
@@ -77,13 +77,21 @@ module ActiveJob
       end
 
       # Asserts that the number of performed jobs matches the given number.
+      # If no block is passed, <tt>perform_enqueued_jobs</tt>
+      # must be called around the job call.
       #
       #   def test_jobs
       #     assert_performed_jobs 0
-      #     HelloJob.perform_later('xavier')
+      #
+      #     perform_enqueued_jobs do
+      #       HelloJob.perform_later('xavier')
+      #     end
       #     assert_performed_jobs 1
-      #     HelloJob.perform_later('yves')
-      #     assert_performed_jobs 2
+      #
+      #     perform_enqueued_jobs do
+      #       HelloJob.perform_later('yves')
+      #       assert_performed_jobs 2
+      #     end
       #   end
       #
       # If a block is passed, that block should cause the specified number of
@@ -102,7 +110,7 @@ module ActiveJob
       def assert_performed_jobs(number)
         if block_given?
           original_count = performed_jobs.size
-          yield
+          perform_enqueued_jobs { yield }
           new_count = performed_jobs.size
           assert_equal original_count + number, new_count,
                        "#{number} jobs expected, but #{new_count - original_count} were performed"
@@ -116,8 +124,11 @@ module ActiveJob
       #
       #   def test_jobs
       #     assert_no_performed_jobs
-      #     HelloJob.perform_later('matthew')
-      #     assert_performed_jobs 1
+      #
+      #     perform_enqueued_jobs do
+      #       HelloJob.perform_later('matthew')
+      #       assert_performed_jobs 1
+      #     end
       #   end
       #
       # If a block is passed, that block should not cause any job to be performed.
@@ -137,7 +148,7 @@ module ActiveJob
 
       # Asserts that the job passed in the block has been enqueued with the given arguments.
       #
-      #   def assert_enqueued_job
+      #   def test_assert_enqueued_with
       #     assert_enqueued_with(job: MyJob, args: [1,2,3], queue: 'low') do
       #       MyJob.perform_later(1,2,3)
       #     end
@@ -166,7 +177,7 @@ module ActiveJob
         original_performed_jobs = performed_jobs.dup
         clear_performed_jobs
         args.assert_valid_keys(:job, :args, :at, :queue)
-        yield
+        perform_enqueued_jobs { yield }
         matching_job = performed_jobs.any? do |job|
           args.all? { |key, value| value == job[key] }
         end
@@ -175,6 +186,17 @@ module ActiveJob
         queue_adapter.performed_jobs = original_performed_jobs + performed_jobs
       end
 
+      def perform_enqueued_jobs
+        @old_perform_enqueued_jobs = queue_adapter.perform_enqueued_jobs
+        @old_perform_enqueued_at_jobs = queue_adapter.perform_enqueued_at_jobs
+        queue_adapter.perform_enqueued_jobs = true
+        queue_adapter.perform_enqueued_at_jobs = true
+        yield
+      ensure
+        queue_adapter.perform_enqueued_jobs = @old_perform_enqueued_jobs
+        queue_adapter.perform_enqueued_at_jobs = @old_perform_enqueued_at_jobs
+      end
+
       def queue_adapter
         ActiveJob::Base.queue_adapter
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activejob
 version: !ruby/object:Gem::Version
-  version: 4.2.0.beta4
+  version: 4.2.0.rc1
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-30 00:00:00.000000000 Z
+date: 2014-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,26 +16,26 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0.beta4
+        version: 4.2.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0.beta4
+        version: 4.2.0.rc1
 - !ruby/object:Gem::Dependency
   name: globalid
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.3.0
 description: Declare job classes that can be run by a variety of queueing backends.
@@ -87,17 +87,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Job framework with pluggable queues.