Better error reporting

mjackson · mjackson · commit eee8d695fcf6 · 2012-12-27T11:06:20.000-08:00
diff --git a/mustache.js b/mustache.js
@@ -380,48 +380,27 @@ var Mustache;
     var tree = [];
     var collector = tree;
     var sections = [];
-    var token, section;
 
-    for (var i = 0; i < tokens.length; ++i) {
+    var token;
+    for (var i = 0, len = tokens.length; i < len; ++i) {
       token = tokens[i];
-
       switch (token[0]) {
-      case "#":
-      case "^":
-        token[4] = [];
+      case '#':
+      case '^':
         sections.push(token);
         collector.push(token);
-        collector = token[4];
+        collector = token[4] = [];
         break;
-      case "/":
-        if (sections.length === 0) {
-          throw new Error("Unopened section: " + token[1]);
-        }
-
-        section = sections.pop();
-
-        if (section[1] !== token[1]) {
-          throw new Error("Unclosed section: " + section[1]);
-        }
-
-        if (sections.length > 0) {
-          collector = sections[sections.length - 1][4];
-        } else {
-          collector = tree;
-        }
+      case '/':
+        sections.pop();
+        var length = sections.length;
+        collector = length > 0 ? sections[length - 1][4] : tree;
         break;
       default:
         collector.push(token);
       }
     }
 
-    // Make sure there were no open sections when we're done.
-    section = sections.pop();
-
-    if (section) {
-      throw new Error("Unclosed section: " + section[1]);
-    }
-
     return tree;
   }
 
@@ -435,7 +414,7 @@ var Mustache;
     var token, lastToken;
     for (var i = 0, len = tokens.length; i < len; ++i) {
       token = tokens[i];
-      if (lastToken && lastToken[0] === "text" && token[0] === "text") {
+      if (token[0] === 'text' && lastToken && lastToken[0] === 'text') {
         lastToken[1] += token[1];
         lastToken[3] = token[3];
       } else {
@@ -448,10 +427,6 @@ var Mustache;
   }
 
   function escapeTags(tags) {
-    if (tags.length !== 2) {
-      throw new Error("Invalid tags: " + tags.join(" "));
-    }
-
     return [
       new RegExp(escapeRe(tags[0]) + "\\s*"),
       new RegExp("\\s*" + escapeRe(tags[1]))
@@ -468,9 +443,15 @@ var Mustache;
     template = template || '';
     tags = tags || exports.tags;
 
+    if (typeof tags === 'string') tags = tags.split(spaceRe);
+    if (tags.length !== 2) {
+      throw new Error('Invalid tags: ' + tags.join(', '));
+    }
+
     var tagRes = escapeTags(tags);
     var scanner = new Scanner(template);
 
+    var sections = [];     // Stack to hold section tokens
     var tokens = [];       // Buffer to hold the tokens
     var spaces = [];       // Indices of whitespace tokens on the current line
     var hasTag = false;    // Is there a {{tag}} on the current line?
@@ -492,7 +473,6 @@ var Mustache;
     }
 
     var start, type, value, chr;
-
     while (!scanner.eos()) {
       start = scanner.pos;
       value = scanner.scanUntil(tagRes[0]);
@@ -546,25 +526,48 @@ var Mustache;
 
       // Match the closing tag.
       if (!scanner.scan(tagRes[1])) {
-        throw new Error("Unclosed tag at " + scanner.pos);
+        throw new Error('Unclosed tag at ' + scanner.pos);
       }
 
-      tokens.push([type, value, start, scanner.pos]);
+      // Check section nesting.
+      if (type === '/') {
+        if (sections.length === 0) {
+          throw new Error('Unopened section "' + value + '" at ' + start);
+        }
 
-      if (type === "name" || type === "{" || type === "&") {
-        nonSpace = true;
+        var section = sections.pop();
+
+        if (section[1] !== value) {
+          throw new Error('Unclosed section "' + section[1] + '" at ' + start);
+        }
       }
 
-      // Set the tags for the next time around.
-      if (type === "=") {
+      var token = [type, value, start, scanner.pos];
+      tokens.push(token);
+
+      if (type === '#' || type === '^') {
+        sections.push(token);
+      } else if (type === "name" || type === "{" || type === "&") {
+        nonSpace = true;
+      } else if (type === "=") {
+        // Set the tags for the next time around.
         tags = value.split(spaceRe);
+
+        if (tags.length !== 2) {
+          throw new Error('Invalid tags at ' + start + ': ' + tags.join(', '));
+        }
+
         tagRes = escapeTags(tags);
       }
     }
 
-    tokens = squashTokens(tokens);
+    // Make sure there are no open sections when we're done.
+    var section = sections.pop();
+    if (section) {
+      throw new Error('Unclosed section "' + section[1] + '" at ' + scanner.pos);
+    }
 
-    return nestTokens(tokens);
+    return nestTokens(squashTokens(tokens));
   };
 
   // The high-level clearCache, compile, compilePartial, and render functions
diff --git a/test/parse-test.js b/test/parse-test.js
@@ -63,4 +63,44 @@ describe('Mustache.parse', function () {
     })(template, expectations[template]);
   }
 
+  describe('when there is an unclosed tag', function () {
+    it('throws an error', function () {
+      assert.throws(function () {
+        Mustache.parse('My name is {{name');
+      }, /unclosed tag at 17/i);
+    });
+  });
+
+  describe('when there is an unclosed section', function () {
+    it('throws an error', function () {
+      assert.throws(function () {
+        Mustache.parse('A list: {{#people}}{{name}}');
+      }, /unclosed section "people" at 27/i);
+    });
+  });
+
+  describe('when there is an unopened section', function () {
+    it('throws an error', function () {
+      assert.throws(function () {
+        Mustache.parse('The end of the list! {{/people}}');
+      }, /unopened section "people" at 21/i);
+    });
+  });
+
+  describe('when invalid tags are given as an argument', function () {
+    it('throws an error', function () {
+      assert.throws(function () {
+        Mustache.parse('A template <% name %>', [ '<%' ]);
+      }, /invalid tags/i);
+    });
+  });
+
+  describe('when the template contains invalid tags', function () {
+    it('throws an error', function () {
+      assert.throws(function () {
+        Mustache.parse('A template {{=<%=}}');
+      }, /invalid tags at 11/i);
+    });
+  });
+
 });
