gitbook-plugin-oerschema/utilities.js

A GitBook Plugin to apply OER Schema metadata to GitBooks content

/**
 * Created by acb222 on 6/28/16.
 */

var md = require("markdown").markdown;

module.exports = {
    isBlocked: function (str) {
        return /(<(?!(\/?(span|meta|link|a|b|em|strong|i|u|oer))).*?\/?>)|(\w.*?\w\s*\|)|(^\={2,}$)|(^\*\s?[^\*]+$)/gmi.test(str) === true;
    },
    isResourcePrefixed: function (r) {
        return /^(https?:\/\/)|#/i.test(r) === true;
    },
    sanitizePrefix: function(str) {
        return this.isResourcePrefixed(str) ? str : '#' + str;
    },
    sanitizeName: function(name) {
        return /^[a-z]+\:/i.test(name) === true ? name : 'oer:' + name;
    },
    generateResourceName: function() {
        return '#oer' + ((new Date()).getTime() * Math.random());
    },
    printResource: function (body, block) {
        try {
            var attr = block.kwargs;
            var inner = '';

            if (block.blocks && block.blocks.length) {
                var blocks = block.blocks;
                for (var i = 0; i < blocks.length; i++) {
                    var b = blocks[i];

                    if (!!b.name && /^(end)/.test(b.name)) {
                        inner += md.toHTML(b.body);
                        continue;
                    }

                    switch (b.name) {
                        case 'oer_property':
                            inner += this.printProperty(b);
                            break;
                        case 'oer_resource':
                            inner += this.printResource(b.body, b);
                            break;
                    }
                }
            }

            inner += md.toHTML(body);

            var tag = this.isBlocked(inner) ? 'div' : 'span';
            var output = '<' + tag;
            var oAttr = {};

            if (attr.id) {
                oAttr.resource = this.sanitizePrefix(attr.id);
            }

            if (attr.type) {
                oAttr.typeof = this.sanitizeName(attr.type);
            }

            if (attr.property) {
                if (attr.for) {
                    var res = oAttr.resource;
                    oAttr.resource = this.generateResourceName();
                    inner += '<oer resource="' + res + '" about="' + this.sanitizePrefix(attr.for) + '" rel="' + this.sanitizeName(attr.property) + '" href="' + oAttr.resource + '">';
                } else {
                    oAttr.property = this.sanitizeName(attr.property);
                }
            }

            for(var n in oAttr) {
                output += ' ' + n + '="' + oAttr[n] + '"';
            }

            output += '>' + inner + '</' + tag + '>';
        } catch (e) {
            output = e.message;
        }

        return output;
    },
    printProperty: function (block) {
        var attr = block.kwargs,
            tag,
            oAttr = {},
            output;

        block.body = md.toHTML(block.body);

        if (!attr.name) {
            throw new Error("Properties require a name");
        }

        oAttr.property = this.sanitizeName(attr.name);

        if (attr.id) {
            oAttr.resource = this.sanitizePrefix(attr.id);
        }

        if (attr.type) {
            oAttr.typeof = this.sanitizeName(attr.type);
        }

        if (attr.value) {
            if (!block.body) { // If no body, then use meta
                tag = 'meta';
            }
            oAttr.content = attr.value;
        } else if (attr.href) {
            tag = 'link';
            oAttr.href = this.sanitizePrefix(attr.href);
        }

        if (attr.for) {
            delete oAttr.property;
            oAttr.resource = this.generateResourceName();
            block.body += '<oer about="' + this.sanitizePrefix(attr.for)
                + '" rel="oer:' + attr.name + '" href="' + oAttr.resource + '">';
        }

        tag = tag || (block.body && this.isBlocked(block.body) ? 'div' : 'span');

        output = '<' + tag;

        for (var n in oAttr) {
            if (oAttr.hasOwnProperty(n)) {
                output += ' ' + n + '="' + oAttr[n] + '"';
            }
        }

        output += '>' + block.body;

        if (tag == 'div' || tag == 'span') {
            output += '</' + tag + '>';
        }

        return output;
    },
    printPage: function (content) {
        try {
            var matches = content.match(/<oer .*?href\=\"[^\"]+\".*?>/gim);
            content = content.replace(/<oer.*?>/gim, "");

            if (!!matches && !!matches.length) {
                for (var i = 0; i < matches.length; i++) {
                    content += matches[i].replace(/<oer\s/gim, '<link ');
                }
            }

            content = content.replace(/<p><div/, '<div').replace(/<\/div><\/p>/, '</div>');

            return '<div prefix="oer: http://oerschema.org/">' + content + '</div>';
        } catch (e) {
            return e.message;
        }
    }
};