@rhinostone/swig-django 2.9.11 → 2.9.13

package/lib/filters.js

@@ -2,6 +2,15 @@ var utils = require('@rhinostone/swig-core/lib/utils'),
   dateFormatter = require('@rhinostone/swig-core/lib/dateformatter'),
   iterateFilter = require('@rhinostone/swig-core/lib/filters').iterateFilter;
 
+/*!
+ * Text of a filter input, as Django's stringfilter gives it: None for null, and for a
+ * variable that fails to resolve where Django reads it as None (if, for, firstof).
+ * @private
+ */
+function asText(input) {
+  return (input === undefined || input === null) ? 'None' : String(input);
+}
+
 /**
  * Django filter catalog.
  *
@@ -18,6 +27,10 @@ var utils = require('@rhinostone/swig-core/lib/utils'),
  *
  * Fidelity notes (cross-checked against Django 5.2 `defaultfilters.py`):
  *
+ * - **None.** The string filters read None, and a variable that fails to
+ *   resolve where Django reads it as None (`if`, `for`, `firstof`), as the
+ *   text None, as Django's `stringfilter` does. `escape`, `escapejs` and
+ *   `safe` keep the empty string of `{{ x }}`.
  * - **`.safe` vs Django `is_safe`.** Django's `is_safe=True` does NOT bypass
  *   autoescape — it only means the filter preserves an already-safe input.
  *   Only filters that Django wraps in `mark_safe()` (always returning trusted
@@ -121,7 +134,10 @@ function urlQuote(value, safe) {
 /**
  * Add the argument to the value. Numeric addition is tried first (Django's
  * `int(value) + int(arg)`); on failure it falls back to concatenation
- * (strings and arrays), then to the empty string.
+ * (strings and arrays), then to the empty string: a string and a number, a
+ * list or a mapping with anything but a list, and two mappings give the empty
+ * string, since Python cannot add them. A None or missing input or argument
+ * gives the empty string too.
  *
  * @example
  * {{ 4|add:2 }}
@@ -136,19 +152,30 @@ function urlQuote(value, safe) {
  * @return {*}
  */
 exports.add = function (input, arg) {
+  if (input === undefined || input === null || arg === undefined || arg === null) {
+    return '';
+  }
+  if (utils.isArray(input) && utils.isArray(arg)) {
+    return input.concat(arg);
+  }
+  // Python raises on a list or a mapping with anything else and on two mappings,
+  // and Django then gives an empty string.
+  if (typeof input === 'object' || typeof arg === 'object') {
+    return '';
+  }
+  // Python's int() reads a boolean as a number.
+  if (typeof input === 'boolean') { input = Number(input); }
+  if (typeof arg === 'boolean') { arg = Number(arg); }
   var a = parseInt(input, 10),
     b = parseInt(arg, 10);
   if (!isNaN(a) && !isNaN(b) && String(input).trim() === String(a) && String(arg).trim() === String(b)) {
     return a + b;
   }
-  if (utils.isArray(input) && utils.isArray(arg)) {
-    return input.concat(arg);
-  }
-  try {
-    return input + arg;
-  } catch (e) {
+  // Python's + raises on two different types.
+  if (typeof input !== typeof arg || (typeof input !== 'string' && typeof input !== 'number')) {
     return '';
   }
+  return input + arg;
 };
 
 /**
@@ -163,7 +190,7 @@ exports.add = function (input, arg) {
  * @return {string}
  */
 exports.addslashes = function (input) {
-  return String(input).replace(/\\/g, '\\\\').replace(/"/g, '\\"').replace(/'/g, "\\'");
+  return asText(input).replace(/\\/g, '\\\\').replace(/"/g, '\\"').replace(/'/g, "\\'");
 };
 
 /**
@@ -179,7 +206,7 @@ exports.addslashes = function (input) {
  * @return {string}
  */
 exports.capfirst = function (input) {
-  var s = String(input);
+  var s = asText(input);
   if (!s.length) {
     return s;
   }
@@ -200,7 +227,7 @@ exports.capfirst = function (input) {
  * @return {string}
  */
 exports.center = function (input, width) {
-  var s = String(input),
+  var s = asText(input),
     w = parseInt(width, 10),
     marg,
     left,
@@ -226,7 +253,7 @@ exports.center = function (input, width) {
  * @return {string}
  */
 exports.cut = function (input, arg) {
-  return String(input).split(String(arg)).join('');
+  return asText(input).split(String(arg)).join('');
 };
 
 /**
@@ -246,7 +273,7 @@ exports.cut = function (input, arg) {
  * @param  {string} [format='F j, Y']
  * @param  {number} [offset]  Timezone offset in minutes west of GMT.
  * @param  {string} [abbr]    Output timezone abbreviation.
- * @return {string}
+ * @return {string}           Formatted date string, or an empty string when the input is undefined, null or no date.
  */
 exports.date = function (input, format, offset, abbr) {
   var l,
@@ -263,6 +290,10 @@ exports.date = function (input, format, offset, abbr) {
   l = format.length;
   date = new dateFormatter.DateZ(input);
 
+  if (isNaN(date.dateZ.getTime())) {
+    return '';
+  }
+
   if (offset) {
     date.setTimezoneOffset(offset, abbr);
   }
@@ -565,7 +596,7 @@ exports.floatformat = function (input, arg) {
     a = utils.trimEnd(String(arg), 'gu');
     p = parseInt(a, 10);
     if (isNaN(p)) {
-      return String(input);
+      return (input === undefined || input === null) ? '' : String(input);
     }
   }
 
@@ -595,7 +626,7 @@ exports.floatformat = function (input, arg) {
  * @return {string}
  */
 exports.force_escape = function (input) {
-  return exports.escape(String(input));
+  return exports.escape(asText(input));
 };
 exports.force_escape.safe = true;
 
@@ -644,7 +675,7 @@ exports.get_digit = function (input, arg) {
  * @return {string}
  */
 exports.iriencode = function (input) {
-  var s = String(input),
+  var s = asText(input),
     out = '',
     i,
     c,
@@ -756,7 +787,7 @@ exports.length = function (input) {
  * @return {string}
  */
 exports.linebreaks = function (input) {
-  var paras = normalizeNewlines(input).split(/\n{2,}/);
+  var paras = normalizeNewlines(asText(input)).split(/\n{2,}/);
   return utils.map(paras, function (p) {
     return '<p>' + exports.escape(p).replace(/\n/g, '<br>') + '</p>';
   }).join('\n\n');
@@ -775,7 +806,7 @@ exports.linebreaks.safe = true;
  * @return {string}
  */
 exports.linebreaksbr = function (input) {
-  return exports.escape(normalizeNewlines(input)).replace(/\n/g, '<br>');
+  return exports.escape(normalizeNewlines(asText(input))).replace(/\n/g, '<br>');
 };
 exports.linebreaksbr.safe = true;
 
@@ -792,7 +823,7 @@ exports.linebreaksbr.safe = true;
  * @return {string}
  */
 exports.linenumbers = function (input) {
-  var lines = String(input).split('\n'),
+  var lines = asText(input).split('\n'),
     width = String(lines.length).length;
   return utils.map(lines, function (line, i) {
     var n = String(i + 1);
@@ -817,7 +848,7 @@ exports.linenumbers.safe = true;
  * @return {string}
  */
 exports.ljust = function (input, width) {
-  var s = String(input),
+  var s = asText(input),
     w = parseInt(width, 10);
   if (isNaN(w) || s.length >= w) {
     return s;
@@ -833,10 +864,13 @@ exports.ljust = function (input, width) {
  * {{ "SWIG"|lower }}
  * // => swig
  *
- * @param  {*} input
+ * @param  {*} input  None reads as the text None.
  * @return {*}
  */
 exports.lower = function (input) {
+  if (input === undefined || input === null) {
+    input = 'None';
+  }
   var out = iterateFilter.apply(exports.lower, arguments);
   if (out !== undefined) {
     return out;
@@ -856,7 +890,7 @@ exports.lower = function (input) {
  * @return {Array}
  */
 exports.make_list = function (input) {
-  return String(input).split('');
+  return asText(input).split('');
 };
 
 /**
@@ -876,7 +910,7 @@ exports.phone2numeric = function (input) {
     j: '5', k: '5', l: '5', m: '6', n: '6', o: '6', p: '7', q: '7', r: '7',
     s: '7', t: '8', u: '8', v: '8', w: '9', x: '9', y: '9', z: '9'
   };
-  return String(input).toLowerCase().replace(/[a-z]/g, function (c) {
+  return asText(input).toLowerCase().replace(/[a-z]/g, function (c) {
     return map[c];
   });
 };
@@ -971,7 +1005,7 @@ exports.pluralize = function (input, arg) {
  * @return {string}
  */
 exports.rjust = function (input, width) {
-  var s = String(input),
+  var s = asText(input),
     w = parseInt(width, 10);
   if (isNaN(w) || s.length >= w) {
     return s;
@@ -1051,7 +1085,7 @@ exports.slice = function (input, arg) {
  * @return {string}
  */
 exports.slugify = function (input) {
-  var value = String(input);
+  var value = asText(input);
   if (value.normalize) {
     value = value.normalize('NFKD').replace(/[\u0300-\u036f]/g, '');
   }
@@ -1077,7 +1111,7 @@ exports.striptags = function (input) {
   // after them (about 5 s for 100 000 characters); stripTags gives the same
   // output in linear time.
   // return String(input).replace(/(<([^>]+)>)/ig, '');
-  return utils.stripTags(String(input));
+  return utils.stripTags(asText(input));
 };
 
 /**
@@ -1111,7 +1145,7 @@ exports.time = function (input, format, offset, abbr) {
  * @return {string}
  */
 exports.title = function (input) {
-  return String(input).replace(/\w\S*/g, function (str) {
+  return asText(input).replace(/\w\S*/g, function (str) {
     return str.charAt(0).toUpperCase() + str.substr(1).toLowerCase();
   });
 };
@@ -1151,7 +1185,7 @@ function pyInt(arg) {
  * @return {string}
  */
 exports.truncatechars = function (input, arg) {
-  var s = String(input),
+  var s = asText(input),
     n = pyInt(arg);
   if (isNaN(n)) {
     return s;
@@ -1183,7 +1217,7 @@ exports.truncatewords = function (input, arg) {
   var n = pyInt(arg),
     words;
   if (isNaN(n)) {
-    return String(input);
+    return asText(input);
   }
   if (n <= 0) {
     return '';
@@ -1191,7 +1225,7 @@ exports.truncatewords = function (input, arg) {
   // A trailing \s+$ takes quadratic time on a long run of whitespace inside
   // the value; utils.strip gives the same output in linear time.
   // words = String(input).replace(/^\s+|\s+$/g, '').split(/\s+/);
-  words = utils.strip(String(input)).split(/\s+/);
+  words = utils.strip(asText(input)).split(/\s+/);
   if (words.length === 1 && words[0] === '') {
     return '';
   }
@@ -1209,10 +1243,13 @@ exports.truncatewords = function (input, arg) {
  * {{ "swig"|upper }}
  * // => SWIG
  *
- * @param  {*} input
+ * @param  {*} input  None reads as the text None.
  * @return {*}
  */
 exports.upper = function (input) {
+  if (input === undefined || input === null) {
+    input = 'None';
+  }
   var out = iterateFilter.apply(exports.upper, arguments);
   if (out !== undefined) {
     return out;
@@ -1235,7 +1272,7 @@ exports.upper = function (input) {
  */
 exports.urlencode = function (input, safe) {
   var safeChars = (safe === undefined || safe === null) ? '/' : String(safe);
-  return urlQuote(input, safeChars);
+  return urlQuote(asText(input), safeChars);
 };
 
 /**
@@ -1250,7 +1287,7 @@ exports.urlencode = function (input, safe) {
  * @return {number}
  */
 exports.wordcount = function (input) {
-  var m = String(input).match(/\S+/g);
+  var m = asText(input).match(/\S+/g);
   return m ? m.length : 0;
 };
 
@@ -1274,9 +1311,9 @@ exports.wordwrap = function (input, width) {
     i,
     word;
   if (isNaN(w) || w <= 0) {
-    return String(input);
+    return asText(input);
   }
-  words = String(input).split(/(\s+)/);
+  words = asText(input).split(/(\s+)/);
   lines = [];
   cur = '';
   for (i = 0; i < words.length; i += 1) {

package/lib/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rhinostone/swig-django",
-  "version": "2.9.11",
+  "version": "2.9.13",
   "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.11"
+    "@rhinostone/swig-core": "2.9.13"
   },
   "publishConfig": {
     "access": "public"