Named property request and resolver to make interception easier (#46)

Author: mattmook

fixture/src/main/kotlin/com/appmattus/kotlinfixture/config/Configuration.kt

@@ -44,6 +44,7 @@ import com.appmattus.kotlinfixture.resolver.HashtableKTypeResolver
 import com.appmattus.kotlinfixture.resolver.IterableKTypeResolver
 import com.appmattus.kotlinfixture.resolver.JodaTimeResolver
 import com.appmattus.kotlinfixture.resolver.KFunctionResolver
+import com.appmattus.kotlinfixture.resolver.KNamedPropertyResolver
 import com.appmattus.kotlinfixture.resolver.KTypeResolver
 import com.appmattus.kotlinfixture.resolver.LocaleResolver
 import com.appmattus.kotlinfixture.resolver.MapKTypeResolver
@@ -131,6 +132,7 @@ data class Configuration(
             MapKTypeResolver(),
 
             KTypeResolver(),
+            KNamedPropertyResolver(),
             KFunctionResolver(),
 
             AbstractClassResolver(),

fixture/src/main/kotlin/com/appmattus/kotlinfixture/resolver/ClassResolver.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 Appmattus Limited
+ * Copyright 2020 Appmattus Limited
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -30,7 +30,7 @@ internal class ClassResolver : Resolver, PopulateInstance {
                 context = context,
                 obj = obj,
                 constructorParameterNames = obj.constructorParameterNames(),
-                overrides = context.configuration.properties.getOrElse(obj) { emptyMap() }
+                callingClass = obj
             )
 
             val results = obj.constructors.shuffled().map { constructor ->

fixture/src/main/kotlin/com/appmattus/kotlinfixture/resolver/FactoryMethodResolver.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 Appmattus Limited
+ * Copyright 2020 Appmattus Limited
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -42,10 +42,10 @@ class FactoryMethodResolver : Resolver, PopulateInstance {
                     if (result !is Unresolved) {
                         if (result != null) {
                             val callContext = PopulateInstance.CallContext(
-                                context,
-                                result::class,
+                                context = context,
+                                obj = result::class,
                                 constructorParameterNames = emptySet(),
-                                overrides = context.configuration.properties.getOrElse(obj) { emptyMap() }
+                                callingClass = obj
                             )
 
                             populatePropertiesAndSetters(callContext, result)

fixture/src/main/kotlin/com/appmattus/kotlinfixture/resolver/KFunctionResolver.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 Appmattus Limited
+ * Copyright 2020 Appmattus Limited
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,7 +18,6 @@ package com.appmattus.kotlinfixture.resolver
 
 import com.appmattus.kotlinfixture.Context
 import com.appmattus.kotlinfixture.Unresolved
-import com.appmattus.kotlinfixture.config.DefaultGenerator
 import com.appmattus.kotlinfixture.createUnresolved
 import com.appmattus.kotlinfixture.decorator.optional.OptionalStrategy
 import com.appmattus.kotlinfixture.decorator.optional.RandomlyOptionalStrategy
@@ -36,16 +35,16 @@ internal class KFunctionResolver : Resolver {
             val overrides = context.configuration.properties.getOrElse(obj.containingClass) { emptyMap() }
 
             val parameters = obj.function.parameters.associateWith {
-                if (it.kind == KParameter.Kind.VALUE) {
-                    if (it.name in overrides) {
-                        overrides[it.name]?.invoke(DefaultGenerator(context))
-                    } else {
-                        context.resolve(it.type)
+                when (it.kind) {
+                    KParameter.Kind.VALUE -> {
+                        context.resolve(KNamedPropertyRequest(it.name, obj.containingClass, it.type))
+                    }
+                    KParameter.Kind.INSTANCE -> {
+                        obj.containingClass.companionObjectInstance
+                    }
+                    else -> {
+                        throw IllegalStateException("Unsupported parameter type: $it")
                     }
-                } else if (it.kind == KParameter.Kind.INSTANCE) {
-                    obj.containingClass.companionObjectInstance
-                } else {
-                    throw IllegalStateException("Unsupported parameter type: $it")
                 }
             }.filterKeys {
                 with(context) {

fixture/src/main/kotlin/com/appmattus/kotlinfixture/resolver/KNamedPropertyRequest.kt

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2020 Appmattus Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.appmattus.kotlinfixture.resolver
+
+import kotlin.reflect.KClass
+import kotlin.reflect.KType
+
+internal data class KNamedPropertyRequest(
+    val name: String?,
+    val containingClass: KClass<*>,
+    val type: KType
+)

fixture/src/main/kotlin/com/appmattus/kotlinfixture/resolver/KNamedPropertyResolver.kt

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2020 Appmattus Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.appmattus.kotlinfixture.resolver
+
+import com.appmattus.kotlinfixture.Context
+import com.appmattus.kotlinfixture.Unresolved
+import com.appmattus.kotlinfixture.config.DefaultGenerator
+
+internal class KNamedPropertyResolver : Resolver {
+    override fun resolve(context: Context, obj: Any): Any? {
+        if (obj is KNamedPropertyRequest) {
+            val overrides = context.configuration.properties.getOrElse(obj.containingClass) { emptyMap() }
+
+            return if (obj.name in overrides) {
+                overrides[obj.name]?.invoke(DefaultGenerator(context))
+            } else {
+                context.resolve(obj.type)
+            }
+        }
+
+        return Unresolved.Unhandled
+    }
+}

fixture/src/main/kotlin/com/appmattus/kotlinfixture/resolver/PopulateInstance.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 Appmattus Limited
+ * Copyright 2020 Appmattus Limited
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,8 +18,6 @@ package com.appmattus.kotlinfixture.resolver
 
 import com.appmattus.kotlinfixture.Context
 import com.appmattus.kotlinfixture.Unresolved
-import com.appmattus.kotlinfixture.config.GeneratorFun
-import com.appmattus.kotlinfixture.config.DefaultGenerator
 import kotlin.reflect.KClass
 import kotlin.reflect.KFunction
 import kotlin.reflect.KMutableProperty
@@ -34,16 +32,15 @@ internal interface PopulateInstance {
         val context: Context,
         val obj: KClass<*>,
         val constructorParameterNames: Set<String?>,
-        val overrides: Map<String, GeneratorFun>
+        val callingClass: KClass<*>
     )
 
     fun populatePropertiesAndSetters(
         callContext: CallContext,
         result: Any?
     ): Boolean {
         return try {
-            populateKotlinProperties(callContext, result) &&
-                    populateJavaSetters(callContext, result)
+            populateKotlinProperties(callContext, result) && populateJavaSetters(callContext, result)
         } catch (expected: Error) {
             // If retrieving setters fails we fail regardless of constructor used
             false
@@ -60,11 +57,9 @@ internal interface PopulateInstance {
             val name = it.name.removePrefix("set").decapitalize()
             callContext.constructorParameterNames.contains(name)
         }.forEach {
-            val propertyResult = if (it.name in callContext.overrides) {
-                callContext.overrides[it.name]?.invoke(DefaultGenerator(callContext.context))
-            } else {
-                callContext.context.resolve(it.valueParameters[0].type)
-            }
+            val propertyResult = callContext.context.resolve(
+                KNamedPropertyRequest(it.name, callContext.callingClass, it.valueParameters[0].type)
+            )
 
             if (propertyResult is Unresolved) {
                 return false
@@ -83,11 +78,9 @@ internal interface PopulateInstance {
         callContext.obj.settableMutableProperties()
             .filterNot { callContext.constructorParameterNames.contains(it.name) }
             .forEach { property ->
-                val propertyResult = if (property.name in callContext.overrides) {
-                    callContext.overrides[property.name]?.invoke(DefaultGenerator(callContext.context))
-                } else {
-                    callContext.context.resolve(property.returnType)
-                }
+                val propertyResult = callContext.context.resolve(
+                    KNamedPropertyRequest(property.name, callContext.callingClass, property.returnType)
+                )
 
                 if (propertyResult is Unresolved) {
                     return false

fixture/src/test/kotlin/com/appmattus/kotlinfixture/resolver/ClassResolverTest.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 Appmattus Limited
+ * Copyright 2020 Appmattus Limited
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -31,7 +31,14 @@ import kotlin.test.assertTrue
 class ClassResolverTest {
     private val context = TestContext(
         Configuration(),
-        CompositeResolver(PrimitiveResolver(), StringResolver(), KTypeResolver(), ClassResolver(), KFunctionResolver())
+        CompositeResolver(
+            PrimitiveResolver(),
+            StringResolver(),
+            KTypeResolver(),
+            ClassResolver(),
+            KNamedPropertyResolver(),
+            KFunctionResolver()
+        )
     )
 
     @Test

fixture/src/test/kotlin/com/appmattus/kotlinfixture/resolver/FactoryMethodResolverTest.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 Appmattus Limited
+ * Copyright 2020 Appmattus Limited
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -34,6 +34,7 @@ class FactoryMethodResolverTest {
             PrimitiveResolver(),
             StringResolver(),
             KTypeResolver(),
+            KNamedPropertyResolver(),
             FactoryMethodResolver(),
             KFunctionResolver()
         )

fixture/src/test/kotlin/com/appmattus/kotlinfixture/resolver/IterableKTypeResolverTest.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 Appmattus Limited
+ * Copyright 2020 Appmattus Limited
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -119,6 +119,7 @@ class IterableKTypeResolverTest {
                 PrimitiveResolver(),
                 KTypeResolver(),
                 KFunctionResolver(),
+                KNamedPropertyResolver(),
                 ClassResolver()
             )
         )