#13, TypeMembersMap.fromMemberedObject, tests.

ajvincent · Jan 14, 2024 · 56715e1 · 56715e1
1 parent 53fce4b
commit 56715e1
Show file tree

Hide file tree

Showing 6 changed files with 280 additions and 44 deletions.
diff --git a/stage_1_integration/toolbox/ClassMembersMap.ts b/stage_1_integration/toolbox/ClassMembersMap.ts
@@ -1,6 +1,7 @@
 import {
   JSDocStructure,
-  StructureKind
+  KindedStructure,
+  StructureKind,
 } from "ts-morph";
 
 import {
@@ -39,7 +40,7 @@ export type ClassMemberImpl = (
  * const foo = new PropertyDeclarationImpl(false, "foo");
  * map.addMembers([foo]);
  * // ...
- * const classDecl = new ClassDeclaration;
+ * const classDecl = new ClassDeclarationImpl;
  * classDecl.name = "FooClass";
  * map.moveMembersToClass(classDecl);
  * // classDecl.properties === [foo];
@@ -135,11 +136,11 @@ extends Map<string, ClassMemberImpl>
   >
   (
     kind: Kind
-  ): Extract<ClassMemberImpl , { kind: Kind }>[]
+  ): Extract<ClassMemberImpl, KindedStructure<Kind>>[]
   {
     let items = Array.from(this.values());
     items = items.filter(item => item.kind === kind);
-    return items as Extract<ClassMemberImpl , { kind: Kind }>[];
+    return items as Extract<ClassMemberImpl, KindedStructure<Kind>>[];
   }
 
   /**
@@ -158,12 +159,12 @@ extends Map<string, ClassMemberImpl>
     kind: Kind,
     isStatic: boolean,
     name: string
-  ): (Extract<ClassMemberImpl, { kind: Kind }>) | undefined
+  ): (Extract<ClassMemberImpl, KindedStructure<Kind>>) | undefined
   {
     const key = ClassMembersMap.keyFromName(kind, isStatic, name);
     const rv = this.get(key);
     if (rv?.kind === kind)
-      return rv as Extract<ClassMemberImpl, { kind: Kind }>;
+      return rv as Extract<ClassMemberImpl, KindedStructure<Kind>>;
     return undefined;
   }
 

diff --git a/stage_1_integration/toolbox/TypeMembersMap.ts b/stage_1_integration/toolbox/TypeMembersMap.ts
@@ -27,6 +27,20 @@ export type TypeMemberImpl = (
 
 export type NamedTypeMemberImpl = Extract<TypeMemberImpl, { name: string }>;
 
+/**
+ * A map for members of `InterfaceDeclarationImpl` and `MemberedObjectTypeStructureImpl`.  This
+ * doesn't replace the structures, rather it _feeds_ them.
+ *
+ * @example
+ *
+ * const map = new TypeMembersMap;
+ * const foo = new PropertySignatureImpl(false, "foo");
+ * map.addMembers([foo]);
+ * // ...
+ * const interfaceDecl = new InterfaceDeclarationImpl("FooInterface");
+ * map.moveMembersToType(interfaceDecl);
+ * // interfaceDecl.properties === [foo];
+ */
 export default class TypeMembersMap
 extends Map<string, TypeMemberImpl>
 {
@@ -82,6 +96,31 @@ extends Map<string, TypeMemberImpl>
     return rv;
   }
 
+  /**
+   * Create a `TypeMembersMap` from an interface or membered object.
+   * @param membered - the membered object.
+   * @returns the type members map.
+   */
+  static fromMemberedObject(
+    membered: InterfaceDeclarationImpl | MemberedObjectTypeStructureImpl
+  ): TypeMembersMap
+  {
+    const map = new TypeMembersMap;
+
+    const members: TypeMemberImpl[] = [
+      ...membered.callSignatures,
+      ...membered.constructSignatures,
+      ...membered.getAccessors,
+      ...membered.indexSignatures,
+      ...membered.methods,
+      ...membered.properties,
+      ...membered.setAccessors,
+    ];
+    map.addMembers(members);
+
+    return map;
+  }
+
   /**
    * Add type members as values of this map, using standard keys.
    *
@@ -116,26 +155,52 @@ extends Map<string, TypeMemberImpl>
 
   /**
    * A typed call to `this.get()` for a given kind.
-   * @param key - the key to get.
    * @param kind - the structure kind.
+   * @param name - the key to get.
    * @returns - the type member, as the right type, or undefined if the wrong type.
    *
-   * @see `ClassMembersMap::keyFromName`
+   * @see `TypeMembersMap::keyFromName`
    */
   getAsKind<
     Kind extends TypeMemberImpl["kind"]
   >
   (
-    key: string,
-    kind: Kind
+    kind: Kind,
+    name: string,
   ): Extract<TypeMemberImpl, KindedStructure<Kind>> | undefined
   {
-    const rv = this.get(key);
+    const rv = this.get(name);
     if (rv?.kind === kind)
       return rv as Extract<TypeMemberImpl, KindedStructure<Kind>>;
     return undefined;
   }
 
+  convertAccessorsToProperty(
+    name: string
+  ): void
+  {
+    void(name);
+    throw new Error("not yet implemented");
+  }
+
+  convertPropertyToAccessors(
+    name: string,
+    toGetter: boolean,
+    toSetter: boolean
+  ): void
+  {
+    void(name);
+    void(toGetter);
+    void(toSetter);
+    throw new Error("not yet implemented");
+  }
+
+  resolveIndexSignature(
+  ): never
+  {
+    throw new Error("not yet implemented");
+  }
+
   /**
    * Move type members from this map to an interface or type literal, and clear this map.
    *

diff --git a/stage_2_fullset/snapshot/source/toolbox/ClassMembersMap.ts b/stage_2_fullset/snapshot/source/toolbox/ClassMembersMap.ts
@@ -1,4 +1,4 @@
-import { JSDocStructure, StructureKind } from "ts-morph";
+import { JSDocStructure, KindedStructure, StructureKind } from "ts-morph";
 
 import {
   ClassDeclarationImpl,
@@ -35,7 +35,7 @@ export type ClassMemberImpl =
  * const foo = new PropertyDeclarationImpl(false, "foo");
  * map.addMembers([foo]);
  * // ...
- * const classDecl = new ClassDeclaration;
+ * const classDecl = new ClassDeclarationImpl;
  * classDecl.name = "FooClass";
  * map.moveMembersToClass(classDecl);
  * // classDecl.properties === [foo];
@@ -113,10 +113,10 @@ export default class ClassMembersMap extends Map<string, ClassMemberImpl> {
    */
   public arrayOfKind<Kind extends ClassMemberImpl["kind"]>(
     kind: Kind,
-  ): Extract<ClassMemberImpl, { kind: Kind }>[] {
+  ): Extract<ClassMemberImpl, KindedStructure<Kind>>[] {
     let items = Array.from(this.values());
     items = items.filter((item) => item.kind === kind);
-    return items as Extract<ClassMemberImpl, { kind: Kind }>[];
+    return items as Extract<ClassMemberImpl, KindedStructure<Kind>>[];
   }
 
   /**
@@ -132,11 +132,11 @@ export default class ClassMembersMap extends Map<string, ClassMemberImpl> {
     kind: Kind,
     isStatic: boolean,
     name: string,
-  ): Extract<ClassMemberImpl, { kind: Kind }> | undefined {
+  ): Extract<ClassMemberImpl, KindedStructure<Kind>> | undefined {
     const key = ClassMembersMap.keyFromName(kind, isStatic, name);
     const rv = this.get(key);
     if (rv?.kind === kind)
-      return rv as Extract<ClassMemberImpl, { kind: Kind }>;
+      return rv as Extract<ClassMemberImpl, KindedStructure<Kind>>;
     return undefined;
   }
 

diff --git a/stage_2_fullset/snapshot/source/toolbox/TypeMembersMap.ts b/stage_2_fullset/snapshot/source/toolbox/TypeMembersMap.ts
@@ -23,6 +23,20 @@ export type TypeMemberImpl =
 
 export type NamedTypeMemberImpl = Extract<TypeMemberImpl, { name: string }>;
 
+/**
+ * A map for members of `InterfaceDeclarationImpl` and `MemberedObjectTypeStructureImpl`.  This
+ * doesn't replace the structures, rather it _feeds_ them.
+ *
+ * @example
+ *
+ * const map = new TypeMembersMap;
+ * const foo = new PropertySignatureImpl(false, "foo");
+ * map.addMembers([foo]);
+ * // ...
+ * const interfaceDecl = new InterfaceDeclarationImpl("FooInterface");
+ * map.moveMembersToType(interfaceDecl);
+ * // interfaceDecl.properties === [foo];
+ */
 export default class TypeMembersMap extends Map<string, TypeMemberImpl> {
   static readonly #uniqueKey = new WeakMap<TypeMemberImpl, string>();
   static #uniqueKeyCounter = 0;
@@ -62,6 +76,30 @@ export default class TypeMembersMap extends Map<string, TypeMemberImpl> {
     return rv;
   }
 
+  /**
+   * Create a `TypeMembersMap` from an interface or membered object.
+   * @param membered - the membered object.
+   * @returns the type members map.
+   */
+  static fromMemberedObject(
+    membered: InterfaceDeclarationImpl | MemberedObjectTypeStructureImpl,
+  ): TypeMembersMap {
+    const map = new TypeMembersMap();
+
+    const members: TypeMemberImpl[] = [
+      ...membered.callSignatures,
+      ...membered.constructSignatures,
+      ...membered.getAccessors,
+      ...membered.indexSignatures,
+      ...membered.methods,
+      ...membered.properties,
+      ...membered.setAccessors,
+    ];
+    map.addMembers(members);
+
+    return map;
+  }
+
   /**
    * Add type members as values of this map, using standard keys.
    *
@@ -89,22 +127,42 @@ export default class TypeMembersMap extends Map<string, TypeMemberImpl> {
 
   /**
    * A typed call to `this.get()` for a given kind.
-   * @param key - the key to get.
    * @param kind - the structure kind.
+   * @param name - the key to get.
    * @returns - the type member, as the right type, or undefined if the wrong type.
    *
-   * @see `ClassMembersMap::keyFromName`
+   * @see `TypeMembersMap::keyFromName`
    */
   getAsKind<Kind extends TypeMemberImpl["kind"]>(
-    key: string,
     kind: Kind,
+    name: string,
   ): Extract<TypeMemberImpl, KindedStructure<Kind>> | undefined {
-    const rv = this.get(key);
+    const rv = this.get(name);
     if (rv?.kind === kind)
       return rv as Extract<TypeMemberImpl, KindedStructure<Kind>>;
     return undefined;
   }
 
+  convertAccessorsToProperty(name: string): void {
+    void name;
+    throw new Error("not yet implemented");
+  }
+
+  convertPropertyToAccessors(
+    name: string,
+    toGetter: boolean,
+    toSetter: boolean,
+  ): void {
+    void name;
+    void toGetter;
+    void toSetter;
+    throw new Error("not yet implemented");
+  }
+
+  resolveIndexSignature(): never {
+    throw new Error("not yet implemented");
+  }
+
   /**
    * Move type members from this map to an interface or type literal, and clear this map.
    *

diff --git a/stage_2_fullset/spec-snapshot/source/toolbox/ClassMembersMap.ts b/stage_2_fullset/spec-snapshot/source/toolbox/ClassMembersMap.ts
@@ -318,7 +318,7 @@ describe("ClassMembersMap", () => {
     });
   });
 
-  it("static methods give us keys we can use in the map", () => {
+  it("static keyFromName() and keyFromMember() give us keys we can use in the map", () => {
     expect(ClassMembersMap.keyFromMember(method3)).toBe("static three");
 
     expect(ClassMembersMap.keyFromName(StructureKind.Constructor, true, "three")).toBe("constructor");