gulpfile.js

'use strict';

var gulp        = require('gulp'),
    $$          = require('gulp-load-plugins')(),
    runSequence = require('run-sequence'),
    browserSync = require('browser-sync').create(),
    exec        = require('child_process').exec,
    path        = require('path'),
    pipe        = require('multipipe');

var name        = 'fin-hypergrid',
    srcDir      = './src/',
    testDir     = './test/',
    jsFiles     = '**/*.js',
    addOnsDir   = './add-ons/',
    demoDir     = './demo/',
    buildDir    = demoDir + 'build/';

var replacementFinHypergrid = 'window.fin.Hypergrid.$2$1$2';

//  //  //  //  //  //  //  //  //  //  //  //

function gulpTaskAddOn(name, exportName) {
    gulp.task('browserify-add-on-' + name, browserify.bind(null,
        name,
        addOnsDir + name + '/',
        buildDir + addOnsDir,
        exportName
    ));
}

gulp.task('lint', lint);
gulp.task('test', test);
gulp.task('doc', doc);
gulp.task('beautify', beautify);
gulp.task('images', swallowImages);
gulp.task('browserify', browserify.bind(null,
    name,
    srcDir,
    buildDir
));
gulp.task('browserify-demo', browserify.bind(null,
    'index',
    './demo/js/demo/',
    './demo/js/demo/build/'
));

gulp.task('reloadBrowsers', reloadBrowsers);
gulp.task('serve', browserSyncLaunchServer);
gulp.task('add-ons', addOns);

gulp.task('css-templates', function() {
    return templates('./css/*.css', 'css');
});

gulp.task('build', function(callback) {
    clearBashScreen();
    runSequence(
        'lint',
        'images',
        'css-templates',
        'test',
        'add-ons',
        //'beautify',
        'browserify',
        'browserify-demo',
        //'doc',
        callback
    );
});

gulp.task('watch', function () {
    gulp.watch([
        addOnsDir + jsFiles,
        srcDir + '**', '!' + srcDir + 'jsdoc/**',
        './css/*.css',
        './html/*.html',
        demoDir + 'js/' + jsFiles, '!' + demoDir + 'js/demo/build/' + jsFiles,
        testDir + '**'
    ], [
        'build'
    ]);

    gulp.watch([
        demoDir + '*.html',
        demoDir + 'css/demo.css',
        buildDir + '*'
    ], [
        'reloadBrowsers'
    ]);
});

gulp.task('default', ['build', 'watch'], browserSyncLaunchServer);

//  //  //  //  //  //  //  //  //  //  //  //

function lint() {
    return gulp.src([
        'index.js',
        addOnsDir + jsFiles,
        srcDir + jsFiles, '!' + srcDir + '**/old/**/',
        demoDir + 'js/' + jsFiles, '!' + demoDir + 'js/demo/build/' + jsFiles,
        testDir + jsFiles,
    ])
        .pipe($$.excludeGitignore())
        .pipe($$.eslint())
        .pipe($$.eslint.format())
        .pipe($$.eslint.failAfterError());
}

function test(cb) {
    return gulp.src(testDir + jsFiles)
        .pipe($$.mocha({reporter: 'spec'}));
}

function beautify() {
    return gulp.src([srcDir + jsFiles, testDir + jsFiles])
        .pipe($$.beautify()) //apparent bug: presence of a .jsbeautifyrc file seems to force all options to their defaults (except space_after_anon_function which is forced to true) so I deleted the file. Any needed options can be included here.
        .pipe(gulp.dest(srcDir));
}

function browserify(name, srcDir, buildDir, exportName) {
    var exportsRegExp = exportName && new RegExp('module\\.exports(\\s*=\\s*)(' + exportName + ')');
    return gulp.src(srcDir + 'index.js')
        // .pipe($$.replace(
        //     /require\('fin-hypergrid\/src\/(.*?)'\)/g,
        //     function(match, p1) { console.log('hi');return 'window.fin.Hypergrid.' + p1.replace(/\//g, '.'); }
        // ))
        .pipe(
            $$.mirror(
                pipe(
                    $$.rename(name + '.js'),
                    $$.browserify({ debug: true })
                        .on('error', $$.util.log),
                    $$.replace(exportsRegExp, replacementFinHypergrid)
                ),
                pipe(
                    $$.rename(name + '.min.js'),
                    $$.browserify(),
                    $$.uglify()
                        .on('error', $$.util.log),
                    $$.replace(exportsRegExp, replacementFinHypergrid)
                )
            )
        )
        .pipe(gulp.dest(buildDir));
}

function doc(cb) {
    exec(path.resolve('jsdoc.sh'), function (err, stdout, stderr) {
        console.log(stdout);
        console.log(stderr);
        cb(err);
    });
}

function browserSyncLaunchServer() {
    browserSync.init({
        server: {
            // Serve up our build folder
            baseDir: demoDir
        },
        port: 9000
    });
}

function reloadBrowsers() {
    browserSync.reload();
}

function clearBashScreen() {
    var ESC = '\x1B';
    console.log(ESC + 'c'); // (VT-100 escape sequence)
}

function swallowImages() {
    var config = {
        src: {
            globs: [ 'images/*.png', 'images/*.gif','images/*.jpeg', 'images/*.jpg' ],
            options: {}
        },
        transform: {
            options: {},
            header: '',
            footer: ''
        },
        dest: {
            path: 'images',
            filename: 'images.js',
            header: 'module.exports = {\n',
            footer: '\n};\n',
            options: {}
        }
    };

    return gulp.src(config.src.globs, config.src.options)
        .pipe($$.imagine64(config.transform.options))
        .pipe($$.header(config.transform.header))
        .pipe($$.footer(config.transform.footer))
        .pipe($$.concat(config.dest.filename))
        .pipe($$.header(config.dest.header))
        .pipe($$.footer(config.dest.footer))
        .pipe(gulp.dest(config.dest.path, config.dest.options));
}

function templates(src, type) {
    return gulp.src(src)
        .pipe($$.each(function(content, file, callback) {
            var filename = path.basename(file.path, "." + type),
                member = /[^\w]/.test(filename) ? "['" + filename + "']" : "." + filename;

            // convert (groups of) 4 space chars at start of lines to tab(s)
            do {
                var len = content.length;
                content = content.replace(/\n((    )*)    (.*)/, "\n$1\t$3");
            } while (content.length < len);

            // quote each line and join them into a single string
            content = 'exports' + member + " = [\n'" + content
                    .replace(/\\/g, "\\\\") // escape all backslashes
                    .replace(/'/g, "\\'") // escape all single-quotes
                    .replace(/\n/g, "',\n'") + "'\n].join('\\n');\n";

            // remove possible blank line at end of each
            content = content.replace(/,\n''\n]/g, "\n]");

            callback(null, content); // the first argument is an error, if you encounter one
        }))
        .pipe($$.concat("index.js"))
        .pipe($$.header("'use strict';\n\n"))
        .pipe(gulp.dest(function(file) { return file.base; }));
}

function addOns() {
    return gulp.src(addOnsDir + '*.js')
    // Insert an IIFE around the code...
        .pipe($$.replace( // ...starting immediately following 'use strict' and...
            "'use strict';\n",
            "'use strict';\n(function() {"
        ))
        .pipe($$.replace( // ...ending after modules.exports.
            /\w+\.exports(\s*=\s*)(\w+);/,
            'window.fin.Hypergrid.$2$1$2;\n})();'
        ))
        .pipe(
            $$.mirror(
                pipe(
                    $$.rename(function (path) {
                        path.basename = addOnsDir + path.basename;
                    })
                ),
                pipe(
                    $$.rename(function (path) {
                        path.basename = addOnsDir + path.basename + '.min';
                    }),
                    $$.uglify() // minimize
                        .on('error', $$.util.log)
                )
            )
        )
        .pipe(gulp.dest(buildDir));
}