zk 0.9.1 → 1.0.0.rc.1

metadata

@@ -1,13 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: zk
 version: !ruby/object:Gem::Version 
-  hash: 57
-  prerelease: 
+  hash: 1457112361
+  prerelease: 6
   segments: 
+  - 1
+  - 0
   - 0
-  - 9
+  - rc
   - 1
-  version: 0.9.1
+  version: 1.0.0.rc.1
 platform: ruby
 authors: 
 - Jonathan D. Simms
@@ -16,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-26 00:00:00 Z
+date: 2012-04-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: slyphon-zookeeper
@@ -26,12 +28,12 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 61
+        hash: 63
         segments: 
         - 0
-        - 8
-        - 1
-        version: 0.8.1
+        - 9
+        - 2
+        version: 0.9.2
   type: :runtime
   version_requirements: *id001
 description: |
@@ -57,30 +59,32 @@ files:
 - README.markdown
 - RELEASES.markdown
 - Rakefile
-- lib/z_k.rb
-- lib/z_k/client.rb
-- lib/z_k/client/base.rb
-- lib/z_k/client/continuation_proxy.rb
-- lib/z_k/client/conveniences.rb
-- lib/z_k/client/drop_box.rb
-- lib/z_k/client/multiplexed.rb
-- lib/z_k/client/state_mixin.rb
-- lib/z_k/client/threaded.rb
-- lib/z_k/client/unixisms.rb
-- lib/z_k/election.rb
-- lib/z_k/event_handler.rb
-- lib/z_k/event_handler_subscription.rb
-- lib/z_k/exceptions.rb
-- lib/z_k/extensions.rb
-- lib/z_k/find.rb
-- lib/z_k/locker.rb
-- lib/z_k/logging.rb
-- lib/z_k/message_queue.rb
-- lib/z_k/mongoid.rb
-- lib/z_k/pool.rb
-- lib/z_k/threadpool.rb
-- lib/z_k/version.rb
+- docs/examples/block_until_node_deleted_ex.rb
+- docs/examples/events_01.rb
+- docs/examples/events_02.rb
 - lib/zk.rb
+- lib/zk/client.rb
+- lib/zk/client/base.rb
+- lib/zk/client/conveniences.rb
+- lib/zk/client/state_mixin.rb
+- lib/zk/client/threaded.rb
+- lib/zk/client/unixisms.rb
+- lib/zk/core_ext.rb
+- lib/zk/election.rb
+- lib/zk/event.rb
+- lib/zk/event_handler.rb
+- lib/zk/event_handler_subscription.rb
+- lib/zk/exceptions.rb
+- lib/zk/extensions.rb
+- lib/zk/find.rb
+- lib/zk/locker.rb
+- lib/zk/logging.rb
+- lib/zk/message_queue.rb
+- lib/zk/mongoid.rb
+- lib/zk/pool.rb
+- lib/zk/stat.rb
+- lib/zk/threadpool.rb
+- lib/zk/version.rb
 - spec/informal/close-in-event-thread.rb
 - spec/informal/lock_with_dead_session.rb
 - spec/informal/what-the-fork.rb
@@ -90,6 +94,8 @@ files:
 - spec/shared/client_examples.rb
 - spec/spec_helper.rb
 - spec/support/bogus_mongoid.rb
+- spec/support/event_catcher.rb
+- spec/support/exist_matcher.rb
 - spec/support/logging.rb
 - spec/support/logging_progress_bar_formatter.rb
 - spec/support/queuey_thread.rb
@@ -97,16 +103,15 @@ files:
 - spec/support/wait_watchers.rb
 - spec/test_file.txt
 - spec/watch_spec.rb
-- spec/z_k/client/drop_box_spec.rb
-- spec/z_k/client/locking_and_session_death_spec.rb
-- spec/z_k/client/multiplexed_spec.rb
-- spec/z_k/client_spec.rb
-- spec/z_k/election_spec.rb
-- spec/z_k/extensions_spec.rb
-- spec/z_k/locker_spec.rb
-- spec/z_k/mongoid_spec.rb
-- spec/z_k/pool_spec.rb
-- spec/z_k/threadpool_spec.rb
+- spec/zk/client/locking_and_session_death_spec.rb
+- spec/zk/client_spec.rb
+- spec/zk/election_spec.rb
+- spec/zk/extensions_spec.rb
+- spec/zk/locker_spec.rb
+- spec/zk/module_spec.rb
+- spec/zk/mongoid_spec.rb
+- spec/zk/pool_spec.rb
+- spec/zk/threadpool_spec.rb
 - spec/zookeeper_spec.rb
 - zk.gemspec
 homepage: https://github.com/slyphon/zk
@@ -129,12 +134,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: 
@@ -152,6 +159,8 @@ test_files:
 - spec/shared/client_examples.rb
 - spec/spec_helper.rb
 - spec/support/bogus_mongoid.rb
+- spec/support/event_catcher.rb
+- spec/support/exist_matcher.rb
 - spec/support/logging.rb
 - spec/support/logging_progress_bar_formatter.rb
 - spec/support/queuey_thread.rb
@@ -159,14 +168,13 @@ test_files:
 - spec/support/wait_watchers.rb
 - spec/test_file.txt
 - spec/watch_spec.rb
-- spec/z_k/client/drop_box_spec.rb
-- spec/z_k/client/locking_and_session_death_spec.rb
-- spec/z_k/client/multiplexed_spec.rb
-- spec/z_k/client_spec.rb
-- spec/z_k/election_spec.rb
-- spec/z_k/extensions_spec.rb
-- spec/z_k/locker_spec.rb
-- spec/z_k/mongoid_spec.rb
-- spec/z_k/pool_spec.rb
-- spec/z_k/threadpool_spec.rb
+- spec/zk/client/locking_and_session_death_spec.rb
+- spec/zk/client_spec.rb
+- spec/zk/election_spec.rb
+- spec/zk/extensions_spec.rb
+- spec/zk/locker_spec.rb
+- spec/zk/module_spec.rb
+- spec/zk/mongoid_spec.rb
+- spec/zk/pool_spec.rb
+- spec/zk/threadpool_spec.rb
 - spec/zookeeper_spec.rb

data/lib/z_k/client/continuation_proxy.rb

@@ -1,109 +0,0 @@
-module ZK
-  module Client
-    # Wraps calls to zookeeper so that the requests are made asynchronously,
-    # but still provides a blocking API
-    #
-    # @private
-    class ContinuationProxy
-      include ZK::Logging
-
-      attr_accessor :zookeeper_cnx
-
-      # @private
-      def self.call_with_continuation(*syms)
-        syms.each do |sym|
-          class_eval(<<-EOS, __FILE__, __LINE__+1)
-            def #{sym}(opts)
-              logger.debug { "_call_continue(#{sym.inspect}, \#{opts.inspect})" }
-              _call_continue(#{sym.inspect}, opts)
-            end
-          EOS
-        end
-      end
-
-      call_with_continuation :get, :set, :stat, :children, :delete, :get_acl, :set_acl
-
-      def initialize(zookeeper_cnx=nil)
-        @zookeeper_cnx = zookeeper_cnx
-        @mutex = Mutex.new
-        @dropboxen = []
-      end
-
-      # create is "special" because the return hash doesn't have a :path, it has a :string
-      def create(opts)
-        logger.debug { "_call_continue(create, #{opts.inspect})" }
-        _call_continue(:create, opts).tap do |rval|
-          rval[:path] = rval.delete(:string)
-        end
-      end
-
-      # called by the multiplxed client to wake up threads that are waiting for
-      # results (with an exception)
-      # @private
-      def connection_closed!
-        _oh_noes(ZookeeperExceptions::ZookeeperException::NotConnected, 'connection closed')
-      end
-
-      # called by the multiplxed client to wake up threads that are waiting for
-      # results (with an exception)
-      # @private
-      def expired_session!
-        _oh_noes(ZookeeperExceptions::ZookeeperException::SessionExpired, 'session expired')
-      end
-
-      private
-        def method_missing(m, *a, &b)
-          @zookeeper_cnx.respond_to?(m) ? @zookeeper_cnx.__send__(m, *a, &b) : super
-        end
-
-        def _oh_noes(exception, message)
-          @mutex.synchronize do
-            @dropboxen.each do |db|
-              db.oh_noes!(exception, message)
-            end
-          end
-        end
-
-        # not really callcc, but close enough
-        # opts should be an options hash as passed through to the Zookeeper
-        # layer
-        def _call_continue(meth, opts)
-          _assert_not_async!(meth, opts)
-
-          opts = opts.dup
-
-          _with_drop_box do |db|
-            cb = lambda do |hash|
-#               logger.debug { "#{self.class}##{__method__} block pushing: #{hash.inspect}" } 
-              db.push(hash)
-            end
-
-            opts[:callback] = cb
-
-            @zookeeper_cnx.__send__(meth, opts)
-
-#             db.pop.tap do |obj|
-#               logger.debug { "#{self.class}##{__method__} popped and returning: #{obj.inspect}" } 
-#             end
-            
-            db.pop
-          end
-        end
-
-        def _with_drop_box
-          db = DropBox.current
-          @mutex.synchronize { @dropboxen << db }
-          yield db
-        ensure
-          @mutex.synchronize { @dropboxen.delete(db) }
-          db.clear
-        end
-
-        def _assert_not_async!(meth, opts)
-          return unless opts.has_key?(:callback)
-          raise ArgumentError, "you cannot use async callbacks with a Multiplexed client! meth: #{meth.inspect}, opts: #{opts.inspect}"
-        end
-    end # ContinuationProxy
-  end
-end
-

data/lib/z_k/client/drop_box.rb

@@ -1,98 +0,0 @@
-module ZK
-  module Client
-    # A simple threadsafe way of having a thread deliver a single value
-    # to another thread. 
-    #
-    # Each thread making requests will have a thread-local continuation
-    # that can be accessed via DropBox.current and one can use
-    # DropBox.with_current that will clear the result once the given block
-    # exits (allowing for reuse)
-    #
-    # (this class is in no way related to dropbox.com or Dropbox Inc.)
-    # @private
-    class DropBox
-      UNDEFINED = Object.new              unless defined?(UNDEFINED)
-      KILL_TOKEN = Object.new             unless defined?(KILL_TOKEN)
-      IMPOSSIBLE_TO_CONTINUE = Object.new unless defined?(IMPOSSIBLE_TO_CONTINUE)
-
-      # represents an exception to raise. if the pop method sees the value as an instance
-      # of this class, it will call the raise! method
-      class ExceptionValue
-        def initialize(exception_class, message)
-          @exception_class, @message = exception_class, message
-        end
-
-        def raise!
-          raise @exception_class, @message
-        end
-      end
-
-      THREAD_LOCAL_KEY = :__zk_client_continuation_current__ unless defined?(THREAD_LOCAL_KEY)
-
-      # @private
-      attr_reader :value
-
-      # sets the thread-local instance to nil, used by tests
-      # @private
-      def self.remove_current
-        Thread.current[THREAD_LOCAL_KEY] = nil
-      end
-
-      # access the thread-local DropBox instance for the current thread
-      def self.current
-        Thread.current[THREAD_LOCAL_KEY] ||= self.new()
-      end
-
-      # yields the current thread's DropBox instance and clears its value
-      # after the block returns
-      def self.with_current
-        yield current
-      ensure
-        current.clear
-      end
-
-      def initialize
-        @mutex = Mutex.new
-        @cond = ConditionVariable.new
-        @value = UNDEFINED  # allows us to return nil
-      end
-
-      def push(obj)
-        @mutex.synchronize do
-          @value = obj
-          @cond.signal
-        end
-      end
-
-      def pop
-        @mutex.synchronize do
-          @cond.wait(@mutex)
-          @value.kind_of?(ExceptionValue) ? @value.raise! : @value
-        end
-      end
-
-      def clear
-        @mutex.synchronize do
-          @value = UNDEFINED
-        end
-      end
-
-      # we are done if value is defined, use clear to reset
-      def done?
-        @value != UNDEFINED
-      end
-
-      # called when you need the waiting thread to receive an exception
-      # returns nil if a value has already been set
-      def oh_noes!(exception_class, message)
-        @mutex.synchronize do
-          return if done?
-          @value = ExceptionValue.new(exception_class, message)
-          @cond.signal
-        end
-        true
-      end
-    end
-  end
-end
-

data/lib/z_k/client/multiplexed.rb

@@ -1,28 +0,0 @@
-module ZK
-  module Client
-    # This client is an experimental implementation of a threaded and
-    # multiplexed client. The idea is that each synchronous request represents 
-    # a continuation. This way, you can have multiple requests pending with the
-    # server simultaneously, and the responses will be delivered on the event
-    # thread (but run in the calling thread). This allows for higher throughput
-    # for multi-threaded applications.
-    #
-    # Asynchronous requests are not supported through this client.
-    #
-    class Multiplexed < Threaded
-      def close!
-        @cnx.connection_closed!
-        super
-      end
-
-      protected
-        def create_connection(*args)
-          ContinuationProxy.new.tap do |cp|
-            on_expired_session { cp.expired_session! } # hook up client's session expired event listener
-            cp.zookeeper_cnx = super(*args)
-          end
-        end
-    end
-  end
-end
-

data/lib/z_k/client/threaded.rb

@@ -1,76 +0,0 @@
-module ZK
-  module Client
-    # This is the default client that ZK will use. In the zk-eventmachine gem,
-    # there is an Evented client.
-    #
-    class Threaded < Base
-      include StateMixin
-      include Unixisms
-      include Conveniences
-
-      DEFAULT_THREADPOOL_SIZE = 1
-
-      # @note The `:timeout` argument here is *not* the session_timeout for the
-      #   connection. rather it is the amount of time we wait for the connection
-      #   to be established. The session timeout exchanged with the server is 
-      #   set to 10s by default in the C implemenation, and as of version 0.8.0 
-      #   of slyphon-zookeeper has yet to be exposed as an option. That feature
-      #   is planned. 
-      #
-      # @param [String] host (see ZK::Client::Base#initialize)
-      #
-      # @option opts [Fixnum] :threadpool_size the size of the threadpool that
-      #   should be used to deliver events. In ZK 0.8.x this was set to 5, which
-      #   means that events could be delivered concurrently. As of 0.9, this will
-      #   be set to 1, so it's very important to _not block the event thread_.
-      #
-      # @option opts [Fixnum] :timeout how long we will wait for the connection
-      #   to be established. 
-      #
-      # @yield [self] calls the block with the new instance after the event
-      #   handler has been set up, but before any connections have been made.
-      #   This allows the client to register watchers for session events like
-      #   `connected`. You *cannot* perform any other operations with the client 
-      #   as you will get a NoMethodError (the underlying connection is nil).
-      #
-      def initialize(host, opts={}, &b)
-        super(host, opts)
-
-        @session_timeout = opts.fetch(:timeout, DEFAULT_TIMEOUT) # maybe move this into superclass?
-        @event_handler   = EventHandler.new(self)
-
-        yield self if block_given?
-
-        @cnx = create_connection(host, @session_timeout, @event_handler.get_default_watcher_block)
-
-        tp_size = opts.fetch(:threadpool_size, DEFAULT_THREADPOOL_SIZE)
-
-        @threadpool = Threadpool.new(tp_size)
-      end
-
-      # @see ZK::Client::Base#close!
-      def close!
-        if event_dispatch_thread?
-          msg = ["ZK ERROR: You called #{self.class}#close! on the event dispatch thread!!",
-                 "This will cause the client to deadlock and possibly your main thread as well!"]
-
-          warn_msg = [nil, msg, nil, "See ZK error log output (stderr by default) for a backtrace", nil].join("\n")
-
-          Kernel.warn(warn_msg)
-          assert_we_are_not_on_the_event_dispatch_thread!(msg.join(' '))
-        end
-
-        @threadpool.shutdown
-        super
-        nil
-      end
-
-      protected
-        # allows for the Mutliplexed client to wrap the connection in its ContinuationProxy
-        # @private
-        def create_connection(*args)
-          ::Zookeeper.new(*args)
-        end
-    end
-  end
-end

data/lib/z_k/client.rb

@@ -1,35 +0,0 @@
-module ZK
-  # A ruby-friendly wrapper around the low-level zookeeper drivers. This is the
-  # class that you will likely interact with the most. 
-  #
-  # @todo ACL support is pretty much unused currently. 
-  #   If anyone has suggestions, hints, use-cases, examples, etc. by all means please file a bug.
-  #
-  module Client
-    DEFAULT_TIMEOUT = 10
-
-    # @private
-    STATE_SYM_MAP = {
-      Zookeeper::ZOO_CLOSED_STATE           => :closed,
-      Zookeeper::ZOO_EXPIRED_SESSION_STATE  => :expired_session,
-      Zookeeper::ZOO_AUTH_FAILED_STATE      => :auth_failed,
-      Zookeeper::ZOO_CONNECTING_STATE       => :connecting,
-      Zookeeper::ZOO_CONNECTED_STATE        => :connected,
-      Zookeeper::ZOO_ASSOCIATING_STATE      => :associating,
-    }.freeze
-
-    def self.new(*a, &b)
-      Threaded.new(*a, &b)
-    end
-  end
-end
-
-require 'z_k/client/drop_box'
-require 'z_k/client/state_mixin'
-require 'z_k/client/unixisms'
-require 'z_k/client/conveniences'
-require 'z_k/client/base'
-require 'z_k/client/threaded'
-require 'z_k/client/continuation_proxy'
-require 'z_k/client/multiplexed'
-

data/lib/z_k/event_handler_subscription.rb

@@ -1,36 +0,0 @@
-module ZK
-  # the subscription object that is passed back from subscribing
-  # to events.
-  # @see ZK::Client::Base#register
-  class EventHandlerSubscription
-    # the event handler associated with this subscription
-    # @return [EventHandler]
-    attr_accessor :event_handler
-
-    # the path this subscription is for
-    # @return [String]
-    attr_accessor :path
-    
-    # the block associated with the path
-    # @return [Proc]
-    attr_accessor :callback
-
-    # @private
-    def initialize(event_handler, path, callback)
-      @event_handler, @path, @callback = event_handler, path, callback
-    end
-
-    # unsubscribe from the path or state you were watching
-    # @see ZK::Client::Base#register
-    def unsubscribe
-      @event_handler.unregister(self)
-    end
-    alias :unregister :unsubscribe
-
-    # @private
-    def call(event)
-      callback.call(event)
-    end
-  end
-end
-