color 1.4.1 → 1.8

data/Rakefile

@@ -1,116 +1,75 @@
-#! /usr/bin/env rake
-#--
-# Color
-# Colour Management with Ruby
-# http://rubyforge.org/projects/color
-#
-# Licensed under a MIT-style licence. See Licence.txt in the main
-# distribution for full licensing information.
-#
-# Copyright (c) 2005 - 2010 Austin Ziegler and Matt Lyon
-#++
+# -*- ruby -*-
 
 require 'rubygems'
 require 'hoe'
-
-$LOAD_PATH.unshift('lib')
-
-require 'color'
-
-PKG_NAME    = 'color'
-PKG_VERSION = Color::COLOR_VERSION
-PKG_DIST    = "#{PKG_NAME}-#{PKG_VERSION}"
-PKG_TAR     = "pkg/#{PKG_DIST}.tar.gz"
-MANIFEST    = File.read("Manifest.txt").split
-
-Hoe.spec PKG_NAME do
-  self.version = PKG_VERSION
-
-# self.rubyforge_name = PKG_NAME
-
-  developer "Austin Ziegler", "austin@rubyforge.org" 
-  developer "Matt Lyon", "matt@postsomnia.com" 
-
-  self.url = %W(http://color.rubyforge.org/ http://github.com/halostatue/color)
-
-  self.summary = "Colour management with Ruby"
-  self.changes = paragraphs_of("History.txt", 0..1).join("\n\n")
-  self.description = paragraphs_of("README.txt", 1..1).join("\n\n")
-
-  extra_dev_deps << [ "archive-tar-minitar", "~>0.5.1" ]
-  clean_globs << "coverage"
-
-  # This is a lie because I will continue to use Archive::Tar::Minitar.
-  self.need_tar        = false
+require 'rake/clean'
+
+Hoe.plugin :doofus
+Hoe.plugin :gemspec2
+Hoe.plugin :git
+Hoe.plugin :minitest
+Hoe.plugin :travis
+Hoe.plugin :email unless ENV['CI'] or ENV['TRAVIS']
+
+spec = Hoe.spec 'color' do
+  developer('Austin Ziegler', 'halostatue@gmail.com')
+  developer('Matt Lyon', 'matt@postsomnia.com')
+
+  license 'MIT'
+
+  self.history_file = 'History.rdoc'
+  self.readme_file = 'README.rdoc'
+
+  extra_dev_deps << ['hoe-doofus', '~> 1.0']
+  extra_dev_deps << ['hoe-gemspec2', '~> 1.1']
+  extra_dev_deps << ['hoe-git', '~> 1.6']
+  extra_dev_deps << ['hoe-travis', '~> 1.2']
+  extra_dev_deps << ['minitest', '~> 5.8']
+  extra_dev_deps << ['minitest-around', '~> 0.3']
+  extra_dev_deps << ['minitest-autotest', '~> 1.0']
+  extra_dev_deps << ['minitest-bisect', '~> 1.2']
+  extra_dev_deps << ['minitest-focus', '~> 1.1']
+  extra_dev_deps << ['minitest-moar', '~> 0.0']
+  extra_dev_deps << ['minitest-pretty_diff', '~> 0.1']
+  extra_dev_deps << ['rake', '~> 10.0']
+
+  if RUBY_VERSION >= '1.9'
+    extra_dev_deps << ['simplecov', '~> 0.7']
+    extra_dev_deps << ['coveralls', '~> 0.7'] if ENV['CI'] or ENV['TRAVIS']
+  end
 end
 
-desc "Build a Color .tar.gz distribution."
-task :tar => [ PKG_TAR ]
-file PKG_TAR => [ :test ] do |t|
-  require 'archive/tar/minitar'
-  require 'zlib'
-  files = MANIFEST.map { |f|
-    fn = File.join(PKG_DIST, f)
-    tm = File.stat(f).mtime
+if RUBY_VERSION >= '1.9'
+  namespace :test do
+    if ENV['CI'] or ENV['TRAVIS']
+      desc "Submit test coverage to Coveralls"
+      task :coveralls do
+        spec.test_prelude = [
+          'require "psych"',
+          'require "simplecov"',
+          'require "coveralls"',
+          'SimpleCov.formatter = Coveralls::SimpleCov::Formatter',
+          'SimpleCov.start("test_frameworks") { command_name "Minitest" }',
+          'gem "minitest"'
+        ].join('; ')
+        Rake::Task['test'].execute
+      end
 
-    if File.directory?(f)
-      { :name => fn, :mode => 0755, :dir => true, :mtime => tm }
-    else
-      mode = if f =~ %r{^bin}
-               0755
-             else
-               0644
-             end
-      data = File.read(f)
-      { :name => fn, :mode => mode, :data => data, :size => data.size,
-        :mtime => tm }
+      Rake::Task['travis'].prerequisites.replace(%w(test:coveralls))
     end
-  }
 
-  begin
-    unless File.directory?(File.dirname(t.name))
-      require 'fileutils'
-      File.mkdir_p File.dirname(t.name)
+    desc "Runs test coverage. Only works Ruby 1.9+ and assumes 'simplecov' is installed."
+    task :coverage do
+      spec.test_prelude = [
+        'require "simplecov"',
+        'SimpleCov.start("test_frameworks") { command_name "Minitest" }',
+        'gem "minitest"'
+      ].join('; ')
+      Rake::Task['test'].execute
     end
-    tf = File.open(t.name, 'wb')
-    gz = Zlib::GzipWriter.new(tf)
-    tw = Archive::Tar::Minitar::Writer.new(gz)
 
-    files.each do |entry|
-      if entry[:dir]
-        tw.mkdir(entry[:name], entry)
-      else
-        tw.add_file_simple(entry[:name], entry) { |os|
-          os.write(entry[:data])
-        }
-      end
-    end
-  ensure
-    tw.close if tw
-    gz.close if gz
+    CLOBBER << 'coverage'
   end
 end
-task :package => [ PKG_TAR ]
-
-desc "Build the manifest file from the current set of files."
-task :build_manifest do |t|
-  require 'find'
 
-  paths = []
-  Find.find(".") do |path|
-    next if File.directory?(path)
-    next if path =~ /\.svn/
-    next if path =~ /\.git/
-    next if path =~ /\.hoerc/
-    next if path =~ /\.swp$/
-    next if path =~ %r{coverage/}
-    next if path =~ /~$/
-    paths << path.sub(%r{^\./}, '')
-  end
-
-  File.open("Manifest.txt", "w") do |f|
-    f.puts paths.sort.join("\n")
-  end
-
-  puts paths.sort.join("\n")
-end
+# vim: syntax=ruby

data/lib/color.rb

@@ -1,24 +1,13 @@
 # :title: Color -- Colour Management with Ruby
-# :main: README.txt
-
-#--
-# Color
-# Colour management with Ruby
-# http://rubyforge.org/projects/color
-#   Version 1.4.1
-#
-# Licensed under a MIT-style licence. See Licence.txt in the main
-# distribution for full licensing information.
-#
-# Copyright (c) 2005 - 2010 Austin Ziegler and Matt Lyon
-#++
+# :main: README.rdoc
 
 # = Colour Management with Ruby
 module Color
-  COLOR_VERSION = '1.4.1'
+  COLOR_VERSION = '1.8'
 
   class RGB; end
   class CMYK; end
+  class HSL; end
   class GrayScale; end
   class YIQ; end
 
@@ -30,65 +19,116 @@ module Color
   # tolerance value of each other.
   COLOR_TOLERANCE = 1e-4
 
-  class << self
-    # Returns +true+ if the value is less than COLOR_EPSILON.
-    def near_zero?(value)
-      (value.abs <= COLOR_EPSILON)
-    end
+  # Compares the +other+ colour to this one. The +other+ colour will be
+  # coerced to the same type as the current colour. Such converted colour
+  # comparisons will always be more approximate than non-converted
+  # comparisons.
+  #
+  # If the +other+ colour cannot be coerced to the current colour class, a
+  # +NoMethodError+ exception will be raised.
+  #
+  # All values are compared as floating-point values, so two colours will be
+  # reported equivalent if all component values are within COLOR_TOLERANCE
+  # of each other.
+  def ==(other)
+    Color.equivalent?(self, other)
+  end
 
-    # Returns +true+ if the value is within COLOR_EPSILON of zero or less than
-    # zero.
-    def near_zero_or_less?(value)
-      (value < 0.0 or near_zero?(value))
-    end
+  # The primary name for the colour.
+  def name
+    names.first
+  end
 
-    # Returns +true+ if the value is within COLOR_EPSILON of one.
-    def near_one?(value)
-      near_zero?(value - 1.0)
-    end
+  # All names for the colour.
+  def names
+    self.names = nil unless defined? @names
+    @names
+  end
+  def names=(n) # :nodoc:
+    @names = Array(n).flatten.compact.map(&:to_s).map(&:downcase).sort.uniq
+  end
+  alias_method :name=, :names=
+end
 
-    # Returns +true+ if the value is within COLOR_EPSILON of one or more than
-    # one.
-    def near_one_or_more?(value)
-      (value > 1.0 or near_one?(value))
-    end
+class << Color
+  # Returns +true+ if the value is less than COLOR_EPSILON.
+  def near_zero?(value)
+    (value.abs <= Color::COLOR_EPSILON)
+  end
 
-    # Normalizes the value to the range (0.0) .. (1.0).
-    def normalize(value)
-      if near_zero_or_less? value
-        0.0
-      elsif near_one_or_more? value
-        1.0
-      else
-        value
-      end
-    end
-    alias normalize_fractional normalize
+  # Returns +true+ if the value is within COLOR_EPSILON of zero or less than
+  # zero.
+  def near_zero_or_less?(value)
+    (value < 0.0 or near_zero?(value))
+  end
 
-    def normalize_to_range(value, range)
-      range = (range.end..range.begin) if (range.end < range.begin)
+  # Returns +true+ if the value is within COLOR_EPSILON of one.
+  def near_one?(value)
+    near_zero?(value - 1.0)
+  end
 
-      if value <= range.begin
-        range.begin
-      elsif value >= range.end
-        range.end
-      else
-        value
-      end
-    end
+  # Returns +true+ if the value is within COLOR_EPSILON of one or more than
+  # one.
+  def near_one_or_more?(value)
+    (value > 1.0 or near_one?(value))
+  end
 
-    # Normalize the value to the range (0) .. (255).
-    def normalize_byte(value)
-      normalize_to_range(value, 0..255).to_i
+  # Returns +true+ if the two values provided are near each other.
+  def near?(x, y)
+    (x - y).abs <= Color::COLOR_TOLERANCE
+  end
+
+  # Returns +true+ if the two colours are roughly equivalent. If colour
+  # conversions are required, this all conversions will be implemented
+  # using the default conversion mechanism.
+  def equivalent?(a, b)
+    return false unless a.kind_of?(Color) && b.kind_of?(Color)
+    a.to_a.zip(a.coerce(b).to_a).all? { |(x, y)| near?(x, y) }
+  end
+
+  # Coerces, if possible, the second given colour object to the first
+  # given colour object type. This will probably involve colour
+  # conversion and therefore a loss of fidelity.
+  def coerce(a, b)
+    a.coerce(b)
+  end
+
+  # Normalizes the value to the range (0.0) .. (1.0).
+  def normalize(value)
+    if near_zero_or_less? value
+      0.0
+    elsif near_one_or_more? value
+      1.0
+    else
+      value
     end
-    alias normalize_8bit normalize_byte
-    
-    # Normalize the value to the range (0) .. (65535).
-    def normalize_word(value)
-      normalize_to_range(value, 0..65535).to_i
+  end
+  alias normalize_fractional normalize
+
+  # Normalizes the value to the specified range.
+  def normalize_to_range(value, range)
+    range = (range.end..range.begin) if (range.end < range.begin)
+
+    if value <= range.begin
+      range.begin
+    elsif value >= range.end
+      range.end
+    else
+      value
     end
-    alias normalize_16bit normalize_word
   end
+
+  # Normalize the value to the range (0) .. (255).
+  def normalize_byte(value)
+    normalize_to_range(value, 0..255).to_i
+  end
+  alias normalize_8bit normalize_byte
+
+  # Normalize the value to the range (0) .. (65535).
+  def normalize_word(value)
+    normalize_to_range(value, 0..65535).to_i
+  end
+  alias normalize_16bit normalize_word
 end
 
 require 'color/rgb'
@@ -96,10 +136,10 @@ require 'color/cmyk'
 require 'color/grayscale'
 require 'color/hsl'
 require 'color/yiq'
-require 'color/rgb/metallic'
+require 'color/css'
 
-module Color
-  def self.const_missing(name) #:nodoc:
+class << Color
+  def const_missing(name) #:nodoc:
     case name
     when "VERSION", :VERSION, "COLOR_TOOLS_VERSION", :COLOR_TOOLS_VERSION
       warn "Color::#{name} has been deprecated. Use Color::COLOR_VERSION instead."
@@ -115,7 +155,7 @@ module Color
   end
 
   # Provides a thin veneer over the Color module to make it seem like this
-  # is Color 0.1.0 (a class) and not Color 1.4.1 (a module). This
+  # is Color 0.1.0 (a class) and not Color 1.4 (a module). This
   # "constructor" will be removed in the future.
   #
   # mode = :hsl::   +values+ must be an array of [ hue deg, sat %, lum % ].
@@ -125,7 +165,7 @@ module Color
   #                 Color::RGB object will be created.
   # mode = :cmyk::  +values+ must be an array of [ cyan %, magenta %, yellow
   #                 %, black % ]. A Color::CMYK object will be created.
-  def self.new(values, mode = :rgb)
+  def new(values, mode = :rgb)
     warn "Color.new has been deprecated. Use Color::#{mode.to_s.upcase}.new instead."
     color = case mode
             when :hsl

data/lib/color/cmyk.rb

@@ -1,70 +1,44 @@
-#--
-# Color
-# Colour management with Ruby
-# http://rubyforge.org/projects/color
-#   Version 1.4.1
-#
-# Licensed under a MIT-style licence. See Licence.txt in the main
-# distribution for full licensing information.
-#
-# Copyright (c) 2005 - 2010 Austin Ziegler and Matt Lyon
-#++
-
 # An CMYK colour object. CMYK (cyan, magenta, yellow, and black) colours are
 # based on additive percentages of ink. A CMYK colour of (0.3, 0, 0.8, 0.3)
 # would be mixed from 30% cyan, 0% magenta, 80% yellow, and 30% black.
 # Primarily used in four-colour printing processes.
 class Color::CMYK
+  include Color
+
   # The format of a DeviceCMYK colour for PDF. In color-tools 2.0 this will
   # be removed from this package and added back as a modification by the
   # PDF::Writer package.
   PDF_FORMAT_STR = "%.3f %.3f %.3f %.3f %s"
 
-  # Compares the other colour to this one. The other colour will be
-  # converted to CMYK before comparison, so the comparison between a CMYK
-  # colour and a non-CMYK colour will be approximate and based on the other
-  # colour's #to_cmyk conversion. If there is no #to_cmyk conversion, this
-  # will raise an exception. This will report that two CMYK colours are
-  # equivalent if all component values are within COLOR_TOLERANCE of each
-  # other.
-  def ==(other)
-    other = other.to_cmyk
-    other.kind_of?(Color::CMYK) and
-    ((@c - other.c).abs <= Color::COLOR_TOLERANCE) and
-    ((@m - other.m).abs <= Color::COLOR_TOLERANCE) and
-    ((@y - other.y).abs <= Color::COLOR_TOLERANCE) and
-    ((@k - other.k).abs <= Color::COLOR_TOLERANCE)
+  # Coerces the other Color object into CMYK.
+  def coerce(other)
+    other.to_cmyk
   end
 
-  # Creates a CMYK colour object from fractional values 0..1.
-  #
-  #   Color::CMYK.from_fraction(0.3, 0, 0.8, 0.3)
-  def self.from_fraction(c = 0, m = 0, y = 0, k = 0)
-    colour = Color::CMYK.new
-    colour.c = c
-    colour.m = m
-    colour.y = y
-    colour.k = k
-    colour
-  end
+  class << self
+    # Creates a CMYK colour object from fractional values 0..1.
+    #
+    #   Color::CMYK.from_fraction(0.3, 0, 0.8, 0.3)
+    def from_fraction(c = 0, m = 0, y = 0, k = 0, &block)
+      new(c, m, y, k, 1.0, &block)
+    end
 
-  # Creates a CMYK colour object from percentages. Internally, the colour is
-  # managed as fractional values 0..1.
-  #
-  #   Color::CMYK.new(30, 0, 80, 30)
-  def self.from_percent(c = 0, m = 0, y = 0, k = 0)
-    Color::CMYK.new(c, m, y, k)
+    # Creates a CMYK colour object from percentages. Internally, the colour is
+    # managed as fractional values 0..1.
+    #
+    #   Color::CMYK.new(30, 0, 80, 30)
+    def from_percent(c = 0, m = 0, y = 0, k = 0, &block)
+      new(c, m, y, k, &block)
+    end
   end
 
   # Creates a CMYK colour object from percentages. Internally, the colour is
   # managed as fractional values 0..1.
   #
   #   Color::CMYK.new(30, 0, 80, 30)
-  def initialize(c = 0, m = 0, y = 0, k = 0)
-    @c = c / 100.0
-    @m = m / 100.0
-    @y = y / 100.0
-    @k = k / 100.0
+  def initialize(c = 0, m = 0, y = 0, k = 0, radix = 100.0, &block) # :yields self:
+    @c, @m, @y, @k = [ c, m, y, k ].map { |v| Color.normalize(v / radix) }
+    block.call(self) if block
   end
 
   # Present the colour as a DeviceCMYK fill colour string for PDF. This will
@@ -96,8 +70,8 @@ class Color::CMYK
   # Present the colour as an RGBA (with alpha) HTML/CSS colour string (e.g.,
   # "rgb(0%, 50%, 100%, 1)"). Note that this will perform a #to_rgb
   # operation using the default conversion formula.
-  def css_rgba
-    to_rgb.css_rgba
+  def css_rgba(alpha = 1)
+    to_rgb.css_rgba(alpha)
   end
 
   # Present the colour as an HSL HTML/CSS colour string (e.g., "hsl(180,
@@ -150,15 +124,10 @@ class Color::CMYK
   # profiles.
   def to_rgb(use_adobe_method = false)
     if use_adobe_method
-      r = 1.0 - [1.0, @c + @k].min
-      g = 1.0 - [1.0, @m + @k].min
-      b = 1.0 - [1.0, @y + @k].min
+      Color::RGB.from_fraction(*adobe_cmyk_rgb)
     else
-      r = 1.0 - (@c.to_f * (1.0 - @k.to_f) + @k.to_f)
-      g = 1.0 - (@m.to_f * (1.0 - @k.to_f) + @k.to_f)
-      b = 1.0 - (@y.to_f * (1.0 - @k.to_f) + @k.to_f)
+      Color::RGB.from_fraction(*standard_cmyk_rgb)
     end
-    Color::RGB.from_fraction(r, g, b)
   end
 
   # Converts the CMYK colour to a single greyscale value. There are
@@ -276,4 +245,19 @@ class Color::CMYK
   def k=(kk)
     @k = Color.normalize(kk)
   end
+
+  def to_a
+    [ c, m, y, k ]
+  end
+
+  private
+  # Implements the Adobe PDF conversion of CMYK to RGB.
+  def adobe_cmyk_rgb
+    [ @c, @m, @y ].map { |v| 1.0 - [ 1.0, v + @k ].min }
+  end
+
+  # Implements the standard conversion of CMYK to RGB.
+  def standard_cmyk_rgb
+    [ @c, @m, @y ].map { |v| 1.0 - (v * (1.0 - k) + k) }
+  end
 end