color_converters 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c97c6fdaf99305ee413b3648f6c16b8fe9a83124696af3e3e161fae19d71fe19
-  data.tar.gz: b0c6e84ebde615a1b7d044aaa85556e16e1ca9bfa0181232c238b74a1d80d25f
+  metadata.gz: 571bd439610154032f4532335702ecb175cd3b022b966843b81ebc26c12a5411
+  data.tar.gz: 33dad1ab16c74560c7fd4587392400002cc863ee16e77bff739e28577f1b9451
 SHA512:
-  metadata.gz: 1c42e5f3097a878896c29b317856cfd3b9d3458b24ad66c69ac1cf550a50c7bd72e04c135157ef582d8f8ce0408500624f7776339c8949442ea41c1cfec77956
-  data.tar.gz: 8a6310fd2eaa1b323236111ddb96732ad84fca43edfd4e39805afd614499c2afee09b481e81fdcb454187e45637c57770a3e4676c346238641aaf23e686220d4
+  metadata.gz: 6c9138a8fa458032dfcc2319a2d188a545e9042cfe740d168b737a5d984b4ec94501efce7d384a54baf3ea717384e6b9cc0fbebc8d085a2eb46c24879fa2cefb
+  data.tar.gz: 5cdd92b601b6458552e617413ff4cd1b884571009d5d565e727e47d57da202feb9e9b4b6a6e8ac0fd2592b612b055bc9aa78cbe530f85336bc5fb0d2a07ed236

data/README.md

@@ -63,10 +63,10 @@ color = ColorConverters::Color.new(c: 74, m: 58, y: 22, k: 3)
 color = ColorConverters::Color.new(x: 16, y: 44, z: 32)
 
 # from cielab
-color = ColorConverters::Color.new(l: 16, a: 44, b: 32)
+color = ColorConverters::Color.new(l: 16, a: 44, b: 32, space: :cie)
 
-# from oklch
-color = ColorConverters::Color.new(l: 16, c: 44, h: 32)
+# from cielch
+color = ColorConverters::Color.new(l: 16, c: 44, h: 32, space: :cie)
 
 # from textual color
 color = ColorConverters::Color.new("blue")
@@ -109,7 +109,7 @@ color.xyz
 color.cielab
 => {:l=>52.47, :a=>-4.08, :b=>-32.19}
 
-color.oklch
+color.cielch
 => {:l=>52.47, :c=>32.45, :h=>262.78}
 
 color.hex
@@ -121,6 +121,15 @@ color.name
 
 ## Options
 
+### space
+
+As there are certain color spaces that use the same letter keys, there needed to be a way to different between those space.
+The space parameter allows that, with examples in the usage code above
+
+```ruby
+ColorConverters::Color.new(l: 64, a: 28, b: -15, space: :cie)
+```
+
 ### limit_override
 
 By default all values are checked to be within the expected number ranges, i.e.; rgb between 0-255 each.

data/lib/color_converters/base_converter.rb

@@ -26,6 +26,8 @@ module ColorConverters
     def initialize(color_input, limit_override = false)
       @original_value = color_input
 
+      # self.clamp_input(color_input) if limit_clamp == true
+
       if limit_override == false && !self.validate_input(color_input)
         raise InvalidColorError # validation method is defined in each convertor
       end
@@ -72,13 +74,13 @@ module ColorConverters
     end
 
     def cielab
-      l, a, b = CielabConverter.xyz_to_lab(XyzConverter.rgb_to_xyz(self.rgb_array_frac))
+      l, a, b = CielabConverter.xyz_to_cielab(XyzConverter.rgb_to_xyz(self.rgb_array_frac))
 
       { l: l.round(OUTPUT_DP), a: a.round(OUTPUT_DP), b: b.round(OUTPUT_DP) }
     end
 
-    def oklch
-      l, c, h = OklchConverter.lab_to_lch(CielabConverter.xyz_to_lab(XyzConverter.rgb_to_xyz(self.rgb_array_frac)))
+    def cielch
+      l, c, h = CielchConverter.cielab_to_cielch(CielabConverter.xyz_to_cielab(XyzConverter.rgb_to_xyz(self.rgb_array_frac)))
 
       { l: l.round(OUTPUT_DP), c: c.round(OUTPUT_DP), h: h.round(OUTPUT_DP) }
     end

data/lib/color_converters/color.rb

@@ -1,7 +1,7 @@
 module ColorConverters
   class Color
     extend Forwardable
-    def_delegators :@converter, :rgb, :hex, :hsl, :hsv, :hsb, :cmyk, :xyz, :cielab, :oklch, :name, :alpha
+    def_delegators :@converter, :rgb, :hex, :hsl, :hsv, :hsb, :cmyk, :xyz, :cielab, :cielch, :name, :alpha
 
     def initialize(color)
       @converter = BaseConverter.factory(color)

data/lib/color_converters/converters/cielab_converter.rb

@@ -3,7 +3,7 @@ module ColorConverters
     def self.matches?(color_input)
       return false unless color_input.is_a?(Hash)
 
-      color_input.keys - [:l, :a, :b] == []
+      color_input.keys - [:l, :a, :b, :space] == [] && color_input[:space].to_s == 'cie'
     end
 
     def self.bounds
@@ -18,11 +18,11 @@ module ColorConverters
     end
 
     def input_to_rgba(color_input)
-      xyz_hash = CielabConverter.lab_to_xyz(color_input)
+      xyz_hash = CielabConverter.cielab_to_xyz(color_input)
       XyzConverter.new(xyz_hash, limit_override: true).rgba
     end
 
-    def self.lab_to_xyz(color_input)
+    def self.cielab_to_xyz(color_input)
       l = color_input[:l].to_f
       a = color_input[:a].to_f
       b = color_input[:b].to_f
@@ -48,7 +48,7 @@ module ColorConverters
       { x: x, y: y, z: z }
     end
 
-    def self.xyz_to_lab(xyz_array)
+    def self.xyz_to_cielab(xyz_array)
       x, y, z = xyz_array
 
       # The D65 standard illuminant white point

data/lib/color_converters/converters/{oklch_converter.rb → cielch_converter.rb}

@@ -1,9 +1,9 @@
 module ColorConverters
-  class OklchConverter < BaseConverter
+  class CielchConverter < BaseConverter
     def self.matches?(color_input)
       return false unless color_input.is_a?(Hash)
 
-      color_input.keys - [:l, :c, :h] == []
+      color_input.keys - [:l, :c, :h, :space] == [] && color_input[:space].to_s == 'cie'
     end
 
     def self.bounds
@@ -13,17 +13,17 @@ module ColorConverters
     private
 
     def validate_input(color_input)
-      bounds = OklchConverter.bounds
+      bounds = CielchConverter.bounds
       color_input[:l].to_f.between?(*bounds[:l]) && color_input[:c].to_f.between?(*bounds[:c]) && color_input[:h].to_f.between?(*bounds[:h])
     end
 
     def input_to_rgba(color_input)
-      lab_hash = OklchConverter.lch_to_lab(color_input)
-      xyz_hash = CielabConverter.lab_to_xyz(lab_hash)
+      lab_hash = CielchConverter.cielch_to_cielab(color_input)
+      xyz_hash = CielabConverter.cielab_to_xyz(lab_hash)
       XyzConverter.new(xyz_hash, limit_override: true).rgba
     end
 
-    def self.lch_to_lab(color_input)
+    def self.cielch_to_cielab(color_input)
       l = color_input[:l].to_f
       c = color_input[:c].to_f
       h = color_input[:h].to_f
@@ -36,7 +36,7 @@ module ColorConverters
       { l: l, a: a, b: b }
     end
 
-    def self.lab_to_lch(lab_array)
+    def self.cielab_to_cielch(lab_array)
       l, aa, bb = lab_array
 
       c = ((aa**2) + (bb**2))**0.5

data/lib/color_converters/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ColorConverters
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/color_converters.rb

@@ -16,7 +16,7 @@ require 'color_converters/converters/hsv_converter'
 require 'color_converters/converters/cmyk_converter'
 require 'color_converters/converters/xyz_converter'
 require 'color_converters/converters/cielab_converter'
-require 'color_converters/converters/oklch_converter'
+require 'color_converters/converters/cielch_converter'
 
 require 'color_converters/converters/name_converter'
 require 'color_converters/converters/null_converter'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: color_converters
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Louis Davis
 bindir: bin
 cert_chain: []
-date: 2025-06-25 00:00:00.000000000 Z
+date: 2025-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -36,6 +36,7 @@ files:
 - lib/color_converters/base_converter.rb
 - lib/color_converters/color.rb
 - lib/color_converters/converters/cielab_converter.rb
+- lib/color_converters/converters/cielch_converter.rb
 - lib/color_converters/converters/cmyk_converter.rb
 - lib/color_converters/converters/hex_converter.rb
 - lib/color_converters/converters/hsl_converter.rb
@@ -43,7 +44,6 @@ files:
 - lib/color_converters/converters/hsv_converter.rb
 - lib/color_converters/converters/name_converter.rb
 - lib/color_converters/converters/null_converter.rb
-- lib/color_converters/converters/oklch_converter.rb
 - lib/color_converters/converters/rgb_converter.rb
 - lib/color_converters/converters/rgb_string_converter.rb
 - lib/color_converters/converters/xyz_converter.rb