Merge pull request #32 from GoNZooo/r.empty-functions-for-kotlin-structs

feat(kt): add companion `create` function for structs
GoNZooo · Oct 28, 2022 · 6aa9647 · 6aa9647
2 parents faeb152 + c47c193
commit 6aa9647
Show file tree

Hide file tree

Showing 15 changed files with 313 additions and 39 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Changelog
 
+## 2.3.0
+
+### Features
+
+- `Struct.create` function in companion object for all generated structs in
+  Kotlin output, which set optional fields to `null` by default.
+
 ## 2.2.3
 
 ### Fixes

diff --git a/gotyno-hs.cabal b/gotyno-hs.cabal
@@ -5,7 +5,7 @@ cabal-version: 1.12
 -- see: https://github.com/sol/hpack
 
 name:           gotyno-hs
-version:        2.2.3
+version:        2.3.0
 synopsis:       A type definition compiler supporting multiple output languages.
 description:    Compiles type definitions into F#, TypeScript and Python, with validators, decoders and encoders.
 category:       Compiler

diff --git a/package.yaml b/package.yaml
@@ -1,5 +1,5 @@
 name:    gotyno-hs
-version: 2.2.3
+version: 2.3.0
 synopsis: A type definition compiler supporting multiple output languages.
 description: Compiles type definitions into F#, TypeScript and Python, with validators, decoders and encoders.
 license: BSD2

diff --git a/src/CodeGeneration/Kotlin.hs b/src/CodeGeneration/Kotlin.hs
@@ -194,7 +194,14 @@ outputPlainStruct name fields =
       literalCompare _other (StructField _aName (LiteralType _bl)) = LT
       literalCompare _a _b = EQ
       typeOutput = mconcat ["@Serializable\n", "data class ", nameOf name]
-   in mconcat [typeOutput, "(\n    ", fieldsOutput, "\n) : java.io.Serializable"]
+   in mconcat
+        [ typeOutput,
+          "(\n    ",
+          fieldsOutput,
+          "\n) : java.io.Serializable {\n",
+          outputStructCompanion name fields [],
+          "}"
+        ]
 
 outputGenericStruct :: DefinitionName -> [TypeVariable] -> [StructField] -> Text
 outputGenericStruct name typeVariables fields =
@@ -206,9 +213,55 @@ outputGenericStruct name typeVariables fields =
           "(\n    ",
           fieldsOutput,
           "\n",
-          ") : java.io.Serializable"
+          ") : java.io.Serializable {\n",
+          outputStructCompanion name fields typeVariables,
+          "}"
         ]
 
+outputStructCompanion :: DefinitionName -> [StructField] -> [TypeVariable] -> Text
+outputStructCompanion name fields typeVariables =
+  let createOutput =
+        mconcat
+          [ "        fun ",
+            typeVariableOutput <> if null typeVariables then "" else " ",
+            "create",
+            "(",
+            createParameterOutput,
+            "): ",
+            nameOf name,
+            typeVariableOutput,
+            " {\n",
+            "            return ",
+            nameOf name,
+            "(",
+            createArgumentOutput,
+            ")\n",
+            "        }\n"
+          ]
+      (optionalFields, nonOptionalFields) = List.partition isOptionalField fields
+      (literalFields, nonLiteralFields) = List.partition isLiteralField nonOptionalFields
+      typeVariableOutput =
+        if null typeVariables then "" else joinedTypeVariables
+      joinedTypeVariables = mconcat ["<", joinTypeVariables typeVariables, ">"]
+      createParameterOutput =
+        (nonLiteralFields <> optionalFields <> literalFields)
+          & fmap outputFieldParameter
+          & Text.intercalate ", "
+      outputFieldParameter f
+        | isOptionalField f =
+          mconcat [nameOf f, ": ", f ^. structFieldType & outputFieldType, " = null"]
+        | otherwise = mconcat [nameOf f, ": ", f ^. structFieldType & outputFieldType]
+      isOptionalField (StructField _ (ComplexType (OptionalType _))) = True
+      isOptionalField _ = False
+      isLiteralField (StructField _ (LiteralType _)) = True
+      isLiteralField _ = False
+      createArgumentOutput =
+        fields
+          & fmap outputFieldArgument
+          & Text.intercalate ", "
+      outputFieldArgument f = mconcat [nameOf f, " = ", nameOf f]
+   in mconcat ["    companion object {\n", createOutput, "    }\n"]
+
 outputUnion :: DefinitionName -> FieldName -> UnionType -> Text
 outputUnion name typeTag unionType =
   let caseUnionOutput =

diff --git a/src/CodeGeneration/Utilities.hs b/src/CodeGeneration/Utilities.hs
@@ -50,6 +50,10 @@ instance HasName FieldName where
   {-# INLINE nameOf #-}
   nameOf = (^. unwrap)
 
+instance HasName StructField where
+  {-# INLINE nameOf #-}
+  nameOf = (^. structFieldName) >>> nameOf
+
 class HasDefinitionName a where
   definitionNameOf :: a -> DefinitionName
 

diff --git a/test/reference-output/basic.kt b/test/reference-output/basic.kt
@@ -25,7 +25,13 @@ data class Recruiter(
     val created: BigInteger,
     @get:JsonProperty("type")
     val type: String = "Recruiter"
-) : java.io.Serializable
+) : java.io.Serializable {
+    companion object {
+        fun create(Name: String, emails: ArrayList<String?>, created: BigInteger, recruiter: Recruiter? = null, type: String = "Recruiter"): Recruiter {
+            return Recruiter(type = type, Name = Name, emails = emails, recruiter = recruiter, created = created)
+        }
+    }
+}
 
 @Serializable
 @JsonTypeInfo(
@@ -65,7 +71,13 @@ sealed class GetSearchesFilter : java.io.Serializable {
 data class SearchesParameters(
     @get:JsonProperty("filters")
     val filters: ArrayList<GetSearchesFilter>
-) : java.io.Serializable
+) : java.io.Serializable {
+    companion object {
+        fun create(filters: ArrayList<GetSearchesFilter>): SearchesParameters {
+            return SearchesParameters(filters = filters)
+        }
+    }
+}
 
 enum class StillSize(val data: String) : java.io.Serializable {
     @JsonProperty("w92") W92("w92"),
@@ -83,29 +95,53 @@ data class LogInData(
     val username: String,
     @get:JsonProperty("password")
     val password: String
-) : java.io.Serializable
+) : java.io.Serializable {
+    companion object {
+        fun create(username: String, password: String): LogInData {
+            return LogInData(username = username, password = password)
+        }
+    }
+}
 
 @Serializable
 data class UserId(
     @get:JsonProperty("value")
     val value: String
-) : java.io.Serializable
+) : java.io.Serializable {
+    companion object {
+        fun create(value: String): UserId {
+            return UserId(value = value)
+        }
+    }
+}
 
 @Serializable
 data class Channel(
     @get:JsonProperty("name")
     val name: String,
     @get:JsonProperty("private")
     val private: Boolean
-) : java.io.Serializable
+) : java.io.Serializable {
+    companion object {
+        fun create(name: String, private: Boolean): Channel {
+            return Channel(name = name, private = private)
+        }
+    }
+}
 
 @Serializable
 data class Email(
     @get:JsonProperty("value")
     val value: String,
     @get:JsonProperty("public")
     val public: Boolean
-) : java.io.Serializable
+) : java.io.Serializable {
+    companion object {
+        fun create(value: String, public: Boolean): Email {
+            return Email(value = value, public = public)
+        }
+    }
+}
 
 @Serializable
 @JsonTypeInfo(
@@ -205,7 +241,13 @@ data class Person(
     val recruiter: Recruiter,
     @get:JsonProperty("spouse")
     val spouse: Maybe<Person>
-) : java.io.Serializable
+) : java.io.Serializable {
+    companion object {
+        fun create(name: String, age: Byte, efficiency: Float, on_vacation: Boolean, hobbies: ArrayList<String>, last_fifteen_comments: ArrayList<String>, recruiter: Recruiter, spouse: Maybe<Person>): Person {
+            return Person(name = name, age = age, efficiency = efficiency, on_vacation = on_vacation, hobbies = hobbies, last_fifteen_comments = last_fifteen_comments, recruiter = recruiter, spouse = spouse)
+        }
+    }
+}
 
 @Serializable
 @JsonTypeInfo(

diff --git a/test/reference-output/basicImport.kt b/test/reference-output/basicImport.kt
@@ -18,7 +18,13 @@ class BasicImport {
 data class StructUsingImport(
     @get:JsonProperty("field")
     val field: BasicStruct.BasicStruct
-) : java.io.Serializable
+) : java.io.Serializable {
+    companion object {
+        fun create(field: BasicStruct.BasicStruct): StructUsingImport {
+            return StructUsingImport(field = field)
+        }
+    }
+}
 
 @Serializable
 @JsonTypeInfo(

diff --git a/test/reference-output/basicOptional.kt b/test/reference-output/basicOptional.kt
@@ -20,7 +20,13 @@ data class HasOptionalString(
     val optionalArrayField: ArrayList<Int>?,
     @get:JsonProperty("arrayOfOptionalField")
     val arrayOfOptionalField: ArrayList<Int?>
-) : java.io.Serializable
+) : java.io.Serializable {
+    companion object {
+        fun create(arrayOfOptionalField: ArrayList<Int?>, stringField: String? = null, optionalArrayField: ArrayList<Int>? = null): HasOptionalString {
+            return HasOptionalString(stringField = stringField, optionalArrayField = optionalArrayField, arrayOfOptionalField = arrayOfOptionalField)
+        }
+    }
+}
 
 @Serializable
 @JsonTypeInfo(

diff --git a/test/reference-output/basicStruct.kt b/test/reference-output/basicStruct.kt
@@ -18,5 +18,11 @@ data class BasicStruct(
     val field1: Int,
     @get:JsonProperty("field2")
     val field2: String
-) : java.io.Serializable
+) : java.io.Serializable {
+    companion object {
+        fun create(field1: Int, field2: String): BasicStruct {
+            return BasicStruct(field1 = field1, field2 = field2)
+        }
+    }
+}
 }
diff --git a/test/reference-output/basicUnion.kt b/test/reference-output/basicUnion.kt
@@ -16,7 +16,13 @@ class BasicUnion {
 data class PayloadStruct(
     @get:JsonProperty("field1")
     val field1: Int
-) : java.io.Serializable
+) : java.io.Serializable {
+    companion object {
+        fun create(field1: Int): PayloadStruct {
+            return PayloadStruct(field1 = field1)
+        }
+    }
+}
 
 @Serializable
 @JsonTypeInfo(

diff --git a/test/reference-output/genericStruct.kt b/test/reference-output/genericStruct.kt
@@ -16,5 +16,11 @@ class GenericStruct {
 data class GenericStruct<T>(
     @get:JsonProperty("field")
     val field: T
-) : java.io.Serializable
+) : java.io.Serializable {
+    companion object {
+        fun <T> create(field: T): GenericStruct<T> {
+            return GenericStruct(field = field)
+        }
+    }
+}
 }
diff --git a/test/reference-output/generics.kt b/test/reference-output/generics.kt
@@ -21,13 +21,25 @@ data class UsingGenerics(
     val field1: Basic.Maybe<String>,
     @get:JsonProperty("field2")
     val field2: Basic.Either<String, Int>
-) : java.io.Serializable
+) : java.io.Serializable {
+    companion object {
+        fun create(field1: Basic.Maybe<String>, field2: Basic.Either<String, Int>): UsingGenerics {
+            return UsingGenerics(field1 = field1, field2 = field2)
+        }
+    }
+}
 
 @Serializable
 data class UsingOwnGenerics<T>(
     @get:JsonProperty("field1")
     val field1: Basic.Maybe<T>
-) : java.io.Serializable
+) : java.io.Serializable {
+    companion object {
+        fun <T> create(field1: Basic.Maybe<T>): UsingOwnGenerics<T> {
+            return UsingOwnGenerics(field1 = field1)
+        }
+    }
+}
 
 @Serializable
 data class KnownForMovie(
@@ -45,7 +57,13 @@ data class KnownForMovie(
     val overview: String,
     @get:JsonProperty("media_type")
     val media_type: String = "movie"
-) : java.io.Serializable
+) : java.io.Serializable {
+    companion object {
+        fun create(id: Int, vote_average: Float, overview: String, poster_path: String? = null, title: String? = null, release_date: String? = null, media_type: String = "movie"): KnownForMovie {
+            return KnownForMovie(media_type = media_type, poster_path = poster_path, id = id, title = title, vote_average = vote_average, release_date = release_date, overview = overview)
+        }
+    }
+}
 
 @Serializable
 data class KnownForShow(
@@ -63,7 +81,13 @@ data class KnownForShow(
     val name: String?,
     @get:JsonProperty("media_type")
     val media_type: String = "tv"
-) : java.io.Serializable
+) : java.io.Serializable {
+    companion object {
+        fun create(id: Int, vote_average: Float, overview: String, poster_path: String? = null, first_air_date: String? = null, name: String? = null, media_type: String = "tv"): KnownForShow {
+            return KnownForShow(media_type = media_type, poster_path = poster_path, id = id, vote_average = vote_average, overview = overview, first_air_date = first_air_date, name = name)
+        }
+    }
+}
 
 @JsonDeserialize(using = KnownFor.Deserializer::class)
 @Serializable
@@ -105,7 +129,13 @@ data class KnownForMovieWithoutTypeTag(
     val release_date: String?,
     @get:JsonProperty("overview")
     val overview: String
-) : java.io.Serializable
+) : java.io.Serializable {
+    companion object {
+        fun create(id: Int, vote_average: Float, overview: String, poster_path: String? = null, title: String? = null, release_date: String? = null): KnownForMovieWithoutTypeTag {
+            return KnownForMovieWithoutTypeTag(poster_path = poster_path, id = id, title = title, vote_average = vote_average, release_date = release_date, overview = overview)
+        }
+    }
+}
 
 @Serializable
 data class KnownForShowWithoutTypeTag(
@@ -121,7 +151,13 @@ data class KnownForShowWithoutTypeTag(
     val first_air_date: String?,
     @get:JsonProperty("name")
     val name: String?
-) : java.io.Serializable
+) : java.io.Serializable {
+    companion object {
+        fun create(id: Int, vote_average: Float, overview: String, poster_path: String? = null, first_air_date: String? = null, name: String? = null): KnownForShowWithoutTypeTag {
+            return KnownForShowWithoutTypeTag(poster_path = poster_path, id = id, vote_average = vote_average, overview = overview, first_air_date = first_air_date, name = name)
+        }
+    }
+}
 
 @Serializable
 @JsonTypeInfo(