gitbook/lib/parse/lex.js

var _ = require('lodash');
var marked = require('marked');

// Split a page up into sections (lesson, exercises, ...)
function splitSections(nodes) {
    var section = [];

    return _.reduce(nodes, function(sections, el) {
        if(el.type === 'hr') {
            sections.push(section);
            section = [];
        } else {
            section.push(el);
        }

        return sections;
    }, []).concat([section]); // Add remaining nodes
}

function isQuizNode(node) {
    return /^[(\[][ x][)\]]/.test(node.text || node);
}

// What is the type of this section
function sectionType(nodes, idx) {
    var codeType = { type: 'code' };

    // Number of code nodes in section
    var len = _.filter(nodes, codeType).length;

    if(
        // Got 3 or 4 code blocks
        (len === 3 || len === 4) &&
        // Ensure all nodes are at the end
        _.all(_.last(nodes, len), codeType)
    )
    {
        return 'exercise';
    }

    if (nodes.length > 2) {
        var potentialQuizNodes = nodes.slice(nodes[0].type === 'paragraph' ? 1 : 0);
        if (_.some(potentialQuizNodes, { type: 'blockquote_start' })) {
            for (var i = 0; i < potentialQuizNodes.length; i++) {
                var node = potentialQuizNodes[i];
                if ((node.type === 'list_item_start' && isQuizNode(potentialQuizNodes[i+1])) ||
                    (node.type === 'table' && _.every(potentialQuizNodes[i].cells[0].slice(1), isQuizNode))){
                    return 'quiz'
                }
            }
        }
    }

    return 'normal';
}

// Generate a uniqueId to identify this section in our code
function sectionId(section, idx) {
    return _.uniqueId('gitbook_');
}

function lexPage(src) {
    // Lex file
    var nodes = marked.lexer(src);

    return _.chain(splitSections(nodes))
    .map(function(section, idx) {
        // Detect section type
        section.type = sectionType(section, idx);
        return section;
    })
    .map(function(section, idx) {
        // Give each section an ID
        section.id = sectionId(section, idx);
        return section;

    })
    .filter(function(section) {
        return !_.isEmpty(section);
    })
    .reduce(function(sections, section) {
        var last = _.last(sections);

        // Merge normal sections together
        if(last && last.type === section.type && last.type === 'normal') {
            last.push.apply(last, [{'type': 'hr'}].concat(section));
        } else {
            // Add to list of sections
            sections.push(section);
        }

        return sections;
    }, [])
    .value();
}

// Exports
module.exports = lexPage;