Gruntfile.js

/*
 * Giggle.js
 * Automated tasks (uses GruntJS)
 *
 * Author: Valerian Saliou https://valeriansaliou.name/
 *
 * Copyright: 2015, Valerian Saliou
 * License: Mozilla Public License v2.0 (MPL v2.0)
 */


module.exports = function(grunt) {


  // Map tasks
  var GRUNT_TASKS_BUILD = {
    main: [
      'clean:reset',
      'bower:install',
      'concat',
      'copy',
      'uglify',
      'jsdoc',
      'clean:temporary'
    ],

    quick: [
      'clean:reset',
      'bower:install',
      'concat',
      'copy',
      'clean:temporary'
    ],

    dev: [
      'clean:temporary',
      'bower:install',
      'concat',
      'copy',
      'clean:temporary'
    ],

    test: [
      'clean:temporary',
      'bower:install',
      'concat',
      'copy',
      'clean:temporary'
    ]
  };

  var GRUNT_TASKS_TEST = {
    main: [
      'build:test',
      'lint'
    ]
  };

  var GRUNT_TASKS_LINT = {
    js: ['jshint']
  };


  // Map files
  var GRUNT_LIB_FILES = [
    'lib/underscore/underscore.js',
    'lib/ring/ring.js'
  ];

  var GRUNT_SRC_FILES = [
    'src/giggle.header.js',
    'src/giggle.constants.js',
    'src/giggle.storage.js',
    'src/giggle.utils.js',
    'src/giggle.sdp.js',
    'src/giggle.base.js',
    'src/giggle.single.js',
    'src/giggle.muji.js',
    'src/giggle.plug.js',
    'src/giggle.plug.jsjac.js',
    'src/giggle.broadcast.js',
    'src/giggle.init.js',
    'src/giggle.main.js'
  ];

  var GRUNT_CONCAT_FILES = GRUNT_LIB_FILES.concat(GRUNT_SRC_FILES);
  var GRUNT_LINT_FILES = GRUNT_SRC_FILES;


  // Map functions
  var fn_generate_banner = function(type) {
    return '/**\n' +
           ' * <%= pkg.name %> [' + type + ']\n' +
           ' * @fileoverview <%= pkg.description %>\n' +
           ' *\n' +
           ' * @version <%= pkg.version %>\n' +
           ' * @date <%= grunt.template.today("yyyy-mm-dd") %>\n' +
           ' * @author <%= pkg.author.name %> <%= pkg.author.url %>\n' +
           ' *\n' +
           ' * @copyright <%= pkg.copyright %>\n' +
           ' * @license <%= pkg.license %>\n' +
           ' *\n' +
           ' * @url <%= pkg.homepage %>\n' +
           ' * @repository <%= pkg.repository.type %>+<%= pkg.repository.url %>\n' +
           ' */\n\n';
  };

  var fn_generate_task = function(tasks_obj, t) {
    var tasks_map = [];

    if(!t) {
      if(typeof tasks_obj.main == 'object') {
        tasks_map.push('main');
      } else {
        for(t in tasks_obj) {
          tasks_map.push(t);
        }
      }
    } else if(typeof tasks_obj[t] != 'object') {
      return grunt.warn('Invalid lint target name.\n');
    } else {
      tasks_map.push(t);
    }

    for(var c in tasks_map) {
      t = tasks_map[c];

      for(var i in tasks_obj[t]) {
        grunt.task.run(tasks_obj[t][i]);
      }
    }
  };


  // Project configuration
  grunt.initConfig({
    pkg: grunt.file.readJSON('package.json'),


    // Task: Watch
    watch: {
      options: {
        interval: 500
      },

      javascripts: {
        files: 'src/**.js',
        tasks: GRUNT_TASKS_BUILD.dev
      }
    },


    // Task: Clean
    clean: {
      temporary: ['tmp/'],

      reset: [
        'tmp/',
        'lib/*',
        'build/*',
        'doc/*',
        'bower_components/'
      ]
    },


    // Task: JSDoc
    jsdoc : {
      dist : {
        src: GRUNT_SRC_FILES,

        options: {
            destination: 'doc/'
        }
      }
    },


    // Task: JSHint
    jshint: {
      files: GRUNT_LINT_FILES
    },


    // Task: Concat
    concat: {
      options: {
        banner: fn_generate_banner('uncompressed')
      },

      all: {
        files: [{
          src: GRUNT_CONCAT_FILES,
          dest: 'tmp/giggle.js',
        }]
      }
    },


    // Task: Copy
    copy: {
      all: {
        files: [{
          src: 'tmp/giggle.js',
          dest: 'build/giggle.js'
        }]
      }
    },


    // Task: Uglify
    uglify: {
      options: {
        report: 'min',
        banner: fn_generate_banner('compressed')
      },

      javascripts: {
        files: [{
          src: 'tmp/giggle.js',
          dest: 'build/giggle.min.js'
        }]
      }
    },


    // Task: Bower
    bower: {
      install: {
        options: {
          install: true,
          verbose: false,
          cleanTargetDir: false,
          cleanBowerDir: false,
          bowerOptions: {}
        }
      }
    }
  });


  // Load plugins
  grunt.loadNpmTasks('grunt-jsdoc');
  grunt.loadNpmTasks('grunt-contrib-jshint');
  grunt.loadNpmTasks('grunt-contrib-watch');
  grunt.loadNpmTasks('grunt-contrib-clean');
  grunt.loadNpmTasks('grunt-contrib-concat');
  grunt.loadNpmTasks('grunt-contrib-copy');
  grunt.loadNpmTasks('grunt-contrib-uglify');
  grunt.loadNpmTasks('grunt-bower-installer');


  // Register tasks
  grunt.registerTask('default', function() {
    return grunt.warn('Usage:' + '\n\n' + 'test - grunt test' + '\n\n');
  });

  grunt.registerTask('test', function() {
    fn_generate_task(GRUNT_TASKS_TEST);
  });

  grunt.registerTask('build', function(t) {
    fn_generate_task(GRUNT_TASKS_BUILD, t);
  });

  grunt.registerTask('lint', function(t) {
    fn_generate_task(GRUNT_TASKS_LINT, t);
  });

};