sai 0.1.0

data/sig/sai/conversion/rgb.rbs

@@ -0,0 +1,243 @@
+# Generated from lib/sai/conversion/rgb.rb with RBS::Inline
+
+module Sai
+  module Conversion
+    # RGB color conversion utilities
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api private
+    module RGB
+      # Get closest ANSI color for RGB values
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @param red [Float] the red component (0-1)
+      # @param green [Float] the green component (0-1)
+      # @param blue [Float] the blue component (0-1)
+      #
+      # @return [Symbol] the closest ANSI color name
+      # @rbs (Float red, Float green, Float blue) -> Symbol
+      def self.closest_ansi_color: (Float red, Float green, Float blue) -> Symbol
+
+      # Determine if a color is dark
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @param red [Float] the red component (0-1)
+      # @param green [Float] the green component (0-1)
+      # @param blue [Float] the blue component (0-1)
+      #
+      # @return [Boolean] true if color is dark
+      # @rbs (Float red, Float green, Float blue) -> bool
+      def self.dark?: (Float red, Float green, Float blue) -> bool
+
+      # Determine if a color is grayscale
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @param red [Float] the red component (0-1)
+      # @param green [Float] the green component (0-1)
+      # @param blue [Float] the blue component (0-1)
+      #
+      # @return [Boolean] true if color is grayscale
+      # @rbs (Float red, Float green, Float blue) -> bool
+      def self.grayscale?: (Float red, Float green, Float blue) -> bool
+
+      # Convert a color value to RGB components
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @param color [String, Array<Integer>] the color to convert
+      #
+      # @raise [ArgumentError] if the color format is invalid
+      # @return [Array<Integer>] the RGB components
+      # @rbs (Array[Integer] | String | Symbol color) -> Array[Integer]
+      def self.resolve: (Array[Integer] | String | Symbol color) -> Array[Integer]
+
+      # Convert RGB values to 256-color cube index
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @param rgb [Array<Integer>] RGB values (0-255)
+      #
+      # @return [Integer] the color cube index
+      # @rbs (Array[Integer] rgb) -> Integer
+      def self.to_color_cube_index: (Array[Integer] rgb) -> Integer
+
+      # Convert RGB values to grayscale index
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @param rgb [Array<Integer>] RGB values
+      #
+      # @return [Integer] the grayscale index
+      # @rbs (Array[Integer] rgb) -> Integer
+      def self.to_grayscale_index: (Array[Integer] rgb) -> Integer
+
+      # Check if RGB values represent cyan
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @param red [Float] the red component (0-1)
+      # @param green [Float] the green component (0-1)
+      # @param blue [Float] the blue component (0-1)
+      #
+      # @return [Boolean] true if color is cyan
+      # @rbs (Float red, Float green, Float blue) -> bool
+      private def self.cyan?: (Float red, Float green, Float blue) -> bool
+
+      # Convert a hex string to RGB values
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @param hex [String] the hex color code
+      #
+      # @return [Array<Integer>] the RGB components
+      # @rbs (String hex) -> Array[Integer]
+      private def self.hex_to_rgb: (String hex) -> Array[Integer]
+
+      # Check if RGB values represent magenta
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @param red [Float] the red component (0-1)
+      # @param green [Float] the green component (0-1)
+      # @param blue [Float] the blue component (0-1)
+      #
+      # @return [Boolean] true if color is magenta
+      # @rbs (Float red, Float green, Float blue) -> bool
+      private def self.magenta?: (Float red, Float green, Float blue) -> bool
+
+      # Convert a named color to RGB values
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @param color_name [String] the color name
+      #
+      # @raise [ArgumentError] if the color name is unknown
+      # @return [Array<Integer>] the RGB components
+      # @rbs (String color_name) -> Array[Integer]
+      private def self.named_to_rgb: (String color_name) -> Array[Integer]
+
+      # Determine if RGB values represent a primary color
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @param red [Float] the red component (0-1)
+      # @param green [Float] the green component (0-1)
+      # @param blue [Float] the blue component (0-1)
+      #
+      # @return [Boolean] true if color is primary
+      # @rbs (Float red, Float green, Float blue) -> bool
+      private def self.primary?: (Float red, Float green, Float blue) -> bool
+
+      # Get the closest primary color
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @param red [Float] the red component (0-1)
+      # @param green [Float] the green component (0-1)
+      # @param blue [Float] the blue component (0-1)
+      #
+      # @return [Symbol] the primary color name
+      # @rbs (Float red, Float green, Float blue) -> Symbol
+      private def self.primary_color: (Float red, Float green, Float blue) -> Symbol
+
+      # Determine if RGB values represent a secondary color
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @param red [Float] the red component (0-1)
+      # @param green [Float] the green component (0-1)
+      # @param blue [Float] the blue component (0-1)
+      #
+      # @return [Boolean] true if color is secondary
+      # @rbs (Float red, Float green, Float blue) -> bool
+      private def self.secondary?: (Float red, Float green, Float blue) -> bool
+
+      # Get the closest secondary color
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @param red [Float] the red component (0-1)
+      # @param green [Float] the green component (0-1)
+      # @param blue [Float] the blue component (0-1)
+      #
+      # @return [Symbol] the secondary color name
+      # @rbs (Float red, Float green, Float blue) -> Symbol
+      private def self.secondary_color: (Float red, Float green, Float blue) -> Symbol
+
+      # Validate RGB values
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @param color [Array<Integer>] the RGB components to validate
+      # @return [Array<Integer>] the validated RGB components
+      # @raise [ArgumentError] if the RGB values are invalid
+      # @rbs (Array[Integer] color) -> Array[Integer]
+      private def self.validate_rgb: (Array[Integer] color) -> Array[Integer]
+
+      # Check if RGB values represent yellow
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @param red [Float] the red component (0-1)
+      # @param green [Float] the green component (0-1)
+      # @param blue [Float] the blue component (0-1)
+      #
+      # @return [Boolean] true if color is yellow
+      # @rbs (Float red, Float green, Float blue) -> bool
+      private def self.yellow?: (Float red, Float green, Float blue) -> bool
+    end
+  end
+end

data/sig/sai/decorator.rbs

@@ -0,0 +1,246 @@
+# Generated from lib/sai/decorator.rb with RBS::Inline
+
+module Sai
+  # A decorator for applying ANSI styles and colors to text
+  #
+  # @author {https://aaronmallen.me Aaron Allen}
+  # @since unreleased
+  #
+  # @api public
+  class Decorator
+    # Initialize a new instance of Decorator
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api private
+    #
+    # @param color_mode [Integer] the color mode to use
+    #
+    # @return [Decorator] the new instance of Decorator
+    # @rbs (Integer color_mode) -> void
+    def initialize: (Integer color_mode) -> void
+
+    def black: () -> self
+
+    def blue: () -> self
+
+    def bright_black: () -> self
+
+    def bright_blue: () -> self
+
+    def bright_cyan: () -> self
+
+    def bright_green: () -> self
+
+    def bright_magenta: () -> self
+
+    def bright_red: () -> self
+
+    def bright_white: () -> self
+
+    def bright_yellow: () -> self
+
+    def cyan: () -> self
+
+    def green: () -> self
+
+    def magenta: () -> self
+
+    def on_black: () -> self
+
+    def on_blue: () -> self
+
+    def on_bright_black: () -> self
+
+    def on_bright_blue: () -> self
+
+    def on_bright_cyan: () -> self
+
+    def on_bright_green: () -> self
+
+    def on_bright_magenta: () -> self
+
+    def on_bright_red: () -> self
+
+    def on_bright_white: () -> self
+
+    def on_bright_yellow: () -> self
+
+    def on_cyan: () -> self
+
+    def on_green: () -> self
+
+    def on_magenta: () -> self
+
+    def on_red: () -> self
+
+    def on_white: () -> self
+
+    def on_yellow: () -> self
+
+    def red: () -> self
+
+    def white: () -> self
+
+    def yellow: () -> self
+
+    def blink: () -> self
+
+    def bold: () -> self
+
+    def conceal: () -> self
+
+    def dim: () -> self
+
+    def italic: () -> self
+
+    def no_blink: () -> self
+
+    def no_conceal: () -> self
+
+    def no_italic: () -> self
+
+    def no_reverse: () -> self
+
+    def no_strike: () -> self
+
+    def no_underline: () -> self
+
+    def normal_intensity: () -> self
+
+    def rapid_blink: () -> self
+
+    def reverse: () -> self
+
+    def strike: () -> self
+
+    def underline: () -> self
+
+    # Apply the styles and colors to the text
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api public
+    #
+    # @example
+    #   decorator.red.on_blue.bold.decorate('Hello, world!')
+    #   #=> "\e[38;2;205;0;0m\e[48;2;0;0;238m\e[1mHello, world!\e[0m"
+    #
+    # @param text [String] the text to decorate
+    #
+    # @return [String] the decorated text
+    # @rbs (String text) -> String
+    def decorate: (String text) -> String
+
+    alias apply decorate
+
+    alias call decorate
+
+    alias encode decorate
+
+    # Apply a hexadecimal color to the foreground
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api public
+    #
+    # @example
+    #   decorator.hex("#EB4133").decorate('Hello, world!') #=> "\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 [self] the instance of Decorator for chaining
+    # @rbs (String code) -> self
+    def hex: (String code) -> self
+
+    # Apply a hexadecimal color to the background
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api public
+    #
+    # @example
+    #   decorator.on_hex("#EB4133").decorate('Hello, world!') #=> "\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 [self] the instance of Decorator for chaining
+    # @rbs (String code) -> self
+    def on_hex: (String code) -> self
+
+    # Apply an RGB color to the background
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api public
+    #
+    # @example
+    #   decorator.on_rgb(235, 65, 51).decorate('Hello, world!') #=> "\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 [self] the instance of Decorator for chaining
+    # @rbs (Integer red, Integer green, Integer blue) -> self
+    def on_rgb: (Integer red, Integer green, Integer blue) -> self
+
+    # Apply an RGB color to the foreground
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api public
+    #
+    # @example
+    #   decorator.rgb(235, 65, 51).decorate('Hello, world!') #=> "\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 [self] the instance of Decorator for chaining
+    # @rbs (Integer red, Integer green, Integer blue) -> self
+    def rgb: (Integer red, Integer green, Integer blue) -> self
+
+    private
+
+    # Apply a named color to the specified style type
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api private
+    #
+    # @param style_type [Symbol] the style type to apply the color to
+    # @param color [Symbol] the color to apply
+    #
+    # @raise [ArgumentError] if the color is invalid
+    # @return [self] the instance of Decorator for chaining
+    # @rbs (Conversion::ColorSequence::style_type style_type, Symbol color) -> self
+    def apply_named_color: (Conversion::ColorSequence::style_type style_type, Symbol color) -> self
+
+    # Apply a style to the text
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api private
+    #
+    # @param style [String, Symbol] the style to apply
+    #
+    # @raise [ArgumentError] if the style is invalid
+    # @return [self] the instance of Decorator for chaining
+    # @rbs (String | Symbol style) -> self
+    def apply_style: (String | Symbol style) -> self
+  end
+end

data/sig/sai/support.rbs

@@ -0,0 +1,108 @@
+# Generated from lib/sai/support.rb with RBS::Inline
+
+module Sai
+  # Determine the color capabilities of the terminal
+  #
+  # @author {https://aaronmallen.me Aaron Allen}
+  # @since unreleased
+  #
+  # @api public
+  class Support
+    # Initialize a new instance of Support
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api private
+    #
+    # @param color_mode [Integer] the color mode
+    #
+    # @return [Support] the new instance of support
+    # @rbs (Integer color_mode) -> void
+    def initialize: (Integer color_mode) -> void
+
+    # Check if the terminal supports ANSI colors (4-bit)
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api public
+    #
+    # @example Check if the terminal supports ANSI colors
+    #   Sai.ansi? # => true
+    #
+    # @return [Boolean] `true` if the terminal supports ANSI colors (4-bit), otherwise `false`
+    # @rbs () -> bool
+    def ansi?: () -> bool
+
+    alias bit4? ansi?
+
+    alias four_bit? ansi?
+
+    # Check if the terminal supports basic colors (3-bit)
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api public
+    #
+    # @example Check if the terminal supports basic colors
+    #   Sai.basic? # => true
+    #
+    # @return [Boolean] `true` if the terminal supports basic colors (3-bit), otherwise `false`
+    # @rbs () -> bool
+    def basic?: () -> bool
+
+    alias bit3? basic?
+
+    alias three_bit? basic?
+
+    # Check if the terminal supports 256 colors (8-bit)
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api public
+    #
+    # @example Check if the terminal supports 256 colors
+    #   Sai.bit_8? # => true
+    #
+    # @return [Boolean] `true` if the terminal supports 256 colors (8-bit), otherwise `false`
+    # @rbs () -> bool
+    def bit8?: () -> bool
+
+    alias eight_bit? bit8?
+
+    # Check if the terminal supports color output
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api public
+    #
+    # @example Check if the terminal supports color
+    #   Sai.color? # => true
+    #
+    # @return [Boolean] `true` if the terminal supports color output, otherwise `false`
+    # @rbs () -> bool
+    def color?: () -> bool
+
+    # Check if the terminal supports true color (24-bit)
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api public
+    #
+    # @example Check if the terminal supports true color
+    #   Sai.true_color? # => true
+    #
+    # @return [Boolean] `true` if the terminal supports true color (24-bit), otherwise `false`
+    # @rbs () -> bool
+    def true_color?: () -> bool
+
+    alias bit24? true_color?
+
+    alias twenty_four_bit? true_color?
+  end
+end

data/sig/sai/terminal/capabilities.rbs

@@ -0,0 +1,81 @@
+# Generated from lib/sai/terminal/capabilities.rb with RBS::Inline
+
+module Sai
+  module Terminal
+    # Detect the color capabilities of the terminal
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api private
+    module Capabilities
+      # Detect the color capabilities of the current terminal
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @return [Integer] the {ColorMode} of the terminal
+      # @rbs () -> Integer
+      def self.detect_color_support: () -> Integer
+
+      # Check for ANSI color support
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @return [Boolean] `true` if the terminal supports basic ANSI colors, otherwise `false`
+      # @rbs () -> bool
+      private def self.ansi?: () -> bool
+
+      # Check for basic color support
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @return [Boolean] `true` if the terminal supports basic colors, otherwise `false`
+      # @rbs () -> bool
+      private def self.basic?: () -> bool
+
+      # Check for 256 color (8-bit) support
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @return [Boolean] `true` if the terminal supports 256 colors, otherwise `false`
+      # @rbs () -> bool
+      private def self.bit8?: () -> bool
+
+      # Check for NO_COLOR environment variable
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @see https://no-color.org
+      #
+      # @return [Boolean] `true` if the NO_COLOR environment variable is set, otherwise `false`
+      # @rbs () -> bool
+      private def self.no_color?: () -> bool
+
+      # Check for true color (24-bit) support
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @return [Boolean] `true` if the terminal supports true color, otherwise `false`
+      # @rbs () -> bool
+      private def self.true_color?: () -> bool
+    end
+  end
+end