feat(pattern_assembler): Further broke out files

Author: bmuenzenmeyer

core/index.js

@@ -18,9 +18,10 @@ const updateNotifier = require('update-notifier');
 const logger = require('./lib/log');
 const PatternGraph = require('./lib/pattern_graph').PatternGraph;
 const CompileState = require('./lib/object_factory').CompileState;
-const pa = require('./lib/pattern_assembler');
 const pe = require('./lib/pattern_exporter');
 const lh = require('./lib/lineage_hunter');
+const markModifiedPatterns = require('./lib/markModifiedPatterns');
+const parseAllLinks = require('./lib/parseAllLinks');
 const renderSync = require('./lib/renderSync');
 
 const defaultConfig = require('../patternlab-config.json');
@@ -31,7 +32,6 @@ let assetCopier = require('./lib/asset_copy'); // eslint-disable-line
 let pattern_exporter = new pe(); // eslint-disable-line
 let serve = require('./lib/serve'); // eslint-disable-line
 
-const pattern_assembler = new pa();
 const lineage_hunter = new lh();
 
 //bootstrap update notifier
@@ -137,7 +137,7 @@ const patternlab_module = function (config) {
 
   function cleanBuildDirectory(incrementalBuildsEnabled) {
     if (incrementalBuildsEnabled) {
-      logger.log.info("Incremental builds enabled.");
+      logger.info("Incremental builds enabled.");
     } else {
       // needs to be done BEFORE processing patterns
       fs.removeSync(paths.public.patterns);
@@ -154,7 +154,7 @@ const patternlab_module = function (config) {
     const graph = patternlab.graph = loadPatternGraph(deletePatternDir);
     const graphNeedsUpgrade = !PatternGraph.checkVersion(graph);
     if (graphNeedsUpgrade) {
-      logger.log.info("Due to an upgrade, a complete rebuild is required and the public/patterns directory was deleted. " +
+      logger.info("Due to an upgrade, a complete rebuild is required and the public/patterns directory was deleted. " +
                        "Incremental build is available again on the next successful run.");
 
       // Ensure that the freshly built graph has the latest version again.
@@ -178,7 +178,7 @@ const patternlab_module = function (config) {
 
       //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);
+      parseAllLinks(patternlab);
 
       //diveSync again to recursively include partials, filling out the
       //extendedTemplate property of the patternlab.patterns elements
@@ -219,12 +219,12 @@ const patternlab_module = function (config) {
         // When the graph was loaded from file, some patterns might have been moved/deleted between runs
         // so the graph data become out of sync
         patternlab.graph.sync().forEach(n => {
-          logger.log.info("[Deleted/Moved] " + n);
+          logger.info("[Deleted/Moved] " + n);
         });
 
         // TODO Find created or deleted files
         const now = new Date().getTime();
-        pattern_assembler.mark_modified_patterns(now, patternlab);
+        markModifiedPatterns(now, patternlab);
         patternsToBuild = patternlab.graph.compileOrder();
       } else {
         // build all patterns, mark all to be rebuilt
@@ -244,7 +244,7 @@ const patternlab_module = function (config) {
           PatternGraph.storeToFile(patternlab);
           if (patternlab.config.exportToGraphViz) {
             PatternGraph.exportToDot(patternlab, "dependencyGraph.dot");
-            logger.log.info(`Exported pattern graph to ${path.join(config.paths.public.root, "dependencyGraph.dot")}`);
+            logger.info(`Exported pattern graph to ${path.join(config.paths.public.root, "dependencyGraph.dot")}`);
           }
 
           //export patterns if necessary

core/lib/buildListItems.js

@@ -0,0 +1,27 @@
+"use strict";
+
+const _ = require('lodash');
+
+module.exports = function (container) {
+  //combine all list items into one structure
+  var list = [];
+  for (var item in container.listitems) {
+    if (container.listitems.hasOwnProperty(item)) {
+      list.push(container.listitems[item]);
+    }
+  }
+  container.listItemArray = _.shuffle(list);
+
+  for (var i = 1; i <= container.listItemArray.length; i++) {
+    var tempItems = [];
+    if (i === 1) {
+      tempItems.push(container.listItemArray[0]);
+      container.listitems['' + i ] = tempItems;
+    } else {
+      for (var c = 1; c <= i; c++) {
+        tempItems.push(container.listItemArray[c - 1]);
+        container.listitems['' + i ] = tempItems;
+      }
+    }
+  }
+};

core/lib/markModifiedPatterns.js

@@ -0,0 +1,46 @@
+"use strict";
+
+const path = require('path');
+const _ = require('lodash');
+
+const CompileState = require('./object_factory').CompileState;
+const ch = require('./changes_hunter');
+const changes_hunter = new ch();
+
+//this is mocked in unit tests
+let fs = require('fs-extra'); //eslint-disable-line prefer-const
+
+/**
+ * Finds patterns that were modified and need to be rebuilt. For clean patterns load the already
+ * rendered markup.
+ *
+ * @param lastModified
+ * @param patternlab
+ */
+module.exports = function (lastModified, patternlab) {
+  /**
+   * If the given array exists, apply a function to each of its elements
+   * @param {Array} array
+   * @param {Function} func
+   */
+  const forEachExisting = (array, func) => {
+    if (array) {
+      array.forEach(func);
+    }
+  };
+  const modifiedOrNot = _.groupBy(
+    patternlab.patterns,
+    p => changes_hunter.needsRebuild(lastModified, p) ? 'modified' : 'notModified');
+
+  // For all unmodified patterns load their rendered template output
+  forEachExisting(modifiedOrNot.notModified, cleanPattern => {
+    const xp = path.join(patternlab.config.paths.public.patterns, cleanPattern.getPatternLink(patternlab, 'markupOnly'));
+
+    // Pattern with non-existing markupOnly files were already marked for rebuild and thus are not "CLEAN"
+    cleanPattern.patternPartialCode = fs.readFileSync(xp, 'utf8');
+  });
+
+  // For all patterns that were modified, schedule them for rebuild
+  forEachExisting(modifiedOrNot.modified, p => p.compileState = CompileState.NEEDS_REBUILD);
+  return modifiedOrNot;
+};

core/lib/object_factory.js

@@ -113,7 +113,6 @@ Pattern.prototype = {
   render: function (data, partials) {
 
     if (!this.extendedTemplate) {
-      console.log('setting extendedTemplate because it didnt seem to be set. this is NEW CODE')
       this.extendedTemplate = this.template;
     }
 

core/lib/parseAllLinks.js

@@ -0,0 +1,15 @@
+"use strict";
+
+const parseLink = require('./parseLink');
+
+//look for pattern links included in data files.
+//these will be in the form of link.* WITHOUT {{}}, which would still be there from direct pattern inclusion
+module.exports = function (patternlab) {
+  //look for link.* such as link.pages-blog as a value
+  patternlab.data = parseLink(patternlab, patternlab.data, 'data.json');
+
+  //loop through all patterns
+  for (var i = 0; i < patternlab.patterns.length; i++) {
+    patternlab.patterns[i].jsonFileData = parseLink(patternlab, patternlab.patterns[i].jsonFileData, patternlab.patterns[i].patternPartial);
+  }
+};

core/lib/pattern_assembler.js

@@ -4,14 +4,13 @@ const path = require('path');
 const _ = require('lodash');
 
 const Pattern = require('./object_factory').Pattern;
-const CompileState = require('./object_factory').CompileState;
 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 parseLink = require('./parseLink');
+const buildListItems = require('./buildListItems');
 const readDocumentation = require('./readDocumentation');
 
 const markdown_parser = new mp();
@@ -23,30 +22,6 @@ let fs = require('fs-extra'); //eslint-disable-line prefer-const
 
 const pattern_assembler = function () {
 
-  function buildListItems(container) {
-    //combine all list items into one structure
-    var list = [];
-    for (var item in container.listitems) {
-      if (container.listitems.hasOwnProperty(item)) {
-        list.push(container.listitems[item]);
-      }
-    }
-    container.listItemArray = _.shuffle(list);
-
-    for (var i = 1; i <= container.listItemArray.length; i++) {
-      var tempItems = [];
-      if (i === 1) {
-        tempItems.push(container.listItemArray[0]);
-        container.listitems['' + i ] = tempItems;
-      } else {
-        for (var c = 1; c <= i; c++) {
-          tempItems.push(container.listItemArray[c - 1]);
-          container.listitems['' + i ] = tempItems;
-        }
-      }
-    }
-  }
-
   // 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) {
@@ -172,86 +147,9 @@ const pattern_assembler = function () {
     return currentPattern;
   }
 
-  /**
-   * Finds patterns that were modified and need to be rebuilt. For clean patterns load the already
-   * rendered markup.
-   *
-   * @param lastModified
-   * @param patternlab
-   */
-  function markModifiedPatterns(lastModified, patternlab) {
-    /**
-     * If the given array exists, apply a function to each of its elements
-     * @param {Array} array
-     * @param {Function} func
-     */
-    const forEachExisting = (array, func) => {
-      if (array) {
-        array.forEach(func);
-      }
-    };
-    const modifiedOrNot = _.groupBy(
-      patternlab.patterns,
-      p => changes_hunter.needsRebuild(lastModified, p) ? 'modified' : 'notModified');
-
-    // For all unmodified patterns load their rendered template output
-    forEachExisting(modifiedOrNot.notModified, cleanPattern => {
-      const xp = path.join(patternlab.config.paths.public.patterns, cleanPattern.getPatternLink(patternlab, 'markupOnly'));
-
-      // Pattern with non-existing markupOnly files were already marked for rebuild and thus are not "CLEAN"
-      cleanPattern.patternPartialCode = fs.readFileSync(xp, 'utf8');
-    });
-
-    // For all patterns that were modified, schedule them for rebuild
-    forEachExisting(modifiedOrNot.modified, p => p.compileState = CompileState.NEEDS_REBUILD);
-    return modifiedOrNot;
-  }
-
-  //look for pattern links included in data files.
-  //these will be in the form of link.* WITHOUT {{}}, which would still be there from direct pattern inclusion
-  function parseDataLinks(patternlab) {
-    //look for link.* such as link.pages-blog as a value
-
-    patternlab.data = parseLink(patternlab, patternlab.data, 'data.json');
-
-    //loop through all patterns
-    for (var i = 0; i < patternlab.patterns.length; i++) {
-      patternlab.patterns[i].jsonFileData = parseLink(patternlab, patternlab.patterns[i].jsonFileData, patternlab.patterns[i].patternPartial);
-    }
-  }
-
   return {
-    mark_modified_patterns: function (lastModified, patternlab) {
-      return markModifiedPatterns(lastModified, patternlab);
-    },
-
-    //todo review for deletion
-    find_pattern_partials: function (pattern) {
-      return pattern.findPartials();
-    },
-
-    //todo review for deletion
-    find_pattern_partials_with_style_modifiers: function (pattern) {
-      return pattern.findPartialsWithStyleModifiers();
-    },
-
-    //todo review for deletion
-    find_pattern_partials_with_parameters: function (pattern) {
-      return pattern.findPartialsWithPatternParameters();
-    },
-
-    //todo review for deletion
-    find_list_items: function (pattern) {
-      return pattern.findListItems();
-    },
     load_pattern_iterative: function (file, patternlab) {
       return loadPatternIterative(file, patternlab);
-    },
-    combine_listItems: function (patternlab) {
-      buildListItems(patternlab);
-    },
-    parse_data_links: function (patternlab) {
-      parseDataLinks(patternlab);
     }
   };
 

core/lib/patternlab.js

@@ -9,6 +9,7 @@ const cleanHtml = require('js-beautify').html;
 const inherits = require('util').inherits;
 const pm = require('./plugin_manager');
 const packageInfo = require('../../package.json');
+const buildListItems = require('./buildListItems');
 const dataLoader = require('./data_loader')();
 const decompose = require('./decompose');
 const logger = require('./log');
@@ -182,7 +183,7 @@ module.exports = class PatternLab {
 
     this.setCacheBust();
 
-    pattern_assembler.combine_listItems(this);
+    buildListItems(this);
 
     this.events.emit('patternlab-build-global-data-end', this);
   }

test/list_item_hunter_tests.js

@@ -25,7 +25,7 @@ function createFakeListPattern(customProps) {
 
 function createFakePatternLab(customProps) {
 
-  //NOTE: These listitems are faked so that pattern_assembler.combine_listitems has already clobbered them.
+  //NOTE: These listitems are faked so that buildListItems has already clobbered them.
 
   var pl = {
     graph: PatternGraph.empty(),