@@ -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)
@@ -48,9 +49,9 @@ deriveApiInstances opts tname =
4849 deriveJSON (derivingOptionsToJsonOptions opts) tname
4950#endif
5051
51−-- | derive JSON and openapi3 (ToSchema) instances
52+-- | 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,53 +94,66 @@ 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
111135 tinfo <- reifyDatatype tname
112136 let
113−#if MIN_VERSION_th_abstraction(0,3,0)
114− tvars = VarT . tvName <$> datatypeVars tinfo
115−#else
116− tvars = datatypeVars tinfo
117−#endif
118137 context = do
119− var <- tvars
138+ var <- datatypeVarsTypes tinfo
120139 [ConT ''Typeable `AppT` var, ConT ''ToSchema `AppT` var]
121− body = AppE (VarE 'genericDeclareNamedSchema) <$>
122− appE (pure $ VarE 'derivingOptionsToSchemaOptions) (lift opts)
123− pure <$> instanceD
124− (pure context)
125− (pure $ ConT ''ToSchema `AppT` datatypeType tinfo)
126− [ funD 'declareNamedSchema $ pure $ clause [] (normalB body) [] ]
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) []] ] ]
127157#endif
128158
129159deriveApiFromJSON :: DerivingOptions -> Name -> Q [Dec]
@@ -137,10 +167,3 @@ generateParseJSON = mkParseJSON . derivingOptionsToJsonOptions
137167
138168stripPrefix' :: String -> String -> String
139169stripPrefix' pfx = fromMaybe <*> stripPrefix pfx
140−
141−deriveArbitrary :: Name -> Q [Dec]
142−deriveArbitrary t = [d|
143− instance Arbitrary $(conT t) where
144− arbitrary = genericArbitrary
145− shrink = genericShrink
146− |]