mazda-custom-application-sdk/gulpfile.js

/**
 * Custom Application SDK for Mazda Connect Infotainment System
 *
 * A micro framework that allows to write custom applications for the Mazda Connect Infotainment System
 * that includes an easy to use abstraction layer to the JCI system.
 *
 * Written by Andreas Schwarz (http://github.com/flyandi/mazda-custom-applications-sdk)
 * Copyright (c) 2016. All rights reserved.
 *
 * WARNING: The installation of this application requires modifications to your Mazda Connect system.
 * If you don't feel comfortable performing these changes, please do not attempt to install this. You might
 * be ending up with an unusuable system that requires reset by your Dealer. You were warned!
 *
 * This program is free software: you can redistribute it and/or modify it under the terms of the
 * GNU General Public License as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
 * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
 * License for more details.
 *
 * You should have received a copy of the GNU General Public License along with this program.
 * If not, see http://www.gnu.org/licenses/
 *
 */

/**
 * This is the build file for the Custom Application SDK for the Mazda Infotainment System
 * @build-file
 */


/**
 * @includes
 */
var
    gulp = require('gulp'),
    less = require('gulp-less'),
    concat = require('gulp-concat'),
    rename = require('gulp-rename'),
    uglify = require('gulp-uglify'),
    git = require('gulp-git'),
    //jsdoc = require('gulp-jsdoc'),
    bump = require('gulp-bump'),
    tar = require('gulp-tar'),
    file = require('gulp-file'),
    replace = require('gulp-replace'),
    concatutil = require('gulp-concat-util'),
    runSequence = require('run-sequence'),
    del = require('del'),
    fs = require('fs'),
    glob = require('glob'),
    exec = require('child_process').exec;

/**
 * @package
 */

var package = require('./package.json');

/**
 * @configuration
 */

var dist = "./dist/",
    output = "./build/",
    input = "./src/";

/**
 * Builds an json version file
 * @method
 */

var buildJsonVersion = function(output, destination, name, attributes) {

    // get latest package
    var package = require("./package.json");

    // prepare json
    var baseJson = {
        description: 'Custom Application SDK for Infotainment',
        name: name,
        license: 'GPL 3.0',
        author: 'Andy (flyandi) <flyandi@yahoo.com>',
        copyright: '(c) 2016',
        created: (new Date()).toLocaleDateString(),
        url: 'https://github.com/flyandi/mazda-custom-application-sdk/',
        version: package.version,
    };

    // get attributes
    if(attributes) {
        var json = attributes(package);

        // combine
        Object.keys(json).forEach(function(key) {

            baseJson[key] = json[key];
        });
    }

    // write output
    file(output, JSON.stringify(baseJson), {
        src: true
    }).pipe(gulp.dest(destination));
}


/**
 * (build) local apps
 *
 * These tasks handle the copy and build of the local apps
 */

var appsPathInput = "./apps/",
    appsPathOutput = output + 'apps/system/casdk/apps/';


// (cleanup)
gulp.task('apps-cleanup', function() {
    return del(
        [appsPathOutput + '**/*']
    );
});

// (copy)
gulp.task('apps-copy', function() {

    return gulp.src(appsPathInput + "**/*", {
            base: appsPathInput
        })
        .pipe(gulp.dest(appsPathOutput));
});

// (register)
gulp.task('apps-register', function() {
    return;
});

// (build)
gulp.task('build-apps', function(callback) {
    runSequence(
        'apps-cleanup',
        'apps-copy',
        'apps-register',
        callback
    );
});


/**
 * tasks to build the runtime
 */

var systemPathOutput = output + "system/",
    runtimePathInput = input + "runtime/",
    runtimePathOutput = systemPathOutput + "runtime/",
    customPathInput = input + "custom/";

// (cleanup)
gulp.task('system-cleanup', function() {
    return del(
        [systemPathOutput + '**/*']
    );
});

// (skeleton)
gulp.task('system-runtime-skeleton', function() {

    return gulp.src(runtimePathInput + "skeleton/**/*", {
            base: runtimePathInput + "skeleton"
        })
        .pipe(gulp.dest(runtimePathOutput));
});


// (less)
gulp.task('system-runtime-less', function() {

    return gulp.src(runtimePathInput + "less/*", {
            base: runtimePathInput + "less"
        })
        .pipe(concat('runtime.css'))
        .pipe(less())
        .pipe(gulp.dest(runtimePathOutput));
});


// (Concatenate & Minify)
gulp.task('system-runtime-js', function() {

    return gulp.src(runtimePathInput + "js/*", {
            base: runtimePathInput + "js"
        })
        .pipe(concat('runtime.js'))
        .pipe(uglify())
        .pipe(concatutil.header(fs.readFileSync(runtimePathInput + "resources/header.txt", "utf8"), {
            pkg: package
        }))
        .pipe(gulp.dest(runtimePathOutput));
});

// (copy custom app)
gulp.task('system-custom', function() {
    return gulp.src(customPathInput + "**/*", {
            base: customPathInput
        })
        .pipe(gulp.dest(systemPathOutput));
});

/** @job system-version */
gulp.task('system-version', function() {

    buildJsonVersion("runtime.json", runtimePathOutput, "runtime-package", function(package) {
        return {
            runtime: true,
        }
    });
});


// (build system)
gulp.task('build-system', function(callback) {
    runSequence(
        'system-cleanup',
        'system-runtime-skeleton',
        'system-runtime-less',
        'system-runtime-js',
        'system-custom',
        'system-version',
        callback
    );
});


/**
 * (build) install deploy image
 *
 * These task builds the install image
 */


var installDeployPathInput = input + 'deploy/install/',
    installDeployPathOutput = output + 'deploy/install/',
    installDeployDataPathOutput = installDeployPathOutput + 'casdk/';

// (cleanup)
gulp.task('install-cleanup', function() {
    return del(
        [installDeployPathOutput + '**/*']
    );
});

// (copy)
gulp.task('install-copy', function() {

    return gulp.src(installDeployPathInput + "**/*", {
            base: installDeployPathInput
        })
        .pipe(gulp.dest(installDeployPathOutput));
});

// (custom)
gulp.task('install-custom', function() {

    return gulp.src(input + "custom/**/*", {
            base: input + "custom"
        })
        .pipe(gulp.dest(installDeployDataPathOutput + "custom/"));
});


// (proxy)
gulp.task('install-proxy', function() {

    return gulp.src(input + "proxy/**/*", {
            base: input + "proxy"
        })
        .pipe(gulp.dest(installDeployDataPathOutput + "proxy/"));
});

/** @job install-version */
gulp.task('install-version', function() {
    buildJsonVersion("system.json", output + 'deploy/', "system-package", function(package) {
        return {
            system: true,
        }
    });
});


// (build)
gulp.task('build-install', function(callback) {
    runSequence(
        'install-cleanup',
        'install-copy',
        'install-proxy',
        'install-version',
        callback
    );
});


/**
 * (build) uninstall deploy image
 *
 * These task builds the uninstall image
 */


var uninstallDeployPathInput = input + 'deploy/uninstall/',
    uninstallDeployPathOutput = output + 'deploy/uninstall/';

// (cleanup)
gulp.task('uninstall-cleanup', function() {
    return del(
        [uninstallDeployPathOutput + '**/*']
    );
});

// (copy)
gulp.task('uninstall-copy', function() {

    return gulp.src(uninstallDeployPathInput + "**/*", {
            base: uninstallDeployPathInput
        })
        .pipe(gulp.dest(uninstallDeployPathOutput));
});


// (build)
gulp.task('build-uninstall', function(callback) {
    runSequence(
        'uninstall-cleanup',
        'uninstall-copy',
        callback
    );
});



/**
 * (build) builds the actual sd card content
 *
 */

var SDCardPathOutput = output + 'sdcard/',
    SDCardSystemPathOutput = SDCardPathOutput + "system/";

// (cleanup)
gulp.task('sdcard-cleanup', function() {
    return del(
        [SDCardPathOutput + '**/*']
    );
});

// (copy)
gulp.task('sdcard-copy', function() {

    // copy system
    gulp.src(systemPathOutput + "**/*", {
        base: systemPathOutput
    })
        .pipe(gulp.dest(SDCardSystemPathOutput));

    // copy apps
    gulp.src("apps/**/*", {
        base: "apps/"
    })
        .pipe(gulp.dest(SDCardPathOutput + 'apps'));
});

// (build)
gulp.task('build-sdcard', function(callback) {
    runSequence(
        'sdcard-cleanup',
        'sdcard-copy',
        callback
    );
});


/**
 * Build documentation
 */

var docsPathTheme = "./.docstheme/",
    docsPathInput = input + "docs/",
    docsPathOutput = output + "docs/";

// (cleanup)
gulp.task('docs-cleanup', function() {
    return del(
        [docsPathOutput + '**']
    );
});

// (theme)
gulp.task('docs-theme', function(callback) {

    // using jaguarjs theme
    if (!fs.lstatSync(docsPathTheme).isDirectory()) {
        git.clone('https://github.com/davidshimjs/jaguarjs-jsdoc', {
            quiet: true,
            args: docsPathTheme,
        }, callback);
    }

    return callback();
});

// (generate)
gulp.task('docs-generate', function() {

    var
        docInfo = {
            name: 'casdk-' + package.version,
        },
        docOptions = {
            systemName: "Something",
            footer: "Something",
            copyright: "Something",
            navType: "vertical",
            theme: "journal",
            linenums: true,
            collapseSymbols: false,
            inverseNav: false
        },
        docTemplate = {
            path: docsPathTheme,
            cleverLinks: true,
            monospaceLinks: true,
            default: {
                "outputSourceFiles": false
            },
            applicationName: "API Documentation",
            googleAnalytics: "",
            openGraph: {
                "title": "",
                "type": "website",
                "image": "",
                "site_name": "",
                "url": ""
            },
            meta: {
                "title": "CASDK API Documentation " + package.version,
                "description": "",
                "keyword": ""
            },
            linenums: false,
        };

    return gulp.src([input + "runtime/js/*.js", docsPathInput + "markup/*.md"])
        .pipe(jsdoc.parser(docInfo))
        .pipe(jsdoc.generator(docsPathOutput, docTemplate, docOptions))
});

// (build)
gulp.task('build-docs', function(callback) {
    runSequence(
        'docs-cleanup',
        'docs-theme',
        'docs-generate',
        callback
    );
});


/**
 * These build jobs are for distribution
 * @job dist
 * @target dist
 */

/** @job dist-bump-major */
gulp.task('dist-bump-major', function() {
    return gulp.src('./package.json').pipe(bump({
        type: 'major'
    })).pipe(gulp.dest('./'));
});

/** @job dist-bump-minor */
gulp.task('dist-bump-minor', function() {
    return gulp.src('./package.json').pipe(bump({
        type: 'minor'
    })).pipe(gulp.dest('./'));
});

/** @job dist-bump-revision */
gulp.task('dist-bump-revision', function() {
    return gulp.src('./package.json').pipe(bump({
        type: 'revision'
    })).pipe(gulp.dest('./'));
});

/**
 * builds the runtime for distribution
 * @job dist-runtime
 */

var distLatestOutput = dist + "latest/";

var distRuntimeOutput = false;

gulp.task('dist-runtime', function() {

    // get latest package
    var package = require("./package.json");

    distRuntimeOutput = 'runtime-' + package.version + '.package';

    return gulp.src(systemPathOutput + "**/*")
        .pipe(tar(distRuntimeOutput))
        .pipe(gulp.dest(distLatestOutput));
});


/**
 * builds the deployment system for distribution
 * @job dist-system
 */

var distSystemOutput = false;

gulp.task('dist-system', function() {

    // get latest package
    var package = require("./package.json");

    distSystemOutput = 'system-' + package.version + '.package';

    return gulp.src(output + "/deploy/**/*")
        .pipe(tar(distSystemOutput))
        .pipe(gulp.dest(distLatestOutput));
});

/**
 * creates the release information for the distribution
 * @job dist-release
 */
gulp.task('dist-latest', function() {

    buildJsonVersion("latest.json", distLatestOutput, "latest-release-package");
});


/**
 * task to build the runtime, system and release information
 * @job build-dist
 */
gulp.task('build-dist', function(callback) {
    runSequence(
        'dist-runtime',
        'dist-system',
        'dist-latest',
        callback
    );
});

gulp.task('dist-revision', function(callback) {
    runSequence(
        'dist-bump-revision',
        'build-dist',
        callback
    );
});

gulp.task('dist-minor', function(callback) {
    runSequence(
        'dist-bump-minor',
        'build-dist',
        callback
    );
});

gulp.task('dist-major', function(callback) {
    runSequence(
        'dist-bump-major',
        'build-dist',
        callback
    );
});

/**
 * Common Commands
 */

// clean
gulp.task('clean', function() {
    return del(
        [output + '**/*']
    );
});


// Default Task
gulp.task('default', function(callback) {
    runSequence(
        'clean',
        'build-system',
        'build-install',
        'build-uninstall',
        'build-sdcard',
        //'build-docs',
        callback
    );
});