redgreenblue 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3acd4edad3c6c358886e6c49138133f207571b610d8ea980fd6ff4d0cb38b7a8
-  data.tar.gz: 81833b3ed57dfcde3c0558f196e7be284ac040e56330019a994e214b39c75463
+  metadata.gz: bb9542466d29c9ddcec8d53f6a374c228cc39f22b8d17e4c7c5b93f4f6095821
+  data.tar.gz: 53b0e22ef0143e5110fc33d6f0cd68615a5b9931c1cd31a790dfc08adc9f2198
 SHA512:
-  metadata.gz: 57a8b63684a52f0495ee14c47a391a42bce9ce40914b9eee7523d1685fc4a66135ccb453b9c5c2ab68900dc700266e71651cb420fd0cd3cbdcf57cecb3012d27
-  data.tar.gz: 78917822fe1a7cd67acc98912adf1107736609fd996300003bc7c77ff02cbfcdabf6efce4b86481f27dbb568612237dbee726563de76dab1b60188b9c27e2ef8
+  metadata.gz: dd97d2edb6a6503c99aa1ee055297d2dcfa21a330234b3c6fb01cf2551cad6ca5c7796103c94d99a7ba51ee33547f508551e3e4376029243eccbd77199b5ddde
+  data.tar.gz: 3b7e6ca19d6c3ee4aafda566cd4187c735e4af0d59f2a2ee09f7e7602a7efb2359c8adaed08eb14c2af9e36c254e299bcbb253cea8755b5b8ead7f8dc7816541

data/lib/redgreenblue.rb

@@ -10,8 +10,11 @@ require 'redgreenblue/48bit'
 require 'redgreenblue/hex'
 require 'redgreenblue/int'
 
+require 'redgreenblue/hsl'
+require 'redgreenblue/hsv'
+require 'redgreenblue/hsb'
+
 require 'redgreenblue/gamma'
-require 'redgreenblue/hsl_hsv'
 require 'redgreenblue/cie'
 
 require 'redgreenblue/inspect'

data/lib/redgreenblue/hsb.rb

@@ -0,0 +1,39 @@
+require 'redgreenblue/hsv'
+
+class RGB
+
+  ########################################################################
+  # Class methods                                                        #
+  ########################################################################
+
+  class << self
+
+    alias hsb hsv
+
+  end
+
+  ########################################################################
+  # Instance methods                                                     #
+  ########################################################################
+
+  alias hsb         hsv
+
+  alias hsb_h       hsv_h
+
+  alias hsb_s       hsv_s
+
+  alias hsb_b       hsv_v
+
+  alias hsb=        hsv=
+
+  alias hsb_h=      hsv_h=
+
+  alias hsb_s=      hsv_s=
+
+  alias hsb_b=      hsv_v=
+
+  alias hsb_rotate! hsv_rotate!
+
+  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

data/lib/redgreenblue/hsv.rb

@@ -0,0 +1,118 @@
+require 'redgreenblue/hsx_shared'
+require 'redgreenblue/math'
+
+class RGB
+
+  ########################################################################
+  # Class methods                                                        #
+  ########################################################################
+
+  class << self
+
+    # Creates a new RGB object from HSV values: hue (0..360), saturation (0..1), and value (0..1).
+    #
+    # ::hsb is an alias for ::hsv.
+    def hsv(*a)
+      new hsv_to_values(*a)
+    end
+
+    # Calculates RGB values from HSV.
+    # Given hue (0..360), saturation (0..1), and value (0..1),
+    # returns red, green, and blue as three values between 0 and 1.
+    def hsv_to_values(*a)
+      hsm_to_values(:hsv, a)
+    end
+
+  end
+
+  ########################################################################
+  # Instance methods                                                     #
+  ########################################################################
+
+  # Returns color as HSV:
+  # hue (0..360), saturation (0..1), value (0..1).
+  # When saturation is 0, hue is nil.
+  #
+  # #hsb is an alias for #hsv.
+  def hsv
+    hsl_hsv_c[1]
+  end
+
+  # Returns the object's HSV-hue (0..360).
+  #
+  # #hsb_h is an alias for #hsv_h.
+  def hsv_h
+    hsv[0]
+  end
+
+  # Returns the object's HSV-saturation (0..1).
+  #
+  # #hsb_s is an alias for #hsv_s.
+  def hsv_s
+    hsv[1]
+  end
+
+  # Returns the object's HSV-value (0..1).
+  #
+  # #hsb_b is an alias for #hsv_v.
+  def hsv_v
+    hsv[2]
+  end
+
+  # Sets red, green, and blue using HSV values: hue (0..360), saturation (0..1), and value (0..1).
+  #
+  # #hsb= is an alias for #hsv=.
+  def hsv=(*a)
+    self.values = RGB.hsv_to_values(*a)
+  end
+
+  # Sets HSV-hue to a number of degrees (0..360) or nil.
+  #
+  # Adjusts red, green, and blue, leaving HSV-saturation and -value unchanged.
+  # When hue is nil, saturation will be 0.
+  #
+  # #hsb_h= is an alias for #hsv_h=.
+  def hsv_h=(degrees)
+    self.hsv = hsv.fill(degrees,0,1)
+  end
+
+  # Sets HSV-saturation to a number between 0 and 1.
+  #
+  # Adjusts red, green, and blue, leaving HSV-hue and -value unchanged.
+  # When saturation is 0, hue will be nil.
+  #
+  # #hsb_s= is an alias for #hsv_s=.
+  def hsv_s=(value)
+    self.hsv = hsv.fill(value  ,1,1)
+  end
+
+  # Sets HSV-value to a number between 0 and 1.
+  #
+  # Adjusts red, green, and blue, leaving HSV-hue and -saturation unchanged.
+  # When value is 0, hue will be nil, and saturation will be 0.
+  #
+  # #hsb_b= is an alias for #hsv_v=.
+  def hsv_v=(value)
+    self.hsv = hsv.fill(value  ,2,1)
+  end
+
+  # Sets red, green, and blue by rotating the object's HSV-hue a number of degrees.
+  #
+  # #hsb_rotate! is an alias for #hsv_rotate!.
+  def hsv_rotate!(degrees)
+    self.hsv = zip_add(hsv, [degrees, 0, 0])
+    self
+  end
+
+  # Creates one or more new RGB objects by rotating this object's HSV-hue a number of degrees.
+  #
+  # #hsb_rotate is an alias for #hsv_rotate.
+  def hsv_rotate(a_degrees, *b_degrees)
+    if a_degrees.class != Array and b_degrees.none?
+      RGB.hsv zip_add(hsv, [a_degrees, 0, 0])
+    else
+      ( [a_degrees] + b_degrees ).flatten.map { |degrees| RGB.hsv zip_add(hsv, [degrees, 0, 0]) }
+    end
+  end
+
+end

data/lib/redgreenblue/hsx_shared.rb

@@ -0,0 +1,94 @@
+class RGB
+
+  ########################################################################
+  # Class methods                                                        #
+  ########################################################################
+
+  class << self
+
+    private
+
+    # Calculates RGB values from HSL or HSV.
+    # With help from:
+    # - https://en.wikipedia.org/wiki/HSL_and_HSV
+    def hsm_to_values(type, *a)
+      raise NotImplementedError unless [:hsl, :hsv].include? type
+
+      hue, saturation, magnitude = a.flatten
+
+      if ( saturation == 0 ) or ( ! hue )
+        return Array.new(3) { magnitude }
+      end
+
+      hue = hue.modulo 360
+
+      chroma = case type
+        when :hsl
+          ( 1 - ( 2 * magnitude - 1 ).abs ) * saturation
+        when :hsv
+          magnitude * saturation
+      end
+
+      values = [
+        chroma,
+        ( 1 - ( ( hue / 60.0 ).modulo(2) - 1 ).abs ) * chroma,
+        0
+      ]
+
+      values = case type
+        when :hsl
+          values.map { |v| ( v + magnitude - chroma / 2.0 ).round(9) }
+        when :hsv
+          values.map { |v| ( v + magnitude - chroma       ).round(9) }
+      end
+
+      # order values according to hue sextant
+      [ [0,1,2], [1,0,2], [2,0,1], [2,1,0], [1,2,0], [0,2,1] ][hue.div 60].map { |i| values[i]}
+    end
+
+  end
+
+  ########################################################################
+  # Instance methods                                                     #
+  ########################################################################
+
+  private
+
+  # Compute HSL, HSV, and chroma.
+  # With help from:
+  # - https://en.wikipedia.org/wiki/HSL_and_HSV
+  def hsl_hsv_c
+    sorted_hash = to_h
+    min, max = sorted_hash.values.values_at(2,0)
+
+    chroma = max - min
+
+    hue =
+      if chroma == 0
+        nil
+      else
+        ( case sorted_hash.keys.first
+          when :red
+            60 * ( ( ( green - blue  ) / chroma ).modulo 6 )
+          when :green
+            60 * ( (   blue  - red   ) / chroma + 2 )
+          when :blue
+            60 * ( (   red   - green ) / chroma + 4 )
+          end
+        ).round(6)
+      end
+
+    lightness = ( min + max ) / 2.0
+
+    saturation_hsl =
+      chroma == 0 ? 0.0 : ( chroma / ( 1 - (2 * lightness - 1).abs ) ).round(9)
+
+    value = max
+
+    saturation_hsv =
+      value == 0 ? 0.0 : chroma / value
+
+    [ [hue, saturation_hsl, lightness], [hue, saturation_hsv, value], chroma ]
+  end
+
+end

data/lib/redgreenblue/math.rb

@@ -0,0 +1,9 @@
+class RGB
+
+private
+
+  def zip_add(a,b)
+    a.zip(b).map { |ab| ( ab[0] || 0 ) + ab[1] }
+  end
+
+end

data/lib/redgreenblue/rgb565.rb

@@ -15,16 +15,6 @@ class RGB
     self.b = ( ( v & 0x001f )       ) << 3
   end
 
-  # Deprecated: this method will be removed in a future version.
-  # Returns the color in 16-bit RGB565 format as a string of 0's and 1's.
-  def rgb565_binary
-    unless defined? @@warned_rgb565_binary_deprecation
-      warn "Warning: 'rgb565_binary' has been deprecated and will be removed in a future version of redgreenblue."
-      @@warned_rgb565_binary_deprecation = true
-    end
-    rgb565.bytes.reverse.map { |b| "%08b" % b }.join
-  end
-
   # Creates a new RGB color from 16-bit RGB565 data.
   def self.rgb565(rgb565_string)
     c = self.new

data/lib/redgreenblue/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redgreenblue
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - lllist.eu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-02 00:00:00.000000000 Z
+date: 2020-04-16 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: 
@@ -25,10 +25,14 @@ files:
 - lib/redgreenblue/gamma.rb
 - lib/redgreenblue/gif.rb
 - lib/redgreenblue/hex.rb
-- lib/redgreenblue/hsl_hsv.rb
+- lib/redgreenblue/hsb.rb
+- lib/redgreenblue/hsl.rb
+- lib/redgreenblue/hsv.rb
+- lib/redgreenblue/hsx_shared.rb
 - lib/redgreenblue/inspect.rb
 - lib/redgreenblue/int.rb
 - lib/redgreenblue/lazy.rb
+- lib/redgreenblue/math.rb
 - lib/redgreenblue/misc.rb
 - lib/redgreenblue/mix.rb
 - lib/redgreenblue/opt/philipshue.rb
@@ -43,7 +47,9 @@ homepage: https://github.com/lllisteu/redgreenblue
 licenses:
 - MIT
 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: 
 rdoc_options: []
 require_paths:

data/lib/redgreenblue/hsl_hsv.rb

@@ -1,59 +0,0 @@
-class RGB
-
-  # 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 color as HSV:
-  # hue (0..360), saturation (0..1), value (0..1).
-  # When saturation is 0, hue is nil.
-  #
-  # #hsb is an alias for #hsv.
-  def hsv
-    hsl_hsv_c[1]
-  end
-
-  alias hsb hsv
-
-  private
-
-  # Compute HSL, HSV, and chroma.
-  # With help from:
-  # - https://en.wikipedia.org/wiki/HSL_and_HSV
-  def hsl_hsv_c
-    sorted_hash = to_h
-    min, max = sorted_hash.values.values_at(2,0)
-
-    chroma = max - min
-
-    hue =
-      if chroma == 0
-        nil
-      else
-        case sorted_hash.keys.first
-        when :red
-          60 * ( ( ( green - blue  ) / chroma ).modulo 6 )
-        when :green
-          60 * ( (   blue  - red   ) / chroma + 2 )
-        when :blue
-          60 * ( (   red   - green ) / chroma + 4 )
-        end
-      end
-
-    lightness = ( min + max ) / 2.0
-
-    saturation_hsl =
-      chroma == 0 ? 0.0 : ( chroma / ( 1 - (2 * lightness - 1).abs ) ).round(9)
-
-    value = max
-
-    saturation_hsv =
-      value == 0 ? 0.0 : chroma / value
-
-    [ [hue, saturation_hsl, lightness], [hue, saturation_hsv, value], chroma ]
-  end
-
-end