mp-utils 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 472fb772fc669be45aee52e5f931823934e59cb5f36974536dbfea782024ac9d
-  data.tar.gz: 9c5079304a471c97261ec621457575b1b79c9454a8a60f7d19ee9b0a51a7c777
+  metadata.gz: 0a57051627a8e74a98a9209b1c213c6148846cf4fe0f4a7a1da5e0b8dbc64cd7
+  data.tar.gz: bd146f3f15a46dbab724a0b18878842a9d96c1508feec23dcf7c9da9b7c99de8
 SHA512:
-  metadata.gz: 79864c2f162bb4d136ae0762d4196c868e0ce4136a31bb873ce79289478734f442acfc18e882d942b53b15e26c570a8b4d18c144f88d1ceae4573c01121583d8
-  data.tar.gz: cd1ed6a8fdb3c724d1953c0df5107468936b5a4800b537097ca32d3f134123c93f39c45ee327a347037e6246fe23600030128fe12f7371034d11bca9fb347204
+  metadata.gz: 8a3c24a403c587a815a14e9ffd7e9321a1642eee43ea96c1282199f7d25c38a403206e277be6855c488a366f96f9eff7f8c823956458ca2e85d09bb4d97abe4b
+  data.tar.gz: c41ceaf522f2d4d9b56de23e432910eeae65697fdf98080755c4d46523486caf8b9226f7eeac2a9220642125b708d1b4ee1d98d9b2b6c22fd2488010ce080e5b

data/lib/mp_utils.rb

@@ -3,8 +3,10 @@
 require_relative 'utils/key'
 require_relative 'utils/ansi'
 require_relative 'utils/array'
+require_relative 'utils/string'
 require_relative 'utils/message'
 require_relative 'utils/question'
 require_relative 'utils/version_manager'
 require_relative 'utils/ansi_style_manager'
+require_relative 'utils/directory_structure'
 require_relative 'resources/path_helper'

data/lib/utils/ansi.rb

@@ -2,18 +2,18 @@
 
 require_relative 'constants'
 
-# The ANSI class is responsible for generating ANSI codes for text styling in terminals.
-# It allows the combination of multiple style and color codes.
+# The ANSI class is responsible for generating ANSI codes for text styling in terminals.  
+# It allows the combination of multiple style and color codes.  
 #
-# @example
-#   ansi = ANSI.new(:bold)
-#   puts ansi.to_s # => "\e[1m"
+# @example  
+#   ansi = ANSI.new(:bold)  
+#   puts ansi.to_s # => "\e[1m"  
 #
-# @example
-#   ansi = ANSI.new([:bold, :red])
-#   puts ansi.to_s # => "\e[1;31m"
+# @example  
+#   ansi = ANSI.new([:bold, :red])  
+#   puts ansi.to_s # => "\e[1;31m"  
 class ANSI
-  # Hash that maps style and color names to their respective ANSI codes.
+  # Hash that maps style and color names to their respective ANSI codes.  
   CODES_HASH = {
     reset_all: 0,
 
@@ -66,12 +66,24 @@ class ANSI
     reset_background: 49
   }.freeze
 
-  # @return [Array<Integer>] the ANSI codes stored in the instance.
+  # @return [Array<Integer>] the ANSI codes stored in the instance.  
   attr_reader :codes
 
-  # Initializes a new instance of the ANSI class.
+  # Removes ANSI escape codes from a given string.
   #
-  # @param code [Array<Symbol>, Symbol, String] One or more ANSI codes represented as symbols, integers, or strings.
+  # This class method is designed to take a string input and remove any ANSI
+  # escape codes, which are often used for text formatting in terminal outputs.
+  #
+  # @param value [String] the string from which ANSI codes should be removed.
+  #   If the input is not a string, it will be converted to a string using `to_s`.
+  # @return [String] a new string with ANSI escape codes removed.
+  def self.remove_from_string(value)
+    value.to_s.gsub(CONSTANTS::ANSI::TOKEN_REGEX, '')
+  end
+
+  # Initializes a new instance of the ANSI class.  
+  #
+  # @param code [Array<Symbol>, Symbol, String] One or more ANSI codes represented as symbols, integers, or strings.  
   def initialize(code)
     @codes = if code.is_a?(Array)
                ANSI.normalize_array_codes(code)
@@ -82,36 +94,36 @@ class ANSI
              end
   end
 
-  # Adds ANSI codes from another instance of the ANSI class.
+  # Adds ANSI codes from another instance of the ANSI class.  
   #
-  # @param ansi [ANSI] The instance of the ANSI class whose codes will be added.
-  # @return [ANSI] A new instance of the ANSI class with the combined codes.
-  # @raise [RuntimeError] If the argument is not an instance of the ANSI class.
+  # @param ansi [ANSI] The instance of the ANSI class whose codes will be added.  
+  # @return [ANSI] A new instance of the ANSI class with the combined codes.  
+  # @raise [RuntimeError] If the argument is not an instance of the ANSI class.  
   def append(ansi)
     raise 'Needs be an instance of ANSI' unless ansi.is_a?(ANSI)
 
     ANSI.new(@codes.union(ansi.codes))
   end
 
-  # Adds ANSI codes from another instance of the ANSI class and updates the current instance.
+  # Adds ANSI codes from another instance of the ANSI class and updates the current instance.  
   #
-  # @param ansi [ANSI] The instance of the ANSI class whose codes will be added.
-  # @return [void]
+  # @param ansi [ANSI] The instance of the ANSI class whose codes will be added.  
+  # @return [void]  
   def append!(ansi)
     @codes = append(ansi).codes
   end
 
-  # Converts the ANSI codes stored in the instance to a formatted string.
+  # Converts the ANSI codes stored in the instance to a formatted string.  
   #
-  # @return [String] The formatted string with the ANSI codes.
+  # @return [String] The formatted string with the ANSI codes.  
   def to_s
     "\e[#{@codes.flatten.join(';')}m"
   end
 
-  # Normalizes an array of codes, converting symbols and strings to their respective ANSI codes.
+  # Normalizes an array of codes, converting symbols and strings to their respective ANSI codes.  
   #
-  # @param array [Array<Symbol, String, Integer>] An array of codes to be normalized.
-  # @return [Array<Integer>] The normalized array of ANSI codes.
+  # @param array [Array<Symbol, String, Integer>] An array of codes to be normalized.  
+  # @return [Array<Integer>] The normalized array of ANSI codes.  
   def self.normalize_array_codes(array)
     array.map do |value|
       next normalize_array_codes(value) if value.is_a?(Array)

data/lib/utils/ansi_style_manager.rb

@@ -3,25 +3,25 @@
 require_relative 'constants'
 require_relative 'ansi'
 
-# The ANSIStyleManager class is responsible for managing and applying ANSI styles to a given string.
+# The ANSIStyleManager class is responsible for managing and applying ANSI styles to a given string.  
 #
-# It can replace tokens in the string with corresponding ANSI codes for colors, backgrounds and effects.
+# It can replace tokens in the string with corresponding ANSI codes for colors, backgrounds and effects.  
 #
-# ## Effects
+# ## Effects  
 # Effects can be used by adding `<effect:effect_name>` at the beginning and `</effect>` at the end of
-# the sequence of characters to which you want the effect to be applied.
-#
-# Example:
-# ```ruby
-# manager = ANSIStyleManager.new('The text <effect:bold>Potato</effect> will be bold.')
-# puts manager
-# ```
-# Output:
-#
-# ![bold output](./.resources/images/bold_effect_example.png)
-#
-# Below is the table with all available effects:
-#
+# the sequence of characters to which you want the effect to be applied.  
+#
+# Example:  
+# ```ruby  
+# manager = ANSIStyleManager.new('The text <effect:bold>Potato</effect> will be bold.')  
+# puts manager  
+# ```  
+# Output:  
+#  
+# ![bold_effect](./images/bold_effect_example.png)
+#  
+# Below is the table with all available effects:  
+#  
 # | Effect Name   | Description                |
 # |---------------|----------------------------|
 # | bold          | set bold mode.             |
@@ -33,45 +33,45 @@ require_relative 'ansi'
 # | hidden        | set hidden/invisible mode. |
 # | strike        | set strikethrough mode.    |
 # | plain         | set double underline mode. |
-#
-# > **Note:** Some terminals may not support some of the effects listed above.
-#
-# ## Colors
-# The ANSIStyleManager supports 3 types of coloring: Named Colors, RGB Colors, or 256 Colors.
-#
+#  
+# > **Note:** Some terminals may not support some of the effects listed above.  
+#  
+# ## Colors  
+# The ANSIStyleManager supports 3 types of coloring: Named Colors, RGB Colors, or 256 Colors.  
+#  
 # The foreground color can be changed by adding `<color:color_type>` at the beginning and `</color>`
-# at the end of the character sequence you want to color.
-#
-# Example:
-# ```ruby
-# text  = 'A <color:green>colorful <color:red>world <color:yellow>is <color:blue>much '
-# text += '</color>more </color>beautiful</color>!</color> ;)'
-# manager = ANSIStyleManager.new(text)
-# puts manager
-# ```
-# Output:
-#
-# ![colored output](./.resources/images/foreground_colored_example.png)
-#
-# It is also possible to set the background color of a text.
-#
+# at the end of the character sequence you want to color.  
+#  
+# Example:  
+# ```ruby  
+# text  = 'A <color:green>colorful <color:red>world <color:yellow>is <color:blue>much '  
+# text += '</color>more </color>beautiful</color>!</color> ;)'  
+# manager = ANSIStyleManager.new(text)  
+# puts manager  
+# ```  
+# Output:  
+#  
+# ![colored output](./images/foreground_colored_example.png)  
+#  
+# It is also possible to set the background color of a text.  
+#  
 # The background color can be changed by adding `<color:color_type:color_type>` at the
-# beginning and `</color>` at the end of the character sequence you want to color.
-#
-# Example:
-# ```ruby
-# text  = 'A <color:green:white>colorful <color:196>world <color:yellow:111>is <color:blue:255;255;255>much '
-# text += '</color>more </color>beautiful</color>!</color> ;)'
-# manager = ANSIStyleManager.new(text)
-# puts manager
-# ```
-#
-# Output:
-#
-# ![colored output](./.resources/images/background_colored_exemple.png)
-#
-# Below is the table with all available color type patterns:
-#
+# beginning and `</color>` at the end of the character sequence you want to color.  
+#  
+# Example:  
+# ```ruby  
+# text  = 'A <color:green:white>colorful <color:196>world <color:yellow:111>is <color:blue:255;255;255>much '  
+# text += '</color>more </color>beautiful</color>!</color> ;)'  
+# manager = ANSIStyleManager.new(text)  
+# puts manager  
+# ```  
+#  
+# Output:  
+#  
+# ![colored output](./images/background_colored_exemple.png)  
+#  
+# Below is the table with all available color type patterns:  
+#  
 # |Color Type   |Pattern |Description                                                                                  |
 # |-------------|--------|---------------------------------------------------------------------------------------------|
 # |Reset colors |reset   |Resets to the terminal's default color.                                                      |
@@ -80,30 +80,30 @@ require_relative 'ansi'
 # |Named Colors |name    |Accepts the following color names: black, red, green, yellow, blue, magenta, cyan and white. |
 #
 class ANSIStyleManager
-  # @return [String] the string to which ANSI styles will be applied.
+  # @return [String] the string to which ANSI styles will be applied.  
   attr_reader :string
 
-  # Initializes a new instance of the ANSIStyleManager class.
+  # Initializes a new instance of the ANSIStyleManager class.  
   #
-  # @param string [String] The string to which ANSI styles will be applied.
-  # @raise [RuntimeError] If the argument is not a string.
+  # @param string [String] The string to which ANSI styles will be applied.  
+  # @raise [RuntimeError] If the argument is not a string.  
   def initialize(string)
     raise 'Need initialize with a string' unless string.is_a?(String)
 
     @string = String.new(string)
   end
 
-  # Replaces all color and effect tokens in the string with corresponding ANSI codes.
-  #
-  # @return [void]
+  # Replaces all color and effect tokens in the string with corresponding ANSI codes.  
+  #  
+  # @return [void]  
   def replace_all_tokens!
     replace_color_tokens!
     replace_effect_tokens!
   end
 
-  # Replaces all color tokens in the string with corresponding ANSI codes.
-  #
-  # @return [void]
+  # Replaces all color tokens in the string with corresponding ANSI codes.  
+  #  
+  # @return [void]  
   def replace_color_tokens!
     scan_while_find(CONSTANTS::ANSI::COLORS) do |value|
       colors = value.first.split(':')
@@ -118,9 +118,9 @@ class ANSIStyleManager
     end
   end
 
-  # Replaces all effect tokens in the string with corresponding ANSI codes.
-  #
-  # @return [void]
+  # Replaces all effect tokens in the string with corresponding ANSI codes.  
+  #  
+  # @return [void] 
   def replace_effect_tokens!
     scan_while_find(CONSTANTS::ANSI::EFFECTS) do |value|
       replace_tokens_with!(
@@ -133,9 +133,9 @@ class ANSIStyleManager
     end
   end
 
-  # Converts the string with all tokens replaced by corresponding ANSI codes.
+  # Converts the string with all tokens replaced by corresponding ANSI codes.  
   #
-  # @return [String] The string with ANSI codes applied.
+  # @return [String] The string with ANSI codes applied.  
   def to_s
     replace_all_tokens!
     @string
@@ -143,11 +143,11 @@ class ANSIStyleManager
 
   private
 
-  # Generates the ANSI prefix for a given color and background.
+  # Generates the ANSI prefix for a given color and background.  
   #
-  # @param color [String] The color name or code.
-  # @param background [String, nil] The background color name or code.
-  # @return [ANSI] The ANSI instance representing the color and background.
+  # @param color [String] The color name or code.  
+  # @param background [String, nil] The background color name or code.  
+  # @return [ANSI] The ANSI instance representing the color and background.  
   def color_prefix(color:, background:)
     color_ansi = generate_color_ansi(color, is_background: false)
     return color_ansi.to_s if background.nil?
@@ -155,11 +155,11 @@ class ANSIStyleManager
     generate_color_ansi(background, is_background: true).append(color_ansi)
   end
 
-  # Generates the ANSI instance for a given color.
+  # Generates the ANSI instance for a given color.  
   #
-  # @param color [String] The color name or code.
-  # @param is_background [Boolean] Whether the color is for the background.
-  # @return [ANSI] The ANSI instance representing the color.
+  # @param color [String] The color name or code.  
+  # @param is_background [Boolean] Whether the color is for the background.  
+  # @return [ANSI] The ANSI instance representing the color.  
   def generate_color_ansi(color, is_background:)
     digit_values = color.scan(CONSTANTS::ANSI::COLOR_DIGITS_REGEX).flatten.compact
 
@@ -175,25 +175,25 @@ class ANSIStyleManager
     ANSI.new(is_background ? "background_#{color}" : color)
   end
 
-  # Replaces tokens in the string with corresponding ANSI codes.
+  # Replaces tokens in the string with corresponding ANSI codes.  
   #
-  # @param text [String] The text to be styled.
-  # @param to_replace [String] The token to be replaced.
-  # @param ansi_token [ANSI] The ANSI instance representing the style.
-  # @param ansi_reset_token [ANSI] The ANSI instance representing the reset style.
-  # @param preserve_reset_token [Boolean] Whether to preserve the reset token in the text.
-  # @return [void]
+  # @param text [String] The text to be styled.  
+  # @param to_replace [String] The token to be replaced.  
+  # @param ansi_token [ANSI] The ANSI instance representing the style.  
+  # @param ansi_reset_token [ANSI] The ANSI instance representing the reset style.  
+  # @param preserve_reset_token [Boolean] Whether to preserve the reset token in the text.  
+  # @return [void]  
   def replace_tokens_with!(text:, to_replace:, ansi_token:, ansi_reset_token:, preserve_reset_token:)
     colored_text = text.gsub(ansi_reset_token.to_s, "#{ansi_reset_token}#{ansi_token}") if preserve_reset_token
     colored_text = text.gsub(ansi_reset_token.to_s, ansi_token.to_s) unless preserve_reset_token
     @string.gsub!(to_replace, "#{ansi_token}#{colored_text}#{ansi_reset_token}")
   end
 
-  # Scans the string for tokens matching the given regex and processes them with the provided block.
+  # Scans the string for tokens matching the given regex and processes them with the provided block.  
   #
-  # @param scan_regex [Regexp] The regex to scan for tokens.
-  # @yieldparam value [Array<String>] The matched tokens.
-  # @return [void]
+  # @param scan_regex [Regexp] The regex to scan for tokens.  
+  # @yieldparam value [Array<String>] The matched tokens.  
+  # @return [void]  
   def scan_while_find(scan_regex, &block)
     result = @string.scan(scan_regex)
     while result.count.positive?

data/lib/utils/array.rb

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
 
-# Extension to Ruby's Array class to enhance functionality.
+# Extension to Ruby's Array class to enhance functionality.  
 class Array
-  # Lists all elements in the array with their index.
+  # Lists all elements in the array with their index.  
   #
-  # This method outputs each element of the array to the console, prefixed by its index (1-based).
-  # The index is right-justified based on the length of the array, ensuring a tidy, column-aligned output.
+  # This method outputs each element of the array to the console, prefixed by its index (1-based).  
+  # The index is right-justified based on the length of the array, ensuring a tidy, column-aligned output.  
   #
-  # Example output for a 3-element array:
-  #   |1| Element 1
-  #   |2| Element 2
-  #   |3| Element 3
+  # @example
+  #   # output for a 3-element array:  
+  #   |1| Element 1  
+  #   |2| Element 2  
+  #   |3| Element 3  
   #
   # @return [void]
   def list_all_elements

data/lib/utils/constants.rb

@@ -6,6 +6,7 @@ module CONSTANTS
 
   # @!visibility private
   module ANSI
+    TOKEN_REGEX = /\e\[(\d|;)+m/.freeze
     COLOR_DIGITS_REGEX = /^(\d+);(\d+);(\d+)|(\d+)$/.freeze
     COLOR_TOKEN_VALUE = '(?:[\w|\d]+|\d+\;\d+\;\d+)(?::[\w|\d]+|:\d+;\d+;\d+)?'
     COLORS = %r{<color:(#{COLOR_TOKEN_VALUE})>((?:(?!<color:#{COLOR_TOKEN_VALUE}>|</color>).)*)</color>}m.freeze

data/lib/utils/directory_structure.rb

@@ -0,0 +1,217 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+# Class to represent and process a directory structure.  
+# It can be initialized with a hash or a YAML file.  
+#
+# ## Using HASH  
+#
+# The following example shows how to use DirectoryStructure with a hash.  
+# ```ruby
+# hash = {
+#   'lib' => {
+#     'version.rb' => nil,
+#     'source' => [
+#       'file_1.rb',
+#       'file_2.rb',
+#       'file_3.rb'
+#     ],
+#     'resource' => {
+#       'images' => [
+#         'potato.png',
+#         'fries.jpeg',
+#         'franch_fries.png'
+#       ],
+#       'scripts' => {
+#         validation: 'teste.rb',
+#         sorting: [
+#           'shellsort.rb',
+#           'quicksort.rb'
+#         ],
+#         'build.rb' => nil
+#       }
+#     },
+#     generated: 'file.generated.rb'
+#   }
+# }
+# directory_structure = DirectoryStructure.new(hash)  
+# puts "That is my directory structure:\n#{directory_structure}"  
+#   
+# # Output:  
+# # That is my directory structure:  
+# # lib  
+# # ╠═ version.rb
+# # ╠═ source
+# # ║  ╠═ file_1.rb
+# # ║  ╠═ file_2.rb
+# # ║  ╚═ file_3.rb
+# # ╠═ resource
+# # ║  ╠═ images
+# # ║  ║  ╠═ potato.png
+# # ║  ║  ╠═ fries.jpeg
+# # ║  ║  ╚═ franch_fries.png
+# # ║  ╚═ scripts
+# # ║     ╠═ validation
+# # ║     ║  ╚═ teste.rb
+# # ║     ╠═ sorting
+# # ║     ║  ╠═ shellsort.rb
+# # ║     ║  ╚═ quicksort.rb
+# # ║     ╚═ build.rb
+# # ╚═ generated
+# #    ╚═ file.generated.rb
+# ```
+#
+# ## Using a YAML/YML File  
+#
+# First, you need to create a yml file.  
+#
+# Example:  
+# ```yml
+# lib:
+#   version.rb:
+#   source:
+#   - file_1.rb
+#   - file_2.rb
+#   - file_3.rb
+#   resource:
+#     images:
+#     - potato.png
+#     - fries.jpeg
+#     - franch_fries.png
+#     scripts:
+#       validation: teste.rb
+#       sorting:
+#       - shellsort.rb
+#       - quicksort.rb
+#       build.rb:
+#   generated: file.generated.rb
+# ```
+#
+# Considering that the file path is passed as a reference.  
+#
+# You can initialize the class as in the example below:  
+#
+# ```ruby  
+# path = 'Replace/By/Your/YAML/FILE/PATH'  
+# directory_structure = DirectoryStructure.new(path)  
+# puts "That is my directory structure:\n#{directory_structure}"  
+# 
+# # Output:
+# # That is my directory structure:
+# # lib
+# # ╠═ version.rb
+# # ╠═ source
+# # ║  ╠═ file_1.rb
+# # ║  ╠═ file_2.rb
+# # ║  ╚═ file_3.rb
+# # ╠═ resource
+# # ║  ╠═ images
+# # ║  ║  ╠═ potato.png
+# # ║  ║  ╠═ fries.jpeg
+# # ║  ║  ╚═ franch_fries.png
+# # ║  ╚═ scripts
+# # ║     ╠═ validation
+# # ║     ║  ╚═ teste.rb
+# # ║     ╠═ sorting
+# # ║     ║  ╠═ shellsort.rb
+# # ║     ║  ╚═ quicksort.rb
+# # ║     ╚═ build.rb
+# # ╚═ generated
+# #    ╚═ file.generated.rb
+# ```
+class DirectoryStructure
+  # Initializes the DirectoryStructure object.  
+  #
+  # @param content [Hash, String] A hash representing the directory structure or a path to a YAML file.  
+  # @raise [RuntimeError] If the content is not a Hash or a valid YAML file path.  
+  def initialize(content)
+    if content.is_a?(Hash)
+      @dir_hash = content
+    elsif File.exist?(content)
+      @dir_hash = YAML.load_file(content)
+    else
+      raise 'Need be initialized with a Hash or yaml file path'
+    end
+  end
+
+  # Converts the directory structure to a string representation.  
+  #
+  # @return [String] The string representation of the directory structure.  
+  def to_s
+    @output = String.new('')
+    process_node(@dir_hash)
+    @output
+  end
+
+  private
+
+  # Generates the indentation string based on the key.  
+  #
+  # @param key [Symbol] The key indicating the type of indentation.  
+  # @return [String] The indentation string.  
+  def generate_indent(key)
+    { middle: '║  ', last: '   ' }[key] || ''
+  end
+
+  # Concatenates the node to the output string with the given prefix and indentation.  
+  #
+  # @param node [String] The node to be concatenated.  
+  # @param prefix [Symbol] The prefix indicating the type of node.  
+  # @param indent [Array<Symbol>] The array of indentation keys.  
+  # @return [void]  
+  def concant(node, prefix:, indent:)
+    prefix_string = { middle: '╠═ ', last: '╚═ ' }[prefix] || ''
+    indent_string = indent.map { |i| generate_indent(i) }.join
+    @output << "#{indent_string}#{prefix_string}#{node}\n"
+  end
+
+  # Processes an array of nodes and concatenates them to the output string.  
+  #
+  # @param array [Array] The array of nodes to be processed.  
+  # @param indent [Array<Symbol>] The array of indentation keys.  
+  # @return [void]  
+  def process_array(array, indent:)
+    array.each_with_index do |item, index|
+      prefix = index == array.size - 1 ? :last : :middle
+      concant(item, prefix: prefix, indent: indent)
+    end
+  end
+
+  # Processes a hash of nodes and concatenates them to the output string.  
+  #
+  # @param hash [Hash] The hash of nodes to be processed.  
+  # @param level [Integer] The current level of indentation.  
+  # @param indent [Array<Symbol>] The array of indentation keys.  
+  # @return [void]  
+  def process_hash(hash, level:, indent:)
+    hash.each_with_index do |(key, value), index|
+      new_indent = indent.dup
+      prefix = :empty
+
+      if level > new_indent.size
+        prefix = index == hash.size - 1 ? :last : :middle
+        new_indent = indent + [prefix]
+      end
+
+      concant(key, prefix: prefix, indent: indent)
+      process_node(value, indent: new_indent, level: level)
+    end
+  end
+
+  # Processes a node (hash, array, or other) and concatenates it to the output string.  
+  #
+  # @param node [Object] The node to be processed.  
+  # @param level [Integer] The current level of indentation.  
+  # @param indent [Array<Symbol>] The array of indentation keys.  
+  # @return [void]
+  def process_node(node, level: 0, indent: [''])
+    if node.is_a?(Hash)
+      process_hash(node, indent: indent, level: level + 1)
+    elsif node.is_a?(Array)
+      process_array(node, indent: indent)
+    elsif !node.nil?
+      concant(node, prefix: :last, indent: indent)
+    end
+  end
+end

data/lib/utils/key.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 # The Key class is designed to encapsulate strings within a specific prefix and suffix,
-# allowing for easy identification and manipulation of placeholders within messages.
+# allowing for easy identification and manipulation of placeholders within messages.  
 # This can be particularly useful in templating systems where placeholders need
-# to be dynamically replaced with actual content.
+# to be dynamically replaced with actual content.  
 #
 # @example Creating a new Key and converting it to a string
 #   key = Key.new("username")
@@ -24,32 +24,32 @@ class Key
     @value = value.to_s
   end
 
-  # Checks equality of two Key objects based on their value.
+  # Checks equality of two Key objects based on their value.  
   #
-  # @param other [Key] the other Key object to compare with.
-  # @return [Boolean] true if both Keys have the same value, false otherwise.
+  # @param other [Key] the other Key object to compare with.  
+  # @return [Boolean] true if both Keys have the same value, false otherwise.  
   def ==(other)
     self.class == other.class && @value == other.value
   end
 
-  # Returns the string representation of the Key, including its prefix and suffix.
-  #
-  # @return [String] the string representation of the Key.
+  # Returns the string representation of the Key, including its prefix and suffix.  
+  #  
+  # @return [String] the string representation of the Key.  
   def to_s
     "#{Key.prefix}#{@value}#{Key.suffix}"
   end
 
-  # Returns the escaped Regexp representation of the Key.to_s return.
-  #
-  # @return [Regexp] the escaped regexp representation of the Key.to_s return.
+  # Returns the escaped Regexp representation of the Key.to_s return.  
+  #  
+  # @return [Regexp] the escaped regexp representation of the Key.to_s return.  
   def to_regexp
     /#{Regexp.escape(to_s)}/
   end
 
-  # Finds and returns all Key instances within the given string.
+  # Finds and returns all Key instances within the given string.  
   #
-  # @param value [#to_s] the string to search for keys.
-  # @return [Array<Key>] an array of Key instances found within the given string.
+  # @param value [#to_s] the string to search for keys.  
+  # @return [Array<Key>] an array of Key instances found within the given string.  
   def self.find_keys_in(value)
     ep = Regexp.escape(prefix)
     es = Regexp.escape(suffix)
@@ -58,16 +58,16 @@ class Key
     end
   end
 
-  # Returns the prefix used to identify the start of a Key in a string.
-  #
-  # @return [String] the prefix.
+  # Returns the prefix used to identify the start of a Key in a string.  
+  #  
+  # @return [String] the prefix.  
   def self.prefix
     '<||'
   end
 
-  # Returns the suffix used to identify the end of a Key in a string.
-  #
-  # @return [String] the suffix.
+  # Returns the suffix used to identify the end of a Key in a string.  
+  #  
+  # @return [String] the suffix.  
   def self.suffix
     '||>'
   end

data/lib/utils/message.rb

@@ -3,16 +3,14 @@
 require_relative File.join('..', 'resources', 'path_helper')
 require_relative 'key'
 
-# The Message class represents a mechanism for dynamically handling and formatting messages.
-#
-# It supports the substitution of placeholders within a message template with actual data.
-#
+# The Message class represents a mechanism for dynamically handling and formatting messages.  
+# It supports the substitution of placeholders within a message template with actual data.  
 # The class leverages file-based message templates, allowing for easy localization or
-# customization of messages.
+# customization of messages.  
 #
 # It integrates seamlessly with the Resources module to access these templates from
 # a customizable path set via the "SCRIPT_CUSTOM_RESOURCES" environment variable or
-# from a default library path.
+# from a default library path.  
 #
 # @example Creating a new Message instance and formatting it
 #   # Assuming "hellow_world" is a file that says "Hello, world!"
@@ -40,10 +38,11 @@ class Message
     self.class == other.class && @message == other.message
   end
 
-  # Converts the message template into a string, replacing any placeholders with actual data.
+  # Converts the message template into a string, replacing any placeholders with actual data.  
   # This method searches for keys within the message and replaces them with corresponding
   # content from message files located in either the custom path or the library path and appling
-  # the given replaces.
+  # the given replaces.  
+  # If the file name have the suffix ".aas.txt", the ANSIStyleManager will be applied to the file.  
   #
   # @return [String] The formatted message with placeholders substituted with actual content.
   def to_s
@@ -53,7 +52,7 @@ class Message
 
   private
 
-  # Determines the custom path for message files, if set through the "SCRIPT_CUSTOM_RESOURCES" environment variable.
+  # Determines the custom path for message files, if set through the "SCRIPT_CUSTOM_RESOURCES" environment variable.  
   #
   # @return [String, nil] The custom path for message files, or nil if not set.
   def custom_path
@@ -63,15 +62,15 @@ class Message
     File.join(path, 'messages')
   end
 
-  # Provides the default library path for message files. This path is used as a fallback
-  # when a message file is not found in the custom path.
+  # Provides the default library path for message files.  
+  # This path is used as a fallback when a message file is not found in the custom path.  
   #
   # @return [String] The path to the default library of message files.
   def library_path
     File.join(Resources.library_path, 'messages')
   end
 
-  # Replaces keys found in the original message with their corresponding values.
+  # Replaces keys found in the original message with their corresponding values.  
   #
   # @param message [String] The original message with keys to be replaced.
   # @return [String] The message with keys replaced by their corresponding values.
@@ -87,7 +86,7 @@ class Message
     message
   end
 
-  # Replaces all placeholders in the message with their corresponding values from the @to_replace hash.
+  # Replaces all placeholders in the message with their corresponding values from the @to_replace hash.  
   #
   # @param message [String] The message with placeholders to replace.
   # @return [String] The message with all placeholders replaced with actual content.
@@ -105,8 +104,8 @@ class Message
     message
   end
 
-  # Attempts to recover and return the content of a message file identified by the file_name parameter.
-  # It first looks in the custom path (if defined) and then in the library path.
+  # Attempts to recover and return the content of a message file identified by the file_name parameter.  
+  # It first looks in the custom path (if defined) and then in the library path.  
   #
   # @param file_name [String] The name of the file containing the message content to be recovered.
   # @return [String] The content of the message file, or the file_name itself if the file cannot be found.
@@ -123,8 +122,8 @@ class Message
     file_name
   end
 
-  # Reads and returns the content of a message file located at a specific path.
-  # If the file name have the suffix ".aas.txt", the ANSIStyleManager will be applied to the file.
+  # Reads and returns the content of a message file located at a specific path.  
+  # If the file name have the suffix ".aas.txt", the ANSIStyleManager will be applied to the file.  
   #
   # @param path [String] The path where the message file is located.
   # @param file_name [String] The name of the file to be read.

data/lib/utils/question.rb

@@ -3,9 +3,9 @@
 require_relative 'message'
 require_relative 'array'
 
-# The Question class facilitates the creation and management of interactive questions in the console.
+# The Question class facilitates the creation and management of interactive questions in the console.  
 # It provides methods to validate and return user input as various data types including boolean,
-# float, integer, options (from a list), and string.
+# float, integer, options (from a list), and string.  
 class Question
   # Initializes a new instance of the Question class.
   #
@@ -93,11 +93,11 @@ class Question
     end
   end
 
-  # Reads an index input from the user, ensuring it falls within a specified range.
+  # Reads an index input from the user, ensuring it falls within a specified range.  
   #
   # This method prompts the user to enter an index number. It validates the input to ensure
   # it is an integer within the range of 0 to (count - 1). If the input is invalid, an error
-  # message is displayed, and the user is prompted again.
+  # message is displayed, and the user is prompted again.  
   #
   # @param count [Integer] The count of items, setting the upper limit of the valid index range.
   # @param error_message [String, nil] Custom error message for invalid index inputs.

data/lib/utils/string.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'question'
+require_relative 'message'
+require_relative 'ansi'
+require_relative 'key'
+
+# This class provides additional methods to the standard Ruby String class,
+# allowing for the removal of ANSI codes, and conversion to Key, Question,
+# and Message objects.  
+class String
+  # Removes ANSI escape codes from the string.
+  #
+  # @return [String] a new string with ANSI codes removed.
+  def remove_ansi
+    ANSI.remove_from_string(self)
+  end
+
+  # Converts the string to a Key object.
+  #
+  # @return [Key] a new Key object initialized with the string.
+  def to_key
+    Key.new(self)
+  end
+
+  # Converts the string to a Question object.
+  #
+  # @return [Question] a new Question object initialized with the string.
+  def to_question
+    Question.new(self)
+  end
+
+  # Converts the string to a Message object.
+  #
+  # @param replaces [Hash, nil] optional replacements to be applied in the message.
+  # @return [Message] a new Message object initialized with the string and optional replacements.
+  def to_message(replaces: nil)
+    Message.new(self, replaces: replaces)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mp-utils
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Marcio F Paludo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-10-24 00:00:00.000000000 Z
 dependencies: []
 description: |
   Helpers to facilitate scripts Writing.
@@ -32,9 +32,11 @@ files:
 - lib/utils/ansi_style_manager.rb
 - lib/utils/array.rb
 - lib/utils/constants.rb
+- lib/utils/directory_structure.rb
 - lib/utils/key.rb
 - lib/utils/message.rb
 - lib/utils/question.rb
+- lib/utils/string.rb
 - lib/utils/version_manager.rb
 homepage: https://github.com/MarcioFPaludo/ruby-mp-utils
 licenses:
@@ -42,6 +44,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/MarcioFPaludo/ruby-mp-utils
   source_code_uri: https://github.com/MarcioFPaludo/ruby-mp-utils
+  documentation_uri: https://marciofpaludo.github.io/ruby-mp-utils
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []