can/Gruntfile.js

MIT-licensed, client-side, JavaScript framework that makes building rich web applications easy.

/*global __dirname */
var path = require('path');
var getTestTasks = function() {
	var suite = process.env.TEST_SUITE;
	var testTasks = ['testee'];
	if(suite === 'loaders') {
		testTasks = ['simplemocha', 'testee:steal', 'testee:amd'];
	} else if(suite === 'dists') {
		testTasks = [ 'testee:dist', 'testee:dev', 'testee:compatibility' ];
	} else if(suite === 'individuals') {
		testTasks = ['testee:individuals'];
	}
	return testTasks;
};

module.exports = function (grunt) {

	var _ = grunt.util._;
	var builderJSON = grunt.file.readJSON('builder.json');
	var pkg = grunt.file.readJSON('package.json');
	var testifyDist = {
		template: 'test/templates/__configuration__-dist.html.ejs',
		builder: builderJSON,
		root: '../../',
		out: 'test/dist/',
		transform: {
			module: function (definition) {
				if (!definition.isDefault) {
					return definition.name.toLowerCase();
				}
				return null;
			},

			options: function (config) {
				return {
					dist: 'can.' + config
				};
			}
		}
	};

	grunt.registerTask('publish', 'Publish a a release (patch, minor, major).', function () {
		var type = this.args[0];

		if (['patch', 'minor', 'major'].indexOf(type) === -1) {
			throw new Error(type + ' is not a valid release version bump (patch, minor, major)');
		}

		grunt.task.run(['release:bump:' + type, 'changelog', 'shell:updateChangelog',
			'release:add:commit:push:tag:pushTags']);
	});

	grunt.initConfig({
		pkg: pkg,
		testify: {
			libs: {
				template: 'test/templates/__configuration__.html.ejs',
				builder: builderJSON,
				out: 'test/',
				transform: {
					test: function(definition, key) {
						return key + '_test.js';
					}
				}
			},
			dist: testifyDist,
			dev: _.extend({}, testifyDist, {
				template: 'test/templates/__configuration__-dev.html.ejs',
				out: 'test/dev/'
			}),
			amd: {
				template: 'test/templates/__configuration__-amd.html.ejs',
				builder: builderJSON,
				root: '../..',
				out: 'test/amd/',
				transform: {
					module: function(definition, name) {
						var path = name.split('/');
						path.pop();
						return path.join('/');
					}
				}
			},
			compatibility: {
				template: 'test/templates/__configuration__-compat.html.ejs',
				builder: builderJSON,
				root: '../../',
				out: 'test/compatibility/',
				transform: {
					module: function (definition) {
						if (!definition.isDefault) {
							return definition.name.toLowerCase();
						}
						return null;
					},

					options: function (config) {
						return {
							pluginified: ['2.0.5'],
							dist: 'can.' + config
						};
					}
				}
			}
		},
		changelog: {
			options: {
				repo: 'canjs',
				user: 'bitovi',
				version: pkg.version
			}
		},
		connect: {
			server: {
				options: {
					port: 8000,
					keepalive: true,
					base: '.'
				}
			}
		},
		// Removes the dist folder
		clean: {
			test: ['test/pluginified/latest.js'],
			build: ['dist/']
		},
		'string-replace': {
			version: {
				options: {
					replacements: [
						{
							pattern: /@EDGE/gim, //version property
							replacement: pkg.version
						}
					]
				},
				files: [
					{
						src: 'dist/**/*.js',
						dest: './',
						cwd: './'
					}
				]
			}
		},
		shell: {
			updateChangelog: {
				command: 'git add changelog.md && git commit -m "Updating changelog." && git push origin'
			}
		},
		release: {
			options: {
				tagName: 'v<%= version %>'
			}
		},
		publish: {},
		jshint: {
			options: {
				jshintrc: true
			},
			lib: [
				'component/**/*.js', 'compute/**/*.js', 'construct/**/*.js', 'control/**/*.js', 'list/**/*.js',
				'map/**/*.js', 'model/**/*.js', 'observe/**/*.js','route/**/*.js', 'util/**/*.js','view/**/*.js',
				'!util/yui/yui-3.7.3.js', '!util/dojo/dojo-1.8.1.js', '!util/dojo/nodelist-traverse.js'
			]
		},
		jsbeautifier: {
			files: '<%= jshint.lib %>',
			options: {
				config: ".jsbeautifyrc"
			}
		},
		docco: {
			options: {
				dst: 'docco/',
				layout : 'parallel',
				css : 'build/docco.css'
			},
			docs: {
				files : [
					{
						src : [
							'component/**/*.js', 'compute/**/*.js', 'construct/**/*.js', 'control/**/*.js', 'list/**/*.js',
							'map/**/*.js', 'model/**/*.js', 'observe/**/*.js','route/**/*.js', 'util/**/*.js','view/**/*.js',
							'!util/dojo/dojo-1.8.1.js', '!util/dojo/nodelist-traverse.js','!**/*_test.js'
						],
						expand : true
					}
				]
			}
		},
		plato: {
			src : {
				options : {
					jshint : grunt.file.readJSON('.jshintrc'),
					title : "CanJS Source",
					exclude : /bower_components\|dist\|docs\|guides\|lib\|node_modules\|src\|examples\|dojo\-\|demos/
				},
				files: {
					'plato/src': '<%= docco.dev.src %>'
				}
			},
			tests : {
				options : {
					jshint : grunt.file.readJSON('.jshintrc'),
					title : "CanJS Tests",
					exclude : /node_modules/
				},
				files: {
					'plato/tests': '**/*_test.js'
				}
			}

		},
		simplemocha: {
			builders: {
				src: ["test/builders/steal-tools/test.js","test/builders/browserify/test.js"]
			},
			server: {
				src: ["test/server/test.js"]
			}
		},
		"steal-export": require("./build/config_stealPluginify")(),
		meta: {
			steal: {
				modules: require("./build/config_meta_modules"),
				"export-helpers": require("./build/config_meta_defaults")()
			}
		},
		usebanner: {
			taskName: {
				options: {
					position: 'top',
					banner: _.template(builderJSON.banner, {
						pkg: pkg,
						ids: [ 'CanJS default build' ]
					}),
					linebreak: true
				},
				files: {
					src: [ 'dist/**/*.js' ]
				}
			}
		},
		testee: {
			options: {
				timeout: 10000,
				reporter: 'Dot'
			},
			steal: [
				'test/*.html',
				'!test/demos_and_tests.html',
				'!test/performance-loading.html',
				'!test/index.html',
				'!test/dojo.html'
			],
			amd: [ 'test/amd/*.html' ],
			dist: [ 'test/dist/*.html' ],
			compatibility: [ 'test/compatibility/*.html' ],
			dev: [ 'test/dev/*.html' ],
			individuals: [
				'component/**/test.html',
				'compute/**/test.html',
				'construct/**/test.html',
				'control/**/test.html',
				'event/**/test.html',
				'list/**/test.html',
				'map/**/test.html',
				'model/**/test.html',
				'route/**/test.html',
				'util/**/test.html',
				'view/**/test.html',
				'!view/autorender/test.html'
			]
		}
	});
	grunt.registerTask('browserify-package', function(){
		var browser = {"./can": "./dist/cjs/can"};
		require('./build/config_meta_modules').forEach(function(mod){
			var moduleName = mod.moduleName.replace("can/", "");
			browser["./"+moduleName] = "./dist/cjs/"+moduleName;
		});
		var cloned = _.clone(pkg, true);
		cloned.browser = browser;
		grunt.file.write("package.json", JSON.stringify(cloned, null, "\t"));
	});

	grunt.loadNpmTasks('grunt-contrib-connect');
	grunt.loadNpmTasks('grunt-contrib-clean');
	grunt.loadNpmTasks('grunt-contrib-jshint');
	grunt.loadNpmTasks('grunt-string-replace');
	grunt.loadNpmTasks('grunt-release-steps');
	grunt.loadNpmTasks('grunt-shell');
	grunt.loadNpmTasks('bitovi-tools');
	grunt.loadNpmTasks('grunt-jsbeautifier');
	grunt.loadNpmTasks('grunt-docco2');
	grunt.loadNpmTasks('grunt-plato');
	grunt.loadNpmTasks('grunt-banner');
	grunt.loadNpmTasks('steal-tools');
	grunt.loadNpmTasks('grunt-simple-mocha');
	grunt.loadNpmTasks('testee');

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

	grunt.registerTask('build', ['clean', 'steal-export',
		'string-replace:version', 'browserify-package', 'usebanner']);
	grunt.registerTask('build:amd',[
		'clean:build',
		'steal-export:amd',
		'steal-export:amd-util-jquery',
		'steal-export:amd-util-dojo',
		'steal-export:amd-util-yui',
		'steal-export:amd-util-zepto',
		'steal-export:amd-util-mootools',
		'string-replace:version'
	]);


	grunt.registerTask('test', ['jshint', 'build', 'testify'].concat(getTestTasks()));
	grunt.registerTask('test:compatibility', ['build', 'testify', 'testee:compatibility']);
	grunt.registerTask('test:steal', ['testee:steal']);
	grunt.registerTask('test:amd', ['build:amd', 'testify', 'testee:amd']);
};