Added tests and refactored code (Part 1) (#3)

* chore: Fixed typos

* refactor: Asserted the existence of the package version. Renamed test files and simplified the test setup.

* refactor: Added tests for analyzeAddon

* refactor: Added tests for useRelativePaths

* refactor: Removed unused code. Localized variables.

* bugfix: Provided the default value of [] to prevent a runtime error

Co-authored-by: ijlee2 <[email protected]>

Author: ijlee2

README.md

@@ -11,7 +11,7 @@ _Codemod to convert Ember addons to v2 addon format_
 - Switches Ember's "magic" import paths to relative paths
 - Preserves your code whenever possible
 - Supports [`ember-cli-typescript`](https://docs.ember-cli-typescript.com/) and [`glint`](https://typed-ember.gitbook.io/glint/)
-- Focuses on maintainbility and extensibility
+- Focuses on maintainability and extensibility
 
 
 ## Usage

src/migration/ember-addon/steps/augment-options.js

@@ -68,8 +68,14 @@ function analyzePackageManager(options) {
 
 function deriveAddonLocation(addonPackage) {
   if (!addonPackage.name) {
-    throw new RangeError(
-      `ERROR: In package.json, the package name \`${addonPackage.name}\` is not valid.`
+    throw new SyntaxError(
+      'ERROR: In package.json, the package name is missing.'
+    );
+  }
+
+  if (!addonPackage.version) {
+    throw new SyntaxError(
+      'ERROR: In package.json, the package version is missing.'
     );
   }
 

src/migration/ember-addon/steps/update-addon-package-json.js

@@ -17,12 +17,12 @@ function updateDependencies(packageJson) {
     'ember-cli-htmlbars',
   ];
 
-  const packagesToInstall = ['@embroider/addon-shim'];
-
   packagesToDelete.forEach((packageName) => {
     dependencies.delete(packageName);
   });
 
+  const packagesToInstall = ['@embroider/addon-shim'];
+
   packagesToInstall.forEach((packageName) => {
     const version = decideVersion(packageName, dependencies);
 
@@ -37,12 +37,17 @@ function updateDevDependencies(packageJson, options) {
 
   const devDependencies = convertToMap(packageJson['devDependencies']);
 
-  const packagesToDelete = [
-    '@embroider/macros',
-    'ember-auto-import',
-    'ember-cli-babel',
-    'ember-cli-htmlbars',
-  ];
+  /*
+    For the time being, we'll take the approach of starting over and
+    adding back the development dependencies that are required. For
+    a more conservative approach, we could delete only the following:
+
+      - @embroider/macros
+      - ember-auto-import
+      - ember-cli-babel
+      - ember-cli-htmlbars
+  */
+  devDependencies.clear();
 
   const packagesToInstall = packages.addon.hasTypeScript
     ? [
@@ -65,13 +70,6 @@ function updateDevDependencies(packageJson, options) {
         'rollup-plugin-copy',
       ];
 
-  // May be easier to start over and add missing dependencies
-  devDependencies.clear();
-
-  packagesToDelete.forEach((packageName) => {
-    devDependencies.delete(packageName);
-  });
-
   packagesToInstall.forEach((packageName) => {
     const version = decideVersion(packageName, devDependencies);
 

src/migration/ember-addon/steps/update-test-app-package-json.js

@@ -37,7 +37,10 @@ function moveDependenciesToDevDependencies(packageJson, options) {
 function updateDependencies(packageJson) {
   const dependencies = convertToMap(packageJson['dependencies']);
 
-  // May be easier to start over and add missing dependencies
+  /*
+    For the time being, we'll take the approach of starting over and
+    adding back the dependencies that are required.
+  */
   dependencies.clear();
 
   packageJson['dependencies'] = convertToObject(dependencies);
@@ -58,9 +61,9 @@ function updateOtherFields(packageJson, options) {
 
   delete packageJson['ember-addon'];
 
-  packageJson['keywords'] = packageJson['keywords'].filter((keyword) => {
-    return keyword !== 'ember-addon';
-  });
+  packageJson['keywords'] = (packageJson['keywords'] ?? []).filter(
+    (keyword) => keyword !== 'ember-addon'
+  );
 
   packageJson['name'] = packages.testApp.name;
 

tests/migration/ember-addon/steps/analyze-addon/base-case.test.js

@@ -0,0 +1,79 @@
+import { analyzeAddon } from '../../../../../src/migration/ember-addon/steps/analyze-addon.js';
+import { assert, loadFixture, test } from '../../../../test-helpers.js';
+
+test('migration | ember-addon | steps | analyze-addon > base case', function () {
+  const options = {
+    addonLocation: undefined,
+    projectRoot: 'tmp/ember-container-query-typescript',
+    testAppLocation: undefined,
+    testAppName: undefined,
+  };
+
+  const inputProject = {
+    addon: {
+      components: {
+        'container-query.hbs': '',
+        'container-query.ts': '',
+      },
+      helpers: {
+        'aspect-ratio.ts': '',
+        'height.ts': '',
+        'width.ts': '',
+      },
+      modifiers: {
+        'container-query.ts': '',
+      },
+      styles: {
+        'container-query.css': '',
+      },
+      '.gitkeep': '',
+      'index.ts': '',
+      'template-registry.ts': '',
+    },
+    app: {
+      components: {
+        'container-query.js': '',
+      },
+      helpers: {
+        'aspect-ratio.js': '',
+        'height.js': '',
+        'width.js': '',
+      },
+      modifiers: {
+        'container-query.js': '',
+      },
+      '.gitkeep': '',
+    },
+  };
+
+  const expectedValue = {
+    appReexports: [
+      'components/container-query.js',
+      'helpers/aspect-ratio.js',
+      'helpers/height.js',
+      'helpers/width.js',
+      'modifiers/container-query.js',
+    ],
+    publicEntrypoints: [
+      'components/container-query.js',
+      'helpers/aspect-ratio.js',
+      'helpers/height.js',
+      'helpers/width.js',
+      'index.js',
+      'modifiers/container-query.js',
+      'template-registry.js',
+    ],
+  };
+
+  loadFixture(inputProject, options);
+
+  // Run the step
+  const augmentedOptions = {
+    projectRoot: 'tmp/ember-container-query-typescript',
+  };
+
+  assert.deepEqual(analyzeAddon(augmentedOptions), expectedValue);
+
+  // Check idempotence
+  assert.deepEqual(analyzeAddon(augmentedOptions), expectedValue);
+});

tests/migration/ember-addon/steps/analyze-addon/edge-case-folders-are-missing.test.js

@@ -0,0 +1,30 @@
+import { analyzeAddon } from '../../../../../src/migration/ember-addon/steps/analyze-addon.js';
+import { assert, loadFixture, test } from '../../../../test-helpers.js';
+
+test('migration | ember-addon | steps | analyze-addon > edge case (folders are missing)', function () {
+  const options = {
+    addonLocation: undefined,
+    projectRoot: 'tmp/new-v1-addon-javascript',
+    testAppLocation: undefined,
+    testAppName: undefined,
+  };
+
+  const inputProject = {};
+
+  const expectedValue = {
+    appReexports: [],
+    publicEntrypoints: [],
+  };
+
+  loadFixture(inputProject, options);
+
+  // Run the step
+  const augmentedOptions = {
+    projectRoot: 'tmp/new-v1-addon-javascript',
+  };
+
+  assert.deepEqual(analyzeAddon(augmentedOptions), expectedValue);
+
+  // Check idempotence
+  assert.deepEqual(analyzeAddon(augmentedOptions), expectedValue);
+});

tests/migration/ember-addon/steps/augment-options/custom-locations.test.js

@@ -26,7 +26,7 @@ test('migration | ember-addon | steps | augment-options > custom locations', fun
       null,
       2
     ),
-    'yarn.lock': 'some code for yarn.lock',
+    'yarn.lock': '',
   };
 
   loadFixture(inputProject, options);

tests/migration/ember-addon/steps/augment-options/error-handling-1.test.js renamed to tests/migration/ember-addon/steps/augment-options/error-handling-package-json-is-an-empty-file.test.js

@@ -1,7 +1,7 @@
 import { augmentOptions } from '../../../../../src/migration/ember-addon/steps/augment-options.js';
 import { assert, loadFixture, test } from '../../../../test-helpers.js';
 
-test('migration | ember-addon | steps | augment-options > error handling (empty file)', function () {
+test('migration | ember-addon | steps | augment-options > error handling (package.json is an empty file)', function () {
   const options = {
     addonLocation: undefined,
     projectRoot: 'tmp/new-v1-addon-javascript',
@@ -11,7 +11,7 @@ test('migration | ember-addon | steps | augment-options > error handling (empty
 
   const inputProject = {
     'package.json': '',
-    'yarn.lock': 'some code for yarn.lock',
+    'yarn.lock': '',
   };
 
   loadFixture(inputProject, options);

tests/migration/ember-addon/steps/augment-options/error-handling-3.test.js renamed to tests/migration/ember-addon/steps/augment-options/error-handling-package-json-is-not-a-valid-json.test.js

@@ -1,7 +1,7 @@
 import { augmentOptions } from '../../../../../src/migration/ember-addon/steps/augment-options.js';
 import { assert, loadFixture, test } from '../../../../test-helpers.js';
 
-test('migration | ember-addon | steps | augment-options > error handling (corrupt package.json)', function () {
+test('migration | ember-addon | steps | augment-options > error handling (package.json is not a valid JSON)', function () {
   const options = {
     addonLocation: undefined,
     projectRoot: 'tmp/new-v1-addon-javascript',
@@ -10,8 +10,8 @@ test('migration | ember-addon | steps | augment-options > error handling (corrup
   };
 
   const inputProject = {
-    'package.json': '{\n  name:}',
-    'yarn.lock': 'some code for yarn.lock',
+    'package.json': '{\n  "name": }',
+    'yarn.lock': '',
   };
 
   loadFixture(inputProject, options);
@@ -23,7 +23,7 @@ test('migration | ember-addon | steps | augment-options > error handling (corrup
     (error) => {
       assert.strictEqual(
         error.message,
-        'ERROR: package.json is missing or is not a valid JSON. (Unexpected token n in JSON at position 4)\n'
+        'ERROR: package.json is missing or is not a valid JSON. (Unexpected token } in JSON at position 12)\n'
       );
 
       return true;

tests/migration/ember-addon/steps/augment-options/error-handling-2.test.js renamed to tests/migration/ember-addon/steps/augment-options/error-handling-package-name-is-missing.test.js

@@ -1,7 +1,7 @@
 import { augmentOptions } from '../../../../../src/migration/ember-addon/steps/augment-options.js';
 import { assert, loadFixture, test } from '../../../../test-helpers.js';
 
-test('migration | ember-addon | steps | augment-options > error handling (empty object)', function () {
+test('migration | ember-addon | steps | augment-options > error handling (package name is missing)', function () {
   const options = {
     addonLocation: undefined,
     projectRoot: 'tmp/new-v1-addon-javascript',
@@ -11,7 +11,7 @@ test('migration | ember-addon | steps | augment-options > error handling (empty
 
   const inputProject = {
     'package.json': '{}',
-    'yarn.lock': 'some code for yarn.lock',
+    'yarn.lock': '',
   };
 
   loadFixture(inputProject, options);
@@ -23,7 +23,7 @@ test('migration | ember-addon | steps | augment-options > error handling (empty
     (error) => {
       assert.strictEqual(
         error.message,
-        'ERROR: In package.json, the package name `undefined` is not valid.'
+        'ERROR: In package.json, the package name is missing.'
       );
 
       return true;