Class: Sass::Script::Color

Inherits:
Literal show all
Extended by:
Util
Defined in:
lib/sass/script/color.rb

Overview

A SassScript object representing a CSS color.

A color may be represented internally as RGBA, HSLA, or both. It's originally represented as whatever its input is; if it's created with RGB values, it's represented as RGBA, and if it's created with HSL values, it's represented as HSLA. Once a property is accessed that requires the other representation -- for example, #red for an HSL color -- that component is calculated and cached.

The alpha channel of a color is independent of its RGB or HSL representation. It's always stored, as 1 if nothing else is specified. If only the alpha channel is modified using #with, the cached RGB and HSL values are retained.

Constant Summary collapse

COLOR_NAMES =

A hash from color names to [red, green, blue] value arrays.

map_vals({
  'aliceblue' => 0xf0f8ff,
  'antiquewhite' => 0xfaebd7,
  'aqua' => 0x00ffff,
  'aquamarine' => 0x7fffd4,
  'azure' => 0xf0ffff,
  'beige' => 0xf5f5dc,
  'bisque' => 0xffe4c4,
  'black' => 0x000000,
  'blanchedalmond' => 0xffebcd,
  'blue' => 0x0000ff,
  'blueviolet' => 0x8a2be2,
  'brown' => 0xa52a2a,
  'burlywood' => 0xdeb887,
  'cadetblue' => 0x5f9ea0,
  'chartreuse' => 0x7fff00,
  'chocolate' => 0xd2691e,
  'coral' => 0xff7f50,
  'cornflowerblue' => 0x6495ed,
  'cornsilk' => 0xfff8dc,
  'crimson' => 0xdc143c,
  'cyan' => 0x00ffff,
  'darkblue' => 0x00008b,
  'darkcyan' => 0x008b8b,
  'darkgoldenrod' => 0xb8860b,
  'darkgray' => 0xa9a9a9,
  'darkgrey' => 0xa9a9a9,
  'darkgreen' => 0x006400,
  'darkkhaki' => 0xbdb76b,
  'darkmagenta' => 0x8b008b,
  'darkolivegreen' => 0x556b2f,
  'darkorange' => 0xff8c00,
  'darkorchid' => 0x9932cc,
  'darkred' => 0x8b0000,
  'darksalmon' => 0xe9967a,
  'darkseagreen' => 0x8fbc8f,
  'darkslateblue' => 0x483d8b,
  'darkslategray' => 0x2f4f4f,
  'darkslategrey' => 0x2f4f4f,
  'darkturquoise' => 0x00ced1,
  'darkviolet' => 0x9400d3,
  'deeppink' => 0xff1493,
  'deepskyblue' => 0x00bfff,
  'dimgray' => 0x696969,
  'dimgrey' => 0x696969,
  'dodgerblue' => 0x1e90ff,
  'firebrick' => 0xb22222,
  'floralwhite' => 0xfffaf0,
  'forestgreen' => 0x228b22,
  'fuchsia' => 0xff00ff,
  'gainsboro' => 0xdcdcdc,
  'ghostwhite' => 0xf8f8ff,
  'gold' => 0xffd700,
  'goldenrod' => 0xdaa520,
  'gray' => 0x808080,
  'green' => 0x008000,
  'greenyellow' => 0xadff2f,
  'honeydew' => 0xf0fff0,
  'hotpink' => 0xff69b4,
  'indianred' => 0xcd5c5c,
  'indigo' => 0x4b0082,
  'ivory' => 0xfffff0,
  'khaki' => 0xf0e68c,
  'lavender' => 0xe6e6fa,
  'lavenderblush' => 0xfff0f5,
  'lawngreen' => 0x7cfc00,
  'lemonchiffon' => 0xfffacd,
  'lightblue' => 0xadd8e6,
  'lightcoral' => 0xf08080,
  'lightcyan' => 0xe0ffff,
  'lightgoldenrodyellow' => 0xfafad2,
  'lightgreen' => 0x90ee90,
  'lightgray' => 0xd3d3d3,
  'lightgrey' => 0xd3d3d3,
  'lightpink' => 0xffb6c1,
  'lightsalmon' => 0xffa07a,
  'lightseagreen' => 0x20b2aa,
  'lightskyblue' => 0x87cefa,
  'lightslategray' => 0x778899,
  'lightslategrey' => 0x778899,
  'lightsteelblue' => 0xb0c4de,
  'lightyellow' => 0xffffe0,
  'lime' => 0x00ff00,
  'limegreen' => 0x32cd32,
  'linen' => 0xfaf0e6,
  'magenta' => 0xff00ff,
  'maroon' => 0x800000,
  'mediumaquamarine' => 0x66cdaa,
  'mediumblue' => 0x0000cd,
  'mediumorchid' => 0xba55d3,
  'mediumpurple' => 0x9370db,
  'mediumseagreen' => 0x3cb371,
  'mediumslateblue' => 0x7b68ee,
  'mediumspringgreen' => 0x00fa9a,
  'mediumturquoise' => 0x48d1cc,
  'mediumvioletred' => 0xc71585,
  'midnightblue' => 0x191970,
  'mintcream' => 0xf5fffa,
  'mistyrose' => 0xffe4e1,
  'moccasin' => 0xffe4b5,
  'navajowhite' => 0xffdead,
  'navy' => 0x000080,
  'oldlace' => 0xfdf5e6,
  'olive' => 0x808000,
  'olivedrab' => 0x6b8e23,
  'orange' => 0xffa500,
  'orangered' => 0xff4500,
  'orchid' => 0xda70d6,
  'palegoldenrod' => 0xeee8aa,
  'palegreen' => 0x98fb98,
  'paleturquoise' => 0xafeeee,
  'palevioletred' => 0xdb7093,
  'papayawhip' => 0xffefd5,
  'peachpuff' => 0xffdab9,
  'peru' => 0xcd853f,
  'pink' => 0xffc0cb,
  'plum' => 0xdda0dd,
  'powderblue' => 0xb0e0e6,
  'purple' => 0x800080,
  'red' => 0xff0000,
  'rosybrown' => 0xbc8f8f,
  'royalblue' => 0x4169e1,
  'saddlebrown' => 0x8b4513,
  'salmon' => 0xfa8072,
  'sandybrown' => 0xf4a460,
  'seagreen' => 0x2e8b57,
  'seashell' => 0xfff5ee,
  'sienna' => 0xa0522d,
  'silver' => 0xc0c0c0,
  'skyblue' => 0x87ceeb,
  'slateblue' => 0x6a5acd,
  'slategray' => 0x708090,
  'slategrey' => 0x708090,
  'snow' => 0xfffafa,
  'springgreen' => 0x00ff7f,
  'steelblue' => 0x4682b4,
  'tan' => 0xd2b48c,
  'teal' => 0x008080,
  'thistle' => 0xd8bfd8,
  'tomato' => 0xff6347,
  'turquoise' => 0x40e0d0,
  'violet' => 0xee82ee,
  'wheat' => 0xf5deb3,
  'white' => 0xffffff,
  'whitesmoke' => 0xf5f5f5,
  'yellow' => 0xffff00,
  'yellowgreen' => 0x9acd32
}) {|color| (0..2).map {|n| color >> (n << 3) & 0xff}.reverse}
COLOR_NAMES_REVERSE =

A hash from [red, green, blue] value arrays to color names.

map_hash(hash_to_a(COLOR_NAMES)) {|k, v| [v, k]}

Constants included from Util

Util::CHARSET_REGEXPS, Util::ENCODINGS_TO_CHECK, Util::RUBY_ENGINE, Util::RUBY_VERSION

Instance Attribute Summary

Attributes inherited from Literal

#value

Attributes inherited from Node

#line, #options

Instance Method Summary collapse

Methods included from Util

abstract, ap_geq?, ap_geq_3?, av_template_class, caller_info, check_encoding, check_range, check_sass_encoding, destructure, enum_cons, enum_slice, enum_with_index, extract!, extract_values, flatten, glob, group_by_to_a, has?, hash_to_a, inject_values, inspect_obj, intersperse, ironruby?, lcs, macruby?, map_hash, map_keys, map_vals, merge_adjacent_strings, ord, paths, powerset, rails_env, rails_root, restrict, ruby1_8?, ruby1_8_6?, sass_warn, scope, set_eql?, set_hash, silence_sass_warnings, silence_warnings, strip_string_array, subsequence?, substitute, to_hash, version_geq, version_gt, windows?, with_extracted_values

Methods inherited from Literal

#==, #_perform, #assert_int!, #children, #comma, #deep_copy, #neq, #null?, #options, #single_eq, #space, #to_a, #to_bool, #to_i, #unary_div, #unary_minus, #unary_not, #unary_plus

Methods inherited from Node

#_perform, #children, #dasherize, #deep_copy, #opts, #perform

Constructor Details

#initialize(attrs) ⇒ Color #initialize(rgba) ⇒ Color

Constructs an RGB or HSL color object, optionally with an alpha channel.

The RGB values must be between 0 and 255. The saturation and lightness values must be between 0 and 100. The alpha value must be between 0 and 1.

Overloads:

  • #initialize(attrs) ⇒ Color

    The attributes are specified as a hash. This hash must contain either :hue, :saturation, and :value keys, or :red, :green, and :blue keys. It cannot contain both HSL and RGB keys. It may also optionally contain an :alpha key.

    Parameters:

    • attrs ({Symbol => Numeric}) —

      A hash of color attributes to values

    Raises:

    • (ArgumentError) —

      if not enough attributes are specified, or both RGB and HSL attributes are specified

  • #initialize(rgba) ⇒ Color

    The attributes are specified as an array. This overload only supports RGB or RGBA colors.

    Parameters:

    • rgba (Array<Numeric>) —

      A three- or four-element array of the red, green, blue, and optionally alpha values (respectively) of the color

    Raises:

    • (ArgumentError) —

      if not enough attributes are specified

Raises:



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/sass/script/color.rb', line 202

def initialize(attrs, allow_both_rgb_and_hsl = false)
  super(nil)

  if attrs.is_a?(Array)
    unless (3..4).include?(attrs.size)
      raise ArgumentError.new("Color.new(array) expects a three- or four-element array")
    end

    red, green, blue = attrs[0...3].map {|c| c.to_i}
    @attrs = {:red => red, :green => green, :blue => blue}
    @attrs[:alpha] = attrs[3] ? attrs[3].to_f : 1
  else
    attrs = attrs.reject {|k, v| v.nil?}
    hsl = [:hue, :saturation, :lightness] & attrs.keys
    rgb = [:red, :green, :blue] & attrs.keys
    if !allow_both_rgb_and_hsl && !hsl.empty? && !rgb.empty?
      raise ArgumentError.new("Color.new(hash) may not have both HSL and RGB keys specified")
    elsif hsl.empty? && rgb.empty?
      raise ArgumentError.new("Color.new(hash) must have either HSL or RGB keys specified")
    elsif !hsl.empty? && hsl.size != 3
      raise ArgumentError.new("Color.new(hash) must have all three HSL values specified")
    elsif !rgb.empty? && rgb.size != 3
      raise ArgumentError.new("Color.new(hash) must have all three RGB values specified")
    end

    @attrs = attrs
    @attrs[:hue] %= 360 if @attrs[:hue]
    @attrs[:alpha] ||= 1
  end

  [:red, :green, :blue].each do |k|
    next if @attrs[k].nil?
    @attrs[k] = @attrs[k].to_i
    Sass::Util.check_range("#{k.to_s.capitalize} value", 0..255, @attrs[k])
  end

  [:saturation, :lightness].each do |k|
    next if @attrs[k].nil?
    value = Number.new(@attrs[k], ['%']) # Get correct unit for error messages
    @attrs[k] = Sass::Util.check_range("#{k.to_s.capitalize}", 0..100, value, '%')
  end

  @attrs[:alpha] = Sass::Util.check_range("Alpha channel", 0..1, @attrs[:alpha])
end

Instance Method Details

#alpha ⇒ Fixnum

The alpha channel (opacity) of the color. This is 1 unless otherwise defined.

Returns:

  • (Fixnum) 


299
300
301
 
# File 'lib/sass/script/color.rb', line 299

def alpha
  @attrs[:alpha]
end

#alpha? ⇒ Boolean

Returns whether this color object is translucent; that is, whether the alpha channel is non-1.

Returns:

  • (Boolean) 


307
308
309
 
# File 'lib/sass/script/color.rb', line 307

def alpha?
  alpha < 1
end

#blue ⇒ Fixnum

The blue component of the color.

Returns:

  • (Fixnum) 


266
267
268
269
 
# File 'lib/sass/script/color.rb', line 266

def blue
  hsl_to_rgb!
  @attrs[:blue]
end

#div(other) ⇒ Color

The SassScript / operation. Its functionality depends on the type of its argument:

Number : Divides each of the RGB color channels by the number.

Sass::Script::Color : Divides each of this color's RGB color channels by the other color's.

Literal : See Literal#div.

Parameters:

  • other (Literal) —

    The right-hand side of the operator

Returns:

  • (Color) —

    The resulting color

Raises:



461
462
463
464
465
466
467
 
# File 'lib/sass/script/color.rb', line 461

def div(other)
  if other.is_a?(Sass::Script::Number) || other.is_a?(Sass::Script::Color)
    piecewise(other, :/)
  else
    super
  end
end

#eq(other) ⇒ Bool

The SassScript == operation. Note that this returns a Bool object, not a Ruby boolean.

Parameters:

  • other (Literal) —

    The right-hand side of the operator

Returns:

  • (Bool) —

    True if this literal is the same as the other, false otherwise



334
335
336
337
 
# File 'lib/sass/script/color.rb', line 334

def eq(other)
  Sass::Script::Bool.new(
    other.is_a?(Color) && rgb == other.rgb && alpha == other.alpha)
end

#green ⇒ Fixnum

The green component of the color.

Returns:

  • (Fixnum) 


258
259
260
261
 
# File 'lib/sass/script/color.rb', line 258

def green
  hsl_to_rgb!
  @attrs[:green]
end

#hsl ⇒ Array<Fixnum>

Returns the hue, saturation, and lightness components of the color.

Returns:

  • (Array<Fixnum>) —

    A frozen three-element array of the hue, saturation, and lightness values (respectively) of the color



323
324
325
 
# File 'lib/sass/script/color.rb', line 323

def hsl
  [hue, saturation, lightness].freeze
end

#hue ⇒ Numeric

The hue component of the color.

Returns:

  • (Numeric) 


274
275
276
277
 
# File 'lib/sass/script/color.rb', line 274

def hue
  rgb_to_hsl!
  @attrs[:hue]
end

#inspect ⇒ String

Returns a string representation of the color.

Returns:



505
506
507
 
# File 'lib/sass/script/color.rb', line 505

def inspect
  alpha? ? rgba_str : hex_str
end

#lightness ⇒ Numeric

The lightness component of the color.

Returns:

  • (Numeric) 


290
291
292
293
 
# File 'lib/sass/script/color.rb', line 290

def lightness
  rgb_to_hsl!
  @attrs[:lightness]
end

#minus(other) ⇒ Color

The SassScript - operation. Its functionality depends on the type of its argument:

Number : Subtracts the number from each of the RGB color channels.

Sass::Script::Color : Subtracts each of the other color's RGB color channels from this color's.

Literal : See Literal#minus.

Parameters:

  • other (Literal) —

    The right-hand side of the operator

Returns:

  • (Color) —

    The resulting color

Raises:



418
419
420
421
422
423
424
 
# File 'lib/sass/script/color.rb', line 418

def minus(other)
  if other.is_a?(Sass::Script::Number) || other.is_a?(Sass::Script::Color)
    piecewise(other, :-)
  else
    super
  end
end

#mod(other) ⇒ Color

The SassScript % operation. Its functionality depends on the type of its argument:

Number : Takes each of the RGB color channels module the number.

Sass::Script::Color : Takes each of this color's RGB color channels modulo the other color's.

Parameters:

  • other (Number, Color) —

    The right-hand side of the operator

Returns:

  • (Color) —

    The resulting color

Raises:



481
482
483
484
485
486
487
 
# File 'lib/sass/script/color.rb', line 481

def mod(other)
  if other.is_a?(Sass::Script::Number) || other.is_a?(Sass::Script::Color)
    piecewise(other, :%)
  else
    raise NoMethodError.new(nil, :mod)
  end
end

#plus(other) ⇒ Color

The SassScript + operation. Its functionality depends on the type of its argument:

Number : Adds the number to each of the RGB color channels.

Sass::Script::Color : Adds each of the RGB color channels together.

Literal : See Literal#plus.

Parameters:

  • other (Literal) —

    The right-hand side of the operator

Returns:

  • (Color) —

    The resulting color

Raises:



395
396
397
398
399
400
401
 
# File 'lib/sass/script/color.rb', line 395

def plus(other)
  if other.is_a?(Sass::Script::Number) || other.is_a?(Sass::Script::Color)
    piecewise(other, :+)
  else
    super
  end
end

#red ⇒ Fixnum

The red component of the color.

Returns:

  • (Fixnum) 


250
251
252
253
 
# File 'lib/sass/script/color.rb', line 250

def red
  hsl_to_rgb!
  @attrs[:red]
end

#rgb ⇒ Array<Fixnum>

Returns the red, green, and blue components of the color.

Returns:

  • (Array<Fixnum>) —

    A frozen three-element array of the red, green, and blue values (respectively) of the color



315
316
317
 
# File 'lib/sass/script/color.rb', line 315

def rgb
  [red, green, blue].freeze
end

#saturation ⇒ Numeric

The saturation component of the color.

Returns:

  • (Numeric) 


282
283
284
285
 
# File 'lib/sass/script/color.rb', line 282

def saturation
  rgb_to_hsl!
  @attrs[:saturation]
end

#times(other) ⇒ Color

The SassScript * operation. Its functionality depends on the type of its argument:

Number : Multiplies the number by each of the RGB color channels.

Sass::Script::Color : Multiplies each of the RGB color channels together.

Parameters:

  • other (Number, Color) —

    The right-hand side of the operator

Returns:

  • (Color) —

    The resulting color

Raises:



438
439
440
441
442
443
444
 
# File 'lib/sass/script/color.rb', line 438

def times(other)
  if other.is_a?(Sass::Script::Number) || other.is_a?(Sass::Script::Color)
    piecewise(other, :*)
  else
    raise NoMethodError.new(nil, :times)
  end
end

#to_s(opts = {}) ⇒ String Also known as: to_sass

Returns a string representation of the color. This is usually the color's hex value, but if the color has a name that's used instead.

Returns:

  • (String) —

    The string representation



494
495
496
497
498
499
 
# File 'lib/sass/script/color.rb', line 494

def to_s(opts = {})
  return rgba_str if alpha?
  return smallest if options[:style] == :compressed
  return COLOR_NAMES_REVERSE[rgb] if COLOR_NAMES_REVERSE[rgb]
  hex_str
end

#with(attrs) ⇒ Color

Returns a copy of this color with one or more channels changed. RGB or HSL colors may be changed, but not both at once.

For example:

Color.new([10, 20, 30]).with(:blue => 40)
  #=> rgb(10, 40, 30)
Color.new([126, 126, 126]).with(:red => 0, :green => 255)
  #=> rgb(0, 255, 126)
Color.new([255, 0, 127]).with(:saturation => 60)
  #=> rgb(204, 51, 127)
Color.new([1, 2, 3]).with(:alpha => 0.4)
  #=> rgba(1, 2, 3, 0.4)

Parameters:

  • attrs ({Symbol => Numeric}) —

    A map of channel names (:red, :green, :blue, :hue, :saturation, :lightness, or :alpha) to values

Returns:

  • (Color) —

    The new Color object

Raises:

  • (ArgumentError) —

    if both RGB and HSL keys are specified



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/sass/script/color.rb', line 358

def with(attrs)
  attrs = attrs.reject {|k, v| v.nil?}
  hsl = !([:hue, :saturation, :lightness] & attrs.keys).empty?
  rgb = !([:red, :green, :blue] & attrs.keys).empty?
  if hsl && rgb
    raise ArgumentError.new("Cannot specify HSL and RGB values for a color at the same time")
  end

  if hsl
    [:hue, :saturation, :lightness].each {|k| attrs[k] ||= send(k)}
  elsif rgb
    [:red, :green, :blue].each {|k| attrs[k] ||= send(k)}
  else
    # If we're just changing the alpha channel,
    # keep all the HSL/RGB stuff we've calculated
    attrs = @attrs.merge(attrs)
  end
  attrs[:alpha] ||= alpha

  Color.new(attrs, :allow_both_rgb_and_hsl)
end