activejob 4.2.0 → 4.2.1.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3925ce1b459be37d50b6ca6abfb3f64998ddc9a5
-  data.tar.gz: 4f770e914535bfd505164c4c906ec5b86a982488
+  metadata.gz: 3d4b1917882888a451df55d600965755a46b26a5
+  data.tar.gz: 501326baaf11dd12a503e7ba68a20ea82d05f65f
 SHA512:
-  metadata.gz: 3035f8ace873f16092a49af5efb3643761a57f1a6eb9925be754538e5b1f42f09c5458a19e9be2641c81074faf4d342ca861cf78da703fc5a608ef2cacb01221
-  data.tar.gz: 73150f5ffcee5caab778da0ddd73dcb35d9dd10225d3b0e5798e6e01553a92bb13b7f38865184efd5cd15fd0b190e41f25cfec75c28c46e6d091e6a43437537f
+  metadata.gz: 92f1f60a13299069e5acb2a0f660c5a3b4117d5932b2d026134f881974675e932caa99200640d409906cd9f225f1b0683aa2a9bcf43423494ca302e2d26ff3c9
+  data.tar.gz: 568d2685bacd7d1e1c415dc5319921461022641f1d97fa1cc49a95bc0b3cb6ddc2999136cc31578c58b61a07589002f6023af9bb07280471db879da40ad49a93

data/CHANGELOG.md

@@ -1 +1,10 @@
-*  Started project.
+*   Allow keyword arguments to be used with Active Job.
+
+    Fixes #18741.
+
+    *Sean Griffin*
+
+
+## Rails 4.2.0 (December 20, 2014) ##
+
+*  Started project.

data/lib/active_job/arguments.rb

@@ -1,3 +1,5 @@
+require 'active_support/core_ext/hash'
+
 module ActiveJob
   # Raised when an exception is raised during job arguments deserialization.
   #
@@ -42,7 +44,9 @@ module ActiveJob
 
     private
       GLOBALID_KEY = '_aj_globalid'.freeze
-      private_constant :GLOBALID_KEY
+      SYMBOL_KEYS_KEY = '_aj_symbol_keys'.freeze
+      WITH_INDIFFERENT_ACCESS_KEY = '_aj_hash_with_indifferent_access'.freeze
+      private_constant :GLOBALID_KEY, :SYMBOL_KEYS_KEY, :WITH_INDIFFERENT_ACCESS_KEY
 
       def serialize_argument(argument)
         case argument
@@ -52,10 +56,15 @@ module ActiveJob
           { GLOBALID_KEY => argument.to_global_id.to_s }
         when Array
           argument.map { |arg| serialize_argument(arg) }
+        when ActiveSupport::HashWithIndifferentAccess
+          result = serialize_hash(argument)
+          result[WITH_INDIFFERENT_ACCESS_KEY] = serialize_argument(true)
+          result
         when Hash
-          argument.each_with_object({}) do |(key, value), hash|
-            hash[serialize_hash_key(key)] = serialize_argument(value)
-          end
+          symbol_keys = argument.each_key.grep(Symbol).map(&:to_s)
+          result = serialize_hash(argument)
+          result[SYMBOL_KEYS_KEY] = symbol_keys
+          result
         else
           raise SerializationError.new("Unsupported argument type: #{argument.class.name}")
         end
@@ -73,7 +82,7 @@ module ActiveJob
           if serialized_global_id?(argument)
             deserialize_global_id argument
           else
-            deserialize_hash argument
+            deserialize_hash(argument)
           end
         else
           raise ArgumentError, "Can only deserialize primitive arguments: #{argument.inspect}"
@@ -88,13 +97,27 @@ module ActiveJob
         GlobalID::Locator.locate hash[GLOBALID_KEY]
       end
 
+      def serialize_hash(argument)
+        argument.each_with_object({}) do |(key, value), hash|
+          hash[serialize_hash_key(key)] = serialize_argument(value)
+        end
+      end
+
       def deserialize_hash(serialized_hash)
-        serialized_hash.each_with_object({}.with_indifferent_access) do |(key, value), hash|
-          hash[key] = deserialize_argument(value)
+        result = serialized_hash.transform_values { |v| deserialize_argument(v) }
+        if result.delete(WITH_INDIFFERENT_ACCESS_KEY)
+          result = result.with_indifferent_access
+        elsif symbol_keys = result.delete(SYMBOL_KEYS_KEY)
+          result = transform_symbol_keys(result, symbol_keys)
         end
+        result
       end
 
-      RESERVED_KEYS = [GLOBALID_KEY, GLOBALID_KEY.to_sym]
+      RESERVED_KEYS = [
+        GLOBALID_KEY, GLOBALID_KEY.to_sym,
+        SYMBOL_KEYS_KEY, SYMBOL_KEYS_KEY.to_sym,
+        WITH_INDIFFERENT_ACCESS_KEY, WITH_INDIFFERENT_ACCESS_KEY.to_sym,
+      ]
       private_constant :RESERVED_KEYS
 
       def serialize_hash_key(key)
@@ -107,5 +130,15 @@ module ActiveJob
           raise SerializationError.new("Only string and symbol hash keys may be serialized as job arguments, but #{key.inspect} is a #{key.class}")
         end
       end
+
+      def transform_symbol_keys(hash, symbol_keys)
+        hash.transform_keys do |key|
+          if symbol_keys.include?(key)
+            key.to_sym
+          else
+            key
+          end
+        end
+      end
   end
 end

data/lib/active_job/gem_version.rb

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

data/lib/active_job/queue_adapter.rb

@@ -2,7 +2,7 @@ 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 
+  # 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
@@ -21,8 +21,8 @@ module ActiveJob
             ActiveJob::QueueAdapters::TestAdapter.new
           when Symbol, String
             load_adapter(name_or_adapter)
-          when Class
-            name_or_adapter
+          else
+            name_or_adapter if name_or_adapter.respond_to?(:enqueue)
           end
       end
 

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 http://guides.rubyonrails.org/v4.2.0/active_job_basics.html")
+          raise NotImplementedError.new("Use a queueing backend to enqueue jobs in the future. Read more at http://guides.rubyonrails.org/active_job_basics.html")
         end
       end
     end

data/lib/active_job/queue_adapters/test_adapter.rb

@@ -14,6 +14,11 @@ module ActiveJob
       attr_accessor(:perform_enqueued_jobs, :perform_enqueued_at_jobs)
       attr_writer(:enqueued_jobs, :performed_jobs)
 
+      def initialize
+        self.perform_enqueued_jobs = false
+        self.perform_enqueued_at_jobs = false
+      end
+
       # Provides a store of all the enqueued jobs with the TestAdapter so you can check them.
       def enqueued_jobs
         @enqueued_jobs ||= []
@@ -26,19 +31,19 @@ module ActiveJob
 
       def enqueue(job) #:nodoc:
         if perform_enqueued_jobs
-          performed_jobs << {job: job.class, args: job.arguments, queue: job.queue_name}
-          job.perform_now
+          performed_jobs << {job: job.class, args: job.serialize['arguments'], queue: job.queue_name}
+          Base.execute job.serialize
         else
-          enqueued_jobs << {job: job.class, args: job.arguments, queue: job.queue_name}
+          enqueued_jobs << {job: job.class, args: job.serialize['arguments'], queue: job.queue_name}
         end
       end
 
       def enqueue_at(job, timestamp) #:nodoc:
         if perform_enqueued_at_jobs
-          performed_jobs << {job: job.class, args: job.arguments, queue: job.queue_name, at: timestamp}
-          job.perform_now
+          performed_jobs << {job: job.class, args: job.serialize['arguments'], queue: job.queue_name, at: timestamp}
+          Base.execute job.serialize
         else
-          enqueued_jobs << {job: job.class, args: job.arguments, queue: job.queue_name, at: timestamp}
+          enqueued_jobs << {job: job.class, args: job.serialize['arguments'], queue: job.queue_name, at: timestamp}
         end
       end
     end

data/lib/active_job/test_helper.rb

@@ -1,3 +1,5 @@
+require 'active_support/core_ext/hash/keys'
+
 module ActiveJob
   # Provides helper methods for testing Active Job
   module TestHelper
@@ -157,9 +159,10 @@ module ActiveJob
         original_enqueued_jobs = enqueued_jobs.dup
         clear_enqueued_jobs
         args.assert_valid_keys(:job, :args, :at, :queue)
+        serialized_args = serialize_args_for_assertion(args)
         yield
         matching_job = enqueued_jobs.any? do |job|
-          args.all? { |key, value| value == job[key] }
+          serialized_args.all? { |key, value| value == job[key] }
         end
         assert matching_job, "No enqueued job found with #{args}"
       ensure
@@ -177,9 +180,10 @@ module ActiveJob
         original_performed_jobs = performed_jobs.dup
         clear_performed_jobs
         args.assert_valid_keys(:job, :args, :at, :queue)
+        serialized_args = serialize_args_for_assertion(args)
         perform_enqueued_jobs { yield }
         matching_job = performed_jobs.any? do |job|
-          args.all? { |key, value| value == job[key] }
+          serialized_args.all? { |key, value| value == job[key] }
         end
         assert matching_job, "No performed job found with #{args}"
       ensure
@@ -213,6 +217,14 @@ module ActiveJob
         def clear_performed_jobs
           performed_jobs.clear
         end
+
+        def serialize_args_for_assertion(args)
+          serialized_args = args.dup
+          if job_args = serialized_args.delete(:args)
+            serialized_args[:args] = ActiveJob::Arguments.serialize(job_args)
+          end
+          serialized_args
+        end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activejob
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.2.1.rc1
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-20 00:00:00.000000000 Z
+date: 2015-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.2.1.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.2.1.rc1
 - !ruby/object:Gem::Dependency
   name: globalid
   requirement: !ruby/object:Gem::Requirement
@@ -92,12 +92,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Job framework with pluggable queues.