slippyd-colorist 0.0.4 → 0.0.5

data/.specification

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: slippyd-colorist
+version: !ruby/object:Gem::Version 
+  version: 0.0.4
+platform: ruby
+authors: 
+- Michael Bleigh
+- oleg dashevskii
+- Slippy Douglas
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-29 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+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.
+email: michael@intridea.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- MIT_LICENSE.rdoc
+- README.rdoc
+files: 
+- .gitignore
+- CHANGELOG.rdoc
+- MIT_LICENSE.rdoc
+- README.rdoc
+- Rakefile
+- VERSION
+- colorist.gemspec
+- lib/colorist.rb
+- lib/colorist/color.rb
+- lib/colorist/core_extensions.rb
+has_rdoc: false
+homepage: http://github.com/slippyd/colorist
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 4
+summary: A library built to handle the easy conversion and simple manipulation of colors.
+test_files: []
+

data/Rakefile

@@ -4,11 +4,11 @@ require 'rake'
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
-    gem.name = "colorist"
+    gem.name = "slippyd-colorist"
     gem.summary = %Q{A library built to handle the easy conversion and simple manipulation of colors.}
-    gem.email = "michael@intridea.com"
-    gem.homepage = "http://github.com/be9/colorist"
-    gem.authors = ["Michael Bleigh", "oleg dashevskii"]
+    gem.email = "slippyd-colorist@6bitt.com"
+    gem.homepage = "http://github.com/slippyd/colorist"
+    gem.authors = ["Michael Bleigh", "oleg dashevskii", "Slippy Douglas"]
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
     gem.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."
     gem.has_rdoc = true

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.5

data/lib/colorist/color.rb

@@ -3,8 +3,8 @@ module Colorist
   # 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
-
+    attr_accessor :r, :g, :b, :a
+    
     CSS_COLOR_NAMES = {  "maroon"  => 0x800000,
                          "red"     => 0xff0000,
                          "orange"  => 0xffa500,
@@ -22,19 +22,20 @@ module Colorist
                          "black"   => 0x000000,
                          "silver"  => 0xc0c0c0,
                          "gray"    => 0x808080  }
-
+    
     # Creates a new color with the hex color provided as a number (i.e. 0x112233)
-    def initialize(color=0x000000)
+    def initialize(color = 0x000000, alpha = 1.0)
       string = "%.6x" % color
       @r = string[0..1].hex
       @g = string[2..3].hex
       @b = string[4..5].hex
+      @a = alpha
     end
-
+    
     # Initialize a color based on RGB values. By default, the values
     # should be between 0 and 255. If you use the option <tt>:percent => true</tt>,
     # the values should then be between 0.0 and 1.0.
-    def self.from_rgb(r,g,b,options={})
+    def self.from_rgb(r, g, b, options = {})
       color = new
       # convert from 0.0 to 1.0 to 0 to 255 if the :percent option is used
       if options[:percent]
@@ -44,21 +45,27 @@ module Colorist
       end
       color
     end
-
+    
+    def self.from_rgba(r, g, b, a, options = {})
+      color = from_rgb(r, g, b, options)
+      color.a = a
+      color
+    end
+    
     # Initialize a colour based on HSV/HSB values. Hue should be between 0 and 360 (inclusive),
     # while saturation and value should be from 0.0 to 1.0.
     def self.from_hsv(hue, saturation, value)
       saturation = 1 if saturation > 1
       value = 1 if saturation > 1
-
+      
       # Conversion formula taken from wikipedia
-
+      
       f = (hue / 60.0) - (hue / 60).floor
-
+      
       p = value * (1 - saturation)
       q = value * (1 - (saturation * f))
       t = value * (1 - (saturation * (1 - f)))
-
+      
       r, g, b = case (hue / 60).floor % 6
                 when 0 then [ value, t, p ]
                 when 1 then [ q, value, p ]
@@ -67,10 +74,16 @@ module Colorist
                 when 4 then [ t, p, value ]
                 when 5 then [ value, p, q ]
                 end
-
+      
       from_rgb(r, g, b, :percent => true)
     end
-
+    
+    def self.from_hsva(hue, saturation, value, alpha)
+      color = from_hsv(hue, saturation, value)
+      color.a = alpha
+      color
+    end
+    
     # Converts a CSS hex string into a color. Works both with the
     # full form (i.e. <tt>#ffffff</tt>) and the abbreviated form (<tt>#fff</tt>). Can
     # also take any of the 16 named CSS colors.
@@ -89,7 +102,7 @@ module Colorist
       end
       color
     end
-
+    
     # Create a new color from the provided object. Duplicates Color objects
     # and attempts to call <tt>to_color</tt> on other objects. Will raise
     # an ArgumentError if it is unable to coerce the color.
@@ -102,14 +115,15 @@ module Colorist
           some_entity.to_color
       end
     end
-
+    
     # Create a duplicate of this color.
     def dup
-      self.class.from_rgb(@r,@g,@b)
+      self.class.from_rgba(@r, @g, @b, @a)
     end
-
-    # Add the individual RGB values of two colors together. You
-    # may also use an equivalent numeric or string color representation.
+    
+    # Add the individual RGB values of two colors together.
+    # You may also use an equivalent numeric or string color representation.
+    # The alpha value is kept from the original color (left-hand side).
     #
     # Examples:
     #
@@ -126,9 +140,10 @@ module Colorist
       color.b += other_color.b
       color
     end
-
+    
     # Subtract the individual RGB values of the two colors together.
     # You may also use an equivalent numeric or string color representation.
+    # The alpha value is kept from the original color (left-hand side).
     def -(other_color)
       other_color = self.class.from(other_color)
       color = self.dup
@@ -137,11 +152,12 @@ module Colorist
       color.b -= other_color.b
       color
     end
-
+    
     # Multiply the individual RGB values of two colors together or against a Float.
     # Colors divided in a way that is equivalent to each of the values being normalized to 0.0..1.0 prior to the operation
     #   and normalized back to 0.0..255.0 after the operation.
     # You may also use an equivalent numeric or string color representation.
+    # The alpha value is kept from the original color (left-hand side).
     def *(other)
       color = self.dup
       
@@ -158,11 +174,12 @@ module Colorist
       
       color
     end
-
+    
     # Divide the individual RGB values of the two colors together or against a Float.
     # Colors divided in a way that is equivalent to each of the values being normalized to 0.0..1.0 prior to the operation
     #   and normalized back to 0.0..255.0 after the operation.
     # You may also use an equivalent numeric or string color representation.
+    # The alpha value is kept from the original color (left-hand side).
     def /(other)
       color = self.dup
       
@@ -179,69 +196,77 @@ module Colorist
       
       color
     end
-
+    
     # Compares colors based on brightness.
     def <=>(other_color)
       other_color = self.class.from(other_color)
       brightness <=> other_color.brightness
     end
-
+    
     # Compares colors based on brightness.
     def < (other_color)
       other_color = self.class.from(other_color)
       brightness < other_color.brightness
     end
-
+    
     # Compares colors based on brightness.
     def > (other_color)
       other_color = self.class.from(other_color)
       brightness > other_color.brightness
     end
-
-    # Equal if the red, green, and blue values are identical.
+    
+    # Equal if the red, green, blue, and alpha values are identical.
     def ==(other_color)
       other_color = self.class.from(other_color)
-      other_color.r == self.r && other_color.g == self.g && other_color.b == self.b
+      other_color.r == self.r && other_color.g == self.g && other_color.b == self.b && other_color.a == self.a
     end
-
+    
     # Equal if the brightnesses of the two colors are identical.
     def ===(other_color)
       other_color = self.class.from(other_color)
       other_color.brightness == brightness
     end
-
+    
     def r=(value) #:nodoc:
       @r = value; normalize; end
     def g=(value) #:nodoc:
       @g = value; normalize; end
     def b=(value) #:nodoc:
       @b = value; normalize; end
-
+    def a=(value) #:nodoc:
+      @a = value; normalize; end
+    
     # Outputs a string representation of the color in the desired format.
     # The available formats are:
     #
     # * <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>:css_rgb</tt> - As a CSS RGB value string (i.e. <tt>rgb(255, 255, 255)</tt>)
+    # * <tt>:css_rgba</tt> - As a CSS RGBA value string (i.e. <tt>rgb(255, 255, 255, 1.0)</tt>)
     # * <tt>:rgb</tt> - As an RGB triplet (i.e. <tt>1.0, 1.0, 1.0</tt>)
+    # * <tt>:rgba</tt> - As an RGBA quadruplet (i.e. <tt>1.0, 1.0, 1.0, 1.0</tt>)
     def to_s(format=:css)
       case format
         when :css
           "#%.2x%.2x%.2x" % [r, g, b]
         when :css_rgb
-          "rgb(%.2f,%.2f,%.2f)" % [r, g, b]
+          "rgb(%d, %d, %d)" % [r, g, b]
+        when :css_rgba
+          "rgba(%d, %d, %d, %.3f)" % [r, g, b, a]
         when :rgb
           "%.3f, %.3f, %.3f" % [r / 255, g / 255, b / 255]
+        when :rgba
+          "%.3f, %.3f, %.3f, %.3f" % [r / 255, g / 255, b / 255, a / 255]
       end
     end
-
+    
     # Returns an array of the hue, saturation and value of the color.
     # Hue will range from 0-359, hue and saturation will be between 0 and 1.
-
+    
     def to_hsv
       red, green, blue = *[r, g, b].collect {|x| x / 255.0}
       max = [red, green, blue].max
       min = [red, green, blue].min
-
+      
       if min == max
         hue = 0
       elsif max == red
@@ -251,22 +276,22 @@ module Colorist
       elsif max == blue
         hue = 60 * ((red - green) / (max - min)) + 240
       end
-
+      
       saturation = (max == 0) ? 0 : (max - min) / max
       [hue % 360, saturation, max]
     end
-
+    
     def inspect
-      "#<Color #{to_s(:css)}>"
+      "#<Color #{to_s(:css_rgba)}>"
     end
-
+    
     # Returns the perceived brightness of the provided color on a
     # scale of 0.0 to 1.0 based on the formula provided. The formulas
     # available are:
     #
     # * <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)
+    def brightness(formula = :w3c)
       case formula
         when :standard
           Math.sqrt(0.241 * r**2 + 0.691 * g**2 + 0.068 * b**2) / 255
@@ -274,7 +299,7 @@ module Colorist
           ((r * 299 + g * 587 + b * 114) / 255000.0)
       end
     end
-
+    
     # Contrast this color with another color using the provided formula. The
     # available formulas are:
     #
@@ -288,14 +313,14 @@ module Colorist
           ([self.b, other_color.b].max - [self.b, other_color.b].min)) / 765.0
       end
     end
-
+    
     # Returns the opposite of the current color.
     def invert
-      self.class.from_rgb(255 - r, 255 - g, 255 - b)
+      self.class.from_rgba(255 - r, 255 - g, 255 - b, a)
     end
-
+    
     alias opposite invert
-
+    
     # Uses a naive formula to generate a gradient between this color and the given color.
     # Returns the array of colors that make the gradient, including this color and the
     # target color.  By default will return 10 colors, but this can be changed by supplying
@@ -305,69 +330,86 @@ module Colorist
       red = color_to.r - r
       green = color_to.g - g
       blue = color_to.b - b
-
+      
       result = (1..(steps - 3)).to_a.collect do |step|
         percentage = step.to_f / (steps - 1)
         self.class.from_rgb(r + (red * percentage), g + (green * percentage), b + (blue * percentage))
       end
-
+      
       # Add first and last colors to result, avoiding uneccessary calculation and rounding errors
-
+      
       result.unshift(self.dup)
       result.push(color.dup)
       result
     end
-
+    
     # Converts the current color to grayscale using the brightness
     # formula provided. See #brightness for a description of the
     # available formulas.
-    def to_grayscale(formula=:w3c)
+    def to_grayscale(formula = :w3c)
       b = brightness(formula)
       self.class.from_rgb(255 * b, 255 * b, 255 * b)
     end
-
+    
     # Returns an appropriate text color (either black or white) based on
     # the brightness of this color. The +threshold+ specifies the brightness
     # cutoff point.
-    def text_color(threshold=0.6, formula=:standard)
+    def text_color(threshold = 0.6, formula = :standard)
       brightness(formula) > threshold ? self.class.new(0x000000) : self.class.new(0xffffff)
     end
-
+    
     # Adjusts any of H, S, V values with relative values: +opts[:h]+, +opts[:s]+, +opts[:v]+
     # and returns adjusted value.
     def adjust(opts = {})
       unless [:h, :s, :v].any? { |part| opts.include? part }
         raise ArgumentError, "please specify at least one of :h, :s, or :v options"
       end
-
+      
       h, s, v = *self.to_hsv
-
-      h = _within(0, h + opts[:h], 359) if opts[:h]
-      s = _within(0, s + opts[:s], 1)   if opts[:s]
-      v = _within(0, v + opts[:v], 1)   if opts[:v]
-
+      
+      h = (h + opts[:h]) % 360 if opts[:h]
+      s = _clamp(s + opts[:s], 0..1)   if opts[:s]
+      v = _clamp(v + opts[:v], 0..1)   if opts[:v]
+      
       self.class.from_hsv(h, s, v)
     end
-
+    
+    # Adjusts any of R, G, B, or A values with aboslute values: opts[:a], opts[:r], opts[:b], opts[:a]
+    # and returns adjusted value.
+    def with(opts = {})
+      unless [:r, :g, :b, :a].any? { |part| opts.include? part }
+        raise ArgumentError, "please specify at least one of :r, :g, :b, or :a options"
+      end
+      
+      color = self.dup
+      
+      color.r = opts[:r] if opts[:r]
+      color.g = opts[:g] if opts[:g]
+      color.b = opts[:b] if opts[:b]
+      color.a = opts[:a] if opts[:a]
+      
+      color
+    end
+    
     protected
-
+    
     def normalize #:nodoc:
-      @r = 255 if @r > 255
-      @g = 255 if @g > 255
-      @b = 255 if @b > 255
-      @r = 0 if @r < 0
-      @g = 0 if @g < 0
-      @b = 0 if @b < 0
+      @r = _clamp(@r, (0..255)) unless (0..255).include? @r
+      @g = _clamp(@g, (0..255)) unless (0..255).include? @g
+      @b = _clamp(@b, (0..255)) unless (0..255).include? @b
+      @a = _clamp(@a, (0.0..1.0)) unless (0.0..1.0).include? @a
     end
-
-    def _within(min, value, max)
-      if value < min
-        min
-      elsif value > max
-        max
+    
+    def _clamp(value, range)
+      if value < range.first
+        range.first
+      elsif value > range.last
+        range.last
       else
         value
       end
     end
-  end
-end
+    
+  end # Color
+  
+end # Colorist

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: slippyd-colorist
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Michael Bleigh
@@ -11,12 +11,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-29 00:00:00 -07:00
+date: 2009-10-12 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
 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.
-email: michael@intridea.com
+email: slippyd-colorist@6bitt.com
 executables: []
 
 extensions: []
@@ -26,17 +26,19 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .gitignore
+- .specification
 - CHANGELOG.rdoc
 - MIT_LICENSE.rdoc
 - README.rdoc
 - Rakefile
 - VERSION
-- colorist.gemspec
 - lib/colorist.rb
 - lib/colorist/color.rb
 - lib/colorist/core_extensions.rb
-has_rdoc: false
+has_rdoc: true
 homepage: http://github.com/slippyd/colorist
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -58,9 +60,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: A library built to handle the easy conversion and simple manipulation of colors.
 test_files: []
 

data/colorist.gemspec

@@ -1,43 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = 'colorist'
-  s.version = '0.0.4'
-
-  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
-  s.authors = ["Michael Bleigh", "oleg dashevskii", "Slippy Douglas"]
-  s.date = '2009-06-29'
-  s.description = %q{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.}
-  s.email = %q<michael@intridea.com>
-  s.extra_rdoc_files = [
-    "MIT_LICENSE.rdoc",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".gitignore",
-    "CHANGELOG.rdoc",
-    "MIT_LICENSE.rdoc",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "colorist.gemspec",
-    "lib/colorist.rb",
-    "lib/colorist/color.rb",
-    "lib/colorist/core_extensions.rb"
-  ]
-  s.homepage = %q<http://github.com/slippyd/colorist>
-  s.rdoc_options = ["--main", "README.rdoc"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = '1.3.3'
-  s.summary = %q{A library built to handle the easy conversion and simple manipulation of colors.}
-  
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 4
-    
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
-end