master..0a19087 · typeable/schematic

ChangeLog.md−11

since splitsnapshots

unifiedsplit

@@ -1,16 +1,5 @@

1# Revision history for schematic

2

3−## 0.6.0.0 -- 2021-01-15

4−

5−Added compatability with aeson-1.4.3.0. Since version 1.4.3 the module `Data.Aeson` started exporting `JSONPath`, which was conflicting with our own `JSONPath`. Furthermore, started using `JSONPathElement` from `aeson` instead of `DemotedPathSegment`.

6−

7−## 0.5.1.0 -- 2021-01-15

8−

9−Fix the generation of json schema for numbers.

10−Add array constraints.

11−Fix the generation of text and number constraints.

12−Remove jsonpath from the error message.

13−

14## 0.5.0.0 -- 2019-02-20

3## 0.5.0.0 -- 2019-02-20

15

4

16GHC 8.6, json generation by schema definition, validation bug fixes, better

5GHC 8.6, json generation by schema definition, validation bug fixes, better

schematic.cabal+4−8

@@ -1,5 +1,5 @@

1name: schematic

2−version: 0.6.0.0

2+version: 0.5.0.0

3synopsis: JSON-biased spec and validation tool

4description: JSON-biased spec and validation tool. Makes possible to have a schema as a haskell type and derive json instances, validation actions, JSON generation for property-test generically. Built-in lens support.

5license: BSD3

@@ -10,7 +10,7 @@ homepage: http://github.com/typeable/schematic

10Bug-reports: http://github.com/typeable/schematic/issues/

11category: Data

12build-type: Simple

13−extra-source-files: ChangeLog.md, README.md

13+extra-source-files: ChangeLog.md

14cabal-version: >=1.10

15

16library

@@ -65,9 +65,9 @@ library

65 , TypeOperators

66 , TypeSynonymInstances

67 , UndecidableInstances

68− build-depends: base >=4.11 && <5

68+ build-depends: base >=4.11 && <4.13

69 , bytestring

70− , aeson >= 1.4.3.0 && < 1.6

70+ , aeson >= 1

71 , containers

72 , hjsonschema

73 , mtl

@@ -118,7 +118,3 @@ test-suite spec

118 , HelpersSpec

119 , LensSpec

120 , JsonSchemaSpec

121−

122−source-repository head

123− type: git

124− location: https://github.com/typeable/schematic

src/Data/Schematic/JsonSchema.hs+9−21

@@ -30,13 +30,13 @@ textConstraint :: DemotedTextConstraint -> State D4.Schema ()

30textConstraint (DTEq n) = modify $ \s -> s

31 { _schemaMinLength = pure $ fromIntegral n

32 , _schemaMaxLength = pure $ fromIntegral n }

33+textConstraint (DTLt n) = modify $ \s -> s

34+ { _schemaMaxLength = pure . fromIntegral $ n + 1 }

33textConstraint (DTLe n) = modify $ \s -> s

35textConstraint (DTLe n) = modify $ \s -> s

34 { _schemaMaxLength = pure . fromIntegral $ n }

36 { _schemaMaxLength = pure . fromIntegral $ n }

35−textConstraint (DTLt n) =

37+textConstraint (DTGt n) =

36 let n' = if n == 0 then 0 else n - 1

38 let n' = if n == 0 then 0 else n - 1

37− in modify $ \s -> s { _schemaMaxLength = pure . fromIntegral $ n' }

39+ in modify $ \s -> s { _schemaMinLength = pure . fromIntegral $ n' }

38−textConstraint (DTGt n) = modify $ \s -> s

39− { _schemaMinLength = pure . fromIntegral $ n + 1 }

40textConstraint (DTGe n) = modify $ \s -> s

41 { _schemaMinLength = pure . fromIntegral $ n }

42textConstraint (DTRegex r) = modify $ \s -> s { _schemaPattern = pure r }

@@ -48,30 +48,18 @@ numberConstraint :: DemotedNumberConstraint -> State D4.Schema ()

48numberConstraint (DNLe n) = modify $ \s -> s

49 { _schemaMaximum = pure . fromIntegral $ n }

50numberConstraint (DNLt n) = modify $ \s -> s

51− { _schemaMaximum = pure . fromIntegral $ n

51+ { _schemaMaximum = pure . fromIntegral $ n + 1 }

52− , _schemaExclusiveMaximum = pure True }

53numberConstraint (DNGt n) = modify $ \s -> s

52numberConstraint (DNGt n) = modify $ \s -> s

54− { _schemaMinimum = pure . fromIntegral $ n

55− , _schemaExclusiveMinimum = pure True }

56−numberConstraint (DNGe n) = modify $ \s -> s

57 { _schemaMinimum = pure . fromIntegral $ n }

53 { _schemaMinimum = pure . fromIntegral $ n }

54+numberConstraint (DNGe n) =

55+ let n' = if n == 0 then 0 else n - 1

56+ in modify $ \s -> s { _schemaMinimum = pure . fromIntegral $ n' }

58numberConstraint (DNEq n) = modify $ \s -> s

57numberConstraint (DNEq n) = modify $ \s -> s

59 { _schemaMinimum = pure $ fromIntegral n

58 { _schemaMinimum = pure $ fromIntegral n

60 , _schemaMaximum = pure $ fromIntegral n }

59 , _schemaMaximum = pure $ fromIntegral n }

61

60

62arrayConstraint :: DemotedArrayConstraint -> State D4.Schema ()

61arrayConstraint :: DemotedArrayConstraint -> State D4.Schema ()

63−arrayConstraint (DALe n) = modify $ \s -> s

62+arrayConstraint (DAEq _) = pure ()

64− { _schemaMaxItems = pure . fromIntegral $ n }

65−arrayConstraint (DALt n) =

66− let n' = if n == 0 then 0 else n - 1

67− in modify $ \s -> s { _schemaMaxItems = pure . fromIntegral $ n' }

68−arrayConstraint (DAGt n) = modify $ \s -> s

69− { _schemaMinItems = pure . fromIntegral $ n + 1 }

70−arrayConstraint (DAGe n) = modify $ \s -> s

71− { _schemaMinItems = pure . fromIntegral $ n }

72−arrayConstraint (DAEq n) = modify $ \s -> s

73− { _schemaMinItems = pure $ fromIntegral n

74− , _schemaMaxItems = pure $ fromIntegral n }

75

63

76toJsonSchema

64toJsonSchema

77 :: forall proxy schema

65 :: forall proxy schema

src/Data/Schematic/Path.hs+20−17

@@ -4,33 +4,36 @@ import Data.Foldable as F

4import Data.Singletons.Prelude

5import Data.Singletons.TypeLits

6import Data.Text as T

7−import Data.Aeson.Internal

8

7

9

8

10−newtype JSONPathText = JSONPathText Text

11− deriving (Show)

12−

13−data PathSegment = PathKey Symbol | PathIx Nat

9+data PathSegment = Key Symbol | Ix Nat

14

10

15data instance Sing (jp :: PathSegment) where

11data instance Sing (jp :: PathSegment) where

16− SKey :: (SingI k) => Sing (k :: Symbol) -> Sing ('PathKey k)

12+ SKey :: (SingI k) => Sing (k :: Symbol) -> Sing ('Key k)

17− SIx :: (SingI n) => Sing (n :: Nat) -> Sing ('PathIx n)

13+ SIx :: (SingI n) => Sing (n :: Nat) -> Sing ('Ix n)

14+

15+data DemotedPathSegment = DKey Text | DIx Integer

16+ deriving (Show)

17+

18+-- | Textual representation of json path.

19+newtype JSONPath = JSONPath Text

20+ deriving (Show)

18

21

19−demotePath :: Sing (ps :: [PathSegment]) -> JSONPath

22+demotePath :: Sing (ps :: [PathSegment]) -> [DemotedPathSegment]

20demotePath = go []

23demotePath = go []

21 where

24 where

22− go :: JSONPath -> Sing (ps :: [PathSegment]) -> JSONPath

25+ go :: [DemotedPathSegment] -> Sing (ps :: [PathSegment]) -> [DemotedPathSegment]

23 go acc SNil = acc

26 go acc SNil = acc

24 go acc (SCons p ps) = go (acc ++ [demotePathSeg p]) ps

27 go acc (SCons p ps) = go (acc ++ [demotePathSeg p]) ps

25− demotePathSeg :: Sing (ps :: PathSegment) -> JSONPathElement

28+ demotePathSeg :: Sing (ps :: PathSegment) -> DemotedPathSegment

26− demotePathSeg (SKey s) = Key $ T.pack $ withKnownSymbol s $ symbolVal s

29+ demotePathSeg (SKey s) = DKey $ T.pack $ withKnownSymbol s $ symbolVal s

27− demotePathSeg (SIx n) = Index $ withKnownNat n $ fromIntegral $ natVal n

30+ demotePathSeg (SIx n) = DIx $ withKnownNat n $ fromIntegral $ natVal n

28

31

29−demotedPathToText :: JSONPath -> JSONPathText

32+demotedPathToText :: [DemotedPathSegment] -> JSONPath

30−demotedPathToText = JSONPathText . F.foldl' renderPathSegment ""

33+demotedPathToText = JSONPath . F.foldl' renderPathSegment ""

31 where

34 where

32− renderPathSegment acc (Key t) = acc <> "." <> t

35+ renderPathSegment acc (DKey t) = acc <> "." <> t

33− renderPathSegment acc (Index n) = acc <> "[" <> T.pack (show n) <> "]"

36+ renderPathSegment acc (DIx n) = acc <> "[" <> T.pack (show n) <> "]"

34

37

35−pathToText :: Sing (ps :: [PathSegment]) -> JSONPathText

38+pathToText :: Sing (ps :: [PathSegment]) -> JSONPath

36pathToText = demotedPathToText . demotePath

39pathToText = demotedPathToText . demotePath

src/Data/Schematic/Schema.hs−36

@@ -180,63 +180,27 @@ instance SingKind NumberConstraint where

180

181data ArrayConstraint

182 = AEq Nat

183− | AGt Nat

184− | AGe Nat

185− | ALt Nat

186− | ALe Nat

187 deriving (Generic)

183 deriving (Generic)

188

184

189data DemotedArrayConstraint

185data DemotedArrayConstraint

190 = DAEq Integer

186 = DAEq Integer

191− | DAGt Integer

192− | DAGe Integer

193− | DALt Integer

194− | DALe Integer

195 deriving (Generic, Eq, Show)

187 deriving (Generic, Eq, Show)

196

188

197data instance Sing (ac :: ArrayConstraint) where

189data instance Sing (ac :: ArrayConstraint) where

198 SAEq :: Sing n -> Sing ('AEq n)

190 SAEq :: Sing n -> Sing ('AEq n)

199− SAGt :: Sing n -> Sing ('AGt n)

200− SAGe :: Sing n -> Sing ('AGe n)

201− SALt :: Sing n -> Sing ('ALt n)

202− SALe :: Sing n -> Sing ('ALe n)

203

191

204instance KnownNat n => SingI ('AEq n) where sing = SAEq sing

192instance KnownNat n => SingI ('AEq n) where sing = SAEq sing

205−instance KnownNat n => SingI ('AGt n) where sing = SAGt sing

206−instance KnownNat n => SingI ('AGe n) where sing = SAGe sing

207−instance KnownNat n => SingI ('ALt n) where sing = SALt sing

208−instance KnownNat n => SingI ('ALe n) where sing = SALe sing

209

193

210instance Eq (Sing ('AEq n)) where _ == _ = True

194instance Eq (Sing ('AEq n)) where _ == _ = True

211−instance Eq (Sing ('AGt n)) where _ == _ = True

212−instance Eq (Sing ('AGe n)) where _ == _ = True

213−instance Eq (Sing ('ALt n)) where _ == _ = True

214−instance Eq (Sing ('ALe n)) where _ == _ = True

215

195

216instance SingKind ArrayConstraint where

196instance SingKind ArrayConstraint where

217 type Demote ArrayConstraint = DemotedArrayConstraint

197 type Demote ArrayConstraint = DemotedArrayConstraint

218 fromSing = \case

198 fromSing = \case

219 SAEq n -> withKnownNat n (DAEq . fromIntegral $ natVal n)

199 SAEq n -> withKnownNat n (DAEq . fromIntegral $ natVal n)

220− SAGt n -> withKnownNat n (DAGt . fromIntegral $ natVal n)

221− SAGe n -> withKnownNat n (DAGe . fromIntegral $ natVal n)

222− SALt n -> withKnownNat n (DALt . fromIntegral $ natVal n)

223− SALe n -> withKnownNat n (DALe . fromIntegral $ natVal n)

224 toSing = \case

200 toSing = \case

225 DAEq n -> case someNatVal n of

201 DAEq n -> case someNatVal n of

226 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SAEq (SNat :: Sing n))

202 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SAEq (SNat :: Sing n))

227 Nothing -> error "Negative singleton nat"

203 Nothing -> error "Negative singleton nat"

228− DAGt n -> case someNatVal n of

229− Just (SomeNat (_ :: Proxy n)) -> SomeSing (SAGt (SNat :: Sing n))

230− Nothing -> error "Negative singleton nat"

231− DAGe n -> case someNatVal n of

232− Just (SomeNat (_ :: Proxy n)) -> SomeSing (SAGe (SNat :: Sing n))

233− Nothing -> error "Negative singleton nat"

234− DALt n -> case someNatVal n of

235− Just (SomeNat (_ :: Proxy n)) -> SomeSing (SALt (SNat :: Sing n))

236− Nothing -> error "Negative singleton nat"

237− DALe n -> case someNatVal n of

238− Just (SomeNat (_ :: Proxy n)) -> SomeSing (SALe (SNat :: Sing n))

239− Nothing -> error "Negative singleton nat"

240

204

241data Schema

205data Schema

242 = SchemaText [TextConstraint]

206 = SchemaText [TextConstraint]

src/Data/Schematic/Schema.hs-boot−8

@@ -46,17 +46,9 @@ data DemotedNumberConstraint

46

47data ArrayConstraint

48 = AEq Nat

49− | AGt Nat

50− | AGe Nat

51− | ALt Nat

52− | ALe Nat

53

49

54data DemotedArrayConstraint

50data DemotedArrayConstraint

55 = DAEq Integer

51 = DAEq Integer

56− | DAGt Integer

57− | DAGe Integer

58− | DALt Integer

59− | DALe Integer

60

52

61data Schema

53data Schema

62 = SchemaText [TextConstraint]

54 = SchemaText [TextConstraint]

src/Data/Schematic/Validation.hs+18−80

@@ -3,7 +3,6 @@ module Data.Schematic.Validation where

3import Control.Monad

4import Control.Monad.Validation

5import Data.Aeson

6−import Data.Aeson.Internal

7import Data.Aeson.Types

6import Data.Aeson.Types

8import Data.Foldable

7import Data.Foldable

9import Data.Functor.Identity

8import Data.Functor.Identity

@@ -18,7 +17,6 @@ import Data.Traversable

18import Data.Union

17import Data.Union

19import Data.Vector as V

18import Data.Vector as V

20import Data.Vinyl

19import Data.Vinyl

21−import Data.Vinyl.TypeLevel

22import Prelude as P

20import Prelude as P

23import Text.Regex.TDFA

21import Text.Regex.TDFA

24

22

@@ -39,7 +37,7 @@ instance (TopLevel a, SingI a, FromJSON (JsonRepr a))

39

37

40isValid :: ParseResult a -> Bool

38isValid :: ParseResult a -> Bool

41isValid (Valid _) = True

39isValid (Valid _) = True

42−isValid _ = False

40+isValid _ = False

43

41

44isDecodingError :: ParseResult a -> Bool

42isDecodingError :: ParseResult a -> Bool

45isDecodingError (DecodingError _) = True

43isDecodingError (DecodingError _) = True

@@ -50,11 +48,11 @@ isValidationError (ValidationError _) = True

50isValidationError _ = False

48isValidationError _ = False

51

49

52validateTextConstraint

50validateTextConstraint

53− :: JSONPathText

51+ :: JSONPath

54 -> Text

52 -> Text

55 -> Sing (tcs :: TextConstraint)

53 -> Sing (tcs :: TextConstraint)

56 -> Validation ()

54 -> Validation ()

57−validateTextConstraint (JSONPathText path) t = \case

55+validateTextConstraint (JSONPath path) t = \case

58 STEq n -> do

56 STEq n -> do

59 let

57 let

60 nlen = withKnownNat n $ natVal n

58 nlen = withKnownNat n $ natVal n

@@ -107,11 +105,11 @@ validateTextConstraint (JSONPathText path) t = \case

107 unless (matching ss) warn

105 unless (matching ss) warn

108

106

109validateNumberConstraint

107validateNumberConstraint

110− :: JSONPathText

108+ :: JSONPath

111 -> Scientific

109 -> Scientific

112 -> Sing (tcs :: NumberConstraint)

110 -> Sing (tcs :: NumberConstraint)

113 -> Validation ()

111 -> Validation ()

114−validateNumberConstraint (JSONPathText path) num = \case

112+validateNumberConstraint (JSONPath path) num = \case

115 SNEq n -> do

113 SNEq n -> do

116 let

114 let

117 nlen = withKnownNat n $ natVal n

115 nlen = withKnownNat n $ natVal n

@@ -149,11 +147,11 @@ validateNumberConstraint (JSONPathText path) num = \case

149 unless predicate warn

147 unless predicate warn

150

148

151validateArrayConstraint

149validateArrayConstraint

152− :: JSONPathText

150+ :: JSONPath

153 -> V.Vector a

151 -> V.Vector a

154 -> Sing (tcs :: ArrayConstraint)

152 -> Sing (tcs :: ArrayConstraint)

155 -> Validation ()

153 -> Validation ()

156−validateArrayConstraint (JSONPathText path) v = \case

154+validateArrayConstraint (JSONPath path) v = \case

157 SAEq n -> do

155 SAEq n -> do

158 let

156 let

159 nlen = withKnownNat n $ natVal n

157 nlen = withKnownNat n $ natVal n

@@ -161,38 +159,10 @@ validateArrayConstraint (JSONPathText path) v = \case

161 errMsg = "length should be == " <> T.pack (show nlen)

159 errMsg = "length should be == " <> T.pack (show nlen)

162 warn = vWarning $ mmSingleton path (pure errMsg)

160 warn = vWarning $ mmSingleton path (pure errMsg)

163 unless predicate warn

161 unless predicate warn

164− SAGt n -> do

165− let

166− nlen = withKnownNat n $ natVal n

167− predicate = fromIntegral (V.length v) > nlen

168− errMsg = "length should be > " <> T.pack (show nlen)

169− warn = vWarning $ mmSingleton path (pure errMsg)

170− unless predicate warn

171− SAGe n -> do

172− let

173− nlen = withKnownNat n $ natVal n

174− predicate = fromIntegral (V.length v) >= nlen

175− errMsg = "length should be >= " <> T.pack (show nlen)

176− warn = vWarning $ mmSingleton path (pure errMsg)

177− unless predicate warn

178− SALt n -> do

179− let

180− nlen = withKnownNat n $ natVal n

181− predicate = fromIntegral (V.length v) < nlen

182− errMsg = "length should be < " <> T.pack (show nlen)

183− warn = vWarning $ mmSingleton path (pure errMsg)

184− unless predicate warn

185− SALe n -> do

186− let

187− nlen = withKnownNat n $ natVal n

188− predicate = fromIntegral (V.length v) <= nlen

189− errMsg = "length should be <= " <> T.pack (show nlen)

190− warn = vWarning $ mmSingleton path (pure errMsg)

191− unless predicate warn

192

162

193validateJsonRepr

163validateJsonRepr

194 :: Sing schema

164 :: Sing schema

195− -> JSONPath

165+ -> [DemotedPathSegment]

196 -> JsonRepr schema

166 -> JsonRepr schema

197 -> Validation ()

167 -> Validation ()

198validateJsonRepr sschema dpath jr = case jr of

168validateJsonRepr sschema dpath jr = case jr of

@@ -226,7 +196,7 @@ validateJsonRepr sschema dpath jr = case jr of

226 process cs

196 process cs

227 process acs

197 process acs

228 for_ (V.indexed v) $ \(ix, jr') -> do

198 for_ (V.indexed v) $ \(ix, jr') -> do

229− let newPath = dpath <> pure (Index $ fromIntegral ix)

199+ let newPath = dpath <> pure (DIx $ fromIntegral ix)

230 validateJsonRepr s newPath jr'

200 validateJsonRepr s newPath jr'

231 ReprOptional d -> case sschema of

201 ReprOptional d -> case sschema of

232 SSchemaOptional ss -> case d of

202 SSchemaOptional ss -> case d of

@@ -238,49 +208,17 @@ validateJsonRepr sschema dpath jr = case jr of

238 go :: Rec FieldRepr (ts :: [(Symbol, Schema)] ) -> Validation ()

208 go :: Rec FieldRepr (ts :: [(Symbol, Schema)] ) -> Validation ()

239 go RNil = pure ()

209 go RNil = pure ()

240 go (f@(FieldRepr d) :& ftl) = do

210 go (f@(FieldRepr d) :& ftl) = do

241− let newPath = dpath <> [Key (knownFieldName f)]

211+ let newPath = dpath <> [DKey (knownFieldName f)]

242 validateJsonRepr (knownFieldSchema f) newPath d

212 validateJsonRepr (knownFieldSchema f) newPath d

243 go ftl

213 go ftl

244− ReprUnion _ -> pure () -- FIXME

245− -- case sschema of

214+ ReprUnion ru -> case sschema of

246− -- SSchemaUnion ss -> case ss of

215+ SSchemaUnion su -> validateUnion su ru

247− -- SCons s stl -> case umatch' s u of

216+ where

248− -- Nothing -> case urestrict u of

217+ validateUnion :: Sing us -> Union JsonRepr us -> Validation ()

249− -- Nothing ->

218+ validateUnion ss r = case (ss,r) of

250− -- fail "impossible to produce subUnion, please report this as a bug"

219+ (SCons s _, This v) -> validateJsonRepr s dpath v

251− -- Just x -> do

220+ (SCons _ stl, That r') -> validateUnion stl r'

252− -- let

221+ (SNil,_) -> fail "Invalid union. Please report this as a bug"

253− -- JSONPathText path = demotedPathToText dpath

254− -- case stl of

255− -- SNil -> void $ vWarning $ mmSingleton path

256− -- $ pure "union handling error, please report this as bug"

257− -- SCons s' stl' ->

258− -- validateJsonRepr (SSchemaUnion (SCons s' stl')) dpath

259− -- $ toUnion (SCons s' stl') x

260− -- Just x -> validateJsonRepr s dpath x

261−

262−-- subUnion

263−-- :: Sing (s ': stl)

264−-- -> ( USubset stl (s ': stl) (RImage stl (s ': stl))

265−-- => Union f (s ': stl)

266−-- -> Maybe (Union f stl) )

267−-- subUnion (SCons s stl) = urestrict

268−

269−-- withUSubset

270−-- :: Sing (s ': stl)

271−-- -> (USubset stl (s ': stl) (RImage stl (s ': stl)) => Maybe (Union f stl))

272−-- -> Maybe (Union f stl)

273−-- withUSubset (SCons s stl) r = r

274−

275−toUnion

276− :: USubset s' (s ': ss) (RImage s' (s ': ss))

277− => Sing (s ': ss)

278− -> Union JsonRepr s'

279− -> JsonRepr ('SchemaUnion (s ': ss))

280−toUnion _ = ReprUnion . urelax

281−

282−umatch' :: UElem a as i => Sing a -> Union f as -> Maybe (f a)

283−umatch' _ u = umatch u

284

222

285parseAndValidateJson

223parseAndValidateJson

286 :: forall schema

224 :: forall schema

stack-13.21.yamldeleted−7

@@ -1,7 +0,0 @@

1−resolver: lts-13.21

2−extra-deps:

3− - hjsonpointer-1.4.0@rev:0

4− - hjsonschema-1.9.0@rev:0

5− - validationt-0.3.0

6−nix:

7− packages: [pcre, pkg-config, zlib]

stack-13.7.yamlnew file+5

@@ -0,0 +1,5 @@

1+resolver: lts-13.7

2+extra-deps:

3+ - hjsonpointer-1.4.0@rev:0

4+ - hjsonschema-1.9.0@rev:0

5+ - validationt-0.2.1.0

stack.yaml+4−5

@@ -1,6 +1,5 @@

1−resolver: lts-14.22

1+resolver: lts-12.0

2extra-deps:

3−- hjsonpointer-1.4.0@rev:0

3+ - hjsonpointer-1.4.0@rev:0

4−- hjsonschema-1.9.0@rev:0

4+ - hjsonschema-1.9.0@rev:0

5−- git: https://github.com/typeable/validationt.git

5+ - validationt-0.2.1.0

6− commit: 97fea97c4015ab5e99f3efb2c73e1fef4b8857d8

test/HelpersSpec.hs+4−4

@@ -1,17 +1,17 @@

1{-# OPTIONS_GHC -Wno-unticked-promoted-constructors #-}

2

3−{-# LANGUAGE LambdaCase #-}

3+{-# LANGUAGE LambdaCase #-}

4

5−{-# LANGUAGE DataKinds #-}

5+{-# LANGUAGE DataKinds #-}

6−{-# LANGUAGE TypeApplications #-}

7{-# LANGUAGE OverloadedStrings #-}

6{-# LANGUAGE OverloadedStrings #-}

7+{-# LANGUAGE TypeApplications #-}

8

9module HelpersSpec (spec, main) where

10

11import Control.Lens

12import Data.ByteString.Lazy.Lens

13import Data.Foldable

14−import Data.Monoid

14+import Data.Monoid ((<>))

15import Data.Schematic

16import Data.Text as T

17import Data.Text.Lens

test/JsonSchemaSpec.hs−58

@@ -10,7 +10,6 @@ module JsonSchemaSpec (spec, main) where

10import Data.Aeson as J

11import Data.Maybe

12import Data.Proxy

13−import Data.ByteString.Lazy as B

14import Data.Schematic

13import Data.Schematic

15import Data.Vinyl

14import Data.Vinyl

16import JSONSchema.Draft4 as D4

15import JSONSchema.Draft4 as D4

@@ -32,27 +31,6 @@ exampleData = withRepr @SchemaExample $

32 :& field @"bar" (pure (ReprText "foo"))

31 :& field @"bar" (pure (ReprText "foo"))

33 :& RNil

32 :& RNil

34

33

35−type SchemaArrayExample = 'SchemaObject

36− '[ '("a1", 'SchemaArray '[ 'AGt 1 ] ('SchemaNumber '[]))

37− , '("a2", 'SchemaArray '[ 'AGe 1 ] ('SchemaNumber '[]))

38− , '("a3", 'SchemaArray '[ 'ALt 1 ] ('SchemaNumber '[]))

39− , '("a4", 'SchemaArray '[ 'ALe 1 ] ('SchemaNumber '[]))

40− ]

41−

42−type SchemaNumberExample = 'SchemaObject

43− '[ '("n1", 'SchemaNumber '[ 'NGt 1 ])

44− , '("n2", 'SchemaNumber '[ 'NGe 1 ])

45− , '("n3", 'SchemaNumber '[ 'NLt 1 ])

46− , '("n4", 'SchemaNumber '[ 'NLe 1 ])

47− ]

48−

49−type SchemaTextExample = 'SchemaObject

50− '[ '("t1", 'SchemaText '[ 'TGt 1 ])

51− , '("t2", 'SchemaText '[ 'TGe 1 ])

52− , '("t3", 'SchemaText '[ 'TLt 1 ])

53− , '("t4", 'SchemaText '[ 'TLe 1 ])

54− ]

55−

56spec :: Spec

34spec :: Spec

57spec = do

35spec = do

58 it "validates simple schema" $ do

36 it "validates simple schema" $ do

@@ -60,42 +38,6 @@ spec = do

60 fetchHTTPAndValidate schema (toJSON exampleData) >>= \case

38 fetchHTTPAndValidate schema (toJSON exampleData) >>= \case

61 Left _ -> fail "failed to validate test example"

39 Left _ -> fail "failed to validate test example"

62 Right _ -> pure ()

40 Right _ -> pure ()

63− it "validates schema with arrays" $ do

64− let

65− schema = D4.SchemaWithURI (fromJust $ toJsonSchema (Proxy @SchemaArrayExample)) Nothing

66− obj = withRepr @SchemaArrayExample $

67− field @"a1" [ReprNumber 13, ReprNumber 13]

68− :& field @"a2" [ReprNumber 13]

69− :& field @"a3" []

70− :& field @"a4" [ReprNumber 13]

71− :& RNil

72− fetchHTTPAndValidate schema (toJSON obj) >>= \case

73− Left e -> fail "failed to validate test example"

74− Right _ -> pure ()

75− it "validates schema with numbers" $ do

76− let

77− schema = D4.SchemaWithURI (fromJust $ toJsonSchema (Proxy @SchemaNumberExample)) Nothing

78− obj = withRepr @SchemaNumberExample $

79− field @"n1" 1.1

80− :& field @"n2" 1

81− :& field @"n3" 0.9

82− :& field @"n4" 1.0

83− :& RNil

84− fetchHTTPAndValidate schema (toJSON obj) >>= \case

85− Left e -> fail "failed to validate test example"

86− Right _ -> pure ()

87− it "validates schema with strings" $ do

88− let

89− schema = D4.SchemaWithURI (fromJust $ toJsonSchema (Proxy @SchemaTextExample)) Nothing

90− obj = withRepr @SchemaTextExample $

91− field @"t1" "11"

92− :& field @"t2" "1"

93− :& field @"t3" ""

94− :& field @"t4" "1"

95− :& RNil

96− fetchHTTPAndValidate schema (toJSON obj) >>= \case

97− Left e -> fail "failed to validate test example"

98− Right _ -> pure ()

99

41

100main :: IO ()

42main :: IO ()

101main = hspec spec

43main = hspec spec

test/LensSpec.hs+3−5

@@ -1,12 +1,11 @@

1−{-# LANGUAGE DataKinds #-}

1+{-# LANGUAGE DataKinds #-}

2−{-# LANGUAGE TypeApplications #-}

3−{-# LANGUAGE OverloadedLists #-}

2+{-# LANGUAGE OverloadedLists #-}

4{-# LANGUAGE OverloadedStrings #-}

3{-# LANGUAGE OverloadedStrings #-}

4+{-# LANGUAGE TypeApplications #-}

5

6module LensSpec (spec, main) where

7

8import Control.Lens

9−import Data.Proxy

10import Data.Schematic

9import Data.Schematic

11import Data.Vinyl

10import Data.Vinyl

12import Test.Hspec

11import Test.Hspec

@@ -301,7 +300,6 @@ spec :: Spec

301spec = do

300spec = do

302 let

301 let

303 newFooVal = FieldRepr $ ReprArray [ReprNumber 15]

302 newFooVal = FieldRepr $ ReprArray [ReprNumber 15]

304− fooProxy = Proxy @"foo"

305 it "gets the field from an object" $ do

303 it "gets the field from an object" $ do

306 fget @"foo" objectData `shouldBe` arrayField

304 fget @"foo" objectData `shouldBe` arrayField

307 it "sets the object field" $ do

305 it "sets the object field" $ do

test/SchemaSpec.hs+23−15

@@ -1,33 +1,28 @@

1+{-# OPTIONS_GHC -fno-warn-unused-top-binds #-}

1{-# OPTIONS_GHC -fprint-potential-instances #-}

2{-# OPTIONS_GHC -fprint-potential-instances #-}

2

3

3−{-# LANGUAGE DataKinds #-}

4+{-# LANGUAGE DataKinds #-}

4−{-# LANGUAGE FlexibleContexts #-}

5+{-# LANGUAGE FlexibleContexts #-}

5−{-# LANGUAGE GADTs #-}

6+{-# LANGUAGE GADTs #-}

6−{-# LANGUAGE OverloadedLists #-}

7+{-# LANGUAGE OverloadedLists #-}

7−{-# LANGUAGE OverloadedStrings #-}

8+{-# LANGUAGE OverloadedStrings #-}

8−{-# LANGUAGE RankNTypes #-}

9+{-# LANGUAGE RankNTypes #-}

9{-# LANGUAGE ScopedTypeVariables #-}

10{-# LANGUAGE ScopedTypeVariables #-}

10−{-# LANGUAGE TypeApplications #-}

11+{-# LANGUAGE TypeApplications #-}

11

12

12module SchemaSpec (spec, main) where

13module SchemaSpec (spec, main) where

13

14

14import Control.Lens

15import Control.Lens

15import Data.Aeson

16import Data.Aeson

16import Data.ByteString.Lazy

17import Data.ByteString.Lazy

17−import Data.Functor.Identity

18import Data.Proxy

19import Data.Schematic

20−import Data.Schematic.Generator

21−import Data.Singletons

22−import Data.Tagged

23import Data.Vinyl

20import Data.Vinyl

24import Test.Hspec

21import Test.Hspec

25import Test.Hspec.SmallCheck

22import Test.Hspec.SmallCheck

26import Test.SmallCheck as SC

23import Test.SmallCheck as SC

27−import Test.SmallCheck.Drivers as SC

28import Test.SmallCheck.Series as SC

24import Test.SmallCheck.Series as SC

29

25

30−import Debug.Trace

31

26

32type SchemaExample = 'SchemaObject

27type SchemaExample = 'SchemaObject

33 '[ '("foo", 'SchemaArray '[ 'AEq 1] ('SchemaNumber '[ 'NGt 10]))

28 '[ '("foo", 'SchemaArray '[ 'AEq 1] ('SchemaNumber '[ 'NGt 10]))

@@ -37,6 +32,13 @@ type SchemaExample2 = 'SchemaObject

37 '[ '("foo", 'SchemaArray '[ 'AEq 2] ('SchemaText '[ 'TGt 10]))

32 '[ '("foo", 'SchemaArray '[ 'AEq 2] ('SchemaText '[ 'TGt 10]))

38 , '("bar", 'SchemaOptional ('SchemaText '[ 'TRegex "[0-9]+"]))]

33 , '("bar", 'SchemaOptional ('SchemaText '[ 'TRegex "[0-9]+"]))]

39

34

35+type SchemaExample3 = 'SchemaUnion '[SchemaExample]

36+

37+type SchemaExample4 = 'SchemaObject

38+ '[ '("baz3", SchemaExample3)

39+ , '("baz1", SchemaExample)]

40+

41+

40jsonExample :: JsonRepr SchemaExample

42jsonExample :: JsonRepr SchemaExample

41jsonExample = withRepr @SchemaExample

43jsonExample = withRepr @SchemaExample

42 $ field @"bar" (Just "bar")

44 $ field @"bar" (Just "bar")

@@ -45,7 +47,7 @@ jsonExample = withRepr @SchemaExample

45

47

46type AddQuuz =

48type AddQuuz =

47 'Migration "add_field_quuz"

49 'Migration "add_field_quuz"

48− '[ 'Diff '[] ('AddKey "quuz" (SchemaNumber '[])) ]

50+ '[ 'Diff '[] ('AddKey "quuz" ('SchemaNumber '[])) ]

49

51

50type DeleteQuuz =

52type DeleteQuuz =

51 'Migration "remove_field_quuz"

53 'Migration "remove_field_quuz"

@@ -80,6 +82,12 @@ schemaJson = "{\"foo\": [13], \"bar\": null}"

80schemaJson2 :: ByteString

82schemaJson2 :: ByteString

81schemaJson2 = "{\"foo\": [3], \"bar\": null}"

83schemaJson2 = "{\"foo\": [3], \"bar\": null}"

82

84

85+schemaJson3 :: ByteString

86+schemaJson3 = schemaJson

87+

88+schemaJson4 :: ByteString

89+schemaJson4 = "{\"baz1\": "<>schemaJson<>", \"baz3\": "<>schemaJson3<>"}"

90+

83schemaJsonSeries :: Monad m => SC.Series m (JsonRepr SchemaExample)

91schemaJsonSeries :: Monad m => SC.Series m (JsonRepr SchemaExample)

84schemaJsonSeries = series

92schemaJsonSeries = series

85

93

@@ -93,7 +101,7 @@ spec = do

93 it "decode/encode JsonRepr properly" $

101 it "decode/encode JsonRepr properly" $

94 decode (encode jsonExample) == Just jsonExample

102 decode (encode jsonExample) == Just jsonExample

95 it "validates correct representation" $

103 it "validates correct representation" $

96− ((decodeAndValidateJson schemaJson) :: ParseResult (JsonRepr SchemaExample))

104+ ((decodeAndValidateJson schemaJson4) :: ParseResult (JsonRepr SchemaExample4))

97 `shouldSatisfy` isValid

105 `shouldSatisfy` isValid

98 it "returns decoding error on structurally incorrect input" $

106 it "returns decoding error on structurally incorrect input" $

99 ((decodeAndValidateJson "{}") :: ParseResult (JsonRepr SchemaExample))

107 ((decodeAndValidateJson "{}") :: ParseResult (JsonRepr SchemaExample))