sai 0.1.0

data/sig/sai/terminal/color_mode.rbs

@@ -0,0 +1,63 @@
+# Generated from lib/sai/terminal/color_mode.rb with RBS::Inline
+
+module Sai
+  module Terminal
+    # Represents different color support levels for terminal interfaces
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api private
+    module ColorMode
+      # The terminal does not support color output
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @return [Integer] the color mode
+      NO_COLOR: Integer
+
+      # The terminal supports 8 colors (3-bit)
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @return [Integer] the color mode
+      BASIC: Integer
+
+      # The terminal supports 16 colors (4-bit)
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @return [Integer] the color mode
+      ANSI: Integer
+
+      # The terminal supports 256 colors (8-bit)
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @return [Integer] the color mode
+      BIT8: Integer
+
+      # The terminal supports 16 million colors (24-bit)
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @return [Integer] the color mode
+      TRUE_COLOR: Integer
+    end
+  end
+end

data/sig/sai.rbs

@@ -0,0 +1,207 @@
+# Generated from lib/sai.rb with RBS::Inline
+
+# An elegant color management system for crafting sophisticated CLI applications
+#
+# Sai (彩) - meaning 'coloring' or 'paint' in Japanese - is a powerful and intuitive system for managing color output in
+# command-line applications. Drawing inspiration from traditional Japanese artistic techniques, Sai brings vibrancy and
+# harmony to terminal interfaces through its sophisticated color management
+#
+# Sai empowers developers to create beautiful, colorful CLI applications that maintain visual consistency across
+# different terminal capabilities. Like its artistic namesake, it combines simplicity and sophistication to bring rich,
+# adaptive color to your terminal interfaces
+#
+# When included in a class or module, Sai provides the following instance methods:
+# * {#decorator} - Returns a new instance of {Decorator} for method chaining
+# * {#terminal_color_support} - Returns the color support capabilities of the current terminal
+#
+# The Sai module itself responds to all the same methods as {Decorator}, excluding methods used for applying
+# decorations (apply, call, decorate, encode). These methods are directly delegated to a new {Decorator} instance
+#
+# @author {https://aaronmallen.me Aaron Allen}
+# @since unreleased
+#
+# @api public
+#
+# @example Using Sai as a module
+#   class MyClass
+#     include Sai
+#   end
+#
+#   my_class = MyClass.new
+#   my_class.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"
+#
+#   my_class.terminal_color_support.true_color? # => true
+#
+# @example Using Sai directly
+#   Sai.red.on_blue.bold.decorate('Hello, World!')
+#   #=> "\e[38;2;205;0;0m\e[48;2;0;0;238m\e[1mHello, World!\e[0m"
+#
+#   Sai.support.true_color? # => true
+module Sai
+  def black: () -> self
+
+  def blink: () -> self
+
+  def blue: () -> self
+
+  def bold: () -> 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 conceal: () -> self
+
+  def cyan: () -> self
+
+  def dim: () -> self
+
+  def green: () -> self
+
+  def italic: () -> self
+
+  def magenta: () -> 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 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 rapid_blink: () -> self
+
+  def red: () -> self
+
+  def reverse: () -> self
+
+  def strike: () -> self
+
+  def underline: () -> self
+
+  def white: () -> self
+
+  def yellow: () -> self
+
+  # The supported color modes for the terminal
+  #
+  # @author {https://aaronmallen.me Aaron Allen}
+  # @since unreleased
+  #
+  # @api public
+  #
+  # @example Check the color support of the terminal
+  #   Sai.support.ansi? # => true
+  #   Sai.support.basic? # => true
+  #   Sai.support.bit8? # => true
+  #   Sai.support.no_color? # => false
+  #   Sai.support.true_color? # => true
+  #
+  # @return [Support] the color support
+  # @rbs () -> Support
+  def self.support: () -> Support
+
+  # Detect the color capabilities of the terminal
+  #
+  # @author {https://aaronmallen.me Aaron Allen}
+  # @since unreleased
+  #
+  # @api private
+  #
+  # @return [Integer] the color mode
+  # @rbs () -> Integer
+  private def self.color_mode: () -> Integer
+
+  # A helper method to initialize an instance of {Decorator}
+  #
+  # @author {https://aaronmallen.me Aaron Allen}
+  # @since unreleased
+  #
+  # @api public
+  #
+  # @example Initialize a new instance of {Decorator}
+  #   class MyClass
+  #     include Sai
+  #   end
+  #
+  #   MyClass.new.decorator.blue.on_red.bold.decorate('Hello, world!')
+  #   #=> "\e[38;5;21m\e[48;5;160m\e[1mHello, world!\e[0m"
+  #
+  # @return [Decorator] the Decorator instance
+  # @rbs () -> Decorator
+  def decorator: () -> Decorator
+
+  # The supported color modes for the terminal
+  #
+  # @author {https://aaronmallen.me Aaron Allen}
+  # @since unreleased
+  #
+  # @api public
+  #
+  # @example Check the color support of the terminal
+  #   class MyClass
+  #     include Sai
+  #   end
+  #
+  #   MyClass.new.terminal_color_support.ansi? # => true
+  #   MyClass.new.terminal_color_support.basic? # => true
+  #   MyClass.new.terminal_color_support.bit8? # => true
+  #   MyClass.new.terminal_color_support.no_color? # => false
+  #   MyClass.new.terminal_color_support.true_color? # => true
+  #
+  # @return [Support] the color support
+  # @rbs () -> Support
+  def terminal_color_support: () -> Support
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: sai
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Allen
+bindir: bin
+cert_chain: []
+date: 2025-01-19 00:00:00.000000000 Z
+dependencies: []
+description: |-
+  Sai (彩) - meaning 'coloring' or 'paint' in Japanese - is a powerful and intuitive system for managing color output in command-line applications. Drawing inspiration from traditional Japanese artistic techniques, Sai brings vibrancy and harmony to terminal interfaces through its sophisticated color management.
+  Sai empowers developers to create beautiful, colorful CLI applications that maintain visual consistency across different terminal capabilities. Like its artistic namesake, it combines simplicity and sophistication to bring rich, adaptive color to your terminal interfaces.
+email:
+- hello@aaronmallen.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/sai.rb
+- lib/sai/ansi.rb
+- lib/sai/conversion/color_sequence.rb
+- lib/sai/conversion/rgb.rb
+- lib/sai/decorator.rb
+- lib/sai/support.rb
+- lib/sai/terminal/capabilities.rb
+- lib/sai/terminal/color_mode.rb
+- sig/sai.rbs
+- sig/sai/ansi.rbs
+- sig/sai/conversion/color_sequence.rbs
+- sig/sai/conversion/rgb.rbs
+- sig/sai/decorator.rbs
+- sig/sai/support.rbs
+- sig/sai/terminal/capabilities.rbs
+- sig/sai/terminal/color_mode.rbs
+homepage: https://github.com/aaronmallen/sai
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/aaronmallen/sai/issues
+  changelog_uri: https://github.com/aaronmallen/sai/releases/tag/0.1.0
+  homepage_uri: https://github.com/aaronmallen/sai
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/aaronmallen/sai/tree/0.1.0
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: An elegant color management system for crafting sophisticated CLI applications
+test_files: []