349: Implement configFileLoader helper methods, refactor config loader to use helper methods

Author: Brandon Morrison

core/lib/config_file_loader.js

@@ -0,0 +1,54 @@
+"use strict";
+
+const glob = require('glob'),
+  _ = require('lodash'),
+  path = require('path'),
+  yaml = require('js-yaml');
+
+/**
+ *
+ * @param dataFilesPath
+ * @param fsDep
+ * @returns {*}
+ */
+function loadFile(dataFilesPath, fsDep) {
+  const dataFilesFullPath = dataFilesPath + '*.{json,yml,yaml}';
+
+  const dataFiles = glob.sync(dataFilesFullPath),
+    dataFile = _.head(dataFiles);
+
+  if (fsDep.existsSync(path.resolve(dataFile))) {
+    return yaml.safeLoad(fsDep.readFileSync(path.resolve(dataFile), 'utf8'));
+  }
+
+  return null;
+}
+
+/**
+ *
+ * @param dataFilesPath
+ * @param excludeFileNames
+ * @param fsDep
+ * @returns {{}}
+ */
+function loadConfigFromFolder(dataFilesPath, excludeFileNames, fsDep) {
+  const dataFilesFullPath = dataFilesPath + '*.{json,yml,yaml}',
+    excludeFullPath = dataFilesPath + excludeFileNames + '.{json,yml,yaml}';
+
+  const dataFiles = glob.sync(dataFilesFullPath, {"ignore" : [excludeFullPath]});
+  let mergeObject = {};
+
+  dataFiles.forEach(function (filePath) {
+    let jsonData = yaml.safeLoad(fsDep.readFileSync(path.resolve(filePath), 'utf8'));
+    mergeObject = _.merge(mergeObject, jsonData);
+  });
+
+  return mergeObject;
+}
+
+module.exports = function configFileLoader() {
+  return {
+    loadConfigFromFile: loadFile,
+    loadConfigFromFolder: loadConfigFromFolder
+  };
+};

core/lib/pattern_assembler.js

@@ -8,6 +8,7 @@ var path = require('path'),
   pph = require('./pseudopattern_hunter'),
   mp = require('./markdown_parser'),
   plutils = require('./utilities'),
+  configLoader = require('./config_file_loader')(),
   patternEngines = require('./pattern_engines'),
   lh = require('./lineage_hunter'),
   lih = require('./list_item_hunter'),
@@ -318,16 +319,13 @@ var 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);
+      let configData = configLoader.loadConfigFromFile(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);
         }
       }
     }
@@ -338,17 +336,14 @@ var 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");
+      let listItemsConfig = configLoader.loadConfigFromFile(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/patternlab.js

@@ -11,16 +11,15 @@
 "use strict";
 
 var diveSync = require('diveSync'),
-  glob = require('glob'),
   _ = require('lodash'),
   path = require('path'),
   chalk = require('chalk'),
-  yaml = require('js-yaml'),
   cleanHtml = require('js-beautify').html,
   inherits = require('util').inherits,
   pm = require('./plugin_manager'),
   fs = require('fs-extra'),
   packageInfo = require('../../package.json'),
+  configLoader = require('./config_file_loader')(),
   plutils = require('./utilities'),
   PatternGraph = require('./pattern_graph').PatternGraph;
 
@@ -46,14 +45,7 @@ var EventEmitter = require('events').EventEmitter;
  * @returns {{}}
  */
 function buildPatternData(dataFilesPath, fsDep) {
-  let dataFiles = glob.sync(dataFilesPath + '*.{json,yml,yaml}', {"ignore" : [dataFilesPath + 'listitems.{json,yml,yaml}']});
-  let mergeObject = {};
-  dataFiles.forEach(function (filePath) {
-    let jsonData = yaml.safeLoad(fsDep.readFileSync(path.resolve(filePath), 'utf8'));
-    mergeObject = _.merge(mergeObject, jsonData);
-  });
-
-  return mergeObject;
+  return configLoader.loadConfigFromFolder(dataFilesPath, 'listitems', fsDep);
 }
 
 // GTP: these two diveSync pattern processors factored out so they can be reused
@@ -500,13 +492,7 @@ var patternlab_engine = function (config) {
       patternlab.data = {};
     }
     try {
-      let dataFiles = glob.sync(paths.source.data + 'listitems.{json,yml,yaml}');
-      let mergeObject = {};
-      dataFiles.forEach(function (filePath) {
-        let jsonData = yaml.safeLoad(fs.readFileSync(path.resolve(filePath), 'utf8'));
-        mergeObject = _.merge(mergeObject, jsonData);
-      });
-      patternlab.listitems = mergeObject;
+      patternlab.listitems = configLoader.loadConfigFromFile(path.resolve(paths.source.data, 'listitems.{json,yml,yaml}'));
     } catch (ex) {
       plutils.warning('WARNING: missing or malformed ' + paths.source.data + 'listitems file.  Pattern Lab may not work without this file.');
       patternlab.listitems = {};