feat(uikits): filter out excluded pattern states from uikit output

Author: bmuenzenmeyer

packages/core/src/lib/compose.js

@@ -7,6 +7,7 @@ const jsonCopy = require('./json_copy');
 const logger = require('./log');
 const parseLink = require('./parseLink');
 const render = require('./render');
+const uikitExcludePattern = require('./uikitExcludePattern');
 
 const Pattern = require('./object_factory').Pattern;
 const CompileState = require('./object_factory').CompileState;
@@ -37,6 +38,11 @@ module.exports = function(pattern, patternlab) {
 
   return Promise.all(
     _.map(patternlab.uikits, uikit => {
+      // exclude pattern from uikit rendering
+      if (uikitExcludePattern(pattern, uikit)) {
+        return Promise.resolve();
+      }
+
       //render the pattern, but first consolidate any data we may have
       let allData;
 

packages/core/src/lib/ui_builder.js

@@ -6,6 +6,7 @@ const _ = require('lodash');
 const of = require('./object_factory');
 const Pattern = of.Pattern;
 const logger = require('./log');
+const uikitExcludePattern = require('./uikitExcludePattern');
 
 //these are mocked in unit tests, so let them be overridden
 let render = require('./render'); //eslint-disable-line prefer-const
@@ -64,15 +65,29 @@ const ui_builder = function() {
    * Returns whether or not the pattern should be excluded from direct rendering or navigation on the front end
    * @param pattern - the pattern to test for inclusion/exclusion
    * @param patternlab - global data store
+   * @param uikit - the current uikit being built
    * @returns boolean - whether or not the pattern is excluded
    */
-  function isPatternExcluded(pattern, patternlab) {
+  function isPatternExcluded(pattern, patternlab, uikit) {
     let isOmitted;
 
+    // skip patterns that the uikit does not want to render
+    isOmitted = uikitExcludePattern(pattern, uikit);
+    if (isOmitted) {
+      logger.info(
+        `Omitting ${
+          pattern.patternPartial
+        } from styleguide patterns because its pattern state or tag is excluded within ${
+          uikit.name
+        }.`
+      );
+      return true;
+    }
+
     // skip underscore-prefixed files
     isOmitted = pattern.isPattern && pattern.fileName.charAt(0) === '_';
     if (isOmitted) {
-      logger.debug(
+      logger.info(
         `Omitting ${
           pattern.patternPartial
         } from styleguide patterns because it has an underscore suffix.`
@@ -83,7 +98,7 @@ const ui_builder = function() {
     //this is meant to be a homepage that is not present anywhere else
     isOmitted = pattern.patternPartial === patternlab.config.defaultPattern;
     if (isOmitted) {
-      logger.debug(
+      logger.info(
         `Omitting ${
           pattern.patternPartial
         } from styleguide patterns because it is defined as a defaultPattern.`
@@ -97,7 +112,7 @@ const ui_builder = function() {
       pattern.relPath.charAt(0) === '_' ||
       pattern.relPath.indexOf(path.sep + '_') > -1;
     if (isOmitted) {
-      logger.debug(
+      logger.info(
         `Omitting ${
           pattern.patternPartial
         } from styleguide patterns because its contained within an underscored directory.`
@@ -108,7 +123,7 @@ const ui_builder = function() {
     //this pattern is a head or foot pattern
     isOmitted = pattern.isMetaPattern;
     if (isOmitted) {
-      logger.debug(
+      logger.info(
         `Omitting ${
           pattern.patternPartial
         } from styleguide patterns because its a meta pattern.`
@@ -427,16 +442,21 @@ const ui_builder = function() {
   /**
    * Returns an object representing how the front end styleguide and navigation is structured
    * @param patternlab - global data store
+   * @param uikit - the current uikit being built
    * @returns ptterns grouped by type -> subtype like atoms -> global -> pattern, pattern, pattern
    */
-  function groupPatterns(patternlab) {
+  function groupPatterns(patternlab, uikit) {
     const groupedPatterns = {
       patternGroups: {},
     };
 
     _.forEach(patternlab.patterns, function(pattern) {
       //ignore patterns we can omit from rendering directly
-      pattern.omitFromStyleguide = isPatternExcluded(pattern, patternlab);
+      pattern.omitFromStyleguide = isPatternExcluded(
+        pattern,
+        patternlab,
+        uikit
+      );
       if (pattern.omitFromStyleguide) {
         return;
       }
@@ -729,10 +749,10 @@ const ui_builder = function() {
 
     const paths = patternlab.config.paths;
 
-    //determine which patterns should be included in the front-end rendering
-    const styleguidePatterns = groupPatterns(patternlab);
-
     const uikitPromises = _.map(patternlab.uikits, uikit => {
+      //determine which patterns should be included in the front-end rendering
+      const styleguidePatterns = groupPatterns(patternlab, uikit);
+
       return new Promise(resolve => {
         //set the pattern-specific header by compiling the general-header with data, and then adding it to the meta header
         const headerPromise = render(
@@ -880,11 +900,11 @@ const ui_builder = function() {
     buildFrontend: function(patternlab) {
       return buildFrontend(patternlab);
     },
-    isPatternExcluded: function(pattern, patternlab) {
-      return isPatternExcluded(pattern, patternlab);
+    isPatternExcluded: function(pattern, patternlab, uikit) {
+      return isPatternExcluded(pattern, patternlab, uikit);
     },
-    groupPatterns: function(patternlab) {
-      return groupPatterns(patternlab);
+    groupPatterns: function(patternlab, uikit) {
+      return groupPatterns(patternlab, uikit);
     },
     resetUIBuilderState: function(patternlab) {
       resetUIBuilderState(patternlab);

packages/core/src/lib/uikitExcludePattern.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const uikitExcludePattern = (pattern, uikit) => {
+  const state = pattern.patternState;
+  return uikit.excludedPatternStates.includes(state);
+};
+module.exports = uikitExcludePattern;

packages/core/test/ui_builder_tests.js

@@ -33,6 +33,13 @@ uiModule.__set__({
   buildFooter: buildFooterMock,
 });
 
+const uikit = {
+  name: 'uikit-workshop',
+  modulePath: '',
+  outputDir: 'test/output',
+  excludedPatternStates: [],
+};
+
 var ui = uiModule();
 
 function createFakePatternLab(customProps) {
@@ -55,13 +62,7 @@ function createFakePatternLab(customProps) {
       },
     },
     data: {},
-    uikits: {
-      'uikit-workshop': {
-        name: 'workshop',
-        modulePath: '',
-        outputDir: 'test/output',
-      },
-    },
+    uikits: [uikit],
   };
   return extend(pl, customProps);
 }
@@ -74,7 +75,7 @@ tap.test(
     var pattern = new Pattern('00-test/_ignored-pattern.mustache');
 
     //act
-    var result = ui.isPatternExcluded(pattern, patternlab);
+    var result = ui.isPatternExcluded(pattern, patternlab, uikit);
 
     //assert
     test.equals(result, true);
@@ -91,7 +92,7 @@ tap.test(
     patternlab.config.defaultPattern = 'test-foo';
 
     //act
-    var result = ui.isPatternExcluded(pattern, patternlab);
+    var result = ui.isPatternExcluded(pattern, patternlab, uikit);
 
     //assert
     test.equals(result, true);
@@ -118,7 +119,7 @@ tap.test(
     });
 
     //act
-    var result = ui.isPatternExcluded(pattern, patternlab);
+    var result = ui.isPatternExcluded(pattern, patternlab, uikit);
 
     //assert
     test.equals(result, true);
@@ -140,7 +141,32 @@ tap.test(
     });
 
     //act
-    var result = ui.isPatternExcluded(pattern, patternlab);
+    var result = ui.isPatternExcluded(pattern, patternlab, uikit);
+
+    //assert
+    test.equals(result, true);
+    test.end();
+  }
+);
+
+tap.test(
+  'isPatternExcluded - returns true when pattern state found withing uikit exclusions',
+  function(test) {
+    //arrange
+    var patternlab = createFakePatternLab({});
+    var pattern = Pattern.createEmpty({
+      relPath:
+        'shown' + path.sep + '_patternsubtype' + path.sep + 'foo.mustache',
+      isPattern: true,
+      fileName: 'foo.mustache',
+      patternPartial: 'shown-foo',
+      patternState: 'complete',
+    });
+
+    //act
+    var result = ui.isPatternExcluded(pattern, patternlab, {
+      excludedPatternStates: 'complete',
+    });
 
     //assert
     test.equals(result, true);
@@ -169,7 +195,7 @@ tap.test('groupPatterns - creates pattern groups correctly', function(test) {
   ui.resetUIBuilderState(patternlab);
 
   //act
-  var result = ui.groupPatterns(patternlab);
+  var result = ui.groupPatterns(patternlab, uikit);
 
   test.equals(
     result.patternGroups.patternType1.patternSubType1.blue.patternPartial,
@@ -232,7 +258,7 @@ tap.test('groupPatterns - orders patterns when provided from md', function(
   patternlab.patterns[1].order = 1;
 
   //act
-  ui.groupPatterns(patternlab);
+  ui.groupPatterns(patternlab, uikit);
 
   let patternType = _.find(patternlab.patternTypes, [
     'patternType',
@@ -272,7 +298,7 @@ tap.test(
     patternlab.patterns[1].order = 'notanumber!';
 
     //act
-    ui.groupPatterns(patternlab);
+    ui.groupPatterns(patternlab, uikit);
 
     let patternType = _.find(patternlab.patternTypes, [
       'patternType',
@@ -315,7 +341,7 @@ tap.test(
     patternlab.patterns[2].order = 2;
 
     //act
-    ui.groupPatterns(patternlab);
+    ui.groupPatterns(patternlab, uikit);
 
     let patternType = _.find(patternlab.patternTypes, [
       'patternType',
@@ -363,7 +389,7 @@ tap.test(
     ui.resetUIBuilderState(patternlab);
 
     //act
-    var result = ui.groupPatterns(patternlab);
+    var result = ui.groupPatterns(patternlab, uikit);
 
     //assert
     test.equals(
@@ -406,7 +432,7 @@ tap.test(
     ui.resetUIBuilderState(patternlab);
 
     //act
-    var result = ui.groupPatterns(patternlab);
+    var result = ui.groupPatterns(patternlab, uikit);
 
     //assert
     test.equals(patternlab.patternPaths['test']['foo'], '00-test-foo');
@@ -463,7 +489,7 @@ tap.test(
     ui.resetUIBuilderState(patternlab);
 
     //act
-    var result = ui.groupPatterns(patternlab);
+    var result = ui.groupPatterns(patternlab, uikit);
 
     //assert
     test.equals('todo', 'todo');
@@ -517,9 +543,7 @@ tap.test(
     );
     ui.resetUIBuilderState(patternlab);
 
-    const styleguidePatterns = ui.groupPatterns(patternlab);
-
-    const uikit = patternlab.uikits['uikit-workshop'];
+    const styleguidePatterns = ui.groupPatterns(patternlab, uikit);
 
     //act
     ui

packages/core/test/uikitExcludePattern_tests.js

@@ -0,0 +1,53 @@
+'use strict';
+
+const tap = require('tap');
+
+const uikitExcludePattern = require('../src/lib/uikitExcludePattern');
+
+tap.test(
+  'uikitExcludePattern - returns false when uikit has no excluded states',
+  test => {
+    //arrange
+    const uikit = { excludedPatternStates: [] };
+    const pattern = { patternState: 'complete' };
+
+    //act
+    const result = uikitExcludePattern(pattern, uikit);
+
+    //assert
+    test.false(result);
+    test.end();
+  }
+);
+
+tap.test(
+  'uikitExcludePattern - returns false pattern does not have same state as uikit exclusions',
+  test => {
+    //arrange
+    const uikit = { excludedPatternStates: ['complete'] };
+    const pattern = { patternState: 'inprogress' };
+
+    //act
+    const result = uikitExcludePattern(pattern, uikit);
+
+    //assert
+    test.false(result);
+    test.end();
+  }
+);
+
+tap.test(
+  'uikitExcludePattern - returns true when uikit has same state as pattern',
+  test => {
+    //arrange
+    const uikit = { excludedPatternStates: ['inreview', 'complete'] };
+    const pattern = { patternState: 'complete' };
+
+    //act
+    const result = uikitExcludePattern(pattern, uikit);
+
+    //assert
+    test.true(result);
+    test.end();
+  }
+);