rambling-trie 0.4.1 → 0.4.2

data/.gitignore

@@ -16,4 +16,8 @@ reports/
 
 # Bundler
 .bundle
-pkg
+pkg/
+
+# Yard
+doc/
+.yardoc/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2

data/Gemfile

@@ -2,9 +2,12 @@ source 'http://rubygems.org'
 
 gemspec
 
-gem 'perftools.rb'
+group :development do
+  gem 'perftools.rb'
+end
 
 group :test do
+  gem 'rake'
   gem 'guard-rspec'
   gem 'simplecov', require: false
 end

data/README.markdown

@@ -1,4 +1,4 @@
-# Rambling Trie
+# Rambling Trie [![Build Status](https://secure.travis-ci.org/egonzalez0787/rambling-trie.png)](http://travis-ci.org/egonzalez0787/rambling-trie) [![Dependency Status](https://gemnasium.com/egonzalez0787/rambling-trie.png)](https://gemnasium.com/egonzalez0787/rambling-trie) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/egonzalez0787/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.
 
@@ -28,9 +28,11 @@ 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:
 
@@ -89,7 +91,7 @@ trie.compressed?
 
 ## Further Documentation
 
-You can find further API documentation on the autogenerated [RubyDoc.info](http://rubydoc.info/gems/rambling-trie)
+You can find further API documentation on the autogenerated [rambling-trie gem RubyDoc.info page](http://rubydoc.info/gems/rambling-trie) or if you want edge documentation, you can go the [GitHub project RubyDoc.info page](http://rubydoc.info/github/egonzalez0787/rambling-trie).
 
 ## Compatible Ruby and Rails versions
 

data/Rakefile

@@ -3,8 +3,7 @@ Bundler::GemHelper.install_tasks
 
 require 'rspec/core/rake_task'
 require 'rambling-trie'
-require 'rambling-trie/version'
-require 'rambling-trie/tasks/performance'
+require 'rambling/trie/tasks/performance'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/lib/rambling-trie.rb

@@ -1,27 +1 @@
-[
-  '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
+require 'rambling/trie'

data/lib/rambling/trie.rb

@@ -0,0 +1,33 @@
+[
+  'invalid_operation',
+  'children_hash_deferer',
+  'compressor',
+  'branches',
+  'enumerable',
+  'node',
+  'root',
+  'version'
+].map { |file| File.join 'rambling', 'trie', file }.each &method(:require)
+
+# General namespace for all Rambling gems.
+module Rambling
+  # Entry point for rambling-trie API.
+  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(filename = nil)
+        Root.new filename
+      end
+
+      # 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).
+      # @deprecated Please use {.create} instead.
+      # @see .create
+      def new(filename = nil)
+        warn '[DEPRECATION] `new` is deprecated. Please use `create` instead.'
+        create filename
+      end
+    end
+  end
+end

data/lib/{rambling-trie → rambling/trie}/branches.rb

@@ -2,10 +2,11 @@ module Rambling
   module Trie
     # Provides the branching behavior for the Trie data structure.
     module Branches
-      # Adds a branch to the trie based on the word.
+      # Adds a branch to the current trie node based on the word
       # @param [String] word the word to add the branch from.
       # @return [Node] the just added branch's root node.
       # @raise [InvalidOperation] if the trie is already compressed.
+      # @note This method clears the contents of the word variable.
       def add_branch_from(word)
         raise InvalidOperation.new('Cannot add branch to compressed trie') if compressed?
         if word.empty?
@@ -25,7 +26,14 @@ module Rambling
         end
       end
 
-      alias_method :<<, :add_branch_from
+      # Alias for {#add_branch_from}. Defined instead of simple `alias_method` for overriding purposes.
+      # @param [String] word the word to add the branch from.
+      # @return [Node] the just added branch's root node.
+      # @raise [InvalidOperation] if the trie is already compressed.
+      # @see #add_branch_from
+      def <<(word)
+        add_branch_from word
+      end
 
       protected
 

data/lib/{rambling-trie → rambling/trie}/compressor.rb

@@ -8,6 +8,8 @@ module Rambling
         @parent.nil? ? false : @parent.compressed?
       end
 
+      # Compressed the current node using redundant node elimination.
+      # @return [Root, Node] the compressed node.
       def compress_tree!
         if @children.size == 1 and not terminal? and not @letter.nil?
           merge_with! @children.values.first

data/lib/rambling/trie/enumerable.rb

@@ -0,0 +1,20 @@
+module Rambling
+  module Trie
+    # Provides enumerable behavior to the Trie data structure.
+    module Enumerable
+      include ::Enumerable
+
+      alias_method :size, :count
+
+      # Calls block once for each of the words contained in the trie. If no block given, an Enumerator is returned.
+      def each(&block)
+        enumerator = Enumerator.new do |words|
+          words << as_word if terminal?
+          children.each { |key, child| child.each { |word| words << word } }
+        end
+
+        block.nil? ? enumerator : enumerator.each(&block)
+      end
+    end
+  end
+end

data/lib/{rambling-trie → rambling/trie}/root.rb

@@ -41,6 +41,16 @@ module Rambling
 
       alias_method :include?, :is_word?
 
+      # Adds a branch to the trie based on the word, without changing the passed word.
+      # @param [String] word the word to add the branch from.
+      # @return [Node] the just added branch's root node.
+      # @raise [InvalidOperation] if the trie is already compressed.
+      # @see Branches#add_branch_from
+      # @note Avoids clearing the contents of the word variable.
+      def add_branch_from(word)
+        super word.clone
+      end
+
       private
       def fulfills_condition(word, method)
         method = compressed? ? "compressed_#{method}" : "uncompressed_#{method}"

data/lib/{rambling-trie → rambling/trie}/version.rb

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

data/rambling-trie.gemspec

@@ -1,6 +1,6 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path('../lib', __FILE__)
-require 'rambling-trie/version'
+require 'rambling/trie/version'
 
 Gem::Specification.new do |gem|
   gem.authors = ['Rambling Labs']

data/spec/lib/rambling/trie/enumerable_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+module Rambling
+  module Trie
+    describe Enumerable do
+      let(:root) { Root.new }
+      let(:words) { %w(add some words and another word) }
+
+      before :each do
+        words.each { |word| root << word.clone }
+      end
+
+      describe '#each' do
+        it 'returns an enumerator' do
+          root.each.should be_a(Enumerator)
+        end
+
+        it 'includes every word contained in the trie' do
+          root.each { |word| words.should include(word) }
+          root.count.should == words.count
+        end
+      end
+
+      describe '#size' do
+        it 'delegates to #count' do
+          root.size.should == words.size
+        end
+      end
+
+      it 'includes the core Enumerable module' do
+        root.all? { |word| words.include? word }.should be_true
+        root.any? { |word| word.start_with? 's' }.should be_true
+        root.to_a.should =~ words
+      end
+    end
+  end
+end

data/spec/lib/{rambling-trie → rambling/trie}/root_spec.rb

@@ -3,10 +3,10 @@ require 'spec_helper'
 module Rambling
   module Trie
     describe Root do
+      let(:root) { Root.new }
+
       describe '.new' do
         context 'without filename' do
-          let(:root) { Root.new }
-
           it 'has no letter' do
             root.letter.should be_nil
           end
@@ -66,8 +66,6 @@ module Rambling
       end
 
       describe '#compress!' do
-        let(:root) { Root.new }
-
         it 'returns itself marked as compressed' do
           compressed_root = root.compress!
 
@@ -186,8 +184,6 @@ module Rambling
       end
 
       describe '#has_branch_for?' do
-        let(:root) { Root.new }
-
         context 'word is contained' do
           shared_examples_for 'word is found' do
             it 'matches part of the word' do
@@ -246,7 +242,6 @@ module Rambling
       end
 
       describe '#include?' do
-        let(:root) { Root.new }
         let(:word) { 'word' }
 
         it 'delegates to #is_word?' do
@@ -256,6 +251,21 @@ module Rambling
           end
         end
       end
+
+      describe '#add_branch_from' do
+        let(:original_word) { 'word' }
+        let(:word) { original_word.clone }
+
+        it 'does not change the original word' do
+          root.add_branch_from word
+          word.should == original_word
+        end
+
+        it 'is still aliased as #<<' do
+          root << word
+          word.should == original_word
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rambling-trie
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-20 00:00:00.000000000 Z
+date: 2012-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -102,6 +102,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE
@@ -109,23 +110,26 @@ files:
 - Rakefile
 - assets/dictionaries/words_with_friends.txt
 - lib/rambling-trie.rb
-- lib/rambling-trie/branches.rb
-- lib/rambling-trie/children_hash_deferer.rb
-- lib/rambling-trie/compressor.rb
-- lib/rambling-trie/invalid_operation.rb
-- lib/rambling-trie/node.rb
-- lib/rambling-trie/root.rb
-- lib/rambling-trie/tasks/gem.rb
-- lib/rambling-trie/tasks/performance.rb
-- lib/rambling-trie/version.rb
+- lib/rambling/trie.rb
+- lib/rambling/trie/branches.rb
+- lib/rambling/trie/children_hash_deferer.rb
+- lib/rambling/trie/compressor.rb
+- lib/rambling/trie/enumerable.rb
+- lib/rambling/trie/invalid_operation.rb
+- lib/rambling/trie/node.rb
+- lib/rambling/trie/root.rb
+- lib/rambling/trie/tasks/gem.rb
+- lib/rambling/trie/tasks/performance.rb
+- lib/rambling/trie/version.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
+- spec/lib/rambling/trie/branches_spec.rb
+- spec/lib/rambling/trie/children_hash_deferer_spec.rb
+- spec/lib/rambling/trie/enumerable_spec.rb
+- spec/lib/rambling/trie/node_spec.rb
+- spec/lib/rambling/trie/root_spec.rb
+- spec/lib/rambling/trie_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/ramblinglabs/rambling-trie
 licenses: []
@@ -141,7 +145,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1932693806363009255
+      hash: -1164707040702408249
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -150,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1932693806363009255
+      hash: -1164707040702408249
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24