ruby-avl 0.0 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a02458c007e726e16b423af5bec30aabd799260
-  data.tar.gz: e0e82835afd930aff2858a6083b2357c084d300e
+  metadata.gz: ba7ed4b2854e4898a5f144338fcd57bdd6241ecb
+  data.tar.gz: 248d30f972253910cbf89b0b5975e8183684c60f
 SHA512:
-  metadata.gz: 3fd204050d57a8f9918d2487bec619d82043352f0052f71bc75932db3e869ef2e959b02ec094b8252c14986a69c321b23403f5c99634f0f0ac0f012fb3388f4c
-  data.tar.gz: d45ac33cc6aa5850cfe309873000c36b81b66f0f6ef94860988e9e8e4b6e650bd5331c8f6593b10fbabbf9ab107b3eddb6fd788c7866873a49b112c338a2ac5e
+  metadata.gz: d084dd9f52378fc4e9f6c4ca07233bd787b406ad20364fb067d509549ec24cfa64b7e5d619f0bc3b3c84a46640a4188612754501ffda7ba3323c88e67e876d11
+  data.tar.gz: 423590f797b7e02a02d7e9323c8c13181becd1e61b8f82daf84c7d1279456621d2b15b060d322378809c42f63166bf1a44ebd4fab7817b871d73ac3f38fc03b7

data/README.md

@@ -0,0 +1,57 @@
+# Ruby AVL
+
+An implementation of the Adelson-Velsky and Landis self-balancing binary search tree written in Ruby.
+
+***
+
+## Usage
+
+The AVL Tree allows any object to be placed into a Node. However, comparison of the objects needs to be done on an attribute, otherwise the tree won't be able to judge which sub-tree to insert the Node to. This is done easily by implementing the method #compare_to on your object:
+
+    class Person
+      attr_accessor :name
+
+      def compare_to(other_person)
+        this.name <=> other_person.name
+      end
+    end
+
+In the above example, a Person object can be added to the tree and it will be balanced on the lexicographical comparison of their name with another Person object's name attribute. This allows you to have more complex trees.
+
+If you just want to build a tree from simple data types (Fixnum, String, etc.) that can already be compared then you don't need to implement this method.
+
+***
+
+To use the AVL Tree is simple, first initialise it:
+
+    avl_tree = AVLTree::AVLTree.new
+
+Then add the data:
+
+    avl_tree.insert_item(1)
+    avl_tree.insert_item(2)
+    avl_tree.insert_item(3)
+
+Remove data if necessary:
+
+    avl_tree.remove_item(3)
+
+***
+
+To view the tree's structural information: use one (or all) of the traversals. Pass in the root of the AVL Tree as the first parameter.
+This will return a string representing the nodes in the tree:
+
+    AVLTree::BSTreeTraversal.new.pre_order_string(avl_tree.root)
+    AVLTree::BSTreeTraversal.new.in_order_string(avl_tree.root)
+    AVLTree::BSTreeTraversal.new.post_order_string(avl_tree.root)
+
+This will return an Array with each element representing a node in the tree:
+
+    AVLTree::BSTreeTraversal.new.pre_order_array(avl_tree.root)
+    AVLTree::BSTreeTraversal.new.in_order_array(avl_tree.root)
+    AVLTree::BSTreeTraversal.new.post_order_array(avl_tree.root)
+
+An optional parameter can be passed into this function to print out an attribute of the data in the node, instead of the node itself. Obviously, the attribute needs to exist on the object:
+
+    AVLTree::BSTreeTraversal.new.pre_order_string(avl_tree.root, :name)
+    AVLTree::BSTreeTraversal.new.pre_order_array(avl_tree.root, :name)

data/lib/ruby-avl/avl_tree.rb

@@ -1,6 +1,6 @@
 require_relative 'bs_tree'
 module AVLTree
-  class AVLTree < BSTree::BSTree
+  class AVLTree < BSTree
 
     # Public interfaces implemented in superclass
 

data/lib/ruby-avl/bs_tree.rb

@@ -1,4 +1,4 @@
-module BSTree  
+module AVLTree  
   class BSTree
 
     attr_reader :root
@@ -40,7 +40,7 @@ module BSTree
     # raised to inform the user of duplication.
     def add_to_tree(item, node)
       if node.nil?
-        return Node::Node.new(item)
+        return Node.new(item)
       elsif compare(item, node.data) < 0
         node.left = add_to_tree(item, node.left)
       elsif compare(item, node.data) > 0

data/lib/ruby-avl/bs_tree_traversal.rb

@@ -1,4 +1,4 @@
-module BSTreeTraversal
+module AVLTree
   class BSTreeTraversal
 
     def pre_order_array(root_node, attribute = nil)

data/lib/ruby-avl/node.rb

@@ -1,4 +1,4 @@
-module Node
+module AVLTree
 	class Node
 	  attr_accessor :data, :left, :right
 

data/lib/ruby-avl/version.rb

@@ -1,3 +1,3 @@
-module AVL
-	VERSION = '0.0'
+module AVLTree
+	VERSION = '0.3'
 end

data/ruby-avl.gemspec

@@ -2,12 +2,12 @@ require File.expand_path('../lib/ruby-avl/version', __FILE__)
 
 Gem::Specification.new do |s|
   s.name          = 'ruby-avl'
-  s.version       = AVL::VERSION
-  s.date          = '2016-04-30'
+  s.version       = AVLTree::VERSION
+  s.date          = '2016-11-03'
   s.description   = s.summary = 'A simple AVL Tree implemented in Ruby'
   s.authors       = ['Daniel Byers']
   s.email         = 'daniel_byers@hotmail.co.uk'
-  s.homepage      = 'http://rubygems.org/gems/ruby-avl'
+  s.homepage      = 'https://github.com/daniel-byers/ruby-avl'
   s.license       = 'MIT'
 
   s.files         = `git ls-files`.split("\n")

data/spec/avl_tree_spec.rb

@@ -3,7 +3,7 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
 Given.use_natural_assertions
 
 describe AVLTree::AVLTree do
-    Given(:node) { Node::Node.new(25) }
+    Given(:node) { AVLTree::Node.new(25) }
 
   context 'initialize a AVL Tree with a null root' do
     Then { subject.root == nil }

data/spec/bs_tree_spec.rb

@@ -2,15 +2,15 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
 
 Given.use_natural_assertions
 
-describe BSTree::BSTree do
-  Given(:node) { Node::Node.new(1) }
+describe AVLTree::BSTree do
+  Given(:node) { AVLTree::Node.new(1) }
 
   context 'initialize a BS Tree with a null root' do
     Then { subject.root == nil }
   end
 
   context 'initialize a BS Tree with a root node' do
-    Given(:subject) { BSTree::BSTree.new(node) }
+    Given(:subject) { AVLTree::BSTree.new(node) }
     Then { subject.root == node }
   end
 

data/spec/bs_tree_traversal_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
 
 Given.use_natural_assertions
 
-describe BSTreeTraversal::BSTreeTraversal do
+describe AVLTree::BSTreeTraversal do
   # Given returns the last node of the AVL Tree instead of the tree object itself.
   # In production, avl_tree.root would need to be passed into the traversal methods.
   Given(:avl_tree) {

data/spec/node_spec.rb

@@ -2,9 +2,9 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
 
 Given.use_natural_assertions
 
-describe Node::Node do
+describe AVLTree::Node do
   context 'should initialize a new node' do
-    Given(:node) { Node::Node.new('test string') }
+    Given(:node) { AVLTree::Node.new('test string') }
     Then  { node.data == 'test string' }
     And   { node.left == nil}
     And   { node.right == nil}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-avl
 version: !ruby/object:Gem::Version
-  version: '0.0'
+  version: '0.3'
 platform: ruby
 authors:
 - Daniel Byers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-30 00:00:00.000000000 Z
+date: 2016-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -74,7 +74,7 @@ files:
 - spec/bs_tree_traversal_spec.rb
 - spec/node_spec.rb
 - spec/spec_helper.rb
-homepage: http://rubygems.org/gems/ruby-avl
+homepage: https://github.com/daniel-byers/ruby-avl
 licenses:
 - MIT
 metadata: {}
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A simple AVL Tree implemented in Ruby