Merge pull request #28 from chadhietala/add-destructuring

Adding generic way to detect destructured Ember object

Author: chadhietala

lib/rules/no-lifecycle-events.js

@@ -8,12 +8,24 @@ function isEmber(node) {
   return node.name === 'Ember';
 }
 
+const { collectObjectPatternBindings } = require('../utils/destructed-binding');
+const { getEmberImportBinding } = require('../utils/imports');
+
 module.exports = {
   meta: {
     message: MESSAGE
   },
   create(context) {
+    var emberImportBinding;
+    let destructedBindings = [];
     return {
+      ObjectPattern(node) {
+        if (emberImportBinding) {
+          destructedBindings = destructedBindings.concat(collectObjectPatternBindings(node, {
+            [emberImportBinding]: ['on']
+          }));
+        }
+      },
 
       ImportDeclaration(node) {
         if (node.source.value === '@ember/object/evented') {
@@ -25,6 +37,10 @@ module.exports = {
         }
       },
 
+      ImportDefaultSpecifier(node) {
+        emberImportBinding = getEmberImportBinding(node);
+      },
+
       FunctionExpression(node) {
         if (node.parent.property && isOn(node.parent.property)) {
           context.report(node, MESSAGE);
@@ -39,15 +55,9 @@ module.exports = {
 
       CallExpression(node) {
         if (isOn(node.callee)) {
-          context.getScope().variables.forEach((v) => {
-            if (isOn(v)) {
-              v.defs.forEach((defNode) => {
-                if (defNode.node.type === 'VariableDeclarator' && isEmber(defNode.node.init)) {
-                  context.report(node, MESSAGE);
-                }
-              });
-            }
-          });
+          if (destructedBindings.includes(node.callee.name)) {
+            context.report(node, MESSAGE);
+          }
         }
       }
     };

lib/rules/no-side-effect-cp.js

@@ -1,8 +1,9 @@
 const { getCaller, cleanCaller } = require('../utils/caller');
 const isCPGetter = require('../utils/computed-property');
-const collectImportBindings = require('../utils/imports');
+const { getEmberImportBinding, collectImportBindings } = require('../utils/imports');
+const { collectObjectPatternBindings } = require('../utils/destructed-binding');
 
-const SIDE_EFFECTS = ['this.send', 'this.sendAction', 'this.sendEvent', 'Em.sendEvent', 'Ember.sendEvent', 'this.trigger', 'this.set', 'Ember.set', 'Em.set', 'this.setProperties', 'Ember.setProperties', 'Em.setProperties'];
+let SIDE_EFFECTS = ['this.send', 'this.sendAction', 'this.sendEvent', 'Em.sendEvent', 'Ember.sendEvent', 'this.trigger', 'this.set', 'Ember.set', 'Em.set', 'this.setProperties', 'Ember.setProperties', 'Em.setProperties'];
 
 const MESSAGE = 'Do not send events or actions in Computed Properties. This will cause data flow issues in the application, where the accessing of a property causes some side-effect. You should only send actions on behalf of user initiated events. Please see the following guide for more infromation: https://github.com/chadhietala/ember-best-practices/blob/master/guides/rules/no-action-cp.md';
 
@@ -12,8 +13,7 @@ module.exports = {
   },
   create(context) {
     let inCPGettter = false;
-    let bindings;
-
+    let bindings, emberImportBinding;
     return {
       ImportDeclaration(node) {
         bindings = collectImportBindings(node, {
@@ -22,6 +22,18 @@ module.exports = {
         });
       },
 
+      ObjectPattern(node) {
+        if (emberImportBinding) {
+          SIDE_EFFECTS = SIDE_EFFECTS.concat(collectObjectPatternBindings(node, {
+            [emberImportBinding]: ['set', 'setProperties', 'sendEvent']
+          }));
+        }
+      },
+
+      ImportDefaultSpecifier(node) {
+        emberImportBinding = getEmberImportBinding(node);
+      },
+
       FunctionExpression(node) {
         if (isCPGetter(node)) {
           inCPGettter = true;

lib/utils/destructed-binding.js

@@ -0,0 +1,21 @@
+const { get } = require('./get');
+
+function collectObjectPatternBindings(node, initialObjToBinding) {
+  let identifiers = Object.keys(initialObjToBinding);
+  let objBindingName = get(node, 'parent.init.name');
+  let bindingIndex = identifiers.indexOf(objBindingName);
+  if (bindingIndex > -1) {
+    let binding = identifiers[bindingIndex];
+    return node.properties.filter(({ key }) => {
+      return initialObjToBinding[binding].includes(key.name);
+    }).map(({ value }) => {
+      return value.name;
+    });
+  }
+
+  return [];
+}
+
+module.exports = {
+  collectObjectPatternBindings
+};

lib/utils/imports.js

@@ -1,4 +1,6 @@
-module.exports = function collectImportBindings(node, imports) {
+const { get } = require('./get');
+
+function collectImportBindings(node, imports) {
   let sources = Object.keys(imports);
   let sourceName = sources[sources.indexOf(node.source.value)];
   let importedBindings = imports[sourceName];
@@ -10,4 +12,15 @@ module.exports = function collectImportBindings(node, imports) {
   }
 
   return [];
+}
+
+function getEmberImportBinding(node) {
+  if (get(node, 'parent.source.raw') === '\'ember\'') {
+    return node.local.name;
+  }
+}
+
+module.exports = {
+  collectImportBindings,
+  getEmberImportBinding
 };

tests/lib/rules/no-lifecycle-events.js

@@ -40,6 +40,7 @@ ruleTester.run('no-lifecycle-events', rule, {
     },
     {
       code: `
+        import Ember from 'ember';
         const { on } = Ember;
         export default Ember.Component({
           registerFocus: on('didInsertElement', function() {