cs10_test.js

/**  LLAB AUTOBUILD WIP SCRIPT
 *
 *  TODO: This script is NOT FINISHED
 *  run with `node edc_test.js`
 */

// Default Node modules
fs = require('fs');
path = require('path');
exec = require('child_process').execSync;

cheerio = require('cheerio');
mkdirp = require('mkdirp');

llab = require('./lib/llab');
css = require('./code/css')
util = require('./code/util');

BASEURL = '/bjc-r'; // MATCH LLAB.ROOTURL IN CURR REPO
// This is where a llab course CONTENT lives
// This should be a checked out state
// TODO: Config param this shit.
curFolder = '../..' + BASEURL + '/';
// This is where the edX XML folder will be.
// TODO: CONFIG THIS SHIT.
output = './tmp/';



if (false) {
    topic = 'berkeley_bjc/recur/recursive-reporters-part2.topic'
    output += 'recur-2/';
    // topic = 'berkeley_bjc/recur/recursive-reporters-part1.topic';
} else {
    output += 'hofs/';
    topic = 'berkeley_bjc/hofs/hofs-with-recursion.topic';
}

mkdirp.sync(output);

var PROCESS_FUNCTIONS = {
    file: processFile,
    quiz: processQuiz,
    markdown: processMarkdown,
    external: processExternal
};


topic = fs.readFileSync(util.topicPath(curFolder, topic));
topic = topic.toString();
data = llab.parse(topic);

// GLOBAL -- FIXME
var relPath;
var count;
var dir;
var PETER = false;


var cssRelPath = path.relative(curFolder, '../../bjc-r/llab/css/default.css');
var CSSOptions = {
    paths: [
        // TODO: Use newer llab stuff?
        // TODO: Exclude Bootstrap?
        curFolder + '/llab/lib/bootstrap/dist/css/bootstrap.min.css',
        curFolder + '/llab/lib/bootstrap/dist/css/bootstrap-theme.min.css',
        curFolder + '/llab/css/default.css'
    ],
    rules: [
        {
            name: 'transform-urls',
            // Params: llab base url, relative file paths
            options: [BASEURL, cssRelPath]
        },
        {
            name: 'rename-selectors',
            options: ['.full', '.llab-full']
        },
        {
            name: 'prefix-selectors',
            options: '.llab-full'
            // , exclude: /bootstrap/
        }
    ]
};

CSS_FILE_NAME = 'bjc-edx-cs10.css';

css_file = fs.openSync(output + CSS_FILE_NAME, 'w');
fs.writeSync(css_file, css(CSSOptions));

cssPath = util.edXPath(CSS_FILE_NAME);
cssString = '<link rel="stylesheet" href="' + cssPath + '">';
jsPath = util.edXPath('edx-llab-hack.js');
cssString += '<script src="' + jsPath + '"></script>\n\n';

function loadFile (path) {

}

data.topics.forEach(parseTopic);


function parseTopic (topic, args) {
    topic.contents.forEach(parseSection, args);
}

function shouldParse (title) {
    return true;
    // return title.indexOf('Programming Lab') == 0 ||
    // title.indexOf('Investigation') == 0;
}

function parseSection (section, skip) {
    var title = section.title.trim();

    if (!shouldParse(title)) {
        console.log('skipping:', title);
        return;
    }

    dir = output;
    if (!PETER) {
        dir += title;
    }
    // Make if it doesn't exist.
    mkdirp.sync(dir);
    count = 0;
    results = [];
    section.contents.forEach(function (item) {
        // This also writes files...hmmm.
        results.push(processCurriculumItem(item));
    });

    return results;
}

// This needs renamed...
function processCurriculumItem (item) {
    if (!item.url) {
        return;
    } else if (item.url.indexOf(BASEURL) != 0) {
        return;
    }

    count += 1;
    file = item.url.replace(BASEURL, curFolder);
    relPath = path.relative(curFolder, file);
    console.log('FILE: ', file);
    html = fs.readFileSync(file);

    parts = splitFile(html, count, dir);
    parts.forEach(function(part, index) {
        var css = index == 0;
        var data = processItem(part, css);
        // part.path is a file name
        console.log(dir);
        var folder = dir + '/' + part.directory
        console.log('WRITING CONTENT', folder + part.path);
        mkdirp.sync(folder);
        fs.writeFileSync(folder + part.path, data);
    });

    return parts;
};

function processItem (item, options) {
    return PROCESS_FUNCTIONS[item.type].call(null, item.content, options);
}

function processQuiz (quiz) {
    return quiz;
}

function processMarkdown (file) {
    return file;
}

function processFile (file, options) {
    // FIXME -- this is a simplification for now.
    return processHTML(file, options);
}

function processExternal (item, options) {
    return item;
}

/** Does the work to modify a bunch of things to prep for edX
 *
 * @param {Cherrio-Object} The contents of the html file
 *
 */
// TODO: This needs to take in an array of functions.
function processHTML (html, includeCSS) {
    var $, outerHTML, wrap;

    $ = cheerio.load(html);

    // Fix some of the EDC image elements with .button
    // These conflict with edX.
    $('.button').removeClass('button');

    // Fix image URLs
    // TODO: Log images to a location to rename files.
    $('img').each(function (index, elm) {
        var url = $(elm).attr('src');
        $(elm).attr('src', util.transformURL(BASEURL, relPath, url));
    });

    // Fix Snap! run links.
    console.log('Found ', $('a').length, ' ALL urls.');
    console.log('Transforming ', $('a.run').length, ' STARTER FILE urls.');
    $('a.run').each(function (index, elm) {
        var url = $(elm).attr('href');
        $(elm).attr('href', util.transformURL(BASEURL, relPath, url)).attr('target', '_blank');
    });

    // Remove EDC's inline HTML comments. (Why is it there.....)
    [
        '.comment',
        '.todo',
        '.commentBig'
    ].forEach(function (sel) { $(sel).remove(); });

    // wrap content in div.llab-full
    wrap = '<div class="llab-full">CONTENT</div>';

    outerHTML = wrap.replace(/CONTENT/, $.html());

    if (includeCSS != false) {
        outerHTML = cssString + outerHTML;
    }

    return outerHTML;
}

/** Split a single curriculum page into components to be in a vertical.
 *
 * @param {string} the raw HTML file to be processed
 */
function splitFile (html, page, dir) {
    var $, output, title, quizzes, qzHTML, text;

    output = [];
    $ = cheerio.load(html);

    // EDC Puts an <h2> at the beginning of every page.
    // TODO: HACKY -- THIS NEEDS TO BE GENERCIZED
    title = $('h2').first().text();

    text = $('body').html()
    // parse quizes separately.
    quizzes = $('div.assessment-data');
    console.log('Found ', quizzes.length, ' quizzes.');
    quizzes.each(function(index, elm) {
        qzHTML = $.html(elm); // like a call to outerHTML()
        command = 'python3 code/mc_parser.py \'' + qzHTML + '\'';
        xml = exec(command).toString();
        var idx = text.indexOf(qzHTML);
        var before = text.slice(0, idx).trim();

        if (before.length) {
            num = output.length + 1;
            file = page + '-' + num + '-' + title + '.html';
            file = util.edXFileName(file);
            output.push({
                type: 'file',
                title: num + '-' + title,
                content: before,
                directory: 'html/',
                path: file
            }); // part before quiz
        }

        num = output.length + 1;
        file = page + '-' + num + '-' + title + '.xml';
        file = util.edXFileName(file);
        output.push({
            type: 'quiz',
            title: num + '-' + 'Quiz-'+ title,
            content: xml,
            directory: 'problem/',
            path: file
        }); // push quiz
        text = text.slice(idx + qzHTML.length);
    });

    if (quizzes.length == 0) {
        file = page + '-' + title + '.html';
        file = util.edXFileName(file);
        output.push({
            type: 'file',
            title: title,
            content: text,
            directory: 'html/',
            path: file
        });
    }

    return output;
}

module.exports = function(path, sectionName, directory) {
    // Globals
    PETER = true;
    // util.topicPath(curFolder, path) == assuming we have some folder.
    topic = fs.readFileSync(path).toString();
    data = llab.parse(topic);
    output = directory;

    var topic, data, result;

    data.topics.forEach(function (topic) {
        topic.contents.some(function (section) {
            var title = section.title.trim();
            found = title.indexOf(sectionName) != -1;
            if (found) {
                tmp = parseSection(section);
                result = tmp;
                return true;
            }
        });
    });

    return result;
}


console.log('This conversion is done!');