git.iko.soy/typeable/schematic
on master help sign in
13 files changed+300−76
since splitsnapshots
unifiedsplit
ChangeLog.md+16 release+16−8 schematic.cabal+10−5 src/Data/Schematic/DSL.hs+11−2 src/Data/Schematic/JsonSchema.hs+21−9 src/Data/Schematic/Migration.hs+10−2 src/Data/Schematic/Path.hs+17−20 src/Data/Schematic/Schema.hs+69−3 src/Data/Schematic/Schema.hs-boot+8 src/Data/Schematic/Validation.hs+52−23 stack-13.21.yaml+7 stack.yaml+5−4 test/JsonSchemaSpec.hs+58
ChangeLog.md+16
@@ -1,5 +1,21 @@
11# Revision history for schematic
22
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
15+
16+GHC 8.6, json generation by schema definition, validation bug fixes, better
17+parsing error messages.
18+
319## 0.4.3.0 -- 2018-07-12
420
521GHC 8.4 support, dropping support for older GHC versions
release+16−8
@@ -4,6 +4,12 @@ set -o xtrace
44
55dist=`stack path --dist-dir --stack-yaml ./stack.yaml 2> /dev/null`
66
7+rootdir=`pwd`
8+
9+cabalfile=`ls *.cabal`
10+packagename="${cabalfile%%.*}"
11+version=`grep '^version:' schematic.cabal | rev | cut -d" " -f1 | rev`
12+
713echo -e "\033[1;36mTesting library...\033[0m"
814stack test 2> /dev/null
915
@@ -18,17 +24,19 @@ if [ "$?" -eq "0" ]; then
1824 read -p "Hackage username: " username
1925 read -p "Hackage password: " -s password
2026 echo ""
21− cabal upload -u $username -p $password dist/$1-$2.tar.gz
27+ cabal upload -u $username -p $password dist/$packagename-$version.tar.gz
2228
23− docdir=$dist/doc/html
24− cd $docdir
25− doc=$1-$2-docs
29+ docdir=`find .stack-work -name "$packagename-$version-docs"`
2630
27− echo -e "Compressing documentation from \033[1;34m$docdir\033[0m for \033[1;35m$1\033[0m-\033[1;33m$2\033[1;30m"
28− cp -r $1 $doc
29− tar -c -v -z --format=ustar -f $doc.tar.gz $doc
31+ echo -e "Compressing documentation from \033[1;34m$docdir\033[0m for \033[1;35m$packagename\033[0m-\033[1;33m$version\033[1;30m"
32+ tar -c -v -z --format=ustar -f $docdir.tar.gz $docdir
3033 echo -e "\033[1;32mUploading documentation to Hackage...\033[0m"
31− curl -X PUT -H 'Content-Type: application/x-tar' -H 'Content-Encoding: gzip' --data-binary "@$doc.tar.gz" "https://$username:$password@hackage.haskell.org/package/$1-$2/docs"
34+ cd $docdir
35+ cd ..
36+ curl -X PUT -H 'Content-Type: application/x-tar' -H 'Content-Encoding: gzip' --data-binary "$packagename-$version-docs.tar.gz" "https://$username:$password@hackage.haskell.org/package/$packagename-$version/candidate/docs"
37+ open "https://hackage.haskell.org/package/$packagename-$version/candidate/"
38+ cd $rootdir
39+ echo "To publish the candidate, use 'cabal upload --publish'."
3240 exit $?
3341else
3442 echo -e "\033[1;31mNot in a stack-powered project\033[0m"
schematic.cabal+10−5
@@ -1,6 +1,7 @@
11name: schematic
2−version: 0.4.3.0
2+version: 0.6.0.0
33synopsis: JSON-biased spec and validation tool
4+description: 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.
45license: BSD3
56license-file: LICENSE
67author: Denis Redozubov
@@ -9,7 +10,7 @@ homepage: http://github.com/typeable/schematic
910Bug-reports: http://github.com/typeable/schematic/issues/
1011category: Data
1112build-type: Simple
12−extra-source-files: ChangeLog.md
13+extra-source-files: ChangeLog.md, README.md
1314cabal-version: >=1.10
1415
1516library
@@ -64,9 +65,9 @@ library
6465 , TypeOperators
6566 , TypeSynonymInstances
6667 , UndecidableInstances
67− build-depends: base >=4.11 && <4.12
68+ build-depends: base >=4.11 && <5
6869 , bytestring
69− , aeson >= 1
70+ , aeson >= 1.4.3.0 && < 1.6
7071 , containers
7172 , hjsonschema
7273 , mtl
@@ -94,7 +95,7 @@ test-suite spec
9495 default-language: Haskell2010
9596 build-depends: HUnit
9697 , aeson >= 1
97− , base >=4.11 && <4.12
98+ , base >=4.11 && <4.13
9899 , bytestring
99100 , containers
100101 , hjsonschema
@@ -117,3 +118,7 @@ test-suite spec
117118 , HelpersSpec
118119 , LensSpec
119120 , 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 @@
11{-# LANGUAGE AllowAmbiguousTypes #-}
2+{-# LANGUAGE CPP #-}
23
34module Data.Schematic.DSL where
45
@@ -17,11 +18,19 @@ import Data.Vinyl
1718import Data.Vinyl.Functor
1819
1920
21+#if MIN_VERSION_base(4,12,0)
2022type Constructor a
21− = forall fields b. (fields ~ FieldsOf a, FSubset fields b (FImage fields b))
23+ = forall fields b
24+ . (fields ~ FieldsOf a, FSubset fields b (FImage fields b), RMap fields)
2225 => Rec (Tagged fields :. FieldRepr) b
2326 -> 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
2534withRepr :: Constructor a
2635withRepr = ReprObject . rmap (unTagged . getCompose) . fcast
2736
src/Data/Schematic/JsonSchema.hs+21−9
@@ -30,13 +30,13 @@ textConstraint :: DemotedTextConstraint -> State D4.Schema ()
3030textConstraint (DTEq n) = modify $ \s -> s
3131 { _schemaMinLength = pure $ fromIntegral n
3232 , _schemaMaxLength = pure $ fromIntegral n }
33−textConstraint (DTLt n) = modify $ \s -> s
34− { _schemaMaxLength = pure . fromIntegral $ n + 1 }
3533textConstraint (DTLe n) = modify $ \s -> s
3634 { _schemaMaxLength = pure . fromIntegral $ n }
37−textConstraint (DTGt n) =
35+textConstraint (DTLt n) =
3836 let n' = if n == 0 then 0 else n - 1
39− in modify $ \s -> s { _schemaMinLength = pure . fromIntegral $ n' }
37+ in modify $ \s -> s { _schemaMaxLength = pure . fromIntegral $ n' }
38+textConstraint (DTGt n) = modify $ \s -> s
39+ { _schemaMinLength = pure . fromIntegral $ n + 1 }
4040textConstraint (DTGe n) = modify $ \s -> s
4141 { _schemaMinLength = pure . fromIntegral $ n }
4242textConstraint (DTRegex r) = modify $ \s -> s { _schemaPattern = pure r }
@@ -48,18 +48,30 @@ numberConstraint :: DemotedNumberConstraint -> State D4.Schema ()
4848numberConstraint (DNLe n) = modify $ \s -> s
4949 { _schemaMaximum = pure . fromIntegral $ n }
5050numberConstraint (DNLt n) = modify $ \s -> s
51− { _schemaMaximum = pure . fromIntegral $ n + 1 }
51+ { _schemaMaximum = pure . fromIntegral $ n
52+ , _schemaExclusiveMaximum = pure True }
5253numberConstraint (DNGt n) = modify $ \s -> s
54+ { _schemaMinimum = pure . fromIntegral $ n
55+ , _schemaExclusiveMinimum = pure True }
56+numberConstraint (DNGe n) = modify $ \s -> s
5357 { _schemaMinimum = pure . fromIntegral $ n }
54−numberConstraint (DNGe n) =
55− let n' = if n == 0 then 0 else n - 1
56− in modify $ \s -> s { _schemaMinimum = pure . fromIntegral $ n' }
5758numberConstraint (DNEq n) = modify $ \s -> s
5859 { _schemaMinimum = pure $ fromIntegral n
5960 , _schemaMaximum = pure $ fromIntegral n }
6061
6162arrayConstraint :: DemotedArrayConstraint -> State D4.Schema ()
62−arrayConstraint (DAEq _) = pure ()
63+arrayConstraint (DALe n) = modify $ \s -> s
64+ { _schemaMaxItems = pure . fromIntegral $ n }
65+arrayConstraint (DALt n) =
66+ let n' = if n == 0 then 0 else n - 1
67+ in modify $ \s -> s { _schemaMaxItems = pure . fromIntegral $ n' }
68+arrayConstraint (DAGt n) = modify $ \s -> s
69+ { _schemaMinItems = pure . fromIntegral $ n + 1 }
70+arrayConstraint (DAGe n) = modify $ \s -> s
71+ { _schemaMinItems = pure . fromIntegral $ n }
72+arrayConstraint (DAEq n) = modify $ \s -> s
73+ { _schemaMinItems = pure $ fromIntegral n
74+ , _schemaMaxItems = pure $ fromIntegral n }
6375
6476toJsonSchema
6577 :: forall proxy schema
src/Data/Schematic/Migration.hs+10−2
@@ -1,5 +1,6 @@
11{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# LANGUAGE TemplateHaskell #-}
2+{-# LANGUAGE CPP #-}
3+{-# LANGUAGE TemplateHaskell #-}
34
45module Data.Schematic.Migration where
56
@@ -8,7 +9,7 @@ import Data.Schematic.DSL
89import Data.Schematic.Lens
910import Data.Schematic.Path
1011import Data.Schematic.Schema
11−import Data.Singletons.Prelude hiding (All, (:.))
12+import Data.Singletons.Prelude hiding ((:.), All)
1213import Data.Singletons.TypeLits
1314import Data.Tagged
1415import Data.Vinyl
@@ -156,10 +157,17 @@ data MList :: (Type -> Type) -> [Schema] -> Type where
156157
157158infixr 7 :&&
158159
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
159166migrateObject
160167 :: forall m fs fh. (FSubset fs fs (FImage fs fs), Monad m)
161168 => (Rec (Tagged fs :. FieldRepr) fh -> m (Rec (Tagged fs :. FieldRepr) fs))
162169 -> Tagged ('SchemaObject fs) (JsonRepr ('SchemaObject fh) -> m (JsonRepr ('SchemaObject fs)))
170+#endif
163171migrateObject f = Tagged $ \(ReprObject r) -> do
164172 res <- f $ rmap (Compose . Tagged) r
165173 pure $ withRepr @('SchemaObject fs) res
src/Data/Schematic/Path.hs+17−20
@@ -4,36 +4,33 @@ import Data.Foldable as F
44import Data.Singletons.Prelude
55import Data.Singletons.TypeLits
66import Data.Text as T
7+import Data.Aeson.Internal
78
89
9−data PathSegment = Key Symbol | Ix Nat
10−
11−data instance Sing (jp :: PathSegment) where
12− SKey :: (SingI k) => Sing (k :: Symbol) -> Sing ('Key k)
13− SIx :: (SingI n) => Sing (n :: Nat) -> Sing ('Ix n)
14−
15−data DemotedPathSegment = DKey Text | DIx Integer
10+newtype JSONPathText = JSONPathText Text
1611 deriving (Show)
1712
18−-- | Textual representation of json path.
19−newtype JSONPath = JSONPath Text
20− deriving (Show)
13+data PathSegment = PathKey Symbol | PathIx Nat
14+
15+data instance Sing (jp :: PathSegment) where
16+ SKey :: (SingI k) => Sing (k :: Symbol) -> Sing ('PathKey k)
17+ SIx :: (SingI n) => Sing (n :: Nat) -> Sing ('PathIx n)
2118
22−demotePath :: Sing (ps :: [PathSegment]) -> [DemotedPathSegment]
19+demotePath :: Sing (ps :: [PathSegment]) -> JSONPath
2320demotePath = go []
2421 where
25− go :: [DemotedPathSegment] -> Sing (ps :: [PathSegment]) -> [DemotedPathSegment]
22+ go :: JSONPath -> Sing (ps :: [PathSegment]) -> JSONPath
2623 go acc SNil = acc
2724 go acc (SCons p ps) = go (acc ++ [demotePathSeg p]) ps
28− demotePathSeg :: Sing (ps :: PathSegment) -> DemotedPathSegment
29− demotePathSeg (SKey s) = DKey $ T.pack $ withKnownSymbol s $ symbolVal s
30− demotePathSeg (SIx n) = DIx $ withKnownNat n $ fromIntegral $ natVal n
25+ demotePathSeg :: Sing (ps :: PathSegment) -> JSONPathElement
26+ demotePathSeg (SKey s) = Key $ T.pack $ withKnownSymbol s $ symbolVal s
27+ demotePathSeg (SIx n) = Index $ withKnownNat n $ fromIntegral $ natVal n
3128
32−demotedPathToText :: [DemotedPathSegment] -> JSONPath
33−demotedPathToText = JSONPath . F.foldl' renderPathSegment ""
29+demotedPathToText :: JSONPath -> JSONPathText
30+demotedPathToText = JSONPathText . F.foldl' renderPathSegment ""
3431 where
35− renderPathSegment acc (DKey t) = acc <> "." <> t
36− renderPathSegment acc (DIx n) = acc <> "[" <> T.pack (show n) <> "]"
32+ renderPathSegment acc (Key t) = acc <> "." <> t
33+ renderPathSegment acc (Index n) = acc <> "[" <> T.pack (show n) <> "]"
3734
38−pathToText :: Sing (ps :: [PathSegment]) -> JSONPath
35+pathToText :: Sing (ps :: [PathSegment]) -> JSONPathText
3936pathToText = demotedPathToText . demotePath
src/Data/Schematic/Schema.hs+69−3
@@ -1,6 +1,7 @@
11{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# LANGUAGE OverloadedLists #-}
3−{-# LANGUAGE OverloadedStrings #-}
2+{-# LANGUAGE CPP #-}
3+{-# LANGUAGE OverloadedLists #-}
4+{-# LANGUAGE OverloadedStrings #-}
45{-# OPTIONS_GHC -fprint-explicit-kinds #-}
56
67module Data.Schematic.Schema where
@@ -12,8 +13,8 @@ import Data.Aeson.Types as J
1213import Data.HashMap.Strict as H
1314import Data.Kind
1415import Data.Maybe
15−import Data.Schematic.Instances ()
1616import Data.Schematic.Generator
17+import Data.Schematic.Instances ()
1718import Data.Scientific
1819import Data.Singletons.Prelude.List hiding (All, Union)
1920import Data.Singletons.TH
@@ -179,27 +180,63 @@ instance SingKind NumberConstraint where
179180
180181data ArrayConstraint
181182 = AEq Nat
183+ | AGt Nat
184+ | AGe Nat
185+ | ALt Nat
186+ | ALe Nat
182187 deriving (Generic)
183188
184189data DemotedArrayConstraint
185190 = DAEq Integer
191+ | DAGt Integer
192+ | DAGe Integer
193+ | DALt Integer
194+ | DALe Integer
186195 deriving (Generic, Eq, Show)
187196
188197data instance Sing (ac :: ArrayConstraint) where
189198 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)
190203
191204instance 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
192209
193210instance 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
194215
195216instance SingKind ArrayConstraint where
196217 type Demote ArrayConstraint = DemotedArrayConstraint
197218 fromSing = \case
198219 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)
199224 toSing = \case
200225 DAEq n -> case someNatVal n of
201226 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SAEq (SNat :: Sing n))
202227 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"
203240
204241data Schema
205242 = SchemaText [TextConstraint]
@@ -368,17 +405,32 @@ instance Show (JsonRepr ('SchemaText cs)) where
368405instance Show (JsonRepr ('SchemaNumber cs)) where
369406 show (ReprNumber n) = "ReprNumber " P.++ show n
370407
408+instance Show (JsonRepr 'SchemaBoolean) where
409+ show (ReprBoolean n) = "ReprBoolean " P.++ show n
410+
371411instance Show (JsonRepr 'SchemaNull) where show _ = "ReprNull"
372412
373413instance Show (JsonRepr s) => Show (JsonRepr ('SchemaArray acs s)) where
374414 show (ReprArray v) = "ReprArray " P.++ show v
375415
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
376423instance V.RecAll FieldRepr fs Show => Show (JsonRepr ('SchemaObject fs)) where
377424 show (ReprObject fs) = "ReprObject " P.++ show fs
425+#endif
378426
379427instance Show (JsonRepr s) => Show (JsonRepr ('SchemaOptional s)) where
380428 show (ReprOptional s) = "ReprOptional " P.++ show s
381429
430+instance Show (Union JsonRepr (h ': tl))
431+ => Show (JsonRepr ('SchemaUnion (h ': tl))) where
432+ show (ReprUnion s) = "ReprUnion " P.++ show s
433+
382434instance Eq (Rec FieldRepr fs) => Eq (JsonRepr ('SchemaObject fs)) where
383435 ReprObject a == ReprObject b = a == b
384436
@@ -388,6 +440,9 @@ instance Eq (JsonRepr ('SchemaText cs)) where
388440instance Eq (JsonRepr ('SchemaNumber cs)) where
389441 ReprNumber a == ReprNumber b = a == b
390442
443+instance Eq (JsonRepr 'SchemaBoolean) where
444+ ReprBoolean a == ReprBoolean b = a == b
445+
391446instance Eq (JsonRepr 'SchemaNull) where
392447 ReprNull == ReprNull = True
393448
@@ -397,6 +452,10 @@ instance Eq (JsonRepr s) => Eq (JsonRepr ('SchemaArray as s)) where
397452instance Eq (JsonRepr s) => Eq (JsonRepr ('SchemaOptional s)) where
398453 ReprOptional a == ReprOptional b = a == b
399454
455+instance Eq (Union JsonRepr (h ': tl))
456+ => Eq (JsonRepr ('SchemaUnion (h ': tl))) where
457+ ReprUnion a == ReprUnion b = a == b
458+
400459instance Ord (Rec FieldRepr fs) => Ord (JsonRepr ('SchemaObject fs)) where
401460 ReprObject a `compare` ReprObject b = a `compare` b
402461
@@ -406,6 +465,9 @@ instance Ord (JsonRepr ('SchemaText cs)) where
406465instance Ord (JsonRepr ('SchemaNumber cs)) where
407466 ReprNumber a `compare` ReprNumber b = a `compare` b
408467
468+instance Ord (JsonRepr 'SchemaBoolean) where
469+ ReprBoolean a `compare` ReprBoolean b = a `compare` b
470+
409471instance Ord (JsonRepr 'SchemaNull) where
410472 compare _ _ = EQ
411473
@@ -415,6 +477,10 @@ instance Ord (JsonRepr s) => Ord (JsonRepr ('SchemaArray as s)) where
415477instance Ord (JsonRepr s) => Ord (JsonRepr ('SchemaOptional s)) where
416478 ReprOptional a `compare` ReprOptional b = a `compare` b
417479
480+instance Ord (Union JsonRepr (h ': tl))
481+ => Ord (JsonRepr ('SchemaUnion (h ': tl))) where
482+ ReprUnion a `compare` ReprUnion b = a `compare` b
483+
418484instance IsList (JsonRepr ('SchemaArray cs s)) where
419485 type Item (JsonRepr ('SchemaArray cs s)) = JsonRepr s
420486 fromList = ReprArray . GHC.Exts.fromList
src/Data/Schematic/Schema.hs-boot+8
@@ -46,9 +46,17 @@ data DemotedNumberConstraint
4646
4747data ArrayConstraint
4848 = AEq Nat
49+ | AGt Nat
50+ | AGe Nat
51+ | ALt Nat
52+ | ALe Nat
4953
5054data DemotedArrayConstraint
5155 = DAEq Integer
56+ | DAGt Integer
57+ | DAGe Integer
58+ | DALt Integer
59+ | DALe Integer
5260
5361data Schema
5462 = SchemaText [TextConstraint]
src/Data/Schematic/Validation.hs+52−23
@@ -3,6 +3,7 @@ module Data.Schematic.Validation where
33import Control.Monad
44import Control.Monad.Validation
55import Data.Aeson
6+import Data.Aeson.Internal
67import Data.Aeson.Types
78import Data.Foldable
89import Data.Functor.Identity
@@ -49,51 +50,51 @@ isValidationError (ValidationError _) = True
4950isValidationError _ = False
5051
5152validateTextConstraint
52− :: JSONPath
53+ :: JSONPathText
5354 -> Text
5455 -> Sing (tcs :: TextConstraint)
5556 -> Validation ()
56−validateTextConstraint (JSONPath path) t = \case
57+validateTextConstraint (JSONPathText path) t = \case
5758 STEq n -> do
5859 let
5960 nlen = withKnownNat n $ natVal n
6061 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)
6263 warn = vWarning $ mmSingleton path (pure errMsg)
6364 unless predicate warn
6465 STLt n -> do
6566 let
6667 nlen = withKnownNat n $ natVal n
6768 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)
6970 warn = vWarning $ mmSingleton path (pure errMsg)
7071 unless predicate warn
7172 STLe n -> do
7273 let
7374 nlen = withKnownNat n $ natVal n
7475 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)
7677 warn = vWarning $ mmSingleton path (pure errMsg)
7778 unless predicate warn
7879 STGt n -> do
7980 let
8081 nlen = withKnownNat n $ natVal n
8182 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)
8384 warn = vWarning $ mmSingleton path (pure errMsg)
8485 unless predicate warn
8586 STGe n -> do
8687 let
8788 nlen = withKnownNat n $ natVal n
8889 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)
9091 warn = vWarning $ mmSingleton path (pure errMsg)
9192 unless predicate warn
9293 STRegex r -> do
9394 let
9495 regex = withKnownSymbol r $ fromSing r
9596 predicate = matchTest (makeRegex (T.unpack regex) :: Regex) (T.unpack t)
96− errMsg = path <> " must match " <> regex
97+ errMsg = "must match " <> regex
9798 warn = vWarning $ mmSingleton path (pure errMsg)
9899 unless predicate warn
99100 STEnum ss -> do
@@ -101,69 +102,97 @@ validateTextConstraint (JSONPath path) t = \case
101102 matching :: Sing (s :: [Symbol]) -> Bool
102103 matching SNil = False
103104 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))
105106 warn = vWarning $ mmSingleton path (pure errMsg)
106107 unless (matching ss) warn
107108
108109validateNumberConstraint
109− :: JSONPath
110+ :: JSONPathText
110111 -> Scientific
111112 -> Sing (tcs :: NumberConstraint)
112113 -> Validation ()
113−validateNumberConstraint (JSONPath path) num = \case
114+validateNumberConstraint (JSONPathText path) num = \case
114115 SNEq n -> do
115116 let
116117 nlen = withKnownNat n $ natVal n
117118 predicate = fromIntegral nlen == num
118− errMsg = path <> " should be == " <> T.pack (show nlen)
119+ errMsg = "should be == " <> T.pack (show nlen)
119120 warn = vWarning $ mmSingleton path (pure errMsg)
120121 unless predicate warn
121122 SNGt n -> do
122123 let
123124 nlen = withKnownNat n $ natVal n
124125 predicate = num > fromIntegral nlen
125− errMsg = path <> " should be > " <> T.pack (show nlen)
126+ errMsg = "should be > " <> T.pack (show nlen)
126127 warn = vWarning $ mmSingleton path (pure errMsg)
127128 unless predicate warn
128129 SNGe n -> do
129130 let
130131 nlen = withKnownNat n $ natVal n
131132 predicate = num >= fromIntegral nlen
132− errMsg = path <> " should be >= " <> T.pack (show nlen)
133+ errMsg = "should be >= " <> T.pack (show nlen)
133134 warn = vWarning $ mmSingleton path (pure errMsg)
134135 unless predicate warn
135136 SNLt n -> do
136137 let
137138 nlen = withKnownNat n $ natVal n
138139 predicate = num < fromIntegral nlen
139− errMsg = path <> " should be < " <> T.pack (show nlen)
140+ errMsg = "should be < " <> T.pack (show nlen)
140141 warn = vWarning $ mmSingleton path (pure errMsg)
141142 unless predicate warn
142143 SNLe n -> do
143144 let
144145 nlen = withKnownNat n $ natVal n
145146 predicate = num <= fromIntegral nlen
146− errMsg = path <> " should be <= " <> T.pack (show nlen)
147+ errMsg = "should be <= " <> T.pack (show nlen)
147148 warn = vWarning $ mmSingleton path (pure errMsg)
148149 unless predicate warn
149150
150151validateArrayConstraint
151− :: JSONPath
152+ :: JSONPathText
152153 -> V.Vector a
153154 -> Sing (tcs :: ArrayConstraint)
154155 -> Validation ()
155−validateArrayConstraint (JSONPath path) v = \case
156+validateArrayConstraint (JSONPathText path) v = \case
156157 SAEq n -> do
157158 let
158159 nlen = withKnownNat n $ natVal n
159160 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)
161190 warn = vWarning $ mmSingleton path (pure errMsg)
162191 unless predicate warn
163192
164193validateJsonRepr
165194 :: Sing schema
166− -> [DemotedPathSegment]
195+ -> JSONPath
167196 -> JsonRepr schema
168197 -> Validation ()
169198validateJsonRepr sschema dpath jr = case jr of
@@ -197,7 +226,7 @@ validateJsonRepr sschema dpath jr = case jr of
197226 process cs
198227 process acs
199228 for_ (V.indexed v) $ \(ix, jr') -> do
200− let newPath = dpath <> pure (DIx $ fromIntegral ix)
229+ let newPath = dpath <> pure (Index $ fromIntegral ix)
201230 validateJsonRepr s newPath jr'
202231 ReprOptional d -> case sschema of
203232 SSchemaOptional ss -> case d of
@@ -209,7 +238,7 @@ validateJsonRepr sschema dpath jr = case jr of
209238 go :: Rec FieldRepr (ts :: [(Symbol, Schema)] ) -> Validation ()
210239 go RNil = pure ()
211240 go (f@(FieldRepr d) :& ftl) = do
212− let newPath = dpath <> [DKey (knownFieldName f)]
241+ let newPath = dpath <> [Key (knownFieldName f)]
213242 validateJsonRepr (knownFieldSchema f) newPath d
214243 go ftl
215244 ReprUnion _ -> pure () -- FIXME
@@ -221,7 +250,7 @@ validateJsonRepr sschema dpath jr = case jr of
221250 -- fail "impossible to produce subUnion, please report this as a bug"
222251 -- Just x -> do
223252 -- let
224− -- JSONPath path = demotedPathToText dpath
253+ -- JSONPathText path = demotedPathToText dpath
225254 -- case stl of
226255 -- SNil -> void $ vWarning $ mmSingleton path
227256 -- $ pure "union handling error, please report this as bug"
stack-13.21.yamlnew file+7
@@ -0,0 +1,7 @@
1+resolver: lts-13.21
2+extra-deps:
3+ - hjsonpointer-1.4.0@rev:0
4+ - hjsonschema-1.9.0@rev:0
5+ - validationt-0.3.0
6+nix:
7+ packages: [pcre, pkg-config, zlib]
stack.yaml+5−4
@@ -1,5 +1,6 @@
1−resolver: lts-12.0
1+resolver: lts-14.22
22extra-deps:
3− - hjsonpointer-1.4.0@rev:0
4− - hjsonschema-1.9.0@rev:0
5− - validationt-0.2.1.0
3+- hjsonpointer-1.4.0@rev:0
4+- hjsonschema-1.9.0@rev:0
5+- git: https://github.com/typeable/validationt.git
6+ commit: 97fea97c4015ab5e99f3efb2c73e1fef4b8857d8
test/JsonSchemaSpec.hs+58
@@ -10,6 +10,7 @@ module JsonSchemaSpec (spec, main) where
1010import Data.Aeson as J
1111import Data.Maybe
1212import Data.Proxy
13+import Data.ByteString.Lazy as B
1314import Data.Schematic
1415import Data.Vinyl
1516import JSONSchema.Draft4 as D4
@@ -31,6 +32,27 @@ exampleData = withRepr @SchemaExample $
3132 :& field @"bar" (pure (ReprText "foo"))
3233 :& RNil
3334
35+type SchemaArrayExample = 'SchemaObject
36+ '[ '("a1", 'SchemaArray '[ 'AGt 1 ] ('SchemaNumber '[]))
37+ , '("a2", 'SchemaArray '[ 'AGe 1 ] ('SchemaNumber '[]))
38+ , '("a3", 'SchemaArray '[ 'ALt 1 ] ('SchemaNumber '[]))
39+ , '("a4", 'SchemaArray '[ 'ALe 1 ] ('SchemaNumber '[]))
40+ ]
41+
42+type SchemaNumberExample = 'SchemaObject
43+ '[ '("n1", 'SchemaNumber '[ 'NGt 1 ])
44+ , '("n2", 'SchemaNumber '[ 'NGe 1 ])
45+ , '("n3", 'SchemaNumber '[ 'NLt 1 ])
46+ , '("n4", 'SchemaNumber '[ 'NLe 1 ])
47+ ]
48+
49+type SchemaTextExample = 'SchemaObject
50+ '[ '("t1", 'SchemaText '[ 'TGt 1 ])
51+ , '("t2", 'SchemaText '[ 'TGe 1 ])
52+ , '("t3", 'SchemaText '[ 'TLt 1 ])
53+ , '("t4", 'SchemaText '[ 'TLe 1 ])
54+ ]
55+
3456spec :: Spec
3557spec = do
3658 it "validates simple schema" $ do
@@ -38,6 +60,42 @@ spec = do
3860 fetchHTTPAndValidate schema (toJSON exampleData) >>= \case
3961 Left _ -> fail "failed to validate test example"
4062 Right _ -> pure ()
63+ it "validates schema with arrays" $ do
64+ let
65+ schema = D4.SchemaWithURI (fromJust $ toJsonSchema (Proxy @SchemaArrayExample)) Nothing
66+ obj = withRepr @SchemaArrayExample $
67+ field @"a1" [ReprNumber 13, ReprNumber 13]
68+ :& field @"a2" [ReprNumber 13]
69+ :& field @"a3" []
70+ :& field @"a4" [ReprNumber 13]
71+ :& RNil
72+ fetchHTTPAndValidate schema (toJSON obj) >>= \case
73+ Left e -> fail "failed to validate test example"
74+ Right _ -> pure ()
75+ it "validates schema with numbers" $ do
76+ let
77+ schema = D4.SchemaWithURI (fromJust $ toJsonSchema (Proxy @SchemaNumberExample)) Nothing
78+ obj = withRepr @SchemaNumberExample $
79+ field @"n1" 1.1
80+ :& field @"n2" 1
81+ :& field @"n3" 0.9
82+ :& field @"n4" 1.0
83+ :& RNil
84+ fetchHTTPAndValidate schema (toJSON obj) >>= \case
85+ Left e -> fail "failed to validate test example"
86+ Right _ -> pure ()
87+ it "validates schema with strings" $ do
88+ let
89+ schema = D4.SchemaWithURI (fromJust $ toJsonSchema (Proxy @SchemaTextExample)) Nothing
90+ obj = withRepr @SchemaTextExample $
91+ field @"t1" "11"
92+ :& field @"t2" "1"
93+ :& field @"t3" ""
94+ :& field @"t4" "1"
95+ :& RNil
96+ fetchHTTPAndValidate schema (toJSON obj) >>= \case
97+ Left e -> fail "failed to validate test example"
98+ Right _ -> pure ()
4199
42100main :: IO ()
43101main = hspec spec