handlebars.js/spec/partials.js

/*global CompilerContext, Handlebars, handlebarsEnv, shouldCompileTo, shouldCompileToWithPartials, shouldThrow */
describe('partials', function() {
  it('basic partials', function() {
    var string = 'Dudes: {{#dudes}}{{> dude}}{{/dudes}}';
    var partial = '{{name}} ({{url}}) ';
    var hash = {dudes: [{name: 'Yehuda', url: 'http://yehuda'}, {name: 'Alan', url: 'http://alan'}]};
    shouldCompileToWithPartials(string, [hash, {}, {dude: partial}], true, 'Dudes: Yehuda (http://yehuda) Alan (http://alan) ');
    shouldCompileToWithPartials(string, [hash, {}, {dude: partial},,false], true, 'Dudes: Yehuda (http://yehuda) Alan (http://alan) ');
  });

  it("partials with context", function() {
    var string = "Dudes: {{>dude dudes}}";
    var partial = "{{#this}}{{name}} ({{url}}) {{/this}}";
    var hash = {dudes: [{name: "Yehuda", url: "http://yehuda"}, {name: "Alan", url: "http://alan"}]};
    shouldCompileToWithPartials(string, [hash, {}, {dude: partial}], true, "Dudes: Yehuda (http://yehuda) Alan (http://alan) ",
                    "Partials can be passed a context");
  });

  it("partials with undefined context", function() {
    var string = "Dudes: {{>dude dudes}}";
    var partial = "{{foo}} Empty";
    var hash = {};
    shouldCompileToWithPartials(string, [hash, {}, {dude: partial}], true, "Dudes:  Empty");
  });

  it("partials with parameters", function() {
    var string = "Dudes: {{#dudes}}{{> dude others=..}}{{/dudes}}";
    var partial = "{{others.foo}}{{name}} ({{url}}) ";
    var hash = {foo: 'bar', dudes: [{name: "Yehuda", url: "http://yehuda"}, {name: "Alan", url: "http://alan"}]};
    shouldCompileToWithPartials(string, [hash, {}, {dude: partial}], true, "Dudes: barYehuda (http://yehuda) barAlan (http://alan) ",
                    "Basic partials output based on current context.");
  });

  it("partial in a partial", function() {
    var string = "Dudes: {{#dudes}}{{>dude}}{{/dudes}}";
    var dude = "{{name}} {{> url}} ";
    var url = "<a href='{{url}}'>{{url}}</a>";
    var hash = {dudes: [{name: "Yehuda", url: "http://yehuda"}, {name: "Alan", url: "http://alan"}]};
    shouldCompileToWithPartials(string, [hash, {}, {dude: dude, url: url}], true, "Dudes: Yehuda <a href='http://yehuda'>http://yehuda</a> Alan <a href='http://alan'>http://alan</a> ", "Partials are rendered inside of other partials");
  });

  it("rendering undefined partial throws an exception", function() {
    shouldThrow(function() {
        var template = CompilerContext.compile("{{> whatever}}");
        template();
    }, Handlebars.Exception, 'The partial whatever could not be found');
  });

  it("rendering template partial in vm mode throws an exception", function() {
    shouldThrow(function() {
      var template = CompilerContext.compile("{{> whatever}}");
      template();
    }, Handlebars.Exception, 'The partial whatever could not be found');
  });

  it("rendering function partial in vm mode", function() {
    var string = "Dudes: {{#dudes}}{{> dude}}{{/dudes}}";
    var partial = function(context) {
      return context.name + ' (' + context.url + ') ';
    };
    var hash = {dudes: [{name: "Yehuda", url: "http://yehuda"}, {name: "Alan", url: "http://alan"}]};
    shouldCompileTo(string, [hash, {}, {dude: partial}], "Dudes: Yehuda (http://yehuda) Alan (http://alan) ",
                    "Function partials output based in VM.");
  });

  it("GH-14: a partial preceding a selector", function() {
     var string = "Dudes: {{>dude}} {{another_dude}}";
     var dude = "{{name}}";
     var hash = {name:"Jeepers", another_dude:"Creepers"};
     shouldCompileToWithPartials(string, [hash, {}, {dude:dude}], true, "Dudes: Jeepers Creepers", "Regular selectors can follow a partial");
  });

  it("Partials with slash paths", function() {
    var string = "Dudes: {{> shared/dude}}";
    var dude = "{{name}}";
    var hash = {name:"Jeepers", another_dude:"Creepers"};
    shouldCompileToWithPartials(string, [hash, {}, {'shared/dude':dude}], true, "Dudes: Jeepers", "Partials can use literal paths");
  });

  it("Partials with slash and point paths", function() {
    var string = "Dudes: {{> shared/dude.thing}}";
    var dude = "{{name}}";
    var hash = {name:"Jeepers", another_dude:"Creepers"};
    shouldCompileToWithPartials(string, [hash, {}, {'shared/dude.thing':dude}], true, "Dudes: Jeepers", "Partials can use literal with points in paths");
  });

  it("Global Partials", function() {
    handlebarsEnv.registerPartial('global_test', '{{another_dude}}');

    var string = "Dudes: {{> shared/dude}} {{> global_test}}";
    var dude = "{{name}}";
    var hash = {name:"Jeepers", another_dude:"Creepers"};
    shouldCompileToWithPartials(string, [hash, {}, {'shared/dude':dude}], true, "Dudes: Jeepers Creepers", "Partials can use globals or passed");

    handlebarsEnv.unregisterPartial('global_test');
    equals(handlebarsEnv.partials.global_test, undefined);
  });

  it("Multiple partial registration", function() {
    handlebarsEnv.registerPartial({
      'shared/dude': '{{name}}',
      global_test: '{{another_dude}}'
    });

    var string = "Dudes: {{> shared/dude}} {{> global_test}}";
    var hash = {name:"Jeepers", another_dude:"Creepers"};
    shouldCompileToWithPartials(string, [hash], true, "Dudes: Jeepers Creepers", "Partials can use globals or passed");
  });

  it("Partials with integer path", function() {
    var string = "Dudes: {{> 404}}";
    var dude = "{{name}}";
    var hash = {name:"Jeepers", another_dude:"Creepers"};
    shouldCompileToWithPartials(string, [hash, {}, {404:dude}], true, "Dudes: Jeepers", "Partials can use literal paths");
  });

  it("Partials with complex path", function() {
    var string = "Dudes: {{> 404/asdf?.bar}}";
    var dude = "{{name}}";
    var hash = {name:"Jeepers", another_dude:"Creepers"};
    shouldCompileToWithPartials(string, [hash, {}, {'404/asdf?.bar':dude}], true, "Dudes: Jeepers", "Partials can use literal paths");
  });

  it("Partials with escaped", function() {
    var string = "Dudes: {{> [+404/asdf?.bar]}}";
    var dude = "{{name}}";
    var hash = {name:"Jeepers", another_dude:"Creepers"};
    shouldCompileToWithPartials(string, [hash, {}, {'+404/asdf?.bar':dude}], true, "Dudes: Jeepers", "Partials can use literal paths");
  });

  it("Partials with string", function() {
    var string = "Dudes: {{> \"+404/asdf?.bar\"}}";
    var dude = "{{name}}";
    var hash = {name:"Jeepers", another_dude:"Creepers"};
    shouldCompileToWithPartials(string, [hash, {}, {'+404/asdf?.bar':dude}], true, "Dudes: Jeepers", "Partials can use literal paths");
  });

  it('should handle empty partial', function() {
    var string = "Dudes: {{#dudes}}{{> dude}}{{/dudes}}";
    var partial = "";
    var hash = {dudes: [{name: "Yehuda", url: "http://yehuda"}, {name: "Alan", url: "http://alan"}]};
    shouldCompileToWithPartials(string, [hash, {}, {dude: partial}], true, "Dudes: ");
  });

  it("throw on missing partial", function() {
    var compile = handlebarsEnv.compile;
    handlebarsEnv.compile = undefined;
    shouldThrow(function() {
      shouldCompileTo('{{> dude}}', [{}, {}, {dude: 'fail'}], '');
    }, Error, /The partial dude could not be compiled/);
    handlebarsEnv.compile = compile;
  });

  describe('standalone partials', function() {
    it("indented partials", function() {
      var string = "Dudes:\n{{#dudes}}\n  {{>dude}}\n{{/dudes}}";
      var dude = "{{name}}\n";
      var hash = {dudes: [{name: "Yehuda", url: "http://yehuda"}, {name: "Alan", url: "http://alan"}]};
      shouldCompileToWithPartials(string, [hash, {}, {dude: dude}], true,
            "Dudes:\n  Yehuda\n  Alan\n");
    });
    it("nested indented partials", function() {
      var string = "Dudes:\n{{#dudes}}\n  {{>dude}}\n{{/dudes}}";
      var dude = "{{name}}\n {{> url}}";
      var url = "{{url}}!\n";
      var hash = {dudes: [{name: "Yehuda", url: "http://yehuda"}, {name: "Alan", url: "http://alan"}]};
      shouldCompileToWithPartials(string, [hash, {}, {dude: dude, url: url}], true,
            "Dudes:\n  Yehuda\n   http://yehuda!\n  Alan\n   http://alan!\n");
    });
    it("prevent nested indented partials", function() {
      var string = "Dudes:\n{{#dudes}}\n  {{>dude}}\n{{/dudes}}";
      var dude = "{{name}}\n {{> url}}";
      var url = "{{url}}!\n";
      var hash = {dudes: [{name: "Yehuda", url: "http://yehuda"}, {name: "Alan", url: "http://alan"}]};
      shouldCompileToWithPartials(string, [hash, {}, {dude: dude, url: url}, {preventIndent: true}], true,
            "Dudes:\n  Yehuda\n http://yehuda!\n  Alan\n http://alan!\n");
    });
  });

  describe('compat mode', function() {
    it('partials can access parents', function() {
      var string = 'Dudes: {{#dudes}}{{> dude}}{{/dudes}}';
      var partial = '{{name}} ({{url}}) {{root}} ';
      var hash = {root: 'yes', dudes: [{name: 'Yehuda', url: 'http://yehuda'}, {name: 'Alan', url: 'http://alan'}]};
      shouldCompileToWithPartials(string, [hash, {}, {dude: partial}, true], true, 'Dudes: Yehuda (http://yehuda) yes Alan (http://alan) yes ');
    });
    it('partials can access parents without data', function() {
      var string = 'Dudes: {{#dudes}}{{> dude}}{{/dudes}}';
      var partial = '{{name}} ({{url}}) {{root}} ';
      var hash = {root: 'yes', dudes: [{name: 'Yehuda', url: 'http://yehuda'}, {name: 'Alan', url: 'http://alan'}]};
      shouldCompileToWithPartials(string, [hash, {}, {dude: partial}, true, false], true, 'Dudes: Yehuda (http://yehuda) yes Alan (http://alan) yes ');
    });
    it('partials inherit compat', function() {
      var string = 'Dudes: {{> dude}}';
      var partial = '{{#dudes}}{{name}} ({{url}}) {{root}} {{/dudes}}';
      var hash = {root: 'yes', dudes: [{name: 'Yehuda', url: 'http://yehuda'}, {name: 'Alan', url: 'http://alan'}]};
      shouldCompileToWithPartials(string, [hash, {}, {dude: partial}, true], true, 'Dudes: Yehuda (http://yehuda) yes Alan (http://alan) yes ');
    });
  });
});