feat(codegen): refactor GeneratedMapper

Author: WipeAir

graphql-kotlin-toolkit-codegen/src/main/kotlin/com/auritylab/graphql/kotlin/toolkit/codegen/mapper/GeneratedMapper.kt

@@ -18,22 +18,24 @@ internal class GeneratedMapper(
     private val options: CodegenOptions
 ) {
     /**
-     * Will return the [ClassName] for the given [graphQLType].
+     * Will build the generated [ClassName] for the given [GraphQLType]. This will only build [ClassName]s which
+     * are generated through this code generator.
      *
      * @throws IllegalArgumentException If no name can be generated for the given [graphQLType]
      */
-    fun getGeneratedTypeClassName(graphQLType: GraphQLType, appendCompanion: Boolean = false): ClassName {
+    fun getGeneratedTypeClassName(graphQLType: GraphQLType): ClassName {
         val name = NamingHelper.uppercaseFirstLetter(graphQLType.name)
         return when (graphQLType) {
-            is GraphQLEnumType -> buildClassName(name, appendCompanion, "enum")
-            is GraphQLInputObjectType -> buildClassName(name, appendCompanion, "inputObject")
-            is GraphQLObjectType -> buildClassName(name, appendCompanion, "object")
+            is GraphQLEnumType -> buildClassName(name, "enum")
+            is GraphQLInputObjectType -> buildClassName(name, "inputObject")
+            is GraphQLObjectType -> buildClassName(name, "object")
             else -> throw IllegalArgumentException("Unable to build name for ${graphQLType.name}")
         }
     }
 
     /**
-     * Will return the [ClassName] for the given [field] in the [container].
+     * Will return the [ClassName] for a resolver which is defined through the given [field], which is within the
+     * given [container]. The [container] is necessary to build a unique identifier for the resolver.
      */
     fun getGeneratedFieldResolverClassName(
         container: GraphQLFieldsContainer,
@@ -43,92 +45,68 @@ internal class GeneratedMapper(
         val containerName = NamingHelper.uppercaseFirstLetter(container.name)
         val fieldName = NamingHelper.uppercaseFirstLetter(field.name)
 
-        return buildClassName(containerName + fieldName, false, "resolver")
+        return buildClassName("$containerName$fieldName", "resolver")
     }
 
     /**
      * Will return the [ClassName] for the value wrapper.
      */
     fun getValueWrapperName(): ClassName =
-        buildClassName("V", false, "util")
+        buildClassName("V", "util")
 
     /**
      * Will return the [ClassName] for the environment wrapper.
      */
     fun getEnvironmentWrapperClassName(): ClassName =
-        buildClassName("Env", false, "util")
+        buildClassName("Env", "util")
 
     /**
      * Will return the [MemberName] of the builder method for the given [inputObject].
      */
     fun getInputObjectBuilderMemberName(inputObject: GraphQLInputObjectType): MemberName =
-        MemberName(getGeneratedTypeClassName(inputObject, true), "buildByMap")
+        MemberName(getGeneratedTypeClassName(inputObject).addSimpleNames("Companion"), "buildByMap")
 
     /**
      * Will return the [MemberName] which points to a string which contains the name of the container for the given field resolver.
      */
     fun getFieldResolverContainerMemberName(
         container: GraphQLFieldsContainer,
         field: GraphQLFieldDefinition
-    ): MemberName {
-        val resolver = getGeneratedFieldResolverClassName(container, field)
-
-        return MemberName(
-            ClassName(resolver.packageName, *resolver.simpleNames.toTypedArray(), "Meta"),
-            "CONTAINER"
-        )
-    }
+    ): MemberName =
+        MemberName(getGeneratedFieldResolverClassName(container, field).addSimpleNames("Meta"), "CONTAINER")
 
     /**
      * Will return the [MemberName] which points to a string which contains the name of the field for the given field resolver.
      */
     fun getFieldResolverFieldMemberName(
         container: GraphQLFieldsContainer,
         field: GraphQLFieldDefinition
-    ): MemberName {
-        val resolver = getGeneratedFieldResolverClassName(container, field)
-
-        return MemberName(
-            ClassName(resolver.packageName, *resolver.simpleNames.toTypedArray(), "Meta"),
-            "FIELD"
-        )
-    }
+    ): MemberName =
+        MemberName(getGeneratedFieldResolverClassName(container, field).addSimpleNames("Meta"), "FIELD")
 
     /**
      * Will return the [ClassName] which points to the Environment class for the given resolver.
      */
-    fun getFieldResolverEnvironment(container: GraphQLFieldsContainer, field: GraphQLFieldDefinition): ClassName {
-        val resolver = getGeneratedFieldResolverClassName(container, field)
-
-        return ClassName(resolver.packageName, *resolver.simpleNames.toTypedArray(), "Env")
-    }
+    fun getFieldResolverEnvironment(container: GraphQLFieldsContainer, field: GraphQLFieldDefinition): ClassName =
+        getGeneratedFieldResolverClassName(container, field).addSimpleNames("Env")
 
     fun getPaginationInfoClassName(): ClassName {
-        return buildClassName("PaginationInfo", false, "pagination")
+        return buildClassName("PaginationInfo", "pagination")
     }
 
-    fun getPaginationInfoBuilderMemberName(): MemberName {
-        val paginationInfo = getPaginationInfoClassName()
-
-        return MemberName(
-            ClassName(
-                paginationInfo.packageName,
-                *paginationInfo.simpleNames.toTypedArray(),
-                "Companion"
-            ), "buildByMap"
-        )
-    }
+    fun getPaginationInfoBuilderMemberName(): MemberName =
+        MemberName(getPaginationInfoClassName().addSimpleNames("Companion"), "buildByMap")
 
     fun getPaginationConnectionClassName(): ClassName {
-        return buildClassName("PaginationConnection", false, "pagination")
+        return buildClassName("PaginationConnection", "pagination")
     }
 
     fun getPaginationEdgeClassName(): ClassName {
-        return buildClassName("PaginationEdge", false, "pagination")
+        return buildClassName("PaginationEdge", "pagination")
     }
 
     fun getPaginationPageInfoClassName(): ClassName {
-        return buildClassName("PaginationPageInfo", false, "pagination")
+        return buildClassName("PaginationPageInfo", "pagination")
     }
 
     /**
@@ -137,18 +115,27 @@ internal class GeneratedMapper(
      */
     private fun buildClassName(
         className: String,
-        appendCompanion: Boolean = false,
         additionalPackage: String = ""
     ): ClassName {
+        // Create the package for the Classname.
         val fullPackage = options.generatedBasePackage + "." + additionalPackage
 
+        // Augment the name of the class with the global prefix.
         val augmented =
             if (options.generatedGlobalPrefix == null) className
             else "${options.generatedGlobalPrefix}$className"
 
-        return if (appendCompanion)
-            ClassName(fullPackage, augmented, "Companion")
-        else
-            ClassName(fullPackage, augmented)
+        // Build the ClassName.
+        return ClassName(fullPackage, augmented)
+    }
+
+    /**
+     * Will create a copy of the [ClassName] and add the given [name]s as [ClassName.simpleNames].
+     *
+     * @param name The names to add as simple names to the ClassName.
+     * @return The new [ClassName] with the added simple names.
+     */
+    private fun ClassName.addSimpleNames(vararg name: String): ClassName {
+        return ClassName(this.packageName, *this.simpleNames.toTypedArray(), *name)
     }
 }

graphql-kotlin-toolkit-codegen/src/main/kotlin/com/auritylab/graphql/kotlin/toolkit/codegen/mapper/KotlinTypeMapper.kt

@@ -168,6 +168,6 @@ internal class KotlinTypeMapper(
      */
     private fun resolveGeneratedClass(type: GraphQLType): ClassName =
         if (options.generateAll || (type is GraphQLDirectiveContainer && DirectiveFacade.generate[type]))
-            generatedMapper.getGeneratedTypeClassName(type, false)
+            generatedMapper.getGeneratedTypeClassName(type)
         else ANY
 }