rambling-trie 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7acf86172aa12a848c9590aa0ec0aee132b70f30bf15b720d95e7bc675a8d13
-  data.tar.gz: 8c08f7abfee53e44d9599160397a21b3e8a9e597125ce52feedbc98f4ad65e62
+  metadata.gz: 25c794ace94646da9b2892ea80c8df575cb3c95fc870790df2b50edde7fbb91e
+  data.tar.gz: e2be8d009e65109b52a1f36f524701b2d9452855aeceb8870e02fe7db52b150f
 SHA512:
-  metadata.gz: c697d039484c41aa733eae791f16b4f82e3b7c6048b006ba64281794834ec54cf5b00f555b3bac196df5589d8dbf779f06fa887a659bb9ee61f822bee7fbdee5
-  data.tar.gz: fcd664c6802aaf8565820a43f52db146b97e010be2c3a2c64c477a4f6643da02fdbe8238678780d9630f9e6877a8772200af7e4c6e0fb0f16bb9028b382d6099
+  metadata.gz: cc61981cb9a93450b0f6159adb497f30de7fa7a7ddf98c69a3baa64ed9cd8757aa035d3f818b080822714b2b5505ed5cefbff7217ce952856630bacab2dc3afd
+  data.tar.gz: 1afc2883a31ee9bbf63172c20d806ed952d40bc65527f582308fbe61b8c83dddc3aa3b3ab1b300ded46bf7dbd2f6e73340d22019de4ca82e0587a81bb789725c

data/Gemfile

@@ -17,10 +17,16 @@ end
 
 group :test do
   gem 'coveralls_reborn', '~> 0.27.0', require: false
+  gem 'rspec_junit_formatter'
   gem 'simplecov', require: false
 end
 
 group :local do
+  gem 'flog', require: false
   gem 'guard-rspec'
+  gem 'mdl', require: false
   gem 'rubocop', require: false
+  gem 'rubocop-performance', require: false
+  gem 'rubocop-rake', require: false
+  gem 'rubocop-rspec', require: false
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012-2017 Edgar Gonzalez
+Copyright (c) 2012-2024 Edgar González
 
 MIT License
 

data/README.md

@@ -1,8 +1,19 @@
 # Rambling Trie
 
-[![Gem Version][badge_fury_badge]][badge_fury_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]
+[![Gem Version][badge_fury_badge]][badge_fury_link]
+[![Downloads][downloads_badge]][downloads_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.
+[![Build Status][github_action_build_badge]][github_action_build_link]
+[![Coverage Status][coveralls_badge]][coveralls_link]
+[![Documentation Status][inch_ci_badge]][rubydoc]
+[![CodeQL Status][github_action_codeql_badge]][github_action_codeql_link]
+
+[![Code Climate Grade][code_climate_grade_badge]][code_climate_link]
+[![Code Climate Issue Count][code_climate_issues_badge]][code_climate_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.
 
 ## Installing the Rambling Trie
 
@@ -47,7 +58,8 @@ Rambling::Trie.create do |trie|
 end
 ```
 
-Additionally, you can provide the path to a file that contains all the words to be added to the trie, and it will read the file and create the complete structure for you, like this:
+Additionally, you can provide the path to a file that contains all the words to be added to the trie, and it will read
+the file and create the complete structure for you, like this:
 
 ``` ruby
 trie = Rambling::Trie.create '/path/to/file'
@@ -64,7 +76,10 @@ the
 trie
 ```
 
-If you want to use a custom file format, you will need to provide a custom file reader that defines an `#each_word` method that yields each word contained in the file. Look at the [`PlainText` reader][rambling_trie_plain_text_reader] class for an example, and at the [Configuration section][rambling_trie_configuration] to see how to add your own custom file readers.
+If you want to use a custom file format, you will need to provide a custom `Reader` that defines an `#each_word` method
+that yields each word contained in the file. Look at the [`PlainText` reader][rambling_trie_plain_text_reader] class for
+an example, and at the [Configuration section][rambling_trie_configuration] to see how to add your own custom file
+readers.
 
 ### Operations
 
@@ -88,7 +103,8 @@ trie.word? 'word'
 trie.include? 'word'
 ```
 
-If you wish to find if part of a word exists in the trie instance, you should call `#partial_word?` or its alias `#match?`:
+If you wish to find if part of a word exists in the trie instance, you should call `#partial_word?` or its
+alias `#match?`:
 
 ``` ruby
 trie.partial_word? 'partial_word'
@@ -109,7 +125,8 @@ trie.words_within 'ifdxawesome45someword3' # => ['if', 'aw', 'awe', ...]
 trie.words_within 'tktktktk' # => []
 ```
 
-Or, if you're just interested in knowing whether a given string contains any valid words or not, you can use `#words_within?`:
+Or, if you're just interested in knowing whether a given string contains any valid words or not, you can
+use `#words_within?`:
 
 ``` ruby
 trie.words_within? 'ifdxawesome45someword3' # => true
@@ -118,13 +135,15 @@ trie.words_within? 'tktktktk' # => false
 
 ### Compression
 
-By default, the Rambling Trie works as a standard trie. Starting from version 0.1.0, you can obtain a compressed trie from the standard one, by using the compression feature. Just call the `#compress!` method on the trie instance:
+By default, the Rambling Trie works as a standard trie. Starting from version 0.1.0, you can obtain a compressed trie
+from the standard one, by using the compression feature. Just call the `#compress!` method on the trie instance:
 
 ``` ruby
 trie.compress!
 ```
 
-This will reduce the size of the trie by using redundant node elimination (redundant nodes are the only-child non-terminal nodes).
+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 replaces the root `Node`. Also, adding words after compression (with `#add` or
@@ -145,7 +164,8 @@ compressed_trie.compressed? # => true
 
 ### Enumeration
 
-Starting from version 0.4.2, you can use any `Enumerable` method over a trie instance, and it will iterate over each word contained in the trie. You can now do things like:
+Starting from version 0.4.2, you can use any `Enumerable` method over a trie instance, and it will iterate over each
+word contained in the trie. You can now do things like:
 
 ``` ruby
 trie.each { |word| puts word }
@@ -156,7 +176,10 @@ trie.all? { |word| word.include? 'x' }
 
 ### Serialization
 
-Starting from version 1.0.0, you can store a full trie instance on disk and retrieve/use it later on. Loading a trie from disk takes less time, less cpu and less memory than loading every word into the trie every time. This is particularly useful for production applications, when you have word lists that you know are going to be static, or that change with little frequency.
+Starting from version 1.0.0, you can store a full trie instance on disk and retrieve/use it later on. Loading a trie
+from disk takes less time, less cpu and less memory than loading every word into the trie every time. This is
+particularly useful for production applications, when you have word lists that you know are going to be static, or that
+change with little frequency.
 
 To store a trie on disk, you can use `.dump` like this:
 
@@ -164,24 +187,26 @@ To store a trie on disk, you can use `.dump` like this:
 Rambling::Trie.dump trie, '/path/to/file'
 ```
 
-Then, when you need to use a trie next time, you don't have to create a new one with all the necessary words. Rather, you can retrieve a previously stored one with `.load` like this:
+Then, when you need to use a trie next time, you don't have to create a new one with all the necessary words. Rather,
+you can retrieve a previously stored one with `.load` like this:
 
 ``` ruby
-trie = Rambling::Trie.load trie, '/path/to/file'
+trie = Rambling::Trie.load '/path/to/file'
 ```
 
 #### Supported formats
 
 Currently, these formats are supported to store tries on disk:
 
-- Ruby's [binary (Marshal)][marshal] format
-- [YAML][yaml]
+* Ruby's [binary (Marshal)][marshal] format
+* [YAML][yaml]
 
 > When dumping into or loading from disk, the format is determined
 > automatically based on the file extension, so `.yml` or `.yaml` files will be
 > handled through `YAML` and `.marshal` files through `Marshal`.
 
-Optionally, you can use a `.zip` version of the supported formats. In order to do so, you'll have to install the [`rubyzip`][rubyzip] gem:
+Optionally, you can use a `.zip` version of the supported formats. In order to do so, you'll have to install
+the [`rubyzip`][rubyzip] gem:
 
 ``` bash
 gem install rubyzip
@@ -197,7 +222,7 @@ Then, you can load contents form a `.zip` file like this:
 
 ``` ruby
 require 'zip'
-trie = Rambling::Trie.load trie, '/path/to/file.zip'
+trie = Rambling::Trie.load '/path/to/file.zip'
 ```
 
 > For `.zip` files, the format is also determined automatically based on the
@@ -236,12 +261,14 @@ end
 
 ### Further Documentation
 
-You can find further API documentation on the autogenerated [rambling-trie gem RubyDoc.info page][rubydoc] or if you want edge documentation, you can go the [GitHub project RubyDoc.info page][rubydoc_github].
+You can find further API documentation on the autogenerated [rambling-trie gem RubyDoc.info page][rubydoc] or if you
+want edge documentation, you can go the [GitHub project RubyDoc.info page][rubydoc_github].
 
 ## Compatible Ruby and Rails versions
 
 The Rambling Trie has been tested with the following Ruby versions:
 
+* 3.3.x
 * 3.2.x
 * 3.1.x
 * 3.0.x
@@ -261,33 +288,47 @@ The Rambling Trie has been tested with the following Ruby versions:
 
 ## Contributing to Rambling Trie
 
-Take a look at the [contributing guide][rambling_trie_contributing_guide] to get started, or fire a question to [@gonzedge][github_user_gonzedge].
+Take a look at the [contributing guide][rambling_trie_contributing_guide] to get started, or fire a question
+to [@gonzedge][github_user_gonzedge].
 
 ## License and copyright
 
-Copyright (c) 2012-2017 Edgar Gonzalez
+Copyright (c) 2012-2024 Edgar González
 
 MIT License
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-[badge_fury_badge]: https://badge.fury.io/rb/rambling-trie.svg
+[badge_fury_badge]: https://badge.fury.io/rb/rambling-trie.svg?version=2.4.0
 [badge_fury_link]: https://badge.fury.io/rb/rambling-trie
 [chruby]: https://github.com/postmodern/chruby
-[code_climage_link]: https://codeclimate.com/github/gonzedge/rambling-trie
-[code_climate_badge]: https://codeclimate.com/github/gonzedge/rambling-trie/badges/gpa.svg
+[code_climate_grade_badge]: https://codeclimate.com/github/gonzedge/rambling-trie/badges/gpa.svg
+[code_climate_issues_badge]: https://codeclimate.com/github/gonzedge/rambling-trie/badges/issue_count.svg
+[code_climate_link]: https://codeclimate.com/github/gonzedge/rambling-trie
 [coveralls_badge]: https://img.shields.io/coveralls/gonzedge/rambling-trie.svg
 [coveralls_link]: https://coveralls.io/r/gonzedge/rambling-trie
+[downloads_badge]: https://img.shields.io/gem/dt/rambling-trie.svg
+[downloads_link]: https://rubygems.org/gems/rambling-trie
 [gemnasium_badge]: https://gemnasium.com/gonzedge/rambling-trie.svg
 [gemnasium_link]: https://gemnasium.com/gonzedge/rambling-trie
+[github_action_build_badge]: https://github.com/gonzedge/rambling-trie/actions/workflows/ruby.yml/badge.svg
+[github_action_build_link]: https://github.com/gonzedge/rambling-trie/actions/workflows/ruby.yml
+[github_action_codeql_badge]: https://github.com/gonzedge/rambling-trie/actions/workflows/codeql.yml/badge.svg
+[github_action_codeql_link]: https://github.com/gonzedge/rambling-trie/actions/workflows/codeql.yml
 [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
-[license_badge]: https://badges.frapsoft.com/os/mit/mit.svg?v=103
+[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
 [license_link]: https://opensource.org/licenses/mit-license.php
 [marshal]: https://ruby-doc.org/core-2.7.0/Marshal.html
 [rambling_trie_configuration]: https://github.com/gonzedge/rambling-trie#configuration
@@ -298,7 +339,5 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
 [rubydoc_github]: http://rubydoc.info/github/gonzedge/rambling-trie
 [rubyzip]: https://github.com/rubyzip/rubyzip
 [rvm]: https://rvm.io
-[travis_ci_badge]: https://travis-ci.com/gonzedge/rambling-trie.svg?branch=master
-[travis_ci_link]: https://travis-ci.com/github/gonzedge/rambling-trie
 [trie_wiki]: https://en.wikipedia.org/wiki/Trie
 [yaml]: https://ruby-doc.org/stdlib-2.7.0/libdoc/yaml/rdoc/YAML.html

data/lib/rambling/trie/comparable.rb

@@ -6,9 +6,8 @@ module Rambling
     module Comparable
       # 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.
+      # @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

@@ -4,12 +4,10 @@ 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
+        !(root? || terminal?) && 1 == children_tree.size
       end
     end
   end

data/lib/rambling/trie/compressor.rb

@@ -24,21 +24,11 @@ module Rambling
       def merge node, other
         letter = node.letter.to_s << other.letter.to_s
 
-        new_compressed_node(
-          letter.to_sym,
-          node.parent,
-          other.children_tree,
-          other.terminal?,
-        )
+        new_compressed_node letter.to_sym, node.parent, other.children_tree, other.terminal?
       end
 
       def compress_children_and_copy node
-        new_compressed_node(
-          node.letter,
-          node.parent,
-          compress_children(node.children_tree),
-          node.terminal?,
-        )
+        new_compressed_node node.letter, node.parent, compress_children(node.children_tree), node.terminal?
       end
 
       def compress_children tree

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

@@ -6,26 +6,23 @@ module Rambling
       # Provides configurable properties for Rambling::Trie.
       class Properties
         # The configured {Readers Readers}.
-        # @return [ProviderCollection] the mapping of configured {Readers
-        #   Readers}.
+        # @return [ProviderCollection<Readers::Reader>] the mapping of configured {Readers Readers}.
         attr_reader :readers
 
         # The configured {Serializers Serializers}.
-        # @return [ProviderCollection] the mapping of configured {Serializers
-        #   Serializers}.
+        # @return [ProviderCollection<Serializers::Serializer>] the mapping of configured {Serializers Serializers}.
         attr_reader :serializers
 
         # The configured {Compressor Compressor}.
         # @return [Compressor] the configured compressor.
         attr_accessor :compressor
 
-        # The configured root_builder, which should return a {Nodes::Node Node}
-        #   when called.
-        # @return [Proc<Nodes::Node>] the configured root_builder.
+        # The configured +root_builder+, which returns 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.
+        # 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.
@@ -34,6 +31,7 @@ module Rambling
         end
 
         # Resets back to default properties.
+        # @return [void]
         def reset
           reset_readers
           reset_serializers
@@ -49,11 +47,7 @@ module Rambling
 
         def reset_readers
           plain_text_reader = Rambling::Trie::Readers::PlainText.new
-
-          @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

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

@@ -6,7 +6,7 @@ module Rambling
       # Collection of configurable providers.
       class ProviderCollection
         # The name of this provider collection.
-        # @return [String] the name of this provider collection.
+        # @return [Symbol] the name of this provider collection.
         attr_reader :name
 
         # @overload default
@@ -15,18 +15,17 @@ module Rambling
         # @overload default=(provider)
         #   Sets the default provider. Needs to be one of the configured
         #   providers.
-        #   @param [Object] provider the provider to use as default.
-        #   @raise [ArgumentError] when the given provider is not in the
-        #     provider collection.
-        #   @note If no providers have been configured, `nil` will be assigned.
-        # @return [Object, nil] the default provider to use when a provider
-        #   cannot be resolved in {ProviderCollection#resolve #resolve}.
+        #   @param [TProvider] provider the provider to use as default.
+        #   @raise [ArgumentError] when the given provider is not in the provider collection.
+        #   @note If no providers have been configured, +nil+ will be assigned.
+        # @return [TProvider, nil] the default provider to use when a provider cannot be resolved in
+        #   {ProviderCollection#resolve #resolve}.
         attr_reader :default
 
         # Creates a new provider collection.
-        # @param [String] name the name for this provider collection.
-        # @param [Hash] providers the configured providers.
-        # @param [Object] default the configured default provider.
+        # @param [Symbol] name the name for this provider collection.
+        # @param [Hash<Symbol, TProvider>] providers the configured providers.
+        # @param [TProvider, nil] default the configured default provider.
         def initialize name, providers = {}, default = nil
           @name = name
           @configured_providers = providers
@@ -36,39 +35,34 @@ module Rambling
         end
 
         # Adds a new provider to the provider collection.
-        # @param [Symbol] extension the extension that the provider will
-        #   correspond to.
-        # @param [provider] provider the provider to add to the provider
-        #   collection.
+        # @param [Symbol] extension the extension that the provider will correspond to.
+        # @param [TProvider] provider the provider to add to the provider collection.
+        # @return [TProvider] the provider just added.
         def add extension, provider
           providers[extension] = provider
         end
 
         def default= provider
-          unless contains? provider
-            raise ArgumentError,
-              "default #{name} should be part of configured #{name}s"
-          end
+          raise ArgumentError, "default #{name} should be part of configured #{name}s" unless contains? provider
 
           @default = provider
         end
 
         # List of configured providers.
-        # @return [Hash] the mapping of extensions to their corresponding
-        #   providers.
+        # @return [Hash<Symbol, TProvider>] the mapping of extensions to their corresponding providers.
         def providers
           @providers ||= {}
         end
 
         # Resolves the provider from a filepath based on the file extension.
         # @param [String] filepath the filepath to resolve into a provider.
-        # @return [Object] the provider corresponding to the file extension in
-        #   this provider collection. {#default} if not found.
+        # @return [TProvider, nil] the provider for the given file's extension. {#default} if not found.
         def resolve filepath
           providers[file_format filepath] || default
         end
 
         # Resets the provider collection to the initial values.
+        # @return [void]
         def reset
           providers.clear
           configured_providers.each { |k, v| self[k] = v }
@@ -85,9 +79,8 @@ module Rambling
 
         # 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.7.0/Hash.html#method-i-5B-5D
-        #   Hash#[]
+        # @return [TProvider] the provider corresponding to that format.
+        # @see https://ruby-doc.org/core-2.7.0/Hash.html#method-i-5B-5D Hash#[]
         def [] format
           providers[format]
         end
@@ -111,8 +104,7 @@ module Rambling
         end
 
         def contains? provider
-          provider.nil? ||
-            (providers.any? && provider_instances.include?(provider))
+          provider.nil? || (providers.any? && provider_instances.include?(provider))
         end
 
         alias_method :provider_instances, :values

data/lib/rambling/trie/container.rb

@@ -13,7 +13,7 @@ module Rambling
       # Creates a new trie.
       # @param [Nodes::Node] root the root node for the trie
       # @param [Compressor] compressor responsible for compressing the trie
-      # @yield [Container] the trie just created.
+      # @yield [self] the trie just initialized.
       def initialize root, compressor
         @root = root
         @compressor = compressor
@@ -41,72 +41,61 @@ module Rambling
         words.map { |word| add word }
       end
 
-      # Compresses the existing trie using redundant node elimination. Marks
-      # the trie as compressed. Does nothing if the trie has already been
-      # compressed.
-      # @return [Container] self
-      # @note This method replaces the root {Nodes::Raw Raw} node with a
-      #   {Nodes::Compressed Compressed} version of it.
+      # Compresses the existing trie using redundant node elimination.
+      # Marks the trie as compressed.
+      # Does nothing if the trie has already been compressed.
+      # @return [self]
+      # @note This method replaces the root {Nodes::Raw Raw} node with a {Nodes::Compressed Compressed} version of it.
       def compress!
         self.root = compress_root unless root.compressed?
         self
       end
 
-      # Compresses the existing trie using redundant node elimination. Returns
-      # a new trie with the compressed root.
-      # @return [Container] A new {Container} with the {Nodes::Compressed
-      #   Compressed} root node or self if the trie has already been
-      #   compressed.
+      # Compresses the existing trie using redundant node elimination. Returns a new trie with the compressed root.
+      # @return [Container] A new {Container} with the {Nodes::Compressed Compressed} root node
+      #   or self if the trie has already been compressed.
       def compress
         return self if root.compressed?
+
         Rambling::Trie::Container.new compress_root, compressor
       end
 
       # Checks if a path for a word or partial word exists in the trie.
       # @param [String] word the word or partial word to look for in the trie.
-      # @return [Boolean] `true` if the word or partial word is found, `false`
-      #   otherwise.
-      # @see Nodes::Raw#partial_word?
-      # @see Nodes::Compressed#partial_word?
+      # @return [Boolean] +true+ if the word or partial word is found, +false+ otherwise.
+      # @see Nodes::Node#partial_word?
       def partial_word? word = ''
         root.partial_word? word.chars
       end
 
       # Checks if a whole word exists in the trie.
       # @param [String] word the word to look for in the trie.
-      # @return [Boolean] `true` only if the word is found and the last
-      #   character corresponds to a terminal node, `false` otherwise.
-      # @see Nodes::Raw#word?
-      # @see Nodes::Compressed#word?
+      # @return [Boolean] +true+ only if the word is found and the last character corresponds to a terminal node,
+      #   +false+ otherwise.
+      # @see Nodes::Node#word?
       def word? word = ''
         root.word? word.chars
       end
 
       # Returns all words that start with the specified characters.
       # @param [String] word the word to look for in the trie.
-      # @return [Array<String>] all the words contained in the trie that start
-      #   with the specified characters.
-      # @see Nodes::Raw#scan
-      # @see Nodes::Compressed#scan
+      # @return [Array<String>] all the words contained in the trie that start with the specified characters.
+      # @see Nodes::Node#scan
       def scan word = ''
         root.scan(word.chars).to_a
       end
 
-      # Returns all words within a string that match a word contained in the
-      # trie.
+      # Returns all words within a string that match a word contained in the trie.
       # @param [String] phrase the string to look for matching words in.
-      # @return [Enumerator<String>] all the words in the given string that
-      #   match a word in the trie.
+      # @return [Enumerator<String>] all the words in the given string that match a word in the trie.
       # @yield [String] each word found in phrase.
-      # @see Nodes::Node#words_within
       def words_within phrase
         words_within_root(phrase).to_a
       end
 
       # Checks if there are any valid words in a given string.
       # @param [String] phrase the string to look for matching words in.
-      # @return [Boolean] `true` if any word within phrase is contained in the
-      #   trie, `false` otherwise.
+      # @return [Boolean] +true+ if any word within phrase is contained in the trie, +false+ otherwise.
       # @see Container#words_within
       def words_within? phrase
         words_within_root(phrase).any?
@@ -114,13 +103,14 @@ module Rambling
 
       # Compares two trie data structures.
       # @param [Container] other the trie to compare against.
-      # @return [Boolean] `true` if the tries are equal, `false` otherwise.
+      # @return [Boolean] +true+ if the tries are equal, +false+ otherwise.
       def == other
         root == other.root
       end
 
       # Iterates over the words contained in the trie.
       # @yield [String] the words contained in this trie node.
+      # @return [self]
       def each
         return enum_for :each unless block_given?
 
@@ -143,33 +133,29 @@ module Rambling
       end
 
       # Root node's child nodes.
-      # @return [Array<Nodes::Node>] the array of children nodes contained in
-      #   the root node.
+      # @return [Array<Nodes::Node>] the array of children nodes contained in the root node.
       # @see Nodes::Node#children
       def children
         root.children
       end
 
       # Root node's children tree.
-      # @return [Array<Nodes::Node>] the array of children nodes contained in
-      #   the root node.
+      # @return [Hash<Symbol, Nodes::Node>] the children tree hash contained in the root node, consisting of
+      #   +:letter => node+.
       # @see Nodes::Node#children_tree
       def children_tree
         root.children_tree
       end
 
-      # Indicates if the root {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 root {Nodes::Node Node} can be compressed or not.
+      # @return [Boolean] +true+ for non-{Nodes::Node#terminal? terminal} nodes with one child, +false+ otherwise.
       def compressed?
         root.compressed?
       end
 
       # Array of words contained in the root {Nodes::Node Node}.
       # @return [Array<String>] all words contained in this trie.
-      # @see https://ruby-doc.org/core-2.7.0/Enumerable.html#method-i-to_a
-      #   Enumerable#to_a
+      # @see https://ruby-doc.org/core-2.7.0/Enumerable.html#method-i-to_a Enumerable#to_a
       def to_a
         root.to_a
       end

data/lib/rambling/trie/enumerable.rb

@@ -7,12 +7,12 @@ module Rambling
       include ::Enumerable
 
       # Returns number of words contained in the trie
-      # @see https://ruby-doc.org/core-2.7.0/Enumerable.html#method-i-count
-      #   Enumerable#count
+      # @see https://ruby-doc.org/core-2.7.0/Enumerable.html#method-i-count Enumerable#count
       alias_method :size, :count
 
       # Iterates over the words contained in the trie.
       # @yield [String] the words contained in this trie node.
+      # @return [self]
       def each
         return enum_for :each unless block_given?
 
@@ -23,6 +23,8 @@ module Rambling
             yield word
           end
         end
+
+        self
       end
     end
   end