rambling-trie 2.2.1 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84eecdcb6a45ad3f8104e85aadc5bfb777342a4ea2b332b5e236b651b1398375
-  data.tar.gz: b68bb7bd9a9da2fe61c921645ff0864ca0dcaa515920d99ccf9456bb5482e159
+  metadata.gz: 3af7f8936c101be83262b9535524bdcd3381bb76b857e7a44f331c932c67afb4
+  data.tar.gz: e1b9dfc8f88822404c82f95b3fac6a376d3433d15535e8fc0dd454b4669f9e52
 SHA512:
-  metadata.gz: d6d88b9d85d9e373a6da19a7db578c7ecd20826974ea1cb4b6a2a502fd7b7d653de46c385e7aa4f9d31918d9d2a792563322c7d8e30ea272e1df053e352b1775
-  data.tar.gz: 4f47a7e8e9f38e6580154c5efe5e723798c48a264e530cb86951ee53e0c555f57bb04414a9367584242f6116e1c198ebbd4065b25d52f12a5769c5adc33cc516
+  metadata.gz: 8bc211404f2a209892aa7de20f20ce5b61f481f117f4ac2f3c45cceaf7076e690229487c7f2dd4613d5725fdf38e4a616efe082b27d4055c359f5801457f704d
+  data.tar.gz: 21cb664d6abccbc565fa8c2441c54c18d3ab8a4ccf8ae2457f4671b6b2b579ccd4893a400b3756af82bc261afa8c804db352bf68b6aa0105ab91396b90e1f2be

data/Gemfile

@@ -16,11 +16,15 @@ group :development do
 end
 
 group :test do
-  gem 'coveralls', '~>0.8.21', require: false
+  gem 'coveralls_reborn', '~> 0.27.0', require: false
+  gem 'rspec_junit_formatter'
   gem 'simplecov', require: false
 end
 
 group :local do
   gem 'guard-rspec'
   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-2023 Edgar Gonzalez
 
 MIT License
 

data/README.md

@@ -1,6 +1,16 @@
 # 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]
+
+[![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.
 
@@ -10,7 +20,7 @@ The Rambling Trie is a Ruby implementation of the [trie data structure][trie_wik
 
 You will need:
 
-* Ruby 2.5.0 or up
+* Ruby 2.7.0 or up
 * RubyGems
 
 See [RVM][rvm], [rbenv][rbenv] or [chruby][chruby] for more information on how to manage Ruby versions.
@@ -167,7 +177,7 @@ 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:
 
 ``` ruby
-trie = Rambling::Trie.load trie, '/path/to/file'
+trie = Rambling::Trie.load '/path/to/file'
 ```
 
 #### Supported formats
@@ -197,7 +207,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
@@ -242,20 +252,22 @@ You can find further API documentation on the autogenerated [rambling-trie gem R
 
 The Rambling Trie has been tested with the following Ruby versions:
 
+* 3.2.x
+* 3.1.x
 * 3.0.x
 * 2.7.x
-* 2.6.x
-* 2.5.x
 
 **No longer supported**:
 
+* 2.6.x (EOL'ed)
+* 2.5.x (EOL'ed)
 * 2.4.x (EOL'ed)
 * 2.3.x (EOL'ed)
-* 2.2.x
-* 2.1.x
-* 2.0.x
-* 1.9.x
-* 1.8.x
+* 2.2.x (EOL'ed)
+* 2.1.x (EOL'ed)
+* 2.0.x (EOL'ed)
+* 1.9.x (EOL'ed)
+* 1.8.x (EOL'ed)
 
 ## Contributing to Rambling Trie
 
@@ -263,7 +275,7 @@ Take a look at the [contributing guide][rambling_trie_contributing_guide] to get
 
 ## License and copyright
 
-Copyright (c) 2012-2017 Edgar Gonzalez
+Copyright (c) 2012-2023 Edgar González
 
 MIT License
 
@@ -273,21 +285,27 @@ The above copyright notice and this permission notice shall be included in all c
 
 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.3.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.5.0/Marshal.html
+[marshal]: https://ruby-doc.org/core-2.7.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
@@ -296,7 +314,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.5.0/libdoc/yaml/rdoc/YAML.html
+[yaml]: https://ruby-doc.org/stdlib-2.7.0/libdoc/yaml/rdoc/YAML.html

data/lib/rambling/trie/comparable.rb

@@ -6,8 +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`
+      # @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 &&

data/lib/rambling/trie/compressible.rb

@@ -6,10 +6,10 @@ module Rambling
     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.
+      # @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/configuration/properties.rb

@@ -6,26 +6,26 @@ 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 +34,7 @@ module Rambling
         end
 
         # Resets back to default properties.
+        # @return [void]
         def reset
           reset_readers
           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,18 @@ 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.
+        #   @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 [Object, nil] the default provider to use when a provider
+        #   @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
@@ -38,8 +38,9 @@ module Rambling
         # 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
+        # @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
@@ -54,21 +55,22 @@ module Rambling
         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 }
@@ -77,7 +79,7 @@ module Rambling
 
         # 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
+        # @see https://ruby-doc.org/core-2.7.0/Hash.html#method-i-5B-5D
         #   Hash#keys
         def formats
           providers.keys
@@ -85,8 +87,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.5.0/Hash.html#method-i-5B-5D
+        # @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]

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
@@ -44,7 +44,7 @@ module Rambling
       # 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
+      # @return [self]
       # @note This method replaces the root {Nodes::Raw Raw} node with a
       #   {Nodes::Compressed Compressed} version of it.
       def compress!
@@ -59,25 +59,24 @@ module Rambling
       #   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`
+      # @return [Boolean] +true+ if the word or partial word is found, +false+
       #   otherwise.
-      # @see Nodes::Raw#partial_word?
-      # @see Nodes::Compressed#partial_word?
+      # @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
@@ -86,8 +85,7 @@ module Rambling
       # @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
+      # @see Nodes::Node#scan
       def scan word = ''
         root.scan(word.chars).to_a
       end
@@ -98,15 +96,14 @@ module Rambling
       # @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 +111,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?
 
@@ -151,8 +149,8 @@ module Rambling
       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
@@ -160,15 +158,15 @@ module Rambling
 
       # 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.
+      # @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.5.0/Enumerable.html#method-i-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

data/lib/rambling/trie/enumerable.rb

@@ -7,12 +7,13 @@ module Rambling
       include ::Enumerable
 
       # Returns number of words contained in the trie
-      # @see https://ruby-doc.org/core-2.5.0/Enumerable.html#method-i-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 +24,8 @@ module Rambling
             yield word
           end
         end
+
+        self
       end
     end
   end

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

@@ -9,14 +9,14 @@ module Rambling
         # trying to add a word to the current compressed trie node
         # @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.
+        # @return [void]
         def add _
           raise Rambling::Trie::InvalidOperation,
             'Cannot add word to compressed trie'
         end
 
-        # Always return `true` for a compressed node.
-        # @return [Boolean] always `true` for a compressed node.
+        # Always return +true+ for a compressed node.
+        # @return [Boolean] always +true+ for a compressed node.
         def compressed?
           true
         end

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

@@ -22,8 +22,8 @@ module Rambling
         attr_reader :letter
 
         # Child nodes tree.
-        # @return [Hash] the children_tree hash, consisting of `:letter =>
-        #   node`.
+        # @return [Hash<Symbol, Node>] the children tree hash, consisting of
+        #   +:letter => node+.
         attr_accessor :children_tree
 
         # Parent node.
@@ -31,7 +31,7 @@ module Rambling
         attr_accessor :parent
 
         # Creates a new node.
-        # @param [Symbol, nil] letter the Node's letter value
+        # @param [Symbol, nil] letter the Node's letter value.
         # @param [Node, nil] parent the parent of the current node.
         def initialize letter = nil, parent = nil, children_tree = {}
           @letter = letter
@@ -40,7 +40,7 @@ module Rambling
         end
 
         # Child nodes.
-        # @return [Array<Node>] the array of children nodes contained
+        # @return [Array<Node>] the array of child nodes contained
         #   in the current node.
         def children
           children_tree.values
@@ -51,20 +51,20 @@ module Rambling
         def first_child
           return if children_tree.empty?
 
-          children_tree.each_value do |child|
-            return child
-          end
+          # rubocop:disable Lint/UnreachableLoop
+          children_tree.each_value { |child| return child }
+          # rubocop:enable Lint/UnreachableLoop
         end
 
         # Indicates if the current node is the root node.
-        # @return [Boolean] `true` if the node does not have a parent, `false`
+        # @return [Boolean] +true+ if the node does not have a parent, +false+
         #   otherwise.
         def root?
           !parent
         end
 
         # Indicates if a {Node Node} is terminal or not.
-        # @return [Boolean] `true` for terminal nodes, `false` otherwise.
+        # @return [Boolean] +true+ for terminal nodes, +false+ otherwise.
         def terminal?
           !!terminal
         end
@@ -82,7 +82,7 @@ module Rambling
 
         # 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`
+        # @return [Boolean] +true+ if the characters are found, +false+
         #   otherwise.
         def partial_word? chars
           return true if chars.empty?
@@ -92,8 +92,8 @@ module Rambling
 
         # 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.
+        # @return [Boolean] +true+ if the characters are found and form a word,
+        #   +false+ otherwise.
         def word? chars = []
           return terminal? if chars.empty?
 
@@ -128,7 +128,7 @@ module Rambling
         # Get {Node Node} corresponding to a given letter.
         # @param [Symbol] letter the letter to search for in the node.
         # @return [Node] the node corresponding to that letter.
-        # @see https://ruby-doc.org/core-2.5.0/Hash.html#method-i-5B-5D
+        # @see https://ruby-doc.org/core-2.7.0/Hash.html#method-i-5B-5D
         #   Hash#[]
         def [] letter
           children_tree[letter]
@@ -139,7 +139,7 @@ module Rambling
         # @param [Node] node the {Node Node} to assign to that letter.
         # @return [Node] the node corresponding to the inserted or
         #   updated letter.
-        # @see https://ruby-doc.org/core-2.5.0/Hash.html#method-i-5B-5D
+        # @see https://ruby-doc.org/core-2.7.0/Hash.html#method-i-5B-5D
         #   Hash#[]
         def []= letter, node
           children_tree[letter] = node
@@ -148,19 +148,19 @@ module Rambling
         # Check if a {Node Node}'s children tree contains a given
         #   letter.
         # @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
+        # @return [Boolean] +true+ if the letter is present, +false+ otherwise.
+        # @see https://ruby-doc.org/core-2.7.0/Hash.html#method-i-has_key-3F
         #   Hash#key?
         def key? letter
           children_tree.key? letter
         end
 
         # Delete a given letter and its corresponding {Node Node} from
-        #   this {Node Node}'s children tree.
+        # this {Node Node}'s children tree.
         # @param [Symbol] letter the letter to delete from the node's children
         #   tree.
         # @return [Node] the node corresponding to the deleted letter.
-        # @see https://ruby-doc.org/core-2.5.0/Hash.html#method-i-delete
+        # @see https://ruby-doc.org/core-2.7.0/Hash.html#method-i-delete
         #   Hash#delete
         def delete letter
           children_tree.delete letter

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

@@ -17,8 +17,8 @@ module Rambling
           end
         end
 
-        # Always return `false` for a raw (uncompressed) node.
-        # @return [Boolean] always `false` for a raw (uncompressed) node.
+        # Always return +false+ for a raw (uncompressed) node.
+        # @return [Boolean] always +false+ for a raw (uncompressed) node.
         def compressed?
           false
         end

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

@@ -3,14 +3,19 @@
 module Rambling
   module Trie
     module Readers
-      # File reader for .txt files.
-      class PlainText
-        # Yields each word read from a .txt file.
+      # File reader for +.txt+ files.
+      class PlainText < Reader
+        # Yields each word read from a +.txt+ file.
         # @param [String] filepath the full path of the file to load the words
         #   from.
         # @yield [String] Each line read from the file.
+        # @return [self]
         def each_word filepath
-          File.foreach(filepath) { |line| yield line.chomp! }
+          return enum_for :each_word unless block_given?
+
+          ::File.foreach(filepath) { |line| yield line.chomp! }
+
+          self
         end
       end
     end