color-generator 0.0.2 → 0.0.3

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+--hide-void-return
+--embed-mixin ClassMethods
+--markup=markdown

data/Gemfile

@@ -1,4 +1,4 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in scraperwiki-api.gemspec
+# Specify your gem's dependencies in the gemspec
 gemspec

data/README.md

@@ -14,19 +14,25 @@ If you are using these colors as background colors, consistent lightness lets yo
 Generate colors using the HSL color representation:
 
     generator = ColorGenerator.new saturation: 0.3, lightness: 0.75
-    color1 = generator.create
+    color1 = generator.create_hex
     # => "cfd2ac"
-    color2 = generator.create
+    color2 = generator.create_hex
     # => "cbacd2"
 
 Generate colors using the HSV color representation:
 
     generator = ColorGenerator.new saturation: 0.3, value: 1.0
-    color1 = generator.create
+    color1 = generator.create_hex
     # => "f7b3ff"
-    color2 = generator.create
+    color2 = generator.create_hex
     # => "b3ffe0"
 
+If you want to make color generation repeatable, set a seed for the pseudorandom number generator:
+
+    generator = ColorGenerator.new saturation: 0.3, value: 1.0, seed: 12345
+
+If you prefer a decimal RGB value, call `create_rgb` instead of `create_hex`.
+
 ## Acknowledgements
 
 Thanks to Martin Ankerl for his [blog post](http://martin.ankerl.com/2009/12/09/how-to-create-random-colors-programmatically/) which inspired this gem.

data/lib/color-generator.rb

@@ -11,7 +11,9 @@ class ColorGenerator
   #   sets the color representation to HSL
   # @option opts [Float,Integer] :value value in the interval [0, 1], sets the
   #   color representation to HSV
+  # @option opts [Integer] :seed seed for the pseudorandom number generator
   def initialize(opts = {})
+    srand(opts[:seed]) if opts.key?(:seed)
     @hue = rand
     @saturation = opts[:saturation].to_f
     if opts.has_key? :lightness
@@ -23,17 +25,26 @@ class ColorGenerator
     end
   end
 
-  # Generates a random color.
+  # Formats a random color as an RGB hex triplet.
   #
   # @return [String] an RGB hex triplet
-  def create
+  def create_hex
+    '%02x%02x%02x' % create_rgb
+  end
+
+  # For backwards compatibility.
+  alias_method :create, :create_hex
+
+  # Generates a random color as an RGB decimal triplet.
+  #
+  # @return [Array] an RGB decimal triplet
+  def create_rgb
     @hue = (hue + GOLDEN_RATIO_CONJUGATE) % 1
-    color = if hsl?
+    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

data/lib/color-generator/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: color-generator
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-12 00:00:00.000000000 Z
+date: 2013-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -52,6 +52,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- .yardopts
 - Gemfile
 - LICENSE
 - README.md