abachrome 0.1.0 → 0.1.2

data/lib/abachrome/to_abcd.rb

@@ -1,7 +1,15 @@
-# frozen_string_literal: true
+#
 
 module Abachrome
   module ToAbcd
+    # Converts the receiver to an AbcDecimal object.
+    # 
+    # This method converts the receiver (typically a numeric value) to an AbcDecimal
+    # instance, which provides high precision decimal arithmetic capabilities for
+    # color space calculations.
+    # 
+    # @return [Abachrome::AbcDecimal] a new AbcDecimal instance representing the
+    # same numeric value as the receiver
     def to_abcd
       AbcDecimal.new(self)
     end
@@ -10,4 +18,4 @@ end
 
 [Numeric, String, Rational].each do |klass|
   klass.include(Abachrome::ToAbcd)
-end
+end

data/lib/abachrome/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
+#
 
 module Abachrome
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/abachrome.rb

@@ -1,4 +1,18 @@
-# frozen_string_literal: true
+# Abachrome - A Ruby color manipulation library
+#
+# This is the main entry point for the Abachrome library, providing color creation,
+# conversion, and manipulation capabilities across multiple color spaces including
+# sRGB, OKLAB, OKLCH, and linear RGB.
+#
+# Key features:
+# - Create colors from RGB, OKLAB, OKLCH values or hex strings
+# - Convert between different color spaces
+# - Parse colors from hex codes and CSS color names
+# - Register custom color spaces and converters
+# - High-precision decimal arithmetic for accurate color calculations
+#
+# The library uses autoloading for efficient memory usage and provides both
+# functional and object-oriented APIs for color operations.
 
 require_relative "abachrome/to_abcd"
 
@@ -57,27 +71,69 @@ module Abachrome
     autoload :Hex, "abachrome/parsers/hex"
   end
 
+  # Creates a new color in the specified color space with given coordinates and alpha value.
+  # 
+  # @param space_name [Symbol, String] The name of the color space (e.g., :srgb, :oklch)
+  # @param coordinates [Array<Numeric>] The color coordinates in the specified color space
+  # @param alpha [Float] The alpha (opacity) value of the color, defaults to 1.0 (fully opaque)
+  # @return [Abachrome::Color] A new Color object in the specified color space with the given coordinates
   def create_color(space_name, *coordinates, alpha: 1.0)
     space = ColorSpace.find(space_name)
     Color.new(space, coordinates, alpha)
   end
 
+  # Creates a color object from RGB values.
+  # 
+  # @param r [Numeric] The red component value (typically 0-255 or 0.0-1.0)
+  # @param g [Numeric] The green component value (typically 0-255 or 0.0-1.0)
+  # @param b [Numeric] The blue component value (typically 0-255 or 0.0-1.0)
+  # @param alpha [Float] The alpha (opacity) component value (0.0-1.0), defaults to 1.0 (fully opaque)
+  # @return [Abachrome::Color] A new Color object initialized with the specified RGB values
   def from_rgb(r, g, b, alpha = 1.0)
     Color.from_rgb(r, g, b, alpha)
   end
 
+  # Creates a color in the OKLAB color space.
+  # 
+  # @param l [Numeric] The lightness component (L) in the OKLAB color space, typically in range 0 to 1
+  # @param a [Numeric] The green-red component (a) in the OKLAB color space
+  # @param b [Numeric] The blue-yellow component (b) in the OKLAB color space
+  # @param alpha [Float] The alpha (opacity) value, ranging from 0.0 (transparent) to 1.0 (opaque), defaults to 1.0
+  # @return [Abachrome::Color] A new Color object in the OKLAB color space
   def from_oklab(l, a, b, alpha = 1.0)
     Color.from_oklab(l, a, b, alpha)
   end
 
+  # Creates a new color from OKLCH color space values.
+  # 
+  # @param l [Numeric] The lightness value, typically in range 0-1
+  # @param a [Numeric] The chroma (colorfulness) value
+  # @param b [Numeric] The hue angle value in degrees (0-360)
+  # @param alpha [Numeric] The alpha (opacity) value, between 0-1 (default: 1.0)
+  # @return [Abachrome::Color] A new color object initialized with the given OKLCH values
   def from_oklch(l, a, b, alpha = 1.0)
     Color.from_oklch(l, a, b, alpha)
   end
 
+  # Creates a color object from a hexadecimal color code string.
+  # 
+  # @param hex_str [String] The hexadecimal color code string to parse. Can be in formats like
+  # "#RGB", "#RRGGBB", "RGB", or "RRGGBB", with or without the leading "#" character.
+  # @return [Abachrome::Color] A new Color object representing the parsed hexadecimal color.
+  # @example
+  # Abachrome.from_hex("#ff0000") # => returns a red Color object
+  # Abachrome.from_hex("00ff00")  # => returns a green Color object
+  # @see Abachrome::Parsers::Hex.parse
   def from_hex(hex_str)
     Parsers::Hex.parse(hex_str)
   end
 
+  # Creates a color object from a CSS color name.
+  # 
+  # @param color_name [String] The CSS color name (e.g., 'red', 'blue', 'cornflowerblue').
+  # Case-insensitive.
+  # @return [Abachrome::Color, nil] A color object in the RGB color space if the name is valid,
+  # nil if the color name is not recognized.
   def from_name(color_name)
     rgb_values = Named::CSS::ColorNames[color_name.downcase]
     return nil unless rgb_values
@@ -85,15 +141,35 @@ module Abachrome
     from_rgb(*rgb_values.map { |v| v / 255.0 })
   end
 
+  # Convert a color from its current color space to another color space.
+  # 
+  # @param color [Abachrome::Color] The color object to convert
+  # @param to_space [Symbol, String] The destination color space identifier (e.g. :srgb, :oklch)
+  # @return [Abachrome::Color] A new color object in the specified color space
   def convert(color, to_space)
     Converter.convert(color, to_space)
   end
 
+  # Register a new color space with the Abachrome library.
+  # 
+  # @param name [Symbol, String] The identifier for the color space being registered
+  # @param block [Proc] A block that defines the color space properties and conversion rules
+  # @return [Abachrome::ColorSpace] The newly registered color space object
   def register_color_space(name, &block)
     ColorSpace.register(name, &block)
   end
 
+  # Register a new color space converter in the Abachrome system.
+  # 
+  # This method allows registering custom converters between color spaces.
+  # Converters are used to transform color representations from one color
+  # space to another.
+  # 
+  # @param from_space [Symbol, String] The source color space identifier
+  # @param to_space [Symbol, String] The destination color space identifier
+  # @param converter [#call] An object responding to #call that performs the conversion
+  # @return [void]
   def register_converter(from_space, to_space, converter)
     Converter.register(from_space, to_space, converter)
   end
-end
+end

metadata

@@ -1,96 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: abachrome
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
-- Durable Programming, LLC
+- Durable Programming
 autorequire:
 bindir: exe
 cert_chain: []
 date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bigdecimal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: dry-inflector
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.25.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.25.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.22.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.22.0
-description: 'Abachrome provides a robust set of tools for working with colors: parsing,
-  manipulation, conversion, etc. Supports RGB, HSV, OkLab and OkLch.'
+        version: '1.0'
+description: Abachrome provides a robust set of tools for working with various color
+  formats including hex, RGB, HSL, and named colors. Features support for multiple
+  color spaces (RGB, HSL, Lab, Oklab), color space conversion, gamut mapping, CSS
+  color parsing and formatting, and high-precision color calculations using BigDecimal.
 email:
-- info@durableprogramming.com
+- commercial@durableprogramming.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".envrc"
 - ".rubocop.yml"
 - CHANGELOG.md
 - README.md
+- Rakefile
 - demos/ncurses/plasma.rb
 - devenv.lock
 - devenv.nix
@@ -106,23 +54,34 @@ files:
 - lib/abachrome/color_mixins/to_oklch.rb
 - lib/abachrome/color_mixins/to_srgb.rb
 - lib/abachrome/color_models/hsv.rb
+- lib/abachrome/color_models/lms.rb
 - lib/abachrome/color_models/oklab.rb
 - lib/abachrome/color_models/oklch.rb
 - lib/abachrome/color_models/rgb.rb
+- lib/abachrome/color_models/xyz.rb
 - lib/abachrome/color_space.rb
 - lib/abachrome/converter.rb
 - lib/abachrome/converters/base.rb
+- lib/abachrome/converters/lms_to_lrgb.rb
+- lib/abachrome/converters/lms_to_srgb.rb
+- lib/abachrome/converters/lms_to_xyz.rb
+- lib/abachrome/converters/lrgb_to_lms.rb
 - lib/abachrome/converters/lrgb_to_oklab.rb
 - lib/abachrome/converters/lrgb_to_srgb.rb
+- lib/abachrome/converters/lrgb_to_xyz.rb
+- lib/abachrome/converters/oklab_to_lms.rb
 - lib/abachrome/converters/oklab_to_lrgb.rb
 - lib/abachrome/converters/oklab_to_oklch.rb
 - lib/abachrome/converters/oklab_to_srgb.rb
 - lib/abachrome/converters/oklch_to_lrgb.rb
 - lib/abachrome/converters/oklch_to_oklab.rb
 - lib/abachrome/converters/oklch_to_srgb.rb
+- lib/abachrome/converters/oklch_to_xyz.rb
 - lib/abachrome/converters/srgb_to_lrgb.rb
 - lib/abachrome/converters/srgb_to_oklab.rb
 - lib/abachrome/converters/srgb_to_oklch.rb
+- lib/abachrome/converters/xyz_to_lms.rb
+- lib/abachrome/converters/xyz_to_oklab.rb
 - lib/abachrome/gamut/base.rb
 - lib/abachrome/gamut/p3.rb
 - lib/abachrome/gamut/rec2020.rb
@@ -141,15 +100,15 @@ files:
 - lib/abachrome/parsers/hex.rb
 - lib/abachrome/to_abcd.rb
 - lib/abachrome/version.rb
+- logo.png
+- logo.webp
 homepage: https://github.com/durableprogramming/abachrome
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/durableprogramming/abachrome
   source_code_uri: https://github.com/durableprogramming/abachrome
   changelog_uri: https://github.com/durableprogramming/abachrome/blob/main/CHANGELOG.md
-  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -165,8 +124,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
-summary: Color parsing, manipulation, and formatting tools.
+summary: A Ruby gem for parsing, manipulating, and managing colors
 test_files: []