Merge pull request #233 from geoffp/pattern-engines

Pattern engines ongoing work, round 5 (I think)

Author: Brian Muenzenmeyer

.eslintrc

@@ -22,11 +22,13 @@
       "allow-null"
     ],
     "global-strict": [
-      2,
+      0,
       "never"
     ],
     "guard-for-in": 2,
-    "key-spacing": 1,
+    "key-spacing": [
+      0
+    ],
     "new-cap": 0,
     "no-bitwise": 2,
     "no-caller": 2,
@@ -42,6 +44,7 @@
     "no-irregular-whitespace": 1,
     "no-iterator": 2,
     "no-loop-func": 2,
+    "no-mixed-requires": 0,
     "no-multi-str": 2,
     "no-multi-spaces": 0,
     "no-new": 2,
@@ -61,7 +64,7 @@
       0,
       "never"
     ],
-    "strict": 2,
+    "strict": 0,
     "valid-typeof": 2,
     "wrap-iife": [
       2,

CHANGELOG

@@ -1,5 +1,21 @@
 THIS CHANGELOG IS AN ATTEMPT TO DOCUMENT CHANGES TO THIS PROJECT.
 
+PL-node-v1.1.0
+- FIX: Fixed issue where partials containing styleModifiers with integers were not found correctly under all circumstances
+- FIX: Fixed 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.
+- FIX: Fixed issue where style modifier partials within list item blocks where not uniquely being applied. this seems like a regression. added a unit test with fix
+- ADD: Added fuzzy pattern matching support based on patternType-substring(patternName) to align with PL PHP
+- FIX: Fixed issue with gulpfile not copying style.css and watching the wrong directory
+- THX: Thanks @robinsonaaron for the issue and pull request!
+- FIX: Prefer exact pattern key match over fuzzy matches inside getpatternbykey()
+- THX: Thanks @EvanLovely for the suggestion
+- FIX: Fix issue where absolute paths in the config path object would not resolve
+- THX: Thanks to @geoffp and @EvanLovely for reporting, fixing and testing the issue in the dev branch.
+- FIX: Typo in gulp instructions in README.
+- THX: Thanks @simonknittel for the watchful eyes
+
 PL-node-v1.0.0
 - FIX: Resolve issue with not hiding underscored patterns.
 - THX: Thanks @ivancamilov for reporting this regression.

README.md

@@ -44,7 +44,7 @@ To run patternlab-node using gulp, you need to swap out the default grunt config
 3. Run `npm install` from the command line
 4. Run `gulp` or `gulp serve` from the command line
 
-This creates all patterns, the styleguide, and the pattern lab site. It's strongly recommended to run `grunt serve` to see have BrowserSync spin up and serve the files to you.
+This creates all patterns, the styleguide, and the pattern lab site. It's strongly recommended to run `gulp serve` to have BrowserSync spin up and serve the files to you.
 
 ### There and Back Again, or Switching Between Grunt and Gulp
 

builder/lineage_hunter.js

@@ -1,6 +1,6 @@
-/* 
- * patternlab-node - v1.0.0 - 2015 
- * 
+/*
+ * patternlab-node - v1.0.1 - 2015
+ *
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license.
  *
@@ -17,54 +17,36 @@
 
 			var pa = require('./pattern_assembler');
 			var pattern_assembler = new pa();
-			var config = require('../config.json');
 
 			//find the {{> template-name }} within patterns
 			var matches = pattern.findPartials();
 			if(matches !== null){
 				matches.forEach(function(match, index, matches){
-					//strip out the template cruft
-					var foundPattern = match.replace("{{> ", "").replace(" }}", "").replace("{{>", "").replace("}}", "");
-
-					// remove any potential pattern parameters. this and the above are rather brutish but I didn't want to do a regex at the time
-					if(foundPattern.indexOf('(') > 0){
-						foundPattern = foundPattern.substring(0, foundPattern.indexOf('('));
-					}
-
-					//add if it doesnt exist
-					if (pattern.lineageIndex.indexOf(foundPattern) === -1){
-
-						pattern.lineageIndex.push(foundPattern);
-
-						patternlab.patterns.forEach(function(ancestorPattern, index, patterns){
-
-							//find the pattern in question
-							var searchPattern = ancestorPattern.patternGroup + "-" + ancestorPattern.patternName;
-
-							if(searchPattern === foundPattern){
-								//create the more complex patternLineage object too
-								var l = {
-									"lineagePattern": foundPattern,
-									"lineagePath": "../../patterns/" + ancestorPattern.patternLink
+					//get the ancestorPattern
+					var ancestorPattern = pattern_assembler.get_pattern_by_key(pattern.findPartialKey(match), patternlab);
+
+					if (ancestorPattern && pattern.lineageIndex.indexOf(ancestorPattern.key) === -1){
+							//add it since it didnt exist
+						pattern.lineageIndex.push(ancestorPattern.key);
+
+							//create the more complex patternLineage object too
+							var l = {
+								"lineagePattern": ancestorPattern.key,
+								"lineagePath": "../../patterns/" + ancestorPattern.patternLink
+							};
+							pattern.lineage.push(JSON.stringify(l));
+
+							//also, add the lineageR entry if it doesn't exist
+							if (ancestorPattern.lineageRIndex.indexOf(pattern.key) === -1){
+								ancestorPattern.lineageRIndex.push(pattern.key);
+
+								//create the more complex patternLineage object in reverse
+								var lr = {
+									"lineagePattern": pattern.key,
+									"lineagePath": "../../patterns/" + pattern.patternLink
 								};
-								pattern.lineage.push(JSON.stringify(l));
-
-								//also, add the lineageR entry if it doesn't exist
-								var patternLabel = pattern.patternGroup + "-" + pattern.patternName;
-								if (ancestorPattern.lineageRIndex.indexOf(patternLabel) === -1){
-									ancestorPattern.lineageRIndex.push(patternLabel);
-
-									//create the more complex patternLineage object in reverse
-									var lr = {
-										"lineagePattern": patternLabel,
-										"lineagePath": "../../patterns/" + pattern.patternLink
-									};
-									ancestorPattern.lineageR.push(JSON.stringify(lr));
-								}
+								ancestorPattern.lineageR.push(JSON.stringify(lr));
 							}
-
-						});
-
 					}
 				});
 			}

builder/list_item_hunter.js

@@ -1,6 +1,6 @@
-/* 
- * patternlab-node - v1.0.0 - 2015 
- * 
+/*
+ * patternlab-node - v1.0.1 - 2015
+ *
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license.
  *
@@ -17,7 +17,6 @@
 				pa = require('./pattern_assembler'),
 				smh = require('./style_modifier_hunter'),
 				plutils = require('./utilities'),
-				config = require('../config.json'),
         of = require('./object_factory');
 
 		var pattern_assembler = new pa(),
@@ -31,7 +30,7 @@
 			if(matches !== null){
 				matches.forEach(function(liMatch, index, matches){
 
-					if(config.debug){
+					if(patternlab.config.debug){
 						console.log('found listItem of size ' + liMatch + ' inside ' + pattern.key);
 					}
 
@@ -43,7 +42,7 @@
 					var repeatedBlockTemplate = [];
 					var repeatedBlockHtml = '';
 					for(var i = 0; i < items.indexOf(loopNumberString); i++){
-            if (config.debug) {
+            if (patternlab.config.debug) {
               console.log('list item(s) in pattern', pattern.patternName, 'adding', patternBlock, 'to repeatedBlockTemplate');
             }
 						repeatedBlockTemplate.push(patternBlock);
@@ -79,13 +78,16 @@
 								var partialName = foundPartials[j].match(/([\w\-\.\/~]+)/g)[0];
 								var partialPattern = pattern_assembler.get_pattern_by_key(partialName, patternlab);
 
+								//create a copy of the partial so as to not pollute it after the get_pattern_by_key call.
+								var cleanPartialPattern = JSON.parse(JSON.stringify(partialPattern));
+
 								//if partial has style modifier data, replace the styleModifier value
-								if(pattern.stylePartials && pattern.stylePartials.length > 0){
-									style_modifier_hunter.consume_style_modifier(partialPattern, foundPartials[j], patternlab);
+								if(foundPartials[j].indexOf(':') > -1){
+									style_modifier_hunter.consume_style_modifier(cleanPartialPattern, foundPartials[j], patternlab);
 								}
 
 								//replace its reference within the block with the extended template
-								thisBlockTemplate = thisBlockTemplate.replace(foundPartials[j], partialPattern.extendedTemplate);
+								thisBlockTemplate = thisBlockTemplate.replace(foundPartials[j], cleanPartialPattern.extendedTemplate);
 							}
 
 							//render with data

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. 

builder/object_factory.js

@@ -1,6 +1,6 @@
-/* 
- * patternlab-node - v1.0.0 - 2015 
- * 
+/*
+ * patternlab-node - v1.0.1 - 2015
+ *
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license.
  *
@@ -14,7 +14,6 @@
   var patternEngines = require('./pattern_engines/pattern_engines');
   var path = require('path');
   var fs = require('fs-extra');
-  var config = fs.readJSONSync('./config.json');
   var extend = require('util')._extend;
 
   // oPattern properties
@@ -52,10 +51,7 @@
     // render method on oPatterns; this acts as a proxy for the PatternEngine's
     // render function
     render: function (data, partials) {
-      if (config.debug && this.isPseudoPattern) {
-        console.log('===', this.name + ' IS A PSEUDO-PATTERN ===');
-      }
-      return this.engine.renderPattern(this.extendedTemplate, data, partials);
+      return this.engine.renderPattern(this.extendedTemplate, data || this.jsonFileData, partials);
     },
 
     registerPartial: function () {
@@ -82,8 +78,8 @@
       return this.engine.findListItems(this);
     },
 
-    getPartialKey: function (partialString) {
-      return this.engine.getPartialKey(this, partialString);
+    findPartialKey: function (partialString) {
+      return this.engine.findPartialKey(partialString);
     }
   };
 

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.