sub_pub 0.0.3 → 0.0.6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sub_pub (0.0.3)
+    sub_pub (0.0.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -92,6 +92,14 @@ Or install it yourself as:
     User.create(name: 'John Doe')
     => SubPub.publish("active_record::user::after_create")
 
+
+## Supported Active Record Callbacks
+
+* before_create
+* after_create
+* after_commit
+
+
 ## Backlog / To Do
 
 http://www.pivotaltracker.com/projects/705655

data/Rakefile

@@ -1 +1,12 @@
 require "bundler/gem_tasks"
+
+task :suite do
+  if system("rspec spec")
+    puts "Test suite passed!!"
+  else
+    puts "Test suite failed..."
+    exit(1)
+  end
+end
+
+task :default => :suite

data/lib/sub_pub/active_record_extensions.rb

@@ -1,38 +1,22 @@
 module SubPub
-  class ActiveRecordExtensions < Rails::Railtie
-    initializer "pub sub configuration of active record extensions" do
-      class ::ActiveRecord::Base
-        after_create :notify_of_after_create
+  module ActiveRecordExtensions
+    extend ActiveSupport::Concern
 
-        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}"
-          SubPub.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 }
+    included do
+      ['before_create', 'after_create', 'after_commit'].each do |callback|
+        class_eval "
+          #{callback} do
+            notify_pub_sub_of_active_record_callback('#{callback}')
+          end
+        "
       end
     end
-  end
 
-  module ActiveRecord
-    class Subscriber < SubPub::Subscriber
-      def self.subscribe_to(class_instance, callback)
-        super("active_record::#{class_instance.to_s.underscore}::#{callback}")
-      end
+    private
 
-      def record
-        options[:record]
-      end
+    def notify_pub_sub_of_active_record_callback(callback)
+      message = "active_record::#{self.class.to_s.underscore}::#{callback}"
+      SubPub.publish(message, record: self)
     end
   end
 end

data/lib/sub_pub/active_record_subscriber.rb

@@ -0,0 +1,13 @@
+module SubPub
+  module ActiveRecord
+    class Subscriber < SubPub::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/sub_pub/railtie.rb

@@ -0,0 +1,15 @@
+module SubPub
+  class Railtie < Rails::Railtie
+    initializer "pub sub configuration of active record extensions" do
+      class ::ActiveRecord::Base
+        include SubPub::ActiveRecordExtensions
+      end
+
+      config.after_initialize do
+        Dir[
+          File.expand_path("app/models/pub_sub/*.rb", Rails.root)
+        ].each { |file| require file }
+      end
+    end
+  end
+end

data/lib/sub_pub/register.rb

@@ -4,14 +4,28 @@ module SubPub
   class Register
     include Singleton
 
-    attr_accessor :enabled
+    attr_accessor :enabled, :scope, :subscriptions
 
     def initialize
-      @enabled = true
+      @enabled = default_enabled_state
+      @scope = default_scope
+      @subscriptions = []
       super
     end
 
+    def default_enabled_state
+      true
+    end
+
+    def default_scope
+      "sub_pub"
+    end
+
     class << self
+      def scope=(new_scope)
+        instance.scope = new_scope
+      end
+
       def enable
         instance.enabled = true
       end
@@ -35,11 +49,36 @@ module SubPub
       def publish(*args, &block)
         return if disabled?
 
-        ActiveSupport::Notifications.publish(*args, &block)
+        topic = args.shift
+        payload = args.last
+        full_topic = scoped(topic).full_topic
+
+        ActiveSupport::Notifications.publish(full_topic, payload, &block)
+      end
+
+      def scoped(topic)
+        ScopedTopic.new(topic, instance.scope)
       end
 
       def subscribe(*args, &block)
-        ActiveSupport::Notifications.subscribe(*args, &block)
+        topic = args.first
+
+        options = {
+          scoped_topic: ScopedTopic.new(topic, instance.scope),
+          action: block
+        }
+
+        Subscription.subscribe(options).tap do |subscription|
+          instance.subscriptions << subscription
+        end
+      end
+
+      def unsubscribe_all
+        instance.subscriptions.each do |subscription|
+          subscription.unsubscribe
+        end
+
+        instance.subscriptions = []
       end
     end
   end

data/lib/sub_pub/scoped_topic.rb

@@ -0,0 +1,16 @@
+module SubPub
+  class ScopedTopic
+    def initialize(topic, scope)
+      @topic = topic
+      @scope = scope
+    end
+
+    def full_topic
+      "#{@scope}::#{@topic}"
+    end
+
+    def topic
+      @topic
+    end
+  end
+end

data/lib/sub_pub/subscriber.rb

@@ -24,7 +24,7 @@ module SubPub
     end
 
     def self.topic
-      @subscription.instance_variable_get("@pattern")
+      @subscription.topic
     end
 
     def on_publish

data/lib/sub_pub/subscription.rb

@@ -0,0 +1,26 @@
+module SubPub
+  class Subscription
+    def initialize(options)
+      @scoped_topic = options[:scoped_topic]
+      @action = options[:action]
+    end
+
+    def self.subscribe(options)
+      subscription = new(options)
+      subscription.subscribe
+      subscription
+    end
+
+    def subscribe
+      @subscription = ActiveSupport::Notifications.subscribe(@scoped_topic.full_topic, @action)
+    end
+
+    def unsubscribe
+      ActiveSupport::Notifications.unsubscribe(@scoped_topic.full_topic)
+    end
+
+    def topic
+      @scoped_topic.topic
+    end
+  end
+end

data/lib/sub_pub/version.rb

@@ -1,3 +1,3 @@
 module SubPub
-  VERSION = "0.0.3"
+  VERSION = "0.0.6"
 end

data/lib/sub_pub.rb

@@ -1,5 +1,9 @@
 module SubPub
   class << self
+    def scope=(new_scope)
+      Register.scope = new_scope
+    end
+
     def enable
       Register.enable
     end
@@ -26,14 +30,22 @@ module SubPub
     def subscribe(*args, &block)
       Register.subscribe(*args, &block)
     end
+
+    def unsubscribe_all
+      Register.unsubscribe_all
+    end
   end
 end
 
 require "sub_pub/version"
 require "sub_pub/subscriber"
 require "sub_pub/register"
+require "sub_pub/subscription"
+require "sub_pub/scoped_topic"
 
-require 'rails'
-require 'active_record'
+require "rails"
+require "active_record"
 
-require_relative "sub_pub/active_record_extensions"
+require "sub_pub/active_record_subscriber"
+require "sub_pub/active_record_extensions"
+require "sub_pub/railtie"

data/spec/integration/sub_pub_spec.rb

@@ -0,0 +1,177 @@
+require 'spec_helper'
+
+describe SubPub do
+  with_model :FakeActiveRecordUser do
+    table do |t|
+      t.string :title
+    end
+
+    model do
+      has_many :fake_active_record_results
+    end
+  end
+
+  with_model :FakeActiveRecordResult do
+    table do |t|
+      t.string :title
+      t.integer :fake_active_record_user_id
+    end
+  end
+
+  describe "initial state" do
+    it "defaults enabled to true" do
+      SubPub::Register.instance.enabled = nil
+      SubPub.enabled?.should be_true
+    end
+  end
+
+  describe "#enable" do
+    it "enables SubPub" do
+      SubPub.disable
+      SubPub.enable
+      SubPub.enabled?.should be_true
+    end
+  end
+
+  describe "#disable" do
+    it "disables SubPub" do
+      SubPub.disable
+      SubPub.enabled?.should be_false
+    end
+  end
+
+  describe "#publish" do
+    context "when disabled" do
+      before { SubPub.disable }
+
+      it "does not publish" do
+        ActiveSupport::Notifications.should_receive(:publish).never
+        SubPub.publish
+      end
+    end
+
+    context "with a set scope" do
+      it "uses the configured scope" do
+        payload = { :payload => 'here' }
+
+        SubPub.scope = 'rails'
+
+        ActiveSupport::Notifications.should_receive(:publish).with(
+          "rails::my-message",
+          payload
+        )
+
+        SubPub.publish("my-message", payload)
+      end
+    end
+
+    context "when using the default scope" do
+      it "publishes to active support using the default scope" do
+        payload = { :payload => 'here' }
+
+        ActiveSupport::Notifications.should_receive(:publish).with(
+          "sub_pub::my-message",
+          payload
+        )
+
+        SubPub.publish("my-message", payload)
+      end
+    end
+  end
+
+  describe "normal pubsub" do
+    before do
+      class CreateAccountSubscriber < SubPub::Subscriber
+        subscribe_to("new_account_posted")
+
+        def on_publish
+          FakeActiveRecordUser.create(title: options[:title])
+        end
+      end
+    end
+
+    it "calls the subscriber properly" do
+      FakeActiveRecordUser.all.size.should == 0
+      SubPub.publish("new_account_posted", {title: 'foo'})
+      FakeActiveRecordUser.all.size.should == 1
+      FakeActiveRecordUser.all.first.title.should == 'foo'
+    end
+  end
+
+  describe "normal pubsub with a configured scope" do
+    before do
+      SubPub.scope = 'foo-bar'
+
+      class CreateAccountSubscriber < SubPub::Subscriber
+        subscribe_to("new_account_posted")
+
+        def on_publish
+          FakeActiveRecordUser.create(title: options[:title])
+        end
+      end
+    end
+
+    it "calls the subscriber properly" do
+      FakeActiveRecordUser.all.size.should == 0
+      SubPub.publish("new_account_posted", {title: 'foo'})
+      FakeActiveRecordUser.all.size.should == 1
+      FakeActiveRecordUser.all.first.title.should == 'foo'
+    end
+  end
+
+  describe "active record configuration" do
+    describe "after create" do
+      before do
+        class FakeActiveRecordUserSubscriber < SubPub::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
+
+    describe "after commit" do
+      before do
+        class FakeActiveRecordUserSubscriber < SubPub::ActiveRecord::Subscriber
+          subscribe_to(FakeActiveRecordUser, 'after_commit')
+
+          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
+
+    describe "before create" do
+      before do
+        class FakeActiveRecordUserSubscriber < SubPub::ActiveRecord::Subscriber
+          subscribe_to(FakeActiveRecordUser, 'before_create')
+
+          def on_publish
+            record.fake_active_record_results.build(title: 'fooz')
+          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
+end

data/spec/spec_helper.rb

@@ -24,7 +24,7 @@ RSpec.configure do |config|
   #
   #  Rails loads this during its setup
   #
-  SubPub::ActiveRecordExtensions.run_initializers
+  SubPub::Railtie.run_initializers
 
   #
   # Test database
@@ -44,7 +44,9 @@ RSpec.configure do |config|
   #
   # Ensure pubsub is enabled
   #
-  config.before do
+  config.before(:each) do
     SubPub.enable
+    SubPub.scope = 'sub_pub'
+    SubPub.unsubscribe_all
   end
 end

data/spec/unit/register_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe SubPub::Register do
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sub_pub
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-13 00:00:00.000000000 Z
+date: 2012-12-17 00:00:00.000000000 Z
 dependencies: []
 description: In process publish/subscribe for Ruby
 email:
@@ -28,12 +28,18 @@ files:
 - db/.gitkeep
 - lib/sub_pub.rb
 - lib/sub_pub/active_record_extensions.rb
+- lib/sub_pub/active_record_subscriber.rb
+- lib/sub_pub/railtie.rb
 - lib/sub_pub/register.rb
+- lib/sub_pub/scoped_topic.rb
 - lib/sub_pub/subscriber.rb
+- lib/sub_pub/subscription.rb
 - lib/sub_pub/version.rb
 - pkg/sub_pub-0.0.3.gem
-- spec/integration/pub_sub_spec.rb
+- pkg/sub_pub-0.0.4.gem
+- spec/integration/sub_pub_spec.rb
 - spec/spec_helper.rb
+- spec/unit/register_spec.rb
 - spec/unit/subscriber_spec.rb
 - sub_pub.gemspec
 homepage: ''
@@ -48,18 +54,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -923795167419613194
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -923795167419613194
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -68,6 +68,8 @@ specification_version: 3
 summary: SubPub is a thin wrapper around ActiveSupport::Notifications, which provides
   an implementation of the Publish/Subscribe pattern.
 test_files:
-- spec/integration/pub_sub_spec.rb
+- spec/integration/sub_pub_spec.rb
 - spec/spec_helper.rb
+- spec/unit/register_spec.rb
 - spec/unit/subscriber_spec.rb
+has_rdoc: 

data/spec/integration/pub_sub_spec.rb

@@ -1,66 +0,0 @@
-require 'spec_helper'
-
-describe SubPub do
-  describe "initial state" do
-    it "defaults enabled to true" do
-      SubPub::Register.instance.enabled = nil
-      SubPub.enabled?.should be_true
-    end
-  end
-
-  describe "#enable" do
-    it "enables SubPub" do
-      SubPub.disable
-      SubPub.enable
-      SubPub.enabled?.should be_true
-    end
-  end
-
-  describe "#disable" do
-    it "disables SubPub" do
-      SubPub.disable
-      SubPub.enabled?.should be_false
-    end
-  end
-
-  describe "#publish" do
-    context "when disabled" do
-      before { SubPub.disable }
-
-      it "does not publish" do
-        ActiveSupport::Notifications.should_receive(:publish).never
-        SubPub.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 < SubPub::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