Gruntfile.js

/*
 * grunt-assets-versioning
 * https://github.com/theasta/grunt-assets-versioning
 *
 * Copyright (c) 2013 Alexandrine Boissière
 * Licensed under the MIT license.
 */

'use strict';

module.exports = function(grunt) {

  var _fileGlobSync;
  // Project configuration.
  grunt.initConfig({
    jsdoc : {
      dist : {
        src: ['tasks/**/*.js'],
        options: {
          destination: 'docs',
          configure: 'jsdoc.conf.json'
        }
      }
    },
    jshint: {
      all: [
        'Gruntfile.js',
        'tasks/**/*.js',
        '<%= nodeunit.tests %>'
      ],
      options: {
        jshintrc: '.jshintrc'
      }
    },

    // Before generating any new files, remove any previously-created files.
    clean: {
      tests: ['tmp']
    },

    // Configuration to be run (and then tested).
    assets_versioning: {
      options_tag_date: {
        options: {
          tag           : 'date'
        },
        files: {
          'tmp/js/js_bundle_a.js': ['test/fake/file1.js', 'test/fake/file2.js'],
          'tmp/js/js_bundle_b.js': ['test/fake/file3.js', 'test/fake/file4.js']
        }
      },
      options_dateFormat: {
        options: {
          tag           : 'date',
          dateFormat: 'YYMMDDHHmmss',
          timezoneOffset: 7
        },
        files: {
          'tmp/js/js_bundle_a.js': ['test/fake/file1.js', 'test/fake/file2.js'],
          'tmp/js/js_bundle_b.js': ['test/fake/file3.js', 'test/fake/file4.js']
        }
      },
      options_timezoneOffset: {
        options: {
          tag           : 'date',
          timezoneOffset: 7
        },
        files: {
          'tmp/js/js_bundle_a.js': ['test/fake/file1.js', 'test/fake/file2.js'],
          'tmp/js/js_bundle_b.js': ['test/fake/file3.js', 'test/fake/file4.js']
        }
      },
      options_hashLength: {
        options: {
          hashLength: 16
        },
        files: {
          'tmp/js/options_hashlength_a.js': ['test/fixtures/js/file1.js', 'test/fixtures/js/file2.js'],
          'tmp/js/options_hashlength_b.js': ['test/fixtures/js/file3.js', 'test/fixtures/js/file4.js']
        }
      },
      options_skipExisting_true: {
        options: {
          skipExisting: true
        },
        files: {
          'tmp/skip_existing_true.js': ['test/fixtures/js/file1.js', 'test/fixtures/js/file2.js']
        }
      },
      options_skipExisting_false: {
        options: {
          skipExisting: false
        },
        files: {
          'tmp/skip_existing_false.js': ['test/fixtures/js/file1.js', 'test/fixtures/js/file2.js']
        }
      },
      options_skipExisting_array: {
        options: {
          skipExisting: ['tmp/js/skip_existing_array_1.3d04f375.js']
        },
        files: {
          'tmp/js/skip_existing_array_1.js': ['test/fixtures/js/file1.js', 'test/fixtures/js/file2.js'],
          'tmp/js/skip_existing_array_2.js': ['test/fixtures/js/file3.js', 'test/fixtures/js/file4.js']
        }
      },
      options_post_external: {
        options: {
          post: true,
          tasks: [
            'concat:options_post_1',
            'concat:options_post_2'
          ]
        }
      },
      options_post_internal: {
        options: {
          post: true
        },
        files: [
          { src: ['test/fixtures/js/file1.js', 'test/fixtures/js/file2.js'], dest: 'tmp/js/options_post_internal_a.js' },
          { src: ['test/fixtures/js/file3.js', 'test/fixtures/js/file4.js'], dest: 'tmp/js/options_post_internal_b.js' }
        ]
      },
      options_versionsMapFile: {
        files: [{
          expand : true,
          cwd    : "test/fixtures/images/",
          src    : ['**/*.png', '**/*.jpg', '**/*.gif'],
          dest   : "tmp/options_output/"
        }],
        options: {
          versionsMapFile     : 'tmp/options_output.json'
        }
      },
      output_versionsMapTrimPath: {
        files: [{
          expand : true,
          cwd    : "test/fixtures/images/",
          src    : ['**/*.png', '**/*.jpg', '**/*.gif'],
          dest   : "tmp/options_output_trim/"
        }],
        options: {
          versionsMapFile     : 'tmp/options_output_trim.json',
          versionsMapTrimPath : 'tmp/options_output_trim/'
        }
      },
      options_versionsMapTemplate: {
        files: [{
          expand : true,
          cwd    : "test/fixtures/images/",
          src    : ['**/*.png', '**/*.jpg', '**/*.gif'],
          dest   : "tmp/options_versionsMapTemplate/"
        }],
        options: {
          versionsMapFile     : 'tmp/options_versionsMapTemplate.php',
          versionsMapTemplate : 'test/fixtures/templates/php.tpl',
          versionsMapTrimPath : 'tmp/options_versionsMapTemplate/'
        }
      },
      files_compact_format: {
        src: [
          'test/fixtures/js/file1.js',
          'test/fixtures/js/file2.js',
          'test/fixtures/js/file3.js'
        ],
        dest: 'tmp/js/files_compact_format.js'
      },
      files_object_format: {
        files: {
          'tmp/js/files_object_format_a.js': ['test/fixtures/js/file1.js', 'test/fixtures/js/file2.js'],
          'tmp/js/files_object_format_b.js': ['test/fixtures/js/file3.js', 'test/fixtures/js/file4.js']
        }
      },
      files_array_format: {
        files: [
          {src: ['test/fixtures/js/file1.js', 'test/fixtures/js/file2.js'], dest: 'tmp/js/files_array_format_a.js'},
          {src: ['test/fixtures/js/file3.js', 'test/fixtures/js/file4.js'], dest: 'tmp/js/files_array_format_b.js'}
        ]
      },
      files_expand_format: {
        files: [{
          expand : true,
          cwd    : "test/fixtures/images/",
          src    : ['**/*.png', '**/*.jpg', '**/*.gif'],
          dest   : "tmp/files_expand_format/"
        }]
      },
      files_expand_format_directory: {
        files: [{
          expand : true,
          cwd    : "test/fixtures/images",
          src    : ['**/*'],
          dest   : "tmp/task_files_expand_format_directory/"
        }]
      },
      task_files_compact_format: {
        options: {
          tasks: ['concat:task_files_compact_format']
        }
      },
      task_files_object_format: {
        options: {
          tasks: ['concat:task_files_object_format']
        }
      },
      task_files_array_format: {
        options: {
          tasks: ['concat:task_files_array_format']
        }
      },
      task_files_expand_format: {
        options: {
          tasks: ['concat:task_files_expand_format']
        }
      },
      multiple_tasks: {
        options: {
          tasks: [
            'concat:multiple_task_1',
            'concat:multiple_task_2',
            'concat:multiple_task_3'
          ]
        }
      },
      files_default_behaviour: {
        files: {
          'tmp/js/default_a.js': ['test/fixtures/js/file1.js', 'test/fixtures/js/file2.js'],
          'tmp/js/default_b.js': ['test/fixtures/js/file3.js', 'test/fixtures/js/file4.js']
        }
      },
      fail_surrogate_already_exists: {
        options: {
          tasks: ['concat:fail_surrogate_already_exists']
        }
      },
      fail_duplicate_destination_files: {
        files: [
          { src: ['test/fixtures/js/file1.js', 'test/fixtures/js/file2.js'], dest: 'tmp/js/duplicate_file.js' },
          { src: ['test/fixtures/js/file1.js', 'test/fixtures/js/file2.js'], dest: 'tmp/js/duplicate_file.js' }
        ]
      },
      fail_no_valid_files: {
        'tmp/js/no_file/no_file.js': ['test/fixtures/js/file2.js']
      },
      fail_no_files: {},
      fail_no_valid_external_task: {
        options: {
          task: ['dontexist']
        }
      },
      fail_no_src: {
        files: {
          'tmp/js/whatever.js': ['test/fixtures/js/']
        }
      },
      fail_no_dest: {
        src: ['test/fixtures/js/file2.js']
      },
      fail_mix_files_task: {
        options: {
          tasks: ['concat:fail_mix_files_task']
        },
        files: {
          'tmp/fail_mix_files_task.js':  'test/fixtures/js/file3.js'
        }
      },
      fail_skipexisting_post_conflict: {
        options: {
          skipExisting: true,
          post: true
        },
        files: {
          'tmp/fail_skipexisting_post_conflict.js':  'test/fixtures/js/file3.js'
        }
      }
    },

    concat: {
      task_files_compact_format:{
        src: [
          'test/fixtures/js/file1.js',
          'test/fixtures/js/file2.js',
          'test/fixtures/js/file3.js'
        ],
        dest: 'tmp/js/task_files_compact_format.js'
      },
      task_files_object_format: {
        files: {
          'tmp/js/task_files_object_format_a.js': ['test/fixtures/js/file1.js', 'test/fixtures/js/file2.js'],
          'tmp/js/task_files_object_format_b.js': ['test/fixtures/js/file3.js', 'test/fixtures/js/file4.js']
        }
      },
      task_files_array_format: {
        files: [
          {src: ['test/fixtures/js/file1.js', 'test/fixtures/js/file2.js'], dest: 'tmp/js/task_files_array_format_a.js'},
          {src: ['test/fixtures/js/file3.js', 'test/fixtures/js/file4.js'], dest: 'tmp/js/task_files_array_format_b.js'}
        ]
      },
      multiple_task_1: {
        files: {
          'tmp/js/multiple_task_1_a.js': ['test/fixtures/js/file1.js', 'test/fixtures/js/file2.js'],
          'tmp/js/multiple_task_1_b.js': ['test/fixtures/js/file3.js', 'test/fixtures/js/file4.js']
        }
      },
      multiple_task_2: {
        src: [
          'test/fixtures/js/file1.js',
          'test/fixtures/js/file2.js',
          'test/fixtures/js/file3.js'
        ],
        dest: 'tmp/js/multiple_task_2.js'
      },
      multiple_task_3: {
        files: [
          {src: ['test/fixtures/js/file1.js', 'test/fixtures/js/file2.js'], dest: 'tmp/js/multiple_task_3_a.js'},
          {src: ['test/fixtures/js/file3.js', 'test/fixtures/js/file4.js'], dest: 'tmp/js/multiple_task_3_b.js'}
        ]
      },
      fail_surrogate_already_exists: {
        src: [
          'test/fixtures/js/file1.js'
        ],
        dest: 'tmp/js/fail_surrogate_already_exists.js'

      },
      fail_surrogate_already_exists_assets_versioning: {},
      task_files_expand_format: {
        files: [{
          expand : true,
          cwd    : "test/fixtures/images/",
          src    : ['**/*.png', '**/*.jpg', '**/*.gif'],
          dest   : "tmp/task_files_expand_format/"
        }]
      },
      fail_mix_files_task: {},
      options_post_1: {
        files: {
          'tmp/js/options_post_a.js': ['test/fixtures/js/file1.js', 'test/fixtures/js/file2.js']
        }
      },
      options_post_2: {
        files: {
          'tmp/js/options_post_b.js': ['test/fixtures/js/file3.js', 'test/fixtures/js/file4.js']
        }
      }
    },

    // Unit tests.
    nodeunit: {
      tests: ['test/*_test.js']
    },

    watch: {
      files: ['<%= jshint.all %>'],
      tasks: ['jshint', 'test']
    }

  });

  // Actually load this plugin's task(s).
  grunt.loadTasks('tasks');

  // These plugins provide necessary tasks.
  grunt.loadNpmTasks('grunt-contrib-concat');
  grunt.loadNpmTasks('grunt-contrib-jshint');
  grunt.loadNpmTasks('grunt-jsdoc');
  grunt.loadNpmTasks('grunt-contrib-clean');
  grunt.loadNpmTasks('grunt-contrib-nodeunit');

  var mock = require('mock-fs');

  grunt.registerTask('startMocking', function () {

    mock({
      'test/fake/': {
        'file1.js': mock.file({
          content: 'file content here',
          ctime: new Date(1411609054470),
          mtime: new Date(1411609054470) //Wed Sep 24 2014 18:37:34 GMT-0700 (PDT)
        }),
        'file2.js': mock.file({
          content: 'file content here',
          ctime: new Date(1369140245000),
          mtime: new Date(1369140245000) //Tue May 21 2013 05:44:05 GMT-0700 (PDT)
        }),
        'file3.js': mock.file({
          content: 'file content here',
          ctime: new Date(1328091453000),
          mtime: new Date(1328091453000) //Wed Feb 01 2012 02:17:33 GMT-0800 (PST)
        }),
        'file4.js': mock.file({
          content: 'file content here',
          ctime: new Date(1388563200000),
          mtime: new Date(1388563200000) //Wed Jan 01 2014 00:00:00 GMT-0800 (PST)
        })
      }
    });

    // grunt is using glob that is using graceful-fs.
    // It also needs to be mocked
    _fileGlobSync = grunt.file.glob.sync;
    grunt.file.glob.sync = function (pattern, options) {
      if (/^test\/fake\/.*/.test(pattern)) {
        return pattern;
      } else {
        return _fileGlobSync(pattern, options);
      }
    };
  });

  grunt.registerTask('stopMocking', function () {
    mock.restore();
    grunt.file.glob.sync = _fileGlobSync;
  });

  grunt.registerTask('prepareSkipExistingTest', function () {
    grunt.file.copy('test/expected/js/skip.js', 'tmp/skip_existing_true.3d04f375.js');
    grunt.file.copy('test/expected/js/skip.js', 'tmp/skip_existing_false.3d04f375.js');
    grunt.file.copy('test/expected/js/skip.js', 'tmp/js/skip_existing_array_1.3d04f375.js');
    grunt.file.copy('test/expected/js/skip.js', 'tmp/js/skip_existing_array_2.bfcf287e.js');
  });

  // Whenever the "test" task is run, first clean the "tmp" dir, then run this
  // plugin's task(s), then test the result.
  grunt.registerTask('test', [
    'clean',
    'startMocking',
    'assets_versioning:options_tag_date',
    'assets_versioning:options_dateFormat',
    'assets_versioning:options_timezoneOffset',
    'stopMocking',
    'assets_versioning:options_hashLength',
    'prepareSkipExistingTest',
    'assets_versioning:options_skipExisting_true',
    'assets_versioning:options_skipExisting_false',
    'assets_versioning:options_skipExisting_array',
    'assets_versioning:options_post_external',
    'assets_versioning:options_post_internal',
    'assets_versioning:options_versionsMapFile',
    'assets_versioning:output_versionsMapTrimPath',
    'assets_versioning:options_versionsMapTemplate',
    'assets_versioning:files_compact_format',
    'assets_versioning:files_object_format',
    'assets_versioning:files_array_format',
    'assets_versioning:files_expand_format',
    'assets_versioning:files_expand_format_directory',
    'assets_versioning:task_files_compact_format',
    'assets_versioning:task_files_object_format',
    'assets_versioning:task_files_array_format',
    'assets_versioning:task_files_expand_format',
    'assets_versioning:multiple_tasks',
    'assets_versioning:files_default_behaviour',
    'nodeunit'
  ]);

  grunt.registerTask('fail', [
    'assets_versioning:fail_no_src',
    'assets_versioning:fail_no_dest',
    'assets_versioning:fail_no_files',
    'assets_versioning:fail_no_valid_files',
    'assets_versioning:fail_mix_files_task',
    'assets_versioning:fail_surrogate_already_exists',
    'assets_versioning:fail_duplicate_destination_files',
    'assets_versioning:fail_no_valid_external_task',
    'assets_versioning:fail_skipexisting_post_conflict'
  ]);

  // By default, lint and run all tests.
  grunt.registerTask('default', ['jshint', 'test']);

};