Finished composing of pages. Removed now dead files. Added more tests.

Author: toekneestuck

index.js

@@ -3,6 +3,8 @@
 var _ = require('lodash');
 var colors = require('colors');
 var Promise = require('bluebird');
+var debug = require('./helpers/debug');
+var save = require('./helpers/save-file');
 
 /**
  * @param {SchemaDriver} schemaDriver
@@ -15,38 +17,91 @@ var Composer = function(schemaDriver, templateDriver, options) {
   this.schemaDriver = schemaDriver;
   this.templateDriver = templateDriver;
   this.options = options || {};
+  this.debugLevel = options.debugLevel || 0;
+
+  if (!_.isArray(this.options.pages)) {
+    throw new TypeError('No pages configured for the composer!');
+  }
 };
 
 /**
- * return {Promise}
+ * Prepares schemas and templates, then call compose.
+ *
+ * @return {Promise}
  */
 Composer.prototype.build = function() {
   return Promise.all([
     this.buildSchemas(),
     this.buildTemplates()
-  ]).bind(this).then(_.spread(_.bind(this.compose, this)));
+  ]).bind(this).then(_.spread(this.compose));
 };
 
 /**
+ * Transforms page confguration into a fully stringified template
  *
- * @param schemas
- * @param templates
+ * @param {Object} schemas - keyed by ID
+ * @param {Object} templates - keyed by file name
  * @return {Object}
  */
 Composer.prototype.compose = function(schemas, templates) {
-  // @TODO figure out how to compose pages
+  return _.transform(this.options.pages, function(compiled, page) {
+    if (!page.file) {
+      throw new ReferenceError('You must specify a file for the page "' + page.title + '"');
+    }
+    compiled[page.file] = this.composePage(page, schemas, templates)
+  }, {}, this);
+};
+
+/**
+ * Build a page. Assumes a base template file
+ *
+ * @param {Object} page
+ * @param {Object} schemas
+ * @param {Object} templates
+ * @returns {String}
+ */
+Composer.prototype.composePage = function(page, schemas, templates) {
+  this._debug(2, 'Building page: %s', page.title);
+  return templates.base(this.getPageTemplateData.apply(this, arguments));
+};
+
+/**
+ * Build template data object
+ *
+ * @param {Object} page
+ * @param {Object} schemas
+ * @param {Object} templates
+ * @returns {{page: {Object}, navigation: {currentPage: {Object}, allPages: {Array}}}
+ */
+Composer.prototype.getPageTemplateData = function(page, schemas, templates) {
+  // Map schema IDs to the full schemas for data access in the templates
+  _.each(page.sections, function(section) {
+    section.schemas = _.filter(schemas, function(schema) {
+      return _.contains(section.schemas, schema.id);
+    });
+  });
+
+  return {
+    page: page,
+    navigation: {
+      currentPage: page,
+      allPages: this.options.pages
+    }
+  };
 };
 
 /**
  * @param {Object} files
+ * @returns {Promise}
  */
 Composer.prototype.write = function(files) {
-  // @TODO file contents keyed by path, relatieve to root of executing directory
+  return Promise.all(_.map(files, _.partial(save, this.options.destination || 'dist')));
 }
 
 /**
+ * Reads and resolves schemas, then applies transformations
  *
- * @param {Object} [options]
+ * @returns {Object}
  */
 Composer.prototype.buildSchemas = function () {
   return this.schemaDriver.fetch()
@@ -64,6 +119,9 @@ Composer.prototype.addTransform = function(Transformer) {
 };
 
 /**
+ * Runs the parsed schemas through transformers. Expects
+ * the transformer to implement a `transform` method that returns
+ * the modified schemas
  *
  * @param {Object} schemas
  * @returns {Object}
@@ -76,6 +134,7 @@ Composer.prototype.applyTransforms = function(schemas) {
 };
 
 /**
+ * Read and prepare the template files
  *
  * @param {Object} schemas
  * @returns {Promise}
@@ -84,9 +143,14 @@ Composer.prototype.buildTemplates = function(schemas) {
   return this.templateDriver.fetch();
 };
 
+/**
+ * @private
+ */
+Composer.prototype._debug = debug;
+
 /**
  * @module lib/composer
  * @class Composer
  * @type {Function}
  */
-modules.exports = Composer;
+module.exports = Composer;

lib/composer.js

@@ -0,0 +1,22 @@
+'use strict';
+
+var _ = require('lodash');
+var DEBUG_PREFIX = 'JSON Docs: ';
+
+/**
+ * Print a message to the console if the object
+ * this method was mixed into was configured for it.
+ *
+ * @module helpers/debug
+ * @type {Function}
+ * @param level
+ */
+module.exports = function(level) {
+  var args = _.rest(arguments);
+  var debugLevel = this.debugLevel;
+  //var args = [].slice.call(arguments, 1);
+  if (debugLevel && level <= debugLevel ) {
+    args[0] = DEBUG_PREFIX + args[0];
+    global.console.log.apply(global.console.log, args);
+  }
+};

lib/helpers/debug.js

@@ -0,0 +1,25 @@
+'use strict';
+
+var path = require('path');
+var mkdir = require('mkdirp-then');
+var color = require('colors');
+var Promise = require('bluebird');
+var writeFile = Promise.promisify(require('fs').writeFile);
+
+/**
+ * Save a file
+ *
+ * @param {String} [destination=dist]
+ * @param {String} contents
+ * @param {String} fileName
+ */
+module.exports = function (destination, contents, filepath){
+  var directory = destination + '/' + path.dirname(filepath);
+  var fullPath = destination + '/' + filepath;
+
+  return mkdir(directory).then(function() {
+    writeFile(fullPath, contents).then(function() {
+      global.console.log('Wrote file: ' + fullPath.green);
+    });
+  });
+};

lib/helpers/generate-flow.js

@@ -52,7 +52,7 @@ ObjectDefinition.prototype.build = function(object) {
   if (_.isArray(object.allOf)) {
     _.each(object.allOf, function(schema) {
       // Deep extend all properties
-      _.merge(self, this.build(schema), function(a, b) {
+      _.merge(self, _.omit(this.build(schema), ['_original']), function(a, b) {
         if (_.isArray(a)) {
           return a.concat(b);
         }
@@ -80,7 +80,12 @@ ObjectDefinition.prototype.build = function(object) {
 
   self.requiredProps = _.pick(self.allProps, required);
   self.optionalProps = _.omit(self.allProps, required);
-  self.example = this._formatter.format(exampleExtractor.extract(object));
+
+  try {
+    self.example = this._formatter.format(exampleExtractor.extract(object));
+  } catch (e) {
+    throw new Error('Error preparing data for object: ' + JSON.stringify(object));
+  }
 
   return self;
 };

lib/helpers/save-file.js

@@ -10,6 +10,7 @@ var _ = require('lodash');
 var pointer = require('./pointer');
 var colors = require('colors');
 var deep = require('deep-get-set');
+var debug = require('./helpers/debug');
 var Resolver;
 
 var INTERNAL_SCHEMA_REFERENCE_SEPARATOR = '#';
@@ -46,15 +47,7 @@ Resolver = function(schemas, options) {
  * @param {Number} level
  * @private
  */
-Resolver.prototype._debug = function(level) {
-  var args = _.rest(arguments);
-  var debugLevel = this.debugLevel;
-  //var args = [].slice.call(arguments, 1);
-  if (debugLevel && level <= debugLevel ) {
-    args[0] = DEBUG_PREFIX + args[0];
-    global.console.log.apply(global.console.log, args);
-  }
-}
+Resolver.prototype._debug = debug;
 
 /**
  * The heavy lifter. This is a recursive method that will traverse over each key in