tire_async_index 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee879c3935e505e60740944e6c5b2227eaeff745
-  data.tar.gz: ae62e2506ff7edd585553ea10320c12c1683b11f
+  metadata.gz: b862d7239b23af431da5f68fc6569e8e2ab79555
+  data.tar.gz: 3ac36b477df231387b642c84622041f5a17feff0
 SHA512:
-  metadata.gz: 1a60f3de5dc39526a7128dbd38e76618db72c629ee1d71ca27453e95663a7d41ee7e3b461a300ac80cf49871df94586850c9b5f1367eaf2f7c324e6ba130b7a6
-  data.tar.gz: 676449173b46273ffa10fd6839cc4514b8aedefcb9c7bd5b363268fd8ecf5fea552f67294ed6ab59327563f3ae59bb9d19b9066d53c9b677dab9317e83c4da4e
+  metadata.gz: 99db27b1eb4445aa70225b45fa0d34664775ad1d7dc2cebe3ad49101acce707b981b941b9819e812ef5ce9eea7dc2a8fb1f826d65b12cbf304a19a0f337aa32b
+  data.tar.gz: 70157720a282e54a349e8b9df1a304370ab2f861bea42d5c07d72de9f51779c46e3cd6cac1cc1ff966cf62f8f76fad35c3d33d39fe57515abd1a5366e09177cb

data/Changelog.md

@@ -1,3 +1,8 @@
+## 0.3.0
+
+  * refactor loading structure
+  * custom identificator & finders
+
 ## 0.2.1
 
   * added `find_class_const` for full suuport of rubies (@we4tech)

data/README.md

@@ -8,10 +8,8 @@ Requirements: Ruby 1.9, 2.0, Rails => 3.0
 
 ## Installation
 
-Add this line to your application's Gemfile after `tire` and `sidekiq` or `resque` gems:
+Add this line to your application's Gemfile:
 
-    gem 'tire'
-    gem 'sidekiq' #'resque'
     gem 'tire_async_index'
 
 And then execute:
@@ -44,6 +42,23 @@ Just add AsyncCallbacks to your model:
 
 That's all.
 
+## Custom identificator or finder
+
+If you need more complex solution to define identificators and/or finder. You could simply add methods to override default:
+
+    class User < ActiveRecord::Base
+        include Tire::Model::Search
+        include Tire::Model::AsyncCallbacks
+
+        def self.tire_async_finder(id)
+          User.where(...).first
+        end
+
+        def async_tire_object_id
+          "#{id}-#{name}"
+        end
+    end
+
 ## TODO
 
 * Add support for custom filter / custom finders

data/lib/tire/model/async_callbacks.rb

@@ -32,30 +32,27 @@ module Tire
       end
 
       def async_tire_callback(type)
-        case TireAsyncIndex.engine
-          when :sidekiq
-            TireAsyncIndex::Workers::SidekiqUpdateIndex.
-              perform_async type, self.class.name, async_tire_object_id
-
-          when :resque
-            Resque.enqueue TireAsyncIndex::Workers::ResqueUpdateIndex,
-              type, self.class.name, async_tire_object_id
-
-          else
-            case type
-              when :update
-                tire.update_index
-              when :delete
-                tire.index.remove self
-            end
+        if TireAsyncIndex.engine == :none
+          case type
+          when :update
+            tire.update_index
+          when :delete
+            tire.index.remove self
+          end
+        else
+          TireAsyncIndex.worker.run(type, self.class.name, get_async_tire_object_id)
         end
       end
 
-      def async_tire_object_id
-        if (method = ID_CONVERSION[self.id.class.name])
-          self.id.send(method)
+      def get_async_tire_object_id
+        if self.respond_to?(:async_tire_object_id)
+          self.send(:async_tire_object_id)
         else
-          self.id
+          if (method = ID_CONVERSION[self.id.class.name])
+            self.id.send(method)
+          else
+            self.id
+          end
         end
       end
 

data/lib/tire_async_index.rb

@@ -9,7 +9,6 @@ module TireAsyncIndex
   def configure
     self.configuration ||= Configuration.new
     yield(configuration)
-    reconfig_workers
   end
 
   def queue
@@ -20,20 +19,25 @@ module TireAsyncIndex
     self.configuration.engine
   end
 
-  def reconfig_workers
-    if defined?(Sidekiq)
-      Workers::SidekiqUpdateIndex.sidekiq_options_hash["queue"] = TireAsyncIndex.queue
+  def worker
+    case configuration.engine
+    when :sidekiq
+      TireAsyncIndex::Workers::Sidekiq
+    when :resque
+      TireAsyncIndex::Workers::Resque
+    else
+      TireAsyncIndex::Workers::UpdateIndex
     end
   end
 
   module Workers
     autoload :UpdateIndex, 'tire_async_index/workers/update_index'
+    autoload :Sidekiq,     'tire_async_index/workers/sidekiq'
+    autoload :Resque,      'tire_async_index/workers/resque'
   end
 
 end
 
-require 'tire_async_index/workers/sidekiq_update_index' if defined?(Sidekiq)
-require 'tire_async_index/workers/resque_update_index' if defined?(Resque)
 require 'tire/model/async_callbacks'
 
 TireAsyncIndex.configure {}

data/lib/tire_async_index/version.rb

@@ -1,3 +1,3 @@
 module TireAsyncIndex
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/tire_async_index/workers/resque.rb

@@ -0,0 +1,15 @@
+module TireAsyncIndex
+  module Workers
+    class Resque < UpdateIndex
+      def self.queue; TireAsyncIndex.queue end
+
+      def self.run(action_type, class_name, id)
+        ::Resque.enqueue TireAsyncIndex::Workers::Resque, action_type, class_name, id
+      end
+
+      def self.perform(action_type, class_name, id)
+        self.new.process(action_type, class_name, id)
+      end
+    end
+  end
+end

data/lib/tire_async_index/workers/sidekiq.rb

@@ -0,0 +1,18 @@
+module TireAsyncIndex
+  module Workers
+    class Sidekiq < UpdateIndex
+      include ::Sidekiq::Worker
+      sidekiq_options queue: TireAsyncIndex.queue
+
+      def self.run(action_type, class_name, id)
+        TireAsyncIndex::Workers::Sidekiq
+          .perform_async(action_type, class_name, id)
+      end
+
+      def perform(action_type, class_name, id)
+        process(action_type, class_name, id)
+      end
+
+    end
+  end
+end

data/lib/tire_async_index/workers/update_index.rb

@@ -11,12 +11,13 @@ module TireAsyncIndex
       #   class_name - Model class name
       #   id - Document id
       #
-      def perform(action_type, class_name, id)
+
+      def process(action_type, class_name, id)
         klass = find_class_const(class_name)
 
         case action_type.to_sym
           when :update
-            object = klass.find(id)
+            object = klass.send(get_finder_method(klass), id)
 
             if object.present? && object.respond_to?(:tire)
               object.tire.update_index
@@ -38,6 +39,10 @@ module TireAsyncIndex
           end
         end
       end
+
+      def get_finder_method(klass)
+        klass.respond_to?(:tire_async_finder) ? :tire_async_finder : :find
+      end
     end
   end
 end

data/spec/active_model_tire_async_index_spec.rb

@@ -86,7 +86,7 @@ describe TireAsyncIndex do
           config.background_engine :sidekiq
         end
 
-        TireAsyncIndex::Workers::SidekiqUpdateIndex.should_receive(:perform_async).with(:update, "AmUser", instance_of(Fixnum))
+        TireAsyncIndex::Workers::Sidekiq.should_receive(:perform_async).with(:update, "AmUser", instance_of(Fixnum))
 
         AmUser.new.tap { |a| a.id = 23 }.save
       end
@@ -96,7 +96,7 @@ describe TireAsyncIndex do
           config.background_engine :resque
         end
 
-        Resque.should_receive(:enqueue).with(TireAsyncIndex::Workers::ResqueUpdateIndex, :update, "AmUser", instance_of(Fixnum))
+        Resque.should_receive(:enqueue).with(TireAsyncIndex::Workers::Resque, :update, "AmUser", instance_of(Fixnum))
 
         AmUser.new.tap { |a| a.id = 23 }.save
       end
@@ -122,7 +122,7 @@ describe TireAsyncIndex do
           config.background_engine :sidekiq
         end
 
-        TireAsyncIndex::Workers::SidekiqUpdateIndex.should_receive(:perform_async).with(:delete, "AmUser", instance_of(Fixnum))
+        TireAsyncIndex::Workers::Sidekiq.should_receive(:perform_async).with(:delete, "AmUser", instance_of(Fixnum))
 
         AmUser.new.tap { |a| a.id = 23 }.destroy
       end
@@ -132,11 +132,11 @@ describe TireAsyncIndex do
           config.background_engine :resque
         end
 
-        Resque.should_receive(:enqueue).with(TireAsyncIndex::Workers::ResqueUpdateIndex, :delete, "AmUser", instance_of(Fixnum))
+        Resque.should_receive(:enqueue).with(TireAsyncIndex::Workers::Resque, :delete, "AmUser", instance_of(Fixnum))
 
         AmUser.new.tap { |a| a.id = 23 }.destroy
       end
     end
 
   end
-end
+end

data/spec/active_record_tire_async_index_spec.rb

@@ -8,6 +8,14 @@ class ArUser < ActiveRecord::Base
   include Tire::Model::AsyncCallbacks
 end
 
+class ArIdUser < ActiveRecord::Base
+  include Tire::Model::AsyncCallbacks
+
+  def async_tire_object_id
+    "text_id"
+  end
+end
+
 describe TireAsyncIndex do
 
   before(:all) do
@@ -72,7 +80,7 @@ describe TireAsyncIndex do
           config.background_engine :sidekiq
         end
 
-        TireAsyncIndex::Workers::SidekiqUpdateIndex.should_receive(:perform_async).with(:update, "ArUser", instance_of(Fixnum))
+        TireAsyncIndex::Workers::Sidekiq.should_receive(:perform_async).with(:update, "ArUser", instance_of(Fixnum))
 
         a = ArUser.new
         a.save
@@ -83,11 +91,33 @@ describe TireAsyncIndex do
           config.background_engine :resque
         end
 
-        Resque.should_receive(:enqueue).with(TireAsyncIndex::Workers::ResqueUpdateIndex, :update, "ArUser", instance_of(Fixnum))
+        Resque.should_receive(:enqueue).with(TireAsyncIndex::Workers::Resque, :update, "ArUser", instance_of(Fixnum))
 
         a = ArUser.new
         a.save
       end
+
+      it "should start sidekiq with custom id" do
+        TireAsyncIndex.configure do |config|
+          config.background_engine :sidekiq
+        end
+
+        TireAsyncIndex::Workers::Sidekiq.should_receive(:perform_async).with(:update, "ArIdUser", "text_id")
+
+        a = ArIdUser.new
+        a.save
+      end
+
+      it "should start resque with custom id" do
+        TireAsyncIndex.configure do |config|
+          config.background_engine :resque
+        end
+
+        Resque.should_receive(:enqueue).with(TireAsyncIndex::Workers::Resque, :update, "ArIdUser", "text_id")
+
+        a = ArIdUser.new
+        a.save
+      end
     end
 
     describe '#after_destroy' do
@@ -110,7 +140,7 @@ describe TireAsyncIndex do
           config.background_engine :sidekiq
         end
 
-        TireAsyncIndex::Workers::SidekiqUpdateIndex.should_receive(:perform_async).with(:delete, "ArUser", instance_of(Fixnum))
+        TireAsyncIndex::Workers::Sidekiq.should_receive(:perform_async).with(:delete, "ArUser", instance_of(Fixnum))
 
         ArUser.new.tap { |a| a.id = 23 }.destroy
       end
@@ -120,11 +150,11 @@ describe TireAsyncIndex do
           config.background_engine :resque
         end
 
-        Resque.should_receive(:enqueue).with(TireAsyncIndex::Workers::ResqueUpdateIndex, :delete, "ArUser", instance_of(Fixnum))
+        Resque.should_receive(:enqueue).with(TireAsyncIndex::Workers::Resque, :delete, "ArUser", instance_of(Fixnum))
 
         ArUser.new.tap { |a| a.id = 23 }.destroy
       end
     end
 
   end
-end
+end

data/spec/test_schema.rb

@@ -4,4 +4,4 @@ ActiveRecord::Schema.define(version: 20130315203352) do
     t.datetime "updated_at"
     t.string   "name"
   end
-end
+end

data/spec/update_index_spec.rb

@@ -11,16 +11,38 @@ module Level1
   end
 end
 
+class ArUser < ActiveRecord::Base
+  include Tire::Model::AsyncCallbacks
+end
+
+class ArUserFinder < ActiveRecord::Base
+  include Tire::Model::AsyncCallbacks
+
+  def self.tire_async_finder(id)
+    nil
+  end
+end
+
 describe TireAsyncIndex::Workers::UpdateIndex do
 
-  describe '#perform' do
+  describe '#process' do
     let(:instance) { described_class.new }
 
     it 'resolves class constant' do
       expect {
-        instance.perform(:nothing, 'Level1::Level2::Model', 123)
+        instance.process(:nothing, 'Level1::Level2::Model', 123)
       }.not_to raise_error
     end
+
+    it 'trigger find on simple ar model' do
+      ArUser.should_receive(:find).with(123).and_return(nil)
+      instance.process(:update, 'ArUser', 123)
+    end
+
+    it 'trigger finder on ar mode with custom finder' do
+      ArUserFinder.should_receive(:tire_async_finder).with(123).and_return(nil)
+      instance.process(:update, 'ArUserFinder', 123)
+    end
   end
 
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tire_async_index
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Sergey Efremov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-21 00:00:00.000000000 Z
+date: 2013-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tire
@@ -142,8 +142,8 @@ files:
 - lib/tire_async_index/configuration.rb
 - lib/tire_async_index/exceptions.rb
 - lib/tire_async_index/version.rb
-- lib/tire_async_index/workers/resque_update_index.rb
-- lib/tire_async_index/workers/sidekiq_update_index.rb
+- lib/tire_async_index/workers/resque.rb
+- lib/tire_async_index/workers/sidekiq.rb
 - lib/tire_async_index/workers/update_index.rb
 - spec/active_model_tire_async_index_spec.rb
 - spec/active_record_tire_async_index_spec.rb

data/lib/tire_async_index/workers/resque_update_index.rb

@@ -1,11 +0,0 @@
-module TireAsyncIndex
-  module Workers
-    class ResqueUpdateIndex < UpdateIndex
-      def self.queue; TireAsyncIndex.queue end
-
-      def self.perform(*args)
-        self.new.perform *args
-      end
-    end
-  end
-end

data/lib/tire_async_index/workers/sidekiq_update_index.rb

@@ -1,8 +0,0 @@
-module TireAsyncIndex
-  module Workers
-    class SidekiqUpdateIndex < UpdateIndex
-      include Sidekiq::Worker
-      sidekiq_options queue: :normal
-    end
-  end
-end