color-generator 0.0.1 → 0.0.2

data/README.md

@@ -10,7 +10,18 @@ If you are using these colors as background colors, consistent lightness lets yo
 ## Usage
 
     require 'color-generator'
-    generator = ColorGenerator.new 0.3, 1.0
+
+Generate colors using the HSL color representation:
+
+    generator = ColorGenerator.new saturation: 0.3, lightness: 0.75
+    color1 = generator.create
+    # => "cfd2ac"
+    color2 = generator.create
+    # => "cbacd2"
+
+Generate colors using the HSV color representation:
+
+    generator = ColorGenerator.new saturation: 0.3, value: 1.0
     color1 = generator.create
     # => "f7b3ff"
     color2 = generator.create

data/lib/color-generator.rb

@@ -1,25 +1,61 @@
 class ColorGenerator
   GOLDEN_RATIO_CONJUGATE = 0.618033988749895
 
-  attr_reader :hue, :saturation, :value
+  attr_reader :mode, :hue, :saturation, :lightness, :value
 
   # Initializes a color generator.
   #
-  # @param [Float,Integer] saturation saturation in the interval [0, 1]
-  # @param [Float,Integer] value value in the interval [0, 1]
-  def initialize(saturation, value)
-    @hue        = rand
-    @saturation = saturation.to_f
-    @value      = value.to_f
+  # @param [Hash] opts optional arguments
+  # @option opts [Float,Integer] :saturation saturation in the interval [0, 1]
+  # @option opts [Float,Integer] :lightness lightness in the interval [0, 1],
+  #   sets the color representation to HSL
+  # @option opts [Float,Integer] :value value in the interval [0, 1], sets the
+  #   color representation to HSV
+  def initialize(opts = {})
+    @hue = rand
+    @saturation = opts[:saturation].to_f
+    if opts.has_key? :lightness
+      @mode = :HSL
+      @lightness = opts[:lightness].to_f
+    else
+      @mode = :HSV
+      @value = opts[:value].to_f
+    end
   end
 
   # Generates a random color.
   #
   # @return [String] an RGB hex triplet
   def create
-    @hue += GOLDEN_RATIO_CONJUGATE
-    @hue %= 1
-    '%02x%02x%02x' % self.class.rgb_from_hsv(hue, saturation, value)
+    @hue = (hue + GOLDEN_RATIO_CONJUGATE) % 1
+    color = if hsl?
+      self.class.rgb_from_hsl hue, saturation, lightness
+    else
+      self.class.rgb_from_hsv hue, saturation, value
+    end
+    '%02x%02x%02x' % color
+  end
+
+  # @return [Boolean] whether the color representation is HSL
+  def hsl?
+    mode == :HSL
+  end
+
+  # @return [Boolean] whether the color representation is HSV
+  def hsv?
+    mode == :HSV
+  end
+
+  # Converts a color from HSL to RGB.
+  #
+  # @param [Float] h hue in the interval [0, 1]
+  # @param [Float] s saturation in the interval [0, 1]
+  # @param [Float] l lightness in the interval [0, 1]
+  # @return [Array] an RGB decimal triplet
+  def self.rgb_from_hsl(h, s, l)
+    c = (1 - (2 * l - 1).abs) * s
+    m = l - 0.5 * c
+    rgb_from_hsl_or_hsv h, c, m
   end
 
   # Converts a color from HSV to RGB.
@@ -28,48 +64,37 @@ class ColorGenerator
   # @param [Float] s saturation in the interval [0, 1]
   # @param [Float] v value in the interval [0, 1]
   # @return [Array] an RGB decimal triplet
-  #
-  # @see http://en.wikipedia.org/wiki/HSL_and_HSV#Converting_to_RGB
   def self.rgb_from_hsv(h, s, v)
     c = v * s
     m = v - c
+    rgb_from_hsl_or_hsv h, c, m
+  end
+
+private
+
+  # @param [Float] h hue in the interval [0, 1]
+  # @param [Float] c chroma
+  # @param [Float] m
+  # @return [Array] an RGB decimal triplet
+  #
+  # @see http://en.wikipedia.org/wiki/HSL_and_HSV#Converting_to_RGB
+  def self.rgb_from_hsl_or_hsv(h, c, m)
     h_prime = h * 6
-    x_prime = v - c * (h_prime % 2 - 1).abs
+    x = c * (1 - (h_prime % 2 - 1).abs)
 
-    # Unlike the Wikipedia article, we add m right away. This reduces the
-    # number of operations to perform. For example, for H' < 1:
-    #
-    # R = R1 + m
-    # R = C + m
-    # R = C + V - C
-    # R = V
-    #
-    # G = G1 + m
-    # G = X + m
-    # G = C (1 - |H' mod 2 - 1|) + m
-    # G = C (1 - |H' mod 2 - 1|) + V - C
-    # G = C - C |H' mod 2 - 1| + V - C
-    # G = V - C |H' mod 2 - 1|
-    #
-    # B = B1 + m
-    # B = 0 + m
-    # B = m
-    #
-    # The blog post above calculates two X values, for when H' mod 2 is
-    # greater or less than 1.
     case h_prime.to_i
     when 0 # 0 <= H' < 1
-      [v, x_prime, m]
+      [c, x, 0]
     when 1 # 1 <= H' < 2
-      [x_prime, v, m]
+      [x, c, 0]
     when 2 # 2 <= H' < 3
-      [m, v, x_prime]
+      [0, c, x]
     when 3 # 3 <= H' < 4
-      [m, x_prime, v]
+      [0, x, c]
     when 4 # 4 <= H' < 5
-      [x_prime, m, v]
+      [x, 0, c]
     else # 5 <= H' < 6
-      [v, m, x_prime]
-    end.map{|value| (value * 255).round}
+      [c, 0, x]
+    end.map{|value| ((value + m) * 255).round}
   end
 end

data/lib/color-generator/version.rb

@@ -1,3 +1,3 @@
 module ColorGenerator
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: color-generator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors: