color_converters 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41c9c2e35a56c7fcbc75a4b96a923cef9c106c260b2eb567caa958404042466a
-  data.tar.gz: f8ee279b96b83cb0938acc291a58752e495c2a6295227f9d3ad5f88ea33ad280
+  metadata.gz: 571bd439610154032f4532335702ecb175cd3b022b966843b81ebc26c12a5411
+  data.tar.gz: 33dad1ab16c74560c7fd4587392400002cc863ee16e77bff739e28577f1b9451
 SHA512:
-  metadata.gz: f9db0a0eec4f2380b45a21be819e5c698dbdcf73e5fbf064e2f97f90a0debd46e62e6e5fc63a07ea64b0ba1c84e2150dc6475d029a577747376f27d3acbe9fd1
-  data.tar.gz: e1a9aec3fee9cb4a467f6d16b42482088c5af3390dead1574015d1cea5e4bdeff69d314f73c9a60566b0ef6d0d087b696235783029888a5da993a351839761e6
+  metadata.gz: 6c9138a8fa458032dfcc2319a2d188a545e9042cfe740d168b737a5d984b4ec94501efce7d384a54baf3ea717384e6b9cc0fbebc8d085a2eb46c24879fa2cefb
+  data.tar.gz: 5cdd92b601b6458552e617413ff4cd1b884571009d5d565e727e47d57da202feb9e9b4b6a6e8ac0fd2592b612b055bc9aa78cbe530f85336bc5fb0d2a07ed236

data/README.md

@@ -41,49 +41,49 @@ Initialize a color:
 
 ```ruby
 # from hex
-color = Color.new("#3366cc")
-color = Color.new("#36c")
+color = ColorConverters::Color.new("#3366cc")
+color = ColorConverters::Color.new("#36c")
 
 # from rgb(a)
-color = Color.new(r: 51, g: 102, b: 204)
-color = Color.new(r: 51, g: 102, b: 204, a: 0.5)
+color = ColorConverters::Color.new(r: 51, g: 102, b: 204)
+color = ColorConverters::Color.new(r: 51, g: 102, b: 204, a: 0.5)
 
 # from hsl(a)
-color = Color.new(h: 225, s: 73, l: 57)
-color = Color.new(h: 225, s: 73, l: 57, a: 0.5)
+color = ColorConverters::Color.new(h: 225, s: 73, l: 57)
+color = ColorConverters::Color.new(h: 225, s: 73, l: 57, a: 0.5)
 
 # from hsv/hsb
-color = Color.new(h: 220, s: 75, v: 80)
-color = Color.new(h: 220, s: 75, b: 80)
+color = ColorConverters::Color.new(h: 220, s: 75, v: 80)
+color = ColorConverters::Color.new(h: 220, s: 75, b: 80)
 
 # from cmyk
-color = Color.new(c: 74, m: 58, y: 22, k: 3)
+color = ColorConverters::Color.new(c: 74, m: 58, y: 22, k: 3)
 
 # from xyz
-color = Color.new(x: 16, y: 44, z: 32)
+color = ColorConverters::Color.new(x: 16, y: 44, z: 32)
 
 # from cielab
-color = Color.new(l: 16, a: 44, b: 32)
+color = ColorConverters::Color.new(l: 16, a: 44, b: 32, space: :cie)
 
-# from oklch
-color = 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 = Color.new("blue")
+color = ColorConverters::Color.new("blue")
 
 # from a css rgb(a) string
-color = Color.new("rgb(51, 102, 204)")
-color = Color.new("rgba(51, 102, 204, 0.5)")
+color = ColorConverters::Color.new("rgb(51, 102, 204)")
+color = ColorConverters::Color.new("rgba(51, 102, 204, 0.5)")
 
 # from a css hsl(a) string
-color = Color.new("hsl(225, 73%, 57%)")
-color = Color.new("hsl(225, 73%, 57%, 0.5)")
+color = ColorConverters::Color.new("hsl(225, 73%, 57%)")
+color = ColorConverters::Color.new("hsl(225, 73%, 57%, 0.5)")
 ```
 
 Converters
 
 ```ruby
-color = Color.new(r: 70, g: 130, b: 180, a: 0.5)
+color = ColorConverters::Color.new(r: 70, g: 130, b: 180, a: 0.5)
 
 color.alpha
 => 0.5
@@ -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,13 +121,22 @@ 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.
 This parameter allows you to ignore those ranges and submit any values you want.
 
 ```ruby
-Color.new(r: 270, g: 1300, b: 380, a: 0.5, limit_override: true)
+ColorConverters::Color.new(r: 270, g: 1300, b: 380, a: 0.5, limit_override: true)
 ```
 
 ## Development

data/lib/{color_converter → color_converters}/base_converter.rb

@@ -1,6 +1,6 @@
 require 'active_support/core_ext/object/blank'
 
-module ColorConverter
+module ColorConverters
   class BaseConverter
     IMPORT_DP = 2
     OUTPUT_DP = 2
@@ -26,6 +26,8 @@ module ColorConverter
     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 ColorConverter
     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_converter → color_converters}/color.rb

@@ -1,7 +1,7 @@
-module ColorConverter
+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_converter/color_converters → color_converters/converters}/cielab_converter.rb

@@ -1,9 +1,9 @@
-module ColorConverter
+module ColorConverters
   class CielabConverter < BaseConverter
     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 ColorConverter
     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 ColorConverter
       { 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_converter/color_converters/oklch_converter.rb → color_converters/converters/cielch_converter.rb}

@@ -1,9 +1,9 @@
-module ColorConverter
-  class OklchConverter < BaseConverter
+module ColorConverters
+  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 ColorConverter
     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 ColorConverter
       { 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_converter/color_converters → color_converters/converters}/cmyk_converter.rb

@@ -1,4 +1,4 @@
-module ColorConverter
+module ColorConverters
   class CmykConverter < BaseConverter
     def self.matches?(color_input)
       return false unless color_input.is_a?(Hash)

data/lib/{color_converter/color_converters → color_converters/converters}/hex_converter.rb

@@ -1,4 +1,4 @@
-module ColorConverter
+module ColorConverters
   class HexConverter < BaseConverter
     def self.matches?(color)
       return false unless color.is_a?(String)
@@ -9,8 +9,8 @@ module ColorConverter
     private
 
     def validate_input(color_input)
+      # TODO
       true
-      # color_input[:l].to_f.between?(0.0, 100.0) && color_input[:a].between?(-128.0, 127.0) && color_input[:b].between?(-128.0, 127.0)
     end
 
     def input_to_rgba(color_input)

data/lib/{color_converter/color_converters → color_converters/converters}/hsl_converter.rb

@@ -1,4 +1,4 @@
-module ColorConverter
+module ColorConverters
   class HslConverter < BaseConverter
     def self.matches?(color_input)
       return false unless color_input.is_a?(Hash)

data/lib/{color_converter/color_converters → color_converters/converters}/hsl_string_converter.rb

@@ -1,4 +1,4 @@
-module ColorConverter
+module ColorConverters
   class HslStringConverter < BaseConverter
     def self.matches?(color_input)
       return false unless color_input.is_a?(String)
@@ -10,7 +10,6 @@ module ColorConverter
 
     def validate_input(color_input)
       true
-      # color_input[:l].between?(0.0, 100.0) && color_input[:a].between?(-128.0, 127.0) && color_input[:b].between?(-128.0, 127.0)
     end
 
     def input_to_rgba(color_input)

data/lib/{color_converter/color_converters → color_converters/converters}/hsv_converter.rb

@@ -1,4 +1,4 @@
-module ColorConverter
+module ColorConverters
   class HsvConverter < BaseConverter
     def self.matches?(color_input)
       return false unless color_input.is_a?(Hash)

data/lib/{color_converter/color_converters → color_converters/converters}/name_converter.rb

@@ -1,4 +1,4 @@
-module ColorConverter
+module ColorConverters
   class NameConverter < BaseConverter
     def self.matches?(color_input)
       return false unless color_input.is_a?(String)
@@ -15,9 +15,9 @@ module ColorConverter
 
     private
 
-    def validate_input(color_input)
+    def validate_input(color_input) #
+      # TODO: validate against list of keys?
       true
-      # color_input[:l].between?(0.0, 100.0) && color_input[:a].between?(-128.0, 127.0) && color_input[:b].between?(-128.0, 127.0)
     end
 
     def input_to_rgba(color_input)

data/lib/{color_converter/color_converters → color_converters/converters}/null_converter.rb

@@ -1,4 +1,4 @@
-module ColorConverter
+module ColorConverters
   class NullConverter < BaseConverter
     def self.matches?(_color_input)
       true

data/lib/{color_converter/color_converters → color_converters/converters}/rgb_converter.rb

@@ -1,4 +1,4 @@
-module ColorConverter
+module ColorConverters
   class RgbConverter < BaseConverter
     def self.matches?(color_input)
       return false unless color_input.is_a?(Hash)

data/lib/{color_converter/color_converters → color_converters/converters}/rgb_string_converter.rb

@@ -1,4 +1,4 @@
-module ColorConverter
+module ColorConverters
   class RgbStringConverter < BaseConverter
     def self.matches?(color_input)
       return false unless color_input.is_a?(String)
@@ -10,7 +10,6 @@ module ColorConverter
 
     def validate_input(color_input)
       true
-      # color_input[:l].between?(0.0, 100.0) && color_input[:a].between?(-128.0, 127.0) && color_input[:b].between?(-128.0, 127.0)
     end
 
     def input_to_rgba(color_input)

data/lib/{color_converter/color_converters → color_converters/converters}/xyz_converter.rb

@@ -1,4 +1,4 @@
-module ColorConverter
+module ColorConverters
   class XyzConverter < BaseConverter
     def self.matches?(color_input)
       return false unless color_input.is_a?(Hash)

data/lib/color_converters/version.rb

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

data/lib/color_converters.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+require 'color_converters/version'
+
+require 'color_converters/color'
+require 'color_converters/base_converter'
+
+require 'color_converters/converters/rgb_converter'
+require 'color_converters/converters/rgb_string_converter'
+require 'color_converters/converters/hex_converter'
+require 'color_converters/converters/hsl_converter'
+require 'color_converters/converters/hsl_string_converter'
+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/cielch_converter'
+
+require 'color_converters/converters/name_converter'
+require 'color_converters/converters/null_converter'
+
+module ColorConverters
+  class Error < StandardError; end
+  class InvalidColorError < Error; end
+  # Your code goes here...
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: color_converters
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  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
@@ -32,22 +32,22 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
-- lib/color_converter.rb
-- lib/color_converter/base_converter.rb
-- lib/color_converter/color.rb
-- lib/color_converter/color_converters/cielab_converter.rb
-- lib/color_converter/color_converters/cmyk_converter.rb
-- lib/color_converter/color_converters/hex_converter.rb
-- lib/color_converter/color_converters/hsl_converter.rb
-- lib/color_converter/color_converters/hsl_string_converter.rb
-- lib/color_converter/color_converters/hsv_converter.rb
-- lib/color_converter/color_converters/name_converter.rb
-- lib/color_converter/color_converters/null_converter.rb
-- lib/color_converter/color_converters/oklch_converter.rb
-- lib/color_converter/color_converters/rgb_converter.rb
-- lib/color_converter/color_converters/rgb_string_converter.rb
-- lib/color_converter/color_converters/xyz_converter.rb
-- lib/color_converter/version.rb
+- lib/color_converters.rb
+- 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
+- lib/color_converters/converters/hsl_string_converter.rb
+- 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/rgb_converter.rb
+- lib/color_converters/converters/rgb_string_converter.rb
+- lib/color_converters/converters/xyz_converter.rb
+- lib/color_converters/version.rb
 homepage: https://github.com/louiswdavis/color_converters
 licenses:
 - MIT

data/lib/color_converter/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module ColorConverter
-  VERSION = '0.1.0'
-end

data/lib/color_converter.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-require 'forwardable'
-
-require 'color_converter/version'
-
-require 'color_converter/color'
-require 'color_converter/base_converter'
-
-require 'color_converter/color_converters/rgb_converter'
-require 'color_converter/color_converters/rgb_string_converter'
-require 'color_converter/color_converters/hex_converter'
-require 'color_converter/color_converters/hsl_converter'
-require 'color_converter/color_converters/hsl_string_converter'
-require 'color_converter/color_converters/hsv_converter'
-require 'color_converter/color_converters/cmyk_converter'
-require 'color_converter/color_converters/xyz_converter'
-require 'color_converter/color_converters/cielab_converter'
-require 'color_converter/color_converters/oklch_converter'
-
-require 'color_converter/color_converters/name_converter'
-require 'color_converter/color_converters/null_converter'
-
-module ColorConverter
-  class Error < StandardError; end
-  class InvalidColorError < Error; end
-  # Your code goes here...
-end