haml 2.2.24 → 3.0.0.beta.1

data/lib/sass/script/node.rb

@@ -3,12 +3,90 @@ module Sass::Script
   #
   # Use \{#perform} to evaluate a parse tree.
   class Node
+    # The options hash for this node.
+    #
+    # @return [{Symbol => Object}]
+    attr_reader :options
+
+    # The context in which this node was parsed,
+    # which determines how some operations are performed.
+    #
+    # Can be `:equals`, which means it's part of a `$var = val` or `prop = val` assignment,
+    # or `:default`, which means it's anywhere else
+    # (including `$var: val` and `prop: val` assignments,
+    # `#{}`-interpolations,
+    # and other script contexts such as `@if` conditions).
+    #
+    # @return [Symbol]
+    attr_reader :context
+
+    # The line of the document on which this node appeared.
+    #
+    # @return [Fixnum]
+    attr_accessor :line
+
+    # Sets the options hash for this node,
+    # as well as for all child nodes.
+    # See {file:SASS_REFERENCE.md#sass_options the Sass options documentation}.
+    #
+    # @param options [{Symbol => Object}] The options
+    def options=(options)
+      @options = options
+      children.each {|c| c.options = options}
+    end
+
+    # Sets the options hash for this node,
+    # as well as for all child nodes.
+    #
+    # @param context [Symbol]
+    # @see #context
+    def context=(context)
+      @context = context
+      children.each {|c| c.context = context}
+    end
+
+    # Creates a new script node.
+    def initialize
+      @context = :default
+    end
+
     # Evaluates the node.
     #
+    # \{#perform} shouldn't be overridden directly;
+    # instead, override \{#\_perform}.
+    #
     # @param environment [Sass::Environment] The environment in which to evaluate the SassScript
     # @return [Literal] The SassScript object that is the value of the SassScript
     def perform(environment)
-      raise NotImplementedError.new("All subclasses of Sass::Script::Node must override #perform.")
+      _perform(environment)
+    rescue Sass::SyntaxError => e
+      e.modify_backtrace(:line => line)
+      raise e
+    end
+
+    # Returns all child nodes of this node.
+    #
+    # @return [Array<Node>]
+    def children
+      raise NotImplementedError.new("All subclasses of Sass::Script::Node must override #children.")
+    end
+
+    # Returns the text of this SassScript expression.
+    #
+    # @return [String]
+    def to_sass
+      raise NotImplementedError.new("All subclasses of Sass::Script::Node must override #to_sass.")
+    end
+
+    protected
+
+    # Evaluates this node.
+    #
+    # @param environment [Sass::Environment] The environment in which to evaluate the SassScript
+    # @return [Literal] The SassScript object that is the value of the SassScript
+    # @see #perform
+    def _perform(environment)
+      raise NotImplementedError.new("All subclasses of Sass::Script::Node must override #_perform.")
     end
   end
 end

data/lib/sass/script/number.rb

@@ -25,6 +25,8 @@ module Sass::Script
     # @return [Array<String>]
     attr_reader :denominator_units
 
+    attr_accessor :original
+
     # The precision with which numbers will be printed to CSS files.
     # For example, if this is `1000.0`,
     # `3.1415926` will be printed as `3.142`.
@@ -65,7 +67,7 @@ module Sass::Script
       end
     end
 
-    # The SassScript binary `-` operation (e.g. `!a - !b`).
+    # The SassScript binary `-` operation (e.g. `$a - $b`).
     # Its functionality depends on the type of its argument:
     #
     # {Number}
@@ -85,7 +87,14 @@ module Sass::Script
       end
     end
 
-    # The SassScript unary `-` operation (e.g. `-!a`).
+    # The SassScript unary `+` operation (e.g. `+$a`).
+    #
+    # @return [Number] The value of this number
+    def unary_plus
+      self
+    end
+
+    # The SassScript unary `-` operation (e.g. `-$a`).
     #
     # @return [Number] The negative value of this number
     def unary_minus
@@ -106,7 +115,7 @@ module Sass::Script
     # @raise [NoMethodError] if `other` is an invalid type
     def times(other)
       if other.is_a? Number
-        operate(other, :*)
+        self.operate(other, :*)
       elsif other.is_a? Color
         other.times(self)
       else
@@ -127,7 +136,11 @@ module Sass::Script
     # @return [Literal] The result of the operation
     def div(other)
       if other.is_a? Number
-        operate(other, :/)
+        res = operate(other, :/)
+        if self.original && other.original && context != :equals
+          res.original = "#{self.original}/#{other.original}"
+        end
+        res
       else
         super
       end
@@ -214,6 +227,7 @@ module Sass::Script
     # @raise [Sass::SyntaxError] if this number has units that can't be used in CSS
     #   (e.g. `px*in`)
     def to_s
+      return original if original
       raise Sass::SyntaxError.new("#{inspect} isn't a valid CSS value.") unless legal_units?
       inspect
     end
@@ -235,6 +249,7 @@ module Sass::Script
         end
       "#{value}#{unit_str}"
     end
+    alias_method :to_sass, :inspect
 
     # @return [Fixnum] The integer value of the number
     # @raise [Sass::SyntaxError] if the number isn't an integer
@@ -284,7 +299,7 @@ module Sass::Script
                  end, num_units, den_units)
     end
 
-    private
+    protected
 
     def operate(other, operation)
       this = self

data/lib/sass/script/operation.rb

@@ -4,11 +4,16 @@ require 'sass/script/number'
 require 'sass/script/color'
 require 'sass/script/functions'
 require 'sass/script/unary_operation'
+require 'sass/script/interpolation'
 
 module Sass::Script
   # A SassScript parse node representing a binary operation,
-  # such as `!a + !b` or `"foo" + 1`.
+  # such as `$a + $b` or `"foo" + 1`.
   class Operation < Node
+    attr_reader :operand1
+    attr_reader :operand2
+    attr_reader :operator
+
     # @param operand1 [Script::Node] The parse-tree node
     #   for the right-hand side of the operator
     # @param operand2 [Script::Node] The parse-tree node
@@ -19,6 +24,7 @@ module Sass::Script
       @operand1 = operand1
       @operand2 = operand2
       @operator = operator
+      super()
     end
 
     # @return [String] A human-readable s-expression representation of the operation
@@ -26,20 +32,60 @@ module Sass::Script
       "(#{@operator.inspect} #{@operand1.inspect} #{@operand2.inspect})"
     end
 
+    # @see Node#to_sass
+    def to_sass
+      pred = Sass::Script::Parser.precedence_of(@operator)
+      o1 = operand_to_sass pred, @operand1
+      o2 = operand_to_sass pred, @operand2
+      sep =
+        case @operator
+        when :comma; ", "
+        when :concat; " "
+        else; " #{Lexer::OPERATORS_REVERSE[@operator]} "
+        end
+      "#{o1}#{sep}#{o2}"
+    end
+
+    # Returns the operands for this operation.
+    #
+    # @return [Array<Node>]
+    # @see Node#children
+    def children
+      [@operand1, @operand2]
+    end
+
+    protected
+
     # Evaluates the operation.
     #
     # @param environment [Sass::Environment] The environment in which to evaluate the SassScript
     # @return [Literal] The SassScript object that is the value of the operation
     # @raise [Sass::SyntaxError] if the operation is undefined for the operands
-    def perform(environment)
+    def _perform(environment)
       literal1 = @operand1.perform(environment)
       literal2 = @operand2.perform(environment)
+
+      if @operator == :concat && context == :equals
+        literal1 = Sass::Script::String.new(literal1.value) if literal1.is_a?(Sass::Script::String)
+        literal2 = Sass::Script::String.new(literal2.value) if literal2.is_a?(Sass::Script::String)
+      end
+
       begin
-        literal1.send(@operator, literal2)
+        res = literal1.send(@operator, literal2)
+        res.options = environment.options
+        res
       rescue NoMethodError => e
         raise e unless e.name.to_s == @operator.to_s
         raise Sass::SyntaxError.new("Undefined operation: \"#{literal1} #{@operator} #{literal2}\".")
       end
     end
+
+    private
+
+    def operand_to_sass(pred, op)
+      return "(#{op.to_sass})" if op.is_a?(Operation) &&
+        Sass::Script::Parser.precedence_of(op.operator) < pred
+      op.to_sass
+    end
   end
 end

data/lib/sass/script/parser.rb

@@ -5,16 +5,23 @@ module Sass
     # The parser for SassScript.
     # It parses a string of code into a tree of {Script::Node}s.
     class Parser
+      # The line number of the parser's current position.
+      #
+      # @return [Fixnum]
+      def line
+        @lexer.line
+      end
+
       # @param str [String, StringScanner] The source text to parse
       # @param line [Fixnum] The line on which the SassScript appears.
       #   Used for error reporting
       # @param offset [Fixnum] The number of characters in on which the SassScript appears.
       #   Used for error reporting
-      # @param filename [String] The name of the file in which the SassScript appears.
-      #   Used for error reporting
-      def initialize(str, line, offset, filename = nil)
-        @filename = filename
-        @lexer = Lexer.new(str, line, offset, filename)
+      # @param options [{Symbol => Object}] An options hash;
+      #   see {file:SASS_REFERENCE.md#sass_options the Sass options documentation}
+      def initialize(str, line, offset, options = {})
+        @options = options
+        @lexer = lexer_class.new(str, line, offset, options)
       end
 
       # Parses a SassScript expression within an interpolated segment (`#{}`).
@@ -27,7 +34,11 @@ module Sass
       def parse_interpolated
         expr = assert_expr :expr
         assert_tok :end_interpolation
+        expr.options = @options
         expr
+      rescue Sass::SyntaxError => e
+        e.modify_backtrace :line => @lexer.line, :filename => @options[:filename]
+        raise e
       end
 
       # Parses a SassScript expression.
@@ -37,7 +48,28 @@ module Sass
       def parse
         expr = assert_expr :expr
         assert_done
+        expr.options = @options
         expr
+      rescue Sass::SyntaxError => e
+        e.modify_backtrace :line => @lexer.line, :filename => @options[:filename]
+        raise e
+      end
+
+      # Parses a SassScript expression,
+      # ending it when it encounters one of the given identifier tokens.
+      #
+      # @param [#include?(String)] A set of strings that delimit the expression.
+      # @return [Script::Node] The root node of the parse tree
+      # @raise [Sass::SyntaxError] if the expression isn't valid SassScript
+      def parse_until(tokens)
+        @stop_at = tokens
+        expr = assert_expr :expr
+        assert_done
+        expr.options = @options
+        expr
+      rescue Sass::SyntaxError => e
+        e.modify_backtrace :line => @lexer.line, :filename => @options[:filename]
+        raise e
       end
 
       # Parses the argument list for a mixin include.
@@ -53,7 +85,11 @@ module Sass
         end
         assert_done
 
+        args.each {|a| a.options = @options}
         args
+      rescue Sass::SyntaxError => e
+        e.modify_backtrace :line => @lexer.line, :filename => @options[:filename]
+        raise e
       end
 
       # Parses the argument list for a mixin definition.
@@ -69,7 +105,14 @@ module Sass
         end
         assert_done
 
+        args.each do |k, v|
+          k.options = @options
+          v.options = @options if v
+        end
         args
+      rescue Sass::SyntaxError => e
+        e.modify_backtrace :line => @lexer.line, :filename => @options[:filename]
+        raise e
       end
 
       # Parses a SassScript expression.
@@ -82,7 +125,28 @@ module Sass
         new(*args).parse
       end
 
+      # @private
+      PRECEDENCE = [
+        :comma, :concat, :or, :and,
+        [:eq, :neq],
+        [:gt, :gte, :lt, :lte],
+        [:plus, :minus],
+        [:times, :div, :mod],
+      ]
+
       class << self
+        # Returns an integer representing the precedence
+        # of the given operator.
+        # A lower integer indicates a looser binding.
+        #
+        # @private
+        def precedence_of(op)
+          PRECEDENCE.each_with_index do |e, i|
+            return i if Array(e).include?(op)
+          end
+          raise "[BUG] Unknown operator #{op}"
+        end
+
         private
 
         # Defines a simple left-associative production.
@@ -94,7 +158,9 @@ module Sass
             def #{name}
               return unless e = #{sub}
               while tok = try_tok(#{ops.map {|o| o.inspect}.join(', ')})
+                line = @lexer.line
                 e = Operation.new(e, assert_expr(#{sub.inspect}), tok.type)
+                e.line = line
               end
               e
             end
@@ -105,7 +171,10 @@ RUBY
           class_eval <<RUBY
             def unary_#{op}
               return #{sub} unless try_tok(:#{op})
-              UnaryOperation.new(assert_expr(:unary_#{op}), :#{op})
+              line = @lexer.line
+              op = UnaryOperation.new(assert_expr(:unary_#{op}), :#{op})
+              op.line = line
+              op
             end
 RUBY
         end
@@ -113,12 +182,28 @@ RUBY
 
       private
 
-      production :expr, :concat, :comma
+      # @private
+      def lexer_class; Lexer; end
+
+      production :expr, :interpolation, :comma
+
+      def interpolation
+        e = concat
+        while interp = try_tok(:begin_interpolation)
+          wb = @lexer.whitespace?(interp)
+          line = @lexer.line
+          mid = parse_interpolated
+          wa = @lexer.whitespace?
+          e = Script::Interpolation.new(e, mid, concat, wb, wa)
+          e.line = line
+        end
+        e
+      end
 
       def concat
         return unless e = or_expr
         while sub = or_expr
-          e = Operation.new(e, sub, :concat)
+          e = node(Operation.new(e, sub, :concat))
         end
         e
       end
@@ -128,37 +213,47 @@ RUBY
       production :eq_or_neq, :relational, :eq, :neq
       production :relational, :plus_or_minus, :gt, :gte, :lt, :lte
       production :plus_or_minus, :times_div_or_mod, :plus, :minus
-      production :times_div_or_mod, :unary_minus, :times, :div, :mod
+      production :times_div_or_mod, :unary_plus, :times, :div, :mod
 
+      unary :plus, :unary_minus
       unary :minus, :unary_div
       unary :div, :unary_not # For strings, so /foo/bar works
       unary :not, :funcall
 
       def funcall
-        return paren unless name = try_tok(:ident)
+        return raw unless @lexer.peek && @lexer.peek.type == :ident
+        return if @stop_at && @stop_at.include?(@lexer.peek.value)
+
+        name = @lexer.next
         # An identifier without arguments is just a string
         unless try_tok(:lparen)
-          warn(<<END)
-DEPRECATION WARNING:
-On line #{name.line}, character #{name.offset}#{" of '#{@filename}'" if @filename}
-Implicit strings have been deprecated and will be removed in version 3.0.
-'#{name.value}' was not quoted. Please add double quotes (e.g. "#{name.value}").
-END
-          Script::String.new(name.value)
+          if color = Color::HTML4_COLORS[name.value]
+            return node(Color.new(color))
+          end
+          node(Script::String.new(name.value, :identifier))
         else
           args = arglist || []
           assert_tok(:rparen)
-          Script::Funcall.new(name.value, args)
+          node(Script::Funcall.new(name.value, args))
         end
       end
 
       def defn_arglist(must_have_default)
+        line = @lexer.line
+        offset = @lexer.offset + 1
         return unless c = try_tok(:const)
         var = Script::Variable.new(c.value)
-        if try_tok(:single_eq)
+        if tok = (try_tok(:colon) || try_tok(:single_eq))
           val = assert_expr(:concat)
+
+          if tok.type == :single_eq
+            val.context = :equals
+            val.options = @options
+            Script.equals_warning("mixin argument defaults", "$#{c.value}",
+              val.to_sass, false, line, offset, @options[:filename])
+          end
         elsif must_have_default
-          raise SyntaxError.new("Required argument #{var.inspect} must come before any optional arguments.", @line)
+          raise SyntaxError.new("Required argument #{var.inspect} must come before any optional arguments.")
         end
 
         return [[var, val]] unless try_tok(:comma)
@@ -166,46 +261,80 @@ END
       end
 
       def arglist
-        return unless e = concat
+        return unless e = interpolation
         return [e] unless try_tok(:comma)
         [e, *arglist]
       end
 
+      def raw
+        return special_fun unless tok = try_tok(:raw)
+        node(Script::String.new(tok.value))
+      end
+
+      def special_fun
+        return paren unless tok = try_tok(:special_fun)
+        first = node(Script::String.new(tok.value.first))
+        Haml::Util.enum_slice(tok.value[1..-1], 2).inject(first) do |l, (i, r)|
+          Script::Interpolation.new(
+            l, i, r && node(Script::String.new(r)),
+            false, false)
+        end
+      end
+
       def paren
         return variable unless try_tok(:lparen)
+        was_in_parens = @in_parens
+        @in_parens = true
         e = assert_expr(:expr)
         assert_tok(:rparen)
         return e
+      ensure
+        @in_parens = was_in_parens
       end
 
       def variable
         return string unless c = try_tok(:const)
-        Variable.new(c.value)
+        node(Variable.new(*c.value))
       end
 
       def string
-        return literal unless first = try_tok(:string)
+        return number unless first = try_tok(:string)
         return first.value unless try_tok(:begin_interpolation)
+        line = @lexer.line
         mid = parse_interpolated
         last = assert_expr(:string)
-        Operation.new(first.value, Operation.new(mid, last, :plus), :plus)
+        op = Operation.new(first.value, node(Operation.new(mid, last, :plus)), :plus)
+        op.line = line
+        op
+      end
+
+      def number
+        return literal unless tok = try_tok(:number)
+        num = tok.value
+        num.original = num.to_s unless @in_parens
+        num
       end
 
       def literal
-        (t = try_tok(:number, :color, :bool)) && (return t.value)
+        (t = try_tok(:color, :bool)) && (return t.value)
       end
 
       # It would be possible to have unified #assert and #try methods,
       # but detecting the method/token difference turns out to be quite expensive.
 
+      EXPR_NAMES = {
+        :string => "string",
+        :default => "expression (e.g. 1px, bold)",
+      }
+
       def assert_expr(name)
         (e = send(name)) && (return e)
-        raise Sass::SyntaxError.new("Expected expression, was #{@lexer.done? ? 'end of text' : "#{@lexer.peek.type} token"}.")
+        @lexer.expected!(EXPR_NAMES[name] || EXPR_NAMES[:default])
       end
 
       def assert_tok(*names)
         (t = try_tok(*names)) && (return t)
-        raise Sass::SyntaxError.new("Expected #{names.join(' or ')} token, was #{@lexer.done? ? 'end of text' : "#{@lexer.peek.type} token"}.")
+        @lexer.expected!(names.map {|tok| Lexer::TOKEN_NAMES[tok] || tok}.join(" or "))
       end
 
       def try_tok(*names)
@@ -215,7 +344,12 @@ END
 
       def assert_done
         return if @lexer.done?
-        raise Sass::SyntaxError.new("Unexpected #{@lexer.peek.type} token.")
+        @lexer.expected!(EXPR_NAMES[:default])
+      end
+
+      def node(node)
+        node.line = @lexer.line
+        node
       end
     end
   end