association_observers 0.0.5 → 0.0.6

data/lib/association_observers/ruby18.rb

@@ -1,12 +1,30 @@
 # -*- encoding : utf-8 -*-
 module AssociationObservers
-  def self.extended_to_s(val)
-    if val.is_a?(Hash)
-      "{#{val.map{|k, v| ":#{k}=>#{extended_to_s(v)}"}.join(",")}}"
-    elsif val.is_a?(Array)
-      "[#{val.map{|a|extended_to_s(a)}.join(",")}]"
-    else
-      val.is_a?(Symbol) ? ":#{val}" : val.is_a?(String) ? "\"#{val}\"" : val
+  module Backports
+    def self.extended_to_s(val)
+      if val.is_a?(Hash)
+        "{#{val.map{|k, v| ":#{k}=>#{extended_to_s(v)}"}.join(",")}}"
+      elsif val.is_a?(Array)
+        "[#{val.map{|a|extended_to_s(a)}.join(",")}]"
+      else
+        val.is_a?(Symbol) ? ":#{val}" : val.is_a?(String) ? "\"#{val}\"" : val
+      end
     end
+
+
+    def self.hash_select(hash, &proc)
+      Hash[hash.select(&proc)]
+    end
+
+    module Proc
+      # it's called fake curry because it only works on one level, that is, you can only pass one level of sub-arguments
+      # sorry, ruby 1.8 sucks balls
+      def self.fake_curry(method, *args)
+        proc { |*proc_args|
+          method.call(*(args + proc_args))
+        }
+      end
+    end
+
   end
-end
+end

data/lib/association_observers/version.rb

@@ -1,3 +1,3 @@
 module AssociationObservers
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/association_observers/workers/many_delayed_notification.rb

@@ -0,0 +1,41 @@
+# -*- encoding : utf-8 -*-
+module AssociationObservers
+  module Workers
+    # This is our main batched worker. It helps on the task of queueing batches of records and asynchronously
+    # call the notifier conditional action for each of them.
+    class ManyDelayedNotification
+
+      attr_reader :observer_ids, :observer_klass, :observable_id, :observable_klass, :notifier
+
+      # @param [Array] observer_ids array of ids of the observers which are going to be iterated
+      # @param [String] observer_klass the class of the observers
+      # @param [Integer, String] observable_id if of the observable
+      # @param [String] observable_klass the class of the observable
+      # @param [String] notifier the notifier containing the action in marshalled format
+      def initialize(observer_ids, observer_klass, observable_id, observable_klass, notifier)
+        @observer_ids = observer_ids
+        @observer_klass = observer_klass
+        @observable_id = observable_id
+        @observable_klass = observable_klass
+        @notifier = Marshal.dump(notifier)
+      end
+
+      # Here we execute our task:
+      # 1. Unmarshal notifier, get observable
+      # 2. Load all the observers
+      # 3. Iterate over them and execute the notifier #conditional_action, which takes the observer and the observable as parameters
+      def perform
+        observable = AssociationObservers::orm_adapter.find(@observable_klass.constantize, @observable_id)
+        return if observable.nil?
+        notifier = Marshal.load(@notifier)
+        method = RUBY_VERSION < "1.9" ?
+            AssociationObservers::Backports::Proc.fake_curry(notifier.method(:conditional_action).to_proc, observable) :
+            notifier.method(:conditional_action).to_proc.curry[observable]
+        AssociationObservers::orm_adapter.find_all(@observer_klass.constantize, :id => @observer_ids).each(&method)
+      end
+
+
+    end
+  end
+
+end

data/spec/activerecord/association_observers_spec.rb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
-require "./spec/active_record_helper"
+require "./spec/helpers/active_record_helper"
 require "./spec/spec_helper"
 
 
@@ -90,6 +90,7 @@ describe AssociationObservers do
     has_many :polymorphic_has_many_observable_tests, :as => :observer
 
     has_one :observer_observer_test
+    has_many :many_observer_observer_tests
 
     has_and_belongs_to_many :habtm_observable_tests
 
@@ -126,6 +127,13 @@ describe AssociationObservers do
     observes :observer_test, :notifiers => :test_update, :on => :update
   end
 
+  class ManyObserverObserverTest < ObserverAbstractTest
+    belongs_to :observer_test
+    attr_accessible :observer_test
+
+    observes :observer_test, :notifiers => :test_update, :on => :update
+  end
+
   ActiveRecord::Schema.define do
     create_table :association_observer_tests, :force => true do |t|
       t.column :type, :string # for polymorphic test only
@@ -428,6 +436,29 @@ describe AssociationObservers do
     end
   end
 
+  describe "when the observer has an observer collection itself" do
+    before(:each) do
+      observer1.update_attribute(:many_observer_observer_tests, [ManyObserverObserverTest.new,
+                                                                 ManyObserverObserverTest.new,
+                                                                 ManyObserverObserverTest.new])
+      observer1.reload
+    end
+    describe "and the batch size for the observer observers has changed" do
+      before do
+        @old_batch_size = ObserverTest.observable_options[:batch_size]
+        ManyObserverObserverTest.stub! :observable? => true
+        ObserverTest.batch_size = 101
+      end
+      after do
+        ObserverTest.batch_size = @old_batch_size
+      end
+      it "should update the observer observers collection with the right batch size" do
+        AssociationObservers.should_receive(:batched_each).with(anything, 101).any_number_of_times
+        belongs_to_observable.update_attributes(:name => "doof")
+      end
+    end
+  end
+
 
   describe "when the association is polymorphic" do
     class HasOnePolymorphicObservableTest < ObservableAbstractTest

data/spec/activerecord/delayed_job/association_observers_spec.rb

@@ -0,0 +1,8 @@
+# -*- encoding : utf-8 -*-
+require "./spec/helpers/active_record_helper"
+require "./spec/helpers/delayed_job_helper"
+require "./spec/spec_helper"
+
+AssociationObservers::queue.engine = :delayed_job
+
+eval File.read(File.join(File.dirname(__FILE__), '..', 'association_observers_spec.rb'))

data/spec/activerecord/readme_example_spec.rb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
-require "./spec/active_record_helper"
+require "./spec/helpers/active_record_helper"
 require './spec/spec_helper'
 require 'examples/readme_example'
 

data/spec/activerecord/resque/association_observers_spec.rb

@@ -0,0 +1,8 @@
+# -*- encoding : utf-8 -*-
+require "./spec/helpers/active_record_helper"
+require "./spec/helpers/resque_helper"
+require "./spec/spec_helper"
+
+AssociationObservers::queue.engine = :resque
+
+eval File.read(File.join(File.dirname(__FILE__), '..', 'association_observers_spec.rb'))

data/spec/activerecord/sidekiq/association_observers_spec.rb

@@ -0,0 +1,8 @@
+# -*- encoding : utf-8 -*-
+require "./spec/helpers/active_record_helper"
+require "./spec/helpers/sidekiq_helper"
+require "./spec/spec_helper"
+
+AssociationObservers::queue.engine = :sidekiq
+
+eval File.read(File.join(File.dirname(__FILE__), '..', 'association_observers_spec.rb'))

data/spec/datamapper/association_observers_spec.rb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
-require "./spec/datamapper_helper"
+require "./spec/helpers/datamapper_helper"
 require "./spec/spec_helper"
 
 
@@ -109,6 +109,7 @@ describe AssociationObservers do
 
 
     has 1, :observer_observer_test
+    has n, :many_observer_observer_tests
 
     has n, :habtm_observable_tests, :through => Resource
 
@@ -141,6 +142,19 @@ describe AssociationObservers do
     observes :observer_test, :notifiers => :test_update, :on => :update
   end
 
+  class ManyObserverObserverTest
+    include DataMapper::Resource
+
+    property :id, Serial
+    property :type, Discriminator
+    property :updated, Boolean
+    property :deleted, Boolean
+
+    belongs_to :observer_test, :required => false
+
+    observes :observer_test, :notifiers => :test_update, :on => :update
+  end
+
   DataMapper.finalize
 
   DataMapper.auto_migrate!
@@ -177,7 +191,6 @@ describe AssociationObservers do
       observer1.should_not be_deleted
     end
   end
-
   describe "when the belongs to observable is updated" do
     before(:each) do
       belongs_to_observable.update(:name => "doof")
@@ -322,6 +335,28 @@ describe AssociationObservers do
     end
   end
 
+  describe "when the observer has an observer collection itself" do
+    before(:each) do
+      ManyObserverObserverTest.create(:observer_test => observer1)
+      observer1.reload
+    end
+    describe "and the batch size for the observer observers has changed" do
+      before do
+        @old_batch_size = ObserverTest.observable_options[:batch_size]
+        ManyObserverObserverTest.stub! :observable? => true
+        ManyObserverObserverTest.any_instance.stub :notify_observers => true
+        ObserverTest.batch_size = 101
+      end
+      after do
+        ObserverTest.batch_size = @old_batch_size
+      end
+      it "should update the observer observers collection with the right batch size" do
+        AssociationObservers.should_receive(:batched_each).with(anything, 101).any_number_of_times
+        belongs_to_observable.update(:name => "doof")
+      end
+    end
+  end
+
   describe "when the association is a joined through" do
     class HasOneThroughObservableTest
       include DataMapper::Resource

data/spec/{active_record_helper.rb → helpers/active_record_helper.rb}

@@ -1,5 +1,8 @@
 # -*- encoding : utf-8 -*-
 require 'rubygems'
 require 'active_record'
-ActiveRecord::Base.configurations = YAML.load_file(File.join(File.expand_path('../..', __FILE__), 'database.yml'))
+require 'logger'
+ActiveRecord::Base.configurations = YAML.load_file(File.join(File.expand_path('../../..', __FILE__), 'database.yml'))
 ActiveRecord::Base.establish_connection("activerecord")
+FileUtils.mkdir_p("log")
+ActiveRecord::Base.logger = Logger.new(File.new("log/test.log", "w"))

data/spec/{datamapper_helper.rb → helpers/datamapper_helper.rb}

@@ -2,6 +2,6 @@
 require 'rubygems'
 require 'data_mapper'
 
-datamapper_config = YAML.load_file(File.join(File.expand_path('../..', __FILE__), 'database.yml'))["datamapper"]
+datamapper_config = YAML.load_file(File.join(File.expand_path('../../..', __FILE__), 'database.yml'))["datamapper"]
 
 DataMapper.setup(:default, datamapper_config)

data/spec/helpers/delayed_job_helper.rb

@@ -0,0 +1,26 @@
+# -*- encoding : utf-8 -*-
+require "logger"
+require "delayed_job_active_record"
+
+FileUtils.mkdir_p("log")
+Delayed::Worker.logger = Logger.new(File.new("log/delayed.log", "w"))
+
+Delayed::Worker.delay_jobs = false
+
+ActiveRecord::Schema.define do
+  create_table :delayed_jobs, :force => true do |table|
+    table.integer  :priority, :default => 0
+    table.integer  :attempts, :default => 0
+    table.text     :handler
+    table.text     :last_error
+    table.datetime :run_at
+    table.datetime :locked_at
+    table.datetime :failed_at
+    table.string   :locked_by
+    table.string   :queue
+    table.timestamps
+  end
+
+  add_index :delayed_jobs, [:priority, :run_at], :name => 'delayed_jobs_priority'
+
+end

data/spec/helpers/resque_helper.rb

@@ -0,0 +1,5 @@
+# -*- encoding : utf-8 -*-
+require "logger"
+require "resque"
+
+Resque.inline = true

data/spec/helpers/sidekiq_helper.rb

@@ -0,0 +1,4 @@
+# -*- encoding : utf-8 -*-
+require "logger"
+require "sidekiq"
+require 'sidekiq/testing/inline'

metadata

@@ -1,171 +1,172 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: association_observers
-version: !ruby/object:Gem::Version
-  version: 0.0.5
+version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 6
+  version: 0.0.6
 platform: ruby
-authors:
+authors: 
 - Tiago Cardoso
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-04 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
+
+date: 2013-04-25 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 9
+        - 2
+        - 2
         version: 0.9.2.2
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :development
+  name: rake
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.9.2.2
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 6
+        - 2
         version: 0.6.2
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.6.2
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  type: :development
+  name: rack-test
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 2
+        - 11
+        - 0
         version: 2.11.0
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :development
+  name: rspec
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.11.0
-- !ruby/object:Gem::Dependency
-  name: database_cleaner
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 8
+        - 0
         version: 0.8.0
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.8.0
-- !ruby/object:Gem::Dependency
-  name: colorize
-  requirement: !ruby/object:Gem::Requirement
+  type: :development
+  name: database_cleaner
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 5
+        - 8
         version: 0.5.8
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  type: :development
+  name: colorize
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.5.8
-- !ruby/object:Gem::Dependency
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
   name: pry
-  requirement: !ruby/object:Gem::Requirement
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+  type: :development
   name: pry-doc
-  requirement: !ruby/object:Gem::Requirement
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+  type: :development
   name: awesome_print
-  requirement: !ruby/object:Gem::Requirement
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
   type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-description: ! "This is an alternative implementation of the observer pattern. As
-  you may know, Ruby (and Rails/ActiveRecord) already have an\n  implementation of
-  it. This implementation is a variation of the pattern, so it is not supposed to
-  supersede the existing\n  implementations, but \"complete\" them for the specific
-  use-cases addressed."
-email:
+  name: activesupport
+  requirement: *id009
+description: |-
+  This is an alternative implementation of the observer pattern. As you may know, Ruby (and Rails/ActiveRecord) already have an
+    implementation of it. This implementation is a variation of the pattern, so it is not supposed to supersede the existing
+    implementations, but "complete" them for the specific use-cases addressed.
+email: 
 - cardoso_tiago@hotmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .pryrc
 - .rspec
@@ -177,62 +178,79 @@ files:
 - association_observers.gemspec
 - database.yml
 - lib/association_observers.rb
-- lib/association_observers/activerecord.rb
-- lib/association_observers/datamapper.rb
+- lib/association_observers/active_record.rb
+- lib/association_observers/data_mapper.rb
+- lib/association_observers/extensions/delayed_job.rb
+- lib/association_observers/extensions/resque.rb
+- lib/association_observers/extensions/sidekiq.rb
 - lib/association_observers/notifiers/base.rb
 - lib/association_observers/notifiers/propagation_notifier.rb
+- lib/association_observers/orm/active_record.rb
+- lib/association_observers/orm/base.rb
+- lib/association_observers/orm/data_mapper.rb
+- lib/association_observers/queue.rb
 - lib/association_observers/railtie.rb
 - lib/association_observers/ruby18.rb
 - lib/association_observers/version.rb
+- lib/association_observers/workers/many_delayed_notification.rb
 - lib/examples/notifiers/update_timestamp_notifier.rb
 - lib/examples/readme_example.rb
-- spec/active_record_helper.rb
 - spec/activerecord/association_observers_spec.rb
+- spec/activerecord/delayed_job/association_observers_spec.rb
 - spec/activerecord/readme_example_spec.rb
+- spec/activerecord/resque/association_observers_spec.rb
+- spec/activerecord/sidekiq/association_observers_spec.rb
 - spec/datamapper/association_observers_spec.rb
-- spec/datamapper_helper.rb
+- spec/helpers/active_record_helper.rb
+- spec/helpers/datamapper_helper.rb
+- spec/helpers/delayed_job_helper.rb
+- spec/helpers/resque_helper.rb
+- spec/helpers/sidekiq_helper.rb
 - spec/spec_helper.rb
 homepage: https://github.com/TiagoCardoso1983/association_observers
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -894078036054121301
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
       - 0
-      hash: -894078036054121301
+      version: "0"
 requirements: []
+
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: ! 'The Observer Pattern clearly defines two roles: the observer and the observed.
-  The observer registers itself by the observed. The observed decides when (for which
-  "actions") to notify the observer. The observer knows what to do when notified.  What''s
-  the limitation? The observed has to know when and whom to notify. The observer has
-  to know what to do. For this logic to be implemented for two other separate entities,
-  behaviour has to be copied from one place to the other. So, why not delegate this
-  information (to whom, when, behaviour) to a third role, the notifier?'
-test_files:
-- spec/active_record_helper.rb
+summary: "The Observer Pattern clearly defines two roles: the observer and the observed. The observer registers itself by the observed. The observed decides when (for which \"actions\") to notify the observer. The observer knows what to do when notified.  What's the limitation? The observed has to know when and whom to notify. The observer has to know what to do. For this logic to be implemented for two other separate entities, behaviour has to be copied from one place to the other. So, why not delegate this information (to whom, when, behaviour) to a third role, the notifier?"
+test_files: 
 - spec/activerecord/association_observers_spec.rb
+- spec/activerecord/delayed_job/association_observers_spec.rb
 - spec/activerecord/readme_example_spec.rb
+- spec/activerecord/resque/association_observers_spec.rb
+- spec/activerecord/sidekiq/association_observers_spec.rb
 - spec/datamapper/association_observers_spec.rb
-- spec/datamapper_helper.rb
+- spec/helpers/active_record_helper.rb
+- spec/helpers/datamapper_helper.rb
+- spec/helpers/delayed_job_helper.rb
+- spec/helpers/resque_helper.rb
+- spec/helpers/sidekiq_helper.rb
 - spec/spec_helper.rb
 has_rdoc: