chore(docs): update to dgeni-0.4.0

* update package with new services and computeId config
* generateIndexPagesProcessor was not using log
* use StringMap not ES6-shim Map in errorNamespaceMap
* remove unused dependencies from generateErrorDocsProcessor
* ensure generatePagesDataProcessor adds its doc to the collection
* debugDumpProcessor was moved to dgeni-packages

Author: petebacondarwin

docs/config/index.js

@@ -1,44 +1,153 @@
-var _ = require('lodash');
+"use strict";
+
 var path = require('canonical-path');
 var packagePath = __dirname;
 
-var basePackage = require('dgeni-packages/ngdoc');
-var examplesPackage = require('dgeni-packages/examples');
+var Package = require('dgeni').Package;
+
+// Create and export a new Dgeni package called dgeni-example. This package depends upon
+// the jsdoc and nunjucks packages defined in the dgeni-packages npm module.
+module.exports = new Package('angularjs', [
+  require('dgeni-packages/ngdoc'),
+  require('dgeni-packages/nunjucks'),
+  require('dgeni-packages/examples')
+])
+
+
+.factory(require('./services/errorNamespaceMap'))
+.factory(require('./services/getMinerrInfo'))
+.factory(require('./services/getVersion'))
+.factory(require('./services/gitData'))
+
+.factory(require('./services/deployments/debug'))
+.factory(require('./services/deployments/default'))
+.factory(require('./services/deployments/jquery'))
+.factory(require('./services/deployments/production'))
+
+.factory(require('./inline-tag-defs/type'))
+
+
+.processor(require('./processors/error-docs'))
+.processor(require('./processors/index-page'))
+.processor(require('./processors/keywords'))
+.processor(require('./processors/pages-data'))
+.processor(require('./processors/versions-data'))
+
+
+.config(function(dgeni, log, readFilesProcessor, writeFilesProcessor) {
+
+  dgeni.stopOnValidationError = true;
+  dgeni.stopOnProcessingError = true;
+
+  log.level = 'info';
+
+  readFilesProcessor.basePath = path.resolve(__dirname,'../..');
+  readFilesProcessor.sourceFiles = [
+    { include: 'src/**/*.js', basePath: 'src' },
+    { include: 'docs/content/**/*.ngdoc', basePath: 'docs/content' }
+  ];
+
+  writeFilesProcessor.outputFolder = 'build/docs';
+
+})
+
+
+.config(function(parseTagsProcessor) {
+  parseTagsProcessor.tagDefinitions.push(require('./tag-defs/tutorial-step'));
+  parseTagsProcessor.tagDefinitions.push(require('./tag-defs/sortOrder'));
+})
+
+
+.config(function(inlineTagProcessor, typeInlineTagDef) {
+  inlineTagProcessor.inlineTagDefinitions.push(typeInlineTagDef);
+})
+
+
+.config(function(templateFinder, renderDocsProcessor, gitData) {
+  templateFinder.templateFolders.unshift(path.resolve(packagePath, 'templates'));
+  renderDocsProcessor.extraData.git = gitData;
+})
+
+
+.config(function(computePathsProcessor, computeIdsProcessor) {
+
+  computePathsProcessor.pathTemplates.push({
+    docTypes: ['error'],
+    pathTemplate: 'error/${namespace}/${name}',
+    outputPathTemplate: 'partials/error/${namespace}/${name}.html'
+  });
+
+  computePathsProcessor.pathTemplates.push({
+    docTypes: ['errorNamespace'],
+    pathTemplate: 'error/${name}',
+    outputPathTemplate: 'partials/error/${name}.html'
+  });
+
+  computePathsProcessor.pathTemplates.push({
+    docTypes: ['overview', 'tutorial'],
+    getPath: function(doc) {
+      var docPath = path.dirname(doc.fileInfo.relativePath);
+      if ( doc.fileInfo.baseName !== 'index' ) {
+        docPath = path.join(docPath, doc.fileInfo.baseName);
+      }
+      return docPath;
+    },
+    getOutputPath: function(doc) {
+      return 'partials/' + doc.path +
+          ( doc.fileInfo.baseName === 'index' ? '/index.html' : '.html');
+    }
+  });
+
+  computePathsProcessor.pathTemplates.push({
+    docTypes: ['e2e-test'],
+    getPath: function() {},
+    outputPathTemplate: 'ptore2e/${example.id}/${deployment.name}_test.js'
+  });
 
-module.exports = function(config) {
+  computePathsProcessor.pathTemplates.push({
+    docTypes: ['indexPage'],
+    getPath: function() {},
+    outputPathTemplate: '${id}.html'
+  });
 
-  config = basePackage(config);
-  config = examplesPackage(config);
 
-  config.append('processing.processors', [
-    require('./processors/git-data'),
-    require('./processors/error-docs'),
-    require('./processors/keywords'),
-    require('./processors/versions-data'),
-    require('./processors/pages-data'),
-    require('./processors/protractor-generate'),
-    require('./processors/index-page'),
-    require('./processors/debug-dump')
-  ]);
+  computeIdsProcessor.idTemplates.push({
+    docTypes: ['overview', 'tutorial', 'e2e-test', 'indexPage'],
+    getId: function(doc) { return doc.fileInfo.baseName; },
+    getAliases: function(doc) { return [doc.id]; }
+  });
 
-  config.append('processing.tagDefinitions', [
-    require('./tag-defs/tutorial-step'),
-    require('./tag-defs/sortOrder')
-  ]);
+  computeIdsProcessor.idTemplates.push({
+    docTypes: ['error', 'errorNamespace'],
+    getId: function(doc) { return 'error:' + doc.name; },
+    getAliases: function(doc) { return [doc.id]; }
+  });
+})
 
-  config.append('processing.defaultTagTransforms', [
-    require('dgeni-packages/jsdoc/tag-defs/transforms/trim-whitespace')
-  ]);
 
-  config.append('processing.inlineTagDefinitions', [
-    require('./inline-tag-defs/type')
-  ]);
+.config(function(
+  generateIndexPagesProcessor,
+  generateProtractorTestsProcessor,
+  generateExamplesProcessor,
+  debugDeployment, defaultDeployment,
+  jqueryDeployment, productionDeployment) {
 
-  config.set('processing.search.ignoreWordsFile', path.resolve(packagePath, 'ignore.words'));
+  generateIndexPagesProcessor.deployments = [
+    debugDeployment,
+    defaultDeployment,
+    jqueryDeployment,
+    productionDeployment
+  ];
 
-  config.prepend('rendering.templateFolders', [
-    path.resolve(packagePath, 'templates')
-  ]);
+  generateProtractorTestsProcessor.deployments = [
+    defaultDeployment,
+    jqueryDeployment
+  ];
 
-  return config;
-};
+  generateExamplesProcessor.deployments = [
+    debugDeployment,
+    defaultDeployment,
+    jqueryDeployment,
+    productionDeployment
+  ];
+});

docs/config/inline-tag-defs/type.js

@@ -1,12 +1,17 @@
-var typeClassFilter = require('dgeni-packages/ngdoc/rendering/filters/type-class');
+"use strict";
+
 var encoder = new require('node-html-encoder').Encoder();
 
-module.exports = {
-  name: 'type',
-  description: 'Replace with markup that displays a nice type',
-  handlerFactory: function() {
-    return function(doc, tagName, tagDescription) {
-      return '<a href="" class="' + typeClassFilter.process(tagDescription) + '">'+encoder.htmlEncode(tagDescription) + '</a>';
-    };
-  }
-};
+/**
+ * @dgService typeInlineTagDef
+ * @description
+ * Replace with markup that displays a nice type
+ */
+module.exports = function typeInlineTagDef(getTypeClass) {
+  return {
+    name: 'type',
+    handler: function(doc, tagName, tagDescription) {
+      return '<a href="" class="' + getTypeClass(tagDescription) + '">'+encoder.htmlEncode(tagDescription) + '</a>';
+    }
+  };
+};

docs/config/processors/debug-dump.js

@@ -1,59 +1,52 @@
+"use strict";
+
 var _ = require('lodash');
-var log = require('winston');
 var path = require('canonical-path');
 
-module.exports = {
-  name: 'error-docs',
-  description: 'Compute the various fields for docs in the Error area',
-  runAfter: ['tags-extracted', 'compute-path'],
-  runBefore: ['extra-docs-added'],
-  exports: {
-    errorNamespaces: ['factory', function() { return {}; }],
-    minerrInfo: ['factory', function(config) {
-      var minerrInfoPath = config.get('processing.errors.minerrInfoPath');
-      if ( !minerrInfoPath ) {
-        throw new Error('Error in configuration: Please provide a path to the minerr info file (errors.json) ' +
-          'in the `config.processing.errors.minerrInfoPath` property');
-      }
-      return require(minerrInfoPath);
-    }]
-  },
-  process: function(docs, partialNames, errorNamespaces, minerrInfo) {
-
-    // Create error namespace docs and attach error docs to each
-    _.forEach(docs, function(doc) {
-      if ( doc.docType === 'error' ) {
-
-        // Parse out the error info from the id
-        parts = doc.name.split(':');
-        doc.namespace = parts[0];
-        doc.name = parts[1];
-
-
-        var namespaceDoc = errorNamespaces[doc.namespace];
-        if ( !namespaceDoc ) {
-          // First time we came across this namespace, so create a new one
-          namespaceDoc = errorNamespaces[doc.namespace] = {
-            area: doc.area,
-            name: doc.namespace,
-            errors: [],
-            path: path.dirname(doc.path),
-            outputPath: path.dirname(doc.outputPath) + '.html',
-            docType: 'errorNamespace'
-          };
+/**
+ * @dgProcessor errorDocsProcessor
+ * @description
+ * Process "error" docType docs and generate errorNamespace docs
+ */
+module.exports = function errorDocsProcessor(errorNamespaceMap, getMinerrInfo) {
+  return {
+    $runAfter: ['tags-extracted'],
+    $runBefore: ['extra-docs-added'],
+    $process: function(docs) {
+
+      // Create error namespace docs and attach error docs to each
+      docs.forEach(function(doc) {
+        var parts, namespaceDoc;
+
+        if ( doc.docType === 'error' ) {
+
+          // Parse out the error info from the id
+          parts = doc.name.split(':');
+          doc.namespace = parts[0];
+          doc.name = parts[1];
+
+          // Get or create the relevant errorNamespace doc
+          namespaceDoc = errorNamespaceMap.get(doc.namespace);
+          if ( !namespaceDoc ) {
+            namespaceDoc = {
+              area: 'error',
+              name: doc.namespace,
+              errors: [],
+              docType: 'errorNamespace'
+            };
+            errorNamespaceMap.set(doc.namespace, namespaceDoc);
+          }
+
+          // Link this error doc to its namespace doc
+          namespaceDoc.errors.push(doc);
+          doc.namespaceDoc = namespaceDoc;
+          doc.formattedErrorMessage = getMinerrInfo().errors[doc.namespace][doc.name];
         }
-
-        // Add this error to the namespace
-        namespaceDoc.errors.push(doc);
-        doc.namespace = namespaceDoc;
-
-        doc.formattedErrorMessage = minerrInfo.errors[doc.namespace.name][doc.name];
-
-      }
-
-    });
-
-
-    return docs.concat(_.values(errorNamespaces));
-  }
-};
+      });
+
+      errorNamespaceMap.forEach(function(errorNamespace) {
+        docs.push(errorNamespace);
+      });
+    }
+  };
+};