Prepare 0.1.2 release

ChangeLog.md

@@ -0,0 +1,17 @@
+## 0.1.2
+
+* Add `UniqueComponentWrapper` that wraps an object unique-like component
+
+* Create interfaces `IUniqueComponent` and `INamedComonent` with default implementation, in case the
+  class supposed to be a unique component or named component already has its super class
+
+* Rework generic finding algorithm on `UniqueComponent`
+
+* Fix the bug that property delegate created by `annotatedInjector()`
+  instantiated `AnnotatedInjector` many times
+
+* Support removing components from scope
+
+## 0.1.1
+
+* Initial release

build.gradle.kts

@@ -5,7 +5,7 @@ plugins {
 }
 
 group = "org.mechdancer"
-version = "0.1.1"
+version = "0.1.2"
 
 repositories { mavenCentral() }
 dependencies {

src/main/kotlin/org/mechdancer/dependency/UniqueComponentWrapper.kt

@@ -3,6 +3,16 @@ package org.mechdancer.dependency
 import kotlin.reflect.KClass
 import kotlin.reflect.safeCast
 
+/**
+ * Wraps an object to a component which has a similar implementation to [UniqueComponent]
+ *
+ * This class is useful in the case that we can't modify some classes to make them components
+ *
+ * Invariance: the implementation in dependency manager and annotation injector enforce
+ * the invariance on the wrapped type, which means there is no chance to cast an instance
+ * to its supertype, and you should declare the dependency with the type exactly the same as you
+ * wrapped and set up in scope.
+ */
 class UniqueComponentWrapper<T : Any> @PublishedApi internal constructor(
     val type: KClass<*>,
     val wrapped: T

src/main/kotlin/org/mechdancer/dependency/annotated/AnnotatedInjector.kt

@@ -36,6 +36,7 @@ class AnnotatedInjector<T : Any>(private val dependent: T, type: KClass<T>) : Sc
                     else it.returnType.jvmErasure as KClass<out Component>
                 ) { component ->
                     (if (needsUnwrap)
+                    // Invariance: See the note on [UniqueComponentWrapper]
                         (component is UniqueComponentWrapper<*> && it.returnType.jvmErasure ==
                             component.type)
                     else
@@ -69,6 +70,7 @@ class AnnotatedInjector<T : Any>(private val dependent: T, type: KClass<T>) : Sc
                     else it.returnType.jvmErasure as KClass<out Component>
                 ) { component ->
                     (if (needsUnwrap)
+                    // Invariance: See the note on [UniqueComponentWrapper]
                         component is UniqueComponentWrapper<*> && it.returnType.jvmErasure ==
                             component.type
                     else

src/main/kotlin/org/mechdancer/dependency/manager/Functions.kt

@@ -164,6 +164,8 @@ inline fun <reified C : INamedComponent<C>>
  * Declare a strict [UniqueComponentWrapper] dependency with type [C] that wrappers type [T],
  * creating a delegate that obtains its value
  *
+ * Invariance: See the note on [UniqueComponentWrapper]
+ *
  * @return a property delegate
  */
 inline fun <reified C : UniqueComponentWrapper<T>, reified T>
@@ -173,6 +175,8 @@ inline fun <reified C : UniqueComponentWrapper<T>, reified T>
  * Declare a weak [UniqueComponentWrapper] dependency with type [C] that wrappers type [T],
  * creating a delegate that obtains its value
  *
+ * Invariance: See the note on [UniqueComponentWrapper]
+ *
  * @return a property delegate
  */
 inline fun <reified C : UniqueComponentWrapper<T>, reified T>