rubystructures 0.0.1 → 0.0.2

data/README.md

@@ -18,8 +18,8 @@ Or install it yourself as:
 
 ## Usage
 
-### Stack
-RubyStructures::Stack provides a First in, First out stack implementation.
+### Stacks
+RubyStructures::Stack provides a First in, Last out stack implementation.
 
 Create a new Stack:
 ```ruby
@@ -60,6 +60,62 @@ Is the Stack empty?
 # => false
 ```
 
+### Queues
+
+`RubyStructures::Queue` implements a First in, First out queue.
+
+Create a new Queue:
+```ruby
+require 'rubystructures'
+
+@queue = RubyStructures::Queue.new
+```
+
+Push a value onto the Queue:
+```ruby
+@queue.push(42)
+# => true
+```
+
+You can also use `enqueue` as an alias for push:
+```ruby
+@queue.enqueue(42)
+# => true
+```
+
+Pop a value off the Queue:
+```ruby
+@queue.pop
+# => 42
+```
+
+You can also use `dequeue` as an alias for pop:
+```ruby
+@queue.dequeue
+# => 42
+```
+
+Take a peek at the values at the front of back of the Queue without removing them:
+```ruby
+@queue.front
+# => 42
+
+@queue.back
+# => 7
+```
+
+Get the size of the Queue:
+```ruby
+@queue.size
+# => 4
+```
+
+Check whether or not the Queue is empty:
+```ruby
+@queue.empty?
+# => false
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/connorjacobsen/rubystructures/fork )

data/lib/rubystructures/queue.rb

@@ -0,0 +1,116 @@
+module RubyStructures
+	class Queue
+		# Public: Creates a new instance of Queue.
+		#
+		# Examples
+		#
+		# 	@queue = Queue.new
+		# 	# => Queue
+		#
+		# Returns a new instance of Queue.
+		def initialize
+			@storage = []
+		end
+
+		# Public: Returns the size of the Queue.
+		#
+		# Examples
+		#
+		# 	@queue.size
+		# 	# => 1
+		#
+		# Returns the Integer size of the Queue.
+		def size
+			@storage.size
+		end
+
+		# Public: Adds a value to the Queue.
+		#
+		# value - Ruby data type, can be of any class type.
+		#
+		# Examples
+		#
+		# 	@queue.push(42)
+		# 	# => true
+		#
+		# Returns true if the value is successfully added to the Queue; returns
+		# false otherwise.
+		def push(value)
+			if @storage.insert(0, value)
+				true
+			else
+				false
+			end
+		end
+
+		# Public: Returns and removes the next item in the Queue.
+		#
+		# Examples
+		#
+		# 	@queue.pop
+		# 	# => 42
+		#
+		# Returns the next value to be served by the Queue, unless
+		# the Queue is empty, then returns nil.
+		def pop
+			@storage.pop
+		end
+
+		# Public: Returns the next value to be served by the Queue without
+		# removing the value from the Queue.
+		#
+		# Examples
+		#
+		# 	@queue.front
+		# 	# => 42
+		#
+		# Returns the value of the next item to be served in the Queue.
+		def front
+			@storage.last
+		end
+
+		# Public: Returns the last value added to the Queue.
+		#
+		# Examples
+		#
+		# 	@queue.back
+		# 	# => 42
+		#
+		# Returns the value at the end of the Queue, which would be served last.
+		def back
+			@storage.first
+		end
+
+		# Public: Checks if whether or not the Queue is empty.
+		#
+		# Examples
+		#
+		# 	@queue.empty?
+		# 	# => true
+		#
+		# Returns true if the Queue is empty; false otherwise.
+		def empty?
+			@storage.size == 0
+		end
+
+		# Alias for Queue.push(value)
+		#
+		# Examples
+		#
+		# 	@queue.push(42)
+		# 	# => true
+		def enqueue(value)
+			self.push value
+		end
+
+		# Alias for Queue.pop
+		#
+		# Examples
+		#
+		# 	@queue.dequeue
+		# 	# => 42
+		def dequeue
+			self.pop
+		end
+	end
+end

data/lib/rubystructures/stack.rb

@@ -0,0 +1,92 @@
+module RubyStructures
+	class Stack
+		# Public: Creates a new instance of Stack with default values.
+		#
+		# Examples
+		# 
+		# 	Stack.new
+		#
+		# Returns a new instance of RubyStuctures::Stack.
+		def initialize
+			@storage = Array.new
+		end
+
+		# Public: Returns the Integer current size of the stack.
+		# We can rely on the Ruby Array to provide us with the correct stack
+		# size, which allows us to not have a :size instance variable.
+		#
+		# Examples
+		#
+		# 	@stack.size
+		# 	# => 42
+		#
+		# Returns the size of the stack.
+		def size
+			@storage.size
+		end
+
+		# Public: Adds value to the Stack.
+		#
+		# value - Ruby data type, can be of any class type.
+		#
+		# Examples
+		# 
+		# 	@stack.push(42)
+		# 	# => true
+		#
+		# Returns true if the value was successfully added to the stack.
+		def push(value)
+			if @storage << value
+				true
+			else
+				false
+			end
+		end
+
+		# Public: Removes and returns the value from the top of the stack.
+		#
+		# Examples
+		# 
+		# 	# If the stack has :size > 1, return the top value.
+		# 	@stack.pop
+		# 	# => 42
+		#
+		# 	# If the stack is empty, returns nil.
+		# 	@stack.pop
+		# 	# => nil
+		#
+		# Returns the value at the top of the stack, or nil if the stack is empty.
+		def pop
+			@storage.pop
+		end
+
+		# Public: Peek at the value on the top of the stack without removing it.
+		#
+		# Examples
+		#
+		# 	@stack.top
+		# 	# => 42
+		#
+		# 	# If the stack is empty, returns nil.
+		# 	@stack.top
+		# 	# => nil
+		#
+		# Returns the value at the stop of the Stack, but does not pop the
+		# value off the stack. Returns nil if the Stack is empty.
+		def top
+			@storage.last
+		end
+
+		# Public: Boolean check to see if the stack is empty.
+		#
+		# Examples
+		# 
+		# 	@stack.empty?
+		# 	# => true
+		# 
+		# Returns true if the Stack is empty, false otherwise.
+		def empty?
+			@storage.size == 0
+		end
+	end
+end

data/lib/rubystructures/version.rb

@@ -1,3 +1,3 @@
 module RubyStructures
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/rubystructures.rb

@@ -2,4 +2,5 @@ require "rubystructures/version"
 
 module RubyStructures
   require 'rubystructures/stack'
+  require 'rubystructures/queue'
 end

data/spec/queue_spec.rb

@@ -0,0 +1,124 @@
+require 'rubystructures'
+
+describe RubyStructures::Queue do
+	queue = RubyStructures::Queue.new
+	subject { queue }
+
+	it { should respond_to :size }
+
+	# Methods
+	describe "#initialize" do
+		before(:each) { @queue = RubyStructures::Queue.new }
+
+		it "creates a Queue object" do
+			expect(@queue.class).to eql RubyStructures::Queue
+		end
+
+		it "has :size zero upon creation" do
+			expect(@queue.size).to eql 0
+		end
+	end
+
+	describe "#push" do
+		before { @queue = RubyStructures::Queue.new }
+		it "add an object to the queue" do
+			expect(@queue.size).to eql 0
+			@queue.push(42)
+			expect(@queue.size).to eql 1
+		end
+	end
+
+	describe "#pop" do
+		before(:each) do
+			@queue = RubyStructures::Queue.new
+			@queue.push(42)
+		end
+
+		it "returns the correct value" do
+			expect(@queue.pop).to eql 42
+		end
+
+		it "has the correct queue size" do
+			expect(@queue.size).to eql 1
+			@queue.pop
+			expect(@queue.size).to eql 0
+		end
+	end
+
+	describe "#size" do
+		before(:each) do
+			@queue = RubyStructures::Queue.new
+		end
+
+		it "returns 0 when Queue is empty" do
+			expect(@queue.size).to eql 0
+		end
+
+		it "returns correct Queue size" do
+			@queue.push(42)
+			expect(@queue.size).to eql 1
+		end
+	end
+
+	describe "#front" do
+		before(:each) do
+			@queue = RubyStructures::Queue.new
+			@queue.push(42)
+			@queue.push(13)
+		end
+
+		it "returns the correct value" do
+			expect(@queue.size).to eql 2
+			expect(@queue.front).to eql 42
+			expect(@queue.size).to eql 2
+		end
+	end
+
+	describe "#back" do
+		before(:each) do
+			@queue = RubyStructures::Queue.new
+			@queue.push(42)
+			@queue.push(13)
+		end
+
+		it "returns the correct value" do
+			expect(@queue.size).to eql 2
+			expect(@queue.back).to eql 13
+			expect(@queue.size).to eql 2
+		end
+	end
+
+	describe "#empty?" do
+		before { @queue = RubyStructures::Queue.new }
+
+		it "returns true when empty" do
+			expect(@queue.empty?).to eql true
+		end
+
+		it "returns false when not empty" do
+			@queue.push(42)
+			expect(@queue.empty?).to eql false
+		end
+	end
+
+	describe "#enqueue" do
+		before { @queue = RubyStructures::Queue.new }
+
+		it "behaves like push" do
+			expect(@queue.size).to eql 0
+			@queue.enqueue(42)
+			expect(@queue.size).to eql 1
+		end
+	end
+
+	describe "#dequeue" do
+		before { @queue = RubyStructures::Queue.new }
+
+		it "behaves like pop" do
+			@queue.push(42)
+			expect(@queue.size).to eql 1
+			expect(@queue.dequeue).to eql 42
+			expect(@queue.size).to eql 0
+		end
+	end
+end

data/spec/stack_spec.rb

@@ -0,0 +1,81 @@
+require 'rubystructures'
+
+describe RubyStructures::Stack do
+	stack = RubyStructures::Stack.new
+	subject { stack }
+
+	# Attributes
+	it { should respond_to :size }
+
+	# Methods
+	describe "#initialize" do
+		before { @stack = RubyStructures::Stack.new }
+		it "creates a Stack object" do
+			expect(@stack.class).to eql RubyStructures::Stack
+		end
+
+		it "has size zero upon creation" do
+			expect(@stack.size).to eql 0
+		end
+	end
+
+	describe "#push" do
+		before { @stack = RubyStructures::Stack.new }
+		it "adds an object to the stack" do
+			expect(@stack.size).to eql 0
+			@stack.push(42)
+			expect(@stack.size).to eql 1
+		end		
+	end
+
+	describe "#pop" do
+		before { @stack = RubyStructures::Stack.new }
+		context "stack is empty" do
+			it "returns nil" do
+				expect(@stack.pop).to eql nil
+			end
+		end
+
+		context "stack is not empty" do
+			before { @stack.push(42) }
+			it "returns and removes correct value" do
+				expect(@stack.pop).to eql 42
+				expect(@stack.size).to eql 0
+			end
+		end
+	end
+
+	describe "#top" do
+		before do
+			@stack = RubyStructures::Stack.new
+			@stack.push(42)
+			@stack.push(13)
+		end
+
+		it "returns the value of the top item" do
+			expect(@stack.top).to eql 13
+		end
+
+		it "doesn't remove any items" do
+			@stack.top
+			expect(@stack.size).to eql 2
+		end
+	end
+
+	describe "#empty?" do
+		before(:each) { @stack = RubyStructures::Stack.new }
+
+		context "when stack is empty" do
+			it "return true" do
+				expect(@stack.empty?).to eql true
+			end
+		end
+
+		context "when stack is not empty" do
+			before { @stack.push(42) }
+			it "returns false" do
+				expect(@stack.empty?).to eql false
+			end
+		end
+	end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubystructures
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -72,8 +72,12 @@ files:
 - README.md
 - Rakefile
 - lib/rubystructures.rb
+- lib/rubystructures/queue.rb
+- lib/rubystructures/stack.rb
 - lib/rubystructures/version.rb
 - rubystructures.gemspec
+- spec/queue_spec.rb
+- spec/stack_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -99,4 +103,6 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Simple, useful data structures in ruby.
-test_files: []
+test_files:
+- spec/queue_spec.rb
+- spec/stack_spec.rb