feat(unit tests): Unit test coverage for loadPattern

Author: bmuenzenmeyer

core/lib/loadPattern.js

@@ -19,8 +19,8 @@ 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[]
+// 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;
@@ -47,12 +47,10 @@ module.exports = function (relPath, patternlab) {
         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.patternDesc = subTypeMarkdown ? subTypeMarkdown.markdown : '';
         subTypePattern.flatPatternPath = subTypePattern.flatPatternPath + '-' + subTypePattern.fileName;
         subTypePattern.isPattern = false;
         subTypePattern.engine = null;
-
         patternlab.subtypePatterns[subTypePattern.patternPartial] = subTypePattern;
 
         return subTypePattern;
@@ -65,7 +63,6 @@ module.exports = function (relPath, patternlab) {
     }
   }
 
-
   //extract some information
   var filename = fileObject.base;
   var ext = fileObject.ext;

core/lib/object_factory.js

@@ -58,7 +58,7 @@ const Pattern = function (relPath, data, patternlab) {
 
   // calculated path from the root of the public directory to the generated
   // (rendered!) html file for this pattern, to be shown in the iframe
-  this.patternLink = patternlab ? this.getPatternLink(patternlab, 'rendered') : null;
+  this.patternLink = this.patternSectionSubtype ? `$${this.name}/index.html` : (patternlab ? this.getPatternLink(patternlab, 'rendered') : null);
 
   // The canonical "key" by which this pattern is known. This is the callable
   // name of the pattern. UPDATE: this.key is now known as this.patternPartial

test/files/_patterns/patternType1/patternSubType1.md

@@ -0,0 +1,4 @@
+---
+title: Colors
+---
+Colors

test/loadPattern_tests.js

@@ -0,0 +1,84 @@
+"use strict";
+
+const path = require('path');
+const tap = require('tap');
+
+const loadPattern = require('../core/lib/loadPattern');
+const util = require('./util/test_utils.js');
+const patternEngines = require('../core/lib/pattern_engines');
+var config = require('./util/patternlab-config.json');
+
+patternEngines.loadAllEngines(config);
+
+const patterns_dir = './test/files/_patterns';
+
+tap.test('loadPattern - returns null if file is not a pattern', function (test) {
+  //arrange
+  const patternlab = util.fakePatternLab(patterns_dir);
+  var patternPath = path.join('00-test', '03-styled-atom.json');
+
+  //act
+  var result = loadPattern(patternPath, patternlab);
+
+  //assert
+  test.equals(result, null);
+  test.end();
+});
+
+tap.test('loadPattern - loads pattern sibling json if found', function (test) {
+  //arrange
+  const patternlab = util.fakePatternLab(patterns_dir);
+  var patternPath = path.join('00-test', '03-styled-atom.mustache');
+
+  //act
+  var result = loadPattern(patternPath, patternlab);
+
+  //assert
+  test.equals(result.jsonFileData.message, 'baseMessage');
+  test.end();
+});
+
+tap.test('loadPattern - adds the pattern to the patternlab.partials object', function (test) {
+  //arrange
+  const patternlab = util.fakePatternLab(patterns_dir);
+  var fooPatternPath = path.join('00-test', '01-bar.mustache');
+
+  //act
+  var result = loadPattern(fooPatternPath, patternlab);
+
+  //assert
+  test.equals(util.sanitized(patternlab.partials['test-bar']), 'bar');
+  test.end();
+});
+
+tap.test('loadPattern - returns pattern with template populated', function (test) {
+  //arrange
+  const patternlab = util.fakePatternLab(patterns_dir);
+  var fooPatternPath = path.join('00-test', '01-bar.mustache');
+
+  //act
+  var result = loadPattern(fooPatternPath, patternlab);
+
+  //assert
+  test.equals(util.sanitized(result.template), util.sanitized('bar'));
+  test.end();
+});
+
+tap.test('loadPattern - adds a markdown pattern if encountered', function (test) {
+  //arrange
+  const patternlab = util.fakePatternLab(patterns_dir);
+  var colorsMarkDownPath = path.join('patternType1', 'patternSubType1.md');
+
+  //act
+  var result = loadPattern(colorsMarkDownPath, patternlab);
+
+  //assert
+  const subTypePattern = patternlab.subtypePatterns['patternType1-patternSubType1'];
+  test.equals(subTypePattern.patternSectionSubtype, true);
+  test.equals(subTypePattern.isPattern, false);
+  test.equals(subTypePattern.patternDesc, '<p>Colors</p>\n');
+  test.equals(subTypePattern.engine, null);
+  test.equals(subTypePattern.flatPatternPath, 'patternType1-patternSubType1');
+  test.equals(result, subTypePattern);
+  test.end();
+});

test/util/test_utils.js

@@ -12,6 +12,7 @@ module.exports = {
       graph: PatternGraph.empty(),
       partials: {},
       patterns: [],
+      subtypePatterns: {},
       footer: '',
       header: '',
       listitems: {},