rambling-trie 1.0.3 → 2.0.0

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rambling
   module Trie
     module Nodes

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rambling
   module Trie
     module Nodes
@@ -20,7 +22,8 @@ module Rambling
         attr_reader :letter
 
         # Child nodes tree.
-        # @return [Hash] the children_tree hash, consisting of `:letter => node`.
+        # @return [Hash] the children_tree hash, consisting of `:letter =>
+        #   node`.
         attr_accessor :children_tree
 
         # Parent node.
@@ -77,6 +80,26 @@ module Rambling
           @letter = letter.to_sym if letter
         end
 
+        # Checks if a path for a set 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
+          return true if chars.empty?
+
+          partial_word_chars? 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 = []
+          return terminal? if chars.empty?
+
+          word_chars? chars
+        end
+
         # Returns the node that starts with the specified characters.
         # @param [Array<String>] chars the characters to look for in the trie.
         # @return [Node] the node that matches the specified characters.
@@ -89,13 +112,14 @@ module Rambling
 
         # Returns all words that match a prefix of any length within chars.
         # @param [String] chars the chars to base the prefix on.
-        # @return [Enumerator<String>] all the words that match a prefix given by
-        #   chars.
+        # @return [Enumerator<String>] all the words that match a prefix given
+        #   by chars.
         # @yield [String] each word found.
         def match_prefix chars
           return enum_for :match_prefix, chars unless block_given?
 
           yield as_word if terminal?
+
           children_match_prefix chars do |word|
             yield word
           end
@@ -126,9 +150,9 @@ module Rambling
         # @param [Symbol] letter the letter to search for in the node.
         # @return [Boolean] `true` if the letter is present, `false` otherwise
         # @see https://ruby-doc.org/core-2.5.0/Hash.html#method-i-has_key-3F
-        #   Hash#has_key?
-        def has_key? letter
-          children_tree.has_key? letter
+        #   Hash#key?
+        def key? letter
+          children_tree.key? letter
         end
 
         # Delete a given letter and its corresponding {Node Node} from
@@ -142,6 +166,14 @@ module Rambling
           children_tree.delete letter
         end
 
+        alias_method :has_key?, :key?
+
+        protected
+
+        def missing
+          Rambling::Trie::Nodes::Missing.new
+        end
+
         private
 
         attr_accessor :terminal

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rambling
   module Trie
     module Nodes
@@ -15,30 +17,6 @@ module Rambling
           end
         end
 
-        # Checks if a path for a set 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 = []
-          return true if chars.empty?
-
-          letter = chars.slice!(0).to_sym
-          child = children_tree[letter]
-          !!child && child.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 = []
-          return terminal? if chars.empty?
-
-          letter = chars.slice!(0).to_sym
-          child = children_tree[letter]
-          !!child && child.word?(chars)
-        end
-
         # Always return `false` for a raw (uncompressed) node.
         # @return [Boolean] always `false` for a raw (uncompressed) node.
         def compressed?
@@ -60,11 +38,26 @@ module Rambling
           node
         end
 
-        def closest_node chars
+        def partial_word_chars? chars = []
+          letter = chars.slice!(0).to_sym
+          child = children_tree[letter]
+          return false unless child
+
+          child.partial_word? chars
+        end
+
+        def word_chars? chars = []
           letter = chars.slice!(0).to_sym
           child = children_tree[letter]
+          return false unless child
 
-          return Rambling::Trie::Nodes::Missing.new unless child
+          child.word? chars
+        end
+
+        def closest_node chars
+          letter = chars.slice!(0).to_sym
+          child = children_tree[letter]
+          return missing unless child
 
           child.scan chars
         end

data/lib/rambling/trie/readers.rb

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

data/lib/rambling/trie/readers/plain_text.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rambling
   module Trie
     module Readers

data/lib/rambling/trie/serializers.rb

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

data/lib/rambling/trie/serializers/file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rambling
   module Trie
     module Serializers

data/lib/rambling/trie/serializers/marshal.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rambling
   module Trie
     module Serializers
@@ -15,16 +17,24 @@ module Rambling
         # @param [String] filepath the full path of the file to load the
         #   marshaled object from.
         # @return [Nodes::Node] The deserialized {Nodes::Node Node}.
+        # @see https://ruby-doc.org/core-2.5.0/Marshal.html#method-c-load
+        #   Marshal.load
+        # @note Use of
+        #   {https://ruby-doc.org/core-2.5.0/Marshal.html#method-c-load
+        #   Marshal.load} is generally discouraged. Only use this with trusted
+        #   input.
         def load filepath
           ::Marshal.load serializer.load filepath
         end
 
-        # Serializes a {Nodes::Node Node} and dumps it as a marshaled object into
-        # filepath.
+        # Serializes a {Nodes::Node Node} and dumps it as a marshaled object
+        # into filepath.
         # @param [Nodes::Node] node the node to serialize
         # @param [String] filepath the full path of the file to dump the
         #   marshaled object into.
         # @return [Numeric] number of bytes written to disk.
+        # @see https://ruby-doc.org/core-2.5.0/Marshal.html#method-c-dump
+        #   Marshal.dump
         def dump node, filepath
           serializer.dump ::Marshal.dump(node), filepath
         end

data/lib/rambling/trie/serializers/yaml.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rambling
   module Trie
     module Serializers
@@ -15,16 +17,30 @@ module Rambling
         # @param [String] filepath the full path of the file to load the
         #   serialized YAML object from.
         # @return [Nodes::Node] The deserialized {Nodes::Node Node}.
+        # @see https://ruby-doc.org/stdlib-2.5.0/libdoc/psych/rdoc/Psych.html#method-c-safe_load
+        #   Psych.safe_load
         def load filepath
           require 'yaml'
-          ::YAML.load serializer.load filepath
+          ::YAML.safe_load(
+            serializer.load(filepath),
+            [
+              Symbol,
+              Rambling::Trie::Nodes::Raw,
+              Rambling::Trie::Nodes::Compressed,
+            ],
+            [],
+            true,
+          )
         end
 
-        # Serializes a {Nodes::Node Node} and dumps it as a YAML object into filepath.
+        # Serializes a {Nodes::Node Node} and dumps it as a YAML object into
+        # filepath.
         # @param [Nodes::Node] node the node to serialize
         # @param [String] filepath the full path of the file to dump the YAML
         #   object into.
         # @return [Numeric] number of bytes written to disk.
+        # @see https://ruby-doc.org/stdlib-2.5.0/libdoc/psych/rdoc/Psych.html#method-c-dump
+        #   Psych.dump
         def dump node, filepath
           require 'yaml'
           serializer.dump ::YAML.dump(node), filepath

data/lib/rambling/trie/serializers/zip.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rambling
   module Trie
     module Serializers
@@ -15,6 +17,8 @@ module Rambling
         # unzipped files.
         # @param [String] filepath the filepath to load contents from.
         # @return [String] all contents of the unzipped loaded file.
+        # @see https://github.com/rubyzip/rubyzip#reading-a-zip-file Zip
+        #   reading a file
         def load filepath
           require 'zip'
 
@@ -32,6 +36,8 @@ module Rambling
         # @param [String] contents the contents to dump.
         # @param [String] filepath the filepath to dump the contents to.
         # @return [Numeric] number of bytes written to disk.
+        # @see https://github.com/rubyzip/rubyzip#basic-zip-archive-creation
+        #   Zip archive creation
         def dump contents, filepath
           require 'zip'
 

data/lib/rambling/trie/stringifyable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rambling
   module Trie
     # Provides the String representation behavior for the trie data structure.
@@ -6,7 +8,11 @@ module Rambling
       # @return [String] the string representation of the current node.
       # @raise [InvalidOperation] if node is not terminal or is root.
       def as_word
-        raise Rambling::Trie::InvalidOperation, 'Cannot represent branch as a word' if letter && !terminal?
+        if letter && !terminal?
+          raise Rambling::Trie::InvalidOperation,
+            'Cannot represent branch as a word'
+        end
+
         to_s
       end
 

data/lib/rambling/trie/version.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Rambling
   module Trie
     # Current version of the rambling-trie.
-    VERSION = '1.0.3'.freeze
+    VERSION = '2.0.0'
   end
 end

data/rambling-trie.gemspec

@@ -1,26 +1,37 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
 require 'rambling/trie/version'
 
 Gem::Specification.new do |gem|
   gem.authors = ['Edgar Gonzalez', 'Lilibeth De La Cruz']
   gem.email = ['edggonzalezg@gmail.com', 'lilibethdlc@gmail.com']
-  gem.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.'
+
+  gem.description = <<~DESCRIPTION.gsub(%r{\s+}, ' ')
+    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.
+  DESCRIPTION
+
   gem.summary = 'A Ruby implementation of the trie data structure.'
   gem.homepage = 'http://github.com/gonzedge/rambling-trie'
   gem.date = Time.now.strftime '%Y-%m-%d'
 
-  gem.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename f }
-  gem.files = `git ls-files -- {lib,*file,*.gemspec,LICENSE*,README*}`.split "\n"
-  gem.test_files = `git ls-files -- {test,spec,features}/*`.split "\n"
-  gem.require_paths = ['lib']
+  executables = `git ls-files -- bin/*`.split "\n"
+  files = `git ls-files -- {lib,*file,*.gemspec,LICENSE*,README*}`.split "\n"
+  test_files = `git ls-files -- {test,spec,features}/*`.split "\n"
+
+  gem.executables = executables.map { |f| File.basename f }
+  gem.files = files
+  gem.test_files = test_files
+  gem.require_paths = %w(lib)
 
   gem.name = 'rambling-trie'
   gem.license = 'MIT'
   gem.version = Rambling::Trie::VERSION
   gem.platform = Gem::Platform::RUBY
+  gem.required_ruby_version = '~> 2.3'
 
-  gem.add_development_dependency 'rspec', '~> 3.5'
-  gem.add_development_dependency 'rake', '~> 12.0'
-  gem.add_development_dependency 'yard', '~> 0.9.5'
+  gem.add_development_dependency 'rake', '~> 12.3'
+  gem.add_development_dependency 'rspec', '~> 3.7'
+  gem.add_development_dependency 'yard', '~> 0.9.12'
 end

data/spec/integration/rambling/trie_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 require 'zip'
 
@@ -6,8 +8,8 @@ describe Rambling::Trie do
 
   context 'when providing words directly' do
     it_behaves_like 'a compressible trie' do
-      let(:words) { %w(a couple of words for our full trie integration test) }
       let(:trie) { Rambling::Trie.create }
+      let(:words) { %w(a couple of words for our full trie integration test) }
 
       before do
         trie.concat words
@@ -17,8 +19,10 @@ describe Rambling::Trie do
 
   context 'when provided with words with unicode characters' do
     it_behaves_like 'a compressible trie' do
-      let(:words) { %w(poquísimas palabras para nuestra prueba de integración completa 🙃) }
       let(:trie) { Rambling::Trie.create }
+      let(:words) do
+        %w(poquísimas palabras para nuestra prueba de integración completa 🙃)
+      end
 
       before do
         trie.concat words
@@ -27,8 +31,8 @@ describe Rambling::Trie do
   end
 
   context 'when provided with a filepath' do
-    let(:words) { File.readlines(filepath).map &:chomp! }
     let(:trie) { Rambling::Trie.create filepath }
+    let(:words) { File.readlines(filepath).map(&:chomp) }
 
     context 'with english words' do
       it_behaves_like 'a compressible trie' do
@@ -45,7 +49,7 @@ describe Rambling::Trie do
 
   describe 'dump and load' do
     let(:words_filepath) { File.join assets_path, 'test_words.en_US.txt' }
-    let(:words) { File.readlines(words_filepath).map &:chomp }
+    let(:words) { File.readlines(words_filepath).map(&:chomp) }
 
     context 'when serialized with Ruby marshal format (default)' do
       it_behaves_like 'a serializable trie' do

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Rambling::Trie::Comparable do

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Rambling::Trie::Compressor do
@@ -10,7 +12,7 @@ describe Rambling::Trie::Compressor do
       add_words node, %w(a few words hello hell)
       compressed = compressor.compress node
 
-      expect(compressed.children_tree.keys).to eq %i(a few words hell)
+      expect(compressed.children_tree.keys).to eq %i(a f w h)
     end
 
     context 'with at least one word' do
@@ -33,10 +35,10 @@ describe Rambling::Trie::Compressor do
       it 'compresses into a single node without children' do
         compressed = compressor.compress node
 
-        expect(compressed[:all].letter).to eq :all
-        expect(compressed[:all].children.size).to eq 0
-        expect(compressed[:all]).to be_terminal
-        expect(compressed[:all]).to be_compressed
+        expect(compressed[:a].letter).to eq :all
+        expect(compressed[:a].children.size).to eq 0
+        expect(compressed[:a]).to be_terminal
+        expect(compressed[:a]).to be_compressed
       end
     end
 
@@ -51,17 +53,17 @@ describe Rambling::Trie::Compressor do
         expect(compressed[:a].letter).to eq :a
         expect(compressed[:a].children.size).to eq 2
 
-        expect(compressed[:a][:ll].letter).to eq :ll
-        expect(compressed[:a][:sk].letter).to eq :sk
+        expect(compressed[:a][:l].letter).to eq :ll
+        expect(compressed[:a][:s].letter).to eq :sk
 
-        expect(compressed[:a][:ll].children.size).to eq 0
-        expect(compressed[:a][:sk].children.size).to eq 0
+        expect(compressed[:a][:l].children.size).to eq 0
+        expect(compressed[:a][:s].children.size).to eq 0
 
-        expect(compressed[:a][:ll]).to be_terminal
-        expect(compressed[:a][:sk]).to be_terminal
+        expect(compressed[:a][:l]).to be_terminal
+        expect(compressed[:a][:s]).to be_terminal
 
-        expect(compressed[:a][:ll]).to be_compressed
-        expect(compressed[:a][:sk]).to be_compressed
+        expect(compressed[:a][:l]).to be_compressed
+        expect(compressed[:a][:s]).to be_compressed
       end
     end
 
@@ -69,38 +71,38 @@ describe Rambling::Trie::Compressor do
       add_words node, %w(repay rest repaint)
       compressed = compressor.compress node
 
-      expect(compressed[:re].letter).to eq :re
-      expect(compressed[:re].parent).to eq compressed
-      expect(compressed[:re].children.size).to eq 2
+      expect(compressed[:r].letter).to eq :re
+      expect(compressed[:r].parent).to eq compressed
+      expect(compressed[:r].children.size).to eq 2
 
-      expect(compressed[:re][:pa].letter).to eq :pa
-      expect(compressed[:re][:pa].parent).to eq compressed[:re]
-      expect(compressed[:re][:pa].children.size).to eq 2
+      expect(compressed[:r][:p].letter).to eq :pa
+      expect(compressed[:r][:p].parent).to eq compressed[:r]
+      expect(compressed[:r][:p].children.size).to eq 2
 
-      expect(compressed[:re][:st].letter).to eq :st
-      expect(compressed[:re][:st].parent).to eq compressed[:re]
-      expect(compressed[:re][:st].children.size).to eq 0
+      expect(compressed[:r][:s].letter).to eq :st
+      expect(compressed[:r][:s].parent).to eq compressed[:r]
+      expect(compressed[:r][:s].children.size).to eq 0
 
-      expect(compressed[:re][:pa][:y].letter).to eq :y
-      expect(compressed[:re][:pa][:y].parent).to eq compressed[:re][:pa]
-      expect(compressed[:re][:pa][:y].children.size).to eq 0
+      expect(compressed[:r][:p][:y].letter).to eq :y
+      expect(compressed[:r][:p][:y].parent).to eq compressed[:r][:p]
+      expect(compressed[:r][:p][:y].children.size).to eq 0
 
-      expect(compressed[:re][:pa][:int].letter).to eq :int
-      expect(compressed[:re][:pa][:int].parent).to eq compressed[:re][:pa]
-      expect(compressed[:re][:pa][:int].children.size).to eq 0
+      expect(compressed[:r][:p][:i].letter).to eq :int
+      expect(compressed[:r][:p][:i].parent).to eq compressed[:r][:p]
+      expect(compressed[:r][:p][:i].children.size).to eq 0
     end
 
     it 'does not compress terminal nodes' do
       add_words node, %w(you your yours)
       compressed = compressor.compress node
 
-      expect(compressed[:you].letter).to eq :you
+      expect(compressed[:y].letter).to eq :you
 
-      expect(compressed[:you][:r].letter).to eq :r
-      expect(compressed[:you][:r]).to be_compressed
+      expect(compressed[:y][:r].letter).to eq :r
+      expect(compressed[:y][:r]).to be_compressed
 
-      expect(compressed[:you][:r][:s].letter).to eq :s
-      expect(compressed[:you][:r][:s]).to be_compressed
+      expect(compressed[:y][:r][:s].letter).to eq :s
+      expect(compressed[:y][:r][:s]).to be_compressed
     end
   end
 end