rambling-trie 1.0.2 → 2.2.0

data/spec/{lib/rambling/trie/compressed_node_spec.rb → support/shared_examples/a_trie_node_implementation.rb}

@@ -1,43 +1,9 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe Rambling::Trie::CompressedNode do
-  let(:node) { Rambling::Trie::CompressedNode.new }
-
-  describe '#compressed?' do
-    it 'returns true' do
-      expect(node).to be_compressed
-    end
-  end
-
-  describe '.new' do
-    context 'with no parent' do
-      let(:node) { Rambling::Trie::CompressedNode.new }
-
-      it 'is marked as root' do
-        expect(node).to be_root
-      end
-    end
-
-    context 'with a specified' do
-      let(:node) { Rambling::Trie::CompressedNode.new double(:root) }
-
-      it 'is not marked as root' do
-        expect(node).not_to be_root
-      end
-    end
-  end
-
-  describe '#add' do
-    it 'raises an error' do
-      expect { node.add 'restaurant' }.to raise_error Rambling::Trie::InvalidOperation
-    end
-  end
+shared_examples_for 'a trie node implementation' do
+  it_behaves_like 'a trie node'
 
   describe '#partial_word?' do
-    let(:raw_node) { Rambling::Trie::RawNode.new }
-    let(:compressor) { Rambling::Trie::Compressor.new }
-    let(:node) { compressor.compress raw_node }
-
     context 'when the chars array is empty' do
       it 'returns true' do
         expect(node.partial_word? []).to be true
@@ -47,7 +13,7 @@ describe Rambling::Trie::CompressedNode do
     context 'when the chars array is not empty' do
       context 'when the node has a tree that matches the characters' do
         before do
-          raw_node.add 'abc'
+          add_word_to_tree 'abc'
         end
 
         it 'returns true' do
@@ -59,7 +25,7 @@ describe Rambling::Trie::CompressedNode do
 
       context 'when the node has a tree that does not match the characters' do
         before do
-          raw_node.add 'cba'
+          add_word_to_tree 'cba'
         end
 
         it 'returns false' do
@@ -72,10 +38,6 @@ describe Rambling::Trie::CompressedNode do
   end
 
   describe '#word?' do
-    let(:raw_node) { Rambling::Trie::RawNode.new }
-    let(:compressor) { Rambling::Trie::Compressor.new }
-    let(:node) { compressor.compress raw_node }
-
     context 'when the chars array is empty' do
       context 'when the node is terminal' do
         before do
@@ -97,32 +59,28 @@ describe Rambling::Trie::CompressedNode do
     context 'when the chars array is not empty' do
       context 'when the node has a tree that matches all the characters' do
         before do
-          raw_node.add 'abc'
+          add_word_to_tree 'abc'
         end
 
         it 'returns true' do
-          expect(node.word? %w(a b c)).to be true
+          expect(node.word? %w(a b c).map(&:dup)).to be true
         end
       end
 
-      context 'when the node has a tree that does not match all the characters' do
+      context 'when the node subtree does not match all the characters' do
         before do
-          raw_node.add 'abc'
+          add_word_to_tree 'abc'
         end
 
         it 'returns false' do
-          expect(node.word? %w(a)).to be false
-          expect(node.word? %w(a b)).to be false
+          expect(node.word? %w(a).map(&:dup)).to be false
+          expect(node.word? %w(a b).map(&:dup)).to be false
         end
       end
     end
   end
 
   describe '#scan' do
-    let(:raw_node) { Rambling::Trie::RawNode.new }
-    let(:compressor) { Rambling::Trie::Compressor.new }
-    let(:node) { compressor.compress raw_node }
-
     context 'when the chars array is empty' do
       it 'returns itself' do
         expect(node.scan []).to eq node
@@ -131,44 +89,39 @@ describe Rambling::Trie::CompressedNode do
 
     context 'when the chars array is not empty' do
       before do
-        raw_node.add 'cba'
+        add_words_to_tree %w(cba ccab)
       end
 
       context 'when the chars are found' do
         it 'returns the found child' do
-          expect(node.scan %w(c)).to eq node[:cba]
-          expect(node.scan %w(c b)).to eq node[:cba]
-          expect(node.scan %w(c b a)).to eq node[:cba]
+          expect(node.scan %w(c)).to match_array %w(cba ccab)
+          expect(node.scan %w(c b)).to match_array %w(cba)
+          expect(node.scan %w(c b a)).to match_array %w(cba)
         end
       end
 
       context 'when the chars are not found' do
-        it 'returns a MissingNode' do
-          expect(node.scan %w(a)).to be_a Rambling::Trie::MissingNode
-          expect(node.scan %w(a b)).to be_a Rambling::Trie::MissingNode
-          expect(node.scan %w(a b c)).to be_a Rambling::Trie::MissingNode
-          expect(node.scan %w(c b a d)).to be_a Rambling::Trie::MissingNode
+        it 'returns a Nodes::Missing' do
+          expect(node.scan %w(a)).to be_a Rambling::Trie::Nodes::Missing
+          expect(node.scan %w(a b)).to be_a Rambling::Trie::Nodes::Missing
+          expect(node.scan %w(a b c)).to be_a Rambling::Trie::Nodes::Missing
+          expect(node.scan %w(c a)).to be_a Rambling::Trie::Nodes::Missing
+          expect(node.scan %w(c c b)).to be_a Rambling::Trie::Nodes::Missing
+          expect(node.scan %w(c b a d)).to be_a Rambling::Trie::Nodes::Missing
         end
       end
     end
   end
 
   describe '#match_prefix' do
-    let(:raw_node) { Rambling::Trie::RawNode.new }
-    let(:compressor) { Rambling::Trie::Compressor.new }
-    let(:node) { compressor.compress raw_node }
-
     before do
-      raw_node.letter = :i
-      raw_node.add 'gnite'
-      raw_node.add 'mport'
-      raw_node.add 'mportant'
-      raw_node.add 'mportantly'
+      assign_letter :i
+      add_words_to_tree %w(gnite mport mportant mportantly)
     end
 
     context 'when the node is terminal' do
       before do
-        raw_node.terminal!
+        node.terminal!
       end
 
       it 'adds itself to the words' do

metadata

@@ -1,60 +1,60 @@
 --- !ruby/object:Gem::Specification
 name: rambling-trie
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Edgar Gonzalez
 - Lilibeth De La Cruz
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-12-19 00:00:00.000000000 Z
+date: 2021-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: 0.9.25
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.5
-description: The Rambling Trie is a Ruby implementation of the trie data structure,
-  which includes compression abilities and is designed to be very fast to traverse.
+        version: 0.9.25
+description: 'The Rambling Trie is a Ruby implementation of the trie data structure,
+  which includes compression abilities and is designed to be very fast to traverse. '
 email:
 - edggonzalezg@gmail.com
 - lilibethdlc@gmail.com
@@ -70,8 +70,7 @@ files:
 - lib/rambling-trie.rb
 - lib/rambling/trie.rb
 - lib/rambling/trie/comparable.rb
-- lib/rambling/trie/compressable.rb
-- lib/rambling/trie/compressed_node.rb
+- lib/rambling/trie/compressible.rb
 - lib/rambling/trie/compressor.rb
 - lib/rambling/trie/configuration.rb
 - lib/rambling/trie/configuration/properties.rb
@@ -80,9 +79,11 @@ files:
 - lib/rambling/trie/enumerable.rb
 - lib/rambling/trie/inspectable.rb
 - lib/rambling/trie/invalid_operation.rb
-- lib/rambling/trie/missing_node.rb
-- lib/rambling/trie/node.rb
-- lib/rambling/trie/raw_node.rb
+- lib/rambling/trie/nodes.rb
+- lib/rambling/trie/nodes/compressed.rb
+- lib/rambling/trie/nodes/missing.rb
+- lib/rambling/trie/nodes/node.rb
+- lib/rambling/trie/nodes/raw.rb
 - lib/rambling/trie/readers.rb
 - lib/rambling/trie/readers/plain_text.rb
 - lib/rambling/trie/serializers.rb
@@ -97,15 +98,15 @@ files:
 - spec/assets/test_words.es_DO.txt
 - spec/integration/rambling/trie_spec.rb
 - spec/lib/rambling/trie/comparable_spec.rb
-- spec/lib/rambling/trie/compressed_node_spec.rb
 - spec/lib/rambling/trie/compressor_spec.rb
 - spec/lib/rambling/trie/configuration/properties_spec.rb
 - spec/lib/rambling/trie/configuration/provider_collection_spec.rb
 - spec/lib/rambling/trie/container_spec.rb
 - spec/lib/rambling/trie/enumerable_spec.rb
 - spec/lib/rambling/trie/inspectable_spec.rb
-- spec/lib/rambling/trie/node_spec.rb
-- spec/lib/rambling/trie/raw_node_spec.rb
+- spec/lib/rambling/trie/nodes/compressed_spec.rb
+- spec/lib/rambling/trie/nodes/node_spec.rb
+- spec/lib/rambling/trie/nodes/raw_spec.rb
 - spec/lib/rambling/trie/readers/plain_text_spec.rb
 - spec/lib/rambling/trie/serializers/file_spec.rb
 - spec/lib/rambling/trie/serializers/marshal_spec.rb
@@ -115,16 +116,20 @@ files:
 - spec/lib/rambling/trie_spec.rb
 - spec/spec_helper.rb
 - spec/support/config.rb
-- spec/support/shared_examples/a_compressable_trie.rb
+- spec/support/helpers/add_word.rb
+- spec/support/helpers/one_line_heredoc.rb
+- spec/support/shared_examples/a_compressible_trie.rb
 - spec/support/shared_examples/a_serializable_trie.rb
 - spec/support/shared_examples/a_serializer.rb
 - spec/support/shared_examples/a_trie_data_structure.rb
+- spec/support/shared_examples/a_trie_node.rb
+- spec/support/shared_examples/a_trie_node_implementation.rb
 - spec/tmp/.gitkeep
 homepage: http://github.com/gonzedge/rambling-trie
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -132,16 +137,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
+  - - "<="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: A Ruby implementation of the trie data structure.
 test_files:
@@ -149,15 +156,15 @@ test_files:
 - spec/assets/test_words.es_DO.txt
 - spec/integration/rambling/trie_spec.rb
 - spec/lib/rambling/trie/comparable_spec.rb
-- spec/lib/rambling/trie/compressed_node_spec.rb
 - spec/lib/rambling/trie/compressor_spec.rb
 - spec/lib/rambling/trie/configuration/properties_spec.rb
 - spec/lib/rambling/trie/configuration/provider_collection_spec.rb
 - spec/lib/rambling/trie/container_spec.rb
 - spec/lib/rambling/trie/enumerable_spec.rb
 - spec/lib/rambling/trie/inspectable_spec.rb
-- spec/lib/rambling/trie/node_spec.rb
-- spec/lib/rambling/trie/raw_node_spec.rb
+- spec/lib/rambling/trie/nodes/compressed_spec.rb
+- spec/lib/rambling/trie/nodes/node_spec.rb
+- spec/lib/rambling/trie/nodes/raw_spec.rb
 - spec/lib/rambling/trie/readers/plain_text_spec.rb
 - spec/lib/rambling/trie/serializers/file_spec.rb
 - spec/lib/rambling/trie/serializers/marshal_spec.rb
@@ -167,8 +174,12 @@ test_files:
 - spec/lib/rambling/trie_spec.rb
 - spec/spec_helper.rb
 - spec/support/config.rb
-- spec/support/shared_examples/a_compressable_trie.rb
+- spec/support/helpers/add_word.rb
+- spec/support/helpers/one_line_heredoc.rb
+- spec/support/shared_examples/a_compressible_trie.rb
 - spec/support/shared_examples/a_serializable_trie.rb
 - spec/support/shared_examples/a_serializer.rb
 - spec/support/shared_examples/a_trie_data_structure.rb
+- spec/support/shared_examples/a_trie_node.rb
+- spec/support/shared_examples/a_trie_node_implementation.rb
 - spec/tmp/.gitkeep

data/lib/rambling/trie/compressable.rb

@@ -1,14 +0,0 @@
-module Rambling
-  module Trie
-    # Provides the compressable behavior for the trie data structure.
-    module Compressable
-      # Indicates if the current {Rambling::Trie::Node Node} can be compressed
-      # or not.
-      # @return [Boolean] `true` for non-{Node#terminal? terminal} nodes with
-      #   one child, `false` otherwise.
-      def compressable?
-        !(root? || terminal?) && children_tree.size == 1
-      end
-    end
-  end
-end

data/lib/rambling/trie/compressed_node.rb

@@ -1,120 +0,0 @@
-module Rambling
-  module Trie
-    # A representation of a node in an compressed trie data structure.
-    class CompressedNode < Rambling::Trie::Node
-      # Always raises {Rambling::Trie::InvalidOperation InvalidOperation} when
-      # trying to add a word to the current compressed trie node
-      # @param [String] word the word to add to the trie.
-      # @raise [InvalidOperation] if the trie is already compressed.
-      # @return [nil] this never returns as it always raises an exception.
-      def add word
-        raise Rambling::Trie::InvalidOperation, 'Cannot add word to compressed trie'
-      end
-
-      # Checks if a path for set a of characters exists in the trie.
-      # @param [Array<String>] chars the characters to look for in the trie.
-      # @return [Boolean] `true` if the characters are found, `false` otherwise.
-      def partial_word? chars
-        chars.empty? || has_partial_word?(chars)
-      end
-
-      # Checks if a path for set of characters represents a word in the trie.
-      # @param [Array<String>] chars the characters to look for in the trie.
-      # @return [Boolean] `true` if the characters are found and form a word,
-      #   `false` otherwise.
-      def word? chars
-        chars.empty? ? terminal? : has_word?(chars)
-      end
-
-      # Returns the node that starts with the specified characters.
-      # @param [Array<String>] chars the characters to look for in the trie.
-      # @return [Node] the node that matches the specified characters.
-      #   {MissingNode MissingNode} when not found.
-      def scan chars
-        chars.empty? ? self : closest_node(chars)
-      end
-
-      # Always return `true` for a compressed node.
-      # @return [Boolean] always `true` for a compressed node.
-      def compressed?
-        true
-      end
-
-      private
-
-      def has_partial_word? chars
-        recursive_get(:partial_word?, chars) || false
-      end
-
-      def has_word? chars
-        current_key = nil
-
-        while !chars.empty?
-          if current_key
-            current_key << chars.slice!(0)
-          else
-            current_key = chars.slice!(0)
-          end
-
-          child = children_tree[current_key.to_sym]
-          return child.word? chars if child
-        end
-
-        false
-      end
-
-      def closest_node chars
-        recursive_get(:scan, chars) || Rambling::Trie::MissingNode.new
-      end
-
-      def children_match_prefix chars
-        return enum_for :children_match_prefix, chars unless block_given?
-
-        current_key = nil
-
-        while !chars.empty?
-          if current_key
-            current_key << chars.slice!(0)
-          else
-            current_key = chars.slice!(0)
-          end
-
-          child = children_tree[current_key.to_sym]
-
-          if child
-            child.match_prefix chars do |word|
-              yield word
-            end
-          end
-        end
-      end
-
-      def recursive_get method, chars
-        current_length = 0
-        current_key = current_key chars.slice!(0)
-
-        begin
-          current_length += 1
-
-          if current_key && (current_key.length == current_length || chars.empty?)
-            return children_tree[current_key.to_sym].send method, chars
-          end
-        end while current_key && current_key[current_length] == chars.slice!(0)
-      end
-
-      def current_key letter
-        current_key = nil
-
-        children_tree.keys.each do |key|
-          key_string = key.to_s
-          if key_string.start_with? letter
-            current_key = key_string
-            break
-          end
-        end
-
-        current_key
-      end
-    end
-  end
-end