mail/Gruntfile.js

module.exports = function(grunt) {
    'use strict';

    require('time-grunt')(grunt);

    var version = grunt.option('release'),
        zipName = (version) ? version : 'DEV';

    var browserifyOpt = {
        exclude: ['openpgp', 'node-forge', 'net', 'tls', 'crypto'], // node apis not required at build time
        ignore: ['buffer'], // node apis to be stubbed for runtime
        browserifyOptions: {
            debug: true
        }
    };

    // Project configuration.
    grunt.initConfig({

        // General

        shell: {
            options: {
                stderr: false
            },
            target: {
                command: 'dir=$(pwd) && cd node_modules/mailreader/ && npm install --production && cd $dir'
            }
        },

        clean: {
            dist: ['dist', 'compile', 'test/lib', 'test/integration/src'],
            release: ['dist/**/*.browserified.js', 'dist/**/*.js.map', 'dist/js/app.templates.js']
        },

        copy: {
            libTest: {
                expand: true,
                flatten: true,
                cwd: './',
                src: [
                    'node_modules/mocha/mocha.css',
                    'node_modules/mocha/mocha.js',
                    'node_modules/chai/chai.js',
                    'node_modules/sinon/pkg/sinon.js',
                    'node_modules/browsercrow/src/*.js',
                    'node_modules/browsersmtp/src/*.js',
                    'node_modules/openpgp/dist/openpgp.min.js',
                    'node_modules/openpgp/dist/openpgp.worker.min.js',
                    'src/lib/forge/forge.min.js',
                    'dist/js/pbkdf2-worker.min.js'
                ],
                dest: 'test/lib/'
            },
            lib: {
                expand: true,
                flatten: true,
                cwd: './',
                src: [
                    'node_modules/openpgp/dist/openpgp.min.js',
                    'node_modules/openpgp/dist/openpgp.worker.min.js',
                    'src/lib/forge/forge.min.js'
                ],
                dest: 'dist/js/'
            },
            font: {
                expand: true,
                cwd: 'src/font/',
                src: ['*'],
                dest: 'dist/font/'
            },
            img: {
                expand: true,
                cwd: 'src/img/',
                src: ['*'],
                dest: 'dist/img/'
            },
            tpl: {
                expand: true,
                cwd: 'src/tpl/',
                src: ['read-sandbox.html'],
                dest: 'dist/tpl/'
            },
            app: {
                expand: true,
                cwd: 'src/',
                src: ['*.js', '*.json', 'manifest.*'],
                dest: 'dist/'
            }
        },

        // Stylesheets

        sass: {
            dist: {
                files: {
                    'src/css/read-sandbox.css': 'src/sass/read-sandbox.scss',
                    'src/css/all.css': 'src/sass/all.scss'
                }
            }
        },
        autoprefixer: {
            options: {
                browsers: ['last 2 versions']
            },
            dist: {
                files: {
                    'src/css/read-sandbox.css': 'src/css/read-sandbox.css',
                    'src/css/all.css': 'src/css/all.css'
                }
            }
        },
        csso: {
            options: {
                banner: '/*! Copyright © 2013, Whiteout Networks GmbH. All rights reserved.*/\n'
            },
            dist: {
                files: {
                    'dist/css/read-sandbox.min.css': 'src/css/read-sandbox.css',
                    'dist/css/all.min.css': 'src/css/all.css'
                }
            }
        },

        // JavaScript

        jshint: {
            all: ['Gruntfile.js', 'src/*.js', 'src/js/**/*.js', 'test/unit/*-test.js', 'test/integration/*-test.js'],
            options: {
                jshintrc: '.jshintrc'
            }
        },

        browserify: {
            app: {
                files: {
                    'dist/js/app.browserified.js': ['src/js/app.js']
                },
                options: browserifyOpt
            },
            pbkdf2Worker: {
                files: {
                    'dist/js/pbkdf2-worker.browserified.js': ['src/js/crypto/pbkdf2-worker.js']
                },
                options: browserifyOpt
            },
            mailreaderWorker: {
                files: {
                    'dist/js/mailreader-parser-worker.browserified.js': ['node_modules/mailreader/src/mailreader-parser-worker-browserify.js']
                },
                options: browserifyOpt
            },
            tlsWorker: {
                files: {
                    'dist/js/tcp-socket-tls-worker.browserified.js': ['node_modules/tcp-socket/src/tcp-socket-tls-worker.js']
                },
                options: browserifyOpt
            },
            unitTest: {
                files: {
                    'test/unit/index.browserified.js': [
                        'test/main.js',
                        'test/unit/util/dialog-test.js',
                        'test/unit/util/connection-doctor-test.js',
                        'test/unit/util/update-handler-test.js',
                        'test/unit/util/status-display-test.js',
                        'test/unit/crypto/pgp-test.js',
                        'test/unit/crypto/crypto-test.js',
                        'test/unit/service/rest-dao-test.js',
                        'test/unit/service/admin-dao-test.js',
                        'test/unit/service/auth-test.js',
                        'test/unit/service/oauth-test.js',
                        'test/unit/service/publickey-dao-test.js',
                        'test/unit/service/privatekey-dao-test.js',
                        'test/unit/service/lawnchair-dao-test.js',
                        'test/unit/service/keychain-dao-test.js',
                        'test/unit/service/devicestorage-dao-test.js',
                        'test/unit/service/newsletter-service-test.js',
                        'test/unit/service/mail-config-service-test.js',
                        'test/unit/service/invitation-dao-test.js',
                        'test/unit/email/outbox-bo-test.js',
                        'test/unit/email/email-dao-test.js',
                        'test/unit/email/account-test.js',
                        'test/unit/email/search-test.js',
                        'test/unit/controller/login/add-account-ctrl-test.js',
                        'test/unit/controller/login/create-account-ctrl-test.js',
                        'test/unit/controller/login/validate-phone-ctrl-test.js',
                        'test/unit/controller/login/login-existing-ctrl-test.js',
                        'test/unit/controller/login/login-initial-ctrl-test.js',
                        'test/unit/controller/login/login-new-device-ctrl-test.js',
                        'test/unit/controller/login/login-privatekey-download-ctrl-test.js',
                        'test/unit/controller/login/login-set-credentials-ctrl-test.js',
                        'test/unit/controller/login/login-ctrl-test.js',
                        'test/unit/controller/app/dialog-ctrl-test.js',
                        'test/unit/controller/app/privatekey-upload-ctrl-test.js',
                        'test/unit/controller/app/publickey-import-ctrl-test.js',
                        'test/unit/controller/app/account-ctrl-test.js',
                        'test/unit/controller/app/set-passphrase-ctrl-test.js',
                        'test/unit/controller/app/contacts-ctrl-test.js',
                        'test/unit/controller/app/read-ctrl-test.js',
                        'test/unit/controller/app/navigation-ctrl-test.js',
                        'test/unit/controller/app/mail-list-ctrl-test.js',
                        'test/unit/controller/app/write-ctrl-test.js',
                        'test/unit/controller/app/action-bar-ctrl-test.js',
                    ]
                },
                options: browserifyOpt
            },
            integrationTest: {
                files: {
                    'test/integration/index.browserified.js': [
                        'test/main.js',
                        'test/integration/email-dao-test.js'
                    ]
                },
                options: browserifyOpt
            }
        },

        exorcise: {
            app: {
                files: {
                    'dist/js/app.browserified.js.map': ['dist/js/app.browserified.js'],
                }
            },
            unitTest: {
                files: {
                    'test/unit/index.browserified.js.map': ['test/unit/index.browserified.js'],
                }
            },
            integrationTest: {
                files: {
                    'test/integration/index.browserified.js.map': ['test/integration/index.browserified.js'],
                }
            }
        },

        ngtemplates: {
            mail: {
                src: [
                    'tpl/**/*.html'
                ],
                dest: 'dist/js/app.templates.js',
                cwd: 'src/',
                options: {
                    htmlmin: {
                        collapseWhitespace: true,
                        removeComments: true // we do not use comment directives
                    }
                }
            }
        },

        concat: {
            options: {
                separator: ';\n',
                sourceMap: true
            },
            app: {
                src: [
                    'src/lib/underscore/underscore.js',
                    'node_modules/jquery/dist/jquery.min.js',
                    'src/lib/angular/angular.js',
                    'src/lib/angular/angular-route.js',
                    'src/lib/angular/angular-animate.js',
                    'src/lib/ngtagsinput/ng-tags-input.min.js',
                    'node_modules/ng-infinite-scroll/build/ng-infinite-scroll.min.js',
                    'node_modules/iframe-resizer/js/iframeResizer.min.js',
                    'src/lib/fastclick/fastclick.js',
                    'src/lib/lawnchair/lawnchair-git.js',
                    'src/lib/lawnchair/lawnchair-adapter-webkit-sqlite-git.js',
                    'src/lib/lawnchair/lawnchair-adapter-indexed-db-git.js',
                    'src/lib/phonenumber/PhoneNumberMetadata.js',
                    'src/lib/phonenumber/PhoneNumberNormalizer.js',
                    'src/lib/phonenumber/PhoneNumber.js',
                    'dist/js/app.browserified.js',
                    '<%= ngtemplates.mail.dest %>'
                ],
                dest: 'dist/js/app.min.js',
                options: {
                    sourceMapName: 'dist/js/app.js.map'
                }
            },
            readSandbox: {
                src: [
                    'node_modules/dompurify/purify.js',
                    'node_modules/iframe-resizer/js/iframeResizer.contentWindow.min.js',
                    'src/js/controller/app/read-sandbox.js'
                ],
                dest: 'dist/js/read-sandbox.min.js'
            },
            pbkdf2Worker: {
                src: ['dist/js/pbkdf2-worker.browserified.js'],
                dest: 'dist/js/pbkdf2-worker.min.js'
            },
            mailreaderWorker: {
                src: ['dist/js/mailreader-parser-worker.browserified.js'],
                dest: 'dist/js/mailreader-parser-worker.min.js'
            },
            tlsWorker: {
                src: ['dist/js/tcp-socket-tls-worker.browserified.js'],
                dest: 'dist/js/tcp-socket-tls-worker.min.js'
            },
            unitTest: {
                src: [
                    'src/lib/underscore/underscore.js',
                    'node_modules/jquery/dist/jquery.min.js',
                    'src/lib/angular/angular.js',
                    'src/lib/angular/angular-route.js',
                    'src/lib/angular/angular-mocks.js',
                    'src/lib/lawnchair/lawnchair-git.js',
                    'src/lib/lawnchair/lawnchair-adapter-webkit-sqlite-git.js',
                    'src/lib/lawnchair/lawnchair-adapter-indexed-db-git.js',
                    'src/lib/phonenumber/PhoneNumberMetadata.js',
                    'src/lib/phonenumber/PhoneNumberNormalizer.js',
                    'src/lib/phonenumber/PhoneNumber.js',
                    'test/unit/index.browserified.js'
                ],
                dest: 'test/unit/index.js',
                options: {
                    sourceMapName: 'test/unit/index.js.map'
                }
            },
            integrationTest: {
                src: [
                    'src/lib/underscore/underscore.js',
                    'node_modules/jquery/dist/jquery.min.js',
                    'src/lib/angular/angular.js',
                    'src/lib/angular/angular-mocks.js',
                    'src/lib/lawnchair/lawnchair-git.js',
                    'src/lib/lawnchair/lawnchair-adapter-webkit-sqlite-git.js',
                    'src/lib/lawnchair/lawnchair-adapter-indexed-db-git.js',
                    'test/integration/index.browserified.js'
                ],
                dest: 'test/integration/index.js',
                options: {
                    sourceMapName: 'test/integration/index.js.map'
                }
            }
        },

        uglify: {
            app: {
                files: {
                    'dist/js/app.min.js': ['dist/js/app.min.js']
                },
                options: {
                    mangle: false,
                    sourceMap: true,
                    sourceMapIn: 'dist/js/app.js.map',
                    sourceMapIncludeSources: true,
                    sourceMapName: 'dist/js/app.min.js.map'
                }
            },
            readSandbox: {
                files: {
                    'dist/js/read-sandbox.min.js': ['dist/js/read-sandbox.min.js']
                },
                options: {
                    sourceMap: true,
                    sourceMapName: 'dist/js/read-sandbox.min.js.map'
                }
            },
            pbkdf2Worker: {
                files: {
                    'dist/js/pbkdf2-worker.min.js': ['dist/js/pbkdf2-worker.min.js']
                }
            },
            mailreaderWorker: {
                files: {
                    'dist/js/mailreader-parser-worker.min.js': ['dist/js/mailreader-parser-worker.min.js']
                },
                options: {
                    sourceMap: true,
                    sourceMapName: 'dist/js/mailreader-parser-worker.min.js.map'
                }
            },
            tlsWorker: {
                files: {
                    'dist/js/tcp-socket-tls-worker.min.js': ['dist/js/tcp-socket-tls-worker.min.js']
                },
                options: {
                    sourceMap: true,
                    sourceMapName: 'dist/js/tcp-socket-tls-worker.min.js.map'
                }
            },
            options: {
                banner: '/*! Copyright © <%= grunt.template.today("yyyy") %>, Whiteout Networks GmbH.*/\n'
            }
        },

        mocha_phantomjs: {
            all: {
                options: {
                    urls: [
                        'http://localhost:<%= connect.test.options.port %>/test/unit/index.html',
                        'http://localhost:<%= connect.test.options.port %>/test/integration/index.html'
                    ]
                }
            }
        },

        // Assets

        svgmin: {
            options: {
                plugins: [{
                    removeViewBox: false
                }, {
                    removeUselessStrokeAndFill: false
                }]
            },
            icons: {
                files: [{
                    expand: true,
                    src: ['img/icons/*.svg', '!img/icons/all.svg'],
                    cwd: 'src/',
                    dest: 'compile/'
                }]
            }
        },
        svgstore: {
            options: {
                prefix: 'icon-',
                svg: {
                    viewBox: '0 0 100 100',
                    xmlns: 'http://www.w3.org/2000/svg'
                },
                cleanup: ['fill', 'stroke']
            },
            icons: {
                files: {
                    'src/img/icons/all.svg': ['compile/img/icons/*.svg'],
                }
            }
        },
        'string-replace': {
            index: {
                files: {
                    'dist/index.html': 'src/index.html'
                },
                options: {
                    replacements: [{
                        pattern: /<!-- @import (.*?) -->/ig,
                        replacement: function(match, p1) {
                            return grunt.file.read('src/' + p1);
                        }
                    }]
                }
            }
        },

        // Development

        connect: {
            dev: {
                options: {
                    port: 8580,
                    base: '.',
                    keepalive: true
                }
            },
            test: {
                options: {
                    port: 8581,
                    base: '.'
                }
            }
        },

        // Utilities

        watch: {
            css: {
                files: ['src/sass/**/*.scss'],
                tasks: ['dist-css', 'manifest']
            },
            jsApp: {
                files: ['src/js/**/*.js', 'src/**/*.html'],
                tasks: ['dist-js-app']
            },
            jsUnitTest: {
                files: ['test/unit/**/*-test.js', 'test/*.js'],
                tasks: ['dist-js-unitTest']
            },
            jsIntegrationTest: {
                files: ['test/integration/*-test.js', 'test/*.js'],
                tasks: ['dist-js-integrationTest']
            },
            icons: {
                files: ['src/index.html', 'src/img/icons/*.svg', '!src/img/icons/all.svg'],
                tasks: ['svgmin', 'svgstore', 'string-replace', 'manifest']
            },
            lib: {
                files: ['src/lib/**/*.js'],
                tasks: ['copy:lib', 'manifest']
            },
            app: {
                files: ['src/*.js', 'src/**/*.html', 'src/**/*.json', 'src/manifest.*', 'src/img/**/*', 'src/font/**/*'],
                tasks: ['copy:app', 'copy:tpl', 'copy:img', 'copy:font', 'manifest-dev', 'manifest']
            }
        },

        // Deployment

        compress: {
            main: {
                options: {
                    mode: 'zip',
                    archive: 'release/whiteout-mail_' + zipName + '.zip'
                },
                expand: true,
                cwd: 'dist/',
                src: ['**/*'],
                dest: 'release/'
            }
        },

        manifest: {
            generate: {
                options: {
                    basePath: 'dist/',
                    timestamp: true,
                    hash: true,
                    cache: ['socket.io/socket.io.js'],
                    exclude: [
                        'appcache.manifest',
                        'manifest.webapp',
                        'manifest.mobile.json',
                        'background.js',
                        'js/app.templates.js',
                        'js/app.js.map',
                        'js/app.min.js.map',
                        'js/app.browserified.js',
                        'js/app.browserified.js.map',
                        'js/crypto/pbkdf2-worker.browserified.js',
                        'js/pbkdf2-worker.browserified.js',
                        'js/pbkdf2-worker.min.js.map',
                        'js/read-sandbox.min.js.map',
                        'js/mailreader-parser-worker.browserified.js',
                        'js/mailreader-parser-worker.min.js.map',
                        'js/tcp-socket-tls-worker.browserified.js',
                        'js/tcp-socket-tls-worker.min.js.map',
                        'img/icon-100-ios.png',
                        'img/icon-114-ios.png',
                        'img/icon-120-ios.png',
                        'img/icon-128-chrome.png',
                        'img/icon-144-android.png',
                        'img/icon-144-ios.png',
                        'img/icon-152-ios.png',
                        'img/icon-180-ios.png',
                        'img/icon-192-android.png',
                        'img/icon-29-ios.png',
                        'img/icon-36-android.png',
                        'img/icon-40-ios.png',
                        'img/icon-48-android.png',
                        'img/icon-50-ios.png',
                        'img/icon-57-ios.png',
                        'img/icon-58-ios.png',
                        'img/icon-60-android.png',
                        'img/icon-60-ios.png',
                        'img/icon-72-android.png',
                        'img/icon-72-ios.png',
                        'img/icon-76-ios.png',
                        'img/icon-78-android.png',
                        'img/icon-80-ios.png',
                        'img/icon-87-ios.png',
                        'img/icon-96-android.png',
                        'img/Default-568h@2x~iphone.png',
                        'img/Default-667h.png',
                        'img/Default-736h.png',
                        'img/Default-Landscape-736h.png',
                        'img/Default-Landscape@2x~ipad.png',
                        'img/Default-Landscape~ipad.png',
                        'img/Default-Portrait@2x~ipad.png',
                        'img/Default-Portrait~ipad.png',
                        'img/Default@2x~iphone.png',
                        'img/Default~iphone.png'
                    ],
                    master: ['index.html']
                },
                src: ['**/*.*'],
                dest: 'dist/appcache.manifest'
            }
        }

    });

    // Load the plugin(s)
    grunt.loadNpmTasks('grunt-browserify');
    grunt.loadNpmTasks('grunt-contrib-concat');
    grunt.loadNpmTasks('grunt-contrib-uglify');
    grunt.loadNpmTasks('grunt-contrib-connect');
    grunt.loadNpmTasks('grunt-contrib-jshint');
    grunt.loadNpmTasks('grunt-contrib-clean');
    grunt.loadNpmTasks('grunt-csso');
    grunt.loadNpmTasks('grunt-contrib-sass');
    grunt.loadNpmTasks('grunt-autoprefixer');
    grunt.loadNpmTasks('grunt-contrib-watch');
    grunt.loadNpmTasks('grunt-contrib-copy');
    grunt.loadNpmTasks('grunt-contrib-compress');
    grunt.loadNpmTasks('grunt-manifest');
    grunt.loadNpmTasks('grunt-mocha-phantomjs');
    grunt.loadNpmTasks('grunt-exorcise');
    grunt.loadNpmTasks('grunt-string-replace');
    grunt.loadNpmTasks('grunt-svgmin');
    grunt.loadNpmTasks('grunt-svgstore');
    grunt.loadNpmTasks('grunt-shell');
    grunt.loadNpmTasks('grunt-angular-templates');

    // Build tasks
    grunt.registerTask('dist-css', ['sass', 'autoprefixer', 'csso']);
    grunt.registerTask('dist-js', ['browserify', 'exorcise', 'ngtemplates', 'concat', 'uglify']);
    grunt.registerTask('dist-js-app', [
        'browserify:app',
        'browserify:pbkdf2Worker',
        'browserify:mailreaderWorker',
        'browserify:tlsWorker',
        'exorcise:app',
        'ngtemplates',
        'concat:app',
        'concat:readSandbox',
        'concat:pbkdf2Worker',
        'concat:mailreaderWorker',
        'concat:tlsWorker',
        'manifest'
    ]);
    grunt.registerTask('dist-js-unitTest', [
        'browserify:unitTest',
        'exorcise:unitTest',
        'concat:unitTest'
    ]);
    grunt.registerTask('dist-js-integrationTest', [
        'browserify:integrationTest',
        'exorcise:integrationTest',
        'concat:integrationTest'
    ]);
    grunt.registerTask('dist-copy', ['copy']);
    grunt.registerTask('dist-assets', ['svgmin', 'svgstore', 'string-replace']);
    grunt.registerTask('dist', ['clean:dist', 'shell', 'dist-css', 'dist-js', 'dist-assets', 'dist-copy', 'manifest']);

    // Test/Dev tasks
    grunt.registerTask('dev', ['connect:dev']);
    grunt.registerTask('test', ['jshint', 'connect:test', 'mocha_phantomjs']);
    grunt.registerTask('prod', ['connect:prod']);

    //
    // Release tasks for Chrome App Release Channels
    //

    grunt.registerTask('manifest-dev', function() {
        patchManifest({
            suffix: ' (DEV)',
            version: '9999.9999.9999'
        });
    });
    grunt.registerTask('manifest-test', function() {
        if (!version) {
            throw new Error('You must specify the version: "--release=1.0.0"');
        }

        patchManifest({
            suffix: ' (TEST)',
            client_id: '440907777130-bfpgo5fbo4f7hetrg3hn57qolrtubs0u.apps.googleusercontent.com',
            version: version,
            deleteKey: true
        });
    });
    grunt.registerTask('manifest-prod', function() {
        if (!version) {
            throw new Error('You must specify the version: "--release=1.0.0"');
        }

        patchManifest({
            version: version,
            deleteKey: true,
            keyServer: 'https://keys.whiteout.io/',
            keychainServer: 'https://keychain.whiteout.io/'
        });
    });

    function patchManifest(options) {
        var fs = require('fs'),
            path = './dist/manifest.json',
            manifest = require(path);

        if (options.version) {
            manifest.version = options.version;
        }
        if (options.suffix) {
            manifest.name += options.suffix;
        }
        if (options.client_id) {
            manifest.oauth2.client_id = options.client_id;
        }
        if (options.keyServer) {
            var ksIndex = manifest.permissions.indexOf('https://keys-test.whiteout.io/');
            manifest.permissions[ksIndex] = options.keyServer;
        }
        if (options.keychainServer) {
            var kcsIndex = manifest.permissions.indexOf('https://keychain-test.whiteout.io/');
            manifest.permissions[kcsIndex] = options.keychainServer;
        }
        if (options.deleteKey) {
            delete manifest.key;
        }

        fs.writeFileSync(path, JSON.stringify(manifest, null, 2));
    }

    grunt.registerTask('release-dev', ['dist', 'manifest-dev', 'compress']);
    grunt.registerTask('release-test', ['dist', 'manifest-test', 'clean:release', 'compress']);
    grunt.registerTask('release-prod', ['dist', 'manifest-prod', 'clean:release', 'compress']);
    grunt.registerTask('default', ['release-dev']);

};