Validation for lifecycle hooks (#58)

Resolves #34

Author: ssutar

transforms/ember-object/__testfixtures__/decorators.invalid.input.js

@@ -41,3 +41,12 @@ const Foo = EmberObject.extend({
     return true;
   }).meta({ type: "Property" })
 });
+
+// Do not transform as action name matches lifecycle hook
+const Foo = EmberObject.extend({
+  actions: {
+    click() {
+      this.set("clicked", true);
+    }
+  }
+});

transforms/ember-object/__testfixtures__/decorators.invalid.output.js

@@ -41,3 +41,12 @@ const Foo = EmberObject.extend({
     return true;
   }).meta({ type: "Property" })
 });
+
+// Do not transform as action name matches lifecycle hook
+const Foo = EmberObject.extend({
+  actions: {
+    click() {
+      this.set("clicked", true);
+    }
+  }
+});

transforms/helpers/util.js

@@ -69,6 +69,92 @@ const ACTION_SUPER_EXPRESSION_COMMENT = [
   " for more details."
 ];
 
+const LIFECYCLE_HOOKS = [
+  // Methods
+  "$",
+  "addObserver",
+  "cacheFor",
+  "decrementProperty",
+  "destroy",
+  "didReceiveAttrs",
+  "didRender",
+  "didUpdate",
+  "didUpdateAttrs",
+  "get",
+  "getProperties",
+  "getWithDefault",
+  "has",
+  "incrementProperty",
+  "init",
+  "notifyPropertyChange",
+  "off",
+  "on",
+  "one",
+  "readDOMAttr",
+  "removeObserver",
+  "rerender",
+  "send",
+  "set",
+  "setProperties",
+  "toString",
+  "toggleProperty",
+  "trigger",
+  "willDestroy",
+  "willRender",
+  "willUpdate",
+
+  // Events
+  "didInsertElement",
+  "didReceiveAttrs",
+  "didRender",
+  "didUpdate",
+  "didUpdateAttrs",
+  "willClearRender",
+  "willDestroyElement",
+  "willInsertElement",
+  "willRender",
+  "willUpdate",
+
+  // Touch events
+  "touchStart",
+  "touchMove",
+  "touchEnd",
+  "touchCancel",
+
+  // Keyboard events
+  "keyDown",
+  "keyUp",
+  "keyPress",
+
+  // Mouse events
+  "mouseDown",
+  "mouseUp",
+  "contextMenu",
+  "click",
+  "doubleClick",
+  "mouseMove",
+  "focusIn",
+  "focusOut",
+  "mouseEnter",
+  "mouseLeave",
+
+  // Form events
+  "submit",
+  "change",
+  "focusIn",
+  "focusOut",
+  "input",
+
+  // HTML5 drag and drop events
+  "dragStart",
+  "drag",
+  "dragEnter",
+  "dragLeave",
+  "dragOver",
+  "dragEnd",
+  "drop"
+];
+
 /**
  * Get a property from and object, useful to get nested props without checking for null values
  *
@@ -224,6 +310,7 @@ module.exports = {
   isClassDecoratorProp,
   LAYOUT_DECORATOR_LOCAL_NAME,
   LAYOUT_DECORATOR_NAME,
+  LIFECYCLE_HOOKS,
   METHOD_DECORATORS,
   shouldSetValue,
   startsWithUpperCaseLetter

transforms/helpers/validation-helper.js

@@ -1,4 +1,5 @@
 const minimatch = require("minimatch");
+const { LIFECYCLE_HOOKS, get, getPropName } = require("./util");
 
 const UNSUPPORTED_PROP_NAMES = ["actions", "layout"];
 
@@ -69,6 +70,10 @@ function hasValidProps(
       );
     }
 
+    if (instanceProp.isAction) {
+      errors = errors.concat(getLifecycleHookErrors(instanceProp));
+    }
+
     if (
       (!decorators &&
         (instanceProp.hasDecorators || instanceProp.isClassDecorator)) ||
@@ -103,6 +108,26 @@ function hasValidProps(
   }, []);
 }
 
+/**
+ * Iterate over actions and verify that the action name does not match the lifecycle hooks
+ * The transformation is not supported if an action has the same name as lifecycle hook
+ * Reference: https://github.com/scalvert/ember-es6-class-codemod/issues/34
+ *
+ * @param {EOProp} actionsProp
+ */
+function getLifecycleHookErrors(actionsProp) {
+  const actionProps = get(actionsProp, "value.properties");
+  return actionProps.reduce((errors, actionProp) => {
+    const actionName = getPropName(actionProp);
+    if (actionName && LIFECYCLE_HOOKS.includes(actionName)) {
+      errors.push(
+        `[${actionName}]: Transform not supported - action name matches one of the lifecycle hooks. Rename and try again. See https://github.com/scalvert/ember-es6-class-codemod/issues/34 for more details`
+      );
+    }
+    return errors;
+  }, []);
+}
+
 /**
  * Returns true if object extends mixin
  *