summaryrefslogtreecommitdiffstats
path: root/packages/gitbook-html/lib/summary.js
blob: 607062e6d6ed8ff03528ca17f9cd77e9d38244aa (plain)
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
var _ = require('lodash');
var dom = require('./dom');

var SELECTOR_LIST = '.olist > ol, ol, ul';
var SELECTOR_LINK = '> a, p > a';

var BL = '\n';

// Find a list
function findList($parent) {
    var $container = $parent.children('.olist');
    if ($container.length > 0) $parent = $container.first();

    return $parent.children('ul, ol');
}

// Parse a ul list and return list of chapters recursvely
function parseList($ul, $) {
    var articles = [];

    $ul.children('li').each(function() {
        var article = {};
        var $li = $(this);

        // Get text for the entry
        var $p = $li.children('p');
        article.title = $p.text() ||  dom.textNode($li.get(0));

        // Parse link
        var $a = $li.find(SELECTOR_LINK);
        if ($a.length > 0) {
            article.title = $a.first().text();
            article.path = $a.attr('href').replace(/\\/g, '/').replace(/^\/+/, '')
        }

        // Sub articles
        var $sub = findList($li);
        article.articles = parseList($sub, $);

        articles.push(article);
    });

    return articles;
}

// HTML -> Summary
function parseSummary(html) {
    var $ = dom.parse(html);
    var $root = dom.cleanup(dom.root($), $);

    var $lists = findList($root);
    var parts = [];

    $lists.each(function() {
        var $list = $(this);

        parts.push({
            articles: parseList($(SELECTOR_LIST).first(), $)
        });
    });

    return {
        parts: parts
    };
}

// Summary -> HTML
function textPrefix(d) {
    return Array(d*4).join(' ');
}

function articleToText(article, d) {
    var prefix = textPrefix(d);
    var content = prefix + '<li>';

    if (article.path) {
        content += '<a href="'+article.path+'">'+article.title+'</a>';
    } else {
        content += article.title;
    }

    if (article.articles.length > 0) {
        content += BL + articlesToText(article.articles, d) + prefix;
    }
    content +=  '</li>' + BL;

    return content;
}

function articlesToText(articles, d) {
    var prefix = textPrefix(d);
    var content = prefix + '<ul>' + BL;
    _.each(articles, function(_article) {
        content += articleToText(_article, d + 1);
    });
    return content + '</ul>' + BL;
}

function partsToText(part) {
    return articlesToText(part.articles, 0) + BL + BL;
}

function summaryToText(summary) {
    var content = '<h1>Summary</h1>' + BL;

    _.each(summary.parts, function(part) {
        content += partsToText(part);
    });

    return content + BL;
};


module.exports = parseSummary;
module.exports.toText = summaryToText;