Handle decorator modifiers (#16)

This handles the computed modifiers mentioned in the #15

Author: ssutar

package-lock.json

@@ -1,4 +1,10 @@
-import { alias, sum as add } from "@ember/object/computed";
+import {
+  alias,
+  readOnly,
+  reads,
+  oneWay as enoWay,
+  sum as add
+} from "@ember/object/computed";
 import { get, set, observer as watcher, computed } from "@ember/object";
 import { inject as controller } from "@ember/controller";
 import { inject as service } from "@ember/service";
@@ -59,22 +65,42 @@ const Foo = EmberObject.extend({
       this.set("lastName", lastName);
       return value;
     }
-  }),
-
+  }).readOnly(),
   /**
   Computed description
   */
   description: computed("fullName", "age", "country", function() {
     return `${this.get(
       "fullName"
     )}; Age: ${this.get("age")}; Country: ${this.get("country")}`;
-  }),
+  })
+    .volatile()
+    .readOnly(),
 
   /**
    * Fname
    */
   fName: alias("firstName"),
 
+  /**
+   * Fname1
+   */
+  fName1: alias("firstName"),
+
+  /**
+   * Fname2
+   */
+  fName2: computed("firstName", "lastName", function() {
+    return true;
+  }).readOnly(),
+
+  /**
+   * Fname3
+   */
+  fName3: computed("firstName", "lastName", function() {
+    return true;
+  }).volatile(),
+
   /**
    * Lname
    */
@@ -83,7 +109,27 @@ const Foo = EmberObject.extend({
   /**
    * Lname1
    */
-  lName1: add("description", "lastName").volatile()
+  lName1: add("description", "lastName"),
+
+  /**
+   * Lname2
+   */
+  lName2: readOnly("description"),
+
+  /**
+   * Lname3
+   */
+  lName3: reads("description", "lastName"),
+
+  /**
+   * Lname4
+   */
+  lName4: enoWay("description", "lastName"),
+
+  /**
+   * Lname5
+   */
+  lName5: add("description", "lastName").readOnly()
 });
 
 const Foo = EmberObject.extend({

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

@@ -8,3 +8,36 @@ const Foo = EmberObject.extend({
 const Foo = EmberObject.extend({
   macroValue: macro()
 });
+
+// Do not transform as a computed property has readOnly and volatile with meta
+const Foo = EmberObject.extend({
+  firstName: "",
+  lastName: "",
+
+  fName2: computed("firstName", "lastName", function() {
+    return true;
+  })
+    .property("baz")
+    .readOnly()
+    .volatile()
+    .meta({ type: "Property" })
+});
+
+// Do not transform as a computed meta has volatile
+const Foo = EmberObject.extend({
+  lName1: add("description", "lastName").volatile()
+});
+
+// Do not transform as computed prop has `property`
+const Foo = EmberObject.extend({
+  fName2: computed("firstName", "lastName", function() {
+    return true;
+  }).property("baz")
+});
+
+// Do not transform as computed prop has `meta`
+const Foo = EmberObject.extend({
+  fName2: computed("firstName", "lastName", function() {
+    return true;
+  }).meta({ type: "Property" })
+});

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

@@ -8,3 +8,36 @@ const Foo = EmberObject.extend({
 const Foo = EmberObject.extend({
   macroValue: macro()
 });
+
+// Do not transform as a computed property has readOnly and volatile with meta
+const Foo = EmberObject.extend({
+  firstName: "",
+  lastName: "",
+
+  fName2: computed("firstName", "lastName", function() {
+    return true;
+  })
+    .property("baz")
+    .readOnly()
+    .volatile()
+    .meta({ type: "Property" })
+});
+
+// Do not transform as a computed meta has volatile
+const Foo = EmberObject.extend({
+  lName1: add("description", "lastName").volatile()
+});
+
+// Do not transform as computed prop has `property`
+const Foo = EmberObject.extend({
+  fName2: computed("firstName", "lastName", function() {
+    return true;
+  }).property("baz")
+});
+
+// Do not transform as computed prop has `meta`
+const Foo = EmberObject.extend({
+  fName2: computed("firstName", "lastName", function() {
+    return true;
+  }).meta({ type: "Property" })
+});

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

@@ -1,11 +1,13 @@
-import { sum as add, alias } from "@ember-decorators/object/computed";
+import { sum as add, overridableReads as enoWay, overridableReads, reads, alias } from "@ember-decorators/object/computed";
 import { get, set } from "@ember/object";
 import { computed, observes as watcher } from "@ember-decorators/object";
 import { controller } from "@ember-decorators/controller";
 import { service } from "@ember-decorators/service";
 import { on } from "@ember-decorators/object/evented";
 import layout from "components/templates/foo";
 
+import { volatile, readOnly } from "@ember-decorators/object";
+
 @tagName("div")
 @classNames(["test-class", "custom-class"])
 class Foo extends EmberObject {
@@ -67,11 +69,12 @@ class Foo extends EmberObject {
   Computed fullname
   */
   @computed("firstName", "lastName")
-  get fullName(key) {
+  @readOnly
+  get fullName() {
     return `${this.get("firstName")} ${this.get("lastName")}`;
   }
 
-  set fullName(key, value) {
+  set fullName(value) {
     let [firstName, lastName] = value.split(/\s+/);
     this.set("firstName", firstName);
     this.set("lastName", lastName);
@@ -81,7 +84,6 @@ class Foo extends EmberObject {
   /**
   Computed description
   */
-  @computed("fullName", "age", "country")
   get description() {
     return `${this.get(
       "fullName"
@@ -94,18 +96,68 @@ class Foo extends EmberObject {
   @alias("firstName")
   fName;
 
+  /**
+   * Fname1
+   */
+  @alias("firstName")
+  fName1;
+
+  /**
+   * Fname2
+   */
+  @computed("firstName", "lastName")
+  @readOnly
+  get fName2() {
+    return true;
+  }
+
+  /**
+   * Fname3
+   */
+  @computed("firstName", "lastName")
+  @volatile
+  get fName3() {
+    return true;
+  }
+
   /**
    * Lname
    */
-  @alias.readOnly("firstName", "lastName")
+  @alias("firstName", "lastName")
+  @readOnly
   lName;
 
   /**
    * Lname1
    */
-  @add.volatile("description", "lastName")
+  @add("description", "lastName")
   lName1;
+
+  /**
+   * Lname2
+   */
+  @reads("description")
+  lName2;
+
+  /**
+   * Lname3
+   */
+  @overridableReads("description", "lastName")
+  lName3;
+
+  /**
+   * Lname4
+   */
+  @enoWay("description", "lastName")
+  lName4;
+
+  /**
+   * Lname5
+   */
+  @add("description", "lastName")
+  @readOnly
+  lName5;
 }
 
 @layout(layout)
-class Foo extends EmberObject {}
+class Foo extends EmberObject {}

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

@@ -1,16 +1,11 @@
 const { getOptions } = require("codemod-cli");
 const { replaceEmberObjectExpressions } = require("../helpers/parse-helper");
 
-module.exports = function transformer(file, api, options) {
+module.exports = function transformer(file, api) {
   const j = api.jscodeshift;
   const root = j(file.source);
 
-  replaceEmberObjectExpressions(
-    j,
-    root,
-    file.path,
-    Object.assign({}, options, getOptions())
-  );
+  replaceEmberObjectExpressions(j, root, file.path, getOptions());
 
   return root.toSource();
 };

transforms/ember-object/index.js

@@ -2,9 +2,8 @@ const {
   get,
   getPropName,
   getPropType,
-  getPropCalleeName,
-  isClassDecoratorProp,
-  METHOD_DECORATORS
+  getModifier,
+  isClassDecoratorProp
 } = require("./util");
 
 /**
@@ -16,6 +15,7 @@ class EOProp {
   constructor(eoProp) {
     this._prop = eoProp;
     this.decoratorNames = [];
+    this.modifiers = [];
   }
 
   get value() {
@@ -43,7 +43,7 @@ class EOProp {
   }
 
   get calleeName() {
-    return getPropCalleeName(this._prop);
+    return get(this.calleeObject, "callee.name");
   }
 
   get comments() {
@@ -67,19 +67,53 @@ class EOProp {
   }
 
   get callExprArgs() {
-    return get(this._prop, "value.arguments") || [];
+    return get(this.calleeObject, "arguments") || [];
   }
 
   get hasNonLiteralArg() {
     return this.callExprArgs.some(arg => arg.type !== "Literal");
   }
 
+  get hasModifierWithArgs() {
+    return this.modifiers.some(modifier => modifier.args.length);
+  }
+
+  get hasVolatile() {
+    return this.modifiers.some(
+      modifier => get(modifier, "prop.name") === "volatile"
+    );
+  }
+
+  get hasReadOnly() {
+    return this.modifiers.some(
+      modifier => get(modifier, "prop.name") === "readOnly"
+    );
+  }
+
+  get isVolatileReadOnly() {
+    return this.modifiers.length === 2 && this.hasVolatile && this.hasReadOnly;
+  }
+
+  setCallExpressionProps() {
+    let calleeObject = get(this._prop, "value");
+    const modifiers = [getModifier(calleeObject)];
+    while (get(calleeObject, "callee.type") === "MemberExpression") {
+      calleeObject = get(calleeObject, "callee.object");
+      modifiers.push(getModifier(calleeObject));
+    }
+    this.calleeObject = calleeObject;
+    this.modifiers = modifiers.reverse();
+    this.modifiers.shift();
+  }
+
   setDecorators(importedDecoratedProps) {
     if (this.isCallExpression) {
-      const { decoratorName, importedName } =
+      this.setCallExpressionProps();
+      const { decoratorName, isMethodDecorator, isMetaDecorator } =
         importedDecoratedProps[this.calleeName] || {};
       if (decoratorName) {
-        this.hasMethodDecorator = METHOD_DECORATORS.includes(importedName);
+        this.hasMethodDecorator = isMethodDecorator;
+        this.hasMetaDecorator = isMetaDecorator;
         this.decoratorNames.push(decoratorName);
       }
     }