Factor the finders out of pattern_assembler and add them as methods on

oPatterns that delegate to PatternEngines. Remove requests to the
pattern_assembler functions from hunters and replace them with calls to
methods on oPattern. Also add new factory methods for oPatterns to be
able to produce empty oPatterns and oPatterns with custom contents,
which is useful both for unit testing and other internal use. This helps
to cut down on usage of "bare" mustache strings.

Author: geoffp

builder/lineage_hunter.js

@@ -1,10 +1,10 @@
-/* 
- * patternlab-node - v0.14.0 - 2015 
- * 
+/*
+ * patternlab-node - v0.14.0 - 2015
+ *
  * Brian Muenzenmeyer, and the web community.
- * Licensed under the MIT license. 
- * 
- * Many thanks to Brad Frost and Dave Olsen for inspiration, encouragement, and advice. 
+ * Licensed under the MIT license.
+ *
+ * Many thanks to Brad Frost and Dave Olsen for inspiration, encouragement, and advice.
  *
  */
 
@@ -19,7 +19,8 @@
 			var pattern_assembler = new pa();
 
 			//find the {{> template-name }} within patterns
-			var matches = pattern_assembler.find_pattern_partials(pattern);
+      console.log('===\n', pattern, '\n===');
+			var matches = pattern.findPartials();
 			if(matches !== null){
 				matches.forEach(function(match, index, matches){
 					//strip out the template cruft

builder/list_item_hunter.js

@@ -1,10 +1,10 @@
-/* 
- * patternlab-node - v0.14.0 - 2015 
- * 
+/*
+ * patternlab-node - v0.14.0 - 2015
+ *
  * Brian Muenzenmeyer, and the web community.
- * Licensed under the MIT license. 
- * 
- * Many thanks to Brad Frost and Dave Olsen for inspiration, encouragement, and advice. 
+ * Licensed under the MIT license.
+ *
+ * Many thanks to Brad Frost and Dave Olsen for inspiration, encouragement, and advice.
  *
  */
 
@@ -14,20 +14,23 @@
 	var list_item_hunter = function(){
 
 		var extend = require('util')._extend,
-		pa = require('./pattern_assembler'),
-		smh = require('./style_modifier_hunter'),
-		mustache = require('mustache'),
-		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'];
+				pa = require('./pattern_assembler'),
+				smh = require('./style_modifier_hunter'),
+				config = require('../config.json'),
+        of = require('./object_factory');
+
+		var 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 processListItemPartials(pattern, patternlab){
 			//find any listitem blocks
-			var matches = pattern_assembler.find_list_items(pattern, patternlab);
+			var matches = pattern.findListItems();
+
 			if(matches !== null){
 				matches.forEach(function(liMatch, index, matches){
 
-					if(patternlab.config.debug){
+					if(config.debug){
 						console.log('found listItem of size ' + liMatch + ' inside ' + pattern.key);
 					}
 
@@ -39,6 +42,7 @@
 					var repeatedBlockTemplate = [];
 					var repeatedBlockHtml = '';
 					for(var i = 0; i < items.indexOf(loopNumberString); i++){
+            console.log('adding', patternBlock, 'to repeatedBlockTemplate');
 						repeatedBlockTemplate.push(patternBlock);
 					}
 
@@ -62,7 +66,7 @@
 						allData.link = extend({}, patternlab.data.link);
 
 						//check for partials within the repeated block
-						var foundPartials = pattern_assembler.find_pattern_partials({ 'template' : thisBlockTemplate });
+						var foundPartials = of.oPattern.createEmpty({'template': thisBlockTemplate}).findPartials();
 
 						if(foundPartials && foundPartials.length > 0){
 

builder/object_factory.js

@@ -13,11 +13,16 @@
 
   var patternEngines = require('./pattern_engines/pattern_engines');
   var path = require('path');
+  var fs = require('fs-extra');
+  var config = fs.readJSONSync('./config.json');
+  var extend = require('util')._extend;
 
   // oPattern properties
 
   var oPattern = function(abspath, subdir, filename, data){
-    console.log('NEW OPATTERN.  ', 'absPath:', abspath, 'subdir:', subdir, 'filename:', filename, 'data:', data);
+    if (config.debug) {
+      console.log('=== NEW OPATTERN.', '\nabsPath:', abspath, '\nsubdir:', subdir, '\nfilename:', filename, '\ndata:\n', data);
+    }
     this.fileName = filename.substring(0, filename.indexOf('.'));
     this.fileExtension = path.extname(abspath);
     this.abspath = abspath;
@@ -48,16 +53,43 @@
   // render method on oPatterns; this acts as a proxy for the PatternEngine's
   // render function
   oPattern.prototype.render = function (data, partials) {
-    if (this.isPseudoPattern) {
-      console.log(this.name + ' is a pseudo-pattern');
-    } else {
-      console.log('this is NOT a pseudo-pattern');
+    if (config.debug && this.isPseudoPattern) {
+      console.log('===', this.name + ' IS A PSEUDO-PATTERN ===');
     }
-    // console.log('this does ' + (this.template ? '' : 'NOT ') + 'have template');
-    // console.log('this does ' + (this.extendedTemplate ? '' : 'NOT ') + 'have extendedTemplate');
-
     return this.engine.renderPattern(this.extendedTemplate, data, partials);
   };
+  // the finders all delegate to the PatternEngine, which also encapsulates all
+  // appropriate regexes
+  oPattern.prototype.findPartials = function () {
+    return this.engine.findPartials(this);
+  };
+  oPattern.prototype.findPartialsWithStyleModifiers = function () {
+    return this.engine.findPartialsWithStyleModifiers(this);
+  };
+  oPattern.prototype.findPartialsWithPatternParameters = function () {
+    return this.engine.findPartialsWithPatternParameters(this);
+  };
+  oPattern.prototype.findListItems = function () {
+    return this.engine.findListItems(this);
+  };
+
+  // oPattern static methods
+
+  // factory: creates an empty oPattern for miscellaneous internal use, such as
+  // by list_item_hunter
+  oPattern.createEmpty = function (customProps) {
+    var pattern = new oPattern('', '', '', null);
+    return extend(pattern, customProps);
+  };
+
+  // factory: creates an oPattern object on-demand from a hash; the hash accepts
+  // parameters that replace the positional parameters that the oPattern
+  // constructor takes.
+  oPattern.create = function (abspath, subdir, filename, data, customProps) {
+    var newPattern =  new oPattern(abspath || '', subdir || '', filename || '', data || null);
+    return extend(newPattern, customProps);
+  };
+
 
   var oBucket = function(name){
     this.bucketNameLC = name;
@@ -97,4 +129,4 @@
     oNavSubItem: oNavSubItem
   };
 
-}());
+})();

builder/pattern_assembler.js

@@ -16,7 +16,8 @@
     var fs = require('fs-extra'),
         of = require('./object_factory'),
         path = require('path'),
-        patternEngines = require('./pattern_engines/pattern_engines');
+        patternEngines = require('./pattern_engines/pattern_engines'),
+        config = fs.readJSONSync('./config.json');
 
     function isObjectEmpty(obj) {
       for(var prop in obj) {
@@ -26,29 +27,6 @@
 
       return true;
     }
-    // GTP: I need to factor out all these regexes
-    // returns any patterns that match {{> value:mod }} or {{> value:mod(foo:"bar") }} within the pattern
-    function findPartialsWithStyleModifiers(pattern){
-      var matches = pattern.template.match(/{{>([ ])?([\w\-\.\/~]+)(?!\()(\:[A-Za-z0-9-_]+)+(?:(| )\(.*)?([ ])?}}/g);
-      return matches;
-    }
-
-    // returns any patterns that match {{> value(foo:"bar") }} or {{> value:mod(foo:"bar") }} within the pattern
-    function findPartialsWithPatternParameters(pattern){
-      var matches = pattern.template.match(/{{>([ ])?([\w\-\.\/~]+)(?:\:[A-Za-z0-9-_]+)?(?:(| )\(.*)+([ ])?}}/g);
-      return matches;
-    }
-
-    //find and return any {{> template-name* }} within pattern
-    function findPartials(pattern){
-      var matches = pattern.template.match(/{{>([ ])?([\w\-\.\/~]+)(?:\:[A-Za-z0-9-_]+)?(?:(| )\(.*)?([ ])?}}/g);
-      return matches;
-    }
-
-    function findListItems(pattern){
-      var matches = pattern.template.match(/({{#( )?)(list(I|i)tems.)(one|two|three|four|five|six|seven|eight|nine|ten|eleven|twelve|thirteen|fourteen|fifteen|sixteen|seventeen|eighteen|nineteen|twenty)( )?}}/g);
-      return matches;
-    }
 
     function setState(pattern, patternlab){
       if(patternlab.config.patternStates[pattern.patternName]){
@@ -82,12 +60,16 @@
       // if we've been passed a full oPattern, it knows what kind of template it
       // is, and how to render itself, so we just call its render method
       if (pattern instanceof of.oPattern) {
-        console.log('rendering full oPattern: ' + pattern.name);
+        if (config.debug) {
+          console.log('rendering full oPattern: ' + pattern.name);
+        }
         return pattern.render(data, partials);
       } else {
         // otherwise, assume it's a plain mustache template string and act
         // accordingly
-        console.log('rendering plain mustache string:', pattern.substring(0, 20) + '...');
+        if (config.debug) {
+          console.log('rendering plain mustache string:', pattern.substring(0, 20) + '...');
+        }
         return patternEngines.mustache.renderPattern(pattern, data, partials);
       }
     }
@@ -106,10 +88,7 @@
       }
 
       // not a hidden pattern, let's dig deeper
-      var engineNames = Object.keys(patternEngines);
-      var supportedPatternFileExtensions = engineNames.map(function (engineName) {
-        return patternEngines[engineName].fileExtension;
-      });
+      var supportedPatternFileExtensions = patternEngines.getSupportedFileExtensions();
       return (supportedPatternFileExtensions.lastIndexOf(extension) !== -1);
     }
 
@@ -123,11 +102,15 @@
       var filename = path.basename(file);
       var ext = path.extname(filename);
 
-      console.log('processPatternIterative:', 'filename:', filename);
+      if (config.debug) {
+        console.log('processPatternIterative:', 'filename:', filename);
+      }
 
       // skip non-pattern files
       if (!isPatternFile(filename, patternlab)) { return; }
-      console.log('found pattern', file);
+      if (config.debug) {
+        console.log('processPatternIterative:', 'found pattern', file);
+      }
 
       //make a new Pattern Object
       var currentPattern = new of.oPattern(file, subdir, filename);
@@ -144,7 +127,9 @@
 
       //can ignore all non-mustache files at this point
       if(ext !== '.mustache'){
-        console.log('==================== FOUND NON-MUSTACHE FILE');
+        if (config.debug) {
+          console.log('==================== FOUND NON-MUSTACHE FILE');
+        }
         return;
       }
 
@@ -178,10 +163,10 @@
       currentPattern.template = fs.readFileSync(file, 'utf8');
 
       //find any stylemodifiers that may be in the current pattern
-      currentPattern.stylePartials = findPartialsWithStyleModifiers(currentPattern);
+      currentPattern.stylePartials = currentPattern.findPartialsWithStyleModifiers();
 
       //find any pattern parameters that may be in the current pattern
-      currentPattern.parameteredPartials = findPartialsWithPatternParameters(currentPattern);
+      currentPattern.parameteredPartials = currentPattern.findPartialsWithPatternParameters();
 
       //add currentPattern to patternlab.patterns array
       addPattern(currentPattern, patternlab);
@@ -218,7 +203,7 @@
       currentPattern.extendedTemplate = currentPattern.template;
 
       //find how many partials there may be for the given pattern
-      var foundPatternPartials = findPartials(currentPattern);
+      var foundPatternPartials = currentPattern.findPartials(currentPattern);
 
       if(foundPatternPartials !== null && foundPatternPartials.length > 0){
 
@@ -356,16 +341,16 @@
 
     return {
       find_pattern_partials: function(pattern){
-        return findPartials(pattern);
+        return pattern.findPartials();
       },
       find_pattern_partials_with_style_modifiers: function(pattern){
-        return findPartialsWithStyleModifiers(pattern);
+        return pattern.findPartialsWithStyleModifiers();
       },
       find_pattern_partials_with_parameters: function(pattern){
-        return findPartialsWithPatternParameters(pattern);
+        return pattern.findPartialsWithPatternParameters();
       },
       find_list_items: function(pattern){
-        return findListItems(pattern)
+        return pattern.findListItems();
       },
       setPatternState: function(pattern, patternlab){
         setState(pattern, patternlab);

builder/pattern_engines/engine_mustache.js

@@ -15,8 +15,14 @@
 
   var engine_mustache = {
     engine: Mustache,
-    name: 'mustache',
-    fileExtension: '.mustache',
+    engineName: 'mustache',
+    engineFileExtension: '.mustache',
+
+    // regexes, stored here so they're only compiled once
+    findPartialsRE: /{{>([ ])?([A-Za-z0-9-]+)(?:\:[A-Za-z0-9-]+)?(?:(| )\(.*)?([ ])?}}/g,
+    findPartialsWithStyleModifiersRE: /{{>([ ])?([\w\-\.\/~]+)(?!\()(\:[A-Za-z0-9-_]+)+(?:(| )\(.*)?([ ])?}}/g,
+    findPartialsWithPatternParametersRE: /{{>([ ])?([\w\-\.\/~]+)(?:\:[A-Za-z0-9-_]+)?(?:(| )\(.*)+([ ])?}}/g,
+    findListItemsRE: /({{#( )?)(list(I|i)tems.)(one|two|three|four|five|six|seven|eight|nine|ten|eleven|twelve|thirteen|fourteen|fifteen|sixteen|seventeen|eighteen|nineteen|twenty)( )?}}/g,
 
     // render it
     renderPattern: function renderPattern(template, data, partials) {
@@ -28,7 +34,20 @@
 
     // find and return any {{> template-name }} within pattern
     findPartials: function findPartials(pattern) {
-      var matches = pattern.template.match(/{{>([ ])?([A-Za-z0-9-]+)(?:\:[A-Za-z0-9-]+)?(?:(| )\(.*)?([ ])?}}/g);
+      var matches = pattern.template.match(this.findPartialsRE);
+      return matches;
+    },
+    findPartialsWithStyleModifiers: function(pattern){
+      var matches = pattern.template.match(this.findPartialsWithStyleModifiersRE);
+      return matches;
+    },
+    // returns any patterns that match {{> value(foo:"bar") }} or {{> value:mod(foo:"bar") }} within the pattern
+    findPartialsWithPatternParameters: function(pattern){
+      var matches = pattern.template.match(this.findPartialsWithPatternParametersRE);
+      return matches;
+    },
+    findListItems: function(pattern){
+      var matches = pattern.template.match(this.findListItemsRE);
       return matches;
     }
   };

builder/pattern_engines/pattern_engines.js

@@ -35,7 +35,7 @@
       // avoid circular dependency by putting this in here. TODO: is this slow?
       var of = require('../object_factory');
 
-      if (pattern instanceof of.oPattern) {
+      if (pattern instanceof of.oPattern && typeof pattern.fileExtension === 'string' && pattern.fileExtension) {
         return engineNameForExtension[pattern.fileExtension];
       }
       // otherwise, assume it's a plain mustache template string and act
@@ -49,6 +49,16 @@
         var engineName = this.getEngineNameForPattern(pattern);
         return this[engineName];
       }
+    },
+    getSupportedFileExtensions: function () {
+      var engineNames = Object.keys(PatternEngines);
+      return engineNames.map(function (engineName) {
+        return PatternEngines[engineName].engineFileExtension;
+      });
+    },
+    isFileExtensionSupported: function (fileExtension) {
+      var supportedExtensions = PatternEngines.getSupportedFileExtensions();
+      return (supportedExtensions.lastIndexOf(fileExtension) !== -1);
     }
   });
 
@@ -69,7 +79,7 @@
     var mapping = {};
 
     Object.keys(PatternEngines).forEach(function (engineName) {
-      var extensionForEngine = PatternEngines[engineName].fileExtension;
+      var extensionForEngine = PatternEngines[engineName].engineFileExtension;
       mapping[extensionForEngine] = engineName;
     });