thread_queues 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9ea8098a4b776f92b6830ca986b09277cd5ecc43
+  data.tar.gz: 8d07b550c6eaa33739303921c0503a6eaebab004
+SHA512:
+  metadata.gz: 57e4074340c6f1edb561bcef380d2eecebd7aeccc8e61f02ebbbc5a27a4adc5b9a1510e23b5fb3d960b612fe9bb126f6522ec7aa5597df6c1664ee8c192c67f1
+  data.tar.gz: e04edca9a185a43bf926da9bb7a21e9a9e85828b866f71f6fd2f7aa079ee767d85667304b492dc5fd60e64a7a0a609a3cac15bcf6f1446752e88eb6b2f3394f1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "string-cases"
+gem "codeclimate-test-reporter", group: :test, require: nil
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,78 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    builder (3.2.2)
+    codeclimate-test-reporter (0.4.2)
+      simplecov (>= 0.7.1, < 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.1.3)
+    docile (1.1.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.8)
+    github_api (0.12.2)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.3.2)
+    highline (1.6.21)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (1.2.0)
+    mini_portile (0.6.1)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.4)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.4.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    string-cases (0.0.0)
+    thread_safe (0.3.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  codeclimate-test-reporter
+  jeweler (~> 2.0.1)
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  simplecov
+  string-cases

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 kaspernj
+
+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,71 @@
+[![Build Status](https://api.shippable.com/projects/54842b6dd46935d5fbbf8e53/badge?branchName=master)](https://app.shippable.com/projects/54842b6dd46935d5fbbf8e53/builds/latest)
+[![Code Climate](https://codeclimate.com/github/kaspernj/thread_queues/badges/gpa.svg)](https://codeclimate.com/github/kaspernj/thread_queues)
+[![Test Coverage](https://codeclimate.com/github/kaspernj/thread_queues/badges/coverage.svg)](https://codeclimate.com/github/kaspernj/thread_queues)
+
+# ThreadQueues
+
+## Installation
+
+```ruby
+gem "thead_queues"
+```
+
+## Usage
+
+### BlockingQueue
+
+```ruby
+queue = ThreadQueues::BlockingQueue.new
+
+Thread.new do
+  3.times do |count|
+    queue.push(count)
+  end
+
+  queue.close
+end
+
+3.times do |count|
+  queue.pop #=> 0|1|2
+end
+
+queue.pop #=> EOFError
+```
+
+### BufferedQueue
+
+Example buffered 5 results before blocking and waiting for results to be read.
+
+```ruby
+queue = ThreadQueues::BufferedQueue.new(5)
+
+Thread.new do
+  10.times do |count|
+    queue.push(count)
+  end
+
+  queue.close
+end
+
+10.times do |count|
+  queue.pop #=> 0|1|2|3|4|5|6|7|8|9
+end
+
+queue.pop #=> EOFError
+```
+
+## Contributing to thread_queues
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2014 kaspernj. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "thread_queues"
+  gem.homepage = "http://github.com/kaspernj/thread_queues"
+  gem.license = "MIT"
+  gem.summary = "Thread-queues for Ruby"
+  gem.description = "Do thread-related work with BlockingQueue and BufferedQueue in Ruby."
+  gem.email = "k@spernj.org"
+  gem.authors = ["kaspernj"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "thread_queues #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/thread_queues/blocking_queue.rb

@@ -0,0 +1,52 @@
+class ThreadQueues::BlockingQueue
+  def initialize
+    @que = []
+    @mutex = Mutex.new
+    @cond_read = ConditionVariable.new
+    @cond_write = ConditionVariable.new
+    @num_waiting = 0
+  end
+
+  def push(obj)
+    loop do
+      @mutex.synchronize do
+        raise EOFError, "Cannot write to closed queue" if @closed
+
+        if @num_waiting > 0 && @que.empty?
+          @que.push(obj)
+          @cond_write.signal
+          return nil
+        else
+          @cond_read.wait @mutex
+        end
+      end
+    end
+  end
+
+  def pop
+    loop do
+      @mutex.synchronize do
+        raise EOFError, "Queue is empty and closed" if @que.empty? && @closed
+
+        if @que.empty?
+          @num_waiting += 1
+
+          begin
+            @cond_read.signal
+            @cond_write.wait @mutex
+          ensure
+            @num_waiting -= 0
+          end
+        else
+          return @que.shift
+        end
+      end
+    end
+  end
+
+  def close
+    @mutex.synchronize do
+      @closed = true
+    end
+  end
+end

data/lib/thread_queues/buffered_queue.rb

@@ -0,0 +1,61 @@
+require "monitor"
+
+class ThreadQueues::BufferedQueue
+  def initialize(max_queued)
+    @que = []
+    @mutex = Mutex.new
+    @cond_read = ConditionVariable.new
+    @cond_write = ConditionVariable.new
+    @num_waiting = 0
+    @max_queued = max_queued
+  end
+
+  def push(obj)
+    loop do
+      @mutex.synchronize do
+        raise EOFError, "Cannot write to closed queue" if @closed
+
+        if length <= @max_queued
+          @que.push(obj)
+          @cond_write.signal
+          return nil
+        else
+          @cond_read.wait @mutex
+        end
+      end
+    end
+  end
+
+  def pop
+    loop do
+      @mutex.synchronize do
+        raise EOFError, "Queue is empty and closed" if @que.empty? && @closed
+
+        if @que.empty?
+          @num_waiting += 1
+
+          begin
+            @cond_read.signal
+            @cond_write.wait @mutex
+          ensure
+            @num_waiting -= 0
+          end
+        else
+          obj = @que.shift
+          @cond_read.signal
+          return obj
+        end
+      end
+    end
+  end
+
+  def length
+    return @que.length
+  end
+
+  def close
+    @mutex.synchronize do
+      @closed = true
+    end
+  end
+end

data/lib/thread_queues.rb

@@ -0,0 +1,13 @@
+require "string-cases"
+
+class ThreadQueues
+  def self.const_missing(name)
+    require_relative "thread_queues/#{::StringCases.camel_to_snake(name)}"
+
+    if ::ThreadQueues.const_defined?(name)
+      return ::ThreadQueues.const_get(name)
+    end
+
+    super
+  end
+end

data/shippable.yml

@@ -0,0 +1,9 @@
+language: ruby
+cache: bundler
+archive: true
+rvm:
+  - 2.1.2
+script:
+  - CODECLIMATE_REPO_TOKEN=d421ef1496626f5f5d4de899dfc5986e944d7fefecc0bb58c58dc004d6f74e95 bundle exec rspec
+notifications:
+   email: false

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_adapter 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'thread_queues'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end

data/spec/thread_queues/blocking_queue_spec.rb

@@ -0,0 +1,43 @@
+require "spec_helper"
+
+describe ThreadQueues::BlockingQueue do
+  it "can read and write when writing is slow" do
+    queue = ThreadQueues::BlockingQueue.new
+
+    Thread.new do
+      3.times do |count|
+        sleep 0.01
+        queue.push(count)
+      end
+
+      queue.close
+    end
+
+    3.times do |count|
+      read = queue.pop
+      read.should eq count
+    end
+
+    expect { queue.pop }.to raise_error(EOFError)
+  end
+
+  it "can read and write when reading is slow" do
+    queue = ThreadQueues::BlockingQueue.new
+
+    Thread.new do
+      3.times do |count|
+        queue.push(count)
+      end
+
+      queue.close
+    end
+
+    3.times do |count|
+      sleep 0.01
+      read = queue.pop
+      read.should eq count
+    end
+
+    expect { queue.pop }.to raise_error(EOFError)
+  end
+end

data/spec/thread_queues/buffered_queue_spec.rb

@@ -0,0 +1,52 @@
+require "spec_helper"
+
+describe ThreadQueues::BufferedQueue do
+  it "should work when slow reading" do
+    queue = ThreadQueues::BufferedQueue.new(5)
+
+    $thread_finished = false
+    $thread_work = Thread.new do
+      10.times do |count|
+        queue.push count
+      end
+      $thread_finished = true
+    end
+
+    sleep 0.01
+
+    4.times do |count|
+      queue.pop.should eq count
+      $thread_finished.should eq false
+      sleep 0.01
+    end
+
+    queue.pop.should eq 4
+    sleep 0.01
+    $thread_finished.should eq true
+  end
+
+  it "should work when slow writing" do
+    queue = ThreadQueues::BufferedQueue.new(5)
+
+    $thread_finished = false
+    $thread_work = Thread.new do
+      10.times do |count|
+        queue.push count
+        sleep 0.01
+      end
+      $thread_finished = true
+    end
+
+    sleep 0.01
+
+    4.times do |count|
+      queue.pop.should eq count
+      $thread_finished.should eq false
+    end
+
+    queue.pop.should eq 4
+    sleep 0.07
+    queue.length.should eq 5
+    $thread_finished.should eq true
+  end
+end

data/spec/thread_queues_spec.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ThreadQueues" do
+end

data/thread_queues.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: thread_queues 0.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "thread_queues"
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["kaspernj"]
+  s.date = "2014-12-07"
+  s.description = "Do thread-related work with BlockingQueue and BufferedQueue in Ruby."
+  s.email = "k@spernj.org"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/thread_queues.rb",
+    "lib/thread_queues/blocking_queue.rb",
+    "lib/thread_queues/buffered_queue.rb",
+    "shippable.yml",
+    "spec/spec_helper.rb",
+    "spec/thread_queues/blocking_queue_spec.rb",
+    "spec/thread_queues/buffered_queue_spec.rb",
+    "spec/thread_queues_spec.rb",
+    "thread_queues.gemspec"
+  ]
+  s.homepage = "http://github.com/kaspernj/thread_queues"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.0"
+  s.summary = "Thread-queues for Ruby"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<string-cases>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<string-cases>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<string-cases>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: thread_queues
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- kaspernj
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: string-cases
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+description: Do thread-related work with BlockingQueue and BufferedQueue in Ruby.
+email: k@spernj.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/thread_queues.rb
+- lib/thread_queues/blocking_queue.rb
+- lib/thread_queues/buffered_queue.rb
+- shippable.yml
+- spec/spec_helper.rb
+- spec/thread_queues/blocking_queue_spec.rb
+- spec/thread_queues/buffered_queue_spec.rb
+- spec/thread_queues_spec.rb
+- thread_queues.gemspec
+homepage: http://github.com/kaspernj/thread_queues
+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.0
+signing_key: 
+specification_version: 4
+summary: Thread-queues for Ruby
+test_files: []