sidekiq-activerecord 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5ab93d1d218ef784216eb2a2769fae0fb837eeb
-  data.tar.gz: 9a346662abbacb3842fc32bfd8077e9e904cc9e7
+  metadata.gz: 9139afdf7efd7b2b766b0f0c79cbffe98cf0a3df
+  data.tar.gz: 579edad53f837e6254d84205f0a0c58985f95fb0
 SHA512:
-  metadata.gz: 68268f2371d13e508b4b21a65c090edc75d9575ee0ed1caf91cf339dd5359f0ef75a67bad6430c0dab3e8709f53b8dd0b42524a9686d3c2af2be5813d40f6e63
-  data.tar.gz: 0ff832cd5fa773e2de3cb682a4b6223c8557810015f358fb565e1cec06123eb664d2844c64ec3b7089d7bd3e1276f7a4600db0a6dd98d2925745c62551387da8
+  metadata.gz: 3dd406e37261203cb64935227bef8bc3448917a7aef5f1035f0a4baea91fe41fbb38b4483155a37eebc732c5504c44ba98b4a94add2b15b9fb068fce1917cbc9
+  data.tar.gz: f6ddc5772b85d0f80dbb9931fb1087dc8403480eb1bfd0b17df11002bed8ffd06006198cb54ef29fcabec8b93fe4a4bb8370669262df788751add0fa0c5442d3

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'
+    gem 'sidekiq-activerecord', '~> 0.0.4'
 
 And then execute:
 

data/lib/sidekiq/active_record/task_worker.rb

@@ -57,13 +57,13 @@ module Sidekiq
       #   UserMailerTaskWorker.perform_async(user.id, :new_email)
       #
       def perform(identifier, *args)
-        @task_model = fetch_model(identifier, *args)
-        return not_found_model(identifier, *args) unless @task_model.present?
+        @task_model = call_alias_method(:fetch_model, identifier, *args)
+        return call_alias_method(:not_found_model, identifier, *args) unless @task_model.present?
 
-        if should_perform_on_model?
-          perform_on_model(*args)
+        if call_alias_method(:should_perform_on_model?)
+          call_alias_method(:perform_on_model, *args)
         else
-          did_not_perform_on_model
+          call_alias_method(:did_not_perform_on_model)
         end
       end
 
@@ -91,6 +91,15 @@ module Sidekiq
         self.class.model_class.find_by(self.class.identifier_key => identifier)
       end
 
+      # Try calling the alias method, and fallback to default name if not defined
+      def call_alias_method(method_name, *args)
+        alias_name = self.class.method_aliases_mapping[method_name]
+        if respond_to?(alias_name.to_sym)
+          send(alias_name, *args)
+        else
+          send(method_name, *args)
+        end
+      end
 
       class << self
 
@@ -121,6 +130,9 @@ module Sidekiq
           @sidekiq_task_options_hash = get_sidekiq_task_options.merge((opts).symbolize_keys!)
         end
 
+        def method_aliases_mapping
+          @_method_aliases_mapping
+        end
 
         private
 
@@ -145,18 +157,19 @@ module Sidekiq
           if model_klass_name.is_a?(Class)
             model_klass_name = model_klass_name.name.underscore
           end
-          {
+          setup_method_aliases_mapping(model_klass_name)
+          alias_method model_klass_name.to_sym, :task_model
+        end
+
+        def setup_method_aliases_mapping(model_klass_name)
+          @_method_aliases_mapping = {
               :task_model => model_klass_name,
               :fetch_model => "fetch_#{model_klass_name}",
               :not_found_model => "not_found_#{model_klass_name}",
               :should_perform_on_model? => "should_perform_on_#{model_klass_name}?",
               :did_not_perform_on_model => "did_not_perform_on_#{model_klass_name}",
               :perform_on_model => "perform_on_#{model_klass_name}"
-          }.each do |old_name, new_name|
-            self.class_exec do
-              alias_method new_name.to_sym, old_name
-            end
-          end
+          }
         end
 
         def get_sidekiq_task_options

data/lib/sidekiq/active_record/version.rb

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

data/spec/examples/alias_user_task_worker.rb

@@ -0,0 +1,27 @@
+module Examples
+  class AliasUserTaskWorker < Sidekiq::ActiveRecord::TaskWorker
+
+    sidekiq_task_model :user # or User class
+    sidekiq_task_options :identifier_key => :email
+
+    def perform_on_user(new_email = nil)
+      UserMailer.update_email(user, new_email)
+    end
+
+    # optional
+    def not_found_user(email)
+      Log.error "User not found for email:#{email}"
+    end
+
+    # optional
+    def should_perform_on_user?
+      user.active?
+    end
+
+    # optional
+    def did_not_perform_on_user
+      Log.error "User #{user.id} is invalid"
+    end
+
+  end
+end

data/spec/examples/helper_classes.rb

@@ -0,0 +1,11 @@
+module Examples
+  class UserMailer
+    def self.update_email(user, new_email)
+    end
+  end
+
+  class Log
+    def self.error(msg)
+    end
+  end
+end

data/spec/examples/no_alias_user_task_worker.rb

@@ -0,0 +1,27 @@
+module Examples
+  class NoAliasUserTaskWorker < Sidekiq::ActiveRecord::TaskWorker
+
+    sidekiq_task_model :user # or User class
+    sidekiq_task_options :identifier_key => :email
+
+    def perform_on_model(new_email = nil)
+      UserMailer.update_email(task_model, new_email)
+    end
+
+    # optional
+    def not_found_model(email)
+      Log.error "User not found for email:#{email}"
+    end
+
+    # optional
+    def should_perform_on_model?
+      user.active?
+    end
+
+    # optional
+    def did_not_perform_on_model
+      Log.error "User #{task_model.id} is invalid"
+    end
+
+  end
+end

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

@@ -0,0 +1,86 @@
+module Examples
+  describe AliasUserTaskWorker do
+
+    let(:logger)  { Log }
+    let(:service_class)  { UserMailer }
+    let(:other_param)  { 'new@email.com' }
+
+    let(:task_worker_class)  { AliasUserTaskWorker }
+    subject(:task_worker)  { AliasUserTaskWorker.new }
+
+    def run_worker
+      task_worker.perform(user.email, other_param)
+    end
+
+    before do
+      allow(service_class).to receive(:update_email)
+      allow(logger).to receive(:error)
+    end
+
+    context 'when the user is not found' do
+
+      let(:unfound_email) { 'unfound@email.com' }
+
+      it 'calls not_found_user' do
+        expect(task_worker).to receive(:not_found_user).with(unfound_email).and_call_original
+        task_worker.perform(unfound_email)
+      end
+
+      it 'calls the logger with the not found email' do
+        task_worker.perform(unfound_email)
+        expect(logger).to have_received(:error).with("User not found for email:#{unfound_email}")
+      end
+    end
+
+    context 'when the user is found' do
+
+      let(:user) { create(:user) }
+
+      it 'calls should_perform_on_user?' do
+        expect(task_worker).to receive(:should_perform_on_user?).and_call_original
+        run_worker
+      end
+
+      it 'check if the user is active' do
+        allow(task_worker).to receive(:user).and_return(user)
+        expect(user).to receive(:active?).and_call_original
+        run_worker
+      end
+
+      context 'when the user is active' do
+
+        let(:user) { create(:user, :active) }
+
+        it 'calls perform_on_user' do
+          expect(task_worker).to receive(:perform_on_user).and_call_original
+          run_worker
+        end
+
+        it 'calls the service class with the user' do
+          run_worker
+          expect(service_class).to have_received(:update_email).with(user, other_param)
+        end
+      end
+
+      context 'when the user is inactive' do
+
+        let(:user) { create(:user, :banned) }
+
+        it 'ignores the user' do
+          run_worker
+          expect(service_class).to_not have_received(:update_email)
+        end
+
+        it 'calls did_not_perform_on_user' do
+          expect(task_worker).to receive(:did_not_perform_on_user).and_call_original
+          run_worker
+        end
+
+        it 'calls the logger with the inactive user' do
+          run_worker
+          expect(logger).to have_received(:error).with("User #{user.id} is invalid")
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,86 @@
+module Examples
+  describe NoAliasUserTaskWorker do
+
+    let(:logger)  { Log }
+    let(:service_class)  { UserMailer }
+    let(:other_param)  { 'new@email.com' }
+
+    let(:task_worker_class)  { NoAliasUserTaskWorker }
+    subject(:task_worker)  { NoAliasUserTaskWorker.new }
+
+    def run_worker
+      task_worker.perform(user.email, other_param)
+    end
+
+    before do
+      allow(service_class).to receive(:update_email)
+      allow(logger).to receive(:error)
+    end
+
+    context 'when the user is not found' do
+
+      let(:unfound_email) { 'unfound@email.com' }
+
+      it 'calls not_found_model' do
+        expect(task_worker).to receive(:not_found_model).with(unfound_email).and_call_original
+        task_worker.perform(unfound_email)
+      end
+
+      it 'calls the logger with the not found email' do
+        task_worker.perform(unfound_email)
+        expect(logger).to have_received(:error).with("User not found for email:#{unfound_email}")
+      end
+    end
+
+    context 'when the user is found' do
+
+      let(:user) { create(:user) }
+
+      it 'calls should_perform_on_model?' do
+        expect(task_worker).to receive(:should_perform_on_model?).and_call_original
+        run_worker
+      end
+
+      it 'check if the user is active' do
+        allow(task_worker).to receive(:user).and_return(user)
+        expect(user).to receive(:active?).and_call_original
+        run_worker
+      end
+
+      context 'when the user is active' do
+
+        let(:user) { create(:user, :active) }
+
+        it 'calls perform_on_model' do
+          expect(task_worker).to receive(:perform_on_model).and_call_original
+          run_worker
+        end
+
+        it 'calls the service class with the user' do
+          run_worker
+          expect(service_class).to have_received(:update_email).with(user, other_param)
+        end
+      end
+
+      context 'when the user is inactive' do
+
+        let(:user) { create(:user, :banned) }
+
+        it 'ignores the user' do
+          run_worker
+          expect(service_class).to_not have_received(:update_email)
+        end
+
+        it 'calls did_not_perform_on_model' do
+          expect(task_worker).to receive(:did_not_perform_on_model).and_call_original
+          run_worker
+        end
+
+        it 'calls the logger with the inactive user' do
+          run_worker
+          expect(logger).to have_received(:error).with("User #{user.id} is invalid")
+        end
+      end
+    end
+  end
+end

data/spec/sidekiq/active_record/task_worker_spec.rb

@@ -92,11 +92,6 @@ describe Sidekiq::ActiveRecord::TaskWorker do
           run_worker
           expect(task_worker.task_model).to eq user
         end
-
-        it 'has an alias of `task_model` withe for the specified model name' do
-          run_worker
-          expect(task_worker.user).to eq user
-        end
       end
 
     end
@@ -118,11 +113,6 @@ describe Sidekiq::ActiveRecord::TaskWorker do
           run_worker
           expect(task_worker.task_model).to eq user
         end
-
-        it 'has an alias of `task_model` withe for the specified model name' do
-          run_worker
-          expect(task_worker.user).to eq user
-        end
       end
 
       describe 'when fetching the model' do
@@ -155,13 +145,6 @@ describe Sidekiq::ActiveRecord::TaskWorker do
           expect(task_worker).to_not receive(:perform_on_model)
           run_worker
         end
-
-        describe 'method alias' do
-          it 'has an alias of not_found_model hook with for the specified task model name' do
-            expect(task_worker.not_found_user(trash_id)).to eq trash_id
-          end
-        end
-
       end
 
       context 'when the mode is found' do
@@ -171,24 +154,6 @@ describe Sidekiq::ActiveRecord::TaskWorker do
             expect(task_worker).to receive(:should_perform_on_model?)
             run_worker
           end
-
-          describe 'method alias' do
-
-            let(:mock_result) { 1234 }
-
-            before do
-              class UserTaskWorker
-                def should_perform_on_user?
-                  1234
-                end
-              end
-            end
-
-            it 'has an alias of should_perform_on_model? hook with for the specified task model name' do
-              run_worker
-              expect(task_worker.should_perform_on_user?).to eq mock_result
-            end
-          end
         end
 
         context 'when the model should be performed' do
@@ -216,14 +181,6 @@ describe Sidekiq::ActiveRecord::TaskWorker do
                 task_worker.perform(user.id, user.email)
               end
             end
-
-            describe 'method alias' do
-              it 'has an alias of perform_on_model hook with for the specified task model name' do
-                task_worker.perform(user.id)
-                expect(task_worker.perform_on_user).to eq user
-              end
-            end
-
           end
         end
 
@@ -242,21 +199,13 @@ describe Sidekiq::ActiveRecord::TaskWorker do
             expect(task_worker).to_not receive(:perform_on_model)
             run_worker
           end
-
-          describe 'method alias' do
-            it 'has an alias of did_not_perform_on_model hook with for the specified task model name' do
-              run_worker
-              expect(task_worker.did_not_perform_on_user).to eq user
-            end
-          end
-
         end
 
       end
     end
   end
 
-  describe 'perform_async_on', :focus do
+  describe 'perform_async_on' do
 
     before do
       class UserTaskWorker

data/spec/spec_helper.rb

@@ -9,7 +9,9 @@ require 'database_cleaner'
 
 RSpec.configure do |config|
   config.alias_example_to :expect_it
+  config.filter_run_including :focus => true
+  config.run_all_when_everything_filtered = true
 end
 
 Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
-
+Dir['./spec/examples/**/*.rb'].sort.each { |f| require f }

data/spec/support/models.rb

@@ -1,4 +1,8 @@
 class User < ActiveRecord::Base
   scope :active, -> { where(:status => :active) }
   scope :banned, -> { where(:status => :banned) }
+
+  def active?
+    status.try(:to_sym) == :active
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-activerecord
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Adam Farhi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-18 00:00:00.000000000 Z
+date: 2014-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -113,6 +113,11 @@ files:
 - lib/sidekiq/active_record/version.rb
 - lib/sidekiq/activerecord.rb
 - sidekiq-activerecord.gemspec
+- spec/examples/alias_user_task_worker.rb
+- spec/examples/helper_classes.rb
+- spec/examples/no_alias_user_task_worker.rb
+- spec/sidekiq/active_record/example/alias_user_task_worker_spec.rb
+- spec/sidekiq/active_record/example/no_alias_user_task_worker_spec.rb
 - spec/sidekiq/active_record/manager_worker_spec.rb
 - spec/sidekiq/active_record/task_worker_spec.rb
 - spec/spec_helper.rb
@@ -145,6 +150,11 @@ signing_key:
 specification_version: 4
 summary: Encapsulates various interactions between Sidekiq and ActiveRecord
 test_files:
+- spec/examples/alias_user_task_worker.rb
+- spec/examples/helper_classes.rb
+- spec/examples/no_alias_user_task_worker.rb
+- spec/sidekiq/active_record/example/alias_user_task_worker_spec.rb
+- spec/sidekiq/active_record/example/no_alias_user_task_worker_spec.rb
 - spec/sidekiq/active_record/manager_worker_spec.rb
 - spec/sidekiq/active_record/task_worker_spec.rb
 - spec/spec_helper.rb