Class: Sass::Script::Color
- Extended by:
- Haml::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
Constants included from Haml::Util
Instance Attribute Summary
Attributes inherited from Node
Instance Method Summary collapse
-
#alpha ⇒ Fixnum
The alpha channel (opacity) of the color.
-
#alpha? ⇒ Boolean
Returns whether this color object is translucent; that is, whether the alpha channel is non-1.
-
#blue ⇒ Fixnum
The blue component of the color.
-
#div(other) ⇒ Color
The SassScript
/
operation. -
#eq(other) ⇒ Bool
The SassScript
==
operation. -
#green ⇒ Fixnum
The green component of the color.
-
#hsl ⇒ Array<Fixnum>
Returns the hue, saturation, and lightness components of the color.
-
#hue ⇒ Numeric
The hue component of the color.
-
#initialize(attrs, allow_both_rgb_and_hsl = false) ⇒ Color
constructor
Constructs an RGB or HSL color object, optionally with an alpha channel.
-
#lightness ⇒ Numeric
The lightness component of the color.
-
#minus(other) ⇒ Color
The SassScript
-
operation. -
#mod(other) ⇒ Color
The SassScript
%
operation. -
#plus(other) ⇒ Color
The SassScript
+
operation. -
#red ⇒ Fixnum
The red component of the color.
-
#rgb ⇒ Array<Fixnum>
Returns the red, green, and blue components of the color.
-
#saturation ⇒ Numeric
The saturation component of the color.
-
#times(other) ⇒ Color
The SassScript
*
operation. -
#to_s ⇒ String
(also: #inspect)
Returns a string representation of the color.
-
#value
deprecated
Deprecated.
This will be removed in version 3.2.
-
#with(attrs) ⇒ Color
Returns a copy of this color with one or more channels changed.
Methods included from Haml::Util
ap_geq_3?, assert_html_safe!, av_template_class, caller_info, check_encoding, def_static_method, enum_with_index, has?, html_safe, map_hash, map_keys, map_vals, merge_adjacent_strings, ord, powerset, rails_env, rails_root, rails_safe_buffer_class, rails_xss_safe?, restrict, ruby1_8?, scope, silence_warnings, static_method_name, to_hash
Methods inherited from Literal
#==, #and, #assert_int!, #children, #comma, #concat, #neq, #options, #or, #perform, #to_bool, #to_i, #unary_div, #unary_minus, #unary_not
Methods inherited from Node
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.
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/sass/script/color.rb', line 73
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
next if (0..255).include?(@attrs[k])
raise Sass::SyntaxError.new("#{k.to_s.capitalize} value must be between 0 and 255")
end
[:saturation, :lightness].each do |k|
next if @attrs[k].nil? || (0..100).include?(@attrs[k])
raise Sass::SyntaxError.new("#{k.to_s.capitalize} must be between 0 and 100")
end
unless (0..1).include?(@attrs[:alpha])
raise Sass::SyntaxError.new("Alpha channel must between 0 and 1")
end
end
|
Instance Method Details
#alpha ⇒ Fixnum
The alpha channel (opacity) of the color. This is 1 unless otherwise defined.
172 173 174 |
# File 'lib/sass/script/color.rb', line 172
def alpha
@attrs[:alpha]
end
|
#alpha? ⇒ Boolean
Returns whether this color object is translucent; that is, whether the alpha channel is non-1.
180 181 182 |
# File 'lib/sass/script/color.rb', line 180
def alpha?
alpha < 1
end
|
#blue ⇒ Fixnum
The blue component of the color.
139 140 141 142 |
# File 'lib/sass/script/color.rb', line 139
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.
345 346 347 348 349 350 351 |
# File 'lib/sass/script/color.rb', line 345
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.
218 219 220 221 |
# File 'lib/sass/script/color.rb', line 218
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.
131 132 133 134 |
# File 'lib/sass/script/color.rb', line 131
def green
hsl_to_rgb!
@attrs[:green]
end
|
#hsl ⇒ Array<Fixnum>
Returns the hue, saturation, and lightness components of the color.
207 208 209 |
# File 'lib/sass/script/color.rb', line 207
def hsl
[hue, saturation, lightness].freeze
end
|
#hue ⇒ Numeric
The hue component of the color.
147 148 149 150 |
# File 'lib/sass/script/color.rb', line 147
def hue
rgb_to_hsl!
@attrs[:hue]
end
|
#lightness ⇒ Numeric
The lightness component of the color.
163 164 165 166 |
# File 'lib/sass/script/color.rb', line 163
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.
302 303 304 305 306 307 308 |
# File 'lib/sass/script/color.rb', line 302
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.
365 366 367 368 369 370 371 |
# File 'lib/sass/script/color.rb', line 365
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.
279 280 281 282 283 284 285 |
# File 'lib/sass/script/color.rb', line 279
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.
123 124 125 126 |
# File 'lib/sass/script/color.rb', line 123
def red
hsl_to_rgb!
@attrs[:red]
end
|
#rgb ⇒ Array<Fixnum>
Returns the red, green, and blue components of the color.
199 200 201 |
# File 'lib/sass/script/color.rb', line 199
def rgb
[red, green, blue].freeze
end
|
#saturation ⇒ Numeric
The saturation component of the color.
155 156 157 158 |
# File 'lib/sass/script/color.rb', line 155
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.
322 323 324 325 326 327 328 |
# File 'lib/sass/script/color.rb', line 322
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 ⇒ String Also known as: inspect
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.
378 379 380 381 382 383 |
# File 'lib/sass/script/color.rb', line 378
def to_s
return rgba_str if alpha?
return smallest if options[:style] == :compressed
return HTML4_COLORS_REVERSE[rgb] if HTML4_COLORS_REVERSE[rgb]
hex_str
end
|
#value
This will be removed in version 3.2.
186 187 188 189 190 191 192 193 |
# File 'lib/sass/script/color.rb', line 186
def value
warn <<END
DEPRECATION WARNING:
The Sass::Script::Color #value attribute is deprecated and will be
removed in version 3.2. Use the #rgb attribute instead.
END
rgb
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)
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 |
# File 'lib/sass/script/color.rb', line 242
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("Color#with may not have both HSL and RGB keys specified")
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
|