GH-62 Improve References handling, provide better Kotlin support and release 1.11.4

dzikoysk · dzikoysk · commit efb83a1ce1b3 · 2021-10-25T23:12:33.000+02:00
diff --git a/.github/README.md b/.github/README.md
@@ -36,9 +36,9 @@ repositories {
 
 dependencies {
     // Default
-    implementation 'net.dzikoysk:cdn:1.11.2'
+    implementation 'net.dzikoysk:cdn:1.11.4'
     // Kotlin wrapper
-    implementation 'net.dzikoysk:cdn-kt:1.11.2'
+    implementation 'net.dzikoysk:cdn-kt:1.11.4'
 }
 ```
 
diff --git a/cdn-kt/pom.xml b/cdn-kt/pom.xml
@@ -19,7 +19,7 @@
     <parent>
         <artifactId>cdn-parent</artifactId>
         <groupId>net.dzikoysk</groupId>
-        <version>1.11.2</version>
+        <version>1.11.4</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
@@ -76,13 +76,23 @@
                         <goals>
                             <goal>compile</goal>
                         </goals>
+                        <configuration>
+                            <sourceDirs>
+                                <sourceDir>${project.basedir}/src/main/kotlin</sourceDir>
+                            </sourceDirs>
+                        </configuration>
                     </execution>
                     <execution>
                         <id>test-compile</id>
                         <phase>test-compile</phase>
                         <goals>
                             <goal>test-compile</goal>
                         </goals>
+                        <configuration>
+                            <sourceDirs>
+                                <sourceDir>${project.basedir}/src/main/kotlin</sourceDir>
+                            </sourceDirs>
+                        </configuration>
                     </execution>
                 </executions>
                 <configuration>
diff --git a/cdn-kt/src/main/kotlin/net/dzikoysk/cdn/KCdn.kt b/cdn-kt/src/main/kotlin/net/dzikoysk/cdn/KCdn.kt
@@ -27,13 +27,13 @@ class KCdn(val cdn: Cdn) {
         fun configure(): CdnSettings = CdnSettings()
     }
 
-    fun parse(source: Source): KConfiguration = KConfiguration(cdn.load(source))
+    fun load(source: Source): KConfiguration = KConfiguration(cdn.load(source))
 
-    fun <T : Any> parse(source: Source, template: KClass<T>): T = cdn.load(source, template.java)
+    inline fun <reified T : Any> load(source: Source): T = this.load(source, T::class)
 
-    fun <T : Any> parse(source: Source, instance: T): T = cdn.load(source, instance)
+    fun <T : Any> load(source: Source, template: KClass<T>): T = cdn.load(source, template.java)
 
-    inline fun <reified T : Any> parseAs(source: Source): T = this.parse(source, T::class)
+    fun <T : Any> load(source: Source, instance: T): T = cdn.load(source, instance)
 
     fun render(element: KNamedElement<*>): String = cdn.render(element.namedElement)
 
diff --git a/cdn-kt/src/main/kotlin/net/dzikoysk/cdn/annotation/KPropertyMember.kt b/cdn-kt/src/main/kotlin/net/dzikoysk/cdn/annotation/KPropertyMember.kt
@@ -3,13 +3,14 @@ package net.dzikoysk.cdn.annotation
 import panda.std.stream.PandaStream
 import java.lang.reflect.AnnotatedType
 import kotlin.reflect.KMutableProperty
+import kotlin.reflect.KProperty
 import kotlin.reflect.jvm.javaField
 import kotlin.reflect.jvm.javaGetter
 
-internal class KPropertyMember(private val instance: Any, private val  property: KMutableProperty<*>) : AnnotatedMember {
+internal class KPropertyMember(private val instance: Any, private val property: KProperty<*>) : AnnotatedMember {
 
     override fun setValue(value: Any?) {
-        property.setter.call(instance, value)
+        (property as KMutableProperty).setter.call(instance, value)
     }
 
     override fun getValue(): Any? {
diff --git a/cdn-kt/src/main/kotlin/net/dzikoysk/cdn/annotation/KotlinMemberResolver.kt b/cdn-kt/src/main/kotlin/net/dzikoysk/cdn/annotation/KotlinMemberResolver.kt
@@ -1,9 +1,13 @@
 package net.dzikoysk.cdn.annotation
 
+import net.dzikoysk.cdn.model.Reference
 import panda.utilities.StringUtils
 import java.lang.reflect.Field
 import kotlin.reflect.KMutableProperty
+import kotlin.reflect.KTypeProjection
+import kotlin.reflect.full.createType
 import kotlin.reflect.full.functions
+import kotlin.reflect.full.isSubtypeOf
 import kotlin.reflect.full.memberProperties
 
 class KotlinMemberResolver : MemberResolver {
@@ -30,9 +34,13 @@ class KotlinMemberResolver : MemberResolver {
     }
 
     override fun getProperties(instance: Any): List<AnnotatedMember> {
-        return instance::class.memberProperties
-            .filterIsInstance<KMutableProperty<*>>()
-            .map { KPropertyMember(instance, it) }
+        return instance::class.memberProperties.mapNotNull {
+            when {
+                it is KMutableProperty<*> -> KPropertyMember(instance, it)
+                it.returnType.isSubtypeOf(Reference::class.createType(listOf(KTypeProjection.STAR))) -> KPropertyMember(instance, it)
+                else -> null
+            }
+        }
     }
 
 }
diff --git a/cdn-kt/src/test/kotlin/net/dzikoysk/cdn/kt/KotlinConfiguration.kt b/cdn-kt/src/test/kotlin/net/dzikoysk/cdn/kt/KotlinConfiguration.kt
@@ -17,10 +17,15 @@
 package net.dzikoysk.cdn.kt
 
 import net.dzikoysk.cdn.entity.Description
+import net.dzikoysk.cdn.model.reference
+import java.io.Serializable
 
-class KotlinConfiguration {
+class KotlinConfiguration : Serializable {
 
     @Description("# Description")
     var key = "value"
 
+    @Description("# Description")
+    val reference = reference("ref")
+
 }
diff --git a/cdn-kt/src/test/kotlin/net/dzikoysk/cdn/kt/KotlinReaderTest.kt b/cdn-kt/src/test/kotlin/net/dzikoysk/cdn/kt/KotlinReaderTest.kt
@@ -16,25 +16,24 @@
 
 package net.dzikoysk.cdn.kt
 
-import net.dzikoysk.cdn.CdnFactory
-import net.dzikoysk.cdn.registerKotlinModule
+import net.dzikoysk.cdn.KCdnFactory
 import org.junit.jupiter.api.Assertions.assertEquals
 import org.junit.jupiter.api.Test
 
 class KotlinReaderTest {
 
     @Test
     fun `should load configuration in kotlin`() {
-        val configuration = CdnFactory.createStandard().settings
-            .registerKotlinModule()
-            .build()
-            .load( { "key: custom" }, KotlinConfiguration::class.java)
+        val configuration = KCdnFactory.createStandard().load<KotlinConfiguration> { "key: custom" }
 
         assertEquals("custom", configuration.key)
+        assertEquals("ref", configuration.reference.get())
         assertEquals("""
         # Description
         key: custom
-        """.trimIndent(), CdnFactory.createStandard().settings.registerKotlinModule().build().render(configuration))
+        # Description
+        reference: ref
+        """.trimIndent(), KCdnFactory.createStandard().render(configuration))
     }
 
 }
diff --git a/cdn/pom.xml b/cdn/pom.xml
@@ -19,7 +19,7 @@
     <parent>
         <artifactId>cdn-parent</artifactId>
         <groupId>net.dzikoysk</groupId>
-        <version>1.11.2</version>
+        <version>1.11.4</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
diff --git a/cdn/src/main/java/net/dzikoysk/cdn/CdnDeserializer.java b/cdn/src/main/java/net/dzikoysk/cdn/CdnDeserializer.java
@@ -21,13 +21,11 @@
 import net.dzikoysk.cdn.entity.DeserializationHandler;
 import net.dzikoysk.cdn.model.Element;
 import net.dzikoysk.cdn.model.Section;
+import net.dzikoysk.cdn.serialization.Composer;
 import net.dzikoysk.cdn.serialization.Deserializer;
 import panda.std.Option;
 import panda.utilities.ObjectUtils;
-import panda.utilities.StringUtils;
-
 import java.lang.reflect.Field;
-import java.lang.reflect.Method;
 
 public final class CdnDeserializer<T> {
 
@@ -87,7 +85,10 @@ private void deserializeMember(Section source, AnnotatedMember member) throws Re
 
         Deserializer<Object> deserializer = CdnUtils.findComposer(settings, member.getType(), member.getAnnotatedType(), member);
         Object value = deserializer.deserialize(settings, element, member.getAnnotatedType(), defaultValue, false);
-        member.setValue(value);
+
+        if (value != Composer.MEMBER_ALREADY_PROCESSED) {
+            member.setValue(value);
+        }
     }
 
 }
diff --git a/cdn/src/main/java/net/dzikoysk/cdn/CdnSettings.java b/cdn/src/main/java/net/dzikoysk/cdn/CdnSettings.java
@@ -23,7 +23,6 @@
 import net.dzikoysk.cdn.composers.MapComposer;
 import net.dzikoysk.cdn.composers.ReferenceComposer;
 import net.dzikoysk.cdn.model.MutableReference;
-import net.dzikoysk.cdn.model.MutableReferenceImpl;
 import net.dzikoysk.cdn.model.Reference;
 import net.dzikoysk.cdn.serialization.Composer;
 import net.dzikoysk.cdn.serialization.Deserializer;
@@ -88,7 +87,6 @@ public final class CdnSettings {
 
         withComposer(Reference.class, new ReferenceComposer<>());
         withComposer(MutableReference.class, new ReferenceComposer<>());
-        withComposer(MutableReferenceImpl.class, new ReferenceComposer<>());
 
         withDynamicComposer(Class::isEnum, new EnumComposer());
     }
diff --git a/cdn/src/main/java/net/dzikoysk/cdn/composers/ReferenceComposer.java b/cdn/src/main/java/net/dzikoysk/cdn/composers/ReferenceComposer.java
@@ -19,9 +19,8 @@
 import net.dzikoysk.cdn.CdnSettings;
 import net.dzikoysk.cdn.CdnUtils;
 import net.dzikoysk.cdn.model.Element;
-import net.dzikoysk.cdn.model.MutableReference;
-import net.dzikoysk.cdn.model.MutableReferenceImpl;
 import net.dzikoysk.cdn.model.Reference;
+import net.dzikoysk.cdn.model.ReferenceUtils;
 import net.dzikoysk.cdn.serialization.Composer;
 import net.dzikoysk.cdn.serialization.Deserializer;
 import net.dzikoysk.cdn.serialization.Serializer;
@@ -38,13 +37,9 @@ public T deserialize(CdnSettings settings, Element<?> source, AnnotatedType type
         AnnotatedType referenceType = annotatedParameterizedType.getAnnotatedActualTypeArguments()[0];
         Deserializer<Object> deserializer = CdnUtils.findComposer(settings, referenceType, null);
         Object value = deserializer.deserialize(settings, source, referenceType, defaultValue, entryAsRecord);
-
-        if (defaultValue instanceof MutableReference) {
-            ((MutableReference<T>) defaultValue).update((T) value);
-            return defaultValue;
-        }
-
-        return (T) new MutableReferenceImpl<>(value);
+        Reference<Object> reference = (Reference<Object>) defaultValue;
+        ReferenceUtils.setValue(reference, value);
+        return (T) MEMBER_ALREADY_PROCESSED;
     }
 
     @Override
diff --git a/cdn/src/main/java/net/dzikoysk/cdn/model/MutableReference.java b/cdn/src/main/java/net/dzikoysk/cdn/model/MutableReference.java
@@ -19,13 +19,20 @@
 import org.jetbrains.annotations.Contract;
 import org.jetbrains.annotations.NotNull;
 
-public interface MutableReference<V> extends Reference<V> {
+public class MutableReference<V> extends Reference<V> {
 
-    MutableReference<V> update(V value);
+    public MutableReference(V value) {
+        super(value);
+    }
+
+    public MutableReference<V> update(V value) {
+        set(value);
+        return this;
+    }
 
     @Contract(value = "_ -> new", pure = true)
-    static <T> MutableReference<@NotNull T> mutableReference(@NotNull T value) {
-        return new MutableReferenceImpl<>(value);
+    public static <T> MutableReference<@NotNull T> mutableReference(@NotNull T value) {
+        return new MutableReference<>(value);
     }
 
 }
diff --git a/cdn/src/main/java/net/dzikoysk/cdn/model/MutableReferenceImpl.java b/cdn/src/main/java/net/dzikoysk/cdn/model/MutableReferenceImpl.java
diff --git a/cdn/src/main/java/net/dzikoysk/cdn/model/Reference.java b/cdn/src/main/java/net/dzikoysk/cdn/model/Reference.java
@@ -19,16 +19,46 @@
 import org.jetbrains.annotations.Contract;
 import org.jetbrains.annotations.NotNull;
 import panda.std.Publisher;
+import panda.std.Subscriber;
+import java.util.ArrayList;
+import java.util.Collection;
 
-public interface Reference<V> extends Publisher<Reference<V>, V> {
+public class Reference<V> implements Publisher<Reference<V>, V> {
 
-    @NotNull V get();
+    protected V value;
+    protected final Collection<Subscriber<? super V>> subscribers = new ArrayList<>();
 
-    Class<V> getType();
+    public Reference(V value) {
+        set(value);
+    }
+
+    @Override
+    public Reference<V> subscribe(Subscriber<? super V> subscriber) {
+        subscribers.add(subscriber);
+        return this;
+    }
+
+    void set(V value) {
+        if (value == null) {
+            throw new IllegalArgumentException("Reference does not support null values");
+        }
+
+        subscribers.forEach(subscriber -> subscriber.onComplete(value));
+        this.value = value;
+    }
+
+    public @NotNull V get() {
+        return value;
+    }
+
+    @SuppressWarnings("unchecked")
+    public @NotNull Class<V> getType() {
+        return (Class<V>) value.getClass();
+    }
 
     @Contract(value = "_ -> new", pure = true)
-    static <T> Reference<@NotNull T> reference(@NotNull T value) {
-        return new MutableReferenceImpl<>(value);
+    public static <T> Reference<@NotNull T> reference(@NotNull T value) {
+        return new Reference<>(value);
     }
 
 }
diff --git a/cdn/src/main/java/net/dzikoysk/cdn/model/ReferenceUtils.java b/cdn/src/main/java/net/dzikoysk/cdn/model/ReferenceUtils.java
diff --git a/cdn/src/main/java/net/dzikoysk/cdn/serialization/Composer.java b/cdn/src/main/java/net/dzikoysk/cdn/serialization/Composer.java
diff --git a/pom.xml b/pom.xml
