0a19087...master · typeable/schematic

git.iko.soy/typeable/schematic

11 files changed+210−52

since splitsnapshots

unifiedsplit

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

ChangeLog.md+11

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

11# Revision history for schematic

3+## 0.6.0.0 -- 2021-01-15

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`.

7+## 0.5.1.0 -- 2021-01-15

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+

314## 0.5.0.0 -- 2019-02-20

415

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

schematic.cabal+8−4

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

11name: schematic

2−version: 0.5.0.0

2+version: 0.6.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

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

1414cabal-version: >=1.10

1515

1616library

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

6565 , TypeOperators

6666 , TypeSynonymInstances

6767 , UndecidableInstances

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

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

6969 , bytestring

70− , aeson >= 1

70+ , aeson >= 1.4.3.0 && < 1.6

7171 , containers

7272 , hjsonschema

7373 , mtl

@@ -118,3 +118,7 @@ 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+21−9

@@ -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 }

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

3634 { _schemaMaxLength = pure . fromIntegral $ n }

37−textConstraint (DTGt n) =

35+textConstraint (DTLt n) =

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

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

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

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

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

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

4141 { _schemaMinLength = pure . fromIntegral $ n }

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

@@ -48,18 +48,30 @@ 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 + 1 }

51+ { _schemaMaximum = pure . fromIntegral $ n

52+ , _schemaExclusiveMaximum = pure True }

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

54+ { _schemaMinimum = pure . fromIntegral $ n

55+ , _schemaExclusiveMinimum = pure True }

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

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

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

5859 { _schemaMinimum = pure $ fromIntegral n

5960 , _schemaMaximum = pure $ fromIntegral n }

6061

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

62−arrayConstraint (DAEq _) = pure ()

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 }

6375

6476toJsonSchema

6577 :: forall proxy schema

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

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

44import Data.Singletons.Prelude

55import Data.Singletons.TypeLits

66import Data.Text as T

7+import Data.Aeson.Internal

9−data PathSegment = Key Symbol | Ix Nat

10−

11−data instance Sing (jp :: PathSegment) where

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

10+newtype JSONPathText = JSONPathText Text

1611 deriving (Show)

1712

18−-- | Textual representation of json path.

19−newtype JSONPath = JSONPath Text

20− deriving (Show)

13+data PathSegment = PathKey Symbol | PathIx Nat

14+

15+data 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)

2118

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

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

2320demotePath = go []

2421 where

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

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

2623 go acc SNil = acc

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

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

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

3128

32−demotedPathToText :: [DemotedPathSegment] -> JSONPath

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

29+demotedPathToText :: JSONPath -> JSONPathText

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

3431 where

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

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

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

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

3734

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

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

3936pathToText = demotedPathToText . demotePath

src/Data/Schematic/Schema.hs+36

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

180180

181181data ArrayConstraint

182182 = AEq Nat

183+ | AGt Nat

184+ | AGe Nat

185+ | ALt Nat

186+ | ALe Nat

183187 deriving (Generic)

184188

185189data DemotedArrayConstraint

186190 = DAEq Integer

191+ | DAGt Integer

192+ | DAGe Integer

193+ | DALt Integer

194+ | DALe Integer

187195 deriving (Generic, Eq, Show)

188196

189197data instance Sing (ac :: ArrayConstraint) where

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

191203

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

193209

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

195215

196216instance SingKind ArrayConstraint where

197217 type Demote ArrayConstraint = DemotedArrayConstraint

198218 fromSing = \case

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

200224 toSing = \case

201225 DAEq n -> case someNatVal n of

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

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

204240

205241data Schema

206242 = SchemaText [TextConstraint]

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

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

4646

4747data ArrayConstraint

4848 = AEq Nat

49+ | AGt Nat

50+ | AGe Nat

51+ | ALt Nat

52+ | ALe Nat

4953

5054data DemotedArrayConstraint

5155 = DAEq Integer

56+ | DAGt Integer

57+ | DAGe Integer

58+ | DALt Integer

59+ | DALe Integer

5260

5361data Schema

5462 = SchemaText [TextConstraint]

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

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

33import Control.Monad

44import Control.Monad.Validation

55import Data.Aeson

6+import Data.Aeson.Internal

67import Data.Aeson.Types

78import Data.Foldable

89import Data.Functor.Identity

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

4950isValidationError _ = False

5051

5152validateTextConstraint

52− :: JSONPath

53+ :: JSONPathText

5354 -> Text

5455 -> Sing (tcs :: TextConstraint)

5556 -> Validation ()

56−validateTextConstraint (JSONPath path) t = \case

57+validateTextConstraint (JSONPathText path) t = \case

5758 STEq n -> do

5859 let

5960 nlen = withKnownNat n $ natVal n

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

106107 unless (matching ss) warn

107108

108109validateNumberConstraint

109− :: JSONPath

110+ :: JSONPathText

110111 -> Scientific

111112 -> Sing (tcs :: NumberConstraint)

112113 -> Validation ()

113−validateNumberConstraint (JSONPath path) num = \case

114+validateNumberConstraint (JSONPathText path) num = \case

114115 SNEq n -> do

115116 let

116117 nlen = withKnownNat n $ natVal n

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

148149 unless predicate warn

149150

150151validateArrayConstraint

151− :: JSONPath

152+ :: JSONPathText

152153 -> V.Vector a

153154 -> Sing (tcs :: ArrayConstraint)

154155 -> Validation ()

155−validateArrayConstraint (JSONPath path) v = \case

156+validateArrayConstraint (JSONPathText path) v = \case

156157 SAEq n -> do

157158 let

158159 nlen = withKnownNat n $ natVal n

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

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

161162 warn = vWarning $ mmSingleton path (pure errMsg)

162163 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

163192

164193validateJsonRepr

165194 :: Sing schema

166− -> [DemotedPathSegment]

195+ -> JSONPath

167196 -> JsonRepr schema

168197 -> Validation ()

169198validateJsonRepr sschema dpath jr = case jr of

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

197226 process cs

198227 process acs

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

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

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

201230 validateJsonRepr s newPath jr'

202231 ReprOptional d -> case sschema of

203232 SSchemaOptional ss -> case d of

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

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

210239 go RNil = pure ()

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

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

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

213242 validateJsonRepr (knownFieldSchema f) newPath d

214243 go ftl

215244 ReprUnion _ -> pure () -- FIXME

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

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

222251 -- Just x -> do

223252 -- let

224− -- JSONPath path = demotedPathToText dpath

253+ -- JSONPathText path = demotedPathToText dpath

225254 -- case stl of

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

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

stack-13.21.yamlnew file+7

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

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.yamldeleted−5

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

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+5−4

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

1−resolver: lts-12.0

1+resolver: lts-14.22

22extra-deps:

3− - hjsonpointer-1.4.0@rev:0

4− - hjsonschema-1.9.0@rev:0

5− - validationt-0.2.1.0

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

test/JsonSchemaSpec.hs+58

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

1010import Data.Aeson as J

1111import Data.Maybe

1212import Data.Proxy

13+import Data.ByteString.Lazy as B

1314import Data.Schematic

1415import Data.Vinyl

1516import JSONSchema.Draft4 as D4

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

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

3233 :& RNil

3334

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+

3456spec :: Spec

3557spec = do

3658 it "validates simple schema" $ do

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

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

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

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

4199

42100main :: IO ()

43101main = hspec spec