ripta-color-tools 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0671d2f6ffbb0a65f9a38f2bebe37a9ac462c4d
+  data.tar.gz: 985a016475aab3b0a0f4e941c6977eda55afa6e2
+SHA512:
+  metadata.gz: 158256c3e29dcff40f383abcdaa301f0f6e546012a2b9484db1383f3fb8a1b01954d3297b54eebbd019acc7f0f75a2e14a41a20d1113d762a2e1976e66950f58
+  data.tar.gz: 26e2308403b9ed12f4ddc1396121825af1110099913f9d516fde59337f1e5bc53e075285b21a2703c9469a050ecdc46d47540e55a38b226177ee139deddc3749

data/Changelog

@@ -0,0 +1,55 @@
+= color-tools Change Log
+
+== color-utils 1.4.0
+* Use autoloading for various parts of the library. Now simply require "color"
+  and other modules/classes will be required for you when you use them for the
+  first time.
+
+== color-utils 1.3.0
+* Added new metallic colours suggested by Jim Freeze <jfn@freeze.org>. These
+  are in the namespace Color::Metallic.
+* Colours that were defined in the Color namespace (e.g., Color::Red,
+  Color::AliceBlue) are now defined in Color::RGB (e.g., Color::RGB::Red,
+  Color::RGB::AliceBlue). They are added back to the Color namespace on the
+  first use of the old colours and a warning is printed. In version 1.4, this
+  warning will be printed on every use of the old colours. In version 1.5,
+  the backwards compatible support for colours like Color::Red will be
+  removed completely.
+* Added the Color::CSS module, color/css or Color::CSS that provides a name
+  lookup of Color::RGB-namespaced constants with Color::CSS[name]. Most of
+  these colours (which are mirrored from the Color::RGB default colours) are
+  only "officially" recognised under the CSS3 colour module or SVG.
+* Added the Color::HSL colour space and some helper utilities to Color::RGB
+  for colour manipulation using the HSL value.
+* Controlled internal value replacement to be between 0 and 1 for all
+  colours.
+* Updated Color::Palette::Gimp to more meaningfully deal with duplicate named
+  colours. Named colours now return an array of colours.
+* Indicated the plans for some methods and constants out to color-tools 2.0.
+* Added unit tests and fixed a number of hidden bugs because of them.
+
+== color-utils 1.2.0
+* Changed installer from a custom-written install.rb to setup.rb
+  3.3.1-modified.
+* Added Color::GreyScale (or Color::GrayScale).
+* Added Color::YIQ. This colour definition is incomplete; it does not have
+  conversions from YIQ to other colour spaces.
+
+== color-utils 1.1.0
+* Added color/palette/gimp to support the reading and use of GIMP color
+  palettes.
+
+== color-utils 1.0.0
+* Initial release.
+
+#--
+# Colour management with Ruby.
+#
+# Copyright 2005 Austin Ziegler
+#   http://rubyforge.org/ruby-pdf/
+#
+#   Licensed under a MIT-style licence.
+#
+# $Id$
+#++
+# vim: sts=2 sw=2 ts=4 et ai tw=77

data/Install

@@ -0,0 +1,18 @@
+Installing this package is as simple as:
+
+% ruby setup.rb
+
+Alternatively, you can use the RubyGem version of color-tools available as
+color-tools-1.3.0.gem from the usual sources.
+
+#--
+# Colour management with Ruby.
+#
+# Copyright 2005 Austin Ziegler
+#   http://rubyforge.org/ruby-pdf/
+#
+#   Licensed under a MIT-style licence.
+#
+# $Id$
+#++
+# vim: sts=2 sw=2 ts=4 et ai tw=77

data/README.rdoc

@@ -0,0 +1,82 @@
+
+color-tools is a Ruby library to provide RGB, CMYK, and other colourspace
+support to applications that require it. It also provides 152 named RGB
+colours. It offers 152 named RGB colours (184 with spelling variations)
+that are commonly supported and used in HTML, SVG, and X11 applications. A
+technique for generating a monochromatic contrasting palette is also
+included.
+
+Version 1.3 offers significant enhancements over color-tools 1.2, and a
+plan for an incompatible change to the library.
+
+* Colours that were defined in the Color namespace (e.g., Color::Red,
+  Color::AliceBlue) are now defined in Color::RGB (e.g., Color::RGB::Red,
+  Color::RGB::AliceBlue). They are added back to the Color namespace on
+  the first use of the old colours and a warning is printed. In version
+  1.4, this warning will be printed on every use of the old colours. In
+  version 1.5, the backwards compatible support for colours like
+  Color::Red will be removed completely.
+
+* A CSS colour name module has been added. It is based on the Color::RGB
+  predefined colours. It is called with "Color::CSS[color]". The provided
+  colour name will be looked up ignoring case so that "DarkSalmon" and
+  "darksalmon" (and :darksalmon) are the same value. This makes it easier
+  on web or SVG developers who wish to be able to manipulate a colour
+  based on a CSS colour name.
+
+* A new predefined colour namespace has been added for RGB metallic
+  colours (Color::Metallic, in color/rgb/metallic), suggested by Jim
+  Freeze <jfn@freeze.org>.
+
+* A new colour space, Color::HSL (hue, saturation, and luminosity) has
+  been added with some helper methods to Color::RGB for colour
+  manipulation.
+
+* Added unit tests and fixed various little bugs.
+
+== Copyright
+Copyright 2005 by Austin Ziegler
+
+Color::Palette was developed based on techniques described by Andy
+"Malarkey" Clarke[1], implemented in JavaScript by Steve G. Chipman at
+SlayerOffice[2] and by Patrick Fitzgerald of BarelyFitz[3] in PHP.
+
+== Licence
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Soft-
+ware"), 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 names of its contributors may not be used to endorse or promote
+  products derived from this software without specific prior written
+  permission.
+
+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.
+
+[1] http://www.stuffandnonsense.co.uk/archives/creating_colour_palettes.html 
+[2] http://slayeroffice.com/tools/color_palette/
+[3] http://www.barelyfitz.com/projects/csscolor/
+
+#--
+# Colour management with Ruby.
+#
+# Copyright 2005 Austin Ziegler
+#   http://rubyforge.org/ruby-pdf/
+#
+#   Licensed under a MIT-style licence.
+#
+# $Id$
+#++
+# vim: sts=2 sw=2 ts=4 et ai tw=74

data/Rakefile

@@ -0,0 +1,123 @@
+#! /usr/bin/env rake
+#--
+# Colour management with Ruby.
+#
+# Copyright 2005 Austin Ziegler
+#   http://rubyforge.org/ruby-pdf/
+#
+#   Licensed under a MIT-style licence.
+#
+# $Id$
+#++
+# vim: sts=2 sw=2 ts=4 et ai tw=77
+
+$LOAD_PATH.unshift('lib')
+
+require 'rubygems'
+require 'rubygems/package_task'
+require 'color'
+
+DISTDIR = "color-tools-#{Color::COLOR_TOOLS_VERSION}"
+TARDIST = "../#{DISTDIR}.tar.gz"
+
+DATE_RE = %r<(\d{4})[./-]?(\d{2})[./-]?(\d{2})(?:[\sT]?(\d{2})[:.]?(\d{2})[:.]?(\d{2})?)?>
+
+if ENV['RELEASE_DATE']
+  year, month, day, hour, minute, second = DATE_RE.match(ENV['RELEASE_DATE']).captures
+  year ||= 0
+  month ||= 0
+  day ||= 0
+  hour ||= 0
+  minute ||= 0
+  second ||= 0
+  ReleaseDate = Time.mktime(year, month, day, hour, minute, second)
+else
+  ReleaseDate = nil
+end
+
+task :test do |t|
+  require 'test/unit/testsuite'
+  require 'test/unit/ui/console/testrunner'
+
+  runner = Test::Unit::UI::Console::TestRunner
+
+  $LOAD_PATH.unshift('tests')
+  Dir['tests/test_*.rb'].each do |testcase|
+    load testcase
+  end
+
+  suite = Test::Unit::TestSuite.new("color-tools")
+
+  ObjectSpace.each_object(Class) do |testcase|
+    suite << testcase.suite if testcase < Test::Unit::TestCase
+  end
+
+  runner.run(suite)
+end
+
+spec = eval(File.read("color-tools.gemspec"))
+spec.version = Color::COLOR_TOOLS_VERSION
+desc "Build the RubyGem for color-tools"
+task :gem => [ :test ]
+Gem::PackageTask.new(spec) do |g|
+  g.need_tar    = false
+  g.need_zip    = false
+  g.package_dir = ".."
+end
+
+desc "Build a color-tools .tar.gz distribution."
+task :tar => [ TARDIST ]
+file TARDIST => [ :test ] do |t|
+  require 'archive/tar/minitar'
+  require 'zlib'
+  current = File.basename(Dir.pwd)
+  Dir.chdir("..") do
+    begin
+      files = Dir["#{current}/**/*"].select { |dd| dd !~ %r{(?:/CVS/?|~$)} }
+      files.map! do |dd|
+        ddnew = dd.gsub(/^#{current}/, DISTDIR)
+        mtime = ReleaseDate || File.stat(dd).mtime
+        if File.directory?(dd)
+          { :name => ddnew, :mode => 0755, :dir => true, :mtime => mtime }
+        else
+          if dd =~ %r{bin/}
+            mode = 0755
+          else
+            mode = 0644
+          end
+          data = File.open(dd, "rb") { |ff| ff.read }
+          { :name => ddnew, :mode => mode, :data => data, :size => data.size,
+            :mtime => mtime }
+        end
+      end
+
+      ff = File.open(t.name.gsub(%r{^\.\./}o, ''), "wb")
+      gz = Zlib::GzipWriter.new(ff)
+      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
+    end
+  end
+end
+task TARDIST => [ :test ]
+
+desc "Build the rdoc documentation for color-tools"
+task :docs do
+  require 'rdoc/rdoc'
+  rdoc_options = %w(--title color-tools --main README.rdoc --line-numbers)
+  files = FileList[*%w(README.rdoc Changelog bin/**/*.rb lib/**/*.rb)]
+  rdoc_options += files.to_a
+  RDoc::RDoc.new.document(rdoc_options)
+end
+
+desc "Build everything."
+task :default => [ :tar, :gem ]

data/lib/color.rb

@@ -0,0 +1,78 @@
+#--
+# Colour management with Ruby.
+#
+# Copyright 2005 Austin Ziegler
+#   http://rubyforge.org/ruby-pdf/
+#
+#   Licensed under a MIT-style licence.
+#
+# $Id$
+#++
+
+# = Colour Management with Ruby
+#
+# == Copyright
+# Copyright 2005 by Austin Ziegler
+#
+# Color::RGB and Color::CMYK were originally developed for the Ruby PDF
+# project and PDF::Writer and represent wholly unique code.
+#
+# Color::Palette was developed based on techniques described by Andy
+# "Malarkey"[http://www.stuffandnonsense.co.uk/archives/creating_colour_palettes.html]
+# Clarke, implemented in JavaScript by Steve G. Chipman at
+# SlayerOffice[http://slayeroffice.com/tools/color_palette/] and by Patrick
+# Fitzgerald of BarelyFitz[http://www.barelyfitz.com/projects/csscolor/] in
+# PHP.
+#
+# == LICENCE
+# 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 names of its contributors may not be used to endorse or promote
+#   products derived from this software without specific prior written
+#   permission.
+#
+# 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.
+module Color
+  
+  COLOR_TOOLS_VERSION = '1.3.0'
+  
+  autoload :CMYK, "color/cmyk"
+  autoload :CSS, "color/css"
+  autoload :GrayScale, "color/grayscale"
+  autoload :GreyScale, "color/grayscale"
+  autoload :HSL, "color/hsl"
+  autoload :Palette, "color/palette"
+  autoload :RGB, "color/rgb"
+  autoload :YIQ, "color/yiq"
+
+  def self.const_missing(name) #:nodoc:
+    if Color::RGB.const_defined?(name)
+      warn "These colour constants have been deprecated. Use Color::RGB::#{name} instead."
+      Color::RGB.constants.each do |const|
+        color = Color::RGB.const_get(const)
+        const_set(const, color) if color.is_a?(Color::RGB)
+      end
+      class <<Color
+        remove_method :const_missing
+      end
+      Color.const_get(name)
+    else
+      super
+    end
+  end
+
+end

data/lib/color/cmyk.rb

@@ -0,0 +1,185 @@
+#--
+# Colour management with Ruby.
+#
+# Copyright 2005 Austin Ziegler
+#   http://rubyforge.org/ruby-pdf/
+#
+#   Licensed under a MIT-style licence.
+#
+# $Id$
+#++
+
+# 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.
+class Color::CMYK
+  # 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 1e-4
+  # (0.0001) of each other.
+  def ==(other)
+    other = other.to_cmyk
+    other.kind_of?(Color::CMYK) and
+    ((@c - other.c).abs <= 1e-4) and
+    ((@m - other.m).abs <= 1e-4) and
+    ((@y - other.y).abs <= 1e-4) and
+    ((@k - other.k).abs <= 1e-4)
+  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
+
+  # Creates a CMYK colour object from percentages. Internally, the colour
+  # is managed as fractional values 0..1.
+  #
+  #   Color::CMYK.from_fraction(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
+  end
+
+  # Present the colour as a DeviceCMYK fill colour string for PDF. This
+  # will be removed from the default package in color-tools 2.0.
+  def pdf_fill
+    PDF_FORMAT_STR % [ @c, @m, @y, @k, "k" ]
+  end
+
+  # Present the colour as a DeviceCMYK stroke colour string for PDF. This
+  # will be removed from the default package in color-tools 2.0.
+  def pdf_stroke
+    PDF_FORMAT_STR % [ @c, @m, @y, @k, "K" ]
+  end
+
+  # Present the colour as an RGB HTML/CSS colour string. Note that this
+  # will perform a #to_rgb operation using the default conversion formula.
+  def html
+    to_rgb.html
+  end
+
+  # Converts the CMYK colour to RGB. Most colour experts strongly suggest
+  # that this is not a good idea (some even suggesting that it's a very
+  # bad idea). CMYK represents additive percentages of inks on white
+  # paper, whereas RGB represents mixed colour intensities on a black
+  # screen.
+  #
+  # However, the colour conversion can be done, and there are two
+  # different methods for the conversion that provide slightly different
+  # results. Adobe PDF conversions are done with the first form.
+  #
+  #     # Adobe PDF Display Formula
+  #   r = 1.0 - min(1.0, c + k)
+  #   g = 1.0 - min(1.0, m + k)
+  #   b = 1.0 - min(1.0, y + k)
+  #
+  #     # Other
+  #   r = 1.0 - (c * (1.0 - k) + k)
+  #   g = 1.0 - (m * (1.0 - k) + k)
+  #   b = 1.0 - (y * (1.0 - k) + k)
+  #
+  # If we have a CMYK colour of [33% 66% 83% 25%], the first method will
+  # give an approximate RGB colour of (107, 23, 0) or #6b1700. The second
+  # method will give an approximate RGB colour of (128, 65, 33) or
+  # #804121. Which is correct? Although the colours may seem to be
+  # drastically different in the RGB colour space, they are very similar
+  # colours, differing mostly in intensity. The first is a darker,
+  # slightly redder brown; the second is a lighter brown.
+  #
+  # Because of this subtlety, both methods are now offered for conversion
+  # in color-tools 1.2 or later. The Adobe method is not used by default;
+  # to enable it, pass +true+ to #to_rgb.
+  #
+  # Future versions of color-tools may offer other conversion mechanisms
+  # that offer greater colour fidelity.
+  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
+    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)
+    end
+    Color::RGB.from_fraction(r, g, b)
+  end
+
+  # Converts the CMYK colour to a single greyscale value. There are
+  # undoubtedly multiple methods for this conversion, but only a minor
+  # variant of the Adobe conversion method will be used:
+  #
+  #   g = 1.0 - min(1.0, 0.299 * c + 0.587 * m + 0.114 * y + k)
+  #
+  # This treats the CMY values similarly to YIQ (NTSC) values and then
+  # adds the level of black. This is a variant of the Adobe version
+  # because it uses the more precise YIQ (NTSC) conversion values for Y
+  # (intensity) rather than the approximates provided by Adobe (0.3, 0.59,
+  # and 0.11).
+  def to_grayscale
+    c = 0.299 * @c.to_f
+    m = 0.587 * @m.to_f
+    y = 0.114 * @y.to_f
+    g = 1.0 - [1.0, c + m + y + @k].min
+    Color::GrayScale.from_fraction(g)
+  end
+  alias to_greyscale to_grayscale
+
+  def to_cmyk
+    self
+  end
+
+  # Converts to RGB then YIQ.
+  def to_yiq
+    to_rgb.to_yiq
+  end
+
+  # Converts to RGB then HSL.
+  def to_hsl
+    to_rgb.to_hsl
+  end
+
+  attr_reader :c, :m, :y, :k
+
+  def c=(cc) #:nodoc:
+    cc = 1.0 if cc > 1
+    cc = 0.0 if cc < 0
+    @c = cc
+  end
+
+  def m=(mm) #:nodoc:
+    mm = 1.0 if mm > 1
+    mm = 0.0 if mm < 0
+    @m = mm
+  end
+
+  def y=(yy) #:nodoc:
+    yy = 1.0 if yy > 1
+    yy = 0.0 if yy < 0
+    @y = yy
+  end
+
+  def k=(kk) #:nodoc:
+    kk = 1.0 if kk > 1
+    kk = 0.0 if kk < 0
+    @k = kk
+  end
+end