rambling-trie 0.4.0 → 0.4.1

data/.gitignore

@@ -13,3 +13,7 @@ coverage/
 
 # RubyProf
 reports/
+
+# Bundler
+.bundle
+pkg

data/README.markdown

@@ -28,31 +28,37 @@ gem 'rambling-trie'
 
 ## How to use the Rambling Trie
 
+### Deprecation warning
+
+Starting from version 0.4.0, `Rambling::Trie.new` is deprecated. Please use `Rambling::Trie.create` instead.
+
 To create the trie, initialize it like this:
 
 ``` ruby
-trie = Rambling::Trie.new
+trie = Rambling::Trie.create
 ```
 
 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'
+trie = Rambling::Trie.create '/path/to/file'
 ```
 
-To add new words to the trie, use `add_branch_from`:
+To add new words to the trie, use `add_branch_from` or `<<`:
 
 ``` ruby
 trie.add_branch_from 'word'
+trie << 'word'
 ```
 
-And to find out if a word already exists in the trie, use `is_word?`:
+And to find out if a word already exists in the trie, use `is_word?` or `include?`:
 
 ``` ruby
 trie.is_word? 'word'
+trie.include? 'word'
 ```
 
-If you wish to find if part of a word exists in the `Rambling::Trie` instance, you should call `has_branch_for?`:
+If you wish to find if part of a word exists in the trie instance, you should call `has_branch_for?`:
 
 ``` ruby
 trie.has_branch_for? 'partial_word'
@@ -62,7 +68,7 @@ trie.has_branch_for? 'partial_word'
 
 By default, the Rambling Trie works as a Standard Trie.
 Starting from version 0.1.0, 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:
+Just call the `compress!` method on the trie instance:
 
 ``` ruby
 trie.compress!
@@ -72,10 +78,10 @@ This will reduce the amount of Trie nodes by eliminating the redundant ones, whi
 
 Starting from version 0.3.2, the `has_branch_for?` and `is_word?` methods work as expected on a compressed trie.
 
-__Note that the `compress!` method acts over the `Rambling::Trie` instance it belongs to.__
+__Note that the `compress!` method acts over the trie instance it belongs to.__
 __Also, adding words after compression is not supported.__
 
-You can find out if a `Rambling::Trie` instance is compressed by calling the `compressed?` method:
+You can find out if a trie instance is compressed by calling the `compressed?` method:
 
 ``` ruby
 trie.compressed?

data/lib/rambling-trie.rb

@@ -1,22 +1,27 @@
 [
-  'rambling',
-  'rambling-trie/invalid_operation',
-  'rambling-trie/children_hash_deferer',
-  'rambling-trie/compressor',
-  'rambling-trie/branches',
-  'rambling-trie/node',
-  'rambling-trie/root',
-  'rambling-trie/version'
-].each do |file|
-  require File.join File.dirname(__FILE__), file
-end
+  'invalid_operation',
+  'children_hash_deferer',
+  'compressor',
+  'branches',
+  'node',
+  'root',
+  'version'
+].map { |file| File.join('rambling-trie', file) }.each &method(:require)
 
 module Rambling
   module Trie
     class << self
+      # Creates a new Trie. Entry point for the Rambling::Trie API.
+      # @param [String, nil] filename the file to load the words from (defaults to nil).
       def create(*params)
         Root.new *params
       end
+
+      # @deprecated Please use {#create} instead
+      def new(*params)
+        warn '[DEPRECATION] `new` is deprecated. Please use `create` instead.'
+        create *params
+      end
     end
   end
 end

data/lib/rambling-trie/branches.rb

@@ -9,71 +9,65 @@ module Rambling
       def add_branch_from(word)
         raise InvalidOperation.new('Cannot add branch to compressed trie') if compressed?
         if word.empty?
-          @is_terminal = true
+          @terminal = true
           return
         end
 
         first_letter = word.slice(0).to_sym
 
-        if @children.has_key?(first_letter)
-          word.slice!(0)
+        if @children.has_key? first_letter
+          word.slice! 0
           child = @children[first_letter]
-          child.add_branch_from(word)
+          child << word
           child
         else
           @children[first_letter] = Node.new word, self
         end
       end
 
+      alias_method :<<, :add_branch_from
+
       protected
 
-      def has_uncompressed_branch_for?(chars)
-        chars.empty? or fulfills_uncompressed_condition?(:has_uncompressed_branch_for?, chars)
+      def uncompressed_has_branch_for?(chars)
+        chars.empty? or fulfills_uncompressed_condition?(:uncompressed_has_branch_for?, chars)
       end
 
-      def has_compressed_branch_for?(chars)
+      def compressed_has_branch_for?(chars)
         return true if chars.empty?
 
-        first_letter = chars.slice!(0)
-        key = nil
-        @children.keys.each do |x|
-          x = x.to_s
-          if x.start_with?(first_letter)
-            key = x
-            break
-          end
-        end
+        first_letter = chars.slice! 0
+        current_key, current_key_string = current_key first_letter
 
-        unless key.nil?
-          sym_key = key.to_sym
-          return @children[sym_key].has_compressed_branch_for?(chars) if key.length == first_letter.length
+        unless current_key.nil?
+          return @children[current_key].compressed_has_branch_for?(chars) if current_key_string.length == first_letter.length
 
           while not chars.empty?
-            char = chars.slice!(0)
+            char = chars.slice! 0
 
-            break unless key[first_letter.length] == char
+            break unless current_key_string[first_letter.length] == char
 
             first_letter += char
             return true if chars.empty?
-            return @children[sym_key].has_compressed_branch_for?(chars) if key.length == first_letter.length
+            return @children[current_key].compressed_has_branch_for?(chars) if current_key_string.length == first_letter.length
           end
         end
 
         false
       end
 
-      def is_uncompressed_word?(chars)
-        (chars.empty? and terminal?) or fulfills_uncompressed_condition?(:is_uncompressed_word?, chars)
+      def uncompressed_is_word?(chars)
+        (chars.empty? and terminal?) or fulfills_uncompressed_condition?(:uncompressed_is_word?, chars)
       end
 
-      def is_compressed_word?(chars)
+      def compressed_is_word?(chars)
         return true if chars.empty? and terminal?
 
         first_letter = ''
         while not chars.empty?
-          first_letter += chars.slice!(0)
+          first_letter += chars.slice! 0
           key = first_letter.to_sym
-          return @children[key].is_compressed_word?(chars) if @children.has_key?(key)
+          return @children[key].compressed_is_word?(chars) if @children.has_key? key
         end
 
         false
@@ -81,11 +75,26 @@ module Rambling
 
       private
 
+      def current_key(letter)
+        current_key_string = current_key = nil
+
+        @children.keys.each do |key|
+          key_string = key.to_s
+          if key_string.start_with? letter
+            current_key = key
+            current_key_string = key_string
+            break
+          end
+        end
+
+        [current_key, current_key_string]
+      end
+
       def fulfills_uncompressed_condition?(method, chars)
-        first_letter = chars.slice!(0)
+        first_letter = chars.slice! 0
         unless first_letter.nil?
           first_letter_sym = first_letter.to_sym
-          return @children[first_letter_sym].send(method, chars) if @children.has_key?(first_letter_sym)
+          return @children[first_letter_sym].send(method, chars) if @children.has_key? first_letter_sym
         end
 
         false

data/lib/rambling-trie/children_hash_deferer.rb

@@ -1,34 +1,35 @@
 module Rambling
-  # Provides some proxy methods to the children's hash for readability.
-  module ChildrenHashDeferer
-    # Proxies to @children[key]
-    # @param [Symbol] key the key to look for in the children's hash.
-    # @return [TrieNode, nil] the child node with that key or nil.
-    def [](key)
-      @children[key]
-    end
+  module Trie
+    # Provides some proxy methods to the children's hash for readability.
+    module ChildrenHashDeferer
+      # Proxies to @children[key]
+      # @param [Symbol] key the key to look for in the children's hash.
+      # @return [Node, nil] the child node with that key or nil.
+      def [](key)
+        @children[key]
+      end
 
-    # Proxies to @children[key] = value.
-    # @param [Symbol] key the to add or change the value for.
-    # @param [TrieNode] value the node to add to the children's hash.
-    # @return [TrieNode, nil] the child node with that key or nil.
-    def []=(key, value)
-      @children[key] = value
-    end
+      # Proxies to @children[key] = value.
+      # @param [Symbol] key the to add or change the value for.
+      # @param [Node] value the node to add to the children's hash.
+      # @return [Node, nil] the child node with that key or nil.
+      def []=(key, value)
+        @children[key] = value
+      end
 
-    # Proxies to @children.delete(key)
-    # @param [Symbol] key the key to delete in the children's hash.
-    # @return [TrieNode, nil] the child node corresponding to the key just deleted or nil.
-    def delete(key)
-      @children.delete(key)
-    end
+      # Proxies to @children.delete(key)
+      # @param [Symbol] key the key to delete in the children's hash.
+      # @return [Node, nil] the child node corresponding to the key just deleted or nil.
+      def delete(key)
+        @children.delete(key)
+      end
 
-    # Proxies to @children.has_key?(key)
-    # @param [Symbol] key the key to look for in the children's hash.
-    # @return [Boolean] `true` for the keys that exist in the children's hash, false otherwise.
-    def has_key?(key)
-      @children.has_key?(key)
+      # Proxies to @children.has_key?(key)
+      # @param [Symbol] key the key to look for in the children's hash.
+      # @return [Boolean] `true` for the keys that exist in the children's hash, false otherwise.
+      def has_key?(key)
+        @children.has_key?(key)
+      end
     end
   end
 end
-

data/lib/rambling-trie/compressor.rb

@@ -8,15 +8,13 @@ module Rambling
         @parent.nil? ? false : @parent.compressed?
       end
 
-      protected
-
-      def compress_own_tree!
+      def compress_tree!
         if @children.size == 1 and not terminal? and not @letter.nil?
-          merge_with!(@children.values.first)
-          compress_own_tree!
+          merge_with! @children.values.first
+          compress_tree!
         end
 
-        @children.values.each { |node| node.compress_own_tree! }
+        @children.values.each &:compress_tree!
 
         self
       end
@@ -26,8 +24,8 @@ module Rambling
       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)
+        rehash_on_parent! @letter, new_letter
+        redefine_self! new_letter, child
 
         @children.values.each { |node| node.parent = self }
       end
@@ -35,14 +33,14 @@ module Rambling
       def rehash_on_parent!(old_letter, new_letter)
         return if @parent.nil?
 
-        @parent.delete(old_letter)
+        @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?
+        @terminal = merged_node.terminal?
       end
     end
   end

data/lib/rambling-trie/node.rb

@@ -5,6 +5,7 @@ module Rambling
       include ChildrenHashDeferer
       include Compressor
       include Branches
+      include Enumerable
 
       # Letter or letters corresponding to this node.
       # @return [Symbol, nil] the corresponding letter(s) or nil.
@@ -15,37 +16,34 @@ module Rambling
       attr_reader :children
 
       # Parent node.
-      # @return [TrieNode, nil] the parent node or nil for the root element.
+      # @return [Node, nil] the parent node or nil for the root element.
       attr_accessor :parent
 
-      # Creates a new TrieNode.
-      # @param [String] word the word from which to create this TrieNode and his branch.
-      # @param [TrieNode] parent the parent of this node.
+      # Creates a new Node.
+      # @param [String] word the word from which to create this Node and his branch.
+      # @param [Node] parent the parent of this node.
       def initialize(word, parent = nil)
-        @letter = nil
-        @parent = parent
-        @is_terminal = false
-        @children = {}
+        @letter, @parent, @terminal, @children = [nil, parent, false, {}]
 
         unless word.nil? or word.empty?
-          letter = word.slice!(0)
+          letter = word.slice! 0
           @letter = letter.to_sym unless letter.nil?
-          @is_terminal = word.empty?
-          add_branch_from(word)
+          @terminal = word.empty?
+          self << word
         end
       end
 
       # Flag for terminal nodes.
       # @return [Boolean] `true` for terminal nodes, `false` otherwise.
       def terminal?
-        @is_terminal
+        @terminal
       end
 
       # String representation of the current node, if it is a terminal node.
       # @return [String] the string representation of the current node.
-      # @raise [InvalidTrieOperation] if node is not terminal or is root.
+      # @raise [InvalidOperation] if node is not terminal or is root.
       def as_word
-        raise InvalidOperation.new() unless @letter.nil? or terminal?
+        raise InvalidOperation.new unless @letter.nil? or terminal?
         get_letter_string
       end
 

data/lib/rambling-trie/root.rb

@@ -8,50 +8,47 @@ module Rambling
         super(nil)
 
         @filename = filename
-        @is_compressed = false
+        @compressed = false
         add_all_nodes if filename
       end
 
       # Compresses the existing tree using redundant node elimination. Flags the trie as compressed.
-      # @return [Trie] same object
+      # @return [Root] same object
       def compress!
-        unless compressed?
-          compress_own_tree!
-          @is_compressed = true
-        end
-
+        @compressed = (not compress_tree!.nil?) unless compressed?
         self
       end
 
-      # Flag for compressed tries. Overrides {TrieCompressor#compressed?}.
+      # Flag for compressed tries. Overrides {Compressor#compressed?}.
       # @return [Boolean] `true` for compressed tries, `false` otherwise.
       def compressed?
-        @is_compressed = @is_compressed.nil? ? false : @is_compressed
+        @compressed
       end
 
       # Checks if a path for a word or partial word exists in the trie.
       # @param [String] word the word or partial word to look for in the trie.
       # @return [Boolean] `true` if the word or partial word is found, `false` otherwise.
       def has_branch_for?(word = '')
-        chars = word.chars.to_a
-        compressed? ? has_compressed_branch_for?(chars) : has_uncompressed_branch_for?(chars)
+        fulfills_condition word, :has_branch_for?
       end
 
       # Checks if a whole word exists in the trie.
       # @param [String] word the word to look for in the trie.
       # @return [Boolean] `true` only if the word is found and the last character corresponds to a terminal node.
       def is_word?(word = '')
-        chars = word.chars.to_a
-        compressed? ? is_compressed_word?(chars) : is_uncompressed_word?(chars)
+        fulfills_condition word, :is_word?
       end
 
+      alias_method :include?, :is_word?
+
       private
+      def fulfills_condition(word, method)
+        method = compressed? ? "compressed_#{method}" : "uncompressed_#{method}"
+        send(method, word.chars.to_a)
+      end
+
       def add_all_nodes
-        File.open(@filename) do |file|
-          while word = file.gets
-            add_branch_from(word.chomp)
-          end
-        end
+        File.open(@filename).each_line { |line| self << line.chomp }
       end
     end
   end

data/lib/rambling-trie/tasks/performance.rb

@@ -9,8 +9,8 @@ namespace :performance do
     methods.each do |method|
       output.puts "`#{method}`:"
       words.each do |word|
-        output.print "#{word} - #{trie.send(method, word)}".ljust(30)
-        output.puts Benchmark.measure { 200_000.times {trie.send(method, word) }}
+        output.print "#{word} - #{trie.send(method, word)}".ljust 30
+        output.puts Benchmark.measure { 200_000.times { trie.send method, word }}
       end
     end
   end
@@ -18,21 +18,29 @@ namespace :performance do
   def generate_report(filename = nil)
     output = filename.nil? ? $stdout : File.open(filename, 'a+')
 
-    trie = Rambling::Trie.new(get_path('assets', 'dictionaries', 'words_with_friends.txt'))
-
     output.puts "\nReport for rambling-trie version #{Rambling::Trie::VERSION}"
-    report('Uncompressed', trie, output)
 
-    return unless trie.respond_to?(:compress!)
+    trie = nil
+    measure = Benchmark.measure { trie = Rambling::Trie.create get_path('assets', 'dictionaries', 'words_with_friends.txt') }
+
+    if ENV['profile_creation']
+      output.puts '==> Creation'
+      output.print 'Rambling::Trie.create'.ljust 30
+      output.puts measure
+    end
+
+    report 'Uncompressed', trie, output
+
+    return unless trie.respond_to? :compress!
 
     trie.compress!
-    report('Compressed', trie, output)
+    report 'Compressed', trie, output
 
     output.close
   end
 
   def get_path(*filename)
-    File.join(File.dirname(__FILE__), '..', '..', '..', *filename)
+    File.join File.dirname(__FILE__), '..', '..', '..', *filename
   end
 
   desc 'Generate performance report'
@@ -45,7 +53,7 @@ namespace :performance do
     desc 'Generate performance report and append result to reports/performance'
     task :save do
       puts 'Generating performance report...'
-      generate_report(get_path('reports', 'performance'))
+      generate_report get_path('reports', 'performance')
       puts 'Report has been saved to reports/performance'
     end
   end
@@ -56,7 +64,7 @@ namespace :performance do
 
     puts 'Generating profiling reports...'
 
-    rambling_trie = Rambling::Trie.new(get_path('assets', 'dictionaries', 'words_with_friends.txt'))
+    rambling_trie = Rambling::Trie.create get_path('assets', 'dictionaries', 'words_with_friends.txt')
     words = ['hi', 'help', 'beautiful', 'impressionism', 'anthropological']
     methods = [:has_branch_for?, :is_word?]
     tries = [lambda {rambling_trie.clone}, lambda {rambling_trie.clone.compress!}]
@@ -66,12 +74,12 @@ namespace :performance do
         trie = trie_generator.call
         result = RubyProf.profile do
           words.each do |word|
-            200_000.times { trie.send(method, word) }
+            200_000.times { trie.send method, word }
           end
         end
 
         File.open get_path('reports', "profile-#{trie.compressed? ? 'compressed' : 'uncompressed'}-#{method.to_s.sub(/\?/, '')}-#{Time.now.to_i}"), 'w' do |file|
-          RubyProf::CallTreePrinter.new(result).print(file)
+          RubyProf::CallTreePrinter.new(result).print file
         end
       end
     end
@@ -85,7 +93,7 @@ namespace :performance do
 
     puts 'Generating cpu profiling reports...'
 
-    rambling_trie = Rambling::Trie.new(get_path('assets', 'dictionaries', 'words_with_friends.txt'))
+    rambling_trie = Rambling::Trie.create get_path('assets', 'dictionaries', 'words_with_friends.txt')
     words = ['hi', 'help', 'beautiful', 'impressionism', 'anthropological']
     methods = [:has_branch_for?, :is_word?]
     tries = [lambda {rambling_trie.clone}, lambda {rambling_trie.clone.compress!}]
@@ -95,7 +103,7 @@ namespace :performance do
         trie = trie_generator.call
         result = PerfTools::CpuProfiler.start get_path('reports', "cpu_profile-#{trie.compressed? ? 'compressed' : 'uncompressed'}-#{method.to_s.sub(/\?/, '')}-#{Time.now.to_i}") do
           words.each do |word|
-            200_000.times { trie.send(method, word) }
+            200_000.times { trie.send method, word }
           end
         end
       end

data/lib/rambling-trie/version.rb

@@ -1,6 +1,6 @@
 module Rambling
   module Trie
     # Current version of the rambling-trie.
-    VERSION = '0.4.0'
+    VERSION = '0.4.1'
   end
 end

data/rambling-trie.gemspec

@@ -1,5 +1,5 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+$:.push File.expand_path('../lib', __FILE__)
 require 'rambling-trie/version'
 
 Gem::Specification.new do |gem|

data/spec/lib/rambling-trie/branches_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+module Rambling
+  module Trie
+    describe Branches do
+      describe '#add_branch_from' do
+        context 'new word for existing branch' do
+          let(:node) { Node.new 'back' }
+
+          before :each do
+            node.add_branch_from 'a'
+          end
+
+          it 'does not increment the child count' do
+            node.should have(1).children
+          end
+
+          it 'marks it as terminal' do
+            node[:a].should be_terminal
+          end
+        end
+
+        context 'old word for existing branch' do
+          let(:node) { Node.new 'back' }
+
+          before :each do
+            node.add_branch_from 'ack'
+          end
+
+          it 'does not increment any child count' do
+            node.should have(1).children
+            node[:a].should have(1).children
+            node[:a][:c].should have(1).children
+            node[:a][:c][:k].should have(0).children
+          end
+        end
+      end
+
+      describe '#<<' do
+        let(:root) { Root.new }
+        let(:word) { 'word' }
+
+        it 'delegates to #add_branch_from' do
+          [true, false].each do |value|
+            root.stub(:add_branch_from).with(word).and_return value
+            root << word
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/rambling-trie/children_hash_deferer_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+module Rambling
+  module Trie
+    describe ChildrenHashDeferer do
+      class ClassWithChildren
+        include ChildrenHashDeferer
+        attr_accessor :children
+
+        def initialize()
+          @children = {}
+        end
+      end
+
+      let(:deferer) { ClassWithChildren.new }
+
+      describe '#[]' do
+        let(:key) { :key }
+        let(:value) { 'value' }
+
+        it 'defers to the children hash' do
+          deferer.children.should_receive(:[]).with(key).and_return value
+          deferer[key].should == value
+        end
+      end
+
+      describe '#[]=' do
+        let(:key) { :key }
+        let(:value) { 'value' }
+
+        it 'defers to the children hash' do
+          deferer.children.should_receive(:[]=).with(key, value)
+          deferer[key] = value
+        end
+      end
+
+      describe '#delete' do
+        let(:key) { :key }
+        let(:value) { 'value' }
+
+        it 'defers to the children hash' do
+          deferer.children.should_receive(:delete).with(key).and_return value
+          deferer.delete(key).should == value
+        end
+      end
+
+      describe '#has_key' do
+        let(:key) { :key }
+
+        it 'defers to the children hash' do
+          [true, false].each do |value|
+            deferer.children.should_receive(:has_key?).with(key).and_return value
+            deferer.has_key?(key).should send("be_#{value}")
+          end
+        end
+      end
+    end
+  end
+end

data/spec/lib/rambling-trie/node_spec.rb

@@ -95,39 +95,6 @@ module Rambling
         end
       end
 
-      describe '#add_branch_from' do
-        context 'new word for existing branch' do
-          let(:node) { Node.new 'back' }
-
-          before :each do
-            node.add_branch_from 'a'
-          end
-
-          it 'does not increment the child count' do
-            node.should have(1).children
-          end
-
-          it 'marks it as terminal' do
-            node[:a].should be_terminal
-          end
-        end
-
-        context 'old word for existing branch' do
-          let(:node) { Node.new 'back' }
-
-          before :each do
-            node.add_branch_from 'ack'
-          end
-
-          it 'does not increment any child count' do
-            node.should have(1).children
-            node[:a].should have(1).children
-            node[:a][:c].should have(1).children
-            node[:a][:c][:k].should have(0).children
-          end
-        end
-      end
-
       describe '#as_word' do
         context 'for an empty node' do
           let(:node) { Node.new '' }
@@ -174,7 +141,7 @@ module Rambling
       end
 
       describe '#compressed?' do
-        let(:root) { double('Root') }
+        let(:root) { double 'Root' }
         let(:node) { Node.new '', root }
 
         context 'parent is compressed' do

data/spec/lib/rambling-trie/root_spec.rb

@@ -37,7 +37,7 @@ module Rambling
           end
 
           it 'loads every word' do
-            File.open(filename) do |file|
+            File.open filename do |file|
               file.readlines.each { |word| root.is_word?(word.chomp).should be_true }
             end
           end
@@ -86,7 +86,7 @@ module Rambling
 
         context 'with at least one word' do
           it 'keeps the root letter nil' do
-            root.add_branch_from('all')
+            root.add_branch_from 'all'
             root.compress!
 
             root.letter.should be_nil
@@ -95,7 +95,7 @@ module Rambling
 
         context 'with a single word' do
           before :each do
-            root.add_branch_from('all')
+            root.add_branch_from 'all'
             root.compress!
           end
 
@@ -109,8 +109,8 @@ module Rambling
 
         context 'with two words' do
           before :each do
-            root.add_branch_from('all')
-            root.add_branch_from('ask')
+            root.add_branch_from 'all'
+            root.add_branch_from 'ask'
             root.compress!
           end
 
@@ -133,9 +133,9 @@ module Rambling
         end
 
         it 'reassigns the parent nodes correctly' do
-          root.add_branch_from('repay')
-          root.add_branch_from('rest')
-          root.add_branch_from('repaint')
+          root.add_branch_from 'repay'
+          root.add_branch_from 'rest'
+          root.add_branch_from 'repaint'
           root.compress!
 
           root[:re].letter.should == :re
@@ -158,9 +158,9 @@ module Rambling
         end
 
         it 'does not compress terminal nodes' do
-          root.add_branch_from('you')
-          root.add_branch_from('your')
-          root.add_branch_from('yours')
+          root.add_branch_from 'you'
+          root.add_branch_from 'your'
+          root.add_branch_from 'yours'
 
           root.compress!
 
@@ -175,9 +175,9 @@ module Rambling
 
         describe 'and trying to add a branch' do
           it 'raises an error' do
-            root.add_branch_from('repay')
-            root.add_branch_from('rest')
-            root.add_branch_from('repaint')
+            root.add_branch_from 'repay'
+            root.add_branch_from 'rest'
+            root.add_branch_from 'repaint'
             root.compress!
 
             lambda { root.add_branch_from('restaurant') }.should raise_error(InvalidOperation)
@@ -191,8 +191,8 @@ module Rambling
         context 'word is contained' do
           shared_examples_for 'word is found' do
             it 'matches part of the word' do
-              root.should have_branch_for('hell')
-              root.should have_branch_for('hig')
+              root.should have_branch_for 'hell'
+              root.should have_branch_for 'hig'
             end
 
             it 'matches the whole word' do
@@ -220,8 +220,8 @@ module Rambling
         context 'word is not contained' do
           shared_examples_for 'word not found' do
             it 'does not match any part of the word' do
-              root.should_not have_branch_for('ha')
-              root.should_not have_branch_for('hal')
+              root.should_not have_branch_for 'ha'
+              root.should_not have_branch_for 'hal'
             end
 
             it 'does not match the whole word' do
@@ -244,6 +244,18 @@ module Rambling
           end
         end
       end
+
+      describe '#include?' do
+        let(:root) { Root.new }
+        let(:word) { 'word' }
+
+        it 'delegates to #is_word?' do
+          [true, false].each do |value|
+            root.stub(:is_word?).with(word).and_return value
+            root.include?(word).should &method("be_#{value}".to_sym)
+          end
+        end
+      end
     end
   end
 end

data/spec/lib/rambling-trie_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 module Rambling
   describe Trie do
     describe '.create' do
-      let(:root) { double('Trie::Root') }
+      let(:root) { double 'Trie::Root' }
 
       before :each do
         Trie::Root.stub(:new).and_return root
@@ -13,5 +13,22 @@ module Rambling
         Trie.create.should == root
       end
     end
+
+    describe '.new' do
+      let(:root) { double 'Trie::Root' }
+
+      before :each do
+        Trie.should_receive(:create).and_return root
+      end
+
+      it 'returns the new trie root node instance' do
+        Trie.new.should == root
+      end
+
+      it 'warns about deprecation' do
+        Trie.should_receive(:warn).with '[DEPRECATION] `new` is deprecated. Please use `create` instead.'
+        Trie.new
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rambling-trie
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-16 00:00:00.000000000 Z
+date: 2012-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -118,10 +118,11 @@ files:
 - lib/rambling-trie/tasks/gem.rb
 - lib/rambling-trie/tasks/performance.rb
 - lib/rambling-trie/version.rb
-- lib/rambling.rb
 - rambling-trie.gemspec
 - reports/performance
 - spec/assets/test_words.txt
+- spec/lib/rambling-trie/branches_spec.rb
+- spec/lib/rambling-trie/children_hash_deferer_spec.rb
 - spec/lib/rambling-trie/node_spec.rb
 - spec/lib/rambling-trie/root_spec.rb
 - spec/lib/rambling-trie_spec.rb
@@ -140,7 +141,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4431661541805612583
+      hash: 1932693806363009255
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -149,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4431661541805612583
+      hash: 1932693806363009255
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24

data/lib/rambling.rb

@@ -1,3 +0,0 @@
-# Entry point for the rambling-trie. General Namespace.
-module Rambling
-end