sai 0.3.2 → 0.4.0

data/sig/sai/decorator.rbs

@@ -11,11 +11,10 @@ module Sai
   # @note For each named color, two methods are dynamically generated:
   #   * color_name - Applies the color to the foreground
   #   * on_color_name - Applies the color to the backgroundAll color methods return {Decorator}
-  # @see Sai::NamedColors Sai::NamedColors for available color names
   #
   # @example Using a named color
-  #   decorator.azure.decorate('Hello')      #=> "\e[38;2;0;127;255mHello\e[0m"
-  #   decorator.on_azure.decorate('Hello')   #=> "\e[48;2;0;127;255mHello\e[0m"
+  #   decorator.blue.decorate('Hello').to_s      #=> "\e[38;2;0;0;238mHello\e[0m"
+  #   decorator.on_blue.decorate('Hello').to_s   #=> "\e[48;2;0;0;238mHello\e[0m"
   class Decorator
     include ColorManipulations
 

data/sig/sai/{named_colors.rbs → registry.rbs}

@@ -1,44 +1,13 @@
-# Generated from lib/sai/named_colors.rb with RBS::Inline
+# Generated from lib/sai/registry.rb with RBS::Inline
 
 module Sai
-  # A collection of named colors and their RGB values
+  # The named color registry
   #
   # @author {https://aaronmallen.me Aaron Allen}
-  # @since 0.3.1
+  # @since 0.4.0
   #
   # @api private
-  module NamedColors
-    # Standard ANSI color names and their RGB values
-    #
-    # @author {https://aaronmallen.me Aaron Allen}
-    # @since 0.3.1
-    #
-    # @api private
-    #
-    # @return [Hash{Symbol => Array<Integer>}] the color names and RGB values
-    ANSI: untyped
-
-    # CSS color names and their RGB values
-    #
-    # @author {https://aaronmallen.me Aaron Allen}
-    # @since 0.3.1
-    #
-    # @api private
-    #
-    # @return [Hash{Symbol => Array<Integer>}] the color names and RGB values
-    CSS: Hash[Symbol, Array[Integer]]
-
-    # XTERM color names and their RGB values
-    #
-    # @author {https://aaronmallen.me Aaron Allen}
-    # @since 0.3.1
-    #
-    # @api private
-    #
-    # @return [Hash{Symbol => Array<Integer>}] the color names and RGB values
-    # rubocop:disable Naming/VariableNumber
-    XTERM: Hash[Symbol, Array[Integer]]
-
+  module Registry
     # Look up an RGB value by color name
     #
     # @author {https://aaronmallen.me Aaron Allen}
@@ -65,7 +34,7 @@ module Sai
     # Register a named color with an RGB or Hexadecimal value
     #
     # @author {https://aaronmallen.me Aaron Allen}
-    # @since 0.3.2
+    # @since 0.4.0
     #
     # @api private
     #
@@ -76,47 +45,57 @@ module Sai
     # @rbs (String | Symbol name, Array[Integer] | String rgb_or_hex) -> void
     def self.register: (String | Symbol name, Array[Integer] | String rgb_or_hex) -> void
 
-    # Install the color methods onto {Sai} and {Sai::Decorator}
+    # Subscribe to registry changes
     #
     # @author {https://aaronmallen.me Aaron Allen}
-    # @since 0.3.2
+    # @since 0.4.0
     #
     # @api private
     #
-    # @param name [Symbol] the name of the color to install
+    # @param subscriber [Object] the subscriber
     #
     # @return [void]
-    # @rbs (Symbol name) -> void
-    private def self.install_color: (Symbol name) -> void
+    # @rbs (Object subscriber) -> void
+    def self.subscribe: (Object subscriber) -> void
 
-    # Provision a color for the registry
+    # Broadcast a color registration to all subscribers
     #
     # @author {https://aaronmallen.me Aaron Allen}
-    # @since 0.3.2
+    # @since 0.4.0
     #
     # @api private
     #
-    # @param name [Symbol] the name of the color to register
-    # @param rgb_or_hex [Array<Integer>, String] the RGB or Hexadecimal value of the color
+    # @param color_name [Symbol] the color name
     #
     # @return [void]
-    # @rbs (Symbol name, Array[Integer] | String rgb_or_hex) -> void
-    private def self.provision_color: (Symbol name, Array[Integer] | String rgb_or_hex) -> void
+    # @rbs (Symbol name) -> void
+    private def self.broadcast_registration: (Symbol name) -> void
+
+    # The Sai named colors lookup
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since 0.4.0
+    #
+    # @api private
+    #
+    # @return [Hash{Symbol => Array<Integer>}] the named colors lookup
+    private def self.lookup: () -> untyped
 
-    # The Sai named colors registry
+    # The registry subscribers
     #
     # @author {https://aaronmallen.me Aaron Allen}
-    # @since 0.3.2
+    # @since 0.4.0
     #
     # @api private
     #
-    # @return [Hash{Symbol => Array<Integer>}] the named colors registry
-    private def self.registry: () -> untyped
+    # @return [Array<Class, Module, Object>] the subscribers
+    # @rbs () -> Array[Class | Module | Object]
+    private def self.subscribers: () -> Array[Class | Module | Object]
 
     # A Mutex for thread safety
     #
     # @author {https://aaronmallen.me Aaron Allen}
-    # @since 0.3.2
+    # @since 0.4.0
     #
     # @api private
     #