sai 0.1.0 → 0.3.0

data/sig/sai/ansi/sequenced_string.rbs

@@ -0,0 +1,380 @@
+# Generated from lib/sai/ansi/sequenced_string.rb with RBS::Inline
+
+module Sai
+  module ANSI
+    # A representation of a ANSI encoded string and its individual {SequencedString::Segment segments}
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since 0.3.0
+    #
+    # @api public
+    class SequencedString
+      include Enumerable[Segment]
+
+      def each: () { (Segment) -> void } -> SequencedString
+
+      def empty?: () -> bool
+
+      def map: () { (Segment) -> untyped } -> Array[untyped]
+
+      def size: () -> Integer
+
+      # Initialize a new instance of SequencedString
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.0
+      #
+      # @api private
+      #
+      # @param string [String] the sequenced string to Segment
+      #
+      # @return [SequencedString] the new instance of SequencedString
+      # @rbs (String string) -> void
+      def initialize: (String string) -> void
+
+      # Fetch a segment by index
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.0
+      #
+      # @api public
+      #
+      # @example
+      #   string = SequencedString.new("\e[31mred\e[0m")
+      #   string[0] #=> #<SequencedString::Segment:0x00007f9b3b8b3e10>
+      #
+      # @param index [Integer] the index of the segment to fetch
+      #
+      # @return [Segment, nil] the segment at the index
+      # @rbs (Integer index) -> Segment?
+      def []: (Integer index) -> Segment?
+
+      # Compare the SequencedString to another object
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.0
+      #
+      # @api public
+      #
+      # @example
+      #   string = "\e[31mred\e[0m"
+      #   SequencedString.new(string) == string #=> true
+      #
+      # @param other [Object] the object to compare to
+      #
+      # @return [Boolean] `true` if the SequencedString is equal to the other object, `false` otherwise
+      # @rbs (untyped other) -> bool
+      def ==: (untyped other) -> bool
+
+      # Combine a sequenced string with another object
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.0
+      #
+      # @api public
+      #
+      # @example
+      #   sequenced_string = SequencedString.new("\e[31mred\e[0m")
+      #   sequenced_string + " is a color" #=> "\e[31mred\e[0m is a color"
+      #
+      # @param other [Object] the object to combine with
+      #
+      # @return [SequencedString] the combined string
+      # @rbs (untyped other) -> SequencedString
+      def +: (untyped other) -> SequencedString
+
+      # Return just the raw text content with **no ANSI sequences**
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.0
+      #
+      # @api public
+      #
+      # @example
+      #   string = SequencedString.new("Normal \e[31mred\e[0m")
+      #   string.stripped #=> "Normal red"
+      #
+      # @return [String] the concatenation of all segment text without color or style
+      def stripped: () -> untyped
+
+      # Return the fully reconstructed string with **all ANSI sequences** (foreground, background, style)
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.0
+      #
+      # @api public
+      #
+      # @example
+      #   string = SequencedString.new("\e[31mred\e[0m")
+      #   string.to_s #=> "\e[31mred\e[0m"
+      #
+      # @return [String]
+      def to_s: () -> untyped
+
+      alias to_str to_s
+
+      # Return a string with everything except **background** color sequences removed
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.0
+      #
+      # @api public
+      #
+      # @example Remove all background colors
+      #   string = SequencedString.new("\e[41mBack\e[0m \e[1mBold\e[0m")
+      #   string.without_background #=> "\e[1mBold\e[0m"
+      #
+      # @return [SequencedString] new instance with background colors removed
+      # @rbs () -> SequencedString
+      def without_background: () -> SequencedString
+
+      # Return a string containing *style* sequences but **no foreground or background colors**
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.0
+      #
+      # @api public
+      #
+      # @example Remove all colors
+      #   string = SequencedString.new("\e[31mred\e[0m \e[1mbold\e[0m")
+      #   string.without_color #=> "\e[1mbold\e[0m"
+      #
+      # @return [SequencedString] new instance with all colors removed
+      # @rbs () -> SequencedString
+      def without_color: () -> SequencedString
+
+      # Return a string with everything except **foreground** color sequences removed
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.0
+      #
+      # @api public
+      #
+      # @example Remove all foreground colors
+      #   string = SequencedString.new("\e[41mBack\e[0m \e[1mBold\e[0m")
+      #   string.without_foreground #=> "\e[41mBack\e[0m \e[1mBold\e[0m"
+      #
+      # @return [SequencedString] new instance with foreground colors removed
+      # @rbs () -> SequencedString
+      def without_foreground: () -> SequencedString
+
+      # Return a string with specified styles removed
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.0
+      #
+      # @api public
+      #
+      # @example Remove all styles
+      #   string = SequencedString.new("\e[31mred\e[0m \e[1mbold\e[0m")
+      #   string.without_style #=> "\e[31mred\e[0m"
+      #
+      # @example Remove specific style
+      #   string = SequencedString.new("\e[1;4mBold and Underlined\e[0m")
+      #   string.without_style(:bold) #=> "\e[4mUnderlined\e[0m"
+      #
+      # @param styles [Array<Symbol>] specific styles to remove (default: all)
+      #
+      # @return [SequencedString] new instance with specified styles removed
+      def without_style: (*untyped styles) -> untyped
+
+      private
+
+      # Build the color sequences for a segment
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.0
+      #
+      # @api private
+      #
+      # @param segment [Segment] the segment to build color sequences for
+      # @param skip_background [Boolean] whether to skip background colors
+      # @param skip_foreground [Boolean] whether to skip foreground colors
+      #
+      # @return [Array<String>] the color sequences
+      # @rbs (Segment segment, ?skip_background: bool, ?skip_foreground: bool) -> Array[String]
+      def build_color_sequences: (Segment segment, ?skip_background: bool, ?skip_foreground: bool) -> Array[String]
+
+      # Build a string with specified parts skipped
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.0
+      #
+      # @api private
+      #
+      # @param skip_background [Boolean] whether to skip background colors
+      # @param skip_foreground [Boolean] whether to skip foreground colors
+      # @param skip_styles [Array<Symbol>] styles to skip
+      #
+      # @return [String] the built string
+      # @rbs (?skip_background: bool, ?skip_foreground: bool, ?skip_styles: Array[Symbol]) -> String
+      def build_string: (?skip_background: bool, ?skip_foreground: bool, ?skip_styles: Array[Symbol]) -> String
+
+      # Build the style sequences for a segment
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.0
+      #
+      # @api private
+      #
+      # @param segment [Segment] the segment to build style sequences for
+      # @param skip_styles [Array<Symbol>] styles to skip
+      #
+      # @return [Array<String>] the style sequences
+      # @rbs (Segment segment, ?skip_styles: Array[Symbol]) -> Array[String]
+      def build_style_sequences: (Segment segment, ?skip_styles: Array[Symbol]) -> Array[String]
+
+      # A segment of an ANSI encoded string
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.3.0
+      #
+      # @api public
+      class Segment
+        # The background color sequences for the Segment
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        # @return [String, nil] the background color sequences
+        attr_reader background: String?
+
+        # The foreground color sequences for the Segment
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        # @return [String, nil] the foreground color sequences
+        attr_reader foreground: String?
+
+        # The {Location} of the encoded string within the {SequencedString}
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        # @return [Location] the {Location}
+        attr_reader encoded_location: Location
+
+        alias encoded_loc encoded_location
+
+        # The {Location} of the encoded string without it's encoding within the {SequencedString}
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        # @return [Location] the {Location}
+        attr_reader stripped_location: Location
+
+        alias stripped_loc stripped_location
+
+        # The style sequences (bold, underline, etc...) for the segment
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        # @return [Array<String>] the style sequences
+        attr_reader styles: Array[String]
+
+        # The raw text of the Segment without any of its ANSI sequences
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.3.0
+        #
+        # @api public
+        #
+        # @return [String]
+        attr_reader text: String
+
+        # Initialize a new instance of Segment
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.3.0
+        #
+        # @api private
+        #
+        # @param options [Hash{Symbol => Object}] the options to initialize the Segment with
+        # @option options background [String, nil] the Segment {#background}
+        # @option options foreground [String, nil] the Segment {#foreground}
+        # @option options encoded_end [Integer] the {Location#end_position end_position} of the Segment
+        #   {#encoded_location}
+        # @option options encoded_start [Integer] the {Location#start_position start_position} of the Segment
+        #   {#encoded_location}
+        # @option options stripped_end [Integer] the {Location#end_position end_position} of the Segment
+        #   {#stripped_location}
+        # @option options stripped_start [Integer] the {Location#start_position start_position} of the Segment
+        #   {#stripped_location}
+        # @option options styles [Array<String>] the Segment {#styles}
+        # @option options text [String] the Segment {#text}
+        #
+        # @return [Segment] the new instance of Segment
+        # @rbs (
+        #   ?background: String?,
+        #   ?foreground: String?,
+        #   encoded_end: Integer,
+        #   encoded_start: Integer,
+        #   stripped_end: Integer,
+        #   stripped_start: Integer,
+        #   ?styles: Array[String],
+        #   text: String
+        #   ) -> void
+        def initialize: (encoded_end: Integer, encoded_start: Integer, stripped_end: Integer, stripped_start: Integer, text: String, ?background: String?, ?foreground: String?, ?styles: Array[String]) -> void
+
+        # The location of the {Segment} within a {SequencedString}
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.3.0
+        #
+        # @api public
+        class Location
+          # The ending position of the Location
+          #
+          # @author {https://aaronmallen.me Aaron Allen}
+          # @since 0.3.0
+          #
+          # @api public
+          #
+          # @return [Integer] the end position
+          attr_reader end_position: Integer
+
+          alias end_pos end_position
+
+          # The starting position of the Location
+          #
+          # @author {https://aaronmallen.me Aaron Allen}
+          # @since 0.3.0
+          #
+          # @api public
+          #
+          # @return [Integer] the start position
+          attr_reader start_position: Integer
+
+          alias start_pos start_position
+
+          # Initialize a new instance of Location
+          #
+          # @author {https://aaronmallen.me Aaron Allen}
+          # @since 0.3.0
+          #
+          # @api private
+          #
+          # @param end_position [Integer] the {#end_position} of the location
+          # @param start_position [Integer] the {#start_position} of the location
+          #
+          # @return [Location] the new instance of Location
+          # @rbs (end_position: Integer, start_position: Integer) -> void
+          def initialize: (end_position: Integer, start_position: Integer) -> void
+        end
+      end
+    end
+  end
+end

data/sig/sai/ansi.rbs

@@ -4,14 +4,14 @@ module Sai
   # ANSI constants for encoding text styles and colors
   #
   # @author {https://aaronmallen.me Aaron Allen}
-  # @since unreleased
+  # @since 0.1.0
   #
   # @api private
   module ANSI
     # ANSI color code mappings
     #
     # @author {https://aaronmallen.me Aaron Allen}
-    # @since unreleased
+    # @since 0.1.0
     #
     # @api private
     #
@@ -21,7 +21,7 @@ module Sai
     # Standard ANSI color names and their RGB values
     #
     # @author {https://aaronmallen.me Aaron Allen}
-    # @since unreleased
+    # @since 0.1.0
     #
     # @api private
     #
@@ -31,7 +31,7 @@ module Sai
     # ANSI escape sequence for resetting text formatting
     #
     # @author {https://aaronmallen.me Aaron Allen}
-    # @since unreleased
+    # @since 0.1.0
     #
     # @api private
     #
@@ -41,7 +41,7 @@ module Sai
     # Standard ANSI style codes
     #
     # @author {https://aaronmallen.me Aaron Allen}
-    # @since unreleased
+    # @since 0.1.0
     #
     # @api private
     #

data/sig/sai/conversion/color_sequence.rbs

@@ -5,7 +5,7 @@ module Sai
     # ANSI escape sequence utilities
     #
     # @author {https://aaronmallen.me Aaron Allen}
-    # @since unreleased
+    # @since 0.1.0
     #
     # @api private
     module ColorSequence
@@ -14,7 +14,7 @@ module Sai
       # Convert a color to the appropriate ANSI escape sequence
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -26,10 +26,24 @@ module Sai
       # @rbs (Array[Integer] | String | Symbol color, Integer mode, ?style_type style_type) -> String
       def self.resolve: (Array[Integer] | String | Symbol color, Integer mode, ?style_type style_type) -> String
 
+      # Convert RGB values to an 8-bit color sequence
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.1.0
+      #
+      # @api private
+      #
+      # @param rgb [Array<Integer>] the RGB components
+      # @param style_type [Symbol] the type of color (foreground or background)
+      #
+      # @return [String] the ANSI escape sequence
+      # @rbs (Array[Integer] rgb, style_type type) -> String
+      private def self.advanced: (Array[Integer] rgb, style_type type) -> String
+
       # Convert RGB values to a 4-bit ANSI color sequence
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -43,7 +57,7 @@ module Sai
       # Convert a base color to a foreground or background sequence
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -57,7 +71,7 @@ module Sai
       # Convert RGB values to a 3-bit basic color sequence
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -68,24 +82,10 @@ module Sai
       # @rbs (Array[Integer] rgb, style_type style_type) -> String
       private def self.basic: (Array[Integer] rgb, style_type style_type) -> String
 
-      # Convert RGB values to an 8-bit color sequence
-      #
-      # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
-      #
-      # @api private
-      #
-      # @param rgb [Array<Integer>] the RGB components
-      # @param style_type [Symbol] the type of color (foreground or background)
-      #
-      # @return [String] the ANSI escape sequence
-      # @rbs (Array[Integer] rgb, style_type type) -> String
-      private def self.bit8: (Array[Integer] rgb, style_type type) -> String
-
       # Convert RGB values to a true color (24-bit) sequence
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -99,7 +99,7 @@ module Sai
       # Validate a color style type
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #

data/sig/sai/conversion/rgb.rbs

@@ -5,14 +5,14 @@ module Sai
     # RGB color conversion utilities
     #
     # @author {https://aaronmallen.me Aaron Allen}
-    # @since unreleased
+    # @since 0.1.0
     #
     # @api private
     module RGB
       # Get closest ANSI color for RGB values
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -27,7 +27,7 @@ module Sai
       # Determine if a color is dark
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -42,7 +42,7 @@ module Sai
       # Determine if a color is grayscale
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -57,7 +57,7 @@ module Sai
       # Convert a color value to RGB components
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -71,7 +71,7 @@ module Sai
       # Convert RGB values to 256-color cube index
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -84,7 +84,7 @@ module Sai
       # Convert RGB values to grayscale index
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -97,7 +97,7 @@ module Sai
       # Check if RGB values represent cyan
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -112,7 +112,7 @@ module Sai
       # Convert a hex string to RGB values
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -125,7 +125,7 @@ module Sai
       # Check if RGB values represent magenta
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -140,7 +140,7 @@ module Sai
       # Convert a named color to RGB values
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -154,7 +154,7 @@ module Sai
       # Determine if RGB values represent a primary color
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -169,7 +169,7 @@ module Sai
       # Get the closest primary color
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -184,7 +184,7 @@ module Sai
       # Determine if RGB values represent a secondary color
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -199,7 +199,7 @@ module Sai
       # Get the closest secondary color
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -214,7 +214,7 @@ module Sai
       # Validate RGB values
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -227,7 +227,7 @@ module Sai
       # Check if RGB values represent yellow
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #