circular_queue 0.0.3 → 0.0.4

data/README.md

@@ -2,6 +2,9 @@
 
 [![Build Status](https://secure.travis-ci.org/alindeman/circular_queue.png)](http://travis-ci.org/alindeman/circular_queue)
 
+Data structure that uses a single, fixed-size buffer as if it were connected
+end-to-end.
+
 **circular_queue** *requires* Ruby 1.9 or a Ruby implementation that
 supports 1.9 syntax and standard library (e.g., JRuby in 1.9 mode;
 Rubinius 2.0 should work if/when Mutex#sleep is implemented).

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.3"
+  s.version     = "0.0.4"
   s.authors     = ["Andy Lindeman"]
   s.email       = ["alindeman@gmail.com"]
   s.homepage    = "https://github.com/alindeman/circular_queue"

data/lib/circular_queue.rb

@@ -109,12 +109,39 @@ class CircularQueue
     @size == @capacity
   end
 
+  # Returns thee first/oldest item in the queue
+  # @return [Object]
+  # Peek at first item without removing
+  def front
+    @mutex.synchronize do
+      @data[@front]
+    end
+  end
+
+  # Returns the last/most recent item in the queue
+  # @return [Object] 
+  # Peek at last item without removing
+  def back
+    @mutex.synchronize do
+      @data[(@back - 1) % @capacity]
+    end
+  end
+
   # Returns the number of threads waiting for items to arrive in the queue
   # @return [Integer] number of threads waiting
   def num_waiting
     @waiting.length
   end
 
+  # Returns the data in the queue
+  # @return [Array] the queue
+  # Allows for easy iteration of queue from front to back
+  def data
+    @mutex.synchronize do
+      @data.clone.rotate @front
+    end
+  end
+
   private
 
   def enq_item(item)

data/spec/circular_queue_spec.rb

@@ -13,6 +13,8 @@ describe CircularQueue do
   describe "adding items" do
     it "accepts new items" do
       subject.enq(1234)
+      subject.front.should == 1234
+      subject.back.should == 1234
       subject.deq.should == 1234
     end
 
@@ -21,6 +23,17 @@ describe CircularQueue do
       subject.size.should == 1
     end
 
+    it "allows for peeking at first and last items" do
+      subject.enq(1)
+
+      subject.front.should == 1
+      subject.back.should == 1
+
+      2.upto(capacity) { |i| subject.enq(i) }
+      subject.front.should == 1
+      subject.back.should == capacity
+    end
+
     it "presents the appearance of accepting infinite items" do
       1.upto(capacity * 2) { |i| subject.enq(i) }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: circular_queue
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-29 00:00:00.000000000 Z
+date: 2012-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -91,7 +91,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -217273425497455269
+      hash: -2396495672156037732
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -100,13 +100,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -217273425497455269
+      hash: -2396495672156037732
 requirements: []
 rubyforge_project: circular_queue
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Data structure that uses a single, fixed-size buffer as if it were connected
   end-to-end
-test_files: []
+test_files:
+- spec/circular_queue_spec.rb
+- spec/spec_helper.rb
 has_rdoc: