feat: remove requirement for @Property: prefix (#97)

* feat: remove requirment for @Property: prefix

* test: annotations on different types

* fix: simplify constructor find logic

* test: remove duplicate test

* test: linter - use data class

* test: increase test coverage

Author: smyrick

example/src/main/kotlin/com.expedia.graphql.sample/model/Widget.kt

@@ -5,16 +5,16 @@ import com.expedia.graphql.annotations.GraphQLIgnore
 
 @GraphQLDescription("A useful widget")
 data class Widget(
-    @property:GraphQLDescription("The widget's value that can be null")
+    @GraphQLDescription("The widget's value that can be null")
     var value: Int? = null,
-    @property:Deprecated(message = "This field is deprecated", replaceWith = ReplaceWith("value"))
-    @property:GraphQLDescription("The widget's deprecated value that shouldn't be used")
+    @Deprecated(message = "This field is deprecated", replaceWith = ReplaceWith("value"))
+    @GraphQLDescription("The widget's deprecated value that shouldn't be used")
     val deprecatedValue: Int? = value,
-    @property:GraphQLIgnore
+    @GraphQLIgnore
     val ignoredField: String? = "ignored",
     private val hiddenField: String? = "hidden"
 ) {
 
     @GraphQLDescription("returns original value multiplied by target OR null if original value was null")
     fun multiplyValueBy(multiplier: Int) = value?.times(multiplier)
-}
+}

example/src/main/kotlin/com.expedia.graphql.sample/query/ScalarQuery.kt

@@ -24,8 +24,8 @@ class ScalarMutation : Mutation {
 }
 
 data class Person(
-    @property:GraphQLID
+    @GraphQLID
     val id: Int,
 
     val name: String
-)
+)

src/main/kotlin/com/expedia/graphql/schema/extensions/annotationExtensions.kt

@@ -3,19 +3,18 @@ package com.expedia.graphql.schema.extensions
 import com.expedia.graphql.annotations.GraphQLDescription
 import com.expedia.graphql.annotations.GraphQLID
 import com.expedia.graphql.annotations.GraphQLIgnore
-import java.lang.reflect.Field
 import kotlin.reflect.KAnnotatedElement
 import kotlin.reflect.full.findAnnotation
 
-internal fun KAnnotatedElement.graphQLDescription(): String? = this.findAnnotation<GraphQLDescription>()?.value
-
-internal fun Field.graphQLDescription(): String? = this.getAnnotation(GraphQLDescription::class.java)?.value
+internal fun KAnnotatedElement.getGraphQLDescription(): String? = this.findAnnotation<GraphQLDescription>()?.value
 
 internal fun KAnnotatedElement.getDeprecationReason(): String? = this.findAnnotation<Deprecated>()?.getReason()
 
-internal fun Field.getDeprecationReason(): String? = this.getDeclaredAnnotation(Deprecated::class.java)?.getReason()
+internal fun KAnnotatedElement.isGraphQLIgnored(): Boolean = this.findAnnotation<GraphQLIgnore>() != null
+
+internal fun KAnnotatedElement.isGraphQLID(): Boolean = this.findAnnotation<GraphQLID>() != null
 
-private fun Deprecated.getReason(): String? {
+internal fun Deprecated.getReason(): String? {
     val builder = StringBuilder()
     builder.append(this.message)
 
@@ -26,7 +25,3 @@ private fun Deprecated.getReason(): String? {
 
     return builder.toString()
 }
-
-internal fun KAnnotatedElement.isGraphQLIgnored() = this.findAnnotation<GraphQLIgnore>() != null
-
-internal fun KAnnotatedElement.isGraphQLID() = this.findAnnotation<GraphQLID>() != null

src/main/kotlin/com/expedia/graphql/schema/extensions/booleanExtensions.kt

@@ -0,0 +1,3 @@
+package com.expedia.graphql.schema.extensions
+
+internal fun Boolean?.isTrue(): Boolean = this == true

src/main/kotlin/com/expedia/graphql/schema/extensions/fieldExtenstions.kt

@@ -0,0 +1,8 @@
+package com.expedia.graphql.schema.extensions
+
+import com.expedia.graphql.annotations.GraphQLDescription
+import java.lang.reflect.Field
+
+internal fun Field.getGraphQLDescription(): String? = this.getAnnotation(GraphQLDescription::class.java)?.value
+
+internal fun Field.getDeprecationReason(): String? = this.getDeclaredAnnotation(Deprecated::class.java)?.getReason()

src/main/kotlin/com/expedia/graphql/schema/extensions/kClassExtensions.kt

@@ -4,17 +4,28 @@ import com.expedia.graphql.schema.generator.functionFilters
 import com.expedia.graphql.schema.generator.propertyFilters
 import com.expedia.graphql.schema.hooks.SchemaGeneratorHooks
 import kotlin.reflect.KClass
+import kotlin.reflect.KFunction
+import kotlin.reflect.KParameter
+import kotlin.reflect.KProperty
 import kotlin.reflect.full.declaredMemberFunctions
 import kotlin.reflect.full.declaredMemberProperties
 import kotlin.reflect.full.isSubclassOf
-
-internal fun KClass<*>.getValidProperties(hooks: SchemaGeneratorHooks) = this.declaredMemberProperties
-    .filter { hooks.isValidProperty(it) }
-    .filter { prop -> propertyFilters.all { it.invoke(prop) } }
-
-internal fun KClass<*>.getValidFunctions(hooks: SchemaGeneratorHooks) = this.declaredMemberFunctions
-    .filter { hooks.isValidFunction(it) }
-    .filter { func -> functionFilters.all { it.invoke(func) } }
+import kotlin.reflect.full.primaryConstructor
+
+internal fun KClass<*>.getValidProperties(hooks: SchemaGeneratorHooks): List<KProperty<*>> =
+    this.declaredMemberProperties
+        .filter { hooks.isValidProperty(it) }
+        .filter { prop -> propertyFilters.all { it.invoke(prop, this) } }
+
+internal fun KClass<*>.getValidFunctions(hooks: SchemaGeneratorHooks): List<KFunction<*>> =
+    this.declaredMemberFunctions
+        .filter { hooks.isValidFunction(it) }
+        .filter { func -> functionFilters.all { it.invoke(func) } }
+
+internal fun KClass<*>.findConstructorParamter(name: String): KParameter? =
+    this.primaryConstructor
+        ?.parameters
+        ?.find { it.name == name }
 
 internal fun KClass<*>.isGraphQLInterface(): Boolean = this.java.isInterface
 

src/main/kotlin/com/expedia/graphql/schema/extensions/kPropertyExtensions.kt

@@ -0,0 +1,26 @@
+package com.expedia.graphql.schema.extensions
+
+import kotlin.reflect.KClass
+import kotlin.reflect.KProperty
+
+internal fun KProperty<*>.isPropertyGraphQLID(parentClass: KClass<*>): Boolean = when {
+    this.isGraphQLID() -> true
+    parentClass.findConstructorParamter(this.name)
+        ?.isGraphQLID()
+        .isTrue() -> true
+    else -> false
+}
+
+internal fun KProperty<*>.isPropertyGraphQLIgnored(parentClass: KClass<*>): Boolean = when {
+    this.isGraphQLIgnored() -> true
+    parentClass.findConstructorParamter(this.name)
+        ?.isGraphQLIgnored()
+        .isTrue() -> true
+    else -> false
+}
+
+internal fun KProperty<*>.getPropertyDeprecationReason(parentClass: KClass<*>): String? =
+    this.getDeprecationReason() ?: parentClass.findConstructorParamter(this.name)?.getDeprecationReason()
+
+internal fun KProperty<*>.getPropertyDescription(parentClass: KClass<*>): String? =
+    this.getGraphQLDescription() ?: parentClass.findConstructorParamter(this.name)?.getGraphQLDescription()

src/main/kotlin/com/expedia/graphql/schema/extensions/kTypeExtensions.kt

@@ -6,8 +6,6 @@ import kotlin.reflect.KType
 import kotlin.reflect.full.createType
 import kotlin.reflect.full.isSubclassOf
 
-internal fun KType.graphQLDescription(): String? = (classifier as? KClass<*>)?.graphQLDescription()
-
 @Throws(InvalidListTypeException::class)
 internal fun KType.getTypeOfFirstArgument(): KType =
     this.arguments.firstOrNull()?.type ?: throw InvalidListTypeException(this)

src/main/kotlin/com/expedia/graphql/schema/generator/SchemaGenerator.kt

@@ -95,8 +95,8 @@ internal class SchemaGenerator(
     internal fun function(fn: KFunction<*>, target: Any? = null, abstract: Boolean = false) =
         functionTypeBuilder.function(fn, target, abstract)
 
-    internal fun property(prop: KProperty<*>) =
-        propertyTypeBuilder.property(prop)
+    internal fun property(prop: KProperty<*>, parentClass: KClass<*>) =
+        propertyTypeBuilder.property(prop, parentClass)
 
     internal fun listType(type: KType, inputType: Boolean) =
         listTypeBuilder.listType(type, inputType)

src/main/kotlin/com/expedia/graphql/schema/generator/schemaFilters.kt

@@ -1,25 +1,29 @@
 package com.expedia.graphql.schema.generator
 
 import com.expedia.graphql.schema.extensions.isGraphQLIgnored
+import com.expedia.graphql.schema.extensions.isPropertyGraphQLIgnored
 import kotlin.reflect.KAnnotatedElement
 import kotlin.reflect.KCallable
+import kotlin.reflect.KClass
 import kotlin.reflect.KFunction
 import kotlin.reflect.KProperty
 import kotlin.reflect.KVisibility
 
 private typealias CallableFilter = (KCallable<*>) -> Boolean
 private typealias AnnotatedElementFilter = (KAnnotatedElement) -> Boolean
-private typealias PropertyFilter = (KProperty<*>) -> Boolean
+private typealias PropertyFilter = (KProperty<*>, KClass<*>) -> Boolean
 private typealias FunctionFilter = (KFunction<*>) -> Boolean
 
 private val blackListFunctions: List<String> = listOf("annotationType", "toString", "copy", "equals", "hashCode")
 private val componentFunctionRegex = Regex("component([0-9]+)")
 
 private val isPublic: CallableFilter = { it.visibility == KVisibility.PUBLIC }
+private val isPropertyPublic: PropertyFilter = { prop, _ -> isPublic(prop) }
 private val isNotGraphQLIgnored: AnnotatedElementFilter = { it.isGraphQLIgnored().not() }
+private val isPropertyNotGraphQLIgnored: PropertyFilter = { prop, parentClass -> prop.isPropertyGraphQLIgnored(parentClass).not() }
 private val isBlacklistedFunction: FunctionFilter = { blackListFunctions.contains(it.name) }
 private val isComponentFunction: FunctionFilter = { it.name.matches(componentFunctionRegex) }
 private val isNotBlackListed: FunctionFilter = { (isBlacklistedFunction(it) || isComponentFunction(it)).not() }
 
-internal val propertyFilters: List<PropertyFilter> = listOf(isPublic, isNotGraphQLIgnored)
+internal val propertyFilters: List<PropertyFilter> = listOf(isPropertyPublic, isPropertyNotGraphQLIgnored)
 internal val functionFilters: List<FunctionFilter> = listOf(isPublic, isNotGraphQLIgnored, isNotBlackListed)