sai 0.1.0 → 0.2.0

data/lib/sai/mode_selector.rb

@@ -0,0 +1,298 @@
+# frozen_string_literal: true
+
+require 'sai/terminal/capabilities'
+require 'sai/terminal/color_mode'
+
+module Sai
+  # Color mode selection methods
+  #
+  # @author {https://aaronmallen.me Aaron Allen}
+  # @since 0.2.0
+  #
+  # @api public
+  module ModeSelector
+    class << self
+      # Set the color mode to 256 color (8-bit) mode
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.2.0
+      #
+      # @api private
+      #
+      # @example
+      #   Sai.mode.advanced  #=> 3
+      #   Sai.mode.eight_bit #=> 3
+      #   Sai.mode.color256  #=> 3
+      #
+      # @return [Integer] the color mode
+      # @rbs () -> Integer
+      def advanced
+        Terminal::ColorMode::ADVANCED
+      end
+      alias color256 advanced
+      alias colour256 advanced
+      alias eight_bit advanced
+      alias two_hundred_fifty_six_color advanced
+      alias two_hundred_fifty_six_colour advanced
+
+      # Automatically set the color mode to advanced (8-bit) or lower
+      #
+      # Sets the terminal color mode to advanced (8-bit) support, which provides 256 colors
+      # The mode will automatically downgrade to 4-bit, 3-bit, or NO_COLOR if the terminal doesn't support
+      # advanced colors
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.2.0
+      #
+      # @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
+      #
+      # @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
+      #
+      # @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
+      #
+      # @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
+      #
+      # @return [Integer] the color mode
+      # @rbs () -> Integer
+      def advanced_auto
+        [Terminal::Capabilities.detect_color_support, Terminal::ColorMode::ADVANCED].min
+      end
+      alias color256_auto advanced_auto
+      alias colour256_auto advanced_auto
+      alias eight_bit_auto advanced_auto
+      alias two_hundred_fifty_six_color_auto advanced_auto
+      alias two_hundred_fifty_six_colour_auto advanced_auto
+
+      # Set the color mode to 16 color (4-bit) mode
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.2.0
+      #
+      # @api public
+      #
+      # @example
+      #   Sai.mode.ansi     #=> 2
+      #   Sai.mode.color16 #=> 2
+      #   Sai.mode.four_bit #=> 2
+      #
+      # @return [Integer] the color mode
+      # @rbs () -> Integer
+      def ansi
+        Terminal::ColorMode::ANSI
+      end
+      alias color16 ansi
+      alias colour16 ansi
+      alias four_bit ansi
+      alias sixteen_color ansi
+      alias sixteen_colour ansi
+
+      # Automatically set the color mode to ansi (4-bit) or lower
+      #
+      # Sets the terminal color mode to ansi (4-bit) support, which provides 8 colors
+      # The mode will automatically downgrade to 3-bit or NO_COLOR if the terminal doesn't support
+      # ansi colors
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.2.0
+      #
+      # @api public
+      #
+      # @example With color support enabled
+      #   ENV['NO_COLOR'] #=> nil
+      #   ENV['TERM'] #=> 'ansi'
+      #   Sai.mode.ansi_auto     #=> 2
+      #   Sai.mode.four_bit_auto #=> 2
+      #   Sai.mode.color_16_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
+      #
+      # @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
+      #
+      # @return [Integer] the color mode
+      # @rbs () -> Integer
+      def ansi_auto
+        [Terminal::Capabilities.detect_color_support, Terminal::ColorMode::ANSI].min
+      end
+      alias color16_auto ansi_auto
+      alias colour16_auto ansi_auto
+      alias four_bit_auto ansi_auto
+      alias sixteen_color_auto ansi_auto
+      alias sixteen_colour_auto ansi_auto
+
+      # Set the color mode based on the current Terminal's capabilities
+      #
+      # This is the default color mode for {Sai}
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.2.0
+      #
+      # @api public
+      #
+      # @example With 24-bit color support enabled
+      #   ENV['COLORTERM'] #=> 'truecolor'
+      #   Sai.node.auto    #=> 4
+      #
+      # @example With only 8-bit color support enabled
+      #   ENV['COLORTERM'] #=> nil
+      #   ENV['TERM']      #=> 'xterm-256color'
+      #   Sai.mode.auto    #=> 3
+      #
+      # @example With only 4-bit color support
+      #   ENV['NO_COLOR'] #=> nil
+      #   ENV['TERM']     #=> 'ansi'
+      #   Sai.mode.auto   #=> 2
+      #
+      # @example With only 3-bit color support
+      #   ENV['TERM']     #=> nil
+      #   ENV['NO_COLOR'] #=> nil
+      #   Sai.mode.auto   #=> 1
+      #
+      # @example With color support disabled
+      #   ENV['NO_COLOR'] #=> 'true'
+      #   Sai.mode.auto   #=> 0
+      #
+      # @return [Integer] the color mode
+      # @rbs () -> Integer
+      def auto
+        Terminal::Capabilities.detect_color_support
+      end
+      alias color16m_auto auto
+      alias colour16m_auto auto
+      alias enabled auto
+      alias sixteen_million_color_auto auto
+      alias sixteen_million_colour_auto auto
+      alias twenty_for_bit_auto auto
+
+      # Set the color mode to 8 color (3-bit) mode
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.2.0
+      #
+      # @api public
+      #
+      # @example
+      #   Sai.mode.basic     #=> 1
+      #   Sai.mode.color8    #=> 1
+      #   Sai.mode.three_bit #=> 1
+      #
+      # @return [Integer] the 4 color (3-bit) mode
+      # @rbs () -> Integer
+      def basic
+        Terminal::ColorMode::BASIC
+      end
+      alias color8 basic
+      alias colour8 basic
+      alias eight_color basic
+      alias eight_colour basic
+      alias three_bit basic
+
+      # Automatically set the color mode to basic (3-bit) or lower
+      #
+      # Sets the terminal color mode to basic (3-bit) support, which provides 8 colors
+      # The mode will automatically downgrade to NO_COLOR if the terminal doesn't support
+      # basic colors
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.2.0
+      #
+      # @api public
+      #
+      # @example With color support enabled
+      #   ENV['NO_COLOR']         #=> nil
+      #   Sai.mode.basic_auto     #=> 1
+      #   Sai.mode.three_bit_auto #=> 1
+      #   Sai.mode.color8_auto    #=> 1
+      #
+      # @example With color support disabled
+      #   ENV['NO_COLOR']         #=> 'true'
+      #   Sai.mode.basic_auto     #=> 0
+      #   Sai.mode.three_bit_auto #=> 0
+      #   Sai.mode.color8_auto    #=> 0
+      #
+      # @return [Integer] the color mode
+      # @rbs () -> Integer
+      def basic_auto
+        [Terminal::Capabilities.detect_color_support, Terminal::ColorMode::BASIC].min
+      end
+      alias color8_auto basic_auto
+      alias colour8_auto basic_auto
+      alias eight_color_auto basic_auto
+      alias eight_colour_auto basic_auto
+      alias three_bit_auto basic_auto
+
+      # Set the color mode to disable all color and styling
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.2.0
+      #
+      # @api public
+      #
+      # @example
+      #   Sai.mode.no_color #=> 0
+      #   Sai.mode.disabled #=> 0
+      #   Sai.mode.mono     #=> 0
+      #
+      # @return [Integer] the color mode
+      # @rbs () -> Integer
+      def no_color
+        Terminal::ColorMode::NO_COLOR
+      end
+      alias disabled no_color
+      alias mono no_color
+      alias no_colour no_color
+
+      # Set the color mode to 16-million color (24-bit) mode
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.2.0
+      #
+      # @api private
+      #
+      # @example
+      #   Sai.mode.true_color      #=> 4
+      #   Sai.mode.twenty_four_bit #=> 4
+      #   Sai.mode.color_16m       #=> 4
+      #
+      # @return [Integer] the color mode
+      # @rbs () -> Integer
+      def true_color
+        Terminal::ColorMode::TRUE_COLOR
+      end
+      alias color16m true_color
+      alias colour16m true_color
+      alias sixteen_million_color true_color
+      alias sixteen_million_colour true_color
+      alias twenty_for_bit true_color
+    end
+  end
+end

data/lib/sai/support.rb

@@ -1,115 +1,116 @@
 # frozen_string_literal: true
 
+require 'sai/terminal/capabilities'
 require 'sai/terminal/color_mode'
 
 module Sai
   # Determine the color capabilities of the terminal
   #
   # @author {https://aaronmallen.me Aaron Allen}
-  # @since unreleased
+  # @since 0.1.0
   #
   # @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(color_mode)
-      @color_mode = color_mode
-    end
-
-    # 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?
-      @color_mode >= Terminal::ColorMode::ANSI
-    end
-    alias bit4? ansi?
-    alias four_bit? ansi?
+  module Support
+    class << self
+      # Check if the terminal supports 256 colors (8-bit)
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.1.0
+      #
+      # @api public
+      #
+      # @example Check if the terminal supports 256 colors
+      #   Sai.advanced? # => true
+      #
+      # @return [Boolean] `true` if the terminal supports 256 colors (8-bit), otherwise `false`
+      # @rbs () -> bool
+      def advanced?
+        Terminal::Capabilities.detect_color_support >= Terminal::ColorMode::ADVANCED
+      end
+      alias color256? advanced?
+      alias colour256? advanced?
+      alias eight_bit? advanced?
+      alias two_hundred_fifty_six_color? advanced?
+      alias two_hundred_fifty_six_colour? advanced?
 
-    # 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?
-      @color_mode >= Terminal::ColorMode::BASIC
-    end
-    alias bit3? basic?
-    alias three_bit? basic?
+      # Check if the terminal supports ANSI colors (4-bit)
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.1.0
+      #
+      # @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?
+        Terminal::Capabilities.detect_color_support >= Terminal::ColorMode::ANSI
+      end
+      alias color16? ansi?
+      alias colour16? ansi?
+      alias four_bit? ansi?
+      alias sixteen_color? ansi?
+      alias sixteen_colour? ansi?
 
-    # 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?
-      @color_mode >= Terminal::ColorMode::BIT8
-    end
-    alias eight_bit? bit8?
+      # Check if the terminal supports basic colors (3-bit)
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.1.0
+      #
+      # @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?
+        Terminal::Capabilities.detect_color_support >= Terminal::ColorMode::BASIC
+      end
+      alias color8? basic?
+      alias colour8? basic?
+      alias eight_color? basic?
+      alias eight_colour? basic?
+      alias three_bit? basic?
 
-    # 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?
-      @color_mode > Terminal::ColorMode::NO_COLOR
-    end
+      # Check if the terminal supports color output
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.1.0
+      #
+      # @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?
+        Terminal::Capabilities.detect_color_support > Terminal::ColorMode::NO_COLOR
+      end
 
-    # 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?
-      @color_mode >= Terminal::ColorMode::TRUE_COLOR
+      # Check if the terminal supports true color (24-bit)
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since 0.1.0
+      #
+      # @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?
+        Terminal::Capabilities.detect_color_support >= Terminal::ColorMode::TRUE_COLOR
+      end
+      alias color16m? true_color?
+      alias colour16m? true_color?
+      alias sixteen_million_color? true_color?
+      alias sixteen_million_colour? true_color?
+      alias twenty_for_bit? true_color?
     end
-    alias bit24? true_color?
-    alias twenty_four_bit? true_color?
   end
 end

data/lib/sai/terminal/capabilities.rb

@@ -7,7 +7,7 @@ module Sai
     # Detect the color capabilities of the terminal
     #
     # @author {https://aaronmallen.me Aaron Allen}
-    # @since unreleased
+    # @since 0.1.0
     #
     # @api private
     module Capabilities
@@ -15,7 +15,7 @@ module Sai
         # Detect the color capabilities of the current terminal
         #
         # @author {https://aaronmallen.me Aaron Allen}
-        # @since unreleased
+        # @since 0.1.0
         #
         # @api private
         #
@@ -24,7 +24,7 @@ module Sai
         def detect_color_support
           return ColorMode::NO_COLOR if no_color?
           return ColorMode::TRUE_COLOR if true_color?
-          return ColorMode::BIT8 if bit8?
+          return ColorMode::ADVANCED if advanced?
           return ColorMode::ANSI if ansi?
           return ColorMode::BASIC if basic?
 
@@ -33,10 +33,25 @@ module Sai
 
         private
 
+        # Check for 256 color (8-bit) support
+        #
+        # @author {https://aaronmallen.me Aaron Allen}
+        # @since 0.1.0
+        #
+        # @api private
+        #
+        # @return [Boolean] `true` if the terminal supports 256 colors, otherwise `false`
+        # @rbs () -> bool
+        def advanced?
+          return true if ENV.fetch('TERM', '').end_with?('-256color')
+
+          ENV.fetch('COLORTERM', '0').to_i >= 256
+        end
+
         # Check for ANSI color support
         #
         # @author {https://aaronmallen.me Aaron Allen}
-        # @since unreleased
+        # @since 0.1.0
         #
         # @api private
         #
@@ -51,7 +66,7 @@ module Sai
         # Check for basic color support
         #
         # @author {https://aaronmallen.me Aaron Allen}
-        # @since unreleased
+        # @since 0.1.0
         #
         # @api private
         #
@@ -61,25 +76,10 @@ module Sai
           !ENV.fetch('TERM', '').empty?
         end
 
-        # 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
-        def bit8?
-          return true if ENV.fetch('TERM', '').end_with?('-256color')
-
-          ENV.fetch('COLORTERM', '0').to_i >= 256
-        end
-
         # Check for NO_COLOR environment variable
         #
         # @author {https://aaronmallen.me Aaron Allen}
-        # @since unreleased
+        # @since 0.1.0
         #
         # @api private
         #
@@ -94,7 +94,7 @@ module Sai
         # Check for true color (24-bit) support
         #
         # @author {https://aaronmallen.me Aaron Allen}
-        # @since unreleased
+        # @since 0.1.0
         #
         # @api private
         #

data/lib/sai/terminal/color_mode.rb

@@ -5,14 +5,14 @@ module Sai
     # Represents different color support levels for terminal interfaces
     #
     # @author {https://aaronmallen.me Aaron Allen}
-    # @since unreleased
+    # @since 0.1.0
     #
     # @api private
     module ColorMode
       # The terminal does not support color output
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -22,7 +22,7 @@ module Sai
       # The terminal supports 8 colors (3-bit)
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -32,7 +32,7 @@ module Sai
       # The terminal supports 16 colors (4-bit)
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
@@ -42,17 +42,17 @@ module Sai
       # The terminal supports 256 colors (8-bit)
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #
       # @return [Integer] the color mode
-      BIT8 = 3 #: Integer
+      ADVANCED = 3 #: Integer
 
       # The terminal supports 16 million colors (24-bit)
       #
       # @author {https://aaronmallen.me Aaron Allen}
-      # @since unreleased
+      # @since 0.1.0
       #
       # @api private
       #