@@ -10,7 +10,7 @@ module Derive.API.TH
1010 , derivingOptionsToJsonOptions
1111 , deriveApiInstances
1212 , deriveApiAndArbitraryInstances
13−#ifndef ghcjs_HOST_OS
13+#ifdef BACKEND
1414 , derivingOptionsToSchemaOptions
1515 , deriveToParamSchema
1616 , deriveToSchema
@@ -21,28 +21,26 @@ module Derive.API.TH
2121 , generateParseJSON
2222 ) where
2323
24−import Control.Monad
25−import Data.Aeson.TH as A
26−import Data.Aeson.Types
27−#if MIN_VERSION_th_abstraction(0,3,0)
28−import Data.Functor
29−#endif
30−import qualified Data.List as List
31−import Data.Maybe
32−import Data.Typeable
33−import Language.Haskell.TH
34−import Language.Haskell.TH.Datatype
35−import Language.Haskell.TH.Syntax
36−
37−#ifndef ghcjs_HOST_OS
38−import Data.OpenApi hiding (prefix)
39−import Test.QuickCheck
40−import Test.QuickCheck.Arbitrary.Generic
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
4139#endif
4240
4341-- | derive JSON and openapi3 (ToSchema) instances
4442deriveApiInstances :: DerivingOptions -> Name -> Q [Dec]
45−#ifndef ghcjs_HOST_OS
43+#ifdef BACKEND
4644deriveApiInstances opts tname = liftM2 (<>)
4745 (deriveJSON (derivingOptionsToJsonOptions opts) tname)
4846 (deriveToSchema opts tname)
@@ -51,9 +49,9 @@ deriveApiInstances opts tname =
5149 deriveJSON (derivingOptionsToJsonOptions opts) tname
5250#endif
5351
54−-- | derive JSON and openapi3 (ToSchema) instances
52+-- | derive JSON and openapi3 (ToSchema) and Arbitrary instances
5553deriveApiAndArbitraryInstances :: DerivingOptions -> Name -> Q [Dec]
56−#ifndef ghcjs_HOST_OS
54+#ifdef BACKEND
5755deriveApiAndArbitraryInstances opts tname = liftM2 (<>)
5856 (deriveApiInstances opts tname)
5957 (deriveArbitrary tname)
@@ -62,14 +60,31 @@ deriveApiAndArbitraryInstances opts tname =
6260 deriveApiInstances opts tname
6361#endif
6462
65−-- 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.
6678data DerivingOptions = DerivingOptions
6779 { prefix :: Maybe String
6880 -- ^ Optional prefix to strip from constructors and field labels
6981 , snake :: Bool
7082 -- ^ Whether to snake constructors and field labels
7183 -- Applied after stripping prefix
84+ , convertMap :: M.Map String String
85+ -- ^ convert names (constructors and fields) before snake and strip prefix
7286 , unwrapUnaryRecords :: Bool
87+ , omitNothingFields :: Bool
7388 , sumEncoding :: SumEncoding
7489 } deriving (Lift)
7590
@@ -79,50 +94,66 @@ defaultDerivingOptions :: DerivingOptions
7994defaultDerivingOptions = DerivingOptions
8095 { prefix = Nothing
8196 , snake = True
82− , unwrapUnaryRecords = True
97+ , convertMap = mempty
98+ , unwrapUnaryRecords = False
99+ , omitNothingFields = False
83100 , sumEncoding = defaultTaggedObject }
84101
85102derivingOptionsToJsonOptions :: DerivingOptions -> Options
86103derivingOptionsToJsonOptions DerivingOptions{..} = defaultOptions
87− { fieldLabelModifier = snaked . stripped
88− , constructorTagModifier = snaked . stripped
104+ { fieldLabelModifier = snaked . stripped . convert
105+ , constructorTagModifier = snaked . stripped . convert
89106 , sumEncoding
107+ , omitNothingFields
90108 , unwrapUnaryRecords }
91109 where
110+ convert s = fromMaybe s $ M.lookup s convertMap
92111 snaked = if snake then camelTo2 '_' else id
93− stripped = maybe id stripPrefix prefix
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
94121
95−#ifndef ghcjs_HOST_OS
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− tvars = datatypeVars tinfo
114−#if MIN_VERSION_th_abstraction(0,3,0)
115− <&> VarT . tvName
116−#endif
117137 context = do
118− var <- tvars
138+ var <- datatypeVarsTypes tinfo
119139 [ConT ''Typeable `AppT` var, ConT ''ToSchema `AppT` var]
120− body = AppE (VarE 'genericDeclareNamedSchema) <$>
121− appE (pure $ VarE 'derivingOptionsToSchemaOptions) (lift opts)
122− pure <$> instanceD
123− (pure context)
124− (pure $ ConT ''ToSchema `AppT` datatypeType tinfo)
125− [ 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) []] ] ]
126157#endif
127158
128159deriveApiFromJSON :: DerivingOptions -> Name -> Q [Dec]
@@ -134,14 +165,5 @@ deriveApiToJSON = deriveToJSON . derivingOptionsToJsonOptions
134165generateParseJSON :: DerivingOptions -> Name -> Q Exp
135166generateParseJSON = mkParseJSON . derivingOptionsToJsonOptions
136167
137−stripPrefix :: String -> String -> String
138−stripPrefix pfx = fromMaybe <*> List.stripPrefix pfx
139−
140−#ifndef ghcjs_HOST_OS
141−deriveArbitrary :: Name -> Q [Dec]
142−deriveArbitrary t = [d|
143− instance Arbitrary $(conT t) where
144− arbitrary = genericArbitrary
145− shrink = genericShrink
146− |]
147−#endif
168+stripPrefix' :: String -> String -> String
169+stripPrefix' pfx = fromMaybe <*> stripPrefix pfx