summaryrefslogtreecommitdiffstats
path: root/packages/gitbook-html/src/summary.js
blob: 1dda344a38ec347e0b452d4442353ee749ae5346 (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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
const dom = require('./dom');

const SELECTOR_LIST = 'ol, ul';
const SELECTOR_LINK = '> a, p > a';
const SELECTOR_PART = 'h2, h3, h4';

/**
 * Find a list.
 * @param {cheerio.Node}
 * @return {cheerio.Node}
 */
function findList($parent) {
    const $container = $parent.children('.olist');
    if ($container.length > 0) $parent = $container.first();

    return $parent.children(SELECTOR_LIST);
}

/**
 * Parse a ul list and return list of chapters recursvely.
 * @param {cheerio.Node}
 * @param {cheerio.DOM}
 * @return {Array}
 */
function parseList($ul, $) {
    const articles = [];

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

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

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

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

        if (!article.title) return;
        articles.push(article);
    });

    return articles;
}

/**
 * Find all parts and their corresponding lists.
 * @param {cheerio.Node}
 * @param {cheerio.DOM}
 * @return {Array<{title: String, list: cheerio.Node}>}
 */
function findParts($parent, $) {
    // Find parts and lists
    // TODO asciidoc compatibility
    const partsAndLists = $parent.children(SELECTOR_LIST + ', ' + SELECTOR_PART);

    // Group each part with the list after
    const parts = [];
    let previousPart = null;

    partsAndLists.each((i, el) => {
        if (isPartNode(el)) {
            if (previousPart !== null) {
                // The previous part was empty
                parts.push(previousPart);
            }
            previousPart = {
                title: getPartTitle(el, $),
                list: null
            };

        } else { // It is a list
            if (previousPart !== null) {
                previousPart.list = el;
            } else {
                previousPart = {
                    title: '',
                    list: el
                };
            }
            parts.push(previousPart);
            previousPart = null;
        }
    });

    // Last part might be empty
    if (previousPart !== null) {
        parts.push(previousPart);
    }

    return parts;
}

/**
 * True if the element is a part.
 * @param el
 * @return {Boolean}
  */
function isPartNode(el) {
    return SELECTOR_PART.indexOf(el.name) !== -1;
}

/**
 * Parse the title of a part element.
 * @param el
 * @param {cheerio.DOM} $
 * @return {String}
 */
function getPartTitle(el, $) {
    return $(el).text().trim();
}

/**
 * Parse an HTML content into a tree of articles/parts.
 * @param {String} html
 * @return {Object}
 */
function parseSummary(html) {
    const $ = dom.parse(html);
    const $root = dom.cleanup(dom.root($), $);

    const parts = findParts($root, $);

    // Parse each list
    const parsedParts = [];
    let part;
    for (let i = 0; i < parts.length; ++i) {
        part = parts[i];
        parsedParts.push({
            title: part.title,
            articles: parseList($(part.list), $)
        });
    }

    return {
        parts: parsedParts
    };
}

module.exports = parseSummary;