observatory 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+doc
+.yardoc
+_site

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    observatory (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bluecloth (2.1.0)
+    rake (0.8.7)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bluecloth (~> 2.1)
+  observatory!
+  rake (~> 0.8)
+  yard (~> 0.6)

data/HISTORY

@@ -0,0 +1,3 @@
+# 0.0.1
+
+First alpha version.

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2011 Arjan van der Gaag
+
+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,97 @@
+# Observatory
+
+## Overview
+
+### Description
+
+Observatory is a simple Ruby gem that implements the observer design pattern to facilitate loosely coupled communication between objects in your program. It allows one object to publish an event, and others to respond to that.
+
+Using Observatory you can apply filters to method arguments, respond to events in your program or dynamically inject new functionality.
+
+### What's new?
+
+See HISTORY for a list of changes per version.
+
+## Usage
+
+### Installation
+
+Observatory is distributed as a Ruby gem, so installation is simple:
+
+    $ gem install observatory
+
+Then, you only need to load it in your program using Bundler or a manual require, like so:
+
+    require 'observatory'
+
+### Quick start
+
+For full documentation refer to the inline API docs (which you can generate using the `yard` rake task). A quick overview:
+
+    class Post
+      include Observatory::Observable
+      
+      attr_reader :dispatcher, :title
+      
+      def initialize(title, dispatcher)
+        @title = title
+        @dispatcher = dispatcher
+      end
+      
+      def publish
+        notify 'post.publish', :title => title
+      end
+      
+      def title
+        filter('post.title', @title).return_value
+      end
+    end
+    
+    class Logger
+      include Observatory::Observer
+      
+      def initialize(dispatcher)
+        @dispatcher = dispatcher
+      end
+      
+      observe 'post.publish'
+      def log(event)
+        "Post published: #{event[:title]}"
+      end
+    end
+    
+    dispatcher = Observatory::Dispatcher.new
+    
+    dispatcher.connect('post.title') do |event, title|
+      "Title: #{title}"
+    end
+    
+    p = Post.new('foo', dispatcher)
+    l = Logger.new(dispatcher)
+    
+    p.publish
+    # => Outputs: 'Post published: Title: foo'
+
+## More information
+
+### To Do
+
+* Complete unit tests for mixins.
+
+### Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+### Credits
+
+By Arjan van der Gaag <arjan@arjanvandergaag.nl>. Based on the [Event Dispatcher Symfonoy Component][1].
+
+### License
+
+Observatory is released under the same license as Ruby. See LICENSE for more information.
+
+[1]: http://components.symfony-project.org/event-dispatcher/

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+Bundler.require(:default, :development)
+require 'rake'
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+YARD::Rake::YardocTask.new do |t| 
+  t.files   = ['lib/**/*.rb', 'app/**/*.rb', '-', 'LICENSE', 'HISTORY'] 
+  t.options = %w{--title Observatory -m markdown}
+end

data/lib/observatory.rb

@@ -0,0 +1,7 @@
+module Observatory
+  autoload :Dispatcher, 'observatory/dispatcher'
+  autoload :Event,      'observatory/event'
+  autoload :Observable, 'observatory/observable'
+  autoload :Observer,   'observatory/observer'
+  autoload :VERSION,    'observatory/version'
+end

data/lib/observatory/dispatcher.rb

@@ -0,0 +1,175 @@
+module Observatory
+  # The Dispatcher is the central repository of all registered observers, and
+  # is used by observables to send out signals to these observers.
+  # 
+  # A dispatcher is not a singleton object, which means you may very well have
+  # several dispatcher objects in your program, keeping track of different
+  # stacks of observers and observables. Note that this requires you to pass
+  # your dispatcher object around using dependency injection.
+  # 
+  # ## For observables
+  # 
+  # The stack of observers for any given signal is kept in {#observers}. When
+  # using {#notify}, {#notify_until} or {#filter} all observers in the stack
+  # will be called.
+  # 
+  # ### Notification methods
+  # 
+  # Observable objects may use the following methods to trigger their
+  # observers:
+  # 
+  # * {#notify} to call all observers.
+  # * {#notify_until} to call observers until one stops the chain.
+  # * {#filter} to let all observers alter a given value.
+  # 
+  # ## For observers
+  # 
+  # An object that observes another object is an observer, and it can
+  # register itself with the {Dispatcher} to listen to a signal that
+  # observable objects may issue.
+  # 
+  # @example Using {#connect} to register a new observer
+  #   class Logger
+  #     def log(event)
+  #       puts "Post published by #{event.observable}"
+  #     end
+  #   end
+  #   logger = Logger.new
+  #   dispatcher.connect('post.publish', logger.method(:log))
+  # 
+  # @example Using {#disconnect} to unregister an observer
+  #   dispatcher.disconnect('post.publish', logger.method(:log))
+  # 
+  # @example Using {#notify} to let other objects know something has happened
+  #   class Post
+  #     include Observable
+  #     attr_reader :title
+  #     def publish
+  #       notify 'post.publish', :title => title
+  #       # do publication stuff here
+  #     end
+  #   end
+  # 
+  # @example Using {#notify_until} to delegate saving a record to another object
+  #   class Post
+  #     def save
+  #       notify_until 'post.save', :title => title
+  #     end
+  #   end
+  # 
+  # @example Using {#filter} to let observers modify the output of the title attribute
+  #   class Post
+  #     def title
+  #       filter('post.title', @title).return_value
+  #     end
+  #   end
+  class Dispatcher
+    # A list of all registered observers grouped by signal.
+    # @return [Hash]
+    attr_reader :observers
+
+    def initialize
+      @observers = {}
+    end
+    
+    # Register a observer for a given signal.
+    # 
+    # Instead of adding a method or Proc object to the stack, you could
+    # also use a block. Either the observer argument or the block is required.
+    # 
+    # @example Using a block as an observer
+    #   dispatcher.connect('post.publish') do |event|
+    #     puts "Post was published"
+    #   end
+    # 
+    # @example Using a method as an observer
+    #   class Reporter
+    #     def log(event)
+    #       puts "Post published"
+    #     end
+    #   end
+    #   dispatcher.connect('post.publish', Reporter.new.method(:log))
+    # 
+    # @param [String] signal is the name used by the observable to trigger
+    #   observers
+    # @param [#call] observer is the Proc or method that will react to
+    #   an event issued by an observable.
+    # @return [#call] the added observer
+    def connect(signal, observer = nil, &block)
+      if observer.nil?
+        if block_given?
+          observer = block
+        else
+          raise ArgumentError, 'Use a block, method or proc to specify an observer'
+        end
+      end
+      observers[signal] ||= []
+      observers[signal] << observer
+    end
+
+    # Removes an observer from a signal stack, so it no longer gets triggered.
+    # 
+    # @param [String] signal is the name of the stack to remove the observer
+    #   from.
+    # @param [#call] observer is the original observer to remove.
+    # @return [#call, nil] the removed observer or nil if it could not be found
+    def disconnect(signal, observer)
+      return nil unless observers.key?(signal)
+      observers[signal].delete(observer)
+    end
+
+    # Send out a signal to all registered observers using a new {Event}
+    # instance. The {Event#signal} will be used to determine the stack of
+    # {#observers} to use.
+    # 
+    # Using {#notify} allows observers to take action at a given time during
+    # program execution, such as logging important events.
+    # 
+    # @param [Event]
+    # @return [Event]
+    def notify(event)
+      each(event.signal) do |observer|
+        observer.call(event)
+      end
+      event
+    end
+
+    # Same as {#notify}, but halt execution as soon as an observer has
+    # indicated it has handled the event by returning a non-falsy value.
+    # 
+    # An event that was acted upon by an observer will be marked as processed.
+    # 
+    # @param [Event]
+    # @see Event#process!
+    # @return [Event]
+    def notify_until(event)
+      each(event.signal) do |observer|
+        event.process! and break if observer.call(event)
+      end
+      event
+    end
+
+    # Let all registered observers modify a given value. The observable can
+    # then use the {Event#return_value} to get the filtered result back.
+    # 
+    # You could use {#filter} to let observers modify arguments to a method
+    # before continuing to work on them (just an example).
+    # 
+    # @param [Event]
+    # @param [Object] value
+    # @return [Event]
+    def filter(event, value)
+      each(event.signal) do |observer|
+        value = observer.call(event, value)
+      end
+      event.return_value = value
+      event
+    end
+
+  private
+
+    def each(signal, &block)
+      (observers[signal] || []).each(&block)
+    end
+  end
+end

data/lib/observatory/event.rb

@@ -0,0 +1,70 @@
+module Observatory
+  # An Event is a value object that the observable passes along to the
+  # observers. It gives observers easy access to the original observable 
+  # and any additional values it may have wanted to pass along
+  # (the parameters).
+  # 
+  # The event object is also returned back to the observable that originally
+  # issued it, so it also works as a value object to pass information from
+  # the observers to the observable. The event knows whether it has been acted
+  # upon, and it can remember a return value that the observable may want to
+  # use (and other observers may want to act upon).
+  # 
+  # The event works just like a regular Ruby Hash, so you can access any
+  # parameters just like you would with a hash.
+  # 
+  # @example Accessing parameters like a Hash
+  #   event = Event.new(self, 'post.publish', :title => 'My new post')
+  #   event[:title] # => 'My new post'
+  # 
+  # @note An event is essentially a Hash with some extra properties, so
+  #   you can use all the regular Hash and Enumerable methods to your liking.
+  class Event < Hash
+    
+    # The original observable object that issued the event.
+    # @return [Object]
+    attr_reader :observable
+    
+    # The name of the signal that the observable triggered. Namespaced with
+    # periods.
+    # @return [String]
+    attr_reader :signal
+    
+    # The return value for the observable, that observers may modify.
+    # @return [Object]
+    attr_accessor :return_value
+
+    # Create a new event instance with the given observable and signal. Any
+    # parameters are stored, which you can later access like a hash.
+    # 
+    # @param [Object] observable
+    # @param [String, #to_s] signal
+    # @param [Hash] parameters is a hash of additional information that
+    #   observers may want to use.
+    def initialize(observable, signal, parameters = {})
+      @observable, @signal = observable, signal.to_s
+      merge! parameters
+      @processed = false
+      super()
+    end
+
+    # See if this event has been processed by an observer. Useful when using
+    # {Dispatcher#notify_until} to see if there was any observer that actually
+    # did something.
+    # 
+    # @see Dispatcher#notify_until
+    # @return [Boolean]
+    def processed?
+      @processed
+    end
+
+    # Mark this event as processed, so the observable knows an observer was
+    # active when using {Dispatcher#notify_until}.
+    # 
+    # @see Dispatcher#notify_until
+    # @return [Boolean] true
+    def process!
+      @processed = true
+    end
+  end
+end

data/lib/observatory/observable.rb

@@ -0,0 +1,63 @@
+module Observatory
+  # An observable object can publish events to registered observers. This
+  # module provides some simple helper methods as syntactic sugar.
+  # 
+  # Using these shortcut methods will default the observable object of the
+  # events raised to `self`, so the method signatures are the same as in
+  # {Dispatcher} but without the first one, the observable object.
+  # 
+  # @note Including this module will create a read-only attribute `dispatcher`
+  #   but not set it. You need to populate it yourself.
+  # 
+  # @example Manually triggering events in your code
+  #   class Post
+  #     attr_reader :dispatcher
+  #   
+  #     def initialize(dispatcher)
+  #       @dispatcher = dispatcher
+  #     end
+  #   
+  #     def publish
+  #       event = Observatory::Event.new(self, 'post.publish')
+  #       dispatcher.notify(event)
+  #     end
+  #   end
+  # 
+  # @example Using the Observable shortcut methods
+  #   class Post
+  #     include Observatory::Observable
+  #   
+  #     def publish
+  #       notify('post.publish') # => instance of Event
+  #     end
+  #   end
+  # 
+  # @see Observer
+  module Observable
+    def self.included(base)
+      base.send(:attr_reader, :dispatcher)
+    end
+
+    # @see Dispatcher#notify
+    def notify(*args)
+      Observatory::Event.new(self, *args).tap do |e|
+        dispatcher.notify(e)
+      end
+    end
+
+    # @see Dispatcher#filter
+    def filter(*args)
+      value = args.pop
+      Observatory::Event.new(self, *args).tap do |e|
+        dispatcher.filter(e, value)
+      end
+    end
+    
+    # @see Dispatcher#notify_until
+    def notify_until(*args)
+      Observatory::Event.new(self, *args).tap do |e|
+        dispatcher.notify_until(e)
+      end
+    end
+  end
+end

data/lib/observatory/observer.rb

@@ -0,0 +1,91 @@
+module Observatory
+  # @note Including the Observer module in your object will override your
+  #   initializer.
+  # 
+  # The Observer module enhances your classes with some simple syntactic sugar
+  # to register methods as observers. You may very well register your
+  # methods manually, but these methods may increase your code readability.
+  # 
+  # This module will override your `initialize` method to automatically
+  # register all observer methods with the dispatcher. In order to do so,
+  # it will alias your own `initialize` method and create a new one that
+  # both calls the old initializer and registers observers. This does mean
+  # that your initializer needs to set up a dispatcher object, probably
+  # via constructor dependency injection.
+  # 
+  # The main benefit of using this module in your classes is you get the
+  # class macro `observe` which will set up the next method that is declared
+  # in the class as an observer for the given signal name.
+  # 
+  # @example Registering a method as an observer for a signal
+  #   class Logger
+  #     include Observatory::Observer
+  # 
+  #     def initialize(dispatcher)
+  #       @dispatcher = dispatcher
+  #     end
+  # 
+  #     observe 'post.publish'
+  #     def log(event)
+  #       puts "Event #{event.signal} happened at #{Time.now}"
+  #     end
+  #   end
+  # 
+  # @todo allow registering a single method to mulitple signals, or even
+  #   matching by regular expression...?
+  # @todo this is pretty magicky. Might need to refactor to make things more
+  #   explicit and obvious.
+  module Observer
+    def self.included(base)
+      base.extend ClassMethods
+      base.overwrite_initialize
+      base.class_eval do
+        attr_reader :dispatcher
+      end
+
+      base.instance_eval do
+        def method_added(name)
+          if name == :initialize
+            overwrite_initialize
+          else
+            if @observer_next_event_name_to_observe
+              @observers_to_set_up ||= {}
+              @observers_to_set_up[@observer_next_event_name_to_observe] ||= []
+              @observers_to_set_up[@observer_next_event_name_to_observe] << name
+              @observer_next_event_name_to_observe = nil
+            end
+          end
+        end
+      end
+    end
+    
+    module ClassMethods
+      def overwrite_initialize
+        class_eval do
+          unless method_defined?(:initialize_and_setup_observers)
+            define_method(:initialize_and_setup_observers) do |*args|
+              initialize_without_observer *args
+              self.class.observers_to_set_up.each_pair do |name, methods|
+                methods.each do |m|
+                  @dispatcher.connect(name, method(m))
+                end
+              end
+            end
+          end
+          if instance_method(:initialize) != instance_method(:initialize_and_setup_observers)
+            alias_method :initialize_without_observer, :initialize
+            alias_method :initialize, :initialize_and_setup_observers
+          end
+        end
+      end
+
+      def observers_to_set_up
+        @observers_to_set_up ||= {}
+      end
+
+      def observe(event_name)
+        @observer_next_event_name_to_observe = event_name
+      end
+    end
+  end
+end

data/lib/observatory/version.rb

@@ -0,0 +1,3 @@
+module Observatory
+  VERSION = '0.0.1'
+end

data/observatory.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'observatory'
+
+Gem::Specification.new do |s|
+  s.name        = 'observatory'
+  s.version     = Observatory::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Arjan van der Gaag']
+  s.email       = ['arjan@arjanvandergaag.nl']
+  s.homepage    = ""
+  s.summary     = "A simple implementation of the observer pattern for Ruby programs."
+  s.description = %q{Observatory is a simple gem to facilitate loosely-coupled communication between Ruby objects. It implements the observer design pattern so that your objects can publish events that other objects can subscribe to. Observatory provides some syntactic sugar and methods to notify events, filter values and allow observing objects to stop the filter chain. Observatory is inspired by the Event Dispatcher Symfony component.}
+
+  s.rubyforge_project = 'observatory'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_development_dependency 'yard',      '~>0.6'
+  s.add_development_dependency 'bluecloth', '~>2.1'
+  s.add_development_dependency 'rake',      '~>0.8'
+end

data/test/dispatcher_test.rb

@@ -0,0 +1,78 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class DispatcherTest < Test::Unit::TestCase
+  def setup
+    @dispatcher = Dispatcher.new
+    @method = method(:example_observer_method)
+  end
+  
+  def example_observer_method
+    # does nothing
+  end
+  
+  def test_should_start_with_empty_list_of_observers
+    assert_equal({}, @dispatcher.observers)
+  end
+  
+  def test_connecting_an_observer_using_a_method
+    @dispatcher.connect('signal', @method)
+    assert @dispatcher.observers['signal'].include?(@method)
+  end
+  
+  def test_connecting_an_oversver_using_a_block
+    @dispatcher.connect('signal') do
+      # does nothing
+    end
+    assert_equal 1, @dispatcher.observers['signal'].size
+  end
+  
+  def test_connecting_nothing_should_raise_exception
+    assert_raise(ArgumentError) { @dispatcher.connect('signal') }
+  end
+  
+  def test_disconnecting_a_new_observer_returns_nil
+    assert_nil @dispatcher.disconnect('signal', @method)
+  end
+  
+  def test_disconnecting_an_exisiting_observer_removes_it_from_stack
+    @dispatcher.connect('signal', @method)
+    assert_equal 1, @dispatcher.observers['signal'].size
+    @dispatcher.disconnect('signal', @method)
+    assert_equal 0, @dispatcher.observers['signal'].size
+  end
+  
+  def test_notify_calls_all_observers
+    flag1 = false
+    flag2 = false
+    @dispatcher.connect('signal') { flag1 = true }
+    @dispatcher.connect('signal') { flag2 = true }
+    @dispatcher.notify(Event.new('observable', 'signal'))
+    assert flag1
+    assert flag2
+  end
+  
+  def test_notify_calls_all_observers_in_order
+    output = ''
+    @dispatcher.connect('signal') { output << 'a' }
+    @dispatcher.connect('signal') { output << 'b' }
+    @dispatcher.notify(Event.new('observable', 'signal'))
+    assert_equal('ab', output)
+  end
+  
+  def test_using_notify_until_calls_all_observers_until_one_returns_true
+    output = ''
+    @dispatcher.connect('signal') { output << 'a'; true }
+    @dispatcher.connect('signal') { output << 'b' }
+    @dispatcher.notify_until(Event.new('observable', 'signal'))
+    assert_equal('a', output)
+  end
+  
+  def test_using_filter_uses_original_value_as_default_return_value
+    assert_equal 'foo', @dispatcher.filter(Event.new('observable', 'signal'), 'foo').return_value
+  end
+  
+  def test_using_filter_uses_adjusted_value_as_default_return_value
+    @dispatcher.connect('signal') { |e,v| v.upcase }
+    assert_equal 'FOO', @dispatcher.filter(Event.new('observable', 'signal'), 'foo').return_value
+  end
+end

data/test/event_test.rb

@@ -0,0 +1,40 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class EventTest < Test::Unit::TestCase
+  def setup
+    @event = Event.new('observable', 'signal', :foo => 'bar')
+  end
+  
+  def test_works_like_a_hash
+    assert_equal('bar', @event[:foo])
+    assert_kind_of(Hash, @event)
+  end
+  
+  def test_should_be_processed_by_default
+    assert !@event.processed?
+  end
+  
+  def test_should_be_marked_processed
+    @event.process!
+    assert @event.processed?
+  end
+  
+  def test_require_observable_and_signal
+    assert_raise(ArgumentError) { Event.new }
+    assert_raise(ArgumentError) { Event.new('foo') }
+  end
+  
+  def test_do_not_require_parameters
+    assert_nothing_raised { Event.new('foo', 'bar') }
+  end
+  
+  def test_use_signal_as_string
+    event = Event.new('foo', 123)
+    assert_equal('123', event.signal)
+  end
+  
+  def test_has_a_return_value_attribute
+    @event.return_value = :foo
+    assert_equal(:foo, @event.return_value)
+  end
+end

data/test/integration_test.rb

@@ -0,0 +1,78 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+require 'stringio'
+
+class Post
+  include Observatory::Observable
+  
+  attr_reader :title
+  
+  def initialize(title, dispatcher)
+    @title, @dispatcher = title, dispatcher
+  end
+  
+  def publish
+    notify('post.publish', :title => title)
+  end
+  
+  def title
+    filter('post.title', @title).return_value
+  end
+  
+  def save
+    event = notify_until('post.save', :title => title)
+    raise Exception, 'Saving is not implemented!' unless event.processed?
+  end
+end
+
+class Spy
+  include Observatory::Observer
+  
+  attr_reader :buffer
+  
+  def initialize(dispatcher, buffer)
+    @dispatcher, @buffer = dispatcher, buffer
+  end
+  
+  observe 'post.publish'
+  def log_publication(event)
+    buffer.puts "Post titled #{event[:title]} was published"
+  end
+  
+  observe 'post.title'
+  def title_filter(event, value)
+    value.upcase
+  end
+  
+  observe 'post.save'
+  def save_post_to_output(event)
+    buffer.puts "Saving post titled #{event[:title]}"
+    true
+  end
+end
+
+class IntegrationTest < Test::Unit::TestCase
+  def setup
+    @buffer = StringIO.new
+    @dispatcher = Observatory::Dispatcher.new
+    @post = Post.new('My new post', @dispatcher)
+    @spy = Spy.new(@dispatcher, @buffer)
+  end
+  
+  def test_notify
+    @dispatcher.disconnect('post.title', @spy.method(:title_filter))
+    @post.publish
+    assert_equal("Post titled My new post was published\n", @buffer.string)
+  end
+  
+  def test_filter
+    assert_equal("MY NEW POST", @post.title)
+  end
+  
+  def test_notify_until
+    @dispatcher.disconnect('post.title', @spy.method(:title_filter))
+    assert_nothing_raised(Exception) { @post.save }
+    assert_equal("Saving post titled My new post\n", @buffer.string)
+    @dispatcher.disconnect('post.save', @spy.method(:save_post_to_output))
+    assert_raise(Exception) { @post.save }
+  end
+end

data/test/observable_test.rb

@@ -0,0 +1,7 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class ObservableTest < Test::Unit::TestCase
+  def test_truth
+    assert true
+  end
+end

data/test/observer_test.rb

@@ -0,0 +1,7 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class ObserverTest < Test::Unit::TestCase
+  def test_truth
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'test/unit'
+require 'rubygems'
+require 'bundler'
+Bundler.require(:default, :development)
+
+class Test::Unit::TestCase
+  include Observatory
+end

data/watch_tests.rb

@@ -0,0 +1,62 @@
+def run(cmd)
+  puts cmd
+  `#{cmd}`
+end
+
+def run_all_tests
+  system 'rake test'
+end
+
+def growl(message)
+  growlnotify = `which growlnotify`.chomp
+  title = "Watchr Test Results"
+  passed = message.include?('0 failures, 0 errors')
+  image = passed ? "~/.watchr_images/passed.png" : "~/.watchr_images/failed.png"
+  severity = passed ? "-1" : "1"
+  options = "-w -n Watchr --image '#{File.expand_path(image)}'"
+  options << " -m '#{message}' '#{title}' -p #{severity}"
+  system %(#{growlnotify} #{options} &)
+end
+
+# --------------------------------------------------
+# Watchr Rules
+# --------------------------------------------------
+watch('^lib.*/(.*)\.rb') do |m|
+  result = run("ruby test/#{m[1]}_test.rb")
+  growl result.split("\n").last
+end
+
+watch('test.*/teststrap\.rb') do
+  run_all_tests
+end
+
+watch('^test/(.*)_test\.rb')  do |m|
+  result = run("ruby test/#{m[1]}_test.rb")
+  growl result.split("\n").last
+end
+
+
+# --------------------------------------------------
+# Signal Handling
+# --------------------------------------------------
+# Ctrl-\
+Signal.trap('QUIT') do
+  puts " --- Running all tests ---\n\n"
+  run_all_tests
+end
+
+@interrupted = false
+
+# Ctrl-C
+Signal.trap 'INT' do
+  if @interrupted then
+    @wants_to_quit = true
+    abort("\n")
+  else
+    puts "Interrupt a second time to quit"
+    @interrupted = true
+    Kernel.sleep 1.5
+    # raise Interrupt, nil # let the run loop catch it
+    run_suite
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: observatory
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Arjan van der Gaag
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-01 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        version: "0.6"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bluecloth
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 1
+        version: "2.1"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 8
+        version: "0.8"
+  type: :development
+  version_requirements: *id003
+description: Observatory is a simple gem to facilitate loosely-coupled communication between Ruby objects. It implements the observer design pattern so that your objects can publish events that other objects can subscribe to. Observatory provides some syntactic sugar and methods to notify events, filter values and allow observing objects to stop the filter chain. Observatory is inspired by the Event Dispatcher Symfony component.
+email: 
+- arjan@arjanvandergaag.nl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- HISTORY
+- LICENSE
+- README.md
+- Rakefile
+- lib/observatory.rb
+- lib/observatory/dispatcher.rb
+- lib/observatory/event.rb
+- lib/observatory/observable.rb
+- lib/observatory/observer.rb
+- lib/observatory/version.rb
+- observatory.gemspec
+- test/dispatcher_test.rb
+- test/event_test.rb
+- test/integration_test.rb
+- test/observable_test.rb
+- test/observer_test.rb
+- test/test_helper.rb
+- watch_tests.rb
+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: observatory
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: A simple implementation of the observer pattern for Ruby programs.
+test_files: 
+- test/dispatcher_test.rb
+- test/event_test.rb
+- test/integration_test.rb
+- test/observable_test.rb
+- test/observer_test.rb
+- test/test_helper.rb
+has_rdoc: