rambling-trie 0.9.3 → 1.0.0

data/spec/lib/rambling/trie_spec.rb

@@ -2,7 +2,9 @@ require 'spec_helper'
 
 describe Rambling::Trie do
   describe '.create' do
-    let(:container) { double :container }
+    let(:root) { Rambling::Trie::RawNode.new }
+    let(:compressor) { Rambling::Trie::Compressor.new }
+    let!(:container) { Rambling::Trie::Container.new root, compressor }
 
     before do
       allow(Rambling::Trie::Container).to receive(:new)
@@ -16,9 +18,9 @@ describe Rambling::Trie do
 
     context 'with a block' do
       it 'yields the new container' do
-        yielded_trie = nil
-        Rambling::Trie.create { |trie| yielded_trie = trie }
-        expect(yielded_trie).to eq container
+        yielded = nil
+        Rambling::Trie.create { |trie| yielded = trie }
+        expect(yielded).to eq container
       end
     end
 
@@ -48,15 +50,126 @@ describe Rambling::Trie do
       let(:reader) { double :reader, each_word: nil }
 
       before do
-        allow(Rambling::Trie::PlainTextReader).to receive(:new)
-          .and_return reader
+        Rambling::Trie.config do |c|
+          c.readers.add :default, reader
+          c.readers.default = reader
+        end
       end
 
-      it 'defaults to the PlainTextReader' do
+      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::RawNode.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
+      trie = 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
+        trie = Rambling::Trie.load 'test.marshal'
+        expect(marshal_serializer).to have_received(:load).with 'test.marshal'
+
+        trie = Rambling::Trie.load 'test.yml'
+        expect(yaml_serializer).to have_received(:load).with 'test.yml'
+
+        trie = Rambling::Trie.load 'test.yaml'
+        expect(yaml_serializer).to have_received(:load).with 'test.yaml'
+
+        trie = 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

@@ -4,7 +4,7 @@ require 'coveralls'
 
 Coveralls.wear!
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new [
+SimpleCov.formatters = [
   SimpleCov::Formatter::HTMLFormatter,
   CodeClimate::TestReporter::Formatter,
   Coveralls::SimpleCov::Formatter
@@ -26,3 +26,9 @@ RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
   config.raise_errors_for_deprecations!
 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'

data/spec/support/config.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |c|
+  c.before do
+    Rambling::Trie.config.reset
+  end
+end

data/spec/support/shared_examples/a_compressable_trie.rb

@@ -0,0 +1,26 @@
+shared_examples_for 'a compressable 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
+
+      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
+    before { trie.compress! }
+
+    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_serializable_trie.rb

@@ -0,0 +1,26 @@
+shared_examples_for 'a serializable trie' do
+  context 'and the trie is not compressed' do
+    before do
+      Rambling::Trie.dump trie_to_serialize, trie_filepath, serializer
+    end
+
+    it_behaves_like 'a compressable trie' do
+      let(:trie) { loaded_trie }
+    end
+  end
+
+  context 'and the trie is compressed' do
+    let(:trie) { loaded_trie }
+
+    before do
+      FileUtils.rm_f trie_filepath
+      Rambling::Trie.dump trie_to_serialize.compress!, trie_filepath, serializer
+    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,29 @@
+shared_examples_for 'a serializer' do
+  before do
+    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 eq 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,29 @@
+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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rambling-trie
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Edgar Gonzalez
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-07 00:00:00.000000000 Z
+date: 2017-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -53,9 +53,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.5
-description: The Rambling Trie is a custom implementation of the Trie data structure
-  with Ruby, which includes compression abilities and is designed to be very fast
-  to traverse.
+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,44 +69,58 @@ files:
 - Rakefile
 - 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/compression.rb
 - lib/rambling/trie/compressor.rb
+- lib/rambling/trie/configuration.rb
+- lib/rambling/trie/configuration/properties.rb
+- lib/rambling/trie/configuration/provider_collection.rb
 - lib/rambling/trie/container.rb
 - lib/rambling/trie/enumerable.rb
 - lib/rambling/trie/forwardable.rb
-- lib/rambling/trie/inspector.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/plain_text_reader.rb
 - lib/rambling/trie/raw_node.rb
-- lib/rambling/trie/tasks/gem.rb
-- lib/rambling/trie/tasks/helpers/path.rb
-- lib/rambling/trie/tasks/helpers/performance_report.rb
-- lib/rambling/trie/tasks/helpers/time.rb
-- lib/rambling/trie/tasks/performance.rb
-- lib/rambling/trie/tasks/performance/all.rb
-- lib/rambling/trie/tasks/performance/benchmark.rb
-- lib/rambling/trie/tasks/performance/directory.rb
-- lib/rambling/trie/tasks/performance/flamegraph.rb
-- lib/rambling/trie/tasks/performance/profile/call_tree.rb
-- lib/rambling/trie/tasks/performance/profile/memory.rb
+- lib/rambling/trie/readers.rb
+- lib/rambling/trie/readers/plain_text.rb
+- lib/rambling/trie/serializers.rb
+- lib/rambling/trie/serializers/file.rb
+- lib/rambling/trie/serializers/marshal.rb
+- lib/rambling/trie/serializers/yaml.rb
+- lib/rambling/trie/serializers/zip.rb
+- lib/rambling/trie/stringifyable.rb
 - lib/rambling/trie/version.rb
 - rambling-trie.gemspec
 - spec/assets/test_words.en_US.txt
 - 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/inspector_spec.rb
+- spec/lib/rambling/trie/inspectable_spec.rb
 - spec/lib/rambling/trie/node_spec.rb
-- spec/lib/rambling/trie/plain_text_reader_spec.rb
 - spec/lib/rambling/trie/raw_node_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
+- spec/lib/rambling/trie/serializers/yaml_spec.rb
+- spec/lib/rambling/trie/serializers/zip_spec.rb
+- spec/lib/rambling/trie/stringifyable_spec.rb
 - spec/lib/rambling/trie_spec.rb
 - spec/spec_helper.rb
+- spec/support/config.rb
+- spec/support/shared_examples/a_compressable_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/tmp/.gitkeep
 homepage: http://github.com/gonzedge/rambling-trie
 licenses:
 - MIT
@@ -131,18 +144,32 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: A custom implementation of the trie data structure.
+summary: A Ruby implementation of the trie data structure.
 test_files:
 - spec/assets/test_words.en_US.txt
 - 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/inspector_spec.rb
+- spec/lib/rambling/trie/inspectable_spec.rb
 - spec/lib/rambling/trie/node_spec.rb
-- spec/lib/rambling/trie/plain_text_reader_spec.rb
 - spec/lib/rambling/trie/raw_node_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
+- spec/lib/rambling/trie/serializers/yaml_spec.rb
+- spec/lib/rambling/trie/serializers/zip_spec.rb
+- spec/lib/rambling/trie/stringifyable_spec.rb
 - spec/lib/rambling/trie_spec.rb
 - spec/spec_helper.rb
+- spec/support/config.rb
+- spec/support/shared_examples/a_compressable_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/tmp/.gitkeep

data/lib/rambling/trie/compression.rb

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