redgreenblue 0.9.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3acd4edad3c6c358886e6c49138133f207571b610d8ea980fd6ff4d0cb38b7a8
-  data.tar.gz: 81833b3ed57dfcde3c0558f196e7be284ac040e56330019a994e214b39c75463
+  metadata.gz: a61701a3122fc8e8b4f4352142862f7e3d63ed317cea1321cfe1bafd5d697a42
+  data.tar.gz: 4a76d444f8080acb74656963654375e975eb91eb0068f6c4012e9233daf58bb7
 SHA512:
-  metadata.gz: 57a8b63684a52f0495ee14c47a391a42bce9ce40914b9eee7523d1685fc4a66135ccb453b9c5c2ab68900dc700266e71651cb420fd0cd3cbdcf57cecb3012d27
-  data.tar.gz: 78917822fe1a7cd67acc98912adf1107736609fd996300003bc7c77ff02cbfcdabf6efce4b86481f27dbb568612237dbee726563de76dab1b60188b9c27e2ef8
+  metadata.gz: 502bc188625f8df6fc3a55fa53454728602843ddd39f61c8199009f0e55c1fbd38a496d27c889c565b578ae85dd9cd051a457deec87979374d89006833f37707
+  data.tar.gz: b811b0e1bc0bd366406be48eead2f11328c8304eee6eb34192bc92c40c31a4683dc5771a3944650749707df7e5a40e330d64c02b7f7818c0064dca5253ffe019

data/lib/redgreenblue.rb

@@ -1,30 +1,30 @@
 class RGB
 end
 
-require 'redgreenblue/version'
+%w(
 
-require 'redgreenblue/base'
+  version
 
-require 'redgreenblue/24bit'
-require 'redgreenblue/48bit'
-require 'redgreenblue/hex'
-require 'redgreenblue/int'
+  base
 
-require 'redgreenblue/gamma'
-require 'redgreenblue/hsl_hsv'
-require 'redgreenblue/cie'
+  24bit 48bit hex int
 
-require 'redgreenblue/inspect'
-require 'redgreenblue/lazy'
+  hsl hsv hsb
 
-require 'redgreenblue/rgb565'
-require 'redgreenblue/bgr24bit'
-require 'redgreenblue/gif'
-require 'redgreenblue/terminal'
-require 'redgreenblue/web'
+  ostwald hwb
 
-require 'redgreenblue/mix'
-require 'redgreenblue/misc'
-require 'redgreenblue/random'
+  gamma
 
-require 'redgreenblue/os'
+  cie_1931 cie_1976
+
+  name
+
+  inspect view lazy
+
+  rgb565 bgr24bit gif terminal web gpl mac
+
+  match mix misc random
+
+  os
+
+).each { |m| require "redgreenblue/#{m}" }

data/lib/redgreenblue/24bit.rb

@@ -51,6 +51,17 @@ class RGB
     c
   end
 
+  # Sets the red, green, and blue values to those of the nearest 24-bit color.
+  def snap!
+    self.rgb = rgb
+    self
+  end
+
+  # Creates a new RGB object containing the nearest 24-bit color.
+  def snap
+    RGB.rgb rgb
+  end
+
   # Calls the given block for each 24-bit RGB color (from black to white), passing the color as an RGB object.
   #
   # Returns the number of iterations.

data/lib/redgreenblue/base.rb

@@ -8,7 +8,7 @@ class RGB
   #
   # Currently always 'sRGB'.
   def color_space
-    @color_space ||= 'sRGB'
+    'sRGB'
   end
 
   # Returns the red component as a value between 0 and 1.

data/lib/redgreenblue/{cie.rb → cie_1931.rb}

@@ -5,15 +5,18 @@ class RGB
   # Based on:
   # - http://www.brucelindbloom.com/index.html?Eqn_RGB_to_XYZ.html
   # - https://en.wikipedia.org/wiki/CIE_1931_color_space
-  # sRGB to XYZ matrix for D65 reference white by Bruce Lindbloom:
-  # - http://www.brucelindbloom.com/index.html?Eqn_RGB_XYZ_Matrix.html
-  def cie_xyz
+  # sRGB to XYZ matrix for D65 reference white calculated with Javascript by Bruce Lindbloom:
+  # - http://www.brucelindbloom.com/ColorCalculator.html
+  def cie_xyz(round: true)
     r, g, b = linear_values
+
     [
-      r * 0.4124564 + g * 0.3575761 + b * 0.1804375,
-      r * 0.2126729 + g * 0.7151522 + b * 0.0721750,
-      r * 0.0193339 + g * 0.1191920 + b * 0.9503041
-    ].map { |v| v.round(6) }
+
+      r * 0.4124_5643_9090 + g * 0.3575_7607_7644 + b * 0.1804_3748_3266,
+      r * 0.2126_7285_1406 + g * 0.7151_5215_5288 + b * 0.0721_7499_3307,
+      r * 0.0193_3389_5582 + g * 0.1191_9202_5881 + b * 0.9503_0407_8536
+
+    ].map { |v| round ? v.round(8) : v }
   end
 
   alias xyz cie_xyz
@@ -25,12 +28,15 @@ class RGB
   # - http://www.brucelindbloom.com/index.html?Eqn_XYZ_to_xyY.html
   # - https://ninedegreesbelow.com/photography/xyz-rgb.html
   def cie_xyy
-    x, y, z = xyz
+    x, y, z = cie_xyz(round: false)
+
     [
+
       x / ( x + y + z ),
       y / ( x + y + z ),
       y
-    ].map { |v| v.round(6) }
+
+    ].map { |v| v.round(8) }
   end
 
   alias xyy cie_xyy

data/lib/redgreenblue/cie_1976.rb

@@ -0,0 +1,105 @@
+class RGB
+
+  # Returns CIE 1976 L*a*b* (CIELAB) values for the RGB object.
+  def cie_lab(round: true)
+    cie_lab_luv(round: round, type: :lab)
+  end
+
+  alias lab cie_lab
+
+  # Returns CIE 1976 LCHab values for the RGB object, derived from L*a*b* (CIELAB).
+  #
+  # When C is 0, H is nil.
+  def cie_lch_ab
+    cie_lch_ab_uv(type: :lab)
+  end
+
+  # Returns CIE 1976 L*u*v* (CIELUV) values for the RGB object.
+  def cie_luv(round: true)
+    cie_lab_luv(round: round, type: :luv)
+  end
+
+  alias luv cie_luv
+
+  # Returns CIE 1976 LCHuv values for the RGB object, derived from L*u*v* (CIELUV).
+  #
+  # When C is 0, H is nil.
+  def cie_lch_uv
+    cie_lch_ab_uv(type: :luv)
+  end
+
+  # Returns the difference between this color and another color, according to the CIE 1976 delta E formula.
+  #
+  # Based on:
+  # - http://www.brucelindbloom.com/Eqn_DeltaE_CIE76.html
+  # - https://en.wikipedia.org/wiki/Color_difference
+  def delta_e_cie_1976(another)
+    l , a , b  =         cie_lab(round: false)
+    l2, a2, b2 = another.cie_lab(round: false)
+
+    Math.sqrt( (l - l2) ** 2 + (a - a2) ** 2 + (b - b2) ** 2 ).round(8)
+  end
+
+  alias de76 delta_e_cie_1976
+
+  private
+
+  # Returns either CIE 1976 L*a*b* (CIELAB) or CIE 1976 L*u*v* (CIELUV) values for the RGB object.
+  #
+  # L*a*b* formula based on:
+  # - http://www.brucelindbloom.com/Eqn_XYZ_to_Lab.html
+  # - https://en.wikipedia.org/wiki/CIELAB_color_space
+  # With peeking at:
+  # - https://github.com/halostatue/color/blob/master/lib/color/rgb.rb
+  #
+  # L*u*v* formula based on:
+  # - http://www.brucelindbloom.com/Eqn_XYZ_to_Luv.html
+  # - https://en.wikipedia.org/wiki/CIELUV
+  def cie_lab_luv(round: true, type: :lab)
+    x , y , z  =           cie_xyz(round: false)
+    xr, yr, zr = RGB.white.cie_xyz(round: false)
+
+    f = [ x / xr, y / yr, z / zr ].map { |v|
+      if v > ( 216.0 / 24389 )
+        Math.cbrt v
+      else
+        ( 24389.0 / 27 * v + 16 ) / 116.0
+      end
+    }
+
+    if type == :luv
+      [
+        l = 116 * f[1] - 16,
+        13 * l * ( ( 4 * x ) / ( x + 15 * y + 3 * z ) - ( 4 * xr ) / ( xr + 15 * yr + 3 * zr ) ),
+        13 * l * ( ( 9 * y ) / ( x + 15 * y + 3 * z ) - ( 9 * yr ) / ( xr + 15 * yr + 3 * zr ) )
+      ]
+    else
+      [
+        116 *  f[1] - 16,
+        500 * (f[0] - f[1]),
+        200 * (f[1] - f[2])
+      ]
+    end.map { |v| v.nan? ? 0.0 : ( round ? v.round(8) : v ) }
+  end
+
+  # Returns either CIE 1976 LCHab or CIE 1976 LCHuv values for the RGB object.
+  #
+  # Based on:
+  # - http://www.brucelindbloom.com/Eqn_Lab_to_LCH.html
+  # - http://www.brucelindbloom.com/Eqn_Luv_to_LCH.html
+  # - https://en.wikipedia.org/wiki/CIELAB_color_space
+  def cie_lch_ab_uv(type: :lab)
+    if type == :luv
+      l, v1, v2 = cie_luv(round: false)
+    else
+      l, v1, v2 = cie_lab(round: false)
+    end
+
+    [
+      l.round(8),
+      c = Math.hypot(v1, v2).round(8),
+      c == 0 ? nil : ( Math.atan2(v2, v1) * 180.0 / Math::PI ).modulo(360).round(8)
+    ]
+  end
+
+end

data/lib/redgreenblue/gpl.rb

@@ -0,0 +1,94 @@
+class RGB
+
+  #----------------------------------------------------------------------#
+  #                            Class Methods                             #
+  #----------------------------------------------------------------------#
+
+  class << self
+
+    # Creates a new RGB object from a line of gpl (Gimp color palette) input. Returns nil if not successful.
+    #
+    # @example
+    #  RGB.gpl "255 153 204\tpink"
+    def gpl(line)
+      if line.chomp.match( /^\s*(?<r>\d{1,3})\s+(?<g>\d{1,3})\s+(?<b>\d{1,3})(\s+(?<name>.*))?/ )
+        color = RGB.rgb $~[:r].to_i, $~[:g].to_i, $~[:b].to_i
+        color.name = $~[:name] if $~[:name]
+        color
+      else
+        nil
+      end
+    end
+
+    # Loads a gpl (Gimp color palette) source and returns an array of RGB objects.
+    #
+    # Options:
+    # - file: Path to a .gpl file to be loaded.
+    # - url: URL for a .gpl source to be loaded.
+    # - compact: Defaults to true. If set to false, returns nil for each line that can not be parsed to an RGB color.
+    # - freeze: Defaults to false. If set to true, returns a frozen array of frozen objects.
+    #
+    # @example String
+    #  RGB.load_gpl "255 0 0\tred\n255 153 204\tpink\n"
+    # @example File
+    #  RGB.load_gpl file: '/path/to/palette.gpl'
+    #  RGB.load_gpl file: '/path/to/palette.gpl', compact: false
+    # @example URL
+    #  RGB.load_gpl url: 'https://lospec.com/palette-list/yuko-tomita-time.gpl'
+    def load_gpl(source=nil, file: nil, url: nil, compact: true, freeze: false)
+
+      if ! source
+        if file
+          source = File.open file
+        elsif url
+          require 'open-uri'
+          source = URI.open url
+        end
+      end
+
+      if source.respond_to? :each_line
+        list = source.each_line.map { |line| RGB.gpl(line) }
+
+        if compact
+          list.compact!
+        end
+
+        if freeze
+          list.freeze
+          list.each &:freeze
+        end
+
+        list
+      else
+        raise ArgumentError, 'Not a valid source'
+      end
+    end
+
+    # 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=nil, columns: nil)
+      "GIMP Palette\n" +
+      ( name    ? "Name: #{name}\n"       : '' ) +
+      ( columns ? "Columns: #{columns}\n" : '' )
+    end
+
+  end
+
+  #----------------------------------------------------------------------#
+  #                           Instance Methods                           #
+  #----------------------------------------------------------------------#
+
+  # Returns the color in the format used in .gpl files (Gimp color palettes), including its name (if present).
+  #
+  # You can optionally supply a name as argument.
+  def gpl(gpl_name=name)
+    ( "%3d %3d %3d" % rgb ) +
+    ( gpl_name.to_s.size != 0 ? "\t#{gpl_name}" : '' )
+  end
+
+end

data/lib/redgreenblue/hsb.rb

@@ -0,0 +1,61 @@
+require 'redgreenblue/hsv'
+
+class RGB
+
+  #----------------------------------------------------------------------#
+  #                            Class Methods                             #
+  #----------------------------------------------------------------------#
+
+  class << self
+
+    # Creates a new RGB object from HSB values: hue (0..360), saturation (0..1), and brightness (0..1).
+    alias hsb hsv
+
+  end
+
+  #----------------------------------------------------------------------#
+  #                           Instance Methods                           #
+  #----------------------------------------------------------------------#
+
+  # Returns color as HSB:
+  # hue (0..360), saturation (0..1), brightness (0..1).
+  # When saturation is 0, hue is nil.
+  alias hsb         hsv
+
+  # Returns the object's HSB-hue (0..360).
+  alias hsb_h       hsv_h
+
+  # Returns the object's HSB-saturation (0..1).
+  alias hsb_s       hsv_s
+
+  # Returns the object's HSB-brightness (0..1).
+  alias hsb_b       hsv_v
+
+  # Sets red, green, and blue using HSB values: hue (0..360), saturation (0..1), and brightness (0..1).
+  alias hsb=        hsv=
+
+  # Sets HSB-hue to a number of degrees (0..360) or nil.
+  #
+  # Adjusts red, green, and blue, leaving HSB-saturation and -brightness unchanged.
+  # When hue is nil, saturation will be 0.
+  alias hsb_h=      hsv_h=
+
+  # Sets HSB-saturation to a number between 0 and 1.
+  #
+  # Adjusts red, green, and blue, leaving HSB-hue and -brightness unchanged.
+  # When saturation is 0, hue will be nil.
+  alias hsb_s=      hsv_s=
+
+  # Sets HSB-brightness to a number between 0 and 1.
+  #
+  # Adjusts red, green, and blue, leaving HSB-hue and -saturation unchanged.
+  # When brightness is 0, hue will be nil, and saturation will be 0.
+  alias hsb_b=      hsv_v=
+
+  # Sets red, green, and blue by rotating the object's HSB-hue a number of degrees.
+  alias hsb_rotate! hsv_rotate!
+
+  # Creates one or more new RGB objects by rotating this object's HSB-hue a number of degrees.
+  alias hsb_rotate  hsv_rotate
+
+end

data/lib/redgreenblue/hsl.rb

@@ -0,0 +1,96 @@
+require 'redgreenblue/hsx_shared'
+require 'redgreenblue/math'
+
+class RGB
+
+  #----------------------------------------------------------------------#
+  #                            Class Methods                             #
+  #----------------------------------------------------------------------#
+
+  class << self
+
+    # Creates a new RGB object from HSL values: hue (0..360), saturation (0..1), and lightness (0..1).
+    def hsl(*a)
+      new hsl_to_values(*a)
+    end
+
+    # Calculates RGB values from HSL.
+    # Given hue (0..360), saturation (0..1), and lightness (0..1),
+    # returns red, green, and blue as three values between 0 and 1.
+    def hsl_to_values(*a)
+      hsm_to_values(:hsl, a)
+    end
+
+  end
+
+  #----------------------------------------------------------------------#
+  #                           Instance Methods                           #
+  #----------------------------------------------------------------------#
+
+  # Returns color as HSL:
+  # hue (0..360), saturation (0..1), lightness (0..1).
+  # When saturation is 0, hue is nil.
+  def hsl
+    hsl_hsv_c[0]
+  end
+
+  # Returns the object's HSL-hue (0..360).
+  def hsl_h
+    hsl[0]
+  end
+
+  # Returns the object's HSL-saturation (0..1).
+  def hsl_s
+    hsl[1]
+  end
+
+  # Returns the object's HSL-lightness (0..1).
+  def hsl_l
+    hsl[2]
+  end
+
+  # Sets red, green, and blue using HSL values: hue (0..360), saturation (0..1), and lightness (0..1).
+  def hsl=(*a)
+    self.values = RGB.hsl_to_values(*a)
+  end
+
+  # Sets HSL-hue to a number of degrees (0..360) or nil.
+  #
+  # Adjusts red, green, and blue, leaving saturation and lightness unchanged.
+  # When hue is nil, saturation will be 0.
+  def hsl_h=(degrees)
+    self.hsl = hsl.fill(degrees,0,1)
+  end
+
+  # Sets HSL-saturation to a value between 0 and 1.
+  #
+  # Adjusts red, green, and blue, leaving hue and lightness unchanged.
+  # When saturation is 0, hue will be nil.
+  def hsl_s=(value)
+    self.hsl = hsl.fill(value  ,1,1)
+  end
+
+  # Sets HSL-lightness to a value between 0 and 1.
+  #
+  # Adjusts red, green, and blue, leaving hue and saturation unchanged.
+  # When lightness is 0 or 1, hue will be nil, and saturation will be 0.
+  def hsl_l=(value)
+    self.hsl = hsl.fill(value  ,2,1)
+  end
+
+  # Sets red, green, and blue by rotating the object's HSL-hue a number of degrees.
+  def hsl_rotate!(degrees)
+    self.hsl = zip_add(hsl, [degrees, 0, 0])
+    self
+  end
+
+  # Creates one or more new RGB objects by rotating this object's HSL-hue a number of degrees.
+  def hsl_rotate(a_degrees, *b_degrees)
+    if a_degrees.class != Array and b_degrees.none?
+      RGB.hsl zip_add(hsl, [a_degrees, 0, 0])
+    else
+      ( [a_degrees] + b_degrees ).flatten.map { |degrees| RGB.hsl zip_add(hsl, [degrees, 0, 0]) }
+    end
+  end
+
+end