gulpfile.js

/**
 * Gulp file (experimental) to concat all the scripts and minimize load time.
 * Usage:
 *
 * npm install gulp gulp-autoprefixer gulp-minify-css gulp-jshint gulp-concat gulp-notify gulp-rename gulp-replace gulp-json-editor js-beautify request webdriverio --save-dev
 * gulp
 *
 * to generate deployment packages:
 *
 * gulp deploy
 */

var gulp = require('gulp'),
    autoprefixer = require('gulp-autoprefixer'),
    minifycss = require('gulp-minify-css'),
    jshint = require('gulp-jshint'),
    rename = require('gulp-rename'),
    concat = require('gulp-concat'),
    concatCss = require('gulp-concat-css'),
    replace = require('gulp-replace'),
    notify = require('gulp-notify'),
    jsonedit = require("gulp-json-editor"),
    zip = require('gulp-zip'),
    fs = require('fs'),
    request = require('request'),
    spawn = require('child_process').spawn;

var ver = String(fs.readFileSync('VERSION'));
var nightly = false; // for nightly builds


// scripts are provided in order to prevent any problems with the load order
var scripts = ['./js/ap*.js', './js/controllers/*.js', './js/controllers/*/*.js', './js/directives/*.js', './js/services/*.js', './js/services/*/*.js', '!./js/**/**/Nyaa.js'];


/**
 * Dependencies for the app, will be rolled into deps.js
 */
var deps = [];

/**
 * CSS files to be concatted. Note that there's separate code to include print.js
 */
var styles = [
    './css/bootstrap.min.css',
    './css/main.css',
    './css/anim.css',
    './css/dialogs.css',
    './css/flags.css'
];

/**
 * Minimum app dependencies for background.js
 */
var background = [
    "js/background.js"
];

/**
 * Default and depoyment tasks:
 * Concats scripts, dependencies, background page, styles, alters the main template to use dist versions and writes all of this the local dist/ directory
 */
gulp.task('default', ['concatScripts', 'concatDeps', 'concatBackgroundPage', 'concatStyles', 'print.css', 'launch.js', 'tabTemplate' /*, 'scenenames'*/ ], function() {
    notify('packaging to dist/ done');
});


gulp.task('build-standalone', ['deploy'], function() {
    var NwBuilder = require('node-webkit-builder');
    var nw = new NwBuilder({
        files: './dist/*.*', // use the glob format
        platforms: ['win'], //, 'osx', 'linux32', 'linux64'],
        buildDir: '../deploy/binaries',
        cacheDir: '../deploy/cache',
        buildType: 'versioned',
        winIco: './img/favicon.ico'
    });

    // Log stuff you want
    nw.on('log', console.log);

    // Build returns a promise
    return nw.build().then(function() {
        console.log('all done!');
    }).catch(function(error) {
        console.error(error);
    });
});

/**
 * Create a nightly build and immediately deploy it to the webstore
 */
gulp.task('nightly', function() {
    nightly = true;
    var d = new Date();
    ver = [d.getFullYear() + '' + d.getMonth(), d.getDate(), d.getHours(), d.getMinutes()].join('.');
    spawn("java", ["-Dwebdriver.chrome.driver=..\\chromedriver.exe", ' -jar ..\\selenium-server-standalone-2.43.1.jar'], {
        cwd: process.cwd()
    });
    gulp.start('deploy').start('webstore-nightly');
});


/**
 * Push a nightly release to the webstore.
 * These are
 */
gulp.task('webstore-nightly', function() {
    var changelog = fs.readFileSync('./README.md').toString();
    var start = changelog.indexOf('Changelog: \r\n==========');
    changelog = changelog.substring(start + 26).split('*')[0];

    var webdriverjs = require('webdriverio'),
        client = webdriverjs.remote({
            desiredCapabilities: {
                browserName: 'chrome',
            },
            logLevel: 'error'
        }).init();

    // i fucking love this
    client
        .url('https://chrome.google.com/webstore/developer/dashboard?hl=en&gl=NL') // login
    .waitFor('#Email')
        .setValue('#Email', process.env.USERNAME)
        .setValue('#Passwd', process.env.PWD || '');
    if (process.env.PWD) {
        client.click('#signIn'); // auto sign in if env user and pass provided
    }
    client.waitFor('form#cx-dash-form', 30000) // wait for redirect to dashboard
    .url('https://chrome.google.com/webstore/developer/edit/gelgiagalkgliccemepngfeahpmihnjp?hl=en&gl=NL') // new tab mode canary version
    .click('.cx-title input[type=button]') // hit upload new version
    .waitFor('#browse-btn') // wait for page to load
    .chooseFile('input[type=file]', '../deploy/newtab-nightly.zip') // select nightly
    .click('#upload-btn') // hit upload
    .waitFor('.id-publish', 30000) // wait for the redirect
    .execute(function(c) { // adjust the changelog to include last update from readme
        var el = document.querySelector('#cx-dev-edit-desc');
        var value = el.value.split("Changelog:");
        el.value = value[0] + "Changelog:\r\n* " + c.toString().trim() + "\r\n" + value[1].trim();
    }, [changelog])
        .click('.id-publish'); // hit the publish button
    //.end(); // close the browser
});

/**
 * Start the cascade to be able to create zip packages.
 * This executes, via sequence dependencies:
 * - default task
 * - copy dist files and dependencies into 3 individual directories in ../deploy/
 * - copy tab.html into place
 * - adjust manifests to include version info and write that to ../deploy/<flavour>/manifest.json
 * - zip files from ../deploy/<flavour>/ into ../deploy/<flavour>-<version>.zip
 * - copy that file into ../deploy/<flavour>-latest.zip
 */
gulp.task('deploy', ['zipbrowseraction', 'zipnewtab', 'zipopera'], function() {
    var latestTag = nightly ? 'nightly' : 'latest';
    gulp.src('../deploy/newtab-' + ver + '.zip')
        .pipe(rename('newtab-' + latestTag + '.zip'))
        .pipe(gulp.dest('../deploy/'));
    gulp.src('../deploy/browseraction-' + ver + '.zip')
        .pipe(rename('browseraction-' + latestTag + '.zip'))
        .pipe(gulp.dest('../deploy/'));
    notify('DEPLOY done to ../deploy/ !');

});

gulp.task('scenenames', function() {
    notify('downloading new scene name exceptions');
    request('https://raw.githubusercontent.com/midgetspy/sb_tvdb_scene_exceptions/gh-pages/exceptions.txt', function(error, response, result) {
        var output = {};
        result = result.split(/,\r\n/g).map(function(line) {
            var l = line.match(/([0-9]+): '(.*)'/);
            if (l) {
                var candidates = l[2].split("', '");
                output[l[1]] = candidates[0].replace('\\\'', "'").replace(/\(US\)/, "").replace(/\([1-2][09]([0-9]{2})\)/, '').trim();
            }
        });
        var sceneNameFile = fs.readFileSync('js/services/SceneNameResolver.js');
        output = sceneNameFile.toString().replace(/exceptions \= (\{[\s\S]+\})\;/g, 'exceptions = ' + JSON.stringify(output, null, 4) + ';');
        fs.writeFileSync('js/services/SceneNameResolver.js', output);
        notify('SceneNameResolver.js was updated');
    });
});



/**
 * Tasks for internal use
 * Each task called by the main task is listing the tasks that need to be executed as dependencies as an array as the second argument
 * Since tasks run in parallell by default, this can seem confusing at first
 */

/*------------------------------------------------------------------------*/

/**
 * Concat the scripts array into a file named dist/app.js
 */
gulp.task('concatScripts', function() {
    return gulp.src(scripts)
        .pipe(concat('app.js', {
            newLine: ';'
        }))
        .pipe(gulp.dest('dist/'))
        .pipe(notify({
            message: 'Scripts packaged to dist/app.js'
        }));
});

/**
 * Concat the dependencies array into a file named dist/deps.js
 */
gulp.task('concatDeps', function() {

    var tab = fs.readFileSync('tab.html').toString()
    var matches = tab.match(/<!-- deploy:replace\=\'(.*)\' -->([\s\S]+?)[^\/deploy:]<!-- \/deploy:replace -->/g);
    var deps = [];
    matches.map(function(match) {
        if (match.indexOf('dist\/deps.js') > -1) {
            deps = match.match(/\.(\/js\/[a-zA-Z0-9\/\.\-]+)/g).map(function(script) {
                if (script.indexOf('.min.js') >= -1) {
                    return script;
                } else {
                    var mifi = script.replace('.js', '.min.js');
                    return fs.existsSync(mifi) ? mifi : script;
                }
            })
        }
    });
    return gulp.src(deps)
        .pipe(concat('deps.js', {
            newLine: ';'
        }))
        .pipe(gulp.dest('dist/'))
        .pipe(notify({
            message: 'Deps packaged to dist/deps.js'
        }));
});

/**
 * Concat the background page and it's dependencies into dist/background.js
 */
gulp.task('concatBackgroundPage', function() {
    return gulp.src(background)
        .pipe(concat('background.js', {
            newLine: ';'
        }))
        .pipe(gulp.dest('dist/'))
        .pipe(notify({
            message: 'Background page packaged to dist/background.js'
        }));
});

/** 
 * Copy launch.js into place
 */
gulp.task('launch.js', function() {
    return gulp.src(['launch.js', 'package.json'])
        .pipe(gulp.dest('dist/'));
});

var templateCache = require('gulp-angular-templatecache');

gulp.task('buildTemplateCache', function() {
    return gulp.src('templates/**/*.html')
        .pipe(templateCache({
            module: 'DuckieTV'
        }))
        .pipe(gulp.dest('dist'))
        .pipe(notify({
            message: 'Templatecache deployed'
        }));
})



/**
 * Parse tab.html and grab the deploy:replace comments sections.
 * Grab the parameter value to those tags, and replace the content with that so that we're left with with just a couple of includes
 */
gulp.task('tabTemplate', ['buildTemplateCache'], function() {
    return gulp.src(['tab.html'])
        .pipe(replace(/<!-- deploy:replace\=\'(.*)\' -->([\s\S]+?)[^\/deploy:]<!-- \/deploy:replace -->/g, '$1'))
        .pipe(replace('</body>', '<script src="dist/templates.js"></script></body>'))
        .pipe(gulp.dest('dist/'))
        .pipe(notify({
            message: 'Tab template deployed'
        }));
});

/**
 * Concat the styles.js into dist/style.css
 */
gulp.task('concatStyles', function() {
    return gulp.src(styles)
        .pipe(concatCss("style.css"))
        .pipe(gulp.dest('dist/'))
        .pipe(notify({
            message: 'Styles concatted'
        }));
});

/**
 * Move print.css into place
 */
gulp.task('print.css', function() {
    return gulp.src('css/print.css')
        .pipe(gulp.dest('dist/'));
});

/**
 * Deployment and packaging functions
 */

gulp.task('copyToDeploy', ['default'], function() {
    return gulp.src(['VERSION', 'trakt-trending-500.json', '_locales/**', 'dist/**', 'fonts/**', 'img/**', 'templates/**'], {
            "base": "."
        })
        .pipe(gulp.dest('../deploy/browseraction'))
        .pipe(gulp.dest('../deploy/newtab'));
});

/**
 * Copy the altered tab.html into place
 */
gulp.task('copytab', ['copyToDeploy'], function() {
    return gulp.src('dist/tab.html')
        .pipe(gulp.dest('../deploy/browseraction'))
        .pipe(gulp.dest('../deploy/newtab'));
});

/**
 * Adjust all 3 versions of manifest.json to use the dist versions of scripts
 * launch.js contains the button attach code for browser-action mode
 * Also updates the manifest to include the latest version defined in the VERSION file
 */
gulp.task('manifests', ['copytab'], function() {

    // js-format formatting options used in manipulating manifest.json
    var formatOptions = {
        'indent_char': '\t',
        'indent_size': 1,
        'brace_style': 'end-expand'
    };

    var noLaunch = function(json) {
        json.version = ver;
        json.background.scripts = ['dist/background.js'];
        return json;
    };

    /**
     * Modify package.json to remove the whole list of background scripts and replace it with dist version and launch.js
     */
    var withLaunch = function(json) {
        json.version = ver;
        json.background.scripts = ['dist/background.js', 'dist/launch.js'];
        return json;
    };

    if (nightly) {
        console.log('nightly mode!');
        gulp.src('./_locales/**/messages.json')
            .pipe(jsonedit(function(json) {
                json.appNameNewTab.message += " - Canary";
                json.appShortNameNewTab.message += " - Canary";
                json.appNameBrowserAction.message += " - Canary";
                json.appShortNameBrowserAction.message += " - Canary";
                return json;
            }, formatOptions))
            .pipe(gulp.dest('../deploy/newtab/_locales/'))
            .pipe(gulp.dest('../deploy/browseraction/_locales/'));
    }

    gulp.src('manifest.json')
        .pipe(jsonedit(noLaunch, formatOptions))
        .pipe(gulp.dest('../deploy/newtab/'));
    return gulp.src('manifest-app.json')
        .pipe(rename('manifest.json'))
        .pipe(jsonedit(withLaunch, formatOptions))
        .pipe(gulp.dest('../deploy/browseraction/'));
});

/**
 * Zip the browser action version
 */
gulp.task('zipbrowseraction', ['manifests'], function() {
    return gulp.src('../deploy/browseraction/**')
        .pipe(zip('browseraction-' + ver + '.zip'))
        .pipe(gulp.dest('../deploy'));
});

/**
 * zip the new tab version
 */

gulp.task('zipnewtab', ['manifests'], function() {
    return gulp.src('../deploy/newtab/**')
        .pipe(zip('newtab-' + ver + '.zip'))
        .pipe(gulp.dest('../deploy'));
});