factor utility functions out of the pattern assembler and put 'em in our

utilities module; move isPatternFile into pattern_engines module since
that's where the knowledge it needs is concentrated

Author: geoffp

builder/list_item_hunter.js

@@ -16,6 +16,7 @@
 		var extend = require('util')._extend,
 				pa = require('./pattern_assembler'),
 				smh = require('./style_modifier_hunter'),
+				plutils = require('./utilities'),
 				config = require('../config.json'),
         of = require('./object_factory');
 
@@ -48,7 +49,7 @@
 
 					//check for a local listitems.json file
 					var listData = JSON.parse(JSON.stringify(patternlab.listitems));
-					listData = pattern_assembler.merge_data(listData, pattern.listitems);
+					listData = plutils.mergeData(listData, pattern.listitems);
 
 					//iterate over each copied block, rendering its contents along with pattenlab.listitems[i]
 					for(var i = 0; i < repeatedBlockTemplate.length; i++){
@@ -61,8 +62,8 @@
 						var globalData = JSON.parse(JSON.stringify(patternlab.data));
 						var localData = JSON.parse(JSON.stringify(pattern.jsonFileData));
 
-						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
+						var allData = plutils.mergeData(globalData, localData);
+						allData = plutils.mergeData(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

builder/parameter_hunter.js

@@ -16,6 +16,7 @@
 		var extend = require('util')._extend,
 		pa = require('./pattern_assembler'),
 		smh = require('./style_modifier_hunter'),
+		plutils = require('./utilities'),
 		style_modifier_hunter = new smh(),
 		pattern_assembler = new pa();
 
@@ -43,8 +44,8 @@
 					var globalData = JSON.parse(JSON.stringify(patternlab.data));
 					var localData = JSON.parse(JSON.stringify(pattern.jsonFileData || {}));
 
-					var allData = pattern_assembler.merge_data(globalData, localData);
-					allData = pattern_assembler.merge_data(allData, paramData);
+					var allData = plutils.mergeData(globalData, localData);
+					allData = plutils.mergeData(allData, paramData);
 
 					//if partial has style modifier data, replace the styleModifier value
 					if(pattern.stylePartials && pattern.stylePartials.length > 0){

builder/pattern_assembler.js

@@ -15,19 +15,10 @@
 
     var fs = require('fs-extra'),
         of = require('./object_factory'),
-        path = require('path'),
+        plutils = require('./utilities'),
         patternEngines = require('./pattern_engines/pattern_engines'),
         config = fs.readJSONSync('./config.json');
 
-    function isObjectEmpty(obj) {
-      for(var prop in obj) {
-          if(obj.hasOwnProperty(prop))
-              return false;
-      }
-
-      return true;
-    }
-
     function setState(pattern, patternlab){
       if(patternlab.config.patternStates[pattern.patternName]){
         pattern.patternState = patternlab.config.patternStates[pattern.patternName];
@@ -74,24 +65,6 @@
       }
     }
 
-    // takes a filename string, not a full path; a basename (plus extension)
-    // ignore _underscored patterns, dotfiles, and anything not recognized by a
-    // loaded pattern engine. Pseudo-pattern .json files ARE considered to be
-    // pattern files!
-    function isPatternFile(filename) {
-      // skip hidden patterns/files without a second thought
-      var extension = path.extname(filename);
-      if(filename.charAt(0) === '.' ||
-         filename.charAt(0) === '_' ||
-         (extension === '.json' && filename.indexOf('~') === -1)) {
-        return false;
-      }
-
-      // not a hidden pattern, let's dig deeper
-      var supportedPatternFileExtensions = patternEngines.getSupportedFileExtensions();
-      return (supportedPatternFileExtensions.lastIndexOf(extension) !== -1);
-    }
-
     function processPatternIterative(file, patternlab){
       var fs = require('fs-extra'),
       of = require('./object_factory'),
@@ -107,7 +80,7 @@
       }
 
       // skip non-pattern files
-      if (!isPatternFile(filename, patternlab)) { return; }
+      if (!patternEngines.isPatternFile(filename, patternlab)) { return; }
       if (config.debug) {
         console.log('processPatternIterative:', 'found pattern', file);
       }
@@ -274,40 +247,7 @@
       throw 'Could not find pattern with key ' + key;
     }
 
-    /**
-     * Recursively merge properties of two objects.
-     *
-     * @param {Object} obj1 If obj1 has properties obj2 doesn't, add to obj2.
-     * @param {Object} obj2 This object's properties have priority over obj1.
-     * @returns {Object} obj2
-     */
-    function mergeData(obj1, obj2){
-      if(typeof obj2 === 'undefined'){
-        obj2 = {};
-      }
-      for(var p in obj1){
-        try {
-          // Only recurse if obj1[p] is an object.
-          if(obj1[p].constructor === Object){
-            // Requires 2 objects as params; create obj2[p] if undefined.
-            if(typeof obj2[p] === 'undefined'){
-              obj2[p] = {};
-            }
-            obj2[p] = mergeData(obj1[p], obj2[p]);
-          // Pop when recursion meets a non-object. If obj1[p] is a non-object,
-          // only copy to undefined obj2[p]. This way, obj2 maintains priority.
-          } else if(typeof obj2[p] === 'undefined'){
-            obj2[p] = obj1[p];
-          }
-        } catch(e) {
-          // Property in destination object not set; create it and set its value.
-          if(typeof obj2[p] === 'undefined'){
-            obj2[p] = obj1[p];
-          }
-        }
-      }
-      return obj2;
-    }
+
 
     function buildListItems(container){
       //combine all list items into one structure
@@ -317,7 +257,7 @@
           list.push(container.listitems[item]);
         }
       }
-      container.listItemArray = shuffle(list);
+      container.listItemArray = plutils.shuffle(list);
 
       for(var i = 1; i <= container.listItemArray.length; i++){
         var tempItems = [];
@@ -333,11 +273,7 @@
       }
     }
 
-    //http://stackoverflow.com/questions/6274339/how-can-i-shuffle-an-array-in-javascript
-    function shuffle(o){
-        for(var j, x, i = o.length; i; j = Math.floor(Math.random() * i), x = o[--i], o[i] = o[j], o[j] = x);
-        return o;
-    }
+
 
     return {
       find_pattern_partials: function(pattern){
@@ -370,16 +306,9 @@
       get_pattern_by_key: function(key, patternlab){
         return getpatternbykey(key, patternlab);
       },
-      merge_data: function(existingData, newData){
-        return mergeData(existingData, newData);
-      },
       combine_listItems: function(patternlab){
         buildListItems(patternlab);
-      },
-      is_object_empty: function(obj){
-        return isObjectEmpty(obj);
-      },
-      is_pattern_file: isPatternFile
+      }
     };
 
   };

builder/pattern_engines/pattern_engines.js

@@ -12,6 +12,8 @@
 (function () {
   'use strict';
 
+  var path = require('path');
+
   // list of supported pattern engines
   var supportedPatternEngineNames = [
     'mustache',
@@ -42,6 +44,7 @@
       // accordingly
       return 'mustache';
     },
+
     getEngineForPattern: function (pattern) {
       if (pattern.isPseudoPattern) {
         return this.getEngineForPattern(pattern.basePattern);
@@ -50,15 +53,35 @@
         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);
+    },
+
+    // takes a filename string, not a full path; a basename (plus extension)
+    // ignore _underscored patterns, dotfiles, and anything not recognized by a
+    // loaded pattern engine. Pseudo-pattern .json files ARE considered to be
+    // pattern files!
+    isPatternFile: function (filename) {
+      // skip hidden patterns/files without a second thought
+      var extension = path.extname(filename);
+      if(filename.charAt(0) === '.' ||
+         filename.charAt(0) === '_' ||
+         (extension === '.json' && filename.indexOf('~') === -1)) {
+        return false;
+      }
+
+      // not a hidden pattern, let's dig deeper
+      var supportedPatternFileExtensions = PatternEngines.getSupportedFileExtensions();
+      return (supportedPatternFileExtensions.lastIndexOf(extension) !== -1);
     }
   });
 

builder/patternlab.js

@@ -19,6 +19,7 @@ var patternlab_engine = function () {
   mh = require('./media_hunter'),
   pe = require('./pattern_exporter'),
   he = require('html-entities').AllHtmlEntities,
+  plutils = require('./utilities'),
   patternlab = {};
 
   patternlab.package = fs.readJSONSync('./package.json');
@@ -120,7 +121,7 @@ var patternlab_engine = function () {
     patternlab.patterns.forEach(function(pattern, index, patterns){
       //render the pattern, but first consolidate any data we may have
       var allData =  JSON.parse(JSON.stringify(patternlab.data));
-      allData = pattern_assembler.merge_data(allData, pattern.jsonFileData);
+      allData = plutils.mergeData(allData, pattern.jsonFileData);
 
       pattern.patternPartial = pattern_assembler.renderPattern(pattern, allData);
 

builder/pseudopattern_hunter.js

@@ -19,7 +19,8 @@
 			fs = require('fs-extra'),
 			pa = require('./pattern_assembler'),
 			lh = require('./lineage_hunter'),
-			of = require('./object_factory');
+			of = require('./object_factory'),
+			plutils = require('./utilities');
 
 			var pattern_assembler = new pa();
 			var lineage_hunter = new lh();
@@ -38,14 +39,15 @@
 				for(var i = 0; i < pseudoPatterns.length; i++){
 
 					if(patternlab.config.debug){
+						debugger;
 						console.log('found pseudoPattern variant of ' + currentPattern.key);
 					}
 
 					//we want to do everything we normally would here, except instead head the pseudoPattern data
 					var variantFileData = fs.readJSONSync('source/_patterns/' + pseudoPatterns[i]);
 
 					//extend any existing data with variant data
-					variantFileData = pattern_assembler.merge_data(currentPattern.jsonFileData, variantFileData);
+					variantFileData = plutils.mergeData(currentPattern.jsonFileData, variantFileData);
 
 					var variantName = pseudoPatterns[i].substring(pseudoPatterns[i].indexOf('~') + 1).split('.')[0];
 					var variantFilePath = 'source/_patterns/' + currentPattern.subdir + '/' + currentPattern.fileName + '~' + variantName + '.json';

builder/util.js

@@ -0,0 +1,65 @@
+/*
+ * patternlab-node - v0.14.0 - 2015
+ *
+ * Brian Muenzenmeyer, Geoffrey Pursell and the web community.
+ * Licensed under the MIT license.
+ *
+ * Many thanks to Brad Frost and Dave Olsen for inspiration, encouragement, and advice.
+ *
+ */
+
+(function () {
+  var path = require('path');
+
+  var util = {
+    // http://stackoverflow.com/questions/6274339/how-can-i-shuffle-an-array-in-javascript
+    shuffle: function (o) {
+      for(var j, x, i = o.length; i; j = Math.floor(Math.random() * i), x = o[--i], o[i] = o[j], o[j] = x);
+      return o;
+    },
+
+    /**
+     * Recursively merge properties of two objects.
+     *
+     * @param {Object} obj1 If obj1 has properties obj2 doesn't, add to obj2.
+     * @param {Object} obj2 This object's properties have priority over obj1.
+     * @returns {Object} obj2
+     */
+    mergeData: function (obj1, obj2) {
+      if(typeof obj2 === 'undefined'){
+        obj2 = {};
+      }
+      for(var p in obj1){
+        try {
+          // Only recurse if obj1[p] is an object.
+          if(obj1[p].constructor === Object){
+            // Requires 2 objects as params; create obj2[p] if undefined.
+            if(typeof obj2[p] === 'undefined'){
+              obj2[p] = {};
+            }
+            obj2[p] = util.mergeData(obj1[p], obj2[p]);
+            // Pop when recursion meets a non-object. If obj1[p] is a non-object,
+            // only copy to undefined obj2[p]. This way, obj2 maintains priority.
+          } else if(typeof obj2[p] === 'undefined'){
+            obj2[p] = obj1[p];
+          }
+        } catch(e) {
+          // Property in destination object not set; create it and set its value.
+          if(typeof obj2[p] === 'undefined'){
+            obj2[p] = obj1[p];
+          }
+        }
+      }
+      return obj2;
+    },
+
+    isObjectEmpty: function (obj) {
+      for(var prop in obj) {
+        if(obj.hasOwnProperty(prop)) { return false; }
+      }
+      return true;
+    }
+  };
+
+  module.exports = util;
+}());

builder/utilities.js

@@ -3,6 +3,7 @@
 
 	var pa = require('../builder/pattern_assembler');
   var of = require('../builder/object_factory');
+  var patternEngines = require('../builder/pattern_engines/pattern_engines');
 
 	exports['pattern_assembler'] = {
 		'find_pattern_partials finds partials' : function(test){
@@ -341,7 +342,7 @@
       // loop over each test case and test it
       Object.keys(filenames).forEach(function (filename) {
         var expectedResult = filenames[filename],
-            actualResult = pattern_assembler.is_pattern_file(filename),
+            actualResult = patternEngines.isPatternFile(filename),
             testMessage = 'isPatternFile should return ' + expectedResult + ' for ' + filename;
         test.strictEqual(actualResult, expectedResult, testMessage);
       });