jquery plugin and tests, fixes #7

You need to call "grunt test:remote" now rather than "grunt intern:remote",
and that will do the test build, run the intern tests, and then delete the test build.

Author: wkeese

Gruntfile.js

@@ -56,10 +56,19 @@ module.exports = function (grunt) {
 					reporters: ["runner"]
 				}
 			}
+		},
+
+		clean: {
+			// Delete files created by the "testBuild" target.
+			testBuild: [
+				"tests/functional/jqueryApp/{bower_components,node_modules,build,tmp}",
+				"tests/jquery.js"	// work around grunt-amd-build bug where it puts files outside of tmp/ dir
+			]
 		}
 	});
 
 	// These plugins provide necessary tasks.
+	grunt.loadNpmTasks("grunt-contrib-clean");
 	grunt.loadNpmTasks("grunt-contrib-jshint");
 	grunt.loadNpmTasks("grunt-jsbeautifier");
 	grunt.loadNpmTasks("grunt-lineending");
@@ -73,6 +82,90 @@ module.exports = function (grunt) {
 	grunt.registerTask("lint", ["jsbeautifier", "lineending", "jshint"]);
 
 	// Travis build
-	grunt.registerTask("travis", ["jshint", "intern:remote"]);
+	grunt.registerTask("travis", ["jshint", "test:remote"]);
+
+	grunt.registerTask("testBuild", "Run the builds used by the functional tests", function () {
+		var done = this.async();
+
+		var appRootDir = "tests/functional/jqueryApp";
+
+		function npmInstall(error, bowerResults) {
+			if (error !== null) {
+				grunt.log.writeln(bowerResults.stdout);
+				done(error);
+				return;
+			}
+			grunt.util.spawn({
+				cmd: "npm",
+				args: ["install"],
+				opts: {
+					cwd: appRootDir
+				}
+			}, startBuild);
+		}
+
+		function startBuild(error, npmResults) {
+			if (error !== null) {
+				grunt.log.writeln(npmResults.stdout);
+				done(error);
+				return;
+			}
+			grunt.util.spawn({
+				cmd: "grunt",
+				args: ["build"],
+				opts: {
+					cwd: appRootDir
+				}
+			}, done.bind(null, true));
+		}
+
+		grunt.util.spawn({
+			cmd: "bower",
+			args: ["install"],
+			opts: {
+				cwd: appRootDir
+			}
+		}, npmInstall);
+	});
+
+	// Testing.
+	// Always specify the target e.g. grunt test:remote, grunt test:remote
+	// then add on any other flags afterwards e.g. console, lcovhtml.
+	var testTaskDescription = "Run this task instead of the intern task directly! \n" +
+		"Always specify the test target e.g. \n" +
+		"grunt test:local\n" +
+		"grunt test:remote\n\n" +
+		"Add any optional reporters via a flag e.g. \n" +
+		"grunt test:local:console\n" +
+		"grunt test:local:lcovhtml\n" +
+		"grunt test:local:console:lcovhtml";
+	grunt.registerTask("test", testTaskDescription, function (target) {
+		function addReporter(reporter) {
+			var property = "intern." + target + ".options.reporters",
+				value = grunt.config.get(property);
+			if (value.indexOf(reporter) !== -1) {
+				return;
+			}
+			value.push(reporter);
+			grunt.config.set(property, value);
+		}
+
+		if (this.flags.lcovhtml) {
+			addReporter("lcovhtml");
+		}
+
+		if (this.flags.console) {
+			addReporter("console");
+		}
+
+		// First create the test builds.  These are referenced from the intern tests.
+		grunt.task.run("testBuild");
+
+		// Then run the intern tests.
+		grunt.task.run("intern:" + target);
+
+		// Finally, delete the test builds so that they don't show up in "git status" as "untracked files".
+		grunt.task.run("clean:testBuild");
+	});
 
 };

README.md

@@ -4,6 +4,7 @@ Set of AMD plugins for RequireJS. It contains the following plugins:
 
  * [has](#has)
  * [i18n](#i18n)
+ * [jquery](#jquery)
  * [maybe](#maybe)
 
 ## Status
@@ -28,6 +29,7 @@ This project requires the following other project to run:
 _Bower_ release installation:
 
     $ bower install requirejs-dplugins
+    $ bower install jquery (if you are using the jquery plugin)
 
 _Manual_ master installation:
 
@@ -49,6 +51,11 @@ This plugin provides provides an API to handle string translation.
 
 See [docs/i18n.md](./docs/i18n.md) and [samples/i18n.html](./samples/i18n.html) for documentation and sample.
 
+## jquery
+This plugin loads the specified jquery modules if they are not loaded already.
+
+See [docs/jquery.md](./docs/jquery.md) for documentation.
+
 ## maybe
 This plugin allows to require modules that may or may not exist.
 

bower.json

@@ -6,6 +6,9 @@
 		"dojo": ">=1.9.1",
 		"requirejs": "2.1.x"
 	},
+	"devDependencies": {
+		"jquery": ">=2.1"
+	},
 	"keywords": [
 		"requirejs",
 		"amd",
@@ -22,4 +25,4 @@
 		"Gruntfile.js",
 		"package.json"
 	]
-}
+}

docs/jquery.md

@@ -0,0 +1,27 @@
+---
+layout: default
+title: requirejs-dplugins/jquery
+---
+
+# requirejs-dplugins/jquery!
+
+
+This plugin will load load the specified jQuery module(s), unless the application has loaded the whole jQuery
+library via a `<script>` tag, in which case it just returns a pointer to the already loaded jQuery.
+
+It's useful to avoid loading jQuery twice.
+
+When using this plugin, you must manually include jquery into your app via `bower install jquery` or via
+a script tag (ex: `<script src="https://code.jquery.com/jquery-2.1.1.min.js">`).
+
+## Example
+
+To get a jQuery object that can modify classes and do animations:
+
+```js
+require(["requirejs-dplugins/jquery!attributes/classes,effects"], function ($) {
+    ...
+    $(myNode).addClass("selected");
+    $(myNode).animate(...);
+});
+```

jquery.js

@@ -0,0 +1,72 @@
+/**
+ * Plugin to load specified jQuery module(s), unless the application has loaded the whole jQuery
+ * library via a `<script>` tag, in which case it just returns a pointer to the already loaded jQuery.
+ * Useful to avoid loading jQuery twice.
+ *
+ * @example:
+ * To get a jQuery object that can modify classes and do animations:
+ * ```
+ * require(["requirejs-dplugins/jquery!attributes/classes,effects"], function ($){
+ *     ...
+ *     $(myNode).addClass("selected");
+ *     $(myNode).animate(...);
+ * });
+ * ```
+ *
+ * @module requirejs-dplugins/jquery
+ */
+
+define([], function () {
+
+	// This is modifying and using the global require() configuration.  Is there a better way?
+	// I tried using a local require but it doesn't have a config() method.
+	require.config({
+		map: {
+			jquery: {
+				"jquery/src/selector": "jquery/src/selector-native"     // don't pull in sizzle
+			}
+		}
+	});
+
+	// Convert abbreviated list of jQuery modules to real list of jQuery modules
+	//		1. Always include jquery/core since some modules like jquery/attributes/classes don't return
+	//		   anything.
+	//		2. Fix paths to modules by prefixing each module name with jQuery/src.  The "src" directoy
+	//		   is to match the directory structure in the jQuery installed via bower.
+	//
+	// Ex: "attributes/classes,effects" --> ["jquery/src/core", "jquery/src/attributes/classes", "jquery/src/effects"]
+	function getModules(str) {
+		return ["core"].concat(str.split(/, */)).map(function (amid) {
+			return "jquery/src/" + amid;
+		});
+	}
+
+	return {
+		normalize: function (resource) {
+			// Don't do any normalization here; it's done when getModules() is called.
+			return resource;
+		},
+
+		load: function (resource, req, onLoad, config) {
+			/* global jQuery */
+			/* global $ */
+			if (config.isBuild) {
+				onLoad();
+			} else if (typeof jQuery !== "undefined") {
+				onLoad(jQuery);
+			} else if (typeof $ !== "undefined") {
+				onLoad($);
+			} else {
+				require(getModules(resource), function ($) {
+					onLoad($);
+				});
+			}
+		},
+
+		// Interface for grunt-amd-build.  If the application doesn't want jQuery in the layer it should exclude
+		// it through directives to grunt-amd-build.
+		addModules: function (pluginName, resource, addModules) {
+			addModules(getModules(resource));
+		}
+	};
+});

package.json

@@ -4,6 +4,7 @@
 	"description": "AMD plugins for RequireJS",
 	"devDependencies": {
 		"grunt": "~0.4.1",
+		"grunt-contrib-clean": "0.6.x",
 		"grunt-contrib-jshint": "~0.6.0",
 		"grunt-jsbeautifier": "~0.2.2",
 		"requirejs": "~2.1.10",

tests/functional/all.js

@@ -0,0 +1,5 @@
+// Listing of all the plugin functional tests
+define([
+	"./jqueryBuild",
+	"./jqueryScript"
+]);

tests/functional/jqueryApp/.bowerrc

@@ -0,0 +1,3 @@
+{
+	"directory": "bower_components"
+}

tests/functional/jqueryApp/Gruntfile.js

@@ -0,0 +1,95 @@
+// Gruntfile for building layer including src.js and the jquery modules it references
+module.exports = function (grunt) {
+	"use strict";
+
+	grunt.loadNpmTasks("grunt-contrib-clean");
+	grunt.loadNpmTasks("grunt-contrib-copy");
+	grunt.loadNpmTasks("grunt-contrib-concat");
+	grunt.loadNpmTasks("grunt-amd-build");
+
+	var outprop = "amdoutput";
+	var outdir = "./build/";
+	var tmpdir = "./tmp/";
+
+	var common = {
+		options: { banner: "<%= " + outprop + ".header%>" },
+		src: "<%= " + outprop + ".modules.abs %>",
+		dest: outdir + "<%= " + outprop + ".layerPath %>"
+	};
+
+	grunt.initConfig({
+		amdloader: {
+			baseUrl: ".",
+
+			paths: {
+				jquery: "bower_components/jquery",
+				"requirejs-dplugins": "../../.."
+			},
+
+			// Unfortunately this is needed for the jquery plugin.
+			// It's automatically handled by the plugin itself at runtime, but not during builds.
+			map: {
+				"*": {
+					"jquery/src/selector": "jquery/src/selector-native"
+				}
+			}
+		},
+
+		amdbuild: {
+			dir: tmpdir,
+
+			// List of layers to build.
+			layers: [
+				// Test build for jquery plugin.  Should contain main test js file and a few jquery modules.
+				{
+					name: "app",
+					include: [
+						// Modules and layers listed here, and their dependencies, will be added to the layer.
+						"src"
+					]
+				}
+			]
+		},
+
+		// Config to allow to concatenate files to generate the layer.
+		concat: {
+			options: {
+				banner: "<%= " + outprop + ".header%>",
+				sourceMap: true
+			},
+			dist: {
+				src: "<%= " + outprop + ".modules.abs %>",
+				dest: outdir + "<%= " + outprop + ".layerPath %>"
+			}
+		},
+
+		copy: {
+			plugins: {
+				expand: true,
+				cwd: tmpdir,
+				src: "<%= " + outprop + ".plugins.rel %>",
+				dest: outdir
+			}
+		},
+
+		clean: {
+			out: [outdir],
+			temp: [tmpdir]
+		}
+	});
+
+	grunt.registerTask("amdbuild", function (amdloader) {
+		var name = this.name, layers = grunt.config(name).layers;
+		layers.forEach(function (layer) {
+			grunt.task.run("amddepsscan:" + layer.name + ":" + name + ":" + amdloader);
+			grunt.task.run("amdserialize:" + layer.name + ":" + name + ":" + outprop);
+			grunt.task.run("concat");
+			grunt.task.run("copy:plugins");
+		});
+	});
+	grunt.registerTask("build", [
+		"clean:out",
+		"clean:temp",
+		"amdbuild:amdloader"
+	]);
+};