@xeplr/expression-handler 2.1.0 → 2.2.0

package/README.md

@@ -171,7 +171,7 @@ const f = xf.compile('sumif(fytd(order_date), revenue)', {
 | `fiscalYearStart` | `4` (April) | `fytd` and any financial-year function |
 | `today` | now | `ytd`, `fytd` — pin it for tests and scheduled runs |
 | `missing` | `'null'` | `'error'` makes a name the row lacks an error |
-| `ignoreCase` | `false` | `true` makes `=`, `!=`, `in` and the text operators (`contains`, `startsWith`, `endsWith`, `notIn`, …) ignore case. Numbers and null compare exactly as before. BI's report formulas set it, so a formula and the SQL it is translated into agree whatever the database's collation; Workflow's conditions leave it off |
+| `ignoreCase` | `false` | `true` makes `=`, `!=`, `in`, the text operators (`contains`, `startsWith`, `endsWith`, `notIn`, …) and the functions `contains()`, `startsWith()`, `endsWith()` ignore case. Numbers and null compare exactly as before. BI's report formulas set it, so a formula and the SQL it is translated into agree whatever the database's collation; Workflow's conditions leave it off |
 | `maxListItems` · `maxDistinct` · `maxSteps` · `maxLevels` | see [Limits](#limits) | |
 | `aggregate(name, args, { compile, level })` | none | supplies the rows for the group form of a total (BI) |
 

package/lib/compile.js

@@ -50,7 +50,7 @@ function compileTree(tree, options) {
   var fy = Number(opts.fiscalYearStart);
   if (!(fy >= 1 && fy <= 12 && Math.floor(fy) === fy)) fail('fiscalYearStart must be a month, 1–12');
 
-  var ctx = { now: dates.todayFor(opts), fiscalYearStart: fy };
+  var ctx = { now: dates.todayFor(opts), fiscalYearStart: fy, ignoreCase: Boolean(opts.ignoreCase) };
   // Equality for `=`, `in` and the word operators: exact, or folded when the
   // caller asked (opts.ignoreCase) — see operators.IGNORE_CASE.
   var eq = opts.ignoreCase ? operators.looseEqIgnoreCase : operators.looseEq;

package/lib/functions.js

@@ -28,6 +28,9 @@ var asDate = dates.asDate;
 
 var CATEGORIES = ['Math', 'Text', 'Date', 'Logic', 'Aggregate'];
 
+// Text for a comparison: lower-cased when the formula ignores case.
+function fold(c, v) { var s = str(v); return c && c.ignoreCase ? s.toLowerCase() : s; }
+
 function str(v) { return v === null || v === undefined ? '' : String(v); }
 function num(v) { var n = Number(v); return isNaN(n) ? null : n; }
 function isEmpty(v) { return v === null || v === undefined || v === ''; }
@@ -121,15 +124,17 @@ var LIST = [
   { name: 'replace', category: 'Text', args: 'text, find, replace with', min: 3, max: 3,
     description: 'Swap one piece of text for another', example: 'replace(phone, "-", "")',
     fn: function (v, find, into) { return str(v).split(str(find)).join(str(into)); } },
-  { name: 'contains', category: 'Text', args: 'text, find', min: 2, max: 2,
+  // context: the compile option ignoreCase folds both sides, as it does for
+  // = and in — one rule for every text comparison in a formula.
+  { name: 'contains', category: 'Text', args: 'text, find', min: 2, max: 2, context: true,
     description: 'True when the text contains it', example: 'contains(notes, "urgent")',
-    fn: function (v, sub) { return str(v).indexOf(str(sub)) !== -1; } },
-  { name: 'startsWith', category: 'Text', args: 'text, find', min: 2, max: 2,
+    fn: function (c, v, sub) { return fold(c, v).indexOf(fold(c, sub)) !== -1; } },
+  { name: 'startsWith', category: 'Text', args: 'text, find', min: 2, max: 2, context: true,
     description: 'True when the text begins with it', example: 'startsWith(sku, "IN")',
-    fn: function (v, sub) { return str(v).startsWith(str(sub)); } },
-  { name: 'endsWith', category: 'Text', args: 'text, find', min: 2, max: 2,
+    fn: function (c, v, sub) { return fold(c, v).startsWith(fold(c, sub)); } },
+  { name: 'endsWith', category: 'Text', args: 'text, find', min: 2, max: 2, context: true,
     description: 'True when the text ends with it', example: 'endsWith(file, ".pdf")',
-    fn: function (v, sub) { return str(v).endsWith(str(sub)); } },
+    fn: function (c, v, sub) { return fold(c, v).endsWith(fold(c, sub)); } },
   { name: 'length', category: 'Text', args: 'text', min: 1, max: 1,
     description: 'How many characters', example: 'length(name)',
     fn: function (v) { return Array.isArray(v) ? v.length : str(v).length; } },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xeplr/expression-handler",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "The one formula engine for xeplr: its own parser (no eval, no dependencies), one function list, compiled-once formulas, totals over lists, AND/OR conditions. Runs in Node and the browser.",
   "main": "index.js",
   "files": [