rambling-trie 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6379fbb202c3257cad63367006a150b801b69649
-  data.tar.gz: 9b4b9f07ec20f5e7a2aef641d06501a03cc20195
+  metadata.gz: 4d281908146ad7997bb01e3765836bb2053d7251
+  data.tar.gz: b3811b63c5d068e49e207849ca90083fe4ca95a1
 SHA512:
-  metadata.gz: 043f1af6cd0b8390585e44b73e63101810f5506198e0ee5adbbe8708b394c8a0bc3db5ce3bdfae4e5fbcb9c1b6692cebf25f5412df2d74926352119690aed573
-  data.tar.gz: 7de76f2ad5e324e1a500bd2f33a80ade73a9c7a1488062ce4ea01fa982dad33955dd724c469ad1f7eeb4c49e69c1e91fc46e62270eaa65b44db5cb288ccc4362
+  metadata.gz: a28530aa9cd4c0d3276c351e6f275e4c24566a9b1f7b87a35377f55287fd35affb5c25b12daf3642aa6e621876be44987df4322f428dc784017bbb621bbb761f
+  data.tar.gz: 2c17da1286a41d083f2bb2a38a4152b682097f980f426e06fa83181707725b5963acbbc214e32d0f7584635ff195321c0ceffe6e9a3586211c4019070f11256e

data/.travis.yml

@@ -1,10 +1,21 @@
 language: ruby
+before_install:
+  - gem install bundler
+install:
+  - bundle install --without test
 rvm:
+  - 2.3.0
+  - 2.2.4
+  - 2.2.3
+  - 2.2.2
+  - 2.2.1
+  - 2.2.0
+  - 2.1.8
+  - 2.1.7
+  - 2.1.6
   - 2.1.5
   - 2.1.4
   - 2.1.3
   - 2.1.2
   - 2.1.1
   - 2.1.0
-  - 2.0.0
-  - 1.9.3

data/Gemfile

@@ -4,10 +4,10 @@ gemspec
 
 gem 'coveralls', require: false
 
+group :development do
+  gem 'simplecov', require: false
+end
+
 group :test do
-  gem 'rake'
   gem 'guard-rspec'
-  gem 'rb-fsevent'
-  gem 'rb-inotify'
-  gem 'simplecov', '~> 0.9.1', require: false
 end

data/Guardfile

@@ -1,9 +1,8 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
-guard 'rspec', all_on_start: true, all_after_pass: false do
+guard 'rspec', cmd: 'rspec', all_on_start: true, all_after_pass: false do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
 end
-

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2014 Edgar Gonzalez
+Copyright (c) 2012-2016 Edgar Gonzalez
 
 MIT License
 

data/{README.markdown → README.md}

@@ -1,6 +1,6 @@
 # Rambling Trie
 
-[![Gem Version][badge_fury_badge]][badge_fury_link] [![Dependency Status][gemnasium_badge]][gemnasium_link] [![Build Status][travis_ci_badge]][travis_ci_link] [![Code Climate][code_climate_badge]][code_climage_link] [![Coverage Status][coveralls_badge]][coveralls_link]
+[![Gem Version][badge_fury_badge]][badge_fury_link] [![Dependency Status][gemnasium_badge]][gemnasium_link] [![Build Status][travis_ci_badge]][travis_ci_link] [![Code Climate][code_climate_badge]][code_climage_link] [![Coverage Status][coveralls_badge]][coveralls_link] [![Documentation Status][inch_ci_badge]][inch_ci_link]
 
 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.
 
@@ -10,7 +10,7 @@ The Rambling Trie is a custom implementation of the Trie data structure with Rub
 
 You will need:
 
-* Ruby 1.9.3 or up
+* Ruby 2.1.0 or up
 * RubyGems
 
 See [RVM][rvm] or [rbenv][rbenv] for more information on how to manage Ruby versions.
@@ -37,14 +37,6 @@ To create the trie, initialize it like this:
 trie = Rambling::Trie.create
 ```
 
-- - -
-
-#### Deprecation warnings
-
-* Starting from version 0.4.0, `Rambling::Trie.new` is deprecated. Please use `Rambling::Trie.create` instead.
-
-- - -
-
 You can also provide a block and the created instance will be yielded for you to perform any operation on it:
 
 ``` ruby
@@ -72,23 +64,6 @@ trie
 
 If you want to use a custom file format, you will need to provide a custom file reader that defines the `each_word` method that yields each word contained in the file. Look at the `Rambling::Trie::PlainTextReader` class for an example.
 
-- - -
-
-#### Breaking changes
-
-* Starting from version 0.6.0, the `children` method returns an array of nodes instead of a hash. If you still need access to the underlying hash, use `children_tree` instead.
-
-- - -
-
-- - -
-
-#### Deprecation warnings
-
-* Starting from version 0.6.0, the `branch?` method is deprecated. The `partial_word?` method should be used instead.
-* Starting from version 0.5.0, the `has_branch_for?`, `is_word?` and `add_branch_from` methods are deprecated. The methods `branch?`, `word?` and `add` should be used respectively.
-
-- - -
-
 To add new words to the trie, use `add` or `<<`:
 
 ``` ruby
@@ -110,6 +85,13 @@ trie.partial_word? 'partial_word'
 trie.match? 'partial_word'
 ```
 
+To get all the words that start with a particular string, you can use `scan`:
+
+``` ruby
+trie.scan 'hi' # => ['hi', 'high', 'highlight', ...]
+trie.words 'hi' # => ['hi', 'high', 'highlight', ...]
+```
+
 ### Compression
 
 By default, the Rambling Trie works as a Standard Trie.
@@ -152,11 +134,11 @@ You can find further API documentation on the autogenerated [rambling-trie gem R
 
 The Rambling Trie has been tested with the following Ruby versions:
 
+* 2.3.x
+* 2.2.x
 * 2.1.x
-* 2.0.0
-* 1.9.3
 
-Ruby 1.8.7 and 1.9.2 are not supported.
+Ruby 1.8.x, 1.9.x and 2.0.x are not supported.
 
 ## Contributing to Rambling Trie
 
@@ -165,7 +147,7 @@ Also, be sure to add tests for any feature you may develop or bug you may fix.
 
 ## License and copyright
 
-Copyright (c) 2012-2014 Edgar Gonzalez
+Copyright (c) 2012-2016 Edgar Gonzalez
 
 MIT License
 
@@ -177,15 +159,17 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 
 [badge_fury_badge]: https://badge.fury.io/rb/rambling-trie.svg
 [badge_fury_link]: https://badge.fury.io/rb/rambling-trie
-[code_climate_badge]: https://codeclimate.com/github/gonzedge/rambling-trie.png
 [code_climage_link]: https://codeclimate.com/github/gonzedge/rambling-trie
-[coveralls_badge]: https://coveralls.io/repos/gonzedge/rambling-trie/badge.png
+[code_climate_badge]: https://codeclimate.com/github/gonzedge/rambling-trie/badges/gpa.svg
+[coveralls_badge]: https://img.shields.io/coveralls/gonzedge/rambling-trie.svg
 [coveralls_link]: https://coveralls.io/r/gonzedge/rambling-trie
 [gemnasium_badge]: https://gemnasium.com/gonzedge/rambling-trie.svg
 [gemnasium_link]: https://gemnasium.com/gonzedge/rambling-trie
-[travis_ci_badge]: https://secure.travis-ci.org/gonzedge/rambling-trie.svg
-[travis_ci_link]: https://travis-ci.org/gonzedge/rambling-trie
-[rvm]: https://rvm.io
+[inch_ci_badge]: https://inch-ci.org/github/gonzedge/rambling-trie.svg?branch=master
+[inch_ci_link]: https://inch-ci.org/github/gonzedge/rambling-trie
 [rbenv]: https://github.com/sstephenson/rbenv
 [rubydoc]: http://rubydoc.info/gems/rambling-trie
 [rubydoc_github]: http://rubydoc.info/github/gonzedge/rambling-trie
+[rvm]: https://rvm.io
+[travis_ci_badge]: https://travis-ci.org/gonzedge/rambling-trie.svg
+[travis_ci_link]: https://travis-ci.org/gonzedge/rambling-trie

data/lib/rambling/trie.rb

@@ -1,9 +1,11 @@
 require 'forwardable'
 %w{
-  branches compressor enumerable
-  inspector invalid_operation node
+  branches compressor enumerable inspector
+  invalid_operation node missing_node
   plain_text_reader root version
-}.map { |file| File.join 'rambling', 'trie', file }.each &method(:require)
+}.each do |file|
+  require File.join('rambling', 'trie', file)
+end
 
 # General namespace for all Rambling gems.
 module Rambling

data/lib/rambling/trie/branches.rb

@@ -51,6 +51,38 @@ module Rambling
         end
       end
 
+      def closest_node_when_uncompressed chars
+        if chars.empty?
+          self
+        else
+          first_letter_sym = chars.slice!(0).to_sym
+          if children_tree.has_key? first_letter_sym
+            children_tree[first_letter_sym].closest_node_when_uncompressed chars
+          else
+            Rambling::Trie::MissingNode.new
+          end
+        end
+      end
+
+      def closest_node_when_compressed chars
+        if chars.empty?
+          self
+        else
+          current_length = 0
+          current_key, current_key_string = current_key chars.slice!(0)
+
+          begin
+            current_length += 1
+
+            if current_key_string.length == current_length || chars.empty?
+              return children_tree[current_key].closest_node_when_compressed chars
+            end
+          end while current_key_string[current_length] == chars.slice!(0)
+
+          Rambling::Trie::MissingNode.new
+        end
+      end
+
       private
 
       def add_to_children_tree word

data/lib/rambling/trie/missing_node.rb

@@ -0,0 +1,7 @@
+module Rambling
+  module Trie
+    # A representation of a missing node in the Trie data structure.
+    class MissingNode < Node
+    end
+  end
+end

data/lib/rambling/trie/root.rb

@@ -57,6 +57,15 @@ module Rambling
 
       alias_method :include?, :word?
 
+      # Returns all words that start with the specified characters.
+      # @param [String] word the word to look for in the trie.
+      # @return [Array] all the words contained in the trie that start with the specified characters.
+      def scan word = ''
+        closest_node(word).to_a
+      end
+
+      alias_method :words, :scan
+
       private
 
       attr_accessor :compressed
@@ -65,6 +74,12 @@ module Rambling
         method = compressed? ? "#{method}_when_compressed?" : "#{method}_when_uncompressed?"
         send method, word.chars.to_a
       end
+
+      def closest_node word
+        method = compressed? ? :closest_node_when_compressed : :closest_node_when_uncompressed
+
+        send method, word.chars.to_a
+      end
     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.7.0'
+    VERSION = '0.8.0'
   end
 end

data/rambling-trie.gemspec

@@ -20,9 +20,9 @@ Gem::Specification.new do |gem|
   gem.version = Rambling::Trie::VERSION
   gem.platform = Gem::Platform::RUBY
 
-  gem.add_development_dependency 'rspec', '~> 3.1'
-  gem.add_development_dependency 'rake', '~> 10.4'
+  gem.add_development_dependency 'rspec', '~> 3.4'
+  gem.add_development_dependency 'rake', '~> 10.5'
   gem.add_development_dependency 'ruby-prof', '~> 0.15.2'
   gem.add_development_dependency 'yard', '~> 0.8.7'
-  gem.add_development_dependency 'redcarpet', '~> 3.2.1'
+  gem.add_development_dependency 'redcarpet', '~> 3.3.4'
 end

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

@@ -34,7 +34,7 @@ module Rambling
 
       describe '#root?' do
         it 'returns false' do
-          expect(subject).to_not be_root
+          expect(subject).not_to be_root
         end
       end
 
@@ -51,7 +51,7 @@ module Rambling
           end
 
           it 'is not a terminal node' do
-            expect(subject).to_not be_terminal
+            expect(subject).not_to be_terminal
           end
 
           it 'returns empty string as its word' do
@@ -59,7 +59,7 @@ module Rambling
           end
 
           it 'is not compressed' do
-            expect(subject).to_not be_compressed
+            expect(subject).not_to be_compressed
           end
         end
 
@@ -75,7 +75,7 @@ module Rambling
           end
 
           it 'is not a terminal node' do
-            expect(subject).to_not be_terminal
+            expect(subject).not_to be_terminal
           end
 
           it 'returns empty string as its word' do
@@ -83,7 +83,7 @@ module Rambling
           end
 
           it 'is not compressed' do
-            expect(subject).to_not be_compressed
+            expect(subject).not_to be_compressed
           end
         end
 
@@ -127,7 +127,7 @@ module Rambling
           end
 
           it 'does not mark itself as a terminal node' do
-            expect(subject).to_not be_terminal
+            expect(subject).not_to be_terminal
           end
 
           it 'marks the first child as a terminal node' do
@@ -143,13 +143,13 @@ module Rambling
           end
 
           it 'does not mark any other letter as terminal node' do
-            expect(subject[:p][:a][:g][:h][:e][:t][:t]).to_not be_terminal
-            expect(subject[:p][:a][:g][:h][:e][:t]).to_not be_terminal
-            expect(subject[:p][:a][:g][:h][:e]).to_not be_terminal
-            expect(subject[:p][:a][:g][:h]).to_not be_terminal
-            expect(subject[:p][:a][:g]).to_not be_terminal
-            expect(subject[:p][:a]).to_not be_terminal
-            expect(subject[:p]).to_not be_terminal
+            expect(subject[:p][:a][:g][:h][:e][:t][:t]).not_to be_terminal
+            expect(subject[:p][:a][:g][:h][:e][:t]).not_to be_terminal
+            expect(subject[:p][:a][:g][:h][:e]).not_to be_terminal
+            expect(subject[:p][:a][:g][:h]).not_to be_terminal
+            expect(subject[:p][:a][:g]).not_to be_terminal
+            expect(subject[:p][:a]).not_to be_terminal
+            expect(subject[:p]).not_to be_terminal
           end
         end
       end
@@ -219,7 +219,7 @@ module Rambling
           end
 
           it 'returns false' do
-            expect(subject).to_not be_compressed
+            expect(subject).not_to be_compressed
           end
         end
       end

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

@@ -19,11 +19,11 @@ module Rambling
         end
 
         it 'is not a terminal node' do
-          expect(subject).to_not be_terminal
+          expect(subject).not_to be_terminal
         end
 
         it 'is not a word' do
-          expect(subject).to_not be_word
+          expect(subject).not_to be_word
         end
 
         context 'with a block' do
@@ -34,11 +34,11 @@ module Rambling
           end
 
           it 'is not a terminal node' do
-            expect(subject).to_not be_terminal
+            expect(subject).not_to be_terminal
           end
 
           it 'is not a word' do
-            expect(subject).to_not be_word
+            expect(subject).not_to be_word
           end
 
           it 'executes the block' do
@@ -205,7 +205,7 @@ module Rambling
           end
 
           it 'is aliased as #include?' do
-            expect(subject).to_not include 'high'
+            expect(subject).not_to include 'high'
           end
 
           context 'and the root has been compressed' do
@@ -279,6 +279,80 @@ module Rambling
         end
       end
 
+      describe '#scan' do
+        context 'words that match are not contained' do
+          before do
+            subject << 'hi'
+            subject << 'hello'
+            subject << 'high'
+            subject << 'hell'
+            subject << 'highlight'
+            subject << 'histerical'
+          end
+
+          it 'returns an array with the words that match' do
+            expect(subject.scan 'hi').to eq [
+              'hi',
+              'high',
+              'highlight',
+              'histerical'
+            ]
+
+            expect(subject.scan 'hig').to eq [
+              'high',
+              'highlight'
+            ]
+          end
+
+          context 'and the root has been compressed' do
+            before do
+              subject.compress!
+            end
+
+            it 'returns an array with the words that match' do
+              expect(subject.scan 'hi').to eq [
+                'hi',
+                'high',
+                'highlight',
+                'histerical'
+              ]
+
+              expect(subject.scan 'hig').to eq [
+                'high',
+                'highlight'
+              ]
+            end
+
+            it 'is aliased as #words' do
+              expect(subject.words 'hig').to eq [
+                'high',
+                'highlight'
+              ]
+            end
+          end
+        end
+
+        context 'words that match are not contained' do
+          before do
+            subject << 'hello'
+          end
+
+          it 'returns an empty array' do
+            expect(subject.scan 'hi').to eq []
+          end
+
+          context 'and the root has been compressed' do
+            before do
+              subject.compress!
+            end
+
+            it 'returns an empty array' do
+              expect(subject.scan 'hi').to eq []
+            end
+          end
+        end
+      end
+
       describe '#add' do
         let(:original_word) { 'word' }
         let(:word) { original_word.clone }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rambling-trie
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Edgar Gonzalez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-06 00:00:00.000000000 Z
+date: 2016-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '10.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
+        version: '10.5'
 - !ruby/object:Gem::Dependency
   name: ruby-prof
   requirement: !ruby/object:Gem::Requirement
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.1
+        version: 3.3.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.1
+        version: 3.3.4
 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.
@@ -98,7 +98,7 @@ files:
 - Gemfile
 - Guardfile
 - LICENSE
-- README.markdown
+- README.md
 - Rakefile
 - assets/dictionaries/words_with_friends.txt
 - lib/rambling-trie.rb
@@ -108,6 +108,7 @@ files:
 - lib/rambling/trie/enumerable.rb
 - lib/rambling/trie/inspector.rb
 - lib/rambling/trie/invalid_operation.rb
+- lib/rambling/trie/missing_node.rb
 - lib/rambling/trie/node.rb
 - lib/rambling/trie/plain_text_reader.rb
 - lib/rambling/trie/root.rb
@@ -146,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A custom implementation of the trie data structure.