Merge pull request #1 from ember-codemods/add-test-fixture

Robert Jackson · web-flow · commit 055000f6a872 · 2021-02-20T12:03:26.000-05:00
add setup qunit dom transform
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,2 @@
+!.*
+__testfixtures__
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -0,0 +1,20 @@
+module.exports = {
+  parserOptions: {
+    ecmaVersion: 2018,
+  },
+
+  plugins: ['prettier', 'node'],
+  extends: ['eslint:recommended', 'plugin:prettier/recommended', 'plugin:node/recommended'],
+  env: {
+    node: true,
+  },
+  rules: {},
+  overrides: [
+    {
+      files: ['__tests__/**/*.js'],
+      env: {
+        jest: true,
+      },
+    },
+  ],
+};
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+/node_modules
+/.eslintcache
diff --git a/README.md b/README.md
@@ -1,2 +1,45 @@
 # ember-qunit-5-codemod
+
+
+A collection of codemods for ember-qunit-5-codemod. 
 Migrates applications using ember-qunit &lt; 5.0.0 to the new structure.
+
+## Usage
+
+To run a specific codemod from this project, you would run the following:
+
+```
+npx ember-qunit-5-codemod <TRANSFORM NAME> path/of/files/ or/some**/*glob.js
+
+# or
+
+yarn global add ember-qunit-5-codemod
+ember-qunit-5-codemod <TRANSFORM NAME> path/of/files/ or/some**/*glob.js
+```
+
+## Local Usage
+```
+node ./bin/cli.js <TRANSFORM NAME> path/of/files/ or/some**/*glob.js
+```
+
+## Transforms
+
+<!--TRANSFORMS_START-->
+* [setup-qunit-dom](transforms/setup-qunit-dom/README.md)
+<!--TRANSFORMS_END-->
+
+## Contributing
+
+### Installation
+
+* clone the repo
+* change into the repo directory
+* `yarn`
+
+### Running tests
+
+* `yarn test`
+
+### Update Documentation
+
+* `yarn update-docs`
diff --git a/bin/cli.js b/bin/cli.js
@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+'use strict';
+
+require('codemod-cli').runTransform(
+  __dirname,
+  process.argv[2] /* transform name */,
+  process.argv.slice(3) /* paths or globs */
+);
diff --git a/package.json b/package.json
@@ -0,0 +1,33 @@
+{
+  "name": "ember-qunit-5-codemod",
+  "version": "0.1.0",
+  "scripts": {
+    "lint": "eslint --cache .",
+    "test": "codemod-cli test",
+    "test:coverage": "codemod-cli test --coverage",
+    "update-docs": "codemod-cli update-docs",
+    "coveralls": "cat ./coverage/lcov.info | node node_modules/.bin/coveralls"
+  },
+  "bin": "./bin/cli.js",
+  "keywords": [
+    "codemod-cli"
+  ],
+  "dependencies": {
+    "codemod-cli": "^3.1.1"
+  },
+  "devDependencies": {
+    "coveralls": "^3.1.0",
+    "eslint": "^7.20.0",
+    "eslint-config-prettier": "^7.2.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^3.3.1",
+    "jest": "^26.6.3",
+    "prettier": "^2.2.1"
+  },
+  "engines": {
+    "node": "10.* || 12.* || >= 14"
+  },
+  "jest": {
+    "testEnvironment": "node"
+  }
+}
diff --git a/transforms/.gitkeep b/transforms/.gitkeep
diff --git a/transforms/setup-qunit-dom/README.md b/transforms/setup-qunit-dom/README.md
@@ -0,0 +1,89 @@
+# setup-qunit-dom
+
+
+## Usage
+
+```
+npx ember-qunit-5-codemod setup-qunit-dom path/of/files/ or/some**/*glob.js
+
+# or
+
+yarn global add ember-qunit-5-codemod
+ember-qunit-5-codemod setup-qunit-dom path/of/files/ or/some**/*glob.js
+```
+
+## Local Usage
+```
+node ./bin/cli.js setup-qunit-dom path/of/files/ or/some**/*glob.js
+```
+
+## Input / Output
+
+<!--FIXTURES_TOC_START-->
+* [basic](#basic)
+* [test-default-import-specifier](#test-default-import-specifier)
+<!--FIXTURES_TOC_END-->
+
+<!--FIXTURES_CONTENT_START-->
+---
+<a id="basic">**basic**</a>
+
+**Input** (<small>[basic.input.js](transforms/setup-qunit-dom/__testfixtures__/basic.input.js)</small>):
+```js
+import Application from 'insights-hub-web-fe/app'; 
+import config from 'insights-hub-web-fe/config/environment'; 
+import { setApplication } from '@ember/test-helpers'; 
+import { start } from 'ember-qunit'; 
+ 
+setApplication(Application.create(config.APP)); 
+ 
+start(); 
+```
+
+**Output** (<small>[basic.output.js](transforms/setup-qunit-dom/__testfixtures__/basic.output.js)</small>):
+```js
+import * as QUnit from 'qunit';
+import { setup } from 'qunit-dom';
+import Application from 'insights-hub-web-fe/app';
+import config from 'insights-hub-web-fe/config/environment';
+import { setApplication } from '@ember/test-helpers';
+import { start } from 'ember-qunit';
+
+setup(QUnit.assert);
+
+setApplication(Application.create(config.APP));
+
+start(); 
+```
+---
+<a id="test-default-import-specifier">**test-default-import-specifier**</a>
+
+**Input** (<small>[test-default-import-specifier.input.js](transforms/setup-qunit-dom/__testfixtures__/test-default-import-specifier.input.js)</small>):
+```js
+import QUnit from 'qunit';
+import { setup } from 'qunit-dom';
+import { setApplication } from '@ember/test-helpers';
+import { start } from 'ember-qunit';
+
+setup(QUnit.assert);
+
+setApplication(Application.create(config.APP));
+
+start(); 
+
+```
+
+**Output** (<small>[test-default-import-specifier.output.js](transforms/setup-qunit-dom/__testfixtures__/test-default-import-specifier.output.js)</small>):
+```js
+import QUnit from 'qunit';
+import { setup } from 'qunit-dom';
+import { setApplication } from '@ember/test-helpers';
+import { start } from 'ember-qunit';
+
+setup(QUnit.assert);
+
+setApplication(Application.create(config.APP));
+
+start(); 
+```
+<!--FIXTURES_CONTENT_END-->
diff --git a/transforms/setup-qunit-dom/__testfixtures__/basic.input.js b/transforms/setup-qunit-dom/__testfixtures__/basic.input.js
@@ -0,0 +1,8 @@
+import Application from 'insights-hub-web-fe/app'; 
+import config from 'insights-hub-web-fe/config/environment'; 
+import { setApplication } from '@ember/test-helpers'; 
+import { start } from 'ember-qunit'; 
+ 
+setApplication(Application.create(config.APP)); 
+ 
+start(); 
diff --git a/transforms/setup-qunit-dom/__testfixtures__/basic.output.js b/transforms/setup-qunit-dom/__testfixtures__/basic.output.js
@@ -0,0 +1,12 @@
+import * as QUnit from 'qunit';
+import { setup } from 'qunit-dom';
+import Application from 'insights-hub-web-fe/app';
+import config from 'insights-hub-web-fe/config/environment';
+import { setApplication } from '@ember/test-helpers';
+import { start } from 'ember-qunit';
+
+setup(QUnit.assert);
+
+setApplication(Application.create(config.APP));
+
+start(); 
diff --git a/transforms/setup-qunit-dom/__testfixtures__/test-default-import-specifier.input.js b/transforms/setup-qunit-dom/__testfixtures__/test-default-import-specifier.input.js
@@ -0,0 +1,10 @@
+import QUnit from 'qunit';
+import { setup } from 'qunit-dom';
+import { setApplication } from '@ember/test-helpers';
+import { start } from 'ember-qunit';
+
+setup(QUnit.assert);
+
+setApplication(Application.create(config.APP));
+
+start(); 
diff --git a/transforms/setup-qunit-dom/__testfixtures__/test-default-import-specifier.output.js b/transforms/setup-qunit-dom/__testfixtures__/test-default-import-specifier.output.js
@@ -0,0 +1,10 @@
+import QUnit from 'qunit';
+import { setup } from 'qunit-dom';
+import { setApplication } from '@ember/test-helpers';
+import { start } from 'ember-qunit';
+
+setup(QUnit.assert);
+
+setApplication(Application.create(config.APP));
+
+start(); 
diff --git a/transforms/setup-qunit-dom/index.js b/transforms/setup-qunit-dom/index.js
@@ -0,0 +1,134 @@
+const { getParser } = require('codemod-cli').jscodeshift;
+
+module.exports = function transformer(file, api) {
+  const j = getParser(api);
+  const root = j(file.source);
+
+  /**
+   * Check if the AST has the given import declaration
+   * @param {AST} root
+   * @param {string} specifierName
+   * @param {string} sourceName
+   * @return {boolean}
+   */
+  function hasImport(root, specifierName, sourceName) {
+    let hasSpecifier = false;
+    let hasSource = false;
+
+    root.find(j.ImportDeclaration).forEach((path) => {
+      let specifiers = path.node.specifiers;
+      let source = path.node.source;
+
+      specifiers.forEach((specifier) => {
+        if (specifierName === 'QUnit') {
+          if (
+            (specifier.type === 'ImportNamespaceSpecifier' ||
+              specifier.type === 'ImportDefaultSpecifier') &&
+            specifier.local.name === specifierName
+          ) {
+            hasSpecifier = true;
+          }
+        } else if (specifierName === 'setup') {
+          if (specifier.type === 'ImportSpecifier' && specifier.imported.name === specifierName) {
+            hasSpecifier = true;
+          }
+        }
+
+        if (source.value === sourceName) {
+          hasSource = true;
+        }
+      });
+    });
+
+    return hasSpecifier && hasSource;
+  }
+
+  /**
+   * Check if test-helper.js has setup(QUnit.assert);
+   * @param {AST} root
+   * @return {boolean}
+   */
+  function hasQunitSetup(root) {
+    return root.find(j.CallExpression).some((path) => {
+      let callee = path.node.callee;
+      let callExpressionArguments = path.node.arguments;
+
+      if (callee.name !== 'setup') {
+        return false;
+      }
+
+      let hasCorrectArguments = callExpressionArguments.some((argument) => {
+        return (
+          argument.type === 'MemberExpression' &&
+          argument.object.name === 'QUnit' &&
+          argument.property.name === 'assert'
+        );
+      });
+
+      return hasCorrectArguments;
+    });
+  }
+
+  /**
+   * Insert given import declatation to the beginning of file
+   * @param {string} specifier
+   * @param {string} source
+   * @param {boolean} defaultImportDeclaration
+   */
+  function addImportDeclaration(specifier, source, defaultImportDeclaration) {
+    const program = root.find(j.Program).at(0).nodes()[0];
+
+    const importSpecifier = defaultImportDeclaration
+      ? [j.importSpecifier(j.identifier(specifier))]
+      : [j.importNamespaceSpecifier(j.identifier(specifier))];
+
+    const setupImportDeclaration = j.importDeclaration(
+      importSpecifier,
+      j.stringLiteral(source),
+      'value'
+    );
+
+    program.body.unshift(setupImportDeclaration);
+  }
+
+  /**
+   * Insert 'setup(QUnit.assert);' above 'setApplication(Application.create(config.APP));'
+   * @param {AST} root
+   */
+  function insertSetupQunit(root) {
+    const setupFunction = j.expressionStatement(
+      j.callExpression(j.identifier('setup'), [
+        j.memberExpression(j.identifier('QUnit'), j.identifier('assert')),
+      ])
+    );
+
+    root.find(j.ExpressionStatement).forEach((path) => {
+      if (path.node.expression.callee && path.node.expression.callee.name === 'setApplication') {
+        path.insertBefore(setupFunction);
+      }
+    });
+  }
+
+  function transform() {
+    if (!hasImport(root, 'setup', 'qunit-dom')) {
+      addImportDeclaration('setup', 'qunit-dom', true);
+    }
+
+    if (!hasImport(root, 'QUnit', 'qunit')) {
+      addImportDeclaration('QUnit', 'qunit', false);
+    }
+
+    if (!hasQunitSetup(root)) {
+      insertSetupQunit(root);
+    }
+  }
+
+  transform();
+
+  return root.toSource({
+    quote: 'single',
+    trailingComma: true,
+  });
+};
+
+module.exports.type = 'js';
diff --git a/transforms/setup-qunit-dom/test.js b/transforms/setup-qunit-dom/test.js
@@ -0,0 +1,7 @@
+'use strict';
+
+const { runTransformTest } = require('codemod-cli');
+
+runTransformTest({
+  name: 'setup-qunit-dom',
+});
diff --git a/yarn.lock b/yarn.lock
