rambling-trie 1.0.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 63d9f2dee886a2a54a5e1df6316eff8abd21dc81
-  data.tar.gz: 5c25c7cfb39c458b6335d3e160cc543ecae2f951
+SHA256:
+  metadata.gz: fd802cb55bb14531c22c64b10e3c278ef20bb828b0680e9e6bea6e275ac2be0c
+  data.tar.gz: 0b6b81b55ce916632604bd3b932b7b67f403cf26f4e655c00fc3fb1f9b362bdd
 SHA512:
-  metadata.gz: 798145e320bddef33321bf18fa2a7713c29e8cc82a004a83b257b71923a97df9a6610e73c08625e9c927f90a7833a2c9e7a800bb1b6c03aa61b7808dd893fc3e
-  data.tar.gz: 834c2e2fcc39611cda4d4de5847944bffac2bf5f6852d2c3ea12e3aca570f80ed9883666d7a35161cb1848712e2e7ecef21b05689c9d3e678a2afcea2f4f4592
+  metadata.gz: cf9c2b2d7d2af2801483b50bc0daec751c7a14b0694b46c769aa06e800c29069574446f434a941a416a90356bd6b10882c21ec94b6be55e807e45b1e0efefb49
+  data.tar.gz: 7072801a3d3d3debbac169dca5ac73f921d2416e664554be77d2dc1d94e4f82b5104752ed90715ed18d4879834ff1af56c1a23f940da3ef64bd63b1079c72753

data/Gemfile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec
@@ -6,19 +7,20 @@ gemspec
 gem 'rubyzip'
 
 group :development do
-  gem 'ruby-prof'
-  gem 'memory_profiler'
   gem 'benchmark-ips'
   gem 'flamegraph'
-  gem 'stackprof'
+  gem 'memory_profiler'
   gem 'pry'
+  gem 'ruby-prof'
+  gem 'stackprof'
 end
 
 group :test do
-  gem 'simplecov', require: false
   gem 'coveralls', '~>0.8.21', require: false
+  gem 'simplecov', require: false
 end
 
 group :local do
   gem 'guard-rspec'
+  gem 'rubocop', require: false
 end

data/Guardfile

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
 guard 'rspec', cmd: 'rspec', all_on_start: true, all_after_pass: false do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
+  watch('spec/spec_helper.rb')  { 'spec' }
 end

data/README.md

@@ -10,7 +10,7 @@ The Rambling Trie is a Ruby implementation of the [trie data structure][trie_wik
 
 You will need:
 
-* Ruby 2.2.0 or up
+* Ruby 2.3.0 or up
 * RubyGems
 
 See [RVM][rvm], [rbenv][rbenv] or [chruby][chruby] for more information on how to manage Ruby versions.
@@ -245,12 +245,12 @@ The Rambling Trie has been tested with the following Ruby versions:
 * 2.5.x
 * 2.4.x
 * 2.3.x
-* 2.2.x
 
 **No longer supported**:
 
-* 2.1.x (might still work, but is not officially supported)
-* 2.0.x (might still work, but is not officially supported)
+* 2.2.x
+* 2.1.x
+* 2.0.x
 * 1.9.x
 * 1.8.x
 

data/Rakefile

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 require 'rambling-trie'
 require_relative 'tasks/performance'
@@ -7,5 +10,6 @@ require_relative 'tasks/serialization'
 require_relative 'tasks/ips'
 
 RSpec::Core::RakeTask.new :spec
+RuboCop::RakeTask.new :rubocop
 
 task default: :spec

data/lib/rambling-trie.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'rambling/trie'

data/lib/rambling/trie.rb

@@ -1,8 +1,10 @@
-%w{
+# frozen_string_literal: true
+
+%w(
   comparable compressible compressor configuration container enumerable
   inspectable invalid_operation readers serializers stringifyable nodes
   version
-}.each do |file|
+).each do |file|
   require File.join('rambling', 'trie', file)
 end
 
@@ -18,7 +20,9 @@ module Rambling
       # @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|
+        root = root_builder.call
+
+        Rambling::Trie::Container.new root, compressor do |container|
           if filepath
             reader ||= readers.resolve filepath
             reader.each_word filepath do |word|
@@ -30,13 +34,20 @@ module Rambling
         end
       end
 
-      # Loads an existing trie from disk into memory.
+      # Loads an existing trie from disk into memory. By default, it will
+      # deduce the correct way to deserialize based on the file extension.
+      # Available formats are `yml`, `marshal`, and `zip` versions of all the
+      # previous formats. You can also define your own.
       # @param [String] filepath the file to load the words from.
-      # @param [Serializer, nil] serializer the object responsible of loading the trie
-      #   from disk
+      # @param [Serializer, nil] serializer the object responsible of loading
+      #   the trie from disk
       # @return [Container] the trie just loaded.
       # @yield [Container] the trie just loaded.
       # @see Rambling::Trie::Serializers Serializers.
+      # @note Use of
+      #   {https://ruby-doc.org/core-2.5.0/Marshal.html#method-c-load
+      #   Marshal.load} is generally discouraged. Only use the `.marshal`
+      #   format with trusted input.
       def load filepath, serializer = nil
         serializer ||= serializers.resolve filepath
         root = serializer.load filepath
@@ -45,7 +56,10 @@ module Rambling
         end
       end
 
-      # Dumps an existing trie from memory into disk.
+      # Dumps an existing trie from memory into disk. By default, it will
+      # deduce the correct way to serialize based on the file extension.
+      # Available formats are `yml`, `marshal`, and `zip` versions of all the
+      # previous formats. You can also define your own.
       # @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
@@ -57,8 +71,10 @@ module Rambling
       end
 
       # Provides configuration properties for the Rambling::Trie gem.
-      # @return [Configuration::Properties] the configured properties of the gem.
-      # @yield [Configuration::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

data/lib/rambling/trie/comparable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rambling
   module Trie
     # Provides the comparable behavior for the trie data structure.
@@ -5,7 +7,8 @@ module Rambling
       # Compares two nodes.
       # @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.
+      #   {Nodes::Node#children_tree #children_tree} are equal, `false`
+      #   otherwise.
       def == other
         letter == other.letter &&
           terminal? == other.terminal? &&

data/lib/rambling/trie/compressible.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 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.
+      # 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

data/lib/rambling/trie/compressor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rambling
   module Trie
     # Responsible for the compression process of a trie data structure.
@@ -26,7 +28,7 @@ module Rambling
           letter.to_sym,
           node.parent,
           other.children_tree,
-          other.terminal?
+          other.terminal?,
         )
       end
 
@@ -35,26 +37,26 @@ module Rambling
           node.letter,
           node.parent,
           compress_children(node.children_tree),
-          node.terminal?
+          node.terminal?,
         )
       end
 
-      def compress_children children_tree
-        new_children_tree = {}
+      def compress_children tree
+        new_tree = {}
 
-        children_tree.each_value do |child|
+        tree.each do |letter, child|
           compressed_child = compress child
-          new_children_tree[compressed_child.letter] = compressed_child
+          new_tree[letter] = compressed_child
         end
 
-        new_children_tree
+        new_tree
       end
 
-      def new_compressed_node letter, parent, children_tree, terminal
-        node = Rambling::Trie::Nodes::Compressed.new letter, parent, children_tree
+      def new_compressed_node letter, parent, tree, terminal
+        node = Rambling::Trie::Nodes::Compressed.new letter, parent, tree
         node.terminal! if terminal
 
-        children_tree.each_value { |child| child.parent = node }
+        tree.each_value { |child| child.parent = node }
         node
       end
     end

data/lib/rambling/trie/configuration.rb

@@ -1,4 +1,6 @@
-%w{properties provider_collection}.each do |file|
+# frozen_string_literal: true
+
+%w(properties provider_collection).each do |file|
   require File.join('rambling', 'trie', 'configuration', file)
 end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rambling
   module Trie
     module Configuration
@@ -17,8 +19,8 @@ module Rambling
         # @return [Compressor] the configured compressor.
         attr_accessor :compressor
 
-        # The configured root_builder, which should return a {Nodes::Node Node} when
-        #   called.
+        # 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
 
@@ -36,9 +38,9 @@ module Rambling
           reset_readers
           reset_serializers
 
-          self.compressor = Rambling::Trie::Compressor.new
-          self.root_builder = lambda { Rambling::Trie::Nodes::Raw.new }
-          self.tmp_path = '/tmp'
+          @compressor = Rambling::Trie::Compressor.new
+          @root_builder = -> { Rambling::Trie::Nodes::Raw.new }
+          @tmp_path = '/tmp'
         end
 
         private
@@ -48,7 +50,10 @@ 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
+          @readers = Rambling::Trie::Configuration::ProviderCollection.new(
+            :reader,
+            txt: plain_text_reader,
+          )
         end
 
         def reset_serializers
@@ -56,11 +61,13 @@ 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,
+          @serializers = Rambling::Trie::Configuration::ProviderCollection.new(
+            :serializer,
             marshal: marshal_serializer,
             yml: yaml_serializer,
             yaml: yaml_serializer,
-            zip: zip_serializer
+            zip: zip_serializer,
+          )
         end
       end
     end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rambling
   module Trie
     module Configuration
@@ -44,7 +46,8 @@ module Rambling
 
         def default= provider
           unless contains? provider
-            raise ArgumentError, "default #{name} should be part of configured #{name}s"
+            raise ArgumentError,
+              "default #{name} should be part of configured #{name}s"
           end
 
           @default = provider

data/lib/rambling/trie/container.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rambling
   module Trie
     # Wrapper on top of trie data structure.
@@ -175,9 +177,9 @@ module Rambling
       # Check if a letter is part of the root {Nodes::Node}'s children tree.
       # @param [Symbol] letter the letter to search for in the root node.
       # @return [Boolean] whether the letter is contained or not.
-      # @see Nodes::Node#has_key?
-      def has_key? letter
-        root.has_key? letter
+      # @see Nodes::Node#key?
+      def key? letter
+        root.key? letter
       end
 
       # Size of the Root {Nodes::Node Node}'s children tree.
@@ -186,47 +188,12 @@ module Rambling
         root.size
       end
 
-      # String representation of the current node, if it is a terminal node.
-      # @return [String] the string representation of the current node.
-      # @raise [InvalidOperation] if node is not terminal or is root.
-      # @deprecated This will always raise an {InvalidOperation} exception.
-      def as_word
-        warn '[DEPRECATION WARNING] `#as_word` is deprecated. Please use `#root#as_word` instead.'
-        root.as_word
-      end
-
-      # Root {Nodes::Node Node}'s letter.
-      # @return [Symbol] the root node's letter
-      # @see Nodes::Node#letter
-      # @deprecated This will always return `nil`.
-      def letter
-        warn '[DEPRECATION WARNING] `#letter` is deprecated. Please use `#root#letter` instead.'
-        root.letter
-      end
-
-      # Root {Nodes::Node Node}'s parent.
-      # @return [Symbol] the root node's parent
-      # @see Nodes::Node#parent
-      # @deprecated This will always return `nil`.
-      def parent
-        warn '[DEPRECATION WARNING] `#parent` is deprecated. Please use `#root#parent` instead.'
-        root.parent
-      end
-
-      # String representation of root {Nodes::Node Node}.
-      # @return [String] the root node's string representation.
-      # @see Stringifyable#to_s
-      # @deprecated This will always return an empty string (`''`).
-      def to_s
-        warn '[DEPRECATION WARNING] `#to_s` is deprecated. Please use `#root#to_s` instead.'
-        root.to_s
-      end
-
       alias_method :include?, :word?
       alias_method :match?, :partial_word?
       alias_method :words, :scan
       alias_method :<<, :add
-      alias_method :has_letter?, :has_key?
+      alias_method :has_key?, :key?
+      alias_method :has_letter?, :key?
 
       private
 

data/lib/rambling/trie/enumerable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rambling
   module Trie
     # Provides enumerable behavior to the trie data structure.

data/lib/rambling/trie/inspectable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rambling
   module Trie
     # Provides pretty printing behavior for the trie data structure.

data/lib/rambling/trie/invalid_operation.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Rambling
   module Trie
     # Raised when trying to execute an invalid operation on a trie data
     # structure.
-    class InvalidOperation < Exception
+    class InvalidOperation < RuntimeError
       # Creates a new {InvalidOperation InvalidOperation} exception.
       # @param [String, nil] message the exception message.
       def initialize message = nil

data/lib/rambling/trie/nodes.rb

@@ -1,4 +1,6 @@
-%w{node missing compressed raw}.each do |file|
+# frozen_string_literal: true
+
+%w(node missing compressed raw).each do |file|
   require File.join('rambling', 'trie', 'nodes', file)
 end
 

data/lib/rambling/trie/nodes/compressed.rb

@@ -1,30 +1,18 @@
+# frozen_string_literal: true
+
 module Rambling
   module Trie
     module Nodes
-    # A representation of a node in an compressed trie data structure.
+      # A representation of a node in an compressed trie data structure.
       class Compressed < Rambling::Trie::Nodes::Node
         # Always raises {Rambling::Trie::InvalidOperation InvalidOperation} when
         # trying to add a word to the current compressed trie node
-        # @param [String] word the word to add to the trie.
+        # @param [String] _ the word to add to the trie.
         # @raise [InvalidOperation] if the trie is already compressed.
         # @return [nil] this never returns as it always raises an exception.
-        def add word
-          raise Rambling::Trie::InvalidOperation, 'Cannot add word to compressed trie'
-        end
-
-        # Checks if a path for set a of characters exists in the trie.
-        # @param [Array<String>] chars the characters to look for in the trie.
-        # @return [Boolean] `true` if the characters are found, `false` otherwise.
-        def partial_word? chars
-          chars.empty? || has_partial_word?(chars)
-        end
-
-        # Checks if a path for set of characters represents a word in the trie.
-        # @param [Array<String>] chars the characters to look for in the trie.
-        # @return [Boolean] `true` if the characters are found and form a word,
-        #   `false` otherwise.
-        def word? chars
-          chars.empty? ? terminal? : has_word?(chars)
+        def add _
+          raise Rambling::Trie::InvalidOperation,
+            'Cannot add word to compressed trie'
         end
 
         # Always return `true` for a compressed node.
@@ -35,79 +23,74 @@ module Rambling
 
         private
 
-        def has_partial_word? chars
-          recursive_get(:partial_word?, chars) || false
+        def partial_word_chars? chars
+          child = children_tree[chars.first.to_sym]
+          return false unless child
+
+          child_letter = child.letter.to_s
+
+          if chars.size >= child_letter.size
+            letter = chars.slice!(0, child_letter.size).join
+            return child.partial_word? chars if child_letter == letter
+          end
+
+          letter = chars.join
+          child_letter = child_letter.slice 0, letter.size
+          child_letter == letter
         end
 
-        def has_word? chars
-          current_key = nil
+        def word_chars? chars
+          letter = chars.slice! 0
+          letter_sym = letter.to_sym
+
+          child = children_tree[letter_sym]
+          return false unless child
+
+          loop do
+            return child.word? chars if letter_sym == child.letter
 
-          while !chars.empty?
-            if current_key
-              current_key << chars.slice!(0)
-            else
-              current_key = chars.slice!(0)
-            end
+            break if chars.empty?
 
-            child = children_tree[current_key.to_sym]
-            return child.word? chars if child
+            letter << chars.slice!(0)
+            letter_sym = letter.to_sym
           end
 
           false
         end
 
         def closest_node chars
-          recursive_get(:scan, chars) || Rambling::Trie::Nodes::Missing.new
-        end
-
-        def children_match_prefix chars
-          return enum_for :children_match_prefix, chars unless block_given?
-
-          current_key = nil
+          child = children_tree[chars.first.to_sym]
+          return missing unless child
 
-          while !chars.empty?
-            if current_key
-              current_key << chars.slice!(0)
-            else
-              current_key = chars.slice!(0)
-            end
+          child_letter = child.letter.to_s
 
-            child = children_tree[current_key.to_sym]
+          if chars.size >= child_letter.size
+            letter = chars.slice!(0, child_letter.size).join
+            return child.scan chars if child_letter == letter
+          end
 
-            next unless child
+          letter = chars.join
+          child_letter = child_letter.slice 0, letter.size
 
-            child.match_prefix chars do |word|
-              yield word
-            end
-          end
+          child_letter == letter ? child : missing
         end
 
-        def recursive_get method, chars
-          current_length = 0
-          current_key = current_key chars.slice!(0)
+        def children_match_prefix chars
+          return enum_for :children_match_prefix, chars unless block_given?
 
-          begin
-            current_length += 1
+          return if chars.empty?
 
-            if current_key && (current_key.length == current_length || chars.empty?)
-              return children_tree[current_key.to_sym].send method, chars
-            end
-          end while current_key && current_key[current_length] == chars.slice!(0)
-        end
+          child = children_tree[chars.first.to_sym]
+          return unless child
 
-        def current_key letter
-          current_key = nil
+          child_letter = child.letter.to_s
+          letter = chars.slice!(0, child_letter.size).join
 
-          children_tree.each_key do |letters|
-            letters_string = letters.to_s
+          return unless child_letter == letter
 
-            if letters_string.start_with? letter
-              current_key = letters_string
-              break
-            end
+          child.match_prefix chars do |word|
+            yield word
           end
-
-          current_key
         end
       end
     end