datastructures 0.1.2 → 0.2.0

data/README.md

@@ -21,6 +21,10 @@ A collection of data structures in Ruby, made for my [data structures challenge]
 
 ## Day 1: Queue
 
+A queue is a simple container-based structure that mimics a real-life queue (e.g. waiting in line at the bank). It is FIFO (first-in-first-out), meaning that when you retrieve items from the queue, they are returned in the order in which they entered. Ruby Arrays provide methods that make Queue implementation trivially easy, but having them named appropriately and contained in a convenience class is worth it to see how they are implemented, and because other structures will inherit from this one. An alternate implementation could be done using a linked list.
+
+Usage:
+
 ```ruby
 require 'datastructure'
 queue = DataStructures::Queue.new
@@ -34,3 +38,23 @@ queue.dequeue # => 'first'
 queue.dequeue # => 'second'
 queue.dequeue # => RuntimeError, "Queue underflow: nothing to dequeue"
 ```
+
+## Day 2: Stack
+
+The stack is the sibling of the queue. It mimicks a real-life stack (e.g. of paper). It is FILO (first-in-last-out), so that when items are retrieved from the stack, they are returned in the reverse of the order in which they were added. Again, Ruby Arrays provide a perfect container. As with the Queue, it could also be implemented using a linked list.
+
+Usage:
+
+```ruby
+require 'datastructure'
+stack = DataStructures::Stack.new
+stack.push('first')
+stack.push('second')
+stack.size # => 2
+stack.empty? # => false
+stack.top # => 'second'
+stack.bottom # => 'first'
+stack.pop # => 'second'
+stack.pop # => 'first'
+stack.pop # => RuntimeError, "Stack underflow: nothing to pop"
+```

data/lib/datastructures.rb

@@ -1,2 +1,3 @@
 require 'datastructures/version'
-require 'datastructures/queue'
+require 'datastructures/queue'
+require 'datastructures/stack'

data/lib/datastructures/stack.rb

@@ -0,0 +1,42 @@
+module DataStructures
+  # Implements a simple FILO (first in, last out) stack data
+  # structure using an array container.
+  class Stack
+
+    def initialize
+      self.clear
+    end
+
+    def size
+      @array.size
+    end
+
+    alias :length :size
+
+    def empty?
+      @array.empty?
+    end
+
+    def push item
+      @array.push item
+    end
+
+    def pop
+      raise "Stack underflow: nothing to pop." if self.size == 0
+      @array.pop
+    end
+
+    def top
+      @array.last
+    end
+
+    def bottom
+      @array.first
+    end
+
+    def clear
+      @array = Array.new
+    end
+
+  end
+end

data/lib/datastructures/version.rb

@@ -3,8 +3,8 @@
 module DataStructures
   module VERSION
     MAJOR = 0
-    MINOR = 1
-    PATCH = 2
+    MINOR = 2
+    PATCH = 0
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');

data/test/test_queue.rb

@@ -73,6 +73,14 @@ class TestQueue < Test::Unit::TestCase
       assert @queue.empty?
     end
 
-  end
+    should "become empty when cleared" do
+      @queue.enqueue('first')
+      @queue.enqueue('second')
+      @queue.clear
+      assert @queue.size == 0
+      assert @queue.empty?
+    end
+
+  end # Queue context
 
-end
+end # TestQueue

data/test/test_stack.rb

@@ -0,0 +1,86 @@
+require 'test_datastructures'
+
+class TestStack < Test::Unit::TestCase
+
+  context "stack" do
+
+    setup do
+      @stack = DataStructures::Stack.new
+    end
+
+    should "be able to create a new instance" do
+      @stack = DataStructures::Stack.new
+    end
+
+    should "begin empty" do
+      assert @stack.empty?
+      assert @stack.size == 0
+    end
+
+    should "raise an error on underflow" do
+      assert_raise RuntimeError, "Stack underflow: nothing to pop" do
+        @stack.pop
+      end
+    end
+
+    should "stop being empty when first item added" do
+      @stack.push('first')
+      assert !@stack.empty?
+      assert @stack.size == 1
+    end
+
+    should "increment size on pushing" do
+      @stack.push('first')
+      @stack.push('second')
+      assert @stack.size == 2
+    end
+
+    should "respond to size and length" do
+      @stack.push('first')
+      assert @stack.size == @stack.length
+    end
+
+    should "have first item on the bottom" do
+      @stack.push('first')
+      @stack.push('second')
+      assert @stack.bottom == 'first'
+    end
+
+    should "have last item in on the top" do
+      @stack.push('first')
+      @stack.push('second')
+      assert @stack.top == 'second'
+    end
+
+    should "return top of stack and get smaller on popping" do
+      @stack.push('first')
+      @stack.push('second')
+      assert @stack.pop == 'second'
+      assert @stack.size == 1
+    end
+
+    should "have top and bottom items equal when length is one" do
+      @stack.push('first')
+      assert @stack.size == 1
+      assert @stack.top == @stack.bottom
+    end
+
+    should "become empty when last item popped" do
+      @stack.push('first')
+      @stack.push('second')
+      2.times{ @stack.pop }
+      assert @stack.size == 0
+      assert @stack.empty?
+    end
+
+    should "become empty when cleared" do
+      @stack.push('first')
+      @stack.push('second')
+      @stack.clear
+      assert @stack.size == 0
+      assert @stack.empty?
+    end
+
+  end # Stack context
+
+end # TestStack

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datastructures
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -32,33 +32,33 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.7.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.7.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -75,7 +75,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.6.7
-description: ! ' 42 useful data structures implemented in pure Ruby for my data structures
+description: ! ' useful data structures implemented in pure Ruby for my data structures
   challenge. '
 email: rds45@cam.ac.uk
 executables: []
@@ -84,10 +84,12 @@ extra_rdoc_files: []
 files:
 - Rakefile
 - lib/datastructures/queue.rb
+- lib/datastructures/stack.rb
 - lib/datastructures/version.rb
 - lib/datastructures.rb
 - test/test_datastructures.rb
 - test/test_queue.rb
+- test/test_stack.rb
 - README.md
 - LICENSE
 homepage: https://github.com/Blahah/datastructures
@@ -113,5 +115,5 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: 42 useful data structures
+summary: useful data structures
 test_files: []