sai 0.3.0 → 0.3.2

data/sig/sai/decorator/named_styles.rbs

@@ -0,0 +1,72 @@
+# Generated from lib/sai/decorator/named_styles.rb with RBS::Inline
+
+module Sai
+  class Decorator
+    # Named style methods for the {Decorator} class
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since 0.3.1
+    #
+    # @abstract This module is meant to be included in the {Decorator} class to provide named style methods
+    # @api private
+    module NamedStyles
+      def blink: () -> Decorator
+
+      def bold: () -> Decorator
+
+      def conceal: () -> Decorator
+
+      def dim: () -> Decorator
+
+      def italic: () -> Decorator
+
+      def no_blink: () -> Decorator
+
+      def no_conceal: () -> Decorator
+
+      def no_italic: () -> Decorator
+
+      def no_reverse: () -> Decorator
+
+      def no_strike: () -> Decorator
+
+      def no_underline: () -> Decorator
+
+      def normal_intensity: () -> Decorator
+
+      def rapid_blink: () -> Decorator
+
+      def reverse: () -> Decorator
+
+      def strike: () -> Decorator
+
+      def underline: () -> Decorator
+
+      private
+
+      # Apply a style to the text
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.1.0
+      #
+      # @api private
+      #
+      # @param style [String, Symbol] the style to apply
+      #
+      # @return [Decorator] a new instance of Decorator with the style applied
+      # @rbs (String | Symbol style) -> Decorator
+      def apply_style: (String | Symbol style) -> Decorator
+
+      # Get style sequences
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.1
+      #
+      # @api private
+      #
+      # @return [Array<String>] ANSI sequences for styles
+      # @rbs () -> Array[String]
+      def style_sequences: () -> Array[String]
+    end
+  end
+end

data/sig/sai/decorator/rgb_colors.rbs

@@ -0,0 +1,52 @@
+# Generated from lib/sai/decorator/rgb_colors.rb with RBS::Inline
+
+module Sai
+  class Decorator
+    # RGB color methods for the {Decorator} class
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since 0.3.1
+    #
+    # @abstract This module is meant to be included in the {Decorator} class to provide RGB color methods
+    # @api private
+    module RGBColors
+      # Apply an RGB color to the background
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.1.0
+      #
+      # @api public
+      #
+      # @example
+      #   decorator.on_rgb(235, 65, 51).decorate('Hello, world!').to_s #=> "\e[48;2;235;65;51mHello, world!\e[0m"
+      #
+      # @param red [Integer] the red component
+      # @param green [Integer] the green component
+      # @param blue [Integer] the blue component
+      #
+      # @raise [ArgumentError] if the RGB values are out of range
+      # @return [Decorator] a new instance of Decorator with the RGB color applied
+      # @rbs (Integer red, Integer green, Integer blue) -> Decorator
+      def on_rgb: (Integer red, Integer green, Integer blue) -> Decorator
+
+      # Apply an RGB color to the foreground
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.1.0
+      #
+      # @api public
+      #
+      # @example
+      #   decorator.rgb(235, 65, 51).decorate('Hello, world!').to_s #=> "\e[38;2;235;65;51mHello, world!\e[0m"
+      #
+      # @param red [Integer] the red component
+      # @param green [Integer] the green component
+      # @param blue [Integer] the blue component
+      #
+      # @raise [ArgumentError] if the RGB values are out of range
+      # @return [Decorator] a new instance of Decorator with the RGB color applied
+      # @rbs (Integer red, Integer green, Integer blue) -> Decorator
+      def rgb: (Integer red, Integer green, Integer blue) -> Decorator
+    end
+  end
+end

data/sig/sai/decorator.rbs

@@ -7,7 +7,28 @@ module Sai
   # @since 0.1.0
   #
   # @api public
+  #
+  # @note For each named color, two methods are dynamically generated:
+  #   * color_name - Applies the color to the foreground
+  #   * on_color_name - Applies the color to the backgroundAll color methods return {Decorator}
+  # @see Sai::NamedColors Sai::NamedColors for available color names
+  #
+  # @example Using a named color
+  #   decorator.azure.decorate('Hello')      #=> "\e[38;2;0;127;255mHello\e[0m"
+  #   decorator.on_azure.decorate('Hello')   #=> "\e[48;2;0;127;255mHello\e[0m"
   class Decorator
+    include ColorManipulations
+
+    include Gradients
+
+    include HexColors
+
+    include NamedColors
+
+    include NamedStyles
+
+    include RGBColors
+
     # Initialize a new instance of Decorator
     #
     # @author {https://aaronmallen.me Aaron Allen}
@@ -21,102 +42,6 @@ module Sai
     # @rbs (?mode: Integer) -> void
     def initialize: (?mode: Integer) -> void
 
-    def black: () -> Decorator
-
-    def blue: () -> Decorator
-
-    def bright_black: () -> Decorator
-
-    def bright_blue: () -> Decorator
-
-    def bright_cyan: () -> Decorator
-
-    def bright_green: () -> Decorator
-
-    def bright_magenta: () -> Decorator
-
-    def bright_red: () -> Decorator
-
-    def bright_white: () -> Decorator
-
-    def bright_yellow: () -> Decorator
-
-    def cyan: () -> Decorator
-
-    def green: () -> Decorator
-
-    def magenta: () -> Decorator
-
-    def on_black: () -> Decorator
-
-    def on_blue: () -> Decorator
-
-    def on_bright_black: () -> Decorator
-
-    def on_bright_blue: () -> Decorator
-
-    def on_bright_cyan: () -> Decorator
-
-    def on_bright_green: () -> Decorator
-
-    def on_bright_magenta: () -> Decorator
-
-    def on_bright_red: () -> Decorator
-
-    def on_bright_white: () -> Decorator
-
-    def on_bright_yellow: () -> Decorator
-
-    def on_cyan: () -> Decorator
-
-    def on_green: () -> Decorator
-
-    def on_magenta: () -> Decorator
-
-    def on_red: () -> Decorator
-
-    def on_white: () -> Decorator
-
-    def on_yellow: () -> Decorator
-
-    def red: () -> Decorator
-
-    def white: () -> Decorator
-
-    def yellow: () -> Decorator
-
-    def blink: () -> Decorator
-
-    def bold: () -> Decorator
-
-    def conceal: () -> Decorator
-
-    def dim: () -> Decorator
-
-    def italic: () -> Decorator
-
-    def no_blink: () -> Decorator
-
-    def no_conceal: () -> Decorator
-
-    def no_italic: () -> Decorator
-
-    def no_reverse: () -> Decorator
-
-    def no_strike: () -> Decorator
-
-    def no_underline: () -> Decorator
-
-    def normal_intensity: () -> Decorator
-
-    def rapid_blink: () -> Decorator
-
-    def reverse: () -> Decorator
-
-    def strike: () -> Decorator
-
-    def underline: () -> Decorator
-
     # Apply the styles and colors to the text
     #
     # @author {https://aaronmallen.me Aaron Allen}
@@ -139,78 +64,6 @@ module Sai
 
     alias encode decorate
 
-    # Apply a hexadecimal color to the foreground
-    #
-    # @author {https://aaronmallen.me Aaron Allen}
-    # @since 0.1.0
-    #
-    # @api public
-    #
-    # @example
-    #   decorator.hex("#EB4133").decorate('Hello, world!').to_s #=> "\e[38;2;235;65;51mHello, world!\e[0m"
-    #
-    # @param code [String] the hex color code
-    #
-    # @raise [ArgumentError] if the hex code is invalid
-    # @return [Decorator] a new instance of Decorator with the hex color applied
-    # @rbs (String code) -> Decorator
-    def hex: (String code) -> Decorator
-
-    # Apply a hexadecimal color to the background
-    #
-    # @author {https://aaronmallen.me Aaron Allen}
-    # @since 0.1.0
-    #
-    # @api public
-    #
-    # @example
-    #   decorator.on_hex("#EB4133").decorate('Hello, world!').to_s #=> "\e[48;2;235;65;51mHello, world!\e[0m"
-    #
-    # @param code [String] the hex color code
-    #
-    # @raise [ArgumentError] if the hex code is invalid
-    # @return [Decorator] a new instance of Decorator with the hex color applied
-    # @rbs (String code) -> Decorator
-    def on_hex: (String code) -> Decorator
-
-    # Apply an RGB color to the background
-    #
-    # @author {https://aaronmallen.me Aaron Allen}
-    # @since 0.1.0
-    #
-    # @api public
-    #
-    # @example
-    #   decorator.on_rgb(235, 65, 51).decorate('Hello, world!').to_s #=> "\e[48;2;235;65;51mHello, world!\e[0m"
-    #
-    # @param red [Integer] the red component
-    # @param green [Integer] the green component
-    # @param blue [Integer] the blue component
-    #
-    # @raise [ArgumentError] if the RGB values are out of range
-    # @return [Decorator] a new instance of Decorator with the RGB color applied
-    # @rbs (Integer red, Integer green, Integer blue) -> Decorator
-    def on_rgb: (Integer red, Integer green, Integer blue) -> Decorator
-
-    # Apply an RGB color to the foreground
-    #
-    # @author {https://aaronmallen.me Aaron Allen}
-    # @since 0.1.0
-    #
-    # @api public
-    #
-    # @example
-    #   decorator.rgb(235, 65, 51).decorate('Hello, world!').to_s #=> "\e[38;2;235;65;51mHello, world!\e[0m"
-    #
-    # @param red [Integer] the red component
-    # @param green [Integer] the green component
-    # @param blue [Integer] the blue component
-    #
-    # @raise [ArgumentError] if the RGB values are out of range
-    # @return [Decorator] a new instance of Decorator with the RGB color applied
-    # @rbs (Integer red, Integer green, Integer blue) -> Decorator
-    def rgb: (Integer red, Integer green, Integer blue) -> Decorator
-
     # Apply a specific color mode to the decorator
     #
     # @author {https://aaronmallen.me Aaron Allen}
@@ -229,33 +82,6 @@ module Sai
 
     private
 
-    # Apply a named color to the specified style type
-    #
-    # @author {https://aaronmallen.me Aaron Allen}
-    # @since 0.1.0
-    #
-    # @api private
-    #
-    # @param style_type [Symbol] the style type to apply the color to
-    # @param color [Symbol] the color to apply
-    #
-    # @return [Decorator] a new instance of Decorator with the color applied
-    # @rbs (Conversion::ColorSequence::style_type style_type, Symbol color) -> Decorator
-    def apply_named_color: (Conversion::ColorSequence::style_type style_type, Symbol color) -> Decorator
-
-    # Apply a style to the text
-    #
-    # @author {https://aaronmallen.me Aaron Allen}
-    # @since 0.1.0
-    #
-    # @api private
-    #
-    # @param style [String, Symbol] the style to apply
-    #
-    # @return [Decorator] a new instance of Decorator with the style applied
-    # @rbs (String | Symbol style) -> self
-    def apply_style: (String | Symbol style) -> self
-
     # Check if text should be decorated
     #
     # @author {https://aaronmallen.me Aaron Allen}

data/sig/sai/named_colors.rbs

@@ -0,0 +1,127 @@
+# Generated from lib/sai/named_colors.rb with RBS::Inline
+
+module Sai
+  # A collection of named colors and their RGB values
+  #
+  # @author {https://aaronmallen.me Aaron Allen}
+  # @since 0.3.1
+  #
+  # @api private
+  module NamedColors
+    # Standard ANSI color names and their RGB values
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since 0.3.1
+    #
+    # @api private
+    #
+    # @return [Hash{Symbol => Array<Integer>}] the color names and RGB values
+    ANSI: untyped
+
+    # CSS color names and their RGB values
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since 0.3.1
+    #
+    # @api private
+    #
+    # @return [Hash{Symbol => Array<Integer>}] the color names and RGB values
+    CSS: Hash[Symbol, Array[Integer]]
+
+    # XTERM color names and their RGB values
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since 0.3.1
+    #
+    # @api private
+    #
+    # @return [Hash{Symbol => Array<Integer>}] the color names and RGB values
+    # rubocop:disable Naming/VariableNumber
+    XTERM: Hash[Symbol, Array[Integer]]
+
+    # Look up an RGB value by color name
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since 0.3.1
+    #
+    # @api private
+    #
+    # @param name [String, Symbol] the color name
+    #
+    # @return [Array<Integer>] the RGB value
+    # @rbs (String | Symbol name) -> Array[Integer]?
+    def self.[]: (String | Symbol name) -> Array[Integer]?
+
+    # Get a list of all color names
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since 0.3.1
+    #
+    # @api private
+    #
+    # @return [Array<Symbol>] the color names
+    def self.names: () -> untyped
+
+    # Register a named color with an RGB or Hexadecimal value
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since 0.3.2
+    #
+    # @api private
+    #
+    # @param name [String, Symbol] the name of the color being registered
+    # @param rgb_or_hex [Array<Integer>, String] the RGB or Hexadecimal value of the color
+    #
+    # @return [Boolean] `true` if the color was registered
+    # @rbs (String | Symbol name, Array[Integer] | String rgb_or_hex) -> void
+    def self.register: (String | Symbol name, Array[Integer] | String rgb_or_hex) -> void
+
+    # Install the color methods onto {Sai} and {Sai::Decorator}
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since 0.3.2
+    #
+    # @api private
+    #
+    # @param name [Symbol] the name of the color to install
+    #
+    # @return [void]
+    # @rbs (Symbol name) -> void
+    private def self.install_color: (Symbol name) -> void
+
+    # Provision a color for the registry
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since 0.3.2
+    #
+    # @api private
+    #
+    # @param name [Symbol] the name of the color to register
+    # @param rgb_or_hex [Array<Integer>, String] the RGB or Hexadecimal value of the color
+    #
+    # @return [void]
+    # @rbs (Symbol name, Array[Integer] | String rgb_or_hex) -> void
+    private def self.provision_color: (Symbol name, Array[Integer] | String rgb_or_hex) -> void
+
+    # The Sai named colors registry
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since 0.3.2
+    #
+    # @api private
+    #
+    # @return [Hash{Symbol => Array<Integer>}] the named colors registry
+    private def self.registry: () -> untyped
+
+    # A Mutex for thread safety
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since 0.3.2
+    #
+    # @api private
+    #
+    # @return [Mutex] the thread lock
+    # @rbs () -> Mutex
+    private def self.thread_lock: () -> Mutex
+  end
+end