redgreenblue 0.17.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2359fa39f6387727f76770372b1f798ae60fdf34dce8bd481b06d58e5a128c4b
-  data.tar.gz: 6194f07e51ce46a4c9bdd3fd7d2fd895eebcb8e6f34e76c37b3c078d3ea58fb9
+  metadata.gz: c8ae59f94eaf3e3cfb8fd8610b95d8f14cc05f9902e565b0cc587ad03e560bc1
+  data.tar.gz: f34de8f1025a07deb03c6de996f2875cc3d72212151432dcbb811fbfe5093fd7
 SHA512:
-  metadata.gz: e76a1651bfac0b0f197cae93a9fa3139e798a3a2ab0ae00950d08eb5e724834f9ccce7fe06beb98b083988fd4d7b672431aee5c23a66c24cce2782669606b517
-  data.tar.gz: 688367a83417deb0a812e96982f9c44ec369a1ee6984836338c25b07bd11843ced02053341044cebcaf2e4e71ce5ef26316799850831e446b85ece5766d31ddf
+  metadata.gz: eece5011d8efd21b6fd22eea58de73b2cb070f34093085049b61c847c8c88f462e4b79465222060bee5398cd5c7c5c80a9d3fb682c68dacaba017c8e6ca1a47c
+  data.tar.gz: 54eac4f2defd4841e5057c91308e0479ccb03a29d0645b9e0a6603d3ec479cdd96ac2369496d401d77a10dedb816d93f0cb6464edc95e6a76a2228535971ef29

data/lib/redgreenblue/base.rb

@@ -1,90 +1,89 @@
-class RGB::Color
+module RGB
 
-  def initialize(*a)
-    self.values = a.any? ? a : [ 0.5, 0.5, 0.5 ]
-  end
+  class Color
 
-  # Returns the color space.
-  #
-  # Currently always 'sRGB'.
-  def color_space
-    'sRGB'
-  end
+    def initialize(*a)
+      self.values = a.any? ? a : [ 0.5, 0.5, 0.5 ]
+    end
 
-  # Returns the red component as a value between 0 and 1.
-  def red
-    @red
-  end
+    # Returns the color space.
+    #
+    # Currently always 'sRGB'.
+    def color_space
+      'sRGB'
+    end
 
-  # Returns the green component as a value between 0 and 1.
-  def green
-    @green
-  end
+    # Returns the red component as a value between 0 and 1.
+    def red
+      @red
+    end
 
-  # Returns the blue component as a value between 0 and 1.
-  def blue
-    @blue
-  end
+    # Returns the green component as a value between 0 and 1.
+    def green
+      @green
+    end
 
-  # Sets the red component to a value between 0 and 1.
-  #
-  # Values outside the range 0..1 will be clipped.
-  def red=(value)
-    @red = limit(value)
-  end
+    # Returns the blue component as a value between 0 and 1.
+    def blue
+      @blue
+    end
 
-  # Sets the green component to a value between 0 and 1.
-  #
-  # Values outside the range 0..1 will be clipped.
-  def green=(value)
-    @green = limit(value)
-  end
+    # Sets the red component to a value between 0 and 1.
+    #
+    # Values outside the range 0..1 will be clipped.
+    def red=(value)
+      @red = limit(value)
+    end
 
-  # Sets the blue component to a value between 0 and 1.
-  #
-  # Values outside the range 0..1 will be clipped.
-  def blue=(value)
-    @blue = limit(value)
-  end
+    # Sets the green component to a value between 0 and 1.
+    #
+    # Values outside the range 0..1 will be clipped.
+    def green=(value)
+      @green = limit(value)
+    end
 
-  # Returns the red, green, and blue components as three values between 0 and 1.
-  def values
-    [ red, green, blue ]
-  end
+    # Sets the blue component to a value between 0 and 1.
+    #
+    # Values outside the range 0..1 will be clipped.
+    def blue=(value)
+      @blue = limit(value)
+    end
 
-  alias to_a values
+    # Returns the red, green, and blue components as three values between 0 and 1.
+    def values
+      [ red, green, blue ]
+    end
 
-  # Sets the red, green, and blue components using three values between 0 and 1.
-  #
-  # Values outside the range 0..1 will be clipped.
-  def values=(*a)
-    self.red, self.green, self.blue = a.flatten
-  end
+    alias to_a values
 
-  # Returns true if this object and another object represent exactly the same color. Otherwise returns false.
-  def ==(other)
-    ( self.class == other.class ) && ( self.values == other.values )
-  end
+    # Sets the red, green, and blue components using three values between 0 and 1.
+    #
+    # Values outside the range 0..1 will be clipped.
+    def values=(*a)
+      self.red, self.green, self.blue = a.flatten
+    end
 
-  # Returns a sorted hash of 3 key/value pairs for red, green, and blue,
-  # sorted in order of decreasing value.
-  def to_h
-    ([:red, :green, :blue].zip values).sort_by {
-      |k,v| [-v,[:red, :green, :blue].index(k)]
-    }.to_h
-  end
+    # Returns true if this object and another object represent exactly the same color. Otherwise returns false.
+    def ==(other)
+      ( self.class == other.class ) && ( self.values == other.values )
+    end
 
-  private
+    # Returns a sorted hash of 3 key/value pairs for red, green, and blue,
+    # sorted in order of decreasing value.
+    def to_h
+      ([:red, :green, :blue].zip values).sort_by {
+        |k,v| [-v,[:red, :green, :blue].index(k)]
+      }.to_h
+    end
 
-  # limits to range 0..1
-  def limit(n)
-    n <= 0 ? 0.0 : n >= 1 ? 1.0 : n
-  end
+    private
 
-end
+    # limits to range 0..1
+    def limit(n)
+      n <= 0 ? 0.0 : n >= 1 ? 1.0 : n
+    end
 
-# The main namespace for redgreenblue.
-module RGB
+  end
 
   class << self
 

data/lib/redgreenblue/inspect.rb

@@ -26,6 +26,17 @@ class RGB::Color
     _inspect_swatch + ( name ? ' ' + name : '' )
   end
 
+  def _inspect_wilhelm
+    _inspect_short +
+    if h = hsl_h
+      " (H:%7.3f %s \e[0m" % [h, ostwald_color.terminal_background]
+    else
+      ' (H:  -      '
+    end +
+    ' C:%5.3f W:%5.3f K:%5.3f)' % cwk +
+    ( name ? ' ' + name : '' )
+  end
+
   public
 
   # Returns a programmer-friendly representation of the object.

data/lib/redgreenblue/math.rb

@@ -2,6 +2,17 @@ class RGB::Color
 
 private
 
+  # Returns shortest angle of travel (rotation)
+  # to move between 2 points on a circle.
+  #
+  # Some discussions here:
+  # - https://stackoverflow.com/questions/9505862/
+  # - https://stackoverflow.com/questions/7428718/
+  def angle_of_travel(source, destination)
+    angle = destination - source
+    (angle.abs > 180) ? (angle + (angle.negative? ? 360 : -360)) : angle
+  end
+
   def zip_add(a,b)
     a.zip(b).map { |ab| ( ab[0] || 0 ) + ab[1] }
   end

data/lib/redgreenblue/mix.rb

@@ -39,10 +39,9 @@ class RGB::Color
     end
   end
 
-  # Returns a set of colors between this color and another. That other color is included.
+  # Returns a number of colors, gradually changing from this color to another color.
   #
-  # The resulting colors are spaced evenly in the RGB color space using a straightforward calculation.
-  # You will likely experience these colors as not exactly evenly spaced.
+  # The resulting colors are spaced evenly in the RGB color space.
   def steps(another,step_count=1,include_begin=false)
     # origin (self, optional)
     ( include_begin ? [self.dup] : [] ) +
@@ -52,6 +51,22 @@ class RGB::Color
     [another.dup]
   end
 
+  # Returns a number of colors, gradually changing from this color to another color.
+  #
+  # The resulting colors are spaced evenly by their HSL values (hue, saturation, and lightness).
+  def steps_hsl(another,step_count=1,include_begin=false)
+    steps_hsx(another,step_count,include_begin, :hsl)
+  end
+
+  # Returns a number of colors, gradually changing from this color to another color.
+  #
+  # The resulting colors are spaced evenly by their HSV values (hue, saturation, and value).
+  def steps_hsv(another,step_count=1,include_begin=false)
+    steps_hsx(another,step_count,include_begin, :hsv)
+  end
+
+  alias steps_hsb steps_hsv
+
   private
 
   def mix_values(some_values, portion)
@@ -62,4 +77,25 @@ class RGB::Color
       ( blue  * (1 - portion) ) + ( some_values[2] * portion )
     ]
   end
+
+  def steps_hsx(another,step_count=1,include_begin=false,type)
+    raise NotImplementedError unless [:hsl, :hsv].include? type
+    src_hsx  = self.send(type)
+    dest_hsx = another.send(type)
+
+    # Take care of achromatic origin/destination
+    src_hsx[0]  = ( dest_hsx[0] || 0 ) unless src_hsx[0]
+    dest_hsx[0] = ( src_hsx[0]  || 0 ) unless dest_hsx[0]
+
+    step = [angle_of_travel(src_hsx[0], dest_hsx[0]), dest_hsx[1]-src_hsx[1], dest_hsx[2]-src_hsx[2] ].map { |v| v/step_count }
+
+    # origin (self, optional)
+    ( include_begin ? [self.dup] : [] ) +
+    # ...plus intermediate colors
+    (1..step_count-1).map { |c| RGB.send(type, zip_add(src_hsx, step.map { |v| v*c })) } +
+    # ...plus destination color
+    [another.dup]
+
+  end
+
 end

data/lib/redgreenblue/version.rb

@@ -1,7 +1,7 @@
 module RGB
 
   # redgreenblue version.
-  VERSION = '0.17.0'
+  VERSION = '0.19.0'
 
   # Returns RGB::VERSION.
   def self.version

data/lib/redgreenblue/yuv.rb

@@ -0,0 +1,24 @@
+require 'redgreenblue/base'
+
+class RGB::Color
+
+  # Returns the color's YUV values.
+  #
+  # Based on:
+  # - http://www.martinreddy.net/gfx/faqs/colorconv.faq (section 6.1)
+  # - https://en.wikipedia.org/wiki/Y%E2%80%B2UV
+  def yuv(round: true)
+    [
+      red *  0.299 + green *  0.587 + blue *  0.114,
+      red * -0.147 + green * -0.289 + blue *  0.436,
+      red *  0.615 + green * -0.515 + blue * -0.100
+    ].map { |v| round ? v.round(6) : v }
+
+    # Wikipedia (2024-Aug-7)
+    # suggests slightly different factors for U and V:
+    #
+    # U = red * -0.14713 + green * -0.28886 + blue *  0.436
+    # V = red *  0.615   + green * -0.51499 + blue * -0.10001
+  end
+
+end

data/lib/redgreenblue.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redgreenblue
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.19.0
 platform: ruby
 authors:
 - lllist.eu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-18 00:00:00.000000000 Z
+date: 2024-08-07 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -53,6 +53,7 @@ files:
 - lib/redgreenblue/version.rb
 - lib/redgreenblue/view.rb
 - lib/redgreenblue/web.rb
+- lib/redgreenblue/yuv.rb
 homepage: https://github.com/lllisteu/redgreenblue
 licenses:
 - MIT