zk-eventmachine 0.1.11 → 0.1.12

data/.gitignore

@@ -7,3 +7,4 @@ pkg/*
 .rspec
 *.log
 .yardoc
+doc

data/.yardopts

@@ -0,0 +1,8 @@
+--protected
+--no-private
+--tag hidden_example:Hidden
+--hide-tag hidden_example
+-
+LICENSE
+README.markdown
+

data/Rakefile

@@ -1,2 +1,37 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+task :yard do
+  Bundler.setup
+  require 'yard'
+
+  YARD::Rake::YardocTask.new(:run_yardoc) do |t|
+    t.files = ['lib/**/*.rb']
+  end
+
+  Rake::Task[:run_yardoc].invoke
+end
+
+%w[1.8.7 1.9.2 1.9.3 jruby].each do |rvm_ruby|
+  gemset_name         = 'zk-em'
+  ruby_with_gemset    = "#{rvm_ruby}@#{gemset_name}"
+  create_gemset_name  = "mb:#{rvm_ruby}:create_gemset"
+  bundle_task_name    = "mb:#{rvm_ruby}:bundle_install"
+  rspec_task_name     = "mb:#{rvm_ruby}:run_rspec"
+
+  task create_gemset_name do
+    sh "rvm #{rvm_ruby} && rvm gemset create #{gemset_name}" 
+  end
+
+  task bundle_task_name => create_gemset_name do
+    rm_f 'Gemfile.lock'
+    sh "rvm #{ruby_with_gemset} do bundle install"
+  end
+
+  task rspec_task_name => bundle_task_name do
+    sh "rvm #{ruby_with_gemset} do bundle exec rspec spec"
+  end
+
+  task 'mb:test_all' => rspec_task_name
+end
+

data/lib/z_k/z_k_event_machine.rb

@@ -4,7 +4,7 @@ require 'zookeeper'
 require 'zookeeper/em_client'
 
 require 'zk'
-
+require 'deferred'
 
 module ZK
   module ZKEventMachine
@@ -15,7 +15,6 @@ end
 $LOAD_PATH.unshift(File.expand_path('../..', __FILE__)).uniq!
 
 require 'z_k/z_k_event_machine/iterator'
-require 'z_k/z_k_event_machine/deferred'
 require 'z_k/z_k_event_machine/callback'
 require 'z_k/z_k_event_machine/event_handler_e_m'
 require 'z_k/z_k_event_machine/unixisms'

data/lib/z_k/z_k_event_machine/callback.rb

@@ -70,7 +70,7 @@ module ZK
         #
         # @param [Hash] hash the result of the async call 
         # 
-        # @returns [true, false] for success, failure 
+        # @return [true, false] for success, failure 
         def success?(hash)
           hash[:rc] == Zookeeper::ZOK
         end

data/lib/z_k/z_k_event_machine/client.rb

@@ -1,22 +1,63 @@
 module ZK
   module ZKEventMachine
     class Client < ZK::Client::Base
+      include Deferred::Accessors
       include ZK::Logging
       include Unixisms
 
       DEFAULT_TIMEOUT = 10
 
+      # If we get a ZK::Exceptions::ConnectionLoss exeption back from any call,
+      # or a EXPIRED_SESSION_STATE event, we will call back any handlers registered
+      # here with the exception instance as the argument.
+      #
+      # once this deferred has been fired, it will be replaced with a new
+      # deferred, so callbacks must be re-registered, and *should* be
+      # re-registered *within* the callback to avoid missing events
+      # 
+      # @method on_connection_lost
+      # @return [Deferred::Default]
+      deferred_event :connection_lost
+      
+
+      # Registers a one-shot callback for the ZOO_CONNECTED_STATE event. 
+      #
+      # @note this is experimental currently. This may or may not fire for the *initial* connection.
+      # it's purpose is to warn an already-existing client with watches that a connection has been
+      # re-established (with session information saved). From the ZooKeeper Programmers' Guide:
+      #
+      #   If you are using watches, you must look for the connected watch event.
+      #   When a ZooKeeper client disconnects from a server, you will not receive
+      #   notification of changes until reconnected. If you are watching for a
+      #   znode to come into existance, you will miss the event if the znode is
+      #   created and deleted while you are disconnected.
+      #
+      # once this deferred has been fired, it will be replaced with a new
+      # deferred, so callbacks must be re-registered, and *should* be
+      # re-registered *within* the callback to avoid missing events
+      #
+      # @method on_connected
+      # @return [Deferred::Default]
+      deferred_event :connected
+
+      # Registers a one-shot callback for the ZOO_CONNECTING_STATE event
+      #
+      # This event is triggered when we have become disconnected from the
+      # cluster and are in the process of reconnecting.
+      deferred_event :connecting
+
+      # called back once the connection has been closed.
+      #
+      # @method on_close
+      # @return [Deferred::Default]
+      deferred_event :close
+
       # Takes same options as ZK::Client::Base
       def initialize(host, opts={})
         @host = host
-        @close_deferred = Deferred::Default.new
-        @connection_lost_deferred = Deferred::Default.new
-        @event_handler = EventHandlerEM.new(self)
-      end
-
-      def on_close(&blk)
-        @close_deferred.callback(&blk) if blk
-        @close_deferred
+        @event_handler  = EventHandlerEM.new(self)
+        @closing        = false
+        register_default_event_handlers!
       end
 
       # open a ZK connection, attach it to the reactor. 
@@ -25,30 +66,20 @@ module ZK
       def connect(&blk)
         # XXX: maybe move this into initialize, need to figure out how to schedule it properly
         @cnx ||= (
-          event_handler.register_state_handler(Zookeeper::ZOO_EXPIRED_SESSION_STATE, &method(:handle_expired_session_state_event!))
           ZookeeperEM::Client.new(@host, DEFAULT_TIMEOUT, event_handler.get_default_watcher_block)
         )
         @cnx.on_attached(&blk)
       end
 
-      # If we get a ZK::Exceptions::ConnectionLoss exeption back from any call,
-      # we will call back any handlers registered here with the exception
-      # instance as the argument
-      #
-      # once this deferred has been fired, it will be replaced with a new
-      # deferred, so callbacks must be re-registered
-      # 
-      def on_connection_lost(&blk)
-        @connection_lost_deferred.callback(&blk) if blk
-        @connection_lost_deferred
-      end
-
+      # @private
       def reopen(*a)
         raise NotImplementedError, "reoopen is not implemented for the eventmachine version of the client"
       end
       
       def close!(&blk)
         on_close(&blk)
+        return on_close if @closing
+        @closing = true
 
         if @cnx
           logger.debug { "#{self.class.name}: in close! clearing event_handler" }
@@ -70,7 +101,7 @@ module ZK
 
       # get data at path, optionally enabling a watch on the node
       #
-      # @returns [Callback] returns a Callback which is an EM::Deferred (so you
+      # @return [Callback] returns a Callback which is an EM::Deferred (so you
       #   can assign callbacks/errbacks) see Callback::Base for discussion
       #
       def get(path, opts={}, &block)
@@ -137,27 +168,47 @@ module ZK
         end
       end
 
+      # @return [Fixnum] The underlying connection's session_id
       def session_id
         return nil unless @cnx
         @cnx.session_id
       end
 
+      # @return [String] The underlying connection's session passwd (an opaque value)
       def session_passwd
         return nil unless @cnx
         @cnx.session_passwd
       end
 
     protected
+      # @private
+      def register_default_event_handlers!
+        @event_handler.register_state_handler(Zookeeper::ZOO_EXPIRED_SESSION_STATE, &method(:handle_expired_session_state_event!))
+        @event_handler.register_state_handler(Zookeeper::ZOO_CONNECTED_STATE,       &method(:handle_connected_state_event!))
+        @event_handler.register_state_handler(Zookeeper::ZOO_CONNECTING_STATE,      &method(:handle_connecting_state_event!))
+      end
+
+      # @private
+      def handle_connected_state_event!(event)
+        reset_connected_event.succeed(event)
+      end
+
+      # @private
+      def handle_connecting_state_event!(event)
+        reset_connecting_event.succeed(event)
+      end
+
+      # @private
       def handle_expired_session_state_event!(event)
         exc = ZK::Exceptions::ConnectionLoss.new("Received EXPIRED_SESSION_STATE event: #{event.inspect}")
         exc.set_backtrace(caller)
         connection_lost_hook(exc)
       end
 
+      # @private
       def connection_lost_hook(exc)
         if exc and exc.kind_of?(ZK::Exceptions::ConnectionLoss)
-          dfr, @connection_lost_deferred = @connection_lost_deferred, Deferred::Default.new
-          dfr.succeed(exc)
+          reset_connection_lost_event.succeed(exc)
         end
       end
     end

data/lib/z_k/z_k_event_machine/unixisms.rb

@@ -31,15 +31,18 @@ module ZK
         _handle_calling_convention(dfr, &blk)
       end
 
+      # @private
       def find(*paths, &block)
         raise NotImplementedError, "Coming soon"
       end
 
+      # @private
       def block_until_node_deleted(abs_node_path)
         raise NotImplementedError, "blocking does not make sense in EventMachine-land"
       end
 
       protected
+        # @private
         def _handle_calling_convention(dfr, &blk)
           return dfr unless blk
           dfr.callback { |*a| blk.call(nil, *a) }
@@ -47,6 +50,7 @@ module ZK
           dfr
         end
 
+        # @private
         def _rm_rf_dfr(path)
           Deferred::Default.new.tap do |my_dfr|
             delete(path) do |exc|
@@ -85,6 +89,7 @@ module ZK
           end
         end
 
+        # @private
         def _mkdir_p_dfr(path)
           Deferred::Default.new.tap do |my_dfr|
             d = create(path, '')

data/lib/z_k/z_k_event_machine/version.rb

@@ -1,5 +1,5 @@
 module ZK
   module ZKEventMachine
-    VERSION = "0.1.11"
+    VERSION = "0.1.12"
   end
 end

data/spec/z_k/z_k_event_machine/client_spec.rb

@@ -18,6 +18,15 @@ module ZK::ZKEventMachine
       @zk.close!
     end
 
+    def event_mock(name=:event)
+      flexmock(name).tap do |ev|
+        ev.should_receive(:node_event?).and_return(false)
+        ev.should_receive(:state_event?).and_return(true)
+        ev.should_receive(:zk=).with_any_args
+        yield ev if block_given?
+      end
+    end
+
     describe 'connect' do
       it %[should return a deferred that fires when connected and then close] do
         em do
@@ -45,64 +54,6 @@ module ZK::ZKEventMachine
       end
     end
 
-    describe 'on_connection_loss' do
-      before do
-        @path = [@base_path, 'foo'].join('/')
-        @data = 'this is data'
-        @zk.create(@path, @data)
-      end
-
-      it %[should be called back if the connection is lost] do
-        em do
-          @zkem.on_connection_lost do |exc|
-            logger.debug { "WIN!" }
-            exc.should be_kind_of(ZK::Exceptions::ConnectionLoss)
-            @zkem.close! { done }
-          end
-
-          @zkem.connect do
-            flexmock(@zkem.cnx) do |m|
-              m.should_receive(:get).with(Hash).and_return do |hash|
-                logger.debug { "client received :get wtih #{hash.inspect}" }
-                @user_cb = hash[:callback]
-
-                EM.next_tick do
-                  logger.debug { "calling back user cb with connection loss" }
-                  @user_cb.call(:rc => ZK::Exceptions::CONNECTIONLOSS)
-                end
-
-                { :rc => Zookeeper::ZOK }
-              end
-            end
-
-            @zkem.get(@path) do |exc,data|
-              exc.should be_kind_of(ZK::Exceptions::ConnectionLoss)
-            end
-          end
-        end
-      end
-
-      it %[should be called if we get a session expired event] do
-        @zkem.on_connection_lost do |exc|
-          logger.debug { "WIN!" }
-          exc.should be_kind_of(ZK::Exceptions::ConnectionLoss)
-          @zkem.close! { done }
-        end
-
-        em do
-          @zkem.connect do
-            event = flexmock(:event).tap do |ev|
-              ev.should_receive(:node_event?).and_return(false)
-              ev.should_receive(:state_event?).and_return(true)
-              ev.should_receive(:zk=).with_any_args
-              ev.should_receive(:state).and_return(Zookeeper::ZOO_EXPIRED_SESSION_STATE)
-            end
-
-            EM.next_tick { @zkem.event_handler.process(event) }
-          end
-        end
-      end
-    end
 
     describe 'get' do
       describe 'success' do
@@ -288,7 +239,6 @@ module ZK::ZKEventMachine
       end # failure
     end # create
 
-
     describe 'set' do
       describe 'success' do
         before do
@@ -775,6 +725,96 @@ module ZK::ZKEventMachine
         end
       end
     end
+
+    describe 'on_connection_lost' do
+      before do
+        @path = [@base_path, 'foo'].join('/')
+        @data = 'this is data'
+        @zk.create(@path, @data)
+      end
+
+      it %[should be called back if the connection is lost] do
+        em do
+          @zkem.on_connection_lost do |exc|
+            logger.debug { "WIN!" }
+            exc.should be_kind_of(ZK::Exceptions::ConnectionLoss)
+            @zkem.close! { done }
+          end
+
+          @zkem.connect do
+            flexmock(@zkem.cnx) do |m|
+              m.should_receive(:get).with(Hash).and_return do |hash|
+                logger.debug { "client received :get wtih #{hash.inspect}" }
+                @user_cb = hash[:callback]
+
+                EM.next_tick do
+                  logger.debug { "calling back user cb with connection loss" }
+                  @user_cb.call(:rc => ZK::Exceptions::CONNECTIONLOSS)
+                end
+
+                { :rc => Zookeeper::ZOK }
+              end
+            end
+
+            @zkem.get(@path) do |exc,data|
+              exc.should be_kind_of(ZK::Exceptions::ConnectionLoss)
+            end
+          end
+        end
+      end
+
+      it %[should be called if we get a session expired event] do
+        @zkem.on_connection_lost do |exc|
+          logger.debug { "WIN!" }
+          exc.should be_kind_of(ZK::Exceptions::ConnectionLoss)
+          @zkem.close! { done }
+        end
+
+        em do
+          @zkem.connect do
+            event = event_mock(:connection_loss_event).tap do |ev|
+              ev.should_receive(:state).and_return(Zookeeper::ZOO_EXPIRED_SESSION_STATE)
+            end
+
+            EM.next_tick { @zkem.event_handler.process(event) }
+          end
+        end
+      end
+    end # on_connection_lost
+
+    describe 'on_connected' do
+      it %[should be called back when a ZOO_CONNECTED_STATE event is received] do
+        em do
+          @zkem.on_connected do |event|
+            logger.debug { "WIN!" }
+            @zkem.close! { done }
+          end
+
+          @zkem.connect do
+            logger.debug { "we connected" }
+          end
+        end
+      end
+    end # on_connected
+
+    describe 'on_connecting' do
+      it %[should be called back when a ZOO_CONNECTING_STATE event is received] do
+        @zkem.on_connecting do |event|
+          logger.debug { "WIN!" }
+          @zkem.close! { done }
+        end
+
+        em do
+          @zkem.connect do
+            event = event_mock(:connecting_event).tap do |ev|
+              ev.should_receive(:state).and_return(Zookeeper::ZOO_CONNECTING_STATE)
+            end
+
+            EM.next_tick { @zkem.event_handler.process(event) }
+          end
+        end
+      end
+    end # on_connecting
   end # Client
 end # ZK::ZKEventMachine
 

data/zk-eventmachine.gemspec

@@ -17,12 +17,14 @@ Gem::Specification.new do |s|
   # zk depends on slyphon-zookeeper, but we need at least this version
   s.add_dependency('slyphon-zookeeper', '~> 0.2.8')
   s.add_dependency('eventmachine', '~> 1.0.0.beta.3')
+  s.add_dependency('deferred', '~> 0.5.3')
 
   s.add_development_dependency('rspec', '~> 2.5.0')
   s.add_development_dependency('yard', '~> 0.7.0')
   s.add_development_dependency('autotest', '>= 4.4.0')
   s.add_development_dependency('flexmock', '~> 0.8.10')
   s.add_development_dependency('evented-spec', '~> 0.4.1')
+  s.add_development_dependency('redcarpet', '~> 2.1.0')
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: zk-eventmachine
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 3
   prerelease: 
   segments: 
   - 0
   - 1
-  - 11
-  version: 0.1.11
+  - 12
+  version: 0.1.12
 platform: ruby
 authors: 
 - Jonathan D. Simms
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-27 00:00:00 Z
+date: 2012-02-01 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: zk
@@ -68,9 +68,25 @@ dependencies:
   type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: deferred
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 5
+        - 3
+        version: 0.5.3
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -82,11 +98,11 @@ dependencies:
         - 0
         version: 2.5.0
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: yard
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -98,11 +114,11 @@ dependencies:
         - 0
         version: 0.7.0
   type: :development
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: autotest
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -114,11 +130,11 @@ dependencies:
         - 0
         version: 4.4.0
   type: :development
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: flexmock
   prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -130,11 +146,11 @@ dependencies:
         - 10
         version: 0.8.10
   type: :development
-  version_requirements: *id007
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: evented-spec
   prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -146,7 +162,23 @@ dependencies:
         - 1
         version: 0.4.1
   type: :development
-  version_requirements: *id008
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: redcarpet
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :development
+  version_requirements: *id010
 description: ""
 email: 
 - slyphon@hp.com
@@ -162,6 +194,7 @@ files:
 - .dev_extras/rvmrc
 - .dev_extras/slyphon-project.vimrc
 - .gitignore
+- .yardopts
 - Gemfile
 - LICENSE
 - README.markdown
@@ -169,7 +202,6 @@ files:
 - lib/z_k/z_k_event_machine.rb
 - lib/z_k/z_k_event_machine/callback.rb
 - lib/z_k/z_k_event_machine/client.rb
-- lib/z_k/z_k_event_machine/deferred.rb
 - lib/z_k/z_k_event_machine/event_handler_e_m.rb
 - lib/z_k/z_k_event_machine/iterator.rb
 - lib/z_k/z_k_event_machine/unixisms.rb

data/lib/z_k/z_k_event_machine/deferred.rb

@@ -1,39 +0,0 @@
-module ZK
-  module ZKEventMachine
-    module Deferred
-      include EM::Deferrable
-
-      # slight modification to EM::Deferrable, 
-      #
-      # @returns [self] to allow for chaining
-      #
-      def callback(&block)
-        super(&block)
-        self
-      end
-
-      # @see #callback
-      def errback(&block)
-        super(&block)
-        self
-      end
-
-      # adds the block to both the callback and errback chains
-      def ensure_that(&block)
-        callback(&block)
-        errback(&block)
-      end
-
-      def chain_to(other_dfr, opts={})
-        other_dfr.callback { |*a| self.succeed(*a) }
-        other_dfr.errback { |*a| self.fail(*a) } unless opts[:ignore_errors]
-        self
-      end
-
-      class Default
-        include ZK::ZKEventMachine::Deferred
-      end
-    end
-  end
-end
-