gabrielg-extended_observers 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Gabriel Gironda
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,9 @@
+= extended_observers
+
+I needed to use an observer to observe multiple models, but only wanted to observe certain sets of changes on each one. There was also a bug where calling observe twice in an ActiveRecord Observer would clear out any previous list of observed classes. This patch adds both the :on option and refactors the workings of the observe method to not clear out models from previous declarations
+
+See also: https://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/1639
+
+== Copyright
+
+Copyright (c) 2009 Gabriel Gironda. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "extended_observers"
+    gem.summary = %Q{TODO}
+    gem.email = "gabriel.gironda@gmail.com"
+    gem.homepage = "http://github.com/gabrielg/extended_observers"
+    gem.authors = ["Gabriel Gironda"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "extended_observers #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 0
+:patch: 1

data/lib/extended_observers.rb

@@ -0,0 +1,65 @@
+require 'active_support'
+require 'active_record'
+require 'active_record/observer'
+
+# Monkey patch until http://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/1639
+# gets accepted.
+module ActiveRecord 
+  class Observer
+    write_inheritable_hash :observable_updates, {}
+    class << self
+      
+      # Attaches the observer to the supplied model classes.
+      def observe(*models)
+        options = models.extract_options!
+        set_watch_options(models, options)
+        models = constantize_models(models)
+        already_observed = read_inheritable_attribute(:observed_classes)
+        write_inheritable_attribute(:observed_classes, Set.new(Array(already_observed)) + Set.new(models))
+      end
+
+    private
+
+      def set_watch_options(models, options)
+        on_methods = options.inject([]) do |methods,(key,val)|
+          if [:before, :after].include?(key)
+            methods.concat(Array(val).map {|v| :"#{key}_#{v}"})
+          elsif key == :on
+            methods.concat(Array(val).map(&:to_sym))
+          end
+          methods
+        end
+        constantize_models(models).each do |model|
+          existing = (obs = read_inheritable_attribute(:observable_updates)) ? obs[model] : []
+          write_inheritable_hash(:observable_updates, model => Array(existing) + on_methods)
+        end
+      end
+      
+      def constantize_models(models)
+        models.flatten.collect { |model| model.is_a?(Symbol) ? model.to_s.camelize.constantize : model }
+      end
+      
+    end # << self
+
+    # Send observed_method(object) if the method exists.
+    def update(observed_method, object) #:nodoc:
+      send(observed_method, object) if listening_for?(object, observed_method)
+    end
+    
+    def observed_classes
+      self.class.read_inheritable_attribute(:observed_classes) || Set.new([self.class.observed_class].compact.flatten)
+    end
+
+  protected
+
+    def listening_for?(object, observed_method)
+      respond_to?(observed_method) && watching?(object, observed_method)
+    end
+
+    def watching?(object, observed_method)
+      observed = self.class.read_inheritable_attribute(:observable_updates)
+      observed[object.class].blank? || observed[object.class].include?(observed_method.to_sym)
+    end
+      
+  end   # Observer
+end     # ActiveRecord

data/test/extended_observers_test.rb

@@ -0,0 +1,86 @@
+require 'test_helper'
+require 'ruby-debug'
+
+# Don't really need a DB connection for these tests
+class ActiveRecord::Base
+  def self.columns; []; end
+end
+
+class Topic < ActiveRecord::Base; end
+class Developer < ActiveRecord::Base; end
+class Reply < ActiveRecord::Base; end
+
+class ActivityObserver < ActiveRecord::Observer
+  observe :topic, :after => [:create, :destroy], :before => :update
+  observe :topic, :developer, :on => [:before_destroy, 'before_save']
+  observe :reply
+end
+
+class ExtendedObserversTest < ActiveRecord::TestCase
+  
+  def setup
+    @observer = ActivityObserver.instance
+  end
+  
+  context "observing a topic" do
+  
+    topic = Topic.new
+    
+    should "observe after_create on Topic" do
+      @observer.expects(:after_create).with(topic)
+      topic.send(:notify, :after_create)
+    end
+
+    should "observe after_destroy on Topic" do
+      @observer.expects(:after_destroy).with(topic)
+      topic.send(:notify, :after_destroy)
+    end
+    
+    should "observe before_update on Topic" do
+      @observer.expects(:before_update).with(topic)
+      topic.send(:notify, :before_update)
+    end
+    
+    should "observe before_destroy on Topic" do 
+      @observer.expects(:before_destroy).with(topic)
+      topic.send(:notify, :before_destroy)
+    end
+  
+    should "observe before_save on Topic" do
+      @observer.expects(:before_save).with(topic)
+      topic.send(:notify, :before_save)
+    end
+  
+    should "ignore after_save and after_validation on topic" do
+      @observer.expects(:after_save).with(topic).never
+      @observer.expects(:after_validation).with(topic).never
+      topic.send(:notify, :after_save)
+      topic.send(:notify, :after_validation)
+    end
+    
+  end # observing a topic
+
+  context "observing a developer" do
+    developer = Developer.new
+    
+    should "observe before_destroy on Developer" do
+      @observer.expects(:before_destroy).with(developer)
+      developer.send(:notify, :before_destroy)
+    end
+  
+    should "observe before_save on Developer" do
+      @observer.expects(:before_save).with(developer)
+      developer.send(:notify, :before_save)
+    end
+    
+  end
+  
+  should "observe all callbacks on Reply" do
+    reply = Reply.new
+    ActiveRecord::Callbacks::CALLBACKS.each do |callback|
+      @observer.expects(callback).with(reply)
+      reply.send(:notify, callback)
+    end
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'extended_observers'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: gabrielg-extended_observers
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Gabriel Gironda
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-23 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: gabriel.gironda@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/extended_observers.rb
+- test/extended_observers_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/gabrielg/extended_observers
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: TODO
+test_files: 
+- test/extended_observers_test.rb
+- test/test_helper.rb