@rhinostone/swig-django 2.9.13 → 2.11.0

package/README.md

@@ -24,8 +24,8 @@ var out = swig.render('Hello, {{ name|upper }}!', {
 // => Hello, WORLD!
 ```
 
-Supported surface (as of 2.7.0)
--------------------------------
+Supported surface
+-----------------
 
 Renders real Django templates — everything below was cross-checked against Django 5.2.
 
@@ -33,6 +33,8 @@ Renders real Django templates — everything below was cross-checked against Dja
 * **Variable resolution** — Django-faithful attribute / dictionary / index lookup. Callable attributes are auto-called (honoring `alters_data` / `do_not_call_in_templates`), numeric indexing works (`{{ list.0 }}`), and dicts iterate via `.keys` / `.values` / `.items`.
 * **Filter arguments** — Django colon syntax (`{{ value|date:"Y-m-d" }}`).
 * **Filters** — 42 built-ins (`add`, `addslashes`, `capfirst`, `center`, `cut`, `date`, `default`, `default_if_none`, `divisibleby`, `escape` / `e`, `escapejs`, `filesizeformat`, `first`, `floatformat`, `force_escape`, `get_digit`, `iriencode`, `join`, `last`, `length`, `linebreaks`, `linebreaksbr`, `linenumbers`, `ljust`, `lower`, `make_list`, `phone2numeric`, `pluralize`, `rjust`, `safe`, `slice`, `slugify`, `striptags`, `time`, `title`, `truncatechars`, `truncatewords`, `upper`, `urlencode`, `wordcount`, `wordwrap`, `yesno`). See `lib/filters.js` for the full list.
+* **Equality** — `==`, `!=` and `in` compare as Python does: a string never equals a number, and lists and mappings compare item by item.
+* **Unknown names** — a filter name the instance does not hold is a compile error wherever it stands, as in Django. Register custom filters before the compile that uses them.
 * **Async** — `renderFile(path, locals, cb)` against a loader with `async === true`, or `compileFile` with `codegenMode: 'async'`; `renderFileAsync` / `compileFileAsync` still work but are deprecated.
 
 Explicitly unsupported (parse-time throw or absent)

package/lib/index.js

@@ -32,7 +32,7 @@ exports.name = 'django';
  *
  * @type {String}
  */
-exports.version = "2.9.13";
+exports.version = "2.11.0";
 
 /**
  * Expression-level parser — Pratt-style recursive descent that consumes

package/lib/lexer.js

@@ -243,9 +243,9 @@ exports.types = TYPES;
 /**
  * Match the next token at the start of `str`.
  *
- * Throws via utils.throwError when no rule matches. The throw is opaque (no
- * line / file info); the Django frontend's onCompileError callback attaches
- * filename + line per the swig-core / frontend seam rule.
+ * Throws when no rule matches. This module does not know the line or the
+ * file, so the error is flagged `unplaced` and the Django frontend's
+ * `exports.parse` names them.
  *
  * @param  {string}     str Input slice starting at the unconsumed offset.
  * @return {LexerToken}     Matched token.
@@ -277,7 +277,9 @@ function reader(str) {
   });
 
   if (!matched) {
-    utils.throwError('Unexpected token "' + str.charAt(0) + '" in Django expression');
+    var err = new Error('Unexpected token "' + str.charAt(0) + '" in Django expression.');
+    err.unplaced = true;
+    throw err;
   }
 
   return matched;

package/lib/parser.js

@@ -5,6 +5,10 @@ var ir = require('@rhinostone/swig-core/lib/ir'),
 var lexer = require('./lexer');
 var _t = require('./tokentypes');
 
+// A catalog entry is read as an own property: a filter can be registered under
+// the name hasOwnProperty, and a name like toString is not a filter.
+var hasOwn = Object.prototype.hasOwnProperty;
+
 /**
  * Make a string safe for embedding into a regular expression.
  * @param  {string} str
@@ -21,6 +25,23 @@ function escapeRegExp(str) {
  */
 var _reserved = ['break', 'case', 'catch', 'continue', 'debugger', 'default', 'delete', 'do', 'else', 'finally', 'for', 'function', 'if', 'in', 'instanceof', 'new', 'return', 'switch', 'this', 'throw', 'try', 'typeof', 'var', 'void', 'while', 'with'];
 
+/**
+ * Build the IR of `left == right` or `left != right`, flagged so swig-core
+ * emits Python's equality (`_utils.pyEq`) instead of JavaScript's loose
+ * operators.
+ *
+ * @param  {string} op     `==` or `!=`.
+ * @param  {object} left   Left operand IR.
+ * @param  {object} right  Right operand IR.
+ * @return {object}        IRBinaryOp.
+ * @private
+ */
+function equality(op, left, right) {
+  var node = ir.binaryOp(op, left, right);
+  node.pyEq = 'django';
+  return node;
+}
+
 /**
  * Build the IR of `left in right`, or of `left not in right` when `negate`
  * is set: a BinaryOp `in` flagged with this flavor's name, so swig-core
@@ -154,9 +175,13 @@ exports.missingAsEmpty = function (expr) {
  * @param  {object}   [_posOut]  Optional out-param; final cursor stored on
  *                                `_posOut.pos` to let callers detect partial
  *                                consumption.
+ * @param  {object}   [_scope]   Set by `exports.parse`: the `line` and the
+ *                                `filename` an error names, and the instance's
+ *                                `extensions`, which make a filter name the
+ *                                catalog does not hold an error.
  * @return {object}              IRExpr tree.
  */
-exports.parseExpr = function (tokens, filters, _posOut) {
+exports.parseExpr = function (tokens, filters, _posOut, _scope) {
   var pos = 0;
   filters = filters || {};
 
@@ -173,7 +198,7 @@ exports.parseExpr = function (tokens, filters, _posOut) {
     return t;
   }
   function bail(msg) {
-    utils.throwError(msg);
+    utils.throwError(msg, _scope && _scope.line, _scope && _scope.filename);
   }
 
   function guardSegment(segment) {
@@ -406,7 +431,7 @@ exports.parseExpr = function (tokens, filters, _posOut) {
       } else if (tok.type === _t.FILTEREMPTY || tok.type === _t.FILTER) {
         consume();
         fname = tok.match;
-        if (filters.hasOwnProperty(fname) && typeof filters[fname] !== 'function') {
+        if (hasOwn.call(filters, fname) ? typeof filters[fname] !== 'function' : (_scope && _scope.extensions)) {
           bail('Invalid filter "' + fname + '"');
         }
         // Django colon-filter: an optional single positional argument
@@ -525,7 +550,11 @@ exports.parseExpr = function (tokens, filters, _posOut) {
         continue;
       }
       var right = parseExpression(info.prec + 1);
-      left = (info.op === 'in' || info.op === 'not in') ? membership(left, right, info.op === 'not in') : ir.binaryOp(info.op, left, right);
+      if (info.op === 'in' || info.op === 'not in') {
+        left = membership(left, right, info.op === 'not in');
+      } else {
+        left = (info.op === '==' || info.op === '!=') ? equality(info.op, left, right) : ir.binaryOp(info.op, left, right);
+      }
     }
     return left;
   }
@@ -590,6 +619,25 @@ exports.parse = function (swig, source, opts, tags, filters) {
   tags = tags || {};
   filters = filters || {};
 
+  // Where parseExpr is working, so that an expression error can name its line
+  // and file, and whether it has a catalog to check a filter name against (only
+  // an engine instance has). A tag gets a handle on this module whose parseExpr
+  // works in the same scope and on this parse's filter catalog.
+  var scope = { line: 0, filename: opts.filename, extensions: swig && swig.extensions };
+  var exprParser = Object.create(exports);
+  exprParser.parseExpr = function (tokens, _filters, posOut) {
+    return exports.parseExpr(tokens, filters, posOut, scope);
+  };
+
+  // The lexer does not know where it is working, so the place of its error is
+  // named here. An error from a nested parse has its place already.
+  function throwPlaced(err) {
+    if (err.unplaced) {
+      utils.throwError(err.message.slice(0, -1), scope.line, scope.filename);
+    }
+    throw err;
+  }
+
   var varControls = opts.varControls || ['{{', '}}'];
   var tagControls = opts.tagControls || ['{%', '%}'];
   var cmtControls = opts.cmtControls || ['{#', '#}'];
@@ -642,16 +690,22 @@ exports.parse = function (swig, source, opts, tags, filters) {
    * @private
    */
   function parseVariable(str, _line) {
-    var lexed = lexer.read(utils.strip(str));
+    scope.line = _line;
+    var lexed;
+    try {
+      lexed = lexer.read(utils.strip(str));
+    } catch (e) {
+      throwPlaced(e);
+    }
     var sawSafe = false;
     utils.each(lexed, function (tok) {
       if (tok.type === _t.FILTEREMPTY || tok.type === _t.FILTER) {
-        if (filters.hasOwnProperty(tok.match) && filters[tok.match].safe === true) {
+        if (hasOwn.call(filters, tok.match) && filters[tok.match].safe === true) {
           sawSafe = true;
         }
       }
     });
-    var expr = exports.missingAsEmpty(exports.parseExpr(lexed, filters));
+    var expr = exports.missingAsEmpty(exports.parseExpr(lexed, filters, undefined, scope));
     var tail;
     var esc = escapeStack[escapeStack.length - 1];
     if (esc && !sawSafe) {
@@ -734,7 +788,13 @@ exports.parse = function (swig, source, opts, tags, filters) {
       escape: escapeStack[escapeStack.length - 1]
     };
 
-    var ok = tag.parse(tagArgs, _line, exports, _t, stack, opts, swig, token);
+    scope.line = _line;
+    var ok;
+    try {
+      ok = tag.parse(tagArgs, _line, exprParser, _t, stack, opts, swig, token);
+    } catch (e) {
+      throwPlaced(e);
+    }
     if (!ok) {
       utils.throwError('Unexpected tag "' + tagName + '"', _line, opts.filename);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rhinostone/swig-django",
-  "version": "2.9.13",
+  "version": "2.11.0",
   "description": "Django-syntax frontend for the @rhinostone/swig-core template engine. Part of the @rhinostone/swig multi-flavor family.",
   "keywords": [
     "template",
@@ -22,7 +22,7 @@
     "node": ">=12"
   },
   "peerDependencies": {
-    "@rhinostone/swig-core": "2.9.13"
+    "@rhinostone/swig-core": "2.11.0"
   },
   "publishConfig": {
     "access": "public"