feat(loadPattern): Rename pattern_assembler to loadPattern and simplify export

Author: bmuenzenmeyer

core/lib/lineage_hunter.js

@@ -10,7 +10,6 @@ const lineage_hunter = function () {
     // As we are adding edges from pattern to ancestor patterns, ensure it is known to the graph
     patternlab.graph.add(pattern);
 
-
     //find the {{> template-name }} within patterns
     const matches = pattern.findPartials();
     if (matches !== null) {

core/lib/loadPattern.js

@@ -0,0 +1,146 @@
+"use strict";
+
+const path = require('path');
+
+const Pattern = require('./object_factory').Pattern;
+const mp = require('./markdown_parser');
+const logger = require('./log');
+const patternEngines = require('./pattern_engines');
+const ch = require('./changes_hunter');
+const da = require('./data_loader');
+const addPattern = require('./addPattern');
+const buildListItems = require('./buildListItems');
+const readDocumentation = require('./readDocumentation');
+
+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
+
+  // loads a pattern from disk, creates a Pattern object from it and
+  // all its associated files, and records it in patternlab.patterns[]
+module.exports = function (relPath, patternlab) {
+
+  var relativeDepth = (relPath.match(/\w(?=\\)|\w(?=\/)/g) || []).length;
+  if (relativeDepth > 2) {
+    logger.warning('');
+    logger.warning('Warning:');
+    logger.warning('A pattern file: ' + relPath + ' was found greater than 2 levels deep from ' + patternlab.config.paths.source.patterns + '.');
+    logger.warning('It\'s strongly suggested to not deviate from the following structure under _patterns/');
+    logger.warning('[patternType]/[patternSubtype]/[patternName].[patternExtension]');
+    logger.warning('');
+    logger.warning('While Pattern Lab may still function, assets may 404 and frontend links may break. Consider yourself warned. ');
+    logger.warning('Read More: http://patternlab.io/docs/pattern-organization.html');
+    logger.warning('');
+  }
+
+  //check if the found file is a top-level markdown file
+  var fileObject = path.parse(relPath);
+  if (fileObject.ext === '.md') {
+    try {
+      var proposedDirectory = path.resolve(patternlab.config.paths.source.patterns, fileObject.dir, fileObject.name);
+      var proposedDirectoryStats = fs.statSync(proposedDirectory);
+      if (proposedDirectoryStats.isDirectory()) {
+        var subTypeMarkdownFileContents = fs.readFileSync(proposedDirectory + '.md', 'utf8');
+        var subTypeMarkdown = markdown_parser.parse(subTypeMarkdownFileContents);
+        var subTypePattern = new Pattern(relPath, null, patternlab);
+        subTypePattern.patternSectionSubtype = true;
+        subTypePattern.patternLink = subTypePattern.name + '/index.html';
+        subTypePattern.patternDesc = subTypeMarkdown.markdown;
+        subTypePattern.flatPatternPath = subTypePattern.flatPatternPath + '-' + subTypePattern.fileName;
+        subTypePattern.isPattern = false;
+        subTypePattern.engine = null;
+
+        patternlab.subtypePatterns[subTypePattern.patternPartial] = subTypePattern;
+
+        return subTypePattern;
+      }
+    } catch (err) {
+      // no file exists, meaning it's a pattern markdown file
+      if (err.code !== 'ENOENT') {
+        logger.warning(err);
+      }
+    }
+  }
+
+
+  //extract some information
+  var filename = fileObject.base;
+  var ext = fileObject.ext;
+  var patternsPath = patternlab.config.paths.source.patterns;
+
+  // skip non-pattern files
+  if (!patternEngines.isPatternFile(filename, patternlab)) { return null; }
+
+  //make a new Pattern Object
+  var currentPattern = new Pattern(relPath, null, patternlab);
+
+  //if file is named in the syntax for variants
+  if (patternEngines.isPseudoPatternJSON(filename)) {
+    return currentPattern;
+  }
+
+  //can ignore all non-supported files at this point
+  if (patternEngines.isFileExtensionSupported(ext) === false) {
+    return currentPattern;
+  }
+
+  //look for a json file for this template
+  try {
+    var jsonFilename = path.resolve(patternsPath, currentPattern.subdir, currentPattern.fileName);
+    const patternData = dataLoader.loadDataFromFile(jsonFilename, fs);
+
+    if (patternData) {
+      currentPattern.jsonFileData = patternData;
+      logger.debug(`found pattern-specific data for ${currentPattern.patternPartial}`);
+    }
+  }
+  catch (err) {
+    logger.warning(`There was an error parsing sibling JSON for ${currentPattern.relPath}`);
+    logger.warning(err);
+  }
+
+  //look for a listitems.json file for this template
+  try {
+    var listJsonFileName = path.resolve(patternsPath, currentPattern.subdir, currentPattern.fileName + ".listitems");
+    const listItemsData = dataLoader.loadDataFromFile(listJsonFileName, fs);
+
+    if (listItemsData) {
+      logger.debug(`found pattern-specific listitems data for ${currentPattern.patternPartial}`);
+      currentPattern.listitems = listItemsData;
+      buildListItems(currentPattern);
+    }
+  }
+  catch (err) {
+    logger.warning(`There was an error parsing sibling listitem JSON for ${currentPattern.relPath}`);
+    logger.warning(err);
+  }
+
+  //look for a markdown file for this template
+  readDocumentation(currentPattern, patternlab);
+
+  //add the raw template to memory
+  var templatePath = path.resolve(patternsPath, currentPattern.relPath);
+
+  currentPattern.template = fs.readFileSync(templatePath, 'utf8');
+
+  //find any stylemodifiers that may be in the current pattern
+  currentPattern.stylePartials = currentPattern.findPartialsWithStyleModifiers();
+
+  //find any pattern parameters that may be in the current pattern
+  currentPattern.parameteredPartials = currentPattern.findPartialsWithPatternParameters();
+
+  [templatePath, jsonFilename, listJsonFileName].forEach(file => {
+    changes_hunter.checkLastModified(currentPattern, file);
+  });
+
+  changes_hunter.checkBuildState(currentPattern, patternlab);
+
+  //add currentPattern to patternlab.patterns array
+  addPattern(currentPattern, patternlab);
+
+  return currentPattern;
+};
+

core/lib/pattern_assembler.js

@@ -42,7 +42,7 @@ PatternRegistry.prototype = {
 
   getPartial: function (partialName) {
     /*
-     Code in here has been moved from pattern_assembler.getPartial() to prepare for some refactoring.
+     Code in here has been moved from getPartial() to prepare for some refactoring.
      There are a few advantages to this method:
      - use a map lookup instead of interating through all patterns
      - get rid of dependency to the patternlab object

core/lib/pattern_registry.js

@@ -16,7 +16,7 @@ const processIterative = require('./processIterative');
 const processRecursive = require('./processRecursive');
 const jsonCopy = require('./json_copy');
 const render = require('./render');
-const pa = require('./pattern_assembler');
+const loadPattern = require('./loadPattern');
 const sm = require('./starterkit_manager');
 const pe = require('./pattern_exporter');
 const Pattern = require('./object_factory').Pattern;
@@ -29,8 +29,6 @@ let pattern_exporter = new pe(); // eslint-disable-line
 let assetCopier = require('./asset_copy'); // eslint-disable-line
 let serve = require('./serve'); // eslint-disable-line
 
-const pattern_assembler = new pa();
-
 const patternEngines = require('./pattern_engines');
 const EventEmitter = require('events').EventEmitter;
 
@@ -458,7 +456,7 @@ module.exports = class PatternLab {
           // please, if you're reading this: don't.
 
           // NOTE: sync for now
-          pattern_assembler.load_pattern_iterative(path.relative(patterns_dir, file), self);
+          loadPattern(path.relative(patterns_dir, file), self);
         },
         resolve
       );

core/lib/patternlab.js

@@ -23,7 +23,7 @@ module.exports = function (file, patternlab) {
   //call our helper method to actually unravel the pattern with any partials
   return decompose(currentPattern, patternlab)
     .catch(reason => {
-      console.log(reason)
+      console.log(reason);
       logger.error(reason);
     });
 };

core/lib/processRecursive.js

@@ -106,7 +106,7 @@ const ui_builder = function () {
    * @returns the found or created pattern object
      */
   function injectDocumentationBlock(pattern, patternlab, isSubtypePattern) {
-    //first see if pattern_assembler processed one already
+    //first see if loadPattern processed one already
     let docPattern = patternlab.subtypePatterns[pattern.patternGroup + (isSubtypePattern ? '-' + pattern.patternSubGroup : '')];
     if (docPattern) {
       docPattern.isDocPattern = true;