Narrowed usage to entity names in @codemod-utils/ember

.changeset/dull-donkeys-taste.md

@@ -0,0 +1,5 @@
+---
+"@codemod-utils/ember": major
+---
+
+Narrowed usage to entity names, in order to remove dependency on ember-cli-string-utils

packages/ember/README.md

@@ -12,47 +12,42 @@ _Utilities for Ember_
 
 ## API
 
-The methods are built with the **entity name** in mind, a string (possibly with hyphens and forward slashes) that represents a set of related files in Ember.
-
-(For example, the `<Ui::Button>` component has the entity name `'ui/button'`. In the Ember source code, you may see variable names like `entityName` or `moduleName`.)
-
-
 ### camelize
 
-Returns a string in camel-case.
+Converts an entity name to camel case. Used for naming the function that is associated with the entity.
 
 ```ts
 import { camelize } from '@codemod-utils/ember';
 
-const newValue = camelize('css-class-name');
+const newValue = camelize('ui/form/generate-error-message');
 
-// 'cssClassName'
+// 'uiFormGenerateErrorMessage'
 ```
 
 
-### classify
+### doubleColonize
 
-Returns a string that can be used to name a JavaScript `class` (a.k.a. Pascal case).
+Converts an entity name to double colon (`::`) case. Used for writing the angle bracket syntax or the signature for a component.
 
 ```ts
-import { classify } from '@codemod-utils/ember';
+import { doubleColonize } from '@codemod-utils/ember';
 
-const newValue = classify('ui/button');
+const newValue = doubleColonize('ui/form/input');
 
-// 'UiButton'
+// 'Ui::Form::Input'
 ```
 
 
-### doubleColonize
+### pascalize
 
-Returns a string associated with the angle bracket syntax for components.
+Converts an entity name to Pascal case. Used for naming the class that is associated with the entity.
 
 ```ts
-import { doubleColonize } from '@codemod-utils/ember';
+import { pascalize } from '@codemod-utils/ember';
 
-const newValue = doubleColonize('ui/button');
+const newValue = pascalize('ui/form/input');
 
-// 'Ui::Button'
+// 'UiFormInput'
 ```
 
 

packages/ember/src/ember/entity-name/camelize.ts

@@ -0,0 +1,28 @@
+import { pascalize } from './pascalize.js';
+
+/**
+ * Converts an entity name to camel case. Used for naming the
+ * function that is associated with the entity.
+ *
+ * @param entityName
+ *
+ * The name of an entity (made up of lowercase letters, hyphen,
+ * and forward slash).
+ *
+ * @return
+ *
+ * The name in camel case.
+ *
+ * @example
+ *
+ * ```ts
+ * const newValue = camelize('ui/form/generate-error-message');
+ *
+ * // 'uiFormGenerateErrorMessage'
+ * ```
+ */
+export function camelize(entityName: string): string {
+  const pascalizedName = pascalize(entityName);
+
+  return pascalizedName.charAt(0).toLowerCase() + pascalizedName.substring(1);
+}

packages/ember/src/ember/entity-name/double-colonize.ts

@@ -0,0 +1,33 @@
+function pascalize(value: string): string {
+  return value
+    .split('-')
+    .map((token) => {
+      return token.charAt(0).toUpperCase() + token.substring(1).toLowerCase();
+    })
+    .join('');
+}
+
+/**
+ * Converts an entity name to double colon (`::`) case. Used for
+ * writing the angle bracket syntax or the signature for a component.
+ *
+ * @param entityName
+ *
+ * The name of an entity (made up of lowercase letters, hyphen,
+ * and forward slash).
+ *
+ * @return
+ *
+ * The name in double colon case.
+ *
+ * @example
+ *
+ * ```ts
+ * const newValue = doubleColonize('ui/form/input');
+ *
+ * // 'Ui::Form::Input'
+ * ```
+ */
+export function doubleColonize(entityName: string): string {
+  return entityName.split('/').map(pascalize).join('::');
+}

packages/ember/src/ember/entity-name/pascalize.ts

@@ -0,0 +1,28 @@
+import { doubleColonize } from './double-colonize.js';
+
+/**
+ * Converts an entity name to Pascal case. Used for naming the
+ * class that is associated with the entity.
+ *
+ * @param entityName
+ *
+ * The name of an entity (made up of lowercase letters, hyphen,
+ * and forward slash).
+ *
+ * @return
+ *
+ * The name in Pascal case.
+ *
+ * @example
+ *
+ * ```ts
+ * const newValue = pascalize('ui/form/input');
+ *
+ * // 'UiFormInput'
+ * ```
+ */
+export function pascalize(entityName: string): string {
+  const doubleColonizedName = doubleColonize(entityName);
+
+  return doubleColonizedName.replaceAll('::', '');
+}

packages/ember/src/index.ts

@@ -1,3 +1,3 @@
-export * from './entity-name/camelize.js';
-export * from './entity-name/classify.js';
-export * from './entity-name/double-colonize.js';
+export * from './ember/entity-name/camelize.js';
+export * from './ember/entity-name/double-colonize.js';
+export * from './ember/entity-name/pascalize.js';

packages/ember/tests/ember/entity-name/camelize/base-case.test.ts

@@ -0,0 +1,11 @@
+import { assert, test } from '@codemod-utils/tests';
+
+import { camelize } from '../../../../src/index.js';
+
+test('utils | ember | entity-name | camelize > base case', function () {
+  assert.strictEqual(camelize('hello'), 'hello');
+
+  assert.strictEqual(camelize('hello-world'), 'helloWorld');
+
+  assert.strictEqual(camelize('hello-world-123'), 'helloWorld123');
+});

packages/ember/tests/ember/entity-name/camelize/nested.test.ts

@@ -0,0 +1,16 @@
+import { assert, test } from '@codemod-utils/tests';
+
+import { camelize } from '../../../../src/index.js';
+
+test('utils | ember | entity-name | camelize > nested', function () {
+  assert.strictEqual(camelize('ui/form'), 'uiForm');
+
+  assert.strictEqual(camelize('ui/form/input'), 'uiFormInput');
+
+  assert.strictEqual(camelize('ui/form/submit-button'), 'uiFormSubmitButton');
+
+  assert.strictEqual(
+    camelize('widgets/widget-3/tour-schedule/responsive-image'),
+    'widgetsWidget3TourScheduleResponsiveImage',
+  );
+});

packages/ember/tests/ember/entity-name/camelize/wrong-input.test.ts

@@ -0,0 +1,21 @@
+import { assert, test } from '@codemod-utils/tests';
+
+import { camelize } from '../../../../src/index.js';
+
+test('utils | ember | entity-name | camelize > wrong input', function () {
+  assert.strictEqual(camelize(''), '');
+
+  assert.strictEqual(camelize('-'), '');
+
+  assert.strictEqual(camelize('/'), '');
+
+  assert.strictEqual(camelize('ui/'), 'ui');
+
+  assert.strictEqual(camelize('/ui'), 'ui');
+
+  assert.strictEqual(camelize('ui.form.input'), 'ui.form.input');
+
+  assert.strictEqual(camelize('ui_form_input'), 'ui_form_input');
+
+  assert.strictEqual(camelize('ui form input'), 'ui form input');
+});

packages/ember/tests/ember/entity-name/double-colonize/base-case.test.ts

@@ -0,0 +1,11 @@
+import { assert, test } from '@codemod-utils/tests';
+
+import { doubleColonize } from '../../../../src/index.js';
+
+test('utils | ember | entity-name | double-colonize > base case', function () {
+  assert.strictEqual(doubleColonize('hello'), 'Hello');
+
+  assert.strictEqual(doubleColonize('hello-world'), 'HelloWorld');
+
+  assert.strictEqual(doubleColonize('hello-world-123'), 'HelloWorld123');
+});

packages/ember/tests/ember/entity-name/double-colonize/edge-case-empty-string.test.ts

@@ -0,0 +1,16 @@
+import { assert, test } from '@codemod-utils/tests';
+
+import { doubleColonize } from '../../../../src/index.js';
+
+test('utils | ember | entity-name | double-colonize > nested', function () {
+  assert.strictEqual(doubleColonize('ui/form'), 'Ui::Form');
+  assert.strictEqual(doubleColonize('ui/form/input'), 'Ui::Form::Input');
+  assert.strictEqual(
+    doubleColonize('ui/form/submit-button'),
+    'Ui::Form::SubmitButton',
+  );
+  assert.strictEqual(
+    doubleColonize('widgets/widget-3/tour-schedule/responsive-image'),
+    'Widgets::Widget3::TourSchedule::ResponsiveImage',
+  );
+});

packages/ember/tests/ember/entity-name/double-colonize/wrong-input.test.ts

@@ -0,0 +1,21 @@
+import { assert, test } from '@codemod-utils/tests';
+
+import { doubleColonize } from '../../../../src/index.js';
+
+test('utils | ember | entity-name | double-colonize > wrong input', function () {
+  assert.strictEqual(doubleColonize(''), '');
+
+  assert.strictEqual(doubleColonize('-'), '');
+
+  assert.strictEqual(doubleColonize('/'), '::');
+
+  assert.strictEqual(doubleColonize('ui/'), 'Ui::');
+
+  assert.strictEqual(doubleColonize('/ui'), '::Ui');
+
+  assert.strictEqual(doubleColonize('ui.form.input'), 'Ui.form.input');
+
+  assert.strictEqual(doubleColonize('ui_form_input'), 'Ui_form_input');
+
+  assert.strictEqual(doubleColonize('ui form input'), 'Ui form input');
+});

packages/ember/tests/ember/entity-name/pascalize/base-case.test.ts

@@ -0,0 +1,11 @@
+import { assert, test } from '@codemod-utils/tests';
+
+import { pascalize } from '../../../../src/index.js';
+
+test('utils | ember | entity-name | pascalize > base case', function () {
+  assert.strictEqual(pascalize('hello'), 'Hello');
+
+  assert.strictEqual(pascalize('hello-world'), 'HelloWorld');
+
+  assert.strictEqual(pascalize('hello-world-123'), 'HelloWorld123');
+});

packages/ember/tests/ember/entity-name/pascalize/nested.test.ts

@@ -0,0 +1,16 @@
+import { assert, test } from '@codemod-utils/tests';
+
+import { pascalize } from '../../../../src/index.js';
+
+test('utils | ember | entity-name | pascalize > nested', function () {
+  assert.strictEqual(pascalize('ui/form'), 'UiForm');
+
+  assert.strictEqual(pascalize('ui/form/input'), 'UiFormInput');
+
+  assert.strictEqual(pascalize('ui/form/submit-button'), 'UiFormSubmitButton');
+
+  assert.strictEqual(
+    pascalize('widgets/widget-3/tour-schedule/responsive-image'),
+    'WidgetsWidget3TourScheduleResponsiveImage',
+  );
+});