colormath 0.1.0 → 0.1.1

data/README.md

@@ -0,0 +1,42 @@
+ColorMath
+=========
+
+A simple Ruby library to perform operations on RGB and HSL colours.
+
+Usage
+-----
+
+Instantiate an RGB (red, green, blue) colour:
+
+    orange = ColorMath::RGB.new(1.0, 0.5, 0)
+
+Or from a hex value via a helper method:
+
+    white  = ColorMath::hex_color("#fff")
+    blue   = ColorMath::hex_color("#0000ff")
+
+Instantiate an HSL (hue, saturation, luminance) colour:
+
+    pink   = ColorMath::HSL.new(350, 1, 0.88)
+
+Retrieve the RGB components of a colour:
+
+    pink.red    # => 1.0
+    pink.green  # => 0.76
+    pink.blue   # => 0.8
+
+Or the HSL components:
+
+    orange.hue         # => 30.0
+    orange.saturation  # =>  1.0
+    orange.luminance   # =>  0.5
+
+Combine two colours via an alpha blend, e.g. 30% orange on white:
+
+    combined = ColorMath::Blend.alpha(white, orange, 0.3)
+
+Convert a colour to hexadecimal representation:
+
+    combined.hex  # => "#ffd8b2"
+
+That’s it. It only does the basics that I need for the job in hand, but it’s probably a good basis for extension.

data/lib/colormath.rb

@@ -24,5 +24,6 @@ module ColorMath
 end
 
 require "colormath/color"
+require "colormath/adjust"
 require "colormath/blend"
 require "colormath/version"

data/lib/colormath/adjust.rb

@@ -0,0 +1,39 @@
+module ColorMath
+
+  # Adjust parameters of a colour
+  #
+  module Adjust
+
+    # Rotate the hue by delta degrees in either direction
+    def hue(color, delta)
+      HSL.new(color.hue + delta, color.saturation, color.luminance)
+    end
+
+    # Adjust the saturation by delta, stopping at 0 or 1
+    def saturation(color, delta)
+      HSL.new(color.hue, color.saturation + delta, color.luminance)
+    end
+
+    # Adjust the luminance by delta, stopping at 0 or 1
+    def luminance(color, delta)
+      HSL.new(color.hue, color.saturation, color.luminance + delta)
+    end
+
+    # Adjust the red component by delta, stopping at 0 or 1
+    def red(color, delta)
+      RGB.new(color.red + delta, color.green, color.blue)
+    end
+
+    # Adjust the green component by delta, stopping at 0 or 1
+    def green(color, delta)
+      RGB.new(color.red, color.green + delta, color.blue)
+    end
+
+    # Adjust the blue component by delta, stopping at 0 or 1
+    def blue(color, delta)
+      RGB.new(color.red, color.green, color.blue + delta)
+    end
+
+    extend self
+  end
+end

data/lib/colormath/color/hsl.rb

@@ -12,10 +12,11 @@ module ColorMath
     #     0 <= s <=   1
     #     0 <= l <=   1
     #
-    # Values outside these ranges will be clippped.
+    # Saturation and luminance values outside these ranges will be clipped.
+    # Hue values will be mapped to a circle, so that e.g. -20 becomes 340.
     #
     def initialize(h, s, l)
-      @hue        = force_range(h, 0, 360).to_f
+      @hue        = h % 360
       @saturation = force_range(s, 0,   1).to_f
       @luminance  = force_range(l, 0,   1).to_f
     end

data/lib/colormath/color/rgb.rb

@@ -23,6 +23,7 @@ module ColorMath
     # The hue component of the colour in HSL representation where 0 <= h < 360
     #
     def hue
+      return 0 if saturation.zero?
       case max
       when red
         (60.0 * ((green - blue) / (max - min))) % 360.0

data/lib/colormath/version.rb

@@ -2,7 +2,7 @@ module ColorMath
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    TINY  = 0
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/adjust_test.rb

@@ -0,0 +1,81 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require "test/unit"
+require "shoulda"
+require "colormath"
+
+class AdjustmentTest < Test::Unit::TestCase
+  include ColorMath
+  EPSILON = 1e-3
+
+  context "in the HSL space" do
+    should "rotate hue" do
+      c = HSL.new(180, 0.5, 0.5)
+      assert_equal 120, Adjust.hue(c,  -60).hue
+      assert_equal 340, Adjust.hue(c, -200).hue
+      assert_equal 240, Adjust.hue(c,   60).hue
+      assert_equal  20, Adjust.hue(c,  200).hue
+    end
+
+    should "adjust saturation" do
+      c = HSL.new(180, 0.5, 0.5)
+      assert_in_delta 0.2, Adjust.saturation(c, -0.3).saturation, EPSILON
+      assert_in_delta 0.0, Adjust.saturation(c, -0.6).saturation, EPSILON
+      assert_in_delta 0.8, Adjust.saturation(c,  0.3).saturation, EPSILON
+      assert_in_delta 1.0, Adjust.saturation(c,  0.6).saturation, EPSILON
+    end
+
+    should "adjust luminance" do
+      c = HSL.new(180, 0.5, 0.5)
+      assert_in_delta 0.2, Adjust.luminance(c, -0.3).luminance, EPSILON
+      assert_in_delta 0.0, Adjust.luminance(c, -0.6).luminance, EPSILON
+      assert_in_delta 0.8, Adjust.luminance(c,  0.3).luminance, EPSILON
+      assert_in_delta 1.0, Adjust.luminance(c,  0.6).luminance, EPSILON
+    end
+
+    should "not affect unrelated parameters" do
+      c = HSL.new(180, 0.4, 0.6)
+      assert_in_delta 180, Adjust.saturation(c, -0.3).hue, EPSILON
+      assert_in_delta 180, Adjust.luminance(c, -0.3).hue, EPSILON
+      assert_in_delta 0.4, Adjust.hue(c, -20).saturation, EPSILON
+      assert_in_delta 0.4, Adjust.luminance(c, -0.3).saturation, EPSILON
+      assert_in_delta 0.6, Adjust.hue(c, -20).luminance, EPSILON
+      assert_in_delta 0.6, Adjust.saturation(c, -0.3).luminance, EPSILON
+    end
+  end
+
+  context "in the RGB space" do
+    should "adjust red" do
+      c = RGB.new(0.5, 0.3, 0.4)
+      assert_in_delta 0.2, Adjust.red(c, -0.3).red, EPSILON
+      assert_in_delta 0.0, Adjust.red(c, -0.6).red, EPSILON
+      assert_in_delta 0.8, Adjust.red(c,  0.3).red, EPSILON
+      assert_in_delta 1.0, Adjust.red(c,  0.6).red, EPSILON
+    end
+
+    should "adjust green" do
+      c = RGB.new(0.3, 0.5, 0.4)
+      assert_in_delta 0.2, Adjust.green(c, -0.3).green, EPSILON
+      assert_in_delta 0.0, Adjust.green(c, -0.6).green, EPSILON
+      assert_in_delta 0.8, Adjust.green(c,  0.3).green, EPSILON
+      assert_in_delta 1.0, Adjust.green(c,  0.6).green, EPSILON
+    end
+
+    should "adjust blue" do
+      c = RGB.new(0.3, 0.4, 0.5)
+      assert_in_delta 0.2, Adjust.blue(c, -0.3).blue, EPSILON
+      assert_in_delta 0.0, Adjust.blue(c, -0.6).blue, EPSILON
+      assert_in_delta 0.8, Adjust.blue(c,  0.3).blue, EPSILON
+      assert_in_delta 1.0, Adjust.blue(c,  0.6).blue, EPSILON
+    end
+
+    should "not affect unrelated parameters" do
+      c = RGB.new(0.3, 0.4, 0.5)
+      assert_in_delta 0.3, Adjust.green(c, -0.3).red, EPSILON
+      assert_in_delta 0.3, Adjust.blue(c, -0.3).red, EPSILON
+      assert_in_delta 0.4, Adjust.red(c, -0.3).green, EPSILON
+      assert_in_delta 0.4, Adjust.blue(c, -0.3).green, EPSILON
+      assert_in_delta 0.5, Adjust.red(c, -0.3).blue, EPSILON
+      assert_in_delta 0.5, Adjust.green(c, -0.3).blue, EPSILON
+    end
+  end
+end

data/test/hsl_test.rb

@@ -14,12 +14,12 @@ class HSLTest < Test::Unit::TestCase
 
   should "force hue >= 0" do
     c = ColorMath::HSL.new(-2, 0, 0)
-    assert_equal 0, c.hue
+    assert_equal 358, c.hue
   end
 
   should "force hue <= 360" do
     c = ColorMath::HSL.new(361, 0, 0)
-    assert_equal 360, c.hue
+    assert_equal 1, c.hue
   end
 
   should "force saturation >= 0" do

data/test/rgb_test.rb

@@ -41,4 +41,9 @@ class RGBTest < Test::Unit::TestCase
     c = ColorMath::RGB.new(0, 0, 1.1)
     assert_equal 1, c.blue
   end
+
+  should "have a hue of zero if it is white" do
+    c = ColorMath::RGB.new(1, 1, 1)
+    assert_equal 0, c.hue
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: colormath
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Paul Battley
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-09 00:00:00 +01:00
+date: 2009-12-03 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,11 +31,14 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- README.md
+- test/adjust_test.rb
 - test/blend_test.rb
 - test/conversion_test.rb
 - test/hex_decoding_test.rb
 - test/hsl_test.rb
 - test/rgb_test.rb
+- lib/colormath/adjust.rb
 - lib/colormath/blend.rb
 - lib/colormath/color/hsl.rb
 - lib/colormath/color/rgb.rb
@@ -66,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Colour manipulation library for Ruby