fix(tests): Fix tests across many files

why you so broke synchronous pattern lab?

Author: bmuenzenmeyer

core/lib/decompose.js

@@ -21,7 +21,7 @@ function expandPartials(foundPatternPartials, patternlab, currentPattern) {
 
   // determine if the template contains any pattern parameters. if so they
   // must be immediately consumed
-  parameter_hunter.find_parameters(currentPattern, patternlab).then(() => {
+  return parameter_hunter.find_parameters(currentPattern, patternlab).then(() => {
 
     //do something with the regular old partials
     for (var i = 0; i < foundPatternPartials.length; i++) {
@@ -37,20 +37,22 @@ function expandPartials(foundPatternPartials, patternlab, currentPattern) {
         }
       }
 
-      //recurse through nested partials to fill out this extended template.
-      processRecursive(partialPath, patternlab);
-
-      //complete assembly of extended template
-      //create a copy of the partial so as to not pollute it after the getPartial call.
-      var partialPattern = getPartial(partial, patternlab);
-      var cleanPartialPattern = jsonCopy(partialPattern, `partial pattern ${partial}`);
+      console.log(processRecursive);
 
-      //if partial has style modifier data, replace the styleModifier value
-      if (currentPattern.stylePartials && currentPattern.stylePartials.length > 0) {
-        style_modifier_hunter.consume_style_modifier(cleanPartialPattern, foundPatternPartials[i], patternlab);
-      }
+      //recurse through nested partials to fill out this extended template.
+      processRecursive(partialPath, patternlab).then(() => { //eslint-disable-line no-loop-func
+        //complete assembly of extended template
+        //create a copy of the partial so as to not pollute it after the getPartial call.
+        var partialPattern = getPartial(partial, patternlab);
+        var cleanPartialPattern = jsonCopy(partialPattern, `partial pattern ${partial}`);
+
+        //if partial has style modifier data, replace the styleModifier value
+        if (currentPattern.stylePartials && currentPattern.stylePartials.length > 0) {
+          style_modifier_hunter.consume_style_modifier(cleanPartialPattern, foundPatternPartials[i], patternlab);
+        }
 
-      currentPattern.extendedTemplate = currentPattern.extendedTemplate.replace(foundPatternPartials[i], cleanPartialPattern.extendedTemplate);
+        currentPattern.extendedTemplate = currentPattern.extendedTemplate.replace(foundPatternPartials[i], cleanPartialPattern.extendedTemplate);
+      });
     }
   });
 }
@@ -94,9 +96,7 @@ module.exports = function (pattern, patternlab, ignoreLineage) {
 
   //find pattern lineage
   if (!ignoreLineage) {
-    lineagePromise.resolve(() => {
-      lineage_hunter.find_lineage(pattern, patternlab);
-    });
+    lineagePromise = Promise.resolve(lineage_hunter.find_lineage(pattern, patternlab));
   } else {
     lineagePromise = Promise.resolve();
   }

core/lib/lineage_hunter.js

@@ -1,14 +1,12 @@
 'use strict';
 const extend = require("util")._extend;
+const getPartial = require('./get');
 const logger = require('./log');
 
 const lineage_hunter = function () {
 
   function findlineage(pattern, patternlab) {
 
-    const pa = require('./pattern_assembler');
-    const pattern_assembler = new pa();
-
     // As we are adding edges from pattern to ancestor patterns, ensure it is known to the graph
     patternlab.graph.add(pattern);
 
@@ -18,7 +16,7 @@ const lineage_hunter = function () {
     if (matches !== null) {
       matches.forEach(function (match) {
         //get the ancestorPattern
-        const ancestorPattern = pattern_assembler.getPartial(pattern.findPartial(match), patternlab);
+        const ancestorPattern = getPartial(pattern.findPartial(match), patternlab);
 
         if (ancestorPattern && pattern.lineageIndex.indexOf(ancestorPattern.patternPartial) === -1) {
           //add it since it didnt exist
@@ -99,8 +97,6 @@ const lineage_hunter = function () {
 
           //find all lineage - patterns being consumed by this one
           for (let h = 0; h < lineage.length; h++) {
-            // Not needed, the graph already knows the concrete pattern
-            // let lineagePattern = pattern_assembler.getPartial(lineageIndex[h], patternlab);
             setPatternState('fromFuture', lineage[h], pattern, patternlab.graph);
           }
         }

core/lib/list_item_hunter.js

@@ -122,7 +122,7 @@ const list_item_hunter = function () {
         }
 
         //replace the block with our generated HTML
-        const repeatingBlock = pattern.extendedTemplate.substring(pattern.extendedTemplate.indexOf(liMatch), pattern.extendedTemplate.indexOf(end) + end.length);
+        //const repeatingBlock = pattern.extendedTemplate.substring(pattern.extendedTemplate.indexOf(liMatch), pattern.extendedTemplate.indexOf(end) + end.length);
 
         //pattern.extendedTemplate = pattern.extendedTemplate.replace(repeatingBlock, repeatedBlockHtml); //todo
 

core/lib/pattern_assembler.js

@@ -12,6 +12,7 @@ const ch = require('./changes_hunter');
 const da = require('./data_loader');
 const addPattern = require('./addPattern');
 const parseLink = require('./parseLink');
+const readDocumentation = require('./readDocumentation');
 
 const markdown_parser = new mp();
 const changes_hunter = new ch();
@@ -46,59 +47,6 @@ const pattern_assembler = function () {
     }
   }
 
-  function parsePatternMarkdown(currentPattern, patternlab) {
-
-    try {
-      var markdownFileName = path.resolve(patternlab.config.paths.source.patterns, currentPattern.subdir, currentPattern.fileName + ".md");
-      changes_hunter.checkLastModified(currentPattern, markdownFileName);
-
-      var markdownFileContents = fs.readFileSync(markdownFileName, 'utf8');
-
-      var markdownObject = markdown_parser.parse(markdownFileContents);
-      if (!_.isEmpty(markdownObject)) {
-        //set keys and markdown itself
-        currentPattern.patternDescExists = true;
-        currentPattern.patternDesc = markdownObject.markdown;
-
-        //Add all markdown to the currentPattern, including frontmatter
-        currentPattern.allMarkdown = markdownObject;
-
-        //consider looping through all keys eventually. would need to blacklist some properties and whitelist others
-        if (markdownObject.state) {
-          currentPattern.patternState = markdownObject.state;
-        }
-        if (markdownObject.order) {
-          currentPattern.order = markdownObject.order;
-        }
-        if (markdownObject.hidden) {
-          currentPattern.hidden = markdownObject.hidden;
-        }
-        if (markdownObject.excludeFromStyleguide) {
-          currentPattern.excludeFromStyleguide = markdownObject.excludeFromStyleguide;
-        }
-        if (markdownObject.tags) {
-          currentPattern.tags = markdownObject.tags;
-        }
-        if (markdownObject.title) {
-          currentPattern.patternName = markdownObject.title;
-        }
-        if (markdownObject.links) {
-          currentPattern.links = markdownObject.links;
-        }
-      } else {
-        logger.warning(`error processing markdown for ${currentPattern.patternPartial}`);
-      }
-      logger.debug(`found pattern-specific markdown for  ${currentPattern.patternPartial}`);
-    }
-    catch (err) {
-      // do nothing when file not found
-      if (err.code !== 'ENOENT') {
-        logger.warning(`'there was an error setting pattern keys after markdown parsing of the companion file for pattern ${currentPattern.patternPartial}`);
-        logger.warning(err);
-      }
-    }
-  }
-
   // loads a pattern from disk, creates a Pattern object from it and
   // all its associated files, and records it in patternlab.patterns[]
   function loadPatternIterative(relPath, patternlab) {
@@ -199,7 +147,7 @@ const pattern_assembler = function () {
     }
 
     //look for a markdown file for this template
-    parsePatternMarkdown(currentPattern, patternlab);
+    readDocumentation(currentPattern, patternlab);
 
     //add the raw template to memory
     var templatePath = path.resolve(patternsPath, currentPattern.relPath);
@@ -304,9 +252,6 @@ const pattern_assembler = function () {
     },
     parse_data_links: function (patternlab) {
       parseDataLinks(patternlab);
-    },
-    parse_pattern_markdown: function (pattern, patternlab) {
-      parsePatternMarkdown(pattern, patternlab);
     }
   };
 

core/lib/pseudopattern_hunter.js

@@ -7,15 +7,15 @@ const _ = require('lodash');
 const lh = require('./lineage_hunter');
 const Pattern = require('./object_factory').Pattern;
 const path = require('path');
+const addPattern = require('./addPattern');
 const logger = require('./log');
+const readDocumentation = require('./readDocumentation');
 const lineage_hunter = new lh();
 const changes_hunter = new ch();
 
 const pseudopattern_hunter = function () {};
 
 pseudopattern_hunter.prototype.find_pseudopatterns = function (currentPattern, patternlab) {
-  const pa = require('./pattern_assembler');
-  const pattern_assembler = new pa();
 
   const paths = patternlab.config.paths;
 
@@ -70,13 +70,13 @@ pseudopattern_hunter.prototype.find_pseudopatterns = function (currentPattern, p
       patternlab.graph.link(patternVariant, currentPattern);
 
       //process the companion markdown file if it exists
-      pattern_assembler.parse_pattern_markdown(patternVariant, patternlab);
+      readDocumentation(patternVariant, patternlab);
 
       //find pattern lineage
       lineage_hunter.find_lineage(patternVariant, patternlab);
 
       //add to patternlab object so we can look these up later.
-      pattern_assembler.addPattern(patternVariant, patternlab);
+      addPattern(patternVariant, patternlab);
     }
 
     // GTP: this is to emulate the behavior of the stale asynced

core/lib/readDocumentation.js

@@ -0,0 +1,67 @@
+"use strict";
+
+const path = require('path');
+const _ = require('lodash');
+
+const ch = require('./changes_hunter');
+const logger = require('./log');
+const mp = require('./markdown_parser');
+
+const changes_hunter = new ch();
+const markdown_parser = new mp();
+
+let fs = require('fs-extra'); //eslint-disable-line prefer-const
+
+module.exports = function (pattern, patternlab) {
+
+  try {
+    var markdownFileName = path.resolve(patternlab.config.paths.source.patterns, pattern.subdir, pattern.fileName + ".md");
+    changes_hunter.checkLastModified(pattern, markdownFileName);
+
+    var markdownFileContents = fs.readFileSync(markdownFileName, 'utf8');
+
+    var markdownObject = markdown_parser.parse(markdownFileContents);
+    if (!_.isEmpty(markdownObject)) {
+      //set keys and markdown itself
+      pattern.patternDescExists = true;
+      pattern.patternDesc = markdownObject.markdown;
+
+      //Add all markdown to the pattern, including frontmatter
+      pattern.allMarkdown = markdownObject;
+
+      //consider looping through all keys eventually. would need to blacklist some properties and whitelist others
+      if (markdownObject.state) {
+        pattern.patternState = markdownObject.state;
+      }
+      if (markdownObject.order) {
+        pattern.order = markdownObject.order;
+      }
+      if (markdownObject.hidden) {
+        pattern.hidden = markdownObject.hidden;
+      }
+      if (markdownObject.excludeFromStyleguide) {
+        pattern.excludeFromStyleguide = markdownObject.excludeFromStyleguide;
+      }
+      if (markdownObject.tags) {
+        pattern.tags = markdownObject.tags;
+      }
+      if (markdownObject.title) {
+        pattern.patternName = markdownObject.title;
+      }
+      if (markdownObject.links) {
+        pattern.links = markdownObject.links;
+      }
+    } else {
+      logger.warning(`error processing markdown for ${pattern.patternPartial}`);
+    }
+    logger.debug(`found pattern-specific markdown for  ${pattern.patternPartial}`);
+  }
+  catch (err) {
+    // do nothing when file not found
+    if (err.code !== 'ENOENT') {
+      logger.warning(`'there was an error setting pattern keys after markdown parsing of the companion file for pattern ${pattern.patternPartial}`);
+      logger.warning(err);
+    }
+  }
+
+};

core/lib/ui_builder.js

@@ -9,7 +9,7 @@ const ae = require('./annotation_exporter');
 const of = require('./object_factory');
 const Pattern = of.Pattern;
 const logger = require('./log');
-const renderSync = require('./lib/renderSync');
+const renderSync = require('./renderSync');
 
 //these are mocked in unit tests, so let them be overridden
 let fs = require('fs-extra'); //eslint-disable-line prefer-const

test/addPattern_tests.js

@@ -0,0 +1,45 @@
+"use strict";
+
+const tap = require('tap');
+
+const addPattern = require('../core/lib/addPattern');
+var Pattern = require('../core/lib/object_factory').Pattern;
+const util = require('./util/test_utils.js');
+
+const patterns_dir = './test/files/_patterns';
+
+tap.test('addPattern - adds pattern extended template to patternlab partial object', function (test) {
+  //arrange
+  const patternlab = util.fakePatternLab(patterns_dir);
+
+  var pattern = new Pattern('00-test/01-bar.mustache');
+  pattern.extendedTemplate = 'barExtended';
+  pattern.template = 'bar';
+
+  //act
+  addPattern(pattern, patternlab);
+
+  //assert
+  test.equals(patternlab.patterns.length, 1);
+  test.equals(patternlab.partials['test-bar'] !== undefined, true);
+  test.equals(patternlab.partials['test-bar'], 'barExtended');
+  test.end();
+});
+
+tap.test('addPattern - adds pattern template to patternlab partial object if extendedtemplate does not exist yet', function (test){
+  //arrange
+  const patternlab = util.fakePatternLab(patterns_dir);
+
+  var pattern = new Pattern('00-test/01-bar.mustache');
+  pattern.extendedTemplate = undefined;
+  pattern.template = 'bar';
+
+  //act
+  addPattern(pattern, patternlab);
+
+  //assert
+  test.equals(patternlab.patterns.length, 1);
+  test.equals(patternlab.partials['test-bar'] !== undefined, true);
+  test.equals(patternlab.partials['test-bar'], 'bar');
+  test.end();
+});