mp-utils 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f99dcd4e1535b4b1777fd10c0659634b4687ac24c47ba7a0c2c967f77beb9a3
-  data.tar.gz: c2af79547fa099dba14ffdadb49bcf5892a30fab76f02f98aff3aa048a256336
+  metadata.gz: 472fb772fc669be45aee52e5f931823934e59cb5f36974536dbfea782024ac9d
+  data.tar.gz: 9c5079304a471c97261ec621457575b1b79c9454a8a60f7d19ee9b0a51a7c777
 SHA512:
-  metadata.gz: 0c35d7a60dcf86f0c908c2b9f2380ae4bb41ff5e73d1e42315f919646c77f1471b43ecf679aaece84182922cef639c21f75ce88320f60a94a70ce126b2ddf540
-  data.tar.gz: ff1a0de07a11334ac444eaf9328c482d45b8b7271dd13e9df622fc4528753cf5c0d1a0e556eaab50ee458e24118d3c6ae1a3bb8bf76ab97318c4effb9a4287f4
+  metadata.gz: 79864c2f162bb4d136ae0762d4196c868e0ce4136a31bb873ce79289478734f442acfc18e882d942b53b15e26c570a8b4d18c144f88d1ceae4573c01121583d8
+  data.tar.gz: cd1ed6a8fdb3c724d1953c0df5107468936b5a4800b537097ca32d3f134123c93f39c45ee327a347037e6246fe23600030128fe12f7371034d11bca9fb347204

data/lib/resources/path_helper.rb

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
 # The Resources module manages and provides access to file system paths used by a script or application.
+#
 # It facilitates the definition and retrieval of a default library path, alongside a customizable path
-# that can be set at runtime either programmatically using the {define} method or through the environment
-# variable "SCRIPT_CUSTOM_RESOURCES". This flexibility allows applications to dynamically access resources
-# stored in various locations, depending on execution environment or user-defined settings.
+# that can be set at runtime either programmatically using the {define} method or through the
+# environment variable "SCRIPT_CUSTOM_RESOURCES".
+#
+# This flexibility allows applications to dynamically access resources stored in various locations,
+# depending on execution environment or user-defined settings.
 module Resources
   # Retrieves the path to the directory containing this module, which serves as the default library path.
   #

data/lib/utils/ansi_style_manager.rb

@@ -4,11 +4,81 @@ require_relative 'constants'
 require_relative 'ansi'
 
 # 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 and effects.
 #
-# @example
-#   manager = ANSIStyleManager.new("Hello <color:red>World</color>")
-#   puts manager.to_s # => "Hello \e[31mWorld\e[39m"
+# It can replace tokens in the string with corresponding ANSI codes for colors, backgrounds and 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:
+#
+# | Effect Name   | Description                |
+# |---------------|----------------------------|
+# | bold          | set bold mode.             |
+# | faint         | set dim/faint mode.        |
+# | italic        | set italic mode.           |
+# | underline     | set underline mode.        |
+# | blinking      | set blinking mode.         |
+# | inverse       | set inverse/reverse mode.  |
+# | 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.
+#
+# 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.
+#
+# 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:
+#
+# |Color Type   |Pattern |Description                                                                                  |
+# |-------------|--------|---------------------------------------------------------------------------------------------|
+# |Reset colors |reset   |Resets to the terminal's default color.                                                      |
+# |256 Colors   |number  |Accepts numbers between 0 and 255.                                                           |
+# |RGB Colors   |R;G;B   |R, G, and B accept values between 0 and 255.                                                 |
+# |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.
   attr_reader :string

data/lib/utils/key.rb

@@ -45,10 +45,7 @@ class Key
   def to_regexp
     /#{Regexp.escape(to_s)}/
   end
-end
 
-# Static Methods
-class Key
   # Finds and returns all Key instances within the given string.
   #
   # @param value [#to_s] the string to search for keys.

data/lib/utils/message.rb

@@ -4,11 +4,15 @@ 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 class leverages file-based message templates, allowing for easy localization or 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.
+#
+# The class leverages file-based message templates, allowing for easy localization or
+# 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.
 #
 # @example Creating a new Message instance and formatting it
 #   # Assuming "hellow_world" is a file that says "Hello, world!"
@@ -46,10 +50,7 @@ class Message
     new_message = replace_message_keys(String.new(@message))
     replace_all_to_replace_elements(new_message)
   end
-end
 
-# Private Methods
-class Message
   private
 
   # Determines the custom path for message files, if set through the "SCRIPT_CUSTOM_RESOURCES" environment variable.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mp-utils
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Marcio F Paludo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-30 00:00:00.000000000 Z
+date: 2024-07-02 00:00:00.000000000 Z
 dependencies: []
 description: |
   Helpers to facilitate scripts Writing.