@@ -2,7 +2,8 @@ Colorist is a library built to handle the conversion, comparison, and manipulation of colors in Ruby projects with an emphasis on W3C standards -and CSS-style hex notation. +and CSS-style hex notation. See the Color class for additional details +on the available methods. == Example @@ -17,5 +18,10 @@ and CSS-style hex notation. gray.brightness # => 0.2 gray.contrast_with("#f00") + +== Resources + +* GitHub Source: http://github.com/mbleigh/colorist +* Lighthouse (for bugs): http://mbleigh.lighthouseapp.com/projects/15686-colorist Copyright (c) 2008 Michael Bleigh and Intridea, Inc. Released under the MIT open source license. \ No newline at end of file README.rdoc @@ -2,7 +2,7 @@ Gem::Specification.new do |s| s.name = "colorist" s.version = "0.0.1" s.date = "2008-08-16" - s.summary = "A library built to handle the easy conversion and manipulation of colors." + s.summary = "A library built to handle the easy conversion and simple manipulation of colors." s.email = "michael@intridea.com" s.homepage = "http://github.com/mbleigh/colorist" s.description = "Colorist is a library built to handle the easy conversion and manipulation of colors with a special emphasis on W3C standards and CSS-style hex color notation." colorist.gemspec @@ -1,4 +1,7 @@ module Colorist + # Color is the general class for storing and manipulating a color with the + # Colorist gem. It provides methods to add, subtract, and calculate aspects + # of the color based on W3C and other standards. class Color attr_accessor :r, :g, :b @@ -148,9 +151,9 @@ module Colorist # Outputs a string representation of the color in the desired format. # The available formats are: # - # * +:css+ - As a CSS hex string (i.e. <tt>#ffffff</tt>) (default) - # * +:css_rgb+ - As a CSS RGB value string (i.e. <tt>rgb(255,255,255)</tt>) - # * +:rgb+ - As an RGB triplet (i.e. <tt>1.0, 1.0, 1.0</tt>) + # * <tt>:css</tt> - As a CSS hex string (i.e. <tt>#ffffff</tt>) (default) + # * <tt>:css_rgb</tt> - As a CSS RGB value string (i.e. <tt>rgb(255,255,255)</tt>) + # * <tt>:rgb</tt> - As an RGB triplet (i.e. <tt>1.0, 1.0, 1.0</tt>) def to_s(format=:css) case format when :css @@ -170,8 +173,8 @@ module Colorist # scale of 0.0 to 1.0 based on the formula provided. The formulas # available are: # - # * +:w3c+ - <tt>((r * 299 + g * 587 + b * 114) / 1000 / 255</tt> - # * +:standard+ - <tt>sqrt(0.241 * r^2 + 0.691 * g^2 + 0.068 * b^2) / 255</tt> + # * <tt>:w3c</tt> - <tt>((r * 299 + g * 587 + b * 114) / 1000 / 255</tt> + # * <tt>:standard</tt> - <tt>sqrt(0.241 * r^2 + 0.691 * g^2 + 0.068 * b^2) / 255</tt> def brightness(formula=:w3c) case formula when :standard @@ -184,7 +187,7 @@ module Colorist # Contrast this color with another color using the provided formula. The # available formulas are: # - # * +:w3c+ - <tt>(max(r1 r2) - min(r1 r2)) + (max(g1 g2) - min(g1 g2)) + (max(b1 b2) - min(b1 b2))</tt> + # * <tt>:w3c</tt> - <tt>(max(r1 r2) - min(r1 r2)) + (max(g1 g2) - min(g1 g2)) + (max(b1 b2) - min(b1 b2))</tt> def contrast_with(other_color, formula=:w3c) other_color = Color.from(other_color) case formula lib/colorist/color.rb @@ -18,8 +18,8 @@ end class String # Converts a CSS-style color string to a Color. Can be - # in the full form (<tt>#112233</tt>), the abbreviated form - # (<tt>#123</tt>) or a CSS named color (<tt>"black"</tt> or <tt>"maroon"</tt>). + # in the full form (<tt>\#112233</tt>), the abbreviated form + # (<tt>\#123</tt>) or a CSS named color (<tt>"black"</tt> or <tt>"maroon"</tt>). def to_color Colorist::Color.from_string(self) end lib/colorist/core_extensions.rb 4584a026b2a0abc6a3d7227aa52b00a987e973ff Michael Bleigh michael@intridea.com http://github.com/mbleigh/colorist/commit/3df7f4fa2e86a756371b9ca7367494085aa16822 3df7f4fa2e86a756371b9ca7367494085aa16822 2008-08-18T07:25:00-07:00 2008-08-18T07:25:00-07:00 Doc and gemspec changes. 749ee421cc2c4c7571a60a72e0ecba8c1dc9dcc1 Michael Bleigh michael@intridea.com