Fix issue where excluded patterns were still rendered on the Pattern Lab site.

bmuenzenmeyer · bmuenzenmeyer · commit bf8cc0d86cec · 2015-12-17T23:30:34.000-06:00
Closes #210
diff --git a/CHANGELOG b/CHANGELOG
@@ -2,6 +2,9 @@ THIS CHANGELOG IS AN ATTEMPT TO DOCUMENT CHANGES TO THIS PROJECT.
 
 PL-node-v1.0.1
 - FIX: Fix issue where partials containing styleModifiers with integers were not found correctly under all circumstances
+- FIX: Fix issue where excluded patterns were still rendered on the Pattern Lab site. Now they do not directly get rendered via the menu, view all links, or the styleguide, but are accessible for inclusion as pattern partials, and can be accessed via lineage.
+- THX: Thanks @theorise for reporting these issues.
+- THX: Thanks @dmolsen for input on desired behavior.
 
 PL-node-v1.0.0
 - FIX: Resolve issue with not hiding underscored patterns.
diff --git a/builder/lineage_hunter.js b/builder/lineage_hunter.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v1.0.0 - 2015 
+ * patternlab-node - v1.0.1 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
diff --git a/builder/list_item_hunter.js b/builder/list_item_hunter.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v1.0.0 - 2015 
+ * patternlab-node - v1.0.1 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
diff --git a/builder/media_hunter.js b/builder/media_hunter.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v1.0.0 - 2015 
+ * patternlab-node - v1.0.1 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
diff --git a/builder/object_factory.js b/builder/object_factory.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v1.0.0 - 2015 
+ * patternlab-node - v1.0.1 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
diff --git a/builder/parameter_hunter.js b/builder/parameter_hunter.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v1.0.0 - 2015 
+ * patternlab-node - v1.0.1 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
diff --git a/builder/pattern_assembler.js b/builder/pattern_assembler.js
@@ -1,10 +1,10 @@
-/*
- * patternlab-node - v1.0.0 - 2015
- *
+/* 
+ * patternlab-node - v1.0.1 - 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. 
  *
  */
 
@@ -96,7 +96,7 @@
       var ext = path.extname(filename);
 
       //ignore dotfiles, underscored files, and non-variant .json files
-      if(filename.charAt(0) === '.' || filename.charAt(0) === '_' || (ext === '.json' && filename.indexOf('~') === -1)){
+      if(filename.charAt(0) === '.' || (ext === '.json' && filename.indexOf('~') === -1)){
         return;
       }
 
diff --git a/builder/pattern_exporter.js b/builder/pattern_exporter.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v1.0.0 - 2015 
+ * patternlab-node - v1.0.1 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
diff --git a/builder/patternlab.js b/builder/patternlab.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v1.0.0 - 2015 
+ * patternlab-node - v1.0.1 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
@@ -124,6 +124,7 @@ var patternlab_engine = function () {
 
     //render all patterns last, so lineageR works
     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);
@@ -165,15 +166,24 @@ var patternlab_engine = function () {
     // check if patterns are excluded, if not add them to styleguidePatterns
     if (styleGuideExcludes.length) {
         for (i = 0; i < patternlab.patterns.length; i++) {
-            var key = patternlab.patterns[i].key;
-            var typeKey = key.substring(0, key.indexOf('-'));
-            var isExcluded = (styleGuideExcludes.indexOf(typeKey) > -1);
-            if (!isExcluded) {
-                styleguidePatterns.push(patternlab.patterns[i]);
+
+          // skip underscore-prefixed files
+          if(isPatternExcluded(patternlab.patterns[i])){
+            if(patternlab.config.debug){
+              console.log('Omitting ' + patternlab.patterns[i].key + " from styleguide pattern exclusion.");
             }
+            continue;
+          }
+
+          var key = patternlab.patterns[i].key;
+          var typeKey = key.substring(0, key.indexOf('-'));
+          var isExcluded = (styleGuideExcludes.indexOf(typeKey) > -1);
+          if (!isExcluded) {
+              styleguidePatterns.push(patternlab.patterns[i]);
+          }
         }
     } else {
-        styleguidePatterns = patternlab.patterns;
+      styleguidePatterns = patternlab.patterns;
     }
 
     //build the styleguide
@@ -187,7 +197,10 @@ var patternlab_engine = function () {
 
     for (i = 0; i < patternlab.patterns.length; i++) {
       // skip underscore-prefixed files
-      if (path.basename(patternlab.patterns[i].abspath).charAt(0) === '_') {
+      if(isPatternExcluded(patternlab.patterns[i])){
+        if(patternlab.config.debug){
+          console.log('Omitting ' + patternlab.patterns[i].key + " from view all rendering.");
+        }
         continue;
       }
 
@@ -203,6 +216,14 @@ var patternlab_engine = function () {
 
         for (j = 0; j < patternlab.patterns.length; j++) {
           if (patternlab.patterns[j].subdir === pattern.subdir) {
+            //again, skip any sibling patterns to the current one that may have underscores
+            if(isPatternExcluded(patternlab.patterns[j])){
+              if(patternlab.config.debug){
+                console.log('Omitting ' + patternlab.patterns[j].key + " from view all sibling rendering.");
+              }
+              continue;
+            }
+
             viewAllPatterns.push(patternlab.patterns[j]);
           }
         }
@@ -231,17 +252,19 @@ var patternlab_engine = function () {
     //loop through all patterns.to build the navigation
     //todo: refactor this someday
     for(var i = 0; i < patternlab.patterns.length; i++){
-      // skip underscore-prefixed files
-      if (path.basename(patternlab.patterns[i].abspath).charAt(0) === '_') {
-        continue;
-      }
 
       var pattern = patternlab.patterns[i];
       var bucketName = pattern.name.replace(/\\/g, '-').split('-')[1];
 
       //check if the bucket already exists
       var bucketIndex = patternlab.bucketIndex.indexOf(bucketName);
       if(bucketIndex === -1){
+
+        // skip underscore-prefixed files. don't create a bucket on account of an underscored pattern
+        if(isPatternExcluded(pattern)){
+          continue;
+        }
+
         //add the bucket
         var bucket = new of.oBucket(bucketName);
 
@@ -333,30 +356,39 @@ var patternlab_engine = function () {
         //if it is flat - we should not add the pattern to patternPaths
         if(flatPatternItem){
 
+          // skip underscore-prefixed files
+          if(isPatternExcluded(pattern)){
+            continue;
+          }
+
           //add the navItem to patternItems
           bucket.patternItems.push(navSubItem);
 
           //add to patternPaths
           addToPatternPaths(bucketName, pattern);
 
         } else{
-          //check to see if navItem exists
-          var navItemIndex = bucket.navItemsIndex.indexOf(navItemName);
-          if(navItemIndex === -1){
-
-            var navItem = new of.oNavItem(navItemName);
-
-            //add the navItem and navSubItem
-            navItem.navSubItems.push(navSubItem);
-            navItem.navSubItemsIndex.push(navSubItemName);
-            bucket.navItems.push(navItem);
-            bucket.navItemsIndex.push(navItemName);
-
-          } else{
-            //add the navSubItem
-            var navItem = bucket.navItems[navItemIndex];
-            navItem.navSubItems.push(navSubItem);
-            navItem.navSubItemsIndex.push(navSubItemName);
+
+          // only do this if pattern is included
+          if(!isPatternExcluded(pattern)){
+            //check to see if navItem exists
+            var navItemIndex = bucket.navItemsIndex.indexOf(navItemName);
+            if(navItemIndex === -1){
+
+              var navItem = new of.oNavItem(navItemName);
+
+              //add the navItem and navSubItem
+              navItem.navSubItems.push(navSubItem);
+              navItem.navSubItemsIndex.push(navSubItemName);
+              bucket.navItems.push(navItem);
+              bucket.navItemsIndex.push(navItemName);
+
+            } else{
+              //add the navSubItem
+              var navItem = bucket.navItems[navItemIndex];
+              navItem.navSubItems.push(navSubItem);
+              navItem.navSubItemsIndex.push(navSubItemName);
+            }
           }
 
           //add the navViewAllSubItem
@@ -414,6 +446,12 @@ var patternlab_engine = function () {
     patternlab.patternPaths[bucketName][pattern.patternName] = pattern.subdir.replace(/\\/g, '/') + "/" + pattern.fileName;
   }
 
+  //todo: refactor this as a method on the pattern object itself once we merge dev with pattern-engines branch
+  function isPatternExcluded(pattern){
+    // returns whether or not the first character of the pattern filename is an underscore, or excluded
+    return pattern.fileName.charAt(0) === '_';
+  }
+
   return {
     version: function(){
       return getVersion();
diff --git a/builder/patternlab_grunt.js b/builder/patternlab_grunt.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v1.0.0 - 2015 
+ * patternlab-node - v1.0.1 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
diff --git a/builder/patternlab_gulp.js b/builder/patternlab_gulp.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v1.0.0 - 2015 
+ * patternlab-node - v1.0.1 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
diff --git a/builder/pseudopattern_hunter.js b/builder/pseudopattern_hunter.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v1.0.0 - 2015 
+ * patternlab-node - v1.0.1 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
diff --git a/builder/style_modifier_hunter.js b/builder/style_modifier_hunter.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v1.0.0 - 2015 
+ * patternlab-node - v1.0.1 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
diff --git a/source/_patterns/01-molecules/03-media/_map.mustache b/source/_patterns/01-molecules/03-media/_map.mustache
@@ -1 +1 @@
-<!--<iframe width=650 height=400 frameborder="0" scrolling="no" marginheight="0" marginwidth="0" src="https://maps.google.com/?ie=UTF8&amp;hq=&amp;hnear=2903+Simkins+Ct,+Palo+Alto,+California+94303&amp;ll=37.44041,-122.117335&amp;spn=0.017412,0.019462&amp;t=m&amp;z=16&amp;output=embed"></iframe>-->
+<iframe width=650 height=400 frameborder="0" scrolling="no" marginheight="0" marginwidth="0" src="https://maps.google.com/?ie=UTF8&amp;hq=&amp;hnear=2903+Simkins+Ct,+Palo+Alto,+California+94303&amp;ll=37.44041,-122.117335&amp;spn=0.017412,0.019462&amp;t=m&amp;z=16&amp;output=embed"></iframe>
diff --git a/test/pattern_assembler_tests.js b/test/pattern_assembler_tests.js
@@ -490,57 +490,6 @@
 			test.equals(bookendPattern.extendedTemplate.replace(/\s\s+/g, ' ').replace(/\n/g, ' ').trim(), expectedValue.trim());
 			test.done();
 		},
-		'processPatternIterative - ignores files that start with underscore' : function(test){
-			//arrange
-			var diveSync = require('diveSync');
-			var fs = require('fs-extra');
-			var pa = require('../builder/pattern_assembler');
-			var pattern_assembler = new pa();
-			var patterns_dir = './test/files/_patterns';
-			var patternlab = {};
-			patternlab.config = fs.readJSONSync('./config.json');
-			patternlab.config.patterns = {source: patterns_dir};
-			patternlab.data = fs.readJSONSync('./source/_data/data.json');
-			patternlab.listitems = fs.readJSONSync('./source/_data/listitems.json');
-			patternlab.header = fs.readFileSync('./source/_patternlab-files/pattern-header-footer/header.html', 'utf8');
-			patternlab.footer = fs.readFileSync('./source/_patternlab-files/pattern-header-footer/footer.html', 'utf8');
-			patternlab.patterns = [];
-			patternlab.data.link = {};
-			patternlab.partials = {};
-
-			//act
-			diveSync(patterns_dir,
-				{
-					filter: function(path, dir){
-						if(dir){
-							var remainingPath = path.replace(patterns_dir, '');
-							var isValidPath = remainingPath.indexOf('/_') === -1;
-							return isValidPath;
-						}
-						return true;
-					}
-				},
-				function(err, file){
-					//log any errors
-					if(err){
-						console.log(err);
-						return;
-					}
-
-					pattern_assembler.process_pattern_iterative(file.substring(2), patternlab);
-				}
-			);
-
-			//assert
-			var foundIgnoredPattern = false;
-			for(var i = 0; i < patternlab.patterns.length; i++){
-				if(patternlab.patterns[i].fileName[0] === '_'){
-					foundIgnoredPattern = true;
-				}
-			}
-			test.equals(foundIgnoredPattern, false);
-			test.done();
-		},
 		'processPatternIterative - ignores files that are variants' : function(test){
 			//arrange
 			var diveSync = require('diveSync');

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/*`
`2`		`- * patternlab-node - v1.0.0 - 2015`
	`2`	`+ * patternlab-node - v1.0.1 - 2015`
`3`	`3`	`*`
`4`	`4`	`* Brian Muenzenmeyer, and the web community.`
`5`	`5`	`* Licensed under the MIT license.`