tantot 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a523888d6f676374dba88050d7cb0026383aefa
-  data.tar.gz: db6d802ec982feae01b1bcf0f4926f1cc46d3141
+  metadata.gz: f2858d3a360d204db3c1755fecc65a5e86b3fb8e
+  data.tar.gz: 54d6490ddd105d5ff50eebae905eb91ace85c4e8
 SHA512:
-  metadata.gz: 3f53c127a4a7f8f51fcb9667bf6e58d6ff5e0c5f51746dcb3c14f11527805183cce3ed409083db36b3077c23c6aa531490ee5126bca29f33f7044d631fe437ee
-  data.tar.gz: 75dcd526791dd3f77b760c1f12afab72b73a94bfe9f5c2b4094024757243ac21ecbd50053c3e838da05979bfcff03bec6cc5bbd110a8c2bb2830cc63cb651d29
+  metadata.gz: 6db43766e1c9dd8e2a56ecd81386bc01a46b6c300fc91d823063fe5418df2e0d74910edc4053eb7e20216ea6316383e03d57ed35bbe0e6f9bffeee3d247bbbcf
+  data.tar.gz: 64a89f3516777115416ce38f48d92317f30390c3acfbb8f770d41bbf12e6cdafd07877fc75e9d65391865099f1308fad5f2fc17792e8c6119ec8967394714aff

data/lib/tantot/agent/block.rb

@@ -1,14 +1,20 @@
+require 'cityhash'
+
 module Tantot
   module Agent
     class Block < Base
       def self.identify(watch)
         if watch.block.present?
-          "#{watch.model.to_s}|#{watch.options.inspect}"
+          CityHash.hash64("#{watch.model.to_s}|#{watch.attributes.inspect}|#{watch.options.inspect}")
         else
           nil
         end
       end
 
+      def setup_watch(watch)
+        raise Tantot::MultipleWatchesProhibited.new("Can't have multiple block watches per model with the same attributes and options: #{debug_block(watch.block)}") if @watches.any?
+      end
+
       def perform(changes_by_model)
         # Block agent always has only one watch
         block = watches.first.block

data/lib/tantot/agent.rb

@@ -10,8 +10,8 @@ module Tantot
 
     def self.resolve!(watch)
       agent_classes = AGENT_CLASSES.collect {|klass| [klass, klass.identify(watch)]}.reject {|_klass, id| id.nil?}
-      raise UnresolvableAgent("Can't resolve agent for watch: #{watch.inspect}") unless agent_classes.any?
-      raise UnresolvableAgent("More than one agent manages watch: #{watch.inspect}") if agent_classes.many?
+      raise Tantot::UnresolvableAgent.new("Can't resolve agent for watch: #{watch.inspect}. Specify either a watcher class or define a block.") unless agent_classes.any?
+      raise Tantot::UnresolvableAgent.new("More than one agent manages watch: #{watch.inspect}") if agent_classes.many?
       agent_classes.first
     end
 

data/lib/tantot/errors.rb

@@ -7,4 +7,7 @@ module Tantot
 
   class AgentNotFound < StandardError
   end
+
+  class MultipleWatchesProhibited < StandardError
+  end
 end

data/lib/tantot/extensions/chewy.rb

@@ -31,16 +31,16 @@ module Tantot
             end
           end
 
-          watch('tantot/extensions/chewy/chewy', *args, watch_options)
           Tantot::Extensions::Chewy.register_watch(self, type_name, options, block)
+          watch('tantot/extensions/chewy/chewy', *args, watch_options)
         end
       end
 
       def self.register_watch(model, type_name, options, block)
         method = options.delete(:method)
         model._tantot_chewy_callbacks ||= {}
-        model._tantot_chewy_callbacks[type_name] ||= []
-        model._tantot_chewy_callbacks[type_name].push({method: method, options: options, block: block})
+        raise MultipleWatchesProhibited.new("Cannot register an index watch on the same type more than once: #{type_name}") if model._tantot_chewy_callbacks.key?(type_name)
+        model._tantot_chewy_callbacks[type_name] = [method, options, block]
       end
 
       class ChewyWatcher
@@ -51,84 +51,87 @@ module Tantot
         def perform(changes_by_model)
           changes_by_model.each do |model, changes_by_id|
             model_watches = model._tantot_chewy_callbacks
-            model_watches.each do |type_name, watch_args_array|
+            model_watches.each do |type_name, (method, options, block)|
               # Find type
-              reference =
-                if type_name.is_a?(Proc)
-                  if type_name.arity.zero?
-                    instance_exec(&type_name)
-                  else
-                    type_name.call(self)
-                  end
-                else
-                  type_name
-                end
+              reference = get_chewy_type(type_name)
+              backreference = get_ids_to_update(model, changes_by_id, method, options, block)
 
-              watch_args_array.each do |watch_args|
-                method = watch_args[:method]
-                block = watch_args[:block]
-                options = watch_args[:options]
-                association = options[:association]
+              if backreference
+                backreference.compact!
 
-                # Find ids to update
-                backreference =
-                  if association
-                    reflection = model.reflect_on_association(association)
-                    reflection.check_validity!
-                    case reflection.macro
-                    when :belongs_to
-                      changes_by_id.for_attribute(reflection.foreign_key)
-                    when :has_one, :has_many
-                      if reflection.options[:through]
-                        through_query =
-                          case reflection.through_reflection.macro
-                          when :belongs_to
-                            reflection.through_reflection.klass.where(reflection.through_reflection.klass.primary_key => changes_by_id.for_attribute(reflection.through_reflection.foreign_key))
-                          when :has_many, :has_one
-                            reflection.through_reflection.klass.where(reflection.through_reflection.foreign_key => changes_by_id.ids)
-                          end
-                        case reflection.source_reflection.macro
-                        when :belongs_to
-                          through_query.pluck(reflection.source_reflection.foreign_key)
-                        when :has_many
-                          reflection.source_reflection.klass.where(reflection.source_reflection.foreign_key => (through_query.ids)).ids
-                        end
-                      else
-                        reflection.klass.where(reflection.foreign_key => changes_by_id.ids).ids
-                      end
-                    end
-                  else
-                    if (method && method.to_sym == :self) || (!method && !block)
-                      # Simply extract keys from changes
-                      changes_by_id.keys
-                    elsif method
-                      # We need to call `method`.
-                      # Try to find it on the class. If so, call it once with all changes.
-                      # There is no API to call per-instance since objects can be already destroyed
-                      # when using the sidekiq performer
-                      model.send(method, changes_by_id)
-                    elsif block
-                      # Since we can be post-destruction of the model, we can't load models here
-                      # Thus, the signature of the block callback is |changes| which are all
-                      # the changes to all the models
-                      model.instance_exec(changes_by_id, &block)
-                    end
-                  end
+                # Make sure there are any backreferences
+                if backreference.any?
+                  Tantot.logger.debug { "[Tantot] [Chewy] [update_index] #{reference} (#{backreference.count} objects): #{backreference.inspect}" }
+                  ::Chewy.derive_type(reference).update_index(backreference, {})
+                end
+              else
+                # nothing to update
+              end
+            end
+          end
+        end
 
-                if backreference
-                  backreference.compact!
+        def get_chewy_type(type_name)
+          if type_name.is_a?(Proc)
+            if type_name.arity.zero?
+              instance_exec(&type_name)
+            else
+              type_name.call(self)
+            end
+          else
+            type_name
+          end
+        end
 
-                  # Make sure there are any backreferences
-                  if backreference.any?
-                    Tantot.logger.debug { "[Tantot] [Chewy] [update_index] #{reference} (#{backreference.count} objects): #{backreference.inspect}" }
-                    ::Chewy.derive_type(reference).update_index(backreference, {})
-                  end
-                end
+        def get_ids_to_update(model, changes_by_id, method, options, block)
+          if options.key?(:association)
+            resolve_association(model, options[:association], changes_by_id)
+          else
+            if (method && method.to_sym == :self) || (!method && !block)
+              # Simply extract keys from changes
+              changes_by_id.keys
+            elsif method
+              # We need to call `method`.
+              # Try to find it on the class. If so, call it once with all changes.
+              # There is no API to call per-instance since objects can be already destroyed
+              # when using the sidekiq performer
+              model.send(method, changes_by_id)
+            elsif block
+              # Since we can be post-destruction of the model, we can't load models here
+              # Thus, the signature of the block callback is |changes| which are all
+              # the changes to all the models
+              model.instance_exec(changes_by_id, &block)
+            end
+          end
+        end
 
+        def resolve_association(model, association, changes_by_id)
+          reflection = model.reflect_on_association(association)
+          reflection.check_validity!
+          case reflection.macro
+          when :belongs_to
+            changes_by_id.for_attribute(reflection.foreign_key)
+          when :has_one, :has_many
+            if reflection.options[:through]
+              through_query =
+                case reflection.through_reflection.macro
+                when :belongs_to
+                  reflection.through_reflection.klass.where(reflection.through_reflection.klass.primary_key => changes_by_id.for_attribute(reflection.through_reflection.foreign_key))
+                when :has_many, :has_one
+                  reflection.through_reflection.klass.where(reflection.through_reflection.foreign_key => changes_by_id.ids)
+                end
+              case reflection.source_reflection.macro
+              when :belongs_to
+                through_query.pluck(reflection.source_reflection.foreign_key)
+              when :has_many
+                reflection.source_reflection.klass.where(reflection.source_reflection.foreign_key => (through_query.ids)).ids
               end
+            else
+              reflection.klass.where(reflection.foreign_key => changes_by_id.ids).ids
             end
           end
         end
+
       end
     end
   end

data/lib/tantot/observe.rb

@@ -57,7 +57,10 @@ module Tantot
           # it if it is a string or class
           watcher = args.first.is_a?(String) || args.first.is_a?(Class) ? args.shift : nil
 
-          only_attributes = Array.wrap(options.fetch(:only, [])).collect(&:to_s)
+          raise ArgumentError.new("Only symbols are allowed as attribute filters") unless args.all? {|arg| arg.is_a?(Symbol)}
+          raise ArgumentError.new("Only one of arguments or :only option are valid attribute filters") if args.any? && options.key?(:only)
+
+          only_attributes = Array.wrap(options.fetch(:only, args)).collect(&:to_s)
           always_attributes = Array.wrap(options.fetch(:always, [])).collect(&:to_s)
 
           # Setup watch
@@ -72,7 +75,7 @@ module Tantot
           watch.block = block
           watch.watcher = watcher
 
-          Tantot.agent_registry.register(watch)
+          agent = Tantot.agent_registry.register(watch)
 
           # Setup and register callbacks
           callback_options = {}.tap do |opts|
@@ -86,6 +89,8 @@ module Tantot
             after_save(callback_options, &update_proc)
             after_destroy(callback_options, &update_proc)
           end
+
+          agent
         end
       end
     end

data/lib/tantot/strategy/bypass.rb

@@ -1,7 +1,7 @@
 module Tantot
   module Strategy
     class Bypass
-      def run(id, changes_by_model)
+      def run(agent, changes_by_model)
         # nop
       end
     end

data/lib/tantot/strategy/chewy.rb

@@ -9,8 +9,7 @@ module Tantot
           raise AgentNotFound.new("No registered agent with id #{id}") unless agent
 
           ::Chewy.strategy(chewy_strategy) do
-            agent.peform(Tantot::Strategy::Sidekiq.unmarshal(changes_by_model))
-            Tantot.manager.perform(context, changes)
+            agent.perform(Tantot::Strategy::Sidekiq.unmarshal(changes_by_model))
           end
         end
       end

data/lib/tantot/version.rb

@@ -1,3 +1,3 @@
 module Tantot
-  VERSION = "0.1.8"
+  VERSION = "0.1.9"
 end

data/spec/collector/block_spec.rb

@@ -1,8 +1,7 @@
 require "spec_helper"
 
 describe Tantot::Agent::Block do
-
-  context 'using a block' do
+  context "normal usage" do
     let(:value) { {changes: 0} }
     let(:changes) { {obj: nil} }
     before do
@@ -22,7 +21,7 @@ describe Tantot::Agent::Block do
       expect(changes[:obj]).to eq(Tantot::Changes::ById.new({city.id => {"id" => [nil, 1]}}))
     end
 
-    it "call a single time if multiple changes occur" do
+    it "should call a single time if multiple changes occur" do
       Tantot.manager.run do
         3.times { City.create! }
       end
@@ -30,4 +29,24 @@ describe Tantot::Agent::Block do
       expect(changes[:obj]).to eq(Tantot::Changes::ById.new({1=>{"id"=>[nil, 1]}, 2=>{"id"=>[nil, 2]}, 3=>{"id"=>[nil, 3]}}))
     end
   end
+
+  context "validations" do
+    it "should prevent registering twice with the same options" do
+      expect do
+        stub_model(:city) do
+          watch {}
+          watch {}
+        end
+      end.to raise_error(Tantot::MultipleWatchesProhibited, /Can't have multiple/)
+    end
+
+    it "should allow registering twice with different options" do
+      expect do
+        stub_model(:city) do
+          watch {}
+          watch(:name) {}
+        end
+      end.not_to raise_error
+    end
+  end
 end

data/spec/extensions/chewy_spec.rb

@@ -4,6 +4,15 @@ if defined?(::Chewy)
 
   describe Tantot::Extensions::Chewy do
 
+    context "validations" do
+      it "should prevent registering on the same type more than once" do
+        stub_model(:city) do
+          watch_index 'foo'
+        end
+        expect { City.watch_index 'foo' }.to raise_error(Tantot::MultipleWatchesProhibited, /same type more than once/)
+      end
+    end
+
     [nil, :self, :class_method, :block].product([:some, :all]).each do |backreference_opt, attribute_opt|
       context "should update indexes using backreference: #{backreference_opt.inspect}, attributes: #{attribute_opt}" do
         let(:chewy_type) { double }

data/spec/observe_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+describe Tantot::Observe::ActiveRecordMethods do
+
+  describe ".watch" do
+    before do
+      stub_class(:some_watcher) do
+        include Tantot::Watcher
+      end
+    end
+
+    it "should validate that at least a watcher or a block is defined" do
+      expect do
+        stub_model(:no_block_no_watcher_model) do
+          watch
+        end
+      end.to raise_error(Tantot::UnresolvableAgent, /Can't resolve/)
+    end
+
+    it "should validate that no more than one agent can be specified" do
+      expect do
+        stub_model(:block_and_watcher_model) do
+          watch(SomeWatcher) {}
+        end
+      end.to raise_error(Tantot::UnresolvableAgent, /More than one/)
+    end
+
+    it "should allow registering a simple block watch" do
+      stub_model(:block_model) do
+        watch {}
+      end
+    end
+
+    it "should allow registering a simple watcher watch" do
+      stub_model(:watcher_model) do
+        watch SomeWatcher
+      end
+    end
+
+    it "should treat additional arguments as the :only option" do
+      stub_model(:block_model)
+
+      agent = BlockModel.watch(:foo, :bar) {}
+
+      expect(agent.watches.first.attributes[:only]).to eq(['foo', 'bar'])
+    end
+
+    it "prevent bad arguments" do
+      stub_model(:block_model)
+
+      expect { BlockModel.watch(SomeWatcher, SomeWatcher, :foo, :bar) }.to raise_error(ArgumentError, /symbol/)
+      expect { BlockModel.watch(:foo, "string", :bar) {} }.to raise_error(ArgumentError, /symbol/)
+      expect { BlockModel.watch(:foo, SomeWatcher, :bar) {} }.to raise_error(ArgumentError, /symbol/)
+      expect { BlockModel.watch(:foo, :bar, only: :baz) {} }.to raise_error(ArgumentError, /Only one of/)
+    end
+  end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tantot
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - François-Pierre Bouchard
@@ -183,6 +183,7 @@ files:
 - spec/collector/options_spec.rb
 - spec/collector/watcher_spec.rb
 - spec/extensions/chewy_spec.rb
+- spec/observe_spec.rb
 - spec/sidekiq_spec.rb
 - spec/spec_helper.rb
 - spec/tantot_spec.rb
@@ -217,6 +218,7 @@ test_files:
 - spec/collector/options_spec.rb
 - spec/collector/watcher_spec.rb
 - spec/extensions/chewy_spec.rb
+- spec/observe_spec.rb
 - spec/sidekiq_spec.rb
 - spec/spec_helper.rb
 - spec/tantot_spec.rb