sai 0.2.0 → 0.3.0

data/sig/sai/mode_selector.rbs

@@ -13,7 +13,7 @@ module Sai
     # @author {https://aaronmallen.me Aaron Allen}
     # @since 0.2.0
     #
-    # @api private
+    # @api public
     #
     # @example
     #   Sai.mode.advanced  #=> 3
@@ -46,31 +46,31 @@ module Sai
     # @api public
     #
     # @example With color support enabled
-    #   ENV['COLORTERM']       #=> nil
-    #   ENV['TERM']            #=> 'xterm-256color'
-    #   Sai.mode.ansi_auto     #=> 3
-    #   Sai.mode.four_bit_auto #=> 3
-    #   Sai.mode.color_16_auto #=> 3
+    #   ENV['COLORTERM']        #=> nil
+    #   ENV['TERM']             #=> 'xterm-256color'
+    #   Sai.mode.advanced_auto  #=> 3
+    #   Sai.mode.eight_bit_auto #=> 3
+    #   Sai.mode.color256_auto  #=> 3
     #
     # @example With only 4-bit color support
-    #   ENV['NO_COLOR']        #=> nil
-    #   ENV['TERM']            #=> 'ansi'
-    #   Sai.mode.ansi_auto     #=> 2
-    #   Sai.mode.four_bit_auto #=> 2
-    #   Sai.mode.color_16_auto #=> 2
+    #   ENV['NO_COLOR']         #=> nil
+    #   ENV['TERM']             #=> 'ansi'
+    #   Sai.mode.advanced_auto  #=> 2
+    #   Sai.mode.eight_bit_auto #=> 2
+    #   Sai.mode.color256_auto  #=> 2
     #
     # @example With only 3-bit color support
     #   ENV['TERM']             #=> nil
     #   ENV['NO_COLOR']         #=> nil
-    #   Sai.mode.ansi_auto      #=> 1
-    #   Sai.mode.four_bit_auto  #=> 1
-    #   Sai.mode.color16_auto   #=> 1
+    #   Sai.mode.advanced_auto  #=> 1
+    #   Sai.mode.eight_bit_auto #=> 1
+    #   Sai.mode.color256_auto  #=> 1
     #
     # @example With color support disabled
     #   ENV['NO_COLOR']         #=> 'true'
-    #   Sai.mode.ansi_auto      #=> 0
-    #   Sai.mode.four_bit_auto  #=> 0
-    #   Sai.mode.color16_auto   #=> 0
+    #   Sai.mode.advanced_auto  #=> 0
+    #   Sai.mode.eight_bit_auto #=> 0
+    #   Sai.mode.color256_auto  #=> 0
     #
     # @return [Integer] the color mode
     # @rbs () -> Integer
@@ -128,7 +128,7 @@ module Sai
     #   ENV['TERM'] #=> 'ansi'
     #   Sai.mode.ansi_auto     #=> 2
     #   Sai.mode.four_bit_auto #=> 2
-    #   Sai.mode.color_16_auto #=> 2
+    #   Sai.mode.color16_auto  #=> 2
     #
     # @example With only 3-bit color support
     #   ENV['TERM']             #=> nil
@@ -295,7 +295,7 @@ module Sai
     # @author {https://aaronmallen.me Aaron Allen}
     # @since 0.2.0
     #
-    # @api private
+    # @api public
     #
     # @example
     #   Sai.mode.true_color      #=> 4

data/sig/sai.rbs

@@ -11,6 +11,7 @@
 # adaptive color to your terminal interfaces
 #
 # When included in a class or module, Sai provides the following instance methods:
+# * {#color_mode} - Returns an interface to select Sai color modes
 # * {#decorator} - Returns a new instance of {Decorator} for method chaining
 # * {#terminal_color_support} - Returns the color support capabilities of the current terminal
 #
@@ -149,6 +150,22 @@ module Sai
 
   def yellow: () -> Decorator
 
+  # Sequence a string with ANSI escape codes
+  #
+  # @author {https://aaronmallen.me Aaron Allen}
+  # @since 0.3.0
+  #
+  # @api public
+  #
+  # @example Sequence a string with ANSI escape codes
+  #   Sai.sequence("\e[38;2;205;0;0mHello, World!\e[0m") #=> #<Sai::ANSI::SequencedString:0x123>
+  #
+  # @param text [String] the text to sequence
+  #
+  # @return [ANSI::SequencedString] the sequenced string
+  # @rbs (String text) -> ANSI::SequencedString
+  def self.sequence: (String text) -> ANSI::SequencedString
+
   # The supported color modes for the terminal
   #
   # @author {https://aaronmallen.me Aaron Allen}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sai
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Aaron Allen
@@ -22,8 +22,11 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- docs/USAGE.md
 - lib/sai.rb
 - lib/sai/ansi.rb
+- lib/sai/ansi/sequence_processor.rb
+- lib/sai/ansi/sequenced_string.rb
 - lib/sai/conversion/color_sequence.rb
 - lib/sai/conversion/rgb.rb
 - lib/sai/decorator.rb
@@ -31,8 +34,11 @@ files:
 - lib/sai/support.rb
 - lib/sai/terminal/capabilities.rb
 - lib/sai/terminal/color_mode.rb
+- sig/manifest.yaml
 - sig/sai.rbs
 - sig/sai/ansi.rbs
+- sig/sai/ansi/sequence_processor.rbs
+- sig/sai/ansi/sequenced_string.rbs
 - sig/sai/conversion/color_sequence.rbs
 - sig/sai/conversion/rgb.rbs
 - sig/sai/decorator.rbs
@@ -45,10 +51,10 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/aaronmallen/sai/issues
-  changelog_uri: https://github.com/aaronmallen/sai/releases/tag/0.2.0
+  changelog_uri: https://github.com/aaronmallen/sai/releases/tag/0.3.0
   homepage_uri: https://github.com/aaronmallen/sai
   rubygems_mfa_required: 'true'
-  source_code_uri: https://github.com/aaronmallen/sai/tree/0.2.0
+  source_code_uri: https://github.com/aaronmallen/sai/tree/0.3.0
 rdoc_options: []
 require_paths:
 - lib