countdownlatch 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in countdownlatch.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ben Langfeld, Tuomas Kareinen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# CountDownLatch [ ![Build status](http://travis-ci.org/benlangfeld/countdownlatch.png) ](http://travis-ci.org/benlangfeld/countdownlatch)
+A synchronization aid that allows one or more threads to wait until a set of operations being performed in other threads completes
+
+## Installation
+    gem install countdownlatch
+
+## Usage
+```ruby
+require 'countdownlatch'
+
+latch = CountDownLatch.new 2
+
+Thread.new do
+  2.times do
+    sleep 1
+    latch.countdown!
+  end
+end
+
+latch.wait 10
+```
+
+## Links
+* [Source](https://github.com/benlangfeld/countdownlatch)
+* [Documentation](http://rdoc.info/github/benlangfeld/countdownlatch/master/CountDownLatch)
+* [Bug Tracker](https://github.com/benlangfeld/countdownlatch/issues)
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  * If you want to have your own version, that is fine but bump version in a commit by itself so I can ignore when I pull
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2011 Ben Langfeld, Tuomas Kareinen. MIT licence (see LICENSE for details).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.test_files = FileList['spec/*_spec.rb']
+  t.verbose = true
+end

data/countdownlatch.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "countdownlatch/version"
+
+Gem::Specification.new do |s|
+  s.name        = "countdownlatch"
+  s.version     = CountDownLatch::VERSION
+  s.authors     = ["Ben Langfeld"]
+  s.email       = ["ben@langfeld.me"]
+  s.homepage    = "https://github.com/benlangfeld/countdownlatch"
+  s.summary     = %q{3..2..1..GO!}
+  s.description = %q{A synchronization aid that allows one or more threads to wait until a set of operations being performed in other threads completes}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'minitest'
+end

data/lib/countdownlatch.rb

@@ -0,0 +1,95 @@
+require "countdownlatch/version"
+
+require 'thread'
+require 'timeout'
+
+##
+# A synchronization aid that allows one or more threads to wait until a set of operations being performed in other threads completes.
+#
+# Mirrors the Java implementation: http://download.oracle.com/javase/1.5.0/docs/api/java/util/concurrent/CountDownLatch.html
+#
+# @author Ben Langfeld
+# @author Tuomas Kareinen (derivative): https://gist.github.com/739662
+#
+# @example Count down from 2 in 2 seconds, with a timeout of 10 seconds
+#   latch = CountDownLatch.new 2
+#
+#   Thread.new do
+#     2.times do
+#       sleep 1
+#       latch.countdown!
+#     end
+#   end
+#
+#   latch.wait 10
+#
+class CountDownLatch
+  ##
+  # Create a new CountDownLatch
+  # @param [Integer] count the number of times #countdown! must be invoked before threads can pass through #wait
+  #
+  # @raise [ArgumentError] if the count is less than zero
+  #
+  def initialize(count)
+    raise ArgumentError if count < 0
+    @count = count
+    @mutex = Mutex.new
+    @conditional = ConditionVariable.new
+  end
+
+  ##
+  # Decrements the count of the latch, releasing all waiting threads if the count reaches zero.
+  # * If the current count is greater than zero then it is decremented. If the new count is zero then all waiting threads are re-enabled for thread scheduling purposes.
+  # * If the current count equals zero then nothing happens.
+  #
+  def countdown!
+    @mutex.synchronize do
+      @count -= 1 if @count > 0
+      @conditional.broadcast if @count == 0
+    end
+  end
+
+  ##
+  # Returns the current count.
+  # This method is typically used for debugging and testing purposes.
+  #
+  # @return [Integer]
+  #
+  def count
+    @mutex.synchronize { @count }
+  end
+
+  ##
+  # Returns a string identifying this latch, as well as its state. The state, in brackets, includes the String "Count =" followed by the current count.
+  #
+  # @return [String]
+  #
+  def to_s
+    super.insert -2, " (Count = #{count})"
+  end
+
+  ##
+  # Causes the current thread to wait until the latch has counted down to zero, unless the thread is interrupted.
+  # If the current count is zero then this method returns immediately.
+  # If the current count is greater than zero then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of three things happen:
+  # * The count reaches zero due to invocations of the countdown! method; or
+  # * Some other thread interrupts the current thread; or
+  # * The specified waiting time elapses.
+  #
+  # @param [Integer] timeout the maximum time to wait in seconds
+  #
+  # @return [Boolean] true if the count reached zero and false if the waiting time elapsed before the count reached zero
+  #
+  def wait(timeout = nil)
+    begin
+      Timeout::timeout timeout do
+        @mutex.synchronize do
+          @conditional.wait @mutex if @count > 0
+        end
+      end
+      true
+    rescue Timeout::Error
+      false
+    end
+  end
+end

data/lib/countdownlatch/version.rb

@@ -0,0 +1,3 @@
+class CountDownLatch
+  VERSION = "1.0.0"
+end

data/spec/countdownlatch_spec.rb

@@ -0,0 +1,150 @@
+require 'minitest/autorun'
+require 'countdownlatch'
+
+describe CountDownLatch do
+  it "requires a positive count" do
+    assert_raises(ArgumentError) { CountDownLatch.new(-1) }
+  end
+
+  describe "#wait" do
+    describe "counting down from 1" do
+      before do
+        @latch = CountDownLatch.new 1
+        @name = :foo
+      end
+
+      it "blocks until counted down in another thread" do
+        Thread.new do
+          @name = :bar
+          @latch.countdown!
+        end
+        @latch.wait
+        @latch.count.must_equal 0
+        @name.must_equal :bar
+      end
+
+      it "blocks another thread until counted down" do
+        Thread.new do
+          @latch.wait
+          @latch.count.must_equal 0
+          @name.must_equal :bar
+        end
+        @name = :bar
+        @latch.countdown!
+      end
+
+      it "returns true if counted down" do
+        Thread.new { @latch.countdown! }
+        @latch.wait.must_equal true
+      end
+
+      it "returns true if timed out" do
+        @latch.wait(0.01).must_equal false
+      end
+    end
+
+    describe "counting down from zero" do
+      before do
+        @latch = CountDownLatch.new 0
+      end
+
+      it "does not wait" do
+        @latch.wait
+        @latch.count.must_equal 0
+      end
+    end
+
+    describe "counting down from 2" do
+      before do
+        @latch = CountDownLatch.new 2
+        @name = :foo
+      end
+
+      it "within a single thread" do
+        Thread.new do
+          @latch.countdown!
+          @name = :bar
+          @latch.countdown!
+        end
+        @latch.wait
+        @latch.count.must_equal 0
+        @name.must_equal :bar
+      end
+
+      it "within two parallel threads" do
+        Thread.new { @latch.countdown! }
+        Thread.new do
+          @name = :bar
+          @latch.countdown!
+        end
+        @latch.wait
+        @latch.count.must_equal 0
+        @name.must_equal :bar
+      end
+
+      it "within two chained threads" do
+        Thread.new do
+          @latch.countdown!
+          Thread.new do
+            @name = :bar
+            @latch.countdown!
+          end
+        end
+        @latch.wait
+        @latch.count.must_equal 0
+        @name.must_equal :bar
+      end
+    end
+
+    describe "with multiple waiters" do
+      before do
+        @proceed_latch = CountDownLatch.new 2
+        @check_latch = CountDownLatch.new 2
+        @results = {}
+      end
+
+      it "executes in the correct order" do
+        Thread.new do
+          @proceed_latch.wait
+          @results[:first] = 1
+          @check_latch.countdown!
+        end
+        Thread.new do
+          @proceed_latch.wait
+          @results[:second] = 2
+          @check_latch.countdown!
+        end
+        @results.must_equal({})
+        2.times { @proceed_latch.countdown! }
+        @check_latch.wait
+        @proceed_latch.count.must_equal 0
+        @check_latch.count.must_equal 0
+        @results.must_equal :first => 1, :second => 2
+      end
+    end
+
+    describe "with interleaved latches" do
+      before do
+        @change_1_latch = CountDownLatch.new 1
+        @check_latch = CountDownLatch.new 1
+        @change_2_latch = CountDownLatch.new 1
+        @name = :foo
+      end
+
+      it "blocks the correct thread" do
+        Thread.new do
+          @name = :bar
+          @change_1_latch.countdown!
+          @check_latch.wait
+          @name = :man
+          @change_2_latch.countdown!
+        end
+        @change_1_latch.wait
+        @name.must_equal :bar
+        @check_latch.countdown!
+        @change_2_latch.wait
+        @name.must_equal :man
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: countdownlatch
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Ben Langfeld
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-10 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: A synchronization aid that allows one or more threads to wait until a set of operations being performed in other threads completes
+email: 
+- ben@langfeld.me
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- countdownlatch.gemspec
+- lib/countdownlatch.rb
+- lib/countdownlatch/version.rb
+- spec/countdownlatch_spec.rb
+has_rdoc: true
+homepage: https://github.com/benlangfeld/countdownlatch
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: 3..2..1..GO!
+test_files: 
+- spec/countdownlatch_spec.rb