sai-mei 0.1.0

data/lib/sai/mei/palette.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module Sai
+  module Mei
+    # The base module for color palettes
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @abstract Include in subclass and define a constant named COLORS
+    # @api private
+    class Palette
+      # The candidates to be installed
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api public
+      #
+      # @return [Hash{Symbol => Array<Integer>}]
+      attr_reader :candidates #: Hash[Symbol, Array[Integer]]
+
+      # Load the Palette from configuration
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @param config_name [String, Symbol] the name of the configuration to load
+      #
+      # @return [Palette] the loaded Palette
+      # @rbs (String | Symbol config_name) -> Palette
+      def self.load(config_name)
+        lookup = YAML.load_file(
+          File.expand_path("../../../config/#{config_name.to_s.downcase}.yml", File.dirname(__FILE__)),
+          symbolize_names: true
+        )
+
+        if Sai::Mei.const_defined?(config_name)
+          Sai::Mei.const_get(config_name).new(lookup)
+        else
+          Sai::Mei.const_set(config_name, Class.new(Palette)).new(lookup)
+        end
+      end
+
+      # Initialize a new instance of the Palette
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @param lookup [Hash{Symbol => Array<Integer>}] the candidates to be installed
+      #
+      # @return [Palette] a new instance of the Palette
+      # @rbs (Hash[Symbol, Array[Integer]] lookup) -> Palette
+      def initialize(lookup)
+        @candidates = lookup.dup
+        @lookup = lookup.freeze
+      end
+
+      # Get all the names of the color names available in the Palette
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api public
+      #
+      # @example
+      #   Sai::Mei.xterm.all_names #=> [:black, :maroon, :green, ...]
+      #
+      # @return [Array<Symbol>] the names of the colors in the palette
+      def color_names
+        @lookup.keys
+      end
+
+      # Exclude colors from the palette
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api public
+      #
+      # @example
+      #   Sai::Mei.xterm.except(:green, :dodger_blue_2, :spring_green_4).install
+      #
+      # @param color_names [Array<String, Symbol>] the names of the colors to exclude
+      #
+      # @return [Palette] the palette with the specified colors excluded
+      # @rbs (*String | Symbol color_names) -> Palette
+      def excluding(*color_names)
+        @candidates = candidates.except(*color_names.map(&:to_sym))
+        self
+      end
+
+      # Install the candidates into Sai
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api public
+      #
+      # @example
+      #   Sai::Mei.xterm.install
+      #
+      # @return [void]
+      # @rbs () -> void
+      def install
+        candidates.each_pair { |name, color| Sai.register(name, color) }
+      end
+
+      # Limit the color palette to specific named colors
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api public
+      #
+      # @example
+      #   Sai::Mei.xterm.only(:green, :dodger_blue_2, :spring_green_4).install
+      #
+      # @param color_names [Array<String, Symbol>] the names of the colors to restrict the palette to
+      #
+      # @return [self] the palette with the specified colors
+      # @rbs (*String | Symbol color_names) -> self
+      def only(*color_names)
+        @candidates = candidates.slice(*color_names.map(&:to_sym))
+        self
+      end
+
+      # Change the name specific colors in the palette
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api public
+      #
+      # @example
+      #  Sai::Mei.xterm.rename(green: :xterm_green, dodger_blue_3: :xterm_dodger_blue).install
+      #
+      # @param color_map [Hash{String, Symbol => String, Symbol}] the mapping of color names to new names
+      #
+      # @return [self] the palette with the specified colors renamed
+      # @rbs (**String | Symbol color_map) -> self
+      def rename(**color_map)
+        color_map = color_map.transform_keys(&:to_sym).transform_values(&:to_sym) #: Hash[Symbol, Symbol]
+
+        color_map.each_pair do |old_name, new_name|
+          next unless candidates.key?(old_name)
+
+          candidates[new_name] = candidates.delete(old_name) # steep:ignore ArgumentTypeMismatch
+        end
+        self
+      end
+
+      # Reset the candidates to the original state
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api public
+      #
+      # @example
+      #   palette = Sai::Mei.xterm.except(:green)
+      #   palette.candidates.keys.include?(:green) #=> false
+      #   palette.reset.candidates.keys.include?(:green) #=> true
+      #
+      # @return [Palette] the Palette with the candidates reset
+      # @rbs () -> Palette
+      def reset!
+        self.class.new(@lookup.dup)
+      end
+    end
+  end
+end

data/lib/sai/mei.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'sai'
+require 'sai/mei/palette'
+
+module Sai
+  # An elegant color naming system extending Sai with sophisticated color palettes
+  #
+  # Sai-Mei (彩名) - combining Sai's color management with the on'yomi reading for 'name' - provides a comprehensive
+  # collection of named colors extending the Sai color management system. Drawing inspiration from traditional color
+  # vocabularies, Sai-Mei brings rich, curated color palettes to terminal interfaces
+  #
+  # Sai-Mei empowers developers to selectively incorporate sophisticated color collections into
+  # their CLI applications. Like its parent gem Sai, it combines precision with flexibility,
+  # allowing developers to organize and utilize color palettes with fine-grained control
+  #
+  # @author {https://aaronmallen.me Aaron Allen}
+  # @since 0.1.0
+  #
+  # @api public
+  module Mei
+    # The CSS color palette
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api public
+    #
+    # @example Installing the CSS color palette
+    #   Sai::Mei.css.install
+    #
+    # @return [Palette] the CSS color palette instance
+    # @rbs () -> Palette
+    def self.css
+      Palette.load(:CSS)
+    end
+
+    # The Tailwind color palette
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api public
+    #
+    # @example Installing the Tailwind color palette
+    #   Sai::Mei.tailwind.install
+    #
+    # @return [Palette] the Tailwind color palette instance
+    # @rbs () -> Palette
+    def self.tailwind
+      Palette.load(:Tailwind)
+    end
+
+    # The XTERM color palette
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api public
+    #
+    # @example Installing the XTERM color palette
+    #   Sai::Mei.xterm.install
+    #
+    # @return [Palette] the XTERM color palette instance
+    # @rbs () -> Palette
+    def self.xterm
+      Palette.load(:XTERM)
+    end
+  end
+end

data/lib/sai-mei.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'sai/mei'

data/sig/manifest.yaml

@@ -0,0 +1,2 @@
+dependencies:
+  - name: yaml

data/sig/sai/mei/palette.rbs

@@ -0,0 +1,141 @@
+# Generated from lib/sai/mei/palette.rb with RBS::Inline
+
+module Sai
+  module Mei
+    # The base module for color palettes
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @abstract Include in subclass and define a constant named COLORS
+    # @api private
+    class Palette
+      # The candidates to be installed
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api public
+      #
+      # @return [Hash{Symbol => Array<Integer>}]
+      attr_reader candidates: Hash[Symbol, Array[Integer]]
+
+      # Load the Palette from configuration
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @param config_name [String, Symbol] the name of the configuration to load
+      #
+      # @return [Palette] the loaded Palette
+      # @rbs (String | Symbol config_name) -> Palette
+      def self.load: (String | Symbol config_name) -> Palette
+
+      # Initialize a new instance of the Palette
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api private
+      #
+      # @param lookup [Hash{Symbol => Array<Integer>}] the candidates to be installed
+      #
+      # @return [Palette] a new instance of the Palette
+      # @rbs (Hash[Symbol, Array[Integer]] lookup) -> Palette
+      def initialize: (Hash[Symbol, Array[Integer]] lookup) -> void
+
+      # Get all the names of the color names available in the Palette
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api public
+      #
+      # @example
+      #   Sai::Mei.xterm.all_names #=> [:black, :maroon, :green, ...]
+      #
+      # @return [Array<Symbol>] the names of the colors in the palette
+      def color_names: () -> untyped
+
+      # Exclude colors from the palette
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api public
+      #
+      # @example
+      #   Sai::Mei.xterm.except(:green, :dodger_blue_2, :spring_green_4).install
+      #
+      # @param color_names [Array<String, Symbol>] the names of the colors to exclude
+      #
+      # @return [Palette] the palette with the specified colors excluded
+      # @rbs (*String | Symbol color_names) -> Palette
+      def excluding: (*String | Symbol color_names) -> Palette
+
+      # Install the candidates into Sai
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api public
+      #
+      # @example
+      #   Sai::Mei.xterm.install
+      #
+      # @return [void]
+      # @rbs () -> void
+      def install: () -> void
+
+      # Limit the color palette to specific named colors
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api public
+      #
+      # @example
+      #   Sai::Mei.xterm.only(:green, :dodger_blue_2, :spring_green_4).install
+      #
+      # @param color_names [Array<String, Symbol>] the names of the colors to restrict the palette to
+      #
+      # @return [self] the palette with the specified colors
+      # @rbs (*String | Symbol color_names) -> self
+      def only: (*String | Symbol color_names) -> self
+
+      # Change the name specific colors in the palette
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api public
+      #
+      # @example
+      #  Sai::Mei.xterm.rename(green: :xterm_green, dodger_blue_3: :xterm_dodger_blue).install
+      #
+      # @param color_map [Hash{String, Symbol => String, Symbol}] the mapping of color names to new names
+      #
+      # @return [self] the palette with the specified colors renamed
+      # @rbs (**String | Symbol color_map) -> self
+      def rename: (**String | Symbol color_map) -> self
+
+      # Reset the candidates to the original state
+      #
+      # @author {https://aaronmallen.me Aaron Allen}
+      # @since unreleased
+      #
+      # @api public
+      #
+      # @example
+      #   palette = Sai::Mei.xterm.except(:green)
+      #   palette.candidates.keys.include?(:green) #=> false
+      #   palette.reset.candidates.keys.include?(:green) #=> true
+      #
+      # @return [Palette] the Palette with the candidates reset
+      # @rbs () -> Palette
+      def reset!: () -> Palette
+    end
+  end
+end

data/sig/sai/mei.rbs

@@ -0,0 +1,61 @@
+# Generated from lib/sai/mei.rb with RBS::Inline
+
+module Sai
+  # An elegant color naming system extending Sai with sophisticated color palettes
+  #
+  # Sai-Mei (彩名) - combining Sai's color management with the on'yomi reading for 'name' - provides a comprehensive
+  # collection of named colors extending the Sai color management system. Drawing inspiration from traditional color
+  # vocabularies, Sai-Mei brings rich, curated color palettes to terminal interfaces
+  #
+  # Sai-Mei empowers developers to selectively incorporate sophisticated color collections into
+  # their CLI applications. Like its parent gem Sai, it combines precision with flexibility,
+  # allowing developers to organize and utilize color palettes with fine-grained control
+  #
+  # @author {https://aaronmallen.me Aaron Allen}
+  # @since 0.1.0
+  #
+  # @api public
+  module Mei
+    # The CSS color palette
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api public
+    #
+    # @example Installing the CSS color palette
+    #   Sai::Mei.css.install
+    #
+    # @return [Palette] the CSS color palette instance
+    # @rbs () -> Palette
+    def self.css: () -> Palette
+
+    # The Tailwind color palette
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api public
+    #
+    # @example Installing the Tailwind color palette
+    #   Sai::Mei.tailwind.install
+    #
+    # @return [Palette] the Tailwind color palette instance
+    # @rbs () -> Palette
+    def self.tailwind: () -> Palette
+
+    # The XTERM color palette
+    #
+    # @author {https://aaronmallen.me Aaron Allen}
+    # @since unreleased
+    #
+    # @api public
+    #
+    # @example Installing the XTERM color palette
+    #   Sai::Mei.xterm.install
+    #
+    # @return [Palette] the XTERM color palette instance
+    # @rbs () -> Palette
+    def self.xterm: () -> Palette
+  end
+end

data/sig/sai-mei.rbs

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+# Generated from lib/sai-mei.rb with RBS::Inline

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: sai-mei
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Allen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: |-
+  Sai-Mei (彩名) - combining Sai's color management with the on'yomi reading for 'name' - provides a comprehensive collection of named colors extending the Sai color management system. Drawing inspiration from traditional color vocabularies, Sai-Mei brings rich, curated color palettes to terminal interfaces.
+  Sai-Mei empowers developers to selectively incorporate sophisticated color collections into their CLI applications. Like its parent gem Sai, it combines precision with flexibility, allowing developers to organize and utilize color palettes with fine-grained control.
+email:
+- hello@aaronmallen.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- config/css.yml
+- config/tailwind.yml
+- config/xterm.yml
+- lib/sai-mei.rb
+- lib/sai/mei.rb
+- lib/sai/mei/palette.rb
+- sig/manifest.yaml
+- sig/sai-mei.rbs
+- sig/sai/mei.rbs
+- sig/sai/mei/palette.rbs
+homepage: https://github.com/aaronmallen/sai-mei
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/aaronmallen/sai-mei/issues
+  changelog_uri: https://github.com/aaronmallen/sai-mei/releases/tag/0.1.0
+  homepage_uri: https://github.com/aaronmallen/sai-mei
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/aaronmallen/sai-mei/tree/0.1.0
+post_install_message:
+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.3.27
+signing_key:
+specification_version: 4
+summary: An elegant color naming system extending Sai with sophisticated color palettes
+test_files: []