tusk 1.0.0 → 1.1.0

data/CHANGELOG.rdoc

@@ -1,3 +1,10 @@
+=== 1.1.0 / 2012-10-04
+
+* Redis supports sending a payload with `notify_observers`
+  Thanks Collin Miller!
+
+* DRb observer added
+
 === 1.0.0 / 2012-07-18
 
 * 1 major enhancement

data/Manifest.txt

@@ -5,9 +5,11 @@ README.markdown
 Rakefile
 lib/tusk.rb
 lib/tusk/latch.rb
+lib/tusk/observable/drb.rb
 lib/tusk/observable/pg.rb
 lib/tusk/observable/redis.rb
 test/helper.rb
+test/observable/test_drb.rb
 test/observable/test_pg.rb
 test/observable/test_redis.rb
 test/redis-test.conf

data/README.markdown

@@ -15,6 +15,7 @@ Currently, Tusk supports Redis and PostgreSQL as message bus back ends.
 * Send message across processes
 * Supports Redis as a message bus
 * Supports PostgreSQL as a message bus
+* Supports DRb as a message bus
 
 ## SYNOPSIS:
 

data/lib/tusk.rb

@@ -3,7 +3,8 @@
 #
 # Tusk::Observers::Redis offers an Observer API with Redis as the
 # message bus.  Tusk::Observers::PG offers and Observer API with
-# PostgreSQL as the message bus.
+# PostgreSQL as the message bus.  Tusk::Observers::DRb offers an
+# Observer API with DRb as the message bus.
 module Tusk
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/tusk/observable/drb.rb

@@ -0,0 +1,178 @@
+require 'drb'
+require 'digest/md5'
+
+module Tusk
+  module Observable
+    ###
+    # An observer implementation for DRb.  This module requires that
+    # you start a DRb server, which can be done via Server.start
+    #
+    # This observer works across processes.
+    #
+    # Example:
+    #
+    #     require 'tusk/observable/drb'
+    #
+    #     class Timer
+    #       include Tusk::Observable::DRb
+    #
+    #       # Start the DRb server. Do this once
+    #       Thread.new { Server.start }
+    #
+    #       def tick
+    #         changed
+    #         notify_observers
+    #       end
+    #     end
+    #
+    #     class Listener
+    #       def update
+    #         puts "got update"
+    #       end
+    #     end
+    #
+    #     timer = Timer.new
+    #
+    #     fork do
+    #       timer.add_observer Listener.new
+    #       sleep # put the process to sleep so it doesn't exit
+    #     end
+    #
+    #     loop do
+    #       timer.tick
+    #       sleep 1
+    #     end
+    module DRb
+      class Server
+        URI = 'druby://localhost:8787'
+
+        def self.start
+          ::DRb.start_service URI, new
+        end
+
+        def self.stop
+          ::DRb.stop_service
+        end
+
+        def initialize
+          @channels = Hash.new { |h,k| h[k] = {} }
+        end
+
+        def watch channel, proxy
+          @channels[channel][proxy] = proxy
+        end
+
+        def signal channel, args
+          @channels[channel].each { |proxy,|
+            proxy.notify args
+          }
+        end
+
+        def delete_observer channel, o
+          @channels[channel].delete o
+        end
+
+        def delete channel
+          @channels.delete channel
+        end
+      end
+
+      class Proxy # :nodoc:
+        include ::DRb::DRbUndumped
+
+        def initialize d, func
+          @delegate = d
+          @func     = func
+        end
+
+        def notify args
+          @delegate.send(@func, *args)
+        end
+      end
+
+      def self.extended klass
+        super
+
+        klass.instance_eval do
+          @bus = DRbObject.new_with_uri uri
+          @observer_state = false
+          @subscribers      = {}
+        end
+      end
+
+      def initialize *args
+        super
+
+        @bus = DRbObject.new_with_uri uri
+        @observer_state = false
+        @subscribers      = {}
+      end
+
+      # Add +observer+ as an observer to this object.  The +object+ will
+      # receive a notification when #changed? returns true and #notify_observers
+      # is called.
+      #
+      # +func+ method is called on +object+ when notifications are sent.
+      def add_observer object, func = :update
+        unless ::DRb.thread && ::DRb.thread.alive?
+          ::DRb.start_service
+        end
+
+        proxy = Proxy.new object, func
+        @subscribers[object] = proxy
+        @bus.watch channel, proxy
+      end
+
+      # If this object's #changed? state is true, this method will notify
+      # observing objects.
+      def notify_observers(*args)
+        return unless changed?
+        @bus.signal channel, args
+        changed false
+      end
+
+      # Remove all observers associated with this object *in the current
+      # process*. This method will not impact observers of this object in
+      # other processes.
+      def delete_observers
+        @bus.delete channel
+        @subscribers.clear
+      end
+
+      # Remove +observer+ so that it will no longer receive notifications.
+      def delete_observer o
+        proxy = @subscribers.delete o
+        @bus.delete_observer channel, proxy
+      end
+
+      # Returns true if this object's state has been changed since the last
+      # call to #notify_observers.
+      def changed?
+        @observer_state
+      end
+
+      # Set the changed state of this object.  Notifications will be sent only
+      # if the changed +state+ is a truthy object.
+      def changed state = true
+        @observer_state = state
+      end
+
+      # Returns the number of observers associated with this object *in the
+      # current process*.  If the object is observed across multiple processes,
+      # the returned count will not reflect the other processes.
+      def count_observers
+        @subscribers.length
+      end
+
+      private
+
+      def uri
+        Server::URI
+      end
+
+      def channel
+        "a" + Digest::MD5.hexdigest("#{self.class.name}#{object_id}")
+      end
+    end
+  end
+end

data/lib/tusk/observable/redis.rb

@@ -15,33 +15,33 @@ module Tusk
     #
     #     require 'redis'
     #     require 'tusk/observable/redis'
-    #     
+    #
     #     class Timer
     #       include Tusk::Observable::Redis
-    #     
+    #
     #       def tick
     #         changed
     #         notify_observers
     #       end
-    #     
+    #
     #       def connection
     #         Thread.current[:conn] ||= ::Redis.new
     #       end
     #     end
-    #     
+    #
     #     class Listener
     #       def update
     #         puts "got update"
     #       end
     #     end
-    #     
+    #
     #     timer = Timer.new
-    #     
+    #
     #     fork do
     #       timer.add_observer Listener.new
     #       sleep # put the process to sleep so it doesn't exit
     #     end
-    #     
+    #
     #     loop do
     #       timer.tick
     #       sleep 1
@@ -100,9 +100,9 @@ module Tusk
 
       # If this object's #changed? state is true, this method will notify
       # observing objects.
-      def notify_observers
+      def notify_observers(*args)
         return unless changed?
-        connection.publish channel, nil
+        connection.publish channel, payload_coder.dump(args)
         changed false
       end
 
@@ -148,6 +148,10 @@ module Tusk
         "a" + Digest::MD5.hexdigest("#{self.class.name}#{object_id}")
       end
 
+      def payload_coder
+        Marshal
+      end
+
       def start_listener latch
         connection.subscribe(channel, control_channel) do |on|
           on.subscribe { |c| latch.release }
@@ -158,7 +162,7 @@ module Tusk
             else
               @sub_lock.synchronize do
                 subscribers.fetch(c, {}).each do |object,m|
-                  object.send m
+                  object.send m, *payload_coder.load(message)
                 end
               end
             end

data/test/helper.rb

@@ -13,6 +13,12 @@ module Tusk
         end
       end
 
+      class PayloadQueueingObserver < QueueingObserver
+        def update(*args)
+          @q.push(args)
+        end
+      end
+
       def test_changed?
         o = build_observable
         refute o.changed?
@@ -69,6 +75,18 @@ module Tusk
         assert_equal :foo, q.pop
       end
 
+      def test_notification_payload
+        o = build_observable
+        q = Queue.new
+
+        o.add_observer PayloadQueueingObserver.new q
+
+        o.changed
+        o.notify_observers :payload
+
+        assert_equal [:payload], q.pop
+      end
+
       def test_multiple_observers
         o = build_observable
         q = Queue.new

data/test/observable/test_drb.rb

@@ -0,0 +1,76 @@
+require 'helper'
+require 'tusk/observable/drb'
+
+module Tusk
+  module Observable
+    class TestDRb < TestCase
+      include ObserverTests
+
+      class Timer
+        include Tusk::Observable::DRb
+
+        def tick
+          changed
+          notify_observers
+        end
+      end
+
+      def setup
+        super
+        DRb::Server.start
+      end
+
+      def teardown
+        super
+        DRb::Server.stop
+      end
+
+      def test_no_connection
+        skip "not implementing for now"
+      end
+
+      private
+
+      def build_observable
+        Timer.new
+      end
+
+      def observer_module
+        Tusk::Observable::DRb
+      end
+    end
+
+    class TestClassDRb < TestCase
+      include ObserverTests
+
+      def setup
+        super
+        DRb::Server.start
+      end
+
+      def teardown
+        super
+        DRb::Server.stop
+      end
+
+      def build_observable
+        Class.new {
+          extend Tusk::Observable::DRb
+
+          def self.tick
+            changed
+            notify_observers
+          end
+        }
+      end
+
+      def test_no_connection
+        skip "not implementing for now"
+      end
+
+      def observer_module
+        Tusk::Observable::DRb
+      end
+    end
+  end
+end

metadata

@@ -1,100 +1,97 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: tusk
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 1.1.0
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Aaron Patterson
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-07-22 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 2
-        - 11
-        version: "2.11"
+      - !ruby/object:Gem::Version
+        version: '3.10'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: pg
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 39
-        segments: 
-        - 0
-        - 14
-        - 0
+      - !ruby/object:Gem::Version
         version: 0.14.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rdoc
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 3
-        - 10
-        version: "3.10"
-  type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
   name: hoe
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 25
-        segments: 
-        - 2
-        - 13
-        version: "2.13"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
-  version_requirements: *id004
-description: |-
-  Tusk is a minimal pub / sub system with multiple observer strategies.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ! 'Tusk is a minimal pub / sub system with multiple observer strategies.
+
   Tusk builds upon the Observer API from stdlib in order to provide a mostly
+
   consistent API for building cross thread or process pub / sub systems.
-  
-  Currently, Tusk supports Redis and PostgreSQL as message bus back ends.
-email: 
+
+
+  Currently, Tusk supports Redis and PostgreSQL as message bus back ends.'
+email:
 - aaron@tenderlovemaking.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- Manifest.txt
+extra_rdoc_files:
 - CHANGELOG.rdoc
+- Manifest.txt
 - README.markdown
-files: 
+files:
 - .autotest
 - CHANGELOG.rdoc
 - Manifest.txt
@@ -102,47 +99,42 @@ files:
 - Rakefile
 - lib/tusk.rb
 - lib/tusk/latch.rb
+- lib/tusk/observable/drb.rb
 - lib/tusk/observable/pg.rb
 - lib/tusk/observable/redis.rb
 - test/helper.rb
+- test/observable/test_drb.rb
 - test/observable/test_pg.rb
 - test/observable/test_redis.rb
 - test/redis-test.conf
 - .gemtest
 homepage: http://github.com/tenderlove/tusk
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.markdown
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: tusk
-rubygems_version: 1.8.22
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Tusk is a minimal pub / sub system with multiple observer strategies
-test_files: 
+test_files:
+- test/observable/test_drb.rb
 - test/observable/test_pg.rb
 - test/observable/test_redis.rb