rambling-trie 0.2.0 → 0.3.0

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2011-2012 Rambling Labs
+
+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.markdown

@@ -0,0 +1,111 @@
+# Rambling Trie
+
+The Rambling Trie is a custom implementation of the Trie data structure with Ruby, which includes compression abilities and is designed to be very fast to traverse.
+
+## Installing the Rambling Trie
+
+### Requirements
+
+You will need:
+
+* Ruby 1.9.2 or up
+* RubyGems
+
+See [RVM](http://beginrescueend.com) or [rbenv](https://github.com/sstephenson/rbenv) for more information on how to manage Ruby versions.
+
+### Installation
+
+You can either install it manually with:
+
+<pre><code>gem install rambling-trie
+</code></pre>
+
+Or, include it in your `Gemfile` and bundle it:
+
+``` ruby
+gem 'rambling-trie'
+```
+
+## How to use the Rambling Trie
+
+To create the trie, initialize it like this:
+
+``` ruby
+trie = Rambling::Trie.new
+```
+
+You can also provide a file which contains all the words to be added to the trie, and it will read the file and create the structure for you, like this:
+
+``` ruby
+trie = Rambling::Trie.new('/path/to/file')
+```
+
+To add new words to the trie, use `add_branch_from`:
+
+``` ruby
+trie.add_branch_from('word')
+```
+
+And to find out if a word already exists in the trie, use `is_word?`:
+
+``` ruby
+trie.is_word?('word')
+```
+
+If you wish to find if part of a word exists in the `Rambling::Trie` instance, you should call `has_branch_from?`:
+
+``` ruby
+trie.has_branch_from?('partial_word')
+```
+
+### Compression
+
+By default, the Rambling Trie works as a Standard Trie.
+You can obtain a Compressed Trie from the Standard one, by using the compression feature.
+Just call the `compress!` method on the `Rambling::Trie` instance:
+
+``` ruby
+trie.compress!
+```
+
+This will reduce the amount of Trie nodes by eliminating the redundant ones, which are the only-child non-terminal nodes.
+This will also make the Trie faster to traverse.
+
+__Note that the `compress!` method acts over the `Rambling::Trie` instance it belongs to.__
+__Also, words added after compression will create new nodes and re-compression is not supported.__
+
+You can find out if a `Rambling::Trie` instance is compressed by calling the `compressed?` method:
+
+``` ruby
+trie.compressed?
+```
+
+## Compatible Ruby and Rails versions
+
+The Rambling Trie has been tested with the following Ruby versions:
+
+* 1.9.2
+* 1.9.3
+
+And the following Rails versions:
+
+* 3.1.x
+* 3.2.x
+
+It's possible that Ruby 1.8.7 and Rails 3.0.x are supported, but there is no guarantee.
+
+## Contributing to Rambling Trie
+
+If you want to contribute to this project, you will need RSpec to run the tests.
+Also, be sure to add tests for any feature you may develop or bug you may fix.
+
+## License and copyright
+
+Copyright (c) 2012 Rambling Labs
+
+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/lib/trie_compressor.rb

@@ -2,7 +2,7 @@ module Rambling
   module TrieCompressor
     def compress!
       if @children.size == 1 and not terminal?
-        transfer_ownership_from(@children.values.first)
+        merge_with!(@children.values.first)
         compress!
       end
 
@@ -13,14 +13,26 @@ module Rambling
 
     private
 
-    def transfer_ownership_from(child)
-      @parent.delete(@letter) unless @parent.nil?
-      @letter = (@letter.to_s + child.letter.to_s).to_sym
-      @parent[@letter] = self unless @parent.nil?
+    def merge_with!(child)
+      new_letter = (@letter.to_s + child.letter.to_s).to_sym
+
+      rehash_on_parent!(@letter, new_letter)
+      redefine_self!(new_letter, child)
 
-      @children = child.children
-      @is_terminal = child.terminal?
       @children.values.each { |node| node.parent = self }
     end
+
+    def rehash_on_parent!(old_letter, new_letter)
+      return if @parent.nil?
+
+      @parent.delete(old_letter)
+      @parent[new_letter] = self
+    end
+
+    def redefine_self!(new_letter, merged_node)
+      @letter = new_letter
+      @children = merged_node.children
+      @is_terminal = merged_node.terminal?
+    end
   end
 end

data/lib/trie_node.rb

@@ -11,7 +11,7 @@ module Rambling
       @is_terminal = false
       @children = {}
 
-      unless word.nil?
+      unless word.nil? or word.empty?
         letter = word.slice!(0)
         @letter = letter.to_sym unless letter.nil?
         @is_terminal = word.empty?
@@ -28,21 +28,20 @@ module Rambling
     end
 
     def add_branch_from(word)
-      unless word.empty?
-        first_letter = word.slice(0).to_sym
-
-        if @children.has_key?(first_letter)
-          word.slice!(0)
-          @children[first_letter].add_branch_from(word)
-        else
-          @children[first_letter] = TrieNode.new(word, self)
-        end
+      return if word.empty?
+
+      first_letter = word.slice(0).to_sym
+
+      if @children.has_key?(first_letter)
+        word.slice!(0)
+        @children[first_letter].add_branch_from(word)
+      else
+        @children[first_letter] = TrieNode.new(word, self)
       end
     end
 
     def has_branch_for?(word)
-      return true if word.empty?
-      branch_exists_and(word) { |node, sliced_word| node.has_branch_for?(sliced_word) }
+      word.empty? or branch_exists_and(word, :has_branch_for?)
     end
 
     def as_word
@@ -50,18 +49,13 @@ module Rambling
       get_letter_string
     end
 
-    def is_word?(word)
-      return true if word.empty? and terminal?
-      branch_exists_and(word) { |node, sliced_word| node.is_word?(sliced_word) }
+    def is_word?(word = '')
+      (word.empty? and terminal?) or branch_exists_and(word, :is_word?)
     end
 
     protected
     def get_letter_string
-      if @parent.nil?
-        @letter.to_s or ''
-      else
-        @parent.get_letter_string + @letter.to_s
-      end
+      (@parent.nil? ? '' : @parent.get_letter_string) + @letter.to_s
     end
 
     def parent=(parent)
@@ -70,15 +64,13 @@ module Rambling
 
     private
 
-    def branch_exists_and(word, &block)
+    def branch_exists_and(word, method)
       first_letter = word.slice!(0)
 
-      unless first_letter.nil?
-        first_letter = first_letter.to_sym
-        return block.call(@children[first_letter], word) if @children.has_key?(first_letter)
-      end
+      return false if first_letter.nil?
 
-      false
+      first_letter_key = first_letter.to_sym
+      @children.has_key?(first_letter_key) ? @children[first_letter_key].send(method, word) : false
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rambling-trie
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-07 00:00:00.000000000Z
-dependencies: []
-description: A custom implementation of the trie data structure
+date: 2012-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &15464280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *15464280
+description: The Rambling Trie is a custom implementation of the Trie data structure
+  with Ruby, which includes compression abilities and is designed to be very fast
+  to traverse.
 email: development@ramblinglabs.com
 executables: []
 extensions: []
@@ -23,7 +36,9 @@ files:
 - ./lib/trie.rb
 - ./lib/trie_compressor.rb
 - ./lib/trie_node.rb
-homepage: http://rubygems.org/gems/rambling-trie
+- LICENSE
+- README.markdown
+homepage: http://github.com/ramblinglabs/rambling-trie
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -46,5 +61,5 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Rambling Trie
+summary: A custom implementation of the trie data structure.
 test_files: []