git.iko.soy/deriving-openapi3
on 94d936f help sign in
7299ae2
swap
0 ahead, 26 behind
.github/workflows/build.yaml+13−31
since splitsnapshots
unifiedsplit
@@ -1,4 +1,4 @@
1−name: Build
1+name: Github Action Docker Image
2
2
3on:
3on:
4 push:
4 push:
@@ -17,7 +17,7 @@ jobs:
17 - name: Check library version
17 - name: Check library version
18 if: github.event_name == 'release'
18 if: github.event_name == 'release'
19 run: |
19 run: |
20− if [ "$(awk -F":" '{if ($1 == "version") {gsub(/ /, "", $2); print $2}}' *.cabal)" != "${{ github.event.release.tag_name }}" ]; then
20+ if [ "$(yq eval ".version" package.yaml)" != "${{ github.event.release.tag_name }}" ]; then
21 echo "::error file=action.yaml::Library version does not match release version."
21 echo "::error file=action.yaml::Library version does not match release version."
22 exit 1
22 exit 1
23 fi
23 fi
@@ -27,37 +27,19 @@ jobs:
27 steps:
27 steps:
28 - uses: actions/checkout@v2
28 - uses: actions/checkout@v2
29
29
30+
30− - name: Cache
31+ - name: Cache
31− uses: actions/cache@v1
32+ uses: actions/cache@v1
32− with:
33+ with:
33− path: |
34+ path: |
34− ~/.stack
35+ ~/.stack
35− .stack-work
36+ .stack-work
36− key: ${{ runner.os }}-stack-${{ hashFiles('stack.yaml') }}-${{ hashFiles('**.cabal') }}
37+ key: ${{ runner.os }}-stack-${{ hashFiles('stack.yaml') }}-${{ hashFiles('package.yaml') }}
37− restore-keys: |
38+ restore-keys: |
38− ${{ runner.os }}-stack-${{ hashFiles('stack.yaml') }}
39+ ${{ runner.os }}-stack-${{ hashFiles('stack.yaml') }}
39− ${{ runner.os }}-stack
40+ ${{ runner.os }}-stack
40
41
41 - name: Build
42 - name: Build
42 shell: bash
43 shell: bash
43 run: |
44 run: |
44 stack build
45 stack build
45−
46− - name: doctests
47− shell: bash
48− run: |
49− ./runDoctests.sh
50−
51− - name: Check Formatting
52− shell: bash
53− run: |
54− stack install ormolu
55− ormolu -o -XTypeApplications -o -XCPP -m check $(find src -type f -name "*.hs")
56−
57− - name: Publish candidate
58− shell: bash
59− if: github.event_name == 'release'
60− env:
61− HACKAGE_KEY: ${{ secrets.HACKAGE_TOKEN }}
62− run: |
63− stack upload --pvp-bounds both --test-tarball --candidate .
.gitignore+1
@@ -0,0 +1 @@
1+deriving-openapi3.cabal
Changelog.mddeleted−3
@@ -1,3 +0,0 @@
1−# 0.1.0.0
2−
3−Initial release
deriving-openapi3.cabaldeleted−55
@@ -1,55 +0,0 @@
1−cabal-version: 1.12
2−
3−-- This file has been generated from package.yaml by hpack version 0.34.5.
4−--
5−-- see: https://github.com/sol/hpack
6−
7−name: deriving-openapi3
8−version: 0.1.0.0
9−synopsis: DerivingVia for OpenAPI 3
10−description: DerivingVia for OpenAPI 3
11−category: JSON, Generics, OpenAPI
12−homepage: https://github.com/ilyakooo0/deriving-openapi3#readme
13−bug-reports: https://github.com/ilyakooo0/deriving-openapi3/issues
14−maintainer: Ilya Kostyuchenko <ilyakooo0@gmail.com>
15−license: MIT
16−license-file: LICENSE
17−build-type: Simple
18−extra-source-files:
19− Changelog.md
20−
21−source-repository head
22− type: git
23− location: https://github.com/ilyakooo0/deriving-openapi3
24−
25−library
26− exposed-modules:
27− Deriving.OpenApi
28− other-modules:
29− Paths_deriving_openapi3
30− hs-source-dirs:
31− src
32− default-extensions:
33− AllowAmbiguousTypes
34− ScopedTypeVariables
35− KindSignatures
36− DataKinds
37− TypeOperators
38− FlexibleInstances
39− TypeApplications
40− UndecidableInstances
41− TypeFamilies
42− PolyKinds
43− OverloadedStrings
44− DerivingStrategies
45− DerivingVia
46− FlexibleContexts
47− ghc-options: -Weverything -Wno-star-is-type -Wno-unsafe -Wno-prepositive-qualified-module -Wno-safe -Wno-missing-safe-haskell-mode -Wno-missing-import-lists -Wno-implicit-prelude
48− build-depends:
49− aeson
50− , base >=4.12
51− , deriving-aeson >=0.2.2
52− , lens
53− , openapi3
54− , text
55− default-language: Haskell2010
package.yamlnew file+29
@@ -0,0 +1,29 @@
1+name: deriving-openapi3
2+version: 0.1.0.0
3+synopsis: DerivingVia for OpenAPI 3
4+# description:
5+maintainer: Ilya Kostyuchenko <ilyakooo0@gmail.com>
6+github: ilyakooo0/deriving-openapi3
7+ghc-options: -Wall
8+dependencies:
9+ - base
10+ - openapi3
11+ - deriving-aeson
12+ - aeson
13+ - servant
14+ - lens
15+ - text
16+library:
17+ source-dirs: src
18+default-extensions:
19+ - AllowAmbiguousTypes
20+ - ScopedTypeVariables
21+ - KindSignatures
22+ - DataKinds
23+ - TypeOperators
24+ - FlexibleInstances
25+ - TypeApplications
26+ - UndecidableInstances
27+ - TypeFamilies
28+ - PolyKinds
29+ - OverloadedStrings
runDoctests.shdeleted−9
@@ -1,9 +0,0 @@
1−#!/bin/sh
2−
3−set -e
4−
5−EXTENSIONS="-XAllowAmbiguousTypes -XScopedTypeVariables -XKindSignatures -XDataKinds -XTypeOperators -XFlexibleInstances -XTypeApplications -XUndecidableInstances -XTypeFamilies -XPolyKinds"
6−
7−DEPENDENCIES="--package doctest --package yaml"
8−
9−stack exec $DEPENDENCIES -- find src -name '*.hs' -exec doctest $EXTENSIONS '{}' \;
src/Deriving/OpenApi.hs+52−89
@@ -1,45 +1,18 @@
1−{-# LANGUAGE CPP #-}
2{-# OPTIONS_GHC -Wno-orphans #-}
1{-# OPTIONS_GHC -Wno-orphans #-}
3
2
4−-- | __Example:__
5−--
6−-- >>> :set -XDerivingStrategies -XDerivingVia -XDeriveGeneric
7−--
8−-- >>> :{
9−-- data User = User
10−-- { userFirstName :: String,
11−-- userAge :: Maybe Integer
12−-- }
13−-- deriving stock (Generic)
14−-- deriving (FromJSON, ToJSON, ToSchema)
15−-- via CustomJSON
16−-- '[FieldLabelModifier '[StripPrefix "user", CamelToSnake], RejectUnknownFields]
17−-- User
18−-- showYaml = Data.ByteString.Char8.putStr . Data.Yaml.encode
19−-- :}
20−--
21−-- >>> showYaml $ toSchema (Proxy :: Proxy User)
22−-- type: object
23−-- properties:
24−-- first_name:
25−-- type: string
26−-- age:
27−-- type: integer
28−-- required:
29−-- - first_name
30−-- additionalProperties: false
31module Deriving.OpenApi
3module Deriving.OpenApi
32 ( CustomOpenApi,
4 ( CustomOpenApi,
33 DatatypeNameModifier,
5 DatatypeNameModifier,
34 ToSchema,
6 ToSchema,
35 module Deriving.Aeson,
7 module Deriving.Aeson,
8+ Extending,
36 )
9 )
37where
10where
38
11
39import Control.Lens
12import Control.Lens
40import qualified Data.Aeson.Types as A
13import qualified Data.Aeson.Types as A
14+import Data.Kind
41import Data.OpenApi
15import Data.OpenApi
42−import Data.OpenApi.Internal.ParamSchema
43import Data.OpenApi.Internal.Schema
16import Data.OpenApi.Internal.Schema
44import Data.Proxy
17import Data.Proxy
45import Data.Text (Text)
18import Data.Text (Text)
@@ -48,92 +21,82 @@ import Data.Typeable
48import Deriving.Aeson
21import Deriving.Aeson
49import GHC.Generics
22import GHC.Generics
50import GHC.TypeLits
23import GHC.TypeLits
24+import Servant.API
51
25
52−data Description (desc :: Symbol) = Description
26+type CustomOpenApi = CustomJSON
27+
28+instance (OpenApiOptions xs, GToSchema (Rep x), Generic x, Typeable x, Typeable xs) => ToSchema (CustomJSON xs x) where
29+ declareNamedSchema Proxy =
30+ openApiSchemaModifier @xs <$> genericDeclareNamedSchema (openApiOptions @xs) (Proxy @x)
31+
32+data DatatypeNameModifier t
33+
34+instance (StringModifier f, OpenApiOptions xs) => OpenApiOptions (DatatypeNameModifier f ': xs) where
35+ openApiOptions = (openApiOptions @xs) {datatypeNameModifier = getStringModifier @f}
36+
37+instance (AesonOptions xs) => AesonOptions (DatatypeNameModifier f ': xs) where
38+ aesonOptions = aesonOptions @xs
53
39
54instance (AesonOptions xs) => AesonOptions (Description f ': xs) where
40instance (AesonOptions xs) => AesonOptions (Description f ': xs) where
55 aesonOptions = aesonOptions @xs
41 aesonOptions = aesonOptions @xs
56
42
57−instance KnownSymbol t => OpenApiOptionModifier (Description t) where
43+instance (OpenApiOptions xs, KnownSymbol t) => OpenApiOptions (Description t ': xs) where
44+ openApiOptions = openApiOptions @xs
58 openApiSchemaModifier = schema . description <>~ Just (toTextLine @t)
45 openApiSchemaModifier = schema . description <>~ Just (toTextLine @t)
59
46
60toTextLine :: forall s. KnownSymbol s => Text
47toTextLine :: forall s. KnownSymbol s => Text
61toTextLine = "\n\n" <> T.pack (symbolVal (Proxy @s))
48toTextLine = "\n\n" <> T.pack (symbolVal (Proxy @s))
62
49
63−-- $setup
50+type family (++) (x :: [k]) (y :: [k]) :: [k] where
64−-- >>> import qualified Data.Yaml
51+ (++) '[] ys = ys
65−-- >>> import qualified Data.ByteString.Char8
52+ (++) (x ': xs) ys = xs ++ (x ': ys)
66−
67−type CustomOpenApi = CustomJSON
68
53
69−instance
54+type family Extending (c :: * -> *) (ee :: [*]) :: * -> * where
70− (OpenApiOptionModifier xs, GToSchema (Rep x), Generic x, Typeable x, Typeable xs, Typeable k) =>
55+ Extending (CustomJSON a) ee = CustomJSON (a ++ ee)
71− ToSchema (CustomJSON (xs :: k) x)
72− where
73− declareNamedSchema Proxy =
74− openApiSchemaModifier @xs
75− <$> genericDeclareNamedSchema (openApiOptionsModifier @xs defaultSchemaOptions) (Proxy @x)
76
56
77−instance
57+-- deriving-aeson-based instances
78− (OpenApiOptionModifier xs, GToParamSchema (Rep x), Generic x) =>
79− ToParamSchema (CustomJSON (xs :: k) x)
80− where
81− toParamSchema Proxy =
82− genericToParamSchema (openApiOptionsModifier @xs defaultSchemaOptions) (Proxy @x)
83
58
84−class OpenApiOptionModifier x where
59+class OpenApiOptions (xs :: [Type]) where
85− openApiOptionsModifier :: SchemaOptions -> SchemaOptions
60+ openApiOptions :: SchemaOptions
86− openApiOptionsModifier = id
87 openApiSchemaModifier :: NamedSchema -> NamedSchema
61 openApiSchemaModifier :: NamedSchema -> NamedSchema
88 openApiSchemaModifier = id
62 openApiSchemaModifier = id
89
63
90−data DatatypeNameModifier t
64+instance OpenApiOptions '[] where
65+ openApiOptions = defaultSchemaOptions
91
66
92−instance (StringModifier f) => OpenApiOptionModifier (DatatypeNameModifier f) where
67+instance OpenApiOptions xs => OpenApiOptions (UnwrapUnaryRecords ': xs) where
93− openApiOptionsModifier o = o {datatypeNameModifier = getStringModifier @f}
68+ openApiOptions = (openApiOptions @xs) {unwrapUnaryRecords = True}
94
69
95−instance (AesonOptions xs) => AesonOptions (DatatypeNameModifier f ': xs) where
70+instance OpenApiOptions xs => OpenApiOptions (OmitNothingFields ': xs) where
96− aesonOptions = aesonOptions @xs
71+ openApiOptions = openApiOptions @xs
97
72
98−-- deriving-aeson-based instances
99−
100−instance OpenApiOptionModifier UnwrapUnaryRecords where
101− openApiOptionsModifier o = o {unwrapUnaryRecords = True}
102−
103−instance OpenApiOptionModifier OmitNothingFields
104−
105−#if MIN_VERSION_deriving_aeson(0,2,4)
106−instance OpenApiOptionModifier RejectUnknownFields where
73+instance OpenApiOptions xs => OpenApiOptions (RejectUnknownFields ': xs) where
74+ openApiOptions = openApiOptions @xs
107 openApiSchemaModifier = schema . additionalProperties .~ Just (AdditionalPropertiesAllowed False)
75 openApiSchemaModifier = schema . additionalProperties .~ Just (AdditionalPropertiesAllowed False)
108−#endif
109
76
110−instance StringModifier f => OpenApiOptionModifier (FieldLabelModifier f) where
77+instance (StringModifier f, OpenApiOptions xs) => OpenApiOptions (FieldLabelModifier f ': xs) where
111− openApiOptionsModifier o = o {fieldLabelModifier = getStringModifier @f}
78+ openApiOptions = (openApiOptions @xs) {fieldLabelModifier = getStringModifier @f}
112
79
113−instance StringModifier f => OpenApiOptionModifier (ConstructorTagModifier f) where
80+instance (StringModifier f, OpenApiOptions xs) => OpenApiOptions (ConstructorTagModifier f ': xs) where
114− openApiOptionsModifier o = o {constructorTagModifier = getStringModifier @f}
81+ openApiOptions = (openApiOptions @xs) {constructorTagModifier = getStringModifier @f}
115
82
116instance
83instance
117− TypeError ('Text "deriving-openapi3 does not currently the `TagSingleConstructors` modifier.") =>
84+ (OpenApiOptions xs, TypeError ('Text "openapi3-deriving does not currently the `TagSingleConstructors` modifier.")) =>
118− OpenApiOptionModifier TagSingleConstructors
85+ OpenApiOptions (TagSingleConstructors ': xs)
119−
86+ where
120−instance OpenApiOptionModifier NoAllNullaryToStringTag where
87+ openApiOptions = undefined
121− openApiOptionsModifier o = o {allNullaryToStringTag = False}
122−
123−instance (KnownSymbol t, KnownSymbol c) => OpenApiOptionModifier (SumTaggedObject t c) where
124− openApiOptionsModifier o = o {sumEncoding = A.TaggedObject (symbolVal (Proxy @t)) (symbolVal (Proxy @c))}
125
88
126−instance OpenApiOptionModifier SumUntaggedValue where
89+instance OpenApiOptions xs => OpenApiOptions (NoAllNullaryToStringTag ': xs) where
127− openApiOptionsModifier o = o {sumEncoding = A.UntaggedValue}
90+ openApiOptions = (openApiOptions @xs) {allNullaryToStringTag = False}
128
91
129−instance OpenApiOptionModifier SumObjectWithSingleField where
92+instance (KnownSymbol t, KnownSymbol c, OpenApiOptions xs) => OpenApiOptions (SumTaggedObject t c ': xs) where
130− openApiOptionsModifier o = o {sumEncoding = A.ObjectWithSingleField}
93+ openApiOptions = (openApiOptions @xs) {sumEncoding = A.TaggedObject (symbolVal (Proxy @t)) (symbolVal (Proxy @c))}
131
94
132−instance OpenApiOptionModifier SumTwoElemArray where
95+instance (OpenApiOptions xs) => OpenApiOptions (SumUntaggedValue ': xs) where
133− openApiOptionsModifier o = o {sumEncoding = A.TwoElemArray}
96+ openApiOptions = (openApiOptions @xs) {sumEncoding = A.UntaggedValue}
134
97
135−instance OpenApiOptionModifier '[]
98+instance (OpenApiOptions xs) => OpenApiOptions (SumObjectWithSingleField ': xs) where
99+ openApiOptions = (openApiOptions @xs) {sumEncoding = A.ObjectWithSingleField}
136
100
137−instance (OpenApiOptionModifier x, OpenApiOptionModifier xs) => OpenApiOptionModifier (x ': xs) where
101+instance (OpenApiOptions xs) => OpenApiOptions (SumTwoElemArray ': xs) where
138− openApiOptionsModifier = openApiOptionsModifier @xs . openApiOptionsModifier @x
102+ openApiOptions = (openApiOptions @xs) {sumEncoding = A.TwoElemArray}
139− openApiSchemaModifier = openApiSchemaModifier @xs . openApiSchemaModifier @x
stack.yaml+4−1
@@ -1,4 +1,7 @@
1−resolver: lts-18.23
1+resolver: lts-18.21
2
2
3packages:
3packages:
4 - .
4 - .
5+
6+extra-deps:
7+ - openapi3-3.1.0