rambling-trie 1.0.2 → 1.0.3

data/spec/lib/rambling/trie_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Rambling::Trie do
   describe '.create' do
-    let(:root) { Rambling::Trie::RawNode.new }
+    let(:root) { Rambling::Trie::Nodes::Raw.new }
     let(:compressor) { Rambling::Trie::Compressor.new }
     let!(:container) { Rambling::Trie::Container.new root, compressor }
 
@@ -65,7 +65,7 @@ describe Rambling::Trie do
   end
 
   describe '.load' do
-    let(:root) { Rambling::Trie::RawNode.new }
+    let(:root) { Rambling::Trie::Nodes::Raw.new }
     let(:compressor) { Rambling::Trie::Compressor.new }
     let(:container) { Rambling::Trie::Container.new root, compressor }
     let(:serializer) { double :serializer, load: root }

data/spec/spec_helper.rb

@@ -26,7 +26,9 @@ RSpec.configure do |config|
 end
 
 require 'support/config'
-require 'support/shared_examples/a_compressable_trie'
+require 'support/shared_examples/a_compressible_trie'
 require 'support/shared_examples/a_serializable_trie'
 require 'support/shared_examples/a_serializer'
 require 'support/shared_examples/a_trie_data_structure'
+require 'support/shared_examples/a_trie_node'
+require 'support/shared_examples/a_trie_node_implementation'

data/spec/support/config.rb

@@ -1,5 +1,9 @@
+require_relative 'helpers/add_word'
+
 RSpec.configure do |c|
   c.before do
     Rambling::Trie.config.reset
   end
+
+  c.include Support::Helpers::AddWord
 end

data/spec/support/helpers/add_word.rb

@@ -0,0 +1,18 @@
+module Support
+  module Helpers
+    module AddWord
+      def add_words node, words
+        words.each { |word| add_word node, word }
+      end
+
+      def add_word node, word
+        case node
+        when Rambling::Trie::Container
+          node.add word
+        else
+          node.add word.chars.reverse.map(&:to_sym)
+        end
+      end
+    end
+  end
+end

data/spec/support/shared_examples/{a_compressable_trie.rb → a_compressible_trie.rb}

@@ -1,10 +1,10 @@
-shared_examples_for 'a compressable trie' do
+shared_examples_for 'a compressible trie' do
   context 'and the trie is not compressed' do
     it_behaves_like 'a trie data structure'
 
     it 'does not alter the input' do
       word = 'string'
-      trie.add word
+      add_word trie, word
 
       expect(word).to eq 'string'
     end
@@ -15,12 +15,22 @@ shared_examples_for 'a compressable trie' do
   end
 
   context 'and the trie is compressed' do
-    before { trie.compress! }
+    let!(:original_root) { trie.root }
+    let!(:original_tree) { original_root.children_tree.keys }
+
+    before do
+      trie.compress!
+    end
 
     it_behaves_like 'a trie data structure'
 
     it 'is marked as compressed' do
       expect(trie).to be_compressed
     end
+
+    it 'leaves the original root intact' do
+      expect(original_root.children_tree.keys).to eq original_tree
+      expect(trie.children_tree.keys).not_to eq original_tree
+    end
   end
 end

data/spec/support/shared_examples/a_serializable_trie.rb

@@ -1,20 +1,22 @@
 shared_examples_for 'a serializable trie' do
+  let(:tmp_path) { File.join ::SPEC_ROOT, 'tmp' }
+  let(:filepath) { File.join tmp_path, "trie-root.#{format}" }
+
   context 'and the trie is not compressed' do
     before do
-      Rambling::Trie.dump trie_to_serialize, trie_filepath, serializer
+      Rambling::Trie.dump trie_to_serialize, filepath
     end
 
-    it_behaves_like 'a compressable trie' do
-      let(:trie) { loaded_trie }
+    it_behaves_like 'a compressible trie' do
+      let(:trie) { Rambling::Trie.load filepath }
     end
   end
 
   context 'and the trie is compressed' do
-    let(:trie) { loaded_trie }
+    let(:trie) { Rambling::Trie.load filepath }
 
     before do
-      FileUtils.rm_f trie_filepath
-      Rambling::Trie.dump trie_to_serialize.compress!, trie_filepath, serializer
+      Rambling::Trie.dump trie_to_serialize.compress!, filepath
     end
 
     it_behaves_like 'a trie data structure'

data/spec/support/shared_examples/a_serializer.rb

@@ -1,5 +1,11 @@
 shared_examples_for 'a serializer' do
+  let(:trie) { Rambling::Trie.create }
+  let(:tmp_path) { File.join ::SPEC_ROOT, 'tmp' }
+  let(:filepath) { File.join tmp_path, "trie-root.#{format}" }
+  let(:content) { trie.root }
+
   before do
+    trie.concat %w(a few words to validate that load and dump are working)
     FileUtils.rm_f filepath
   end
 

data/spec/{lib/rambling/trie/node_spec.rb → support/shared_examples/a_trie_node.rb}

@@ -1,12 +1,45 @@
-require 'spec_helper'
+shared_examples_for 'a trie node' do
+  let(:node_class) { node.class }
 
-describe Rambling::Trie::Node do
-  let(:node) { Rambling::Trie::Node.new }
+  describe '.new' do
+    it 'has no letter' do
+      expect(node.letter).to be_nil
+    end
+
+    it 'has no children' do
+      expect(node.children.size).to eq 0
+    end
+
+    it 'is not terminal' do
+      expect(node).not_to be_terminal
+    end
+
+    it 'returns empty string as its word' do
+      expect(node.as_word).to be_empty
+    end
+
+    context 'with a letter and a parent' do
+      let(:parent) { node.class.new }
+      let(:node_with_parent) { node_class.new :a, parent }
+
+      it 'does not have any letter' do
+        expect(node_with_parent.letter).to eq :a
+      end
+
+      it 'has no children' do
+        expect(node_with_parent.children.size).to eq 0
+      end
+
+      it 'is not terminal' do
+        expect(node_with_parent).not_to be_terminal
+      end
+    end
+  end
 
   describe '#root?' do
     context 'when the node has a parent' do
       before do
-        node.parent = double :parent
+        node.parent = node
       end
 
       it 'returns false' do
@@ -25,26 +58,6 @@ describe Rambling::Trie::Node do
     end
   end
 
-  describe '.new' do
-    let(:node) { Rambling::Trie::Node.new }
-
-    it 'does not have any letter' do
-      expect(node.letter).to be_nil
-    end
-
-    it 'includes no children' do
-      expect(node.children.size).to eq 0
-    end
-
-    it 'is not a terminal node' do
-      expect(node).not_to be_terminal
-    end
-
-    it 'returns empty string as its word' do
-      expect(node.as_word).to be_empty
-    end
-  end
-
   describe '#terminal!' do
     it 'forces the node to be terminal' do
       expect(node).not_to be_terminal
@@ -59,27 +72,45 @@ describe Rambling::Trie::Node do
   end
 
   describe 'delegates and aliases' do
+    let(:children_tree) do
+      double :children_tree, {
+        :[] => 'value',
+        :[]= => nil,
+        has_key?: false,
+        delete: true,
+      }
+    end
+
+    before do
+      node.children_tree = children_tree
+    end
+
     it 'delegates `#[]` to its children tree' do
-      expect(node.children_tree).to receive(:[]).with(:key).and_return('value')
       expect(node[:key]).to eq 'value'
+      expect(children_tree).to have_received(:[]).with :key
     end
 
     it 'delegates `#[]=` to its children tree' do
-      expect(node.children_tree).to receive(:[]=).with(:key, 'value')
       node[:key] = 'value'
+      expect(children_tree).to have_received(:[]=).with(:key, 'value')
     end
 
     it 'delegates `#has_key?` to its children tree' do
-      expect(node.children_tree).to receive(:has_key?).with(:present_key).and_return(true)
-      expect(node).to have_key(:present_key)
+      allow(children_tree).to receive(:has_key?).with(:present_key).and_return true
 
-      expect(node.children_tree).to receive(:has_key?).with(:absent_key).and_return(false)
+      expect(node).to have_key(:present_key)
       expect(node).not_to have_key(:absent_key)
     end
 
+    it 'delegates `#delete` to its children tree' do
+      expect(node.delete :key).to be true
+      expect(children_tree).to have_received(:delete).with :key
+    end
+
     it 'delegates `#children` to its children tree values' do
       children = [double(:child_1), double(:child_2)]
-      expect(node.children_tree).to receive(:values).and_return(children)
+      allow(children_tree).to receive(:values).and_return children
+
       expect(node.children).to eq children
     end
   end

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

@@ -1,43 +1,7 @@
-require 'spec_helper'
-
-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 +11,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 +23,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 +36,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,7 +57,7 @@ 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
@@ -107,7 +67,7 @@ describe Rambling::Trie::CompressedNode do
 
       context 'when the node has a tree that does not match all the characters' do
         before do
-          raw_node.add 'abc'
+          add_word_to_tree 'abc'
         end
 
         it 'returns false' do
@@ -119,10 +79,6 @@ describe Rambling::Trie::CompressedNode do
   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 +87,37 @@ describe Rambling::Trie::CompressedNode do
 
     context 'when the chars array is not empty' do
       before do
-        raw_node.add 'cba'
+        add_word_to_tree 'cba'
       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)
+          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 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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rambling-trie
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Edgar Gonzalez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-19 00:00:00.000000000 Z
+date: 2018-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -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,10 +116,13 @@ 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/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:
@@ -149,15 +153,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 +171,11 @@ 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/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