RubyDataStructures 1.0.0 → 1.1.0

data/README.md

@@ -22,10 +22,25 @@ Usage
 The `RubyDatStructures` library can be easily imported by running:
 
     require 'rubygems'
-    require 'RubyDatStructures'
+    require 'RubyDataStructures'
 
 The usage of each of the data structures is described below.
 
+You can enable macros to more conveniently create these data structures by:
+
+    require 'RubyDataStructures/macros'
+
+    @stack = stack(3)
+    @fifo = fifo_stack(5)
+    @arr = multi_array(1,2,3)
+    ...
+
+## Tests
+
+Run tests/specs from console: 
+
+    rake test
+
 ## Multi Dimensional Array
 
 A `multi dimensional array` can be initialized by running:
@@ -72,6 +87,10 @@ Examples:
     my_stach.push(3)
     my_stack.pop        # Return `3`
 
+*Notes:*
+Why not use the internal `#push` and `#pop` methods of Array that already makes an Array simulate a stack? Why create the initial array with the full max length?
+Perhaps make this a config option?
+
 ## Queue
 
 A `Queue` can be initialized by calling:

data/RELEASE_NOTES

@@ -1,3 +1,14 @@
+= Announce: Ruby DataStructures Release 1.1.0
+
+- Added FifoStack.
+- Added macros
+- Extra Documentation
+- Rakefile for running tests
+
+= Announce: Ruby DataStructures Release 1.0.0
+
+Basic data structures in place
+
 = Announce: Ruby DataStructures Release 0.0.4
 Date Mar 5, 2011
 Release 0.0.4 is just a dummy release to fix some gem push issues.

data/Rakefile

@@ -1,2 +1,10 @@
 require 'bundler'
-Bundler::GemHelper.install_tasks
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end

data/lib/RubyDataStructures.rb

@@ -4,6 +4,7 @@ require 'RubyDataStructures/ruby_data_structures'
 # All RubyDataStructures
 require 'RubyDataStructures/multi_dimensional_array'
 require 'RubyDataStructures/stack_as_array'
+require 'RubyDataStructures/fifo_stack'
 require 'RubyDataStructures/queue_as_array'
 require 'RubyDataStructures/singly_linked_list'
 require 'RubyDataStructures/singly_linked_list/element'

data/lib/RubyDataStructures/fifo_stack.rb

@@ -0,0 +1,17 @@
+class RubyDataStructures::FifoStack < RubyDataStructures::StackAsArray
+  def push(element)
+    
+    if self.full?
+      @array.shift
+      @top -= 1
+    end      
+
+    if self.empty?
+      @top = 0
+    else
+      @top = @top + 1
+    end
+
+    @array[@top] = element
+  end  
+end

data/lib/RubyDataStructures/macros.rb

@@ -0,0 +1,30 @@
+def fifo_stack size=1
+  RubyDataStructures::FifoStack.new size
+end
+
+def stack size=1
+  RubyDataStructures::Stack.new size
+end
+
+def multi_array(*dimensions)
+  RubyDataStructures::MultiDimensionalArray.new(*dimensions)
+end
+
+def max_heap(*array)
+  RubyDataStructures::MaxHeap.build(array.flatten)
+end
+
+def linked_list(type = :single)
+  case type
+  when :single 
+    RubyDataStructures::SinglyLinkedList.new 
+  when :double, :dbl
+    RubyDataStructures::DoublyLinkedList.new
+  else
+    raise ArgumentError, "Unknown or unsupported kind of Linked List: #{type}, must be: :single or :double"
+  end
+end
+
+def aqueue size
+  RubyDataStructures::QueueAsArray.new size
+end

data/lib/RubyDataStructures/stack_as_array.rb

@@ -1,4 +1,6 @@
 class RubyDataStructures::StackAsArray
+  attr_reader :length, :top
+
   # Initializes a stack of size +size+
   # The value of +top+ for an empty stack is +nil+
   def initialize(size = 1)
@@ -53,6 +55,23 @@ class RubyDataStructures::StackAsArray
     @array = Array.new(@length)
     @top = nil
   end
+  alias_method :reset!, :reset
+
+  def size
+    @array.size
+  end
+
+  def first
+    @array.first
+  end
 
-  #TODO: Implement *each* method
+  def last
+    @array[@top]
+  end
+
+  def each
+    @array.each do
+      yield
+    end
+  end
 end

data/lib/RubyDataStructures/version.rb

@@ -1,3 +1,3 @@
 module Rubydatastructures
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/test/fifo_stack_test.rb

@@ -0,0 +1,54 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'test/unit'
+require 'RubyDataStructures'
+
+class AutoStackTest < Test::Unit::TestCase
+  def test_fifo_stack
+    stack = RubyDataStructures::FifoStack.new(2)
+
+    assert stack.empty?
+    assert !stack.singleton?
+    assert !stack.full?
+    assert stack.length == 2
+    # assert stack.size == 0
+
+    assert_raise RuntimeError, "Stack Underflow - The stack is empty" do
+      stack.pop
+    end
+
+    stack.push(1)
+    assert !stack.empty?
+    assert stack.singleton?
+    assert !stack.full?
+    assert stack.first == 1
+    assert stack.length == 2
+    assert stack.last == 1
+    # assert stack.size == 1
+
+    stack.push(2)
+    assert !stack.empty?
+    assert !stack.singleton?
+    assert stack.full?
+    assert stack.first == 1
+    assert stack.last == 2
+
+    stack.push(3)
+    assert !stack.empty?
+    assert !stack.singleton?
+    assert stack.full?
+    assert stack.size == 2    
+    assert stack.first == 2
+    assert stack.last == 3
+
+    stack.push(4)
+    assert !stack.empty?
+    assert !stack.singleton?
+    assert stack.full?
+    assert stack.first == 3
+    assert stack.last == 4
+    assert stack.pop == 4
+    assert !stack.full?
+    assert stack.size == 2
+  end
+end

metadata

@@ -1,33 +1,23 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: RubyDataStructures
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Satyaram B V
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-16 00:00:00 +05:30
-default_executable: 
+date: 2012-11-25 00:00:00.000000000 Z
 dependencies: []
-
 description: Implementation of standard data structures in Ruby
-email: 
+email:
 - bvsatyaramATgmailDOTcom
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE
@@ -38,6 +28,8 @@ files:
 - lib/RubyDataStructures.rb
 - lib/RubyDataStructures/doubly_linked_list.rb
 - lib/RubyDataStructures/doubly_linked_list/element.rb
+- lib/RubyDataStructures/fifo_stack.rb
+- lib/RubyDataStructures/macros.rb
 - lib/RubyDataStructures/max_heap.rb
 - lib/RubyDataStructures/multi_dimensional_array.rb
 - lib/RubyDataStructures/queue_as_array.rb
@@ -49,41 +41,35 @@ files:
 - test/RubyDataStructureTest.rb
 - test/doubly_linked_list_element_test.rb
 - test/doubly_linked_list_test.rb
+- test/fifo_stack_test.rb
 - test/max_heap_test.rb
 - test/multi_dimensional_array_test.rb
 - test/queue_as_array_test.rb
 - test/singly_linked_list_element_test.rb
 - test/singly_linked_list_test.rb
 - test/stack_as_array_test.rb
-has_rdoc: true
 homepage: http://bvsatyaram.com
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: RubyDataStructures
-rubygems_version: 1.3.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Implementation of standard data structures in Ruby
 test_files: []
-