sidekiq-activerecord 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9139afdf7efd7b2b766b0f0c79cbffe98cf0a3df
-  data.tar.gz: 579edad53f837e6254d84205f0a0c58985f95fb0
+  metadata.gz: bd12daf4b1a40526767e3c932dac065426cd76bc
+  data.tar.gz: 1c9131194a47aef814abd6f6888806858d38847d
 SHA512:
-  metadata.gz: 3dd406e37261203cb64935227bef8bc3448917a7aef5f1035f0a4baea91fe41fbb38b4483155a37eebc732c5504c44ba98b4a94add2b15b9fb068fce1917cbc9
-  data.tar.gz: f6ddc5772b85d0f80dbb9931fb1087dc8403480eb1bfd0b17df11002bed8ffd06006198cb54ef29fcabec8b93fe4a4bb8370669262df788751add0fa0c5442d3
+  metadata.gz: 90f6397634ef7af9778e477bff84528761275a426d404a09787e1cb70a603616cb927f144377e3d83ab00d35be0d5058de85922350dbb77720fe20129b53a0c4
+  data.tar.gz: 4ba64fd648ca8daa7841ba2a84e8be837b66bfed4f556566d130e3c0925a6be0f52bb5abfd1754f6f484d74d27e56488b227c9405639a1e549b7cfcdc9181727

data/README.md

@@ -60,7 +60,7 @@ Checkout the project's [Wiki Page](https://github.com/sidekiq-orm/sidekiq-active
 
 Add this line to your application's Gemfile:
 
-    gem 'sidekiq-activerecord', '~> 0.0.4'
+    gem 'sidekiq-activerecord', '~> 0.0.5'
 
 And then execute:
 

data/lib/sidekiq/active_record/manager_worker.rb

@@ -21,7 +21,8 @@ module Sidekiq
         # @param options Hash
         #   :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
+        #   :selected_attributes - the attributes to SELECT for models query
+        #   :additional_keys - additional model keys - defaults to :selected_attributes
         #   :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.
@@ -39,7 +40,8 @@ module Sidekiq
         #     sidekiq_delegate_task_to :user_task_worker # or UserTaskWorker
         #     sidekiq_manager_options :batch_size => 500,
         #                             :identifier_key => :user_token,
-        #                             :additional_keys => [:status]
+        #                             :selected_attributes => [:first_name, :last_name, :email],
+        #                             :additional_keys => [:full_name, :email]
         #   end
         #
         #   UserSyncer.perform_query_async(User.active, :batch_size => 300)
@@ -75,7 +77,8 @@ module Sidekiq
         #
         #   :worker_class - the worker class to delegate the task to. Alternative to `sidekiq_delegate_task_to`
         #   :identifier_key - the model identifier column. Default 'id'
-        #   :additional_keys - additional model keys
+        #   :selected_attributes - the attributes to SELECT for models query
+        #   :additional_keys - additional model keys - defaults to :selected_attributes
         #   :batch_size - Specifies the size of the batch. Default to 1000.
         def sidekiq_manager_options(opts = {})
           @sidekiq_manager_options_hash = get_sidekiq_manager_options.merge((opts || {}))
@@ -100,6 +103,7 @@ module Sidekiq
         def default_worker_manager_options
           {
               identifier_key: DEFAULT_IDENTIFIER_KEY,
+              selected_attributes: [],
               additional_keys: [],
               batch_size: DEFAULT_BATCH_SIZE
           }
@@ -114,8 +118,8 @@ module Sidekiq
         end
 
         def prepare_models_query(models_query)
-          selected_attributes = [models_query.primary_key.to_sym, identifier_key, additional_keys].uniq
-          models_query.select(selected_attributes)
+          selected_attrs = [models_query.primary_key.to_sym, identifier_key, selected_attributes].uniq
+          models_query.select(selected_attrs)
         end
 
         def worker_class
@@ -127,8 +131,13 @@ module Sidekiq
           manager_options[:identifier_key]
         end
 
+        def selected_attributes
+          manager_options[:selected_attributes]
+        end
+
         def additional_keys
-          manager_options[:additional_keys]
+          additional = manager_options[:additional_keys]
+          additional.present? ? additional :  selected_attributes
         end
 
         def batch_size

data/lib/sidekiq/active_record/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module ActiveRecord
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/sidekiq-activerecord.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = 'sidekiq-activerecord'
   spec.version       = Sidekiq::ActiveRecord::VERSION
   spec.authors       = ['Adam Farhi']
-  spec.email         = ['afarhi@ebay.com']
+  spec.email         = ['yelled3@gmail.com']
   spec.summary       = 'Encapsulates various interactions between Sidekiq and ActiveRecord'
   spec.description   = spec.summary
   spec.homepage      = 'https://github.com/yelled3/sidekiq-activerecord'

data/spec/examples/alias_user_task_worker.rb

@@ -1,9 +1,13 @@
+require 'examples/helper_classes'
+
 module Examples
   class AliasUserTaskWorker < Sidekiq::ActiveRecord::TaskWorker
 
     sidekiq_task_model :user # or User class
     sidekiq_task_options :identifier_key => :email
 
+    sidekiq_options :queue => USER_TASK_QUEUE
+
     def perform_on_user(new_email = nil)
       UserMailer.update_email(user, new_email)
     end

data/spec/examples/helper_classes.rb

@@ -1,4 +1,7 @@
 module Examples
+
+  USER_TASK_QUEUE = :user_task_queue
+
   class UserMailer
     def self.update_email(user, new_email)
     end

data/spec/examples/no_alias_user_task_worker.rb

@@ -1,9 +1,13 @@
+require 'examples/helper_classes'
+
 module Examples
   class NoAliasUserTaskWorker < Sidekiq::ActiveRecord::TaskWorker
 
     sidekiq_task_model :user # or User class
     sidekiq_task_options :identifier_key => :email
 
+    sidekiq_options :queue => USER_TASK_QUEUE
+
     def perform_on_model(new_email = nil)
       UserMailer.update_email(task_model, new_email)
     end

data/spec/sidekiq/active_record/example/alias_user_task_worker_spec.rb

@@ -17,6 +17,13 @@ module Examples
       allow(logger).to receive(:error)
     end
 
+    context 'when a sidekiq_options is specified' do
+      it 'sets the queue' do
+        sidekiq_options = task_worker_class.send(:get_sidekiq_options)
+        expect(sidekiq_options['queue']).to eq USER_TASK_QUEUE
+      end
+    end
+
     context 'when the user is not found' do
 
       let(:unfound_email) { 'unfound@email.com' }

data/spec/sidekiq/active_record/example/no_alias_user_task_worker_spec.rb

@@ -17,6 +17,13 @@ module Examples
       allow(logger).to receive(:error)
     end
 
+    context 'when a sidekiq_options is specified' do
+      it 'sets the queue' do
+        sidekiq_options = task_worker_class.send(:get_sidekiq_options)
+        expect(sidekiq_options['queue']).to eq USER_TASK_QUEUE
+      end
+    end
+
     context 'when the user is not found' do
 
       let(:unfound_email) { 'unfound@email.com' }

data/spec/sidekiq/active_record/manager_worker_spec.rb

@@ -130,26 +130,57 @@ describe Sidekiq::ActiveRecord::ManagerWorker do
       end
     end
 
-    context 'when the additional_keys are specified' do
+    context 'when the selected_attributes are specified' do
 
-      let(:additional_keys) { [:email, :status] }
+      let(:selected_attributes) { [:email, :status] }
 
       def batch_args(*users)
         {class: worker_class, args: users.map{ |user| [user.id, user.email, user.status] }}
       end
 
+      context 'as method arguments' do
+        it 'pushes a bulk of all user ids and selected_attributes' do
+          expect(sidekiq_client).to receive(:push_bulk).with( batch_args(user_1, user_2, user_3) )
+          run_worker({selected_attributes: selected_attributes})
+        end
+      end
+
+      context 'as sidekiq_manager_options' do
+        around do |example|
+          mock_options(:selected_attributes => selected_attributes)
+          example.run
+          mock_options(:selected_attributes => [])
+        end
+
+        it 'pushes a bulk of all user ids and selected_attributes' do
+          expect(sidekiq_client).to receive(:push_bulk).with( batch_args(user_1, user_2, user_3) )
+          run_worker
+        end
+      end
+
+    end
+
+    context 'when the additional_keys are specified' do
+
+      let(:selected_attributes) { [:first_name, :last_name] }
+      let(:additional_keys) { [:full_name] } # a method on User model
+
+      def batch_args(*users)
+        {class: worker_class, args: users.map{ |user| [user.id, user.full_name] }}
+      end
+
       context 'as method arguments' do
         it 'pushes a bulk of all user ids and additional_keys' do
           expect(sidekiq_client).to receive(:push_bulk).with( batch_args(user_1, user_2, user_3) )
-          run_worker({additional_keys: additional_keys})
+          run_worker(selected_attributes: selected_attributes, additional_keys: additional_keys)
         end
       end
 
       context 'as sidekiq_manager_options' do
         around do |example|
-          mock_options(:additional_keys => additional_keys)
+          mock_options(:selected_attributes => selected_attributes, :additional_keys => additional_keys)
           example.run
-          mock_options(:additional_keys => [])
+          mock_options(:selected_attributes => [], :additional_keys => [])
         end
 
         it 'pushes a bulk of all user ids and additional_keys' do
@@ -157,7 +188,6 @@ describe Sidekiq::ActiveRecord::ManagerWorker do
           run_worker
         end
       end
-
     end
 
     context 'when the identifier_key is specified' do

data/spec/sidekiq/active_record/task_worker_spec.rb

@@ -223,7 +223,7 @@ describe Sidekiq::ActiveRecord::TaskWorker do
     context "when the specified model doesn't match the task_model class" do
 
       let(:unrelated_model) {
-        Struct.new(:id, :name).new(55, 'Mike')
+        Struct.new(:id, :first_name).new(55, 'Mike')
       }
 
       it "raises an ArgumentError and doesn't call perform_async" do

data/spec/support/database.rb

@@ -3,7 +3,8 @@ ActiveRecord::Base.establish_connection(db_config)
 connection = ActiveRecord::Base.connection
 
 connection.create_table :users, force: true do |t|
-  t.string :name
+  t.string :first_name
+  t.string :last_name
   t.string :email
   t.string :status
   t.timestamps

data/spec/support/factory_girl.rb

@@ -5,7 +5,8 @@ end
 FactoryGirl.define do
   factory :user do
 
-    sequence(:name) { |n| "name-#{n}" }
+    sequence(:first_name) { |n| "first-name-#{n}" }
+    sequence(:last_name) { |n| "last-name-#{n}" }
     sequence(:email) { |n| "email-#{n}" }
 
     trait :active do

data/spec/support/models.rb

@@ -5,4 +5,8 @@ class User < ActiveRecord::Base
   def active?
     status.try(:to_sym) == :active
   end
+
+  def full_name
+    "#{first_name} #{last_name}"
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-activerecord
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Adam Farhi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-21 00:00:00.000000000 Z
+date: 2014-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -96,7 +96,7 @@ dependencies:
         version: '4.0'
 description: Encapsulates various interactions between Sidekiq and ActiveRecord
 email:
-- afarhi@ebay.com
+- yelled3@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []