250 with recursion limiter

core/lib/list_item_hunter.js

@@ -12,119 +12,97 @@
 
 var list_item_hunter = function () {
 
-  var extend = require('util')._extend,
-    JSON5 = require('json5'),
+  var JSON5 = require('json5'),
     pa = require('./pattern_assembler'),
-    smh = require('./style_modifier_hunter'),
     pattern_assembler = new pa(),
-    style_modifier_hunter = new smh(),
     items = [ 'zero', 'one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine', 'ten', 'eleven', 'twelve', 'thirteen', 'fourteen', 'fifteen', 'sixteen', 'seventeen', 'eighteen', 'nineteen', 'twenty'];
 
+  function getListItemIterationKeys() {
+    return items;
+  }
+
   function processListItemPartials(pattern, patternlab) {
+
     //find any listitem blocks
-    var matches = pattern_assembler.find_list_items(pattern, patternlab);
-    if (matches !== null) {
-      matches.forEach(function (liMatch) {
+    var liMatches = pattern_assembler.find_list_items(pattern.extendedTemplate, patternlab);
+    if (liMatches !== null) {
+
+      if (pattern.listitemsRaw) {
+
+        //copy, don't reference
+        try {
+          pattern.listitems = JSON5.parse(JSON5.stringify(pattern.listitemsRaw));
+        } catch (err) {
+          console.log('There was an error parsing JSON for ' + pattern.abspath);
+          console.log(err);
+        }
+
+      //if no local listitems.json file, use global listitems data
+      } else {
+
+        //copy, don't reference
+        try {
+          pattern.listitems = JSON5.parse(JSON5.stringify(patternlab.listitems));
+          pattern.listitemsRaw = JSON5.parse(JSON5.stringify(patternlab.listitems));
+        } catch (err) {
+          console.log('There was an error parsing JSON for ' + pattern.abspath);
+          console.log(err);
+        }
+      }
+
+      //this shuffles listitemsRaw, and builds it into an object of array of
+      //objects and saves that in listitems
+      pattern_assembler.combine_listItems(pattern);
+
+      for (var i = 0; i < liMatches.length; i++) {
 
         if (patternlab.config.debug) {
-          console.log('found listItem of size ' + liMatch + ' inside ' + pattern.key);
+          console.log('found listItem of size ' + liMatches[i] + ' inside ' + pattern.key);
         }
 
         //find the boundaries of the block
-        var loopNumberString = liMatch.split('.')[1].split('}')[0].trim();
-        var end = liMatch.replace('#', '/');
-        var patternBlock = pattern.template.substring(pattern.template.indexOf(liMatch) + liMatch.length, pattern.template.indexOf(end)).trim();
+        var loopNumberString = liMatches[i].split('.')[1].split('}')[0].trim();
+        var end = liMatches[i].replace('#', '/');
+        var patternBlock = pattern.extendedTemplate.substring(pattern.extendedTemplate.indexOf(liMatches[i]) + liMatches[i].length, pattern.extendedTemplate.indexOf(end)).trim();
 
         //build arrays that repeat the block, however large we need to
         var repeatedBlockTemplate = [];
         var repeatedBlockHtml = '';
-        var i; // for loops
+        var j; // for loops
 
-        for (i = 0; i < items.indexOf(loopNumberString); i++) {
+        for (j = 0; j < items.indexOf(loopNumberString); j++) {
           repeatedBlockTemplate.push(patternBlock);
         }
 
-        //check for a local listitems.json file
-        var listData;
-        try {
-          listData = JSON5.parse(JSON5.stringify(patternlab.listitems));
-        } catch (err) {
-          console.log('There was an error parsing JSON for ' + pattern.abspath);
-          console.log(err);
-        }
-        listData = pattern_assembler.merge_data(listData, pattern.listitems);
-
-        //iterate over each copied block, rendering its contents along with pattenlab.listitems[i]
-        for (i = 0; i < repeatedBlockTemplate.length; i++) {
-          var thisBlockTemplate = repeatedBlockTemplate[i];
+        //iterate over each copied block, rendering its contents along with pattenlab.listitems[j]
+        for (j = 0; j < repeatedBlockTemplate.length; j++) {
           var thisBlockHTML = "";
+          var itemData = pattern.listitems['' + items.indexOf(loopNumberString)]; //this is a property like "2"
+          var patternData = pattern.jsonFileData;
+          var allData = pattern_assembler.merge_data(patternData, itemData !== undefined ? itemData[j] : {}); //itemData could be undefined if the listblock contains no partial, just markup
 
-          //combine listItem data with pattern data with global data
-          var itemData = listData['' + items.indexOf(loopNumberString)]; //this is a property like "2"
-          var globalData;
-          var localData;
-          try {
-            globalData = JSON5.parse(JSON5.stringify(patternlab.data));
-            localData = JSON5.parse(JSON5.stringify(pattern.jsonFileData));
-          } catch (err) {
-            console.log('There was an error parsing JSON for ' + pattern.abspath);
-            console.log(err);
-          }
-
-          var allData = pattern_assembler.merge_data(globalData, localData);
-          allData = pattern_assembler.merge_data(allData, itemData !== undefined ? itemData[i] : {}); //itemData could be undefined if the listblock contains no partial, just markup
-          allData.link = extend({}, patternlab.data.link);
-
-          //check for partials within the repeated block
-          var foundPartials = pattern_assembler.find_pattern_partials({ 'template' : thisBlockTemplate });
-
-          if (foundPartials && foundPartials.length > 0) {
-            for (var j = 0; j < foundPartials.length; j++) {
-              //get the partial
-              var partialName = foundPartials[j].match(/([\w\-\.\/~]+)/g)[0];
-              var partialPattern = pattern_assembler.get_pattern_by_key(partialName, patternlab);
-
-              //create a copy of the partial so as to not pollute it after the get_pattern_by_key call.
-              var cleanPartialPattern;
-              try {
-                cleanPartialPattern = JSON5.parse(JSON5.stringify(partialPattern));
-              } catch (err) {
-                console.log('There was an error parsing JSON for ' + pattern.abspath);
-                console.log(err);
-              }
-
-              //if partial has style modifier data, replace the styleModifier value
-              if (foundPartials[j].indexOf(':') > -1) {
-                style_modifier_hunter.consume_style_modifier(cleanPartialPattern, foundPartials[j], patternlab);
-              }
-
-              //replace its reference within the block with the extended template
-              thisBlockTemplate = thisBlockTemplate.replace(foundPartials[j], cleanPartialPattern.extendedTemplate);
-            }
-
-            //render with data
-            thisBlockHTML = pattern_assembler.renderPattern(thisBlockTemplate, allData, patternlab.partials);
-          } else {
-            //just render with mergedData
-            thisBlockHTML = pattern_assembler.renderPattern(thisBlockTemplate, allData, patternlab.partials);
-          }
+
+          thisBlockHTML = pattern_assembler.renderPattern(patternBlock, allData);
 
           //add the rendered HTML to our string
           repeatedBlockHtml = repeatedBlockHtml + thisBlockHTML;
+
+          //unset the allData reference to free up memory
+          allData = null;
         }
 
         //replace the block with our generated HTML
-        var repeatingBlock = pattern.extendedTemplate.substring(pattern.extendedTemplate.indexOf(liMatch), pattern.extendedTemplate.indexOf(end) + end.length);
+        var repeatingBlock = pattern.extendedTemplate.substring(pattern.extendedTemplate.indexOf(liMatches[i]), pattern.extendedTemplate.indexOf(end) + end.length);
         pattern.extendedTemplate = pattern.extendedTemplate.replace(repeatingBlock, repeatedBlockHtml);
 
-        //update the extendedTemplate in the partials object in case this pattern is consumed later
-        patternlab.partials[pattern.key] = pattern.extendedTemplate;
-
-      });
+      }
     }
   }
 
   return {
+    get_list_item_iteration_keys: function () {
+      return getListItemIterationKeys();
+    },
     process_list_item_partials: function (pattern, patternlab) {
       processListItemPartials(pattern, patternlab);
     }

core/lib/parameter_hunter.js

@@ -12,8 +12,7 @@
 
 var parameter_hunter = function () {
 
-  var extend = require('util')._extend,
-    JSON5 = require('json5'),
+  var JSON5 = require('json5'),
     pa = require('./pattern_assembler'),
     smh = require('./style_modifier_hunter'),
     pattern_assembler = new pa(),
@@ -159,7 +158,7 @@ var parameter_hunter = function () {
         values.push(paramString.match(regex)[0].trim());
 
         //truncate the beginning from paramString and continue either
-        //looking for a key, or returning 
+        //looking for a key, or returning
         paramString = paramString.replace(regex, '').trim();
 
         //exit do while if the final char is '}'
@@ -241,67 +240,97 @@ var parameter_hunter = function () {
     return paramStringWellFormed;
   }
 
-  function findparameters(pattern, patternlab) {
+  function findparameters(pattern, patternlab, parameteredPartials) {
+    var uniquePartials = [];
 
-    if (pattern.parameteredPartials && pattern.parameteredPartials.length > 0) {
+    for (var i = 0; i < parameteredPartials.length; i++) {
 
-      //compile this partial immeadiately, essentially consuming it.
-      pattern.parameteredPartials.forEach(function (pMatch) {
-        //find the partial's name and retrieve it
-        var partialName = pMatch.match(/([\w\-\.\/~]+)/g)[0];
-        var partialPattern = pattern_assembler.get_pattern_by_key(partialName, patternlab);
+      //limit iteration to one time per partial. eliminate duplicates.
+      if (uniquePartials.indexOf(parameteredPartials[i]) === -1) {
+        uniquePartials.push(parameteredPartials[i]);
+      } else {
+        continue;
+      }
 
-        //if we retrieved a pattern we should make sure that its extendedTemplate is reset. looks to fix #190
-        partialPattern.extendedTemplate = partialPattern.template;
+      //find the partial's name and retrieve it
+      var partialName = parameteredPartials[i].match(/([\w\-\.\/~]+)/g)[0];
+      var partialPattern = pattern_assembler.get_pattern_by_key(partialName, patternlab);
 
-        if (patternlab.config.debug) {
-          console.log('found patternParameters for ' + partialName);
-        }
+      if (!partialPattern) {
+        throw ('Could not find pattern with key ' + partialName);
+      }
 
-        //strip out the additional data, convert string to JSON.
-        var leftParen = pMatch.indexOf('(');
-        var rightParen = pMatch.lastIndexOf(')');
-        var paramString = '{' + pMatch.substring(leftParen + 1, rightParen) + '}';
-        var paramStringWellFormed = paramToJson(paramString);
-
-        var paramData = {};
-        var globalData = {};
-        var localData = {};
-
-        try {
-          paramData = JSON5.parse(paramStringWellFormed);
-          globalData = JSON5.parse(JSON5.stringify(patternlab.data));
-          localData = JSON5.parse(JSON5.stringify(pattern.jsonFileData || {}));
-        } catch (err) {
-          console.log('There was an error parsing JSON for ' + pattern.abspath);
-          console.log(err);
-        }
+      //if we retrieved a pattern we should make sure that its tmpTemplate is reset. looks to fix #190
+      partialPattern.tmpTemplate = partialPattern.escapedTemplate;
 
-        var allData = pattern_assembler.merge_data(globalData, localData);
-        allData = pattern_assembler.merge_data(allData, paramData);
+      if (patternlab.config.debug) {
+        console.log('found patternParameters for ' + partialName);
+      }
 
-        //if partial has style modifier data, replace the styleModifier value
-        if (pattern.stylePartials && pattern.stylePartials.length > 0) {
-          style_modifier_hunter.consume_style_modifier(partialPattern, pMatch, patternlab);
+      //if the current tag has styleModifier data, replace the styleModifier value in the partial
+      //do this before rendering parametered tags
+      if (pattern_assembler.find_pattern_partials_with_style_modifiers(parameteredPartials[i])) {
+        style_modifier_hunter.consume_style_modifier(partialPattern, parameteredPartials[i], patternlab);
+      }
+
+      //strip out the additional data, convert string to JSON
+      var leftParen = parameteredPartials[i].indexOf('(');
+      var rightParen = parameteredPartials[i].lastIndexOf(')');
+      var paramString = '{' + parameteredPartials[i].substring(leftParen + 1, rightParen) + '}';
+      var paramStringWellFormed = paramToJson(paramString);
+
+      var paramData = {};
+      try {
+        paramData = JSON5.parse(paramStringWellFormed);
+      } catch (e) {
+        console.log(e);
+      }
+
+      var regex;
+      var escapedKey;
+      for (var j in paramData) {
+        if (paramData.hasOwnProperty(j) && (typeof paramData[j] === 'boolean' || typeof paramData[j] === 'number' || typeof paramData[j] === 'string')) {
+          //escape regex special characters as per https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#Using_special_characters
+          escapedKey = j.replace(/[.*+?^${}()|[\]\\\/]/g, '\\$&');
+
+          //apply replacement based on allowable characters from lines 78 and 79 of mustache.js
+          //of the Mustache for JS project.
+          regex = new RegExp('\\{\\{([\\{#\\^\\/&]?\\s*' + escapedKey + '\\s*\\}?)\\}\\}', 'g');
+
+          //since ERB is already used for escaping in partialPattern.escapedTemplate,
+          //using <%% %%> as escaping tags.
+          partialPattern.tmpTemplate = partialPattern.tmpTemplate.replace(regex, '<%%$1%%>');
+          regex = new RegExp('<%([\\{#\\^\\/&]?\\s*' + escapedKey + '\\s*\\}?)%>', 'g');
+          partialPattern.tmpTemplate = partialPattern.tmpTemplate.replace(regex, '<%%$1%%>');
+
+          //when using alternate delimiters, triple-Mustache syntax won't work.
+          //<%{ must be replaced with <%# and }%> with %>.
+          partialPattern.tmpTemplate = partialPattern.tmpTemplate.replace(/<%%\{/g, '<%%&');
+          partialPattern.tmpTemplate = partialPattern.tmpTemplate.replace(/\}%%>/g, '%%>');
         }
+      }
 
-        //extend pattern data links into link for pattern link shortcuts to work. we do this locally and globally
-        allData.link = extend({}, patternlab.data.link);
+      //then set the new delimiter at the beginning of the extended template
+      partialPattern.tmpTemplate = '{{=<%% %%>=}}' + partialPattern.tmpTemplate;
 
-        var renderedPartial = pattern_assembler.renderPattern(partialPattern.extendedTemplate, allData, patternlab.partials);
+      //the reason for rendering at this point is to eliminate the unwanted
+      //recursion paths that would remain if irrelevant conditional tags persisted.
+      partialPattern.tmpTemplate = pattern_assembler.renderPattern(partialPattern.tmpTemplate, paramData);
+      partialPattern.tmpTemplate = pattern_assembler.winnow_unused_tags(partialPattern.tmpTemplate, pattern);
 
-        //remove the parameter from the partial and replace it with the rendered partial + paramData
-        pattern.extendedTemplate = pattern.extendedTemplate.replace(pMatch, renderedPartial);
+      //replace parameteredPartials with their rendered values.
+      var pMatch = parameteredPartials[i].replace(/[.*+?^${}()|[\]\\\/]/g, '\\$&');
+      regex = new RegExp(pMatch, 'g');
+      pattern.extendedTemplate = pattern.extendedTemplate.replace(regex, partialPattern.tmpTemplate);
 
-        //update the extendedTemplate in the partials object in case this pattern is consumed later
-        patternlab.partials[pattern.key] = pattern.extendedTemplate;
-      });
+      //free tmpTemplate from memory.
+      partialPattern.tmpTemplate = '';
     }
   }
 
   return {
-    find_parameters: function (pattern, patternlab) {
-      findparameters(pattern, patternlab);
+    find_parameters: function (pattern, patternlab, parameteredPartials, tmpTemplate) {
+      findparameters(pattern, patternlab, parameteredPartials, tmpTemplate);
     }
   };