Base

lib/parse/parseStructureFile.js

@@ -0,0 +1,57 @@
+var findParsableFile = require('./findParsableFile');
+var Promise = require('../utils/promise');
+var error = require('../utils/error');
+
+/**
+    Parse a ParsableFile using a specific method
+
+    @param {FS} fs
+    @param {ParsableFile} file
+    @param {String} type
+    @return {Promise<Array<String, List|Map>>}
+*/
+function parseFile(fs, file, type) {
+    var filepath = file.getPath();
+    var parser = file.getParser();
+
+    if (!parser) {
+        return Promise.reject(
+            error.FileNotParsableError({
+                filename: filepath
+            })
+        );
+    }
+
+    return fs.readAsString(filepath)
+    .then(function(content) {
+        return [
+            file,
+            parser[type](content)
+        ];
+    });
+}
+
+
+/**
+    Parse a structure file (ex: SUMMARY.md, GLOSSARY.md).
+    It uses the configuration to find the specified file.
+
+    @param {Book} book
+    @param {String} type: one of ["glossary", "readme", "summary"]
+    @return {Promise<List|Map>}
+*/
+function parseStructureFile(book, type) {
+    var fs = book.getContentFS();
+    var config = book.getConfig();
+
+    var fileToSearch = config.getValue(['structure', type]);
+
+    return findParsableFile(book, fileToSearch)
+    .then(function(file) {
+        if (!file) return [undefined, undefined];
+
+        return parseFile(fs, file, type);
+    });
+}
+
+module.exports = parseStructureFile;