stop failing if dev includes 'curl' as the new apiName or 'define' as…

… the new defineName. also added some more tests to test that configuring apiName or defineName after loading curl works as expected.
cujojs · Jul 16, 2012 · 9964b1e · 9964b1e
1 parent 497779a
commit 9964b1e
Show file tree

Hide file tree

Showing 7 changed files with 155 additions and 58 deletions.
diff --git a/src/curl.js b/src/curl.js
@@ -16,7 +16,8 @@ var window;
 "use strict";
 	var
 		version = '0.6.4',
-		userCfg = global['curl'],
+		curlName = 'curl',
+		userCfg = global[curlName],
 		prevCurl,
 		prevDefine,
 		doc = global.document,
@@ -358,40 +359,42 @@ var window;
 		},
 
 		config: function (cfg) {
-			var hasCfg,
+			var hasCfg, defineName,
 				apiName, apiObj, defName, defObj, define;
 
 			hasCfg = cfg;
 
+			defineName = 'define';
+
 			if (!cfg) cfg = {};
 
 			// allow dev to rename/relocate curl() to another object
-			apiName = cfg['apiName'];
-			apiObj = cfg['apiContext'];
+			apiName = cfg['apiName'] || curlName;
+			apiObj = cfg['apiContext'] || global;
 			// if the dev is overwriting an existing curl()
-			if (apiObj || apiName ? (apiObj || global)[apiName] : prevCurl && hasCfg) {
-				throw new Error((apiName || 'curl') + ' already exists');
+			if (apiObj != global || apiName != curlName ? apiObj[apiName] : prevCurl && hasCfg) {
+				throw new Error(apiName + ' already exists');
 			}
-			(apiObj || global)[apiName || 'curl'] = _curl;
+			apiObj[apiName] = _curl;
 			// restore previous curl
-			if (prevCurl && hasCfg) global['curl'] = prevCurl;
+			if (prevCurl && hasCfg) global[curlName] = prevCurl;
 
 			// allow dev to rename/relocate define() to another object
-			defName = cfg['defineName'];
-			defObj = cfg['defineContext'];
-			if (defObj || defName ? (defObj || global)[defName] : prevDefine && hasCfg) {
-				throw new Error((defName|| 'define') + ' already exists');
+			defName = cfg['defineName'] || defineName;
+			defObj = cfg['defineContext'] || global;
+			if (defObj != global || defName != defineName ? defObj[defName] : prevDefine && hasCfg) {
+				throw new Error(defName + ' already exists');
 			}
-			(defObj || global)[defName || 'define'] = define = function () {
+			defObj[defName] = define = function () {
 				// wrap inner _define so it can be replaced without losing define.amd
 				var args = core.fixArgs(arguments);
 				_define(args);
 			};
 			// restore previous define
-			if (prevDefine && hasCfg) global['define'] = prevDefine;
+			if (prevDefine && hasCfg) global[defineName] = prevDefine;
 
 			// indicate our capabilities:
-			define['amd'] = { 'plugins': true, 'jQuery': true, 'curl': version };
+			define['amd'] = { 'plugins': true, 'jQuery': true, curlName: version };
 
 			// switch to re-runnable config
 			if (hasCfg) core.config = core.moreConfig;
@@ -1068,7 +1071,7 @@ var window;
 	core.checkPreloads(userCfg);
 
 	// allow curl to be a dependency
-	cache['curl'] = _curl;
+	cache[curlName] = _curl;
 
 	// expose curl core for special plugins and modules
 	// Note: core overrides will only work in either of two scenarios:

diff --git a/test/apiAfter.html b/test/apiAfter.html
@@ -0,0 +1,43 @@
+<!DOCTYPE HTML>
+<html>
+<head>
+<title>apiName/apiContext curl test file</title>
+
+<script>
+
+	// simulate existing curl
+	function existingCurl () {}
+	curl = existingCurl;
+
+</script>
+<script src="../src/curl.js" type="text/javascript"></script>
+
+<script type="text/javascript">
+
+var foo = {},
+	cfg = {
+		apiName: 'bar',
+		apiContext: foo,
+		paths: {
+			curl: '../src/curl/'
+		}
+	};
+	curl(
+		cfg,
+		[ 'stuff/three', 'domReady!' ]
+	).then(
+		function (three) {
+			var restoredPrev, createdNew;
+			restoredPrev = curl == existingCurl ? 'SUCCESS' : 'FAILED';
+			createdNew = foo && foo.bar && typeof foo.bar == 'function' && foo.bar.version ? 'SUCCESS' : 'FAILED';
+			document.body.appendChild(document.createElement('div')).innerHTML = restoredPrev + ' previous global curl restored';
+			document.body.appendChild(document.createElement('div')).innerHTML = createdNew + ' new custom curl created';
+		}
+	);
+
+</script>
+
+</head>
+<body>
+</body>
+</html>
diff --git a/test/apiConflict.html b/test/apiConflict.html
@@ -23,7 +23,7 @@
 	write('FAILED: curl should not overwrite global curl');
 }
 catch (ex) {
-	write('SUCCESS: curl should threw when it conflicted with no recourse: ' + ex.message);
+	write('SUCCESS: curl should throw when it conflicts with no recourse: ' + ex.message);
 }
 
 curl({

diff --git a/test/apiName.html b/test/apiName.html
@@ -4,11 +4,11 @@
 <title>apiName/apiContext curl test file</title>
 
 <script>
-    foo = {};
+	foo = {};
 
 	curl = {
-        apiName: 'bar',
-        apiContext: foo,
+		apiName: 'bar',
+		apiContext: foo,
 		paths: {
 			curl: '../src/curl/'
 		}
@@ -19,23 +19,23 @@
 
 <script type="text/javascript">
 
-    var contextifiedCurl = foo.bar;
-
-    if(typeof contextifiedCurl !== 'function') {
-        alert('api context foo.bar failed');
-    }
-    else {
-        contextifiedCurl(
-                [
-                    'stuff/three',
-					'domReady!'
-                ]
-        ).then(
-                function (three) {
-					document.body.appendChild(document.createTextNode('api context foo.bar SUCCESS'));
-                }
-        );
-    }
+	var contextifiedCurl = foo.bar;
+
+	if(typeof contextifiedCurl !== 'function') {
+		alert('api context foo.bar failed');
+	}
+	else {
+		contextifiedCurl(
+			[
+				'stuff/three',
+				'domReady!'
+			]
+		).then(
+			function (three) {
+				document.body.appendChild(document.createTextNode('api context foo.bar SUCCESS'));
+			}
+		);
+	}
 
 </script>
 

diff --git a/test/apiName2.html b/test/apiName2.html
@@ -4,10 +4,10 @@
 <title>apiName/apiContext curl test file</title>
 
 <script>
-    foo = {};
+	foo = {};
 
 	curl = {
-        apiName: 'bar',
+		apiName: 'require',
 		paths: {
 			curl: '../src/curl/'
 		}
@@ -16,29 +16,30 @@
 </script>
 <script src="../src/curl.js" type="text/javascript"></script>
 
+</head>
+<body>
+
 <script type="text/javascript">
 
-    var contextifiedCurl = window.bar;
-
-    if(typeof contextifiedCurl !== 'function') {
-        alert('api context foo.bar failed');
-    }
-    else {
-        contextifiedCurl(
-                [
-                    'stuff/three',
-					'domReady!'
-                ]
-        ).then(
-                function (three) {
-					document.body.appendChild(document.createTextNode('api context foo.bar SUCCESS'));
-                }
-        );
-    }
+	//var contextifiedCurl = require;
+
+	if(typeof require !== 'function') {
+		alert('api context foo.bar failed');
+	}
+	else {
+		require(
+			[
+				'stuff/three',
+				'domReady!'
+			]
+		).then(
+			function (three) {
+				document.body.appendChild(document.createTextNode('api context is foo.bar SUCCESS'));
+			}
+		);
+	}
 
 </script>
 
-</head>
-<body>
 </body>
 </html>
diff --git a/test/defineAfter.html b/test/defineAfter.html
@@ -0,0 +1,45 @@
+<!DOCTYPE HTML>
+<html>
+<head>
+<title>apiName/apiContext curl test file</title>
+
+<script>
+
+	// simulate existing define
+	function existingDefine () {}
+	define = existingDefine;
+
+</script>
+<script src="../src/curl.js" type="text/javascript"></script>
+
+</head>
+
+<body>
+</body>
+
+<script type="text/javascript">
+
+var foo = {},
+	cfg = {
+		defineName: 'bar',
+		defineContext: foo,
+		paths: {
+			curl: '../src/curl/'
+		}
+	};
+	curl(
+		cfg,
+		[ 'support/foo-bar-define/simple' ]
+	).then(
+		function (three) {
+			var restoredPrev, createdNew;
+			restoredPrev = define == existingDefine ? 'SUCCESS' : 'FAILED';
+			createdNew = foo && foo.bar && foo.bar.amd ? 'SUCCESS' : 'FAILED';
+			document.body.appendChild(document.createElement('div')).innerHTML = restoredPrev + ' previous global define() restored';
+			document.body.appendChild(document.createElement('div')).innerHTML = createdNew + ' new custom define() created';
+		}
+	);
+
+</script>
+
+</html>
diff --git a/test/support/foo-bar-define/simple.js b/test/support/foo-bar-define/simple.js
@@ -0,0 +1,5 @@
+foo.bar([], function () {
+
+	return 1;
+
+});