refactor markdown parser code

* extract functions
* add test case for zero files

Author: tevio

core/lib/annotation_exporter.js

@@ -37,41 +37,45 @@ var annotations_exporter = function (pl) {
     return oldAnnotationsJSON.comments;
   }
 
-  /*
-   Converts the annotations.md file yaml list into an array of annotations
-   */
-  function parseAnnotationsMD() {
-    var markdown_parser = new mp();
-    var annotations = [];
-    var mdFiles = readDir.readSync(paths.source.annotations, ['*.md'])
+  function buildAnnotationMD(annotationsYAML, annotations, markdown_parser) {
+    var annotationsYAML = annotationsYAML;
+    var annotations = annotations;
 
-    mdFiles.forEach(function (file) {
-      var annotationsMD = '';
-      try {
-        annotationsMD = fs.readFileSync(path.resolve(paths.source.annotations, file), 'utf8');
-      } catch (ex) {
-        if (pl.config.debug) {
-          console.log('annotations.md file missing from ' + paths.source.annotations + '. This may be expected.');
-        }
-        return [];
-      }
+    for (var i = 0; i < annotationsYAML.length; i++) {
+      var annotation = {};
 
-    //take the annotation snippets and split them on our custom delimiter
-      var annotationsYAML = annotationsMD.split('~*~');
+      var markdownObj = markdown_parser.parse(annotationsYAML[i]);
 
-      for (var i = 0; i < annotationsYAML.length; i++) {
-        var annotation = {};
+      annotation.el = markdownObj.el || markdownObj.selector;
+      annotation.title = markdownObj.title;
+      annotation.comment = markdownObj.markdown;
 
-        var markdownObj = markdown_parser.parse(annotationsYAML[i]);
+      annotations.push(annotation);
+    }
+  }
 
-        annotation.el = markdownObj.el || markdownObj.selector;
-        annotation.title = markdownObj.title;
-        annotation.comment = markdownObj.markdown;
+  function parseMDFile(annotations, parser) {
+    var annotations = annotations;
+    var markdown_parser = parser;
+    return function (file) {
+      var annotationsMD = fs.readFileSync(path.resolve(paths.source.annotations, file), 'utf8');
 
-        annotations.push(annotation);
-      }
+    //take the annotation snippets and split them on our custom delimiter
+      var annotationsYAML = annotationsMD.split('~*~');
+      buildAnnotationMD(annotationsYAML, annotations, markdown_parser);
       return false;
-    })
+    }
+  }
+
+  /*
+   Converts the *.md file yaml list into an array of annotations
+   */
+  function parseAnnotationsMD() {
+    var markdown_parser = new mp();
+    var annotations = [];
+    var mdFiles = readDir.readSync(paths.source.annotations, ['*.md'])
+
+    mdFiles.forEach(parseMDFile(annotations, markdown_parser));
     return annotations;
   }
 

test/annotation_exporter_tests.js

@@ -3,13 +3,14 @@
 var eol = require('os').EOL;
 var Pattern = require('../core/lib/object_factory').Pattern;
 var extend = require('util')._extend;
+var anPath = './test/files/';
 
-function createFakePatternLab(customProps) {
+function createFakePatternLab(anPath, customProps) {
   var pl = {
     "config": {
       "paths": {
         "source": {
-          "annotations": './test/files/'
+          "annotations": anPath
         }
       }
     }
@@ -18,7 +19,7 @@ function createFakePatternLab(customProps) {
   return extend(pl, customProps);
 }
 
-var patternlab = createFakePatternLab();
+var patternlab = createFakePatternLab(anPath);
 var ae = require('../core/lib/annotation_exporter')(patternlab);
 
 exports['annotaton_exporter'] = {
@@ -65,5 +66,15 @@ exports['annotaton_exporter'] = {
 
     test.done();
 
+  },
+
+  'when there are 0 annotation files' : function (test) {
+    var emptyAnPath = './test/files/empty/';
+    var patternlab2 = createFakePatternLab(emptyAnPath);
+    var ae2 = require('../core/lib/annotation_exporter')(patternlab2);
+
+    var annotations = ae2.gather();
+    test.equals(annotations.length, 0);
+    test.done();
   }
 };