Abstracts combineString transformer

ptrdo · psylwester · commit cf0584c6ea5c · 2019-09-10T16:42:14.000-07:00
diff --git a/README.md b/README.md
@@ -208,13 +208,24 @@ By default, the value inserted for a token will be applied as the nodeValue of t
 
 | Modifer | Usage | Description |
 |----------|-----------|---------|
-| html | {{ html:value }} |  Insert value with innerHTML rather than nodeValue (e.g. escaped content, unicodes, html entities). |
-| concat | {{ concat:value }} | Concatenates value in-context to any adjacent content within the targeted attribute or node. |
-| forin | {{ forin:value }} | Iterates over every property found in the assumed object (see [object](/example/simple-javascript/object.html) example). |
-| boolean | {{ boolean:value }} | Inserts boolean per resolved truthiness of value (e.g. *checked="false"*, *disabled="true"*). |
+| html | `{{ html:token }}` |  Insert value with innerHTML rather than nodeValue (e.g. escaped content, unicodes, html entities). |
+| concat | `{{ concat:token }}` | Concatenates value in-context to any adjacent content within the targeted attribute or node. |
+| forin | `{{ forin:token }}` | Iterates over every property found in the assumed object (see [object](/example/simple-javascript/object.html) example). |
+| boolean | `{{ boolean:token }}` | Inserts boolean per resolved truthiness of value (e.g. *checked="false"*, *disabled="true"*, *class="true"*). |
 
 ***
 ### Transformers
+Transformers allow for modification of a value prior to insertion into the targeted location. This allows for performing logic on the data without embedding logic into the markup. The transformer function receive two arguments: the value and the index of the current iteration.
+
+| Transformer | Usage | Description |
+|----------|-----------|---------|
+| join | `{{ join:token }}` |  Inserts comma-delineated string concatenating an assumed array of values. |
+| toLocaleString | `{{ toLocaleString:token }}` |  Inserts commas into large numbers (e.g. 1234567.890 becomes 1,234,567.89). |
+| parseDateToTimeValue | `{{ parseDateToTimeValue:token }}` |  Inserts a time value parsed from an assumed standard date string. |
+| toMebibytes | `{{ toMebibytes:token }}` |  Converts bytes to mebibytes. (e.g. 1048576 becomes "1.00"). |
+| exists | `{{ exists:token }}` |  Inserts `true` or `false` if value exists (e.g. as a CSS class name to denote visibility). |
+| absent | `{{ absent:token }}` |  Inserts `true` or `false` if value does not exist (the obverse of `exists`). |
+| combineString | `{{ combineString:('foo',token1,'bar',token2,…) }}` | Combines arbitrary strings and/or token values (e.g. to construct an URL). |
 
 ***
 ### Public API
diff --git a/example/simple-javascript/transformer.html b/example/simple-javascript/transformer.html
@@ -42,7 +42,7 @@
   <article>
     <section>
       <blockquote itemscope itemid="{{ id }}" itemtype="https://schema.org/UserTweets" hidden>
-        <h5 itemprop="screen_name">@{{ concat:user.screen_name }} tweeted:</h5>
+        <h5 itemprop="screen_name">{{ concat:combineString:("@", user.screen_name, " tweeted from ", user.location) }}:</h5>
         <p itemprop="text">{{ text }}</p>
         <time itemprop="created_at" datetime="{{ parseDateToTimeValue:created_at }}">{{ formatDate:created_at }}</time>
       </blockquote>
diff --git a/lib/microdata-template.js b/lib/microdata-template.js
@@ -113,6 +113,7 @@
    * @private static
    * @property proxy will match the token-identifying wrapper (e.g. the "{{ info }}" of <span>{{ info }}</span>).
    * @property notation will match any string that appears to be dot syntax (e.g. "{{ someObject.someProperty }}").
+   * @property address will match object address of dot or bracket syntax (e.g. foo.bar and foo[bar] and foo[bar][too]).
    * @property expression will match any prefix to the token value (e.g. "{{ parseDateToTimeValue:someDateString }}").
    * @property expressionsplit separates transforms applied progressively (e.g. "{{ thenDoThis:doThis:someValue }}").
    * @property orsplit separates tokens progressively considered for value (e.g. "{{ perhaps|maybe|probably|definitely }}").
@@ -121,6 +122,7 @@
   var PATTERN = {
     proxy: /{{\s*\b(.*)\s* }}/,
     notation: /[\.\[\]]+/,
+    address: /(\w+(\.\w+)+)|(\w+(\[\w+\])+)/,
     expression: /^(.*)\:(?=[^:]*$)(.*)/,
     expressionsplit: /\:/,
     orsplit: /\|/,
@@ -137,12 +139,11 @@
    * @private extendable
    * "{{ join:value }} inserts a comma-delineated string concatenating an assumed array of values.
    * "{{ toLocaleString:value }}" inserts commas into large numbers (e.g. 1234567.890 becomes 1,234,567.89).
-   * "{{ parseDateToTimeValue:value }}" inserts the time value parsed from a standard date string.
+   * "{{ parseDateToTimeValue:value }}" inserts the time value parsed from an assumed standard date string.
    * "{{ toMebibytes:value }}" converts bytes to mebibytes. (e.g. 1048576 becomes "1.00").
    * "{{ exists:value }}" inserts "true" or "false" if value exists (e.g. as a CSS class name to denote visibility).
-   * "{{ absent:value }}" inserts "true" or "false" if value does not exist (e.g. as a CSS class name to denote visibility).
-   * "{{ combineString:(value1, value2,...) }}" for combining strings and attributes to one string value.
-   *                                            Input param can either be string literal or property name of the data model.
+   * "{{ absent:value }}" inserts "true" or "false" if value does not exist (the obverse of exists).
+   * "{{ combineString:('abc', token1, '123', token2...) }}" combines arbitrary strings and/or token values.
    */
   var TRANSFORMER = {
     join: function (value, index) {
@@ -166,13 +167,11 @@
     },
     combineString: function (values, index) {
       var result = "";
-
       if (values) {
         values.forEach(function (value) {
           result += value;
         })
       }
-
       return result;
     }
   };
@@ -241,7 +240,7 @@
 
   var parseDotNotation = function (obj, notation) {
     /* TODO: return [obj].concat(notation.split(".")).reduce(function(parent, child){ return !!parent && child in parent ? parent[child] : null; }); */
-    var address = notation.split(PATTERN.notation);
+    var address = notation.split(/\.|\[|\]\[|\]/).filter(function(item){ return item.length > 0; }); // (PATTERN.notation);
     while (address.length > 0 && !!obj) {
       var index, property = address.shift();
       if (Array.isArray(obj)) {
@@ -345,7 +344,22 @@
                 return alt in datum;
               })[0];
             }
-            if (notation) {
+            if (/\(/.test(proxy[0])) {
+              // this is a parenthetical, e/g combineString:(foo,bar) 
+              value = [];
+              var params = proxy.replace(/[\(\)]/g, "");
+              params = params.split(",");
+              params.forEach(function (param) {
+                param = param.trim();
+                if (PATTERN.address.test(param)) {
+                  value.push(parseDotNotation(datum, param));
+                } else if (datum.hasOwnProperty(param)) {
+                  value.push(datum[param]);
+                } else {
+                  value.push(param.replace(/[\'\"]/g, ""));
+                }
+              });
+            } else if (notation) {
               value = parseDotNotation(datum, proxy);
             } else {
               value
@@ -396,18 +410,23 @@
                     return alt in datum;
                   })[0];
                 }
-                if (notation) {
-                  value = parseDotNotation(datum, proxy);
-                } else if (!!proxy && proxy[0] == '(') {
+                if (/\(/.test(proxy[0])) {
+                  // this is a parenthetical, e/g combineString:(foo,bar) 
                   value = [];
-                  //remove brackets like ( and )
                   var params = proxy.replace(/[\(\)]/g, "");
                   params = params.split(",");
                   params.forEach(function (param) {
                     param = param.trim();
-                    value.push(datum.hasOwnProperty(param) ? datum[param] : param.replace(/[\'\"]/g, ""));
+                    if (PATTERN.address.test(param)) {
+                      value.push(parseDotNotation(datum, param));
+                    } else if (datum.hasOwnProperty(param)) {
+                      value.push(datum[param]);
+                    } else {
+                      value.push(param.replace(/[\'\"]/g, ""));
+                    }
                   });
-
+                } else if (notation) {
+                  value = parseDotNotation(datum, proxy);
                 } else {
                   value
                       = proxy === TOKEN.index ? i
