Merge pull request #45 from ccremer/plurals

Add pluralizer to fetch implementation

Author: ccremer

packages/kubernetes-client/src/fetch/index.ts

@@ -3,3 +3,4 @@ export * from './builder'
 export * from './client'
 export * from './urlgenerator'
 export * from './authorizer'
+export * from './pluralizer'

packages/kubernetes-client/src/fetch/pluralizer.spec.ts

@@ -0,0 +1,29 @@
+import { describe, expect, it } from 'vitest'
+import { DefaultPluralizer } from './pluralizer'
+
+describe('Pluralizer', () => {
+  const tests: {
+    name: string
+    input: string
+    expected: string
+  }[] = [
+    {
+      name: 'should append s to kind without y suffix',
+      input: 'namespace',
+      expected: 'namespaces',
+    },
+    {
+      name: 'should replace last occurrence of y with ie',
+      input: 'happyentity',
+      expected: 'happyentities',
+    },
+  ]
+
+  tests.forEach(({ name, input, expected }) => {
+    it(name, () => {
+      const p = new DefaultPluralizer()
+      const result = p.pluralize(input)
+      expect(result).toEqual(expected)
+    })
+  })
+})

packages/kubernetes-client/src/fetch/pluralizer.ts

@@ -0,0 +1,19 @@
+export interface Pluralizer {
+  /**
+   * Returns the plural form of the given kind.
+   * Required for building an URL endpoint.
+   * @param kind API kind as given in `kind` field of a resource, but in lower-case.
+   * @returns kind in lower-case in plural form.
+   */
+  pluralize(kind: string): string
+}
+
+/**
+ * Appends an "s" to the `kind`.
+ * If `kind` ends with "y", it is replaced with "ie" before appending an "s".
+ */
+export class DefaultPluralizer implements Pluralizer {
+  pluralize(kind: string): string {
+    return kind.replace(/y$/, 'ie').concat('s')
+  }
+}

packages/kubernetes-client/src/fetch/urlgenerator.ts

@@ -1,4 +1,5 @@
 import { OptionValue } from '../api'
+import { DefaultPluralizer, Pluralizer } from './pluralizer'
 
 export declare type HttpMethods = 'DELETE' | 'GET' | 'POST' | 'PUT' | 'PATCH'
 
@@ -21,7 +22,7 @@ export interface UrlGenerator {
  * Default {@link UrlGenerator} that generates API endpoint paths based on resource metadata.
  */
 export class KubernetesUrlGenerator implements UrlGenerator {
-  constructor(private apiBase = '') {}
+  constructor(private apiBase = '', private pluralizer: Pluralizer = new DefaultPluralizer()) {}
 
   buildEndpoint(
     method: HttpMethods,
@@ -43,7 +44,7 @@ export class KubernetesUrlGenerator implements UrlGenerator {
       endpoint.push('namespaces')
       endpoint.push(inNamespace)
     }
-    endpoint.push(kind.toLowerCase().concat('s'))
+    endpoint.push(this.pluralizer.pluralize(kind.toLowerCase()))
     if (name && name !== '' && method !== 'POST') {
       endpoint.push(name)
     }