sai 0.3.0 → 0.3.1

data/sig/sai/ansi/color_parser.rbs

@@ -0,0 +1,77 @@
+# Generated from lib/sai/ansi/color_parser.rb with RBS::Inline
+
+module Sai
+  module ANSI
+    # Handles parsing of ANSI color codes
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since 0.3.1
+    #
+    # @api private
+    class ColorParser
+      # The current segment being processed
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.1
+      #
+      # @api private
+      #
+      # @return [Hash] the current segment being processed
+      attr_reader segment: Hash[Symbol, untyped]
+
+      # Initialize a new instance of ColorParser
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.1
+      #
+      # @api private
+      #
+      # @param segment [Hash] the segment to update
+      #
+      # @return [ColorParser] the new instance of ColorParser
+      # @rbs (Hash[Symbol, untyped] segment) -> void
+      def initialize: (Hash[Symbol, untyped] segment) -> void
+
+      # Parse a 256-color code
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.1
+      #
+      # @api private
+      #
+      # @param codes [Array<Integer>] array of color codes
+      # @param index [Integer] current position in array
+      #
+      # @return [Integer] new position in array
+      # @rbs (Array[Integer] codes, Integer index) -> Integer
+      def parse256: (Array[Integer] codes, Integer index) -> Integer
+
+      # Parse a 24-bit color code
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.1
+      #
+      # @api private
+      #
+      # @param codes [Array<Integer>] array of color codes
+      # @param index [Integer] current position in array
+      #
+      # @return [Integer] new position in array
+      # @rbs (Array[Integer] codes, Integer index) -> Integer
+      def parse_24bit: (Array[Integer] codes, Integer index) -> Integer
+
+      # Parse a basic color code
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.1
+      #
+      # @api private
+      #
+      # @param code [Integer] the color code
+      #
+      # @return [void]
+      # @rbs (Integer code) -> void
+      def parse_basic: (Integer code) -> void
+    end
+  end
+end

data/sig/sai/ansi/sequence_processor.rbs

@@ -19,16 +19,6 @@ module Sai
       # @return [Regexp] the pattern
       SEQUENCE_PATTERN: Regexp
 
-      # Matches the code portion of style sequences
-      #
-      # @author {https://aaronmallen.me Aaron Allen}
-      # @since 0.3.0
-      #
-      # @api private
-      #
-      # @return [Regexp] the pattern
-      STYLE_CODE_PATTERN: Regexp
-
       # Initialize a new instance of SequenceProcessor and parse the provided string
       #
       # @author {https://aaronmallen.me Aaron Allen}
@@ -68,34 +58,6 @@ module Sai
 
       private
 
-      # Applies 24-bit truecolor (e.g., 38;2;R;G;B or 48;2;R;G;B)
-      #
-      # @author {https://aaronmallen.me Aaron Allen}
-      # @since 0.3.0
-      #
-      # @api private
-      #
-      # @param codes_array [Array<Integer>]
-      # @param index [Integer]
-      #
-      # @return [Integer] the updated index (consumed 5 codes)
-      # @rbs (Array[Integer] codes_array, Integer index) -> Integer
-      def apply_24bit_color: (Array[Integer] codes_array, Integer index) -> Integer
-
-      # Applies 256-color mode (e.g., 38;5;160 or 48;5;21)
-      #
-      # @author {https://aaronmallen.me Aaron Allen}
-      # @since 0.3.0
-      #
-      # @api private
-      #
-      # @param codes_array [Array<Integer>]
-      # @param index [Integer]
-      #
-      # @return [Integer] the updated index (consumed 3 codes)
-      # @rbs (Array[Integer] codes_array, Integer index) -> Integer
-      def apply_256_color: (Array[Integer] codes_array, Integer index) -> Integer
-
       # Applies the appropriate action for the provided ANSI sequence
       #
       # @author {https://aaronmallen.me Aaron Allen}
@@ -109,19 +71,6 @@ module Sai
       # @rbs (String sequence) -> void
       def apply_ansi_sequence: (String sequence) -> void
 
-      # Applies a basic color (FG or BG) in the range 30..37 (FG) or 40..47 (BG)
-      #
-      # @author {https://aaronmallen.me Aaron Allen}
-      # @since 0.3.0
-      #
-      # @api private
-      #
-      # @param code [Integer] the numeric color code
-      #
-      # @return [void]
-      # @rbs (Integer code) -> void
-      def apply_basic_color: (Integer code) -> void
-
       # Parse all numeric codes in the provided string, applying them in order (just like a real ANSI terminal)
       #
       # @author {https://aaronmallen.me Aaron Allen}
@@ -154,30 +103,6 @@ module Sai
       # @rbs (Array[Integer] codes_array, Integer index) -> Integer
       def apply_single_code: (Array[Integer] codes_array, Integer index) -> Integer
 
-      # Applies a single style code (e.g. 1=bold, 2=dim, 4=underline, etc.) if it matches
-      #
-      # @author {https://aaronmallen.me Aaron Allen}
-      # @since 0.3.0
-      #
-      # @api private
-      #
-      # @param code [Integer] the numeric code to check
-      #
-      # @return [void]
-      # @rbs (Integer code) -> void
-      def apply_style_code: (Integer code) -> void
-
-      # Creates and returns a fresh, blank segment
-      #
-      # @author {https://aaronmallen.me Aaron Allen}
-      # @since 0.3.0
-      #
-      # @api private
-      #
-      # @return [Hash{Symbol => Object}] a new, empty segment
-      # @rbs () -> Hash[Symbol, untyped]
-      def blank_segment: () -> Hash[Symbol, untyped]
-
       # Scans the string for ANSI sequences or individual characters
       #
       # @author {https://aaronmallen.me Aaron Allen}

data/sig/sai/ansi/style_parser.rbs

@@ -0,0 +1,59 @@
+# Generated from lib/sai/ansi/style_parser.rb with RBS::Inline
+
+module Sai
+  module ANSI
+    # Handles parsing of ANSI style codes
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since 0.3.1
+    #
+    # @api private
+    class StyleParser
+      # Matches the code portion of style sequences
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.1
+      #
+      # @api private
+      #
+      # @return [Regexp] the pattern
+      STYLE_CODE_PATTERN: Regexp
+
+      # The current segment being processed
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.1
+      #
+      # @api private
+      #
+      # @return [Hash] the current segment being processed
+      attr_reader segment: Hash[Symbol, untyped]
+
+      # Initialize a new instance of StyleParser
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.1
+      #
+      # @api private
+      #
+      # @param segment [Hash] the segment to update
+      #
+      # @return [StyleParser] the new instance of StyleParser
+      # @rbs (Hash[Symbol, untyped] segment) -> void
+      def initialize: (Hash[Symbol, untyped] segment) -> void
+
+      # Parse a style code
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.1
+      #
+      # @api private
+      #
+      # @param code [Integer] the style code
+      #
+      # @return [void]
+      # @rbs (Integer code) -> void
+      def parse: (Integer code) -> void
+    end
+  end
+end

data/sig/sai/ansi.rbs

@@ -18,16 +18,6 @@ module Sai
     # @return [Hash{Symbol => Integer}] the color codes
     COLOR_CODES: untyped
 
-    # Standard ANSI color names and their RGB values
-    #
-    # @author {https://aaronmallen.me Aaron Allen}
-    # @since 0.1.0
-    #
-    # @api private
-    #
-    # @return [Hash{Symbol => Array<Integer>}] the color names and RGB values
-    COLOR_NAMES: untyped
-
     # ANSI escape sequence for resetting text formatting
     #
     # @author {https://aaronmallen.me Aaron Allen}

data/sig/sai/conversion/rgb/color_classifier.rbs

@@ -0,0 +1,165 @@
+# Generated from lib/sai/conversion/rgb/color_classifier.rb with RBS::Inline
+
+module Sai
+  module Conversion
+    module RGB
+      # Classify color characteristics
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.1
+      #
+      # @api private
+      module ColorClassifier
+        # Get closest ANSI color for RGB values
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.1.0
+        #
+        # @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 0.1.0
+        #
+        # @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 0.1.0
+        #
+        # @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
+
+        # Determine if RGB values represent a primary color
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.1.0
+        #
+        # @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
+        def self.primary?: (Float red, Float green, Float blue) -> bool
+
+        # Get the closest primary color
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.1.0
+        #
+        # @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
+        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 0.1.0
+        #
+        # @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
+        def self.secondary?: (Float red, Float green, Float blue) -> bool
+
+        # Get the closest secondary color
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.1.0
+        #
+        # @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
+        def self.secondary_color: (Float red, Float green, Float blue) -> Symbol
+
+        # Check if RGB values represent cyan
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.1.0
+        #
+        # @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
+
+        # Check if RGB values represent magenta
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.1.0
+        #
+        # @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
+
+        # Check if RGB values represent yellow
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.1.0
+        #
+        # @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
+end

data/sig/sai/conversion/rgb/color_indexer.rbs

@@ -0,0 +1,41 @@
+# Generated from lib/sai/conversion/rgb/color_indexer.rb with RBS::Inline
+
+module Sai
+  module Conversion
+    module RGB
+      # Color indexing utilities
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.1
+      #
+      # @api private
+      module ColorIndexer
+        # Convert RGB values to 256-color cube index
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.1.0
+        #
+        # @api private
+        #
+        # @param rgb [Array<Integer>] RGB values (0-255)
+        #
+        # @return [Integer] the color cube index
+        # @rbs (Array[Integer] rgb) -> Integer
+        def self.color_cube: (Array[Integer] rgb) -> Integer
+
+        # Convert RGB values to grayscale index
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.1.0
+        #
+        # @api private
+        #
+        # @param rgb [Array<Integer>] RGB values
+        #
+        # @return [Integer] the grayscale index
+        # @rbs (Array[Integer] rgb) -> Integer
+        def self.grayscale: (Array[Integer] rgb) -> Integer
+      end
+    end
+  end
+end

data/sig/sai/conversion/rgb/color_space.rbs

@@ -0,0 +1,129 @@
+# Generated from lib/sai/conversion/rgb/color_space.rb with RBS::Inline
+
+module Sai
+  module Conversion
+    module RGB
+      # Convert colors between different color space formats
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.1
+      #
+      # @api private
+      module ColorSpace
+        # Convert HSV values to RGB
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.3.1
+        #
+        # @api private
+        #
+        # @param hue [Float] the hue component (0-360)
+        # @param saturation [Float] the saturation component (0-1)
+        # @param value [Float] the value component (0-1)
+        #
+        # @return [Array<Integer>] the RGB values
+        # @rbs (Float hue, Float saturation, Float value) -> Array[Integer]
+        def self.hsv_to_rgb: (Float hue, Float saturation, Float value) -> Array[Integer]
+
+        # Convert a color value to RGB components
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.1.0
+        #
+        # @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]
+
+        # Calculate the intermediate HSV components
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.3.1
+        #
+        # @api private
+        #
+        # @param value [Float] the value component
+        # @param saturation [Float] the saturation component
+        # @param hue_remainder [Float] the remainder of hue / 60
+        #
+        # @return [Array<Float>] the primary, secondary, and tertiary components
+        # @rbs (Float value, Float saturation, Float hue_remainder) -> [Float, Float, Float]
+        private def self.calculate_hsv_components: (Float value, Float saturation, Float hue_remainder) -> [ Float, Float, Float ]
+
+        # Convert a hex string to RGB values
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.1.0
+        #
+        # @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]
+
+        # Convert a named color to RGB values
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.1.0
+        #
+        # @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]
+
+        # Convert RGB values from 0-1 range to 0-255 range
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.3.1
+        #
+        # @api private
+        #
+        # @param rgb [Array<Float>] RGB values in 0-1 range
+        #
+        # @return [Array<Integer>] RGB values in 0-255 range
+        # @rbs (Array[Float] rgb) -> Array[Integer]
+        private def self.normalize_rgb: (Array[Float] rgb) -> Array[Integer]
+
+        # Select RGB values based on the hue sector
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.3.1
+        #
+        # @api private
+        #
+        # @param sector [Integer] the hue sector (0-5)
+        # @param value [Float] the value component
+        # @param primary [Float] primary component from HSV calculation
+        # @param secondary [Float] secondary component from HSV calculation
+        # @param tertiary [Float] tertiary component from HSV calculation
+        #
+        # @return [Array<Float>] the RGB values before normalization
+        # @rbs (Integer sector, Float value, Float primary, Float secondary, Float tertiary) -> Array[Float]
+        private def self.select_rgb_values: (Integer sector, Float value, Float primary, Float secondary, Float tertiary) -> Array[Float]
+
+        # Validate RGB values
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.1.0
+        #
+        # @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]
+      end
+    end
+  end
+end

data/sig/sai/conversion/rgb/color_transformer.rbs

@@ -0,0 +1,99 @@
+# Generated from lib/sai/conversion/rgb/color_transformer.rb with RBS::Inline
+
+module Sai
+  module Conversion
+    module RGB
+      # Perform color transformations
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.1
+      #
+      # @api private
+      module ColorTransformer
+        # Darken an RGB color by a percentage
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.3.1
+        #
+        # @api private
+        #
+        # @param color [Array<Integer>, String, Symbol] the color to darken
+        # @param amount [Float] amount to darken by (0.0-1.0)
+        #
+        # @raise [ArgumentError] if amount is not between 0.0 and 1.0
+        # @return [Array<Integer>] the darkened RGB values
+        # @rbs ((Array[Integer] | String | Symbol) color, Float amount) -> Array[Integer]
+        def self.darken: (Array[Integer] | String | Symbol color, Float amount) -> Array[Integer]
+
+        # Generate a gradient between two colors with a specified number of steps
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.3.1
+        #
+        # @api private
+        #
+        # @param start_color [Array<Integer>, String, Symbol] the starting color
+        # @param end_color [Array<Integer>, String, Symbol] the ending color
+        # @param steps [Integer] the number of colors to generate (minimum 2)
+        #
+        # @raise [ArgumentError] if steps is less than 2
+        # @return [Array<Array<Integer>>] the gradient colors as RGB values
+        # @rbs (
+        #   (Array[Integer] | String | Symbol) start_color,
+        #   (Array[Integer] | String | Symbol) end_color,
+        #   Integer steps
+        #   ) -> Array[Array[Integer]]
+        def self.gradient: (Array[Integer] | String | Symbol start_color, Array[Integer] | String | Symbol end_color, Integer steps) -> Array[Array[Integer]]
+
+        # Interpolate between two colors to create a gradient step
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.3.1
+        #
+        # @api private
+        #
+        # @param start_color [Array<Integer>, String, Symbol] the starting color
+        # @param end_color [Array<Integer>, String, Symbol] the ending color
+        # @param step [Float] the interpolation step (0.0-1.0)
+        #
+        # @raise [ArgumentError] if step is not between 0.0 and 1.0
+        # @return [Array<Integer>] the interpolated RGB values
+        # @rbs (
+        #   (Array[Integer] | String | Symbol) start_color,
+        #   (Array[Integer] | String | Symbol) end_color,
+        #   Float step
+        #   ) -> Array[Integer]
+        def self.interpolate_color: (Array[Integer] | String | Symbol start_color, Array[Integer] | String | Symbol end_color, Float step) -> Array[Integer]
+
+        # Lighten an RGB color by a percentage
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.3.1
+        #
+        # @api private
+        #
+        # @param color [Array<Integer>, String, Symbol] the color to lighten
+        # @param amount [Float] amount to lighten by (0.0-1.0)
+        #
+        # @raise [ArgumentError] if amount is not between 0.0 and 1.0
+        # @return [Array<Integer>] the lightened RGB values
+        # @rbs ((Array[Integer] | String | Symbol) color, Float amount) -> Array[Integer]
+        def self.lighten: (Array[Integer] | String | Symbol color, Float amount) -> Array[Integer]
+
+        # Generate a rainbow gradient with a specified number of steps
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.3.1
+        #
+        # @api private
+        #
+        # @param steps [Integer] the number of colors to generate (minimum 2)
+        #
+        # @raise [ArgumentError] if steps is less than 2
+        # @return [Array<Array<Integer>>] the rainbow gradient colors as RGB values
+        # @rbs (Integer steps) -> Array[Array[Integer]]
+        def self.rainbow_gradient: (Integer steps) -> Array[Array[Integer]]
+      end
+    end
+  end
+end