Gruntfile.js

/*jslint node: true, es3: false, maxlen: 88 */
'use strict';
var mountFolder = function (connect, dir) {
        return connect.static(require('path').resolve(dir));
    };

module.exports = function (grunt) {
    // show elapsed time at the end
    require('time-grunt')(grunt);

    var humanName = 'WYMeditor',
        projectPage = "https://github.com/wymeditor/wymeditor/",
        releaseArchive = projectPage +
            'releases/download/v<%= pkg.version %>/<%= pkg.name %>' +
            '-<%= pkg.version %>' + '.tag.gz',
        sourceArchive = projectPage + 'archive/v<%= pkg.version %>.zip',
        // Oldest supported version of jQuery is used by default
        jqueryVersion = grunt.option("jquery") || "1.4.4",
        yeomanConfig = {
            app: 'src',
            dist: 'dist'
        },
        unitTestPort = 9001,
        editorFiles = ['{.tmp,<%= yeoman.app %>}/wymeditor/{,*/}*.js'],
        stylesFiles = ['.tmp/styles/{,*/}*.css'],
        examplesFiles = ['{.tmp,<%= yeoman.app %>}/examples/{,*/}*.{js,html}'],
        readmePath = 'README.rst',
        jekyllDir = '<%= yeoman.app %>/jekyll',
        jekyllFiles = [jekyllDir + '/**'],
        jekyllDevServeDir = '<%= yeoman.app %>/website',
        jekyllDevServeFiles = [jekyllDevServeDir + '/*'];

    grunt.initConfig({
        pkg: grunt.file.readJSON("package.json"),
        yeoman: yeomanConfig,
        meta: {
            banner: "/*!\n" +
                "WYMeditor - v<%= pkg.version %>\n\n" +
                "Home page: <%= pkg.homepage %>\n\n" +
                "Copyright (c) <%= grunt.template.today('yyyy') %> " +
                "<%= pkg.author.name %>;\n" +
                "Licensed <%= _.pluck(pkg.licenses, 'type').join(', ') %>\n" +
                "*/\n\n"
        },
        // Some targets run concurrently because watch is blocking and we
        // have different watches.
        watch: {
            options: {
                // Don't spawn a child process. Virtualbox's NFS share is
                // slow enough already.
                spawn: false
            },
            // Rebuilds the website on changes
            jekyll: {
                files: [].concat(
                    jekyllFiles,
                    [readmePath]
                ),
                tasks: [
                    'shell:convertReadmeToHomePage',
                    'jekyll:dev'
                ]
            },
            // Convenience. LiveReload must be only in one concurrent
            // watch because you can't have more than one at the same time,
            // running.
            livereload: {
                options: {
                    livereload: true
                },
                files: [].concat(
                    editorFiles,
                    stylesFiles,
                    examplesFiles,
                    jekyllDevServeFiles
                )
            },
            dist: {
                options: {
                    livereload: true
                },
                files: [].concat(
                    stylesFiles,
                    examplesFiles,
                    editorFiles,
                    jekyllFiles,
                    [readmePath]
                ),
                tasks: ['build']
            }
        },
        // This runs the watches concurrently.
        concurrent: {
            watchDev: {
                tasks: [
                    'watch:jekyll',
                    'watch:livereload'
                ],
                options: {
                    // Limit by default is set according to CPU specs.
                    limit: 2,
                    logConcurrentOutput: true
                }
            }
        },
        connect: {
            options: {
                port: 9000,
                // change this to '0.0.0.0' to access the server from outside
                hostname: '0.0.0.0'
            },
            dev: {
                options: {
                    middleware: function (connect) {
                        return [
                            mountFolder(connect, '.tmp'),
                            mountFolder(connect, yeomanConfig.app)
                        ];
                    }
                }
            },
            test: {
                options: {
                    port: unitTestPort,
                    middleware: function (connect) {
                        return [
                            mountFolder(connect, '.tmp'),
                            mountFolder(connect, 'test'),
                            mountFolder(connect, yeomanConfig.app)
                        ];
                    }
                }
            },
            dist: {
                options: {
                    middleware: function (connect) {
                        return [
                            mountFolder(connect, yeomanConfig.dist)
                        ];
                    }
                }
            }
        },
        clean: {
            dist: {
                files: [{
                    dot: true,
                    src: [
                        '.tmp',
                        '<%= yeoman.dist %>/*',
                        '!<%= yeoman.dist %>/.git*'
                    ]
                }]
            },
            server: '.tmp',
            jekyll: jekyllDevServeFiles,
            lib: '<%= yeoman.app %>/lib/**/*'
        },
        jshint: {
            options: {
                jshintrc: '.jshintrc'
            },
            all: [
                'Gruntfile.js',
                '<%= yeoman.app %>/wymeditor/{,*/}*.js',
                '<%= yeoman.app %>/wymeditor/plugins/{,*/}*.js',
                '<%= yeoman.app %>/wymeditor/skins/{,*/}*.js',
                '<%= yeoman.app %>/test/unit/{,*/}*.js',
                '<%= yeoman.app %>/jekyll/website-media/javascripts/main.js'
            ]
        },
        qunit: {
            all: {
                options: {
                    timeout: 25000,
                    urls: [
                        [""
                            , "http://localhost:"
                            , unitTestPort
                            , "/test/unit/index.html"
                            , "?inPhantomjs=true&jquery="
                            , jqueryVersion
                        ].join("")
                    ]
                }
            }
        },
        browserify: {
            // This task Browserifies an NPM CommonJS module that will be
            // bundled in the build.
            options: {
                browserifyOptions: {
                    debug: true
                }
            },
            objectHistory: {
                // This file is the entry point for the browserification of
                // this module. It assigns the module's CommonJS export to a
                // browser window global.
                src: ['<%= yeoman.app %>/wymeditor/editor/' +
                    'object-history-browserify.js'],
                dest: '<%= yeoman.app %>/lib/object-history.js'
            }
        },
        useminPrepare: {
            options: {
                dest: '<%= yeoman.dist %>'
            },
            html: [
                '<%= yeoman.app %>/wymeditor/iframe/{,*/}*.html'
            ]
        },
        usemin: {
            options: {
                dirs: ['<%= yeoman.dist %>']
            },
            html: [
                '<%= yeoman.dist %>/examples/{,*/}*.html',
                '<%= yeoman.dist %>/wymeditor/iframe/{,*/}*.html'
            ],
            css: [
                '<%= yeoman.dist %>/examples/{,*/}*.css',
                '<%= yeoman.dist %>/wymeditor/plugins/{,*/}*.css',
                '<%= yeoman.dist %>/wymeditor/skins/{,*/}*.css'
            ]
        },
        replace: {
            dist: {
                options: {
                    variables: {
                        "VERSION": "<%= pkg.version %>"
                    }
                },
                files: [
                    {
                        expand: true,
                        cwd: '<%= yeoman.dist %>/wymeditor',
                        src: [
                            '*.js'
                        ],
                        dest: '<%= yeoman.dist %>/wymeditor'
                    }
                ]
            }
        },
        concat: {
            dist: {
                src: [
                    "<%= yeoman.app %>/lib/jquery.browser.js",
                    "<%= yeoman.app %>/wymeditor/core.js",
                    "<%= yeoman.app %>/wymeditor/editor/base.js",
                    "<%= yeoman.app %>/wymeditor/editor/" +
                        "document-structure-manager.js",
                    "<%= yeoman.app %>/wymeditor/editor/gecko.js",
                    "<%= yeoman.app %>/wymeditor/editor/webkit.js",
                    "<%= yeoman.app %>/wymeditor/editor/trident-pre-7.js",
                    "<%= yeoman.app %>/wymeditor/editor/trident-7.js",
                    "<%= yeoman.app %>/lib/object-history.js",
                    "<%= yeoman.app %>/wymeditor/editor/undo-redo.js",
                    "<%= yeoman.app %>/wymeditor/parser/*.js",
                    // TODO: For custom builds, will need to change this.
                    "<%= yeoman.app %>/wymeditor/lang/*.js",
                    "<%= yeoman.app %>/wymeditor/rangy/rangy-core.js",
                    "<%= yeoman.app %>/wymeditor/rangy/" +
                        "rangy-selectionsaverestore.js",
                    // TODO: For custom builds, will need to change this.
                    '<%= yeoman.app %>/wymeditor/skins/{,*/}skin.js'
                ],
                dest: "<%= yeoman.dist %>/wymeditor/jquery.wymeditor.js"
            }
        },
        uglify: {
            options: {
                banner: "<%= meta.banner %>"
            },
            all: {
                files: {
                    "<%= yeoman.dist %>/wymeditor/jquery.wymeditor.min.js": [
                        "<%= yeoman.dist %>/wymeditor/jquery.wymeditor.js"
                    ]
                }
            }
        },
        // All of the files not handled by other tasks that need to make it to
        // the distribution
        copy: {
            dist: {
                files: [
                    // Misc project files
                    {
                        expand: true,
                        dot: true,
                        cwd: '<%= yeoman.app %>/..',
                        dest: '<%= yeoman.dist %>',
                        src: [
                            "README.md",
                            "CHANGELOG.md",
                            "AUTHORS",
                            "MIT-license.txt",
                            "GPL-license.txt",
                            "package.json"
                        ]
                    },
                    // Examples
                    {
                        expand: true,
                        dot: true,
                        cwd: '<%= yeoman.app %>',
                        dest: '<%= yeoman.dist %>',
                        src: [
                            "examples/{,*/}*.{html,js,css,png,jpg,jpeg,gif}"
                        ]
                    },
                    // Plugins
                    {
                        expand: true,
                        dot: true,
                        cwd: '<%= yeoman.app %>/wymeditor',
                        dest: '<%= yeoman.dist %>/wymeditor',
                        src: [
                            "plugins/{,*/}*.{js,css,png,jpg,jpeg,gif}"
                        ]
                    },
                    // Iframes
                    {
                        expand: true,
                        dot: true,
                        cwd: '<%= yeoman.app %>/wymeditor',
                        dest: '<%= yeoman.dist %>/wymeditor',
                        src: [
                            "iframe/{,*/}*.{html,js,css,png,jpg,jpeg,gif,eot,ttf,woff}"
                        ]
                    },
                    // Non-Javascript skin components
                    // The javascript is included in jquery.wymeditor.js
                    {
                        expand: true,
                        dot: true,
                        cwd: '<%= yeoman.app %>/wymeditor',
                        dest: '<%= yeoman.dist %>/wymeditor',
                        src: [
                            "skins/{,*/}*.{css,png,jpg,jpeg,gif}",
                            "skins/{,*/}images/{,*/}*.{png,jpg,jpeg,gif}"
                        ]
                    },
                    // Already-built Sphinx documentation
                    {
                        expand: true,
                        dot: true,
                        cwd: '<%= yeoman.app %>/docs/.build/html',
                        dest: '<%= yeoman.dist %>/docs',
                        src: [
                            "**",
                        ]
                    }
                ]
            },
            styles: {
                expand: true,
                dot: true,
                cwd: '<%= yeoman.app %>/styles',
                dest: '.tmp/styles/',
                src: '{,*/}*.css'
            }
        },
        compress: {
            tgz: {
                options: {
                    mode: "tgz",
                    archive: "<%= yeoman.dist %>/wymeditor-<%= pkg.version %>" +
                             ".tar.gz"
                },
                expand: true,
                cwd: "<%= yeoman.dist %>",
                src: ["./**"]
            }
        },
        jekyll: {
            options: {
                src: jekyllDir,
                raw: 'name: ' + humanName + '\n' +
                    'projectPage: ' + projectPage + '\n' +
                    'releaseArchive: ' + releaseArchive + '\n' +
                    'sourceArchive: ' + sourceArchive + '\n'
            },
            dev: {
                options: {
                    dest: jekyllDevServeDir
                }
            },
            dist: {
                options: {
                    dest: '<%= yeoman.dist %>/website'
                }
            }
        },
        // This task installs the Bower components, as configured in
        // `bower.json`.
        'bower-install-simple': {
            options: {
                color: true,
                cwd: process.cwd(),
                forceLatest: false,
                production: false,
                interactive: true,
                directory: "src/bower_components"
            }
        },
        'bower-linker': {
            // This task links the libraries that are required by WYMeditor
            // for use in the development environment. It links the specific
            // files that are required, from the Bower installation directory,
            // into the development environment.
            dev: {
                options: {
                    copy: false,
                    cwd: "<%= yeoman.app %>",
                    force: false,
                    map: {
                        'require.js': '/',
                        'jquery.js': '/',
                        'jquery.browser.js': '/',
                        'es5-shim.js': '/',
                        // Originates from js-beautify
                        'beautify-html.js': '/',
                        // following two also originate from js-beautify and we
                        // don't use them so tuck them away nicely.
                        'beautify.js': '/redundant/',
                        'beautify-css.js': '/redundant/'
                    },
                    offline: true,
                    root: "<%= yeoman.app %>/lib",
                    vendor: false
                }
            },
            'dist-examples': {
                options: {
                    copy: true,
                    cwd: "<%= yeoman.app %>",
                    force: false,
                    map: {
                        'jquery.js': '/jquery/',
                        'jquery.browser.js': '/',
                        'require.js': '/redundant/',
                        'beautify-html.js': '/redundant/',
                        'beautify.js': '/redundant/',
                        'beautify-css.js': '/redundant/'
                    },
                    offline: true,
                    root: "<%= yeoman.dist %>/examples/vendor",
                    vendor: false
                }
            }
        },
        shell: {
            convertReadmeToHomePage: {
                command: [
                    'rst2html',
                    '--template ' + jekyllDir + '/_index.template',
                    '--no-doc-title',
                    readmePath,
                    jekyllDir + '/index.html'
                ].join(' ')
            },
            docsMakeHtml: {
                options: {
                    stdout: true,
                    stderr: true,
                    stdin: false,
                    failOnError: true,
                    execOptions: {
                        cwd: 'docs'
                    }
                },
                command: 'make html'
            },
            docsOpenHtml: {
                options: {
                    stdout: true,
                    stderr: true,
                    stdin: false,
                    failOnError: true
                },
                command: 'xdg-open docs/.build/html/index.html'
            },
            // Unlike the ES5 shims, the shams file is not linked by default,
            // by the bower-linker task, because it is not in the `main`
            // of its Bower package. So we link it manually, with this `shell`
            // task.
            linkES5Sham: {
                options: {
                    stdout: true,
                    stderr: true,
                    stdin: false,
                    failOnError: true
                },
                command: 'ln -sf ../bower_components/es5-shim/es5-sham.js ' +
                    'src/lib/es5-sham.js'
            }
        }
    });

    grunt.registerTask('server', function (target) {
        if (target === 'dist') {
            return grunt.task.run([
                'build',
                'connect:dist',
                'watch:dist'
            ]);
        }

        grunt.task.run([
            'bower',
            'browserify:objectHistory',
            'clean:server',
            'jekyllDev',
            'connect:dev',
            'concurrent:watchDev'
        ]);
    });

    grunt.registerTask('test', [
        'bower',
        'browserify:objectHistory',
        'clean:server',
        'connect:test',
        'qunit'
    ]);

    grunt.registerTask('build', [
        'clean:dist',
        'useminPrepare',
        'bower-install-simple',
        'bower-linker:dist-examples',
        'browserify:objectHistory',
        'concat',
        'uglify',
        'copy:dist',
        'usemin',
        'replace',
        'compress',
        'jekyllDist'
    ]);

    grunt.registerTask('default', [
        'jshint',
        'test',
        'build'
    ]);

    // This task combines the installation of Bower components and the copying
    // of the library files for use in the development environment.
    grunt.registerTask('bower', [
        'bower-install-simple',
        'bower-linker:dev',
        'shell:linkES5Sham'
    ]);

    grunt.registerTask('jekyllDev', [
        'shell:convertReadmeToHomePage',
        'jekyll:dev'
    ]);

    grunt.registerTask('jekyllDist', [
        'shell:convertReadmeToHomePage',
        'jekyll:dist'
    ]);

    grunt.registerTask('docsMakeHtml', ['shell:docsMakeHtml']);
    grunt.registerTask('docsMake', ['docsMakeHtml']);
    grunt.registerTask('docsOpenHtml', ['shell:docsOpenHtml']);
    grunt.registerTask('docsOpen', ['docsOpenHtml']);
    grunt.registerTask('docs', [
        'docsMake',
        'docsOpen'
    ]);

    grunt.loadNpmTasks("grunt-contrib-uglify");
    grunt.loadNpmTasks("grunt-contrib-copy");
    grunt.loadNpmTasks("grunt-contrib-concat");
    grunt.loadNpmTasks("grunt-contrib-compress");
    grunt.loadNpmTasks("grunt-contrib-connect");
    grunt.loadNpmTasks("grunt-contrib-jshint");
    grunt.loadNpmTasks("grunt-contrib-watch");
    grunt.loadNpmTasks("grunt-contrib-clean");
    grunt.loadNpmTasks("grunt-contrib-qunit");
    grunt.loadNpmTasks("grunt-replace");
    grunt.loadNpmTasks("grunt-usemin");
    grunt.loadNpmTasks("grunt-bower-install-simple");
    grunt.loadNpmTasks("grunt-bower-linker");
    grunt.loadNpmTasks("grunt-jekyll");
    grunt.loadNpmTasks("grunt-concurrent");
    grunt.loadNpmTasks("grunt-shell");
    grunt.loadNpmTasks("grunt-browserify");
};