active_model_listener 0.2.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jeff Dean
+
+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.md

@@ -0,0 +1,96 @@
+# ActiveModelListener
+
+Simple, global ActiveRecord event observers, using a middleware architecture, that can easily be turned on and off.  Designed for audit trails, activity feeds and other application-level event handlers.
+
+## Usage
+
+First, require Active Model Listener above your rails initializer:
+
+    # environment.rb
+    require 'active_model_listener'
+    Rails::Initializer.run do |config|
+      # ...
+    end
+
+Add the listeners to the ActiveModelListener in an initializer:
+
+    # config/initializers/active_model_listener.rb
+    ActiveModelListener.listeners << ActivityFeedListener
+
+Then, create a listener class that defines methods for after_create, after_update and after_destroy:
+
+    class ActivityFeedListener
+      class << self
+        def after_create(record)
+          description = "#{record.class.name} was created"
+          publish_activity_feed_items record, description
+        end
+
+        def after_update(record)
+          description = "#{record.class.name} was updated"
+          publish_activity_feed_items record, description
+        end
+
+        def after_destroy(record)
+          description = "#{record.class.name} was deleted"
+          publish_activity_feed_items record, description
+        end
+
+        def publish_activity_feed_items(record, description)
+          record.activity_feed_item_subscribers.each do |subscriber|
+            ActivityFeedItem.create :user => subscriber, :description => description
+          end
+        end
+
+        private :publish_activity_feed_items
+      end
+    end
+
+## Turning off listeners in specs
+
+When unit testing if your listeners are all firing your unit tests become integration tests.  To avoid this, you can easily turn off listeners for all specs all the time:
+
+    Spec::Runner.configure do |config|
+      config.before(:each) do
+        ActiveModelListener.listeners.clear
+      end
+    end
+
+Then, when you want them back on again, you can either turn them back on for a spec:
+
+    describe "Integrating with listeners" do
+      before do
+        ActiveModelListener.listeners << FooListener
+      end
+    end
+
+## Specifying a subset of listeners to use
+
+When doing data imports, migrations or certain actions that need to only use certain listeners, you can easily specify which ones you'd like to use:
+
+    ActiveModelListener.with_listeners AuditListener, ActivityListener do
+      Article.create! :title => "foo"
+    end
+
+After the block runs, the original listeners are restored.
+
+If you want to run some code with no listeners, you can do so with:
+
+    ActiveModelListener.without_listeners do
+      Article.create! :title => "foo"
+    end
+
+##  Um.  Don't observers already do this?
+
+ActiveRecord Observers are:
+
+ * Hard to apply to large numbers of models (you have to explicitly declare every one)
+ * Hard to turn off in tests
+ * Hard to selectively enable / disable
+
+ActiveModelListener applies to all ActiveRecord models anywhere in your app, all the time.  ActiveModelListener listeners are very easy to turn off during unit tests as well.
+
+## Copyright
+
+Copyright (c) 2009 Jeff Dean. See LICENSE for details.
+

data/spec/active_model_listener_spec.rb

@@ -0,0 +1,90 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class GenericListener
+  def self.after_create(object)
+  end
+  def self.after_update(object)
+  end
+  def self.after_destroy(object)
+  end
+end
+
+class FooListener < GenericListener
+end
+
+class BarListener < GenericListener
+end
+
+class BazListener < GenericListener
+end
+
+describe ActiveModelListener do
+  before do
+    build_model :articles do
+      string :title
+    end
+
+    ActiveModelListener.listeners.clear
+    ActiveModelListener.listeners << FooListener
+    ActiveModelListener.listeners << BarListener
+  end
+
+  describe "with_listeners" do
+    it "only fires those listeners that are present" do
+      FooListener.should_receive(:after_create)
+      BarListener.should_not_receive(:after_create)
+
+      ActiveModelListener.with_listeners([FooListener]) do
+        Article.create! :title => "foo"
+      end
+    end
+
+    it "splats the args" do
+      FooListener.should_receive(:after_create)
+      BarListener.should_receive(:after_create)
+      BarListener.should_not_receive(:after_create)
+
+      ActiveModelListener.with_listeners(FooListener, BarListener) do
+        Article.create! :title => "foo"
+      end
+    end
+  end
+
+  describe "without_listeners" do
+    it "fires no listeners" do
+      FooListener.should_not_receive(:after_create)
+      BarListener.should_not_receive(:after_create)
+
+      ActiveModelListener.without_listeners do
+        Article.create! :title => "foo"
+      end
+    end
+  end
+
+  describe "after create" do
+    it "should fire off all wired up events" do
+      FooListener.should_receive(:after_create)
+      BarListener.should_receive(:after_create)
+      Article.create! :title => "foo"
+    end
+  end
+
+  describe "after update" do
+    it "should fire off all wired up events" do
+      article = Article.create
+      FooListener.should_receive(:after_update).with(article)
+      BarListener.should_receive(:after_update).with(article)
+      article.save
+    end
+  end
+
+  describe "after destroy" do
+    it "should fire off all wired up events" do
+      article = Article.create
+      FooListener.should_receive(:after_destroy).with(article)
+      BarListener.should_receive(:after_destroy).with(article)
+      article.destroy
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'spec'
+require 'acts_as_fu'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'active_model_listener'
+
+Spec::Runner.configure do |config|
+  config.include ActsAsFu
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: active_model_listener
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Jeff Dean
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-03 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: jeff@zilkey.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- LICENSE
+- README.md
+has_rdoc: true
+homepage: http://github.com/zilkey/active_model_listener
+licenses: []
+
+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.3.3
+signing_key: 
+specification_version: 3
+summary: Simple, global ActiveRecord event observers, using a middleware architecture, that can easily be turned on and off.  Designed for audit trails, activity feeds and other app-level event handlers
+test_files: 
+- spec/active_model_listener_spec.rb
+- spec/spec_helper.rb