refact(examples/exampleMap): rename and convert to a StringMap

Author: petebacondarwin

examples/index.js

@@ -8,7 +8,7 @@ module.exports = new Package('examples', ['jsdoc'])
 .processor(require('./processors/examples-generate'))
 .processor(require('./processors/protractor-generate'))
 
-.factory(require('./services/examples'))
+.factory(require('./services/exampleMap'))
 .factory(require('./inline-tag-defs/runnableExample'))
 
 .config(function(templateFinder, generateExamplesProcessor) {

examples/inline-tag-defs/runnableExample.js

@@ -3,14 +3,14 @@
  * @description
  * Inject the specified runnable example into the doc
  */
-module.exports = function runnableExampleInlineTagDef(examples, createDocMessage) {
+module.exports = function runnableExampleInlineTagDef(exampleMap, createDocMessage) {
   return {
     name: 'runnableExample',
 
     handler: function(doc, tagName, description) {
 
       // The tag description should contain the id of the runnable example doc
-      var example = examples[description];
+      var example = exampleMap.get(description);
       if ( !example ) {
         throw new Error(createDocMessage('No example exists with id "' + description + '".', doc));
       }

examples/processors/examples-generate.js

@@ -8,7 +8,7 @@ var path = require('canonical-path');
  * This includes the files that will be run in an iframe, the code that will be injected
  * into the HTML pages and the protractor test files.
  */
-module.exports = function generateExamplesProcessor(log, examples) {
+module.exports = function generateExamplesProcessor(log, exampleMap) {
 
   return {
     $runAfter: ['adding-extra-docs'],
@@ -17,7 +17,8 @@ module.exports = function generateExamplesProcessor(log, examples) {
       deployments: { presence: true }
     },
     $process: function(docs) {
-      _.forEach(examples, function(example) {
+      var that = this;
+      exampleMap.forEach(function(example) {
 
         var stylesheets = [];
         var scripts = [];
@@ -29,7 +30,7 @@ module.exports = function generateExamplesProcessor(log, examples) {
         _.forEach(example.files, function(file, fileName) {
           if ( fileName === 'index.html' ) return;
 
-          var fileDoc = this.createFileDoc(example, file);
+          var fileDoc = that.createFileDoc(example, file);
           docs.push(fileDoc);
 
           // Store a reference to the fileDoc for attaching to the exampleDocs
@@ -38,24 +39,24 @@ module.exports = function generateExamplesProcessor(log, examples) {
           } else if ( file.type == 'js' ) {
             scripts.push(fileDoc);
           }
-        }, this);
+        });
 
         // Create an index.html document for the example (one for each deployment type)
-        _.forEach(this.deployments, function(deployment) {
-          var exampleDoc = this.createExampleDoc(example, deployment, stylesheets, scripts);
+        _.forEach(that.deployments, function(deployment) {
+          var exampleDoc = that.createExampleDoc(example, deployment, stylesheets, scripts);
           docs.push(exampleDoc);
           example.deployments[deployment.name] = exampleDoc;
-        }, this);
+        });
 
         // Create the doc that will be injected into the website as a runnable example
-        var runnableExampleDoc = this.createRunnableExampleDoc(example);
+        var runnableExampleDoc = that.createRunnableExampleDoc(example);
         docs.push(runnableExampleDoc);
         example.runnableExampleDoc = runnableExampleDoc;
 
         // Create the manifest that will be sent to Plunker
-        docs.push(this.createManifestDoc(example));
+        docs.push(that.createManifestDoc(example));
 
-      }, this);
+      });
     },
 
     createExampleDoc: function(example, deployment, stylesheets, scripts) {

examples/processors/examples-parse.js

@@ -11,7 +11,7 @@ var FILE_REGEX = /<file([^>]*)>([\S\s]+?)<\/file>/g;
  * @description
  * Search the documentation for examples that need to be extracted
  */
-module.exports = function parseExamplesProcessor(log, examples, trimIndentation, createDocMessage) {
+module.exports = function parseExamplesProcessor(log, exampleMap, trimIndentation, createDocMessage) {
   return {
     $runAfter: ['files-read'],
     $runBefore: ['parsing-tags'],
@@ -22,7 +22,7 @@ module.exports = function parseExamplesProcessor(log, examples, trimIndentation,
           doc.content = doc.content.replace(EXAMPLE_REGEX, function processExample(match, attributeText, exampleText) {
 
             var example = extractAttributes(attributeText);
-            var id = uniqueName(examples, 'example-' + (example.name || 'example'));
+            var id = uniqueName(exampleMap, 'example-' + (example.name || 'example'));
             _.assign(example, {
               attributes: _.omit(example, ['files', 'doc']),
               files: extractFiles(exampleText),
@@ -33,7 +33,7 @@ module.exports = function parseExamplesProcessor(log, examples, trimIndentation,
 
             // store the example information for later
             log.debug('Storing example', id);
-            examples[id] = example;
+            exampleMap.set(id, example);
 
             return '{@runnableExample ' + id + '}';
           });
@@ -46,7 +46,7 @@ module.exports = function parseExamplesProcessor(log, examples, trimIndentation,
   };
 
   function extractAttributes(attributeText) {
-    var attributes = Object.create(null);
+    var attributes = {};
     attributeText.replace(ATTRIBUTE_REGEX, function(match, prop, val1, val2){
       attributes[prop] = val1 || val2;
     });
@@ -73,10 +73,10 @@ module.exports = function parseExamplesProcessor(log, examples, trimIndentation,
     return files;
   }
 
-  function uniqueName(container, name) {
-    if ( container[name] ) {
+  function uniqueName(containerMap, name) {
+    if ( containerMap.has(name) ) {
       var index = 1;
-      while(container[name + index]) {
+      while(containerMap.has(name + index)) {
         index += 1;
       }
       name = name + index;

examples/processors/protractor-generate.js

@@ -8,7 +8,7 @@ var path = require('canonical-path');
  * @description
  * Generate a protractor test files from the e2e tests in the examples
  */
-module.exports = function generateProtractorTestsProcessor(examples) {
+module.exports = function generateProtractorTestsProcessor(exampleMap) {
   return {
     deployments: [],
     $validate: {
@@ -20,7 +20,7 @@ module.exports = function generateProtractorTestsProcessor(examples) {
 
       var deployments = this.deployments;
 
-      _.forEach(examples, function(example) {
+      exampleMap.forEach(function(example) {
         _.forEach(example.files, function(file) {
 
           // Check if it's a Protractor test.

examples/services/exampleMap.js

@@ -0,0 +1,10 @@
+var StringMap = require('stringmap');
+
+/**
+ * @dgService exampleMap
+ * @description
+ * A map of examples parsed out of the doc content, keyed on
+ */
+module.exports = function exampleMap() {
+  return new StringMap();
+};

examples/services/examples.js

@@ -74,6 +74,7 @@ describe('examples package', function() {
 
   it("should compute the path of examples from their attributes", function(done) {
     processExample().then(function(docs) {
+
       expect(docs.length).toEqual(4);
 
       expect(docs[0].id).toEqual('example-testExample/app.js');

examples/spec/index.spec.js

@@ -1,18 +1,19 @@
 var tagDefinitionFactory = require('../../inline-tag-defs/runnableExample');
 var createDocMessageFactory = require('../../../base/services/createDocMessage');
+var StringMap = require('stringmap');
 
 describe("runnableExampleInlineTagDef", function() {
 
-  var examples, tagDef;
+  var exampleMap, tagDef;
 
   beforeEach(function() {
-    examples = {};
-    examples['some-example'] = {
+    exampleMap = new StringMap();
+    exampleMap.set('some-example', {
       runnableExampleDoc: {
         renderedContent: 'The rendered content of the some-example example'
       }
-    };
-    tagDef = tagDefinitionFactory(examples, createDocMessageFactory());
+    });
+    tagDef = tagDefinitionFactory(exampleMap, createDocMessageFactory());
   });
 
   it("should have the correct name", function() {

examples/spec/inline-tag-defs/runnableExample.spec.js

@@ -1,15 +1,16 @@
 var generateExamplesProcessorFactory = require('../../processors/examples-generate');
 var mockLog = require('dgeni/lib/mocks/log');
 var _ = require('lodash');
+var StringMap = require('stringmap');
 
 describe("examples-generate processor", function() {
-  var templateFolder, deployments, docs, examples;
+  var templateFolder, deployments, docs, exampleMap;
 
   beforeEach(function() {
 
     docs = [{ file: 'a.b.js' }];
 
-    examples = {};
+    exampleMap = new StringMap();
 
     files = {};
 
@@ -18,16 +19,16 @@ describe("examples-generate processor", function() {
     files['app.css'] = { type: 'css', name: 'app.css', fileContents: 'app.css content' };
     files['app.spec.js'] = { type: 'spec', name: 'app.spec.js', fileContents: 'app.spec.js content' };
 
-    examples['a.b.c'] = {
+    exampleMap.set('a.b.c', {
       id: 'a.b.c',
       doc: docs[0],
       outputFolder: 'examples',
       deps: 'dep1.js;dep2.js',
       files: files,
       deployments: {}
-    };
+    });
 
-    processor = generateExamplesProcessorFactory(mockLog, examples);
+    processor = generateExamplesProcessorFactory(mockLog, exampleMap);
     processor.templateFolder = 'examples';
     processor.deployments = [
       {
@@ -95,6 +96,6 @@ describe("examples-generate processor", function() {
     var manifestDoc = _.filter(docs, { docType: 'example-file', template: 'manifest.template.json' })[0];
     expect(manifestDoc.id).toEqual('a.b.c/manifest.json');
     expect(manifestDoc.docType).toEqual('example-file');
-    expect(manifestDoc.example).toEqual(examples['a.b.c']);
+    expect(manifestDoc.example).toEqual(exampleMap.get('a.b.c'));
   });
 });

examples/spec/processors/examples-generate.spec.js

@@ -2,15 +2,16 @@ var parseExamplesProcessorFactory = require('../../processors/examples-parse');
 var mockLog = require('dgeni/lib/mocks/log')(false);
 var createDocMessageFactory = require('../../../base/services/createDocMessage');
 var _ = require('lodash');
+var StringMap = require('stringmap');
 
-describe("examples-parse doc processor", function() {
+describe("parseExamplesProcessor", function() {
 
-  var processor, examples, mockTrimIndentation;
+  var processor, exampleMap, mockTrimIndentation;
 
   beforeEach(function() {
-    examples = {};
+    exampleMap = new StringMap();
     mockTrimIndentation = jasmine.createSpy('trimIndentation').and.callFake(function(value) { return value; });
-    processor = parseExamplesProcessorFactory(mockLog, examples, mockTrimIndentation, createDocMessageFactory());
+    processor = parseExamplesProcessorFactory(mockLog, exampleMap, mockTrimIndentation, createDocMessageFactory());
   });
 
   it("should extract example tags from the doc content", function() {
@@ -27,12 +28,12 @@ describe("examples-parse doc processor", function() {
       }
     ];
     processor.$process(docs);
-    expect(examples['example-bar']).toEqual(jasmine.objectContaining({ name:'bar', moo1:'nar1', id: 'example-bar'}));
-    expect(examples['example-bar1']).toEqual(jasmine.objectContaining({ name:'bar', moo2:'nar2', id: 'example-bar1'}));
-    expect(examples['example-value']).toEqual(jasmine.objectContaining({ name:'value', id: 'example-value'}));
-    expect(examples['example-with-files']).toEqual(jasmine.objectContaining({ name: 'with-files', id: 'example-with-files'}));
+    expect(exampleMap.get('example-bar')).toEqual(jasmine.objectContaining({ name:'bar', moo1:'nar1', id: 'example-bar'}));
+    expect(exampleMap.get('example-bar1')).toEqual(jasmine.objectContaining({ name:'bar', moo2:'nar2', id: 'example-bar1'}));
+    expect(exampleMap.get('example-value')).toEqual(jasmine.objectContaining({ name:'value', id: 'example-value'}));
+    expect(exampleMap.get('example-with-files')).toEqual(jasmine.objectContaining({ name: 'with-files', id: 'example-with-files'}));
 
-    var files = examples['example-with-files'].files;
+    var files = exampleMap.get('example-with-files').files;
     var file = files['app.js'];
     expect(file.name).toEqual('app.js');
     expect(file.type).toEqual('js');
@@ -53,8 +54,8 @@ describe("examples-parse doc processor", function() {
                     '<example name="bar">some example content 2</example>'
     }];
     processor.$process(docs);
-    expect(examples['example-bar'].id).toEqual('example-bar');
-    expect(examples['example-bar1'].id).toEqual('example-bar1');
+    expect(exampleMap.get('example-bar').id).toEqual('example-bar');
+    expect(exampleMap.get('example-bar1').id).toEqual('example-bar1');
   });
 
   it("should inject a new set of elements in place of the example into the original markup to be used by the template", function() {