redgreenblue 0.13.0 → 0.16.0

data/lib/redgreenblue/web.rb

@@ -1,9 +1,73 @@
-class RGB
+class RGB::Color
 
   #----------------------------------------------------------------------#
-  #                            Class Methods                             #
+  #                           Instance Methods                           #
   #----------------------------------------------------------------------#
 
+  # Returns the object's RGB value in hexadecimal notation as used in CSS.
+  #
+  # Shortens to 3 digits when possible.
+  def css_hex
+    "##{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
+
+  # Returns true if this is one of the 216 so-called "web safe" colors, otherwise false.
+  def web_safe?
+    ( values - [0.0, 0.2, 0.4, 0.6, 0.8, 1.0] ).empty?
+  end
+
+end
+
+#----------------------------------------------------------------------#
+#                            Module Methods                            #
+#----------------------------------------------------------------------#
+
+module RGB
+
   class << self
 
     # Returns CSS named colors, as per CSS Color Module Level 4.
@@ -42,7 +106,7 @@ class RGB
           @@css.select { |c| c.name =~ r }
         when Integer
           @@css[selector]
-        when self
+        when RGB::Color
           @@css.select { |c| c == selector }
         else
           raise ArgumentError, 'Unsupported selector'
@@ -51,15 +115,4 @@ class RGB
 
   end
 
-  #----------------------------------------------------------------------#
-  #                           Instance Methods                           #
-  #----------------------------------------------------------------------#
-
-  # Returns the object's RGB value in hexadecimal notation as used in CSS.
-  #
-  # Shortens to 3 digits when possible.
-  def css_hex
-    "##{hex true}"
-  end
-
 end

data/lib/redgreenblue.rb

@@ -1,4 +1,23 @@
-class RGB
+# The RGB module is the main namespace for redgreenblue.
+#
+# This module has many helper methods for creating RGB::Color objects.
+# The example below shows seven ways to create an RGB::Color object for the exact same color.
+# @example
+#  require 'redgreenblue'
+#
+#  pink = RGB.new(1, 0.6, 0.8)
+#  pink = RGB.rgb(255, 153, 204)
+#  pink = RGB.rrggbb(65535, 39321, 52428)
+#  pink = RGB.hex('f9c')
+#  pink = RGB.hsl(330, 1, 0.8)
+#  pink = RGB.hsv(330, 0.4, 1)
+#  pink = RGB.at(16751052)
+module RGB
+
+  # This class represents an RGB color.
+  class Color
+  end
+
 end
 
 %w(
@@ -11,11 +30,11 @@ end
 
   hsl hsv hsb
 
-  ostwald
+  ostwald hwb
 
   gamma
 
-  cie_1931 cie_1976
+  cie_1931 cie_1976 cie_1994
 
   name
 

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: redgreenblue
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.16.0
 platform: ruby
 authors:
 - lllist.eu
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-09 00:00:00.000000000 Z
+date: 2022-06-09 00:00:00.000000000 Z
 dependencies: []
-description: 
-email: 
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -23,6 +23,7 @@ files:
 - lib/redgreenblue/bgr24bit.rb
 - lib/redgreenblue/cie_1931.rb
 - lib/redgreenblue/cie_1976.rb
+- lib/redgreenblue/cie_1994.rb
 - lib/redgreenblue/gamma.rb
 - lib/redgreenblue/gif.rb
 - lib/redgreenblue/gpl.rb
@@ -31,6 +32,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 +60,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 +75,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.3.11
+signing_key:
 specification_version: 4
 summary: A simple Ruby library for handling RGB colors.
 test_files: []