path: root/spec/parser_spec.rb

require "spec_helper"

describe "Parser" do
  let(:handlebars) { @context["Handlebars"] }

  before(:all) do
    @compiles = true
  end

  def root(&block)
    ASTBuilder.build do
      instance_eval(&block)
    end
  end

  def ast_for(string)
    ast = handlebars.parse(string)
    handlebars.print(ast)
  end

  class ASTBuilder
    def self.build(&block)
      ret = new
      ret.evaluate(&block)
      ret.out
    end

    attr_reader :out

    def initialize
      @padding = 0
      @out = ""
    end

    def evaluate(&block)
      instance_eval(&block)
    end

    def pad(string)
      @out << ("  " * @padding) + string + "\n"
    end

    def with_padding
      @padding += 1
      ret = yield
      @padding -= 1
      ret
    end

    def program
      pad("PROGRAM:")
      with_padding { yield }
    end

    def inverse
      pad("{{^}}")
      with_padding { yield }
    end

    def block
      pad("BLOCK:")
      with_padding { yield }
    end

    def inverted_block
      pad("INVERSE:")
      with_padding { yield }
    end

    def mustache(id, params = [], hash = nil)
      hash = " #{hash}" if hash
      pad("{{ #{id} [#{params.join(", ")}]#{hash} }}")
    end

    def partial(id, context = nil)
      content = id.dup
      content << " #{context}" if context
      pad("{{> #{content} }}")
    end

    def comment(comment)
      pad("{{! '#{comment}' }}")
    end

    def multiline_comment(comment)
      pad("{{! '\n#{comment}\n' }}")
    end

    def content(string)
      pad("CONTENT[ '#{string}' ]")
    end

    def string(string)
      string.inspect
    end

    def integer(string)
      "INTEGER{#{string}}"
    end

    def boolean(string)
      "BOOLEAN{#{string}}"
    end

    def hash(*pairs)
      "HASH{" + pairs.map {|k,v| "#{k}=#{v}" }.join(", ") + "}"
    end

    def id(id)
      "ID:#{id}"
    end

    def data(id)
      "@ID:#{id}"
    end

    def partial_name(name)
      "PARTIAL:#{name}"
    end

    def path(*parts)
      "PATH:#{parts.join("/")}"
    end
  end

  it "parses simple mustaches" do
    ast_for("{{foo}}").should == root { mustache id("foo") }
    ast_for("{{foo?}}").should == root { mustache id("foo?") }
    ast_for("{{foo_}}").should == root { mustache id("foo_") }
    ast_for("{{foo-}}").should == root { mustache id("foo-") }
    ast_for("{{foo:}}").should == root { mustache id("foo:") }
  end

  it "parses simple mustaches with data" do
    ast_for("{{@foo}}").should == root { mustache data("foo") }
  end

  it "parses mustaches with paths" do
    ast_for("{{foo/bar}}").should == root { mustache path("foo", "bar") }
  end

  it "parses mustaches with this/foo" do
    ast_for("{{this/foo}}").should == root { mustache id("foo") }
  end

  it "parses mustaches with - in a path" do
    ast_for("{{foo-bar}}").should == root { mustache id("foo-bar") }
  end

  it "parses mustaches with parameters" do
    ast_for("{{foo bar}}").should == root { mustache id("foo"), [id("bar")] }
  end

  it "parses mustaches with hash arguments" do
    ast_for("{{foo bar=baz}}").should == root do
      mustache id("foo"), [], hash(["bar", id("baz")])
    end

    ast_for("{{foo bar=1}}").should == root do
      mustache id("foo"), [], hash(["bar", integer("1")])
    end

    ast_for("{{foo bar=true}}").should == root do
      mustache id("foo"), [], hash(["bar", boolean("true")])
    end

    ast_for("{{foo bar=false}}").should == root do
      mustache id("foo"), [], hash(["bar", boolean("false")])
    end

    ast_for("{{foo bar=@baz}}").should == root do
      mustache id("foo"), [], hash(["bar", data("baz")])
    end

    ast_for("{{foo bar=baz bat=bam}}").should == root do
      mustache id("foo"), [], hash(["bar", "ID:baz"], ["bat", "ID:bam"])
    end

    ast_for("{{foo bar=baz bat=\"bam\"}}").should == root do
      mustache id("foo"), [], hash(["bar", "ID:baz"], ["bat", "\"bam\""])
    end

    ast_for("{{foo bat='bam'}}").should == root do
      mustache id("foo"), [], hash(["bat", "\"bam\""])
    end

    ast_for("{{foo omg bar=baz bat=\"bam\"}}").should == root do
      mustache id("foo"), [id("omg")], hash(["bar", id("baz")], ["bat", string("bam")])
    end

    ast_for("{{foo omg bar=baz bat=\"bam\" baz=1}}").should == root do
      mustache id("foo"), [id("omg")], hash(["bar", id("baz")], ["bat", string("bam")], ["baz", integer("1")])
    end

    ast_for("{{foo omg bar=baz bat=\"bam\" baz=true}}").should == root do
      mustache id("foo"), [id("omg")], hash(["bar", id("baz")], ["bat", string("bam")], ["baz", boolean("true")])
    end

    ast_for("{{foo omg bar=baz bat=\"bam\" baz=false}}").should == root do
      mustache id("foo"), [id("omg")], hash(["bar", id("baz")], ["bat", string("bam")], ["baz", boolean("false")])
    end
  end

  it "parses mustaches with string parameters" do
    ast_for("{{foo bar \"baz\" }}").should == root { mustache id("foo"), [id("bar"), string("baz")] }
  end

  it "parses mustaches with INTEGER parameters" do
    ast_for("{{foo 1}}").should == root { mustache id("foo"), [integer("1")] }
  end

  it "parses mustaches with BOOLEAN parameters" do
    ast_for("{{foo true}}").should == root { mustache id("foo"), [boolean("true")] }
    ast_for("{{foo false}}").should == root { mustache id("foo"), [boolean("false")] }
  end

  it "parses mutaches with DATA parameters" do
    ast_for("{{foo @bar}}").should == root { mustache id("foo"), [data("bar")] }
  end

  it "parses contents followed by a mustache" do
    ast_for("foo bar {{baz}}").should == root do
      content "foo bar "
      mustache id("baz")
    end
  end

  it "parses a partial" do
    ast_for("{{> foo }}").should == root { partial partial_name("foo") }
  end

  it "parses a partial with context" do
    ast_for("{{> foo bar}}").should == root { partial partial_name("foo"), id("bar") }
  end

  it "parses a partial with a complex name" do
    ast_for("{{> shared/partial?.bar}}").should == root { partial partial_name("shared/partial?.bar") }
  end

  it "parses a comment" do
    ast_for("{{! this is a comment }}").should == root do
      comment " this is a comment "
    end
  end

  it "parses a multi-line comment" do
    ast_for("{{!\nthis is a multi-line comment\n}}").should == root do
      multiline_comment "this is a multi-line comment"
    end
  end

  it "parses an inverse section" do
    ast_for("{{#foo}} bar {{^}} baz {{/foo}}").should == root do
      block do
        mustache id("foo")

        program do
          content " bar "
        end

        inverse do
          content " baz "
        end
      end
    end
  end

  it "parses an inverse ('else'-style) section" do
    ast_for("{{#foo}} bar {{else}} baz {{/foo}}").should == root do
      block do
        mustache id("foo")

        program do
          content " bar "
        end

        inverse do
          content " baz "
        end
      end
    end
  end

  it "parses empty blocks" do
    ast_for("{{#foo}}{{/foo}}").should == root do
      block do
        mustache id("foo")

        program do
          #  empty program
        end
      end
    end
  end

  it "parses empty blocks with empty inverse section" do
    ast_for("{{#foo}}{{^}}{{/foo}}").should == root do
      block do
        mustache id("foo")

        program do
          #  empty program
        end

        inverse do
          #  empty inverse
        end
      end
    end
  end

  it "parses empty blocks with empty inverse ('else'-style) section" do
    ast_for("{{#foo}}{{else}}{{/foo}}").should == root do
      block do
        mustache id("foo")

        program do
          #  empty program
        end

        inverse do
          #  empty inverse
        end
      end
    end
  end

  it "parses non-empty blocks with empty inverse section" do
    ast_for("{{#foo}} bar {{^}}{{/foo}}").should == root do
      block do
        mustache id("foo")

        program do
          content " bar "
        end

        inverse do
          #  empty inverse
        end
      end
    end
  end

  it "parses non-empty blocks with empty inverse ('else'-style) section" do
    ast_for("{{#foo}} bar {{else}}{{/foo}}").should == root do
      block do
        mustache id("foo")

        program do
          content " bar "
        end

        inverse do
          #  empty inverse
        end
      end
    end
  end

  it "parses empty blocks with non-empty inverse section" do
    ast_for("{{#foo}}{{^}} bar {{/foo}}").should == root do
      block do
        mustache id("foo")

        program do
          #  empty program
        end

        inverse do
          content " bar "
        end
      end
    end
  end

  it "parses empty blocks with non-empty inverse ('else'-style) section" do
    ast_for("{{#foo}}{{else}} bar {{/foo}}").should == root do
      block do
        mustache id("foo")

        program do
          #  empty program
        end

        inverse do
          content " bar "
        end
      end
    end
  end

  it "parses a standalone inverse section" do
    ast_for("{{^foo}}bar{{/foo}}").should == root do
      block do
        mustache id("foo")

        inverse do
          content "bar"
        end
      end
    end
  end

  it "raises if there's a Parse error" do
    lambda { ast_for("{{foo}") }.should   raise_error(V8::JSError, /Parse error on line 1/)
    lambda { ast_for("{{foo &}}")}.should raise_error(V8::JSError, /Parse error on line 1/)
    lambda { ast_for("{{#goodbyes}}{{/hellos}}") }.should raise_error(V8::JSError, /goodbyes doesn't match hellos/)
  end

  it "knows how to report the correct line number in errors" do
    lambda { ast_for("hello\nmy\n{{foo}") }.should     raise_error(V8::JSError, /Parse error on line 3/m)
    lambda { ast_for("hello\n\nmy\n\n{{foo}") }.should raise_error(V8::JSError, /Parse error on line 5/m)
  end

  it "knows how to report the correct line number in errors when the first character is a newline" do
    lambda { ast_for("\n\nhello\n\nmy\n\n{{foo}") }.should raise_error(V8::JSError, /Parse error on line 7/m)
  end

  context "externally compiled AST" do
    it "can pass through an already-compiled AST" do
      ast_for(@context.eval('new Handlebars.AST.ProgramNode([ new Handlebars.AST.ContentNode("Hello")]);')).should == root do
        content "Hello"
      end
    end
  end
end