git.iko.soy/schematic
on master help sign in
swap
f5ed14a21 ahead, 0 behind
19 files changed+512−257
since splitsnapshots
unifiedsplit
ChangeLog.md+5 release+16−8 schematic.cabal+4−3 src/Data/Schematic/DSL.hs+11−2 src/Data/Schematic/Generator.hs+34−55 src/Data/Schematic/Generator/Regex.hs+13−22 src/Data/Schematic/JsonSchema.hs+21−9 src/Data/Schematic/Migration.hs+10−2 src/Data/Schematic/Path.hs−1 src/Data/Schematic/Schema.hs+108−38 src/Data/Schematic/Schema.hs-boot+95 src/Data/Schematic/Validation.hs+45−17 src/Data/Schematic/Verifier/Array.hs+1−9 src/Data/Schematic/Verifier/Common.hs+3−3 src/Data/Schematic/Verifier/Number.hs+9−18 src/Data/Schematic/Verifier/Text.hs+61−67 stack-13.7.yaml+5 test/JsonSchemaSpec.hs+58 test/SchemaSpec.hs+13−3
ChangeLog.md+5
@@ -1,5 +1,10 @@
11# Revision history for schematic
22
3+## 0.5.0.0 -- 2019-02-20
4+
5+GHC 8.6, json generation by schema definition, validation bug fixes, better
6+parsing error messages.
7+
38## 0.4.3.0 -- 2018-07-12
49
510GHC 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+4−3
@@ -1,6 +1,7 @@
11name: schematic
2−version: 0.4.3.0
2+version: 0.5.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
@@ -64,7 +65,7 @@ library
6465 , TypeOperators
6566 , TypeSynonymInstances
6667 , UndecidableInstances
67− build-depends: base >=4.11 && <4.12
68+ build-depends: base >=4.11 && <4.13
6869 , bytestring
6970 , aeson >= 1
7071 , containers
@@ -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
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/Generator.hs+34−55
@@ -1,26 +1,13 @@
11module Data.Schematic.Generator where
22
3−import Control.Monad
4−import Data.Aeson (Object, Value(..))
5−import Data.HashMap.Lazy (HashMap)
6−import qualified Data.HashMap.Lazy as H
7−import Data.List
8−import Data.Maybe
9−import Data.Monoid
10−import Data.Schematic.Schema
11−import qualified Data.Set as S
12−import Data.Text (Text, pack, unpack)
13−import qualified Data.Text as T (replicate)
14−import Data.Text.Lazy (toStrict)
15−import Data.Text.Lazy.Builder (Builder, singleton, toLazyText)
3+import Data.Maybe
4+import Data.Schematic.Generator.Regex
5+import {-# SOURCE #-} Data.Schematic.Schema
6+import Data.Schematic.Verifier
7+import Data.Scientific
8+import Data.Text (Text, pack)
169import qualified Data.Vector as V
17−import Data.Schematic.Generator.Regex
18−import Data.Schematic.Verifier
19−import Test.SmallCheck
20−import Test.SmallCheck.Series
21−import Text.Regex.TDFA
22−import Text.Regex.TDFA.Pattern
23−import Text.Regex.TDFA.ReadRegex (parseRegex)
10+import Test.SmallCheck.Series
2411
2512maxHigh :: Int
2613maxHigh = 30
@@ -31,25 +18,26 @@ minLow = 2
3118textLengthSeries :: Monad m => [VerifiedTextConstraint] -> Series m Text
3219textLengthSeries =
3320 \case
34− [VTEq eq] -> pure $ pack $ take (fromIntegral eq) $ cycle "sample"
21+ [VTEq eq] -> pure $ pack $ take (fromIntegral eq) $ cycle "sample"
3522 [VTBounds ml mh] -> do
36− let l = fromMaybe minLow (fromIntegral <$> ml) + 1
37− h = fromMaybe maxHigh (fromIntegral <$> mh) - 1
23+ let
24+ l = fromMaybe minLow (fromIntegral <$> ml) + 1
25+ h = fromMaybe maxHigh (fromIntegral <$> mh) - 1
3826 n <- generate $ \depth -> take depth [l .. h]
3927 pure $ pack $ take (fromIntegral n) $ cycle "sample"
40− _ -> pure "error"
28+ _ -> pure "error"
4129
4230textEnumSeries :: Monad m => [Text] -> Series m Text
4331textEnumSeries enum = generate $ \depth -> take depth enum
4432
45−textSeries :: Monad m => [DemotedTextConstraint] -> Series m Value
33+textSeries :: Monad m => [DemotedTextConstraint] -> Series m Text
4634textSeries cs = do
4735 let mvcs = verifyTextConstraints cs
4836 case mvcs of
4937 Just vcs -> do
5038 n <- textSeries' vcs
51− pure $ String n
52− Nothing -> pure Null
39+ pure n
40+ Nothing -> pure "error"
5341
5442textSeries' :: Monad m => [VerifiedTextConstraint] -> Series m Text
5543textSeries' [] = pure "sample"
@@ -60,19 +48,19 @@ textSeries' vcs = do
6048 Nothing -> do
6149 let regexps = listToMaybe [x | VTRegex x _ _ <- vcs]
6250 case regexps of
63− Just e -> regexSeries e
51+ Just e -> regexSeries e
6452 Nothing -> textLengthSeries vcs
6553
66−numberSeries :: Monad m => [DemotedNumberConstraint] -> Series m Value
54+numberSeries :: Monad m => [DemotedNumberConstraint] -> Series m Scientific
6755numberSeries cs = do
6856 let mvcs = verifyNumberConstraints cs
6957 case mvcs of
7058 Just vcs -> do
7159 n <- numberSeries' vcs
72− pure $ Number $ fromIntegral n
73− Nothing -> pure Null
60+ pure $ n
61+ Nothing -> pure 0
7462
75−numberSeries' :: Monad m => VerifiedNumberConstraint -> Series m Integer
63+numberSeries' :: Monad m => VerifiedNumberConstraint -> Series m Scientific
7664numberSeries' =
7765 \case
7866 VNEq eq -> pure $ fromIntegral eq
@@ -82,31 +70,22 @@ numberSeries' =
8270 n <- generate $ \depth -> take depth [l .. h]
8371 pure $ fromIntegral n
8472
85−arraySeries ::
86− Monad m => [DemotedArrayConstraint] -> DemotedSchema -> Series m Value
87−arraySeries cs sch = do
73+arraySeries
74+ :: (Monad m, Serial m (JsonRepr s))
75+ => [DemotedArrayConstraint]
76+ -> Series m (V.Vector (JsonRepr s))
77+arraySeries cs = do
8878 let mvcs = verifyArrayConstraint cs
8979 case mvcs of
90− Just vcs -> arraySeries' vcs sch
91− Nothing -> pure Null
80+ Just vcs -> arraySeries' vcs
81+ Nothing -> pure V.empty
9282
93−arraySeries' ::
94− Monad m => Maybe VerifiedArrayConstraint -> DemotedSchema -> Series m Value
95−arraySeries' ml sch = do
96− objs <- V.replicateM (maybe minRepeat f ml) (valueSeries sch)
97− pure $ Array objs
83+arraySeries'
84+ :: forall m s. (Monad m, Serial m (JsonRepr s))
85+ => Maybe VerifiedArrayConstraint
86+ -> Series m (V.Vector (JsonRepr s))
87+arraySeries' ml = do
88+ objs <- V.replicateM (maybe minRepeat f ml) (series :: Series m (JsonRepr s))
89+ pure $ objs
9890 where
9991 f (VAEq l) = fromIntegral l
100−
101−valueSeries :: Monad m => DemotedSchema -> Series m Value
102−valueSeries (DSchemaText cs) = textSeries cs
103−valueSeries (DSchemaNumber cs) = numberSeries cs
104−valueSeries DSchemaBoolean = Bool <$> pure True \/ pure False
105−valueSeries (DSchemaObject pairs') =
106− Object <$> (decDepth $ mapM valueSeries $ H.fromList pairs')
107−valueSeries (DSchemaArray cs sch) = arraySeries cs sch
108−valueSeries DSchemaNull = pure Null
109−valueSeries (DSchemaOptional sch) = pure Null \/ valueSeries sch
110−valueSeries (DSchemaUnion schs) = do
111− objs <- mapM valueSeries schs
112− pure $ Array $ V.fromList objs
src/Data/Schematic/Generator/Regex.hs+13−22
@@ -1,24 +1,15 @@
11module Data.Schematic.Generator.Regex where
22
3−import Control.Monad
4−import Data.Aeson (Object, Value(..))
5−import Data.HashMap.Lazy (HashMap)
6−import qualified Data.HashMap.Lazy as H
7−import Data.List
8−import Data.Maybe
9−import Data.Monoid
10−import Data.Schematic.Schema
3+import Control.Monad
4+import Data.List
5+import Data.Maybe
116import qualified Data.Set as S
12−import Data.Text (Text, pack, unpack)
13−import Data.Text.Lazy (toStrict)
14−import Data.Text.Lazy.Builder (Builder, singleton, toLazyText)
15−import qualified Data.Vector as V
16−import Test.SmallCheck
17−import Test.SmallCheck.Series
18−import Text.Regex.TDFA
19−import Text.Regex.TDFA.Pattern
20−import Text.Regex.TDFA.ReadRegex (parseRegex)
21−import Data.Schematic.Verifier
7+import Data.Text (Text, unpack)
8+import Data.Text.Lazy (toStrict)
9+import Data.Text.Lazy.Builder (Builder, singleton, toLazyText)
10+import Test.SmallCheck.Series
11+import Text.Regex.TDFA.Pattern
12+import Text.Regex.TDFA.ReadRegex (parseRegex)
2213
2314
2415minRepeat :: Int
@@ -31,11 +22,11 @@ regexSeries :: (Monad m) => Text -> Series m Text
3122regexSeries regexp =
3223 case parseRegex . unpack $ regexp of
3324 Right (p, _) -> toStrict . toLazyText <$> regexSeries' p
34− Left _ -> pure ""
25+ Left _ -> pure ""
3526
3627regexSeries' :: (Monad m) => Pattern -> Series m Builder
37−regexSeries' p =
38− case p of
28+regexSeries' pt =
29+ case pt of
3930 PEmpty -> pure mempty
4031 PChar {..} -> pure $ singleton getPatternChar
4132 PAny {getPatternSet = PatternSet (Just cset) _ _ _} -> do
@@ -82,4 +73,4 @@ regexSeries' p =
8273 'D' -> notChars $ ['0' .. '9']
8374 'W' -> notChars $ ['0' .. '9'] ++ '_' : ['a' .. 'z'] ++ ['A' .. 'Z']
8475 'S' -> notChars "\9\32"
85− ch -> [ch]
76+ ch' -> [ch']
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−1
@@ -1,7 +1,6 @@
11module Data.Schematic.Path where
22
33import Data.Foldable as F
4−import Data.Monoid
54import Data.Singletons.Prelude
65import Data.Singletons.TypeLits
76import Data.Text as T
src/Data/Schematic/Schema.hs+108−38
@@ -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,6 +13,7 @@ import Data.Aeson.Types as J
1213import Data.HashMap.Strict as H
1314import Data.Kind
1415import Data.Maybe
16+import Data.Schematic.Generator
1517import Data.Schematic.Instances ()
1618import Data.Scientific
1719import Data.Singletons.Prelude.List hiding (All, Union)
@@ -24,7 +26,8 @@ import Data.Vinyl hiding (Dict)
2426import qualified Data.Vinyl.TypeLevel as V
2527import GHC.Exts
2628import GHC.Generics (Generic)
27−import GHC.TypeLits (SomeNat(..), SomeSymbol(..), someSymbolVal, someNatVal)
29+import GHC.TypeLits
30+ (SomeNat(..), SomeSymbol(..), someNatVal, someSymbolVal)
2831import Prelude as P
2932import Test.SmallCheck.Series
3033
@@ -56,25 +59,25 @@ instance SingKind TextConstraint where
5659 STRegex s -> withKnownSymbol s (DTRegex $ T.pack $ symbolVal s)
5760 STEnum s -> let
5861 d :: Sing (s :: [Symbol]) -> [Text]
59− d SNil = []
62+ d SNil = []
6063 d (SCons ss@SSym fs) = T.pack (symbolVal ss) : d fs
6164 in DTEnum $ d s
6265 toSing = \case
6366 DTEq n -> case someNatVal n of
6467 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STEq (SNat :: Sing n))
65− Nothing -> error "Negative singleton nat"
68+ Nothing -> error "Negative singleton nat"
6669 DTLt n -> case someNatVal n of
6770 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STLt (SNat :: Sing n))
68− Nothing -> error "Negative singleton nat"
71+ Nothing -> error "Negative singleton nat"
6972 DTLe n -> case someNatVal n of
7073 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STLe (SNat :: Sing n))
71− Nothing -> error "Negative singleton nat"
74+ Nothing -> error "Negative singleton nat"
7275 DTGt n -> case someNatVal n of
7376 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STGt (SNat :: Sing n))
74− Nothing -> error "Negative singleton nat"
77+ Nothing -> error "Negative singleton nat"
7578 DTGe n -> case someNatVal n of
7679 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STGe (SNat :: Sing n))
77− Nothing -> error "Negative singleton nat"
80+ Nothing -> error "Negative singleton nat"
7881 DTRegex s -> case someSymbolVal (T.unpack s) of
7982 SomeSymbol (_ :: Proxy n) -> SomeSing (STRegex (SSym :: Sing n))
8083 DTEnum ss -> case toSing ss of
@@ -161,43 +164,79 @@ instance SingKind NumberConstraint where
161164 toSing = \case
162165 DNEq n -> case someNatVal n of
163166 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNEq (SNat :: Sing n))
164− Nothing -> error "Negative singleton nat"
167+ Nothing -> error "Negative singleton nat"
165168 DNGt n -> case someNatVal n of
166169 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNGt (SNat :: Sing n))
167− Nothing -> error "Negative singleton nat"
170+ Nothing -> error "Negative singleton nat"
168171 DNGe n -> case someNatVal n of
169172 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNGe (SNat :: Sing n))
170− Nothing -> error "Negative singleton nat"
173+ Nothing -> error "Negative singleton nat"
171174 DNLt n -> case someNatVal n of
172175 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNLt (SNat :: Sing n))
173− Nothing -> error "Negative singleton nat"
176+ Nothing -> error "Negative singleton nat"
174177 DNLe n -> case someNatVal n of
175178 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNLe (SNat :: Sing n))
176− Nothing -> error "Negative singleton nat"
179+ Nothing -> error "Negative singleton nat"
177180
178181data ArrayConstraint
179182 = AEq Nat
183+ | AGt Nat
184+ | AGe Nat
185+ | ALt Nat
186+ | ALe Nat
180187 deriving (Generic)
181188
182189data DemotedArrayConstraint
183190 = DAEq Integer
191+ | DAGt Integer
192+ | DAGe Integer
193+ | DALt Integer
194+ | DALe Integer
184195 deriving (Generic, Eq, Show)
185196
186197data instance Sing (ac :: ArrayConstraint) where
187198 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)
188203
189204instance 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
190209
191210instance 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
192215
193216instance SingKind ArrayConstraint where
194217 type Demote ArrayConstraint = DemotedArrayConstraint
195218 fromSing = \case
196219 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)
197224 toSing = \case
198225 DAEq n -> case someNatVal n of
199226 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SAEq (SNat :: Sing n))
200− 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"
201240
202241data Schema
203242 = SchemaText [TextConstraint]
@@ -334,6 +373,31 @@ data JsonRepr :: Schema -> Type where
334373 ReprOptional :: Maybe (JsonRepr s) -> JsonRepr ('SchemaOptional s)
335374 ReprUnion :: Union JsonRepr (h ': tl) -> JsonRepr ('SchemaUnion (h ': tl))
336375
376+instance (Monad m, Serial m Text, SingI cs)
377+ => Serial m (JsonRepr ('SchemaText cs)) where
378+ series = decDepth $ fmap ReprText $ textSeries $ fromSing (sing :: Sing cs)
379+
380+instance (Monad m, Serial m Scientific, SingI cs)
381+ => Serial m (JsonRepr ('SchemaNumber cs)) where
382+ series = decDepth $ fmap ReprNumber
383+ $ numberSeries $ fromSing (sing :: Sing cs)
384+
385+instance Monad m => Serial m (JsonRepr 'SchemaNull) where
386+ series = cons0 ReprNull
387+
388+instance (Serial m (JsonRepr s), Serial m (V.Vector (JsonRepr s)), SingI cs)
389+ => Serial m (JsonRepr ('SchemaArray cs s)) where
390+ series = decDepth $ fmap ReprArray
391+ $ arraySeries $ fromSing (sing :: Sing cs)
392+
393+instance (Serial m (JsonRepr s))
394+ => Serial m (JsonRepr ('SchemaOptional s)) where
395+ series = cons1 ReprOptional
396+
397+instance (Monad m, Serial m (Rec FieldRepr fs))
398+ => Serial m (JsonRepr ('SchemaObject fs)) where
399+ series = cons1 ReprObject
400+
337401-- | Move to the union package
338402instance Show (JsonRepr ('SchemaText cs)) where
339403 show (ReprText t) = "ReprText " P.++ show t
@@ -341,39 +405,31 @@ instance Show (JsonRepr ('SchemaText cs)) where
341405instance Show (JsonRepr ('SchemaNumber cs)) where
342406 show (ReprNumber n) = "ReprNumber " P.++ show n
343407
408+instance Show (JsonRepr 'SchemaBoolean) where
409+ show (ReprBoolean n) = "ReprBoolean " P.++ show n
410+
344411instance Show (JsonRepr 'SchemaNull) where show _ = "ReprNull"
345412
346413instance Show (JsonRepr s) => Show (JsonRepr ('SchemaArray acs s)) where
347414 show (ReprArray v) = "ReprArray " P.++ show v
348415
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
349423instance V.RecAll FieldRepr fs Show => Show (JsonRepr ('SchemaObject fs)) where
350424 show (ReprObject fs) = "ReprObject " P.++ show fs
425+#endif
351426
352427instance Show (JsonRepr s) => Show (JsonRepr ('SchemaOptional s)) where
353428 show (ReprOptional s) = "ReprOptional " P.++ show s
354429
355−instance (Monad m, Serial m Text)
356− => Serial m (JsonRepr ('SchemaText cs)) where
357− series = cons1 ReprText
358−
359−instance (Monad m, Serial m Scientific)
360− => Serial m (JsonRepr ('SchemaNumber cs)) where
361− series = cons1 ReprNumber
362−
363−instance Monad m => Serial m (JsonRepr 'SchemaNull) where
364− series = cons0 ReprNull
365−
366−instance (Serial m (V.Vector (JsonRepr s)))
367− => Serial m (JsonRepr ('SchemaArray cs s)) where
368− series = cons1 ReprArray
369−
370−instance (Serial m (JsonRepr s))
371− => Serial m (JsonRepr ('SchemaOptional s)) where
372− series = cons1 ReprOptional
373−
374−instance (Monad m, Serial m (Rec FieldRepr fs))
375− => Serial m (JsonRepr ('SchemaObject fs)) where
376− series = cons1 ReprObject
430+instance Show (Union JsonRepr (h ': tl))
431+ => Show (JsonRepr ('SchemaUnion (h ': tl))) where
432+ show (ReprUnion s) = "ReprUnion " P.++ show s
377433
378434instance Eq (Rec FieldRepr fs) => Eq (JsonRepr ('SchemaObject fs)) where
379435 ReprObject a == ReprObject b = a == b
@@ -384,6 +440,9 @@ instance Eq (JsonRepr ('SchemaText cs)) where
384440instance Eq (JsonRepr ('SchemaNumber cs)) where
385441 ReprNumber a == ReprNumber b = a == b
386442
443+instance Eq (JsonRepr 'SchemaBoolean) where
444+ ReprBoolean a == ReprBoolean b = a == b
445+
387446instance Eq (JsonRepr 'SchemaNull) where
388447 ReprNull == ReprNull = True
389448
@@ -393,6 +452,10 @@ instance Eq (JsonRepr s) => Eq (JsonRepr ('SchemaArray as s)) where
393452instance Eq (JsonRepr s) => Eq (JsonRepr ('SchemaOptional s)) where
394453 ReprOptional a == ReprOptional b = a == b
395454
455+instance Eq (Union JsonRepr (h ': tl))
456+ => Eq (JsonRepr ('SchemaUnion (h ': tl))) where
457+ ReprUnion a == ReprUnion b = a == b
458+
396459instance Ord (Rec FieldRepr fs) => Ord (JsonRepr ('SchemaObject fs)) where
397460 ReprObject a `compare` ReprObject b = a `compare` b
398461
@@ -402,6 +465,9 @@ instance Ord (JsonRepr ('SchemaText cs)) where
402465instance Ord (JsonRepr ('SchemaNumber cs)) where
403466 ReprNumber a `compare` ReprNumber b = a `compare` b
404467
468+instance Ord (JsonRepr 'SchemaBoolean) where
469+ ReprBoolean a `compare` ReprBoolean b = a `compare` b
470+
405471instance Ord (JsonRepr 'SchemaNull) where
406472 compare _ _ = EQ
407473
@@ -411,6 +477,10 @@ instance Ord (JsonRepr s) => Ord (JsonRepr ('SchemaArray as s)) where
411477instance Ord (JsonRepr s) => Ord (JsonRepr ('SchemaOptional s)) where
412478 ReprOptional a `compare` ReprOptional b = a `compare` b
413479
480+instance Ord (Union JsonRepr (h ': tl))
481+ => Ord (JsonRepr ('SchemaUnion (h ': tl))) where
482+ ReprUnion a `compare` ReprUnion b = a `compare` b
483+
414484instance IsList (JsonRepr ('SchemaArray cs s)) where
415485 type Item (JsonRepr ('SchemaArray cs s)) = JsonRepr s
416486 fromList = ReprArray . GHC.Exts.fromList
@@ -502,7 +572,7 @@ instance J.ToJSON (JsonRepr a) where
502572 toJSON (ReprText t) = J.String t
503573 toJSON (ReprNumber n) = J.Number n
504574 toJSON (ReprOptional s) = case s of
505− Just v -> toJSON v
575+ Just v -> toJSON v
506576 Nothing -> J.Null
507577 toJSON (ReprArray v) = J.Array $ toJSON <$> v
508578 toJSON (ReprObject r) = J.Object . H.fromList . fold $ r
src/Data/Schematic/Schema.hs-bootnew file+95
@@ -0,0 +1,95 @@
1+module Data.Schematic.Schema where
2+
3+import Data.Kind
4+import Data.Maybe
5+import Data.Schematic.Instances ()
6+import Data.Scientific
7+import Data.Singletons.TH
8+import Data.Singletons.TypeLits
9+import Data.Text as T
10+import Data.Union
11+import Data.Vector as V
12+import Data.Vinyl hiding (Dict)
13+import Prelude as P
14+
15+data TextConstraint
16+ = TEq Nat
17+ | TLt Nat
18+ | TLe Nat
19+ | TGt Nat
20+ | TGe Nat
21+ | TRegex Symbol
22+ | TEnum [Symbol]
23+
24+data DemotedTextConstraint
25+ = DTEq Integer
26+ | DTLt Integer
27+ | DTLe Integer
28+ | DTGt Integer
29+ | DTGe Integer
30+ | DTRegex Text
31+ | DTEnum [Text]
32+
33+data NumberConstraint
34+ = NLe Nat
35+ | NLt Nat
36+ | NGt Nat
37+ | NGe Nat
38+ | NEq Nat
39+
40+data DemotedNumberConstraint
41+ = DNLe Integer
42+ | DNLt Integer
43+ | DNGt Integer
44+ | DNGe Integer
45+ | DNEq Integer
46+
47+data ArrayConstraint
48+ = AEq Nat
49+ | AGt Nat
50+ | AGe Nat
51+ | ALt Nat
52+ | ALe Nat
53+
54+data DemotedArrayConstraint
55+ = DAEq Integer
56+ | DAGt Integer
57+ | DAGe Integer
58+ | DALt Integer
59+ | DALe Integer
60+
61+data Schema
62+ = SchemaText [TextConstraint]
63+ | SchemaBoolean
64+ | SchemaNumber [NumberConstraint]
65+ | SchemaObject [(Symbol, Schema)]
66+ | SchemaArray [ArrayConstraint] Schema
67+ | SchemaNull
68+ | SchemaOptional Schema
69+ | SchemaUnion [Schema]
70+
71+data DemotedSchema
72+ = DSchemaText [DemotedTextConstraint]
73+ | DSchemaNumber [DemotedNumberConstraint]
74+ | DSchemaBoolean
75+ | DSchemaObject [(Text, DemotedSchema)]
76+ | DSchemaArray [DemotedArrayConstraint] DemotedSchema
77+ | DSchemaNull
78+ | DSchemaOptional DemotedSchema
79+ | DSchemaUnion [DemotedSchema]
80+
81+data FieldRepr :: (Symbol, Schema) -> Type where
82+ FieldRepr
83+ :: (SingI schema, KnownSymbol name)
84+ => JsonRepr schema
85+ -> FieldRepr '(name, schema)
86+
87+data JsonRepr :: Schema -> Type where
88+ ReprText :: Text -> JsonRepr ('SchemaText cs)
89+ ReprNumber :: Scientific -> JsonRepr ('SchemaNumber cs)
90+ ReprBoolean :: Bool -> JsonRepr 'SchemaBoolean
91+ ReprNull :: JsonRepr 'SchemaNull
92+ ReprArray :: V.Vector (JsonRepr s) -> JsonRepr ('SchemaArray cs s)
93+ ReprObject :: Rec FieldRepr fs -> JsonRepr ('SchemaObject fs)
94+ ReprOptional :: Maybe (JsonRepr s) -> JsonRepr ('SchemaOptional s)
95+ ReprUnion :: Union JsonRepr (h ': tl) -> JsonRepr ('SchemaUnion (h ': tl))
src/Data/Schematic/Validation.hs+45−17
@@ -58,42 +58,42 @@ validateTextConstraint (JSONPath path) t = \case
5858 let
5959 nlen = withKnownNat n $ natVal n
6060 predicate = nlen == (fromIntegral $ T.length t)
61− errMsg = "length of " <> path <> " should be == " <> T.pack (show nlen)
61+ errMsg = "length should be == " <> T.pack (show nlen)
6262 warn = vWarning $ mmSingleton path (pure errMsg)
6363 unless predicate warn
6464 STLt n -> do
6565 let
6666 nlen = withKnownNat n $ natVal n
67− predicate = nlen < (fromIntegral $ T.length t)
68− errMsg = "length of " <> path <> " should be < " <> T.pack (show nlen)
67+ predicate = nlen > (fromIntegral $ T.length t)
68+ errMsg = "length should be < " <> T.pack (show nlen)
6969 warn = vWarning $ mmSingleton path (pure errMsg)
7070 unless predicate warn
7171 STLe n -> do
7272 let
7373 nlen = withKnownNat n $ natVal n
74− predicate = nlen <= (fromIntegral $ T.length t)
75− errMsg = "length of " <> path <> " should be <= " <> T.pack (show nlen)
74+ predicate = nlen >= (fromIntegral $ T.length t)
75+ errMsg = "length should be <= " <> T.pack (show nlen)
7676 warn = vWarning $ mmSingleton path (pure errMsg)
7777 unless predicate warn
7878 STGt n -> do
7979 let
8080 nlen = withKnownNat n $ natVal n
81− predicate = nlen > (fromIntegral $ T.length t)
82− errMsg = "length of " <> path <> " should be > " <> T.pack (show nlen)
81+ predicate = nlen < (fromIntegral $ T.length t)
82+ errMsg = "length should be > " <> T.pack (show nlen)
8383 warn = vWarning $ mmSingleton path (pure errMsg)
8484 unless predicate warn
8585 STGe n -> do
8686 let
8787 nlen = withKnownNat n $ natVal n
88− predicate = nlen >= (fromIntegral $ T.length t)
89− errMsg = "length of " <> path <> " should be >= " <> T.pack (show nlen)
88+ predicate = nlen <= (fromIntegral $ T.length t)
89+ errMsg = "length should be >= " <> T.pack (show nlen)
9090 warn = vWarning $ mmSingleton path (pure errMsg)
9191 unless predicate warn
9292 STRegex r -> do
9393 let
9494 regex = withKnownSymbol r $ fromSing r
9595 predicate = matchTest (makeRegex (T.unpack regex) :: Regex) (T.unpack t)
96− errMsg = path <> " must match " <> regex
96+ errMsg = "must match " <> regex
9797 warn = vWarning $ mmSingleton path (pure errMsg)
9898 unless predicate warn
9999 STEnum ss -> do
@@ -101,7 +101,7 @@ validateTextConstraint (JSONPath path) t = \case
101101 matching :: Sing (s :: [Symbol]) -> Bool
102102 matching SNil = False
103103 matching (SCons s@SSym fs) = T.pack (symbolVal s) == t || matching fs
104− errMsg = path <> " must be one of " <> T.pack (show (fromSing ss))
104+ errMsg = "must be one of " <> T.pack (show (fromSing ss))
105105 warn = vWarning $ mmSingleton path (pure errMsg)
106106 unless (matching ss) warn
107107
@@ -115,35 +115,35 @@ validateNumberConstraint (JSONPath path) num = \case
115115 let
116116 nlen = withKnownNat n $ natVal n
117117 predicate = fromIntegral nlen == num
118− errMsg = path <> " should be == " <> T.pack (show nlen)
118+ errMsg = "should be == " <> T.pack (show nlen)
119119 warn = vWarning $ mmSingleton path (pure errMsg)
120120 unless predicate warn
121121 SNGt n -> do
122122 let
123123 nlen = withKnownNat n $ natVal n
124124 predicate = num > fromIntegral nlen
125− errMsg = path <> " should be > " <> T.pack (show nlen)
125+ errMsg = "should be > " <> T.pack (show nlen)
126126 warn = vWarning $ mmSingleton path (pure errMsg)
127127 unless predicate warn
128128 SNGe n -> do
129129 let
130130 nlen = withKnownNat n $ natVal n
131131 predicate = num >= fromIntegral nlen
132− errMsg = path <> " should be >= " <> T.pack (show nlen)
132+ errMsg = "should be >= " <> T.pack (show nlen)
133133 warn = vWarning $ mmSingleton path (pure errMsg)
134134 unless predicate warn
135135 SNLt n -> do
136136 let
137137 nlen = withKnownNat n $ natVal n
138138 predicate = num < fromIntegral nlen
139− errMsg = path <> " should be < " <> T.pack (show nlen)
139+ errMsg = "should be < " <> T.pack (show nlen)
140140 warn = vWarning $ mmSingleton path (pure errMsg)
141141 unless predicate warn
142142 SNLe n -> do
143143 let
144144 nlen = withKnownNat n $ natVal n
145145 predicate = num <= fromIntegral nlen
146− errMsg = path <> " should be <= " <> T.pack (show nlen)
146+ errMsg = "should be <= " <> T.pack (show nlen)
147147 warn = vWarning $ mmSingleton path (pure errMsg)
148148 unless predicate warn
149149
@@ -157,7 +157,35 @@ validateArrayConstraint (JSONPath path) v = \case
157157 let
158158 nlen = withKnownNat n $ natVal n
159159 predicate = nlen == fromIntegral (V.length v)
160− errMsg = "length of " <> path <> " should be == " <> T.pack (show nlen)
160+ errMsg = "length should be == " <> T.pack (show nlen)
161+ warn = vWarning $ mmSingleton path (pure errMsg)
162+ unless predicate warn
163+ SAGt n -> do
164+ let
165+ nlen = withKnownNat n $ natVal n
166+ predicate = fromIntegral (V.length v) > nlen
167+ errMsg = "length should be > " <> T.pack (show nlen)
168+ warn = vWarning $ mmSingleton path (pure errMsg)
169+ unless predicate warn
170+ SAGe n -> do
171+ let
172+ nlen = withKnownNat n $ natVal n
173+ predicate = fromIntegral (V.length v) >= nlen
174+ errMsg = "length should be >= " <> T.pack (show nlen)
175+ warn = vWarning $ mmSingleton path (pure errMsg)
176+ unless predicate warn
177+ SALt n -> do
178+ let
179+ nlen = withKnownNat n $ natVal n
180+ predicate = fromIntegral (V.length v) < nlen
181+ errMsg = "length should be < " <> T.pack (show nlen)
182+ warn = vWarning $ mmSingleton path (pure errMsg)
183+ unless predicate warn
184+ SALe n -> do
185+ let
186+ nlen = withKnownNat n $ natVal n
187+ predicate = fromIntegral (V.length v) <= nlen
188+ errMsg = "length should be <= " <> T.pack (show nlen)
161189 warn = vWarning $ mmSingleton path (pure errMsg)
162190 unless predicate warn
163191
src/Data/Schematic/Verifier/Array.hs+1−9
@@ -1,15 +1,7 @@
11module Data.Schematic.Verifier.Array where
22
3−import Data.List
4−import Data.Maybe
5−import Data.Schematic
3+import {-# SOURCE #-} Data.Schematic.Schema
64import Data.Schematic.Verifier.Common
7−import Data.Singletons
8−import Data.Singletons.Prelude
9−import Data.Singletons.TypeLits
10−import Data.Text (Text)
11−import Data.Text.Array (Array)
12−import GHC.Generics
135
146data VerifiedArrayConstraint =
157 VAEq Integer
src/Data/Schematic/Verifier/Common.hs+3−3
@@ -17,9 +17,9 @@ simplifyDNGs = simplifyNumberConstraint maximum
1717verifyDNEq :: [Integer] -> Maybe (Maybe Integer)
1818verifyDNEq x =
1919 case nub x of
20− [] -> Just Nothing
21− [x] -> Just $ Just x
22− (x:y:_) -> Nothing
20+ [] -> Just Nothing
21+ [y] -> Just $ Just y
22+ (_:_:_) -> Nothing
2323
2424verify3 :: Maybe Integer -> Maybe Integer -> Maybe Integer -> Maybe ()
2525verify3 (Just x) (Just y) (Just z) =
src/Data/Schematic/Verifier/Number.hs+9−18
@@ -1,37 +1,28 @@
11module Data.Schematic.Verifier.Number where
22
3−import Data.List
4−import Data.Maybe
5−import Data.Schematic
6−import Data.Schematic.Schema
3+import {-# SOURCE #-} Data.Schematic.Schema
74import Data.Schematic.Verifier.Common
8−import Data.Singletons
9−import Data.Singletons.Prelude
10−import Data.Singletons.TypeLits
11−import Data.Text (Text)
12−import Data.Text.Array (Array)
13−import GHC.Generics
145
156toStrictNumber :: [DemotedNumberConstraint] -> [DemotedNumberConstraint]
167toStrictNumber = map f
178 where
189 f (DNLe x) = DNLt (x + 1)
1910 f (DNGe x) = DNGt (x - 1)
20− f x = x
11+ f x = x
2112
2213data VerifiedNumberConstraint
2314 = VNEq Integer
24− | VNBounds (Maybe Integer)
25− (Maybe Integer)
15+ | VNBounds (Maybe Integer) (Maybe Integer)
2616 deriving (Show)
2717
28−verifyNumberConstraints ::
29− [DemotedNumberConstraint]
18+verifyNumberConstraints
19+ :: [DemotedNumberConstraint]
3020 -> Maybe VerifiedNumberConstraint
3121verifyNumberConstraints cs' = do
32− let cs = toStrictNumber cs'
33− mlt = simplifyDNLs [x | DNLt x <- cs]
34− mgt = simplifyDNGs [x | DNGt x <- cs]
22+ let
23+ cs = toStrictNumber cs'
24+ mlt = simplifyDNLs [x | DNLt x <- cs]
25+ mgt = simplifyDNGs [x | DNGt x <- cs]
3526 meq <- verifyDNEq [x | DNEq x <- cs]
3627 verifyEquations mgt meq mlt
3728 Just $
src/Data/Schematic/Verifier/Text.hs+61−67
@@ -1,19 +1,10 @@
11module Data.Schematic.Verifier.Text where
22
33import Control.Monad
4−import Data.List
54import Data.Maybe
6−import Data.Schematic
7−import Data.Schematic.Schema
5+import {-# SOURCE #-} Data.Schematic.Schema
86import Data.Schematic.Verifier.Common
9−import Data.Singletons
10−import Data.Singletons.Prelude
11−import Data.Singletons.TypeLits
12−import Data.Text (unpack)
13−import Data.Text (Text)
14−import Data.Text.Array (Array)
15−import GHC.Generics
16−import Text.Regex.TDFA
7+import Data.Text (Text, unpack)
178import Text.Regex.TDFA.Pattern
189import Text.Regex.TDFA.ReadRegex (parseRegex)
1910
@@ -22,29 +13,28 @@ toStrictTextLength = map f
2213 where
2314 f (DTLe x) = DTLt (x + 1)
2415 f (DTGe x) = DTGt (x - 1)
25− f x = x
16+ f x = x
2617
2718data VerifiedTextConstraint
2819 = VTEq Integer
29− | VTBounds (Maybe Integer)
30− (Maybe Integer)
31− | VTRegex Text
32− Integer
33− (Maybe Integer)
20+ | VTBounds (Maybe Integer) (Maybe Integer)
21+ | VTRegex Text Integer (Maybe Integer)
3422 | VTEnum [Text]
3523 deriving (Show)
3624
37−verifyTextLengthConstraints ::
38− [DemotedTextConstraint] -> Maybe (Maybe VerifiedTextConstraint)
25+verifyTextLengthConstraints
26+ :: [DemotedTextConstraint]
27+ -> Maybe (Maybe VerifiedTextConstraint)
3928verifyTextLengthConstraints cs' = do
40− let cs = toStrictTextLength cs'
41− mlt = simplifyDNLs [x | DTLt x <- cs]
42− mgt = simplifyDNGs [x | DTGt x <- cs]
29+ let
30+ cs = toStrictTextLength cs'
31+ mlt = simplifyDNLs [x | DTLt x <- cs]
32+ mgt = simplifyDNGs [x | DTGt x <- cs]
4333 meq <- verifyDNEq [x | DTEq x <- cs]
4434 verifyEquations mgt meq mlt
4535 case all isNothing ([mgt, meq, mlt] :: [Maybe Integer]) of
4636 True -> Just Nothing
47− _ ->
37+ _ ->
4838 Just $
4939 Just $
5040 case meq of
@@ -55,73 +45,77 @@ regexLength :: Text -> Maybe (Int, Maybe Int)
5545regexLength regexp =
5646 case parseRegex . unpack $ regexp of
5747 Right (p, _) -> Just (minRegexLength p, maxRegexLength p)
58− Left _ -> Nothing
48+ Left _ -> Nothing
5949
6050minRegexLength :: Pattern -> Int
6151minRegexLength p =
6252 case p of
63− PEmpty -> 0
64− PChar {..} -> 1
65− PAny {getPatternSet = PatternSet (Just cset) _ _ _} -> 1
66− PAnyNot {getPatternSet = PatternSet (Just cset) _ _ _} -> 1
67− PQuest p -> 0
68− PPlus p -> minRegexLength $ PBound 1 Nothing p
69− PStar _ p -> minRegexLength $ PBound 0 Nothing p
70− PBound low mhigh p -> low * minRegexLength p
71− PConcat ps -> sum $ fmap minRegexLength ps
72− POr xs -> minimum $ fmap minRegexLength xs
73− PDot _ -> 1
74− PEscape {..} -> 1
75− PCarat _ -> 0
76− PDollar _ -> 0
77− _ -> 0
53+ PEmpty -> 0
54+ PChar {..} -> 1
55+ PAny {..} -> 1
56+ PAnyNot {..} -> 1
57+ PQuest _ -> 0
58+ PPlus sch -> minRegexLength $ PBound 1 Nothing sch
59+ PStar _ sch -> minRegexLength $ PBound 0 Nothing sch
60+ PBound low _ sch -> low * minRegexLength sch
61+ PConcat ps -> sum $ fmap minRegexLength ps
62+ POr xs -> minimum $ fmap minRegexLength xs
63+ PDot _ -> 1
64+ PEscape {..} -> 1
65+ PCarat _ -> 0
66+ PDollar _ -> 0
67+ _ -> 0
7868
7969maxRegexLength :: Pattern -> Maybe Int
8070maxRegexLength p =
8171 case p of
82− PEmpty -> Just 0
83− PChar _ _ -> Just 1
84− PAny _ _ -> Just 1
85− PAnyNot _ _ -> Just 1
86− PQuest _ -> Just 0
87− PPlus _ -> Nothing
88− PStar _ _ -> Nothing
89− PBound low mhigh p -> (*) <$> mhigh <*> maxRegexLength p
90− PConcat ps -> sum <$> mapM maxRegexLength ps
91− POr xs -> maximum <$> mapM maxRegexLength xs
92− PDot _ -> Just 1
93− PEscape _ _ -> Just 1
94− PCarat _ -> Just 0
95− PDollar _ -> Just 0
96− _ -> Just 0
72+ PEmpty -> Just 0
73+ PChar _ _ -> Just 1
74+ PAny _ _ -> Just 1
75+ PAnyNot _ _ -> Just 1
76+ PQuest _ -> Just 0
77+ PPlus _ -> Nothing
78+ PStar _ _ -> Nothing
79+ PBound _ mhigh sch -> (*) <$> mhigh <*> maxRegexLength sch
80+ PConcat ps -> sum <$> mapM maxRegexLength ps
81+ POr xs -> maximum <$> mapM maxRegexLength xs
82+ PDot _ -> Just 1
83+ PEscape _ _ -> Just 1
84+ PCarat _ -> Just 0
85+ PDollar _ -> Just 0
86+ _ -> Just 0
9787
98−verifyTextRegexConstraint ::
99− [DemotedTextConstraint] -> Maybe (Maybe VerifiedTextConstraint)
88+verifyTextRegexConstraint
89+ :: [DemotedTextConstraint]
90+ -> Maybe (Maybe VerifiedTextConstraint)
10091verifyTextRegexConstraint cs = do
10192 let regexps = [x | DTRegex x <- cs]
10293 case regexps of
103− [] -> Just Nothing
94+ [] -> Just Nothing
10495 [x] -> do
10596 (l, mh) <- regexLength x
10697 Just $ Just $ VTRegex x (fromIntegral l) (fromIntegral <$> mh)
107− _ -> Nothing
98+ _ -> Nothing
10899
109−verifyTextEnumConstraint ::
110− [DemotedTextConstraint] -> Maybe (Maybe VerifiedTextConstraint)
100+verifyTextEnumConstraint
101+ :: [DemotedTextConstraint]
102+ -> Maybe (Maybe VerifiedTextConstraint)
111103verifyTextEnumConstraint cs = do
112104 let enums = concat [x | DTEnum x <- cs]
113105 case enums of
114106 [] -> Just Nothing
115− x -> Just $ Just $ VTEnum x
107+ x -> Just $ Just $ VTEnum x
116108
117−verifyTextConstraints ::
118− [DemotedTextConstraint] -> Maybe [VerifiedTextConstraint]
109+verifyTextConstraints
110+ :: [DemotedTextConstraint]
111+ -> Maybe [VerifiedTextConstraint]
119112verifyTextConstraints cs = do
120113 regexp <- verifyTextRegexConstraint cs
121− void $ case regexp of
122− Just (VTRegex _ l mh) ->
123− verifyTextLengthConstraints (DTGe l : cs ++ maybeToList (DTLe <$> mh))
124− _ -> pure Nothing
114+ void $
115+ case regexp of
116+ Just (VTRegex _ l mh) ->
117+ verifyTextLengthConstraints (DTGe l : cs ++ maybeToList (DTLe <$> mh))
118+ _ -> pure Nothing
125119 lengths <- verifyTextLengthConstraints cs
126120 enums <- verifyTextEnumConstraint cs
127121 return $ catMaybes [lengths, enums, regexp]
stack-13.7.yamlnew file+5
@@ -0,0 +1,5 @@
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
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
test/SchemaSpec.hs+13−3
@@ -33,6 +33,10 @@ type SchemaExample = 'SchemaObject
3333 '[ '("foo", 'SchemaArray '[ 'AEq 1] ('SchemaNumber '[ 'NGt 10]))
3434 , '("bar", 'SchemaOptional ('SchemaText '[ 'TEnum '["foo", "bar"]]))]
3535
36+type SchemaExample2 = 'SchemaObject
37+ '[ '("foo", 'SchemaArray '[ 'AEq 2] ('SchemaText '[ 'TGt 10]))
38+ , '("bar", 'SchemaOptional ('SchemaText '[ 'TRegex "[0-9]+"]))]
39+
3640jsonExample :: JsonRepr SchemaExample
3741jsonExample = withRepr @SchemaExample
3842 $ field @"bar" (Just "bar")
@@ -76,8 +80,11 @@ schemaJson = "{\"foo\": [13], \"bar\": null}"
7680schemaJson2 :: ByteString
7781schemaJson2 = "{\"foo\": [3], \"bar\": null}"
7882
79−schemaJsonSeries :: Monad m => SC.Series m Value
80−schemaJsonSeries = valueSeries $ fromSing (sing :: Sing SchemaExample)
83+schemaJsonSeries :: Monad m => SC.Series m (JsonRepr SchemaExample)
84+schemaJsonSeries = series
85+
86+schemaJsonSeries2 :: Monad m => SC.Series m (JsonRepr SchemaExample2)
87+schemaJsonSeries2 = series
8188
8289spec :: Spec
8390spec = do
@@ -105,7 +112,10 @@ spec = do
105112 `shouldSatisfy` isValid
106113 it "validates json series" $ property $
107114 SC.over schemaJsonSeries $ \x ->
108− isValid (parseAndValidateJson @SchemaExample x)
115+ isValid (parseAndValidateJson @SchemaExample (toJSON x))
116+ it "validates json series 2" $ property $
117+ SC.over schemaJsonSeries2 $ \x ->
118+ isValid (parseAndValidateJson @SchemaExample2 (toJSON x))
109119
110120
111121main :: IO ()