coloration 0.3.3 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f20ffabab2c5147efa6b0c06421827a1b05fb615
+  data.tar.gz: 6323701b78561cd8382e2d0337138038b98784f3
+SHA512:
+  metadata.gz: 2d26dc40b8625dd46bcba5baa2f85f90b870152d340de97a5cd98fe7df5ea91720da1567d492e5d7d69ae5a5cc0cc56d86c71d835f7f7a3093487326764e5f72
+  data.tar.gz: 006055f21fd76e4a136912e4efec624620170d2270d16e46d5bddc2c1dd0017e8488f23f784b766287abe36ed549b0cef9d9cb61160aaca4ad9290046a0e1616

data/README.md

@@ -2,26 +2,36 @@
 
 ## About
 
-__Coloration__ is editor/IDE color scheme converter. Right now it allows you to convert your favourite Textmate color
-scheme (in XML plist format) to Vim, JEdit and KDevelop/Kate/Kwrite color scheme. It tries to do its best to generate the most accurate 
-result for given target.
+__Coloration__ is editor/IDE color scheme converter. Right now it allows you to
+ convert your favourite Textmate color scheme (in XML plist format) to Vim,
+ JEdit and KDevelop/Kate/Kwrite color scheme. It tries to do its best to
+ generate the most accurate result for given target.
+
+## Requirements
+
+If you are running Coloration from the command line locally, a modern version
+ (> 2.0) of Ruby is required. Note: You may have trouble running Coloration with
+ Windows installations. (Pull requests welcome!)
 
 ## Installation && Usage
 
-You can use Coloration in two ways: online or on your local machine. Online version is available 
-at [coloration.sickill.net](http://coloration.sickill.net/). If you like to install coloration on your own machine to 
-do some batch conversion or for some other reason just run:
+You can use Coloration in two ways: online or on your local machine. The online
+ version is available at [coloration.ku1ik.com](http://coloration.ku1ik.com/).
+ If you like to install coloration on your own machine to do some batch
+ conversion or for some other reason just run:
 
     gem install coloration
 
-It gives you _tm2vim_, _tm2jedit_ and _tm2katepart_ binaries to do the conversion on command line.
+It gives you _tm2vim_, _tm2jedit_ and _tm2katepart_ binaries to do the
+ conversion on command line.
 
 ## Contact
 
-If you found a bug or want to look at the source code you should go to [githubs](http://github.com/sickill/coloration).
-Also if you tried to convert a theme and coloration failed or result is not quite good, please report an issue 
-at [issue tracker](http://github.com/sickill/coloration/issues).
+If you found a bug or want to look at the source code you should go to
+ [github](http://github.com/sickill/coloration). Also if you tried to convert a
+ theme and coloration failed or result is not quite good, please report an issue
+ at [issue tracker](http://github.com/sickill/coloration/issues).
 
 ## Author
 
-Coloration was created by Marcin Kulik ([sickill.net](http://sickill.net/))
+Coloration was created by Marcin Kulik ([ku1ik.com](http://ku1ik.com/))

data/bin/tm2jedit

@@ -1,5 +1,8 @@
 #!/usr/bin/env ruby
 
+lib_dir = File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
 require "coloration"
 
 Coloration::Converters::Textmate2JEditConverter.process_cmd_line

data/bin/tm2katepart

@@ -1,5 +1,8 @@
 #!/usr/bin/env ruby
 
+lib_dir = File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
 require "coloration"
 
 Coloration::Converters::Textmate2KatePartConverter.process_cmd_line

data/bin/tm2vim

@@ -1,5 +1,8 @@
 #!/usr/bin/env ruby
 
+lib_dir = File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
 require "coloration"
 
 Coloration::Converters::Textmate2VimConverter.process_cmd_line

data/lib/coloration.rb

@@ -1,13 +1,15 @@
-require 'color'
+require 'coloration/color/color'
 
 require "coloration/version.rb"
 require "coloration/extensions.rb"
 require "coloration/style.rb"
-require "coloration/abstract_converter.rb"
+require "coloration/converters/abstract_converter.rb"
 require "coloration/color_rgba.rb"
 
+require "coloration/support/items_lookup.rb"
 require "coloration/readers/textmate_theme_reader.rb"
 
+require "coloration/writers/abstract_writer.rb"
 require "coloration/writers/jedit_theme_writer.rb"
 require "coloration/writers/katepart_theme_writer.rb"
 require "coloration/writers/vim_theme_writer.rb"

data/lib/coloration/color/cmyk.rb

@@ -0,0 +1,182 @@
+#--
+# Colour management with Ruby.
+#
+# Copyright 2005 Austin Ziegler
+#   http://rubyforge.org/ruby-pdf/
+#
+#   Licensed under a MIT-style licence.
+#
+# $Id: cmyk.rb,v 1.5 2005/08/08 02:44:17 austin Exp $
+#++
+
+  # 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_accessor :c, :m, :y, :k
+  remove_method :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

data/lib/coloration/color/color.rb

@@ -0,0 +1,87 @@
+#--
+# Colour management with Ruby.
+#
+# Copyright 2005 Austin Ziegler
+#   http://rubyforge.org/ruby-pdf/
+#
+#   Licensed under a MIT-style licence.
+#
+# $Id: color.rb,v 1.8 2005/08/08 02:44:17 austin Exp $
+#++
+
+# = 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'
+
+  class RGB; end
+  class CMYK; end
+  class GrayScale; end
+  class YIQ; end
+end
+
+require 'coloration/color/rgb'
+require 'coloration/color/cmyk'
+require 'coloration/color/grayscale'
+require 'coloration/color/hsl'
+require 'coloration/color/yiq'
+require 'coloration/color/rgb/metallic'
+
+  # We load EVERYTHING if we're being run under ZenTest.
+if defined? $ZENTEST and $ZENTEST
+  require 'coloration/color/css'
+  require 'coloration/color/palette/gimp'
+  require 'coloration/color/palette/monocontrast'
+end
+
+module Color
+  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|
+        next if const == "PDF_FORMAT_STR"
+        next if const == "Metallic"
+        const_set(const, Color::RGB.const_get(const))
+      end
+      class << Color; remove_method :const_missing; end
+      Color.const_get(name)
+    else
+      super
+    end
+  end
+end

data/lib/coloration/color/css.rb

@@ -0,0 +1,27 @@
+#--
+# Colour management with Ruby.
+#
+# Copyright 2005 Austin Ziegler
+#   http://rubyforge.org/ruby-pdf/
+#
+#   Licensed under a MIT-style licence.
+#
+# $Id: css.rb,v 1.1 2005/08/05 23:07:20 austin Exp $
+#++
+
+require 'coloration/color'
+
+  # This namespace contains some CSS colour names.
+module Color::CSS
+    # Returns the RGB colour for name or +nil+ if the name is not valid.
+  def self.[](name)
+    @colors[name.to_s.downcase.to_sym]
+  end
+
+  @colors = {}
+  Color::RGB.constants.each do |const|
+    next if const == "PDF_FORMAT_STR"
+    next if const == "Metallic"
+    @colors[const.downcase.to_sym] ||= Color::RGB.const_get(const)
+  end
+end

data/lib/coloration/color/grayscale.rb

@@ -0,0 +1,135 @@
+#--
+# Colour management with Ruby.
+#
+# Copyright 2005 Austin Ziegler
+#   http://rubyforge.org/ruby-pdf/
+#
+#   Licensed under a MIT-style licence.
+#
+# $Id: grayscale.rb,v 1.3 2005/08/08 02:44:17 austin Exp $
+#++
+
+  # A colour object representing shades of grey. Used primarily in PDF
+  # document creation.
+class Color::GrayScale
+    # The format of a DeviceGrey 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 %s"
+
+    # Creates a greyscale colour object from fractional values 0..1.
+    #
+    #   Color::GreyScale.from_fraction(0.5)
+  def self.from_fraction(g = 0)
+    color = Color::GrayScale.new
+    color.g = g
+    color
+  end
+
+    # Creates a greyscale colour object from percentages 0..100.
+    #
+    #   Color::GrayScale.new(50)
+  def initialize(g = 0)
+    @g = g / 100.0
+  end
+
+    # Compares the other colour to this one. The other colour will be
+    # converted to GreyScale before comparison, so the comparison between a
+    # GreyScale colour and a non-GreyScale colour will be approximate and
+    # based on the other colour's #to_greyscale conversion. If there is no
+    # #to_greyscale conversion, this will raise an exception. This will
+    # report that two GreyScale values are equivalent if they are within
+    # 1e-4 (0.0001) of each other.
+  def ==(other)
+    other = other.to_grayscale
+    other.kind_of?(Color::GrayScale) and
+    ((@g - other.g).abs <= 1e-4)
+  end
+
+    # Present the colour as a DeviceGrey fill colour string for PDF. This
+    # will be removed from the default package in color-tools 2.0.
+  def pdf_fill
+    PDF_FORMAT_STR % [ @g, "g" ]
+  end
+
+    # Present the colour as a DeviceGrey stroke colour string for PDF. This
+    # will be removed from the default package in color-tools 2.0.
+  def pdf_stroke
+    PDF_FORMAT_STR % [ @g, "G" ]
+  end
+
+  def to_255
+    [(@g * 255).round, 255].min
+  end
+  private :to_255
+
+    # Present the colour as an HTML/CSS colour string.
+  def html
+    gs = "%02x" % to_255
+    "##{gs * 3}"
+  end
+
+    # Convert the greyscale colour to CMYK.
+  def to_cmyk
+    k = 1.0 - @g.to_f
+    Color::CMYK.from_fraction(0, 0, 0, k)
+  end
+
+    # Convert the greyscale colour to RGB.
+  def to_rgb(ignored = true)
+    g = to_255
+    Color::RGB.new(g, g, g)
+  end
+
+  def to_grayscale
+    self
+  end
+  alias to_greyscale to_grayscale
+
+    # Lightens the greyscale colour by the stated percent.
+  def lighten_by(percent)
+    g = [@g + (@g * (percent / 100.0)), 1.0].min
+    Color::GrayScale.from_fraction(g)
+  end
+
+    # Darken the RGB hue by the stated percent.
+  def darken_by(percent)
+    g = [@g - (@g * (percent / 100.0)), 0.0].max
+    Color::GrayScale.from_fraction(g)
+  end
+
+    # Returns the YIQ (NTSC) colour encoding of the greyscale value. This
+    # is an approximation, as the values for I and Q are calculated by
+    # treating the greyscale value as an RGB value. The Y (intensity or
+    # brightness) value is the same as the greyscale value.
+  def to_yiq
+    y = @g
+    i = (@g * 0.596) + (@g * -0.275) + (@g * -0.321)
+    q = (@g * 0.212) + (@g * -0.523) + (@g *  0.311)
+    Color::YIQ.from_fraction(y, i, q)
+  end
+
+    # Returns the HSL colour encoding of the greyscale value.
+  def to_hsl
+    Color::HSL.from_fraction(0, 0, @g)
+  end
+
+    # Returns the brightness value for this greyscale value; this is the
+    # greyscale value.
+  def brightness
+    @g
+  end
+
+  attr_accessor :g
+  remove_method :g= ;
+  def g=(gg) #:nodoc:
+    gg = 1.0 if gg > 1
+    gg = 0.0 if gg < 0
+    @g = gg
+  end
+end
+
+module Color
+    # A synonym for Color::GrayScale.
+  GreyScale = GrayScale
+end