on_event 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in on_event.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Brendon Murphy
+
+MIT License
+
+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,81 @@
+# OnEvent
+
+Build callback chains for named events.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'on_event'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install on_event
+
+## Usage
+
+```ruby
+# Regular Style:
+on_event = OnEvent.new(:success, :failure)
+on_event.on_success { |a| a << "A success" }
+on_event.on_failure { |a| a << "A failure" }
+
+# Block Style:
+on_event = OnEvent.new(:foo, :bar) do |oe|
+ oe.on_foo { |a| a << "foo" }
+ oe.on_bar { |a| a << "bar" }
+end
+
+a = []
+on_event.foo(a)
+a # => ["foo",]
+on_event.bar(a)
+a # => ["foo", "bar"]
+```
+
+## Why is this useful?
+
+You could just put event calls inline in a code block to get a similar effect.
+However, in the case you want a repeatable and reusable chain of events with
+shared rescue handling for firing, then this pattern helps.
+
+An example might be you are tracking multiple metric statistics in Rails controller
+actions (or via filters).  Perhaps the metrics are important, but in the case of a
+new user signup, not so important that you should fail the action should any of the
+metrics tracking or other notifications fail.
+
+```ruby
+on_event = OnEvent.new(:signup_success) do |oe|
+  oe.on_signup_success do |new_user|
+    Mailer.notify_admins(new_user)
+  end
+
+  oe.on_signup_success do |new_user|
+    Metrics.increment(new_user)
+  end
+end
+```
+
+If the admin doesn't get the email that somebody signed up, or Redis is unreachable and
+your metrics are temporarily unavailable, your user still signs up.
+
+By overriding the `#rescue_handler` in your `OnEvent` class, you can get shared exception
+handling should any callback fail.  This could be as simple as call to `Rails.logger.error`,
+or triggering Airbrake but still swallowing the exception.
+
+Often these callbacks are packaged into lifecycle on a model;  however, it is sometimes
+the case where you only want them firing in the specific context of a controller.  For
+instance, if I create a user on the console, I don't need to receive a mail message
+about it.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+
+task :default => [:test]

data/lib/on_event/version.rb

@@ -0,0 +1,3 @@
+class OnEvent
+  VERSION = "0.0.1"
+end

data/lib/on_event.rb

@@ -0,0 +1,72 @@
+require "on_event/version"
+require 'logger'
+
+class OnEvent
+  def initialize(*events)
+    establish_events(*events)
+    yield self if block_given?
+  end
+
+  ##
+  # This defines an #event_name and #on_event_name method for
+  # each given event. #on_event_name takes a block stored
+  # as a callback, which is passed the args from corresponding
+  # calls to #event_name
+  #
+  #   # Regular Style:
+  #   on_event = OnEvent.new(:success, :failure)
+  #   on_event.on_success { |a| a << "A success" }
+  #   on_event.on_failure { |a| a << "A failure" }
+  #
+  #   # Block Style:
+  #   on_event = OnEvent.new(:foo, :bar) do |oe|
+  #     oe.on_foo { |a| a << "foo" }
+  #     oe.on_bar { |a| a << "bar" }
+  #   end
+  #
+  #   a = []
+  #   on_event.foo(a)
+  #   a # => ["foo",]
+  #   on_event.bar(a)
+  #   a # => ["foo", "bar"]
+  #
+  def establish_events(*events)
+    (class << self; self; end).instance_eval do
+      Array(events).each do |event_name|
+        define_method "on_#{event_name}" do |&block|
+          event_blocks[event_name.to_sym] << block
+        end
+
+        define_method event_name do |*args|
+          event_blocks[event_name.to_sym].each do |block|
+            with_rescue { block.call *args }
+          end
+          true
+        end
+      end
+    end
+  end
+  alias :establish_event :establish_events
+
+  def logger
+    @logger ||= Logger.new(STDERR)
+  end
+
+  private
+
+  def event_blocks
+    @event_blocks ||= Hash.new {|h, k| h[k] = []}
+  end
+
+  def with_rescue
+    begin
+      yield
+    rescue => e
+      rescue_handler(e)
+    end
+  end
+
+  def rescue_handler(exception)
+    logger.error exception.message
+  end
+end

data/on_event.gemspec

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/on_event/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Brendon Murphy"]
+  gem.email         = ["xternal1+github@gmail.com"]
+  gem.description   = %q{Build callback chains for named events.}
+  gem.summary       = gem.description
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "on_event"
+  gem.require_paths = ["lib"]
+  gem.version       = OnEvent::VERSION
+end

data/test/test_on_event.rb

@@ -0,0 +1,73 @@
+require "test/unit"
+require File.expand_path("../../lib/on_event", __FILE__)
+
+class TestOnEvent < Test::Unit::TestCase
+  def test_setup_with_no_block
+    subject = OnEvent.new(:foo, :bar)
+    assert subject.respond_to?(:on_foo)
+    assert subject.respond_to?(:foo)
+    assert subject.respond_to?(:on_bar)
+    assert subject.respond_to?(:bar)
+  end
+
+  def test_adding_event_callbacks
+    subject = OnEvent.new(:foo, :bar)
+    subject.on_foo { |a| a << "f1" }
+    subject.on_bar { |a| a << "b1" }
+    subject.on_foo { |a| a << "f2" }
+    subject.on_bar { |a| a << "b2" }
+    a = []
+    subject.foo(a)
+    subject.bar(a)
+    assert_equal %w[f1 f2 b1 b2], a
+  end
+
+  def test_callback_events_returns_true
+    subject = OnEvent.new(:foo)
+    subject.on_foo { "f1" }
+    assert_instance_of TrueClass, subject.foo()
+  end
+
+  def test_adding_establish_event_alias
+    subject = OnEvent.new
+    subject.establish_event(:foo)
+    assert subject.respond_to?(:on_foo)
+    assert subject.respond_to?(:foo)
+  end
+
+  def test_setup_with_block
+    subject = OnEvent.new(:foo, :bar) do |oe|
+      oe.on_foo { |a| a << "foo" }
+      oe.on_bar { |a| a << "bar" }
+    end
+    a = []
+    subject.foo(a)
+    subject.bar(a)
+    assert_equal %w[foo bar], a
+  end
+
+  def test_rescue_handler
+    subject = OnEvent.new(:foo, :bar) do |oe|
+      oe.on_foo { |a| a << "foo" }
+      oe.on_bar { |a| a << oops_missing }
+      oe.on_bar { |a| a << oops_another }
+    end
+
+    $handledExceptions = []
+    def subject.rescue_handler(exception)
+      $handledExceptions << exception.message
+    end
+
+    a = []
+    subject.foo(a)
+    subject.bar(a)
+    assert_equal ["foo"], a
+    assert_match /oops_missing/, $handledExceptions[0]
+    assert_match /oops_another/, $handledExceptions[1]
+  end
+
+  def test_logger
+    subject = OnEvent.new
+    assert_kind_of Logger, subject.logger
+  end
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: on_event
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Brendon Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-08-12 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Build callback chains for named events.
+email: 
+- xternal1+github@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/on_event.rb
+- lib/on_event/version.rb
+- on_event.gemspec
+- test/test_on_event.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Build callback chains for named events.
+test_files: 
+- test/test_on_event.rb