280ea5d · typeable/schematic

git.iko.soy/typeable/schematic

Add array constraints. Fix the generation of text and number constraints.

commit280ea5dd4259751a59120de53c9ff6e6a403e588 authorEvgenii Akentev <i@ak3n.com> dateTue 30 Apr 2019, 19:09 (7 years ago) parentef8ab4d

5 files changed+151−10

compare with master

unifiedsplit

src/Data/Schematic/JsonSchema.hs+21−10 src/Data/Schematic/Schema.hs+36 src/Data/Schematic/Schema.hs-boot+8 src/Data/Schematic/Validation.hs+28 test/JsonSchemaSpec.hs+58

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

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

@@ -47,19 +47,30 @@ textConstraint (DTEnum ss) =

4747numberConstraint :: DemotedNumberConstraint -> State D4.Schema ()

4848numberConstraint (DNLe n) = modify $ \s -> s

4949 { _schemaMaximum = pure . fromIntegral $ n }

50−numberConstraint (DNLt n) = modify $ \s -> s

51− { _schemaMaximum = pure . fromIntegral $ n + 1 }

50+numberConstraint (DNLt n) =

51+ let n' = if n == 0 then 0 else n - 1

52+ in modify $ \s -> s { _schemaMaximum = pure . fromIntegral $ n' }

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

54+ { _schemaMinimum = pure . fromIntegral $ n + 1 }

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

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

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

5858 { _schemaMinimum = pure $ fromIntegral n

5959 , _schemaMaximum = pure $ fromIntegral n }

6060

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

62−arrayConstraint (DAEq _) = pure ()

62+arrayConstraint (DALe n) = modify $ \s -> s

63+ { _schemaMaxItems = pure . fromIntegral $ n }

64+arrayConstraint (DALt n) =

65+ let n' = if n == 0 then 0 else n - 1

66+ in modify $ \s -> s { _schemaMaxItems = pure . fromIntegral $ n' }

67+arrayConstraint (DAGt n) = modify $ \s -> s

68+ { _schemaMinItems = pure . fromIntegral $ n + 1 }

69+arrayConstraint (DAGe n) = modify $ \s -> s

70+ { _schemaMinItems = pure . fromIntegral $ n }

71+arrayConstraint (DAEq n) = modify $ \s -> s

72+ { _schemaMinItems = pure $ fromIntegral n

73+ , _schemaMaxItems = pure $ fromIntegral n }

6374

6475toJsonSchema

6576 :: forall proxy schema

src/Data/Schematic/Schema.hs+36

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

180180

181181data ArrayConstraint

182182 = AEq Nat

183+ | AGt Nat

184+ | AGe Nat

185+ | ALt Nat

186+ | ALe Nat

183187 deriving (Generic)

184188

185189data DemotedArrayConstraint

186190 = DAEq Integer

191+ | DAGt Integer

192+ | DAGe Integer

193+ | DALt Integer

194+ | DALe Integer

187195 deriving (Generic, Eq, Show)

188196

189197data instance Sing (ac :: ArrayConstraint) where

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

191203

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

193209

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

195215

196216instance SingKind ArrayConstraint where

197217 type Demote ArrayConstraint = DemotedArrayConstraint

198218 fromSing = \case

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

200224 toSing = \case

201225 DAEq n -> case someNatVal n of

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

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

204240

205241data Schema

206242 = SchemaText [TextConstraint]

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+28

@@ -160,6 +160,34 @@ validateArrayConstraint (JSONPath path) v = \case

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

161161 warn = vWarning $ mmSingleton path (pure errMsg)

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

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

190+ unless predicate warn

163191

164192validateJsonRepr

165193 :: Sing schema

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

80+ :& field @"n2" 1

81+ :& field @"n3" 0

82+ :& field @"n4" 1

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