lib/parse/parseSummary.js


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

var Promise = require('../utils/promise');

var parseStructureFile = require('./parseStructureFile');
var Summary = require('../models/summary');
var SummaryModifier = require('../modifiers').Summary;

/**
    Parse summary in a book, the summary can only be parsed
    if the readme as be detected before.

    @param {Book} book
    @return {Promise<Book>}
*/
function parseSummary(book) {
    var readme = book.getReadme();
    var logger = book.getLogger();
    var readmeFile = readme.getFile();

    if (!readmeFile.exists()) {
        return Promise.reject(new Error('Summary parsing should be done after readme parsing'));
    }

    return parseStructureFile(book, 'summary')
    .spread(function(file, result) {
        if (!file) {
            logger.warn.ln('no summary file in this book');
            return book;
        }
        logger.debug.ln('summary file found at', file.getPath());

        var summary = Summary.createFromParts(file, result.parts);


        // Insert readme as first entry
        var firstArticle = summary.getFirstArticle();
        if (!firstArticle || firstArticle.getRef() !== readmeFile.getPath()) {
            summary = SummaryModifier.unshiftArticle(summary, {
                title: 'Introduction',
                ref: readmeFile.getPath()
            });
        }


        // Set new summary
        return book.set('summary', summary);
    });
}

module.exports = parseSummary;