rambling-trie-opal 2.1.1

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+module Rambling
+  module Trie
+    describe Enumerable do
+      let(:node) { Rambling::Trie::Nodes::Raw.new }
+      let(:words) { %w(add some words and another word) }
+
+      before do
+        add_words node, words
+      end
+
+      describe '#each' do
+        it 'returns an enumerator' do
+          expect(node.each).to be_a Enumerator
+        end
+
+        it 'includes every word contained in the trie' do
+          node.each do |word|
+            expect(words).to include word
+          end
+
+          expect(node.count).to eq words.count
+        end
+      end
+
+      describe '#size' do
+        it 'delegates to #count' do
+          expect(node.size).to eq words.size
+        end
+      end
+
+      it 'includes the core Enumerable module' do
+        expect(node.all? { |word| words.include? word }).to be true
+        expect(node.any? { |word| word.start_with? 's' }).to be true
+        expect(node.to_a).to match_array words
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Rambling::Trie::Inspectable do
+  let(:node) { Rambling::Trie::Nodes::Raw.new }
+
+  before do
+    add_words node, %w(only three words)
+  end
+
+  describe '#inspect' do
+    let(:child) { node[:o] }
+    let(:terminal_node) { node[:o][:n][:l][:y] }
+
+    it 'returns a pretty printed version of the node' do
+      expect(node.inspect).to eq one_line <<~RAW
+        #<Rambling::Trie::Nodes::Raw letter: nil,
+        terminal: nil,
+        children: [:o, :t, :w]>
+      RAW
+
+      expect(child.inspect).to eq one_line <<~CHILD
+        #<Rambling::Trie::Nodes::Raw letter: :o,
+        terminal: nil,
+        children: [:n]>
+      CHILD
+
+      expect(terminal_node.inspect).to eq one_line <<~TERMINAL
+        #<Rambling::Trie::Nodes::Raw letter: :y,
+        terminal: true,
+        children: []>
+      TERMINAL
+    end
+
+    context 'for a compressed node' do
+      let(:compressor) { Rambling::Trie::Compressor.new }
+      let(:compressed) { compressor.compress node }
+      let(:compressed_child) { compressed[:o] }
+
+      it 'returns a pretty printed version of the compressed node' do
+        expect(compressed.inspect).to eq one_line <<~COMPRESSED
+          #<Rambling::Trie::Nodes::Compressed letter: nil,
+          terminal: nil,
+          children: [:o, :t, :w]>
+        COMPRESSED
+
+        expect(compressed_child.inspect).to eq one_line <<~CHILD
+          #<Rambling::Trie::Nodes::Compressed letter: :only,
+          terminal: true,
+          children: []>
+        CHILD
+      end
+    end
+  end
+end

data/spec/lib/rambling/trie/nodes/compressed_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Rambling::Trie::Nodes::Compressed do
+  let(:raw_node) { Rambling::Trie::Nodes::Raw.new }
+  let(:compressor) { Rambling::Trie::Compressor.new }
+  let(:node) { compressor.compress raw_node }
+
+  it_behaves_like 'a trie node implementation' do
+    def add_word_to_tree word
+      add_word raw_node, word
+    end
+
+    def add_words_to_tree words
+      add_words raw_node, words
+    end
+
+    def assign_letter letter
+      raw_node.letter = letter
+    end
+  end
+
+  describe '#compressed?' do
+    it 'returns true' do
+      expect(node).to be_compressed
+    end
+  end
+
+  describe '#add' do
+    it 'raises an error' do
+      expect do
+        add_word node, 'restaurant'
+      end.to raise_error Rambling::Trie::InvalidOperation
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Rambling::Trie::Nodes::Node do
+  it_behaves_like 'a trie node' do
+    let(:node) { Rambling::Trie::Nodes::Node.new }
+  end
+end

data/spec/lib/rambling/trie/nodes/raw_spec.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Rambling::Trie::Nodes::Raw do
+  let(:node) { Rambling::Trie::Nodes::Raw.new }
+
+  it_behaves_like 'a trie node implementation' do
+    def add_word_to_tree word
+      add_word node, word
+    end
+
+    def add_words_to_tree words
+      add_words node, words
+    end
+
+    def assign_letter letter
+      node.letter = letter
+    end
+
+    it 'is not a word' do
+      expect(node).not_to be_word
+    end
+  end
+
+  describe '#compressed?' do
+    it 'returns false' do
+      expect(node).not_to be_compressed
+    end
+  end
+
+  describe '#add' do
+    context 'when the node has no branches' do
+      before do
+        add_word node, 'abc'
+      end
+
+      it 'adds only one child' do
+        expect(node.children.size).to eq 1
+      end
+
+      it 'adds the full subtree' do
+        expect(node[:a]).not_to be_nil
+        expect(node[:a][:b]).not_to be_nil
+        expect(node[:a][:b][:c]).not_to be_nil
+      end
+
+      it 'marks only the last child as terminal' do
+        expect(node).not_to be_terminal
+        expect(node[:a]).not_to be_terminal
+        expect(node[:a][:b]).not_to be_terminal
+        expect(node[:a][:b][:c]).to be_terminal
+      end
+    end
+
+    context 'when a word is added more than once' do
+      before do
+        add_word node, 'ack'
+        add_word node, 'ack'
+      end
+
+      it 'only counts it once' do
+        expect(node.children.size).to eq 1
+        expect(node[:a].children.size).to eq 1
+        expect(node[:a][:c].children.size).to eq 1
+        expect(node[:a][:c][:k].children.size).to eq 0
+      end
+
+      it 'does not change the terminal nodes in the tree' do
+        expect(node).not_to be_terminal
+        expect(node[:a]).not_to be_terminal
+        expect(node[:a][:c]).not_to be_terminal
+        expect(node[:a][:c][:k]).to be_terminal
+      end
+
+      it 'still returns the "added" node' do
+        child = add_word node, 'ack'
+        expect(child.letter).to eq :a
+      end
+    end
+
+    context 'when the word does not exist in the tree but the letters do' do
+      before do
+        add_words node, %w(ack a)
+      end
+
+      it 'does not add another branch' do
+        expect(node.children.size).to eq 1
+      end
+
+      it 'marks the corresponding node as terminal' do
+        expect(node[:a]).to be_terminal
+
+        expect(node).not_to be_terminal
+        expect(node[:a][:c]).not_to be_terminal
+        expect(node[:a][:c][:k]).to be_terminal
+      end
+
+      it 'returns the added node' do
+        child = add_word node, 'a'
+        expect(child.letter).to eq :a
+      end
+    end
+
+    context 'when the node has a letter and a parent' do
+      let(:parent) { Rambling::Trie::Nodes::Raw.new }
+      let(:node) { Rambling::Trie::Nodes::Raw.new :a, parent }
+
+      context 'adding an empty string' do
+        before do
+          add_word node, ''
+        end
+
+        it 'does not alter the node letter' do
+          expect(node.letter).to eq :a
+        end
+
+        it 'does not change the node children' do
+          expect(node.children.size).to eq 0
+        end
+
+        it 'changes the node to terminal' do
+          expect(node).to be_terminal
+        end
+      end
+
+      context 'adding a one letter word' do
+        before do
+          add_word node, 'b'
+        end
+
+        it 'does not alter the node letter' do
+          expect(node.letter).to eq :a
+        end
+
+        it 'adds a child with the expected letter' do
+          expect(node.children.size).to eq 1
+          expect(node.children.first.letter).to eq :b
+        end
+
+        it 'reports it has the expected letter a key' do
+          expect(node).to have_key(:b)
+        end
+
+        it 'returns the child corresponding to the key' do
+          expect(node[:b]).to eq node.children_tree[:b]
+        end
+
+        it 'does not mark itself as terminal' do
+          expect(node).not_to be_terminal
+        end
+
+        it 'marks the first child as terminal' do
+          expect(node[:b]).to be_terminal
+        end
+      end
+
+      context 'adding a large word' do
+        before do
+          add_word node, 'mplified'
+        end
+
+        it 'marks the last letter as terminal' do
+          expect(node[:m][:p][:l][:i][:f][:i][:e][:d]).to be_terminal
+        end
+
+        it 'does not mark any other letter as terminal' do
+          expect(node[:m][:p][:l][:i][:f][:i][:e]).not_to be_terminal
+          expect(node[:m][:p][:l][:i][:f][:i]).not_to be_terminal
+          expect(node[:m][:p][:l][:i][:f]).not_to be_terminal
+          expect(node[:m][:p][:l][:i]).not_to be_terminal
+          expect(node[:m][:p][:l]).not_to be_terminal
+          expect(node[:m][:p]).not_to be_terminal
+          expect(node[:m]).not_to be_terminal
+        end
+      end
+    end
+  end
+end

data/spec/lib/rambling/trie/readers/plain_text_spec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Rambling::Trie::Readers::PlainText do
+  describe '#each_word' do
+    let(:filepath) { File.join(::SPEC_ROOT, 'assets', 'test_words.en_US.txt') }
+    let(:words) { File.readlines(filepath).map(&:chomp) }
+
+    it 'yields every word yielded by the file' do
+      yielded = []
+      subject.each_word(filepath) { |word| yielded << word }
+      expect(yielded).to eq words
+    end
+  end
+end

data/spec/lib/rambling/trie/serializers/file_spec.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Rambling::Trie::Serializers::File do
+  it_behaves_like 'a serializer' do
+    let(:serializer) { Rambling::Trie::Serializers::File.new }
+    let(:format) { :file }
+
+    let(:content) { trie.to_a.join ' ' }
+    let(:formatted_content) { content }
+  end
+end

data/spec/lib/rambling/trie/serializers/marshal_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Rambling::Trie::Serializers::Marshal do
+  it_behaves_like 'a serializer' do
+    let(:serializer) { Rambling::Trie::Serializers::Marshal.new }
+    let(:format) { :marshal }
+
+    let(:formatted_content) { Marshal.dump content }
+  end
+end

data/spec/lib/rambling/trie/serializers/yaml_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Rambling::Trie::Serializers::Yaml do
+  it_behaves_like 'a serializer' do
+    let(:serializer) { Rambling::Trie::Serializers::Yaml.new }
+    let(:format) { :yml }
+
+    let(:formatted_content) { YAML.dump content }
+  end
+end

data/spec/lib/rambling/trie/serializers/zip_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+# describe Rambling::Trie::Serializers::Zip do
+#   it_behaves_like 'a serializer' do
+#     let(:properties) { Rambling::Trie::Configuration::Properties.new }
+#     let(:serializer) { Rambling::Trie::Serializers::Zip.new properties }
+#     let(:format) { 'marshal.zip' }
+
+#     before do
+#       properties.tmp_path = tmp_path
+#     end
+
+#     let(:filename) { File.basename(filepath).gsub %r{\.zip}, '' }
+#     let(:formatted_content) { zip Marshal.dump content }
+
+#     def zip content
+#       cursor = Zip::OutputStream.write_buffer do |io|
+#         io.put_next_entry filename
+#         io.write content
+#       end
+
+#       cursor.rewind
+#       cursor.read
+#     end
+#   end
+# end

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

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Rambling::Trie::Stringifyable do
+  describe '#as_word' do
+    let(:node) { Rambling::Trie::Nodes::Raw.new }
+
+    context 'for an empty node' do
+      before do
+        add_word node, ''
+      end
+
+      it 'returns nil' do
+        expect(node.as_word).to be_empty
+      end
+    end
+
+    context 'for one letter' do
+      before do
+        node.letter = :a
+        add_word node, ''
+      end
+
+      it 'returns the expected one letter word' do
+        expect(node.as_word).to eq 'a'
+      end
+    end
+
+    context 'for a small word' do
+      before do
+        node.letter = :a
+        add_word node, 'll'
+      end
+
+      it 'returns the expected small word' do
+        expect(node[:l][:l].as_word).to eq 'all'
+      end
+
+      it 'raises an error for a non terminal node' do
+        expect { node[:l].as_word }
+          .to raise_error Rambling::Trie::InvalidOperation
+      end
+    end
+
+    context 'for a long word' do
+      before do
+        node.letter = :b
+        add_word node, 'eautiful'
+      end
+
+      it 'returns the expected long word' do
+        expect(node[:e][:a][:u][:t][:i][:f][:u][:l].as_word).to eq 'beautiful'
+      end
+    end
+
+    context 'for a node with nil letter' do
+      let(:node) { Rambling::Trie::Nodes::Raw.new nil }
+
+      it 'returns nil' do
+        expect(node.as_word).to be_empty
+      end
+    end
+
+    context 'for a compressed node' do
+      let(:compressor) { Rambling::Trie::Compressor.new }
+      let(:compressed_node) { compressor.compress node }
+
+      before do
+        node.letter = :a
+        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[: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
+      end
+    end
+  end
+end