chore(doc-gen): update to dgeni 0.3.0

Author: petebacondarwin

docs/config/index.js

@@ -25,6 +25,10 @@ module.exports = function(config) {
     require('./tag-defs/tutorial-step')
   ]);
 
+  config.append('processing.defaultTagTransforms', [
+    require('dgeni-packages/jsdoc/tag-defs/transforms/trim-whitespace')
+  ]);
+
   config.append('processing.inlineTagDefinitions', [
     require('./inline-tag-defs/type')
   ]);

docs/config/processors/debug-dump.js

@@ -1,26 +1,33 @@
-var writer = require('dgeni/lib/utils/doc-writer');
+var fs = require('q-io/fs');
 var log = require('winston');
 var util = require("util");
 
-var filter, outputPath, depth;
-
 module.exports = {
   name: 'debug-dump',
   runBefore: ['write-files'],
   description: 'This processor dumps docs that match a filter to a file',
-  init: function(config, injectables) {
+  process: function(docs, config) {
+
+    var filter, outputPath, depth;
+
     filter = config.get('processing.debug-dump.filter');
     outputPath = config.get('processing.debug-dump.outputPath');
     depth = config.get('processing.debug-dump.depth', 2);
-  },
-  process: function(docs) {
+
+
     if ( filter && outputPath ) {
       log.info('Dumping docs:', filter, outputPath);
       var filteredDocs = filter(docs);
       var dumpedDocs = util.inspect(filteredDocs, depth);
-      return writer.writeFile(outputPath, dumpedDocs).then(function() {
+      return writeFile(outputPath, dumpedDocs).then(function() {
         return docs;
       });
     }
   }
-};
+};
+
+function writeFile(file, content) {
+  return fs.makeTree(fs.directory(file)).then(function() {
+    return fs.write(file, content, 'wb');
+  });
+}

docs/config/processors/error-docs.js

@@ -5,16 +5,18 @@ var path = require('canonical-path');
 module.exports = {
   name: 'error-docs',
   description: 'Compute the various fields for docs in the Error area',
-  runAfter: ['tags-extracted'],
-  init: function(config, injectables) {
-    injectables.value('errorNamespaces', {});
-
-    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');
-    }
-    injectables.value('minerrInfo', require(minerrInfoPath));
+  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) {
 

docs/config/processors/git-data.js

@@ -3,14 +3,16 @@ var versionInfo = require('../../../lib/versions/version-info');
 
 module.exports = {
   name: 'git-data',
-  runBefore: ['loading-files'],
+  runBefore: ['reading-files'],
   description: 'This processor adds information from the local git repository to the extraData injectable',
-  init: function(config, injectables) {
-    injectables.value('gitData', {
-      version: versionInfo.currentVersion,
-      versions: versionInfo.previousVersions,
-      info: versionInfo.gitRepoInfo
-    });
+  exports: {
+    gitData: ['factory', function() {
+      return {
+        version: versionInfo.currentVersion,
+        versions: versionInfo.previousVersions,
+        info: versionInfo.gitRepoInfo
+      };
+    }]
   },
   process: function(extraData, gitData) {
     extraData.git = gitData;

docs/config/processors/index-page.js

@@ -1,20 +1,18 @@
 var _ = require('lodash');
 var log = require('winston');
 var path = require('canonical-path');
-var deployment;
 
 module.exports = {
   name: 'index-page',
   runAfter: ['adding-extra-docs'],
   runBefore: ['extra-docs-added'],
   description: 'This processor creates docs that will be rendered as the index page for the app',
-  init: function(config) {
-    deployment = config.deployment;
+  process: function(docs, config) {
+
+    var deployment = config.deployment;
     if ( !deployment || !deployment.environments ) {
       throw new Error('No deployment environments found in the config.');
     }
-  },
-  process: function(docs) {
 
     // Collect up all the areas in the docs
     var areas = {};

docs/config/processors/keywords.js

@@ -3,20 +3,20 @@ var log = require('winston');
 var fs = require('fs');
 var path = require('canonical-path');
 
-// Keywords to ignore
-var wordsToIgnore = [];
-var propertiesToIgnore;
-var areasToSearch;
-
-// Keywords start with "ng:" or one of $, _ or a letter
-var KEYWORD_REGEX = /^((ng:|[\$_a-z])[\w\-_]+)/;
-
 module.exports = {
   name: 'keywords',
   runAfter: ['docs-processed'],
   runBefore: ['adding-extra-docs'],
   description: 'This processor extracts all the keywords from the document',
-  init: function(config) {
+  process: function(docs, config) {
+
+    // Keywords to ignore
+    var wordsToIgnore = [];
+    var propertiesToIgnore;
+    var areasToSearch;
+
+    // Keywords start with "ng:" or one of $, _ or a letter
+    var KEYWORD_REGEX = /^((ng:|[\$_a-z])[\w\-_]+)/;
 
     // Load up the keywords to ignore, if specified in the config
     if ( config.processing.search && config.processing.search.ignoreWordsFile ) {
@@ -34,9 +34,6 @@ module.exports = {
     propertiesToIgnore = _.indexBy(config.get('processing.search.propertiesToIgnore', []));
     log.debug('Properties to ignore', propertiesToIgnore);
 
-  },
-  process: function(docs) {
-
     var ignoreWordsMap = _.indexBy(wordsToIgnore);
 
     // If the title contains a name starting with ng, e.g. "ngController", then add the module name

docs/config/processors/pages-data.js

@@ -129,18 +129,15 @@ var navGroupMappers = {
   }
 };
 
-var outputFolder;
-
 module.exports = {
   name: 'pages-data',
   description: 'This plugin will create a new doc that will be rendered as an angularjs module ' +
                'which will contain meta information about the pages and navigation',
-  runAfter: ['adding-extra-docs', 'component-groups-generate'],
+  runAfter: ['adding-extra-docs', 'component-groups-generate', 'compute-path'],
   runBefore: ['extra-docs-added'],
-  init: function(config) {
-    outputFolder = config.rendering.outputFolder;
-  },
-  process: function(docs) {
+  process: function(docs, config) {
+
+    var outputFolder = config.rendering.outputFolder;
 
     _(docs)
     .filter(function(doc) { return doc.area === 'api'; })
@@ -191,7 +188,7 @@ module.exports = {
         area.navGroups = navGroupMapper(pages, area);
       });
 
-    // Extract a list of basic page information for mapping paths to paritals and for client side searching
+    // Extract a list of basic page information for mapping paths to partials and for client side searching
     var pages = _(docs)
       .map(function(doc) {
         var page = _.pick(doc, [

docs/config/processors/protractor-generate.js

@@ -1,45 +1,20 @@
 var _ = require('lodash');
-var log = require('winston');
 var path = require('canonical-path');
-var trimIndentation = require('dgeni/lib/utils/trim-indentation');
-var code = require('dgeni/lib/utils/code');
-var protractorFolder;
-
-function createProtractorDoc(example, file, env) {
-  var protractorDoc = {
-    docType: 'e2e-test',
-    id: 'protractorTest' + '-' + example.id,
-    template: 'protractorTests.template.js',
-    outputPath: path.join(protractorFolder, example.id, env + '_test.js'),
-    innerTest: file.fileContents,
-    pathPrefix: '.', // Hold for if we test with full jQuery
-    exampleId: example.id,
-    description: example.doc.id
-  };
-
-  if (env === 'jquery') {
-    protractorDoc.examplePath = example.outputFolder + '/index-jquery.html'
-  } else {
-    protractorDoc.examplePath = example.outputFolder + '/index.html'
-  }
-  return protractorDoc;
-}
 
 module.exports = {
   name: 'protractor-generate',
   description: 'Generate a protractor test file from the e2e tests in the examples',
   runAfter: ['adding-extra-docs'],
   runBefore: ['extra-docs-added'],
-  init: function(config, injectables) {
-    protractorFolder = config.get('rendering.protractor.outputFolder', 'ptore2e');
-  },
-  process: function(docs, examples) {
+  process: function(docs, examples, config) {
+    var protractorFolder = config.get('rendering.protractor.outputFolder', 'ptore2e');
+
     _.forEach(examples, function(example) {
 
       _.forEach(example.files, function(file) {
 
         // Check if it's a Protractor test.
-        if (!(file.type == 'protractor')) {
+        if (file.type !== 'protractor') {
           return;
         }
 
@@ -48,5 +23,27 @@ module.exports = {
         docs.push(createProtractorDoc(example, file, 'jqlite'));
       });
     });
+
+    function createProtractorDoc(example, file, env) {
+      var protractorDoc = {
+        docType: 'e2e-test',
+        id: 'protractorTest' + '-' + example.id,
+        template: 'protractorTests.template.js',
+        outputPath: path.join(protractorFolder, example.id, env + '_test.js'),
+        innerTest: file.fileContents,
+        pathPrefix: '.', // Hold for if we test with full jQuery
+        exampleId: example.id,
+        description: example.doc.id
+      };
+
+      if (env === 'jquery') {
+        protractorDoc.examplePath = example.outputFolder + '/index-jquery.html';
+      } else {
+        protractorDoc.examplePath = example.outputFolder + '/index.html';
+      }
+      return protractorDoc;
+    }
+
+
   }
 };

docs/config/tag-defs/tutorial-step.js

@@ -1,9 +1,9 @@
 module.exports = {
   name: 'step',
-  transformFn: function(doc, tag) {
+  transforms: function(doc, tag, value) {
     if ( doc.docType !== 'tutorial' ) {
       throw new Error('Invalid tag, step.  You should only use this tag on tutorial docs');
     }
-    return parseInt(tag.description,10);
+    return parseInt(value,10);
   }
 };

docs/gulpfile.js

@@ -2,7 +2,7 @@ var gulp = require('gulp');
 var concat = require('gulp-concat');
 var jshint = require('gulp-jshint');
 var bower = require('bower');
-var docGenerator = require('dgeni');
+var dgeni = require('dgeni');
 var merge = require('event-stream').merge;
 var path = require('canonical-path');
 
@@ -49,8 +49,8 @@ gulp.task('assets', ['bower'], function() {
 
 
 gulp.task('doc-gen', function() {
-  return docGenerator('docs.config.js')
-    .generateDocs()
+  var generateDocs = dgeni.generator('docs.config.js');
+  return generateDocs()
     .catch(function(error) {
       process.exit(1);
     });