circular_queue 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - rbx-2.0
+  - jruby
+  - ree
+notifications:
+  disabled: true

data/README.md

@@ -0,0 +1,27 @@
+# Circular Queue
+
+Documentation, including example use, is covered in the [API
+Docs](http://rdoc.info/github/alindeman/circular_queue/master/CircularQueue).
+
+## License
+
+Copyright (c) 2011 Andy Lindeman
+
+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/Rakefile

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

data/circular_queue.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "circular_queue"
-  s.version     = "0.0.1"
+  s.version     = "0.0.2"
   s.authors     = ["Andy Lindeman"]
   s.email       = ["alindeman@gmail.com"]
   s.homepage    = ""

data/lib/circular_queue.rb

@@ -19,8 +19,8 @@ require "thread"
 #     q << 3 # => [1, 2, 3]
 #
 #     # Elements are replaced when the queue reaches capacity
-#     q << 4 # => [4, 2, 3]
-#     q << 5 # => [4, 5, 3]
+#     q << 4 # => [2, 3, 4]
+#     q << 5 # => [3, 4, 5]
 class CircularQueue
   # Returns the maximum number of elements that can be enqueued
   # @return [Integer]
@@ -32,7 +32,7 @@ class CircularQueue
   alias length size
 
   # Creates a new queue of the specified capacity
-  # @param [Integer] the maximum capacity of the queue
+  # @param [Integer] capacity the maximum capacity of the queue
   def initialize(capacity)
     @capacity = capacity
     @data     = Array.new(capacity)
@@ -44,7 +44,7 @@ class CircularQueue
   end
 
   # Adds an item to the queue
-  # @param [Object] item to add
+  # @param [Object] item item to add
   def enq(item)
     @mutex.synchronize do
       enq_item(item)
@@ -55,7 +55,7 @@ class CircularQueue
   alias push enq
 
   # Adds an item to the queue, raising an error if the queue is full
-  # @param [Object] item to add
+  # @param [Object] item item to add
   # @raise [ThreadError] queue is full
   def enq!(item)
     @mutex.synchronize do
@@ -68,8 +68,8 @@ class CircularQueue
   alias push! enq!
 
   # Removes an item from the queue
-  # @param [Boolean] true to raise an error if the queue is empty; otherwise,
-  #                  waits for an item to arrive from another thread
+  # @param [Boolean] non_block true to raise an error if the queue is empty;
+  #                  otherwise, waits for an item to arrive from another thread
   # @raise [ThreadError] non_block was true and the queue was empty
   def deq(non_block = false)
     @mutex.synchronize do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: circular_queue
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-10-17 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2156106760 !ruby/object:Gem::Requirement
+  requirement: &2168477680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *2156106760
+  version_requirements: *2168477680
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2156106060 !ruby/object:Gem::Requirement
+  requirement: &2168476120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *2156106060
+  version_requirements: *2168476120
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2156105200 !ruby/object:Gem::Requirement
+  requirement: &2168475140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156105200
+  version_requirements: *2168475140
 description: A circular queue (also called a circular buffer or ring buffer) is useful
   when buffering data streams
 email:
@@ -53,7 +53,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
+- README.md
 - Rakefile
 - circular_queue.gemspec
 - lib/circular_queue.rb
@@ -73,7 +75,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2375285051311577887
+      hash: 2997727403092005944
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -82,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2375285051311577887
+      hash: 2997727403092005944
 requirements: []
 rubyforge_project: circular_queue
 rubygems_version: 1.8.10