color 0.1.0

data/CHANGELOG

@@ -0,0 +1,4 @@
+=== 24 July 2006
+* Initial import of code written 23 July.
+* Adding LICENSE, README, CHANGELOG files.
+* Added Rakefile, Basic Conversion Test for hex.

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2006 Matt Lyon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,41 @@
+Color
+=====
+
+A simple library for dealing with colors. Currently it features:
+
+Conversion:
+  RGB Int <-> RGB Hex
+  HSL <-> RGB
+  RGB <-> CMYK
+  RGB -> HSV
+
+Manipulation:
+  Mixing colors
+  Adjusting Hue, Saturation, or Lightness values of a color
+  
+Future plans include #to_web_safe, a palette (fe: Color.new(:black)), 
+color wheel traversing ( Color.new(:red).compliment == Color.new(:green) ),
+and possibly color scheme suggestions (analagous, etc).
+
+Usage
+=====
+
+require 'color'
+=> true
+red = Color.new('ff0000')
+=> #<Color:0x352fd0 @hue=0.0, @lightness=0.5, @rgb=[255, 0, 0], @saturation=1.0>
+yellow = Color.new('ffff00')
+=> #<Color:0x34bb18 @hue=0.166666666666667, @lightness=0.5, @rgb=[255, 255, 0], @saturation=1.0>
+orange = red.mix_with yellow, 0.5
+=> #<Color:0x33dea0 @hue=0.0830065359477123, @lightness=0.5, @rgb=[255, 127, 0], @saturation=1.0>
+orange.to_hex
+=> "#ff7f00"
+orange.lightness += 0.2
+=> 0.7
+orange.to_hex
+=> "#ffb266"
+
+Warning
+=======
+
+This is alpha-quality software. It works according to general poking and prodding, but at this point all of half a morning has been spent on it. The API is subject to change. 

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rake'
+require 'rake/gempackagetask'
+# require 'rake/rdoctask'
+require 'rake/testtask'
+require 'rubygems'
+
+$:.unshift(File.dirname(__FILE__) + "/lib")
+require 'color'
+
+PKG_NAME      = 'color'
+PKG_VERSION   = Color::VERSION
+PKG_FILE_NAME = "#{PKG_NAME}-#{PKG_VERSION}"
+
+RELEASE_NAME  = "REL #{PKG_VERSION}"
+
+RUBY_FORGE_PROJECT = "color"
+RUBY_FORGE_USER    = "mly"
+
+desc "Default Task"
+task :default => [ :test ]
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/*_test.rb']
+  t.warning = true
+  t.verbose = false
+end
+
+spec = Gem::Specification.new do |s|
+  s.platform = Gem::Platform::RUBY
+  s.name = PKG_NAME
+  s.summary = "A Simply Library for Color Manipulation"
+  s.description = %q{Manipulate Colors Programatically}
+  s.version = PKG_VERSION
+  
+  s.author = "Matt Lyon"
+  s.email = "matt@postsomnia.com"
+  s.rubyforge_project = RUBY_FORGE_PROJECT
+  s.homepage = ""
+  
+  s.has_rdoc = false
+  s.require_path = 'lib'
+  s.autorequire = 'color'
+  
+  s.files = [ "Rakefile", "README", "CHANGELOG", "LICENSE" ]
+  s.files = s.files + Dir.glob("lib/**/*").delete_if {|item| item.include?("\.svn")}
+  s.files = s.files + Dir.glob("test/**/*").delete_if {|item| item.include?("\.svn")}
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end

data/lib/color.rb

@@ -0,0 +1,202 @@
+class Color
+  
+  VERSION = "0.1.0"
+  
+  # attr_accessor :rgb
+  attr_accessor :hue
+  attr_accessor :saturation
+  attr_accessor :lightness
+    
+  def initialize(values, mode=:rgb)
+    rgb = case mode
+    when :hsl
+      Color.hsl_to_rgb(values)
+    when :rgb
+      values = [values].flatten
+      case values.size
+      when 1
+        Color.rgbhex_to_rgb(values.first)
+      else
+        values
+      end
+    when :cmyk
+      Color.cmyk_to_rgb(values)
+    end
+    rgb.collect! {|n| n.coerce(0).max.coerce(255).min }
+    @hue, @saturation, @lightness = Color.rgb_to_hsl(rgb)
+  end
+  
+  def hue=(value)
+    value = value.abs >= 1 ? (value/360.0) : value
+    @hue = value
+    @hue += 1 if @hue < 0 # color is _perceived_ as a wheel, not a continuum
+    @hue -= 1 if @hue > 1
+  end
+  
+  def hue
+    (@hue * 360).round
+  end
+  
+  def saturation
+    (@saturation * 100).round
+  end
+  
+  def saturation=(value)
+    @saturation = value.abs >= 1 ? (value / 100.0) : value
+    @saturation = @saturation.coerce(0.0).max.coerce(1.0).min
+  end
+  
+  def lightness
+    (@lightness * 100).round
+  end
+  
+  def lightness=(value)
+    @lightness = value.abs >= 1 ? (value / 100.0) : value
+    @lightness = @lightness.coerce(0.0).max.coerce(1.0).min
+  end
+  
+  def mix_with(color, percent_as_decimal=0.5)
+    target = color.to_hsl
+    deltas = []
+    self.hsl.each_with_index {|val, i| deltas[i] = target[i] - val }
+    deltas.collect! {|n| n * percent_as_decimal }
+    new_color = []
+    deltas.each_with_index {|val, i| new_color[i] = val + self.hsl[i] }
+    Color.new(new_color, :hsl)
+  end
+  
+  def hsl
+    [@hue, @saturation, @lightness]
+  end
+  
+  def to_hsl
+    [(@hue * 360.0).round, (@saturation * 100.0).round, (@lightness * 100.0).round]
+  end
+    
+  def to_rgb
+    Color.hsl_to_rgb(hsl)
+  end
+  
+  def to_hex
+    Color.rgb_to_rgbhex(@rgb)
+  end
+  
+  def to_cmyk
+    Color.rgb_to_cmyk(@rgb)
+  end
+  
+  class << self
+    
+    def rgb_to_rgbhex(rgb=[])
+      '#' + rgb.collect {|n| "%02X" % n }.join('').downcase
+    end
+    
+    def rgbhex_to_rgb(value)
+      rg, blue = value.sub(/#/,'').hex.divmod(256)
+      red, green = rg.divmod(256)
+      return red, green, blue
+    end
+    
+    # conversion formulas from http://www.easyrgb.com/math.php
+    # They're on Wikipedia too. And elsewhere, really, but the easyrbg ones
+    # were most easily translatable to ruby.
+    #
+    # What's the difference between HSL and HSV? Quite a bit. 
+    # Wikipedia knows all:
+    #   http://en.wikipedia.org/wiki/HSV_color_space
+    #   http://en.wikipedia.org/wiki/HSL_color_space
+    #
+    # Generally, HSL has a more decoupled notion of saturation and lightness
+    # whereas with HSV saturation and value are coupled in such a way as to
+    # not behave intuitively. HSV is a bit more mathematically straightforward.
+    # 
+    # Since the author of this library is an artist and has a personal bias
+    # towards HSL, this library reflects that bias and uses HSL internally.   
+    # HSL is also part of the CSS3 Color Module, if I haven't convinced you yet.
+    
+    def rgb_to_hsl(rgb=[])
+      r, g, b, min, max, delta = rgb_to_values(rgb)
+      lightness = (max + min) / 2.0
+      return [0,0,lightness] if delta.zero?  # gray, no chroma
+      saturation = (lightness < 0.5) ? (delta / (max + min)) : (delta / (2.0 - max - min))
+      hue = figure_hue_for(rgb)
+      return hue, saturation, lightness
+    end
+    
+    def rgb_to_hsl_human(rgb=[])
+      h,s,l = Color.rgb_to_hsl(rgb)
+      return (h * 360).round, (s * 100).round, (l * 100).round
+    end
+    
+    def hsl_to_rgb(hsl=[])
+      h, s, l = hsl
+      if h > 1 || s > 1 || l > 1
+        h = h / 360.0
+        s = s * 0.01
+        l = l * 0.01
+      end
+      return [l,l,l].collect {|l| (l * 255.0).round } if s.zero? # gray, no chroma
+      v2 = (l < 0.5) ? (l * (1 + s)) : (l + s) - (s * l)
+      v1 = 2.0 * l - v2
+      rgb = [h+(1/3.0), h, h-(1/3.0)]
+      rgb.collect! do |hue|
+        hue += 1 if hue < 0
+        hue -= 1 if hue > 1
+        if (6 * hue) < 1
+          v1 + (v2 - v1) * 6 * hue
+        elsif (2 * hue) < 1
+          v2
+        elsif (3 * hue) < 2
+          v1 + (v2 - v1) * ((2 / 3.0) - hue) * 6
+        else
+          v1
+        end
+      end
+      return rgb.collect {|n| (n * 255.0).round }
+    end
+    
+    # def rgb_to_hsv(rgb=[])
+    #   r, g, b, min, max, delta = rgb_to_values(rgb)
+    #   value = max
+    #   return [0.0, 0.0, value] if delta.zero? # gray, no chroma
+    #   saturation = delta / max
+    #   hue = figure_hue_for(rgb)
+    #   return hue, saturation, value
+    # end
+        
+    def rgb_to_cmyk(rgb=[])
+      cmy = rgb.collect {|n| 1 - (n / 255.0)}
+      k = cmy.min
+      return [0.0,0.0,0.0,1.0] if k == 1.0  # black
+      cmy.collect {|n| (n - k) / (1 - k) } << k
+    end
+    
+    def cmyk_to_rgb(cmyk=[])
+      c,m,y,k = cmyk
+      [c,m,y].collect {|n| ((1 - (n * (1 - k) + k)) * 255.0).to_i }
+    end
+    
+    private
+    def rgb_to_values(rgb=[])
+      rgb.collect! {|n| n / 255.0 }
+      rgb << rgb.min << rgb.max << rgb.max - rgb.min
+    end
+    
+    def figure_hue_for(rgb=[])
+      r, g, b, min, max, delta = rgb_to_values(rgb)
+      delta_r, delta_g, delta_b = [r,g,b].collect {|n| (((max - n) / 6.0) + (delta / 2.0)) / delta }
+      hue = if r.eql? max
+        delta_b - delta_g
+      elsif g.eql? max
+        (1 / 3.0) + delta_r - delta_b
+      else # blue
+        (2 / 3.0) + delta_g - delta_r
+      end
+      hue += 1 if hue < 0
+      hue -= 1 if hue > 1
+      hue
+    end
+    
+  end
+  
+end

data/test/test_color.rb

@@ -0,0 +1,131 @@
+$:.unshift(File.dirname(__FILE__) + "/../lib/")
+
+require 'test/unit'
+require 'color'
+
+class TestColor < Test::Unit::TestCase
+  
+  COLORS = {
+    :red =>       {:html => '#ff0000', :rgb => [255,0,0],     :hsl => [0,100,50] },
+    :yellow =>    {:html => '#ffff00', :rgb => [255,255,0],   :hsl => [60,100,50] },
+    :blue =>      {:html => '#0000ff', :rgb => [0,0,255],     :hsl => [240,100,50] },
+    :brown =>     {:html => '#a16328', :rgb => [161,99,40],   :hsl => [29,60,39] },
+    :carnation => {:html => '#ff5ed0', :rgb => [255,94,208],  :hsl => [318,100,68] },
+    :cayenne =>   {:html => '#8d0000', :rgb => [141,0,0],     :hsl => [0,100,28] }
+  }
+  
+  ## eigenclass conversion methods
+  
+  def test_rgb_to_hex
+    COLORS.each_value do |color|
+      assert_equal color[:html], Color.rgb_to_rgbhex(color[:rgb])
+    end
+  end
+  
+  def test_hex_to_rgb
+    COLORS.each_value do |color|
+      assert_equal color[:rgb], Color.rgbhex_to_rgb(color[:html])
+    end
+  end
+  
+  def test_rgb_to_hsl
+    COLORS.each_value do |color|
+      assert_equivalent color[:hsl], Color.rgb_to_hsl_human(color[:rgb])
+    end
+  end
+  
+  def test_hsl_to_rgb
+    COLORS.each_value do |color|
+      assert_equivalent color[:rgb], Color.hsl_to_rgb(color[:hsl])
+    end
+  end
+  
+  def test_hsl_to_rgb_with_floats
+    COLORS.each_value do |color|
+      assert_equivalent color[:rgb], Color.hsl_to_rgb([(color[:hsl][0]/360.0), (color[:hsl][1]/100.0), (color[:hsl][2]/100.0)])
+    end
+  end
+  
+  # instance methods
+  
+  def test_intialize_from_hex
+    COLORS.each_value do |color|
+      instance = Color.new(color[:html])
+      assert_equal color[:hsl], instance.to_hsl
+    end
+  end
+  
+  def test_hue
+    assert_equal 60, Color.new(COLORS[:yellow][:html]).hue
+  end
+  
+  def test_hue_is
+    assert_equal 0.1, Color.new('000000').hue = 0.1
+    assert_equal 100, Color.new('000000').hue = 100
+    assert_equal 80, Color.new(COLORS[:yellow][:html]).hue += 20
+    # TODO: is there a way to have -= return 340 instead of -20 ?
+    red = Color.new(COLORS[:red][:html])
+    red.hue -= 20
+    assert_equal 340, red.hue
+  end
+  
+  def test_saturation
+    assert_equal 60, Color.new(COLORS[:brown][:html]).saturation
+  end
+  
+  def test_saturation_is
+    assert_equal 0.1, Color.new('000000').saturation = 0.1
+    assert_equal 10, Color.new('000000').saturation = 10
+    assert_equal 80, Color.new(COLORS[:red][:html]).saturation -= 20
+    assert_equal 70, Color.new(COLORS[:brown][:html]).saturation += 10
+  end
+  
+  def test_saturation_is_lower_limit
+    brown = Color.new(COLORS[:brown][:html])
+    brown.saturation -= 80
+    assert_equal 0, brown.saturation
+  end
+  
+  def test_saturation_is_upper_limit
+    brown = Color.new(COLORS[:brown][:html])
+    brown.saturation += 80
+    assert_equal 100, brown.saturation
+  end
+  
+  def test_lightness
+    assert_equal 50, Color.new(COLORS[:red][:html]).lightness
+  end
+  
+  def test_lightness_is
+    assert_equal 0.1, Color.new('000000').lightness = 0.1
+    assert_equal 10, Color.new('000000').lightness = 10
+    assert_equal 30, Color.new(COLORS[:red][:html]).lightness -= 20
+    assert_equal 70, Color.new(COLORS[:red][:html]).lightness += 20
+  end
+  
+  def test_lightness_is_lower_limit
+    red = Color.new(COLORS[:red][:html])
+    red.lightness -= 80
+    assert_equal 0, red.lightness
+  end
+  
+  def test_saturation_is_upper_limit
+    red = Color.new(COLORS[:red][:html])
+    red.lightness += 80
+    assert_equal 100, red.lightness
+  end
+  
+  def test_mix_with
+    red, yellow = Color.new(COLORS[:red][:html]), Color.new(COLORS[:yellow][:html])
+    assert_equal 30, red.mix_with(yellow, 0.5).hue
+  end
+  
+  #helpers
+  
+  def assert_equivalent(target=[], input=[])
+    difference = 0
+    target.each_with_index {|value, index| difference += (value - input[index]).abs }
+    assert difference <= 5, "[#{input.join(',')}] is not close enough to [#{target.join(',')}]"
+  end
+  
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: color
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2006-08-05 00:00:00 -07:00
+summary: A Simply Library for Color Manipulation
+require_paths: 
+- lib
+email: matt@postsomnia.com
+homepage: ""
+rubyforge_project: color
+description: Manipulate Colors Programatically
+autorequire: color
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Matt Lyon
+files: 
+- Rakefile
+- README
+- CHANGELOG
+- LICENSE
+- lib/color.rb
+- test/test_color.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+