sidekiq-activerecord 0.0.1 → 0.0.2

data/.gitignore

@@ -1 +1,2 @@
-*.idea
+*.idea
+*.lock

data/.rspec

@@ -1 +1,3 @@
---color --format documentation
+-c
+-f d
+-r spec_helper

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+services:
+  - redis-server
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - rbx
+  - 2.0.0
+  - 2.1
+matrix:
+  allow_failures:
+    - rvm: rbx

data/Gemfile

@@ -1,4 +1,2 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in sidekiq-activerecord.gemspec
 gemspec

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    sidekiq-activerecord (0.0.1)
-      activerecord (~> 4.1.1)
-      sidekiq (>= 2.16.0)
+    sidekiq-activerecord (0.0.2)
+      activerecord (>= 4.0)
+      sidekiq (>= 2.16)
 
 GEM
   remote: https://rubygems.org/
@@ -28,7 +28,7 @@ GEM
     connection_pool (2.0.0)
     database_cleaner (1.2.0)
     diff-lcs (1.2.5)
-    factory_girl (4.2.0)
+    factory_girl (4.4.0)
       activesupport (>= 3.0.0)
     i18n (0.6.9)
     json (1.8.1)
@@ -36,15 +36,19 @@ GEM
     redis (3.0.7)
     redis-namespace (1.4.1)
       redis (~> 3.0.4)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.8)
-    rspec-expectations (2.14.5)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.6)
-    sidekiq (3.0.2)
+    rspec (3.0.0.rc1)
+      rspec-core (= 3.0.0.rc1)
+      rspec-expectations (= 3.0.0.rc1)
+      rspec-mocks (= 3.0.0.rc1)
+    rspec-core (3.0.0.rc1)
+      rspec-support (= 3.0.0.rc1)
+    rspec-expectations (3.0.0.rc1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (= 3.0.0.rc1)
+    rspec-mocks (3.0.0.rc1)
+      rspec-support (= 3.0.0.rc1)
+    rspec-support (3.0.0.rc1)
+    sidekiq (3.1.0)
       celluloid (>= 0.15.2)
       connection_pool (>= 2.0.0)
       json
@@ -60,8 +64,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  database_cleaner (~> 1.2.0)
+  database_cleaner (>= 1.2.0)
   factory_girl (~> 4.0)
-  rspec (>= 2.14)
+  rspec (= 3.0.0.rc1)
   sidekiq-activerecord!
-  sqlite3 (~> 1.3.9)
+  sqlite3 (>= 1.3.9)

data/README.md

@@ -44,7 +44,7 @@ class UserTaskWorker
 end
 
 class UserSyncer
-  include Sidekiq::ManagerWorker
+  include Sidekiq::ActiveRecord::ManagerWorker
 
   sidekiq_delegate_task_to :user_task_worker # or UserTaskWorker
   sidekiq_manager_options :batch_size => 500,
@@ -78,7 +78,7 @@ end
 
 ```ruby
 class UserMailerTaskWorker
-  include Sidekiq::TaskWorker
+  include Sidekiq::ActiveRecord::TaskWorker
 
   sidekiq_task_model :user_model # or UserModel
   sidekiq_task_options :identifier_key => :token
@@ -110,7 +110,7 @@ UserMailerTaskWorker.perform(user.id, :new_email)
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/sidekiq-activerecord/fork )
+1. Fork it ( http://github.com/yelled3/sidekiq-activerecord/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1 +1,12 @@
-require "bundler/gem_tasks"
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs'
+task default: :spec
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+Bundler::GemHelper.install_tasks

data/lib/sidekiq/active_record/manager_worker.rb

@@ -0,0 +1,141 @@
+module Sidekiq
+  module ActiveRecord
+    module ManagerWorker
+      extend Sidekiq::Worker
+
+      DEFAULT_IDENTIFIER_KEY = :id
+      DEFAULT_BATCH_SIZE = 1000
+
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.class_attribute :sidekiq_manager_options_hash
+      end
+
+      module ClassMethods
+        # For a given model collection, it delegates each model to a sub-worker (e.g TaskWorker)
+        # Specify the TaskWorker with the `sidekiq_delegate_task_to` method.
+        #
+        # @param models_query ActiveRecord::Relation
+        # @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
+        #   :batch_size - Specifies the size of the batch. Default to 1000.
+        #
+        # @example:
+        #   class UserTaskWorker
+        #     include Sidekiq::ActiveRecord::TaskWorker
+        #   end
+        #
+        #   class UserSyncer
+        #     include Sidekiq::ActiveRecord::ManagerWorker
+        #
+        #     sidekiq_delegate_task_to :user_task_worker # or UserTaskWorker
+        #     sidekiq_manager_options :batch_size => 500,
+        #                             :identifier_key => :user_token,
+        #                             :additional_keys => [:status]
+        #   end
+        #
+        #   UserSyncer.perform_query_async(User.active, :batch_size => 300)
+        #
+        #
+        # is equivalent to doing:
+        #   User.active.each {|user| UserTaskWorker.perform(user.id) }
+        #
+        def perform_query_async(models_query, options = {})
+          set_runtime_options(options)
+          models = models_query.select(selected_attributes)
+          models.find_in_batches(batch_size: batch_size) do |models_batch|
+            model_attributes = models_batch.map { |model| model_attributes(model) }
+            Sidekiq::Client.push_bulk(class: worker_class, args: model_attributes)
+          end
+        end
+
+        # @required
+        # The task worker to delegate to.
+        # @param worker_klass (Sidekiq::Worker, Symbol) - UserTaskWorker or :user_task_worker
+        def sidekiq_delegate_task_to(worker_klass)
+          case worker_klass
+          when String, Symbol
+            worker_klass.to_s.split('_').map(&:capitalize).join.constantize
+          else
+            worker_klass
+          end
+          get_sidekiq_manager_options[:worker_class] = worker_klass
+        end
+
+        # Allows customization for this type of ManagerWorker.
+        # Legal options:
+        #
+        #   :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
+        #   :batch_size - Specifies the size of the batch. Default to 1000.
+        def sidekiq_manager_options(opts = {})
+          self.sidekiq_manager_options_hash = get_sidekiq_manager_options.merge((opts || {}))
+        end
+
+        # private
+
+        def default_worker_manager_options
+          {
+              identifier_key: DEFAULT_IDENTIFIER_KEY,
+              additional_keys: [],
+              batch_size: DEFAULT_BATCH_SIZE
+          }
+        end
+
+        # returns the model attributes array:
+        # [model_id, attr1, attr2, ...]
+        def model_attributes(model)
+          additional_attributes = additional_keys.map { |key| model.send(key) }
+          id_attribute = model.send(identifier_key)
+          additional_attributes.unshift(id_attribute)
+        end
+
+        def selected_attributes
+          attrs = [identifier_key, additional_keys]
+          attrs << DEFAULT_IDENTIFIER_KEY unless default_identifier? # :id must be included
+          attrs
+        end
+
+        def worker_class
+          fail NotImplementedError.new('`worker_class` was not specified') unless manager_options[:worker_class].present?
+          manager_options[:worker_class]
+        end
+
+        def default_identifier?
+          identifier_key == DEFAULT_IDENTIFIER_KEY
+        end
+
+        def identifier_key
+          manager_options[:identifier_key]
+        end
+
+        def additional_keys
+          manager_options[:additional_keys]
+        end
+
+        def batch_size
+          manager_options[:batch_size]
+        end
+
+        def manager_options
+          get_sidekiq_manager_options.merge(runtime_options)
+        end
+
+        def get_sidekiq_manager_options
+          self.sidekiq_manager_options_hash ||= default_worker_manager_options
+        end
+
+        def runtime_options
+          @sidekiq_manager_runtime_options || {}
+        end
+
+        def set_runtime_options(options={})
+          @sidekiq_manager_runtime_options = options.delete_if { |_, v| v.to_s.strip == '' }
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/active_record/task_worker.rb

@@ -0,0 +1,114 @@
+module Sidekiq
+  module ActiveRecord
+    module TaskWorker
+      extend Sidekiq::Worker
+
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.class_attribute :sidekiq_task_options_hash
+      end
+
+      module ClassMethods
+        # @example:
+        #   class UserMailerTaskWorker
+        #     include Sidekiq::ActiveRecord::TaskWorker
+        #
+        #     sidekiq_task_model :user_model # or UserModel
+        #     sidekiq_task_options :identifier_key => :token
+        #
+        #     def perform_on_model(user, email_type)
+        #       UserMailer.deliver_registration_confirmation(user, email_type)
+        #     end
+        #
+        #     def not_found_model(token)
+        #       Log.error "User not found for token:#{token}"
+        #     end
+        #
+        #     def model_valid?(user)
+        #       user.active?
+        #     end
+        #
+        #     def invalid_model(user)
+        #       Log.error "User #{user.token} is invalid"
+        #     end
+        #
+        #   end
+        #
+        #
+        #   UserMailerTaskWorker.perform(user.id, :new_email)
+        #
+        def perform(identifier, *args)
+          model = fetch_model(identifier)
+          return not_found_model(identifier) unless model.present?
+
+          if model_valid?(model)
+            perform_on_model(model, *args)
+          else
+            invalid_model(model)
+          end
+        end
+
+        def sidekiq_task_model(model_klass)
+          if model_klass.is_a?(String) || model_klass.is_a?(Symbol)
+            model_klass = model_klass.to_s.split('_').map(&:capitalize).join.constantize
+          else
+            model_klass
+          end
+          get_sidekiq_task_options[:model_class] = model_klass
+        end
+
+        def perform_on_model(model)
+          model
+        end
+
+        # recheck the if one of the items is still valid
+        def model_valid?(_model)
+          true
+        end
+
+        # Hook to handel an invalid model
+        def invalid_model(_model)
+        end
+
+        # Hook to handel not found model
+        def not_found_model(_identifier)
+        end
+
+        # private
+
+        def fetch_model(identifier)
+          model_class.find_by(identifier_key => identifier)
+        end
+
+        def model_class
+          klass = get_sidekiq_task_options[:model_class]
+          fail NotImplementedError.new('`model_class` was not specified') unless klass.present?
+          klass
+        end
+
+        def identifier_key
+          get_sidekiq_task_options[:identifier_key]
+        end
+
+        #
+        # Allows customization for this type of TaskWorker.
+        # Legal options:
+        #
+        #   :identifier_key - the model identifier column. Default 'id'
+        def sidekiq_task_options(opts = {})
+          self.sidekiq_task_options_hash = get_sidekiq_task_options.merge((opts || {}).symbolize_keys!)
+        end
+
+        def get_sidekiq_task_options
+          self.sidekiq_task_options_hash ||= default_worker_task_options
+        end
+
+        def default_worker_task_options
+          {
+              identifier_key: :id
+          }
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/active_record/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module ActiveRecord
+    VERSION = "0.0.2"
+  end
+end

data/lib/sidekiq/activerecord.rb

@@ -1,10 +1,16 @@
-
-# gems
+# dependencies
 require 'sidekiq'
 require 'active_record'
 
-require "sidekiq/activerecord/version"
+# core
+require 'sidekiq/active_record/version'
+
+
+module Sidekiq
+  module ActiveRecord
+    extend ActiveSupport::Autoload
 
-# internal
-require 'sidekiq/task_worker'
-require 'sidekiq/manager_worker'
+    autoload :TaskWorker
+    autoload :ManagerWorker
+  end
+end

data/sidekiq-activerecord.gemspec

@@ -1,28 +1,28 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'sidekiq/activerecord/version'
+require 'sidekiq/active_record/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "sidekiq-activerecord"
-  spec.version       = Sidekiq::Activerecord::VERSION
-  spec.authors       = ["Adam Farhi"]
-  spec.email         = ["yelled3@gmail.com"]
+  spec.name          = 'sidekiq-activerecord'
+  spec.version       = Sidekiq::ActiveRecord::VERSION
+  spec.authors       = ['Adam Farhi']
+  spec.email         = ['afarhi@ebay.com']
   spec.summary       = 'Encapsulates various interactions between Sidekiq and ActiveRecord'
-  spec.description   = 'Encapsulates various interactions between Sidekiq and ActiveRecord'
-  spec.homepage      = "https://github.com/yelled3/sidekiq-activerecord"
-  spec.license       = "MIT"
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/yelled3/sidekiq-activerecord'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ['lib']
 
-  spec.add_dependency 'sidekiq',   '>= 2.16.0'
-  spec.add_dependency 'activerecord', '~> 4.1.1'
+  spec.add_dependency 'sidekiq',   '>= 2.16'
+  spec.add_dependency 'activerecord', '>= 4.0'
 
-  spec.add_development_dependency "rspec", ">= 2.14"
-  spec.add_development_dependency "database_cleaner", '~> 1.2.0'
-  spec.add_development_dependency 'sqlite3', '~> 1.3.9'
-  spec.add_development_dependency 'factory_girl', "~> 4.0"
+  spec.add_development_dependency 'rspec', '3.0.0.rc1'
+  spec.add_development_dependency 'database_cleaner', '>= 1.2.0'
+  spec.add_development_dependency 'sqlite3', '>= 1.3.9'
+  spec.add_development_dependency 'factory_girl', '~> 4.0'
 end

data/spec/{lib/sidekiq/manager_worker.rb → sidekiq/active_record/manager_worker_spec.rb}

@@ -1,6 +1,4 @@
-require 'spec_helper'
-
-describe Sidekiq::ManagerWorker do
+describe Sidekiq::ActiveRecord::ManagerWorker do
 
   before do
     allow(Sidekiq::Client).to receive(:push_bulk)
@@ -12,7 +10,7 @@ describe Sidekiq::ManagerWorker do
   let(:sidekiq_client) { Sidekiq::Client }
 
   class UserManagerWorker
-    include Sidekiq::ManagerWorker
+    include Sidekiq::ActiveRecord::ManagerWorker
     sidekiq_delegate_task_to MockUserWorker
   end
 
@@ -34,7 +32,7 @@ describe Sidekiq::ManagerWorker do
     end
 
     def batch_args(*ids)
-      {'class' => worker_class, 'args' => ids.map{ |id| [id] }}
+      {class: worker_class, args: ids.map{ |id| [id] }}
     end
 
     let(:model_ids) { [[user_1.id], [user_2.id], [user_3.id]] }
@@ -46,7 +44,7 @@ describe Sidekiq::ManagerWorker do
       let(:custom_worker_class) { MockCustomWorker }
 
       def batch_args(*ids)
-        {'class' => custom_worker_class, 'args' => ids.map{ |id| [id] }}
+        {class: custom_worker_class, args: ids.map{ |id| [id] }}
       end
 
       context 'as method arguments' do
@@ -90,7 +88,7 @@ describe Sidekiq::ManagerWorker do
         around do |example|
           mock_options(:batch_size => batch_size)
           example.run
-          mock_options(:batch_size => Sidekiq::ManagerWorker::DEFAULT_BATCH_SIZE)
+          mock_options(:batch_size => Sidekiq::ActiveRecord::ManagerWorker::DEFAULT_BATCH_SIZE)
         end
 
         it 'pushes a bulk of user ids batches' do
@@ -106,7 +104,7 @@ describe Sidekiq::ManagerWorker do
       let(:additional_keys) { [:email, :status] }
 
       def batch_args(*users)
-        {'class' => worker_class, 'args' => users.map{ |user| [user.id, user.email, user.status] }}
+        {class: worker_class, args: users.map{ |user| [user.id, user.email, user.status] }}
       end
 
       context 'as method arguments' do
@@ -134,7 +132,7 @@ describe Sidekiq::ManagerWorker do
     context 'when the identifier_key is specified' do
 
       def batch_args(*users)
-        {'class' => worker_class, 'args' => users.map{ |user| [user.email] }}
+        {class: worker_class, args: users.map{ |user| [user.email] }}
       end
 
       let(:identifier_key) { :email }
@@ -151,7 +149,7 @@ describe Sidekiq::ManagerWorker do
         around do |example|
           mock_options(:identifier_key => identifier_key)
           example.run
-          mock_options(:identifier_key => Sidekiq::ManagerWorker::DEFAULT_IDENTIFIER_KEY)
+          mock_options(:identifier_key => Sidekiq::ActiveRecord::ManagerWorker::DEFAULT_IDENTIFIER_KEY)
         end
 
         it 'pushes a bulk of all user emails as the identifier_key' do

data/spec/{lib/sidekiq/task_worker.rb → sidekiq/active_record/task_worker_spec.rb}

@@ -1,9 +1,7 @@
-require 'spec_helper'
-
-describe Sidekiq::TaskWorker do
+describe Sidekiq::ActiveRecord::TaskWorker do
 
   class UserTaskWorker
-    include Sidekiq::TaskWorker
+    include Sidekiq::ActiveRecord::TaskWorker
   end
 
   let!(:user) { create(:user, :active) }

data/spec/spec_helper.rb

@@ -1,36 +1,11 @@
-require "sidekiq"
-require "sidekiq/activerecord"
+require 'sidekiq'
+require 'sidekiq/activerecord'
 require 'factory_girl'
 require 'database_cleaner'
-require 'support'
 
 RSpec.configure do |config|
   config.alias_example_to :expect_it
-
-  # config.full_backtrace = true
-
-  # If you're not using ActiveRecord, or you'd prefer not to run each of your
-  # examples within a transaction, remove the following line or assign false
-  # instead of true.
-  # config.use_transactional_fixtures = true
-
-  config.expect_with :rspec do |config|
-    config.syntax = :expect
-  end
-
-  config.include FactoryGirl::Syntax::Methods # Don't need to write FactoryGirl.create => create
-
-  config.before(:suite) do
-    DatabaseCleaner.strategy = :transaction
-    DatabaseCleaner.clean_with(:truncation)
-  end
-
-  config.before(:each) do
-    DatabaseCleaner.start
-  end
-
-  config.after(:each) do
-    DatabaseCleaner.clean
-  end
 end
 
+Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
+

data/spec/support/database.rb

@@ -0,0 +1,10 @@
+db_config = {:adapter => 'sqlite3', :database => ':memory:'}
+ActiveRecord::Base.establish_connection(db_config)
+connection = ActiveRecord::Base.connection
+
+connection.create_table :users, force: true do |t|
+  t.string :name
+  t.string :email
+  t.string :status
+  t.timestamps
+end

data/spec/support/database_cleaner.rb

@@ -0,0 +1,14 @@
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/spec/support/factory_girl.rb

@@ -0,0 +1,20 @@
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods # Don't need to write FactoryGirl.create => create
+end
+
+FactoryGirl.define do
+  factory :user do
+
+    sequence(:name) { |n| "name-#{n}" }
+    sequence(:email) { |n| "email-#{n}" }
+
+    trait :active do
+      status 'active'
+    end
+
+    trait :banned do
+      status 'banned'
+    end
+
+  end
+end

data/spec/support/models.rb

@@ -0,0 +1,4 @@
+class User < ActiveRecord::Base
+  scope :active, -> { where(:status => :active) }
+  scope :banned, -> { where(:status => :banned) }
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-activerecord
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-20 00:00:00.000000000 Z
+date: 2014-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.16.0
+        version: '2.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,45 +26,45 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.16.0
+        version: '2.16'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: 3.0.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: 3.0.0.rc1
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :development
@@ -72,7 +72,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.2.0
 - !ruby/object:Gem::Dependency
@@ -80,7 +80,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.3.9
   type: :development
@@ -88,7 +88,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.3.9
 - !ruby/object:Gem::Dependency
@@ -109,27 +109,33 @@ dependencies:
         version: '4.0'
 description: Encapsulates various interactions between Sidekiq and ActiveRecord
 email:
-- yelled3@gmail.com
+- afarhi@ebay.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/sidekiq/active_record/manager_worker.rb
+- lib/sidekiq/active_record/task_worker.rb
+- lib/sidekiq/active_record/version.rb
 - lib/sidekiq/activerecord.rb
-- lib/sidekiq/activerecord/version.rb
-- lib/sidekiq/manager_worker.rb
-- lib/sidekiq/task_worker.rb
+- pkg/sidekiq-activerecord-0.0.1.gem
+- pkg/sidekiq-activerecord-0.0.2.gem
 - sidekiq-activerecord.gemspec
-- spec/lib/sidekiq/manager_worker.rb
-- spec/lib/sidekiq/task_worker.rb
+- spec/sidekiq/active_record/manager_worker_spec.rb
+- spec/sidekiq/active_record/task_worker_spec.rb
 - spec/spec_helper.rb
-- spec/support.rb
+- spec/support/database.rb
+- spec/support/database_cleaner.rb
+- spec/support/factory_girl.rb
+- spec/support/models.rb
 homepage: https://github.com/yelled3/sidekiq-activerecord
 licenses:
 - MIT
@@ -156,8 +162,11 @@ signing_key:
 specification_version: 3
 summary: Encapsulates various interactions between Sidekiq and ActiveRecord
 test_files:
-- spec/lib/sidekiq/manager_worker.rb
-- spec/lib/sidekiq/task_worker.rb
+- spec/sidekiq/active_record/manager_worker_spec.rb
+- spec/sidekiq/active_record/task_worker_spec.rb
 - spec/spec_helper.rb
-- spec/support.rb
+- spec/support/database.rb
+- spec/support/database_cleaner.rb
+- spec/support/factory_girl.rb
+- spec/support/models.rb
 has_rdoc: 

data/lib/sidekiq/activerecord/version.rb

@@ -1,5 +0,0 @@
-module Sidekiq
-  module Activerecord
-    VERSION = "0.0.1"
-  end
-end

data/lib/sidekiq/manager_worker.rb

@@ -1,144 +0,0 @@
-module Sidekiq
-  module ManagerWorker
-    extend Sidekiq::Worker
-
-    DEFAULT_IDENTIFIER_KEY = :id
-    DEFAULT_BATCH_SIZE = 1000
-
-    def self.included(base)
-      base.extend(ClassMethods)
-      base.class_attribute :sidekiq_manager_options_hash
-    end
-
-    module ClassMethods
-
-      # For a given model collection, it delegates each model to a sub-worker (e.g TaskWorker)
-      # Specify the TaskWoker with the `sidekiq_delegate_task_to` method.
-      #
-      # @param models_query ActiveRecord::Relation
-      # @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
-      #   :batch_size - Specifies the size of the batch. Default to 1000.
-      #
-      # @example:
-      #   class UserTaskWorker
-      #     include Sidekiq::TaskWorker
-      #   end
-      #
-      #   class UserSyncer
-      #     include Sidekiq::ManagerWorker
-      #
-      #     sidekiq_delegate_task_to :user_task_worker # or UserTaskWorker
-      #     sidekiq_manager_options :batch_size => 500,
-      #                             :identifier_key => :user_token,
-      #                             :additional_keys => [:status]
-      #   end
-      #
-      #   UserSyncer.perform_query_async(User.active, :batch_size => 300)
-      #
-      #
-      # is equivalent to doing:
-      #   User.active.each {|user| UserTaskWorker.peform(user.id) }
-      #
-      def perform_query_async(models_query, options={})
-        set_runtime_options(options)
-        models = models_query.select(selected_attributes)
-        models.find_in_batches(batch_size: batch_size) do |models_batch|
-          model_attributes = models_batch.map { |model| model_attributes(model) }
-          Sidekiq::Client.push_bulk('class' => worker_class, 'args' => model_attributes)
-        end
-        # set_runtime_options(nil)
-      end
-
-      # @required
-      # The task worker to delegate to.
-      # @param worker_klass (Sidekiq::Worker, Symbol) - UserTaskWorker or :user_task_worker
-      def sidekiq_delegate_task_to(worker_klass)
-        if worker_klass.is_a?(String) or is_a?(Symbol)
-          worker_klass.to_s.split('_').collect(&:capitalize).join.constantize
-        else
-          worker_klass
-        end
-        self.get_sidekiq_manager_options[:worker_class] = worker_klass
-      end
-
-      # Allows customization for this type of ManagerWorker.
-      # Legal options:
-      #
-      #   :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
-      #   :batch_size - Specifies the size of the batch. Default to 1000.
-      def sidekiq_manager_options(opts={})
-        self.sidekiq_manager_options_hash = get_sidekiq_manager_options.merge((opts || {}).symbolize_keys!)
-      end
-
-
-      # private
-
-      def default_worker_manager_options
-        {
-            :identifier_key => DEFAULT_IDENTIFIER_KEY,
-            :additional_keys => [],
-            :worker_class => nil,
-            :batch_size => DEFAULT_BATCH_SIZE,
-        }
-      end
-
-      # returns the model attributes array:
-      # [model_id, attr1, attr2, ...]
-      def model_attributes(model)
-        additional_attributes = additional_keys.map { |key| model.send(key) }
-        id_attribute = model.send(identifier_key)
-        additional_attributes.unshift(id_attribute)
-      end
-
-      def selected_attributes
-        attrs = [identifier_key, additional_keys]
-        attrs << DEFAULT_IDENTIFIER_KEY unless default_identifier? # :id must be included
-        attrs
-      end
-
-      def worker_class
-        raise NotImplementedError.new('`worker_class` was not specified') unless manager_options[:worker_class].present?
-        manager_options[:worker_class]
-      end
-
-      def default_identifier?
-        identifier_key == DEFAULT_IDENTIFIER_KEY
-      end
-
-      def identifier_key
-        manager_options[:identifier_key]
-      end
-
-      def additional_keys
-        manager_options[:additional_keys]
-      end
-
-      def batch_size
-        manager_options[:batch_size]
-      end
-
-      def manager_options
-        self.get_sidekiq_manager_options.merge(runtime_options)
-      end
-
-      def get_sidekiq_manager_options
-        self.sidekiq_manager_options_hash ||= default_worker_manager_options
-      end
-
-      def runtime_options
-        @sidekiq_manager_runtime_options || {}
-      end
-
-      def set_runtime_options(options)
-        options = options.delete_if { |k, v| v.nil? } if options.present?
-        @sidekiq_manager_runtime_options = options
-      end
-
-    end
-  end
-end

data/lib/sidekiq/task_worker.rb

@@ -1,117 +0,0 @@
-module Sidekiq
-  module TaskWorker
-    extend Sidekiq::Worker
-
-    def self.included(base)
-      base.extend(ClassMethods)
-      base.class_attribute :sidekiq_task_options_hash
-    end
-
-    module ClassMethods
-
-      # @example:
-      #   class UserMailerTaskWorker
-      #     include Sidekiq::TaskWorker
-      #
-      #     sidekiq_task_model :user_model # or UserModel
-      #     sidekiq_task_options :identifier_key => :token
-      #
-      #     def perform_on_model(user, email_type)
-      #       UserMailer.deliver_registration_confirmation(user, email_type)
-      #     end
-      #
-      #     def not_found_model(token)
-      #       Log.error "User not found for token:#{token}"
-      #     end
-      #
-      #     def model_valid?(user)
-      #       user.active?
-      #     end
-      #
-      #     def invalid_model(user)
-      #       Log.error "User #{user.token} is invalid"
-      #     end
-      #
-      #   end
-      #
-      #
-      #   UserMailerTaskWorker.perform(user.id, :new_email)
-      #
-      def perform(identifier, *args)
-        model = fetch_model(identifier)
-        return not_found_model(identifier) unless model.present?
-
-        if model_valid?(model)
-          perform_on_model(model, *args)
-        else
-          invalid_model(model)
-        end
-      end
-
-      def sidekiq_task_model(model_klass)
-        if model_klass.is_a?(String) or model_klass.is_a?(Symbol)
-          model_klass = model_klass.to_s.split('_').collect(&:capitalize).join.constantize
-        else
-          model_klass
-        end
-        self.get_sidekiq_task_options[:model_class] = model_klass
-      end
-
-      def perform_on_model(model)
-        model
-      end
-
-      # recheck the if one of the items is still valid
-      def model_valid?(model)
-        true
-      end
-
-      # Hook to handel an invalid model
-      def invalid_model(model)
-      end
-
-      # Hook to handel not found model
-      def not_found_model(identifier)
-      end
-
-      
-      # private
-
-      def fetch_model(identifier)
-        model_class.find_by(identifier_key => identifier)
-      end
-
-      def model_class
-        klass = self.get_sidekiq_task_options[:model_class]
-        raise NotImplementedError.new('`model_class` was not specified') unless klass.present?
-        klass
-      end
-
-      def identifier_key
-        self.get_sidekiq_task_options[:identifier_key]
-      end
-
-      #
-      # Allows customization for this type of TaskWorker.
-      # Legal options:
-      #
-      #   :identifier_key - the model identifier column. Default 'id'
-      def sidekiq_task_options(opts={})
-        self.sidekiq_task_options_hash = get_sidekiq_task_options.merge((opts || {}).symbolize_keys!)
-      end
-
-      def get_sidekiq_task_options
-        self.sidekiq_task_options_hash ||= default_worker_task_options
-      end
-
-      def default_worker_task_options
-        {
-            :identifier_key => :id,
-            :model_class => nil
-        }
-      end
-
-    end
-
-  end
-end

data/spec/support.rb

@@ -1,39 +0,0 @@
-require "active_record"
-
-def set_database
-  db_config = {:adapter => "sqlite3", :database => ":memory:"}
-  ActiveRecord::Base.establish_connection(db_config)
-  connection = ActiveRecord::Base.connection
-
-  connection.create_table :users, force: true do |t|
-    t.string :name
-    t.string :email
-    t.string :status
-    t.timestamps
-  end
-end
-
-set_database
-
-class User < ActiveRecord::Base
-  scope :active, -> { where(:status => :active) }
-  scope :banned, -> { where(:status => :banned) }
-end
-
-
-FactoryGirl.define do
-  factory :user do
-
-    sequence(:name) { |n| "name-#{n}" }
-    sequence(:email) { |n| "email-#{n}" }
-
-    trait :active do
-      status 'active'
-    end
-
-    trait :banned do
-      status 'banned'
-    end
-
-  end
-end