Rename config_loader to data_loader

Author: Brandon Morrison

core/lib/config_file_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}';
+
+  let globOptions = {};
+  if (excludeFileNames) {
+    globOptions.ignore = [excludeFullPath];
+  }
+
+  const dataFiles = glob.sync(dataFilesFullPath, globOptions);
+  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 {
+    loadDataFromFile: loadFile,
+    loadDataFromFolder: loadDataFromFolder
+  };
+};

core/lib/data_loader.js

@@ -8,7 +8,7 @@ var path = require('path'),
   pph = require('./pseudopattern_hunter'),
   mp = require('./markdown_parser'),
   plutils = require('./utilities'),
-  configLoader = require('./config_file_loader')(),
+  dataLoader = require('./data_loader')(),
   patternEngines = require('./pattern_engines'),
   lh = require('./lineage_hunter'),
   lih = require('./list_item_hunter'),
@@ -320,7 +320,7 @@ var pattern_assembler = function () {
     //look for a json file for this template
     try {
       var jsonFilename = path.resolve(patternsPath, currentPattern.subdir, currentPattern.fileName);
-      let configData = configLoader.loadConfigFromFile(jsonFilename, fs);
+      let configData = dataLoader.loadDataFromFile(jsonFilename, fs);
 
       if (configData) {
         currentPattern.jsonFileData = configData;
@@ -337,7 +337,7 @@ var pattern_assembler = function () {
     //look for a listitems.json file for this template
     try {
       var listJsonFileName = path.resolve(patternsPath, currentPattern.subdir, currentPattern.fileName + ".listitems");
-      let listItemsConfig = configLoader.loadConfigFromFile(listJsonFileName, fs);
+      let listItemsConfig = dataLoader.loadDataFromFile(listJsonFileName, fs);
 
       if (listItemsConfig) {
         currentPattern.listitems = listItemsConfig;

core/lib/pattern_assembler.js

@@ -19,7 +19,7 @@ var diveSync = require('diveSync'),
   pm = require('./plugin_manager'),
   fs = require('fs-extra'),
   packageInfo = require('../../package.json'),
-  configLoader = require('./config_file_loader')(),
+  dataLoader = require('./data_loader')(),
   plutils = require('./utilities'),
   PatternGraph = require('./pattern_graph').PatternGraph;
 
@@ -45,7 +45,7 @@ var EventEmitter = require('events').EventEmitter;
  * @returns {{}}
  */
 function buildPatternData(dataFilesPath, fsDep) {
-  return configLoader.loadConfigFromFolder(dataFilesPath, 'listitems', fsDep);
+  return dataLoader.loadDataFromFolder(dataFilesPath, 'listitems', fsDep);
 }
 
 // GTP: these two diveSync pattern processors factored out so they can be reused
@@ -492,7 +492,7 @@ var patternlab_engine = function (config) {
       patternlab.data = {};
     }
     try {
-      patternlab.listitems = configLoader.loadConfigFromFile(path.resolve(paths.source.data, 'listitems.{json,yml,yaml}'));
+      patternlab.listitems = dataLoader.loadDataFromFile(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 = {};

core/lib/patternlab.js

@@ -0,0 +1,13 @@
+'use strict';
+
+const tap = require('tap');
+
+tap.test('loadDataFromFile - Load ', function(test){
+  const fs = require('fs-extra'),
+    dataLoader = require('../core/lib/data_loader')(),
+    data_dir = './test/files/_data/';
+
+  let data = dataLoader.loadDataFromFile(data_dir + 'foo', fs);
+  test.equals(data.foo, 'bar');
+  test.end();
+});