simplify patternlab.js

fix last of unit tests

Author: bmuenzenmeyer

.vscode/launch.json

@@ -0,0 +1,20 @@
+{
+    // Use IntelliSense to learn about possible Node.js debug attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Launch Program",
+            "program": "${workspaceRoot}\\core\\lib\\patternlab.js"
+        },
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Debug",
+            "program": "${workspaceRoot}\\test\\patternlab_tests.js"
+        }
+    ]
+}

core/lib/patternlab.js

@@ -19,11 +19,24 @@ const chalk = require('chalk');
 const cleanHtml = require('js-beautify').html;
 const inherits = require('util').inherits;
 const pm = require('./plugin_manager');
-const fs = require('fs-extra');
 const packageInfo = require('../../package.json');
 const plutils = require('./utilities');
 const jsonCopy = require('./json_copy');
 const PatternGraph = require('./pattern_graph').PatternGraph;
+const pa = require('./pattern_assembler');
+const lh = require('./lineage_hunter');
+const sm = require('./starterkit_manager');
+const pe = require('./pattern_exporter');
+const Pattern = require('./object_factory').Pattern;
+const CompileState = require('./object_factory').CompileState;
+
+//these are mocked in unit tests, so let them be overridden
+let fs = require('fs-extra'); // eslint-disable-line
+let ui_builder = require('./ui_builder'); // eslint-disable-line
+let pattern_exporter = new pe(); // eslint-disable-line
+
+const pattern_assembler = new pa();
+const lineage_hunter = new lh();
 
 //register our log events
 plutils.log.on('error', msg => console.log(msg));
@@ -46,7 +59,7 @@ function buildPatternData(dataFilesPath, fsDep) {
 
 // GTP: these two diveSync pattern processors factored out so they can be reused
 // from unit tests to reduce code dupe!
-function processAllPatternsIterative(pattern_assembler, patterns_dir, patternlab) {
+function processAllPatternsIterative(patterns_dir, patternlab) {
 
   const promiseAllPatternFiles = new Promise(function (resolve) {
     dive(
@@ -84,7 +97,7 @@ function processAllPatternsIterative(pattern_assembler, patterns_dir, patternlab
   });
 }
 
-function processAllPatternsRecursive(pattern_assembler, patterns_dir, patternlab) {
+function processAllPatternsRecursive(patterns_dir, patternlab) {
   diveSync(
     patterns_dir,
     function (err, file) {
@@ -164,24 +177,11 @@ function PatternLabEventEmitter() {
 inherits(PatternLabEventEmitter, EventEmitter);
 
 const patternlab_engine = function (config) {
-  'use strict';
-
-  const pa = require('./pattern_assembler');
-  const pe = require('./pattern_exporter');
-  const lh = require('./lineage_hunter');
-  const ui = require('./ui_builder');
-  const sm = require('./starterkit_manager');
-  const Pattern = require('./object_factory').Pattern;
-  const CompileState = require('./object_factory').CompileState;
   const patternlab = {};
 
   patternlab.engines = patternEngines;
   patternlab.engines.loadAllEngines(config);
 
-  const pattern_assembler = new pa();
-  const pattern_exporter = new pe();
-  const lineage_hunter = new lh();
-
   patternlab.package = fs.readJSONSync(path.resolve(__dirname, '../../package.json'));
   patternlab.config = config || fs.readJSONSync(path.resolve(__dirname, '../../patternlab-config.json'));
   patternlab.events = new PatternLabEventEmitter();
@@ -563,18 +563,18 @@ const patternlab_engine = function (config) {
     patternlab.events.emit('patternlab-build-global-data-end', patternlab);
 
     // diveSync once to perform iterative populating of patternlab object
-    return processAllPatternsIterative(pattern_assembler, paths.source.patterns, patternlab).then(() => {
+    return processAllPatternsIterative(paths.source.patterns, patternlab).then(() => {
 
       patternlab.events.emit('patternlab-pattern-iteration-end', patternlab);
 
       //now that all the main patterns are known, look for any links that might be within data and expand them
       //we need to do this before expanding patterns & partials into extendedTemplates, otherwise we could lose the data -> partial reference
-      pattern_assembler.parse_data_links(patternlab);      
+      pattern_assembler.parse_data_links(patternlab);
 
       //diveSync again to recursively include partials, filling out the
       //extendedTemplate property of the patternlab.patterns elements
       // TODO we can reduce the time needed by only processing changed patterns and their partials
-      processAllPatternsRecursive(pattern_assembler, paths.source.patterns, patternlab);
+      processAllPatternsRecursive(paths.source.patterns, patternlab);
 
       //take the user defined head and foot and process any data and patterns that apply
       processHeadPattern();
@@ -654,7 +654,7 @@ const patternlab_engine = function (config) {
       }
       patternlab.isBusy = true;
       return buildPatterns(deletePatternDir).then(() => {
-        new ui().buildFrontend(patternlab);
+        new ui_builder().buildFrontend(patternlab);
         printDebug();
         patternlab.isBusy = false;
         callback();

pattern_exports/test-paramParent.html

@@ -0,0 +1,4 @@
+<div class="foo">
+<a href="&#x2F;patterns&#x2F;00-test-00-foo&#x2F;00-test-00-foo.rendered.html">Cool Dude</a>
+</div>
+

test/files/_patterns/00-test/01-bar.md

@@ -1,5 +1,5 @@
 ---
-status: complete
+state: complete
 title: An Atom Walks Into a Bar
 joke: bad
 ---

test/files/_patterns/00-test/02-baz.md

@@ -0,0 +1 @@
+### Only baz

test/files/_patterns/00-test/02-baz.mustache

@@ -0,0 +1 @@
+baz

test/markdown_parser_tests.js

@@ -10,14 +10,14 @@ var markdown_parser = new mp();
 
 tap.test('parses pattern description block correctly when frontmatter not present', function(test) {
     //arrange
-    var markdownFileName = path.resolve("./test/files/_patterns/00-test/00-foo.md");
+    var markdownFileName = path.resolve("./test/files/_patterns/00-test/02-baz.md");
     var markdownFileContents = fs.readFileSync(markdownFileName, 'utf8');
 
     //act
     var returnObject = markdown_parser.parse(markdownFileContents);
 
     //assert
-    test.equals(returnObject.markdown, '<h2>A Simple Include</h2>\n<p>This pattern contains an include of <code>test-bar</code>. It also has this markdown file, which does not have frontmatter.</p>\n');
+    test.equals(returnObject.markdown, '<h3>Only baz</h3>\n');
   test.end();
 });
 

test/pattern_assembler_tests.js

@@ -48,11 +48,11 @@ tap.test('process_pattern_recursive recursively includes partials', function(tes
   patternlab.partials = {};
 
   //diveSync once to perform iterative populating of patternlab object
-  plMain.process_all_patterns_iterative(pattern_assembler, patterns_dir, patternlab)
+  plMain.process_all_patterns_iterative(patterns_dir, patternlab)
     .then(() => {
       //diveSync again to recursively include partials, filling out the
       //extendedTemplate property of the patternlab.patterns elements
-      plMain.process_all_patterns_recursive(pattern_assembler, patterns_dir, patternlab);
+      plMain.process_all_patterns_recursive(patterns_dir, patternlab);
 
       //get test output for comparison
       var foo = fs.readFileSync(patterns_dir + '/00-test/00-foo.mustache', 'utf8').trim();
@@ -491,7 +491,7 @@ tap.test('parseDataLinks - replaces found link.* data for their expanded links',
   patternlab.partials = {};
 
   //diveSync once to perform iterative populating of patternlab object
-  plMain.process_all_patterns_iterative(pattern_assembler, patterns_dir, patternlab)
+  plMain.process_all_patterns_iterative( patterns_dir, patternlab)
     .then(() => {
       //for the sake of the test, also imagining I have the following pages...
       patternlab.data.link['twitter-brad'] = 'https://twitter.com/brad_frost';
@@ -740,14 +740,17 @@ tap.test('parses pattern title correctly when frontmatter present', function(tes
   var pl = util.fakePatternLab(testPatternsPath);
   var pattern_assembler = new pa();
 
-  //act
   var testPatternPath = path.join('00-test', '01-bar.mustache');
-  var testPattern = pattern_assembler.process_pattern_iterative(testPatternPath, pl);
-  pattern_assembler.process_pattern_recursive(testPatternPath, pl);
+  var testPattern = pattern_assembler.load_pattern_iterative(testPatternPath, pl);
 
-  //assert
-  test.equals(testPattern.patternName, 'An Atom Walks Into a Bar','patternName not overridden');
-  test.end();
+  //act
+  return Promise.all([
+    pattern_assembler.process_pattern_iterative(testPattern, pl),
+    pattern_assembler.process_pattern_recursive(testPatternPath, pl)
+  ]).then((results) => {
+    //assert
+    test.equals(results[0].patternName, 'An Atom Walks Into a Bar','patternName not overridden');
+  }).catch(test.threw);
 });
 
 tap.test('parses pattern extra frontmatter correctly when frontmatter present', function(test){
@@ -758,12 +761,16 @@ tap.test('parses pattern extra frontmatter correctly when frontmatter present',
   var pl = util.fakePatternLab(testPatternsPath);
   var pattern_assembler = new pa();
 
-  //act
   var testPatternPath = path.join('00-test', '01-bar.mustache');
-  var testPattern = pattern_assembler.process_pattern_iterative(testPatternPath, pl);
-  pattern_assembler.process_pattern_recursive(testPatternPath, pl);
+  var testPattern = pattern_assembler.load_pattern_iterative(testPatternPath, pl);
 
-  //assert
-  test.equals(testPattern.allMarkdown.joke, 'bad','extra key not added');
-  test.end();
-});
+  //act
+  return Promise.all([
+    pattern_assembler.process_pattern_iterative(testPattern, pl),
+    pattern_assembler.process_pattern_recursive(testPatternPath, pl)
+  ]).then((results) => {
+    //assert
+    test.equals(results[0].allMarkdown.joke, 'bad','extra key not added');
+
+  }).catch(test.threw);
+});

test/patternlab_tests.js

@@ -9,8 +9,10 @@ var config = require('./util/patternlab-config.json');
 var plEngineModule = rewire('../core/lib/patternlab');
 
 //set up a global mocks - we don't want to be writing/rendering any files right now
-const uiBuilderMock = {
-  buildFrontend: function (patternlab) { }
+const uiBuilderMock = function(){
+  return {
+    buildFrontend: function () { }
+  };
 };
 
 const fsMock = {
@@ -49,8 +51,8 @@ tap.test('buildPatterns - should replace data link even when pattern parameter p
      only on the order of events within build.
      */
     export_patterns: function (patternlab) {
-      var pattern = _.find(patternlab.patterns, (pattern) => {
-        return pattern.patternPartial === 'test-paramParent';
+      var pattern = _.find(patternlab.patterns, (p) => {
+        return p.patternPartial === 'test-paramParent';
       });
       //assert
       test.equals(pattern.patternPartialCode.indexOf('00-test-00-foo.rendered.html') > -1, true, 'data link should be replaced properly');