rambling-trie-opal 2.1.1

data/spec/lib/rambling/trie_spec.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Rambling::Trie do
+  describe '.create' do
+    let(:root) { Rambling::Trie::Nodes::Raw.new }
+    let(:compressor) { Rambling::Trie::Compressor.new }
+    let!(:container) { Rambling::Trie::Container.new root, compressor }
+
+    before do
+      allow(Rambling::Trie::Container).to receive(:new)
+        .and_yield(container)
+        .and_return container
+    end
+
+    it 'returns a new instance of the trie container' do
+      expect(Rambling::Trie.create).to eq container
+    end
+
+    context 'with a block' do
+      it 'yields the new container' do
+        yielded = nil
+        Rambling::Trie.create { |trie| yielded = trie }
+        expect(yielded).to eq container
+      end
+    end
+
+    context 'with a filepath' do
+      let(:filepath) { 'a test filepath' }
+      let(:reader) { double :reader }
+      let(:words) { %w(a couple of test words over here) }
+
+      before do
+        receive_and_yield = receive(:each_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
+
+      it 'loads every word' do
+        Rambling::Trie.create filepath, reader
+
+        words.each do |word|
+          expect(container).to have_received(:<<).with word
+        end
+      end
+    end
+
+    context 'without any reader' do
+      let(:filepath) { 'a test filepath' }
+      let(:reader) { double :reader, each_word: nil }
+
+      before do
+        Rambling::Trie.config do |c|
+          c.readers.add :default, reader
+          c.readers.default = reader
+        end
+      end
+
+      it 'defaults to a plain text reader' do
+        Rambling::Trie.create filepath, nil
+
+        expect(reader).to have_received(:each_word).with filepath
+      end
+    end
+  end
+
+  describe '.load' do
+    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 }
+    let(:filepath) { 'a path to a file' }
+
+    it 'returns a new container with the loaded root node' do
+      trie = Rambling::Trie.load filepath, serializer
+      expect(trie).to eq container
+    end
+
+    it 'uses the serializer to load the root node from the given filepath' do
+      Rambling::Trie.load filepath, serializer
+      expect(serializer).to have_received(:load).with filepath
+    end
+
+    context 'without a serializer' do
+      let(:marshal_serializer) { double :marshal_serializer, load: nil }
+      let(:default_serializer) { double :default_serializer, load: nil }
+      let(:yaml_serializer) { double :yaml_serializer, load: nil }
+
+      before do
+        Rambling::Trie.config do |c|
+          c.serializers.add :default, default_serializer
+          c.serializers.add :marshal, marshal_serializer
+          c.serializers.add :yml, yaml_serializer
+          c.serializers.add :yaml, yaml_serializer
+
+          c.serializers.default = default_serializer
+        end
+      end
+
+      it 'determines the serializer based on the file extension' do
+        Rambling::Trie.load 'test.marshal'
+        expect(marshal_serializer).to have_received(:load).with 'test.marshal'
+
+        Rambling::Trie.load 'test.yml'
+        expect(yaml_serializer).to have_received(:load).with 'test.yml'
+
+        Rambling::Trie.load 'test.yaml'
+        expect(yaml_serializer).to have_received(:load).with 'test.yaml'
+
+        Rambling::Trie.load 'test'
+        expect(default_serializer).to have_received(:load).with 'test'
+      end
+    end
+
+    context 'with a block' do
+      it 'yields the new container' do
+        yielded = nil
+
+        Rambling::Trie.load filepath, serializer do |trie|
+          yielded = trie
+        end
+
+        expect(yielded).to eq container
+      end
+    end
+  end
+
+  describe '.dump' do
+    let(:filename) { 'a trie' }
+    let(:root) { double :root }
+    let(:compressor) { double :compressor }
+    let(:trie) { Rambling::Trie::Container.new root, compressor }
+
+    let(:marshal_serializer) { double :marshal_serializer, dump: nil }
+    let(:yaml_serializer) { double :yaml_serializer, dump: nil }
+    let(:default_serializer) { double :default_serializer, dump: nil }
+
+    before do
+      Rambling::Trie.config do |c|
+        c.serializers.add :default, default_serializer
+        c.serializers.add :marshal, marshal_serializer
+        c.serializers.add :yml, yaml_serializer
+
+        c.serializers.default = default_serializer
+      end
+    end
+
+    it 'uses the configured default serializer by default' do
+      Rambling::Trie.dump trie, filename
+      expect(default_serializer).to have_received(:dump).with root, filename
+    end
+
+    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"
+
+        Rambling::Trie.dump trie, "#{filename}.yml"
+        expect(yaml_serializer).to have_received(:dump)
+          .with root, "#{filename}.yml"
+      end
+    end
+  end
+
+  describe '.config' do
+    it 'returns the properties' do
+      expect(Rambling::Trie.config).to eq Rambling::Trie.send :properties
+    end
+
+    it 'yields the properties' do
+      yielded = nil
+      Rambling::Trie.config { |c| yielded = c }
+      expect(yielded).to eq Rambling::Trie.send :properties
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+require 'coveralls'
+
+Coveralls.wear!
+
+SimpleCov.formatters = [
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter,
+]
+
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
+require 'rspec'
+require 'rambling-trie'
+::SPEC_ROOT = File.dirname __FILE__
+
+RSpec.configure do |config|
+  config.color = true
+  config.tty = true
+  config.formatter = :documentation
+  config.order = :random
+  config.run_all_when_everything_filtered = true
+  config.raise_errors_for_deprecations!
+end
+
+require 'support/config'
+
+%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

@@ -0,0 +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

@@ -0,0 +1,30 @@
+# 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, filepath
+    end
+
+    it_behaves_like 'a compressible trie' do
+      let(:trie) { Rambling::Trie.load filepath }
+    end
+  end
+
+  context 'and the trie is compressed' do
+    let(:trie) { Rambling::Trie.load filepath }
+
+    before do
+      Rambling::Trie.dump trie_to_serialize.compress!, filepath
+    end
+
+    it_behaves_like 'a trie data structure'
+
+    it 'is marked as compressed' do
+      expect(trie).to be_compressed
+    end
+  end
+end

data/spec/support/shared_examples/a_serializer.rb

@@ -0,0 +1,37 @@
+# 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
+
+  describe '#dump' do
+    before do
+      serializer.dump content, filepath
+    end
+
+    it 'creates the file with the provided path' do
+      expect(File.exist? filepath).to be true
+    end
+
+    it 'converts the contents to the appropriate format' do
+      expect(File.read(filepath).size).to be_within(10).of formatted_content.size
+    end
+  end
+
+  describe '#load' do
+    before do
+      serializer.dump content, filepath
+    end
+
+    it 'loads the dumped object back into memory' do
+      expect(serializer.load filepath).to eq content
+    end
+  end
+end

data/spec/support/shared_examples/a_trie_data_structure.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+shared_examples_for 'a trie data structure' do
+  it 'contains all the words previously provided' do
+    words.each do |word|
+      expect(trie).to include word
+      expect(trie.word? word).to be true
+    end
+  end
+
+  it 'matches the start of all the words from the file' do
+    words.each do |word|
+      expect(trie.match? word).to be true
+      expect(trie.match? word[0..-2]).to be true
+      expect(trie.partial_word? word).to be true
+      expect(trie.partial_word? word[0..-2]).to be true
+    end
+  end
+
+  it 'identifies words within larger strings' do
+    words.each do |word|
+      phrase = "x#{word}y"
+      expect(trie.words_within phrase).to include word
+      expect(trie.words_within? phrase).to be true
+    end
+  end
+
+  it 'allows iterating over all the words' do
+    expect(trie.to_a.sort).to eq words.sort
+  end
+end

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