docs(examples): add transformer-mapping example

example/kotlin/pom.xml

@@ -41,6 +41,7 @@
     <modules>
         <module>simple-mapping</module>
         <module>advanced-mapping</module>
+        <module>transformer-mapping</module>
     </modules>
 
     <dependencies>

example/kotlin/transformer-mapping/pom.xml

@@ -0,0 +1,24 @@
+<!--
+  ~ Copyright KRUD 2022
+  ~
+  ~ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+  ~
+  ~ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+  ~
+  ~ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+  -->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <artifactId>transformer-mapping</artifactId>
+    <name>transformer-mapping</name>
+    <version>0.0.1-SNAPSHOT</version>
+    <packaging>jar</packaging>
+
+    <parent>
+        <groupId>dev.krud.shapeshift.examples.kotlin</groupId>
+        <artifactId>shapeshift-examples-kotlin</artifactId>
+        <version>0.0.1-SNAPSHOT</version>
+    </parent>
+</project>

example/kotlin/transformer-mapping/src/main/kotlin/dev/krud/shapeshift/examples/kotlin/Main.kt

@@ -0,0 +1,34 @@
+/*
+ * Copyright KRUD 2022
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package dev.krud.shapeshift.examples.kotlin
+
+import dev.krud.shapeshift.ShapeShiftBuilder
+import dev.krud.shapeshift.transformer.DateToLongTransformer
+import java.util.*
+
+/**
+ * This example shows how to use ShapeShift to map one object to another using transformers
+ */
+fun main() {
+    // Initialize ShapeShift with a StringToCommaSeparatedStringListTransformer and a default DateToLongTransformer
+    val shapeShift = ShapeShiftBuilder()
+        .withTransformer(DateToLongTransformer(), true)
+        .withTransformer(StringToCommaSeparatedStringListTransformer())
+        .build()
+    // Initialize a SimpleEntity
+    val simpleEntity = SimpleEntity(
+        Date(1),
+        "First,Second,Third"
+    )
+    // Map the SimpleEntity to a SimpleEntityDisplay using ShapeShift
+    val simpleEntityDisplay = shapeShift.map(simpleEntity, SimpleEntityDisplay::class.java)
+    println("SimpleEntityDisplay: $simpleEntityDisplay")
+}

example/kotlin/transformer-mapping/src/main/kotlin/dev/krud/shapeshift/examples/kotlin/SimpleEntity.kt

@@ -0,0 +1,24 @@
+/*
+ * Copyright KRUD 2022
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package dev.krud.shapeshift.examples.kotlin
+
+import dev.krud.shapeshift.annotation.DefaultMappingTarget
+import dev.krud.shapeshift.annotation.MappedField
+import java.util.*
+
+@DefaultMappingTarget(SimpleEntityDisplay::class) // The default target class for the mapping
+data class SimpleEntity(
+    @MappedField
+    val creationDate: Date, // This field will be mapped to the creationDate field of the target class, and use the DateToLongTransformer implicitly
+
+    @MappedField(transformer = StringToCommaSeparatedStringListTransformer::class, mapTo = "stringList")
+    val commaDelimitedString: String, // This field will be mapped to the stringList field of the target class, and use the StringToCommaSeparatedStringListTransformer as it is explicitly specified
+)

example/kotlin/transformer-mapping/src/main/kotlin/dev/krud/shapeshift/examples/kotlin/SimpleEntityDisplay.kt

@@ -0,0 +1,16 @@
+/*
+ * Copyright KRUD 2022
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package dev.krud.shapeshift.examples.kotlin
+
+data class SimpleEntityDisplay(
+    val creationDate: Long = 0,
+    val stringList: List<String> = emptyList()
+)

example/kotlin/transformer-mapping/src/main/kotlin/dev/krud/shapeshift/examples/kotlin/StringToCommaSeparatedStringListTransformer.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright KRUD 2022
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package dev.krud.shapeshift.examples.kotlin
+
+import dev.krud.shapeshift.transformer.base.FieldTransformer
+import java.lang.reflect.Field
+
+class StringToCommaSeparatedStringListTransformer : FieldTransformer<String, List<*>> {
+    override val fromType: Class<String> = String::class.java
+    override val toType: Class<List<*>> = List::class.java
+
+    override fun transform(fromField: Field, toField: Field, originalValue: String?, fromObject: Any, toObject: Any): List<String>? {
+        return originalValue?.split(",")
+    }
+}