Skip to content

Commit

Permalink
Merge pull request #909 from bmish/computed-property-import-checks
Browse files Browse the repository at this point in the history 
Check imports when detecting computed properties in many rules
  • Loading branch information
@bmish
bmish committed Aug 9, 2020
2 parents 1cad4d0 + 98090d5 commit 0e44781
Show file tree
Hide file tree
Showing 24 changed files with 477 additions and 170 deletions.
19 changes: 18 additions & 1 deletion lib/rules/computed-property-getters.js
View file
Expand Up @@ -2,6 +2,7 @@

const ember = require('../utils/ember');
const types = require('../utils/types');
const { getImportIdentifier } = require('../utils/import');

//------------------------------------------------------------------------------
// General rule - Prevent using a getter inside computed properties.
Expand Down Expand Up @@ -94,9 +95,25 @@ module.exports = {
}
};

let importedEmberName;
let importedComputedName;

return {
ImportDeclaration(node) {
if (node.source.value === 'ember') {
importedEmberName = importedEmberName || getImportIdentifier(node, 'ember');
}
if (node.source.value === '@ember/object') {
importedComputedName =
importedComputedName || getImportIdentifier(node, '@ember/object', 'computed');
}
},

CallExpression(node) {
if (ember.isComputedProp(node) && node.arguments.length > 0) {
if (
ember.isComputedProp(node, importedEmberName, importedComputedName) &&
node.arguments.length > 0
) {
if (requireGetters === 'always-with-setter') {
requireGetterOnlyWithASetterInComputedProperty(node);
}
Expand Down
18 changes: 17 additions & 1 deletion lib/rules/no-arrow-function-computed-properties.js
View file
Expand Up @@ -2,6 +2,7 @@

const types = require('../utils/types');
const emberUtils = require('../utils/ember');
const { getImportIdentifier } = require('../utils/import');

const ERROR_MESSAGE = 'Do not use arrow functions in computed properties';

Expand Down Expand Up @@ -37,7 +38,20 @@ module.exports = {

let isThisPresent = false;

let importedEmberName;
let importedComputedName;

return {
ImportDeclaration(node) {
if (node.source.value === 'ember') {
importedEmberName = importedEmberName || getImportIdentifier(node, 'ember');
}
if (node.source.value === '@ember/object') {
importedComputedName =
importedComputedName || getImportIdentifier(node, '@ember/object', 'computed');
}
},

ThisExpression() {
isThisPresent = true;
},
Expand All @@ -46,7 +60,9 @@ module.exports = {
},
'CallExpression:exit'(node) {
const isComputedArrow =
emberUtils.isComputedProp(node) &&
emberUtils.isComputedProp(node, importedEmberName, importedComputedName, {
includeMacro: true,
}) &&
node.arguments.length > 0 &&
types.isArrowFunctionExpression(node.arguments[node.arguments.length - 1]);

Expand Down
19 changes: 15 additions & 4 deletions lib/rules/no-deeply-nested-dependent-keys-with-each.js
View file
@@ -1,6 +1,7 @@
'use strict';

const emberUtils = require('../utils/ember');
const { getImportIdentifier } = require('../utils/import');

//------------------------------------------------------------------------------
// Rule Definition
Expand All @@ -26,12 +27,22 @@ module.exports = {
ERROR_MESSAGE,

create(context) {
let importedEmberName;
let importedComputedName;

return {
ImportDeclaration(node) {
if (node.source.value === 'ember') {
importedEmberName = importedEmberName || getImportIdentifier(node, 'ember');
}
if (node.source.value === '@ember/object') {
importedComputedName =
importedComputedName || getImportIdentifier(node, '@ember/object', 'computed');
}
},

CallExpression(node) {
if (
emberUtils.isComputedProp(node) &&
(!node.callee.property || node.callee.property.name === 'computed')
) {
if (emberUtils.isComputedProp(node, importedEmberName, importedComputedName)) {
emberUtils.parseDependentKeys(node).forEach((key) => {
const parts = key.split('.');
const indexOfAtEach = parts.indexOf('@each');
Expand Down
16 changes: 15 additions & 1 deletion lib/rules/no-duplicate-dependent-keys.js
View file
Expand Up @@ -4,6 +4,7 @@ const emberUtils = require('../utils/ember');
const types = require('../utils/types');
const fixerUtils = require('../utils/fixer');
const javascriptUtils = require('../utils/javascript');
const { getImportIdentifier } = require('../utils/import');

const ERROR_MESSAGE = 'Dependent keys should not be repeated';
//------------------------------------------------------------------------------
Expand All @@ -27,9 +28,22 @@ module.exports = {
ERROR_MESSAGE,

create(context) {
let importedEmberName;
let importedComputedName;

return {
ImportDeclaration(node) {
if (node.source.value === 'ember') {
importedEmberName = importedEmberName || getImportIdentifier(node, 'ember');
}
if (node.source.value === '@ember/object') {
importedComputedName =
importedComputedName || getImportIdentifier(node, '@ember/object', 'computed');
}
},

CallExpression(node) {
if (emberUtils.hasDuplicateDependentKeys(node)) {
if (emberUtils.hasDuplicateDependentKeys(node, importedEmberName, importedComputedName)) {
context.report({
node,
message: ERROR_MESSAGE,
Expand Down
16 changes: 15 additions & 1 deletion lib/rules/no-invalid-dependent-keys.js
View file
Expand Up @@ -2,6 +2,7 @@

const types = require('../utils/types');
const ember = require('../utils/ember');
const { getImportIdentifier } = require('../utils/import');

//------------------------------------------------------------------------------
// General rule - Dependent keys used for computed properties have to be valid.
Expand Down Expand Up @@ -56,9 +57,22 @@ module.exports = {
ERROR_MESSAGE_INVALID_CHARACTER,

create(context) {
let importedEmberName;
let importedComputedName;

return {
ImportDeclaration(node) {
if (node.source.value === 'ember') {
importedEmberName = importedEmberName || getImportIdentifier(node, 'ember');
}
if (node.source.value === '@ember/object') {
importedComputedName =
importedComputedName || getImportIdentifier(node, '@ember/object', 'computed');
}
},

CallExpression(node) {
if (!ember.isComputedProp(node) || types.isMemberExpression(node.callee)) {
if (!ember.isComputedProp(node, importedEmberName, importedComputedName)) {
return;
}

Expand Down
21 changes: 13 additions & 8 deletions lib/rules/no-side-effects.js
View file
@@ -1,11 +1,11 @@
'use strict';

const types = require('../utils/types');
const ember = require('../utils/ember');
const computedPropertyUtils = require('../utils/computed-properties');
const propertySetterUtils = require('../utils/property-setter');
const emberUtils = require('../utils/ember');
const Traverser = require('../utils/traverser');
const { getImportIdentifier } = require('../utils/import');

//------------------------------------------------------------------------------
// General rule - Don't introduce side-effects in computed properties
Expand Down Expand Up @@ -68,37 +68,42 @@ module.exports = {
ERROR_MESSAGE,

create(context) {
let emberImportAliasName;
let importedEmberName;
let importedComputedName;

const report = function (node) {
context.report(node, ERROR_MESSAGE);
};

return {
ImportDeclaration(node) {
if (!emberImportAliasName) {
emberImportAliasName = ember.getEmberImportAliasName(node);
if (node.source.value === 'ember') {
importedEmberName = importedEmberName || getImportIdentifier(node, 'ember');
}
if (node.source.value === '@ember/object') {
importedComputedName =
importedComputedName || getImportIdentifier(node, '@ember/object', 'computed');
}
},

CallExpression(node) {
if (!emberUtils.isComputedProp(node)) {
if (!emberUtils.isComputedProp(node, importedEmberName, importedComputedName)) {
return;
}

const computedPropertyBody = computedPropertyUtils.getComputedPropertyFunctionBody(node);

findSideEffects(computedPropertyBody, emberImportAliasName).forEach(report);
findSideEffects(computedPropertyBody, importedEmberName).forEach(report);
},

Identifier(node) {
if (!emberUtils.isComputedProp(node)) {
if (!emberUtils.isComputedProp(node, importedEmberName, importedComputedName)) {
return;
}

const computedPropertyBody = computedPropertyUtils.getComputedPropertyFunctionBody(node);

findSideEffects(computedPropertyBody, emberImportAliasName).forEach(report);
findSideEffects(computedPropertyBody, importedEmberName).forEach(report);
},
};
},
Expand Down
16 changes: 15 additions & 1 deletion lib/rules/no-volatile-computed-properties.js
View file
Expand Up @@ -2,6 +2,7 @@

const types = require('../utils/types');
const emberUtils = require('../utils/ember');
const { getImportIdentifier } = require('../utils/import');

const ERROR_MESSAGE = 'Do not use volatile computed properties';

Expand All @@ -21,12 +22,25 @@ module.exports = {
},

create(context) {
let importedEmberName;
let importedComputedName;

return {
ImportDeclaration(node) {
if (node.source.value === 'ember') {
importedEmberName = importedEmberName || getImportIdentifier(node, 'ember');
}
if (node.source.value === '@ember/object') {
importedComputedName =
importedComputedName || getImportIdentifier(node, '@ember/object', 'computed');
}
},

CallExpression(node) {
if (
types.isMemberExpression(node.callee) &&
types.isCallExpression(node.callee.object) &&
emberUtils.isComputedProp(node.callee.object) &&
emberUtils.isComputedProp(node.callee.object, importedEmberName, importedComputedName) &&
types.isIdentifier(node.callee.property) &&
node.callee.property.name === 'volatile'
) {
Expand Down
16 changes: 15 additions & 1 deletion lib/rules/require-computed-macros.js
View file
Expand Up @@ -5,6 +5,7 @@ const emberUtils = require('../utils/ember');
const propertyGetterUtils = require('../utils/property-getter');
const assert = require('assert');
const scopeReferencesThis = require('../utils/scope-references-this');
const { getImportIdentifier } = require('../utils/import');

//------------------------------------------------------------------------------
// Rule Definition
Expand Down Expand Up @@ -227,10 +228,23 @@ module.exports = {
});
}

let importedEmberName;
let importedComputedName;

return {
ImportDeclaration(node) {
if (node.source.value === 'ember') {
importedEmberName = importedEmberName || getImportIdentifier(node, 'ember');
}
if (node.source.value === '@ember/object') {
importedComputedName =
importedComputedName || getImportIdentifier(node, '@ember/object', 'computed');
}
},

// eslint-disable-next-line complexity
CallExpression(node) {
if (!emberUtils.isComputedProp(node)) {
if (!emberUtils.isComputedProp(node, importedEmberName, importedComputedName)) {
return;
}

Expand Down
17 changes: 2 additions & 15 deletions lib/rules/require-computed-property-dependencies.js
View file
Expand Up @@ -47,19 +47,6 @@ function isMemberExpression(node, objectName, propertyName) {
);
}

/**
* @param {ASTNode} node
* @param {string} importedEmberName
* @param {string} importedComputedName
* @returns {boolean}
*/
function isEmberComputed(node, importedEmberName, importedComputedName) {
return (
isIdentifier(node, importedComputedName) ||
isMemberExpression(node, importedEmberName, 'computed')
);
}

/**
* Checks if a node looks like: 'part1' + 'part2'
*
Expand Down Expand Up @@ -481,7 +468,7 @@ module.exports = {
},

Identifier(node) {
if (isEmberComputed(node, importedEmberName, importedComputedName)) {
if (emberUtils.isComputedProp(node, importedEmberName, importedComputedName)) {
checkComputedDependencies(node, [], {
importedEmberName,
importedGetName,
Expand All @@ -492,7 +479,7 @@ module.exports = {
},

CallExpression(node) {
if (isEmberComputed(node.callee, importedEmberName, importedComputedName)) {
if (emberUtils.isComputedProp(node, importedEmberName, importedComputedName)) {
checkComputedDependencies(node, node.arguments, {
importedEmberName,
importedGetName,
Expand Down
26 changes: 24 additions & 2 deletions lib/rules/require-return-from-computed.js
View file
@@ -1,6 +1,7 @@
'use strict';

const ember = require('../utils/ember');
const { getImportIdentifier } = require('../utils/import');

//------------------------------------------------------------------------------
// General rule - Always return a value from computed properties
Expand Down Expand Up @@ -46,12 +47,30 @@ module.exports = {
}
}

let importedEmberName;
let importedComputedName;

return {
ImportDeclaration(node) {
if (node.source.value === 'ember') {
importedEmberName = importedEmberName || getImportIdentifier(node, 'ember');
}
if (node.source.value === '@ember/object') {
importedComputedName =
importedComputedName || getImportIdentifier(node, '@ember/object', 'computed');
}
},

onCodePathStart(codePath) {
funcInfo = {
upper: funcInfo,
codePath,
shouldCheck: context.getAncestors().findIndex(ember.isComputedProp) > -1,
shouldCheck:
context
.getAncestors()
.findIndex((node) =>
ember.isComputedProp(node, importedEmberName, importedComputedName)
) > -1,
};
},

Expand All @@ -60,7 +79,10 @@ module.exports = {
},

'FunctionExpression:exit'(node) {
if (ember.isComputedProp(node.parent) || ember.isComputedProp(node.parent.parent.parent)) {
if (
ember.isComputedProp(node.parent, importedEmberName, importedComputedName) ||
ember.isComputedProp(node.parent.parent.parent, importedEmberName, importedComputedName)
) {
checkLastSegment(node);
}
},
Expand Down

0 comments on commit 0e44781

Please sign in to comment.