sass 3.2.19 → 3.4.25

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

@@ -1,6 +1,4 @@
-require 'sass/script/literal'
-
-module Sass::Script
+module Sass::Script::Value
   # A SassScript object representing a number.
   # SassScript numbers can have decimal values,
   # and can also have units.
@@ -9,7 +7,7 @@ module Sass::Script
   #
   # Numbers can also have more complex units, such as `1px*em/in`.
   # These cannot be inputted directly in Sass code at the moment.
-  class Number < Literal
+  class Number < Base
     # The Ruby value of the number.
     #
     # @return [Numeric]
@@ -17,7 +15,7 @@ module Sass::Script
 
     # A list of units in the numerator of the number.
     # For example, `1px*em/in*cm` would return `["px", "em"]`
-    # @return [Array<String>] 
+    # @return [Array<String>]
     attr_reader :numerator_units
 
     # A list of units in the denominator of the number.
@@ -36,44 +34,46 @@ module Sass::Script
     attr_accessor :original
 
     def self.precision
-      @precision ||= 5
+      Thread.current[:sass_numeric_precision] || Thread.main[:sass_numeric_precision] || 5
     end
 
     # Sets the number of digits of precision
     # For example, if this is `3`,
     # `3.1415926` will be printed as `3.142`.
+    # The numeric precision is stored as a thread local for thread safety reasons.
+    # To set for all threads, be sure to set the precision on the main thread.
     def self.precision=(digits)
-      @precision = digits.round
-      @precision_factor = 10.0**@precision
+      Thread.current[:sass_numeric_precision] = digits.round
+      Thread.current[:sass_numeric_precision_factor] = nil
+      Thread.current[:sass_numeric_epsilon] = nil
     end
 
     # the precision factor used in numeric output
     # it is derived from the `precision` method.
     def self.precision_factor
-      @precision_factor ||= 10.0**precision
+      Thread.current[:sass_numeric_precision_factor] ||= 10.0**precision
     end
 
-    # Handles the deprecation warning for the PRECISION constant
-    # This can be removed in 3.2.
-    def self.const_missing(const)
-      if const == :PRECISION
-        Sass::Util.sass_warn("Sass::Script::Number::PRECISION is deprecated and will be removed in a future release. Use Sass::Script::Number.precision_factor instead.")
-        const_set(:PRECISION, self.precision_factor)
-      else
-        super
-      end
+    # Used in checking equality of floating point numbers. Any
+    # numbers within an `epsilon` of each other are considered functionally equal.
+    # The value for epsilon is one tenth of the current numeric precision.
+    def self.epsilon
+      Thread.current[:sass_numeric_epsilon] ||= 1 / (precision_factor * 10)
     end
 
     # Used so we don't allocate two new arrays for each new number.
-    NO_UNITS  = []
+    NO_UNITS = []
 
     # @param value [Numeric] The value of the number
-    # @param numerator_units [Array<String>] See \{#numerator\_units}
-    # @param denominator_units [Array<String>] See \{#denominator\_units}
+    # @param numerator_units [::String, Array<::String>] See \{#numerator\_units}
+    # @param denominator_units [::String, Array<::String>] See \{#denominator\_units}
     def initialize(value, numerator_units = NO_UNITS, denominator_units = NO_UNITS)
+      numerator_units = [numerator_units] if numerator_units.is_a?(::String)
+      denominator_units = [denominator_units] if denominator_units.is_a?(::String)
       super(value)
       @numerator_units = numerator_units
       @denominator_units = denominator_units
+      @options = nil
       normalize!
     end
 
@@ -86,11 +86,11 @@ module Sass::Script
     # {Color}
     # : Adds this number to each of the RGB color channels.
     #
-    # {Literal}
-    # : See {Literal#plus}.
+    # {Value}
+    # : See {Value::Base#plus}.
     #
-    # @param other [Literal] The right-hand side of the operator
-    # @return [Literal] The result of the operation
+    # @param other [Value] The right-hand side of the operator
+    # @return [Value] The result of the operation
     # @raise [Sass::UnitConversionError] if `other` is a number with incompatible units
     def plus(other)
       if other.is_a? Number
@@ -108,11 +108,11 @@ module Sass::Script
     # {Number}
     # : Subtracts this number from the other, converting units if possible.
     #
-    # {Literal}
-    # : See {Literal#minus}.
+    # {Value}
+    # : See {Value::Base#minus}.
     #
-    # @param other [Literal] The right-hand side of the operator
-    # @return [Literal] The result of the operation
+    # @param other [Value] The right-hand side of the operator
+    # @return [Value] The result of the operation
     # @raise [Sass::UnitConversionError] if `other` is a number with incompatible units
     def minus(other)
       if other.is_a? Number
@@ -164,16 +164,16 @@ module Sass::Script
     # {Number}
     # : Divides this number by the other, converting units appropriately.
     #
-    # {Literal}
-    # : See {Literal#div}.
+    # {Value}
+    # : See {Value::Base#div}.
     #
-    # @param other [Literal] The right-hand side of the operator
-    # @return [Literal] The result of the operation
+    # @param other [Value] The right-hand side of the operator
+    # @return [Value] The result of the operation
     def div(other)
       if other.is_a? Number
         res = operate(other, :/)
-        if self.original && other.original
-          res.original = "#{self.original}/#{other.original}"
+        if original && other.original
+          res.original = "#{original}/#{other.original}"
         end
         res
       else
@@ -186,12 +186,9 @@ module Sass::Script
     # @param other [Number] The right-hand side of the operator
     # @return [Number] This number modulo the other
     # @raise [NoMethodError] if `other` is an invalid type
-    # @raise [Sass::UnitConversionError] if `other` has any units
+    # @raise [Sass::UnitConversionError] if `other` has incompatible units
     def mod(other)
       if other.is_a?(Number)
-        unless other.unitless?
-          raise Sass::UnitConversionError.new("Cannot modulo by a number with units: #{other.inspect}.")
-        end
         operate(other, :%)
       else
         raise NoMethodError.new(nil, :mod)
@@ -200,10 +197,10 @@ module Sass::Script
 
     # The SassScript `==` operation.
     #
-    # @param other [Literal] The right-hand side of the operator
+    # @param other [Value] The right-hand side of the operator
     # @return [Boolean] Whether this number is equal to the other object
     def eq(other)
-      return Sass::Script::Bool.new(false) unless other.is_a?(Sass::Script::Number)
+      return Bool::FALSE unless other.is_a?(Sass::Script::Value::Number)
       this = self
       begin
         if unitless?
@@ -212,10 +209,21 @@ module Sass::Script
           other = other.coerce(@numerator_units, @denominator_units)
         end
       rescue Sass::UnitConversionError
-        return Sass::Script::Bool.new(false)
+        return Bool::FALSE
       end
+      Bool.new(basically_equal?(this.value, other.value))
+    end
 
-      Sass::Script::Bool.new(this.value == other.value)
+    def hash
+      [value, numerator_units, denominator_units].hash
+    end
+
+    # Hash-equality works differently than `==` equality for numbers.
+    # Hash-equality must be transitive, so it just compares the exact value,
+    # numerator units, and denominator units.
+    def eql?(other)
+      basically_equal?(value, other.value) && numerator_units == other.numerator_units &&
+        denominator_units == other.denominator_units
     end
 
     # The SassScript `>` operation.
@@ -274,21 +282,40 @@ module Sass::Script
     #
     # @return [String] The representation
     def inspect(opts = {})
+      return original if original
+
       value = self.class.round(self.value)
-      unitless? ? value.to_s : "#{value}#{unit_str}"
+      str = value.to_s
+
+      # Ruby will occasionally print in scientific notation if the number is
+      # small enough. That's technically valid CSS, but it's not well-supported
+      # and confusing.
+      str = ("%0.#{self.class.precision}f" % value).gsub(/0*$/, '') if str.include?('e')
+
+      # Sometimes numeric formatting will result in a decimal number with a trailing zero (x.0)
+      if str =~ /(.*)\.0$/
+        str = $1
+      end
+
+      # We omit a leading zero before the decimal point in compressed mode.
+      if @options && options[:style] == :compressed
+        str.sub!(/^(-)?0\./, '\1.')
+      end
+
+      unitless? ? str : "#{str}#{unit_str}"
     end
     alias_method :to_sass, :inspect
 
-    # @return [Fixnum] The integer value of the number
+    # @return [Integer] The integer value of the number
     # @raise [Sass::SyntaxError] if the number isn't an integer
     def to_i
       super unless int?
-      return value
+      value.to_i
     end
 
     # @return [Boolean] Whether or not this number is an integer.
     def int?
-      value % 1 == 0.0
+      basically_equal?(value % 1, 0.0)
     end
 
     # @return [Boolean] Whether or not this number has no units.
@@ -296,6 +323,24 @@ module Sass::Script
       @numerator_units.empty? && @denominator_units.empty?
     end
 
+    # Checks whether the number has the numerator unit specified.
+    #
+    # @example
+    #   number = Sass::Script::Value::Number.new(10, "px")
+    #   number.is_unit?("px") => true
+    #   number.is_unit?(nil) => false
+    #
+    # @param unit [::String, nil] The unit the number should have or nil if the number
+    #   should be unitless.
+    # @see Number#unitless? The unitless? method may be more readable.
+    def is_unit?(unit)
+      if unit
+        denominator_units.size == 0 && numerator_units.size == 1 && numerator_units.first == unit
+      else
+        unitless?
+      end
+    end
+
     # @return [Boolean] Whether or not this number has units that can be represented in CSS
     #   (that is, zero or one \{#numerator\_units}).
     def legal_units?
@@ -320,9 +365,9 @@ module Sass::Script
     #   current units
     def coerce(num_units, den_units)
       Number.new(if unitless?
-                   self.value
+                   value
                  else
-                   self.value * coercion_factor(@numerator_units, num_units) /
+                   value * coercion_factor(@numerator_units, num_units) /
                      coercion_factor(@denominator_units, den_units)
                  end, num_units, den_units)
     end
@@ -330,12 +375,10 @@ module Sass::Script
     # @param other [Number] A number to decide if it can be compared with this number.
     # @return [Boolean] Whether or not this number can be compared with the other.
     def comparable_to?(other)
-      begin
-        operate(other, :+)
-        true
-      rescue Sass::UnitConversionError
-        false
-      end
+      operate(other, :+)
+      true
+    rescue Sass::UnitConversionError
+      false
     end
 
     # Returns a human readable representation of the units in this number.
@@ -353,18 +396,30 @@ module Sass::Script
 
     private
 
+    # @private
+    # @see Sass::Script::Number.basically_equal?
+    def basically_equal?(num1, num2)
+      self.class.basically_equal?(num1, num2)
+    end
+
+    # Checks whether two numbers are within an epsilon of each other.
+    # @return [Boolean]
+    def self.basically_equal?(num1, num2)
+      (num1 - num2).abs < epsilon
+    end
+
     # @private
     def self.round(num)
       if num.is_a?(Float) && (num.infinite? || num.nan?)
         num
-      elsif num % 1 == 0.0
-        num.to_i
+      elsif basically_equal?(num % 1, 0.0)
+        num.round
       else
-        ((num * self.precision_factor).round / self.precision_factor).to_f
+        ((num * precision_factor).round / precision_factor).to_f
       end
     end
 
-    OPERATIONS = [:+, :-, :<=, :<, :>, :>=]
+    OPERATIONS = [:+, :-, :<=, :<, :>, :>=, :%]
 
     def operate(other, operation)
       this = self
@@ -376,7 +431,7 @@ module Sass::Script
         end
       end
       # avoid integer division
-      value = (:/ == operation) ? this.value.to_f : this.value
+      value = :/ == operation ? this.value.to_f : this.value
       result = value.send(operation, other.value)
 
       if result.is_a?(Numeric)
@@ -391,63 +446,118 @@ module Sass::Script
       from_units, to_units = sans_common_units(from_units, to_units)
 
       if from_units.size != to_units.size || !convertable?(from_units | to_units)
-        raise Sass::UnitConversionError.new("Incompatible units: '#{from_units.join('*')}' and '#{to_units.join('*')}'.")
+        raise Sass::UnitConversionError.new(
+          "Incompatible units: '#{from_units.join('*')}' and '#{to_units.join('*')}'.")
       end
 
-      from_units.zip(to_units).inject(1) {|m,p| m * conversion_factor(p[0], p[1]) }
+      from_units.zip(to_units).inject(1) {|m, p| m * conversion_factor(p[0], p[1])}
     end
 
     def compute_units(this, other, operation)
       case operation
       when :*
-        [this.numerator_units + other.numerator_units, this.denominator_units + other.denominator_units]
+        [this.numerator_units + other.numerator_units,
+         this.denominator_units + other.denominator_units]
       when :/
-        [this.numerator_units + other.denominator_units, this.denominator_units + other.numerator_units]
-      else  
+        [this.numerator_units + other.denominator_units,
+         this.denominator_units + other.numerator_units]
+      else
         [this.numerator_units, this.denominator_units]
       end
     end
 
     def normalize!
       return if unitless?
-      @numerator_units, @denominator_units = sans_common_units(@numerator_units, @denominator_units)
+      @numerator_units, @denominator_units =
+        sans_common_units(@numerator_units, @denominator_units)
 
       @denominator_units.each_with_index do |d, i|
-        if convertable?(d) && (u = @numerator_units.detect(&method(:convertable?)))
-          @value /= conversion_factor(d, u)
-          @denominator_units.delete_at(i)
-          @numerator_units.delete_at(@numerator_units.index(u))
-        end
+        next unless convertable?(d) && (u = @numerator_units.find(&method(:convertable?)))
+        @value /= conversion_factor(d, u)
+        @denominator_units.delete_at(i)
+        @numerator_units.delete_at(@numerator_units.index(u))
       end
     end
 
-    # A hash of unit names to their index in the conversion table
-    CONVERTABLE_UNITS = {"in" => 0,        "cm" => 1,    "pc" => 2,    "mm" => 3,   "pt" => 4,  "px" => 5    }
-    CONVERSION_TABLE = [[ 1,                2.54,         6,            25.4,        72        , 96          ], # in
-                        [ nil,              1,            2.36220473,   10,          28.3464567, 37.795275591], # cm
-                        [ nil,              nil,          1,            4.23333333,  12        , 16          ], # pc
-                        [ nil,              nil,          nil,          1,           2.83464567, 3.7795275591], # mm
-                        [ nil,              nil,          nil,          nil,         1         , 1.3333333333], # pt
-                        [ nil,              nil,          nil,          nil,         nil       , 1           ]] # px
+    # This is the source data for all the unit logic. It's pre-processed to make
+    # it efficient to figure out whether a set of units is mutually compatible
+    # and what the conversion ratio is between two units.
+    #
+    # These come from http://www.w3.org/TR/2012/WD-css3-values-20120308/.
+    relative_sizes = [
+      {
+        'in' => Rational(1),
+        'cm' => Rational(1, 2.54),
+        'pc' => Rational(1, 6),
+        'mm' => Rational(1, 25.4),
+        'q' => Rational(1, 101.6),
+        'pt' => Rational(1, 72),
+        'px' => Rational(1, 96)
+      },
+      {
+        'deg'  => Rational(1, 360),
+        'grad' => Rational(1, 400),
+        'rad'  => Rational(1, 2 * Math::PI),
+        'turn' => Rational(1)
+      },
+      {
+        's'  => Rational(1),
+        'ms' => Rational(1, 1000)
+      },
+      {
+        'Hz'  => Rational(1),
+        'kHz' => Rational(1000)
+      },
+      {
+        'dpi'  => Rational(1),
+        'dpcm' => Rational(254, 100),
+        'dppx' => Rational(96)
+      }
+    ]
+
+    # A hash from each known unit to the set of units that it's mutually
+    # convertible with.
+    MUTUALLY_CONVERTIBLE = {}
+    relative_sizes.map do |values|
+      set = values.keys.to_set
+      values.keys.each {|name| MUTUALLY_CONVERTIBLE[name] = set}
+    end
+
+    # A two-dimensional hash from two units to the conversion ratio between
+    # them. Multiply `X` by `CONVERSION_TABLE[X][Y]` to convert it to `Y`.
+    CONVERSION_TABLE = {}
+    relative_sizes.each do |values|
+      values.each do |(name1, value1)|
+        CONVERSION_TABLE[name1] ||= {}
+        values.each do |(name2, value2)|
+          value = value1 / value2
+          CONVERSION_TABLE[name1][name2] = value.denominator == 1 ? value.to_i : value.to_f
+        end
+      end
+    end
 
     def conversion_factor(from_unit, to_unit)
-      res = CONVERSION_TABLE[CONVERTABLE_UNITS[from_unit]][CONVERTABLE_UNITS[to_unit]]
-      return 1.0 / conversion_factor(to_unit, from_unit) if res.nil?
-      res
+      CONVERSION_TABLE[from_unit][to_unit]
     end
 
     def convertable?(units)
-      Array(units).all? {|u| CONVERTABLE_UNITS.include?(u)}
+      units = Array(units).to_set
+      return true if units.empty?
+      return false unless (mutually_convertible = MUTUALLY_CONVERTIBLE[units.first])
+      units.subset?(mutually_convertible)
     end
 
     def sans_common_units(units1, units2)
       units2 = units2.dup
       # Can't just use -, because we want px*px to coerce properly to px*mm
-      return units1.map do |u|
-        next u unless j = units2.index(u)
+      units1 = units1.map do |u|
+        j = units2.index(u)
+        next u unless j
         units2.delete_at(j)
         nil
-      end.compact, units2
+      end
+      units1.compact!
+      return units1, units2
     end
   end
 end

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

@@ -0,0 +1,138 @@
+# -*- coding: utf-8 -*-
+module Sass::Script::Value
+  # A SassScript object representing a CSS string *or* a CSS identifier.
+  class String < Base
+    @@interpolation_deprecation = Sass::Deprecation.new
+
+    # The Ruby value of the string.
+    #
+    # @return [String]
+    attr_reader :value
+
+    # Whether this is a CSS string or a CSS identifier.
+    # The difference is that strings are written with double-quotes,
+    # while identifiers aren't.
+    #
+    # @return [Symbol] `:string` or `:identifier`
+    attr_reader :type
+
+    def self.value(contents)
+      contents.gsub("\\\n", "").gsub(/\\(?:([0-9a-fA-F]{1,6})\s?|(.))/) do
+        next $2 if $2
+        # Handle unicode escapes as per CSS Syntax Level 3 section 4.3.8.
+        code_point = $1.to_i(16)
+        if code_point == 0 || code_point > 0x10FFFF ||
+            (code_point >= 0xD800 && code_point <= 0xDFFF)
+          '�'
+        else
+          [code_point].pack("U")
+        end
+      end
+    end
+
+    # Returns the quoted string representation of `contents`.
+    #
+    # @options opts :quote [String]
+    #   The preferred quote style for quoted strings. If `:none`, strings are
+    #   always emitted unquoted. If `nil`, quoting is determined automatically.
+    # @options opts :sass [String]
+    #   Whether to quote strings for Sass source, as opposed to CSS. Defaults to `false`.
+    def self.quote(contents, opts = {})
+      quote = opts[:quote]
+
+      # Short-circuit if there are no characters that need quoting.
+      unless contents =~ /[\n\\"']|\#\{/
+        quote ||= '"'
+        return "#{quote}#{contents}#{quote}"
+      end
+
+      if quote.nil?
+        if contents.include?('"')
+          if contents.include?("'")
+            quote = '"'
+          else
+            quote = "'"
+          end
+        else
+          quote = '"'
+        end
+      end
+
+      # Replace single backslashes with multiples.
+      contents = contents.gsub("\\", "\\\\\\\\")
+
+      # Escape interpolation.
+      contents = contents.gsub('#{', "\\\#{") if opts[:sass]
+
+      if quote == '"'
+        contents = contents.gsub('"', "\\\"")
+      else
+        contents = contents.gsub("'", "\\'")
+      end
+
+      contents = contents.gsub(/\n(?![a-fA-F0-9\s])/, "\\a").gsub("\n", "\\a ")
+      "#{quote}#{contents}#{quote}"
+    end
+
+    # Creates a new string.
+    #
+    # @param value [String] See \{#value}
+    # @param type [Symbol] See \{#type}
+    # @param deprecated_interp_equivalent [String?]
+    #   If this was created via a potentially-deprecated string interpolation,
+    #   this is the replacement expression that should be suggested to the user.
+    def initialize(value, type = :identifier, deprecated_interp_equivalent = nil)
+      super(value)
+      @type = type
+      @deprecated_interp_equivalent = deprecated_interp_equivalent
+    end
+
+    # @see Value#plus
+    def plus(other)
+      other_value = if other.is_a?(Sass::Script::Value::String)
+                      other.value
+                    else
+                      other.to_s(:quote => :none)
+                    end
+      Sass::Script::Value::String.new(value + other_value, type)
+    end
+
+    # @see Value#to_s
+    def to_s(opts = {})
+      return @value.gsub(/\n\s*/, ' ') if opts[:quote] == :none || @type == :identifier
+      String.quote(value, opts)
+    end
+
+    # @see Value#to_sass
+    def to_sass(opts = {})
+      to_s(opts.merge(:sass => true))
+    end
+
+    def separator
+      check_deprecated_interp
+      super
+    end
+
+    def to_a
+      check_deprecated_interp
+      super
+    end
+
+    # Prints a warning if this string was created using potentially-deprecated
+    # interpolation.
+    def check_deprecated_interp
+      return unless @deprecated_interp_equivalent
+
+      @@interpolation_deprecation.warn(source_range.file, source_range.start_pos.line, <<WARNING)
+\#{} interpolation near operators will be simplified in a future version of Sass.
+To preserve the current behavior, use quotes:
+
+  #{@deprecated_interp_equivalent}
+WARNING
+    end
+
+    def inspect
+      String.quote(value)
+    end
+  end
+end

data/lib/sass/script/value.rb

@@ -0,0 +1,11 @@
+module Sass::Script::Value; end
+
+require 'sass/script/value/base'
+require 'sass/script/value/string'
+require 'sass/script/value/number'
+require 'sass/script/value/color'
+require 'sass/script/value/bool'
+require 'sass/script/value/null'
+require 'sass/script/value/list'
+require 'sass/script/value/arg_list'
+require 'sass/script/value/map'