zk 1.9.6 → 1.10.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YWUxMzk1MjRkMmFhZjEyMDg2OTA1ODQ3NTQxYjBiNWNjODc4OGQ3ZA==
-  data.tar.gz: !binary |-
-    NjViMTA4YTA1YTUxYTA4ZWJiMTA4Y2JiNDIxMGMyZDVkZjY5ZmMyMw==
+SHA256:
+  metadata.gz: c011796ca41504b7a8618ce83fe5eb497422160ce4cee31e7ab1ed45c208bb12
+  data.tar.gz: fe7d1be9ed832ba2f3bb41d89e3e945cabc52cdd01fe62ff09a79ae79802b93c
 SHA512:
-  metadata.gz: !binary |-
-    N2UwYzk3YTMxY2M1ZGFiNGU4ZjgwMmEyYjVjNTQ2MzIxNWRhZWNiNmUzMjIz
-    ZjVhZTZmNTkyMmE3MDRhMTFlODY4MTM0MDBkMWY3MWQxNDRlNjA1OTVkOGQy
-    NjU2YTU2ODIwZGEzY2Y2YTg4MjlkY2FjNGY3NTgzYWNjOTI1ZTQ=
-  data.tar.gz: !binary |-
-    NjY5YTA0MzRkMDEwMTQzYzAxYjRjODZiOTlkNGMwZmQ0MTI4MzhlOGJiODgx
-    ZGVhODY2YWQzM2I5NzJkZDgwNzMwZDBkMTZmMmU5N2IxY2VlYTg4M2ExMzcx
-    NGZjM2QwMjhhMzRkYWY2OTA4OWI5YTA2YTdkMmJiNDllODM2ZmQ=
+  metadata.gz: 5689fd5376c5378d03617f95d9443279a708ad7b8090bf555de9c85b813b76663d9a0d76d4f29eb32cd1ac398b28265168f1a5e87ddbd08457eb0f55cf83c0cd
+  data.tar.gz: 941e497e7f174e6420bab78d45f320d6939f892ed06b26473d38c8c4b3e68608d7f93f2f53f911bdf680b0cdb5a9801e0c1af5722096c50ad8645a81e80e3f19

data/.github/workflows/build.yml

@@ -0,0 +1,55 @@
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    name: Ruby ${{ matrix.ruby }} / GCC ${{ matrix.gcc }} / ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu-latest
+          - macos-latest
+        ruby:
+          - 2.5
+          - 2.6
+          - 2.7
+          - jruby-9.1.17.0
+          - jruby
+        gcc:
+          - 7
+          - latest
+        exclude:
+          - os: macos-latest
+            gcc: 7
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+
+      - name: Set up GCC
+        if: ${{ matrix.gcc != 'latest' }}
+        uses: egor-tensin/setup-gcc@v1
+        with:
+          version: ${{ matrix.gcc }}
+          platform: x64
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run Tests
+        env:
+          RAILS_ENV: test
+          SPAWN_ZOOKEEPER: true
+        run: |
+          bundle exec rake

data/Gemfile

@@ -12,11 +12,16 @@ source "https://rubygems.org"
 #   gem 'zookeeper', '~> 1.3.0'
 # end
 
-gem 'rake', :group => [:development, :test]
-gem 'pry',  :group => [:development]
+group :development, :test do
+  if RUBY_VERSION >= '1.9.3'
+    gem 'rake'
+  else
+    gem 'rake', '~> 10.5'
+  end
+end
 
 group :docs do
-  gem 'yard', '~> 0.8.0'
+  gem 'yard', '>= 0.9.20'
 
   platform :mri_19 do
     gem 'redcarpet'
@@ -37,13 +42,17 @@ group :development do
     gem 'growl',       :require => false
     gem 'rb-readline', :platform => :ruby
   end
+
+  platform :mri do
+    gem 'pry-byebug'
+  end
 end
 
 group :test do
-  gem 'rspec', '~> 2.8.0'
-  gem 'flexmock', '~> 0.8.10'
+  gem 'pry'
+  gem 'rspec', '~> 3.6.0'
   gem 'zk-server', '~> 1.1.4'
-  gem 'test-unit', :platforms => [:ruby_22]
+  gem 'test-unit', :platforms => [:ruby_22, :ruby_23, :ruby_24]
 end
 
 # Specify your gem's dependencies in zk.gemspec

data/README.markdown

@@ -1,10 +1,10 @@
 # ZK #
 
-[![Build Status (master)](https://secure.travis-ci.org/zk-ruby/zk.png?branch=master)](http://travis-ci.org/zk-ruby/zk)
+![Build Status](https://github.com/zk-ruby/zk/actions/workflows/build.yml/badge.svg)
 
-ZK is an application programmer's interface to the Apache [ZooKeeper][] server. It is based on the [zookeeper gem][] which is a multi-Ruby low-level driver. Currently MRI 1.8.7, 1.9.2, 1.9.3, REE, and JRuby are supported. Rubinius 2.0.testing is supported-ish (it's expected to work, but upstream is unstable, so YMMV). 
+ZK is an application programmer's interface to the Apache [ZooKeeper][] server. It is based on the [zookeeper gem][] which is a multi-Ruby low-level driver. Currently MRI 1.8.7, 1.9.2, 1.9.3, REE, and JRuby are supported. Rubinius 2.0.testing is supported-ish (it's expected to work, but upstream is unstable, so YMMV).
 
-ZK is licensed under the [MIT][] license. 
+ZK is licensed under the [MIT][] license.
 
 The key place to start in the documentation is with ZK::Client::Base ([rubydoc.info][ZK::Client::Base], [local](/docs/ZK/Client/Base)).
 
@@ -27,11 +27,11 @@ ZooKeeper is a multi-purpose tool that is designed to allow you to write code th
 
 One of the most useful aspects of ZooKeeper is the ability to set "[watches][]" on nodes. This allows one to be notified when a node has been deleted, created, changed, or has had its list of child znodes modified. The asynchronous nature of these watches enables you to write code that can _react_ to changes in your environment without polling and busy-waiting.
 
-Znodes can be _ephemeral_, which means that when the connection that created them goes away, they're automatically cleaned up, and all the clients that were watching them are notified of the deletion. This is an incredibly useful mechanism for providing _presence_ in a cluster ("which of my thingamabobers are up?). If you've ever run across a stale pid file or lock, you can imagine how useful this feature can be. 
+Znodes can be _ephemeral_, which means that when the connection that created them goes away, they're automatically cleaned up, and all the clients that were watching them are notified of the deletion. This is an incredibly useful mechanism for providing _presence_ in a cluster ("which of my thingamabobers are up?). If you've ever run across a stale pid file or lock, you can imagine how useful this feature can be.
 
 Znodes can also be created as _sequence_ nodes, which means that beneath a given path, a node can be created with a given prefix and assigned a unique integer. This, along with the _ephemeral_ property, provide the basis for most of the coordination classes such as [groups][] and [locks][].
 
-ZooKeeper is easy to deploy in a [Highly Available][ha-config] configuration, and the clients natively understand the clustering and how to resume a session transparently when one of the cluster nodes goes away. 
+ZooKeeper is easy to deploy in a [Highly Available][ha-config] configuration, and the clients natively understand the clustering and how to resume a session transparently when one of the cluster nodes goes away.
 
 [watches]: http://zookeeper.apache.org/doc/current/zookeeperProgrammers.html#ch_zkWatches
 [locking]: http://zookeeper.apache.org/doc/current/recipes.html#sc_recipes_Locks
@@ -64,7 +64,7 @@ In addition to all of that, I would like to think that the public API the ZK::Cl
 [EventMachine]: https://github.com/eventmachine/eventmachine
 [zk-eventmachine]: https://github.com/zk-ruby/zk-eventmachine
 
-## Release info / Changelog 
+## Release info / Changelog
 
 See the [RELEASES][] page for more info on features and bugfixes in each release.
 
@@ -74,9 +74,9 @@ ZK strives to be a complete, correct, and convenient way of interacting with Zoo
 
 * In versions < 0.9 there is only *one* event dispatch thread. It is *very important* that you don't block the event delivery thread. In 1.0, there is one delivery thread by default, but you can adjust the level of concurrency, allowing more control and convenience for building your event-driven app.
 
-* ZK uses threads. You will have to use synchronization primitives if you want to avoid getting hurt. There are use cases that do not require you to think about this, but as soon as you want to register for events, you're using multiple threads. 
+* ZK uses threads. You will have to use synchronization primitives if you want to avoid getting hurt. There are use cases that do not require you to think about this, but as soon as you want to register for events, you're using multiple threads.
 
-* If you're not familiar with developing solutions with zookeeper, you should read about [sessions][] and [watches][] in the Programmer's Guide. Even if you *are* familiar, you should probably go read it again. 
+* If you're not familiar with developing solutions with zookeeper, you should read about [sessions][] and [watches][] in the Programmer's Guide. Even if you *are* familiar, you should probably go read it again.
 
 * It is very important that you not ignore connection state events if you're using watches.
 
@@ -88,7 +88,7 @@ ZK strives to be a complete, correct, and convenient way of interacting with Zoo
 [async-branch]: https://github.com/zk-ruby/zk/tree/dev%2Fasync-conveniences
 [chroot]: http://zookeeper.apache.org/doc/current/zookeeperProgrammers.html#ch_zkSessions
 [YARD]: http://yardoc.org/
-[sessions]: http://zookeeper.apache.org/doc/current/zookeeperProgrammers.html#ch_zkSessions 
+[sessions]: http://zookeeper.apache.org/doc/current/zookeeperProgrammers.html#ch_zkSessions
 [watches]: http://zookeeper.apache.org/doc/r3.3.5/zookeeperProgrammers.html#ch_zkWatches
 
 ## Users

data/RELEASES.markdown

@@ -1,5 +1,14 @@
 This file notes feature differences and bugfixes contained between releases.
 
+### v1.10.0 ###
+
+* Updates dependency on zookeeper gem to 1.5.0 #90 (h/t: @malmckay)
+* Move build to Github Actions, drop support for older Rubies (#104) (h/t: @malmckay)
+* bump yard revision to ~> 0.9.11 (Fixes #101) (#102) (h/t: @slyphon)
+* Add other Ruby versions with currently breaking tests (h/t: @berlincount)
+* RSpec 3 support and cleanups (h/t: @nerdrew)
+* Interrupt blocked locker (h/t: @lmarburger)
+
 ### v1.9.6 ###
 
 * Fixes from @rickypai for ruby 2.2 (#89)
@@ -259,7 +268,7 @@ You are __STRONGLY ENCOURAGED__ to go and look at the [CHANGELOG](http://git.io/
 * add zk.register(:all) to recevie node updates for all nodes (i.e. not filtered on path)
 
 * add 'interest' feature to zk.register, now you can indicate what kind of events should be delivered to the given block (previously you had to do that filtering inside the block). The default behavior is still the same, if no 'interest' is given, then all event types for the given path will be delivered to that block.
-  
+
     zk.register('/path', :created) do |event|
       # event.node_created? will always be true
     end

data/lib/zk/client.rb

@@ -6,7 +6,7 @@ module ZK
   # Once you've had a look there, take a look at {Client::Conveniences},
   # {Client::StateMixin}, and {Client::Unixisms}
   #
-  # @todo ACL support is pretty much unused currently. 
+  # @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

data/lib/zk/event_handler.rb

@@ -36,7 +36,7 @@ module ZK
       @mutex = nil
       @setup_watcher_mutex = nil
 
-      @callbacks = Hash.new { |h,k| h[k] = [] }
+      @callbacks = Hash.new
 
       @outstanding_watches = VALID_WATCH_TYPES.inject({}) do |h,k|
         h.tap { |x| x[k] = Set.new }
@@ -84,7 +84,9 @@ module ZK
       end
 
       EventHandlerSubscription.new(self, path, block, hash).tap do |subscription|
-        synchronize { @callbacks[path] << subscription }
+        synchronize do
+          (@callbacks[path] ||= []) << subscription
+        end
       end
     end
     alias :subscribe :register
@@ -131,15 +133,21 @@ module ZK
         subscription = args[1]
       else
         path, index = args[0..1]
-        synchronize { @callbacks[path][index] = nil }
+        synchronize do
+          if @callbacks[path] && @callbacks[path][index]
+            @callbacks[path][index] = nil
+          end
+        end
         return
       end
 
       synchronize do
-        ary = @callbacks[subscription.path]
-
-        idx = ary.index(subscription) and ary.delete_at(idx)
-        @callbacks.delete(subscription.path) if ary.empty?
+        if ary = @callbacks[subscription.path]
+          idx = ary.index(subscription) and ary.delete_at(idx)
+          if ary.empty?
+            @callbacks.delete(subscription.path)
+          end
+        end
       end
 
       nil

data/lib/zk/fork_hook.rb

@@ -3,13 +3,13 @@ module ZK
     include ZK::Logger
     extend self
 
-    @mutex = Mutex.new unless @mutex
+    @mutex = Mutex.new unless defined?(@mutex)
 
     @hooks = {
       :prepare      => [],
       :after_child  => [],
       :after_parent => [],
-    } unless @hooks
+    } unless defined?(@hooks)
 
     attr_reader :hooks, :mutex
 

data/lib/zk/locker/locker_base.rb

@@ -291,6 +291,19 @@ module ZK
         false
       end
 
+      # interrupt caller blocked on acquring a lock by delegating to
+      # ZK::NodeDeletionWatcher#interrupt!
+      #
+      # this does nothing if the watcher is not currently blocked.
+      #
+      # @raise [WakeUpException] raised when caller interrupted
+      #
+      def interrupt!
+        synchronize do
+          @node_deletion_watcher and @node_deletion_watcher.interrupt!
+        end
+      end
+
       private
         def synchronize
           @mutex.synchronize { yield }

data/lib/zk/locker/semaphore.rb

@@ -2,8 +2,6 @@ module ZK
   module Locker
     # A semaphore implementation
     class Semaphore < LockerBase
-      include Exceptions
-
       @default_root_node = '/_zksemaphore'.freeze unless @default_root_node
 
       class << self
@@ -13,7 +11,7 @@ module ZK
       end
 
       def initialize(client, name, semaphore_size, root_node=nil)
-        raise BadArgument, <<-EOMESSAGE unless semaphore_size.kind_of? Integer
+        raise ZK::Exceptions::BadArguments, <<-EOMESSAGE unless semaphore_size.kind_of? Integer
           semaphore_size must be Integer, not #{semaphore_size.inspect}
         EOMESSAGE
 

data/lib/zk/node_deletion_watcher.rb

@@ -1,7 +1,6 @@
 module ZK
   class NodeDeletionWatcher
     include Zookeeper::Constants
-    include Exceptions
     include Logger
 
     # @private
@@ -42,7 +41,7 @@ module ZK
       @paths      = paths.dup
       @options    = options.dup
       @threshold  = options[:threshold] || 0
-      raise BadArgument, <<-EOBADARG unless @threshold.kind_of? Integer
+      raise ZK::Exceptions::BadArguments, <<-EOBADARG unless @threshold.kind_of? Integer
         options[:threshold] must be an Integer. Got #{@threshold.inspect}."
       EOBADARG
 
@@ -89,7 +88,7 @@ module ZK
         start = Time.now
         time_to_stop = timeout ? (start + timeout) : nil
 
-        logger.debug { "#{__method__} @blocked: #{@blocked.inspect} about to wait" } 
+        logger.debug { "#{__method__} @blocked: #{@blocked.inspect} about to wait" }
         @cond.wait(timeout)
 
         if (time_to_stop and (Time.now > time_to_stop)) and (@blocked == NOT_YET)
@@ -101,7 +100,7 @@ module ZK
     end
 
     # cause a thread blocked by us to be awakened and have a WakeUpException
-    # raised. 
+    # raised.
     #
     # if a result has already been delivered, then this does nothing
     #

data/lib/zk/pool.rb

@@ -1,18 +1,18 @@
 module ZK
   module Pool
-    # Base class for a ZK connection pool. There are some applications that may 
+    # Base class for a ZK connection pool. There are some applications that may
     # require high synchronous throughput, which would be a suitable use for a
     # connection pool. The ZK::Client::Threaded class is threadsafe, so it's
     # not a problem accessing it from multiple threads, but it is limited to
     # one outgoing synchronous request at a time, which could cause throughput
-    # issues for apps that are making very heavy use of zookeeper. 
+    # issues for apps that are making very heavy use of zookeeper.
     #
     # The problem with using a connection pool is the added complexity when you
     # try to use watchers. It may be possible to register a watch with one
     # connection, and then call `:watch => true` on a different connection if
     # you're not careful. Events delivered as part of an event handler have a
     # `zk` attribute which can be used to access the connection that the
-    # callback is registered with. 
+    # callback is registered with.
     #
     # Unless you're sure you *need* a connection pool, then avoid the added
     # complexity.
@@ -27,7 +27,7 @@ module ZK
 
         @mutex  = Monitor.new
         @checkin_cond = @mutex.new_cond
-        
+
         @connections = []     # all connections we control
         @pool = []            # currently available connections
 
@@ -58,7 +58,7 @@ module ZK
 
       # close all the connections on the pool
       def close_all!
-        @mutex.synchronize do 
+        @mutex.synchronize do
           return unless open?
           @state = :closing
 
@@ -86,7 +86,7 @@ module ZK
 
           @state = :closed
 
-          # free any waiting 
+          # free any waiting
           @checkin_cond.broadcast
         end
       end
@@ -146,7 +146,7 @@ module ZK
         end
 
         def assert_open!
-          raise Exceptions::PoolIsShuttingDownException, "pool is shutting down" unless open? 
+          raise Exceptions::PoolIsShuttingDownException, "pool is shutting down" unless open?
         end
 
     end # Base
@@ -211,7 +211,7 @@ module ZK
         @mutex.synchronize { @count_waiters }
       end
 
-      def checkout(blocking=true) 
+      def checkout(blocking=true)
         raise ArgumentError, "checkout does not take a block, use .with_connection" if block_given?
         @mutex.lock
         begin
@@ -224,7 +224,7 @@ module ZK
               # XXX(slyphon): not really sure how this case happens, but protect against it as we're
               # seeing an issue in production
               next if cnx.nil?
-              
+
               # if the connection isn't connected, then set up an on_connection
               # handler and try the next one in the pool
               unless cnx.connected?
@@ -263,7 +263,7 @@ module ZK
         def add_connection!
           @mutex.synchronize do
             cnx = create_connection
-            @connections << cnx 
+            @connections << cnx
 
             handle_checkin_on_connection(cnx)
           end # synchronize
@@ -281,7 +281,7 @@ module ZK
             else
               @on_connected_subs.synchronize do
 
-                sub = cnx.on_connected do 
+                sub = cnx.on_connected do
                   # this synchronization is to prevent a race between setting up the subscription
                   # and assigning it to the @on_connected_subs hash. It's possible that the callback
                   # would fire before we had a chance to add the sub to the hash.

data/lib/zk/version.rb

@@ -1,3 +1,3 @@
 module ZK
-  VERSION = "1.9.6"
+  VERSION = "1.10.0"
 end

data/spec/event_catcher_spec.rb

@@ -25,7 +25,7 @@ describe EventCatcher do
 
       subject.add(:created, 'blah')
 
-      th.join(2).value.should be_true
+      expect(th.join(2).value).to be(true)
     end
   end
 end

data/spec/message_queue_spec.rb

@@ -22,35 +22,35 @@ describe ZK::MessageQueue do
   it "should be able to receive a published message" do
     message_received = false
     @consume_queue.subscribe do |title, data|
-      data.should == 'mydata'
+      expect(data).to eq('mydata')
       message_received = true
     end
     @publish_queue.publish("mydata")
     wait_until {message_received }
-    message_received.should be_true
+    expect(message_received).to be(true)
   end
 
   it "should be able to receive a custom message title" do
     message_title = false
     @consume_queue.subscribe do |title, data|
-      title.should == 'title'
+      expect(title).to eq('title')
       message_title = true
     end
     @publish_queue.publish("data", "title")
     wait_until { message_title }
-    message_title.should be_true
+    expect(message_title).to be(true)
   end
 
   it "should work even after processing a message from before" do
     @publish_queue.publish("data1", "title")
     message_times = 0
     @consume_queue.subscribe do |title, data|
-      title.should == "title"
+      expect(title).to eq("title")
       message_times += 1
     end
 
     @publish_queue.publish("data2", "title")
     wait_until { message_times == 2 }
-    message_times.should == 2
+    expect(message_times).to eq(2)
   end
 end