Merge branch 'dev-3.0' into asset-copy

# Conflicts:
#	package.json

Author: bmuenzenmeyer

.github/CONTRIBUTING.md

@@ -1,14 +1,28 @@
-# Contributing to Patternlab Node
+# Contributing to Pattern Lab Node
 If you'd like to contribute to Pattern Lab Node, please do so! There is always a lot of ground to cover and something for your wheelhouse.
 
 No pull request is too small. Check out any [up for grabs issues](https://github.com/pattern-lab/patternlab-node/labels/up%20for%20grabs) as a good way to get your feet wet, or add some more unit tests.
 
+## Developing Locally
+
+The best way to make changes to the Pattern Lab Node core and test them is through your existing edition.
+
+* Fork this repository on Github.
+* Create a new branch in your fork and push your changes in that fork.
+* `npm install`
+* `npm link`
+* `cd /path/to/your/edition`
+* `npm link patternlab-node`
+
 ## Guidelines
-1. Please keep your pull requests concise and limited to **ONE** substantive change at a time. This makes reviewing and testing so much easier.
-2. _ALWAYS_ submit pull requests against the [dev branch](https://github.com/pattern-lab/patternlab-node/tree/dev). If this does not occur, I will first, try to redirect you gently, second, port over your contribution manually if time allows, and/or third, close your pull request. If you have a major feature to stabilize over time, talk to @bmuenzenmeyer about making a dedicated `feature-branch`
-3. If you can, add some unit tests using the existing patterns in the `./test` directory
 
-##Coding style
+* _ALWAYS_ submit pull requests against the [dev branch](https://github.com/pattern-lab/patternlab-node/tree/dev). If this does not occur, I will first, try to redirect you gently, second, port over your contribution manually if time allows, and/or third, close your pull request. If you have a major feature to stabilize over time, talk to @bmuenzenmeyer via an issue about making a dedicated `feature-branch`
+* Please keep your pull requests concise and limited to **ONE** substantive change at a time. This makes reviewing and testing so much easier.
+* Commits should reference the issue you are adressing. For any Pull Request that you send, use the template provided.
+* If you can, add some unit tests using the existing patterns in the `./test` directory
+* Large enhancements should begin with opening an issue. This will result in a more systematic way for us to review your contribution and determine if a [specifcation discussion](https://github.com/pattern-lab/the-spec/issues) needs to occur.
+
+## Coding style
 Two files combine within the project to define and maintain our coding style.
 
 * The `.editorconfig` controls spaces / tabs within supported editors. Check out their [site](http://editorconfig.org/).

.github/stale.yml

@@ -0,0 +1,17 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - staged for next release
+  - pinned
+# Label to use when marking an issue as stale
+staleLabel: needs response
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

README.md

@@ -10,13 +10,14 @@ This repository contains the core functionality for Pattern Lab Node. Pattern La
 
 ## Support for Pattern Lab Node
 
-Pattern Lab Node wouldn't be what it is today without the support of the community. It will always be free and open source. Continued development is made possible in part from the support of [these wonderful project supporters](https://github.com/pattern-lab/patternlab-node/wiki/Thanks). If you want to learn more about supporting the project, visit the [Pattern Lab Node Patreon page](https://www.patreon.com/patternlab).   
+Pattern Lab Node wouldn't be what it is today without the support of the community. It will always be free and open source. Continued development is made possible in part from the support of [these wonderful project supporters](https://github.com/pattern-lab/patternlab-node/wiki/Thanks). If you want to learn more about supporting the project, visit the [Pattern Lab Node Patreon page](https://www.patreon.com/patternlab).
 
-**:100: Thanks for support from the following:** 
+**:100: Thanks for support from the following:**
 
 * **[Brad Frost](http://bradfrost.com/)**
 * [Marcos Peebles](https://twitter.com/marcospeebles)
 * [Susan Simkins](https://twitter.com/susanmsimkins)
+* [Wilfred Nas](https://twitter.com/wnas)
 
 ## Installation
 

core/lib/data_loader.js

@@ -0,0 +1,63 @@
+"use strict";
+
+const glob = require('glob'),
+  _ = require('lodash'),
+  path = require('path'),
+  yaml = require('js-yaml');
+
+/**
+ * Loads a single config file, in yaml/json format.
+ *
+ * @param dataFilesPath - leave off the file extension.
+ * @param fsDep
+ * @returns {*}
+ */
+function loadFile(dataFilesPath, fsDep) {
+  const dataFilesFullPath = dataFilesPath + '{.,[!-]*.}{json,yml,yaml}';
+
+  if (dataFilesPath) {
+    const dataFiles = glob.sync(dataFilesFullPath),
+      dataFile = _.head(dataFiles);
+
+    if (dataFile && fsDep.existsSync(path.resolve(dataFile))) {
+      return yaml.safeLoad(fsDep.readFileSync(path.resolve(dataFile), 'utf8'));
+    }
+  }
+
+  return null;
+}
+
+/**
+ * Loads a set of config files from a folder, in yaml/json format.
+ *
+ * @param dataFilesPath - leave off the file extension
+ * @param excludeFileNames - leave off the file extension
+ * @param fsDep
+ * @returns Object, with merged data files, empty object if no files.
+ */
+function loadDataFromFolder(dataFilesPath, excludeFileNames, fsDep) {
+  const dataFilesFullPath = dataFilesPath + '*.{json,yml,yaml}',
+    excludeFullPath = dataFilesPath + excludeFileNames + '.{json,yml,yaml}';
+
+  const globOptions = {};
+  if (excludeFileNames) {
+    globOptions.ignore = [excludeFullPath];
+  }
+
+  const dataFiles = glob.sync(dataFilesFullPath, globOptions);
+  let mergeObject = {};
+
+  dataFiles.forEach(function (filePath) {
+    const jsonData = yaml.safeLoad(fsDep.readFileSync(path.resolve(filePath), 'utf8'));
+    mergeObject = _.merge(mergeObject, jsonData);
+  });
+
+  return mergeObject;
+}
+
+module.exports = function configFileLoader() {
+  return {
+    loadDataFromFile: loadFile,
+    loadDataFromFolder: loadDataFromFolder
+  };
+};

core/lib/object_factory.js

@@ -66,7 +66,7 @@ const Pattern = function (relPath, data, patternlab) {
 
   // Let's calculate the verbose name ahead of time! We don't use path.sep here
   // on purpose. This isn't a file name!
-  this.verbosePartial = this.subdir + '/' + this.fileName;
+  this.verbosePartial = this.subdir.split(path.sep).join('/') + '/' + this.fileName;
 
   this.isPattern = true;
   this.isFlatPattern = this.patternGroup === this.patternSubGroup;

core/lib/parameter_hunter.js

@@ -49,9 +49,10 @@ const parameter_hunter = function () {
    *   * Return paramStringWellFormed.
    *
    * @param {string} pString
+   * @param {object} patternlab
    * @returns {string} paramStringWellFormed
    */
-  function paramToJson(pString) {
+  function paramToJson(pString, patternlab) {
     let colonPos = -1;
     const keys = [];
     let paramString = pString; // to not reassign param
@@ -61,6 +62,17 @@ const parameter_hunter = function () {
     const values = [];
     let wrapper;
 
+    // attempt to parse the data in case it is already well formed JSON
+    try {
+      paramStringWellFormed = JSON.stringify(JSON.parse(pString));
+      return paramStringWellFormed;
+    } catch (err) {
+      //todo this might be a good candidate for a different log level, should we implement that someday
+      if (patternlab.config.debug) {
+        console.log(`Not valid JSON found for passed pattern parameter ${pString} will attempt to parse manually...`);
+      }
+    }
+
     //replace all escaped double-quotes with escaped unicode
     paramString = paramString.replace(/\\"/g, '\\u0022');
 
@@ -252,7 +264,7 @@ const parameter_hunter = function () {
         const leftParen = pMatch.indexOf('(');
         const rightParen = pMatch.lastIndexOf(')');
         const paramString = '{' + pMatch.substring(leftParen + 1, rightParen) + '}';
-        const paramStringWellFormed = paramToJson(paramString);
+        const paramStringWellFormed = paramToJson(paramString, patternlab);
 
         let paramData = {};
         let globalData = {};
@@ -267,6 +279,10 @@ const parameter_hunter = function () {
           console.log(err);
         }
 
+        // resolve any pattern links that might be present
+        paramData = pattern_assembler.parse_data_links_specific(patternlab, paramData, pattern.patternPartial);
+
+        //combine all data: GLOBAL DATA => PATTERN.JSON DATA => PARAMETER DATA
         let allData = _.merge(globalData, localData);
         allData = _.merge(allData, paramData);
 

core/lib/pattern_assembler.js

@@ -14,8 +14,10 @@ const smh = require('./style_modifier_hunter');
 const ph = require('./parameter_hunter');
 const ch = require('./changes_hunter');
 const jsonCopy = require('./json_copy');
+const da = require('./data_loader');
 const markdown_parser = new mp();
 const changes_hunter = new ch();
+const dataLoader = new da();
 
 //this is mocked in unit tests
 let fs = require('fs-extra'); //eslint-disable-line prefer-const
@@ -35,7 +37,7 @@ const pattern_assembler = function () {
     for (var i = 0; i < patternlab.patterns.length; i++) {
       switch (partialName) {
         case patternlab.patterns[i].relPath:
-        case patternlab.patterns[i].subdir + '/' + patternlab.patterns[i].fileName:
+        case patternlab.patterns[i].verbosePartial:
           return patternlab.patterns[i];
       }
     }
@@ -309,16 +311,13 @@ const pattern_assembler = function () {
 
     //look for a json file for this template
     try {
-      var jsonFilename = path.resolve(patternsPath, currentPattern.subdir, currentPattern.fileName + ".json");
-      try {
-        var jsonFilenameStats = fs.statSync(jsonFilename);
-      } catch (err) {
-        //not a file
-      }
-      if (jsonFilenameStats && jsonFilenameStats.isFile()) {
-        currentPattern.jsonFileData = fs.readJSONSync(jsonFilename);
+      var jsonFilename = path.resolve(patternsPath, currentPattern.subdir, currentPattern.fileName);
+      const configData = dataLoader.loadDataFromFile(jsonFilename, fs);
+
+      if (configData) {
+        currentPattern.jsonFileData = configData;
         if (patternlab.config.debug) {
-          console.log('processPatternIterative: found pattern-specific data.json for ' + currentPattern.patternPartial);
+          console.log('processPatternIterative: found pattern-specific config data for ' + currentPattern.patternPartial);
         }
       }
     }
@@ -329,17 +328,14 @@ const pattern_assembler = function () {
 
     //look for a listitems.json file for this template
     try {
-      var listJsonFileName = path.resolve(patternsPath, currentPattern.subdir, currentPattern.fileName + ".listitems.json");
-      try {
-        var listJsonFileStats = fs.statSync(listJsonFileName);
-      } catch (err) {
-        //not a file
-      }
-      if (listJsonFileStats && listJsonFileStats.isFile()) {
-        currentPattern.listitems = fs.readJSONSync(listJsonFileName);
+      var listJsonFileName = path.resolve(patternsPath, currentPattern.subdir, currentPattern.fileName + ".listitems");
+      const listItemsConfig = dataLoader.loadDataFromFile(listJsonFileName, fs);
+
+      if (listItemsConfig) {
+        currentPattern.listitems = listItemsConfig;
         buildListItems(currentPattern);
         if (patternlab.config.debug) {
-          console.log('found pattern-specific listitems.json for ' + currentPattern.patternPartial);
+          console.log('found pattern-specific listitems config for ' + currentPattern.patternPartial);
         }
       }
     }

core/lib/pattern_registry.js

@@ -62,7 +62,7 @@ PatternRegistry.prototype = {
     for (const thisPattern of patterns) {
       switch (partialName) {
         case thisPattern.relPath:
-        case thisPattern.subdir + '/' + thisPattern.fileName:
+        case thisPattern.verbosePartial:
           return thisPattern;
       }
     }

core/lib/patternlab.js

@@ -1,5 +1,5 @@
 /*
- * patternlab-node - v2.10.0 - 2017
+ * patternlab-node - v3.0.0-alpha.1 - 2017
  *
  * Brian Muenzenmeyer, Geoff Pursell, Raphael Okon, tburny and the web community.
  * Licensed under the MIT license.
@@ -12,14 +12,14 @@
 
 const diveSync = require('diveSync');
 const dive = require('dive');
-const glob = require('glob');
 const _ = require('lodash');
 const path = require('path');
 const chalk = require('chalk');
 const cleanHtml = require('js-beautify').html;
 const inherits = require('util').inherits;
 const pm = require('./plugin_manager');
 const packageInfo = require('../../package.json');
+const dataLoader = require('./data_loader')();
 const plutils = require('./utilities');
 const jsonCopy = require('./json_copy');
 const PatternGraph = require('./pattern_graph').PatternGraph;
@@ -29,6 +29,7 @@ const sm = require('./starterkit_manager');
 const pe = require('./pattern_exporter');
 const Pattern = require('./object_factory').Pattern;
 const CompileState = require('./object_factory').CompileState;
+const updateNotifier = require('update-notifier');
 
 //these are mocked in unit tests, so let them be overridden
 let fs = require('fs-extra'); // eslint-disable-line
@@ -48,14 +49,20 @@ plutils.log.on('info', msg => console.log(msg));
 const patternEngines = require('./pattern_engines');
 const EventEmitter = require('events').EventEmitter;
 
+//bootstrap update notifier
+updateNotifier({
+  pkg: packageInfo,
+  updateCheckInterval: 1000 * 60 * 60 * 24 // notify at most once a day
+}).notify();
+
+/**
+ * Given a path, load info from the folder to compile into a single config object.
+ * @param dataFilesPath
+ * @param fsDep
+ * @returns {{}}
+ */
 function buildPatternData(dataFilesPath, fsDep) {
-  const dataFiles = glob.sync(dataFilesPath + '*.json', {"ignore" : [dataFilesPath + 'listitems.json']});
-  let mergeObject = {};
-  dataFiles.forEach(function (filePath) {
-    const jsonData = fsDep.readJSONSync(path.resolve(filePath), 'utf8');
-    mergeObject = _.merge(mergeObject, jsonData);
-  });
-  return mergeObject;
+  return dataLoader.loadDataFromFolder(dataFilesPath, 'listitems', fsDep);
 }
 
 // GTP: these two diveSync pattern processors factored out so they can be reused
@@ -542,9 +549,9 @@ const patternlab_engine = function (config) {
       patternlab.data = {};
     }
     try {
-      patternlab.listitems = fs.readJSONSync(path.resolve(paths.source.data, 'listitems.json'));
+      patternlab.listitems = dataLoader.loadDataFromFile(path.resolve(paths.source.data, 'listitems'), fs);
     } catch (ex) {
-      plutils.warning('WARNING: missing or malformed ' + paths.source.data + 'listitems.json file.  Pattern Lab may not work without this file.');
+      plutils.warning('WARNING: missing or malformed ' + paths.source.data + 'listitems file.  Pattern Lab may not work without this file.');
       patternlab.listitems = {};
     }
     try {

core/lib/ui_builder.js

@@ -595,6 +595,9 @@ const ui_builder = function () {
     //plugins
     output += 'var plugins = ' + JSON.stringify(patternlab.plugins || []) + ';' + eol;
 
+    //theme
+    output += 'var theme = ' + JSON.stringify(patternlab.config.theme) + ';' + eol;
+
     //smaller config elements
     output += 'var defaultShowPatternInfo = ' + (patternlab.config.defaultShowPatternInfo ? patternlab.config.defaultShowPatternInfo : 'false') + ';' + eol;
     output += 'var defaultPattern = "' + (patternlab.config.defaultPattern ? patternlab.config.defaultPattern : 'all') + '";' + eol;