master..ef8ab4d · typeable/schematic

git.iko.soy/typeable/schematic

11 files changed+52−210

unifiedsplit

ChangeLog.md−11 schematic.cabal+4−8 src/Data/Schematic/JsonSchema.hs+9−21 src/Data/Schematic/Path.hs+20−17 src/Data/Schematic/Schema.hs−36 src/Data/Schematic/Schema.hs-boot−8 src/Data/Schematic/Validation.hs+10−39 stack-13.21.yaml−7 stack-13.7.yaml+5 stack.yaml+4−5 test/JsonSchemaSpec.hs−58

ChangeLog.md−11

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

11# Revision history for schematic

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−

143## 0.5.0.0 -- 2019-02-20

154

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

schematic.cabal+4−8

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

11name: schematic

2−version: 0.6.0.0

2+version: 0.5.0.0

33synopsis: JSON-biased spec and validation tool

44description: 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.

55license: BSD3

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

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

1111category: Data

1212build-type: Simple

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

13+extra-source-files: ChangeLog.md

1414cabal-version: >=1.10

1515

1616library

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

6565 , TypeOperators

6666 , TypeSynonymInstances

6767 , UndecidableInstances

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

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

6969 , bytestring

70− , aeson >= 1.4.3.0 && < 1.6

70+ , aeson >= 1

7171 , containers

7272 , hjsonschema

7373 , mtl

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

118118 , HelpersSpec

119119 , LensSpec

120120 , 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 ()

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

3131 { _schemaMinLength = pure $ fromIntegral n

3232 , _schemaMaxLength = pure $ fromIntegral n }

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

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

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

3436 { _schemaMaxLength = pure . fromIntegral $ n }

35−textConstraint (DTLt n) =

37+textConstraint (DTGt n) =

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

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

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

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

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

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

4141 { _schemaMinLength = pure . fromIntegral $ n }

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

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

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

4949 { _schemaMaximum = pure . fromIntegral $ n }

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

51− { _schemaMaximum = pure . fromIntegral $ n

52− , _schemaExclusiveMaximum = pure True }

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

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

54− { _schemaMinimum = pure . fromIntegral $ n

55− , _schemaExclusiveMinimum = pure True }

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

5753 { _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' }

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

5958 { _schemaMinimum = pure $ fromIntegral n

6059 , _schemaMaximum = pure $ fromIntegral n }

6160

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

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

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 }

62+arrayConstraint (DAEq _) = pure ()

7563

7664toJsonSchema

7765 :: forall proxy schema

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

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

44import Data.Singletons.Prelude

55import Data.Singletons.TypeLits

66import Data.Text as T

7−import Data.Aeson.Internal

10−newtype JSONPathText = JSONPathText Text

11− deriving (Show)

12−

13−data PathSegment = PathKey Symbol | PathIx Nat

9+data PathSegment = Key Symbol | Ix Nat

1410

1511data instance Sing (jp :: PathSegment) where

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

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

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

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)

1821

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

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

2023demotePath = go []

2124 where

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

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

2326 go acc SNil = acc

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

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

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

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

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

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

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

2831

29−demotedPathToText :: JSONPath -> JSONPathText

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

32+demotedPathToText :: [DemotedPathSegment] -> JSONPath

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

3134 where

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

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

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

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

3437

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

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

3639pathToText = demotedPathToText . demotePath

src/Data/Schematic/Schema.hs−36

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

180180

181181data ArrayConstraint

182182 = AEq Nat

183− | AGt Nat

184− | AGe Nat

185− | ALt Nat

186− | ALe Nat

187183 deriving (Generic)

188184

189185data DemotedArrayConstraint

190186 = DAEq Integer

191− | DAGt Integer

192− | DAGe Integer

193− | DALt Integer

194− | DALe Integer

195187 deriving (Generic, Eq, Show)

196188

197189data instance Sing (ac :: ArrayConstraint) where

198190 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)

203191

204192instance 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

209193

210194instance 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

215195

216196instance SingKind ArrayConstraint where

217197 type Demote ArrayConstraint = DemotedArrayConstraint

218198 fromSing = \case

219199 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)

224200 toSing = \case

225201 DAEq n -> case someNatVal n of

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

227203 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"

240204

241205data Schema

242206 = SchemaText [TextConstraint]

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

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

4646

4747data ArrayConstraint

4848 = AEq Nat

49− | AGt Nat

50− | AGe Nat

51− | ALt Nat

52− | ALe Nat

5349

5450data DemotedArrayConstraint

5551 = DAEq Integer

56− | DAGt Integer

57− | DAGe Integer

58− | DALt Integer

59− | DALe Integer

6052

6153data Schema

6254 = SchemaText [TextConstraint]

src/Data/Schematic/Validation.hs+10−39

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

33import Control.Monad

44import Control.Monad.Validation

55import Data.Aeson

6−import Data.Aeson.Internal

76import Data.Aeson.Types

87import Data.Foldable

98import Data.Functor.Identity

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

5049isValidationError _ = False

5150

5251validateTextConstraint

53− :: JSONPathText

52+ :: JSONPath

5453 -> Text

5554 -> Sing (tcs :: TextConstraint)

5655 -> Validation ()

57−validateTextConstraint (JSONPathText path) t = \case

56+validateTextConstraint (JSONPath path) t = \case

5857 STEq n -> do

5958 let

6059 nlen = withKnownNat n $ natVal n

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

107106 unless (matching ss) warn

108107

109108validateNumberConstraint

110− :: JSONPathText

109+ :: JSONPath

111110 -> Scientific

112111 -> Sing (tcs :: NumberConstraint)

113112 -> Validation ()

114−validateNumberConstraint (JSONPathText path) num = \case

113+validateNumberConstraint (JSONPath path) num = \case

115114 SNEq n -> do

116115 let

117116 nlen = withKnownNat n $ natVal n

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

149148 unless predicate warn

150149

151150validateArrayConstraint

152− :: JSONPathText

151+ :: JSONPath

153152 -> V.Vector a

154153 -> Sing (tcs :: ArrayConstraint)

155154 -> Validation ()

156−validateArrayConstraint (JSONPathText path) v = \case

155+validateArrayConstraint (JSONPath path) v = \case

157156 SAEq n -> do

158157 let

159158 nlen = withKnownNat n $ natVal n

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

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

162161 warn = vWarning $ mmSingleton path (pure errMsg)

163162 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

192163

193164validateJsonRepr

194165 :: Sing schema

195− -> JSONPath

166+ -> [DemotedPathSegment]

196167 -> JsonRepr schema

197168 -> Validation ()

198169validateJsonRepr sschema dpath jr = case jr of

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

226197 process cs

227198 process acs

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

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

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

230201 validateJsonRepr s newPath jr'

231202 ReprOptional d -> case sschema of

232203 SSchemaOptional ss -> case d of

@@ -238,7 +209,7 @@ validateJsonRepr sschema dpath jr = case jr of

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

239210 go RNil = pure ()

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

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

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

242213 validateJsonRepr (knownFieldSchema f) newPath d

243214 go ftl

244215 ReprUnion _ -> pure () -- FIXME

@@ -250,7 +221,7 @@ validateJsonRepr sschema dpath jr = case jr of

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

251222 -- Just x -> do

252223 -- let

253− -- JSONPathText path = demotedPathToText dpath

224+ -- JSONPath path = demotedPathToText dpath

254225 -- case stl of

255226 -- SNil -> void $ vWarning $ mmSingleton path

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

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

22extra-deps:

3−- hjsonpointer-1.4.0@rev:0

4−- hjsonschema-1.9.0@rev:0

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

6− commit: 97fea97c4015ab5e99f3efb2c73e1fef4b8857d8

3+ - hjsonpointer-1.4.0@rev:0

4+ - hjsonschema-1.9.0@rev:0

5+ - validationt-0.2.1.0

test/JsonSchemaSpec.hs−58

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

1010import Data.Aeson as J

1111import Data.Maybe

1212import Data.Proxy

13−import Data.ByteString.Lazy as B

1413import Data.Schematic

1514import Data.Vinyl

1615import JSONSchema.Draft4 as D4

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

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

3332 :& RNil

3433

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−

5634spec :: Spec

5735spec = do

5836 it "validates simple schema" $ do

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

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

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

6240 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 ()

9941

10042main :: IO ()

10143main = hspec spec