zk-eventmachine 1.0.0 → 1.0.1

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "releaseops"]
+	path = releaseops
+	url = git://github.com/slyphon/releaseops.git

data/Rakefile

@@ -1,62 +1,47 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
+gemset_name  = 'zk-em'
 
-task :yard do
-  Bundler.setup
-  require 'yard'
+release_ops_path = File.expand_path('../releaseops/lib', __FILE__)
 
-  YARD::Rake::YardocTask.new(:run_yardoc) do |t|
-    t.files = ['lib/**/*.rb']
-  end
+# if the special submodule is availabe, use it
+# we use a submodule because it doesn't depend on anything else (*cough* bundler)
+# and can be shared across projects
+#
+if File.exists?(release_ops_path)
+  require File.join(release_ops_path, 'releaseops')
+  
+  # sets up the multi-ruby zk:test_all rake tasks
+  ReleaseOps::TestTasks.define_for(*%w[1.8.7 1.9.2 jruby ree 1.9.3])
 
-  Rake::Task[:run_yardoc].invoke
-end
+  # sets up the task :default => 'spec:run' and defines a simple
+  # "run the specs with the current rvm profile" task
+  ReleaseOps::TestTasks.define_simple_default_for_travis
 
-gemset_name  = 'zk-em'
+  # Define a task to run code coverage tests
+  ReleaseOps::TestTasks.define_simplecov_tasks
 
-%w[1.8.7 1.9.2 jruby rbx 1.9.3].each do |ns_name|
-  rvm_ruby = (ns_name == 'rbx') ? "rbx-2.0.testing" : ns_name
+  # set up yard:server, yard:gems, and yard:clean tasks 
+  # for doing documentation stuff
+  ReleaseOps::YardTasks.define
 
-  ruby_with_gemset        = "#{rvm_ruby}@#{gemset_name}"
-  create_gemset_task_name = "mb:#{ns_name}:create_gemset"
-  bundle_task_name        = "mb:#{ns_name}:bundle_install"
-  rspec_task_name         = "mb:#{ns_name}:run_rspec"
-
-  phony_gemfile_link_name = "Gemfile.#{ns_name}"
-  phony_gemfile_lock_name = "#{phony_gemfile_link_name}.lock"
+  ReleaseOps::GemTasks.define('zk-eventmachine.gemspec')
+end
 
-  file phony_gemfile_link_name do
-    # apparently, rake doesn't deal with symlinks intelligently :P
-    ln_s('Gemfile', phony_gemfile_link_name) unless File.symlink?(phony_gemfile_link_name)
-  end
+task 'mb:test_all' => 'zk:test_all'
 
+namespace :yard do
   task :clean do
-    rm_rf [phony_gemfile_lock_name, phony_gemfile_lock_name]
+    rm_rf '.yardoc'
   end
 
-  task create_gemset_task_name do
-    sh "rvm #{rvm_ruby} do rvm gemset create #{gemset_name}" 
+  task :server => :clean do
+    sh "yard server --reload --port=8810"
   end
 
-  task bundle_task_name => [phony_gemfile_link_name, create_gemset_task_name] do
-    sh "rvm #{ruby_with_gemset} do bundle install --gemfile #{phony_gemfile_link_name}"
+  task :gems do
+    sh 'yard server --gems --port=8811'
   end
-
-  task rspec_task_name => bundle_task_name do
-    sh "rvm #{ruby_with_gemset} do env BUNDLE_GEMFILE=#{phony_gemfile_link_name} bundle exec rspec spec --fail-fast"
-  end
-
-  task "mb:#{ns_name}" => rspec_task_name
-
-  task "mb:test_all_rubies" => rspec_task_name
 end
 
-task 'mb:test_all' do
-  require 'benchmark'
-  tm = Benchmark.realtime do
-    Rake::Task['mb:test_all_rubies'].invoke
-  end
+task :clean => 'yard:clean'
 
-  $stderr.puts "Test run took: #{tm}"
-end
 

data/lib/z_k/z_k_event_machine/client.rb

@@ -1,5 +1,29 @@
 module ZK
   module ZKEventMachine
+    # @example use of on_connecting
+    #
+    #   def handle_connecting_event(event=nil)
+    #
+    #     # this (re-)registers this hook for the next time this event is called
+    #     @zkem.on_connecting(&:handle_connecting_event)
+    #
+    #     return unless event     # nil is the initial registration case
+    #
+    #     logger.warn { "Oh no! got a connecting event, taking evasive action!" }
+    #
+    #     # do stuff
+    #   end
+    #
+    #
+    #   # your setup method would then look like
+    #   def run
+    #     @zkem.connect do
+    #       handle_connecting_event
+    #       
+    #       do_the_rest_of_your_stuff
+    #     end
+    #   end
+    #
     class Client < ZK::Client::Base
       include Deferred::Accessors
       include ZK::Logging
@@ -14,6 +38,10 @@ module ZK
       # 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
+      #
+      # @note if you want to be notified when the connection state has not
+      #   become *invalid* but you are in a possibly recoverable state, then
+      #   you should hook the {#on_connecting} method
       # 
       # @method on_connection_lost
       # @return [Deferred::Default]
@@ -43,8 +71,18 @@ module ZK
       #
       # This event is triggered when we have become disconnected from the
       # cluster and are in the process of reconnecting.
+      # 
+      # @note this would more accurately be called `on_disconnection`, but because
+      #   it's fired also when the client is starting up, it has the name it does.
+      #   there's an alias for this `on_disconnection`. (It's not `on_disconnected`
+      #   because the '-ion' seems to indicate that the condition may be temporary)
+      #
+      # @method on_connecting
+      # @return [Deferred::Default]
       deferred_event :connecting
 
+      alias :on_disconnection :on_connecting
+
       # called back once the connection has been closed.
       #
       # @method on_close

data/lib/z_k/z_k_event_machine/version.rb

@@ -1,5 +1,5 @@
 module ZK
   module ZKEventMachine
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/spec/support/logging.rb

@@ -22,7 +22,7 @@ module SpecGlobalLogger
   # sets the log level to FATAL for the duration of the block
   def mute_logger
     orig_level, ZK.logger.level = ZK.logger.level, Logger::FATAL
-    orig_zk_level, Zookeeper.debug_level = Zookeeper.debug_level, ZookeeperConstants::ZOO_LOG_LEVEL_ERROR
+    orig_zk_level, Zookeeper.debug_level = Zookeeper.debug_level, Zookeeper::Constants::ZOO_LOG_LEVEL_ERROR
     yield
   ensure
     ZK.logger.level = orig_level

data/spec/z_k/z_k_event_machine/client_spec.rb

@@ -70,7 +70,7 @@ module ZK::ZKEventMachine
                 logger.debug { "got callback with #{a.inspect}" }
                 a.should_not be_empty
                 a.first.should == @data
-                a.last.should be_instance_of(ZookeeperStat::Stat)
+                a.last.should be_instance_of(Zookeeper::Stat)
                 EM.reactor_thread?.should be_true
                 @zkem.close! { done }
               end
@@ -88,7 +88,7 @@ module ZK::ZKEventMachine
               @zkem.get(@path) do |exc,data,stat|
                 exc.should be_nil
                 data.should == @data
-                stat.should be_instance_of(ZookeeperStat::Stat)
+                stat.should be_instance_of(Zookeeper::Stat)
                 EM.reactor_thread?.should be_true
                 @zkem.close! { done }
               end
@@ -253,7 +253,7 @@ module ZK::ZKEventMachine
               dfr = @zkem.set(@path, @new_data)
 
               dfr.callback do |stat| 
-                stat.should be_instance_of(ZookeeperStat::Stat)
+                stat.should be_instance_of(Zookeeper::Stat)
                 stat.version.should > @orig_stat.version
                 EM.reactor_thread?.should be_true
 
@@ -275,7 +275,7 @@ module ZK::ZKEventMachine
             @zkem.connect do
               @zkem.set(@path, @new_data) do |exc,stat|
                 exc.should be_nil
-                stat.should be_instance_of(ZookeeperStat::Stat)
+                stat.should be_instance_of(Zookeeper::Stat)
                 EM.reactor_thread?.should be_true
 
                 @zkem.get(@path) do |_,data|
@@ -386,7 +386,7 @@ module ZK::ZKEventMachine
               dfr.callback do |stat| 
                 stat.should_not be_nil
                 stat.should == @orig_stat
-                stat.should be_instance_of(ZookeeperStat::Stat)
+                stat.should be_instance_of(Zookeeper::Stat)
                 EM.reactor_thread?.should be_true
                 @zkem.close! { done }
               end
@@ -403,7 +403,7 @@ module ZK::ZKEventMachine
             @zkem.connect do
               @zkem.stat(@path) do |exc,stat|
                 exc.should be_nil
-                stat.should be_instance_of(ZookeeperStat::Stat)
+                stat.should be_instance_of(Zookeeper::Stat)
                 EM.reactor_thread?.should be_true
                 @zkem.close! { done }
               end
@@ -426,7 +426,7 @@ module ZK::ZKEventMachine
               dfr.callback do |stat| 
                 stat.should_not be_nil
                 stat.exists?.should be_false
-                stat.should be_instance_of(ZookeeperStat::Stat)
+                stat.should be_instance_of(Zookeeper::Stat)
                 EM.reactor_thread?.should be_true
                 @zkem.close! { done }
               end
@@ -539,7 +539,7 @@ module ZK::ZKEventMachine
                 children.should include('child_1')
                 children.should include('child_2')
 
-                stat.should be_instance_of(ZookeeperStat::Stat)
+                stat.should be_instance_of(Zookeeper::Stat)
 
                 EM.reactor_thread?.should be_true
                 @zkem.close! { done }
@@ -561,7 +561,7 @@ module ZK::ZKEventMachine
                 children.length.should == 2
                 children.should include('child_1')
                 children.should include('child_2')
-                stat.should be_instance_of(ZookeeperStat::Stat)
+                stat.should be_instance_of(Zookeeper::Stat)
                 EM.reactor_thread?.should be_true
                 @zkem.close! { done }
               end
@@ -621,8 +621,8 @@ module ZK::ZKEventMachine
 
               dfr.callback do |acls,stat| 
                 acls.should be_kind_of(Array)
-                acls.first.should be_kind_of(ZookeeperACLs::ACL)
-                stat.should be_instance_of(ZookeeperStat::Stat)
+                acls.first.should be_kind_of(Zookeeper::ACLs::ACL)
+                stat.should be_instance_of(Zookeeper::Stat)
 
                 EM.reactor_thread?.should be_true
                 @zkem.close! { done }
@@ -641,8 +641,8 @@ module ZK::ZKEventMachine
               @zkem.get_acl(@path) do |exc,acls,stat|
                 exc.should be_nil
                 acls.should be_kind_of(Array)
-                acls.first.should be_kind_of(ZookeeperACLs::ACL)
-                stat.should be_instance_of(ZookeeperStat::Stat)
+                acls.first.should be_kind_of(Zookeeper::ACLs::ACL)
+                stat.should be_instance_of(Zookeeper::Stat)
                 EM.reactor_thread?.should be_true
                 @zkem.close! { done }
               end
@@ -811,6 +811,35 @@ module ZK::ZKEventMachine
           end
         end
       end
+
+      it %[should re-register when the hook in the documentation is used] do
+
+        @perform_count = 0
+
+        hook = proc do |ev|
+          @zkem.on_connecting(&hook)
+
+          if ev
+            @perform_count += 1
+          end
+
+          if @perform_count == 2
+            @zkem.close! { done }
+          end
+        end
+
+        em do
+          hook.call(nil)
+
+          @zkem.connect do
+            event = event_mock(:connecting_event).tap do |ev|
+              ev.should_receive(:state).and_return(Zookeeper::ZOO_CONNECTING_STATE)
+            end
+
+            2.times { EM.next_tick { @zkem.event_handler.process(event) } }
+          end
+        end
+      end
     end # on_connecting
   end # Client
 

data/spec/z_k/z_k_event_machine/event_handler_e_m_spec.rb

@@ -72,7 +72,7 @@ module ZK::ZKEventMachine
             @zkem.children(@path, :watch => true).callback { |ary,stat|
               logger.debug { "called back with: #{ary.inspect}" }
               ary.should be_empty
-              stat.should be_kind_of(ZookeeperStat::Stat)
+              stat.should be_kind_of(Zookeeper::Stat)
 
               @zkem.create(@child_path, '').callback { |p|
                 p.should == @child_path

data/zk-eventmachine.gemspec

@@ -12,10 +12,10 @@ Gem::Specification.new do |s|
   s.summary     = %q{ZK client for EventMachine-based (async) applications}
   s.description = s.description
 
-  s.add_dependency 'zk', '~> 1.0.0'
+  s.add_dependency 'zk', '~> 1.4.1'
 
   # zk depends on slyphon-zookeeper, but we need at least this version
-  s.add_dependency 'slyphon-zookeeper', '~> 0.9.2'
+  s.add_dependency 'zookeeper', '~> 1.1.0'
   s.add_dependency 'eventmachine',      '~> 1.0.0.beta.4'
   s.add_dependency 'deferred',          '~> 0.5.3'
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: zk-eventmachine
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Jonathan D. Simms
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-30 00:00:00 Z
+date: 2012-05-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: zk
@@ -25,28 +25,28 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
+        hash: 5
         segments: 
         - 1
-        - 0
-        - 0
-        version: 1.0.0
+        - 4
+        - 1
+        version: 1.4.1
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: slyphon-zookeeper
+  name: zookeeper
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 63
+        hash: 19
         segments: 
+        - 1
+        - 1
         - 0
-        - 9
-        - 2
-        version: 0.9.2
+        version: 1.1.0
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -57,7 +57,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 2603058889
+        hash: 3300709603
         segments: 
         - 1
         - 0
@@ -98,6 +98,7 @@ files:
 - .dev_extras/rvmrc
 - .dev_extras/slyphon-project.vimrc
 - .gitignore
+- .gitmodules
 - .yardopts
 - Gemfile
 - LICENSE