activejob 4.2.0.beta3 → 4.2.0.beta4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5a2b58acaf46d3c73b8e4912dae2b8eb8641925
-  data.tar.gz: c5e4a57013c1b509b26ee75f915eb22a1df9cf7f
+  metadata.gz: b7f0d0bb6e1251caa7d81084bb08533b08fad421
+  data.tar.gz: 68455756afb12ee46fd20d005339f53b429ffc06
 SHA512:
-  metadata.gz: 5dc374de91f62afd1b734992fdde22c5165164f296dc336e043e3c33d2de0054e0e7e26838ce1b4b46d7e1bffddaf5c56bb99f145cf76ac1d7c8793215f55a31
-  data.tar.gz: 8527e31bdbb06eb5afaf8502023c38688ffc7d5c7a7ec2227ef2d70b3918b7f4df8064238040a11fb3006e9fedd0227ef41d905d0d0ad19739a317e7eb560ed2
+  metadata.gz: ad1b0d84c6ef53c2f1c9e0859d7dc1b4d1a08dd24f2eca11c181b433cfd318984216b63e9f32330f9bbabf5581a1e4c7f7d8dd897cebab16f40f3ab05a0c484c
+  data.tar.gz: af98007efc01844df75eade2e77443043f543a120fbdc58319aa95340bcec5f5a1fac82162d098dff3de90e7fc2d680192d4094d8d41663d9de6f7425912c2f9

data/lib/active_job/arguments.rb

@@ -24,10 +24,16 @@ module ActiveJob
     extend self
     TYPE_WHITELIST = [ NilClass, Fixnum, Float, String, TrueClass, FalseClass, Bignum ]
 
+    # Serializes a set of arguments. Whitelisted types are returned
+    # as-is. Arrays/Hashes are serialized element by element.
+    # All other types are serialized using GlobalID.
     def serialize(arguments)
       arguments.map { |argument| serialize_argument(argument) }
     end
 
+    # Deserializes a set of arguments. Whitelisted types are returned
+    # as-is. Arrays/Hashes are deserialized element by element.
+    # All other types are deserialized using GlobalID.
     def deserialize(arguments)
       arguments.map { |argument| deserialize_argument(argument) }
     rescue => e

data/lib/active_job/base.rb

@@ -6,7 +6,52 @@ require 'active_job/execution'
 require 'active_job/callbacks'
 require 'active_job/logging'
 
-module ActiveJob
+module ActiveJob #:nodoc:
+  # = Active Job
+  #
+  # Active Job objects can be configured to work with different backend
+  # queuing frameworks. To specify a queue adapter to use:
+  #
+  #   ActiveJob::Base.queue_adapter = :inline
+  #
+  # A list of supported adapters can be found in QueueAdapters.
+  #
+  # Active Job objects can be defined by creating a class that inherits
+  # from the ActiveJob::Base class. The only necessary method to
+  # implement is the "perform" method.
+  #
+  # To define an Active Job object:
+  #
+  #   class ProcessPhotoJob < ActiveJob::Base
+  #     def perform(photo)
+  #       photo.watermark!('Rails')
+  #       photo.rotate!(90.degrees)
+  #       photo.resize_to_fit!(300, 300)
+  #       photo.upload!
+  #     end
+  #   end
+  #
+  # Records that are passed in are serialized/deserialized using Global
+  # Id. More information can be found in Arguments.
+  #
+  # To enqueue a job to be performed as soon the queueing system is free:
+  #
+  #   ProcessPhotoJob.perform_later(photo)
+  #
+  # To enqueue a job to be processed at some point in the future:
+  #
+  #   ProcessPhotoJob.set(wait_until: Date.tomorrow.noon).perform_later(photo)
+  #
+  # More information can be found in ActiveJob::Core::ClassMethods#set
+  #
+  # A job can also be processed immediately without sending to the queue:
+  #
+  #  ProcessPhotoJob.perform_now(photo)
+  #
+  # == Exceptions
+  #
+  # * DeserializationError - Error class for deserialization errors.
+  # * SerializationError - Error class for serialization errors.
   class Base
     include Core
     include QueueAdapter

data/lib/active_job/core.rb

@@ -40,9 +40,9 @@ module ActiveJob
       #
       #    VideoJob.set(queue: :some_queue).perform_later(Video.last)
       #    VideoJob.set(wait: 5.minutes).perform_later(Video.last)
-      #    VideoJob.set(wait_until: Time.tomorroe).perform_later(Video.last)
+      #    VideoJob.set(wait_until: Time.now.tomorrow).perform_later(Video.last)
       #    VideoJob.set(queue: :some_queue, wait: 5.minutes).perform_later(Video.last)
-      #    VideoJob.set(queue: :some_queue, wait_until: Time.tomorroe).perform_later(Video.last)
+      #    VideoJob.set(queue: :some_queue, wait_until: Time.now.tomorrow).perform_later(Video.last)
       def set(options={})
         ConfiguredJob.new(self, options)
       end

data/lib/active_job/enqueuing.rb

@@ -10,7 +10,7 @@ module ActiveJob
       # GlobalID::Identification instances. Arbitrary Ruby objects
       # are not supported.
       #
-      # Returns an instance of the job class queued with args available in
+      # Returns an instance of the job class queued with arguments available in
       # Job#arguments.
       def perform_later(*args)
         job_or_instantiate(*args).enqueue

data/lib/active_job/gem_version.rb

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

data/lib/active_job/logging.rb

@@ -3,7 +3,7 @@ require 'active_support/tagged_logging'
 require 'active_support/logger'
 
 module ActiveJob
-  module Logging
+  module Logging #:nodoc:
     extend ActiveSupport::Concern
 
     included do

data/lib/active_job/queue_adapter.rb

@@ -2,12 +2,15 @@ require 'active_job/queue_adapters/inline_adapter'
 require 'active_support/core_ext/string/inflections'
 
 module ActiveJob
-  module QueueAdapter
+  module QueueAdapter #:nodoc:
     extend ActiveSupport::Concern
 
     module ClassMethods
       mattr_reader(:queue_adapter) { ActiveJob::QueueAdapters::InlineAdapter }
 
+      # Specify the backend queue provider. The default queue adapter
+      # is the :inline queue. See QueueAdapters for more
+      # information.
       def queue_adapter=(name_or_adapter)
         @@queue_adapter = \
           case name_or_adapter
@@ -26,4 +29,4 @@ module ActiveJob
         end
     end
   end
-end
+end

data/lib/active_job/queue_adapters.rb

@@ -7,7 +7,7 @@ module ActiveJob
   # * {Delayed Job}[https://github.com/collectiveidea/delayed_job]
   # * {Qu}[https://github.com/bkeepers/qu]
   # * {Que}[https://github.com/chanks/que]
-  # * {QueueClassic 2.x}[https://github.com/ryandotsmith/queue_classic/tree/v2.2.3]
+  # * {queue_classic}[https://github.com/QueueClassic/queue_classic]
   # * {Resque 1.x}[https://github.com/resque/resque/tree/1-x-stable]
   # * {Sidekiq}[http://sidekiq.org]
   # * {Sneakers}[https://github.com/jondot/sneakers]
@@ -20,7 +20,7 @@ module ActiveJob
   #   | Backburner        | Yes   | Yes    | Yes       | Yes        | Job     | Global  |
   #   | Delayed Job       | Yes   | Yes    | Yes       | Job        | Global  | Global  |
   #   | Que               | Yes   | Yes    | Yes       | Job        | No      | Job     |
-  #   | Queue Classic     | Yes   | Yes    | No*       | No         | No      | No      |
+  #   | queue_classic     | Yes   | Yes    | No*       | No         | No      | No      |
   #   | Resque            | Yes   | Yes    | Yes (Gem) | Queue      | Global  | Yes     |
   #   | Sidekiq           | Yes   | Yes    | Yes       | Queue      | No      | Job     |
   #   | Sneakers          | Yes   | Yes    | No        | Queue      | Queue   | No      |
@@ -29,7 +29,7 @@ module ActiveJob
   #   | Active Job        | Yes   | Yes    | Yes       | No         | No      | No      |
   #
   # NOTE:
-  # Queue Classic does not support Job scheduling. However you can implement this
+  # queue_classic does not support Job scheduling. However you can implement this
   # yourself or you can use the queue_classic-later gem. See the documentation for
   # ActiveJob::QueueAdapters::QueueClassicAdapter.
   #

data/lib/active_job/queue_adapters/inline_adapter.rb

@@ -15,7 +15,7 @@ module ActiveJob
         end
 
         def enqueue_at(*) #:nodoc:
-          raise NotImplementedError.new("Use a queueing backend to enqueue jobs in the future. Read more at https://github.com/rails/activejob")
+          raise NotImplementedError.new("Use a queueing backend to enqueue jobs in the future. Read more at http://guides.rubyonrails.org/v4.2.0/active_job_basics.html")
         end
       end
     end

data/lib/active_job/queue_adapters/qu_adapter.rb

@@ -6,11 +6,11 @@ module ActiveJob
     #
     # Qu is a Ruby library for queuing and processing background jobs. It is
     # heavily inspired by delayed_job and Resque. Qu was created to overcome
-    # some shortcomings in the existing queuing libraries that we experienced.
+    # some shortcomings in the existing queuing libraries.
     # The advantages of Qu are: Multiple backends (redis, mongo), jobs are
     # requeued when worker is killed, resque-like API.
     #
-    # Read more about Que {here}[https://github.com/bkeepers/qu].
+    # Read more about Qu {here}[https://github.com/bkeepers/qu].
     #
     # To use Qu set the queue_adapter config to +:qu+.
     #

data/lib/active_job/queue_adapters/queue_classic_adapter.rb

@@ -2,7 +2,7 @@ require 'queue_classic'
 
 module ActiveJob
   module QueueAdapters
-    # == Queue Classic adapter for Active Job
+    # == queue_classic adapter for Active Job
     #
     # queue_classic provides a simple interface to a PostgreSQL-backed message
     # queue. queue_classic specializes in concurrent locking and minimizing
@@ -11,9 +11,9 @@ module ActiveJob
     # production environment and that adding another dependency (e.g. redis,
     # beanstalkd, 0mq) is undesirable.
     #
-    # Read more about Queue Classic {here}[https://github.com/ryandotsmith/queue_classic].
+    # Read more about queue_classic {here}[https://github.com/QueueClassic/queue_classic].
     #
-    # To use Queue Classic set the queue_adapter config to +:queue_classic+.
+    # To use queue_classic set the queue_adapter config to +:queue_classic+.
     #
     #   Rails.application.config.active_job.queue_adapter = :queue_classic
     class QueueClassicAdapter
@@ -25,8 +25,8 @@ 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)`. '
+            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
           queue.enqueue_at(timestamp, "#{JobWrapper.name}.perform", job.serialize)
@@ -34,7 +34,7 @@ module ActiveJob
 
         # Builds a <tt>QC::Queue</tt> object to schedule jobs on.
         #
-        # If you have a custom <tt>QC::Queue</tt> subclass you'll need to suclass
+        # If you have a custom <tt>QC::Queue</tt> subclass you'll need to subclass
         # <tt>ActiveJob::QueueAdapters::QueueClassicAdapter</tt> and override the
         # <tt>build_queue</tt> method.
         def build_queue(queue_name)

data/lib/active_job/queue_adapters/sidekiq_adapter.rb

@@ -6,8 +6,8 @@ module ActiveJob
     #
     # Simple, efficient background processing for Ruby. Sidekiq uses threads to
     # handle many jobs at the same time in the same process. It does not
-    # require Rails but will integrate tightly with Rails 3/4 to make
-    # background processing dead simple.
+    # require Rails but will integrate tightly with it to make background
+    # processing dead simple.
     #
     # Read more about Sidekiq {here}[http://sidekiq.org].
     #
@@ -21,8 +21,7 @@ module ActiveJob
           Sidekiq::Client.push \
             'class' => JobWrapper,
             'queue' => job.queue_name,
-            'args'  => [ job.serialize ],
-            'retry' => true
+            'args'  => [ job.serialize ]
         end
 
         def enqueue_at(job, timestamp) #:nodoc:
@@ -30,7 +29,6 @@ module ActiveJob
             'class' => JobWrapper,
             'queue' => job.queue_name,
             'args'  => [ job.serialize ],
-            'retry' => true,
             'at'    => timestamp
         end
       end

data/lib/active_job/queue_name.rb

@@ -6,6 +6,15 @@ module ActiveJob
       mattr_accessor(:queue_name_prefix)
       mattr_accessor(:default_queue_name) { "default" }
 
+      # Specifies the name of the queue to process the job on.
+      #
+      #   class PublishToFeedJob < ActiveJob::Base
+      #     queue_as :feeds
+      #
+      #     def perform(post)
+      #       post.to_feed!
+      #     end
+      #   end
       def queue_as(part_name=nil, &block)
         if block_given?
           self.queue_name = block
@@ -15,15 +24,18 @@ module ActiveJob
       end
 
       def queue_name_from_part(part_name) #:nodoc:
-        queue_name = part_name.to_s.presence || default_queue_name
+        queue_name = part_name || default_queue_name
         name_parts = [queue_name_prefix.presence, queue_name]
-        name_parts.compact.join('_')
+        name_parts.compact.join(queue_name_delimiter)
       end
     end
 
     included do
       class_attribute :queue_name, instance_accessor: false
+      class_attribute :queue_name_delimiter, instance_accessor: false
+
       self.queue_name = default_queue_name
+      self.queue_name_delimiter = '_' # set default delimiter to '_'
     end
 
     # Returns the name of the queue the job will be run on

data/lib/active_job/test_helper.rb

@@ -71,7 +71,7 @@ module ActiveJob
       #
       # Note: This assertion is simply a shortcut for:
       #
-      #   assert_enqueued_jobs 0
+      #   assert_enqueued_jobs 0, &block
       def assert_no_enqueued_jobs(&block)
         assert_enqueued_jobs 0, &block
       end
@@ -130,7 +130,7 @@ module ActiveJob
       #
       # Note: This assertion is simply a shortcut for:
       #
-      #   assert_performed_jobs 0
+      #   assert_performed_jobs 0, &block
       def assert_no_performed_jobs(&block)
         assert_performed_jobs 0, &block
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activejob
 version: !ruby/object:Gem::Version
-  version: 4.2.0.beta3
+  version: 4.2.0.beta4
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-29 00:00:00.000000000 Z
+date: 2014-10-30 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.beta3
+        version: 4.2.0.beta4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0.beta3
+        version: 4.2.0.beta4
 - !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.2
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Job framework with pluggable queues.