43d2526..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+8−4

@@ -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.13

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

@@ -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/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/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+36

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

180

181data ArrayConstraint

182 = AEq Nat

183+ | AGt Nat

184+ | AGe Nat

185+ | ALt Nat

186+ | ALe Nat

183 deriving (Generic)

187 deriving (Generic)

184

188

185data DemotedArrayConstraint

189data DemotedArrayConstraint

186 = DAEq Integer

190 = DAEq Integer

191+ | DAGt Integer

192+ | DAGe Integer

193+ | DALt Integer

194+ | DALe Integer

187 deriving (Generic, Eq, Show)

195 deriving (Generic, Eq, Show)

188

196

189data instance Sing (ac :: ArrayConstraint) where

197data instance Sing (ac :: ArrayConstraint) where

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

191

203

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

193

209

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

195

215

196instance SingKind ArrayConstraint where

216instance SingKind ArrayConstraint where

197 type Demote ArrayConstraint = DemotedArrayConstraint

217 type Demote ArrayConstraint = DemotedArrayConstraint

198 fromSing = \case

218 fromSing = \case

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

200 toSing = \case

224 toSing = \case

201 DAEq n -> case someNatVal n of

225 DAEq n -> case someNatVal n of

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

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

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

204

240

205data Schema

241data Schema

206 = SchemaText [TextConstraint]

242 = SchemaText [TextConstraint]

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+100−71

@@ -1,24 +1,20 @@

1−{-# LANGUAGE AllowAmbiguousTypes #-}

2−

3module Data.Schematic.Validation where

1module Data.Schematic.Validation where

5−import Control.Applicative

6import Control.Monad

3import Control.Monad

7import Control.Monad.Validation

4import Control.Monad.Validation

8import Data.Aeson

5import Data.Aeson

6+import Data.Aeson.Internal

9import Data.Aeson.Types

7import Data.Aeson.Types

10−import Data.Coerce

11import Data.Foldable

8import Data.Foldable

12import Data.Functor.Identity

9import Data.Functor.Identity

13import Data.Monoid

10import Data.Monoid

14import Data.Schematic.Path

11import Data.Schematic.Path

15import Data.Schematic.Schema

12import Data.Schematic.Schema

16import Data.Scientific

13import Data.Scientific

17−import Data.Singletons.Prelude hiding (Const)

14+import Data.Singletons.Prelude

18import Data.Singletons.TypeLits

15import Data.Singletons.TypeLits

19import Data.Text as T

16import Data.Text as T

20import Data.Traversable

17import Data.Traversable

21−import Data.Type.Equality

22import Data.Union

18import Data.Union

23import Data.Vector as V

19import Data.Vector as V

24import Data.Vinyl

20import Data.Vinyl

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

54isValidationError _ = False

50isValidationError _ = False

56validateTextConstraint

52validateTextConstraint

57− :: JSONPath

53+ :: JSONPathText

58 -> Text

54 -> Text

59 -> Sing (tcs :: TextConstraint)

55 -> Sing (tcs :: TextConstraint)

60 -> Validation ()

56 -> Validation ()

61−validateTextConstraint (JSONPath path) t = \case

57+validateTextConstraint (JSONPathText path) t = \case

62 STEq n -> do

58 STEq n -> do

63 let

59 let

64 nlen = withKnownNat n $ natVal n

60 nlen = withKnownNat n $ natVal n

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

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

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

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

67 warn = vWarning $ mmSingleton path (pure errMsg)

63 warn = vWarning $ mmSingleton path (pure errMsg)

68 unless predicate warn

64 unless predicate warn

69 STLt n -> do

65 STLt n -> do

70 let

66 let

71 nlen = withKnownNat n $ natVal n

67 nlen = withKnownNat n $ natVal n

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

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

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

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

74 warn = vWarning $ mmSingleton path (pure errMsg)

70 warn = vWarning $ mmSingleton path (pure errMsg)

75 unless predicate warn

71 unless predicate warn

76 STLe n -> do

72 STLe n -> do

77 let

73 let

78 nlen = withKnownNat n $ natVal n

74 nlen = withKnownNat n $ natVal n

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

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

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

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

81 warn = vWarning $ mmSingleton path (pure errMsg)

77 warn = vWarning $ mmSingleton path (pure errMsg)

82 unless predicate warn

78 unless predicate warn

83 STGt n -> do

79 STGt n -> do

84 let

80 let

85 nlen = withKnownNat n $ natVal n

81 nlen = withKnownNat n $ natVal n

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

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

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

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

88 warn = vWarning $ mmSingleton path (pure errMsg)

84 warn = vWarning $ mmSingleton path (pure errMsg)

89 unless predicate warn

85 unless predicate warn

90 STGe n -> do

86 STGe n -> do

91 let

87 let

92 nlen = withKnownNat n $ natVal n

88 nlen = withKnownNat n $ natVal n

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

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

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

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

95 warn = vWarning $ mmSingleton path (pure errMsg)

91 warn = vWarning $ mmSingleton path (pure errMsg)

96 unless predicate warn

92 unless predicate warn

97 STRegex r -> do

93 STRegex r -> do

98 let

94 let

99 regex = withKnownSymbol r $ fromSing r

95 regex = withKnownSymbol r $ fromSing r

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

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

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

97+ errMsg = "must match " <> regex

102 warn = vWarning $ mmSingleton path (pure errMsg)

98 warn = vWarning $ mmSingleton path (pure errMsg)

103 unless predicate warn

99 unless predicate warn

104 STEnum ss -> do

100 STEnum ss -> do

@@ -106,76 +102,101 @@ validateTextConstraint (JSONPath path) t = \case

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

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

107 matching SNil = False

103 matching SNil = False

108 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

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

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

110 warn = vWarning $ mmSingleton path (pure errMsg)

106 warn = vWarning $ mmSingleton path (pure errMsg)

111 unless (matching ss) warn

107 unless (matching ss) warn

112

108

113validateNumberConstraint

109validateNumberConstraint

114− :: JSONPath

110+ :: JSONPathText

115 -> Scientific

111 -> Scientific

116 -> Sing (tcs :: NumberConstraint)

112 -> Sing (tcs :: NumberConstraint)

117 -> Validation ()

113 -> Validation ()

118−validateNumberConstraint (JSONPath path) num = \case

114+validateNumberConstraint (JSONPathText path) num = \case

119 SNEq n -> do

115 SNEq n -> do

120 let

116 let

121 nlen = withKnownNat n $ natVal n

117 nlen = withKnownNat n $ natVal n

122 predicate = fromIntegral nlen == num

118 predicate = fromIntegral nlen == num

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

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

124 warn = vWarning $ mmSingleton path (pure errMsg)

120 warn = vWarning $ mmSingleton path (pure errMsg)

125 unless predicate warn

121 unless predicate warn

126 SNGt n -> do

122 SNGt n -> do

127 let

123 let

128 nlen = withKnownNat n $ natVal n

124 nlen = withKnownNat n $ natVal n

129 predicate = num > fromIntegral nlen

125 predicate = num > fromIntegral nlen

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

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

131 warn = vWarning $ mmSingleton path (pure errMsg)

127 warn = vWarning $ mmSingleton path (pure errMsg)

132 unless predicate warn

128 unless predicate warn

133 SNGe n -> do

129 SNGe n -> do

134 let

130 let

135 nlen = withKnownNat n $ natVal n

131 nlen = withKnownNat n $ natVal n

136 predicate = num >= fromIntegral nlen

132 predicate = num >= fromIntegral nlen

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

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

138 warn = vWarning $ mmSingleton path (pure errMsg)

134 warn = vWarning $ mmSingleton path (pure errMsg)

139 unless predicate warn

135 unless predicate warn

140 SNLt n -> do

136 SNLt n -> do

141 let

137 let

142 nlen = withKnownNat n $ natVal n

138 nlen = withKnownNat n $ natVal n

143 predicate = num < fromIntegral nlen

139 predicate = num < fromIntegral nlen

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

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

145 warn = vWarning $ mmSingleton path (pure errMsg)

141 warn = vWarning $ mmSingleton path (pure errMsg)

146 unless predicate warn

142 unless predicate warn

147 SNLe n -> do

143 SNLe n -> do

148 let

144 let

149 nlen = withKnownNat n $ natVal n

145 nlen = withKnownNat n $ natVal n

150 predicate = num <= fromIntegral nlen

146 predicate = num <= fromIntegral nlen

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

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

152 warn = vWarning $ mmSingleton path (pure errMsg)

148 warn = vWarning $ mmSingleton path (pure errMsg)

153 unless predicate warn

149 unless predicate warn

154

150

155validateArrayConstraint

151validateArrayConstraint

156− :: JSONPath

152+ :: JSONPathText

157 -> V.Vector a

153 -> V.Vector a

158 -> Sing (tcs :: ArrayConstraint)

154 -> Sing (tcs :: ArrayConstraint)

159 -> Validation ()

155 -> Validation ()

160−validateArrayConstraint (JSONPath path) v = \case

156+validateArrayConstraint (JSONPathText path) v = \case

161 SAEq n -> do

157 SAEq n -> do

162 let

158 let

163 nlen = withKnownNat n $ natVal n

159 nlen = withKnownNat n $ natVal n

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

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

165− 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)

166 warn = vWarning $ mmSingleton path (pure errMsg)

190 warn = vWarning $ mmSingleton path (pure errMsg)

167 unless predicate warn

191 unless predicate warn

168−

169−class Validatable schema where

170− validateJsonRepr :: [DemotedPathSegment] -> JsonRepr schema -> Validation ()

171

192

172validateJsonRepr

193validateJsonRepr

173− :: forall schema. SingI schema

194+ :: Sing schema

174− => [DemotedPathSegment]

195+ -> JSONPath

175 -> JsonRepr schema

196 -> JsonRepr schema

176 -> Validation ()

197 -> Validation ()

177−validateJsonRepr dpath jr = withSingI (sing :: Sing schema) $ case jr of

198+validateJsonRepr sschema dpath jr = case jr of

178− ReprText t -> case sing :: Sing schema of

199+ ReprText t -> case sschema of

179 SSchemaText scs -> do

200 SSchemaText scs -> do

180 let

201 let

181 process :: Sing (cs :: [TextConstraint]) -> Validation ()

202 process :: Sing (cs :: [TextConstraint]) -> Validation ()

@@ -184,7 +205,7 @@ validateJsonRepr dpath jr = withSingI (sing :: Sing schema) $ case jr of

184 validateTextConstraint (demotedPathToText dpath) t c

205 validateTextConstraint (demotedPathToText dpath) t c

185 process cs

206 process cs

186 process scs

207 process scs

187− ReprNumber n -> case sing :: Sing schema of

208+ ReprNumber n -> case sschema of

188 SSchemaNumber scs -> do

209 SSchemaNumber scs -> do

189 let

210 let

190 process :: Sing (cs :: [NumberConstraint]) -> Validation ()

211 process :: Sing (cs :: [NumberConstraint]) -> Validation ()

@@ -195,7 +216,7 @@ validateJsonRepr dpath jr = withSingI (sing :: Sing schema) $ case jr of

195 process scs

216 process scs

196 ReprNull -> pure ()

217 ReprNull -> pure ()

197 ReprBoolean _ -> pure ()

218 ReprBoolean _ -> pure ()

198− ReprArray v -> case sing :: Sing schema of

219+ ReprArray v -> case sschema of

199 SSchemaArray acs s -> do

220 SSchemaArray acs s -> do

200 let

221 let

201 process :: Sing (cs :: [ArrayConstraint]) -> Validation ()

222 process :: Sing (cs :: [ArrayConstraint]) -> Validation ()

@@ -205,53 +226,61 @@ validateJsonRepr dpath jr = withSingI (sing :: Sing schema) $ case jr of

205 process cs

226 process cs

206 process acs

227 process acs

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

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

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

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

209− withSingI s $ validateJsonRepr newPath jr'

230+ validateJsonRepr s newPath jr'

210− ReprOptional d -> case sing :: Sing schema of

231+ ReprOptional d -> case sschema of

211 SSchemaOptional ss -> case d of

232 SSchemaOptional ss -> case d of

212− Just x -> withSingI ss $ validateJsonRepr dpath x

233+ Just x -> validateJsonRepr ss dpath x

213 Nothing -> pure ()

234 Nothing -> pure ()

214− ReprObject fs -> case sing :: Sing schema of

235+ ReprObject fs -> case sschema of

215 SSchemaObject _ -> go fs

236 SSchemaObject _ -> go fs

216 where

237 where

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

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

218 go RNil = pure ()

239 go RNil = pure ()

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

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

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

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

221− withSingI (knownFieldSchema f)

242+ validateJsonRepr (knownFieldSchema f) newPath d

222− $ validateJsonRepr newPath d

223 go ftl

243 go ftl

224− ReprUnion u -> pure () -- upeel u (sing :: Sing schema)

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

225− -- ReprUnion u -> do

226− -- let

227− -- v :: forall s. JsonRepr s -> Const (Validation ()) s

228− -- v j = Const $ validateJsonRepr (singByProxy j) dpath j

229− -- peel :: Union (Const (Validation ())) ts -> Validation ()

230− -- peel (That u) = peel u

231− -- peel (This v) = getConst v

232− -- peel (umap v u)

233− -- ReprUnion u -> do

234− -- let

235− -- peel :: Union JsonRepr ss -> [DemotedSchema] -> Validation ()

236− -- peel (That u) ds = peel u ds

237− -- peel (This j) ds = case ds of

238− -- [] -> error "peeling error: report this as a schematic bug"

239− -- (ds' :_) -> let s' = toSing ds'

240− -- in case s' of

241− -- SomeSing s -> case s `testEquality` (singByProxy j) of

242− -- Just Refl -> validateJsonRepr s dpath j

243− -- case sschema of

245+ -- case sschema of

244− -- SSchemaUnion us -> peel u (fromSing us)

246+ -- SSchemaUnion ss -> case ss of

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

248+ -- Nothing -> case urestrict u of

249+ -- Nothing ->

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

251+ -- Just x -> do

252+ -- let

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

245

268

246−class UPeel ss where

269+-- withUSubset

247− upeel :: Union JsonRepr ss -> Sing (SchemaUnion ss :: Schema) -> Validation ()

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

248

274

249−instance (UPeel stl) => UPeel (s ': stl) where

275+toUnion

250− upeel (That u) (SSchemaUnion (SCons _ stl)) = upeel @stl u (SSchemaUnion stl)

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

251− upeel (This j) (SSchemaUnion (SCons s _)) = withSingI s $ validateJsonRepr mempty j

277+ => Sing (s ': ss)

278+ -> Union JsonRepr s'

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

280+toUnion _ = ReprUnion . urelax

252

281

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

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

254−umatch' _ = umatch

283+umatch' _ u = umatch u

255

284

256parseAndValidateJson

285parseAndValidateJson

257 :: forall schema

286 :: forall schema

@@ -263,7 +292,7 @@ parseAndValidateJson v =

263 Left s -> DecodingError $ T.pack s

292 Left s -> DecodingError $ T.pack s

264 Right jsonRepr ->

293 Right jsonRepr ->

265 let

294 let

266− validate = validateJsonRepr [] jsonRepr

295+ validate = validateJsonRepr (sing :: Sing schema) [] jsonRepr

267 res = runIdentity . runValidationTEither $ validate

296 res = runIdentity . runValidationTEither $ validate

268 in case res of

297 in case res of

269 Left em -> ValidationError em

298 Left em -> ValidationError em

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

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