do not short-circuit viewall page building when encountering a flatpattern

bmuenzenmeyer · bmuenzenmeyer · commit f3d4ba406ea9 · 2016-11-12T00:17:19.000-06:00
closes #549
diff --git a/core/lib/patternlab.js b/core/lib/patternlab.js
@@ -1,5 +1,5 @@
 /*
- * patternlab-node - v2.6.1 - 2016
+ * patternlab-node - v2.6.2 - 2016
  *
  * Brian Muenzenmeyer, Geoff Pursell, and the web community.
  * Licensed under the MIT license.
diff --git a/core/lib/ui_builder.js b/core/lib/ui_builder.js
@@ -6,8 +6,7 @@ var fs = require('fs-extra');
 var ae = require('./annotation_exporter');
 var of = require('./object_factory');
 var Pattern = of.Pattern;
-var pa = require('./pattern_assembler');
-var pattern_assembler = new pa();
+var pattern_assembler = require('./pattern_assembler')();
 var plutils = require('./utilities');
 var eol = require('os').EOL;
 var _ = require('lodash');
@@ -640,7 +639,7 @@ var ui_builder = function () {
       resetUIBuilderState(patternlab);
     },
     buildViewAllPages: function (mainPageHeadHtml, patternlab, styleguidePatterns) {
-      buildViewAllPages(mainPageHeadHtml, patternlab, styleguidePatterns);
+      return buildViewAllPages(mainPageHeadHtml, patternlab, styleguidePatterns);
     }
   };
 
diff --git a/package.json b/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.6.1",
+  "version": "2.6.2",
   "main": "./core/lib/patternlab.js",
   "dependencies": {
     "diveSync": "^0.3.0",
@@ -17,6 +17,7 @@
   },
   "devDependencies": {
     "eslint": "^3.5.0",
+    "rewire": "^2.5.2",
     "tap": "^7.1.2"
   },
   "keywords": [
diff --git a/test/ui_builder_tests.js b/test/ui_builder_tests.js
@@ -1,10 +1,28 @@
 "use strict";
 
 var tap = require('tap');
-
+var rewire = require("rewire");
 var eol = require('os').EOL;
 var Pattern = require('../core/lib/object_factory').Pattern;
 var extend = require('util')._extend;
+var uiModule = rewire('../core/lib/ui_builder');
+
+//set up a global mocks - we don't want to be writing/rendering any files right now
+var fsMock = {
+  outputFileSync: function (path, data, cb) { }
+};
+
+var patternAssemblerMock = {
+  renderPattern: function (template, data, partials) { return ''; }
+};
+
+//set our mocks in place of usual require()
+uiModule.__set__({
+  'fs': fsMock,
+  'pattern_assembler': patternAssemblerMock
+});
+
+var ui = uiModule();
 
 function createFakePatternLab(customProps) {
   var pl = {
@@ -24,13 +42,12 @@ function createFakePatternLab(customProps) {
         rawTemplate: '',
         markupOnly: '.markup-only'
       }
-    }
+    },
+    data: {}
   };
   return extend(pl, customProps);
 }
 
-var ui = require('../core/lib/ui_builder')();
-
 tap.test('isPatternExcluded - returns true when pattern filename starts with underscore', function (test) {
   //arrange
   var patternlab = createFakePatternLab({});
@@ -249,10 +266,42 @@ tap.test('resetUIBuilderState - reset global objects', function (test) {
 
 tap.test('buildViewAllPages - adds viewall page for each type and subtype', function (test) {
   //arrange
+  let mainPageHeadHtml = '<head></head>';
+  let patternlab = createFakePatternLab({
+    patterns: [],
+    patternGroups: {},
+    subtypePatterns: {}
+  });
+
+  patternlab.patterns.push(
+    //this flat pattern is found and causes trouble for the rest of the crew
+    new Pattern('00-test/foo.mustache'),
+    new Pattern('patternType1/patternSubType1/blue.mustache'),
+    new Pattern('patternType1/patternSubType1/red.mustache'),
+    new Pattern('patternType1/patternSubType1/yellow.mustache'),
+    new Pattern('patternType1/patternSubType2/black.mustache'),
+    new Pattern('patternType1/patternSubType2/grey.mustache'),
+    new Pattern('patternType1/patternSubType2/white.mustache')
+  );
+  ui.resetUIBuilderState(patternlab);
+
+  let styleguidePatterns = ui.groupPatterns(patternlab);
 
   //act
+  var patterns = ui.buildViewAllPages(mainPageHeadHtml, patternlab, styleguidePatterns);
 
   //assert
+  //this was a nuanced one. buildViewAllPages() had return false; statements
+  //within _.forOwn(...) loops, causing premature termination of the entire loop
+  //when what was intended was a continue
+  //we expect 8 here because:
+  //  - foo.mustache is flat and therefore does not have a viewall page
+  //  - the colors.mustache files make 6
+  //  - patternSubType1 and patternSubType2 make 8
+  //while most of that heavy lifting occurs inside groupPatterns and not buildViewAllPages,
+  //it's important to ensure that this method does not get prematurely terminated
+  //we choose to do that by checking it's return number of patterns
+  test.equals(patterns.length, 8, '2 viewall pages should be added');
 
   test.end();
 });

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * patternlab-node - v2.6.1 - 2016`
	`2`	`+ * patternlab-node - v2.6.2 - 2016`
`3`	`3`	`*`
`4`	`4`	`* Brian Muenzenmeyer, Geoff Pursell, and the web community.`
`5`	`5`	`* Licensed under the MIT license.`