Skip to content

[elm] Add support for oneOf #4434

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 17, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions bin/openapi3/elm-all.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#!/bin/sh

./bin/openapi3/elm-petstore.sh
./bin/openapi3/elm-composition.sh

35 changes: 35 additions & 0 deletions bin/openapi3/elm-composition.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
#!/bin/sh

SCRIPT="$0"
echo "# START SCRIPT: $SCRIPT"

while [ -h "$SCRIPT" ] ; do
ls=`ls -ld "$SCRIPT"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
SCRIPT="$link"
else
SCRIPT=`dirname "$SCRIPT"`/"$link"
fi
done

if [ ! -d "${APP_DIR}" ]; then
APP_DIR=`dirname "$SCRIPT"`/..
APP_DIR=`cd "${APP_DIR}"; pwd`
fi

executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"

if [ ! -f "$executable" ]
then
mvn -B clean package
fi

# auto format elm code using elm-format
export ELM_POST_PROCESS_FILE="/usr/bin/env elm-format --elm-version=0.19 --yes"

# if you've executed sbt assembly previously it will use that instead.
export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
ags="generate -i modules/openapi-generator/src/test/resources/3_0/composition.yaml -g elm -t modules/openapi-generator/src/main/resources/elm -o samples/openapi3/client/composition/elm --enable-post-process-file $@"

java $JAVA_OPTS -jar $executable $ags
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,13 @@ public int compare(CodegenModel cm1, CodegenModel cm2) {
elmImports.add(elmImport);
}
}
if (cm.discriminator != null) {
if (cm.oneOf != null) {
for (String variant : cm.oneOf) {
final ElmImport elmImport = createImport(variant);
elmImports.add(elmImport);
}
}
if (cm.discriminator != null && cm.children != null) {
for (CodegenModel child : cm.children) {
// add child imports
final ElmImport elmImport = createImport(child.classname);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{{>licenseInfo}}

module Data.{{classname}} exposing ({{#models}}{{#model}}{{classname}}{{#hasChildren}}(..){{/hasChildren}}{{#isEnum}}(..){{/isEnum}}{{^isEnum}}{{#vars}}{{#isEnum}}, {{vendorExtensions.elmCustomType}}(..){{/isEnum}}{{/vars}}{{/isEnum}}, decoder, encode, toString{{/model}}{{/models}})
module Data.{{classname}} exposing ({{#models}}{{#model}}{{classname}}{{#hasChildren}}(..){{/hasChildren}}{{#isEnum}}(..){{/isEnum}}{{^isEnum}}{{#vars}}{{#isEnum}}, {{vendorExtensions.elmCustomType}}(..){{/isEnum}}{{/vars}}{{/isEnum}}, decoder, encode{{^isEnum}}{{^discriminator}}{{^oneOf}}, encodeWithTag{{/oneOf}}{{/discriminator}}{{/isEnum}}, toString{{/model}}{{/models}})

{{>imports}}import Dict exposing (Dict)
import Json.Decode as Decode exposing (Decoder)
Expand All @@ -14,7 +14,7 @@ import Json.Encode as Encode
{-| {{{description}}}
-}
{{/description}}
{{#isEnum}}{{>modelTypeCustom}}{{/isEnum}}{{^isEnum}}{{#discriminator}}{{>modelTypeDiscriminator}}{{/discriminator}}{{^discriminator}}{{#isAlias}}{{>modelTypePrimitive}}{{/isAlias}}{{^isAlias}}{{#isArrayModel}}{{>modelTypeArray}}{{/isArrayModel}}{{^isArrayModel}}{{>modelTypeRecord}}{{/isArrayModel}}{{/isAlias}}{{/discriminator}}{{/isEnum}}
{{#isEnum}}{{>modelTypeCustom}}{{/isEnum}}{{^isEnum}}{{#discriminator}}{{>modelTypeDiscriminator}}{{/discriminator}}{{^discriminator}}{{#oneOf}}{{#-first}}{{>modelTypeDiscriminator}}{{/-first}}{{/oneOf}}{{^oneOf}}{{#isAlias}}{{>modelTypePrimitive}}{{/isAlias}}{{^isAlias}}{{#isArrayModel}}{{>modelTypeArray}}{{/isArrayModel}}{{^isArrayModel}}{{>modelTypeRecord}}{{/isArrayModel}}{{/isAlias}}{{/oneOf}}{{/discriminator}}{{/isEnum}}

{{/model}}
{{/models}}
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@
type {{classname}}
{{#mappedModels}}
{{^discriminator}}{{#oneOf}}
{{#-first}}={{/-first}}{{^-first}}|{{/-first}} {{{.}}}Type {{{.}}}
{{/oneOf}}{{/discriminator}}
{{#discriminator}}{{#mappedModels}}
{{#-first}}={{/-first}}{{^-first}}|{{/-first}} {{modelName}}Type {{modelName}}
{{/mappedModels}}
{{/mappedModels}}{{/discriminator}}


decoder : Decoder {{classname}}
decoder =
{{^discriminator}}
Decode.oneOf
{{#oneOf}}
{{#-first}}[{{/-first}}{{^-first}},{{/-first}} Decode.map {{{.}}}Type {{{.}}}.decoder
{{/oneOf}}
]
{{/discriminator}}
{{#discriminator}}
Decode.field "{{{discriminator.propertyName}}}" Decode.string
|> Decode.andThen {{classVarName}}Decoder

Expand All @@ -19,17 +30,25 @@ decoder =

{{/mappedModels}}
_ ->
Decode.fail <| "Trying to decode {{classname}}, but {{{discriminatorName}}} " ++ tag ++ " is not supported."
Decode.fail <| "Trying to decode {{classname}}, but {{{discriminatorName}}} '" ++ tag ++ "' is not supported."
{{/discriminator}}


encode : {{classname}} -> Encode.Value
encode model =
case model of
{{^discriminator}}{{#oneOf}}
{{{.}}}Type subModel ->
{{{.}}}.encode subModel

{{/oneOf}}{{/discriminator}}
{{#discriminator}}
{{#mappedModels}}
{{modelName}}Type subModel ->
{{modelName}}.encode "{{mappingName}}" subModel
{{modelName}}.encodeWithTag ("{{discriminatorName}}", "{{mappingName}}") subModel

{{/mappedModels}}
{{/discriminator}}


toString : {{classname}} -> String
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ type alias {{classname}} =

toString : {{classname}} -> String
toString =
Encode.encode 0 << encode{{#vendorExtensions.discriminatorName}} ""{{/vendorExtensions.discriminatorName}}
Encode.encode 0 << encode


{{#vars}}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,16 @@
encode : {{#vendorExtensions.discriminatorName}}String -> {{/vendorExtensions.discriminatorName}}{{classname}} -> Encode.Value
encode {{#vendorExtensions.discriminatorName}}tag {{/vendorExtensions.discriminatorName}}model =
Encode.object
encode : {{classname}} -> Encode.Value
encode =
Encode.object << encodePairs


encodeWithTag : ( String, String ) -> {{classname}} -> Encode.Value
encodeWithTag (tagField, tag) model =
Encode.object <| encodePairs model ++ [ ( tagField, Encode.string tag ) ]


encodePairs : {{classname}} -> List (String, Encode.Value)
encodePairs model =
{{#allVars}}
{{#-first}}[{{/-first}}{{^-first}},{{/-first}} {{>recordFieldEncoder}}
{{/allVars}}{{#vendorExtensions.discriminatorName}} , ( "{{{vendorExtensions.discriminatorName}}}", Encode.string tag ){{/vendorExtensions.discriminatorName}}
]
{{#-first}}[{{/-first}}{{^-first}},{{/-first}} {{>recordFieldEncoder}}
{{/allVars}}
]
121 changes: 121 additions & 0 deletions modules/openapi-generator/src/test/resources/3_0/composition.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
openapi: 3.0.0
info:
title: Composition and Inheritence (Polymorphism)
version: 1.0.0
paths:
/oneOf:
post:
summary: One of
responses:
200:
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/OneOf'
/oneOfWithDiscriminator:
post:
summary: One of with discriminator
responses:
200:
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/OneOfWithDiscriminator'
/oneOfWithAllOfDiscriminator:
post:
summary: One of with discriminator from all of
responses:
200:
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/OneOfWithAllOfDiscriminator'
/allOf:
post:
summary: All of
responses:
200:
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/AllOf'
/allOfWithDiscriminator:
post:
summary: All of with discriminator
responses:
200:
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/BaseObject'
components:
schemas:
OneOf:
oneOf:
- $ref: "#/components/schemas/ObjectA"
- $ref: "#/components/schemas/ObjectB"
OneOfWithDiscriminator:
oneOf:
- $ref: "#/components/schemas/ObjectA"
- $ref: "#/components/schemas/ObjectB"
discriminator:
propertyName: objectType
mapping:
a: "#/components/schemas/ObjectA"
b: "#/components/schemas/ObjectB"
OneOfWithAllOfDiscriminator:
oneOf:
- $ref: "#/components/schemas/SubObjectA"
- $ref: "#/components/schemas/SubObjectB"
AllOf:
allOf:
- $ref: "#/components/schemas/ObjectA"
- $ref: "#/components/schemas/ObjectB"
BaseObject:
required:
- objectType
- value
properties:
objectType:
type: string
value:
type: boolean
discriminator:
propertyName: objectType
ObjectA:
type: object
required:
- objectType
properties:
objectType:
type: string
valueA:
type: string
ObjectB:
type: object
required:
- objectType
properties:
objectType:
type: string
valueB:
type: number
SubObjectA:
allOf:
- $ref: "#/components/schemas/BaseObject"
- type: object
properties:
valueA:
type: string
SubObjectB:
allOf:
- $ref: "#/components/schemas/BaseObject"
- type: object
properties:
valueB:
type: number
23 changes: 16 additions & 7 deletions samples/client/petstore/elm-0.18/src/Data/ApiResponse.elm
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
-}


module Data.ApiResponse exposing (ApiResponse, decoder, encode, toString)
module Data.ApiResponse exposing (ApiResponse, decoder, encode, encodeWithTag, toString)

import Dict exposing (Dict)
import Json.Decode as Decode exposing (Decoder)
Expand All @@ -36,12 +36,21 @@ decoder =


encode : ApiResponse -> Encode.Value
encode model =
Encode.object
[ ( "code", Maybe.withDefault Encode.null (Maybe.map Encode.int model.code) )
, ( "type", Maybe.withDefault Encode.null (Maybe.map Encode.string model.type_) )
, ( "message", Maybe.withDefault Encode.null (Maybe.map Encode.string model.message) )
]
encode =
Encode.object << encodePairs


encodeWithTag : ( String, String ) -> ApiResponse -> Encode.Value
encodeWithTag ( tagField, tag ) model =
Encode.object <| encodePairs model ++ [ ( tagField, Encode.string tag ) ]


encodePairs : ApiResponse -> List ( String, Encode.Value )
encodePairs model =
[ ( "code", Maybe.withDefault Encode.null (Maybe.map Encode.int model.code) )
, ( "type", Maybe.withDefault Encode.null (Maybe.map Encode.string model.type_) )
, ( "message", Maybe.withDefault Encode.null (Maybe.map Encode.string model.message) )
]


toString : ApiResponse -> String
Expand Down
21 changes: 15 additions & 6 deletions samples/client/petstore/elm-0.18/src/Data/Category.elm
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
-}


module Data.Category exposing (Category, decoder, encode, toString)
module Data.Category exposing (Category, decoder, encode, encodeWithTag, toString)

import Dict exposing (Dict)
import Json.Decode as Decode exposing (Decoder)
Expand All @@ -34,11 +34,20 @@ decoder =


encode : Category -> Encode.Value
encode model =
Encode.object
[ ( "id", Maybe.withDefault Encode.null (Maybe.map Encode.int model.id) )
, ( "name", Maybe.withDefault Encode.null (Maybe.map Encode.string model.name) )
]
encode =
Encode.object << encodePairs


encodeWithTag : ( String, String ) -> Category -> Encode.Value
encodeWithTag ( tagField, tag ) model =
Encode.object <| encodePairs model ++ [ ( tagField, Encode.string tag ) ]


encodePairs : Category -> List ( String, Encode.Value )
encodePairs model =
[ ( "id", Maybe.withDefault Encode.null (Maybe.map Encode.int model.id) )
, ( "name", Maybe.withDefault Encode.null (Maybe.map Encode.string model.name) )
]


toString : Category -> String
Expand Down
29 changes: 19 additions & 10 deletions samples/client/petstore/elm-0.18/src/Data/Order_.elm
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
-}


module Data.Order_ exposing (Order_, Status(..), decoder, encode, toString)
module Data.Order_ exposing (Order_, Status(..), decoder, encode, encodeWithTag, toString)

import DateTime exposing (DateTime)
import Dict exposing (Dict)
Expand Down Expand Up @@ -49,15 +49,24 @@ decoder =


encode : Order_ -> Encode.Value
encode model =
Encode.object
[ ( "id", Maybe.withDefault Encode.null (Maybe.map Encode.int model.id) )
, ( "petId", Maybe.withDefault Encode.null (Maybe.map Encode.int model.petId) )
, ( "quantity", Maybe.withDefault Encode.null (Maybe.map Encode.int model.quantity) )
, ( "shipDate", Maybe.withDefault Encode.null (Maybe.map DateTime.encode model.shipDate) )
, ( "status", Maybe.withDefault Encode.null (Maybe.map encodeStatus model.status) )
, ( "complete", Maybe.withDefault Encode.null (Maybe.map Encode.bool model.complete) )
]
encode =
Encode.object << encodePairs


encodeWithTag : ( String, String ) -> Order_ -> Encode.Value
encodeWithTag ( tagField, tag ) model =
Encode.object <| encodePairs model ++ [ ( tagField, Encode.string tag ) ]


encodePairs : Order_ -> List ( String, Encode.Value )
encodePairs model =
[ ( "id", Maybe.withDefault Encode.null (Maybe.map Encode.int model.id) )
, ( "petId", Maybe.withDefault Encode.null (Maybe.map Encode.int model.petId) )
, ( "quantity", Maybe.withDefault Encode.null (Maybe.map Encode.int model.quantity) )
, ( "shipDate", Maybe.withDefault Encode.null (Maybe.map DateTime.encode model.shipDate) )
, ( "status", Maybe.withDefault Encode.null (Maybe.map encodeStatus model.status) )
, ( "complete", Maybe.withDefault Encode.null (Maybe.map Encode.bool model.complete) )
]


toString : Order_ -> String
Expand Down
Loading