446a306..master · typeable/schematic

git.iko.soy/typeable/schematic

ChangeLog.md+11

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

1# 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+

3## 0.5.0.0 -- 2019-02-20

14## 0.5.0.0 -- 2019-02-20

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

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

schematic.cabal+9−5

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

1name: schematic

2−version: 0.5.0.0

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

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

14cabal-version: >=1.10

16library

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

65 , TypeOperators

66 , TypeSynonymInstances

67 , UndecidableInstances

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

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

69 , bytestring

70− , aeson >= 1

70+ , aeson >= 1.4.3.0 && < 1.6

71 , containers

72 , hjsonschema

73 , mtl

@@ -95,7 +95,7 @@ test-suite spec

95 default-language: Haskell2010

96 build-depends: HUnit

97 , aeson >= 1

98− , base >=4.11 && <4.12

98+ , base >=4.11 && <4.13

99 , bytestring

100 , containers

101 , hjsonschema

@@ -118,3 +118,7 @@ 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/DSL.hs+11−2

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

1{-# LANGUAGE AllowAmbiguousTypes #-}

2+{-# LANGUAGE CPP #-}

3module Data.Schematic.DSL where

4module Data.Schematic.DSL where

@@ -17,11 +18,19 @@ import Data.Vinyl

17import Data.Vinyl.Functor

18import Data.Vinyl.Functor

21+#if MIN_VERSION_base(4,12,0)

20type Constructor a

22type Constructor a

23+ = forall fields b

21− = forall fields b. (fields ~ FieldsOf a, FSubset fields b (FImage fields b))

24+ . (fields ~ FieldsOf a, FSubset fields b (FImage fields b), RMap fields)

22 => Rec (Tagged fields :. FieldRepr) b

25 => Rec (Tagged fields :. FieldRepr) b

23 -> JsonRepr ('SchemaObject fields)

26 -> JsonRepr ('SchemaObject fields)

24−

27+#else

28+type Constructor a

29+ = forall fields b

30+ . (fields ~ FieldsOf a, FSubset fields b (FImage fields b))

31+ => Rec (Tagged fields :. FieldRepr) b

32+ -> JsonRepr ('SchemaObject fields)

33+#endif

25withRepr :: Constructor a

34withRepr :: Constructor a

26withRepr = ReprObject . rmap (unTagged . getCompose) . fcast

35withRepr = ReprObject . rmap (unTagged . getCompose) . fcast

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

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

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

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

36 { _schemaMaxLength = pure . fromIntegral $ n }

34 { _schemaMaxLength = pure . fromIntegral $ n }

37−textConstraint (DTGt n) =

35+textConstraint (DTLt n) =

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

36 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− in modify $ \s -> s { _schemaMinLength = pure . fromIntegral $ n' }

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

51+ { _schemaMaximum = pure . fromIntegral $ n

52+ , _schemaExclusiveMaximum = pure True }

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

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

54+ { _schemaMinimum = pure . fromIntegral $ n

55+ , _schemaExclusiveMinimum = pure True }

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

53 { _schemaMinimum = pure . fromIntegral $ n }

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

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

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

58 { _schemaMinimum = pure $ fromIntegral n

59 { _schemaMinimum = pure $ fromIntegral n

59 , _schemaMaximum = pure $ fromIntegral n }

60 , _schemaMaximum = pure $ fromIntegral n }

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

62arrayConstraint :: 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 }

64toJsonSchema

76toJsonSchema

65 :: forall proxy schema

77 :: forall proxy schema

src/Data/Schematic/Migration.hs+10−2

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

1{-# LANGUAGE AllowAmbiguousTypes #-}

2+{-# LANGUAGE CPP #-}

2−{-# LANGUAGE TemplateHaskell #-}

3+{-# LANGUAGE TemplateHaskell #-}

4module Data.Schematic.Migration where

5module Data.Schematic.Migration where

@@ -8,7 +9,7 @@ import Data.Schematic.DSL

8import Data.Schematic.Lens

9import Data.Schematic.Lens

9import Data.Schematic.Path

10import Data.Schematic.Path

10import Data.Schematic.Schema

11import Data.Schematic.Schema

11−import Data.Singletons.Prelude hiding (All, (:.))

12+import Data.Singletons.Prelude hiding ((:.), All)

12import Data.Singletons.TypeLits

13import Data.Singletons.TypeLits

13import Data.Tagged

14import Data.Tagged

14import Data.Vinyl

15import Data.Vinyl

@@ -156,10 +157,17 @@ data MList :: (Type -> Type) -> [Schema] -> Type where

156

157

157infixr 7 :&&

158infixr 7 :&&

158

159

160+#if MIN_VERSION_base(4,12,0)

161+migrateObject

162+ :: forall m fs fh. (FSubset fs fs (FImage fs fs), Monad m, RMap fh, RMap fs)

163+ => (Rec (Tagged fs :. FieldRepr) fh -> m (Rec (Tagged fs :. FieldRepr) fs))

164+ -> Tagged ('SchemaObject fs) (JsonRepr ('SchemaObject fh) -> m (JsonRepr ('SchemaObject fs)))

165+#else

159migrateObject

166migrateObject

160 :: forall m fs fh. (FSubset fs fs (FImage fs fs), Monad m)

167 :: forall m fs fh. (FSubset fs fs (FImage fs fs), Monad m)

161 => (Rec (Tagged fs :. FieldRepr) fh -> m (Rec (Tagged fs :. FieldRepr) fs))

168 => (Rec (Tagged fs :. FieldRepr) fh -> m (Rec (Tagged fs :. FieldRepr) fs))

162 -> Tagged ('SchemaObject fs) (JsonRepr ('SchemaObject fh) -> m (JsonRepr ('SchemaObject fs)))

169 -> Tagged ('SchemaObject fs) (JsonRepr ('SchemaObject fh) -> m (JsonRepr ('SchemaObject fs)))

170+#endif

163migrateObject f = Tagged $ \(ReprObject r) -> do

171migrateObject f = Tagged $ \(ReprObject r) -> do

164 res <- f $ rmap (Compose . Tagged) r

172 res <- f $ rmap (Compose . Tagged) r

165 pure $ withRepr @('SchemaObject fs) res

173 pure $ withRepr @('SchemaObject fs) res

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

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

4import Data.Singletons.Prelude

5import Data.Singletons.TypeLits

6import Data.Text as T

7+import Data.Aeson.Internal

9−data PathSegment = Key Symbol | Ix Nat

10+newtype JSONPathText = JSONPathText Text

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

16 deriving (Show)

11 deriving (Show)

18−-- | Textual representation of json path.

13+data PathSegment = PathKey Symbol | PathIx Nat

19−newtype JSONPath = JSONPath Text

14+

20− deriving (Show)

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)

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

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

23demotePath = go []

20demotePath = go []

24 where

21 where

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

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

26 go acc SNil = acc

23 go acc SNil = acc

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

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

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

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

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

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

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

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

32−demotedPathToText :: [DemotedPathSegment] -> JSONPath

29+demotedPathToText :: JSONPath -> JSONPathText

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

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

34 where

31 where

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

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

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

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

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

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

39pathToText = demotedPathToText . demotePath

36pathToText = demotedPathToText . demotePath

src/Data/Schematic/Schema.hs+47−2

@@ -1,6 +1,7 @@

1{-# LANGUAGE AllowAmbiguousTypes #-}

2+{-# LANGUAGE CPP #-}

2−{-# LANGUAGE OverloadedLists #-}

3+{-# LANGUAGE OverloadedLists #-}

3−{-# LANGUAGE OverloadedStrings #-}

4+{-# LANGUAGE OverloadedStrings #-}

4{-# OPTIONS_GHC -fprint-explicit-kinds #-}

5{-# OPTIONS_GHC -fprint-explicit-kinds #-}

6module Data.Schematic.Schema where

7module Data.Schematic.Schema where

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

179

180

180data ArrayConstraint

181data ArrayConstraint

181 = AEq Nat

182 = AEq Nat

183+ | AGt Nat

184+ | AGe Nat

185+ | ALt Nat

186+ | ALe Nat

182 deriving (Generic)

187 deriving (Generic)

183

188

184data DemotedArrayConstraint

189data DemotedArrayConstraint

185 = DAEq Integer

190 = DAEq Integer

191+ | DAGt Integer

192+ | DAGe Integer

193+ | DALt Integer

194+ | DALe Integer

186 deriving (Generic, Eq, Show)

195 deriving (Generic, Eq, Show)

187

196

188data instance Sing (ac :: ArrayConstraint) where

197data instance Sing (ac :: ArrayConstraint) where

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

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

190

203

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

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

192

209

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

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

194

215

195instance SingKind ArrayConstraint where

216instance SingKind ArrayConstraint where

196 type Demote ArrayConstraint = DemotedArrayConstraint

217 type Demote ArrayConstraint = DemotedArrayConstraint

197 fromSing = \case

218 fromSing = \case

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

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

199 toSing = \case

224 toSing = \case

200 DAEq n -> case someNatVal n of

225 DAEq n -> case someNatVal n of

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

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

202 Nothing -> error "Negative singleton nat"

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

203

240

204data Schema

241data Schema

205 = SchemaText [TextConstraint]

242 = SchemaText [TextConstraint]

@@ -376,8 +413,16 @@ instance Show (JsonRepr 'SchemaNull) where show _ = "ReprNull"

376instance Show (JsonRepr s) => Show (JsonRepr ('SchemaArray acs s)) where

413instance Show (JsonRepr s) => Show (JsonRepr ('SchemaArray acs s)) where

377 show (ReprArray v) = "ReprArray " P.++ show v

414 show (ReprArray v) = "ReprArray " P.++ show v

378

415

416+#if MIN_VERSION_base(4,12,0)

417+instance

418+ ( V.RecAll FieldRepr fs Show, RMap fs, ReifyConstraint Show FieldRepr fs

419+ , RecordToList fs )

420+ => Show (JsonRepr ('SchemaObject fs)) where

421+ show (ReprObject fs) = "ReprObject " P.++ show fs

422+#else

379instance V.RecAll FieldRepr fs Show => Show (JsonRepr ('SchemaObject fs)) where

423instance V.RecAll FieldRepr fs Show => Show (JsonRepr ('SchemaObject fs)) where

380 show (ReprObject fs) = "ReprObject " P.++ show fs

424 show (ReprObject fs) = "ReprObject " P.++ show fs

425+#endif

381

426

382instance Show (JsonRepr s) => Show (JsonRepr ('SchemaOptional s)) where

427instance Show (JsonRepr s) => Show (JsonRepr ('SchemaOptional s)) where

383 show (ReprOptional s) = "ReprOptional " P.++ show s

428 show (ReprOptional s) = "ReprOptional " P.++ show s

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

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

47data ArrayConstraint

48 = AEq Nat

49+ | AGt Nat

50+ | AGe Nat

51+ | ALt Nat

52+ | ALe Nat

50data DemotedArrayConstraint

54data DemotedArrayConstraint

51 = DAEq Integer

55 = DAEq Integer

56+ | DAGt Integer

57+ | DAGe Integer

58+ | DALt Integer

59+ | DALe Integer

53data Schema

61data Schema

54 = SchemaText [TextConstraint]

62 = SchemaText [TextConstraint]

src/Data/Schematic/Validation.hs+52−23

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

3import Control.Monad

4import Control.Monad.Validation

5import Data.Aeson

6+import Data.Aeson.Internal

6import Data.Aeson.Types

7import Data.Aeson.Types

7import Data.Foldable

8import Data.Foldable

8import Data.Functor.Identity

9import Data.Functor.Identity

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

49isValidationError _ = False

50isValidationError _ = False

51validateTextConstraint

52validateTextConstraint

52− :: JSONPath

53+ :: JSONPathText

53 -> Text

54 -> Text

54 -> Sing (tcs :: TextConstraint)

55 -> Sing (tcs :: TextConstraint)

55 -> Validation ()

56 -> Validation ()

56−validateTextConstraint (JSONPath path) t = \case

57+validateTextConstraint (JSONPathText path) t = \case

57 STEq n -> do

58 STEq n -> do

58 let

59 let

59 nlen = withKnownNat n $ natVal n

60 nlen = withKnownNat n $ natVal n

60 predicate = nlen == (fromIntegral $ T.length t)

61 predicate = nlen == (fromIntegral $ T.length t)

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

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

62 warn = vWarning $ mmSingleton path (pure errMsg)

63 warn = vWarning $ mmSingleton path (pure errMsg)

63 unless predicate warn

64 unless predicate warn

64 STLt n -> do

65 STLt n -> do

65 let

66 let

66 nlen = withKnownNat n $ natVal n

67 nlen = withKnownNat n $ natVal n

67 predicate = nlen > (fromIntegral $ T.length t)

68 predicate = nlen > (fromIntegral $ T.length t)

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

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

69 warn = vWarning $ mmSingleton path (pure errMsg)

70 warn = vWarning $ mmSingleton path (pure errMsg)

70 unless predicate warn

71 unless predicate warn

71 STLe n -> do

72 STLe n -> do

72 let

73 let

73 nlen = withKnownNat n $ natVal n

74 nlen = withKnownNat n $ natVal n

74 predicate = nlen >= (fromIntegral $ T.length t)

75 predicate = nlen >= (fromIntegral $ T.length t)

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

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

76 warn = vWarning $ mmSingleton path (pure errMsg)

77 warn = vWarning $ mmSingleton path (pure errMsg)

77 unless predicate warn

78 unless predicate warn

78 STGt n -> do

79 STGt n -> do

79 let

80 let

80 nlen = withKnownNat n $ natVal n

81 nlen = withKnownNat n $ natVal n

81 predicate = nlen < (fromIntegral $ T.length t)

82 predicate = nlen < (fromIntegral $ T.length t)

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

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

83 warn = vWarning $ mmSingleton path (pure errMsg)

84 warn = vWarning $ mmSingleton path (pure errMsg)

84 unless predicate warn

85 unless predicate warn

85 STGe n -> do

86 STGe n -> do

86 let

87 let

87 nlen = withKnownNat n $ natVal n

88 nlen = withKnownNat n $ natVal n

88 predicate = nlen <= (fromIntegral $ T.length t)

89 predicate = nlen <= (fromIntegral $ T.length t)

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

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

90 warn = vWarning $ mmSingleton path (pure errMsg)

91 warn = vWarning $ mmSingleton path (pure errMsg)

91 unless predicate warn

92 unless predicate warn

92 STRegex r -> do

93 STRegex r -> do

93 let

94 let

94 regex = withKnownSymbol r $ fromSing r

95 regex = withKnownSymbol r $ fromSing r

95 predicate = matchTest (makeRegex (T.unpack regex) :: Regex) (T.unpack t)

96 predicate = matchTest (makeRegex (T.unpack regex) :: Regex) (T.unpack t)

96− errMsg = path <> " must match " <> regex

97+ errMsg = "must match " <> regex

97 warn = vWarning $ mmSingleton path (pure errMsg)

98 warn = vWarning $ mmSingleton path (pure errMsg)

98 unless predicate warn

99 unless predicate warn

99 STEnum ss -> do

100 STEnum ss -> do

@@ -101,69 +102,97 @@ validateTextConstraint (JSONPath path) t = \case

101 matching :: Sing (s :: [Symbol]) -> Bool

102 matching :: Sing (s :: [Symbol]) -> Bool

102 matching SNil = False

103 matching SNil = False

103 matching (SCons s@SSym fs) = T.pack (symbolVal s) == t || matching fs

104 matching (SCons s@SSym fs) = T.pack (symbolVal s) == t || matching fs

104− errMsg = path <> " must be one of " <> T.pack (show (fromSing ss))

105+ errMsg = "must be one of " <> T.pack (show (fromSing ss))

105 warn = vWarning $ mmSingleton path (pure errMsg)

106 warn = vWarning $ mmSingleton path (pure errMsg)

106 unless (matching ss) warn

107 unless (matching ss) warn

107

108

108validateNumberConstraint

109validateNumberConstraint

109− :: JSONPath

110+ :: JSONPathText

110 -> Scientific

111 -> Scientific

111 -> Sing (tcs :: NumberConstraint)

112 -> Sing (tcs :: NumberConstraint)

112 -> Validation ()

113 -> Validation ()

113−validateNumberConstraint (JSONPath path) num = \case

114+validateNumberConstraint (JSONPathText path) num = \case

114 SNEq n -> do

115 SNEq n -> do

115 let

116 let

116 nlen = withKnownNat n $ natVal n

117 nlen = withKnownNat n $ natVal n

117 predicate = fromIntegral nlen == num

118 predicate = fromIntegral nlen == num

118− errMsg = path <> " should be == " <> T.pack (show nlen)

119+ errMsg = "should be == " <> T.pack (show nlen)

119 warn = vWarning $ mmSingleton path (pure errMsg)

120 warn = vWarning $ mmSingleton path (pure errMsg)

120 unless predicate warn

121 unless predicate warn

121 SNGt n -> do

122 SNGt n -> do

122 let

123 let

123 nlen = withKnownNat n $ natVal n

124 nlen = withKnownNat n $ natVal n

124 predicate = num > fromIntegral nlen

125 predicate = num > fromIntegral nlen

125− errMsg = path <> " should be > " <> T.pack (show nlen)

126+ errMsg = "should be > " <> T.pack (show nlen)

126 warn = vWarning $ mmSingleton path (pure errMsg)

127 warn = vWarning $ mmSingleton path (pure errMsg)

127 unless predicate warn

128 unless predicate warn

128 SNGe n -> do

129 SNGe n -> do

129 let

130 let

130 nlen = withKnownNat n $ natVal n

131 nlen = withKnownNat n $ natVal n

131 predicate = num >= fromIntegral nlen

132 predicate = num >= fromIntegral nlen

132− errMsg = path <> " should be >= " <> T.pack (show nlen)

133+ errMsg = "should be >= " <> T.pack (show nlen)

133 warn = vWarning $ mmSingleton path (pure errMsg)

134 warn = vWarning $ mmSingleton path (pure errMsg)

134 unless predicate warn

135 unless predicate warn

135 SNLt n -> do

136 SNLt n -> do

136 let

137 let

137 nlen = withKnownNat n $ natVal n

138 nlen = withKnownNat n $ natVal n

138 predicate = num < fromIntegral nlen

139 predicate = num < fromIntegral nlen

139− errMsg = path <> " should be < " <> T.pack (show nlen)

140+ errMsg = "should be < " <> T.pack (show nlen)

140 warn = vWarning $ mmSingleton path (pure errMsg)

141 warn = vWarning $ mmSingleton path (pure errMsg)

141 unless predicate warn

142 unless predicate warn

142 SNLe n -> do

143 SNLe n -> do

143 let

144 let

144 nlen = withKnownNat n $ natVal n

145 nlen = withKnownNat n $ natVal n

145 predicate = num <= fromIntegral nlen

146 predicate = num <= fromIntegral nlen

146− errMsg = path <> " should be <= " <> T.pack (show nlen)

147+ errMsg = "should be <= " <> T.pack (show nlen)

147 warn = vWarning $ mmSingleton path (pure errMsg)

148 warn = vWarning $ mmSingleton path (pure errMsg)

148 unless predicate warn

149 unless predicate warn

149

150

150validateArrayConstraint

151validateArrayConstraint

151− :: JSONPath

152+ :: JSONPathText

152 -> V.Vector a

153 -> V.Vector a

153 -> Sing (tcs :: ArrayConstraint)

154 -> Sing (tcs :: ArrayConstraint)

154 -> Validation ()

155 -> Validation ()

155−validateArrayConstraint (JSONPath path) v = \case

156+validateArrayConstraint (JSONPathText path) v = \case

156 SAEq n -> do

157 SAEq n -> do

157 let

158 let

158 nlen = withKnownNat n $ natVal n

159 nlen = withKnownNat n $ natVal n

159 predicate = nlen == fromIntegral (V.length v)

160 predicate = nlen == fromIntegral (V.length v)

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

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

162+ warn = vWarning $ mmSingleton path (pure errMsg)

163+ 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)

161 warn = vWarning $ mmSingleton path (pure errMsg)

190 warn = vWarning $ mmSingleton path (pure errMsg)

162 unless predicate warn

191 unless predicate warn

163

192

164validateJsonRepr

193validateJsonRepr

165 :: Sing schema

194 :: Sing schema

166− -> [DemotedPathSegment]

195+ -> JSONPath

167 -> JsonRepr schema

196 -> JsonRepr schema

168 -> Validation ()

197 -> Validation ()

169validateJsonRepr sschema dpath jr = case jr of

198validateJsonRepr sschema dpath jr = case jr of

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

197 process cs

226 process cs

198 process acs

227 process acs

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

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

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

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

201 validateJsonRepr s newPath jr'

230 validateJsonRepr s newPath jr'

202 ReprOptional d -> case sschema of

231 ReprOptional d -> case sschema of

203 SSchemaOptional ss -> case d of

232 SSchemaOptional ss -> case d of

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

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

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

210 go RNil = pure ()

239 go RNil = pure ()

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

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

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

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

213 validateJsonRepr (knownFieldSchema f) newPath d

242 validateJsonRepr (knownFieldSchema f) newPath d

214 go ftl

243 go ftl

215 ReprUnion _ -> pure () -- FIXME

244 ReprUnion _ -> pure () -- FIXME

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

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

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

222 -- Just x -> do

251 -- Just x -> do

223 -- let

252 -- let

224− -- JSONPath path = demotedPathToText dpath

253+ -- JSONPathText path = demotedPathToText dpath

225 -- case stl of

254 -- case stl of

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

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

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

256 -- $ 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.yaml+5−4

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

1−resolver: lts-12.0

1+resolver: lts-14.22

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− - validationt-0.2.1.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

10import Data.Aeson as J

11import Data.Maybe

12import Data.Proxy

13+import Data.ByteString.Lazy as B

13import Data.Schematic

14import Data.Schematic

14import Data.Vinyl

15import Data.Vinyl

15import JSONSchema.Draft4 as D4

16import JSONSchema.Draft4 as D4

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

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

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

32 :& RNil

33 :& RNil

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+

34spec :: Spec

56spec :: Spec

35spec = do

57spec = do

36 it "validates simple schema" $ do

58 it "validates simple schema" $ do

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

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

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

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

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

40 Right _ -> pure ()

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

42main :: IO ()

100main :: IO ()

43main = hspec spec

101main = hspec spec