rambling-trie 1.0.2 → 2.2.0

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

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Rambling::Trie::Stringifyable do
   describe '#as_word' do
-    let(:node) { Rambling::Trie::RawNode.new }
+    let(:node) { Rambling::Trie::Nodes::Raw.new }
 
     context 'for an empty node' do
       before do
-        node.add ''
+        add_word node, ''
       end
 
       it 'returns nil' do
@@ -17,7 +19,7 @@ describe Rambling::Trie::Stringifyable do
     context 'for one letter' do
       before do
         node.letter = :a
-        node.add ''
+        add_word node, ''
       end
 
       it 'returns the expected one letter word' do
@@ -28,7 +30,7 @@ describe Rambling::Trie::Stringifyable do
     context 'for a small word' do
       before do
         node.letter = :a
-        node.add 'll'
+        add_word node, 'll'
       end
 
       it 'returns the expected small word' do
@@ -36,14 +38,15 @@ describe Rambling::Trie::Stringifyable do
       end
 
       it 'raises an error for a non terminal node' do
-        expect { node[:l].as_word }.to raise_error Rambling::Trie::InvalidOperation
+        expect { node[:l].as_word }
+          .to raise_error Rambling::Trie::InvalidOperation
       end
     end
 
     context 'for a long word' do
       before do
         node.letter = :b
-        node.add 'eautiful'
+        add_word node, 'eautiful'
       end
 
       it 'returns the expected long word' do
@@ -52,7 +55,7 @@ describe Rambling::Trie::Stringifyable do
     end
 
     context 'for a node with nil letter' do
-      let(:node) { Rambling::Trie::RawNode.new nil }
+      let(:node) { Rambling::Trie::Nodes::Raw.new nil }
 
       it 'returns nil' do
         expect(node.as_word).to be_empty
@@ -65,17 +68,17 @@ describe Rambling::Trie::Stringifyable do
 
       before do
         node.letter = :a
-        node.add 'm'
-        node.add 'dd'
+        add_words node, %w(m dd)
       end
 
       it 'returns the words for the terminal nodes' do
         expect(compressed_node[:m].as_word).to eq 'am'
-        expect(compressed_node[:dd].as_word).to eq 'add'
+        expect(compressed_node[:d].as_word).to eq 'add'
       end
 
       it 'raise an error for non terminal nodes' do
-        expect { compressed_node.as_word }.to raise_error Rambling::Trie::InvalidOperation
+        expect { compressed_node.as_word }
+          .to raise_error Rambling::Trie::InvalidOperation
       end
     end
   end

data/spec/lib/rambling/trie_spec.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 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 }
 
@@ -31,7 +33,10 @@ describe Rambling::Trie do
 
       before do
         receive_and_yield = receive(:each_word)
-        words.inject(receive_and_yield) { |yielder, word| yielder.and_yield word }
+        words.inject(receive_and_yield) do |yielder, word|
+          yielder.and_yield word
+        end
+
         allow(reader).to receive_and_yield
         allow(container).to receive :<<
       end
@@ -40,7 +45,7 @@ describe Rambling::Trie do
         Rambling::Trie.create filepath, reader
 
         words.each do |word|
-          expect(container).to have_received(:<<).with(word)
+          expect(container).to have_received(:<<).with word
         end
       end
     end
@@ -65,7 +70,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 }
@@ -77,7 +82,7 @@ describe Rambling::Trie do
     end
 
     it 'uses the serializer to load the root node from the given filepath' do
-      trie = Rambling::Trie.load filepath, serializer
+      Rambling::Trie.load filepath, serializer
       expect(serializer).to have_received(:load).with filepath
     end
 
@@ -98,16 +103,16 @@ describe Rambling::Trie do
       end
 
       it 'determines the serializer based on the file extension' do
-        trie = Rambling::Trie.load 'test.marshal'
+        Rambling::Trie.load 'test.marshal'
         expect(marshal_serializer).to have_received(:load).with 'test.marshal'
 
-        trie = Rambling::Trie.load 'test.yml'
+        Rambling::Trie.load 'test.yml'
         expect(yaml_serializer).to have_received(:load).with 'test.yml'
 
-        trie = Rambling::Trie.load 'test.yaml'
+        Rambling::Trie.load 'test.yaml'
         expect(yaml_serializer).to have_received(:load).with 'test.yaml'
 
-        trie = Rambling::Trie.load 'test'
+        Rambling::Trie.load 'test'
         expect(default_serializer).to have_received(:load).with 'test'
       end
     end
@@ -153,10 +158,12 @@ describe Rambling::Trie do
     context 'when provided with a format' do
       it 'uses the corresponding serializer' do
         Rambling::Trie.dump trie, "#{filename}.marshal"
-        expect(marshal_serializer).to have_received(:dump).with root, "#{filename}.marshal"
+        expect(marshal_serializer).to have_received(:dump)
+          .with root, "#{filename}.marshal"
 
         Rambling::Trie.dump trie, "#{filename}.yml"
-        expect(yaml_serializer).to have_received(:dump).with root, "#{filename}.yml"
+        expect(yaml_serializer).to have_received(:dump)
+          .with root, "#{filename}.yml"
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'simplecov'
 require 'coveralls'
 
@@ -5,7 +7,7 @@ Coveralls.wear!
 
 SimpleCov.formatters = [
   SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter
+  Coveralls::SimpleCov::Formatter,
 ]
 
 SimpleCov.start do
@@ -26,7 +28,10 @@ RSpec.configure do |config|
 end
 
 require 'support/config'
-require 'support/shared_examples/a_compressable_trie'
-require 'support/shared_examples/a_serializable_trie'
-require 'support/shared_examples/a_serializer'
-require 'support/shared_examples/a_trie_data_structure'
+
+%w(
+  a_compressible_trie a_serializable_trie a_serializer a_trie_data_structure
+  a_trie_node a_trie_node_implementation
+).each do |name|
+  require File.join('support', 'shared_examples', name)
+end

data/spec/support/config.rb

@@ -1,5 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'helpers/add_word'
+require_relative 'helpers/one_line_heredoc'
+
 RSpec.configure do |c|
   c.before do
     Rambling::Trie.config.reset
   end
+
+  c.include Support::Helpers::AddWord
+  c.include Support::Helpers::OneLineHeredoc
+
+  RSpec::Matchers.define_negated_matcher :not_change, :change
 end

data/spec/support/helpers/add_word.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+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/helpers/one_line_heredoc.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Support
+  module Helpers
+    module OneLineHeredoc
+      def one_line heredoc
+        heredoc.strip.tr "\n", ' '
+      end
+    end
+  end
+end

data/spec/support/shared_examples/a_compressible_trie.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+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'
+      add_word trie, word
+
+      expect(word).to eq 'string'
+    end
+
+    it 'is marked as not compressed' do
+      expect(trie).not_to be_compressed
+    end
+  end
+
+  context 'and the trie is compressed' do
+    let!(:original_root) { trie.root }
+    let!(:original_keys) { original_root.children_tree.keys }
+    let!(:original_values) { original_root.children_tree.values }
+
+    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_keys
+      expect(trie.children_tree.keys).to eq original_keys
+      expect(trie.children_tree.values).not_to eq original_values
+    end
+  end
+end

data/spec/support/shared_examples/a_serializable_trie.rb

@@ -1,20 +1,24 @@
+# frozen_string_literal: true
+
 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,13 @@
+# frozen_string_literal: true
+
 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
 
@@ -13,7 +21,7 @@ shared_examples_for 'a serializer' do
     end
 
     it 'converts the contents to the appropriate format' do
-      expect(File.read(filepath).size).to eq formatted_content.size
+      expect(File.read(filepath).size).to be_within(10).of formatted_content.size
     end
   end
 

data/spec/support/shared_examples/a_trie_data_structure.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 shared_examples_for 'a trie data structure' do
   it 'contains all the words previously provided' do
     words.each do |word|

data/spec/support/shared_examples/a_trie_node.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+shared_examples_for 'a trie node' do
+  let(:node_class) { node.class }
+
+  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 = node
+      end
+
+      it 'returns false' do
+        expect(node).not_to be_root
+      end
+    end
+
+    context 'when the node does not have a parent' do
+      before do
+        node.parent = nil
+      end
+
+      it 'returns true' do
+        expect(node).to be_root
+      end
+    end
+  end
+
+  describe '#terminal!' do
+    it 'forces the node to be terminal' do
+      expect(node).not_to be_terminal
+      node.terminal!
+
+      expect(node).to be_terminal
+    end
+
+    it 'returns the node' do
+      expect(node.terminal!).to eq node
+    end
+  end
+
+  describe 'delegates and aliases' do
+    let(:children_tree) do
+      double(
+        :children_tree,
+        :[] => 'value',
+        :[]= => nil,
+        key?: false,
+        delete: true,
+      )
+    end
+
+    before do
+      node.children_tree = children_tree
+    end
+
+    it 'delegates `#[]` to its children tree' do
+      expect(node[:key]).to eq 'value'
+      expect(children_tree).to have_received(:[]).with :key
+    end
+
+    it 'delegates `#[]=` to its children tree' do
+      node[:key] = 'value'
+      expect(children_tree).to have_received(:[]=).with(:key, 'value')
+    end
+
+    it 'delegates `#key?` to its children tree' do
+      allow(children_tree).to receive(:key?)
+        .with(:present_key)
+        .and_return true
+
+      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)]
+      allow(children_tree).to receive(:values).and_return children
+
+      expect(node.children).to eq children
+    end
+
+    it 'aliases `#has_key?` to `#key?`' do
+      node.has_key? :nope
+      expect(children_tree).to have_received(:key?).with :nope
+    end
+  end
+end