Made pseudopattern_hunter a bit less hardcoded

bmuenzenmeyer · bmuenzenmeyer · commit a66d0a850bbe · 2015-12-07T23:53:13.000-06:00
added unit test for pseudopattern generation
fixed a bug where pseudopatterns were being added to the UI twice
explicitly sorted patterns before UI build

setting version to v0.16.0
diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,7 @@ public/index.html
 public/styleguide.html
 public/styleguide/html/styleguide.html
 public/css/*
+public/data/*
 public/fonts/*
 public/js/*
 public/images/*
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,13 +1,16 @@
 THIS CHANGELOG IS AN ATTEMPT TO DOCUMENT CHANGES TO THIS PROJECT.
 
-PL-node-v0.15.2
+PL-node-v0.16.0
 - FIX: Resolve issue with not hiding underscored patterns.
 - THX: Thanks @ivancamilov for reporting this regression.
 - FIX: Fix misapplied error input class
 - THX: Thanks @johngerome for the pull request!
 - ADD: Added a note in the README during installation to run with elevated privileges
 - THX: Thanks @RichardBray for the heads up
 - ADD: Added a Prerequisites section to the README
+- ADD: Added unit tests for pattern states and pseudopatterns
+- CHG: Changed pseudopattern generation to use config.patterns.source directory instead of hardcode
+- CHG: Explicitly sorting patterns by name prior to building the UI
 
 PL-node-v0.15.1
 - FIX: Resolve issue with styleModifiers not being replaced when the partial has spaces in it.
diff --git a/builder/lineage_hunter.js b/builder/lineage_hunter.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v0.15.2 - 2015 
+ * patternlab-node - v0.16.0 - 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 - v0.15.2 - 2015 
+ * patternlab-node - v0.16.0 - 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 - v0.15.2 - 2015 
+ * patternlab-node - v0.16.0 - 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 - v0.15.2 - 2015 
+ * patternlab-node - v0.16.0 - 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 - v0.15.2 - 2015 
+ * patternlab-node - v0.16.0 - 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,5 +1,5 @@
 /* 
- * patternlab-node - v0.15.2 - 2015 
+ * patternlab-node - v0.16.0 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
@@ -46,7 +46,7 @@
     }
 
     function setState(pattern, patternlab){
-      if(patternlab.config.patternStates[pattern.patternName]){
+      if(patternlab.config.patternStates && patternlab.config.patternStates[pattern.patternName]){
         pattern.patternState = patternlab.config.patternStates[pattern.patternName];
       } else{
         pattern.patternState = "";
@@ -102,13 +102,9 @@
       //make a new Pattern Object
       var currentPattern = new of.oPattern(file, subdir, filename);
 
-      //if file is named in the syntax for variants
+      //if file is named in the syntax for variants, no need to process further
+      //processPatternRecursive() will run find_pseudopatterns() and look at each pattern for a variant
       if(ext === '.json' && filename.indexOf('~') > -1){
-        //add current pattern to patternlab object with minimal data
-        //processPatternRecursive() will run find_pseudopatterns() to fill out
-        //the object in the next diveSync
-        addPattern(currentPattern, patternlab);
-        //no need to process further
         return;
       }
 
diff --git a/builder/pattern_exporter.js b/builder/pattern_exporter.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v0.15.2 - 2015 
+ * patternlab-node - v0.16.0 - 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 - v0.15.2 - 2015 
+ * patternlab-node - v0.16.0 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
@@ -211,6 +211,18 @@ var patternlab_engine = function () {
     //build the patternlab website
     var patternlabSiteTemplate = fs.readFileSync('./source/_patternlab-files/index.mustache', 'utf8');
 
+    //sort all patterns explicitly.
+    patternlab.patterns = patternlab.patterns.sort(function(a,b){
+      if (a.name > b.name) {
+        return 1;
+      }
+      if (a.name < b.name) {
+        return -1;
+      }
+      // a must be equal to b
+      return 0;
+    });
+
     //loop through all patterns.to build the navigation
     //todo: refactor this someday
     for(var i = 0; i < patternlab.patterns.length; i++){
diff --git a/builder/patternlab_grunt.js b/builder/patternlab_grunt.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v0.15.2 - 2015 
+ * patternlab-node - v0.16.0 - 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 - v0.15.2 - 2015 
+ * patternlab-node - v0.16.0 - 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 - v0.15.2 - 2015 
+ * patternlab-node - v0.16.0 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
@@ -28,7 +28,7 @@
 			//look for a pseudo pattern by checking if there is a file containing same name, with ~ in it, ending in .json
 			var needle = currentPattern.subdir + '/' + currentPattern.fileName + '~*.json';
 			var pseudoPatterns = glob.sync(needle, {
-				cwd: 'source/_patterns/', //relative to gruntfile
+				cwd: patternlab.config.patterns.source + '/',
 				debug: false,
 				nodir: true,
 			});
@@ -41,14 +41,14 @@
 						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]);
+					//we want to do everything we normally would here, except instead read the pseudoPattern data
+					var variantFileData = fs.readJSONSync(patternlab.config.patterns.source + '/' + pseudoPatterns[i]);
 
 					//extend any existing data with variant data
 					variantFileData = pattern_assembler.merge_data(currentPattern.jsonFileData, variantFileData);
 
 					var variantName = pseudoPatterns[i].substring(pseudoPatterns[i].indexOf('~') + 1).split('.')[0];
-					var variantFilePath = 'source/_patterns/' + currentPattern.subdir + '/' + currentPattern.fileName + '~' + variantName + '.json';
+					var variantFilePath = patternlab.config.patterns.source + '/' + currentPattern.subdir + '/' + currentPattern.fileName + '~' + variantName + '.json';
 					var variantFileName = currentPattern.fileName + '-' + variantName + '.';
 					var patternVariant = new of.oPattern(variantFilePath, currentPattern.subdir, variantFileName, variantFileData);
 
diff --git a/builder/style_modifier_hunter.js b/builder/style_modifier_hunter.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v0.15.2 - 2015 
+ * patternlab-node - v0.16.0 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
diff --git a/package.gulp.json b/package.gulp.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": "0.15.2",
+  "version": "0.16.0",
   "devDependencies": {
     "browser-sync": "^2.10.0",
     "del": "^2.0.2",
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": "0.15.2",
+  "version": "0.16.0",
   "devDependencies": {
     "bs-html-injector": "^3.0.0",
     "diveSync": "^0.3.0",
diff --git a/test/files/_patterns/00-test/03-styled-atom~alt.json b/test/files/_patterns/00-test/03-styled-atom~alt.json
@@ -0,0 +1,3 @@
+{
+  "message": "alternateMessage"
+}
diff --git a/test/pattern_assembler_tests.js b/test/pattern_assembler_tests.js
@@ -290,14 +290,15 @@
 			//arrange
 			var fs = require('fs-extra');
 			var pattern_assembler = new pa();
+			var patterns_dir = './test/files/_patterns';
 
 			var pl = {};
 			pl.config = {};
 			pl.data = {};
 			pl.data.link = {};
 			pl.config.debug = false;
 			pl.patterns = [];
-			var patterns_dir = './test/files/_patterns';
+			pl.config.patterns = { source: patterns_dir};
 
 			var atomPattern = new object_factory.oPattern('test/files/_patterns/00-test/03-styled-atom.mustache', '00-test', '03-styled-atom.mustache');
 			atomPattern.template = fs.readFileSync(patterns_dir + '/00-test/03-styled-atom.mustache', 'utf8');
@@ -322,14 +323,15 @@
 			//arrange
 			var fs = require('fs-extra');
 			var pattern_assembler = new pa();
+			var patterns_dir = './test/files/_patterns';
 
 			var pl = {};
 			pl.config = {};
 			pl.data = {};
 			pl.data.link = {};
 			pl.config.debug = false;
 			pl.patterns = [];
-			var patterns_dir = './test/files/_patterns';
+			pl.config.patterns = { source: patterns_dir};
 
 			var atomPattern = new object_factory.oPattern('test/files/_patterns/00-test/03-styled-atom.mustache', '00-test', '03-styled-atom.mustache');
 			atomPattern.template = fs.readFileSync(patterns_dir + '/00-test/03-styled-atom.mustache', 'utf8');
@@ -354,14 +356,15 @@
 			//arrange
 			var fs = require('fs-extra');
 			var pattern_assembler = new pa();
+			var patterns_dir = './test/files/_patterns';
 
 			var pl = {};
 			pl.config = {};
 			pl.data = {};
 			pl.data.link = {};
 			pl.config.debug = false;
 			pl.patterns = [];
-			var patterns_dir = './test/files/_patterns';
+			pl.config.patterns = { source: patterns_dir};
 
 			var atomPattern = new object_factory.oPattern('test/files/_patterns/00-test/03-styled-atom.mustache', '00-test', '03-styled-atom.mustache');
 			atomPattern.template = fs.readFileSync(patterns_dir + '/00-test/03-styled-atom.mustache', 'utf8');
@@ -386,14 +389,15 @@
 			//arrange
 			var fs = require('fs-extra');
 			var pattern_assembler = new pa();
+			var patterns_dir = './test/files/_patterns';
 
 			var pl = {};
 			pl.config = {};
 			pl.data = {};
 			pl.data.link = {};
 			pl.config.debug = false;
 			pl.patterns = [];
-			var patterns_dir = './test/files/_patterns';
+			pl.config.patterns = { source: patterns_dir};
 
 			var atomPattern = new object_factory.oPattern('test/files/_patterns/00-test/03-styled-atom.mustache', '00-test', '03-styled-atom.mustache');
 			atomPattern.template = fs.readFileSync(patterns_dir + '/00-test/03-styled-atom.mustache', 'utf8');
@@ -420,14 +424,15 @@
 			//arrange
 			var fs = require('fs-extra');
 			var pattern_assembler = new pa();
+			var patterns_dir = './test/files/_patterns';
 
 			var pl = {};
 			pl.config = {};
 			pl.data = {};
 			pl.data.link = {};
 			pl.config.debug = false;
 			pl.patterns = [];
-			var patterns_dir = './test/files/_patterns';
+			pl.config.patterns = { source: patterns_dir};
 
 			var atomPattern = new object_factory.oPattern('test/files/_patterns/00-test/03-styled-atom.mustache', '00-test', '03-styled-atom.mustache');
 			atomPattern.template = fs.readFileSync(patterns_dir + '/00-test/03-styled-atom.mustache', 'utf8');
@@ -501,6 +506,57 @@
 			test.equals(foundIgnoredPattern, false);
 			test.done();
 		},
+		'processPatternIterative - ignores files that are variants' : 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 foundVariant = false;
+			for(var i = 0; i < patternlab.patterns.length; i++){
+				if(patternlab.patterns[i].fileName.indexOf('~') > -1){
+					foundVariant = true;
+				}
+			}
+			test.equals(foundVariant, false);
+			test.done();
+		},
 		'setState - applies any patternState matching the pattern' : function(test){
 			//arrange
 			var pa = require('../builder/pattern_assembler');
diff --git a/test/pseudopattern_hunter_tests.js b/test/pseudopattern_hunter_tests.js
@@ -0,0 +1,45 @@
+(function () {
+	"use strict";
+
+	var pha = require('../builder/pseudopattern_hunter');
+  var pa = require('../builder/pattern_assembler');
+	var object_factory = require('../builder/object_factory');
+
+	exports['pseudopattern_hunter'] = {
+		'pseudpattern found and added as a pattern' : function(test){
+      //arrange
+      var fs = require('fs-extra');
+      var pattern_assembler = new pa();
+      var pseudopattern_hunter = new pha();
+      var patterns_dir = './test/files/_patterns/';
+
+      var pl = {};
+      pl.config = {};
+      pl.data = {};
+      pl.data.link = {};
+      pl.config.debug = false;
+      pl.patterns = [];
+      pl.config.patterns = { source: patterns_dir};
+      pl.config.patternStates = {};
+
+      var atomPattern = new object_factory.oPattern('test/files/_patterns/00-test/03-styled-atom.mustache', '00-test', '03-styled-atom.mustache');
+      atomPattern.template = fs.readFileSync(patterns_dir + '00-test/03-styled-atom.mustache', 'utf8');
+      atomPattern.extendedTemplate = atomPattern.template;
+      atomPattern.stylePartials = pattern_assembler.find_pattern_partials_with_style_modifiers(atomPattern);
+
+      pl.patterns.push(atomPattern);
+
+      //act
+      var patternCountBefore = pl.patterns.length;
+      pseudopattern_hunter.find_pseudopatterns(atomPattern, pl);
+
+      //assert
+			test.equals(patternCountBefore + 1, pl.patterns.length);
+      test.equals(pl.patterns[1].key, 'test-styled-atom-alt');
+      test.equals(pl.patterns[1].extendedTemplate.replace(/\s\s+/g, ' ').replace(/\n/g, ' ').trim(), '<span class="test_base {{styleModifier}}"> {{message}} </span>');
+      test.equals(JSON.stringify(pl.patterns[1].jsonFileData), JSON.stringify({"message": "alternateMessage"}));
+
+			test.done();
+		}
+  }
+}());

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