object_pub_sub 1.0.0

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 John Wilger
+
+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,105 @@
+# ObjectPubSub
+
+ObjectPubSub is an implementation of the Observer pattern for Ruby that 
+provides finer-grained controll over message passing than does the 
+Observable module from Ruby's stdlib. The including class can publish 
+multiple event types, and the subscribers can specify both which event 
+types to listen for and what method on the subscriber should be invoked 
+for each event type.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'object_pub_sub'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install object_pub_sub
+
+## Usage
+
+In the class that will be publishing events (the "Observable"), simply 
+include `ObjectPubSub` and then publish events where appropriate:
+
+    class UserValidator
+      include ObjectPubSub
+
+      attr_reader :user, :errors
+
+      def initialize(user)
+        @user = user
+        @errors = {}
+      end
+
+      def validate
+        validate_username #def exluded for brevity
+        validate_password #def exluded for brevity
+        validate_email #def exluded for brevity
+
+        notify_subscribers
+      end
+
+      private
+
+      def notify_subscribers
+        if errors.any?
+          publish_event(:invalid, errors)
+        else
+          publish_event(:valid, user)
+        end
+      end
+    end
+
+Then, objects that care about those events can subscribe to them:
+
+    class ValidationLogger
+      def initialize(name, logger = nil)
+        @logger = logger || Logger.new(STDERR)
+        @name = name
+      end
+
+      def log_validation_error(errors)
+        logger.warn("Validation errors on #{name}: #{errors}")
+      end
+    end
+
+    class CreateUser
+      def initialize(logger = nil)
+        @logger = logger
+      end
+
+      def perform(user_attrs)
+        user = User.new(attrs)
+        validation_logger = ValidationLogger.new("User creation", logger)
+        validator = UserValidator.new(user)
+        validator.add_subscriber(self, :valid => :handle_valid_user, :invalid => :handle_invalid_user)
+        validator.add_subscriber(validation_logger, :invalid => :log_validation_error)
+        validator.validate
+      end
+
+      def handle_valid_user(user)
+        # ...
+      end
+
+      def handle_invalid_user(errors)
+       # ...
+      end
+    end
+
+    CreateUser.new \
+      .perform(:username => 'foo', :email => 'foo@example.com', :password => 'foopassword')
+
+See the examples under `/spec` for more information.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'bundler/setup'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/object_pub_sub/version.rb

@@ -0,0 +1,3 @@
+module ObjectPubSub
+  VERSION = "1.0.0"
+end

data/lib/object_pub_sub.rb

@@ -0,0 +1,75 @@
+require 'active_support/concern'
+
+module ObjectPubSub
+  extend ActiveSupport::Concern
+
+  def add_subscriber(*args)
+    object_pub_sub_subscriber_lists.add_subscriber(*args)
+  end
+
+  private
+
+  def publish_event(*args)
+    object_pub_sub_subscriber_lists.publish_event(*args)
+  end
+
+  def object_pub_sub_subscriber_lists
+    @object_pub_sub_subscriber_lists ||= SubscriberListManager.new
+  end
+
+  class SubscriberListManager
+    class SubscriberList
+      def initialize
+        @subscribers = []
+      end
+
+      def add_subscriber(subscriber, callback_method)
+        callback_pair = [subscriber, callback_method]
+        return if @subscribers.include?(callback_pair)
+        @subscribers << callback_pair
+      end
+
+      def publish_event(data = nil)
+        @subscribers.each do |subscriber, callback_method|
+          subscriber.send(callback_method, data)
+        end
+      end
+    end
+
+    def initialize
+      @subscriber_lists ||= {}
+    end
+
+    def add_subscriber(subscriber, *event_names)
+      callback_map(event_names).each do |event_name, callback_method|
+        subscriber_list_for(event_name).add_subscriber(subscriber, callback_method)
+      end
+    end
+
+    def publish_event(event_name, data = nil)
+      subscriber_list_for(event_name).publish_event(data)
+    end
+
+    private
+
+    def callback_map(event_names)
+      callback_map = {}
+      last_one = event_names.pop
+      if last_one.kind_of?(Hash)
+        callback_map.merge!(last_one)
+      else
+        callback_map[last_one] = last_one
+      end
+      event_names.each do |event_name|
+        callback_map[event_name] = event_name
+      end
+      callback_map
+    end
+
+    def subscriber_list_for(event_name)
+      @subscriber_lists.fetch(event_name) do
+        @subscriber_lists[event_name] = SubscriberList.new
+      end
+    end
+  end
+end

data/object_pub_sub.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'object_pub_sub/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "object_pub_sub"
+  gem.version       = ObjectPubSub::VERSION
+  gem.authors       = ["John Wilger"]
+  gem.email         = ["johnwilger@gmail.com"]
+  gem.description   = %q{An Observer implementation with finer-grained controll over event publishing.}
+  gem.summary       = %q{An Observer implementation with finer-grained controll over event publishing.}
+  gem.homepage      = "http://github.com/jwilger/object_pub_sub"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'activesupport', '>= 3.0.0'
+  gem.add_development_dependency 'rspec'
+end

data/spec/object_pub_sub_spec.rb

@@ -0,0 +1,94 @@
+require 'object_pub_sub'
+
+describe ObjectPubSub do
+  describe "instance methods added to including class" do
+    it "forwards subscription requests to the object's subscriber list" do
+      subscriber_lists.should_receive(:add_subscriber) \
+        .with(subscriber, :event_a, :event_b, :event_c, :and_so_on)
+      publisher.add_subscriber(subscriber, :event_a, :event_b, :event_c, :and_so_on)
+    end
+
+    it "publishes events to the object's subscriber list" do
+      subscriber_lists.should_receive(:publish_event) \
+        .with(:did_a_thing, :some_data)
+      publisher.do_a_thing
+    end
+
+    let(:subscriber_lists) { stub('subscriber_lists') }
+    let(:subscriber) { stub('subscriber') }
+
+    let(:publisher) {
+      klass = Class.new do
+        include ObjectPubSub
+
+        def do_a_thing
+          publish_event(:did_a_thing, :some_data)
+        end
+      end
+
+      klass.new.tap do |p|
+        p.stub!(:object_pub_sub_subscriber_lists => subscriber_lists)
+      end
+    }
+  end
+
+  describe ObjectPubSub::SubscriberListManager do
+    it "distributes published events to all subscribers" do
+      subscriber_a = stub('subscriber_a')
+      subscriber_b = stub('subscirber_b')
+
+      subject.add_subscriber(subscriber_a, :event_a)
+      subject.add_subscriber(subscriber_b, :event_a)
+
+      subscriber_a.should_receive(:event_a)
+      subscriber_b.should_receive(:event_a)
+      subject.publish_event(:event_a)
+    end
+
+    it "does not distribute an event to subscribers that do not subscribe to that event" do
+      subject.add_subscriber(subscriber, :event_b)
+
+      subscriber.should_receive(:event_a).never
+      subject.publish_event(:event_a)
+    end
+
+    it "only notifies a subscriber once even if it subscribes multiple times" do
+      subject.add_subscriber(subscriber, :event_a)
+      subject.add_subscriber(subscriber, :event_a)
+
+      subscriber.should_receive(:event_a).once
+      subject.publish_event(:event_a)
+    end
+
+    it "allows a subscriber to subscribe to multiple events" do
+      subject.add_subscriber(subscriber, :event_a, :event_b)
+
+      subscriber.should_receive(:event_a)
+      subject.publish_event(:event_a)
+
+      subscriber.should_receive(:event_b)
+      subject.publish_event(:event_b)
+    end
+
+    it "can publish data along with an event" do
+      subject.add_subscriber(subscriber, :event_a)
+
+      subscriber.should_receive(:event_a).with(:some_data)
+      subject.publish_event(:event_a, :some_data)
+    end
+
+    it "allows the subscriber to specify a custom callback method for some events" do
+      subject.add_subscriber(subscriber, :event_b, :event_a => :handle_event_a)
+
+      subscriber.should_receive(:handle_event_a)
+      subject.publish_event(:event_a)
+
+      subscriber.should_receive(:event_b)
+      subject.publish_event(:event_b)
+    end
+
+    let(:subject) { ObjectPubSub::SubscriberListManager.new }
+
+    let(:subscriber) { stub('subscriber') }
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: object_pub_sub
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- John Wilger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An Observer implementation with finer-grained controll over event publishing.
+email:
+- johnwilger@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/object_pub_sub.rb
+- lib/object_pub_sub/version.rb
+- object_pub_sub.gemspec
+- spec/object_pub_sub_spec.rb
+homepage: http://github.com/jwilger/object_pub_sub
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4599717495677016490
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4599717495677016490
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: An Observer implementation with finer-grained controll over event publishing.
+test_files:
+- spec/object_pub_sub_spec.rb