redgreenblue 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65191c26a6dcae9a6bb52abe182d376e0975b79672686120185c9a2b3d49e4e9
-  data.tar.gz: 3fb9dc542660f5edaec8283a2e74ec0687e369e05475bf6840344ca5cca0304f
+  metadata.gz: a61701a3122fc8e8b4f4352142862f7e3d63ed317cea1321cfe1bafd5d697a42
+  data.tar.gz: 4a76d444f8080acb74656963654375e975eb91eb0068f6c4012e9233daf58bb7
 SHA512:
-  metadata.gz: 4c0d6a47aa611822dba62189c14ebf38c0ef6315f08ac9b5eb9efe04b28487d2c95105c0e86536cb52fdc9ce36df445d060623a14e99f2dbab34df5e0d10e515
-  data.tar.gz: 756bdaa8c6859c685e51342ee8a6d34e7340ea0580bd79b4487443d97b04629ed1b7c8f1631bf3ac26a5570e6c243aba7f7b931243ea967f07d8437fa223d495
+  metadata.gz: 502bc188625f8df6fc3a55fa53454728602843ddd39f61c8199009f0e55c1fbd38a496d27c889c565b578ae85dd9cd051a457deec87979374d89006833f37707
+  data.tar.gz: b811b0e1bc0bd366406be48eead2f11328c8304eee6eb34192bc92c40c31a4683dc5771a3944650749707df7e5a40e330d64c02b7f7818c0064dca5253ffe019

data/lib/redgreenblue.rb

@@ -11,7 +11,7 @@ end
 
   hsl hsv hsb
 
-  ostwald
+  ostwald hwb
 
   gamma
 

data/lib/redgreenblue/gpl.rb

@@ -64,13 +64,16 @@ class RGB
       end
     end
 
-    private
-
+    # Returns a header for a .gpl file (Gimp color palette). Includes an optional name and number of columns.
+    #
+    # @example
+    #  RGB.gpl_header('Spring')
+    #
     # Reverse-engineered from:
     # - https://github.com/GNOME/gimp/blob/5d79fba8238a27b8691556489898d33b3fa0dda0/app/core/gimppalette-load.c
-    def gpl_header(name, columns=nil)
+    def gpl_header(name=nil, columns: nil)
       "GIMP Palette\n" +
-      "Name: #{name}\n" +
+      ( name    ? "Name: #{name}\n"       : '' ) +
       ( columns ? "Columns: #{columns}\n" : '' )
     end
 

data/lib/redgreenblue/hwb.rb

@@ -0,0 +1,14 @@
+class RGB
+
+  # Returns the color's hue (0..360), whiteness (0..1), and blackness (0..1), as defined by the HWB color model.
+  #
+  # For achromatic colors, hue is nil.
+  #
+  # Based on:
+  # - http://alvyray.com/Papers/CG/HWB_JGTv208.pdf (PDF)
+  # - https://en.wikipedia.org/wiki/HWB_color_model
+  def hwb
+    [ hsv_h, cwk[1,2] ].flatten
+  end
+
+end

data/lib/redgreenblue/ostwald.rb

@@ -32,12 +32,12 @@ class RGB
   # Based on:
   # - Color for the Sciences, pp. 575–591
   # - https://lirias.kuleuven.be/retrieve/306124 (PDF)
-  def ostwald_cwk
+  def ostwald_cwk(round: true)
     [
       color_portion = values.max - values.min,
       white_portion = values.min,
       1 - color_portion - white_portion
-    ]
+    ].map { |v| round ? v.round(8) : v }
   end
 
   alias cwk ostwald_cwk

data/lib/redgreenblue/version.rb

@@ -1,7 +1,7 @@
 class RGB
 
   # redgreenblue version.
-  VERSION = '0.13.0'
+  VERSION = '0.14.0'
 
   # Returns RGB::VERSION.
   def self.version

data/lib/redgreenblue/web.rb

@@ -62,4 +62,48 @@ class RGB
     "##{hex true}"
   end
 
+  # Returns the names of CSS named colors identical to this color.
+  # @example
+  #  RGB.hex('f0f').css_names
+  def css_names
+    RGB.css(self).map &:name
+  end
+
+  # Returns the color's relative luminance, as defined by the Web Content Accessibility Guidelines (WCAG) 2.0.
+  #
+  # This is different from the Y component of CIE 1931 XYZ.
+  #
+  # Based on:
+  # - https://www.w3.org/TR/WCAG20/#relativeluminancedef
+  def wcag20_luminance(round: true)
+    if color_space == 'sRGB'
+      values.map { |v|
+        if v <= 0.03928
+          v / 12.92
+        else
+          ( ( v + 0.055 ) / 1.055 ) ** 2.4
+        end
+      }.zip( [0.2126, 0.7152, 0.0722] ).map { |c,f|
+        c * f
+      }.inject(:+).instance_eval { |v| round ? v.round(8) : v }
+    else
+      raise "can not calculate luminance for color space '#{color_space}'"
+    end
+  end
+
+  # Returns the contrast ratio for this color and another color, as defined by the Web Content Accessibility Guidelines (WCAG) 2.0.
+  #
+  # Based on:
+  # - https://www.w3.org/TR/WCAG20/#contrast-ratiodef
+  def wcag20_contrast_ratio(another, round: true)
+    luminances = [
+      wcag20_luminance(round: false),
+      another.wcag20_luminance(round: false)
+    ].sort.reverse
+
+    contrast_ratio = ( luminances[0] + 0.05 ) / ( luminances[1] + 0.05 )
+
+    round ? contrast_ratio.round(8) : contrast_ratio
+  end
+
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: redgreenblue
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - lllist.eu
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-09 00:00:00.000000000 Z
+date: 2021-05-03 00:00:00.000000000 Z
 dependencies: []
-description: 
-email: 
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -31,6 +31,7 @@ files:
 - lib/redgreenblue/hsl.rb
 - lib/redgreenblue/hsv.rb
 - lib/redgreenblue/hsx_shared.rb
+- lib/redgreenblue/hwb.rb
 - lib/redgreenblue/inspect.rb
 - lib/redgreenblue/int.rb
 - lib/redgreenblue/lazy.rb
@@ -58,7 +59,7 @@ metadata:
   homepage_uri: https://github.com/lllisteu/redgreenblue
   changelog_uri: https://github.com/lllisteu/redgreenblue/blob/master/History.md
   documentation_uri: https://www.rubydoc.info/gems/redgreenblue/RGB
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -73,8 +74,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A simple Ruby library for handling RGB colors.
 test_files: []