[BUGFIX beta] Adds a deprecation message when targetObject is set or …

…used
emberjs · Nov 19, 2016 · a2930ef · a2930ef
1 parent 56ac120
commit a2930ef
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 3 deletions.
diff --git a/packages/ember-runtime/lib/mixins/target_action_support.js b/packages/ember-runtime/lib/mixins/target_action_support.js
@@ -8,7 +8,8 @@ import {
   assert,
   get,
   Mixin,
-  computed
+  computed,
+  deprecate
 } from 'ember-metal';
 
 /**
@@ -24,6 +25,19 @@ doing more complex event handling in Components.
 @private
 */
 export default Mixin.create({
+  init() {
+    this._super(...arguments);
+    if (this.targetObject) {
+      deprecate(
+        'Setting `targetObject` is deprecated. Please use `target` instead.',
+        false,
+        {
+          id: 'ember-runtime.setting-targetObject',
+          until: '2.12.0'
+        }
+      );
+    }
+  },
   target: null,
   action: null,
   actionContext: null,
@@ -136,11 +150,20 @@ export default Mixin.create({
 });
 
 function getTarget(instance) {
-  // TODO: Deprecate specifying `targetObject`
   let target = get(instance, 'targetObject');
 
   // if a `targetObject` CP was provided, use it
-  if (target) { return target; }
+  if (target) {
+    deprecate(
+      'Using `targetObject` is deprecated. Please use `target` instead.',
+      false,
+      {
+        id: 'ember-runtime.using-targetObject',
+        until: '2.12.0'
+      }
+    );
+    return target;
+  }
 
   // if _targetObject use it
   if (instance._targetObject) { return instance._targetObject; }

diff --git a/packages/ember-runtime/tests/mixins/target_action_support_test.js b/packages/ember-runtime/tests/mixins/target_action_support_test.js
@@ -89,6 +89,25 @@ QUnit.test('it should use an actionContext object specified as a property on the
   ok(true === obj.triggerAction(), 'a valid target and action were specified');
 });
 
+QUnit.test('it should raise a deprecation warning when a targetObject is specified and used', function() {
+  expect(4);
+  let obj;
+  expectDeprecation(() => {
+    obj = EmberObject.extend(TargetActionSupport).create({
+      action: 'anEvent',
+      actionContext: {},
+      targetObject: EmberObject.create({
+        anEvent(ctx) {
+          ok(obj.actionContext === ctx, 'anEvent method was called with the expected context');
+        }
+      })
+    });
+  }, /Setting `targetObject` is deprecated. Please use `target` instead./);
+  expectDeprecation(() => {
+    ok(true === obj.triggerAction(), 'a valid targetObject and action were specified');
+  }, /Using `targetObject` is deprecated. Please use `target` instead./);
+});
+
 QUnit.test('it should find an actionContext specified as a property path', function() {
   expect(2);