rambling-trie 2.4.0 → 2.5.1

data/lib/rambling/trie/container.rb

@@ -28,7 +28,7 @@ module Rambling
       # @see Nodes::Raw#add
       # @see Nodes::Compressed#add
       def add word
-        root.add char_symbols word
+        root.add reversed_char_symbols word
       end
 
       # Adds all provided words to the trie.
@@ -62,16 +62,27 @@ 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
       end
 
+      # Adds all provided words to the trie.
+      # @param [Array<String>] words the words to add the branch from.
+      # @return [Array<Nodes::Node>] the collection of nodes added.
+      # @raise [InvalidOperation] if the trie is already compressed.
+      # @see #concat
+      # @see Nodes::Raw#add
+      # @see Nodes::Compressed#add
+      def push *words
+        concat words
+      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.
+      # @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
@@ -87,7 +98,7 @@ module Rambling
 
       # 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 [Array<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
@@ -95,7 +106,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?
@@ -103,7 +114,7 @@ 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
@@ -114,9 +125,7 @@ module Rambling
       def each
         return enum_for :each unless block_given?
 
-        root.each do |word|
-          yield word
-        end
+        root.each { |word| yield word }
       end
 
       # @return [String] a string representation of the container.
@@ -141,21 +150,21 @@ module Rambling
 
       # Root node's children tree.
       # @return [Hash<Symbol, Nodes::Node>] the children tree hash contained in the root node, consisting of
-      #   +:letter => node+.
+      #   `: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.
+      # @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/3.3.0/Enumerable.html#method-i-to_a Enumerable#to_a
       def to_a
         root.to_a
       end
@@ -190,22 +199,21 @@ module Rambling
         return enum_for :words_within_root, phrase unless block_given?
 
         chars = phrase.chars
-        0.upto(chars.length - 1).each do |starting_index|
-          new_phrase = chars.slice starting_index..(chars.length - 1)
-          root.match_prefix new_phrase do |word|
-            yield word
-          end
-        end
+        size = chars.length
+        # rubocop:disable Style/CommentedKeyword
+        0.upto(size - 1).each do |starting_index|
+          new_phrase = chars.slice starting_index, size # : Array[String]
+          root.match_prefix(new_phrase) { |word| yield word }
+        end # : Enumerator[String, void]
+        # rubocop:enable Style/CommentedKeyword
       end
 
       def compress_root
-        compressor.compress root
+        compressor.compress root # : Nodes::Compressed
       end
 
-      def char_symbols word
-        symbols = []
-        word.reverse.each_char { |c| symbols << c.to_sym }
-        symbols
+      def reversed_char_symbols word
+        word.reverse.chars.map(&:to_sym).to_a
       end
     end
   end

data/lib/rambling/trie/enumerable.rb

@@ -6,8 +6,11 @@ module Rambling
     module Enumerable
       include ::Enumerable
 
+      # Empty enumerator constant for early each exits.
+      EMPTY_ENUMERATOR = [].to_enum :each
+
       # 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/3.3.0/Enumerable.html#method-i-count Enumerable#count
       alias_method :size, :count
 
       # Iterates over the words contained in the trie.
@@ -18,11 +21,7 @@ module Rambling
 
         yield as_word if terminal?
 
-        children_tree.each_value do |child|
-          child.each do |word|
-            yield word
-          end
-        end
+        children_tree.each_value { |child| child.each { |word| yield word } }
 
         self
       end

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

@@ -4,7 +4,19 @@ module Rambling
   module Trie
     module Nodes
       # A representation of a node in an compressed trie data structure.
+      # :reek:RepeatedConditional { max_ifs: 4 }
       class Compressed < Rambling::Trie::Nodes::Node
+        # Creates a new compressed node.
+        # @param [Symbol, nil] letter the Node's letter value.
+        # @param [Node, nil] parent the parent of the current node.
+        # @param [Hash<Symbol, Node>] children_tree the children tree of the current node.
+        def initialize letter = nil, parent = nil, children_tree = {}
+          super
+
+          # Ensure all children have the current compressed node as the parent
+          children_tree.each_value { |child| child.parent = self }
+        end
+
         # Always raises {Rambling::Trie::InvalidOperation InvalidOperation} when
         # trying to add a word to the current compressed trie node
         # @param [String] _ the word to add to the trie.
@@ -14,8 +26,8 @@ module Rambling
           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
@@ -23,13 +35,13 @@ module Rambling
         private
 
         def partial_word_chars? chars
-          child = children_tree[chars.first.to_sym]
+          child = children_tree[(chars.first || raise).to_sym]
           return false unless child
 
           child_letter = child.letter.to_s
 
           if chars.size >= child_letter.size
-            letter = chars.slice!(0, child_letter.size).join
+            letter = (chars.shift(child_letter.size) || raise).join
             return child.partial_word? chars if child_letter == letter
           end
 
@@ -39,7 +51,7 @@ module Rambling
         end
 
         def word_chars? chars
-          letter = chars.slice! 0
+          letter = chars.shift || raise
           letter_sym = letter.to_sym
 
           child = children_tree[letter_sym]
@@ -50,7 +62,7 @@ module Rambling
 
             break if chars.empty?
 
-            letter << chars.slice!(0)
+            letter << (chars.shift || raise)
             letter_sym = letter.to_sym
           end
 
@@ -58,13 +70,13 @@ module Rambling
         end
 
         def closest_node chars
-          child = children_tree[chars.first.to_sym]
+          child = children_tree[(chars.first || raise).to_sym]
           return missing unless child
 
           child_letter = child.letter.to_s
 
           if chars.size >= child_letter.size
-            letter = chars.slice!(0, child_letter.size).join
+            letter = (chars.shift(child_letter.size) || raise).join
             return child.scan chars if child_letter == letter
           end
 
@@ -77,19 +89,17 @@ module Rambling
         def children_match_prefix chars
           return enum_for :children_match_prefix, chars unless block_given?
 
-          return if chars.empty?
+          return EMPTY_ENUMERATOR if chars.empty?
 
-          child = children_tree[chars.first.to_sym]
-          return unless child
+          child = children_tree[(chars.first || raise).to_sym]
+          return EMPTY_ENUMERATOR unless child
 
           child_letter = child.letter.to_s
-          letter = chars.slice!(0, child_letter.size).join
+          letter = (chars.shift(child_letter.size) || raise).join
 
-          return unless child_letter == letter
+          return EMPTY_ENUMERATOR unless child_letter == letter
 
-          child.match_prefix chars do |word|
-            yield word
-          end
+          child.match_prefix(chars) { |word| yield word }
         end
       end
     end

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

@@ -4,6 +4,8 @@ module Rambling
   module Trie
     module Nodes
       # A representation of a node in the trie data structure.
+      # :reek:MissingSafeMethod { exclude: [ terminal! ] }
+      # :reek:RepeatedConditional { max_ifs: 3 }
       class Node
         include Rambling::Trie::Compressible
         include Rambling::Trie::Enumerable
@@ -22,7 +24,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.
@@ -32,6 +34,7 @@ module Rambling
         # Creates a new node.
         # @param [Symbol, nil] letter the Node's letter value.
         # @param [Node, nil] parent the parent of the current node.
+        # @param [Hash<Symbol, Node>] children_tree the children tree of the current node.
         def initialize letter = nil, parent = nil, children_tree = {}
           @letter = letter
           @parent = parent
@@ -52,16 +55,18 @@ module Rambling
           # rubocop:disable Lint/UnreachableLoop
           children_tree.each_value { |child| return child }
           # rubocop:enable Lint/UnreachableLoop
+
+          nil
         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
 
         # 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
@@ -79,7 +84,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?
 
@@ -88,7 +93,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?
 
@@ -106,7 +111,7 @@ module Rambling
         end
 
         # Returns all words that match a prefix of any length within chars.
-        # @param [String] chars the chars to base the prefix on.
+        # @param [Array[String]] chars the chars to base the prefix on.
         # @return [Enumerator<String>] all the words that match a prefix by chars.
         # @yield [String] each word found.
         def match_prefix chars
@@ -122,7 +127,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/3.3.0/Hash.html#method-i-5B-5D Hash#[]
         def [] letter
           children_tree[letter]
         end
@@ -131,15 +136,15 @@ module Rambling
         # @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#[]
+        # @see https://ruby-doc.org/3.3.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.
         # @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?
+        # @return [Boolean] `true` if the letter is present, `false` otherwise.
+        # @see https://ruby-doc.org/3.3.0/Hash.html#method-i-has_key-3F Hash#key?
         def key? letter
           children_tree.key? letter
         end
@@ -147,8 +152,8 @@ module Rambling
         # 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.
-        # @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
+        # @return [Node, nil] the node corresponding to the deleted letter.
+        # @see https://ruby-doc.org/3.3.0/Hash.html#method-i-delete Hash#delete
         def delete letter
           children_tree.delete letter
         end
@@ -164,6 +169,24 @@ module Rambling
         private
 
         attr_accessor :terminal
+
+        # abstract methods
+
+        def children_match_prefix chars
+          raise NotImplementedError
+        end
+
+        def partial_word_chars? chars
+          raise NotImplementedError
+        end
+
+        def word_chars? chars
+          raise NotImplementedError
+        end
+
+        def closest_node chars
+          raise NotImplementedError
+        end
       end
     end
   end

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

@@ -4,21 +4,23 @@ module Rambling
   module Trie
     module Nodes
       # A representation of a node in an uncompressed trie data structure.
+      # :reek:RepeatedConditional { max_ifs: 4 }
       class Raw < Rambling::Trie::Nodes::Node
         # Adds a word to the current raw (uncompressed) trie node.
-        # @param [Array<Symbol>] chars the char array to add to the trie.
-        # @return [Raw] the added/modified node based on the word added.
+        # @param [Array<Symbol>] reversed_chars the char array to add to the trie, in reverse order.
+        # @return [Node] the added/modified node based on the word added.
         # @note This method clears the contents of the chars variable.
-        def add chars
-          if chars.empty?
-            terminal!
+        def add reversed_chars
+          if reversed_chars.empty?
+            terminal! unless root?
+            self
           else
-            add_to_children_tree chars
+            add_to_children_tree reversed_chars
           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
@@ -26,7 +28,7 @@ module Rambling
         private
 
         def add_to_children_tree chars
-          letter = chars.pop
+          letter = chars.pop || raise
           child = children_tree[letter] || new_node(letter)
           child.add chars
           child
@@ -39,7 +41,7 @@ module Rambling
         end
 
         def partial_word_chars? chars = []
-          letter = chars.shift.to_sym
+          letter = (chars.shift || raise).to_sym
           child = children_tree[letter]
           return false unless child
 
@@ -47,7 +49,7 @@ module Rambling
         end
 
         def word_chars? chars = []
-          letter = chars.shift.to_sym
+          letter = (chars.shift || raise).to_sym
           child = children_tree[letter]
           return false unless child
 
@@ -55,7 +57,7 @@ module Rambling
         end
 
         def closest_node chars
-          letter = chars.shift.to_sym
+          letter = (chars.shift || raise).to_sym
           child = children_tree[letter]
           return missing unless child
 
@@ -65,16 +67,12 @@ module Rambling
         def children_match_prefix chars
           return enum_for :children_match_prefix, chars unless block_given?
 
-          return if chars.empty?
+          return EMPTY_ENUMERATOR if chars.empty?
 
-          letter = chars.shift.to_sym
-          child = children_tree[letter]
-
-          return unless child
+          child = children_tree[(chars.shift || raise).to_sym]
+          return EMPTY_ENUMERATOR unless child
 
-          child.match_prefix chars do |word|
-            yield word
-          end
+          child.match_prefix(chars) { |word| yield word }
         end
       end
     end

data/lib/rambling/trie/nodes.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-%w(node missing compressed raw).each do |file|
-  require File.join('rambling', 'trie', 'nodes', file)
-end
+path = File.join 'rambling', 'trie', 'nodes'
+%w(node missing compressed raw).each { |file| require File.join(path, file) }
 
 module Rambling
   module Trie

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

@@ -3,14 +3,14 @@
 module Rambling
   module Trie
     module Readers
-      # File reader for +.txt+ files.
+      # File reader for `.txt` files.
       class PlainText < Reader
-        # Yields each word read from a +.txt+ file.
+        # 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
-          return enum_for :each_word unless block_given?
+          return enum_for :each_word, filepath unless block_given?
 
           ::File.foreach(filepath) { |line| yield line.chomp! }
 

data/lib/rambling/trie/readers.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-%w(reader plain_text).each do |file|
-  require File.join('rambling', 'trie', 'readers', file)
-end
+path = File.join 'rambling', 'trie', 'readers'
+%w(reader plain_text).each { |file| require File.join(path, file) }
 
 module Rambling
   module Trie

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

@@ -17,9 +17,7 @@ module Rambling
         # @param [String] filepath the filepath to dump the contents to.
         # @return [Numeric] number of bytes written to disk.
         def dump contents, filepath
-          ::File.open filepath, 'w+' do |f|
-            f.write contents
-          end
+          ::File.write filepath, contents
         end
       end
     end

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

@@ -3,7 +3,7 @@
 module Rambling
   module Trie
     module Serializers
-      # Serializer for Ruby marshal format (+.marshal+) files.
+      # Serializer for Ruby marshal format (`.marshal`) files.
       class Marshal < Serializer
         # Creates a new Marshal serializer.
         # @param [Serializer] serializer the serializer responsible to write to and read from disk.
@@ -15,8 +15,8 @@ module Rambling
         # Loads marshaled object from contents in filepath and deserializes it into a {Nodes::Node Node}.
         # @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.7.0/Marshal.html#method-c-load Marshal.load
-        # @note Use of {https://ruby-doc.org/core-2.7.0/Marshal.html#method-c-load Marshal.load} is generally
+        # @see https://ruby-doc.org/3.3.0/Marshal.html#method-c-load Marshal.load
+        # @note Use of {https://ruby-doc.org/3.3.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
@@ -26,7 +26,7 @@ module Rambling
         # @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.7.0/Marshal.html#method-c-dump Marshal.dump
+        # @see https://ruby-doc.org/3.3.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

@@ -3,7 +3,7 @@
 module Rambling
   module Trie
     module Serializers
-      # Serializer for Ruby yaml format (+.yaml+, or +.yml+) files.
+      # Serializer for Ruby yaml format (`.yaml`, or `.yml`) files.
       class Yaml < Serializer
         # Creates a new Yaml serializer.
         # @param [Serializer] serializer the serializer responsible to write to and read from disk.
@@ -15,7 +15,7 @@ module Rambling
         # Loads serialized object from YAML file in filepath and deserializes it into a {Nodes::Node Node}.
         # @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.7.0/libdoc/psych/rdoc/Psych.html#method-c-safe_load Psych.safe_load
+        # @see https://ruby-doc.org/3.3.0/exts/psych/Psych.html#method-c-safe_load Psych.safe_load
         def load filepath
           require 'yaml'
           ::YAML.safe_load(
@@ -33,7 +33,7 @@ module Rambling
         # @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.7.0/libdoc/psych/rdoc/Psych.html#method-c-dump Psych.dump
+        # @see https://ruby-doc.org/3.3.0/exts/psych/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

@@ -3,9 +3,9 @@
 module Rambling
   module Trie
     module Serializers
-      # Zip file serializer. Dumps/loads contents from +.zip+ files.
-      # Automatically detects if zip file contains a +.marshal+ or +.yml+ file,
-      # or any other registered +:format => serializer+ combo.
+      # Zip file serializer. Dumps/loads contents from `.zip` files.
+      # Automatically detects if zip file contains a `.marshal` or `.yml` file,
+      # or any other registered `:format => serializer` combo.
       class Zip < Serializer
         # Creates a new Zip serializer.
         # @param [Configuration::Properties] properties the configuration
@@ -26,10 +26,15 @@ module Rambling
 
           ::Zip::File.open filepath do |zip|
             entry = zip.entries.first
-            entry_path = path entry.name
+            raise unless entry
+
+            entry_name = entry.name
+            entry_path = path entry_name
             entry.extract entry_path
 
-            serializer = serializers.resolve entry.name
+            serializer = serializers.resolve entry_name
+            raise unless serializer
+
             serializer.load entry_path
           end
         end
@@ -48,6 +53,9 @@ module Rambling
 
             entry_path = path filename
             serializer = serializers.resolve filename
+
+            raise unless serializer
+
             serializer.dump contents, entry_path
 
             zip.add filename, entry_path

data/lib/rambling/trie/serializers.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
-%w(serializer file marshal yaml zip).each do |file|
-  require File.join('rambling', 'trie', 'serializers', file)
-end
+path = File.join 'rambling', 'trie', 'serializers'
+%w(serializer file marshal yaml zip).each { |file| require File.join(path, file) }
 
 module Rambling
   module Trie

data/lib/rambling/trie/stringifyable.rb

@@ -2,7 +2,7 @@
 
 module Rambling
   module Trie
-    # Provides the +String+ representation behavior for the trie data structure.
+    # Provides the `String` representation behavior for the trie data structure.
     module Stringifyable
       # String representation of the current node, if it is a terminal node.
       # @return [String] the string representation of the current node.