Deferred: Deprecate deferred.pipe() method

dmethvin · dmethvin · commit 7691f7f68867 · 2015-03-12T15:32:51.000-04:00
Ref #89
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -27,6 +27,7 @@ module.exports = function(grunt) {
 			"src/manipulation.js",
 			"src/event.js",
 			"src/traversing.js",
+			"src/deferred.js",
 			"src/outro.js"
 		],
 		tests: {
diff --git a/src/deferred.js b/src/deferred.js
@@ -0,0 +1,13 @@
+
+var oldDeferred = jQuery.Deferred;
+
+jQuery.Deferred = function() {
+	var deferred = oldDeferred.apply( this, arguments );
+
+	deferred.pipe = function() {
+		migrateWarn( "deferred.pipe() is deprecated" );
+		return deferred.then.apply( this, arguments );
+	};
+	
+	return deferred;
+};
diff --git a/test/deferred.js b/test/deferred.js
@@ -0,0 +1,21 @@
+
+module("deferred");
+
+test( ".pipe()", function() {
+	expect( 4 );
+
+	var d = jQuery.Deferred().resolve( 1 );
+
+	expectNoWarning( "then", function() {
+		d.then(function( v ) {
+			equal( v, 1, "got correct value" );
+		});	});
+
+	expectWarning( "pipe", function() {
+		d.pipe(function( v ) {
+			equal( v, 1, "got correct value" );
+		});
+	});
+		
+});
+
diff --git a/test/index.html b/test/index.html
@@ -40,6 +40,7 @@
 	<script src="ajax.js"></script>
 	<script src="event.js"></script>
 	<script src="traversing.js"></script>
+	<script src="deferred.js"></script>
 </head>
 <body>
 	<div id="qunit"></div>
diff --git a/warnings.md b/warnings.md
@@ -148,6 +148,12 @@ $(document).ajaxStart(function(){ $("#status").text("Ajax started"); });
 
 **Solution**: Boolean properties should generally not be passed to `$().attr` at all; replace with `$().prop` unless you truly intend to update the underlying HTML *attribute*.
 
+### JQMIGRATE: deferred.pipe() is deprecated
+
+**Cause**: The `.pipe()` method on a `jQuery.Deferred` object was deprecated as of jQuery 1.8, when the `.then()` method was changed to perform the same function.
+
+**Solution**: Change all occurrences of `.pipe()` to `.then()`.
+
 ### JQMIGRATE: jQuery.clean() is deprecated
 
 **Cause**: `jQuery.buildFragment()` and `jQuery.clean()` are undocumented internal methods. The signature of `jQuery.buildFragment()` was changed in jQuery 1.8 and 1.9, and `jQuery.clean()` was removed in 1.9. However, we are aware of some plugins or other code that may be using them.
