git.iko.soy/typeable/schematic
on 446a306 help sign in
ChangeLog.md−11
since splitsnapshots
unifiedsplit
@@ -1,16 +1,5 @@
1# Revision history for schematic
1# Revision history for schematic
2
2
3−## 0.6.0.0 -- 2021-01-15
4−
5−Added compatability with aeson-1.4.3.0. Since version 1.4.3 the module `Data.Aeson` started exporting `JSONPath`, which was conflicting with our own `JSONPath`. Furthermore, started using `JSONPathElement` from `aeson` instead of `DemotedPathSegment`.
6−
7−## 0.5.1.0 -- 2021-01-15
8−
9−Fix the generation of json schema for numbers.
10−Add array constraints.
11−Fix the generation of text and number constraints.
12−Remove jsonpath from the error message.
13−
14## 0.5.0.0 -- 2019-02-20
3## 0.5.0.0 -- 2019-02-20
15
4
16GHC 8.6, json generation by schema definition, validation bug fixes, better
5GHC 8.6, json generation by schema definition, validation bug fixes, better
schematic.cabal+5−9
@@ -1,5 +1,5 @@
1name: schematic
1name: schematic
2−version: 0.6.0.0
2+version: 0.5.0.0
3synopsis: JSON-biased spec and validation tool
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.
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
5license: BSD3
@@ -10,7 +10,7 @@ homepage: http://github.com/typeable/schematic
10Bug-reports: http://github.com/typeable/schematic/issues/
10Bug-reports: http://github.com/typeable/schematic/issues/
11category: Data
11category: Data
12build-type: Simple
12build-type: Simple
13−extra-source-files: ChangeLog.md, README.md
13+extra-source-files: ChangeLog.md
14cabal-version: >=1.10
14cabal-version: >=1.10
15
15
16library
16library
@@ -65,9 +65,9 @@ library
65 , TypeOperators
65 , TypeOperators
66 , TypeSynonymInstances
66 , TypeSynonymInstances
67 , UndecidableInstances
67 , UndecidableInstances
68− build-depends: base >=4.11 && <5
68+ build-depends: base >=4.11 && <4.12
69 , bytestring
69 , bytestring
70− , aeson >= 1.4.3.0 && < 1.6
70+ , aeson >= 1
71 , containers
71 , containers
72 , hjsonschema
72 , hjsonschema
73 , mtl
73 , mtl
@@ -95,7 +95,7 @@ test-suite spec
95 default-language: Haskell2010
95 default-language: Haskell2010
96 build-depends: HUnit
96 build-depends: HUnit
97 , aeson >= 1
97 , aeson >= 1
98− , base >=4.11 && <4.13
98+ , base >=4.11 && <4.12
99 , bytestring
99 , bytestring
100 , containers
100 , containers
101 , hjsonschema
101 , hjsonschema
@@ -118,7 +118,3 @@ test-suite spec
118 , HelpersSpec
118 , HelpersSpec
119 , LensSpec
119 , LensSpec
120 , JsonSchemaSpec
120 , JsonSchemaSpec
121−
122−source-repository head
123− type: git
124− location: https://github.com/typeable/schematic
src/Data/Schematic/DSL.hs+2−11
@@ -1,5 +1,4 @@
1{-# LANGUAGE AllowAmbiguousTypes #-}
1{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# LANGUAGE CPP #-}
3
2
4module Data.Schematic.DSL where
3module Data.Schematic.DSL where
5
4
@@ -18,19 +17,11 @@ import Data.Vinyl
18import Data.Vinyl.Functor
17import Data.Vinyl.Functor
19
18
20
19
21−#if MIN_VERSION_base(4,12,0)
22type Constructor a
20type Constructor a
23− = forall fields b
24− . (fields ~ FieldsOf a, FSubset fields b (FImage fields b), RMap fields)
21+ = forall fields b. (fields ~ FieldsOf a, FSubset fields b (FImage fields b))
25 => Rec (Tagged fields :. FieldRepr) b
22 => Rec (Tagged fields :. FieldRepr) b
26 -> JsonRepr ('SchemaObject fields)
23 -> JsonRepr ('SchemaObject fields)
27−#else
24+
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
34withRepr :: Constructor a
25withRepr :: Constructor a
35withRepr = ReprObject . rmap (unTagged . getCompose) . fcast
26withRepr = ReprObject . rmap (unTagged . getCompose) . fcast
36
27
src/Data/Schematic/JsonSchema.hs+9−21
@@ -30,13 +30,13 @@ textConstraint :: DemotedTextConstraint -> State D4.Schema ()
30textConstraint (DTEq n) = modify $ \s -> s
30textConstraint (DTEq n) = modify $ \s -> s
31 { _schemaMinLength = pure $ fromIntegral n
31 { _schemaMinLength = pure $ fromIntegral n
32 , _schemaMaxLength = pure $ fromIntegral n }
32 , _schemaMaxLength = pure $ fromIntegral n }
33+textConstraint (DTLt n) = modify $ \s -> s
34+ { _schemaMaxLength = pure . fromIntegral $ n + 1 }
33textConstraint (DTLe n) = modify $ \s -> s
35textConstraint (DTLe n) = modify $ \s -> s
34 { _schemaMaxLength = pure . fromIntegral $ n }
36 { _schemaMaxLength = pure . fromIntegral $ n }
35−textConstraint (DTLt n) =
37+textConstraint (DTGt n) =
36 let n' = if n == 0 then 0 else n - 1
38 let n' = if n == 0 then 0 else n - 1
37− in modify $ \s -> s { _schemaMaxLength = pure . fromIntegral $ n' }
39+ in modify $ \s -> s { _schemaMinLength = pure . fromIntegral $ n' }
38−textConstraint (DTGt n) = modify $ \s -> s
39− { _schemaMinLength = pure . fromIntegral $ n + 1 }
40textConstraint (DTGe n) = modify $ \s -> s
40textConstraint (DTGe n) = modify $ \s -> s
41 { _schemaMinLength = pure . fromIntegral $ n }
41 { _schemaMinLength = pure . fromIntegral $ n }
42textConstraint (DTRegex r) = modify $ \s -> s { _schemaPattern = pure r }
42textConstraint (DTRegex r) = modify $ \s -> s { _schemaPattern = pure r }
@@ -48,30 +48,18 @@ numberConstraint :: DemotedNumberConstraint -> State D4.Schema ()
48numberConstraint (DNLe n) = modify $ \s -> s
48numberConstraint (DNLe n) = modify $ \s -> s
49 { _schemaMaximum = pure . fromIntegral $ n }
49 { _schemaMaximum = pure . fromIntegral $ n }
50numberConstraint (DNLt n) = modify $ \s -> s
50numberConstraint (DNLt n) = modify $ \s -> s
51− { _schemaMaximum = pure . fromIntegral $ n
51+ { _schemaMaximum = pure . fromIntegral $ n + 1 }
52− , _schemaExclusiveMaximum = pure True }
53numberConstraint (DNGt n) = modify $ \s -> s
52numberConstraint (DNGt n) = modify $ \s -> s
54− { _schemaMinimum = pure . fromIntegral $ n
55− , _schemaExclusiveMinimum = pure True }
56−numberConstraint (DNGe n) = modify $ \s -> s
57 { _schemaMinimum = pure . fromIntegral $ n }
53 { _schemaMinimum = pure . fromIntegral $ n }
54+numberConstraint (DNGe n) =
55+ let n' = if n == 0 then 0 else n - 1
56+ in modify $ \s -> s { _schemaMinimum = pure . fromIntegral $ n' }
58numberConstraint (DNEq n) = modify $ \s -> s
57numberConstraint (DNEq n) = modify $ \s -> s
59 { _schemaMinimum = pure $ fromIntegral n
58 { _schemaMinimum = pure $ fromIntegral n
60 , _schemaMaximum = pure $ fromIntegral n }
59 , _schemaMaximum = pure $ fromIntegral n }
61
60
62arrayConstraint :: DemotedArrayConstraint -> State D4.Schema ()
61arrayConstraint :: DemotedArrayConstraint -> State D4.Schema ()
63−arrayConstraint (DALe n) = modify $ \s -> s
62+arrayConstraint (DAEq _) = pure ()
64− { _schemaMaxItems = pure . fromIntegral $ n }
65−arrayConstraint (DALt n) =
66− let n' = if n == 0 then 0 else n - 1
67− in modify $ \s -> s { _schemaMaxItems = pure . fromIntegral $ n' }
68−arrayConstraint (DAGt n) = modify $ \s -> s
69− { _schemaMinItems = pure . fromIntegral $ n + 1 }
70−arrayConstraint (DAGe n) = modify $ \s -> s
71− { _schemaMinItems = pure . fromIntegral $ n }
72−arrayConstraint (DAEq n) = modify $ \s -> s
73− { _schemaMinItems = pure $ fromIntegral n
74− , _schemaMaxItems = pure $ fromIntegral n }
75
63
76toJsonSchema
64toJsonSchema
77 :: forall proxy schema
65 :: forall proxy schema
src/Data/Schematic/Migration.hs+2−10
@@ -1,6 +1,5 @@
1{-# LANGUAGE AllowAmbiguousTypes #-}
1{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# LANGUAGE CPP #-}
3−{-# LANGUAGE TemplateHaskell #-}
2+{-# LANGUAGE TemplateHaskell #-}
4
3
5module Data.Schematic.Migration where
4module Data.Schematic.Migration where
6
5
@@ -9,7 +8,7 @@ import Data.Schematic.DSL
9import Data.Schematic.Lens
8import Data.Schematic.Lens
10import Data.Schematic.Path
9import Data.Schematic.Path
11import Data.Schematic.Schema
10import Data.Schematic.Schema
12−import Data.Singletons.Prelude hiding ((:.), All)
11+import Data.Singletons.Prelude hiding (All, (:.))
13import Data.Singletons.TypeLits
12import Data.Singletons.TypeLits
14import Data.Tagged
13import Data.Tagged
15import Data.Vinyl
14import Data.Vinyl
@@ -157,17 +156,10 @@ data MList :: (Type -> Type) -> [Schema] -> Type where
157
156
158infixr 7 :&&
157infixr 7 :&&
159
158
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
166migrateObject
159migrateObject
167 :: forall m fs fh. (FSubset fs fs (FImage fs fs), Monad m)
160 :: forall m fs fh. (FSubset fs fs (FImage fs fs), Monad m)
168 => (Rec (Tagged fs :. FieldRepr) fh -> m (Rec (Tagged fs :. FieldRepr) fs))
161 => (Rec (Tagged fs :. FieldRepr) fh -> m (Rec (Tagged fs :. FieldRepr) fs))
169 -> Tagged ('SchemaObject fs) (JsonRepr ('SchemaObject fh) -> m (JsonRepr ('SchemaObject fs)))
162 -> Tagged ('SchemaObject fs) (JsonRepr ('SchemaObject fh) -> m (JsonRepr ('SchemaObject fs)))
170−#endif
171migrateObject f = Tagged $ \(ReprObject r) -> do
163migrateObject f = Tagged $ \(ReprObject r) -> do
172 res <- f $ rmap (Compose . Tagged) r
164 res <- f $ rmap (Compose . Tagged) r
173 pure $ withRepr @('SchemaObject fs) res
165 pure $ withRepr @('SchemaObject fs) res
src/Data/Schematic/Path.hs+20−17
@@ -4,33 +4,36 @@ import Data.Foldable as F
4import Data.Singletons.Prelude
4import Data.Singletons.Prelude
5import Data.Singletons.TypeLits
5import Data.Singletons.TypeLits
6import Data.Text as T
6import Data.Text as T
7−import Data.Aeson.Internal
8
7
9
8
10−newtype JSONPathText = JSONPathText Text
11− deriving (Show)
12−
13−data PathSegment = PathKey Symbol | PathIx Nat
9+data PathSegment = Key Symbol | Ix Nat
14
10
15data instance Sing (jp :: PathSegment) where
11data instance Sing (jp :: PathSegment) where
16− SKey :: (SingI k) => Sing (k :: Symbol) -> Sing ('PathKey k)
12+ SKey :: (SingI k) => Sing (k :: Symbol) -> Sing ('Key k)
17− SIx :: (SingI n) => Sing (n :: Nat) -> Sing ('PathIx n)
13+ SIx :: (SingI n) => Sing (n :: Nat) -> Sing ('Ix n)
14+
15+data DemotedPathSegment = DKey Text | DIx Integer
16+ deriving (Show)
17+
18+-- | Textual representation of json path.
19+newtype JSONPath = JSONPath Text
20+ deriving (Show)
18
21
19−demotePath :: Sing (ps :: [PathSegment]) -> JSONPath
22+demotePath :: Sing (ps :: [PathSegment]) -> [DemotedPathSegment]
20demotePath = go []
23demotePath = go []
21 where
24 where
22− go :: JSONPath -> Sing (ps :: [PathSegment]) -> JSONPath
25+ go :: [DemotedPathSegment] -> Sing (ps :: [PathSegment]) -> [DemotedPathSegment]
23 go acc SNil = acc
26 go acc SNil = acc
24 go acc (SCons p ps) = go (acc ++ [demotePathSeg p]) ps
27 go acc (SCons p ps) = go (acc ++ [demotePathSeg p]) ps
25− demotePathSeg :: Sing (ps :: PathSegment) -> JSONPathElement
28+ demotePathSeg :: Sing (ps :: PathSegment) -> DemotedPathSegment
26− demotePathSeg (SKey s) = Key $ T.pack $ withKnownSymbol s $ symbolVal s
29+ demotePathSeg (SKey s) = DKey $ T.pack $ withKnownSymbol s $ symbolVal s
27− demotePathSeg (SIx n) = Index $ withKnownNat n $ fromIntegral $ natVal n
30+ demotePathSeg (SIx n) = DIx $ withKnownNat n $ fromIntegral $ natVal n
28
31
29−demotedPathToText :: JSONPath -> JSONPathText
32+demotedPathToText :: [DemotedPathSegment] -> JSONPath
30−demotedPathToText = JSONPathText . F.foldl' renderPathSegment ""
33+demotedPathToText = JSONPath . F.foldl' renderPathSegment ""
31 where
34 where
32− renderPathSegment acc (Key t) = acc <> "." <> t
35+ renderPathSegment acc (DKey t) = acc <> "." <> t
33− renderPathSegment acc (Index n) = acc <> "[" <> T.pack (show n) <> "]"
36+ renderPathSegment acc (DIx n) = acc <> "[" <> T.pack (show n) <> "]"
34
37
35−pathToText :: Sing (ps :: [PathSegment]) -> JSONPathText
38+pathToText :: Sing (ps :: [PathSegment]) -> JSONPath
36pathToText = demotedPathToText . demotePath
39pathToText = demotedPathToText . demotePath
src/Data/Schematic/Schema.hs+2−47
@@ -1,7 +1,6 @@
1{-# LANGUAGE AllowAmbiguousTypes #-}
1{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# LANGUAGE CPP #-}
3−{-# LANGUAGE OverloadedLists #-}
2+{-# LANGUAGE OverloadedLists #-}
4−{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE OverloadedStrings #-}
5{-# OPTIONS_GHC -fprint-explicit-kinds #-}
4{-# OPTIONS_GHC -fprint-explicit-kinds #-}
6
5
7module Data.Schematic.Schema where
6module Data.Schematic.Schema where
@@ -180,63 +179,27 @@ instance SingKind NumberConstraint where
180
179
181data ArrayConstraint
180data ArrayConstraint
182 = AEq Nat
181 = AEq Nat
183− | AGt Nat
184− | AGe Nat
185− | ALt Nat
186− | ALe Nat
187 deriving (Generic)
182 deriving (Generic)
188
183
189data DemotedArrayConstraint
184data DemotedArrayConstraint
190 = DAEq Integer
185 = DAEq Integer
191− | DAGt Integer
192− | DAGe Integer
193− | DALt Integer
194− | DALe Integer
195 deriving (Generic, Eq, Show)
186 deriving (Generic, Eq, Show)
196
187
197data instance Sing (ac :: ArrayConstraint) where
188data instance Sing (ac :: ArrayConstraint) where
198 SAEq :: Sing n -> Sing ('AEq n)
189 SAEq :: Sing n -> Sing ('AEq n)
199− SAGt :: Sing n -> Sing ('AGt n)
200− SAGe :: Sing n -> Sing ('AGe n)
201− SALt :: Sing n -> Sing ('ALt n)
202− SALe :: Sing n -> Sing ('ALe n)
203
190
204instance KnownNat n => SingI ('AEq n) where sing = SAEq sing
191instance KnownNat n => SingI ('AEq n) where sing = SAEq sing
205−instance KnownNat n => SingI ('AGt n) where sing = SAGt sing
206−instance KnownNat n => SingI ('AGe n) where sing = SAGe sing
207−instance KnownNat n => SingI ('ALt n) where sing = SALt sing
208−instance KnownNat n => SingI ('ALe n) where sing = SALe sing
209
192
210instance Eq (Sing ('AEq n)) where _ == _ = True
193instance Eq (Sing ('AEq n)) where _ == _ = True
211−instance Eq (Sing ('AGt n)) where _ == _ = True
212−instance Eq (Sing ('AGe n)) where _ == _ = True
213−instance Eq (Sing ('ALt n)) where _ == _ = True
214−instance Eq (Sing ('ALe n)) where _ == _ = True
215
194
216instance SingKind ArrayConstraint where
195instance SingKind ArrayConstraint where
217 type Demote ArrayConstraint = DemotedArrayConstraint
196 type Demote ArrayConstraint = DemotedArrayConstraint
218 fromSing = \case
197 fromSing = \case
219 SAEq n -> withKnownNat n (DAEq . fromIntegral $ natVal n)
198 SAEq n -> withKnownNat n (DAEq . fromIntegral $ natVal n)
220− SAGt n -> withKnownNat n (DAGt . fromIntegral $ natVal n)
221− SAGe n -> withKnownNat n (DAGe . fromIntegral $ natVal n)
222− SALt n -> withKnownNat n (DALt . fromIntegral $ natVal n)
223− SALe n -> withKnownNat n (DALe . fromIntegral $ natVal n)
224 toSing = \case
199 toSing = \case
225 DAEq n -> case someNatVal n of
200 DAEq n -> case someNatVal n of
226 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SAEq (SNat :: Sing n))
201 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SAEq (SNat :: Sing n))
227 Nothing -> error "Negative singleton nat"
202 Nothing -> error "Negative singleton nat"
228− DAGt n -> case someNatVal n of
229− Just (SomeNat (_ :: Proxy n)) -> SomeSing (SAGt (SNat :: Sing n))
230− Nothing -> error "Negative singleton nat"
231− DAGe n -> case someNatVal n of
232− Just (SomeNat (_ :: Proxy n)) -> SomeSing (SAGe (SNat :: Sing n))
233− Nothing -> error "Negative singleton nat"
234− DALt n -> case someNatVal n of
235− Just (SomeNat (_ :: Proxy n)) -> SomeSing (SALt (SNat :: Sing n))
236− Nothing -> error "Negative singleton nat"
237− DALe n -> case someNatVal n of
238− Just (SomeNat (_ :: Proxy n)) -> SomeSing (SALe (SNat :: Sing n))
239− Nothing -> error "Negative singleton nat"
240
203
241data Schema
204data Schema
242 = SchemaText [TextConstraint]
205 = SchemaText [TextConstraint]
@@ -413,16 +376,8 @@ instance Show (JsonRepr 'SchemaNull) where show _ = "ReprNull"
413instance Show (JsonRepr s) => Show (JsonRepr ('SchemaArray acs s)) where
376instance Show (JsonRepr s) => Show (JsonRepr ('SchemaArray acs s)) where
414 show (ReprArray v) = "ReprArray " P.++ show v
377 show (ReprArray v) = "ReprArray " P.++ show v
415
378
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
423instance V.RecAll FieldRepr fs Show => Show (JsonRepr ('SchemaObject fs)) where
379instance V.RecAll FieldRepr fs Show => Show (JsonRepr ('SchemaObject fs)) where
424 show (ReprObject fs) = "ReprObject " P.++ show fs
380 show (ReprObject fs) = "ReprObject " P.++ show fs
425−#endif
426
381
427instance Show (JsonRepr s) => Show (JsonRepr ('SchemaOptional s)) where
382instance Show (JsonRepr s) => Show (JsonRepr ('SchemaOptional s)) where
428 show (ReprOptional s) = "ReprOptional " P.++ show s
383 show (ReprOptional s) = "ReprOptional " P.++ show s
src/Data/Schematic/Schema.hs-boot−8
@@ -46,17 +46,9 @@ data DemotedNumberConstraint
46
46
47data ArrayConstraint
47data ArrayConstraint
48 = AEq Nat
48 = AEq Nat
49− | AGt Nat
50− | AGe Nat
51− | ALt Nat
52− | ALe Nat
53
49
54data DemotedArrayConstraint
50data DemotedArrayConstraint
55 = DAEq Integer
51 = DAEq Integer
56− | DAGt Integer
57− | DAGe Integer
58− | DALt Integer
59− | DALe Integer
60
52
61data Schema
53data Schema
62 = SchemaText [TextConstraint]
54 = SchemaText [TextConstraint]
src/Data/Schematic/Validation.hs+23−52
@@ -3,7 +3,6 @@ module Data.Schematic.Validation where
3import Control.Monad
3import Control.Monad
4import Control.Monad.Validation
4import Control.Monad.Validation
5import Data.Aeson
5import Data.Aeson
6−import Data.Aeson.Internal
7import Data.Aeson.Types
6import Data.Aeson.Types
8import Data.Foldable
7import Data.Foldable
9import Data.Functor.Identity
8import Data.Functor.Identity
@@ -50,51 +49,51 @@ isValidationError (ValidationError _) = True
50isValidationError _ = False
49isValidationError _ = False
51
50
52validateTextConstraint
51validateTextConstraint
53− :: JSONPathText
52+ :: JSONPath
54 -> Text
53 -> Text
55 -> Sing (tcs :: TextConstraint)
54 -> Sing (tcs :: TextConstraint)
56 -> Validation ()
55 -> Validation ()
57−validateTextConstraint (JSONPathText path) t = \case
56+validateTextConstraint (JSONPath path) t = \case
58 STEq n -> do
57 STEq n -> do
59 let
58 let
60 nlen = withKnownNat n $ natVal n
59 nlen = withKnownNat n $ natVal n
61 predicate = nlen == (fromIntegral $ T.length t)
60 predicate = nlen == (fromIntegral $ T.length t)
62− errMsg = "length should be == " <> T.pack (show nlen)
61+ errMsg = "length of " <> path <> " should be == " <> T.pack (show nlen)
63 warn = vWarning $ mmSingleton path (pure errMsg)
62 warn = vWarning $ mmSingleton path (pure errMsg)
64 unless predicate warn
63 unless predicate warn
65 STLt n -> do
64 STLt n -> do
66 let
65 let
67 nlen = withKnownNat n $ natVal n
66 nlen = withKnownNat n $ natVal n
68 predicate = nlen > (fromIntegral $ T.length t)
67 predicate = nlen > (fromIntegral $ T.length t)
69− errMsg = "length should be < " <> T.pack (show nlen)
68+ errMsg = "length of " <> path <> " should be < " <> T.pack (show nlen)
70 warn = vWarning $ mmSingleton path (pure errMsg)
69 warn = vWarning $ mmSingleton path (pure errMsg)
71 unless predicate warn
70 unless predicate warn
72 STLe n -> do
71 STLe n -> do
73 let
72 let
74 nlen = withKnownNat n $ natVal n
73 nlen = withKnownNat n $ natVal n
75 predicate = nlen >= (fromIntegral $ T.length t)
74 predicate = nlen >= (fromIntegral $ T.length t)
76− errMsg = "length should be <= " <> T.pack (show nlen)
75+ errMsg = "length of " <> path <> " should be <= " <> T.pack (show nlen)
77 warn = vWarning $ mmSingleton path (pure errMsg)
76 warn = vWarning $ mmSingleton path (pure errMsg)
78 unless predicate warn
77 unless predicate warn
79 STGt n -> do
78 STGt n -> do
80 let
79 let
81 nlen = withKnownNat n $ natVal n
80 nlen = withKnownNat n $ natVal n
82 predicate = nlen < (fromIntegral $ T.length t)
81 predicate = nlen < (fromIntegral $ T.length t)
83− errMsg = "length should be > " <> T.pack (show nlen)
82+ errMsg = "length of " <> path <> " should be > " <> T.pack (show nlen)
84 warn = vWarning $ mmSingleton path (pure errMsg)
83 warn = vWarning $ mmSingleton path (pure errMsg)
85 unless predicate warn
84 unless predicate warn
86 STGe n -> do
85 STGe n -> do
87 let
86 let
88 nlen = withKnownNat n $ natVal n
87 nlen = withKnownNat n $ natVal n
89 predicate = nlen <= (fromIntegral $ T.length t)
88 predicate = nlen <= (fromIntegral $ T.length t)
90− errMsg = "length should be >= " <> T.pack (show nlen)
89+ errMsg = "length of " <> path <> " should be >= " <> T.pack (show nlen)
91 warn = vWarning $ mmSingleton path (pure errMsg)
90 warn = vWarning $ mmSingleton path (pure errMsg)
92 unless predicate warn
91 unless predicate warn
93 STRegex r -> do
92 STRegex r -> do
94 let
93 let
95 regex = withKnownSymbol r $ fromSing r
94 regex = withKnownSymbol r $ fromSing r
96 predicate = matchTest (makeRegex (T.unpack regex) :: Regex) (T.unpack t)
95 predicate = matchTest (makeRegex (T.unpack regex) :: Regex) (T.unpack t)
97− errMsg = "must match " <> regex
96+ errMsg = path <> " must match " <> regex
98 warn = vWarning $ mmSingleton path (pure errMsg)
97 warn = vWarning $ mmSingleton path (pure errMsg)
99 unless predicate warn
98 unless predicate warn
100 STEnum ss -> do
99 STEnum ss -> do
@@ -102,97 +101,69 @@ validateTextConstraint (JSONPathText path) t = \case
102 matching :: Sing (s :: [Symbol]) -> Bool
101 matching :: Sing (s :: [Symbol]) -> Bool
103 matching SNil = False
102 matching SNil = False
104 matching (SCons s@SSym fs) = T.pack (symbolVal s) == t || matching fs
103 matching (SCons s@SSym fs) = T.pack (symbolVal s) == t || matching fs
105− errMsg = "must be one of " <> T.pack (show (fromSing ss))
104+ errMsg = path <> " must be one of " <> T.pack (show (fromSing ss))
106 warn = vWarning $ mmSingleton path (pure errMsg)
105 warn = vWarning $ mmSingleton path (pure errMsg)
107 unless (matching ss) warn
106 unless (matching ss) warn
108
107
109validateNumberConstraint
108validateNumberConstraint
110− :: JSONPathText
109+ :: JSONPath
111 -> Scientific
110 -> Scientific
112 -> Sing (tcs :: NumberConstraint)
111 -> Sing (tcs :: NumberConstraint)
113 -> Validation ()
112 -> Validation ()
114−validateNumberConstraint (JSONPathText path) num = \case
113+validateNumberConstraint (JSONPath path) num = \case
115 SNEq n -> do
114 SNEq n -> do
116 let
115 let
117 nlen = withKnownNat n $ natVal n
116 nlen = withKnownNat n $ natVal n
118 predicate = fromIntegral nlen == num
117 predicate = fromIntegral nlen == num
119− errMsg = "should be == " <> T.pack (show nlen)
118+ errMsg = path <> " should be == " <> T.pack (show nlen)
120 warn = vWarning $ mmSingleton path (pure errMsg)
119 warn = vWarning $ mmSingleton path (pure errMsg)
121 unless predicate warn
120 unless predicate warn
122 SNGt n -> do
121 SNGt n -> do
123 let
122 let
124 nlen = withKnownNat n $ natVal n
123 nlen = withKnownNat n $ natVal n
125 predicate = num > fromIntegral nlen
124 predicate = num > fromIntegral nlen
126− errMsg = "should be > " <> T.pack (show nlen)
125+ errMsg = path <> " should be > " <> T.pack (show nlen)
127 warn = vWarning $ mmSingleton path (pure errMsg)
126 warn = vWarning $ mmSingleton path (pure errMsg)
128 unless predicate warn
127 unless predicate warn
129 SNGe n -> do
128 SNGe n -> do
130 let
129 let
131 nlen = withKnownNat n $ natVal n
130 nlen = withKnownNat n $ natVal n
132 predicate = num >= fromIntegral nlen
131 predicate = num >= fromIntegral nlen
133− errMsg = "should be >= " <> T.pack (show nlen)
132+ errMsg = path <> " should be >= " <> T.pack (show nlen)
134 warn = vWarning $ mmSingleton path (pure errMsg)
133 warn = vWarning $ mmSingleton path (pure errMsg)
135 unless predicate warn
134 unless predicate warn
136 SNLt n -> do
135 SNLt n -> do
137 let
136 let
138 nlen = withKnownNat n $ natVal n
137 nlen = withKnownNat n $ natVal n
139 predicate = num < fromIntegral nlen
138 predicate = num < fromIntegral nlen
140− errMsg = "should be < " <> T.pack (show nlen)
139+ errMsg = path <> " should be < " <> T.pack (show nlen)
141 warn = vWarning $ mmSingleton path (pure errMsg)
140 warn = vWarning $ mmSingleton path (pure errMsg)
142 unless predicate warn
141 unless predicate warn
143 SNLe n -> do
142 SNLe n -> do
144 let
143 let
145 nlen = withKnownNat n $ natVal n
144 nlen = withKnownNat n $ natVal n
146 predicate = num <= fromIntegral nlen
145 predicate = num <= fromIntegral nlen
147− errMsg = "should be <= " <> T.pack (show nlen)
146+ errMsg = path <> " should be <= " <> T.pack (show nlen)
148 warn = vWarning $ mmSingleton path (pure errMsg)
147 warn = vWarning $ mmSingleton path (pure errMsg)
149 unless predicate warn
148 unless predicate warn
150
149
151validateArrayConstraint
150validateArrayConstraint
152− :: JSONPathText
151+ :: JSONPath
153 -> V.Vector a
152 -> V.Vector a
154 -> Sing (tcs :: ArrayConstraint)
153 -> Sing (tcs :: ArrayConstraint)
155 -> Validation ()
154 -> Validation ()
156−validateArrayConstraint (JSONPathText path) v = \case
155+validateArrayConstraint (JSONPath path) v = \case
157 SAEq n -> do
156 SAEq n -> do
158 let
157 let
159 nlen = withKnownNat n $ natVal n
158 nlen = withKnownNat n $ natVal n
160 predicate = nlen == fromIntegral (V.length v)
159 predicate = nlen == fromIntegral (V.length v)
161− errMsg = "length should be == " <> T.pack (show nlen)
160+ errMsg = "length of " <> path <> " 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)
190 warn = vWarning $ mmSingleton path (pure errMsg)
161 warn = vWarning $ mmSingleton path (pure errMsg)
191 unless predicate warn
162 unless predicate warn
192
163
193validateJsonRepr
164validateJsonRepr
194 :: Sing schema
165 :: Sing schema
195− -> JSONPath
166+ -> [DemotedPathSegment]
196 -> JsonRepr schema
167 -> JsonRepr schema
197 -> Validation ()
168 -> Validation ()
198validateJsonRepr sschema dpath jr = case jr of
169validateJsonRepr sschema dpath jr = case jr of
@@ -226,7 +197,7 @@ validateJsonRepr sschema dpath jr = case jr of
226 process cs
197 process cs
227 process acs
198 process acs
228 for_ (V.indexed v) $ \(ix, jr') -> do
199 for_ (V.indexed v) $ \(ix, jr') -> do
229− let newPath = dpath <> pure (Index $ fromIntegral ix)
200+ let newPath = dpath <> pure (DIx $ fromIntegral ix)
230 validateJsonRepr s newPath jr'
201 validateJsonRepr s newPath jr'
231 ReprOptional d -> case sschema of
202 ReprOptional d -> case sschema of
232 SSchemaOptional ss -> case d of
203 SSchemaOptional ss -> case d of
@@ -238,7 +209,7 @@ validateJsonRepr sschema dpath jr = case jr of
238 go :: Rec FieldRepr (ts :: [(Symbol, Schema)] ) -> Validation ()
209 go :: Rec FieldRepr (ts :: [(Symbol, Schema)] ) -> Validation ()
239 go RNil = pure ()
210 go RNil = pure ()
240 go (f@(FieldRepr d) :& ftl) = do
211 go (f@(FieldRepr d) :& ftl) = do
241− let newPath = dpath <> [Key (knownFieldName f)]
212+ let newPath = dpath <> [DKey (knownFieldName f)]
242 validateJsonRepr (knownFieldSchema f) newPath d
213 validateJsonRepr (knownFieldSchema f) newPath d
243 go ftl
214 go ftl
244 ReprUnion _ -> pure () -- FIXME
215 ReprUnion _ -> pure () -- FIXME
@@ -250,7 +221,7 @@ validateJsonRepr sschema dpath jr = case jr of
250 -- fail "impossible to produce subUnion, please report this as a bug"
221 -- fail "impossible to produce subUnion, please report this as a bug"
251 -- Just x -> do
222 -- Just x -> do
252 -- let
223 -- let
253− -- JSONPathText path = demotedPathToText dpath
224+ -- JSONPath path = demotedPathToText dpath
254 -- case stl of
225 -- case stl of
255 -- SNil -> void $ vWarning $ mmSingleton path
226 -- SNil -> void $ vWarning $ mmSingleton path
256 -- $ pure "union handling error, please report this as bug"
227 -- $ 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.yaml+4−5
@@ -1,6 +1,5 @@
1−resolver: lts-14.22
1+resolver: lts-12.0
2extra-deps:
2extra-deps:
3−- hjsonpointer-1.4.0@rev:0
3+ - hjsonpointer-1.4.0@rev:0
4−- hjsonschema-1.9.0@rev:0
4+ - hjsonschema-1.9.0@rev:0
5−- git: https://github.com/typeable/validationt.git
5+ - validationt-0.2.1.0
6− commit: 97fea97c4015ab5e99f3efb2c73e1fef4b8857d8
test/JsonSchemaSpec.hs−58
@@ -10,7 +10,6 @@ module JsonSchemaSpec (spec, main) where
10import Data.Aeson as J
10import Data.Aeson as J
11import Data.Maybe
11import Data.Maybe
12import Data.Proxy
12import Data.Proxy
13−import Data.ByteString.Lazy as B
14import Data.Schematic
13import Data.Schematic
15import Data.Vinyl
14import Data.Vinyl
16import JSONSchema.Draft4 as D4
15import JSONSchema.Draft4 as D4
@@ -32,27 +31,6 @@ exampleData = withRepr @SchemaExample $
32 :& field @"bar" (pure (ReprText "foo"))
31 :& field @"bar" (pure (ReprText "foo"))
33 :& RNil
32 :& RNil
34
33
35−type SchemaArrayExample = 'SchemaObject
36− '[ '("a1", 'SchemaArray '[ 'AGt 1 ] ('SchemaNumber '[]))
37− , '("a2", 'SchemaArray '[ 'AGe 1 ] ('SchemaNumber '[]))
38− , '("a3", 'SchemaArray '[ 'ALt 1 ] ('SchemaNumber '[]))
39− , '("a4", 'SchemaArray '[ 'ALe 1 ] ('SchemaNumber '[]))
40− ]
41−
42−type SchemaNumberExample = 'SchemaObject
43− '[ '("n1", 'SchemaNumber '[ 'NGt 1 ])
44− , '("n2", 'SchemaNumber '[ 'NGe 1 ])
45− , '("n3", 'SchemaNumber '[ 'NLt 1 ])
46− , '("n4", 'SchemaNumber '[ 'NLe 1 ])
47− ]
48−
49−type SchemaTextExample = 'SchemaObject
50− '[ '("t1", 'SchemaText '[ 'TGt 1 ])
51− , '("t2", 'SchemaText '[ 'TGe 1 ])
52− , '("t3", 'SchemaText '[ 'TLt 1 ])
53− , '("t4", 'SchemaText '[ 'TLe 1 ])
54− ]
55−
56spec :: Spec
34spec :: Spec
57spec = do
35spec = do
58 it "validates simple schema" $ do
36 it "validates simple schema" $ do
@@ -60,42 +38,6 @@ spec = do
60 fetchHTTPAndValidate schema (toJSON exampleData) >>= \case
38 fetchHTTPAndValidate schema (toJSON exampleData) >>= \case
61 Left _ -> fail "failed to validate test example"
39 Left _ -> fail "failed to validate test example"
62 Right _ -> pure ()
40 Right _ -> pure ()
63− it "validates schema with arrays" $ do
64− let
65− schema = D4.SchemaWithURI (fromJust $ toJsonSchema (Proxy @SchemaArrayExample)) Nothing
66− obj = withRepr @SchemaArrayExample $
67− field @"a1" [ReprNumber 13, ReprNumber 13]
68− :& field @"a2" [ReprNumber 13]
69− :& field @"a3" []
70− :& field @"a4" [ReprNumber 13]
71− :& RNil
72− fetchHTTPAndValidate schema (toJSON obj) >>= \case
73− Left e -> fail "failed to validate test example"
74− Right _ -> pure ()
75− it "validates schema with numbers" $ do
76− let
77− schema = D4.SchemaWithURI (fromJust $ toJsonSchema (Proxy @SchemaNumberExample)) Nothing
78− obj = withRepr @SchemaNumberExample $
79− field @"n1" 1.1
80− :& field @"n2" 1
81− :& field @"n3" 0.9
82− :& field @"n4" 1.0
83− :& RNil
84− fetchHTTPAndValidate schema (toJSON obj) >>= \case
85− Left e -> fail "failed to validate test example"
86− Right _ -> pure ()
87− it "validates schema with strings" $ do
88− let
89− schema = D4.SchemaWithURI (fromJust $ toJsonSchema (Proxy @SchemaTextExample)) Nothing
90− obj = withRepr @SchemaTextExample $
91− field @"t1" "11"
92− :& field @"t2" "1"
93− :& field @"t3" ""
94− :& field @"t4" "1"
95− :& RNil
96− fetchHTTPAndValidate schema (toJSON obj) >>= \case
97− Left e -> fail "failed to validate test example"
98− Right _ -> pure ()
99
41
100main :: IO ()
42main :: IO ()
101main = hspec spec
43main = hspec spec