Support custom names via @GraphQLName (#211)

sgeb · smyrick · commit ee67a5aa0cb1 · 2019-04-10T15:12:25.000-07:00
diff --git a/src/main/kotlin/com/expedia/graphql/annotations/GraphQLName.kt b/src/main/kotlin/com/expedia/graphql/annotations/GraphQLName.kt
@@ -0,0 +1,7 @@
+package com.expedia.graphql.annotations
+
+/**
+ * Set the GraphQL name to be picked up by the schema generator.
+ */
+@Target(AnnotationTarget.CLASS)
+annotation class GraphQLName(val value: String)
diff --git a/src/main/kotlin/com/expedia/graphql/generator/extensions/annotationExtensions.kt b/src/main/kotlin/com/expedia/graphql/generator/extensions/annotationExtensions.kt
@@ -3,11 +3,14 @@ package com.expedia.graphql.generator.extensions
 import com.expedia.graphql.annotations.GraphQLDescription
 import com.expedia.graphql.annotations.GraphQLID
 import com.expedia.graphql.annotations.GraphQLIgnore
+import com.expedia.graphql.annotations.GraphQLName
 import kotlin.reflect.KAnnotatedElement
 import kotlin.reflect.full.findAnnotation
 
 internal fun KAnnotatedElement.getGraphQLDescription(): String? = this.findAnnotation<GraphQLDescription>()?.value
 
+internal fun KAnnotatedElement.getGraphQLName(): String? = this.findAnnotation<GraphQLName>()?.value
+
 internal fun KAnnotatedElement.getDeprecationReason(): String? = this.findAnnotation<Deprecated>()?.getReason()
 
 internal fun KAnnotatedElement.isGraphQLIgnored(): Boolean = this.findAnnotation<GraphQLIgnore>() != null
diff --git a/src/main/kotlin/com/expedia/graphql/generator/extensions/kClassExtensions.kt b/src/main/kotlin/com/expedia/graphql/generator/extensions/kClassExtensions.kt
@@ -54,7 +54,9 @@ internal fun KClass<*>.isListType(): Boolean = this.isList() || this.isArray()
 
 @Throws(CouldNotGetNameOfKClassException::class)
 internal fun KClass<*>.getSimpleName(isInputClass: Boolean = false): String {
-    val name = this.simpleName ?: throw CouldNotGetNameOfKClassException(this)
+    val name = this.getGraphQLName()
+        ?: this.simpleName
+        ?: throw CouldNotGetNameOfKClassException(this)
 
     return when {
         isInputClass -> if (name.endsWith(INPUT_SUFFIX)) name else "$name$INPUT_SUFFIX"
diff --git a/src/test/kotlin/com/expedia/graphql/generator/SchemaGeneratorTest.kt b/src/test/kotlin/com/expedia/graphql/generator/SchemaGeneratorTest.kt
@@ -4,6 +4,7 @@ import com.expedia.graphql.TopLevelObject
 import com.expedia.graphql.annotations.GraphQLDescription
 import com.expedia.graphql.annotations.GraphQLID
 import com.expedia.graphql.annotations.GraphQLIgnore
+import com.expedia.graphql.annotations.GraphQLName
 import com.expedia.graphql.exceptions.ConflictingTypesException
 import com.expedia.graphql.exceptions.GraphQLKotlinException
 import com.expedia.graphql.exceptions.InvalidIdTypeException
@@ -129,6 +130,27 @@ class SchemaGeneratorTest {
         assertEquals("SomeEnum!", topLevelQuery.getFieldDefinition("query").type.deepName)
     }
 
+    @Test
+    fun `SchemaGenerator names types according to custom name in @GraphQLName`() {
+        val schema = toSchema(queries = listOf(TopLevelObject(QueryWithCustomName())), config = testSchemaConfig)
+        val topLevelQuery = schema.getObjectType("Query")
+
+        assertEquals("SomeInputObjectRenamedInput!", topLevelQuery.getFieldDefinition("query").getArgument("someInputObjectWithCustomName").type.deepName)
+        assertEquals("SomeEnumRenamed!", topLevelQuery.getFieldDefinition("query").getArgument("someEnumWithCustomName").type.deepName)
+        assertEquals("SomeObjectWithDefaultNameInput!", topLevelQuery.getFieldDefinition("query").getArgument("someObjectWithDefaultName").type.deepName)
+        assertEquals("SomeOtherObjectRenamed!", topLevelQuery.getFieldDefinition("query").type.deepName)
+    }
+
+    @Test
+    fun `SchemaGenerator names self-referencing types according to custom name in @GraphQLName`() {
+        val schema = toSchema(queries = listOf(TopLevelObject(QuerySelfReferencingWithCustomName())), config = testSchemaConfig)
+        val topLevelQuery = schema.getObjectType("Query")
+        val resultType = schema.getObjectType("ObjectSelfReferencingRenamed")
+
+        assertEquals("ObjectSelfReferencingRenamed!", topLevelQuery.getFieldDefinition("query").type.deepName)
+        assertEquals("ObjectSelfReferencingRenamed", resultType.getFieldDefinition("self").type.deepName)
+    }
+
     @Test
     fun `SchemaGenerator documents types annotated with @Description`() {
         val schema = toSchema(
@@ -415,6 +437,46 @@ class SchemaGeneratorTest {
         fun query(): InvalidIds = InvalidIds(Person("person id not a valid type id"))
     }
 
+    data class SomeObjectWithDefaultName(val title: String)
+
+    @GraphQLName("SomeObjectRenamed")
+    data class SomeObjectWithCustomName(val title: String)
+
+    @GraphQLName("SomeOtherObjectRenamed")
+    data class SomeOtherObjectWithCustomName(
+        val title: String,
+        val someObject: SomeObjectWithCustomName,
+        val someEnum: SomeEnumWithCustomName
+    )
+
+    @GraphQLName("SomeInputObjectRenamed")
+    data class SomeInputObjectWithCustomName(val title: String)
+
+    @GraphQLName("SomeEnumRenamed")
+    enum class SomeEnumWithCustomName { ONE, TWO }
+
+    class QueryWithCustomName {
+        fun query(
+            someInputObjectWithCustomName: SomeInputObjectWithCustomName,
+            someEnumWithCustomName: SomeEnumWithCustomName,
+            someObjectWithDefaultName: SomeObjectWithDefaultName
+        ): SomeOtherObjectWithCustomName =
+            SomeOtherObjectWithCustomName(
+                title = someObjectWithDefaultName.title,
+                someObject = SomeObjectWithCustomName("something"),
+                someEnum = someEnumWithCustomName
+            )
+    }
+
+    @GraphQLName("ObjectSelfReferencingRenamed")
+    data class ObjectSelfReferencingWithCustomName(
+        val self: ObjectSelfReferencingWithCustomName? = null
+    )
+
+    class QuerySelfReferencingWithCustomName {
+        fun query(): ObjectSelfReferencingWithCustomName = ObjectSelfReferencingWithCustomName()
+    }
+
     class MutationWithId {
         fun mutate(furniture: Furniture): Furniture = furniture
     }
diff --git a/src/test/kotlin/com/expedia/graphql/generator/extensions/AnnotationExtensionsTest.kt b/src/test/kotlin/com/expedia/graphql/generator/extensions/AnnotationExtensionsTest.kt
@@ -3,6 +3,7 @@ package com.expedia.graphql.generator.extensions
 import com.expedia.graphql.annotations.GraphQLDescription
 import com.expedia.graphql.annotations.GraphQLID
 import com.expedia.graphql.annotations.GraphQLIgnore
+import com.expedia.graphql.annotations.GraphQLName
 import org.junit.jupiter.api.Test
 import kotlin.reflect.full.declaredMemberProperties
 import kotlin.test.assertEquals
@@ -13,6 +14,7 @@ import kotlin.test.assertTrue
 @Suppress("Detekt.UnusedPrivateClass")
 internal class AnnotationExtensionsTest {
 
+    @GraphQLName("WithAnnotationsCustomName")
     @GraphQLDescription("class description")
     @Deprecated("class deprecated")
     @GraphQLIgnore
@@ -25,6 +27,12 @@ internal class AnnotationExtensionsTest {
 
     private data class NoAnnotations(val id: String)
 
+    @Test
+    fun `verify @GraphQLName on classes`() {
+        assertEquals(expected = "WithAnnotationsCustomName", actual = WithAnnotations::class.getGraphQLName())
+        assertNull(NoAnnotations::class.getGraphQLName())
+    }
+
     @Test
     fun `verify @GraphQLDescrption on classes`() {
         assertEquals(expected = "class description", actual = WithAnnotations::class.getGraphQLDescription())
diff --git a/src/test/kotlin/com/expedia/graphql/generator/extensions/KClassExtensionsTest.kt b/src/test/kotlin/com/expedia/graphql/generator/extensions/KClassExtensionsTest.kt
@@ -1,5 +1,6 @@
 package com.expedia.graphql.generator.extensions
 
+import com.expedia.graphql.annotations.GraphQLName
 import com.expedia.graphql.exceptions.CouldNotGetNameOfKClassException
 import com.expedia.graphql.hooks.NoopSchemaGeneratorHooks
 import com.expedia.graphql.hooks.SchemaGeneratorHooks
@@ -48,10 +49,16 @@ open class KClassExtensionsTest {
         private fun privateTestFunction() = "private function"
     }
 
+    @GraphQLName("MyTestClassRenamed")
+    private class MyTestClassCustomName
+
     internal class MyInternalClass
 
     class MyClassInput
 
+    @GraphQLName("MyClassRenamedInput")
+    class MyClassCustomNameInput
+
     protected class MyProtectedClass
 
     class MyPublicClass
@@ -209,12 +216,23 @@ open class KClassExtensionsTest {
         }
     }
 
+    @Test
+    fun `test class simple name with GraphQLName`() {
+        assertEquals("MyTestClassRenamed", MyTestClassCustomName::class.getSimpleName())
+    }
+
     @Test
     fun `test input class name`() {
         assertEquals("MyTestClassInput", MyTestClass::class.getSimpleName(true))
         assertEquals("MyClassInput", MyClassInput::class.getSimpleName(true))
     }
 
+    @Test
+    fun `test input class name with GraphQLName`() {
+        assertEquals("MyTestClassRenamedInput", MyTestClassCustomName::class.getSimpleName(true))
+        assertEquals("MyClassRenamedInput", MyClassCustomNameInput::class.getSimpleName(true))
+    }
+
     @Test
     fun getQualifiedName() {
         assertEquals("com.expedia.graphql.generator.extensions.KClassExtensionsTest.MyTestClass", MyTestClass::class.getQualifiedName())
diff --git a/src/test/kotlin/com/expedia/graphql/generator/types/EnumBuilderTest.kt b/src/test/kotlin/com/expedia/graphql/generator/types/EnumBuilderTest.kt
@@ -1,6 +1,7 @@
 package com.expedia.graphql.generator.types
 
 import com.expedia.graphql.annotations.GraphQLDescription
+import com.expedia.graphql.annotations.GraphQLName
 import com.expedia.graphql.test.utils.CustomDirective
 import com.expedia.graphql.test.utils.SimpleDirective
 import org.junit.jupiter.api.Test
@@ -30,6 +31,10 @@ internal class EnumBuilderTest : TypeTestHelper() {
         THREE
     }
 
+    @Suppress("Detekt.UnusedPrivateClass")
+    @GraphQLName("MyTestEnumRenamed")
+    private enum class MyTestEnumCustomName
+
     lateinit var builder: EnumBuilder
 
     override fun beforeTest() {
@@ -47,6 +52,12 @@ internal class EnumBuilderTest : TypeTestHelper() {
         assertEquals(expected = "THREE", actual = actual.values[2].value)
     }
 
+    @Test
+    fun `Custom name on enum class`() {
+        val gqlEnum = assertNotNull(builder.enumType(MyTestEnumCustomName::class))
+        assertEquals("MyTestEnumRenamed", gqlEnum.name)
+    }
+
     @Test
     fun `Description on enum class and values`() {
         val gqlEnum = assertNotNull(builder.enumType(MyTestEnum::class))
diff --git a/src/test/kotlin/com/expedia/graphql/generator/types/InputObjectBuilderTest.kt b/src/test/kotlin/com/expedia/graphql/generator/types/InputObjectBuilderTest.kt
@@ -1,6 +1,7 @@
 package com.expedia.graphql.generator.types
 
 import com.expedia.graphql.annotations.GraphQLDescription
+import com.expedia.graphql.annotations.GraphQLName
 import com.expedia.graphql.test.utils.SimpleDirective
 import org.junit.jupiter.api.Test
 import kotlin.test.assertEquals
@@ -17,17 +18,28 @@ internal class InputObjectBuilderTest : TypeTestHelper() {
     @GraphQLDescription("The truth")
     @SimpleDirective
     private class InputClass {
-
         @SimpleDirective
         val myField: String = "car"
     }
 
+    @Suppress("Detekt.UnusedPrivateClass")
+    @GraphQLName("InputClassRenamed")
+    private class InputClassCustomName {
+        val myField: String = "car"
+    }
+
     @Test
     fun `Test naming`() {
         val result = builder.inputObjectType(InputClass::class)
         assertEquals("InputClassInput", result.name)
     }
 
+    @Test
+    fun `Test custom naming`() {
+        val result = builder.inputObjectType(InputClassCustomName::class)
+        assertEquals("InputClassRenamedInput", result.name)
+    }
+
     @Test
     fun `Test description`() {
         val result = builder.inputObjectType(InputClass::class)
diff --git a/src/test/kotlin/com/expedia/graphql/generator/types/InterfaceBuilderTest.kt b/src/test/kotlin/com/expedia/graphql/generator/types/InterfaceBuilderTest.kt
@@ -1,6 +1,7 @@
 package com.expedia.graphql.generator.types
 
 import com.expedia.graphql.annotations.GraphQLDescription
+import com.expedia.graphql.annotations.GraphQLName
 import com.expedia.graphql.test.utils.SimpleDirective
 import graphql.schema.GraphQLInterfaceType
 import org.junit.jupiter.api.Test
@@ -19,12 +20,22 @@ internal class InterfaceBuilderTest : TypeTestHelper() {
     @SimpleDirective
     private interface HappyInterface
 
+    @Suppress("Detekt.UnusedPrivateClass")
+    @GraphQLName("HappyInterfaceRenamed")
+    private interface HappyInterfaceCustomName
+
     @Test
     fun `Test naming`() {
         val result = builder.interfaceType(HappyInterface::class) as? GraphQLInterfaceType
         assertEquals("HappyInterface", result?.name)
     }
 
+    @Test
+    fun `Test custom naming`() {
+        val result = builder.interfaceType(HappyInterfaceCustomName::class) as? GraphQLInterfaceType
+        assertEquals("HappyInterfaceRenamed", result?.name)
+    }
+
     @Test
     fun `Test description`() {
         val result = builder.interfaceType(HappyInterface::class) as? GraphQLInterfaceType
diff --git a/src/test/kotlin/com/expedia/graphql/generator/types/ObjectBuilderTest.kt b/src/test/kotlin/com/expedia/graphql/generator/types/ObjectBuilderTest.kt
@@ -2,6 +2,7 @@ package com.expedia.graphql.generator.types
 
 import com.expedia.graphql.annotations.GraphQLDescription
 import com.expedia.graphql.annotations.GraphQLDirective
+import com.expedia.graphql.annotations.GraphQLName
 import graphql.Scalars
 import graphql.introspection.Introspection
 import graphql.schema.GraphQLNonNull
@@ -26,13 +27,23 @@ internal class ObjectBuilderTest : TypeTestHelper() {
     @ObjectDirective("Don't worry")
     private class BeHappy
 
+    @GraphQLName("BeHappyRenamed")
+    private class BeHappyCustomName
+
     @Test
     fun `Test naming`() {
         val result = builder.objectType(BeHappy::class) as? GraphQLObjectType
         assertNotNull(result)
         assertEquals("BeHappy", result.name)
     }
 
+    @Test
+    fun `Test custom naming`() {
+        val result = builder.objectType(BeHappyCustomName::class) as? GraphQLObjectType
+        assertNotNull(result)
+        assertEquals("BeHappyRenamed", result.name)
+    }
+
     @Test
     fun `Test description`() {
         val result = builder.objectType(BeHappy::class) as? GraphQLObjectType
diff --git a/src/test/kotlin/com/expedia/graphql/generator/types/UnionBuilderTest.kt b/src/test/kotlin/com/expedia/graphql/generator/types/UnionBuilderTest.kt
@@ -1,6 +1,7 @@
 package com.expedia.graphql.generator.types
 
 import com.expedia.graphql.annotations.GraphQLDescription
+import com.expedia.graphql.annotations.GraphQLName
 import com.expedia.graphql.test.utils.SimpleDirective
 import graphql.schema.GraphQLObjectType
 import graphql.schema.GraphQLUnionType
@@ -24,6 +25,12 @@ internal class UnionBuilderTest : TypeTestHelper() {
     @GraphQLDescription("so red")
     private class StrawBerryCake : Cake
 
+    @GraphQLName("CakeRenamed")
+    private interface CakeCustomName
+
+    @GraphQLName("StrawBerryCakeRenamed")
+    private class StrawBerryCakeCustomName : CakeCustomName
+
     @Test
     fun `Test naming`() {
         val result = builder.unionType(Cake::class) as? GraphQLUnionType
@@ -34,6 +41,16 @@ internal class UnionBuilderTest : TypeTestHelper() {
         assertEquals(StrawBerryCake::class.java.simpleName, result.types[0].name)
     }
 
+    @Test
+    fun `Test custom naming`() {
+        val result = builder.unionType(CakeCustomName::class) as? GraphQLUnionType
+        assertNotNull(result)
+
+        assertEquals("CakeRenamed", result.name)
+        assertEquals(1, result.types.size)
+        assertEquals("StrawBerryCakeRenamed", result.types[0].name)
+    }
+
     @Test
     fun `Test description`() {
         val result = builder.unionType(Cake::class) as? GraphQLUnionType
