Support for pattern link.* shortcut inside pattern data objects.

bmuenzenmeyer · bmuenzenmeyer · commit ddfd363baa94 · 2015-12-08T23:42:24.000-06:00
Unit test to cover this Resolves #171 Marking this version 1.0.0 - having achieved broad feature parity with PL PHP v1
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,6 +1,6 @@
 THIS CHANGELOG IS AN ATTEMPT TO DOCUMENT CHANGES TO THIS PROJECT.
 
-PL-node-v0.16.0
+PL-node-v1.0.0
 - FIX: Resolve issue with not hiding underscored patterns.
 - THX: Thanks @ivancamilov for reporting this regression.
 - FIX: Fix misapplied error input class
@@ -11,6 +11,9 @@ PL-node-v0.16.0
 - 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
+- ADD: Added ability to specify link.* urls inside data objects
+- CHG: Incremented version to 1.0.0. Achieved near-parity with PL PHP 1!
+- THX: Thanks to each and every person who cared about Pattern Lab Node! - Brian
 
 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.16.0 - 2015 
+ * patternlab-node - v1.0.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.16.0 - 2015 
+ * patternlab-node - v1.0.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.16.0 - 2015 
+ * patternlab-node - v1.0.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.16.0 - 2015 
+ * patternlab-node - v1.0.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.16.0 - 2015 
+ * patternlab-node - v1.0.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.16.0 - 2015 
+ * patternlab-node - v1.0.0 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
@@ -54,6 +54,7 @@
     }
 
     function addPattern(pattern, patternlab){
+      //add the link to the global object
       patternlab.data.link[pattern.patternGroup + '-' + pattern.patternName] = '/patterns/' + pattern.patternLink;
 
       //only push to array if the array doesn't contain this pattern
@@ -317,6 +318,36 @@
         return o;
     }
 
+    //look for pattern links included in data files.
+    //these will be in the form of link.* WITHOUT {{}}, which would still be there from direct pattern inclusion
+    function parseDataLinks(patternlab){
+
+      //loop through all patterns
+      for (var i = 0; i < patternlab.patterns.length; i++){
+        var pattern = patternlab.patterns[i];
+        //look for link.* such as link.pages-blog as a value
+        var linkRE = /link.[A-z0-9-_]+/g;
+        //convert to string for easier searching
+        var dataObjAsString = JSON.stringify(pattern.jsonFileData);
+        var linkMatches = dataObjAsString.match(linkRE);
+
+        //if no matches found, escape current loop iteration
+        if(linkMatches === null) { continue; }
+
+        for(var i = 0; i < linkMatches.length; i++){
+          //for each match, find the expanded link within the already constructed patternlab.data.link object
+          var expandedLink = patternlab.data.link[linkMatches[i].split('.')[1]];
+          if(patternlab.config.debug){
+            console.log('expanded data link from ' + linkMatches[i] + ' to ' + expandedLink + ' inside ' + pattern.key);
+          }
+          //replace value with expandedLink on the pattern
+          dataObjAsString = dataObjAsString.replace(linkMatches[i], expandedLink);
+        }
+        //write back to data on the pattern
+        pattern.jsonFileData = JSON.parse(dataObjAsString);
+      }
+    }
+
     return {
       find_pattern_partials: function(pattern){
         return findPartials(pattern);
@@ -356,6 +387,9 @@
       },
       is_object_empty: function(obj){
         return isObjectEmpty(obj);
+      },
+      parse_data_links: function(patternlab){
+        parseDataLinks(patternlab);
       }
     };
 
diff --git a/builder/pattern_exporter.js b/builder/pattern_exporter.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v0.16.0 - 2015 
+ * patternlab-node - v1.0.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.16.0 - 2015 
+ * patternlab-node - v1.0.0 - 2015 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
@@ -91,6 +91,10 @@ var patternlab_engine = function () {
         pattern_assembler.process_pattern_iterative(file.substring(2), patternlab);
     });
 
+    //now that all the main patterns are known, look for any links that might be within data and expand them
+    //we need to do this before expanding patterns & partials into extendedTemplates, otherwise we could lose the data -> partial reference
+    pattern_assembler.parse_data_links(patternlab);
+
     //diveSync again to recursively include partials, filling out the
     //extendedTemplate property of the patternlab.patterns elements
     diveSync(patterns_dir, {
@@ -124,6 +128,7 @@ var patternlab_engine = function () {
       var allData =  JSON.parse(JSON.stringify(patternlab.data));
       allData = pattern_assembler.merge_data(allData, pattern.jsonFileData);
 
+      //render the extendedTemplate with all data
       pattern.patternPartial = pattern_assembler.renderPattern(pattern.extendedTemplate, allData);
 
       //add footer info before writing
diff --git a/builder/patternlab_grunt.js b/builder/patternlab_grunt.js
@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v0.16.0 - 2015 
+ * patternlab-node - v1.0.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.16.0 - 2015 
+ * patternlab-node - v1.0.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.16.0 - 2015 
+ * patternlab-node - v1.0.0 - 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 - v0.16.0 - 2015 
+ * patternlab-node - v1.0.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.16.0",
+  "version": "1.0.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.16.0",
+  "version": "1.0.0",
   "devDependencies": {
     "bs-html-injector": "^3.0.0",
     "diveSync": "^0.3.0",
diff --git a/test/files/_patterns/00-test/link.mustache b/test/files/_patterns/00-test/link.mustache
@@ -0,0 +1 @@
+<a href="{{url}}">Cool Dude</a>
diff --git a/test/files/_patterns/00-test/nav.json b/test/files/_patterns/00-test/nav.json
@@ -0,0 +1,11 @@
+{
+  "brad" : {
+    "url" : "link.twitter-brad"
+  },
+  "dave" : {
+    "url" : "link.twitter-dave"
+  },
+  "brian" : {
+    "url" : "link.twitter-brian"
+  }
+}
diff --git a/test/files/_patterns/00-test/nav.mustache b/test/files/_patterns/00-test/nav.mustache
@@ -0,0 +1,9 @@
+{{# brad }}
+   {{> test-link }}
+{{/ brad }}
+{{# dave }}
+   {{> test-link }}
+{{/ dave }}
+{{# brian }}
+   {{> test-link }}
+{{/ brian }}
diff --git a/test/pattern_assembler_tests.js b/test/pattern_assembler_tests.js
@@ -514,6 +514,7 @@
 			var pattern_assembler = new pa();
 			var patterns_dir = './test/files/_patterns';
 			var patternlab = {};
+			//THIS IS BAD.
 			patternlab.config = fs.readJSONSync('./config.json');
 			patternlab.config.patterns = {source: patterns_dir};
 			patternlab.data = fs.readJSONSync('./source/_data/data.json');
@@ -596,6 +597,71 @@
 			//assert
 			test.equals(pattern.patternState, "");
 			test.done();
+		},
+		'parseDataLinks - replaces found link.* data for their expanded links' : 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 = {};
+			//THIS IS BAD
+			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 = {};
+
+			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);
+				}
+			);
+
+			//for the sake of the test, also imagining I have the following pages...
+			patternlab.data.link['twitter-brad'] = 'https://twitter.com/brad_frost';
+			patternlab.data.link['twitter-dave'] = 'https://twitter.com/dmolsen';
+			patternlab.data.link['twitter-brian'] = 'https://twitter.com/bmuenzenmeyer';
+
+			var pattern;
+			for(var i = 0; i < patternlab.patterns.length; i++){
+				if(patternlab.patterns[i].key === 'test-nav'){
+					pattern = patternlab.patterns[i];
+				}
+			}
+			//assert before
+			test.equals(pattern.jsonFileData.brad.url, "link.twitter-brad");
+			test.equals(pattern.jsonFileData.dave.url, "link.twitter-dave");
+			test.equals(pattern.jsonFileData.brian.url, "link.twitter-brian");
+
+			//act
+			pattern_assembler.parse_data_links(patternlab);
+
+			//assert after
+			test.equals(pattern.jsonFileData.brad.url, "https://twitter.com/brad_frost");
+			test.equals(pattern.jsonFileData.dave.url, "https://twitter.com/dmolsen");
+			test.equals(pattern.jsonFileData.brian.url, "https://twitter.com/bmuenzenmeyer");
+			test.done();
 		}
 	};
 }());

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