closeable_queue 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61fbb50b1a346c221c930aeaa5a1edf0f952dbfd
+  data.tar.gz: 78e4c2130f9b22e205dbf8b514ffa68ae4b2a86b
+SHA512:
+  metadata.gz: 86621e560893b5ef314dd2a07083647ab9bb1cb1cc7829a3289b27d0fb7ccf0b657004b003d2ce601e5587be8de5605a404943a68ce58e4ae8822962b7491769
+  data.tar.gz: 3af8cb15ee0ec3dc2448c56c06b73cc12fa51d609ddc1b31155eebfc8d7a03c2e39cc8926dff3fb8ca29a2991e689b37649f8477cb81c53decf4d9fc9bcd09e3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Thomas Hurst
+
+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,49 @@
+# CloseableQueue
+
+Wrapper around Queue and SizedQueue adding a `#close` method.
+
+Closed queues allow `#pop` until the queue is drained, then forever return nil
+or raise StopIteration.  Pushes to a closed queue also raise an exception.
+
+Ruby 2.3 is expected to support a native `#close` method which works similarly:
+
+  https://bugs.ruby-lang.org/issues/10600
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'closeable_queue'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install closeable_queue
+
+## Usage
+
+```ruby
+queue = CloseableQueue.new
+queue.push(an_object) # => queue
+queue.pop             # => an_object
+queue.close
+queue.pop             # => nil
+queue.close(true)
+queue.pop             # => raises CloseableQueue::ClosedQueue (is_a? StopIteration)
+```
+
+## 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/Freaky/closeable_queue
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'closeable_queue'
+
+begin
+  require 'pry'
+  Pry.start
+rescue LoadError
+  require 'irb'
+  IRB.start
+end

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/closeable_queue.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'closeable_queue/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "closeable_queue"
+  spec.version       = CloseableQueue::VERSION
+  spec.authors       = ["Thomas Hurst"]
+  spec.email         = ["tom@hur.st"]
+  spec.license       = "MIT"
+
+  spec.summary       = %q{Thread-safe queues with safer shutdown semantics}
+  spec.description   = %q{Adds a #close method to the standard library Queue and SizedQueue to close down consumers}
+  spec.homepage      = "https://github.com/Freaky/closeable_queue"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_dependency "concurrent-ruby"
+end

data/lib/closeable_queue/version.rb

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

data/lib/closeable_queue.rb

@@ -0,0 +1,129 @@
+
+require 'thread'
+require 'concurrent'
+require 'closeable_queue/version'
+
+# A wrapper around +Queue+ to provide support for `#close`.
+#
+# Once closed, threads waiting on dequeue will drain the queue and then receive
+# nil on future dequeues. If close(true) is used, pop from an empty closed queue
+# or attempts to push raise +ClosedQueue+, a subclass of +StopIteration+.
+#
+#  Example usage:
+#
+#   queue = ClosableQueue.new
+#   consumer = Thread.new { while number = queue.pop ; puts number ; end }
+#   5.times {|x| queue.push(x) }
+#   queue.close
+#   consumer.join
+#
+# `#close` is thread-safe and can be called safely multiple times.
+#
+# This is anticipated to be obsolete by Ruby 2.3 with Queue#close.
+#
+class CloseableQueue
+  class ClosedQueueError < ThreadError
+  end
+
+  class ClosedQueue < StopIteration
+  end
+
+  # Set up a new queue.  +limit+ will use a SizedQueue, default unbounded Queue.
+  def initialize(limit = nil)
+    @mutex           = Mutex.new
+    @waiting         = Set.new
+    @num_waiting     = Concurrent::AtomicFixnum.new
+    @closed          = Concurrent::AtomicBoolean.new
+    @raise_exception = Concurrent::AtomicBoolean.new(false)
+
+    if limit
+      @queue = SizedQueue.new(Integer(limit))
+    else
+      @queue = Queue.new
+    end
+  end
+
+  def inspect
+    "<#{name} size=#{length} closed=#{closed?} waiting=#{num_waiting}>"
+  end
+
+  # Take the first element off the queue.
+  #
+  # If the queue is empty and closed?, return nil, or optionally raise
+  # ClosedQueue (a subclass of StopIteration)
+  def pop
+    @queue.pop(true)
+  rescue ThreadError
+    if closed?
+      raise ClosedQueue if @raise_exception.true?
+      return nil
+    else
+      sleep
+      retry
+    end
+  end
+
+  [:deq, :shift].each { |name| alias_method name, :pop }
+
+  # Add an item to the queue and wakeup any sleeping consumers.
+  #
+  # If the queue is closed, raises +ClosedQueueError+.
+  def push(item)
+    fail ClosedQueueError if closed?
+
+    @queue.push(item)
+    wakeup
+    self
+  end
+
+  [:enq, :<<].each { |name| alias_method name, :push }
+
+  # Get an atomic snapshot if the number of threads waiting on the queue.
+  def num_waiting
+    @num_waiting.value
+  end
+
+  # Get the number of items remaining on the queue
+  def length
+    @queue.length
+  end
+
+  # Return true if the queue is empty
+  def empty?
+    @queue.empty?
+  end
+
+  # Return true if the queue has been closed
+  def closed?
+    @closed.true?
+  end
+
+  # Close the queue if it hasn't been already.  Wake up waiting threads if any.
+  def close(raise_exception = false)
+    @raise_exception.make_true if raise_exception
+    @mutex.synchronize { @waiting.each(&:wakeup) } if @closed.make_true
+    self
+  end
+
+  private
+
+  def sleep
+    @mutex.synchronize do
+      @waiting << Thread.current
+      @num_waiting.increment
+      @mutex.sleep
+      @waiting.delete(Thread.current)
+      @num_waiting.decrement
+    end
+  end
+
+  def wakeup
+    return if @num_waiting.value.zero?
+
+    @mutex.synchronize do
+      @waiting.first.wakeup if @waiting.any?
+    end
+  end
+end
+
+ClosableQueue = CloseableQueue

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: closeable_queue
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas Hurst
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Adds a #close method to the standard library Queue and SizedQueue to
+  close down consumers'
+email:
+- tom@hur.st
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- closeable_queue.gemspec
+- lib/closeable_queue.rb
+- lib/closeable_queue/version.rb
+homepage: https://github.com/Freaky/closeable_queue
+licenses:
+- MIT
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Thread-safe queues with safer shutdown semantics
+test_files: []
+has_rdoc: