git.iko.soy/typeable/derive-api-th
on master help sign in
5 files changed+122−70
since splitsnapshots
unifiedsplit
README.md+1−1 default.nix+34 derive-api-th.cabal+36−34 shell.nix+1 src/Derive/API/TH.hs+50−35
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-base instance generation.
4+It is convenient to derive together and drastically reduce compile time comparing with generic-based instance generation.
default.nixnew file+34
@@ -0,0 +1,34 @@
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+36−34
@@ -1,45 +1,47 @@
1−cabal-version: 1.12
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>
26
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
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
1616
1717source-repository head
18− type: git
18+ type: git
1919 location: https://github.com/typeable/derive-api-th
2020
2121library
22− exposed-modules:
23− Derive.API.TH
24− other-modules:
25− Paths_derive_api_th
26− hs-source-dirs:
27− src
22+ exposed-modules: Derive.API.TH
23+ other-modules: Paths_derive_api_th
24+ hs-source-dirs: src
2825 build-depends:
29− base >=4.7 && <5
30− , aeson
26+ aeson
27+ , base >=4.7 && <5
28+ , containers
3129 , template-haskell
3230 , th-abstraction
33− , generic-arbitrary
34− , QuickCheck
35− if !impl(ghcjs)
31+
32+ if !(impl(ghcjs) || arch(javascript) || arch(wasm32))
3633 build-depends:
37− openapi3
38− default-language: Haskell2010
34+ generic-arbitrary >=1.0
35+ , openapi3
36+ , QuickCheck
37+
38+ cpp-options: -DBACKEND
39+
40+ default-language: Haskell2010
3941 default-extensions:
40− BlockArguments
41− , DuplicateRecordFields
42− , NamedFieldPuns
43− , RecordWildCards
44− , StandaloneDeriving
45− , TemplateHaskell
42+ BlockArguments
43+ DuplicateRecordFields
44+ NamedFieldPuns
45+ RecordWildCards
46+ StandaloneDeriving
47+ TemplateHaskell
shell.nixnew file+1
@@ -0,0 +1 @@
1+(import ./default.nix { }).shells.ghcjs
src/Derive/API/TH.hs+50−35
@@ -10,14 +10,14 @@ module Derive.API.TH
1010 , derivingOptionsToJsonOptions
1111 , deriveApiInstances
1212 , deriveApiAndArbitraryInstances
13−#ifndef ghcjs_HOST_OS
13+#ifdef BACKEND
1414 , derivingOptionsToSchemaOptions
1515 , deriveToParamSchema
1616 , deriveToSchema
17+ , deriveArbitrary
1718#endif
1819 , deriveApiFromJSON
1920 , deriveApiToJSON
20− , deriveArbitrary
2121 , generateParseJSON
2222 ) where
2323
@@ -25,21 +25,22 @@ import Control.Monad
2525import Data.Aeson.TH as A
2626import Data.Aeson.Types
2727import Data.List
28+import Data.Map as M
2829import Data.Maybe
2930import Data.Typeable
3031import Language.Haskell.TH
3132import Language.Haskell.TH.Datatype
3233import Language.Haskell.TH.Syntax
33−import Test.QuickCheck
34−import Test.QuickCheck.Arbitrary.Generic
3534
36−#ifndef ghcjs_HOST_OS
35+#ifdef BACKEND
3736import Data.OpenApi hiding (prefix)
37+import Test.QuickCheck
38+import Test.QuickCheck.Arbitrary.Generic
3839#endif
3940
4041-- | derive JSON and openapi3 (ToSchema) instances
4142deriveApiInstances :: DerivingOptions -> Name -> Q [Dec]
42−#ifndef ghcjs_HOST_OS
43+#ifdef BACKEND
4344deriveApiInstances opts tname = liftM2 (<>)
4445 (deriveJSON (derivingOptionsToJsonOptions opts) tname)
4546 (deriveToSchema opts tname)
@@ -50,7 +51,7 @@ deriveApiInstances opts tname =
5051
5152-- | derive JSON and openapi3 (ToSchema) and Arbitrary instances
5253deriveApiAndArbitraryInstances :: DerivingOptions -> Name -> Q [Dec]
53−#ifndef ghcjs_HOST_OS
54+#ifdef BACKEND
5455deriveApiAndArbitraryInstances opts tname = liftM2 (<>)
5556 (deriveApiInstances opts tname)
5657 (deriveArbitrary tname)
@@ -59,13 +60,29 @@ deriveApiAndArbitraryInstances opts tname =
5960 deriveApiInstances opts tname
6061#endif
6162
62−-- We can't directly 'lift' Options into TH, so have to use this
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.
6378data DerivingOptions = DerivingOptions
6479 { prefix :: Maybe String
6580 -- ^ Optional prefix to strip from constructors and field labels
6681 , snake :: Bool
6782 -- ^ Whether to snake constructors and field labels
6883 -- Applied after stripping prefix
84+ , convertMap :: M.Map String String
85+ -- ^ convert names (constructors and fields) before snake and strip prefix
6986 , unwrapUnaryRecords :: Bool
7087 , omitNothingFields :: Bool
7188 , sumEncoding :: SumEncoding
@@ -77,34 +94,41 @@ defaultDerivingOptions :: DerivingOptions
7794defaultDerivingOptions = DerivingOptions
7895 { prefix = Nothing
7996 , snake = True
97+ , convertMap = mempty
8098 , unwrapUnaryRecords = False
8199 , omitNothingFields = False
82100 , sumEncoding = defaultTaggedObject }
83101
84102derivingOptionsToJsonOptions :: DerivingOptions -> Options
85103derivingOptionsToJsonOptions DerivingOptions{..} = defaultOptions
86− { fieldLabelModifier = snaked . stripped
87− , constructorTagModifier = snaked . stripped
104+ { fieldLabelModifier = snaked . stripped . convert
105+ , constructorTagModifier = snaked . stripped . convert
88106 , sumEncoding
89107 , omitNothingFields
90108 , unwrapUnaryRecords }
91109 where
110+ convert s = fromMaybe s $ M.lookup s convertMap
92111 snaked = if snake then camelTo2 '_' else id
93112 stripped = maybe id stripPrefix' prefix
94113
95−#ifndef ghcjs_HOST_OS
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
121+
96122derivingOptionsToSchemaOptions :: DerivingOptions -> SchemaOptions
97123derivingOptionsToSchemaOptions = fromAesonOptions . derivingOptionsToJsonOptions
98124
99125deriveToParamSchema :: DerivingOptions -> Name -> Q [Dec]
100126deriveToParamSchema opts tname = do
101− let
102− body = AppE (VarE 'genericToParamSchema) <$>
103− appE (pure $ VarE 'derivingOptionsToSchemaOptions) (lift opts)
104− pure <$> instanceD
105− (pure [])
106− (pure $ ConT ''ToParamSchema `AppT` ConT tname)
107− [ funD 'toParamSchema $ pure $ clause [] (normalB body) [] ]
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) []] ]]
108132
109133deriveToSchema :: DerivingOptions -> Name -> Q [Dec]
110134deriveToSchema opts tname = do
@@ -113,26 +137,18 @@ deriveToSchema opts tname = do
113137 context = do
114138 var <- datatypeVarsTypes tinfo
115139 [ConT ''Typeable `AppT` var, ConT ''ToSchema `AppT` var]
116− body = AppE (VarE 'genericDeclareNamedSchema) <$>
117− appE (pure $ VarE 'derivingOptionsToSchemaOptions) (lift opts)
118− pure <$> instanceD
119− (pure context)
120− (pure $ ConT ''ToSchema `AppT` datatypeType tinfo)
121− [ funD 'declareNamedSchema $ pure $ clause [] (normalB body) [] ]
122−
123−datatypeVarsTypes :: DatatypeInfo -> [Type]
124−#if MIN_VERSION_th_abstraction(0,3,0)
125−datatypeVarsTypes = fmap (VarT . tvName) . datatypeVars
126−#else
127−datatypeVarsTypes = datatypeVars
128−#endif
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) []] ]]
129145
130146deriveArbitrary :: Name -> Q [Dec]
131−deriveArbitrary t = do
147+deriveArbitrary t = do
132148 tinfo <- reifyDatatype t
133− let
149+ let
134150 typ = datatypeType tinfo
135− ctx = datatypeVarsTypes tinfo >>= \tv ->
151+ ctx = datatypeVarsTypes tinfo >>= \tv ->
136152 [ ConT ''Arbitrary `AppT` tv
137153 , ConT ''Arg `AppT` typ `AppT` tv ]
138154 pure [InstanceD Nothing ctx (ConT ''Arbitrary `AppT` typ)
@@ -151,4 +167,3 @@ generateParseJSON = mkParseJSON . derivingOptionsToJsonOptions
151167
152168stripPrefix' :: String -> String -> String
153169stripPrefix' pfx = fromMaybe <*> stripPrefix pfx
154−