Merge branch 'pattern-engines' into pattern-engines-upstream

Author: geoffp

.gitignore

@@ -18,3 +18,5 @@ public/styleguide/css/static.css.map
 public/styleguide/css/styleguide-specific.css.map
 public/styleguide/css/styleguide.css.map
 source/css/style.css.map
+.idea/
+public/styleguide/

CHANGELOG

@@ -1,5 +1,8 @@
 THIS CHANGELOG IS AN ATTEMPT TO DOCUMENT CHANGES TO THIS PROJECT.
 
+PL-node-v1.1.1
+- FIX: Fixed issue where alternate patterns are added to end of styleguide instead of inline with their parent pattern.
+
 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.
@@ -11,10 +14,18 @@ PL-node-v1.1.0
 - 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
+- ADD: Make all paths configurable
+- THX: HUGE Thanks to @geoffp and @EvanLovely for their thoughts, time, and talent to make this a reality!
 - 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
+- CHG: Changed locations of ./public/styleguide to ./core/styleguide to make ./public/ a cleaner distribution directory
+- CHG: Removed scss files and config from project. This is in preparation for including the default asset repo in the future
+- FIX: Fix issue where partials were not being sent to Mustache during pattern parameter parsing.
+- THX: Thanks to @e2tha-e for reporting this issue.
+- ADD: Now patterns and pseudopatterns can be linked from global or file data.json
+- THX: Thanks @kylewelsby for the thoughtful enhancement
 
 PL-node-v1.0.0
 - FIX: Resolve issue with not hiding underscored patterns.

Gruntfile.js

@@ -1,5 +1,7 @@
 module.exports = function(grunt) {
 
+	var path = require('path');
+
 	// Project configuration.
 	grunt.initConfig({
 		pkg: grunt.file.readJSON('package.json'),
@@ -60,97 +62,77 @@ module.exports = function(grunt) {
 		copy: {
 			main: {
 				files: [
-				{ expand: true, cwd: './source/js/', src: '*', dest: './public/js/'},
-				{ expand: true, cwd: './source/css/', src: '*.css', dest: './public/css/' },
-				{ expand: true, cwd: './source/images/', src: ['*.png', '*.jpg', '*.gif', '*.jpeg'], dest: './public/images/' },
-				{ expand: true, cwd: './source/images/sample/', src: ['*.png', '*.jpg', '*.gif', '*.jpeg'], dest: './public/images/sample/'},
-				{ expand: true, cwd: './source/fonts/', src: '*', dest: './public/fonts/'},
-				{ expand: true, cwd: './source/_data/', src: 'annotations.js', dest: './public/data/' }
+					{ expand: true, cwd: path.resolve(paths().source.js), src: '*.js', dest: path.resolve(paths().public.js) },
+					{ expand: true, cwd: path.resolve(paths().source.css), src: '*.css', dest: path.resolve(paths().public.css) },
+					{ expand: true, cwd: path.resolve(paths().source.images), src: ['**/*.png', '**/*.jpg', '**/*.gif', '**/*.jpeg'], dest: path.resolve(paths().public.images) },
+					{ expand: true, cwd: path.resolve(paths().source.fonts), src: '*', dest: path.resolve(paths().public.fonts) },
+					{ expand: true, cwd: path.resolve(paths().source.data), src: 'annotations.js', dest: path.resolve(paths().public.data) }
 				]
 			},
-			css: {
+			styleguide: {
 				files: [
-				{ expand: true, cwd: './source/css/', src: '*.css', dest: './public/css/' }
+					{ expand: true, cwd: path.resolve(paths().source.styleguide), src: ['*.*', '**/*.*'], dest: path.resolve(paths().public.styleguide) }
 				]
 			}
 		},
 		watch: {
 			all: {
 				files: [
-					'source/css/**/*.css',
-					'public/styleguide/css/*.css',
-					'source/_patterns/**/*.mustache',
-					'source/_patterns/**/*.json',
-					'source/_data/*.json'
+					path.resolve(paths().source.css + '**/*.css'),
+					path.resolve(paths().source.styleguide + 'css/*.css'),
+					path.resolve(paths().source.patterns + '**/*.mustache'),
+					path.resolve(paths().source.patterns + '**/*.json'),
+					path.resolve(paths().source.fonts + '/*'),
+					path.resolve(paths().source.images + '/*'),
+					path.resolve(paths().source.data + '*.json')
 				],
-				tasks: ['default']
-			},
-			// scss: {
-			// 	files: ['source/css/**/*.scss', 'public/styleguide/css/*.scss'],
-			// 	tasks: ['sass', 'copy:css','bsReload:css']
-			// },
-			patterns: {
-				files: [
-					'source/_patterns/**/*.mustache',
-					'source/_patterns/**/*.json',
-					'source/_data/*.json'
-				],
-				tasks: ['default']
+				tasks: ['default', 'bsReload:css']
 			}
 		},
-		// sass: {
-		// 	build: {
-		// 		options: {
-		// 			style: 'expanded',
-		// 			precision: 8
-		// 		},
-		// 		files: {
-		// 			'./source/css/style.css': './source/css/style.scss',
-		// 			'./public/styleguide/css/static.css': './public/styleguide/css/static.scss',
-		// 			'./public/styleguide/css/styleguide.css': './public/styleguide/css/styleguide.scss',
-		// 			'./public/styleguide/css/styleguide-specific.css': './public/styleguide/css/styleguide-specific.scss'
-		// 		}
-		// 	}
-		// },
 		nodeunit: {
 			all: ['test/*_tests.js']
 		},
 		browserSync: {
 			dev: {
 				options: {
-					server:  './public',
+					server:  path.resolve(paths().public.root),
 					watchTask: true,
+					watchOptions: {
+						ignoreInitial: true,
+						ignored: '*.html'
+					},
 					plugins: [
 						{
 							module: 'bs-html-injector',
 							options: {
-								files: './public/index.html'
+								files: [path.resolve(paths().public.root + '/index.html'), path.resolve(paths().public.styleguide + '/styleguide.html')]
 							}
 						}
 					]
 				}
 			}
 		},
 		bsReload: {
-			css: './public/**/*.css'
+			css: path.resolve(paths().public.root + '**/*.css')
 		}
 	});
 
+	function paths () {
+	  return require('./config.json').paths;
+	}
+
 	// load all grunt tasks
 	require('matchdep').filterDev('grunt-*').forEach(grunt.loadNpmTasks);
 
 	//load the patternlab task
 	grunt.task.loadTasks('./builder/');
 
-	//if you choose to use scss, or any preprocessor, you can add it here
-	grunt.registerTask('default', ['patternlab', /*'sass',*/ 'copy:main']);
+	grunt.registerTask('default', ['patternlab', 'copy:main', 'copy:styleguide']);
 
 	//travis CI task
 	grunt.registerTask('travis', ['nodeunit', 'patternlab']);
 
-	//TODO: this line is more efficient, but you cannot run concurrent watch tasks without another dependency.
-	//grunt.registerTask('serve', ['patternlab', /*'sass',*/ 'copy:main', 'browserSync', 'watch:patterns', 'watch:scss']);
-	grunt.registerTask('serve', ['patternlab', /*'sass',*/ 'copy:main', 'browserSync', 'watch:all']);
+	grunt.registerTask('serve', ['patternlab', 'copy:main', 'copy:styleguide', 'browserSync', 'watch:all']);
 
 	grunt.registerTask('build', ['nodeunit', 'concat']);
 

README.md

@@ -80,10 +80,36 @@ Get more information about patternlab-node, pattern lab in general, and where to
 ##### Watching Changes
 To have patternlab-node watch for changes to either a mustache template, data, or stylesheets, run `grunt|gulp watch` or `grunt|gulp serve`. The `Gruntfile|Gulpfile` governs what is watched. It should be easy to add scss or whatever preprocessor you fancy.
 
-##### Preprocessor Support
-The patternlab-node release package ships with some `.scss` files utilized in the creation of the style guide and sample templates, but these are not required. The compilation tasks are commented out in the `Gruntfiles|Gulpfiles` but can be uncommented or changed to meet your needs. Sass modules are not included in `package.json` files - the prevailing thought being if you are familiar enough with preprocessors, you can use the instructions for [grunt-contrib-sass](https://github.com/gruntjs/grunt-contrib-sass) / [gulp-sass](https://github.com/dlmanning/gulp-sass) / _preprocessor of choice_ to install them. Uncomment the preprocessor configuration to fully utilize the example templates, css and style guide.
+##### Configurable Paths
+Pattern Lab Node ships with a particular source and public workflow intended to separate the code you work on with the code generated for consumption elsewhere. If you wish to change any paths, you may do so within `config.json`. The contents are here:
 
-**NOTE:** You may run into issues installing gulp-sass if you don't have the latest Visual Studio on Windows. See [here](https://github.com/sass/node-sass/issues/469) for more information and [this query](https://github.com/sass/node-sass/issues?utf8=%E2%9C%93&q=is%3Aissue+install) for a slew of installation problems related to gulp-sass.
+```
+"paths" : {
+    "source" : {
+      "root": "./source/",
+      "patterns" : "./source/_patterns/",
+      "data" : "./source/_data/",
+      "styleguide" : "./core/styleguide/",
+      "patternlabFiles" : "./source/_patternlab-files/",
+      "js" : "./source/js",
+      "images" : "./source/images",
+      "fonts" : "./source/fonts",
+      "css" : "./source/css/"
+    },
+    "public" : {
+      "root" : "./public/",
+      "patterns" : "./public/patterns/",
+      "data" : "./public/data/",
+      "styleguide" : "./public/styleguide/",
+      "js" : "./public/js",
+      "images" : "./public/images",
+      "fonts" : "./public/fonts",
+      "css" : "./public/css"
+    }
+}
+```
+
+Note the intentional repitition of the nested structure, made this way for maximum flexibility. Relative paths are default but absolute paths should work too. You may also use these paths within Grunt or Gulp files by referring to the paths() object.
 
 ##### Nav Bar Controls
 If you don't have a need for some of the nav-bar tools in the Pattern Lab frontend, you can turn them off in `config.json`.

builder/lineage_hunter.js

@@ -1,6 +1,6 @@
-/*
- * patternlab-node - v1.0.1 - 2015
- *
+/* 
+ * patternlab-node - v1.1.1 - 2016 
+ * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license.
  *

builder/list_item_hunter.js

@@ -1,10 +1,10 @@
-/*
- * patternlab-node - v1.0.1 - 2015
- *
+/* 
+ * patternlab-node - v1.1.1 - 2016 
+ * 
  * 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. 
  *
  */
 
@@ -106,6 +106,9 @@
 					var repeatingBlock = pattern.extendedTemplate.substring(pattern.extendedTemplate.indexOf(liMatch), pattern.extendedTemplate.indexOf(end) + end.length);
 					pattern.extendedTemplate = pattern.extendedTemplate.replace(repeatingBlock, repeatedBlockHtml);
 
+					//update the extendedTemplate in the partials object in case this pattern is consumed later
+					patternlab.partials[pattern.key] = pattern.extendedTemplate;
+
 				});
 			}
 		}

builder/media_hunter.js

@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v1.0.1 - 2015 
+ * patternlab-node - v1.1.1 - 2016 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 

builder/object_factory.js

@@ -1,6 +1,6 @@
-/*
- * patternlab-node - v1.0.1 - 2015
- *
+/* 
+ * patternlab-node - v1.1.1 - 2016 
+ * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license.
  *

builder/parameter_hunter.js

@@ -1,5 +1,5 @@
 /* 
- * patternlab-node - v1.0.1 - 2015 
+ * patternlab-node - v1.1.1 - 2016 
  * 
  * Brian Muenzenmeyer, and the web community.
  * Licensed under the MIT license. 
@@ -61,6 +61,9 @@
 
 					//remove the parameter from the partial and replace it with the rendered partial + paramData
 					pattern.extendedTemplate = pattern.extendedTemplate.replace(pMatch, renderedPartial);
+
+					//update the extendedTemplate in the partials object in case this pattern is consumed later
+					patternlab.partials[pattern.key] = pattern.extendedTemplate;
 				});
 			}
 		}

builder/pattern_assembler.js

@@ -1,10 +1,10 @@
-/*
- * patternlab-node - v1.0.1 - 2015
- *
+/* 
+ * patternlab-node - v1.1.1 - 2016 
+ * 
  * 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. 
  *
  */
 
@@ -37,14 +37,17 @@
         if(pattern.abspath === patternlab.patterns[i].abspath){
           //if abspath already exists, overwrite that element
           patternlab.patterns[i] = pattern;
+          patternlab.partials[pattern.key] = pattern.extendedTemplate || pattern.template;
           isNew = false;
           break;
         }
       }
-      //if the pattern is new, just push to the array
-      if(isNew){
+      // if the pattern is new, we must register it with various data structures!
+      if (isNew) {
         // do global registration
         patternlab.patterns.push(pattern);
+        patternlab.partials[pattern.key] = pattern.extendedTemplate || pattern.template;
+        
         // do plugin-specific registration
         pattern.registerPartial();
       }
@@ -199,10 +202,16 @@
 
       //find any listItem blocks that within the pattern, even if there are no partials
       list_item_hunter.process_list_item_partials(currentPattern, patternlab);
-
-      // expand any partials present in this pattern; that is, drill down into the template and replace their calls in this template with rendered results
+      
+      // expand any partials present in this pattern; that is, drill down into
+      // the template and replace their calls in this template with rendered
+      // results
       if (currentPattern.engine.expandPartials && (foundPatternPartials !== null && foundPatternPartials.length > 0)) {
         expandPartials(foundPatternPartials, list_item_hunter, patternlab, currentPattern);
+        
+        // update the extendedTemplate in the partials object in case this
+        // pattern is consumed later
+        patternlab.partials[currentPattern.key] = currentPattern.extendedTemplate;
       }
 
       //find pattern lineage
@@ -273,33 +282,36 @@
 
 
 
+    function parseDataLinksHelper (patternlab, obj, key) {
+      var linkRE, dataObjAsString, linkMatches, expandedLink;
+
+      linkRE = /link\.[A-z0-9-_]+/g
+      dataObjAsString = JSON.stringify(obj);
+      linkMatches = dataObjAsString.match(linkRE)
+
+      if(linkMatches) {
+        for (var i = 0; i < linkMatches.length; i++) {
+          expandedLink = patternlab.data.link[linkMatches[i].split('.')[1]];
+          if (expandedLink) {
+            if(patternlab.config.debug){
+              console.log('expanded data link from ' + linkMatches[i] + ' to ' + expandedLink + ' inside ' + key);
+            }
+            dataObjAsString = dataObjAsString.replace(linkMatches[i], expandedLink);
+          }
+        }
+      }
+      return JSON.parse(dataObjAsString)
+    }
     //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){
+    function parseDataLinks(patternlab) {
+      //look for link.* such as link.pages-blog as a value
+
+      patternlab.data = parseDataLinksHelper(patternlab, patternlab.data, 'data.json')
 
       //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);
+      for (var i = 0; i < patternlab.patterns.length; i++) {
+        patternlab.patterns[i].jsonFileData = parseDataLinksHelper(patternlab, patternlab.patterns[i].jsonFileData, patternlab.patterns[i].key)
       }
     }