rubystructures 0.0.2 → 0.0.3

data/lib/rubystructures.rb

@@ -3,4 +3,6 @@ require "rubystructures/version"
 module RubyStructures
   require 'rubystructures/stack'
   require 'rubystructures/queue'
+  require 'rubystructures/node'
+  require 'rubystructures/linked_list'
 end

data/lib/rubystructures/linked_list.rb

@@ -0,0 +1,206 @@
+module RubyStructures
+	class LinkedList
+		# Public: Create a new instance of LinkedList
+		#
+		# Examples
+		#
+		# 	@linked_list = RubyStructures::LinkedList.new
+		# 	# => LinkedList
+		#
+		# Returns a new instance of LinkedList.
+		def initialize
+			@head = RubyStructures::Node.new(self, nil)
+		end
+
+		# Public: Returns the value at the head of the LinkedList.
+		#
+		# Examples
+		#
+		# 	@linked_list.head
+		# 	# => 42
+		#
+		# Returns the value held by the Node at the head of the list, otherwise
+		# if the list is empty, returns nil.
+		def head
+			@head.next
+		end
+
+		# Public: Checks to see if the LinkedList is empty.
+		#
+		# Examples
+		#
+		# 	@linked_list.empty?
+		# 	# => false
+		#
+		# Returns true if the LinkedList is empty, returns false otherwise.
+		def empty?
+			@head.next == nil
+		end
+
+		# Public: Add a value to the beginning of the LinkedList
+		#
+		# value - Ruby object to be inserted into the LinkedList
+		#
+		# Examples
+		#
+		# 	@linked_list.prepend(42)
+		# 	# => Node
+		#
+		# Returns the Node added to the LinkedList.
+		def prepend(value)
+			element = RubyStructures::Node.new(self, value)
+			element.next = @head.next
+			@head.next = element
+		end
+
+		# Public: Add a value to the end of the LinkedList
+		#
+		# value - Ruby object to be inserted into the LinkedList
+		#
+		# Examples
+		#
+		# 	@linked_list.append(42)
+		# 	# => Node
+		#
+		# Returns the Node added to the LinkedList.
+		def append(value)
+			if self.empty?
+				self.prepend(value)
+				return
+			end
+
+			element = self.head
+			# loop through each element in the LinkedList, until element.next 
+			# equals @head, signifying we have reached the end of the list.
+			while(element != self.head)
+				element = element.next
+			end
+
+			new_element = RubyStructures::Node.new(self, value)
+			# insert the new element at the end of the LinkedList.
+			new_element.next = element.next
+			element.next = new_element
+		end
+
+		# Public: Find an element by its value and return it.
+		#
+		# value - Ruby object to be inserted into the LinkedList
+		#
+		# Examples
+		#
+		# 	@linked_list.search(42)
+		# 	# => 42
+		#
+		# Returns the value of the element if it is in the LinkedList, returns
+		# nil otherwise.
+		def search(value)
+			return nil if self.empty?
+			element = self.head
+			while element.value != value
+				if element.next.nil?
+					return nil
+				else
+					element = element.next
+				end
+			end
+			element
+		end
+
+		# Public: Gets the Node at the head of the LinkedList.
+		#
+		# Examples
+		#
+		# 	@linked_list.item_at_head
+		# 	# => #<Node: >
+		#
+		# Returns the Node at the head of the LinkedList.
+		def item_at_head
+			@head.next
+		end
+
+		# Public: Returns the Node at the desired :index.
+		#
+		# index - the Integer index value of Node to return.
+		#
+		# Examples
+		#
+		# 	@linked_list.item_at(42)
+		# 	# => #<Node: >
+		#
+		# Returns a Node located at position :index in the LinkedList.
+		def item_at(index)
+			element = self.head
+			count = 0
+			while count < index
+				return nil if element.nil?
+				element = element.next
+				count += 1
+			end
+			element
+		end
+
+		# Public: Finds and removes the first occurrence of a Node with the 
+		# desired value.
+		#
+		# value - the Ruby object value to find and remove from the LinkedList
+		#
+		# Examples
+		#
+		# 	@linked_list.remove(42)
+		# 	# => #<Node: >
+		#
+		# Returns the node that was removed from the LinkedList
+		def remove(value)
+			element = self.head
+			previous_element = @head
+			while element.value != value
+				if element.next.nil?
+					return nil
+				else
+					previous_element = element
+					element = element.next
+				end
+			end
+
+			previous_element.next = element.next
+			element
+		end
+
+		# Public: Removes the Node at the head of the LinkedList.
+		#
+		# Examples
+		#
+		# 	@linked_list.remove_at_head
+		# 	# => #<Node: >
+		#
+		# Returns the Node at the head of the list.
+		def remove_at_head
+			return nil if self.empty?
+			element = self.head
+			@head.next = nil || element.next
+			element
+		end
+
+		# Public: Removes the Node at the tail of the LinkedList.
+		#
+		# Examples
+		#
+		# 	@linked_list.remove_at_tail
+		# 	# => #<Node: >
+		#
+		# Returns 
+		def remove_at_tail
+			return nil if self.empty?
+			element = self.head
+			previous_element = @head
+
+			until element.next.nil?
+				previous_element = element
+				element = element.next
+			end
+
+			previous_element.next = nil
+			element
+		end
+	end
+end

data/lib/rubystructures/node.rb

@@ -0,0 +1,22 @@
+module RubyStructures
+	class Node
+		attr_accessor :value
+		attr_accessor :next
+		attr_reader :list
+
+		# Internal: Creates a new instance of Node.
+		#
+		# list - instance of LinkedList to which the Node belongs.
+		# value - the value to be stored in the Node.
+		#
+		# Examples
+		#
+		# 	@node = RubyStructures::Node.new
+		#
+		# Returns a new instance of Node.
+		def initialize(list, value)
+			@list = list
+			@value = value
+		end
+	end
+end

data/lib/rubystructures/version.rb

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

data/spec/linked_list_spec.rb

@@ -0,0 +1,258 @@
+require 'rubystructures'
+
+describe RubyStructures::LinkedList do
+	before(:each) { @linked_list = RubyStructures::LinkedList.new }
+
+	describe "#initialize" do
+		it "class should be LinkedList" do
+			expect(@linked_list.class).to eql RubyStructures::LinkedList
+		end
+	end
+
+	describe "#head" do
+		context "when the LinkedList is empty" do
+			it "head has value of nil" do
+				expect(@linked_list.head).to eql nil
+			end
+		end
+
+		context "when the LinkedList is not empty" do
+			before { @linked_list.prepend(42) }
+			it "head returns an element" do
+				expect(@linked_list.head.class).to eql RubyStructures::Node
+			end
+		end
+	end
+
+	describe "#empty" do
+		context "when the LinkedList is empty" do
+			it "returns true" do
+				expect(@linked_list.empty?).to eql true
+			end
+		end
+		
+		context "when the LinkedList is not empty" do
+			before { @linked_list.prepend(42) }
+			it "returns false" do
+				expect(@linked_list.empty?).to eql false
+			end
+		end
+	end
+
+	describe "#prepend" do
+		before(:each) { @linked_list.prepend(42) }
+
+		it "empty? returns false" do
+			expect(@linked_list.empty?).to eql false
+		end
+
+		it "has the correct value" do
+			expect(@linked_list.head.value).to eql 42
+		end
+	end
+
+	describe "#append" do
+		context "when the list is empty" do
+			it "adds the element to the LinkedList" do
+				expect(@linked_list.head).to eql nil
+				@linked_list.append(42)
+				expect(@linked_list.head.value).to eql 42
+			end
+		end
+
+		context "when the list is not empty" do
+			before { @linked_list.prepend(42) }
+			it "adds the element to the LinkedList" do
+				@linked_list.append(13)
+				expect(@linked_list.head.value).to eql 42
+				element = @linked_list.head
+				element = element.next
+				expect(element.value).to eql 13
+			end
+		end
+	end
+
+	describe "#item_at_head" do
+		before { @linked_list.prepend(42) }
+		before { @linked_list.prepend(13) }
+
+		it "returns the correct item" do
+			element = @linked_list.item_at_head
+			expect(element.value).to eql 13
+		end
+	end
+
+	describe "#item_at" do
+		before { @linked_list.prepend(42) }
+		before { @linked_list.prepend(7) }
+		before { @linked_list.prepend(13) }
+
+		context "item at index zero" do
+			it "returns correct value" do
+				expect(@linked_list.item_at(0).value).to eql 13
+			end
+		end
+
+		context "item at index one" do
+			it "returns correct value" do
+				expect(@linked_list.item_at(1).value).to eql 7
+			end
+		end
+
+		context "item at index two" do
+			it "returns correct value" do
+				expect(@linked_list.item_at(2).value).to eql 42
+			end
+		end
+
+		context "item at index out of range" do
+			it "returns nil" do
+				expect(@linked_list.item_at(3)).to eql nil
+			end
+
+			it "returns nil" do
+				expect(@linked_list.item_at(4)).to eql nil
+			end
+		end
+	end
+
+	describe "#search" do
+
+		context "when the list is empty" do
+			it "returns nil" do
+				expect(@linked_list.search(42)).to eql nil
+			end
+		end
+
+		context "when the list is not empty" do
+			before(:each) { @linked_list.prepend(42) }
+			before(:each) { @linked_list.prepend(13) }
+			before(:each) { @linked_list.prepend(7) }
+
+			context "when item is at head of the list" do
+				it "returns the correct value" do
+					expect(@linked_list.search(7).value).to eql 7
+				end
+			end
+
+			context "when item is in the middle of the list" do
+				it "returns the correct value" do
+					expect(@linked_list.search(13).value).to eql 13
+				end
+			end
+
+			context "when item is at the end of the list" do
+				it "returns the correct value" do
+					expect(@linked_list.search(42).value).to eql 42
+				end
+			end
+		end
+	end
+
+	describe "#remove_at_head" do
+
+		context "list is not empty" do
+			before(:each) { @linked_list.prepend(42) }
+
+			context "only one Node" do
+				it "returns the Node at the head of the list" do
+					expect(@linked_list.remove_at_head.value).to eql 42
+				end
+
+				it "removes the Node from the list" do
+					expect(@linked_list.empty?).to eql false
+					@linked_list.remove_at_head
+					expect(@linked_list.empty?).to eql true
+				end
+			end
+
+			context "more than one Node" do
+				before(:each) { @linked_list.append(13) }
+
+				it "returns the correct Node" do
+					expect(@linked_list.remove_at_head.value).to eql 42
+				end
+
+				it "removes the value from the list" do
+					@linked_list.remove_at_head
+					expect(@linked_list.item_at_head.value).to eql 13
+				end
+			end
+		end
+
+		context "list is empty" do
+			it "returns nil" do
+				expect(@linked_list.remove_at_head).to eql nil
+			end
+		end
+	end
+
+	describe "#remove_at_tail" do
+
+		context "when the list is empty" do
+			it "returns nil" do
+				expect(@linked_list.remove_at_tail).to eql nil
+			end
+		end
+
+		context "when the list is not empty" do
+			before(:each) { @linked_list.prepend(42) }
+
+			context "list has one element" do
+				it "returns the correct value" do
+					expect(@linked_list.remove_at_tail.value).to eql 42
+				end
+
+				it "is empty after removal" do
+					expect(@linked_list.empty?).to eql false
+					@linked_list.remove_at_tail
+					expect(@linked_list.empty?).to eql true
+				end
+			end
+
+			context "list has two or more elements" do
+				before(:each) { @linked_list.prepend(13) }
+
+				it "returns the correct value" do
+					expect(@linked_list.remove_at_tail.value).to eql 42
+				end
+
+				it "Node is removed" do
+					@linked_list.remove_at_tail
+					element = @linked_list.head
+					expect(element.next).to eql nil
+				end
+			end
+		end
+	end
+
+	describe "#remove" do
+		before(:each) { @linked_list.prepend(42) }
+		before(:each) { @linked_list.prepend(7) }
+		before(:each) { @linked_list.prepend(13) }
+
+		context "value at index 0" do
+			it "returns Node" do
+				expect(@linked_list.remove(13).value).to eql 13
+			end
+		end
+
+		context "value at index 1" do
+			it "returns Node" do
+				expect(@linked_list.remove(7).value).to eql 7
+			end
+		end
+
+		context "value at index 2" do
+			it "returns Node" do
+				expect(@linked_list.remove(42).value).to eql 42
+			end
+		end
+
+		context "value not in LinkedList" do
+			it "returns nil" do
+				expect(@linked_list.remove(100)).to eql nil
+			end
+		end
+	end
+end

data/spec/node_spec.rb

@@ -0,0 +1,15 @@
+require 'rubystructures'
+
+describe RubyStructures::Node do
+	describe "#initialize" do
+		before { @node = RubyStructures::Node.new(1, 42) }
+
+		it "has correct list" do
+			expect(@node.list).to eql 1
+		end
+
+		it "has correct value" do
+			expect(@node.value).to eql 42
+		end
+	end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubystructures
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-30 00:00:00.000000000 Z
+date: 2014-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,10 +72,14 @@ files:
 - README.md
 - Rakefile
 - lib/rubystructures.rb
+- lib/rubystructures/linked_list.rb
+- lib/rubystructures/node.rb
 - lib/rubystructures/queue.rb
 - lib/rubystructures/stack.rb
 - lib/rubystructures/version.rb
 - rubystructures.gemspec
+- spec/linked_list_spec.rb
+- spec/node_spec.rb
 - spec/queue_spec.rb
 - spec/stack_spec.rb
 homepage: ''
@@ -104,5 +108,7 @@ signing_key:
 specification_version: 3
 summary: Simple, useful data structures in ruby.
 test_files:
+- spec/linked_list_spec.rb
+- spec/node_spec.rb
 - spec/queue_spec.rb
 - spec/stack_spec.rb