datastructures 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Richard Smith
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,26 @@
+datastructures
+==============
+
+A collection of data structures in Ruby, made for my [data structures challenge](http://blahah.net/2013/08/18/algorithm-challenge)
+
+## Installation
+
+```bash
+gem install datastructures
+```
+
+## Day 1: Queue
+
+```
+require 'datastructure'
+queue = DataStructures::Queue.new
+queue.enqueue('first')
+queue.enqueue('second')
+queue.size # => 2
+queue.empty? # => false
+queue.front # => 'first'
+queue.back # => 'second'
+queue.dequeue # => 'first'
+queue.dequeue # => 'second'
+queue.dequeue # => RuntimeError, "Queue underflow: nothing to dequeue"
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/datastructures.rb

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

data/lib/datastructures/queue.rb

@@ -0,0 +1,42 @@
+module DataStructures
+  # Implements a simple FIFO (first in, first out) queue data
+  # structure using an array container.
+  class Queue
+
+    def initialize
+      self.clear
+    end
+
+    def size
+      @array.size
+    end
+
+    alias :length :size
+
+    def empty?
+      @array.empty?
+    end
+
+    def enqueue item
+      @array.push item
+    end
+
+    def dequeue
+      raise "Queue underflow: nothing to dequeue." if self.size == 0
+      @array.shift
+    end
+
+    def front
+      @array.first
+    end
+
+    def back
+      @array.last
+    end
+
+    def clear
+      @array = Array.new
+    end
+
+  end
+end

data/lib/datastructures/version.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module DataStructures
+  module VERSION
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    BUILD = nil
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');
+  end
+end # DataStructures

data/test/test_datastructures.rb

@@ -0,0 +1,3 @@
+require 'test/unit'
+require 'datastructures'
+

data/test/test_queue.rb

@@ -0,0 +1,45 @@
+require 'test/unit'
+require 'datastructures'
+
+class TestQueue < Test::Unit::TestCase
+
+  def test_queue
+
+    # we can create a queue
+    queue = DataStructures::Queue.new
+
+    # should start empty
+    assert queue.empty?
+    assert queue.size == 0
+
+    # underflow raises error
+    assert_raise RuntimeError, "Queue underflow: nothing to dequeue" do
+      queue.dequeue
+    end
+
+    # enqueueing increases size, removes emptiness
+    queue.enqueue('first')
+    assert !queue.empty?
+    assert queue.size == 1
+
+    # more enqueueing just increments size
+    queue.enqueue('second')
+    assert queue.size == 2
+
+    # dequeueing returns first in, reduces size
+    assert queue.dequeue == 'first'
+    assert queue.size == 1
+
+    # more dequeueing empties the queue
+    assert queue.dequeue == 'second'
+    assert queue.size == 0
+    assert queue.empty?
+
+    # trying to continue gives underflow
+    assert_raise RuntimeError, "Queue underflow: nothing to dequeue" do
+      queue.dequeue
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: datastructures
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Richard Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.7
+description: ! ' 42 useful data structures implemented in pure Ruby for my data structures
+  challenge. '
+email: rds45@cam.ac.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/datastructures/queue.rb
+- lib/datastructures/version.rb
+- lib/datastructures.rb
+- test/test_datastructures.rb
+- test/test_queue.rb
+- README.md
+- LICENSE
+homepage: https://github.com/Blahah/datastructures
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: 42 useful data structures
+test_files: []