git.iko.soy/typeable/derive-api-th
on 075cd79 help sign in
6 files changed+90−152
since splitsnapshots
unifiedsplit
README.md+1−1 default.nix−34 derive-api-th.cabal+32−35 shell.nix−1 src/Derive/API/TH.hs+56−79 stack.yaml+1−2
README.md+1−1
@@ -1,4 +1,4 @@
11# derive-api-th
22
33Derive JSON and Openapi3 instances using TH.
4−It is convenient to derive together and drastically reduce compile time comparing with generic-based instance generation.
4+It is convenient to derive together and drastically reduce compile time comparing with generic-base instance generation.
default.nixdeleted−34
@@ -1,34 +0,0 @@
1−{ reflex-platform ? ((import <nixpkgs> {}).fetchFromGitHub {
2− owner = "reflex-frp";
3− repo = "reflex-platform";
4− rev = "a4664e3b99f1b89a77ac759501b6bd85e18eac95";
5− sha256 = "1pjzjhj966rs16f4b80ir9v8d7g7q2aa0i0zs30fny3x0xk1b4ah";
6− })
7−}:
8−(import reflex-platform { config.allowBroken = true; }).project ({ pkgs, ... }:{
9− useWarp = true;
10− withHoogle = false;
11−
12− packages = {
13− derive-api-th = ../derive-api-th;
14− };
15−
16− tools = _: [
17− (pkgs.haskell.lib.dontCheck pkgs.haskellPackages.cabal-cargs)
18− pkgs.inotify-tools
19− ];
20−
21− shellToolOverrides = ghc: super: {
22− closure-compiler = null;
23− haskell-ide-engine = null;
24− hdevtools = null;
25− hlint = null;
26− stylish-haskell = null;
27− hoogle = null;
28− };
29−
30− shells = {
31− ghc = ["derive-api-th"];
32− ghcjs = ["derive-api-th"];
33− };
34−})
derive-api-th.cabal+32−35
@@ -1,47 +1,44 @@
1−cabal-version: 1.12
2−name: derive-api-th
3−version: 0.1.0.0
4−description:
5− Please see the README on GitHub at <https://github.com/typeable/derive-api-th#readme>
1+cabal-version: 1.12
62
7−homepage: https://github.com/typeable/derive-api-th#readme
8−bug-reports: https://github.com/typeable/derive-api-th/issues
9−author: Typeable
10−maintainer: dima@typeable.io
11−copyright: 2022 Typeable LLC
12−license: BSD3
13−license-file: LICENSE
14−build-type: Simple
15−extra-source-files: README.md
3+name: derive-api-th
4+version: 0.1.0.0
5+description: Please see the README on GitHub at <https://github.com/typeable/derive-api-th#readme>
6+homepage: https://github.com/typeable/derive-api-th#readme
7+bug-reports: https://github.com/typeable/derive-api-th/issues
8+author: Typeable
9+maintainer: dima@typeable.io
10+copyright: 2022 Typeable LLC
11+license: BSD3
12+license-file: LICENSE
13+build-type: Simple
14+extra-source-files:
15+ README.md
1616
1717source-repository head
18− type: git
18+ type: git
1919 location: https://github.com/typeable/derive-api-th
2020
2121library
22− exposed-modules: Derive.API.TH
23− other-modules: Paths_derive_api_th
24− hs-source-dirs: src
22+ exposed-modules:
23+ Derive.API.TH
24+ other-modules:
25+ Paths_derive_api_th
26+ hs-source-dirs:
27+ src
2528 build-depends:
26− aeson
27− , base >=4.7 && <5
28− , containers
29+ base >=4.7 && <5
30+ , aeson
2931 , template-haskell
3032 , th-abstraction
31−
32− if !(impl(ghcjs) || arch(javascript) || arch(wasm32))
33+ if !impl(ghcjs)
3334 build-depends:
34− generic-arbitrary >=1.0
35− , openapi3
35+ openapi3
36+ , generic-arbitrary
3637 , QuickCheck
37−
38− cpp-options: -DBACKEND
39−
40− default-language: Haskell2010
38+ default-language: Haskell2010
4139 default-extensions:
42− BlockArguments
43− DuplicateRecordFields
44− NamedFieldPuns
45− RecordWildCards
46− StandaloneDeriving
47− TemplateHaskell
40+ DuplicateRecordFields
41+ , NamedFieldPuns
42+ , RecordWildCards
43+ , StandaloneDeriving
44+ , TemplateHaskell
shell.nixdeleted−1
@@ -1 +0,0 @@
1−(import ./default.nix { }).shells.ghcjs
src/Derive/API/TH.hs+56−79
@@ -9,8 +9,7 @@ module Derive.API.TH
99 , defaultDerivingOptions
1010 , derivingOptionsToJsonOptions
1111 , deriveApiInstances
12− , deriveApiAndArbitraryInstances
13−#ifdef BACKEND
12+#ifndef ghcjs_HOST_OS
1413 , derivingOptionsToSchemaOptions
1514 , deriveToParamSchema
1615 , deriveToSchema
@@ -21,26 +20,28 @@ module Derive.API.TH
2120 , generateParseJSON
2221 ) where
2322
24−import Control.Monad
25−import Data.Aeson.TH as A
26−import Data.Aeson.Types
27−import Data.List
28−import Data.Map as M
29−import Data.Maybe
30−import Data.Typeable
31−import Language.Haskell.TH
32−import Language.Haskell.TH.Datatype
33−import Language.Haskell.TH.Syntax
34−
35−#ifdef BACKEND
36−import Data.OpenApi hiding (prefix)
37−import Test.QuickCheck
38−import Test.QuickCheck.Arbitrary.Generic
23+import Control.Monad
24+import Data.Aeson.TH as A
25+import Data.Aeson.Types
26+#if MIN_VERSION_th_abstraction(0,3,0)
27+import Data.Functor
28+#endif
29+import qualified Data.List as List
30+import Data.Maybe
31+import Data.Typeable
32+import Language.Haskell.TH
33+import Language.Haskell.TH.Datatype
34+import Language.Haskell.TH.Syntax
35+
36+#ifndef ghcjs_HOST_OS
37+import Data.OpenApi hiding (prefix)
38+import Test.QuickCheck
39+import Test.QuickCheck.Arbitrary.Generic
3940#endif
4041
4142-- | derive JSON and openapi3 (ToSchema) instances
4243deriveApiInstances :: DerivingOptions -> Name -> Q [Dec]
43−#ifdef BACKEND
44+#ifndef ghcjs_HOST_OS
4445deriveApiInstances opts tname = liftM2 (<>)
4546 (deriveJSON (derivingOptionsToJsonOptions opts) tname)
4647 (deriveToSchema opts tname)
@@ -49,9 +50,9 @@ deriveApiInstances opts tname =
4950 deriveJSON (derivingOptionsToJsonOptions opts) tname
5051#endif
5152
52−-- | derive JSON and openapi3 (ToSchema) and Arbitrary instances
53+-- | derive JSON and openapi3 (ToSchema) instances
5354deriveApiAndArbitraryInstances :: DerivingOptions -> Name -> Q [Dec]
54−#ifdef BACKEND
55+#ifndef ghcjs_HOST_OS
5556deriveApiAndArbitraryInstances opts tname = liftM2 (<>)
5657 (deriveApiInstances opts tname)
5758 (deriveArbitrary tname)
@@ -60,31 +61,14 @@ deriveApiAndArbitraryInstances opts tname =
6061 deriveApiInstances opts tname
6162#endif
6263
63−#if MIN_VERSION_containers(0,6,6)
64−#elif MIN_VERSION_template_haskell(2,17,0)
65−instance (Lift k, Lift a) => Lift (Map k a) where
66− liftTyped x = unsafeCodeCoerce (lift x)
67− lift m = [|M.fromList (M.toList m)|]
68−#elif MIN_VERSION_template_haskell(2,16,0)
69−instance (Lift k, Lift a) => Lift (Map k a) where
70− liftTyped x = unsafeTExpCoerce (lift x)
71− lift m = [|M.fromList (M.toList m)|]
72−#else
73−instance (Lift k, Lift a) => Lift (Map k a) where
74− lift m = [|M.fromList (M.toList m)|]
75−#endif
76−-- We can't directly 'lift' Options into TH (there is no instance for function),
77−-- so we use this type.
64+-- We can't directly 'lift' Options into TH, so have to use this
7865data DerivingOptions = DerivingOptions
7966 { prefix :: Maybe String
8067 -- ^ Optional prefix to strip from constructors and field labels
8168 , snake :: Bool
8269 -- ^ Whether to snake constructors and field labels
8370 -- Applied after stripping prefix
84− , convertMap :: M.Map String String
85− -- ^ convert names (constructors and fields) before snake and strip prefix
8671 , unwrapUnaryRecords :: Bool
87− , omitNothingFields :: Bool
8872 , sumEncoding :: SumEncoding
8973 } deriving (Lift)
9074
@@ -94,66 +78,50 @@ defaultDerivingOptions :: DerivingOptions
9478defaultDerivingOptions = DerivingOptions
9579 { prefix = Nothing
9680 , snake = True
97− , convertMap = mempty
98− , unwrapUnaryRecords = False
99− , omitNothingFields = False
81+ , unwrapUnaryRecords = True
10082 , sumEncoding = defaultTaggedObject }
10183
10284derivingOptionsToJsonOptions :: DerivingOptions -> Options
10385derivingOptionsToJsonOptions DerivingOptions{..} = defaultOptions
104− { fieldLabelModifier = snaked . stripped . convert
105− , constructorTagModifier = snaked . stripped . convert
86+ { fieldLabelModifier = snaked . stripped
87+ , constructorTagModifier = snaked . stripped
10688 , sumEncoding
107− , omitNothingFields
10889 , unwrapUnaryRecords }
10990 where
110− convert s = fromMaybe s $ M.lookup s convertMap
11191 snaked = if snake then camelTo2 '_' else id
112− stripped = maybe id stripPrefix' prefix
113−
114−#ifdef BACKEND
115−datatypeVarsTypes :: DatatypeInfo -> [Type]
116−#if MIN_VERSION_th_abstraction(0,3,0)
117−datatypeVarsTypes = fmap (VarT . tvName) . datatypeVars
118−#else
119−datatypeVarsTypes = datatypeVars
120−#endif
92+ stripped = maybe id stripPrefix prefix
12193
94+#ifndef ghcjs_HOST_OS
12295derivingOptionsToSchemaOptions :: DerivingOptions -> SchemaOptions
12396derivingOptionsToSchemaOptions = fromAesonOptions . derivingOptionsToJsonOptions
12497
12598deriveToParamSchema :: DerivingOptions -> Name -> Q [Dec]
12699deriveToParamSchema opts tname = do
127− body <- AppE (VarE 'genericToParamSchema)
128− . AppE (VarE 'derivingOptionsToSchemaOptions) <$> lift opts
129− pure [InstanceD Nothing []
130− (ConT ''ToParamSchema `AppT` ConT tname)
131− [FunD 'toParamSchema [Clause [] (NormalB body) []] ]]
100+ let
101+ body = AppE (VarE 'genericToParamSchema) <$>
102+ appE (pure $ VarE 'derivingOptionsToSchemaOptions) (lift opts)
103+ pure <$> instanceD
104+ (pure [])
105+ (pure $ ConT ''ToParamSchema `AppT` ConT tname)
106+ [ funD 'toParamSchema $ pure $ clause [] (normalB body) [] ]
132107
133108deriveToSchema :: DerivingOptions -> Name -> Q [Dec]
134109deriveToSchema opts tname = do
135110 tinfo <- reifyDatatype tname
136111 let
112+ tvars = datatypeVars tinfo
113+#if MIN_VERSION_th_abstraction(0,3,0)
114+ <&> VarT . tvName
115+#endif
137116 context = do
138− var <- datatypeVarsTypes tinfo
117+ var <- tvars
139118 [ConT ''Typeable `AppT` var, ConT ''ToSchema `AppT` var]
140− body <- AppE (VarE 'genericDeclareNamedSchema)
141− . AppE (VarE 'derivingOptionsToSchemaOptions) <$> lift opts
142− pure [InstanceD Nothing context
143− (ConT ''ToSchema `AppT` datatypeType tinfo)
144− [ FunD 'declareNamedSchema [Clause [] (NormalB body) []] ]]
145−
146−deriveArbitrary :: Name -> Q [Dec]
147−deriveArbitrary t = do
148− tinfo <- reifyDatatype t
149− let
150− typ = datatypeType tinfo
151− ctx = datatypeVarsTypes tinfo >>= \tv ->
152− [ ConT ''Arbitrary `AppT` tv
153− , ConT ''Arg `AppT` typ `AppT` tv ]
154− pure [InstanceD Nothing ctx (ConT ''Arbitrary `AppT` typ)
155− [ FunD 'arbitrary [Clause [] (NormalB $ VarE 'genericArbitrary) []]
156− , FunD 'shrink [Clause [] (NormalB $ VarE 'genericShrink) []] ] ]
119+ body = AppE (VarE 'genericDeclareNamedSchema) <$>
120+ appE (pure $ VarE 'derivingOptionsToSchemaOptions) (lift opts)
121+ pure <$> instanceD
122+ (pure context)
123+ (pure $ ConT ''ToSchema `AppT` datatypeType tinfo)
124+ [ funD 'declareNamedSchema $ pure $ clause [] (normalB body) [] ]
157125#endif
158126
159127deriveApiFromJSON :: DerivingOptions -> Name -> Q [Dec]
@@ -165,5 +133,14 @@ deriveApiToJSON = deriveToJSON . derivingOptionsToJsonOptions
165133generateParseJSON :: DerivingOptions -> Name -> Q Exp
166134generateParseJSON = mkParseJSON . derivingOptionsToJsonOptions
167135
168−stripPrefix' :: String -> String -> String
169−stripPrefix' pfx = fromMaybe <*> stripPrefix pfx
136+stripPrefix :: String -> String -> String
137+stripPrefix pfx = fromMaybe <*> List.stripPrefix pfx
138+
139+#ifndef ghcjs_HOST_OS
140+deriveArbitrary :: Name -> Q [Dec]
141+deriveArbitrary t = [d|
142+ instance Arbitrary $(conT t) where
143+ arbitrary = genericArbitrary
144+ shrink = genericShrink
145+ |]
146+#endif
stack.yaml+1−2
@@ -1,5 +1,4 @@
1−resolver: lts-22.27
2−# resolver: lts-19.16
1+resolver: lts-19.16
32# resolver: lts-18.6
43
54packages: