ruby_pub_sub 0.0.4

data/.gitignore

@@ -0,0 +1,3 @@
+*.swp
+*.sqlite3
+

data/.pairs

@@ -0,0 +1,4 @@
+pairs:
+  # <initials>: <Firstname> <Lastname>[; <email-id>]
+  ab: Adam Berlin; berlin.ab@gmail.com
+  bm: Ben Moss; bmoss@pivotallabs.com

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  #- "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  #- jruby-18mode # JRuby in 1.8 mode
+  #- jruby-19mode # JRuby in 1.9 mode
+  #- rbx-18mode
+  - rbx-19mode
+script: bundle exec rspec spec
+
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pub_sub.gemspec
+gemspec
+
+gem 'with_model'
+gem 'rspec'
+gem 'activerecord'
+gem 'rails'
+gem 'sqlite3'
+gem 'pivotal_git_scripts'

data/Gemfile.lock

@@ -0,0 +1,113 @@
+PATH
+  remote: .
+  specs:
+    ruby_pub_sub (0.0.4)
+      activerecord (>= 3.2.9)
+      rails (>= 3.2.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.9)
+      actionpack (= 3.2.9)
+      mail (~> 2.4.4)
+    actionpack (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.9)
+      activesupport (= 3.2.9)
+      builder (~> 3.0.0)
+    activerecord (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.9)
+      activemodel (= 3.2.9)
+      activesupport (= 3.2.9)
+    activesupport (3.2.9)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.1)
+    journey (1.0.4)
+    json (1.7.5)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.5.0)
+    pivotal_git_scripts (1.1.4)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.9)
+      actionmailer (= 3.2.9)
+      actionpack (= 3.2.9)
+      activerecord (= 3.2.9)
+      activeresource (= 3.2.9)
+      activesupport (= 3.2.9)
+      bundler (~> 1.0)
+      railties (= 3.2.9)
+    railties (3.2.9)
+      actionpack (= 3.2.9)
+      activesupport (= 3.2.9)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.0)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.6)
+    thor (0.16.0)
+    tilt (1.3.3)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.35)
+    with_model (0.3.1)
+      activerecord (>= 2.3.5, < 4.0.0)
+      rspec (~> 2.11)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  pivotal_git_scripts
+  rails
+  rspec
+  ruby_pub_sub!
+  sqlite3
+  with_model

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Gust, LLC
+
+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,122 @@
+# PubSub
+
+PubSub is a thin wrapper around ActiveSupport::Notifications, which provides an implementation of the Publish/Subscribe pattern.
+
+http://api.rubyonrails.org/classes/ActiveSupport/Notifications.html
+
+The goal was to be able to create more loosly coupled models by pulling side effects of our models into their own class.  We wanted this behavior for Active Record classes as well as non-Active Record classes.
+
+The result was a library that was:
+* easy to test
+* easy to disable (when using the console, during unit tests, etc.)
+* easy to understand (b/c of AS::Notifications syncronous publishing queue)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pub_sub'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pub_sub
+
+## Usage
+
+### Configuration
+
+    PubSub.disable # disables publishing
+    PubSub.enable  # enables publishing
+
+    By default, PubSub looks for subscribers in app/models/pub_sub/* 
+
+
+### Within a plain ruby project
+
+    PubSub::Subscriber => provides an interface to subscribe to a topic
+
+    #
+    # Subscribe to the 'user_created' topic.
+    #
+    class SendWelcomeEmailToUser < PubSub::Subscriber
+      subscribe_to("user_created")
+
+      def on_publish
+        write_user_to_file(options[:user])
+      end
+
+      private
+
+      def write_user_to_file(user)
+        File.open("/tmp/users.txt", "w+") do |file|
+          file << user.name
+        end
+      end
+    end
+
+
+    #
+    # Publish a message to the 'user_created' topic
+    #
+    PubSub.publish("user_created", user:
+      User.new(name: 'John Doe')
+    )
+
+
+### Within a Rails project
+
+    PubSub::ActiveRecord::Subscriber => provide an interface to subscribe to an ActiveRecord callback topic
+
+    #
+    # Subscribe to the after_create callback of User
+    #
+    # currently, PubSub loads all subscribers in app/models/pub_sub/*
+    #
+    class SendWelcomeEmailToUser < PubSub::ActiveRecord::Subscriber
+      subscribe_to(User, 'after_create')
+
+      def on_publish
+        ApplicationMailer.send_welcome_email(record)
+      end
+    end
+    => PubSub.subscribe("active_record::user::after_create")
+
+
+    #
+    #  inside your application (controller, model, etc)
+    #
+    User.create(name: 'John Doe')
+    => PubSub.publish("active_record::user::after_create")
+
+## Backlog / To Do
+
+http://www.pivotaltracker.com/projects/705655
+
+Feel free to take a look.
+
+## 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
+
+# Contributors
+
+* Brent Wheeldon
+* Cathy O'Connell
+* Nick Monje
+* Evan Goodberry
+* Ben Moss
+* Chien Kuo
+* Edwin Chong
+* Adam Berlin
+* Rasheed Abdul-Aziz
+* Ryan McGarvey
+* Geoffrey Ducharme
+* Alex Kramer

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/pub_sub.rb

@@ -0,0 +1,39 @@
+require "pub_sub/version"
+require "pub_sub/subscriber"
+require "pub_sub/register"
+
+require 'rails'
+require 'active_record'
+
+module PubSub
+  class << self
+    def enable
+      Register.enable
+    end
+
+    def disable
+      Register.disable
+    end
+
+    def enabled?
+      Register.enabled?
+    end
+
+    def disabled?
+      Register.disabled?
+    end
+
+    #
+    #  Standardize on Pub/Sub naming
+    #
+    def publish(*args, &block)
+      Register.publish(*args, &block)
+    end
+
+    def subscribe(*args, &block)
+      Register.subscribe(*args, &block)
+    end
+  end
+end
+
+require_relative "pub_sub/active_record_extensions"

data/lib/pub_sub/active_record_extensions.rb

@@ -0,0 +1,38 @@
+module PubSub
+  class ActiveRecordExtensions < Rails::Railtie
+    initializer "pub sub configuration of active record extensions" do
+      class ::ActiveRecord::Base
+        after_create :notify_of_after_create
+
+        private
+
+        def notify_of_after_create
+          notify_pub_sub_of_active_record_callback('after_create')
+        end
+
+        def notify_pub_sub_of_active_record_callback(callback)
+          message = "active_record::#{self.class.to_s.underscore}::#{callback}"
+          PubSub.publish(message, record: self)
+        end
+      end
+
+      config.after_initialize do
+        Dir[
+          File.expand_path("app/models/pub_sub/*.rb", Rails.root)
+        ].each { |file| require file }
+      end
+    end
+  end
+
+  module ActiveRecord
+    class Subscriber < PubSub::Subscriber
+      def self.subscribe_to(class_instance, callback)
+        super("active_record::#{class_instance.to_s.underscore}::#{callback}")
+      end
+
+      def record
+        options[:record]
+      end
+    end
+  end
+end

data/lib/pub_sub/register.rb

@@ -0,0 +1,46 @@
+require "singleton"
+
+module PubSub
+  class Register
+    include Singleton
+
+    attr_accessor :enabled
+
+    def initialize
+      @enabled = true
+      super
+    end
+
+    class << self
+      def enable
+        instance.enabled = true
+      end
+
+      def disable
+        instance.enabled = false
+      end
+
+      def enabled?
+        if instance.enabled.nil?
+          instance.enabled = true
+        end
+
+        instance.enabled
+      end
+
+      def disabled?
+        !instance.enabled
+      end
+
+      def publish(*args, &block)
+        return if disabled?
+
+        ActiveSupport::Notifications.publish(*args, &block)
+      end
+
+      def subscribe(*args, &block)
+        ActiveSupport::Notifications.subscribe(*args, &block)
+      end
+    end
+  end
+end

data/lib/pub_sub/subscriber.rb

@@ -0,0 +1,34 @@
+module PubSub
+  class Subscriber
+    attr_reader :options
+    alias :payload :options
+
+    def initialize(options)
+      @options = options
+    end
+
+    def self.subscribe_to(topic_name)
+      klass = self
+
+      @subscription = PubSub.subscribe(topic_name) do |topic, options|
+        publish(klass.new(options))
+      end
+    end
+
+    def self.publish(subscription)
+      subscription.on_publish
+    end
+
+    def self.subscription
+      @subscription
+    end
+
+    def self.topic
+      @subscription.instance_variable_get("@pattern")
+    end
+
+    def on_publish
+      raise "Please define an on_publish method for #{self.class.name}"
+    end
+  end
+end

data/lib/pub_sub/version.rb

@@ -0,0 +1,3 @@
+module PubSub
+  VERSION = "0.0.4"
+end

data/ruby_pub_sub.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pub_sub/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "ruby_pub_sub"
+  gem.version       = PubSub::VERSION
+  gem.authors       = ["Adam Berlin & Evan Goodberry"]
+  gem.email         = ["pair+aberlin+egoodberry@pivotallabs.com"]
+  gem.description   = %q{Publish/Subscribe for Ruby}
+  gem.summary       = %q{Publish messages to subscribers within your application.  Initially built as a replacement for Active Record's Observer pattern.  It is a thin wrapper around ActiveSupport::Notifications which implements the Publish/Subscribe pattern.  This gem is intended to create an easy to use and understand API around AS::Notifications.}
+  gem.homepage      = ""
+
+  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"]
+  require File.dirname(__FILE__) + '/lib/pub_sub'
+
+  gem.add_dependency('rails', '>= 3.2.9')
+  gem.add_dependency('activerecord', '>= 3.2.9')
+end

data/spec/integration/pub_sub_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe PubSub do
+  describe "initial state" do
+    it "defaults enabled to true" do
+      PubSub::Register.instance.enabled = nil
+      PubSub.enabled?.should be_true
+    end
+  end
+
+  describe "#enable" do
+    it "enables PubSub" do
+      PubSub.disable
+      PubSub.enable
+      PubSub.enabled?.should be_true
+    end
+  end
+
+  describe "#disable" do
+    it "disables PubSub" do
+      PubSub.disable
+      PubSub.enabled?.should be_false
+    end
+  end
+
+  describe "#publish" do
+    context "when disabled" do
+      before { PubSub.disable }
+
+      it "does not publish" do
+        ActiveSupport::Notifications.should_receive(:publish).never
+        PubSub.publish
+      end
+    end
+  end
+
+  describe "active record configuration" do
+    with_model :FakeActiveRecordUser do
+      table do |t|
+        t.string :title
+      end
+    end
+
+    with_model :FakeActiveRecordResult do
+      table do |t|
+        t.string :title
+      end
+    end
+
+    before do
+      class FakeActiveRecordUserSubscriber < PubSub::ActiveRecord::Subscriber
+        subscribe_to(FakeActiveRecordUser, 'after_create')
+
+        def on_publish
+          FakeActiveRecordResult.create
+        end
+      end
+    end
+
+    it "successfully calls through to the subscriber" do
+      FakeActiveRecordResult.all.size.should == 0
+      FakeActiveRecordUser.create
+      FakeActiveRecordResult.all.size.should == 1
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  #
+  #  Load the environment
+  #
+  require 'bundler'
+  Bundler.require
+
+  #
+  #  Rails loads this during its setup
+  #
+  PubSub::ActiveRecordExtensions.run_initializers
+
+  #
+  # Test database
+  #
+  ActiveRecord::Base.establish_connection(
+    adapter: 'sqlite3',
+    database: 'db/test.sqlite3',
+    pool: 5,
+    timeout: 5000
+  )
+
+  #
+  # Use with_model
+  #
+  config.extend WithModel
+
+  #
+  # Ensure pubsub is enabled
+  #
+  config.before do
+    PubSub.enable
+  end
+end

data/spec/unit/subscriber_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe PubSub::Subscriber do
+  class FooBar < PubSub::Subscriber
+  end
+
+  describe ".topic" do
+    it "sets up a subscription" do
+      FooBar.class_eval do
+        subscribe_to("foo")
+      end
+
+      FooBar.topic.should == 'foo'
+    end
+  end
+
+  describe ".subscription" do
+    it "should be the result of the subscribe" do
+      subscription = stub
+
+      PubSub.should_receive(:subscribe).with('topic-name') { subscription }
+
+      FooBar.class_eval do
+        subscribe_to("topic-name")
+      end
+
+      FooBar.subscription.should be(subscription)
+    end
+  end
+
+  describe ".publish" do
+    it "notifies the subscription of the publish event" do
+      subscription = double
+      subscription.should_receive(:on_publish)
+      FooBar.publish(subscription)
+    end
+  end
+
+  describe "#on_publish" do
+    it "warns developers that they need to implement the interface" do
+      expect {FooBar.new({}).on_publish}.to raise_error(/Please define/)
+    end
+  end
+
+  describe "payload" do
+    let(:payload) { double }
+    it "has a payload" do
+      FooBar.new(payload).payload.should == payload
+    end
+
+    it "has options" do
+      FooBar.new(payload).options.should == payload
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: ruby_pub_sub
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Adam Berlin & Evan Goodberry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.9
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.9
+description: Publish/Subscribe for Ruby
+email:
+- pair+aberlin+egoodberry@pivotallabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .pairs
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- db/.gitkeep
+- lib/pub_sub.rb
+- lib/pub_sub/active_record_extensions.rb
+- lib/pub_sub/register.rb
+- lib/pub_sub/subscriber.rb
+- lib/pub_sub/version.rb
+- pkg/pub_sub-0.0.1.gem
+- pkg/pub_sub-0.0.2.gem
+- pkg/pub_sub-0.0.3.gem
+- pkg/ruby_pub_sub-0.0.3.gem
+- pkg/ruby_pub_sub-0.0.4.gem
+- ruby_pub_sub.gemspec
+- spec/integration/pub_sub_spec.rb
+- spec/spec_helper.rb
+- spec/unit/subscriber_spec.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
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Publish messages to subscribers within your application.  Initially built
+  as a replacement for Active Record's Observer pattern.  It is a thin wrapper around
+  ActiveSupport::Notifications which implements the Publish/Subscribe pattern.  This
+  gem is intended to create an easy to use and understand API around AS::Notifications.
+test_files:
+- spec/integration/pub_sub_spec.rb
+- spec/spec_helper.rb
+- spec/unit/subscriber_spec.rb