rambling-trie 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee20334126cebef1f6c2701fe7d612fde28854e3
-  data.tar.gz: 832b58d0d0580d2318350adeafdd1b894b5f7ee4
+  metadata.gz: 63d9f2dee886a2a54a5e1df6316eff8abd21dc81
+  data.tar.gz: 5c25c7cfb39c458b6335d3e160cc543ecae2f951
 SHA512:
-  metadata.gz: f2d654657d6cdaf376c84c28855c08ca4d9d21e752badf94e88a36f796dfeff0179abc748bd79cc6d7749b7840f9d0eeb20f7f62957237ec7c4861b016db61a2
-  data.tar.gz: f46b5c920c9871e637706ce3a1a2578aca2e938c824979c5925ebf8f8994e7f5bbc85e1ac4b062da318db310c4642a9650d22fbbf8e516cc35967e9f1e3a7e89
+  metadata.gz: 798145e320bddef33321bf18fa2a7713c29e8cc82a004a83b257b71923a97df9a6610e73c08625e9c927f90a7833a2c9e7a800bb1b6c03aa61b7808dd893fc3e
+  data.tar.gz: 834c2e2fcc39611cda4d4de5847944bffac2bf5f6852d2c3ea12e3aca570f80ed9883666d7a35161cb1848712e2e7ecef21b05689c9d3e678a2afcea2f4f4592

data/Gemfile

@@ -11,11 +11,12 @@ group :development do
   gem 'benchmark-ips'
   gem 'flamegraph'
   gem 'stackprof'
+  gem 'pry'
 end
 
 group :test do
   gem 'simplecov', require: false
-  gem 'coveralls', require: false
+  gem 'coveralls', '~>0.8.21', require: false
 end
 
 group :local do

data/README.md

@@ -1,6 +1,6 @@
 # Rambling Trie
 
-[![Gem Version][badge_fury_badge]][badge_fury_link] [![Dependency Status][gemnasium_badge]][gemnasium_link] [![Build Status][travis_ci_badge]][travis_ci_link] [![Code Climate][code_climate_badge]][code_climage_link] [![Coverage Status][coveralls_badge]][coveralls_link] [![Documentation Status][inch_ci_badge]][inch_ci_link]
+[![Gem Version][badge_fury_badge]][badge_fury_link] [![Dependency Status][gemnasium_badge]][gemnasium_link] [![Build Status][travis_ci_badge]][travis_ci_link] [![Code Climate][code_climate_badge]][code_climage_link] [![Coverage Status][coveralls_badge]][coveralls_link] [![Documentation Status][inch_ci_badge]][inch_ci_link] [![License][license_badge]][license_link]
 
 The Rambling Trie is a Ruby implementation of the [trie data structure][trie_wiki], which includes compression abilities and is designed to be very fast to traverse.
 
@@ -10,7 +10,7 @@ The Rambling Trie is a Ruby implementation of the [trie data structure][trie_wik
 
 You will need:
 
-* Ruby 2.1.0 or up
+* Ruby 2.2.0 or up
 * RubyGems
 
 See [RVM][rvm], [rbenv][rbenv] or [chruby][chruby] for more information on how to manage Ruby versions.
@@ -75,6 +75,12 @@ trie.add 'word'
 trie << 'word'
 ```
 
+Or if you have multiple words to add, you can use `#concat`:
+
+``` ruby
+trie.concat %w(a collection of words)
+```
+
 And to find out if a word already exists in the trie, use `#word?` or its alias `#include?`:
 
 ``` ruby
@@ -121,13 +127,20 @@ trie.compress!
 This will reduce the size of the trie by using redundant node elimination (redundant nodes are the only-child non-terminal nodes).
 
 > _**Note**: The `#compress!` method acts over the trie instance it belongs to
-> and is destructive. Also, adding words after compression (with `#add` or
+> and replaces the root `Node`. Also, adding words after compression (with `#add` or
 > `#<<`) is not supported._
 
-You can find out if a trie instance is compressed by calling the `#compressed?` method:
+If you want, you can also create a new compressed trie and leave the existing one intact. Just use `#compress` instead:
+
+``` ruby
+compressed_trie = trie.compress
+```
+
+You can find out if a trie instance is compressed by calling the `#compressed?` method. From the `#compress` example:
 
 ``` ruby
-trie.compressed?
+trie.compressed? # => false
+compressed_trie.compressed? # => true
 ```
 
 ### Enumeration
@@ -229,6 +242,7 @@ You can find further API documentation on the autogenerated [rambling-trie gem R
 
 The Rambling Trie has been tested with the following Ruby versions:
 
+* 2.5.x
 * 2.4.x
 * 2.3.x
 * 2.2.x
@@ -268,7 +282,9 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 [github_user_gonzedge]: https://github.com/gonzedge
 [inch_ci_badge]: https://inch-ci.org/github/gonzedge/rambling-trie.svg?branch=master
 [inch_ci_link]: https://inch-ci.org/github/gonzedge/rambling-trie
-[marshal]: https://ruby-doc.org/core-2.4.0/Marshal.html
+[license_badge]: https://badges.frapsoft.com/os/mit/mit.svg?v=103
+[license_link]: https://opensource.org/licenses/mit-license.php
+[marshal]: https://ruby-doc.org/core-2.5.0/Marshal.html
 [rambling_trie_configuration]: https://github.com/gonzedge/rambling-trie#configuration
 [rambling_trie_contributing_guide]: https://github.com/gonzedge/rambling-trie/blob/master/CONTRIBUTING.md
 [rambling_trie_plain_text_reader]: https://github.com/gonzedge/rambling-trie/blob/master/lib/rambling/trie/readers/plain_text.rb
@@ -280,4 +296,4 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 [travis_ci_badge]: https://travis-ci.org/gonzedge/rambling-trie.svg
 [travis_ci_link]: https://travis-ci.org/gonzedge/rambling-trie
 [trie_wiki]: https://en.wikipedia.org/wiki/Trie
-[yaml]: https://ruby-doc.org/stdlib-2.4.0/libdoc/yaml/rdoc/YAML.html
+[yaml]: https://ruby-doc.org/stdlib-2.5.0/libdoc/yaml/rdoc/YAML.html

data/Rakefile

@@ -1,6 +1,10 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+
+require 'rambling-trie'
 require_relative 'tasks/performance'
+require_relative 'tasks/serialization'
+require_relative 'tasks/ips'
 
 RSpec::Core::RakeTask.new :spec
 

data/lib/rambling/trie.rb

@@ -1,9 +1,7 @@
-require 'forwardable'
-
 %w{
-  comparable compressable compressor configuration container enumerable
-  inspectable invalid_operation readers serializers stringifyable node
-  missing_node compressed_node raw_node version
+  comparable compressible compressor configuration container enumerable
+  inspectable invalid_operation readers serializers stringifyable nodes
+  version
 }.each do |file|
   require File.join('rambling', 'trie', file)
 end
@@ -13,21 +11,12 @@ module Rambling
   # Entry point for rambling-trie API.
   module Trie
     class << self
-      extend ::Forwardable
-
-      delegate [
-        :readers,
-        :serializers,
-        :compressor,
-        :root_builder
-      ] => :properties
-
       # Creates a new Rambling::Trie. Entry point for the Rambling::Trie API.
       # @param [String, nil] filepath the file to load the words from.
-      # @param [Reader, nil] reader the file parser to get each word. See
-      #   {Rambling::Trie::Readers Readers}.
+      # @param [Reader, nil] reader the file parser to get each word.
       # @return [Container] the trie just created.
       # @yield [Container] the trie just created.
+      # @see Rambling::Trie::Readers Readers.
       def create filepath = nil, reader = nil
         Rambling::Trie::Container.new root_builder.call, compressor do |container|
           if filepath
@@ -44,9 +33,10 @@ module Rambling
       # Loads an existing trie from disk into memory.
       # @param [String] filepath the file to load the words from.
       # @param [Serializer, nil] serializer the object responsible of loading the trie
-      #   from disk. See {Rambling::Trie::Serializers Serializers}.
+      #   from disk
       # @return [Container] the trie just loaded.
       # @yield [Container] the trie just loaded.
+      # @see Rambling::Trie::Serializers Serializers.
       def load filepath, serializer = nil
         serializer ||= serializers.resolve filepath
         root = serializer.load filepath
@@ -59,16 +49,16 @@ module Rambling
       # @param [Container] trie the trie to dump into disk.
       # @param [String] filepath the file to dump to serialized trie into.
       # @param [Serializer, nil] serializer the object responsible of
-      #   serializing and dumping the trie into disk. See
-      #   {Rambling::Trie::Serializers Serializers}.
+      #   serializing and dumping the trie into disk.
+      # @see Rambling::Trie::Serializers Serializers.
       def dump trie, filepath, serializer = nil
         serializer ||= serializers.resolve filepath
         serializer.dump trie.root, filepath
       end
 
       # Provides configuration properties for the Rambling::Trie gem.
-      # @return [Properties] the configured properties of the gem.
-      # @yield [Properties] the configured properties of the gem.
+      # @return [Configuration::Properties] the configured properties of the gem.
+      # @yield [Configuration::Properties] the configured properties of the gem.
       def config
         yield properties if block_given?
         properties
@@ -79,6 +69,22 @@ module Rambling
       def properties
         @properties ||= Rambling::Trie::Configuration::Properties.new
       end
+
+      def readers
+        properties.readers
+      end
+
+      def serializers
+        properties.serializers
+      end
+
+      def compressor
+        properties.compressor
+      end
+
+      def root_builder
+        properties.root_builder
+      end
     end
   end
 end

data/lib/rambling/trie/comparable.rb

@@ -3,9 +3,9 @@ module Rambling
     # Provides the comparable behavior for the trie data structure.
     module Comparable
       # Compares two nodes.
-      # @param [Node] other the node to compare against.
-      # @return [Boolean] `true` if the nodes' {Node#letter #letter} and
-      #   {Node#children_tree #children_tree} are equal, `false` otherwise.
+      # @param [Nodes::Node] other the node to compare against.
+      # @return [Boolean] `true` if the nodes' {Nodes::Node#letter #letter} and
+      #   {Nodes::Node#children_tree #children_tree} are equal, `false` otherwise.
       def == other
         letter == other.letter &&
           terminal? == other.terminal? &&

data/lib/rambling/trie/compressible.rb

@@ -0,0 +1,14 @@
+module Rambling
+  module Trie
+    # Provides the compressible behavior for the trie data structure.
+    module Compressible
+      # Indicates if the current {Rambling::Trie::Nodes::Node Node} can be compressed
+      # or not.
+      # @return [Boolean] `true` for non-{Nodes::Node#terminal? terminal} nodes with
+      #   one child, `false` otherwise.
+      def compressible?
+        !(root? || terminal?) && children_tree.size == 1
+      end
+    end
+  end
+end

data/lib/rambling/trie/compressor.rb

@@ -2,47 +2,60 @@ module Rambling
   module Trie
     # Responsible for the compression process of a trie data structure.
     class Compressor
-      # Compresses a {Node Node} from a trie data structure.
-      # @param [RawNode] node the node to compress.
-      # @return [CompressedNode] node the compressed version of the node.
+      # Compresses a {Nodes::Node Node} from a trie data structure.
+      # @param [Nodes::Raw] node the node to compress.
+      # @return [Nodes::Compressed] node the compressed version of the node.
       def compress node
-        if node.compressable?
-          merge_with_child_and_compress node
+        if node.compressible?
+          compress_child_and_merge node
         else
-          copy_node_and_compress_children node
+          compress_children_and_copy node
         end
       end
 
       private
 
-      def merge_with_child_and_compress node
-        child = node.children.first
+      def compress_child_and_merge node
+        merge node, compress(node.first_child)
+      end
 
-        letter = node.letter.to_s << child.letter.to_s
-        new_node = new_compressed_node node, letter, child.terminal?
-        new_node.children_tree = child.children_tree
+      def merge node, other
+        letter = node.letter.to_s << other.letter.to_s
 
-        compress new_node
+        new_compressed_node(
+          letter.to_sym,
+          node.parent,
+          other.children_tree,
+          other.terminal?
+        )
       end
 
-      def copy_node_and_compress_children node
-        new_node = new_compressed_node node, node.letter, node.terminal?
+      def compress_children_and_copy node
+        new_compressed_node(
+          node.letter,
+          node.parent,
+          compress_children(node.children_tree),
+          node.terminal?
+        )
+      end
 
-        node.children.each do |child|
-          compressed_child = compress child
+      def compress_children children_tree
+        new_children_tree = {}
 
-          compressed_child.parent = new_node
-          new_node[compressed_child.letter] = compressed_child
+        children_tree.each_value do |child|
+          compressed_child = compress child
+          new_children_tree[compressed_child.letter] = compressed_child
         end
 
-        new_node
+        new_children_tree
       end
 
-      def new_compressed_node node, letter, terminal
-        new_node = Rambling::Trie::CompressedNode.new node.parent
-        new_node.letter = letter
-        new_node.terminal! if terminal
-        new_node
+      def new_compressed_node letter, parent, children_tree, terminal
+        node = Rambling::Trie::Nodes::Compressed.new letter, parent, children_tree
+        node.terminal! if terminal
+
+        children_tree.each_value { |child| child.parent = node }
+        node
       end
     end
   end

data/lib/rambling/trie/configuration/properties.rb

@@ -17,11 +17,13 @@ module Rambling
         # @return [Compressor] the configured compressor.
         attr_accessor :compressor
 
-        # The configured root_builder, which should return a {Node Node} when
-        # called.
-        # @return [Proc<Node>] the configured root_builder.
+        # The configured root_builder, which should return a {Nodes::Node Node} when
+        #   called.
+        # @return [Proc<Nodes::Node>] the configured root_builder.
         attr_accessor :root_builder
 
+        # The configured tmp_path, which will be used for throwaway files.
+        # @return [String] the configured tmp_path.
         attr_accessor :tmp_path
 
         # Returns a new properties instance.
@@ -35,7 +37,7 @@ module Rambling
           reset_serializers
 
           self.compressor = Rambling::Trie::Compressor.new
-          self.root_builder = lambda { Rambling::Trie::RawNode.new }
+          self.root_builder = lambda { Rambling::Trie::Nodes::Raw.new }
           self.tmp_path = '/tmp'
         end
 
@@ -46,7 +48,7 @@ module Rambling
         def reset_readers
           plain_text_reader = Rambling::Trie::Readers::PlainText.new
 
-          self.readers = Rambling::Trie::Configuration::ProviderCollection.new 'reader', txt: plain_text_reader
+          self.readers = Rambling::Trie::Configuration::ProviderCollection.new :reader, txt: plain_text_reader
         end
 
         def reset_serializers
@@ -54,7 +56,7 @@ module Rambling
           yaml_serializer = Rambling::Trie::Serializers::Yaml.new
           zip_serializer = Rambling::Trie::Serializers::Zip.new self
 
-          self.serializers = Rambling::Trie::Configuration::ProviderCollection.new 'serializer',
+          self.serializers = Rambling::Trie::Configuration::ProviderCollection.new :serializer,
             marshal: marshal_serializer,
             yml: yaml_serializer,
             yaml: yaml_serializer,

data/lib/rambling/trie/configuration/provider_collection.rb

@@ -3,8 +3,6 @@ module Rambling
     module Configuration
       # Collection of configurable providers.
       class ProviderCollection
-        extend ::Forwardable
-
         # The name of this provider collection.
         # @return [String] the name of this provider collection.
         attr_reader :name
@@ -23,13 +21,6 @@ module Rambling
         #   cannot be resolved in {ProviderCollection#resolve #resolve}.
         attr_reader :default
 
-        delegate [
-          :[],
-          :[]=,
-          :keys,
-          :values,
-        ] => :providers
-
         # Creates a new provider collection.
         # @param [String] name the name for this provider collection.
         # @param [Hash] providers the configured providers.
@@ -52,7 +43,7 @@ module Rambling
         end
 
         def default= provider
-          if provider_not_in_list? provider
+          unless contains? provider
             raise ArgumentError, "default #{name} should be part of configured #{name}s"
           end
 
@@ -71,30 +62,57 @@ module Rambling
         # @return [Object] the provider corresponding to the file extension in
         #   this provider collection. {#default} if not found.
         def resolve filepath
-          providers[format filepath] || default
+          providers[file_format filepath] || default
         end
 
         # Resets the provider collection to the initial values.
         def reset
           providers.clear
-          configured_providers.each { |k, v| providers[k] = v }
+          configured_providers.each { |k, v| self[k] = v }
           self.default = configured_default
         end
 
+        # Get provider corresponding to a given format.
+        # @return [Array<Symbol>] the provider corresponding to that format.
+        # @see https://ruby-doc.org/core-2.5.0/Hash.html#method-i-5B-5D
+        #   Hash#keys
+        def formats
+          providers.keys
+        end
+
+        # Get provider corresponding to a given format.
+        # @param [Symbol] format the format to search for in the collection.
+        # @return [Object] the provider corresponding to that format.
+        # @see https://ruby-doc.org/core-2.5.0/Hash.html#method-i-5B-5D
+        #   Hash#[]
+        def [] format
+          providers[format]
+        end
+
         private
 
         attr_reader :configured_providers, :configured_default
 
-        def format filepath
+        def []= format, instance
+          providers[format] = instance
+        end
+
+        def values
+          providers.values
+        end
+
+        def file_format filepath
           format = File.extname filepath
           format.slice! 0
           format.to_sym
         end
 
-        def provider_not_in_list? provider
-          (provider && providers.values.empty?) ||
-            (providers.values.any? && !providers.values.include?(provider))
+        def contains? provider
+          provider.nil? ||
+            (providers.any? && provider_instances.include?(provider))
         end
+
+        alias_method :provider_instances, :values
       end
     end
   end