thwait 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a0906e3fbcba8466f400788c2aa1dc49358a6128f2235e26c822e34fc2affd0
+  data.tar.gz: 79eaa003a91adf0131cf941b06c04adaa86b5bf4fff937c9ead26e0b1ceeee0e
+SHA512:
+  metadata.gz: 8dd2618bd3d76aa346a67cb3ba63d85a83508ee4e3920c08ec69f4d65c38e000174e4e7f8f27607124bc098e4b7d64c8c032062e9f452be5549c3f269a3fcca6
+  data.tar.gz: fd36fda399a7f0d3ea6fb594bc087eba1fff4a639088a430fef209a6549027e31d4f92dd140c3002813d15756b82bc4d98afd19a9c49f30bdeec88afddae7a68

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (C) 1993-2013 Yukihiro Matsumoto. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/README.md

@@ -0,0 +1,44 @@
+# ThreadsWait
+
+This class watches for termination of multiple threads.  Basic functionality (wait until specified threads have terminated) can be accessed through the class method ThreadsWait::all_waits.  Finer control can be gained using instance methods.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'thwait'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install thwait
+
+## Usage
+
+```
+  ThreadsWait.all_waits(thr1, thr2, ...) do |t|
+    STDERR.puts "Thread #{t} has terminated."
+  end
+
+  th = ThreadsWait.new(thread1,...)
+  th.next_wait # next one to be done
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/thwait.
+
+## License
+
+The gem is available as open source under the terms of the [2-Clause BSD License](https://opensource.org/licenses/BSD-2-Clause).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require_relative "../lib/thwait"
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/thwait.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: false
+#
+#   thwait.rb - thread synchronization class
+#       $Release Version: 0.9 $
+#       $Revision: 1.3 $
+#       by Keiju ISHITSUKA(Nihon Rational Software Co.,Ltd.)
+
+require "e2mmap"
+
+#
+# This class watches for termination of multiple threads.  Basic functionality
+# (wait until specified threads have terminated) can be accessed through the
+# class method ThreadsWait::all_waits.  Finer control can be gained using
+# instance methods.
+#
+# Example:
+#
+#   ThreadsWait.all_waits(thr1, thr2, ...) do |t|
+#     STDERR.puts "Thread #{t} has terminated."
+#   end
+#
+#
+#   th = ThreadsWait.new(thread1,...)
+#   th.next_wait # next one to be done
+#
+#
+class ThreadsWait
+  extend Exception2MessageMapper
+  def_exception("ErrNoWaitingThread", "No threads for waiting.")
+  def_exception("ErrNoFinishedThread", "No finished threads.")
+
+  #
+  # Waits until all specified threads have terminated.  If a block is provided,
+  # it is executed for each thread as they terminate.
+  #
+  def ThreadsWait.all_waits(*threads) # :yield: thread
+    tw = ThreadsWait.new(*threads)
+    if block_given?
+      tw.all_waits do |th|
+        yield th
+      end
+    else
+      tw.all_waits
+    end
+  end
+
+  #
+  # Creates a ThreadsWait object, specifying the threads to wait on.
+  # Non-blocking.
+  #
+  def initialize(*threads)
+    @threads = []
+    @wait_queue = Thread::Queue.new
+    join_nowait(*threads) unless threads.empty?
+  end
+
+  # Returns the array of threads that have not terminated yet.
+  attr_reader :threads
+
+  #
+  # Returns +true+ if there are no threads in the pool still running.
+  #
+  def empty?
+    @threads.empty?
+  end
+
+  #
+  # Returns +true+ if any thread has terminated and is ready to be collected.
+  #
+  def finished?
+    !@wait_queue.empty?
+  end
+
+  #
+  # Waits for specified threads to terminate, and returns when one of
+  # the threads terminated.
+  #
+  def join(*threads)
+    join_nowait(*threads)
+    next_wait
+  end
+
+  #
+  # Specifies the threads that this object will wait for, but does not actually
+  # wait.
+  #
+  def join_nowait(*threads)
+    threads.flatten!
+    @threads.concat threads
+    for th in threads
+      Thread.start(th) do |t|
+        begin
+          t.join
+        ensure
+          @wait_queue.push t
+        end
+      end
+    end
+  end
+
+  #
+  # Waits until any of the specified threads has terminated, and returns the one
+  # that does.
+  #
+  # If there is no thread to wait, raises +ErrNoWaitingThread+.  If +nonblock+
+  # is true, and there is no terminated thread, raises +ErrNoFinishedThread+.
+  #
+  def next_wait(nonblock = nil)
+    ThreadsWait.fail ErrNoWaitingThread if @threads.empty?
+    begin
+      @threads.delete(th = @wait_queue.pop(nonblock))
+      th
+    rescue ThreadError
+      ThreadsWait.fail ErrNoFinishedThread
+    end
+  end
+
+  #
+  # Waits until all of the specified threads are terminated.  If a block is
+  # supplied for the method, it is executed for each thread termination.
+  #
+  # Raises exceptions in the same manner as +next_wait+.
+  #
+  def all_waits
+    until @threads.empty?
+      th = next_wait
+      yield th if block_given?
+    end
+  end
+end
+
+##
+# An alias for ThreadsWait from thwait.rb
+
+ThWait = ThreadsWait
+
+# Documentation comments:
+#  - Source of documentation is evenly split between Nutshell, existing
+#    comments, and my own rephrasing.
+#  - I'm not particularly confident that the comments are all exactly correct.

data/lib/thwait/version.rb

@@ -0,0 +1,3 @@
+class ThreadsWait
+  VERSION = "0.1.0"
+end

data/thwait.gemspec

@@ -0,0 +1,26 @@
+begin
+  require_relative "lib/thwait/version"
+rescue LoadError
+  # for Ruby core repository
+  require_relative "version"
+end
+
+Gem::Specification.new do |spec|
+  spec.name          = "thwait"
+  spec.version       = ThreadsWait::VERSION
+  spec.authors       = ["Keiju ISHITSUKA"]
+  spec.email         = ["keiju@ruby-lang.org"]
+
+  spec.summary       = %q{Watches for termination of multiple threads.}
+  spec.description   = %q{Watches for termination of multiple threads.}
+  spec.homepage      = "https://github.com/ruby/thwait"
+  spec.license       = "BSD-2-Clause"
+
+  spec.files         = [".gitignore", "Gemfile", "LICENSE.txt", "README.md", "Rakefile", "bin/console", "bin/setup", "lib/thwait.rb", "lib/thwait/version.rb", "thwait.gemspec"]
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: thwait
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keiju ISHITSUKA
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Watches for termination of multiple threads.
+email:
+- keiju@ruby-lang.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/thwait.rb
+- lib/thwait/version.rb
+- thwait.gemspec
+homepage: https://github.com/ruby/thwait
+licenses:
+- BSD-2-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Watches for termination of multiple threads.
+test_files: []