c0ef770..master · typeable/hjsonschema

git.iko.soy/typeable/hjsonschema

on master help sign in

.travis.yml+5−5

since splitsnapshots

unifiedsplit

@@ -26,15 +26,15 @@ before_cache:

27matrix:

28 include:

29− - compiler: "ghc-7.10.3"

30− # env: TEST=--disable-tests BENCH=--disable-benchmarks

31− addons: {apt: {packages: [ghc-ppa-tools,cabal-install-head,ghc-7.10.3], sources: [hvr-ghc]}}

32 - compiler: "ghc-8.0.2"

29 - compiler: "ghc-8.0.2"

33 # env: TEST=--disable-tests BENCH=--disable-benchmarks

30 # env: TEST=--disable-tests BENCH=--disable-benchmarks

34 addons: {apt: {packages: [ghc-ppa-tools,cabal-install-head,ghc-8.0.2], sources: [hvr-ghc]}}

31 addons: {apt: {packages: [ghc-ppa-tools,cabal-install-head,ghc-8.0.2], sources: [hvr-ghc]}}

35− - compiler: "ghc-8.2.1"

32+ - compiler: "ghc-8.2.2"

33+ # env: TEST=--disable-tests BENCH=--disable-benchmarks

34+ addons: {apt: {packages: [ghc-ppa-tools,cabal-install-head,ghc-8.2.2], sources: [hvr-ghc]}}

35+ - compiler: "ghc-8.4.1"

36 # env: TEST=--disable-tests BENCH=--disable-benchmarks

37− addons: {apt: {packages: [ghc-ppa-tools,cabal-install-head,ghc-8.2.1], sources: [hvr-ghc]}}

37+ addons: {apt: {packages: [ghc-ppa-tools,cabal-install-head,ghc-8.4.1], sources: [hvr-ghc]}}

39before_install:

40 - HC=${CC}

README.md+8−20

@@ -1,37 +1,25 @@

1−# Summary

1+# DEPRECATION NOTICE

3−A Haskell implementation of [JSON Schema](http://json-schema.org/) ([Draft 4](http://json-schema.org/specification-links.html)).

3+`hjsonschema` was an attempt to build a very modular JSON Schema library. Validators have [a concrete type](src/JSONSchema/Validator/Types.hs) and can be mixed and matched into new [Specs](src/JSONSchema/Types.hs).

5−[Hackage](https://hackage.haskell.org/package/hjsonschema) / [GitHub](https://github.com/seagreen/hjsonschema) / [Travis CI](https://travis-ci.org/seagreen/hjsonschema)

5+However this flexibility came at the price of complicating the code. I don't think it was the right tradeoff, especially since situations where you'd want to change what validators make up a `Spec` at runtime seem rare.

7−# Example

7+Also, there are many parts of JSON Schema that `hjsonschema` doesn't implement properly (as you can see from the issue tracker). I'm hoping that a new JSON Schema library will come along that handles these correctly. In the meantime I'm happy to merge working fixes into here.

9−See [here](https://github.com/seagreen/hjsonschema/blob/master/examples/Simple.hs).

9+# Links

11−# Design

11+[Hackage](https://hackage.haskell.org/package/hjsonschema) / [GitHub](https://github.com/seagreen/hjsonschema) / [Travis CI](https://travis-ci.org/seagreen/hjsonschema)

12−

13−`hjsonschema` was an attempt to build a very modular JSON Schema library. Validators have [a concrete type](src/JSONSchema/Validator/Types.hs) and can be mixed and matched into new [Specs](src/JSONSchema/Types.hs).

15−However this flexibility comes at the price of complicating the code. I'm no longer sure it was the right tradeoff, especially since situations where you'd want to change what validators make up a `Spec` at runtime seem rare.

13+# Example

17−Also, there are edge cases of JSON Schema that `hjsonschema` doesn't implement properly (as you can see from the issue tracker). My motivation to fix them myself has ended. However, I'll still maintain the library, give feedback on issues, and merge PRs. I'd also be happy to advise any Haskellers who are interested in writing their own JSON Schema libraries.

15+See [here](https://github.com/seagreen/hjsonschema/blob/master/examples/Simple.hs).

19# System dependencies

17# System dependencies

21+ Requires [pcre](http://www.pcre.org/) (`pkgs.pcre` in Nixpkgs).

19+ Requires [pcre](http://www.pcre.org/) (`pkgs.pcre` in Nixpkgs).

23−# Tests

24−

25−Run all: `stack test`

26−

27−Run only local tests: `stack test hjsonschema:local`

28−

29−Run only remote tests (temporarily starts an HTTP server on port 1234 and makes GETs to json-schema.org): `stack test hjsonschema:remote`

30−

31## Vendoring

21## Vendoring

33+ `JSON-Schema-Test-Suite` is vendored from commit # c1b12bf699f29a04b4286711c6e3bbfba66f21e5 [here](https://github.com/json-schema-org/JSON-Schema-Test-Suite).

23+ `JSON-Schema-Test-Suite` is vendored from commit # c1b12bf699f29a04b4286711c6e3bbfba66f21e5 [here](https://github.com/json-schema-org/JSON-Schema-Test-Suite).

35+ `src/draft4.json` is from commit # c1b12bf699f29a04b4286711c6e3bbfba66f21e5 [here](https://github.com/json-schema/json-schema). The [root ref in remote ref](./JSON-Schema-Test-Suite/tests/draft4/refRemote.json) test has been modified to fix [#175](https://github.com/json-schema-org/JSON-Schema-Test-Suite/issues/175).

25+ `src/draft4.json` is from commit # c1b12bf699f29a04b4286711c6e3bbfba66f21e5 [here](https://github.com/json-schema/json-schema). The [root ref in remote ref](./JSON-Schema-Test-Suite/tests/draft4/refRemote.json) test has been modified to fix [#175](https://github.com/json-schema-org/JSON-Schema-Test-Suite/issues/175).

36−

37−+ `.travis.yml` was created with `make_travis_yml_2.hs` commit # ea6c7d177a97bfbfb2fdc4deba943d60d2aff199.

changelog.md+6

@@ -1,5 +1,11 @@

1# 1.8.0

3++ Add GHC 8.4 support (thanks @4e6 !).

4++ Drop GHC 7.10 support.

5++ Fix JSON Pointer resolution error.

7+# 1.8.0

3+ Allow HTTPS references (thanks @creichert!).

9+ Allow HTTPS references (thanks @creichert!).

4+ Use `safe-exceptions` to eliminate the risk of catching asynchronous exceptions.

10+ Use `safe-exceptions` to eliminate the risk of catching asynchronous exceptions.

hjsonschema.cabal+2−5

@@ -1,5 +1,5 @@

1name: hjsonschema

2−version: 1.8.0

2+version: 1.9.0

3synopsis: JSON Schema library

4homepage: https://github.com/seagreen/hjsonschema

5license: MIT

@@ -10,7 +10,7 @@ category: Data

10build-type: Simple

11cabal-version: >=1.10

12-- Rerun multi-ghc-travis (executable make-travis-yml-2) after changing:

13−Tested-With: GHC == 7.10.3, GHC == 8.0.2, GHC == 8.2.1

13+Tested-With: GHC == 8.0.2, GHC == 8.2.2, GHC == 8.4.1

14extra-source-files:

15 changelog.md

16 JSON-Schema-Test-Suite/remotes/*.json

@@ -77,7 +77,6 @@ library

77 , QuickCheck >= 2.8

78 , safe-exceptions >= 0.1.6

79 , scientific >= 0.3

80− , semigroups >= 0.18

81 , unordered-containers >= 0.2

80 , unordered-containers >= 0.2

82 , text >= 1.1

81 , text >= 1.1

83 , vector >= 0.10

82 , vector >= 0.10

@@ -115,7 +114,6 @@ test-suite local

115 , hjsonschema

114 , hjsonschema

116 , profunctors

115 , profunctors

117 , protolude

116 , protolude

118− , semigroups

119 , text

117 , text

120 , QuickCheck

118 , QuickCheck

121 , unordered-containers

119 , unordered-containers

@@ -154,7 +152,6 @@ test-suite remote

154 , hjsonschema

152 , hjsonschema

155 , profunctors

153 , profunctors

156 , protolude

154 , protolude

157− , semigroups

158 , text

155 , text

159 , unordered-containers

156 , unordered-containers

160 , vector

157 , vector

src/JSONSchema/Fetch.hs+2−1

@@ -7,6 +7,7 @@ import Control.Monad (foldM)

7import qualified Data.ByteString as BS

8import qualified Data.ByteString.Lazy as LBS

9import qualified Data.HashMap.Strict as HM

10+import qualified Data.Semigroup as S

10import qualified Data.Text as T

11import qualified Data.Text as T

11import qualified Network.HTTP.Client as NC

12import qualified Network.HTTP.Client as NC

12import qualified Network.HTTP.Client.TLS as NCTLS

13import qualified Network.HTTP.Client.TLS as NCTLS

@@ -29,7 +30,7 @@ data FetchInfo schema = FetchInfo

29-- | Keys are URIs (without URI fragments).

30-- | Keys are URIs (without URI fragments).

30newtype URISchemaMap schema

31newtype URISchemaMap schema

31 = URISchemaMap { _unURISchemaMap :: HashMap Text schema }

32 = URISchemaMap { _unURISchemaMap :: HashMap Text schema }

32− deriving (Eq, Show, Monoid)

33+ deriving (Eq, Show, S.Semigroup, Monoid)

34-- | A top-level schema along with its location.

35-- | A top-level schema along with its location.

35data SchemaWithURI schema = SchemaWithURI

36data SchemaWithURI schema = SchemaWithURI

src/JSONSchema/Validator/Draft4/Any.hs+32−8

@@ -4,6 +4,7 @@ import Import hiding ((<>))

5import Data.Aeson.TH (constructorTagModifier)

6import Data.Char (toLower)

7+import qualified Data.HashMap.Strict as HM

7import Data.List.NonEmpty (NonEmpty((:|)))

8import Data.List.NonEmpty (NonEmpty((:|)))

8import qualified Data.List.NonEmpty as NE

9import qualified Data.List.NonEmpty as NE

9import qualified Data.Scientific as SCI

10import qualified Data.Scientific as SCI

@@ -133,7 +134,7 @@ data JSONPointerError

133 deriving (Eq, Show)

134 deriving (Eq, Show)

134

135

135resolveFragment

136resolveFragment

136− :: forall schema. (FromJSON schema, ToJSON schema)

137+ :: (FromJSON schema, ToJSON schema)

137 => (BaseURI -> schema -> BaseURI)

138 => (BaseURI -> schema -> BaseURI)

138 -> Scope schema

139 -> Scope schema

139 -> Text

140 -> Text

@@ -158,17 +159,40 @@ resolveFragment updateScope scope fragment = do

158 -- as property keys that aren't meant to change scope?

159 -- as property keys that aren't meant to change scope?

159 -- Perhaps this should be added to the language agnostic

160 -- Perhaps this should be added to the language agnostic

160 -- test suite as well.

161 -- test suite as well.

162+ --

163+ -- In the meantime 'newBaseURIFromFragment' drops all keys

164+ -- from JSON objects except "id", which at least prevents

165+ -- SubschemaDecodingError in a situation where one of the

166+ -- values we step through isn't a valid schema.

161 go :: (Value, BaseURI)

167 go :: (Value, BaseURI)

162 -> JP.Token

168 -> JP.Token

163 -> Either JSONPointerError (Value, BaseURI)

169 -> Either JSONPointerError (Value, BaseURI)

164− go (lastVal, uri) tok = do

170+ go (lastVal, baseURI) tok = do

165 v <- first ResolutionError (JP.resolveToken tok lastVal)

171 v <- first ResolutionError (JP.resolveToken tok lastVal)

166− case v of

172+ newBase <- newBaseURIFromFragment updateScope baseURI v

167− Array _ -> pure (v, uri)

173+ Right (v, newBase)

168− _ -> do

174+

169− -- PERFORMANCE: Avoid deserializing subschemas.

175+-- | Update the 'BaseURI' (the store of the current "id" value)

176+-- after resolving one token of a JSON Pointer and stepping into

177+-- a new 'Value'.

178+newBaseURIFromFragment

179+ :: FromJSON schema

180+ => (BaseURI -> schema -> BaseURI)

181+ -> BaseURI

182+ -> Value

183+ -> Either JSONPointerError BaseURI

184+newBaseURIFromFragment updateScope baseURI v =

185+ case v of

186+ Object hm -> do

187+ let hmWithOnlyId = case HM.lookup idKey hm of

188+ Nothing -> mempty

189+ Just idVal -> HM.singleton idKey idVal

170− schema <- first SubschemaDecodingError (fromJSONEither v)

190+ schema <- first SubschemaDecodingError (fromJSONEither (Object hmWithOnlyId))

171− pure (v, updateScope uri schema)

191+ Right (updateScope baseURI schema)

192+ _ -> Right baseURI

193+ where

194+ idKey :: Text

195+ idKey = "id"

172

196

173--------------------------------------------------

197--------------------------------------------------

174-- * enum

198-- * enum