master..5e6c70a · schematic

git.iko.soy/schematic

5 files changed+22−164

unifiedsplit

src/Data/Schematic/JsonSchema.hs+9−21 src/Data/Schematic/Schema.hs−36 src/Data/Schematic/Schema.hs-boot−8 src/Data/Schematic/Validation.hs+13−41 test/JsonSchemaSpec.hs−58

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

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

3335textConstraint (DTLe n) = modify $ \s -> s

3436 { _schemaMaxLength = pure . fromIntegral $ n }

35−textConstraint (DTLt n) =

37+textConstraint (DTGt n) =

3638 let n' = if n == 0 then 0 else n - 1

37− in modify $ \s -> s { _schemaMaxLength = pure . fromIntegral $ n' }

38−textConstraint (DTGt n) = modify $ \s -> s

39− { _schemaMinLength = pure . fromIntegral $ n + 1 }

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

4040textConstraint (DTGe n) = modify $ \s -> s

4141 { _schemaMinLength = pure . fromIntegral $ n }

4242textConstraint (DTRegex r) = modify $ \s -> s { _schemaPattern = pure r }

@@ -48,30 +48,18 @@ 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

52− , _schemaExclusiveMaximum = pure True }

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

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

54− { _schemaMinimum = pure . fromIntegral $ n

55− , _schemaExclusiveMinimum = pure True }

56−numberConstraint (DNGe n) = modify $ \s -> s

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

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

5958 { _schemaMinimum = pure $ fromIntegral n

6059 , _schemaMaximum = pure $ fromIntegral n }

6160

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

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 }

62+arrayConstraint (DAEq _) = pure ()

7563

7664toJsonSchema

7765 :: forall proxy schema

src/Data/Schematic/Schema.hs−36

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

180180

181181data ArrayConstraint

182182 = AEq Nat

183− | AGt Nat

184− | AGe Nat

185− | ALt Nat

186− | ALe Nat

187183 deriving (Generic)

188184

189185data DemotedArrayConstraint

190186 = DAEq Integer

191− | DAGt Integer

192− | DAGe Integer

193− | DALt Integer

194− | DALe Integer

195187 deriving (Generic, Eq, Show)

196188

197189data instance Sing (ac :: ArrayConstraint) where

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

203191

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

209193

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

215195

216196instance SingKind ArrayConstraint where

217197 type Demote ArrayConstraint = DemotedArrayConstraint

218198 fromSing = \case

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

224200 toSing = \case

225201 DAEq n -> case someNatVal n of

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

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

240204

241205data Schema

242206 = SchemaText [TextConstraint]

src/Data/Schematic/Schema.hs-boot−8

@@ -46,17 +46,9 @@ data DemotedNumberConstraint

4646

4747data ArrayConstraint

4848 = AEq Nat

49− | AGt Nat

50− | AGe Nat

51− | ALt Nat

52− | ALe Nat

5349

5450data DemotedArrayConstraint

5551 = DAEq Integer

56− | DAGt Integer

57− | DAGe Integer

58− | DALt Integer

59− | DALe Integer

6052

6153data Schema

6254 = SchemaText [TextConstraint]

src/Data/Schematic/Validation.hs+13−41

@@ -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 should be == " <> T.pack (show nlen)

61+ errMsg = "length of " <> path <> " 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

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

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

68+ errMsg = "length of " <> path <> " 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

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

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

75+ errMsg = "length of " <> path <> " 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

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

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

82+ errMsg = "length of " <> path <> " 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

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

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

89+ errMsg = "length of " <> path <> " 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 = "must match " <> regex

96+ errMsg = path <> " 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 = "must be one of " <> T.pack (show (fromSing ss))

104+ errMsg = path <> " 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 = "should be == " <> T.pack (show nlen)

118+ errMsg = path <> " 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 = "should be > " <> T.pack (show nlen)

125+ errMsg = path <> " 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 = "should be >= " <> T.pack (show nlen)

132+ errMsg = path <> " 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 = "should be < " <> T.pack (show nlen)

139+ errMsg = path <> " 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 = "should be <= " <> T.pack (show nlen)

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

147147 warn = vWarning $ mmSingleton path (pure errMsg)

148148 unless predicate warn

149149

@@ -157,35 +157,7 @@ validateArrayConstraint (JSONPath path) v = \case

157157 let

158158 nlen = withKnownNat n $ natVal n

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

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)

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

189161 warn = vWarning $ mmSingleton path (pure errMsg)

190162 unless predicate warn

191163

test/JsonSchemaSpec.hs−58

@@ -10,7 +10,6 @@ module JsonSchemaSpec (spec, main) where

1010import Data.Aeson as J

1111import Data.Maybe

1212import Data.Proxy

13−import Data.ByteString.Lazy as B

1413import Data.Schematic

1514import Data.Vinyl

1615import JSONSchema.Draft4 as D4

@@ -32,27 +31,6 @@ exampleData = withRepr @SchemaExample $

3231 :& field @"bar" (pure (ReprText "foo"))

3332 :& RNil

3433

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−

5634spec :: Spec

5735spec = do

5836 it "validates simple schema" $ do

@@ -60,42 +38,6 @@ spec = do

6038 fetchHTTPAndValidate schema (toJSON exampleData) >>= \case

6139 Left _ -> fail "failed to validate test example"

6240 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 ()

9941

10042main :: IO ()

10143main = hspec spec