rambling-trie 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3af7f8936c101be83262b9535524bdcd3381bb76b857e7a44f331c932c67afb4
-  data.tar.gz: e1b9dfc8f88822404c82f95b3fac6a376d3433d15535e8fc0dd454b4669f9e52
+  metadata.gz: 25c794ace94646da9b2892ea80c8df575cb3c95fc870790df2b50edde7fbb91e
+  data.tar.gz: e2be8d009e65109b52a1f36f524701b2d9452855aeceb8870e02fe7db52b150f
 SHA512:
-  metadata.gz: 8bc211404f2a209892aa7de20f20ce5b61f481f117f4ac2f3c45cceaf7076e690229487c7f2dd4613d5725fdf38e4a616efe082b27d4055c359f5801457f704d
-  data.tar.gz: 21cb664d6abccbc565fa8c2441c54c18d3ab8a4ccf8ae2457f4671b6b2b579ccd4893a400b3756af82bc261afa8c804db352bf68b6aa0105ab91396b90e1f2be
+  metadata.gz: cc61981cb9a93450b0f6159adb497f30de7fa7a7ddf98c69a3baa64ed9cd8757aa035d3f818b080822714b2b5505ed5cefbff7217ce952856630bacab2dc3afd
+  data.tar.gz: 1afc2883a31ee9bbf63172c20d806ed952d40bc65527f582308fbe61b8c83dddc3aa3b3ab1b300ded46bf7dbd2f6e73340d22019de4ca82e0587a81bb789725c

data/Gemfile

@@ -22,7 +22,9 @@ group :test do
 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

data/LICENSE

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

data/README.md

@@ -12,7 +12,8 @@
 [![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.
+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
 
@@ -57,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'
@@ -74,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
 
@@ -98,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'
@@ -119,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
@@ -128,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
@@ -155,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 }
@@ -166,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:
 
@@ -174,7 +187,8 @@ 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 '/path/to/file'
@@ -184,14 +198,15 @@ trie = Rambling::Trie.load '/path/to/file'
 
 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
@@ -246,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
@@ -271,21 +288,29 @@ 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-2023 Edgar González
+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?version=2.3.0
+[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_climate_grade_badge]: https://codeclimate.com/github/gonzedge/rambling-trie/badges/gpa.svg

data/lib/rambling/trie/comparable.rb

@@ -7,8 +7,7 @@ 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

@@ -4,10 +4,8 @@ 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?) && 1 == children_tree.size
       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,21 +6,18 @@ module Rambling
       # Provides configurable properties for Rambling::Trie.
       class Properties
         # The configured {Readers Readers}.
-        # @return [ProviderCollection<Readers::Reader>] 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<Serializers::Serializer>] 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 returns a {Nodes::Node Node}
-        # when called.
+        # The configured +root_builder+, which returns a {Nodes::Node Node} when called.
         # @return [Proc<Nodes::Node>] the configured +root_builder+.
         attr_accessor :root_builder
 
@@ -50,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

@@ -16,11 +16,10 @@ module Rambling
         #   Sets the default provider. Needs to be one of the configured
         #   providers.
         #   @param [TProvider] provider the provider to use as default.
-        #   @raise [ArgumentError] when the given provider is not in the
-        #     provider collection.
+        #   @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}.
+        # @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.
@@ -36,35 +35,28 @@ module Rambling
         end
 
         # Adds a new provider 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.
+        # @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<Symbol, TProvider>] 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 [TProvider, nil] the provider for the given file's extension.
-        #   {#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
@@ -88,8 +80,7 @@ module Rambling
         # Get provider corresponding to a given format.
         # @param [Symbol] format the format to search for in the collection.
         # @return [TProvider] the provider corresponding to that format.
-        # @see https://ruby-doc.org/core-2.7.0/Hash.html#method-i-5B-5D
-        #   Hash#[]
+        # @see https://ruby-doc.org/core-2.7.0/Hash.html#method-i-5B-5D Hash#[]
         def [] format
           providers[format]
         end
@@ -113,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

@@ -41,22 +41,19 @@ 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.
+      # 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.
+      # @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?
 
@@ -65,8 +62,7 @@ module Rambling
 
       # 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.
+      # @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
@@ -74,8 +70,8 @@ module Rambling
 
       # 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.
+      # @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
@@ -83,18 +79,15 @@ module Rambling
 
       # 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.
+      # @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.
       def words_within phrase
         words_within_root(phrase).to_a
@@ -102,8 +95,7 @@ module Rambling
 
       # 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?
@@ -141,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 [Hash<Symbol, Nodes::Node>] the children tree hash contained in
-      #   the root node, consisting of +:letter => 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,8 +7,7 @@ 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.

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

@@ -11,8 +11,7 @@ module Rambling
         # @raise [InvalidOperation] if the trie is already compressed.
         # @return [void]
         def add _
-          raise Rambling::Trie::InvalidOperation,
-            'Cannot add word to compressed trie'
+          raise Rambling::Trie::InvalidOperation, 'Cannot add word to compressed trie'
         end
 
         # Always return +true+ for a compressed node.

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

@@ -3,8 +3,7 @@
 module Rambling
   module Trie
     module Nodes
-      # A representation of a missing node in the trie data structure. Returned
-      # when a node is not found.
+      # A representation of a missing node in the trie data structure. Returned when a node is not found.
       class Missing < Rambling::Trie::Nodes::Node
       end
     end

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

@@ -22,8 +22,7 @@ module Rambling
         attr_reader :letter
 
         # Child nodes tree.
-        # @return [Hash<Symbol, Node>] 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.
@@ -40,8 +39,7 @@ module Rambling
         end
 
         # Child nodes.
-        # @return [Array<Node>] the array of child nodes contained
-        #   in the current node.
+        # @return [Array<Node>] the array of child nodes contained in the current node.
         def children
           children_tree.values
         end
@@ -57,8 +55,7 @@ module Rambling
         end
 
         # Indicates if the current node is the root node.
-        # @return [Boolean] +true+ if the node does not have a parent, +false+
-        #   otherwise.
+        # @return [Boolean] +true+ if the node does not have a parent, +false+ otherwise.
         def root?
           !parent
         end
@@ -70,7 +67,7 @@ module Rambling
         end
 
         # Mark {Node Node} as terminal.
-        # @return [Node] the modified node.
+        # @return [self] the modified node.
         def terminal!
           self.terminal = true
           self
@@ -82,8 +79,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+
-        #   otherwise.
+        # @return [Boolean] +true+ if the characters are found, +false+ otherwise.
         def partial_word? chars
           return true if chars.empty?
 
@@ -92,8 +88,7 @@ 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?
 
@@ -112,8 +107,7 @@ 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 by chars.
         # @yield [String] each word found.
         def match_prefix chars
           return enum_for :match_prefix, chars unless block_given?
@@ -128,8 +122,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.7.0/Hash.html#method-i-5B-5D
-        #   Hash#[]
+        # @see https://ruby-doc.org/core-2.7.0/Hash.html#method-i-5B-5D Hash#[]
         def [] letter
           children_tree[letter]
         end
@@ -137,31 +130,25 @@ module Rambling
         # Set the {Node Node} that corresponds to a given letter.
         # @param [Symbol] letter the letter to insert or update in the node's
         # @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.7.0/Hash.html#method-i-5B-5D
-        #   Hash#[]
+        # @return [Node] the node corresponding to the inserted or updated letter.
+        # @see https://ruby-doc.org/core-2.7.0/Hash.html#method-i-5B-5D Hash#[]
         def []= letter, node
           children_tree[letter] = node
         end
 
-        # Check if a {Node Node}'s children tree contains a given
-        #   letter.
+        # 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.7.0/Hash.html#method-i-has_key-3F
-        #   Hash#key?
+        # @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.
-        # @param [Symbol] letter the letter to delete from the 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.7.0/Hash.html#method-i-delete
-        #   Hash#delete
+        # @see https://ruby-doc.org/core-2.7.0/Hash.html#method-i-delete Hash#delete
         def delete letter
           children_tree.delete letter
         end

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

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