sass 3.1.0 → 3.3.0

data/lib/sass/script/{color.rb → value/color.rb}

@@ -1,6 +1,4 @@
-require 'sass/script/literal'
-
-module Sass::Script
+module Sass::Script::Value
   # A SassScript object representing a CSS color.
   #
   # A color may be represented internally as RGBA, HSLA, or both.
@@ -15,34 +13,183 @@ module Sass::Script
   # 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.
-  class Color < Literal
-    class << self; include Sass::Util; end
+  class Color < Base
+    # @private
+    #
+    # Convert a ruby integer to a rgba components
+    # @param color [Fixnum]
+    # @return [Array<Fixnum>] Array of 4 numbers representing r,g,b and alpha
+    def self.int_to_rgba(color)
+      rgba = (0..3).map {|n| color >> (n << 3) & 0xff}.reverse
+      rgba[-1] = rgba[-1] / 255.0
+      rgba
+    end
+
+    ALTERNATE_COLOR_NAMES = Sass::Util.map_vals({
+        'aqua'                 => 0x00FFFFFF,
+        'darkgrey'             => 0xA9A9A9FF,
+        'darkslategrey'        => 0x2F4F4FFF,
+        'dimgrey'              => 0x696969FF,
+        'fuchsia'              => 0xFF00FFFF,
+        'grey'                 => 0x808080FF,
+        'lightgrey'            => 0xD3D3D3FF,
+        'lightslategrey'       => 0x778899FF,
+        'slategrey'            => 0x708090FF,
+    }, &method(:int_to_rgba))
 
     # A hash from color names to `[red, green, blue]` value arrays.
-    HTML4_COLORS = map_vals({
-        'black'   => 0x000000,
-        'silver'  => 0xc0c0c0,
-        'gray'    => 0x808080,
-        'white'   => 0xffffff,
-        'maroon'  => 0x800000,
-        'red'     => 0xff0000,
-        'purple'  => 0x800080,
-        'fuchsia' => 0xff00ff,
-        'green'   => 0x008000,
-        'lime'    => 0x00ff00,
-        'olive'   => 0x808000,
-        'yellow'  => 0xffff00,
-        'navy'    => 0x000080,
-        'blue'    => 0x0000ff,
-        'teal'    => 0x008080,
-        'aqua'    => 0x00ffff
-      }) {|color| (0..2).map {|n| color >> (n << 3) & 0xff}.reverse}
-    # A hash from `[red, green, blue]` value arrays to color names.
-    HTML4_COLORS_REVERSE = map_hash(HTML4_COLORS) {|k, v| [v, k]}
+    COLOR_NAMES = Sass::Util.map_vals({
+        'aliceblue'            => 0xF0F8FFFF,
+        'antiquewhite'         => 0xFAEBD7FF,
+        'aquamarine'           => 0x7FFFD4FF,
+        'azure'                => 0xF0FFFFFF,
+        'beige'                => 0xF5F5DCFF,
+        'bisque'               => 0xFFE4C4FF,
+        'black'                => 0x000000FF,
+        'blanchedalmond'       => 0xFFEBCDFF,
+        'blue'                 => 0x0000FFFF,
+        'blueviolet'           => 0x8A2BE2FF,
+        'brown'                => 0xA52A2AFF,
+        'burlywood'            => 0xDEB887FF,
+        'cadetblue'            => 0x5F9EA0FF,
+        'chartreuse'           => 0x7FFF00FF,
+        'chocolate'            => 0xD2691EFF,
+        'coral'                => 0xFF7F50FF,
+        'cornflowerblue'       => 0x6495EDFF,
+        'cornsilk'             => 0xFFF8DCFF,
+        'crimson'              => 0xDC143CFF,
+        'cyan'                 => 0x00FFFFFF,
+        'darkblue'             => 0x00008BFF,
+        'darkcyan'             => 0x008B8BFF,
+        'darkgoldenrod'        => 0xB8860BFF,
+        'darkgray'             => 0xA9A9A9FF,
+        'darkgreen'            => 0x006400FF,
+        'darkkhaki'            => 0xBDB76BFF,
+        'darkmagenta'          => 0x8B008BFF,
+        'darkolivegreen'       => 0x556B2FFF,
+        'darkorange'           => 0xFF8C00FF,
+        'darkorchid'           => 0x9932CCFF,
+        'darkred'              => 0x8B0000FF,
+        'darksalmon'           => 0xE9967AFF,
+        'darkseagreen'         => 0x8FBC8FFF,
+        'darkslateblue'        => 0x483D8BFF,
+        'darkslategray'        => 0x2F4F4FFF,
+        'darkturquoise'        => 0x00CED1FF,
+        'darkviolet'           => 0x9400D3FF,
+        'deeppink'             => 0xFF1493FF,
+        'deepskyblue'          => 0x00BFFFFF,
+        'dimgray'              => 0x696969FF,
+        'dodgerblue'           => 0x1E90FFFF,
+        'firebrick'            => 0xB22222FF,
+        'floralwhite'          => 0xFFFAF0FF,
+        'forestgreen'          => 0x228B22FF,
+        'gainsboro'            => 0xDCDCDCFF,
+        'ghostwhite'           => 0xF8F8FFFF,
+        'gold'                 => 0xFFD700FF,
+        'goldenrod'            => 0xDAA520FF,
+        'gray'                 => 0x808080FF,
+        'green'                => 0x008000FF,
+        'greenyellow'          => 0xADFF2FFF,
+        'honeydew'             => 0xF0FFF0FF,
+        'hotpink'              => 0xFF69B4FF,
+        'indianred'            => 0xCD5C5CFF,
+        'indigo'               => 0x4B0082FF,
+        'ivory'                => 0xFFFFF0FF,
+        'khaki'                => 0xF0E68CFF,
+        'lavender'             => 0xE6E6FAFF,
+        'lavenderblush'        => 0xFFF0F5FF,
+        'lawngreen'            => 0x7CFC00FF,
+        'lemonchiffon'         => 0xFFFACDFF,
+        'lightblue'            => 0xADD8E6FF,
+        'lightcoral'           => 0xF08080FF,
+        'lightcyan'            => 0xE0FFFFFF,
+        'lightgoldenrodyellow' => 0xFAFAD2FF,
+        'lightgreen'           => 0x90EE90FF,
+        'lightgray'            => 0xD3D3D3FF,
+        'lightpink'            => 0xFFB6C1FF,
+        'lightsalmon'          => 0xFFA07AFF,
+        'lightseagreen'        => 0x20B2AAFF,
+        'lightskyblue'         => 0x87CEFAFF,
+        'lightslategray'       => 0x778899FF,
+        'lightsteelblue'       => 0xB0C4DEFF,
+        'lightyellow'          => 0xFFFFE0FF,
+        'lime'                 => 0x00FF00FF,
+        'limegreen'            => 0x32CD32FF,
+        'linen'                => 0xFAF0E6FF,
+        'magenta'              => 0xFF00FFFF,
+        'maroon'               => 0x800000FF,
+        'mediumaquamarine'     => 0x66CDAAFF,
+        'mediumblue'           => 0x0000CDFF,
+        'mediumorchid'         => 0xBA55D3FF,
+        'mediumpurple'         => 0x9370DBFF,
+        'mediumseagreen'       => 0x3CB371FF,
+        'mediumslateblue'      => 0x7B68EEFF,
+        'mediumspringgreen'    => 0x00FA9AFF,
+        'mediumturquoise'      => 0x48D1CCFF,
+        'mediumvioletred'      => 0xC71585FF,
+        'midnightblue'         => 0x191970FF,
+        'mintcream'            => 0xF5FFFAFF,
+        'mistyrose'            => 0xFFE4E1FF,
+        'moccasin'             => 0xFFE4B5FF,
+        'navajowhite'          => 0xFFDEADFF,
+        'navy'                 => 0x000080FF,
+        'oldlace'              => 0xFDF5E6FF,
+        'olive'                => 0x808000FF,
+        'olivedrab'            => 0x6B8E23FF,
+        'orange'               => 0xFFA500FF,
+        'orangered'            => 0xFF4500FF,
+        'orchid'               => 0xDA70D6FF,
+        'palegoldenrod'        => 0xEEE8AAFF,
+        'palegreen'            => 0x98FB98FF,
+        'paleturquoise'        => 0xAFEEEEFF,
+        'palevioletred'        => 0xDB7093FF,
+        'papayawhip'           => 0xFFEFD5FF,
+        'peachpuff'            => 0xFFDAB9FF,
+        'peru'                 => 0xCD853FFF,
+        'pink'                 => 0xFFC0CBFF,
+        'plum'                 => 0xDDA0DDFF,
+        'powderblue'           => 0xB0E0E6FF,
+        'purple'               => 0x800080FF,
+        'red'                  => 0xFF0000FF,
+        'rosybrown'            => 0xBC8F8FFF,
+        'royalblue'            => 0x4169E1FF,
+        'saddlebrown'          => 0x8B4513FF,
+        'salmon'               => 0xFA8072FF,
+        'sandybrown'           => 0xF4A460FF,
+        'seagreen'             => 0x2E8B57FF,
+        'seashell'             => 0xFFF5EEFF,
+        'sienna'               => 0xA0522DFF,
+        'silver'               => 0xC0C0C0FF,
+        'skyblue'              => 0x87CEEBFF,
+        'slateblue'            => 0x6A5ACDFF,
+        'slategray'            => 0x708090FF,
+        'snow'                 => 0xFFFAFAFF,
+        'springgreen'          => 0x00FF7FFF,
+        'steelblue'            => 0x4682B4FF,
+        'tan'                  => 0xD2B48CFF,
+        'teal'                 => 0x008080FF,
+        'thistle'              => 0xD8BFD8FF,
+        'tomato'               => 0xFF6347FF,
+        'transparent'          => 0x00000000,
+        'turquoise'            => 0x40E0D0FF,
+        'violet'               => 0xEE82EEFF,
+        'wheat'                => 0xF5DEB3FF,
+        'white'                => 0xFFFFFFFF,
+        'whitesmoke'           => 0xF5F5F5FF,
+        'yellow'               => 0xFFFF00FF,
+        'yellowgreen'          => 0x9ACD32FF
+     }, &method(:int_to_rgba))
+
+    # A hash from `[red, green, blue, alpha]` value arrays to color names.
+    COLOR_NAMES_REVERSE = COLOR_NAMES.invert.freeze
+
+    # We add the alternate color names after inverting because
+    # different ruby implementations and versions vary on the ordering of the result of invert.
+    COLOR_NAMES.update(ALTERNATE_COLOR_NAMES).freeze
 
     # 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.
@@ -101,21 +248,34 @@ module Sass::Script
       [: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 ArgumentError.new("#{k.to_s.capitalize} value must be between 0 and 255")
+        Sass::Util.check_range("#{k.to_s.capitalize} value", 0..255, @attrs[k])
       end
 
       [:saturation, :lightness].each do |k|
         next if @attrs[k].nil?
-        @attrs[k] = 0 if @attrs[k] < 0.00001 && @attrs[k] > -0.00001
-        @attrs[k] = 100 if @attrs[k] - 100 < 0.00001 && @attrs[k] - 100 > -0.00001
-        next if (0..100).include?(@attrs[k])
-        raise ArgumentError.new("#{k.to_s.capitalize} must be between 0 and 100")
+        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
 
-      unless (0..1).include?(@attrs[:alpha])
-        raise ArgumentError.new("Alpha channel must be between 0 and 1")
+      @attrs[:alpha] = Sass::Util.check_range("Alpha channel", 0..1, @attrs[:alpha])
+    end
+
+    # Create a new color from a valid CSS hex string.
+    #
+    # The leading hash is optional.
+    #
+    # @return [Color]
+    def self.from_hex(hex_string, alpha = nil)
+      unless hex_string =~ /^#?([0-9a-f]{2})([0-9a-f]{2})([0-9a-f]{2})$/i ||
+             hex_string =~ /^#?([0-9a-f])([0-9a-f])([0-9a-f])$/i
+        raise ArgumentError.new("#{hex_string.inspect} is not a valid hex color.")
       end
+      red   = $1.ljust(2, $1).to_i(16)
+      green = $2.ljust(2, $2).to_i(16)
+      blue  = $3.ljust(2, $3).to_i(16)
+      attrs = {:red => red, :green => green, :blue => blue}
+      attrs[:alpha] = alpha if alpha
+      new(attrs)
     end
 
     # The red component of the color.
@@ -171,7 +331,7 @@ module Sass::Script
     #
     # @return [Fixnum]
     def alpha
-      @attrs[:alpha]
+      @attrs[:alpha].to_f
     end
 
     # Returns whether this color object is translucent;
@@ -190,6 +350,14 @@ module Sass::Script
       [red, green, blue].freeze
     end
 
+    # Returns the red, green, blue, and alpha components of the color.
+    #
+    # @return [Array<Fixnum>] A frozen four-element array of the red, green,
+    #   blue, and alpha values (respectively) of the color
+    def rgba
+      [red, green, blue, alpha].freeze
+    end
+
     # Returns the hue, saturation, and lightness components of the color.
     #
     # @return [Array<Fixnum>] A frozen three-element array of the
@@ -198,18 +366,30 @@ module Sass::Script
       [hue, saturation, lightness].freeze
     end
 
+    # Returns the hue, saturation, lightness, and alpha components of the color.
+    #
+    # @return [Array<Fixnum>] A frozen four-element array of the hue,
+    #   saturation, lightness, and alpha values (respectively) of the color
+    def hsla
+      [hue, saturation, lightness].freeze
+    end
+
     # The SassScript `==` operation.
-    # **Note that this returns a {Sass::Script::Bool} object,
+    # **Note that this returns a {Sass::Script::Value::Bool} object,
     # not a Ruby boolean**.
     #
-    # @param other [Literal] The right-hand side of the operator
-    # @return [Bool] True if this literal is the same as the other,
+    # @param other [Value] The right-hand side of the operator
+    # @return [Bool] True if this value is the same as the other,
     #   false otherwise
     def eq(other)
-      Sass::Script::Bool.new(
+      Sass::Script::Value::Bool.new(
         other.is_a?(Color) && rgb == other.rgb && alpha == other.alpha)
     end
 
+    def hash
+      [rgb, alpha].hash
+    end
+
     # Returns a copy of this color with one or more channels changed.
     # RGB or HSL colors may be changed, but not both at once.
     #
@@ -260,14 +440,14 @@ module Sass::Script
     # {Color}
     # : Adds each of the RGB color channels together.
     #
-    # {Literal}
-    # : See {Literal#plus}.
+    # {Value}
+    # : See {Value::Base#plus}.
     #
-    # @param other [Literal] The right-hand side of the operator
+    # @param other [Value] The right-hand side of the operator
     # @return [Color] The resulting color
     # @raise [Sass::SyntaxError] if `other` is a number with units
     def plus(other)
-      if other.is_a?(Sass::Script::Number) || other.is_a?(Sass::Script::Color)
+      if other.is_a?(Sass::Script::Value::Number) || other.is_a?(Sass::Script::Value::Color)
         piecewise(other, :+)
       else
         super
@@ -283,14 +463,14 @@ module Sass::Script
     # {Color}
     # : Subtracts each of the other color's RGB color channels from this color's.
     #
-    # {Literal}
-    # : See {Literal#minus}.
+    # {Value}
+    # : See {Value::Base#minus}.
     #
-    # @param other [Literal] The right-hand side of the operator
+    # @param other [Value] The right-hand side of the operator
     # @return [Color] The resulting color
     # @raise [Sass::SyntaxError] if `other` is a number with units
     def minus(other)
-      if other.is_a?(Sass::Script::Number) || other.is_a?(Sass::Script::Color)
+      if other.is_a?(Sass::Script::Value::Number) || other.is_a?(Sass::Script::Value::Color)
         piecewise(other, :-)
       else
         super
@@ -310,7 +490,7 @@ module Sass::Script
     # @return [Color] The resulting color
     # @raise [Sass::SyntaxError] if `other` is a number with units
     def times(other)
-      if other.is_a?(Sass::Script::Number) || other.is_a?(Sass::Script::Color)
+      if other.is_a?(Sass::Script::Value::Number) || other.is_a?(Sass::Script::Value::Color)
         piecewise(other, :*)
       else
         raise NoMethodError.new(nil, :times)
@@ -326,14 +506,15 @@ module Sass::Script
     # {Color}
     # : Divides each of this color's RGB color channels by the other color's.
     #
-    # {Literal}
-    # : See {Literal#div}.
+    # {Value}
+    # : See {Value::Base#div}.
     #
-    # @param other [Literal] The right-hand side of the operator
+    # @param other [Value] The right-hand side of the operator
     # @return [Color] The resulting color
     # @raise [Sass::SyntaxError] if `other` is a number with units
     def div(other)
-      if other.is_a?(Sass::Script::Number) || other.is_a?(Sass::Script::Color)
+      if other.is_a?(Sass::Script::Value::Number) ||
+          other.is_a?(Sass::Script::Value::Color)
         piecewise(other, :/)
       else
         super
@@ -353,7 +534,8 @@ module Sass::Script
     # @return [Color] The resulting color
     # @raise [Sass::SyntaxError] if `other` is a number with units
     def mod(other)
-      if other.is_a?(Sass::Script::Number) || other.is_a?(Sass::Script::Color)
+      if other.is_a?(Sass::Script::Value::Number) ||
+          other.is_a?(Sass::Script::Value::Color)
         piecewise(other, :%)
       else
         raise NoMethodError.new(nil, :mod)
@@ -366,10 +548,9 @@ module Sass::Script
     #
     # @return [String] The string representation
     def to_s(opts = {})
-      return rgba_str if alpha?
       return smallest if options[:style] == :compressed
-      return HTML4_COLORS_REVERSE[rgb] if HTML4_COLORS_REVERSE[rgb]
-      hex_str
+      return COLOR_NAMES_REVERSE[rgba] if COLOR_NAMES_REVERSE[rgba]
+      alpha? ? rgba_str : hex_str
     end
     alias_method :to_sass, :to_s
 
@@ -383,10 +564,10 @@ module Sass::Script
     private
 
     def smallest
-      small_hex_str = hex_str.gsub(/^#(.)\1(.)\2(.)\3$/, '#\1\2\3')
-      return small_hex_str unless (color = HTML4_COLORS_REVERSE[rgb]) &&
-        color.size <= small_hex_str.size
-      return color
+      small_explicit_str = alpha? ? rgba_str : hex_str.gsub(/^#(.)\1(.)\2(.)\3$/, '#\1\2\3')
+      return small_explicit_str unless (color = COLOR_NAMES_REVERSE[rgba]) &&
+        color.size <= small_explicit_str.size
+      color
     end
 
     def rgba_str
@@ -395,20 +576,21 @@ module Sass::Script
     end
 
     def hex_str
-      red, green, blue = rgb.map { |num| num.to_s(16).rjust(2, '0') }
+      red, green, blue = rgb.map {|num| num.to_s(16).rjust(2, '0')}
       "##{red}#{green}#{blue}"
     end
 
     def piecewise(other, operation)
       other_num = other.is_a? Number
       if other_num && !other.unitless?
-        raise Sass::SyntaxError.new("Cannot add a number with units (#{other}) to a color (#{self}).") 
+        raise Sass::SyntaxError.new(
+          "Cannot add a number with units (#{other}) to a color (#{self}).")
       end
 
       result = []
-      for i in (0...3)
+      (0...3).each do |i|
         res = rgb[i].send(operation, other_num ? other.value : other.rgb[i])
-        result[i] = [ [res, 255].min, 0 ].max
+        result[i] = [[res, 255].min, 0].max
       end
 
       if !other_num && other.alpha != alpha
@@ -429,9 +611,9 @@ module Sass::Script
       m2 = l <= 0.5 ? l * (s + 1) : l + s - l * s
       m1 = l * 2 - m2
       @attrs[:red], @attrs[:green], @attrs[:blue] = [
-        hue_to_rgb(m1, m2, h + 1.0/3),
+        hue_to_rgb(m1, m2, h + 1.0 / 3),
         hue_to_rgb(m1, m2, h),
-        hue_to_rgb(m1, m2, h - 1.0/3)
+        hue_to_rgb(m1, m2, h - 1.0 / 3)
       ].map {|c| (c * 0xff).round}
     end
 
@@ -440,8 +622,8 @@ module Sass::Script
       h -= 1 if h > 1
       return m1 + (m2 - m1) * h * 6 if h * 6 < 1
       return m2 if h * 2 < 1
-      return m1 + (m2 - m1) * (2.0/3 - h) * 6 if h * 3 < 2
-      return m1
+      return m1 + (m2 - m1) * (2.0 / 3 - h) * 6 if h * 3 < 2
+      m1
     end
 
     def rgb_to_hsl!
@@ -456,20 +638,20 @@ module Sass::Script
       h =
         case max
         when min; 0
-        when r; 60 * (g-b)/d
-        when g; 60 * (b-r)/d + 120
-        when b; 60 * (r-g)/d + 240
+        when r; 60 * (g - b) / d
+        when g; 60 * (b - r) / d + 120
+        when b; 60 * (r - g) / d + 240
         end
 
-      l = (max + min)/2.0
+      l = (max + min) / 2.0
 
       s =
         if max == min
           0
         elsif l < 0.5
-          d/(2*l)
+          d / (2 * l)
         else
-          d/(2 - 2*l)
+          d / (2 - 2 * l)
         end
 
       @attrs[:hue] = h % 360

data/lib/sass/script/value/deprecated_false.rb

@@ -0,0 +1,55 @@
+module Sass::Script::Value
+  # A SassScript object representing a `false` value that came from a call to
+  # `index()`. It will print deprecation warnings if it's used with `==`.
+  class DeprecatedFalse < Bool
+    def self.new(environment)
+      obj = allocate
+      obj.send(:initialize, environment)
+      obj
+    end
+
+    def initialize(environment)
+      @value = false
+      @global_env = environment.global_env
+      if (frame = environment.stack.frames.last)
+        @filename = frame.filename
+        @line = frame.line
+      end
+    end
+
+    def eq(other)
+      if other.value == false && !warned?
+        self.warned = true
+        Sass::Util.sass_warn <<WARNING + @global_env.stack.to_s.gsub(/^/, '        ')
+DEPRECATION WARNING: The return value of index() will change from "false" to
+"null" in future versions of Sass. For compatibility, avoid using "== false" on
+the return value. For example, instead of "@if index(...) == false", just write
+"@if index(...)".
+WARNING
+      end
+      Bool.new(other.value == false)
+    end
+
+    def neq(other)
+      if other.value.nil? && !warned?
+        self.warned = true
+        Sass::Util.sass_warn <<WARNING + @global_env.stack.to_s.gsub(/^/, '        ')
+DEPRECATION WARNING: The return value of index() will change from "false" to
+"null" in future versions of Sass. For compatibility, avoid using "!= null" on
+the return value.
+WARNING
+      end
+      Bool.new(other.value != false)
+    end
+
+    private
+
+    def warned?
+      @global_env.deprecated_false_warning_given.include?([@filename, @line])
+    end
+
+    def warned=(value)
+      @global_env.deprecated_false_warning_given << [@filename, @line]
+    end
+  end
+end