Allows jQuery to integrate with the require() provided by RequireJS, if it is available. Exposes jQuery as a module that can be required and makes sure jQuery ready callbacks are not fired if scripts are still being loaded by require(). Includes unit tests.

Author: jrburke

src/core.js

@@ -40,7 +40,13 @@ var jQuery = function( selector, context ) {
 
 	// For matching the engine and version of the browser
 	browserMatch,
-	
+
+	// Should require integration be used?
+	useRequire = !!( typeof require !== "undefined" && require.def ),
+
+	// require could have page load logic built in so remember its function
+	requireReadyCallback = useRequire && require.callReady,
+
 	// Has the ready events already been bound?
 	readyBound = false,
 
@@ -236,15 +242,24 @@ jQuery.fn = jQuery.prototype = {
 		// Attach the listeners
 		jQuery.bindReady();
 
-		// If the DOM is already ready
-		if ( jQuery.isReady ) {
+		// If the DOM is already ready, and if require is in use
+                // all scripts have finished loading
+		if ( jQuery.isReady && ( !useRequire || require.s.isDone ) ) {
 			// Execute the function immediately
 			fn.call( document, jQuery );
 
 		// Otherwise, remember the function for later
-		} else if ( readyList ) {
-			// Add the function to the wait list
-			readyList.push( fn );
+		} else {
+                    // readyList could have been cleared for the initial
+                    // page load, but if scripts are loaded via require after
+                    // page load, then need to allow for other ready callbacks
+                    // to be registered that indicate those scripts after page
+                    // load have finished loading.
+                    if ( !readyList ) {
+                        readyList = [];
+                    }
+		    // Add the function to the wait list
+		    readyList.push( fn );
 		}
 
 		return this;
@@ -371,24 +386,31 @@ jQuery.extend({
 			// Remember that the DOM is ready
 			jQuery.isReady = true;
 
-			// If there are functions bound, to execute
-			if ( readyList ) {
-				// Execute all of them
-				var fn, i = 0;
-				while ( (fn = readyList[ i++ ]) ) {
-					fn.call( document, jQuery );
-				}
-
-				// Reset the list of functions
-				readyList = null;
-			}
-
-			// Trigger any bound ready events
-			if ( jQuery.fn.triggerHandler ) {
-				jQuery( document ).triggerHandler( "ready" );
-			}
+			jQuery.callReady();
 		}
 	},
+
+        // Calls ready callbacks, can be triggered by require script loading.
+        callReady: function() {
+            if ( jQuery.isReady && (!useRequire || require.s.isDone) ) {
+                // If there are functions bound, to execute
+                if ( readyList ) {
+                        // Execute all of them
+                        var fn, i = 0;
+                        while ( (fn = readyList[ i++ ]) ) {
+                                fn.call( document, jQuery );
+                        }
+
+                        // Reset the list of functions
+                        readyList = null;
+                }
+
+                // Trigger any bound ready events
+                if ( jQuery.fn.triggerHandler ) {
+                        jQuery( document ).triggerHandler( "ready" );
+                }
+            }
+        },
 
 	bindReady: function() {
 		if ( readyBound ) {
@@ -817,4 +839,19 @@ function doScrollCheck() {
 // Expose jQuery to the global object
 window.jQuery = window.$ = jQuery;
 
+// Integrate with require
+if (useRequire) {
+    // Register script load completion callback
+    require.callReady = function() {
+        // If require has its own ready callback functionality, call it.
+        if ( requireReadyCallback ) {
+            requireReadyCallback();
+        }
+        jQuery.callReady();
+    };
+
+    // Register jQuery as a module
+    require.def("jquery", function() { return jQuery; });
+}
+
 })();

test/require/data/dimple.js

@@ -0,0 +1,5 @@
+require.def("dimple",
+  {
+    color: "dimple-blue"
+  }
+);

test/require/data/dos.js

@@ -0,0 +1,13 @@
+require.def("dos",
+  ["tres"],
+  function(tres) {
+    return {
+      name: "dos",
+      doSomething: function() {
+        return {
+          tresName: tres.name
+        };
+      }
+    };
+  }
+);

test/require/data/epsilon.js

@@ -0,0 +1,7 @@
+"use strict";
+/*global require: false */
+require.def("epsilon",
+    {
+        name: "epsilon"
+    }
+);

test/require/data/func.js

@@ -0,0 +1,7 @@
+require.def("func",
+    function () {
+        return function () {
+            return "You called a function";
+        }
+    }
+);

test/require/data/funcFour.js

@@ -0,0 +1,14 @@
+require.def("funcFour",
+    ["require", "funcThree"],
+    function (require) {
+        var four = function (arg) {
+            return "FOUR called with " + arg;
+        };
+
+        four.suffix = function () {
+            return require("funcThree").suffix();
+        };
+
+        return four;
+    }
+);

test/require/data/funcOne.js

@@ -0,0 +1,15 @@
+require.def("funcOne",
+    ["require", "funcTwo"],
+    function (require) {
+        var one = function (name) {
+            this.name = name;
+        };
+
+        one.prototype.getName = function () {
+            var inst = new (require("funcTwo"))("-NESTED");
+            return this.name + inst.name;
+        };
+
+        return one;
+    }
+);

test/require/data/funcThree.js

@@ -0,0 +1,14 @@
+require.def("funcThree",
+    ["funcFour"],
+    function (four) {
+        var three = function (arg) {
+            return arg + "-" + require("funcFour").suffix();
+        };
+
+        three.suffix = function () {
+            return "THREE_SUFFIX";
+        };
+        
+        return three;
+    }
+);

test/require/data/funcTwo.js

@@ -0,0 +1,15 @@
+require.def("funcTwo",
+    ["funcOne"],
+    function () {
+        var two = function (name) {
+            this.name = name;
+            this.one = new (require("funcOne"))("ONE");
+        };
+    
+        two.prototype.oneName = function () {
+            return this.one.getName();
+        };
+
+        return two;
+    }
+);

test/require/data/layer1.js

@@ -0,0 +1,38 @@
+//Example layer file.
+
+"use strict";
+/*global require: false */
+
+require.pause();
+
+require.def("alpha",
+    ["beta", "gamma"],
+    function (beta, gamma) {
+        return {
+            name: "alpha",
+            betaName: beta.name
+        };
+    }
+);
+
+require.def("beta",
+    ["gamma"],
+    function (gamma) {
+        return {
+            name: "beta",
+            gammaName: gamma.name
+        };
+    }
+);
+
+require.def("gamma",
+    ["epsilon"],
+    function (epsilon) {
+        return {
+            name: "gamma",
+            epsilonName: epsilon.name
+        };
+    }
+);
+
+require.resume();