sidekiq-activerecord 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4546acc561ce4ce6579666b4b05a66006ec39d9
-  data.tar.gz: 73e5e411912bca36600f5bf091fb010767119f00
+  metadata.gz: d5ab93d1d218ef784216eb2a2769fae0fb837eeb
+  data.tar.gz: 9a346662abbacb3842fc32bfd8077e9e904cc9e7
 SHA512:
-  metadata.gz: 716f41cd85a9809af9965675eca4220b7d35f5607cb42abfea2fe5c1251fb7d2a8f466219db43bcaefb19e9ab77b604a0926a11482039bb0f89a4333c4fc19af
-  data.tar.gz: b5ec0c789fa00a57ee2464f72a88c40b930dd1683c858d914d8a1330059bf13338abd002d15537ea8419c089e37b76e719495ef34aaa4b1c6490e7b77a8fe018
+  metadata.gz: 68268f2371d13e508b4b21a65c090edc75d9575ee0ed1caf91cf339dd5359f0ef75a67bad6430c0dab3e8709f53b8dd0b42524a9686d3c2af2be5813d40f6e63
+  data.tar.gz: 0ff832cd5fa773e2de3cb682a4b6223c8557810015f358fb565e1cec06123eb664d2844c64ec3b7089d7bd3e1276f7a4600db0a6dd98d2925745c62551387da8

data/README.md

@@ -11,7 +11,7 @@ If you've been using Sidekiq for a while, you've probably noticed a recurring pa
 ## [Sidekiq::ActiveRecord::TaskWorker](https://github.com/sidekiq-orm/sidekiq-activerecord/wiki/Task-Worker)
 A very conventional pattern, is to have a worker that gets a model identifier, loads it and runs some custom logic on the model. 
 
-[```TaskWorker```]https://github.com/sidekiq-orm/sidekiq-activerecord/wiki/Task-Worker) provides a simple and clean interface, which reduces the boilerplate and exposes only the custom logic.   
+[```TaskWorker```](https://github.com/sidekiq-orm/sidekiq-activerecord/wiki/Task-Worker) provides a simple and clean interface, which reduces the boilerplate and exposes only the custom logic.   
 
 Here's a simple example:
 

data/lib/sidekiq/active_record/manager_worker.rb

@@ -22,7 +22,9 @@ module Sidekiq
         #   :worker_class - the worker class to delegate the task to. Alternative to the default `sidekiq_delegate_task_to`
         #   :identifier_key - the model identifier column. Default 'id'
         #   :additional_keys - additional model keys
-        #   :batch_size - Specifies the size of the batch. Default to 1000.
+        #   :batch_size - Specifies the size of each batch to push in bulk.
+        #                 This is also the number of models to fetch in each find_in_batches query.
+        #                 Default is 1000.
         #
         # @example:
         #   class UserTaskWorker

data/lib/sidekiq/active_record/task_worker.rb

@@ -5,6 +5,30 @@ module Sidekiq
 
       attr_reader :task_model
 
+      # Helper method, to automatically call the task worker with the identifier.
+      # This will allow you to change the :identifier_key option, without needing to change it in other places.
+      #
+      # @example:
+      #   class UserMailerTaskWorker < Sidekiq::ActiveRecord::TaskWorker
+      #
+      #     sidekiq_task_model User
+      #     sidekiq_task_options :identifier_key => :email
+      #
+      #   end
+      #
+      #   user = User.find_by(:email => user@mail.com)
+      #
+      #   UserMailerTaskWorker.perform_async(user.email, arg1, arg2)
+      #
+      #   # is the same as doing
+      #   UserMailerTaskWorker.perform_async_on(user, arg1, arg2)
+      #
+      def self.perform_async_on(model, *args)
+        fail ArgumentError.new "Specified model must be a #{model_class.to_s}" unless model.class <= model_class
+        identifier = model.send(self.identifier_key)
+        perform_async(identifier, *args)
+      end
+
       # @example:
       #   class UserMailerTaskWorker < Sidekiq::ActiveRecord::TaskWorker
       #
@@ -30,7 +54,7 @@ module Sidekiq
       #   end
       #
       #
-      #   UserMailerTaskWorker.perform(user.id, :new_email)
+      #   UserMailerTaskWorker.perform_async(user.id, :new_email)
       #
       def perform(identifier, *args)
         @task_model = fetch_model(identifier, *args)

data/lib/sidekiq/active_record/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module ActiveRecord
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/sidekiq-activerecord.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activerecord', '>= 4.0'
 
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '3.0.0.rc1'
+  spec.add_development_dependency 'rspec', '3.0.0'
   spec.add_development_dependency 'database_cleaner', '>= 1.2.0'
   spec.add_development_dependency 'factory_girl', '~> 4.0'
 end

data/spec/sidekiq/active_record/task_worker_spec.rb

@@ -255,4 +255,57 @@ describe Sidekiq::ActiveRecord::TaskWorker do
       end
     end
   end
+
+  describe 'perform_async_on', :focus do
+
+    before do
+      class UserTaskWorker
+        sidekiq_task_model User
+      end
+    end
+
+    let(:custom_arg1) { 'arg1' }
+    let(:custom_arg2) { 'arg2' }
+
+    before do
+      allow(task_worker_class).to receive(:perform_async)
+    end
+
+    context "when the specified model doesn't match the task_model class" do
+
+      let(:unrelated_model) {
+        Struct.new(:id, :name).new(55, 'Mike')
+      }
+
+      it "raises an ArgumentError and doesn't call perform_async" do
+        expect{
+          task_worker_class.perform_async_on(unrelated_model)
+        }.to raise_error(ArgumentError)
+        expect(task_worker_class).to_not have_received(:perform_async)
+      end
+    end
+
+    context 'when the identifier_key is undefined' do
+      it 'calls perform_async with the task_model.id and optionals arguments' do
+        task_worker_class.perform_async_on(user, custom_arg1, custom_arg2)
+        expect(task_worker_class).to have_received(:perform_async).with(user.id, custom_arg1, custom_arg2)
+      end
+    end
+
+    context 'when the identifier_key is defined' do
+
+      before do
+        class UserTaskWorker
+          sidekiq_task_options :identifier_key => :email
+        end
+      end
+
+      it 'calls perform_async with the task_model identifier and optionals arguments' do
+        task_worker_class.perform_async_on(user, custom_arg1, custom_arg2)
+        expect(task_worker_class).to have_received(:perform_async).with(user.email, custom_arg1, custom_arg2)
+      end
+    end
+
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-activerecord
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Adam Farhi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-05 00:00:00.000000000 Z
+date: 2014-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.0.rc1
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.0.rc1
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -152,3 +152,4 @@ test_files:
 - spec/support/database_cleaner.rb
 - spec/support/factory_girl.rb
 - spec/support/models.rb
+has_rdoc: