stringtree 0.1.0 → 0.1.1

data/README.md

@@ -16,7 +16,7 @@ This has become my 'hello world' over the years with any new language. I use it
 
 ## Installation
 
-```ruby
+```bash
 gem install stringtree
 ```
 
@@ -87,7 +87,7 @@ Type 'exit' to finish the demo.
 
 ## Code of Conduct
 
-The StringTree project is committed to the [Contributor Covenant](http://contributor-covenant.org). Please read [CODE_OF_CONDUCT.md] before making any contributions or comments.
+The StringTree project is committed to the [Contributor Covenant](http://contributor-covenant.org). Please read [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) before making any contributions or comments.
 
 ## References
 

data/lib/stringtree/node.rb

@@ -94,7 +94,7 @@ module StringTree
     # and repeating with the next character and so on. Return the last node if found, or nil if any
     # horizontal search fails. 
     # Optionally, set the offset into the string and its length
-    def find_vertical(str, offset = 0, length = str.length)
+    def find_vertical(str, offset = 0, length = str.length-offset)
       node = nil
       i = offset
       while (i<offset+length)
@@ -212,5 +212,15 @@ module StringTree
       @down.walk(str) { |str| list << str } unless @down.nil?
       list
     end
+
+    # Prune the tree back from this node onward so that all leaves have values.
+    def prune
+      return true if !@down.nil? && down.prune 
+      return true if !@left.nil? && left.prune 
+      return true if !@right.nil? && right.prune 
+      return true unless @value.nil?
+      up.down = nil if !up.nil? && left.nil? && right.nil?
+      false
+    end
   end
 end

data/lib/stringtree/tree.rb

@@ -6,7 +6,7 @@ module StringTree
     
     # Create a new empty Tree
     def initialize
-      @root = nil
+      clear
     end
 
     # Add a key and value to this Tree
@@ -15,18 +15,34 @@ module StringTree
       @root.add_vertical(key,value)
     end
 
+    alias []= add
+
+    # Clear the Tree (Remove all keys/values)
+    def clear
+      @root = nil
+    end
+
     # Find a specified key in the Tree, and return the value, or nil if not found.
     def find(key)
-      return nil if @root == nil
-      node = @root.find_vertical(key)
+      node = find_node(key)
       (node == nil ? nil : node.value)
     end
 
+    alias [] find
+
     # Return true if the given key exists
     def has_key?(key)
-      return false if @root == nil
-      node = @root.find_vertical(key) 
-      return false if node.nil? or node.value.nil?
+      !find_node(key).nil?
+    end
+
+    alias include? has_key?
+
+    # Delete a key 
+    def delete(key)
+      node = find_node(key) 
+      return false if node.nil?
+      node.value = nil
+      node.prune
       true
     end
 
@@ -45,6 +61,7 @@ module StringTree
     # Rebalance the tree for faster access.
     def optimize!
       return nil if @root == nil
+      @root.prune
       @root = @root.balance
     end
 
@@ -64,16 +81,6 @@ module StringTree
       end
     end
 
-    # Alias for find 
-    def [](key)
-      find(key)
-    end
-
-    # Alias for add
-    def []=(key,value)
-      add(key,value)
-    end
-
     # Return a Hash of terminating nodes to Integer counts for a given String data,
     # i.e. Find the count of instances of each String in the tree in the given data.
     def match_count(data, list = {})
@@ -94,5 +101,14 @@ module StringTree
       end
       list
     end
+
+    private
+
+    # Find a node by its key
+    def find_node(key)
+      return nil if @root == nil
+      node = @root.find_vertical(key)
+      (node.nil? || node.value.nil? ? nil : node)
+    end
   end
 end

data/lib/stringtree/version.rb

@@ -1,5 +1,5 @@
 # The StringTree module contains all the classes and constants for the `stringtree` gem.
 module StringTree
   # The current version of the `stringtree` gem
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/spec/tree_spec.rb

@@ -262,5 +262,51 @@ describe StringTree::Tree do
         end
       end
     end
+
+    describe '#delete' do
+      it 'should return false on empty tree' do
+        inst = StringTree::Tree.new
+
+        expect(inst.delete("test")).to be(false)
+      end
+      it 'should delete only the correct key and return true' do
+        inst = StringTree::Tree.new
+
+        inst["OneX"] = 5
+        inst["TwoX"] = 3
+        inst["TenX"] = 10
+
+        expect(inst.delete("TwoX")).to be(true)
+
+        expect(inst.has_key?("OneX")).to be(true)
+        expect(inst.has_key?("TenX")).to be(true)
+        expect(inst.has_key?("TwoX")).to be(false)
+      end
+
+      it 'should return false if key not found' do
+        inst = StringTree::Tree.new
+
+        inst["OneX"] = 5
+        inst["TwoX"] = 3
+        inst["TenX"] = 10
+
+        expect(inst.delete("FiveX")).to be(false)
+        expect(inst.delete("OneX1")).to be(false)
+        expect(inst.delete("Two")).to be(false)
+      end
+
+      it 'should not corrupt tree' do
+        inst = StringTree::Tree.new
+
+        inst["super"] = 5
+        inst["supercala"] = 3
+        inst["supercalafragilistic"] = 10
+
+        expect(inst.delete("super")).to be(true)
+        expect(inst.has_key?("super")).to be(false)
+        expect(inst.has_key?("supercala")).to be(true)
+        expect(inst.has_key?("supercalafragilistic")).to be(true)
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stringtree
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -176,7 +176,6 @@ files:
 - examples/dictionary.txt
 - examples/hamlet.txt
 - examples/warandpeace.txt
-- hamlet.tokens.txt
 - lib/stringtree.rb
 - lib/stringtree/item.rb
 - lib/stringtree/node.rb
@@ -187,7 +186,6 @@ files:
 - spec/spec_helper.rb
 - spec/tree_spec.rb
 - stringtree.gemspec
-- warandpeace.tokens.txt
 homepage: http://github.com/tomdionysus/stringtree-ruby
 licenses: []
 post_install_message: