simple-queue 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6c13aed10884e8b79ab2ba86b505dee7542867e7
+  data.tar.gz: c5f49d232c1ce7e2d8fa6b79405af9a713f283fb
+SHA512:
+  metadata.gz: e3e9b6ca1d32e7f79b632aef4ec1de9ee688e091845d9d58dd9881aa1f9b6df263ea21b29a2652cce37a7c33f4ea9a39aa96d2dc9c83e996bb697a10abee4526
+  data.tar.gz: 23165a9c8a98fb0103e3bf7b9e72e51e6571d2c7a9483fbdd04a07277bbcc346edb1e951ada9f8dd70e5784bb6d474b3676e20d36ddb7c65990d72cec4b54d12

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/README.md

@@ -0,0 +1,131 @@
+# Simple::Queue
+
+`Simple::Queue` is a Ruby library that provides a non-blocking queue similar to
+the `Queue` library provided in Ruby's standard library. The difference is that
+this queue does not require jumping through hoops for non-blocking behavior.
+
+An example:
+
+```ruby
+require 'queue'
+
+# Ruby `Queue` blocking example:
+queue = Queue.new
+queue << 'foo'
+queue << 'bar'
+queue.pop #=> 'foo'
+queue.pop #=> 'bar'
+queue.pop # Blocks until an item is pushed onto the queue from another thread.
+
+# Ruby `Queue` non-blocking example:
+queue = Queue.new
+queue << 'foo'
+queue << 'bar'
+queue.pop(true) #=> 'foo'
+queue.pop(true) #=> 'bar'
+queue.pop(true) # Raises a `ThreadError`.
+
+# Alternative approach:
+queue = Queue.new
+queue << 'foo'
+queue << 'bar'
+queue.pop(true) rescue nil #=> 'foo'
+queue.pop(true) rescue nil #=> 'bar'
+queue.pop(true) rescue nil #=> nil
+queue.pop(true) rescue nil #=> nil
+```
+
+Whereas with `Simple::Queue`:
+
+```ruby
+require 'simple/queue'
+
+queue = Simple::Queue.new
+queue << 'foo'
+queue << 'bar'
+queue.pop #=> 'foo'
+queue.pop #=> 'bar'
+queue.pop #=> nil
+queue.pop #=> nil
+```
+
+In every other way, `Simple::Queue` acts like the Ruby queue, with the caveat
+that it will be minutely slower in the best case (since it is pure Ruby and not
+C), and faster in the worst case (since there is no rescuing of exceptions,
+which is slow in Ruby).
+
+It is thread-safe, since all operations are wrapped in a Mutex. But since it
+does not block, there should be no opportunity for race conditions (every
+operation performs exactly one thing and returns).
+
+It follows the API of `Queue` exactly:
+
+```ruby
+# Create a new simple-queue.
+Queue#initialize
+
+# Clear all items out of the queue.
+Queue#clear
+
+# Returns `true` if there is nothing in the queue, and `false` otherwise.
+Queue#empty?
+
+# Returns how many items are in the queue.
+Queue#length
+Queue#size
+
+# Puts an item in the queue.
+Queue#push(obj)
+Queue#<<(obj)
+Queue#enq(obj)
+
+# Removes an item from the queue, or returns `nil` if there are none. This
+# method takes an optional argument, which is discarded. This is for
+# compatibility with Ruby's `Queue` implementation.
+#
+Queue#pop
+Queue#deq
+Queue#shift
+
+# Always returns `0`, since there is no opportunity to wait.
+Queue#num_waiting
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple-queue'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple-queue
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` 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).
+
+## TODO
+
+* Document code with RDoc.
+* More exhaustively test threading in test suite.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/rjungemann/simple-queue.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple/queue"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

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

data/lib/simple/queue.rb

@@ -0,0 +1,39 @@
+require "simple/queue/version"
+
+module Simple
+  class Queue
+    def initialize
+      @array = []
+      @mutex = Mutex.new
+    end
+
+    def clear
+      @mutex.synchronize { @array = [] }
+    end
+
+    def empty?
+      @mutex.synchronize { @array.empty? }
+    end
+
+    def length
+      @mutex.synchronize { @array.length }
+    end
+    alias_method :size, :length
+
+    def push(obj)
+      @mutex.synchronize { @array.push(obj) }
+    end
+    alias_method :<<, :push
+    alias_method :enq, :push
+
+    def pop(_=nil)
+      @mutex.synchronize { @array.shift }
+    end
+    alias_method :deq, :pop
+    alias_method :shift, :pop
+
+    def num_waiting
+      0
+    end
+  end
+end

data/lib/simple/queue/version.rb

@@ -0,0 +1,5 @@
+module Simple
+  class Queue
+    VERSION = "0.1.0"
+  end
+end

data/simple-queue.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple/queue/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple-queue"
+  spec.version       = Simple::Queue::VERSION
+  spec.authors       = ["Roger Jungemann"]
+  spec.email         = ["roger@thefifthcircuit.com"]
+
+  spec.summary       = %q{A dead-simple non-blocking queue.}
+  spec.homepage      = "https://github.com/rjungemann/simple-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.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: simple-queue
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roger Jungemann
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- roger@thefifthcircuit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple/queue.rb
+- lib/simple/queue/version.rb
+- simple-queue.gemspec
+homepage: https://github.com/rjungemann/simple-queue
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A dead-simple non-blocking queue.
+test_files: []