Attempt to single-thread pattern lab builds and clean up between them

closes #450

Author: bmuenzenmeyer

core/lib/patternlab.js

@@ -1,10 +1,10 @@
 /* 
- * patternlab-node - v2.4.3 - 2016 
+ * patternlab-node - v2.4.4 - 2016 
  * 
  * Brian Muenzenmeyer, Geoff Pursell, 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. 
  *
  */
 
@@ -375,17 +375,29 @@ var patternlab_engine = function (config) {
       return getVersion();
     },
     build: function (callback, deletePatternDir) {
+      if (patternlab && patternlab.isBusy) {
+        console.log('Pattern Lab is busy building a previous run - returning early.');
+        return;
+      }
+      patternlab.isBusy = true;
       buildPatterns(deletePatternDir);
       new ui().buildFrontend(patternlab);
       printDebug();
+      patternlab.isBusy = false;
       callback();
     },
     help: function () {
       help();
     },
     patternsonly: function (callback, deletePatternDir) {
+      if (patternlab && patternlab.isBusy) {
+        console.log('Pattern Lab is busy building a previous run - returning early.');
+        return;
+      }
+      patternlab.isBusy = true;
       buildPatterns(deletePatternDir);
       printDebug();
+      patternlab.isBusy = false;
       callback();
     },
     liststarterkits: function () {

core/lib/ui_builder.js

@@ -20,10 +20,6 @@ var ui_builder = function () {
    * @param pattern - the pattern to add
      */
   function addToPatternPaths(patternlab, pattern) {
-    if (!patternlab.patternPaths) {
-      patternlab.patternPaths = {};
-    }
-
     if (!patternlab.patternPaths[pattern.patternGroup]) {
       patternlab.patternPaths[pattern.patternGroup] = {};
     }
@@ -40,10 +36,6 @@ var ui_builder = function () {
    * @param pattern -  the pattern to add
      */
   function addToViewAllPaths(patternlab, pattern) {
-    if (!patternlab.viewAllPaths) {
-      patternlab.viewAllPaths = {};
-    }
-
     if (!patternlab.viewAllPaths[pattern.patternGroup]) {
       patternlab.viewAllPaths[pattern.patternGroup] = {};
     }
@@ -342,12 +334,6 @@ var ui_builder = function () {
       patternGroups: {}
     };
 
-    //if (!patternlab.patternTypes) {
-      patternlab.counter = (patternlab.counter ? patternlab.counter + 1: 1);
-      console.log('build counts:', patternlab.counter);
-      patternlab.patternTypes = [];
-    //}
-
     _.forEach(sortPatterns(patternlab.patterns), function (pattern) {
 
       //ignore patterns we can omit from rendering directly
@@ -562,12 +548,23 @@ var ui_builder = function () {
     writeFile(path.resolve(paths.public.annotations, 'annotations.js'), annotations);
   }
 
+  /**
+   * Reset any global data we use between builds to guard against double adding things
+   */
+  function resetUIBuilderState(patternlab) {
+    patternlab.patternPaths = {};
+    patternlab.viewAllPaths = {};
+    patternlab.patternTypes = [];
+  }
+
   /**
    * The main entry point for ui_builder
    * @param patternlab - global data store
      */
   function buildFrontend(patternlab) {
 
+    resetUIBuilderState(patternlab);
+
     var paths = patternlab.config.paths;
 
     //determine which patterns should be included in the front-end rendering
@@ -628,6 +625,9 @@ var ui_builder = function () {
     },
     groupPatterns: function (patternlab) {
       return groupPatterns(patternlab);
+    },
+    resetUIBuilderState: function (patternlab) {
+      resetUIBuilderState(patternlab);
     }
   };
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "patternlab-node",
   "description": "Pattern Lab is a collection of tools to help you create atomic design systems. This is the node command line interface (CLI).",
-  "version": "2.4.3",
+  "version": "2.4.4",
   "main": "./core/lib/patternlab.js",
   "dependencies": {
     "diveSync": "^0.3.0",

test/ui_builder_tests.js

@@ -112,6 +112,7 @@ exports['ui_builder'] = {
       new Pattern('patternType1/patternSubType2/grey.mustache'),
       new Pattern('patternType1/patternSubType2/white.mustache')
     );
+    ui.resetUIBuilderState(patternlab);
 
     //act
     var result = ui.groupPatterns(patternlab);
@@ -150,6 +151,7 @@ exports['ui_builder'] = {
       new Pattern('patternType1/patternSubType2/grey.mustache'),
       new Pattern('patternType1/patternSubType2/white.mustache')
     );
+    ui.resetUIBuilderState(patternlab);
 
     //act
     var result = ui.groupPatterns(patternlab);
@@ -179,6 +181,7 @@ exports['ui_builder'] = {
       new Pattern('patternType1/patternSubType2/grey.mustache'),
       new Pattern('patternType1/patternSubType2/white.mustache')
     );
+    ui.resetUIBuilderState(patternlab);
 
     //act
     var result = ui.groupPatterns(patternlab);
@@ -214,13 +217,33 @@ exports['ui_builder'] = {
       new Pattern('patternType1/patternSubType2/grey.mustache'),
       new Pattern('patternType1/patternSubType2/white.mustache')
     );
+    ui.resetUIBuilderState(patternlab);
 
     //act
     var result = ui.groupPatterns(patternlab);
 
     //assert
     test.equals('todo', 'todo');
 
+    test.done();
+  },
+
+  'resetUIBuilderState - reset global objects' : function (test) {
+    //arrange
+    var patternlab = createFakePatternLab({
+      patternPaths: { foo: 1},
+      viewAllPaths: { bar: 2},
+      patternTypes: ['baz']
+    });
+
+    //act
+    ui.resetUIBuilderState(patternlab);
+
+    //assert
+    test.equals(patternlab.patternPaths.foo, undefined);
+    test.equals(patternlab.viewAllPaths.bar, undefined);
+    test.equals(patternlab.patternTypes.length, 0);
+
     test.done();
   }