git.iko.soy/typeable/schematic
on master help sign in
swap
7db0b4694 ahead, 0 behind
.travis.yml+2−2
since splitsnapshots
unifiedsplit
@@ -1,4 +1,4 @@
1−sudo: false
1+sudo: required
2
2
3language: c
3language: c
4
4
@@ -22,4 +22,4 @@ script:
22
22
23cache:
23cache:
24 directories:
24 directories:
25− - $HOME/.stack
25+ - $HOME/.stack
ChangeLog.md+56
@@ -1,5 +1,61 @@
1# Revision history for schematic
1# Revision history for schematic
2
2
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+
19+## 0.4.3.0 -- 2018-07-12
20+
21+GHC 8.4 support, dropping support for older GHC versions
22+
23+## 0.4.2.0
24+
25+Support ghc-8.4 and drop support for older versions
26+
27+## 0.4.1.0 -- 2017-11-05
28+
29+Convenience isomorphisms: txt, num, opt, bln etc
30+
31+## 0.4.1.0 -- 2017-11-01
32+
33+flens and fget now use type application syntax
34+
35+## 0.4.0.0 -- 2017-10-17
36+
37+Object building DSL, more convenience helpers, MCons simplified with Tagged
38+
39+## 0.3.2.0 -- 2017-10-02
40+
41+Fixed FIndex bug, added bunch of convenience isomorphism, re-exports.
42+
43+## 0.3.1.0 -- 2017-09-28
44+
45+Add UUID and ISO8601 helpers, json schema constraint export, fsubset lens
46+combinator.
47+
48+## 0.3.0.0 -- 2017-09-28
49+
50+Updated to GHC 8.2.1 and singletons 2.3.1
51+
52+## 0.2.1.0 -- 2017-09-26
53+
54+Add decodeAndValidateVersionedWithPureMList, fix tests
55+
56+## 0.2.0.0 -- 2017-09-26
57+
58+Migratable is deprecated, migrations are now possible in an arbitrary monad.
3
59
4## 0.1.5.0 -- 2017-08-22
60## 0.1.5.0 -- 2017-08-22
5
61
README.md+145−26
@@ -22,9 +22,35 @@ Be aware that library is experimental and subject to change a lot. The current s
22$ stack install schematic
22$ stack install schematic
23```
23```
24
24
25−## Basic Examples
25+## GHC Extensions
26+
27+To use this library without any hassle you should add a few GHC extension
28+either to a module or a cabal file:
26
29
27```
30```
31+DataKinds
32+OverloadedLists
33+OverloadedStrings
34+TypeApplications
35+```
36+
37+`Overloaded`-extensions are being used only by `field` combinator,
38+so if you don't use it - feel free to disable it.
39+
40+## GHC Options
41+
42+I recommend using `{-# OPTIONS_GHC -fno-warn-unticked-promoted-constructors #-}`
43+pragma in modules which declare schemas and schema migrations, because `schematic`
44+heavily uses promoted types which should be prefixed with "`" signs and they can
45+be dropped with this option, making it less noisy visually.
46+It's entirely optional and totally opinionated, so feel free to ignore this.
47+Through the documentation, the code is written without any explicit ticks for
48+the same reason.
49+Notice that they're still needed for type-level lists and tuples in schematic code.
50+
51+## Basic Examples
52+
53+```haskell
28type SchemaExample
54type SchemaExample
29 = SchemaObject
55 = SchemaObject
30 '[ '("foo", SchemaArray '[AEq 1] (SchemaNumber '[NGt 10]))
56 '[ '("foo", SchemaArray '[AEq 1] (SchemaNumber '[NGt 10]))
@@ -42,21 +68,21 @@ type SchemaExample
42
68
43This one is valid for example
69This one is valid for example
44
70
45−```
71+```haskell
46schemaJson :: ByteString
72schemaJson :: ByteString
47schemaJson = "{\"foo\": [13], \"bar\": null}"
73schemaJson = "{\"foo\": [13], \"bar\": null}"
48```
74```
49
75
50Also valid
76Also valid
51
77
52−```
78+```haskell
53schemaJson :: ByteString
79schemaJson :: ByteString
54schemaJson = "{\"foo\": [13], \"bar\": \"bar\"}"
80schemaJson = "{\"foo\": [13], \"bar\": \"bar\"}"
55```
81```
56
82
57it can be parsed and validated like this:
83it can be parsed and validated like this:
58
84
59−```
85+```haskell
60decodeAndValidateJson schemaJson :: ParseResult (JsonRepr SchemaExample)
86decodeAndValidateJson schemaJson :: ParseResult (JsonRepr SchemaExample)
61```
87```
62
88
@@ -66,24 +92,64 @@ decodeAndValidateJson schemaJson :: ParseResult (JsonRepr SchemaExample)
66* some of the runtime validations have failed, but it's structurally correct
92* some of the runtime validations have failed, but it's structurally correct
67 overall
93 overall
68
94
69−It implies a transport layer representation of that data that can be traversed and transformed to whatever internal types user has. It's called `JsonRepr`. Type parameter is the schema itself.
95+It implies a transport layer representation of that data that can be traversed
96+and transformed to whatever internal types user has.
97+It's called `JsonRepr`. Type parameter is the schema itself.
98+
99+```haskell
100+jsonExample :: JsonRepr SchemaExample
101+jsonExample = withRepr @SchemaExample
102+ $ field @"foo" [12]
103+ :& field @"bar" (Just "bar")
104+ :& RNil
105+```
70
106
107+The most basic and sugar-free way of constructing the same object will look like this:
71
108
72```
109```
73−jsonExample :: JsonRepr SchemaExample
110+jsonExample' :: JsonRepr SchemaExample
74−jsonExample = ReprObject $
111+jsonExample' = ReprObject $
75 FieldRepr (ReprArray [ReprNumber 12])
112 FieldRepr (ReprArray [ReprNumber 12])
76 :& FieldRepr (ReprOptional (Just (ReprText "bar")))
113 :& FieldRepr (ReprOptional (Just (ReprText "bar")))
77 :& RNil
114 :& RNil
78```
115```
79
116
117+## Lens-compatibility
118+
119+It's possible to use `flens` to construct a field lens for a typed object in schematic. Let's suppose you have a schema like this:
120+
121+```haskell
122+type ArraySchema = SchemaArray '[AEq 1] (SchemaNumber '[NGt 10])
123+
124+type ArrayField = '("foo", ArraySchema)
125+
126+type FieldsSchema =
127+ '[ ArrayField, '("bar", SchemaOptional (SchemaText '[TEnum '["foo", "bar"]]))]
128+
129+type SchemaExample = 'SchemaObject FieldsSchema
130+
131+```
132+
133+There are two ways of working with named fields in the objects:
134+
135+* Using the `fget` and `fset` functions: `fget @"foo" (fput newFooVal objectData) == newFooVal`
136+* Using the lens library: `set (flens @"foo") newFooVal objectData ^. flens @"foo" == newFooVal`
137+
80## Migrations
138## Migrations
81
139
140+Usually migrations are implicit and hard to deal with, `schematic` deals with it
141+by giving tools to deal with it to a programmer, being as explicit as possible,
142+notifying the developer of a missing transition with a compile-time error.
143+It allows to build versioned HTTP APIs or migrate data from the older versions
144+when reading from the JSON storages.
145+
146+It's possible to represent schema changes as a series of migrations,
82−It's possible to represent schema changes as a series of migrations, which describes a series of json-path/change pairs. Migrations can be applied in succession.
147+which describes a series of json-path/change pairs. Migrations can be applied in
148+succession.
83
149
84This piece of code will apply a migration to the schema, decode and validate the latest version.
150This piece of code will apply a migration to the schema, decode and validate the latest version.
85
151
86−```
152+```haskell
87type SchemaExample
153type SchemaExample
88 = SchemaObject
154 = SchemaObject
89 '[ '("foo", SchemaArray '[AEq 1] (SchemaNumber '[NGt 10]))
155 '[ '("foo", SchemaArray '[AEq 1] (SchemaNumber '[NGt 10]))
@@ -91,8 +157,8 @@ type SchemaExample
91
157
92type TestMigration =
158type TestMigration =
93 'Migration "test_revision"
159 'Migration "test_revision"
94− '[ 'Diff '[ 'PKey "bar" ] ('Update ('SchemaText '[]))
160+ '[ Diff '[ PKey "bar" ] (Update (SchemaText '[]))
95− , 'Diff '[ 'PKey "foo" ] ('Update ('SchemaNumber '[])) ]
161+ , Diff '[ PKey "foo" ] (Update (SchemaNumber '[])) ]
96
162
97type VS = 'Versioned SchemaExample '[ TestMigration ]
163type VS = 'Versioned SchemaExample '[ TestMigration ]
98
164
@@ -106,31 +172,84 @@ It's possible to decode the latest version like this:
106decodeAndValidateJson schemaJsonTopVersion :: ParseResult (JsonRepr (TopVersion (AllVersions VS)))
172decodeAndValidateJson schemaJsonTopVersion :: ParseResult (JsonRepr (TopVersion (AllVersions VS)))
107```
173```
108
174
109−## Lens-compatibility
175+It's important to differentiate between schema migrations and data migrations.
176+Schema migration is a change of a schema acceptable by a JSON consumer. It transforms one schema to another.
177+Data migrations on the other hand are functions on the data itself. They transform values
178+acceptable by one schema to values acceptable by another.
179+Let's look at the situation when we have to add a field to a JSON Object of a current schema:
110
180
111−It's possible to use `flens` to construct a field lens for a typed object in schematic. Let's suppose you have a schema like this:
181+```haskell
182+type SchemaExample = 'SchemaObject
183+ '[ '("foo", 'SchemaArray '[ 'AEq 1] ('SchemaNumber '[ 'NGt 10]))
184+ , '("bar", 'SchemaOptional ('SchemaText '[ 'TEnum '["foo", "bar"]]))]
112
185
113−```
186+jsonExample :: JsonRepr SchemaExample
114−type ArraySchema = 'SchemaArray '[AEq 1] ('SchemaNumber '[NGt 10])
187+jsonExample = withRepr @SchemaExample
188+ $ field @"bar" (Just "bar")
189+ :& field @"foo" [12]
190+ :& RNil
115
191
116−type ArrayField = '("foo", ArraySchema)
192+type AddQuuz =
193+ 'Migration "add_field_quuz"
194+ '[ 'Diff '[] ('AddKey "quuz" (SchemaNumber '[])) ]
117
195
118−type FieldsSchema =
196+type DeleteQuuz =
119− '[ ArrayField, '("bar", 'SchemaOptional ('SchemaText '[TEnum '["foo", "bar"]]))]
197+ 'Migration "remove_field_quuz"
198+ '[ 'Diff '[] ( 'DeleteKey "quuz") ]
120
199
121−type SchemaExample = 'SchemaObject FieldsSchema
200+type Migrations = '[ AddQuuz
201+ , DeleteQuuz ]
202+
203+type VersionedJson = 'Versioned SchemaExample Migrations
204+
205+migrationList :: MigrationList Identity VersionedJson
206+migrationList
207+ = (migrateObject (\r -> Identity $ field @"quuz" 42 :& r))
208+ :&& shrinkObject
209+ :&& MNil
122
210
123```
211```
124
212
125−There are two ways of working with named fields in the objects:
213+In this instance `Migrations` is a list of schema migrations and
214+`MigrationList Identity VersionedJson` is a list of data migrations corresponding
215+to the list of schema migrations: `migrateObject (\r -> Identity $ field @"quuz" 42 :& r))`
216+will be used at runtime to transform `JsonRepr SchemaExample` to
217+`JsonRepr (SchemaByRevision "add_quuz" VersionedJson). `Identity` in the type of
218+`MigrationList` is a monad we choose to run our migrations in. If there's need to
219+do database queries or something like that, it can be changed to something more
220+appropriate by a user.
221+`migrateObject` takes a function transforming old fields into new ones, `shrinkObject`
222+allows to shrink the JSON object in case migration only removed fields.
126
223
127−* Using the `fget` and `fset` functions: `fget fooProxy (fput newFooVal objectData) == newFooVal`
224+## How do I construct a value of `JsonRepr schema`?
128−* Using the lens library: `set (flens (Proxy @"foo")) newFooVal objectData ^. flens (Proxy @"foo") == newFooVal`
129
225
130−## Export to json-schema (draft 4)
226+`JsonRepr schema` is a primary representation of a value serializable/deserializable
227+to JSON, but with a twist. It's guaranteed to correspond a type-level schema,
228+it's a type parameter of a same name.
229+It makes constructing it a little bit more involved, but luckily `schematic`
230+provides a DSL for doing so in a more straightforward fashion. An example would
231+look like this:
131
232
233+```haskell
234+type SchemaExample = 'SchemaObject
235+ '[ '("foo", SchemaArray '[ AEq 1] (SchemaNumber '[NGt 10]))
236+ , '("bar", SchemaOptional (SchemaText '[TEnum '["foo", "bar"]]))]
132
237
133−## TODO
238+jsonExample = withRepr @SchemaExample
239+ $ field @"bar" (Just "bar")
240+ :& field @"foo" [12]
241+ :& RNil
242+```
243+
244+`@foo` syntax is an explicit type application, which is a feature of GHC 8+, it
245+makes type inference possible without relying on a bunch of `Proxy`s, which
246+makes it syntactically more terse.
247+
248+[GHC Type Applications](https://ghc.haskell.org/trac/ghc/wiki/TypeApplication)
134
249
135−* Overall user friendliness
250+`schematic` provides instances for `OverloadedLists` and `OverloadedStrings`
136−* Versioned http endpoints
251+GHC extensions to make use of string and list literals for values in a previous
252+example.
253+
254+
255+## Export to json-schema (draft 4)
releasenew file+43
@@ -0,0 +1,43 @@
1+#!/bin/bash
2+
3+set -o xtrace
4+
5+dist=`stack path --dist-dir --stack-yaml ./stack.yaml 2> /dev/null`
6+
7+rootdir=`pwd`
8+
9+cabalfile=`ls *.cabal`
10+packagename="${cabalfile%%.*}"
11+version=`grep '^version:' schematic.cabal | rev | cut -d" " -f1 | rev`
12+
13+echo -e "\033[1;36mTesting library...\033[0m"
14+stack test 2> /dev/null
15+
16+echo -e "\033[1;36mRunning sdist...\033[0m"
17+cabal sdist
18+
19+echo -e "\033[1;36mGenerating documentation...\033[0m"
20+stack haddock 2> /dev/null
21+
22+if [ "$?" -eq "0" ]; then
23+ echo -e "\033[1;32mUploading package to Hackage...\033[0m"
24+ read -p "Hackage username: " username
25+ read -p "Hackage password: " -s password
26+ echo ""
27+ cabal upload -u $username -p $password dist/$packagename-$version.tar.gz
28+
29+ docdir=`find .stack-work -name "$packagename-$version-docs"`
30+
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
33+ echo -e "\033[1;32mUploading documentation to Hackage...\033[0m"
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'."
40+ exit $?
41+else
42+ echo -e "\033[1;31mNot in a stack-powered project\033[0m"
43+fi
release.nixnew file+32
@@ -0,0 +1,32 @@
1+{ schematicSrc ? { outPath = ./.; revCount = 0; gitTag = "dirty"; }
2+, supportedSystems ? [ "x86_64-linux" ]
3+}:
4+
5+let
6+ _nixpkgs = import <nixpkgs> {};
7+ inherit (_nixpkgs) pkgs lib;
8+
9+ stackageOverlayPath = pkgs.fetchFromGitHub {
10+ owner = "typeable";
11+ repo = "nixpkgs-stackage";
12+ rev = "abe0a03ba2bde609b0707ce45301ec836cb3ed29";
13+ sha256 = "0ksdk83zbsgvs30izwsfyjh4xxwz8dsn9a5igrs3pjap4whpzqfv";
14+ };
15+
16+ nixpkgsArgs = {
17+ overlays = [ (import stackageOverlayPath) ];
18+ };
19+
20+ release = import <nixpkgs/pkgs/top-level/release-lib.nix> { inherit nixpkgsArgs supportedSystems; };
21+
22+ mkStackage = system:
23+ let
24+ nixpkgs = release.pkgsFor system;
25+ stackage = nixpkgs.haskell.packages.stackage.lib.callStackage2nix "schematic" schematicSrc { inherit nixpkgs; };
26+ in
27+ stackage;
28+
29+in
30+ lib.genAttrs supportedSystems (system: {
31+ inherit (mkStackage system) schematic;
32+ })
schematic.cabal+34−47
@@ -1,37 +1,43 @@
1−-- Initial schematic.cabal generated by cabal init. For further
2−-- documentation, see http://haskell.org/cabal/users-guide/
3−
4name: schematic
1name: schematic
5−version: 0.1.6.0
2+version: 0.6.0.0
6synopsis: JSON-biased spec and validation tool
3synopsis: JSON-biased spec and validation tool
7−-- description:
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.
8license: BSD3
5license: BSD3
9license-file: LICENSE
6license-file: LICENSE
10author: Denis Redozubov
7author: Denis Redozubov
11maintainer: denis.redozubov@gmail.com
8maintainer: denis.redozubov@gmail.com
12−-- copyright:
9+homepage: http://github.com/typeable/schematic
10+Bug-reports: http://github.com/typeable/schematic/issues/
13category: Data
11category: Data
14build-type: Simple
12build-type: Simple
15−extra-source-files: ChangeLog.md
13+extra-source-files: ChangeLog.md, README.md
16cabal-version: >=1.10
14cabal-version: >=1.10
17
15
18library
16library
19 exposed-modules: Data.Schematic
17 exposed-modules: Data.Schematic
18+ , Data.Schematic.DSL
19+ , Data.Schematic.Generator
20+ , Data.Schematic.Generator.Regex
20 , Data.Schematic.Instances
21 , Data.Schematic.Instances
21 , Data.Schematic.JsonSchema
22 , Data.Schematic.JsonSchema
23+ , Data.Schematic.Helpers
22 , Data.Schematic.Lens
24 , Data.Schematic.Lens
23 , Data.Schematic.Migration
25 , Data.Schematic.Migration
24 , Data.Schematic.Path
26 , Data.Schematic.Path
25 , Data.Schematic.Schema
27 , Data.Schematic.Schema
26 , Data.Schematic.Validation
28 , Data.Schematic.Validation
27− , Data.Schematic.Utils
29+ , Data.Schematic.Verifier
30+ , Data.Schematic.Verifier.Array
31+ , Data.Schematic.Verifier.Common
32+ , Data.Schematic.Verifier.Number
33+ , Data.Schematic.Verifier.Text
28 ghc-options: -Wall
34 ghc-options: -Wall
29− -- other-modules:
30 default-extensions: ConstraintKinds
35 default-extensions: ConstraintKinds
31 , DataKinds
36 , DataKinds
32 , DefaultSignatures
37 , DefaultSignatures
33 , DeriveFunctor
38 , DeriveFunctor
34 , DeriveFoldable
39 , DeriveFoldable
40+ , DeriveTraversable
35 , DeriveGeneric
41 , DeriveGeneric
36 , DeriveDataTypeable
42 , DeriveDataTypeable
37 , FlexibleContexts
43 , FlexibleContexts
@@ -59,21 +65,24 @@ library
59 , TypeOperators
65 , TypeOperators
60 , TypeSynonymInstances
66 , TypeSynonymInstances
61 , UndecidableInstances
67 , UndecidableInstances
62− build-depends: base >=4.9 && <4.10
68+ build-depends: base >=4.11 && <5
63 , bytestring
69 , bytestring
64− , aeson >= 1
70+ , aeson >= 1.4.3.0 && < 1.6
65 , containers
71 , containers
66 , hjsonschema
72 , hjsonschema
67 , mtl
73 , mtl
74+ , profunctors
75+ , regex-tdfa
68− , regex-compat
76+ , regex-tdfa-text
69 , scientific
77 , scientific
70− , singletons >= 2.2
78+ , singletons >= 2.4
71 , smallcheck
79 , smallcheck
72− , smallcheck-series
73 , tagged
80 , tagged
81+ , template-haskell
74 , text
82 , text
83+ , union
75 , unordered-containers
84 , unordered-containers
76− , validationt >= 0.1.0.1
85+ , validationt >= 0.2.1.0
77 , vector
86 , vector
78 , vinyl
87 , vinyl
79 hs-source-dirs: src
88 hs-source-dirs: src
@@ -84,36 +93,9 @@ test-suite spec
84 hs-source-dirs: test
93 hs-source-dirs: test
85 main-is: Spec.hs
94 main-is: Spec.hs
86 default-language: Haskell2010
95 default-language: Haskell2010
87− default-extensions: ConstraintKinds
88− , DataKinds
89− , DeriveFunctor
90− , DeriveFoldable
91− , DeriveGeneric
92− , DeriveDataTypeable
93− , FlexibleContexts
94− , FlexibleInstances
95− , FunctionalDependencies
96− , GADTs
97− , KindSignatures
98− , InstanceSigs
99− , LambdaCase
100− , MultiParamTypeClasses
101− , OverloadedLists
102− , OverloadedStrings
103− , PolyKinds
104− , QuasiQuotes
105− , PartialTypeSignatures
106− , RecordWildCards
107− , ScopedTypeVariables
108− , TemplateHaskell
109− , TypeApplications
110− , TypeFamilies
111− , TypeInType
112− , TypeOperators
113− , TypeSynonymInstances
114 build-depends: HUnit
96 build-depends: HUnit
115 , aeson >= 1
97 , aeson >= 1
116− , base >=4.9 && <4.10
98+ , base >=4.11 && <4.13
117 , bytestring
99 , bytestring
118 , containers
100 , containers
119 , hjsonschema
101 , hjsonschema
@@ -122,16 +104,21 @@ test-suite spec
122 , hspec-discover
104 , hspec-discover
123 , hspec-smallcheck
105 , hspec-smallcheck
124 , lens
106 , lens
125− , regex-compat
107+ , regex-tdfa
108+ , regex-tdfa-text
126 , schematic
109 , schematic
127 , smallcheck
110 , smallcheck
128− , smallcheck-series
129 , singletons
111 , singletons
130 , tagged
112 , tagged
131 , text
113 , text
132 , unordered-containers
114 , unordered-containers
133− , validationt >= 0.1.0.1
115+ , validationt >= 0.2.1.0
134 , vinyl
116 , vinyl
135 other-modules: SchemaSpec
117 other-modules: SchemaSpec
118+ , HelpersSpec
136 , LensSpec
119 , LensSpec
137− , JsonSchemaSpec
120+ , JsonSchemaSpec
121+
122+source-repository head
123+ type: git
124+ location: https://github.com/typeable/schematic
src/Data/Schematic.hs+36−82
@@ -3,63 +3,42 @@
3
3
4module Data.Schematic
4module Data.Schematic
5 ( module Data.Schematic.JsonSchema
5 ( module Data.Schematic.JsonSchema
6− , module Data.Schematic.Schema
6+ , module Data.Schematic.Helpers
7 , module Data.Schematic.Lens
7 , module Data.Schematic.Lens
8 , module Data.Schematic.Migration
8 , module Data.Schematic.Migration
9− , module Data.Schematic.Utils
9+ , module Data.Schematic.Schema
10 , decodeAndValidateJson
10 , decodeAndValidateJson
11 , parseAndValidateJson
11 , parseAndValidateJson
12 , parseAndValidateJsonBy
12 , parseAndValidateJsonBy
13− , parseAndValidateVersionedJson
14 , parseAndValidateTopVersionJson
13 , parseAndValidateTopVersionJson
15− , decodeAndValidateVersionedJson
16 , parseAndValidateWithMList
14 , parseAndValidateWithMList
17 , decodeAndValidateVersionedWithMList
15 , decodeAndValidateVersionedWithMList
16+ , decodeAndValidateVersionedWithPureMList
18 , isValid
17 , isValid
19 , isDecodingError
18 , isDecodingError
20 , isValidationError
19 , isValidationError
21 , ParseResult(..)
20 , ParseResult(..)
22− , Migratable
21+ , withRepr
22+ , field
23 ) where
23 ) where
24
24
25import Control.Monad.Validation
25import Control.Monad.Validation
26import Data.Aeson as J
26import Data.Aeson as J
27import Data.Aeson.Types as J
27import Data.Aeson.Types as J
28import Data.ByteString.Lazy as BL
28import Data.ByteString.Lazy as BL
29−import Data.Functor.Identity
29+import Data.Functor.Identity as F
30+import Data.Schematic.DSL
31+import Data.Schematic.Helpers
30import Data.Schematic.JsonSchema
32import Data.Schematic.JsonSchema
31import Data.Schematic.Lens
33import Data.Schematic.Lens
32import Data.Schematic.Migration
34import Data.Schematic.Migration
33import Data.Schematic.Schema
35import Data.Schematic.Schema
34−import Data.Schematic.Utils
35import Data.Schematic.Validation
36import Data.Schematic.Validation
36−import Data.Singletons.Prelude
37+import Data.Singletons.Prelude hiding ((:.))
38+import Data.Tagged
37import Data.Text as T
39import Data.Text as T
38
40
39
41
40−parseAndValidateJson
41− :: forall schema
42− . (J.FromJSON (JsonRepr schema), TopLevel schema, SingI schema)
43− => J.Value
44− -> ParseResult (JsonRepr schema)
45−parseAndValidateJson v =
46− case parseEither parseJSON v of
47− Left s -> DecodingError $ T.pack s
48− Right jsonRepr ->
49− let
50− validate = validateJsonRepr (sing :: Sing schema) [] jsonRepr
51− res = runIdentity . runValidationTEither $ validate
52− in case res of
53− Left em -> ValidationError em
54− Right () -> Valid jsonRepr
55−
56−parseAndValidateJsonBy
57− :: (J.FromJSON (JsonRepr schema), TopLevel schema, SingI schema)
58− => proxy schema
59− -> J.Value
60− -> ParseResult (JsonRepr schema)
61−parseAndValidateJsonBy _ = parseAndValidateJson
62−
63parseAndValidateTopVersionJson
42parseAndValidateTopVersionJson
64 :: forall proxy (v :: Versioned)
43 :: forall proxy (v :: Versioned)
65 . (SingI (TopVersion (AllVersions v)))
44 . (SingI (TopVersion (AllVersions v)))
@@ -78,44 +57,23 @@ parseAndValidateTopVersionJson _ v =
78 Left em -> ValidationError em
57 Left em -> ValidationError em
79 Right () -> Valid jsonRepr
58 Right () -> Valid jsonRepr
80
59
81−class Migratable (revisions :: [(Revision, Schema)]) where
82− mparse
83− :: Sing revisions
84− -> J.Value
85− -> ParseResult (JsonRepr (Snd (Head revisions)))
86−
87−instance
88− {-# OVERLAPPING #-}
89− ( TopLevel (Snd rev), SingI (Snd rev) )
90− => Migratable '[rev] where
91− mparse _ = parseAndValidateJson
92−
93−instance {-# OVERLAPPABLE #-}
94− ( Migratable (Tail revisions)
95− , MigrateSchema (Snd (Head (Tail revisions))) (Snd (Head revisions))
96− , SingI (Snd (Head revisions)))
97− => Migratable revisions where
98− mparse s v = case parseEither parseJSON v of
99− Left _ ->
100− migrate <$> (mparse (sTail s) v :: ParseResult (JsonRepr (Snd (Head (Tail revisions)))))
101− Right x -> Valid x
102−
103−parseAndValidateVersionedJson
104− :: forall proxy v. (SingI (AllVersions v), Migratable (AllVersions v))
105− => proxy v
106− -> J.Value
107− -> ParseResult (JsonRepr (Snd (Head (AllVersions v))))
108−parseAndValidateVersionedJson _ v = mparse (sing :: Sing (AllVersions v)) v
109−
110parseAndValidateWithMList
60parseAndValidateWithMList
61+ :: Monad m
111− :: MList revisions
62+ => MList m revisions
112 -> J.Value
63 -> J.Value
113− -> ParseResult (JsonRepr (Head revisions))
64+ -> m (ParseResult (JsonRepr (Head revisions)))
114−parseAndValidateWithMList MNil v = parseAndValidateJson v
65+parseAndValidateWithMList MNil v = pure $ parseAndValidateJson v
66+parseAndValidateWithMList (Tagged f :&& tl) v =
115−parseAndValidateWithMList ((:&&) p f tl) v = case parseAndValidateJsonBy p v of
67+ case parseAndValidateJsonBy Proxy v of
116− Valid a -> Valid a
68+ Valid a -> pure $ Valid a
69+ DecodingError _ -> do
117− DecodingError _ -> f <$> parseAndValidateWithMList tl v
70+ pr <- parseAndValidateWithMList tl v
71+ let pr' = f <$> pr
72+ sequence pr'
73+ ValidationError _ -> do
118− ValidationError _ -> f <$> parseAndValidateWithMList tl v
74+ pr <- parseAndValidateWithMList tl v
75+ let pr' = f <$> pr
76+ sequence pr'
119
77
120decodeAndValidateJson
78decodeAndValidateJson
121 :: forall schema
79 :: forall schema
@@ -126,24 +84,20 @@ decodeAndValidateJson bs = case decode bs of
126 Nothing -> DecodingError "malformed json"
84 Nothing -> DecodingError "malformed json"
127 Just x -> parseAndValidateJson x
85 Just x -> parseAndValidateJson x
128
86
129−decodeAndValidateVersionedJson
87+decodeAndValidateVersionedWithMList
130− :: (Migratable (AllVersions versioned), SingI (AllVersions versioned))
88+ :: Monad m
131 => proxy versioned
89 => proxy versioned
90+ -> MList m (MapSnd (AllVersions versioned))
132 -> BL.ByteString
91 -> BL.ByteString
133− -> ParseResult (JsonRepr (Snd (Head (AllVersions versioned))))
92+ -> m (ParseResult (JsonRepr (Head (MapSnd (AllVersions versioned)))))
134−decodeAndValidateVersionedJson vp bs = case decode bs of
93+decodeAndValidateVersionedWithMList _ mlist bs = case decode bs of
135− Nothing -> DecodingError "malformed json"
94+ Nothing -> pure $ DecodingError "malformed json"
136− Just x -> parseAndValidateVersionedJson vp x
95+ Just x -> parseAndValidateWithMList mlist x
137−
138−type family MapSnd (l :: [(a,k)]) = (r :: [k]) where
139− MapSnd '[] = '[]
140− MapSnd ( '(a, b) ': tl) = b ': MapSnd tl
141
96
142−decodeAndValidateVersionedWithMList
97+decodeAndValidateVersionedWithPureMList
143 :: proxy versioned
98 :: proxy versioned
144− -> MList (MapSnd (AllVersions versioned))
99+ -> MList F.Identity (MapSnd (AllVersions versioned))
145 -> BL.ByteString
100 -> BL.ByteString
146 -> ParseResult (JsonRepr (Head (MapSnd (AllVersions versioned))))
101 -> ParseResult (JsonRepr (Head (MapSnd (AllVersions versioned))))
147−decodeAndValidateVersionedWithMList _ mlist bs = case decode bs of
102+decodeAndValidateVersionedWithPureMList a b c =
148− Nothing -> DecodingError "malformed json"
103+ runIdentity $ decodeAndValidateVersionedWithMList a b c
149− Just x -> parseAndValidateWithMList mlist x
src/Data/Schematic/DSL.hsnew file+92
@@ -0,0 +1,92 @@
1+{-# LANGUAGE AllowAmbiguousTypes #-}
2+{-# LANGUAGE CPP #-}
3+
4+module Data.Schematic.DSL where
5+
6+import Data.Kind
7+import Data.Schematic.Lens
8+import Data.Schematic.Schema
9+import Data.Scientific
10+import Data.Singletons
11+import Data.Singletons.Prelude hiding ((:.))
12+import Data.Singletons.TypeLits
13+import Data.Tagged
14+import Data.Text as T
15+import Data.Union
16+import qualified Data.Vector as V
17+import Data.Vinyl
18+import Data.Vinyl.Functor
19+
20+
21+#if MIN_VERSION_base(4,12,0)
22+type Constructor a
23+ = forall fields b
24+ . (fields ~ FieldsOf a, FSubset fields b (FImage fields b), RMap fields)
25+ => Rec (Tagged fields :. FieldRepr) b
26+ -> JsonRepr ('SchemaObject fields)
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
34+withRepr :: Constructor a
35+withRepr = ReprObject . rmap (unTagged . getCompose) . fcast
36+
37+class Representable s where
38+ constructField :: Sing fn -> Proxy s -> Repr s -> FieldRepr '(fn, s)
39+
40+instance SingI so => Representable ('SchemaObject so) where
41+ constructField sfn _ o = withKnownSymbol sfn $ FieldRepr $ ReprObject o
42+
43+instance (SingI cs, SingI sa) => Representable ('SchemaArray cs sa) where
44+ constructField sfn _ a = withKnownSymbol sfn $ FieldRepr $ ReprArray a
45+
46+instance SingI cs => Representable ('SchemaText cs) where
47+ constructField sfn _ t = withKnownSymbol sfn $ FieldRepr $ ReprText t
48+
49+instance SingI cs => Representable ('SchemaNumber cs) where
50+ constructField sfn _ n = withKnownSymbol sfn $ FieldRepr $ ReprNumber n
51+
52+instance Representable 'SchemaBoolean where
53+ constructField sfn _ b = withKnownSymbol sfn $ FieldRepr $ ReprBoolean b
54+
55+instance SingI so => Representable ('SchemaOptional so) where
56+ constructField sfn _ o = withKnownSymbol sfn $ FieldRepr $ ReprOptional o
57+
58+instance SingI (h ': tl) => Representable ('SchemaUnion (h ': tl)) where
59+ constructField sfn _ u = withKnownSymbol sfn $ FieldRepr $ ReprUnion u
60+
61+construct :: Sing s -> Repr s -> JsonRepr s
62+construct s r = case s of
63+ SSchemaObject _ -> ReprObject r
64+ SSchemaArray _ _ -> ReprArray r
65+ SSchemaText _ -> ReprText r
66+ SSchemaNumber _ -> ReprNumber r
67+ SSchemaBoolean -> ReprBoolean r
68+ SSchemaOptional _ -> ReprOptional r
69+ SSchemaNull -> ReprNull
70+ SSchemaUnion ss -> case ss of
71+ SNil -> error "unconstructable union"
72+ SCons _ _ -> ReprUnion r
73+
74+type family FieldsOf (s :: Schema) :: [(Symbol, Schema)] where
75+ FieldsOf ('SchemaObject fs) = fs
76+
77+type FieldConstructor fn =
78+ forall byField fs. (byField ~ ByField fn fs (FIndex fn fs), Representable byField)
79+ => Repr byField
80+ -> (Tagged fs :. FieldRepr) '(fn, byField)
81+
82+field :: forall fn. KnownSymbol fn => FieldConstructor fn
83+field = Compose . Tagged . constructField (sing :: Sing fn) Proxy
84+
85+type family Repr (s :: Schema) = (ty :: Type) where
86+ Repr ('SchemaObject so) = Rec FieldRepr so
87+ Repr ('SchemaArray cs sa) = V.Vector (JsonRepr sa)
88+ Repr ('SchemaText cs) = Text
89+ Repr ('SchemaNumber cs) = Scientific
90+ Repr 'SchemaBoolean = Bool
91+ Repr ('SchemaOptional so) = Maybe (JsonRepr so)
92+ Repr ('SchemaUnion (h ': tl)) = Union JsonRepr (h ': tl)
src/Data/Schematic/Generator.hsnew file+91
@@ -0,0 +1,91 @@
1+module Data.Schematic.Generator where
2+
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)
9+import qualified Data.Vector as V
10+import Test.SmallCheck.Series
11+
12+maxHigh :: Int
13+maxHigh = 30
14+
15+minLow :: Int
16+minLow = 2
17+
18+textLengthSeries :: Monad m => [VerifiedTextConstraint] -> Series m Text
19+textLengthSeries =
20+ \case
21+ [VTEq eq] -> pure $ pack $ take (fromIntegral eq) $ cycle "sample"
22+ [VTBounds ml mh] -> do
23+ let
24+ l = fromMaybe minLow (fromIntegral <$> ml) + 1
25+ h = fromMaybe maxHigh (fromIntegral <$> mh) - 1
26+ n <- generate $ \depth -> take depth [l .. h]
27+ pure $ pack $ take (fromIntegral n) $ cycle "sample"
28+ _ -> pure "error"
29+
30+textEnumSeries :: Monad m => [Text] -> Series m Text
31+textEnumSeries enum = generate $ \depth -> take depth enum
32+
33+textSeries :: Monad m => [DemotedTextConstraint] -> Series m Text
34+textSeries cs = do
35+ let mvcs = verifyTextConstraints cs
36+ case mvcs of
37+ Just vcs -> do
38+ n <- textSeries' vcs
39+ pure n
40+ Nothing -> pure "error"
41+
42+textSeries' :: Monad m => [VerifiedTextConstraint] -> Series m Text
43+textSeries' [] = pure "sample"
44+textSeries' vcs = do
45+ let enums = listToMaybe [x | VTEnum x <- vcs]
46+ case enums of
47+ Just e -> textEnumSeries e
48+ Nothing -> do
49+ let regexps = listToMaybe [x | VTRegex x _ _ <- vcs]
50+ case regexps of
51+ Just e -> regexSeries e
52+ Nothing -> textLengthSeries vcs
53+
54+numberSeries :: Monad m => [DemotedNumberConstraint] -> Series m Scientific
55+numberSeries cs = do
56+ let mvcs = verifyNumberConstraints cs
57+ case mvcs of
58+ Just vcs -> do
59+ n <- numberSeries' vcs
60+ pure $ n
61+ Nothing -> pure 0
62+
63+numberSeries' :: Monad m => VerifiedNumberConstraint -> Series m Scientific
64+numberSeries' =
65+ \case
66+ VNEq eq -> pure $ fromIntegral eq
67+ VNBounds ml mh -> do
68+ let l = fromMaybe minLow (fromIntegral <$> ml) + 1
69+ h = fromMaybe maxHigh (fromIntegral <$> mh) - 1
70+ n <- generate $ \depth -> take depth [l .. h]
71+ pure $ fromIntegral n
72+
73+arraySeries
74+ :: (Monad m, Serial m (JsonRepr s))
75+ => [DemotedArrayConstraint]
76+ -> Series m (V.Vector (JsonRepr s))
77+arraySeries cs = do
78+ let mvcs = verifyArrayConstraint cs
79+ case mvcs of
80+ Just vcs -> arraySeries' vcs
81+ Nothing -> pure V.empty
82+
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
90+ where
91+ f (VAEq l) = fromIntegral l
src/Data/Schematic/Generator/Regex.hsnew file+76
@@ -0,0 +1,76 @@
1+module Data.Schematic.Generator.Regex where
2+
3+import Control.Monad
4+import Data.List
5+import Data.Maybe
6+import qualified Data.Set as S
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)
13+
14+
15+minRepeat :: Int
16+minRepeat = 2
17+
18+maxRepeat :: Int
19+maxRepeat = 10
20+
21+regexSeries :: (Monad m) => Text -> Series m Text
22+regexSeries regexp =
23+ case parseRegex . unpack $ regexp of
24+ Right (p, _) -> toStrict . toLazyText <$> regexSeries' p
25+ Left _ -> pure ""
26+
27+regexSeries' :: (Monad m) => Pattern -> Series m Builder
28+regexSeries' pt =
29+ case pt of
30+ PEmpty -> pure mempty
31+ PChar {..} -> pure $ singleton getPatternChar
32+ PAny {getPatternSet = PatternSet (Just cset) _ _ _} -> do
33+ x <- generate $ \depth -> take depth $ S.toList cset
34+ pure $ singleton x
35+ PAnyNot {getPatternSet = PatternSet (Just cset) _ _ _} -> do
36+ x <-
37+ generate $ \depth ->
38+ take depth $ notChars $ concatMap expandEscape $ S.toList cset
39+ pure $ singleton x
40+ PQuest p -> regexSeries' p \/ pure mempty
41+ PPlus p -> regexSeries' $ PBound 1 Nothing p
42+ PStar _ p -> regexSeries' $ PBound 0 Nothing p
43+ PBound low mhigh p -> do
44+ let high = fromMaybe (low + maxRepeat) mhigh
45+ n <- generate $ \depth -> take depth [low .. high]
46+ decDepth $ do
47+ ps <- replicateM n $ regexSeries' p
48+ pure $ mconcat ps
49+ PConcat ps -> mconcat <$> mapM regexSeries' ps
50+ POr xs -> regexSeries' =<< (generate $ \depth -> take depth xs)
51+ PDot _ -> do
52+ x <- generate $ \depth -> take depth $ notChars []
53+ pure $ singleton x
54+ PEscape {..} -> do
55+ x <- generate $ \depth -> take depth $ expandEscape getPatternChar
56+ pure $ singleton x
57+ PCarat _ -> pure mempty
58+ PDollar _ -> pure mempty
59+ _ -> pure mempty
60+ where
61+ notChars = ([' ' .. '~'] \\)
62+ expandEscape ch =
63+ case ch of
64+ 'n' -> "\n"
65+ 't' -> "\t"
66+ 'r' -> "\r"
67+ 'f' -> "\f"
68+ 'a' -> "\a"
69+ 'e' -> "\ESC"
70+ 'd' -> ['0' .. '9']
71+ 'w' -> ['0' .. '9'] ++ '_' : ['a' .. 'z'] ++ ['A' .. 'Z']
72+ 's' -> "\9\32"
73+ 'D' -> notChars $ ['0' .. '9']
74+ 'W' -> notChars $ ['0' .. '9'] ++ '_' : ['a' .. 'z'] ++ ['A' .. 'Z']
75+ 'S' -> notChars "\9\32"
76+ ch' -> [ch']
src/Data/Schematic/Helpers.hsnew file+59
@@ -0,0 +1,59 @@
1+module Data.Schematic.Helpers where
2+
3+import Data.Schematic.Schema
4+import GHC.TypeLits
5+
6+
7+type UUIDRegex =
8+ 'TRegex "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
9+
10+type IsUUID = '[UUIDRegex]
11+
12+-- [ "1985-04-12T23:20:50.52Z"
13+-- , "1996-12-19T16:39:57-08:00"
14+-- , "1990-12-31T23:59:60Z"
15+-- , "1990-12-31T15:59:60-08:00"
16+-- , "1937-01-01T12:00:27.87+00:20"
17+-- ]
18+
19+-- components
20+type ISO8601Date = "[1-9][0-9]{3}-(0[1-9]|1[0-2])-([0-2][0-9]|3[0-1])"
21+
22+type ISO8601Time = "([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]"
23+
24+type ISO8601DateTime =
25+ AppendSymbol
26+ ISO8601Date
27+ (AppendSymbol "(T" (AppendSymbol ISO8601Time ")?"))
28+
29+type ISO8601UTC = "(Z|\\+00:00)"
30+
31+type ISO8601DateTimeUTC =
32+ AppendSymbol ISO8601Date (AppendSymbol "T" (AppendSymbol ISO8601Time ISO8601UTC))
33+
34+type ISO8601TZ = "\\+[0-1][0-9]:[0-6][0-9]"
35+
36+type ISO8601DateTimeZoned =
37+ AppendSymbol ISO8601Date (AppendSymbol "T" (AppendSymbol ISO8601Time ISO8601TZ))
38+
39+-- regexes
40+type ISO8601DateRegex = 'TRegex ISO8601Date
41+
42+type ISO8601TimeRegex = 'TRegex ISO8601Time
43+
44+type ISO8601DateTimeRegex = 'TRegex ISO8601DateTime
45+
46+type ISO8601DateTimeRegexUTC = 'TRegex ISO8601DateTimeUTC
47+
48+type ISO8601DateTimeRegexZoned = 'TRegex ISO8601DateTimeZoned
49+
50+-- constraints
51+type IsDate = '[ISO8601DateRegex]
52+
53+type IsTime = '[ISO8601TimeRegex]
54+
55+type IsDateTime = '[ISO8601DateTimeRegex]
56+
57+type IsZonedDateTime = '[ISO8601DateTimeRegexZoned]
58+
59+type IsUTCDateTime = '[ISO8601DateTimeRegexUTC]
src/Data/Schematic/Instances.hs+4
@@ -4,6 +4,7 @@
4module Data.Schematic.Instances where
4module Data.Schematic.Instances where
5
5
6import Data.Scientific
6import Data.Scientific
7+import Data.Text (Text, pack)
7import Data.Vector as V
8import Data.Vector as V
8import Data.Vinyl
9import Data.Vinyl
9import Test.SmallCheck.Series
10import Test.SmallCheck.Series
@@ -21,3 +22,6 @@ instance Serial m a => Serial m (V.Vector a) where
21
22
22instance Monad m => Serial m Scientific where
23instance Monad m => Serial m Scientific where
23 series = scientific <$> series <*> series
24 series = scientific <$> series <*> series
25+
26+instance Monad m => Serial m Text where
27+ series = pack <$> series
src/Data/Schematic/JsonSchema.hs+86−37
@@ -1,6 +1,7 @@
1{-# LANGUAGE AllowAmbiguousTypes #-}
1{-# LANGUAGE AllowAmbiguousTypes #-}
2{-# LANGUAGE RecordWildCards #-}
2{-# LANGUAGE RecordWildCards #-}
3{-# LANGUAGE OverloadedLabels #-}
3{-# LANGUAGE OverloadedLabels #-}
4+{-# LANGUAGE TemplateHaskell #-}
4
5
5module Data.Schematic.JsonSchema
6module Data.Schematic.JsonSchema
6 ( toJsonSchema
7 ( toJsonSchema
@@ -8,68 +9,116 @@ module Data.Schematic.JsonSchema
8 ) where
9 ) where
9
10
10import Control.Monad.State.Strict
11import Control.Monad.State.Strict
11−import Data.Foldable
12+import Data.Aeson as J
13+import Data.Foldable as F
12import Data.HashMap.Strict as H
14import Data.HashMap.Strict as H
13−import Data.List.NonEmpty
15+import Data.List as L
16+import Data.List.NonEmpty as NE
14import Data.Schematic.Schema as S
17import Data.Schematic.Schema as S
18+import Data.Set as Set
15import Data.Singletons
19import Data.Singletons
16import Data.Text
20import Data.Text
21+import Data.Traversable
17import JSONSchema.Draft4.Schema as D4
22import JSONSchema.Draft4.Schema as D4
18import JSONSchema.Validator.Draft4 as D4
23import JSONSchema.Validator.Draft4 as D4
19
24
20
25
21draft4 :: Text
26draft4 :: Text
22−draft4 = "http://Jason-schema.org/draft-04/schema#"
27+draft4 = "http://json-schema.org/draft-04/schema#"
23
28
24−-- FIXME: implement all this later
25textConstraint :: DemotedTextConstraint -> State D4.Schema ()
29textConstraint :: DemotedTextConstraint -> State D4.Schema ()
26−textConstraint (DTEq _) = pure ()
30+textConstraint (DTEq n) = modify $ \s -> s
27−textConstraint (DTLt _) = pure ()
31+ { _schemaMinLength = pure $ fromIntegral n
32+ , _schemaMaxLength = pure $ fromIntegral n }
28−textConstraint (DTLe _) = pure ()
33+textConstraint (DTLe n) = modify $ \s -> s
34+ { _schemaMaxLength = pure . fromIntegral $ n }
35+textConstraint (DTLt n) =
36+ let n' = if n == 0 then 0 else n - 1
37+ in modify $ \s -> s { _schemaMaxLength = pure . fromIntegral $ n' }
29−textConstraint (DTGt _) = pure ()
38+textConstraint (DTGt n) = modify $ \s -> s
39+ { _schemaMinLength = pure . fromIntegral $ n + 1 }
30−textConstraint (DTGe _) = pure ()
40+textConstraint (DTGe n) = modify $ \s -> s
41+ { _schemaMinLength = pure . fromIntegral $ n }
31−textConstraint (DTRegex _) = pure ()
42+textConstraint (DTRegex r) = modify $ \s -> s { _schemaPattern = pure r }
32−textConstraint (DTEnum _) = pure ()
43+textConstraint (DTEnum ss) =
44+ let ss' = if F.length ss == 0 then [] else NE.fromList $ J.String <$> ss
45+ in modify $ \s -> s { _schemaEnum = pure ss' }
33
46
34numberConstraint :: DemotedNumberConstraint -> State D4.Schema ()
47numberConstraint :: DemotedNumberConstraint -> State D4.Schema ()
35−numberConstraint (DNLe _) = pure ()
48+numberConstraint (DNLe n) = modify $ \s -> s
49+ { _schemaMaximum = pure . fromIntegral $ n }
36−numberConstraint (DNLt _) = pure ()
50+numberConstraint (DNLt n) = modify $ \s -> s
51+ { _schemaMaximum = pure . fromIntegral $ n
52+ , _schemaExclusiveMaximum = pure True }
37−numberConstraint (DNGt _) = pure ()
53+numberConstraint (DNGt n) = modify $ \s -> s
54+ { _schemaMinimum = pure . fromIntegral $ n
55+ , _schemaExclusiveMinimum = pure True }
38−numberConstraint (DNGe _) = pure ()
56+numberConstraint (DNGe n) = modify $ \s -> s
57+ { _schemaMinimum = pure . fromIntegral $ n }
39−numberConstraint (DNEq _) = pure ()
58+numberConstraint (DNEq n) = modify $ \s -> s
59+ { _schemaMinimum = pure $ fromIntegral n
60+ , _schemaMaximum = pure $ fromIntegral n }
40
61
41arrayConstraint :: DemotedArrayConstraint -> State D4.Schema ()
62arrayConstraint :: DemotedArrayConstraint -> State D4.Schema ()
42−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 }
43
75
44toJsonSchema
76toJsonSchema
45 :: forall proxy schema
77 :: forall proxy schema
46 . SingI schema
78 . SingI schema
47 => proxy (schema :: S.Schema)
79 => proxy (schema :: S.Schema)
48− -> D4.Schema
80+ -> Maybe D4.Schema
81+toJsonSchema _ = do
49−toJsonSchema _ = (toJsonSchema' $ fromSing (sing :: Sing schema))
82+ js <- toJsonSchema' $ fromSing (sing :: Sing schema)
50− { _schemaVersion = pure draft4 }
83+ pure $ js { _schemaVersion = pure draft4 }
51
84
52toJsonSchema'
85toJsonSchema'
53 :: DemotedSchema
86 :: DemotedSchema
54− -> D4.Schema
87+ -> Maybe D4.Schema
55toJsonSchema' = \case
88toJsonSchema' = \case
56 DSchemaText tcs ->
89 DSchemaText tcs ->
57− execState (traverse_ textConstraint tcs) $ emptySchema
90+ pure $ execState (traverse_ textConstraint tcs) $ emptySchema
58 { _schemaType = pure $ TypeValidatorString D4.SchemaString }
91 { _schemaType = pure $ TypeValidatorString D4.SchemaString }
59 DSchemaNumber ncs ->
92 DSchemaNumber ncs ->
60− execState (traverse_ numberConstraint ncs) $ emptySchema
93+ pure $ execState (traverse_ numberConstraint ncs) $ emptySchema
61 { _schemaType = pure $ TypeValidatorString D4.SchemaNumber }
94 { _schemaType = pure $ TypeValidatorString D4.SchemaNumber }
62− DSchemaBoolean -> emptySchema
95+ DSchemaBoolean -> pure $ emptySchema
63− { _schemaType = pure $ TypeValidatorString D4.SchemaBoolean }
96+ { _schemaType = pure $ TypeValidatorString D4.SchemaBoolean }
64− DSchemaObject objs -> emptySchema
97+ DSchemaObject objs -> do
98+ res <- for objs $ \(n,s) -> do
99+ s' <- toJsonSchema' s
100+ pure (n, s')
101+ let
102+ nonOpt = \case
103+ (_, DSchemaOptional _) -> False
104+ _ -> True
105+ pure $ emptySchema
65− { _schemaType = pure $ TypeValidatorString D4.SchemaObject
106+ { _schemaType = pure $ TypeValidatorString D4.SchemaObject
107+ , _schemaRequired = pure $ Set.fromList $ fst <$> L.filter nonOpt objs
66− , _schemaProperties = pure $ H.fromList $ (\(n,s) -> (n, toJsonSchema' s))
108+ , _schemaProperties = pure $ H.fromList res }
67− <$> objs }
68− DSchemaArray acs sch ->
109+ DSchemaArray acs sch -> do
110+ res <- toJsonSchema' sch
69− execState (traverse_ arrayConstraint acs) $ emptySchema
111+ pure $ execState (traverse_ arrayConstraint acs) $ emptySchema
70− { _schemaType = pure $ TypeValidatorString D4.SchemaArray
112+ { _schemaType = pure $ TypeValidatorString D4.SchemaArray
71− , _schemaItems = pure $ ItemsArray [toJsonSchema' sch] }
113+ , _schemaItems = pure $ ItemsObject res }
72− DSchemaNull -> emptySchema
114+ DSchemaNull -> pure $ emptySchema
73− { _schemaType = pure $ TypeValidatorString D4.SchemaNull }
115+ { _schemaType = pure $ TypeValidatorString D4.SchemaNull }
74− DSchemaOptional sch -> emptySchema
116+ DSchemaOptional sch -> do
75− { _schemaOneOf = pure $ toJsonSchema' DSchemaNull :| [toJsonSchema' sch] }
117+ snull <- toJsonSchema' DSchemaNull
118+ sres <- toJsonSchema' sch
119+ pure $ emptySchema { _schemaOneOf = pure (snull :| [sres]) }
120+ DSchemaUnion sch -> do
121+ schemaUnion <- traverse toJsonSchema' sch >>= \case
122+ [] -> Nothing
123+ x -> Just x
124+ pure $ emptySchema { _schemaAnyOf = pure $ NE.fromList schemaUnion }
src/Data/Schematic/Lens.hs+168−27
@@ -3,64 +3,205 @@
3{-# LANGUAGE AllowAmbiguousTypes #-}
3{-# LANGUAGE AllowAmbiguousTypes #-}
4{-# LANGUAGE InstanceSigs #-}
4{-# LANGUAGE InstanceSigs #-}
5
5
6−module Data.Schematic.Lens where
6+module Data.Schematic.Lens
7+ ( FIndex
8+ , FElem(..)
9+ , FImage
10+ , FSubset(..)
11+ , obj
12+ , arr
13+ , uni
14+ , txt
15+ , num
16+ , opt
17+ , bln
18+ , textRepr
19+ , numberRepr
20+ , boolRepr
21+ , arrayRepr
22+ , objectRepr
23+ , optionalRepr
24+ ) where
7
25
8−import Data.Proxy
26+import Data.Profunctor
9import Data.Schematic.Schema
27import Data.Schematic.Schema
28+import Data.Scientific
29+import Data.Singletons
30+import Data.Text
31+import Data.Union
32+import Data.Vector as V
10import Data.Vinyl
33import Data.Vinyl
11import Data.Vinyl.Functor
34import Data.Vinyl.Functor
12import Data.Vinyl.TypeLevel (Nat(..))
35import Data.Vinyl.TypeLevel (Nat(..))
13−import GHC.TypeLits (Symbol)
36+import GHC.TypeLits (Symbol, KnownSymbol)
14
37
15
38
16-- | A partial relation that gives the index of a value in a list.
39-- | A partial relation that gives the index of a value in a list.
17type family FIndex (r :: Symbol) (rs :: [(Symbol, Schema)]) :: Nat where
40type family FIndex (r :: Symbol) (rs :: [(Symbol, Schema)]) :: Nat where
18− FIndex r ( '(fn, s) ': rs) = 'Z
41+ FIndex r ( '(r, s) ': rs) = 'Z
19− FIndex r ( s ': rs) = 'S (FIndex r rs)
42+ FIndex r ( s ': rs) = 'S (FIndex r rs)
43+
44+type Flens fn f g rs i
45+ = Functor g
46+ => (f '(fn, (ByField fn rs i)) -> g (f '(fn, (ByField fn rs i))))
47+ -> Rec f rs
48+ -> g (Rec f rs)
49+
50+type FGetter fn f rs i = Rec f rs -> f '(fn, (ByField fn rs i))
20
51
21class i ~ FIndex fn rs => FElem (fn :: Symbol) (rs :: [(Symbol, Schema)]) (i :: Nat) where
52class i ~ FIndex fn rs => FElem (fn :: Symbol) (rs :: [(Symbol, Schema)]) (i :: Nat) where
22− type ByRevision fn rs i :: Schema
53+ type ByField fn rs i :: Schema
23− flens
54+ flens :: Flens fn f g rs i
24− :: Functor g
25− => proxy fn
26− -> (FieldRepr '(fn, (ByRevision fn rs i)) -> g (FieldRepr '(fn, (ByRevision fn rs i))))
27− -> Rec FieldRepr rs
28− -> g (Rec FieldRepr rs)
29
55
30 -- | For Vinyl users who are not using the @lens@ package, we provide a getter.
56 -- | For Vinyl users who are not using the @lens@ package, we provide a getter.
31− fget
57+ fget :: FGetter fn f rs i
32− :: proxy fn
33− -> Rec FieldRepr rs
34− -> FieldRepr '(fn, (ByRevision fn rs i))
35
58
36 -- | For Vinyl users who are not using the @lens@ package, we also provide a
59 -- | For Vinyl users who are not using the @lens@ package, we also provide a
37 -- setter. In general, it will be unambiguous what field is being written to,
60 -- setter. In general, it will be unambiguous what field is being written to,
38 -- and so we do not take a proxy argument here.
61 -- and so we do not take a proxy argument here.
39 fput
62 fput
40− :: FieldRepr '(fn, ByRevision fn rs i)
63+ :: f '(fn, ByField fn rs i)
41− -> Rec FieldRepr rs
64+ -> Rec f rs
42− -> Rec FieldRepr rs
65+ -> Rec f rs
43
66
44instance FElem fn ('(fn, r) ': rs) 'Z where
67instance FElem fn ('(fn, r) ': rs) 'Z where
45− type ByRevision fn ('(fn, r) ': rs) 'Z = r
68+ type ByField fn ('(fn, r) ': rs) 'Z = r
46
69
47− flens _ f (x :& xs) = fmap (:& xs) (f x)
70+ flens f (x :& xs) = fmap (:& xs) (f x)
48 {-# INLINE flens #-}
71 {-# INLINE flens #-}
49
72
50− fget k = getConst . flens k Const
73+ fget = getConst . flens Const
51 {-# INLINE fget #-}
74 {-# INLINE fget #-}
52
75
53− fput y = getIdentity . flens Proxy (\_ -> Identity y)
76+ fput y = getIdentity . flens (\_ -> Identity y)
54 {-# INLINE fput #-}
77 {-# INLINE fput #-}
55
78
56instance (FIndex r (s ': rs) ~ 'S i, FElem r rs i) => FElem r (s ': rs) ('S i) where
79instance (FIndex r (s ': rs) ~ 'S i, FElem r rs i) => FElem r (s ': rs) ('S i) where
57− type ByRevision fn (s ': rs) ('S i) = ByRevision fn rs i
80+ type ByField r (s ': rs) ('S i) = ByField r rs i
58
81
59− flens p f (x :& xs) = fmap (x :&) (flens p f xs)
82+ flens f (x :& xs) = fmap (x :&) (flens f xs)
60 {-# INLINE flens #-}
83 {-# INLINE flens #-}
61
84
62− fget k = getConst . flens k Const
85+ fget = getConst . flens Const
63 {-# INLINE fget #-}
86 {-# INLINE fget #-}
64
87
65− fput y = getIdentity . flens Proxy (\_ -> Identity y)
88+ fput y = getIdentity . flens (\_ -> Identity y)
66 {-# INLINE fput #-}
89 {-# INLINE fput #-}
90+
91+-- This is an internal convenience helpers stolen from the @lens@ library.
92+lens
93+ :: Functor f
94+ => (t -> s)
95+ -> (t -> a -> b)
96+ -> (s -> f a)
97+ -> t
98+ -> f b
99+lens sa sbt afb s = fmap (sbt s) $ afb (sa s)
100+{-# INLINE lens #-}
101+
102+type Iso s t a b = forall p f. (Profunctor p, Functor f) => p a (f b) -> p s (f t)
103+
104+type Iso' s a = Iso s s a a
105+
106+iso
107+ :: (s -> a) -> (b -> t)
108+ -> Iso s t a b
109+iso sa bt = dimap sa (fmap bt)
110+{-# INLINE iso #-}
111+
112+-- | A partial relation that gives the indices of a sublist in a larger list.
113+type family FImage (rs :: [(Symbol, Schema)]) (ss :: [(Symbol, Schema)]) :: [Nat] where
114+ FImage '[] ss = '[]
115+ FImage ('(fn,s) ': rs) ss = FIndex fn ss ': FImage rs ss
116+
117+class is ~ FImage rs ss
118+ => FSubset (rs :: [(Symbol, Schema)]) (ss :: [(Symbol, Schema)]) is where
119+ -- | This is a lens into a slice of the larger record. Morally, we have:
120+ --
121+ -- > fsubset :: Lens' (Rec FieldRepr ss) (Rec FieldRepr rs)
122+ fsubset
123+ :: Functor g
124+ => (Rec f rs -> g (Rec f rs))
125+ -> Rec f ss
126+ -> g (Rec f ss)
127+
128+ -- | The getter of the 'fsubset' lens is 'fcast', which takes a larger record
129+ -- to a smaller one by forgetting fields.
130+ fcast
131+ :: Rec f ss
132+ -> Rec f rs
133+ fcast = getConst . fsubset Const
134+ {-# INLINE fcast #-}
135+
136+ -- | The setter of the 'fsubset' lens is 'freplace', which allows a slice of
137+ -- a record to be replaced with different values.
138+ freplace
139+ :: Rec f rs
140+ -> Rec f ss
141+ -> Rec f ss
142+ freplace rs = getIdentity . fsubset (\_ -> Identity rs)
143+ {-# INLINE freplace #-}
144+
145+instance FSubset '[] ss '[] where
146+ fsubset = lens (const RNil) const
147+
148+instance
149+ ( ByField fn ss i ~ s
150+ , FElem fn ss i
151+ , FSubset rs ss is) => FSubset ( '(fn,s) ': rs) ss (i ': is) where
152+ fsubset = lens (\ss -> fget @fn ss :& fcast ss) set
153+ where
154+ set :: Rec f ss -> Rec f ( '(fn,s) ': rs) -> Rec f ss
155+ set ss (r :& rs) = fput r $ freplace rs ss
156+
157+-- A bunch of @Iso@morphisms
158+textRepr
159+ :: (KnownSymbol fn, SingI cs)
160+ => Iso' (FieldRepr '(fn, ('SchemaText cs))) Text
161+textRepr = iso (\(FieldRepr (ReprText t)) -> t) (FieldRepr . ReprText)
162+
163+numberRepr
164+ :: (KnownSymbol fn, SingI cs)
165+ => Iso' (FieldRepr '(fn, ('SchemaNumber cs))) Scientific
166+numberRepr = iso (\(FieldRepr (ReprNumber n)) -> n) (FieldRepr . ReprNumber)
167+
168+boolRepr
169+ :: (KnownSymbol fn)
170+ => Iso' (FieldRepr '(fn, 'SchemaBoolean)) Bool
171+boolRepr = iso (\(FieldRepr (ReprBoolean b)) -> b) (FieldRepr . ReprBoolean)
172+
173+arrayRepr
174+ :: (KnownSymbol fn, SingI cs, SingI schema)
175+ => Iso' (FieldRepr '(fn, ('SchemaArray cs schema))) (V.Vector (JsonRepr schema))
176+arrayRepr = iso (\(FieldRepr (ReprArray a)) -> a) (FieldRepr . ReprArray)
177+
178+objectRepr
179+ :: (KnownSymbol fn, SingI fields)
180+ => Iso' (FieldRepr '(fn, ('SchemaObject fields))) (Rec FieldRepr fields)
181+objectRepr = iso (\(FieldRepr (ReprObject o)) -> o) (FieldRepr . ReprObject)
182+
183+optionalRepr
184+ :: (KnownSymbol fn, SingI schema)
185+ => Iso' (FieldRepr '(fn, ('SchemaOptional schema))) (Maybe (JsonRepr schema))
186+optionalRepr = iso (\(FieldRepr (ReprOptional r)) -> r) (FieldRepr . ReprOptional)
187+
188+obj :: Iso' (JsonRepr ('SchemaObject fields)) (Rec FieldRepr fields)
189+obj = iso (\(ReprObject r) -> r) ReprObject
190+
191+arr :: Iso' (JsonRepr ('SchemaArray cs schema)) (V.Vector (JsonRepr schema))
192+arr = iso (\(ReprArray r) -> r) ReprArray
193+
194+uni :: Iso' (JsonRepr ('SchemaUnion (h ': tl))) (Union JsonRepr (h ': tl))
195+uni = iso (\(ReprUnion u) -> u) ReprUnion
196+
197+txt :: Iso' (JsonRepr ('SchemaText cs)) Text
198+txt = iso (\(ReprText t) -> t) ReprText
199+
200+num :: Iso' (JsonRepr ('SchemaNumber cs)) Scientific
201+num = iso (\(ReprNumber t) -> t) ReprNumber
202+
203+bln :: Iso' (JsonRepr 'SchemaBoolean) Bool
204+bln = iso (\(ReprBoolean b) -> b) ReprBoolean
205+
206+opt :: Iso' (JsonRepr ('SchemaOptional schema)) (Maybe (JsonRepr schema))
207+opt = iso (\(ReprOptional o) -> o) ReprOptional
src/Data/Schematic/Migration.hs+48−14
@@ -1,13 +1,19 @@
1{-# LANGUAGE AllowAmbiguousTypes #-}
1{-# LANGUAGE AllowAmbiguousTypes #-}
2+{-# LANGUAGE CPP #-}
2−{-# LANGUAGE TemplateHaskell #-}
3+{-# LANGUAGE TemplateHaskell #-}
3
4
4module Data.Schematic.Migration where
5module Data.Schematic.Migration where
5
6
6import Data.Kind
7import Data.Kind
8+import Data.Schematic.DSL
9+import Data.Schematic.Lens
7import Data.Schematic.Path
10import Data.Schematic.Path
8import Data.Schematic.Schema
11import Data.Schematic.Schema
9−import Data.Singletons.Prelude hiding (All)
12+import Data.Singletons.Prelude hiding ((:.), All)
10import Data.Singletons.TypeLits
13import Data.Singletons.TypeLits
14+import Data.Tagged
15+import Data.Vinyl
16+import Data.Vinyl.Functor
11
17
12
18
13data Path
19data Path
@@ -37,8 +43,8 @@ type family SchemaByKey (fs :: [(Symbol, Schema)]) (s :: Symbol) :: Schema where
37 SchemaByKey ( '(a, s) ': tl) fn = SchemaByKey tl fn
43 SchemaByKey ( '(a, s) ': tl) fn = SchemaByKey tl fn
38
44
39type family DeleteKey (acc :: [(Symbol, Schema)]) (fn :: Symbol) (fs :: [(Symbol, Schema)]) :: [(Symbol, Schema)] where
45type family DeleteKey (acc :: [(Symbol, Schema)]) (fn :: Symbol) (fs :: [(Symbol, Schema)]) :: [(Symbol, Schema)] where
40− DeleteKey acc fn ('(fn, a) ': tl) = acc :++ tl
46+ DeleteKey acc fn ('(fn, a) ': tl) = acc ++ tl
41− DeleteKey acc fn (fna ': tl) = acc :++ (fna ': tl)
47+ DeleteKey acc fn (fna ': tl) = acc ++ (fna ': tl)
42
48
43type family UpdateKey
49type family UpdateKey
44 (fn :: Symbol)
50 (fn :: Symbol)
@@ -91,7 +97,8 @@ type family ElemOf (e :: k) (l :: [(a,k)]) :: Constraint where
91type family AllVersions (vd :: Versioned) :: [(Revision, Schema)] where
97type family AllVersions (vd :: Versioned) :: [(Revision, Schema)] where
92 AllVersions ('Versioned s ms) = Reverse (AllVersions' '[ '("initial", s) ] ms)
98 AllVersions ('Versioned s ms) = Reverse (AllVersions' '[ '("initial", s) ] ms)
93
99
94−type family AllVersions' (acc :: [(Revision, Schema)]) (ms :: [Migration]) = (r :: [(Revision, Schema)]) where
100+type family AllVersions' (acc :: [(Revision, Schema)]) (ms :: [Migration])
101+ = (r :: [(Revision, Schema)]) where
95 AllVersions' acc '[] = acc
102 AllVersions' acc '[] = acc
96 AllVersions' ( '(rh, sh) ': tl ) (m ': ms) =
103 AllVersions' ( '(rh, sh) ': tl ) (m ': ms) =
97 AllVersions' ( '(rh, sh) ': ApplyMigration m sh ': tl ) ms
104 AllVersions' ( '(rh, sh) ': ApplyMigration m sh ': tl ) ms
@@ -99,9 +106,6 @@ type family AllVersions' (acc :: [(Revision, Schema)]) (ms :: [Migration]) = (r
99type family TopVersion (rs :: [(Revision, Schema)]) :: Schema where
106type family TopVersion (rs :: [(Revision, Schema)]) :: Schema where
100 TopVersion ( '(rh, sh) ': tl) = sh
107 TopVersion ( '(rh, sh) ': tl) = sh
101
108
102−class MigrateSchema (a :: Schema) (b :: Schema) where
103− migrate :: JsonRepr a -> JsonRepr b
104−
105data Action = AddKey Symbol Schema | Update Schema | DeleteKey Symbol
109data Action = AddKey Symbol Schema | Update Schema | DeleteKey Symbol
106
110
107data instance Sing (a :: Action) where
111data instance Sing (a :: Action) where
@@ -141,13 +145,43 @@ data instance Sing (v :: Versioned) where
141 -> Sing (ms :: [Migration]) -- a bunch of migrations
145 -> Sing (ms :: [Migration]) -- a bunch of migrations
142 -> Sing ('Versioned s ms)
146 -> Sing ('Versioned s ms)
143
147
148+type DataMigration s m h = Tagged s (JsonRepr h -> m (JsonRepr s))
149+
144−data MList :: [Schema] -> Type where
150+data MList :: (Type -> Type) -> [Schema] -> Type where
145− MNil :: (SingI s, TopLevel s) => MList '[s]
151+ MNil :: (Monad m, SingI s, TopLevel s) => MList m '[s]
146 (:&&)
152 (:&&)
147 :: (TopLevel s, SingI s)
153 :: (TopLevel s, SingI s)
148− => proxy s
154+ => DataMigration s m h
149− -> (JsonRepr h -> JsonRepr s)
150− -> MList (h ': tl)
155+ -> MList m (h ': tl)
151− -> MList (s ': h ': tl)
156+ -> MList m (s ': h ': tl)
152
157
153infixr 7 :&&
158infixr 7 :&&
159+
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
166+migrateObject
167+ :: forall m fs fh. (FSubset fs fs (FImage fs fs), Monad m)
168+ => (Rec (Tagged fs :. FieldRepr) fh -> m (Rec (Tagged fs :. FieldRepr) fs))
169+ -> Tagged ('SchemaObject fs) (JsonRepr ('SchemaObject fh) -> m (JsonRepr ('SchemaObject fs)))
170+#endif
171+migrateObject f = Tagged $ \(ReprObject r) -> do
172+ res <- f $ rmap (Compose . Tagged) r
173+ pure $ withRepr @('SchemaObject fs) res
174+
175+shrinkObject
176+ :: forall rs ss m
177+ . ( Monad m, FSubset rs ss (FImage rs ss) )
178+ => Tagged
179+ ('SchemaObject rs)
180+ (JsonRepr ('SchemaObject ss) -> m (JsonRepr ('SchemaObject rs)))
181+shrinkObject = Tagged $ \(ReprObject r) -> pure $ ReprObject $ fcast r
182+
183+type family MapSnd (l :: [(a,k)]) = (r :: [k]) where
184+ MapSnd '[] = '[]
185+ MapSnd ( '(a, b) ': tl) = b ': MapSnd tl
186+
187+type MigrationList m vs = MList m (MapSnd (AllVersions vs))
src/Data/Schematic/Path.hs+18−32
@@ -1,50 +1,36 @@
1module Data.Schematic.Path where
1module Data.Schematic.Path where
2
2
3import Data.Foldable as F
3import Data.Foldable as F
4−import Data.Monoid
5−import Data.Schematic.Utils
6−import Data.Singletons
7import Data.Singletons.Prelude
4import Data.Singletons.Prelude
8import Data.Singletons.TypeLits
5import Data.Singletons.TypeLits
9import Data.Text as T
6import Data.Text as T
7+import Data.Aeson.Internal
10
8
11
9
12−data PathSegment = Key Symbol | Ix Nat
10+newtype JSONPathText = JSONPathText Text
13−
14−data instance Sing (jp :: PathSegment) where
15− SKey :: (KnownSymbol k, Known (Sing k)) => Sing (k :: Symbol) -> Sing ('Key k)
16− SIx :: (KnownNat n, Known (Sing n)) => Sing (n :: Nat) -> Sing ('Ix n)
17−
18−instance (KnownSymbol k, Known (Sing k))
19− => Known (Sing ('Key k)) where
20− known = SKey known
21−
22−instance (KnownNat n, Known (Sing n))
23− => Known (Sing ('Ix n)) where
24− known = SIx known
25−
26−data DemotedPathSegment = DKey Text | DIx Integer
27 deriving (Show)
11 deriving (Show)
28
12
29−-- | Textual representation of json path.
13+data PathSegment = PathKey Symbol | PathIx Nat
30−newtype JSONPath = JSONPath Text
14+
31− deriving (Show)
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)
32
18
33−demotePath :: Sing (ps :: [PathSegment]) -> [DemotedPathSegment]
19+demotePath :: Sing (ps :: [PathSegment]) -> JSONPath
34demotePath = go []
20demotePath = go []
35 where
21 where
36− go :: [DemotedPathSegment] -> Sing (ps :: [PathSegment]) -> [DemotedPathSegment]
22+ go :: JSONPath -> Sing (ps :: [PathSegment]) -> JSONPath
37 go acc SNil = acc
23 go acc SNil = acc
38− go acc (SCons p ps) = go (acc ++ [demote p]) ps
24+ go acc (SCons p ps) = go (acc ++ [demotePathSeg p]) ps
39− demote :: Sing (ps :: PathSegment) -> DemotedPathSegment
25+ demotePathSeg :: Sing (ps :: PathSegment) -> JSONPathElement
40− demote (SKey s) = DKey $ T.pack $ symbolVal s
26+ demotePathSeg (SKey s) = Key $ T.pack $ withKnownSymbol s $ symbolVal s
41− demote (SIx n) = DIx $ natVal n
27+ demotePathSeg (SIx n) = Index $ withKnownNat n $ fromIntegral $ natVal n
42
28
43−demotedPathToText :: [DemotedPathSegment] -> JSONPath
29+demotedPathToText :: JSONPath -> JSONPathText
44−demotedPathToText = JSONPath . F.foldl' renderPathSegment ""
30+demotedPathToText = JSONPathText . F.foldl' renderPathSegment ""
45 where
31 where
46− renderPathSegment acc (DKey t) = acc <> "." <> t
32+ renderPathSegment acc (Key t) = acc <> "." <> t
47− renderPathSegment acc (DIx n) = acc <> "[" <> T.pack (show n) <> "]"
33+ renderPathSegment acc (Index n) = acc <> "[" <> T.pack (show n) <> "]"
48
34
49−pathToText :: Sing (ps :: [PathSegment]) -> JSONPath
35+pathToText :: Sing (ps :: [PathSegment]) -> JSONPathText
50pathToText = demotedPathToText . demotePath
36pathToText = demotedPathToText . demotePath
src/Data/Schematic/Schema.hs+211−74
@@ -1,28 +1,33 @@
1{-# LANGUAGE AllowAmbiguousTypes #-}
1{-# LANGUAGE AllowAmbiguousTypes #-}
2+{-# LANGUAGE CPP #-}
2−{-# LANGUAGE OverloadedLists #-}
3+{-# LANGUAGE OverloadedLists #-}
3−{-# LANGUAGE OverloadedStrings #-}
4+{-# LANGUAGE OverloadedStrings #-}
4{-# OPTIONS_GHC -fprint-explicit-kinds #-}
5{-# OPTIONS_GHC -fprint-explicit-kinds #-}
5
6
6module Data.Schematic.Schema where
7module Data.Schematic.Schema where
7
8
8−import Control.Applicative ()
9+import Control.Applicative ((<|>))
9import Control.Monad
10import Control.Monad
10import Data.Aeson as J
11import Data.Aeson as J
11import Data.Aeson.Types as J
12import Data.Aeson.Types as J
12import Data.HashMap.Strict as H
13import Data.HashMap.Strict as H
13import Data.Kind
14import Data.Kind
14import Data.Maybe
15import Data.Maybe
16+import Data.Schematic.Generator
15import Data.Schematic.Instances ()
17import Data.Schematic.Instances ()
16import Data.Scientific
18import Data.Scientific
17−import Data.Singletons.Prelude.List hiding (All)
19+import Data.Singletons.Prelude.List hiding (All, Union)
18import Data.Singletons.TH
20import Data.Singletons.TH
19import Data.Singletons.TypeLits
21import Data.Singletons.TypeLits
20import Data.Text as T
22import Data.Text as T
23+import Data.Union
21import Data.Vector as V
24import Data.Vector as V
22import Data.Vinyl hiding (Dict)
25import Data.Vinyl hiding (Dict)
23import qualified Data.Vinyl.TypeLevel as V
26import qualified Data.Vinyl.TypeLevel as V
27+import GHC.Exts
24import GHC.Generics (Generic)
28import GHC.Generics (Generic)
29+import GHC.TypeLits
25−import GHC.TypeLits (SomeNat(..), SomeSymbol(..), someSymbolVal, someNatVal)
30+ (SomeNat(..), SomeSymbol(..), someNatVal, someSymbolVal)
26import Prelude as P
31import Prelude as P
27import Test.SmallCheck.Series
32import Test.SmallCheck.Series
28
33
@@ -44,38 +49,38 @@ data TextConstraint
44 deriving (Generic)
49 deriving (Generic)
45
50
46instance SingKind TextConstraint where
51instance SingKind TextConstraint where
47− type DemoteRep TextConstraint = DemotedTextConstraint
52+ type Demote TextConstraint = DemotedTextConstraint
48 fromSing = \case
53 fromSing = \case
49− STEq n -> withKnownNat n (DTEq $ natVal n)
54+ STEq n -> withKnownNat n (DTEq . fromIntegral $ natVal n)
50− STLt n -> withKnownNat n (DTLt $ natVal n)
55+ STLt n -> withKnownNat n (DTLt . fromIntegral $ natVal n)
51− STLe n -> withKnownNat n (DTLe $ natVal n)
56+ STLe n -> withKnownNat n (DTLe . fromIntegral $ natVal n)
52− STGt n -> withKnownNat n (DTGt $ natVal n)
57+ STGt n -> withKnownNat n (DTGt . fromIntegral $ natVal n)
53− STGe n -> withKnownNat n (DTGe $ natVal n)
58+ STGe n -> withKnownNat n (DTGe . fromIntegral $ natVal n)
54 STRegex s -> withKnownSymbol s (DTRegex $ T.pack $ symbolVal s)
59 STRegex s -> withKnownSymbol s (DTRegex $ T.pack $ symbolVal s)
55 STEnum s -> let
60 STEnum s -> let
56 d :: Sing (s :: [Symbol]) -> [Text]
61 d :: Sing (s :: [Symbol]) -> [Text]
57− d SNil = []
62+ d SNil = []
58 d (SCons ss@SSym fs) = T.pack (symbolVal ss) : d fs
63 d (SCons ss@SSym fs) = T.pack (symbolVal ss) : d fs
59 in DTEnum $ d s
64 in DTEnum $ d s
60 toSing = \case
65 toSing = \case
61 DTEq n -> case someNatVal n of
66 DTEq n -> case someNatVal n of
62 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STEq (SNat :: Sing n))
67 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STEq (SNat :: Sing n))
63− Nothing -> error "Negative singleton nat"
68+ Nothing -> error "Negative singleton nat"
64 DTLt n -> case someNatVal n of
69 DTLt n -> case someNatVal n of
65 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STLt (SNat :: Sing n))
70 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STLt (SNat :: Sing n))
66− Nothing -> error "Negative singleton nat"
71+ Nothing -> error "Negative singleton nat"
67 DTLe n -> case someNatVal n of
72 DTLe n -> case someNatVal n of
68 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STLe (SNat :: Sing n))
73 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STLe (SNat :: Sing n))
69− Nothing -> error "Negative singleton nat"
74+ Nothing -> error "Negative singleton nat"
70 DTGt n -> case someNatVal n of
75 DTGt n -> case someNatVal n of
71 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STGt (SNat :: Sing n))
76 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STGt (SNat :: Sing n))
72− Nothing -> error "Negative singleton nat"
77+ Nothing -> error "Negative singleton nat"
73 DTGe n -> case someNatVal n of
78 DTGe n -> case someNatVal n of
74 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STGe (SNat :: Sing n))
79 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STGe (SNat :: Sing n))
75− Nothing -> error "Negative singleton nat"
80+ Nothing -> error "Negative singleton nat"
76 DTRegex s -> case someSymbolVal (T.unpack s) of
81 DTRegex s -> case someSymbolVal (T.unpack s) of
77 SomeSymbol (_ :: Proxy n) -> SomeSing (STRegex (SSym :: Sing n))
82 SomeSymbol (_ :: Proxy n) -> SomeSing (STRegex (SSym :: Sing n))
78− DTEnum ss -> case toSing (T.unpack <$> ss) of
83+ DTEnum ss -> case toSing ss of
79 SomeSing l -> SomeSing (STEnum l)
84 SomeSing l -> SomeSing (STEnum l)
80
85
81data DemotedTextConstraint
86data DemotedTextConstraint
@@ -86,7 +91,7 @@ data DemotedTextConstraint
86 | DTGe Integer
91 | DTGe Integer
87 | DTRegex Text
92 | DTRegex Text
88 | DTEnum [Text]
93 | DTEnum [Text]
89− deriving (Generic)
94+ deriving (Generic, Eq, Show)
90
95
91data instance Sing (tc :: TextConstraint) where
96data instance Sing (tc :: TextConstraint) where
92 STEq :: Sing n -> Sing ('TEq n)
97 STEq :: Sing n -> Sing ('TEq n)
@@ -127,7 +132,7 @@ data DemotedNumberConstraint
127 | DNGt Integer
132 | DNGt Integer
128 | DNGe Integer
133 | DNGe Integer
129 | DNEq Integer
134 | DNEq Integer
130− deriving (Generic)
135+ deriving (Generic, Eq, Show)
131
136
132data instance Sing (nc :: NumberConstraint) where
137data instance Sing (nc :: NumberConstraint) where
133 SNEq :: Sing n -> Sing ('NEq n)
138 SNEq :: Sing n -> Sing ('NEq n)
@@ -149,53 +154,89 @@ instance Eq (Sing ('NGt n)) where _ == _ = True
149instance Eq (Sing ('NGe n)) where _ == _ = True
154instance Eq (Sing ('NGe n)) where _ == _ = True
150
155
151instance SingKind NumberConstraint where
156instance SingKind NumberConstraint where
152− type DemoteRep NumberConstraint = DemotedNumberConstraint
157+ type Demote NumberConstraint = DemotedNumberConstraint
153 fromSing = \case
158 fromSing = \case
154− SNEq n -> withKnownNat n (DNEq $ natVal n)
159+ SNEq n -> withKnownNat n (DNEq . fromIntegral $ natVal n)
155− SNGt n -> withKnownNat n (DNGt $ natVal n)
160+ SNGt n -> withKnownNat n (DNGt . fromIntegral $ natVal n)
156− SNGe n -> withKnownNat n (DNGe $ natVal n)
161+ SNGe n -> withKnownNat n (DNGe . fromIntegral $ natVal n)
157− SNLt n -> withKnownNat n (DNLt $ natVal n)
162+ SNLt n -> withKnownNat n (DNLt . fromIntegral $ natVal n)
158− SNLe n -> withKnownNat n (DNLe $ natVal n)
163+ SNLe n -> withKnownNat n (DNLe . fromIntegral $ natVal n)
159 toSing = \case
164 toSing = \case
160 DNEq n -> case someNatVal n of
165 DNEq n -> case someNatVal n of
161 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNEq (SNat :: Sing n))
166 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNEq (SNat :: Sing n))
162− Nothing -> error "Negative singleton nat"
167+ Nothing -> error "Negative singleton nat"
163 DNGt n -> case someNatVal n of
168 DNGt n -> case someNatVal n of
164 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNGt (SNat :: Sing n))
169 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNGt (SNat :: Sing n))
165− Nothing -> error "Negative singleton nat"
170+ Nothing -> error "Negative singleton nat"
166 DNGe n -> case someNatVal n of
171 DNGe n -> case someNatVal n of
167 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNGe (SNat :: Sing n))
172 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNGe (SNat :: Sing n))
168− Nothing -> error "Negative singleton nat"
173+ Nothing -> error "Negative singleton nat"
169 DNLt n -> case someNatVal n of
174 DNLt n -> case someNatVal n of
170 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNLt (SNat :: Sing n))
175 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNLt (SNat :: Sing n))
171− Nothing -> error "Negative singleton nat"
176+ Nothing -> error "Negative singleton nat"
172 DNLe n -> case someNatVal n of
177 DNLe n -> case someNatVal n of
173 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNLe (SNat :: Sing n))
178 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNLe (SNat :: Sing n))
174− Nothing -> error "Negative singleton nat"
179+ Nothing -> error "Negative singleton nat"
175
180
176data ArrayConstraint
181data ArrayConstraint
177 = AEq Nat
182 = AEq Nat
183+ | AGt Nat
184+ | AGe Nat
185+ | ALt Nat
186+ | ALe Nat
178 deriving (Generic)
187 deriving (Generic)
179
188
180data DemotedArrayConstraint
189data DemotedArrayConstraint
181 = DAEq Integer
190 = DAEq Integer
191+ | DAGt Integer
192+ | DAGe Integer
193+ | DALt Integer
194+ | DALe Integer
182− deriving (Generic)
195+ deriving (Generic, Eq, Show)
183
196
184data instance Sing (ac :: ArrayConstraint) where
197data instance Sing (ac :: ArrayConstraint) where
185 SAEq :: Sing n -> Sing ('AEq n)
198 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)
186
203
187instance KnownNat n => SingI ('AEq n) where sing = SAEq sing
204instance 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
188
209
189instance Eq (Sing ('AEq n)) where _ == _ = True
210instance 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
190
215
191instance SingKind ArrayConstraint where
216instance SingKind ArrayConstraint where
192− type DemoteRep ArrayConstraint = DemotedArrayConstraint
217+ type Demote ArrayConstraint = DemotedArrayConstraint
193 fromSing = \case
218 fromSing = \case
194− SAEq n -> withKnownNat n (DAEq $ natVal n)
219+ 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)
195 toSing = \case
224 toSing = \case
196 DAEq n -> case someNatVal n of
225 DAEq n -> case someNatVal n of
197 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SAEq (SNat :: Sing n))
226 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SAEq (SNat :: Sing n))
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))
198− Nothing -> error "Negative singleton nat"
239+ Nothing -> error "Negative singleton nat"
199
240
200data Schema
241data Schema
201 = SchemaText [TextConstraint]
242 = SchemaText [TextConstraint]
@@ -205,6 +246,7 @@ data Schema
205 | SchemaArray [ArrayConstraint] Schema
246 | SchemaArray [ArrayConstraint] Schema
206 | SchemaNull
247 | SchemaNull
207 | SchemaOptional Schema
248 | SchemaOptional Schema
249+ | SchemaUnion [Schema]
208 deriving (Generic)
250 deriving (Generic)
209
251
210data DemotedSchema
252data DemotedSchema
@@ -215,7 +257,8 @@ data DemotedSchema
215 | DSchemaArray [DemotedArrayConstraint] DemotedSchema
257 | DSchemaArray [DemotedArrayConstraint] DemotedSchema
216 | DSchemaNull
258 | DSchemaNull
217 | DSchemaOptional DemotedSchema
259 | DSchemaOptional DemotedSchema
260+ | DSchemaUnion [DemotedSchema]
218− deriving (Generic)
261+ deriving (Generic, Eq, Show)
219
262
220data instance Sing (schema :: Schema) where
263data instance Sing (schema :: Schema) where
221 SSchemaText :: Sing tcs -> Sing ('SchemaText tcs)
264 SSchemaText :: Sing tcs -> Sing ('SchemaText tcs)
@@ -225,6 +268,7 @@ data instance Sing (schema :: Schema) where
225 SSchemaObject :: Sing fields -> Sing ('SchemaObject fields)
268 SSchemaObject :: Sing fields -> Sing ('SchemaObject fields)
226 SSchemaOptional :: Sing s -> Sing ('SchemaOptional s)
269 SSchemaOptional :: Sing s -> Sing ('SchemaOptional s)
227 SSchemaNull :: Sing 'SchemaNull
270 SSchemaNull :: Sing 'SchemaNull
271+ SSchemaUnion :: Sing ss -> Sing ('SchemaUnion ss)
228
272
229instance SingI sl => SingI ('SchemaText sl) where
273instance SingI sl => SingI ('SchemaText sl) where
230 sing = SSchemaText sing
274 sing = SSchemaText sing
@@ -240,6 +284,8 @@ instance SingI stl => SingI ('SchemaObject stl) where
240 sing = SSchemaObject sing
284 sing = SSchemaObject sing
241instance SingI s => SingI ('SchemaOptional s) where
285instance SingI s => SingI ('SchemaOptional s) where
242 sing = SSchemaOptional sing
286 sing = SSchemaOptional sing
287+instance SingI s => SingI ('SchemaUnion s) where
288+ sing = SSchemaUnion sing
243
289
244instance Eq (Sing ('SchemaText cs)) where _ == _ = True
290instance Eq (Sing ('SchemaText cs)) where _ == _ = True
245instance Eq (Sing ('SchemaNumber cs)) where _ == _ = True
291instance Eq (Sing ('SchemaNumber cs)) where _ == _ = True
@@ -248,9 +294,10 @@ instance Eq (Sing 'SchemaBoolean) where _ == _ = True
248instance Eq (Sing ('SchemaArray as s)) where _ == _ = True
294instance Eq (Sing ('SchemaArray as s)) where _ == _ = True
249instance Eq (Sing ('SchemaObject cs)) where _ == _ = True
295instance Eq (Sing ('SchemaObject cs)) where _ == _ = True
250instance Eq (Sing ('SchemaOptional s)) where _ == _ = True
296instance Eq (Sing ('SchemaOptional s)) where _ == _ = True
297+instance Eq (Sing ('SchemaUnion s)) where _ == _ = True
251
298
252instance SingKind Schema where
299instance SingKind Schema where
253− type DemoteRep Schema = DemotedSchema
300+ type Demote Schema = DemotedSchema
254 fromSing = \case
301 fromSing = \case
255 SSchemaText cs -> DSchemaText $ fromSing cs
302 SSchemaText cs -> DSchemaText $ fromSing cs
256 SSchemaNumber cs -> DSchemaNumber $ fromSing cs
303 SSchemaNumber cs -> DSchemaNumber $ fromSing cs
@@ -258,12 +305,8 @@ instance SingKind Schema where
258 SSchemaArray cs s -> DSchemaArray (fromSing cs) (fromSing s)
305 SSchemaArray cs s -> DSchemaArray (fromSing cs) (fromSing s)
259 SSchemaOptional s -> DSchemaOptional $ fromSing s
306 SSchemaOptional s -> DSchemaOptional $ fromSing s
260 SSchemaNull -> DSchemaNull
307 SSchemaNull -> DSchemaNull
261− SSchemaObject cs -> let
308+ SSchemaObject cs -> DSchemaObject $ fromSing cs
262− dem :: Sing (s :: [(Symbol, Schema)]) -> [(Text, DemotedSchema)]
309+ SSchemaUnion ss -> DSchemaUnion $ fromSing ss
263− dem SNil = []
264− dem (SCons (STuple2 ss ssch) fs) = withKnownSymbol ss
265− $ (T.pack (symbolVal ss), fromSing ssch) : dem fs
266− in DSchemaObject $ dem cs
267 toSing = \case
310 toSing = \case
268 DSchemaText cs -> case toSing cs of
311 DSchemaText cs -> case toSing cs of
269 SomeSing scs -> SomeSing $ SSchemaText scs
312 SomeSing scs -> SomeSing $ SSchemaText scs
@@ -275,8 +318,10 @@ instance SingKind Schema where
275 DSchemaOptional sch -> case toSing sch of
318 DSchemaOptional sch -> case toSing sch of
276 SomeSing ssch -> SomeSing $ SSchemaOptional ssch
319 SomeSing ssch -> SomeSing $ SSchemaOptional ssch
277 DSchemaNull -> SomeSing SSchemaNull
320 DSchemaNull -> SomeSing SSchemaNull
278− DSchemaObject cs -> case toSing ((\(sym,sch) -> (T.unpack sym, sch)) <$> cs) of
321+ DSchemaObject cs -> case toSing cs of
279 SomeSing scs -> SomeSing $ SSchemaObject scs
322 SomeSing scs -> SomeSing $ SSchemaObject scs
323+ DSchemaUnion ss -> case toSing ss of
324+ SomeSing sss -> SomeSing $ SSchemaUnion sss
280
325
281data FieldRepr :: (Symbol, Schema) -> Type where
326data FieldRepr :: (Symbol, Schema) -> Type where
282 FieldRepr
327 FieldRepr
@@ -314,6 +359,10 @@ instance
314 => Serial m (FieldRepr '(name, schema)) where
359 => Serial m (FieldRepr '(name, schema)) where
315 series = FieldRepr <$> series
360 series = FieldRepr <$> series
316
361
362+type family USubsets (u :: [k]) :: Constraint where
363+ USubsets '[] = ()
364+ USubsets (h ': tl) = (USubset tl (h ': tl) (V.RImage tl (h ': tl)), USubsets tl)
365+
317data JsonRepr :: Schema -> Type where
366data JsonRepr :: Schema -> Type where
318 ReprText :: Text -> JsonRepr ('SchemaText cs)
367 ReprText :: Text -> JsonRepr ('SchemaText cs)
319 ReprNumber :: Scientific -> JsonRepr ('SchemaNumber cs)
368 ReprNumber :: Scientific -> JsonRepr ('SchemaNumber cs)
@@ -322,46 +371,65 @@ data JsonRepr :: Schema -> Type where
322 ReprArray :: V.Vector (JsonRepr s) -> JsonRepr ('SchemaArray cs s)
371 ReprArray :: V.Vector (JsonRepr s) -> JsonRepr ('SchemaArray cs s)
323 ReprObject :: Rec FieldRepr fs -> JsonRepr ('SchemaObject fs)
372 ReprObject :: Rec FieldRepr fs -> JsonRepr ('SchemaObject fs)
324 ReprOptional :: Maybe (JsonRepr s) -> JsonRepr ('SchemaOptional s)
373 ReprOptional :: Maybe (JsonRepr s) -> JsonRepr ('SchemaOptional s)
374+ ReprUnion :: Union JsonRepr (h ': tl) -> JsonRepr ('SchemaUnion (h ': tl))
375+
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)
325
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+
401+-- | Move to the union package
326instance Show (JsonRepr ('SchemaText cs)) where
402instance Show (JsonRepr ('SchemaText cs)) where
327 show (ReprText t) = "ReprText " P.++ show t
403 show (ReprText t) = "ReprText " P.++ show t
328
404
329instance Show (JsonRepr ('SchemaNumber cs)) where
405instance Show (JsonRepr ('SchemaNumber cs)) where
330 show (ReprNumber n) = "ReprNumber " P.++ show n
406 show (ReprNumber n) = "ReprNumber " P.++ show n
331
407
408+instance Show (JsonRepr 'SchemaBoolean) where
409+ show (ReprBoolean n) = "ReprBoolean " P.++ show n
410+
332instance Show (JsonRepr 'SchemaNull) where show _ = "ReprNull"
411instance Show (JsonRepr 'SchemaNull) where show _ = "ReprNull"
333
412
334instance Show (JsonRepr s) => Show (JsonRepr ('SchemaArray acs s)) where
413instance Show (JsonRepr s) => Show (JsonRepr ('SchemaArray acs s)) where
335 show (ReprArray v) = "ReprArray " P.++ show v
414 show (ReprArray v) = "ReprArray " P.++ show v
336
415
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
337instance V.RecAll FieldRepr fs Show => Show (JsonRepr ('SchemaObject fs)) where
423instance V.RecAll FieldRepr fs Show => Show (JsonRepr ('SchemaObject fs)) where
338 show (ReprObject fs) = "ReprObject " P.++ show fs
424 show (ReprObject fs) = "ReprObject " P.++ show fs
425+#endif
339
426
340instance Show (JsonRepr s) => Show (JsonRepr ('SchemaOptional s)) where
427instance Show (JsonRepr s) => Show (JsonRepr ('SchemaOptional s)) where
341 show (ReprOptional s) = "ReprOptional " P.++ show s
428 show (ReprOptional s) = "ReprOptional " P.++ show s
342
429
343−instance (Monad m, Serial m Text)
430+instance Show (Union JsonRepr (h ': tl))
344− => Serial m (JsonRepr ('SchemaText cs)) where
431+ => Show (JsonRepr ('SchemaUnion (h ': tl))) where
345− series = cons1 ReprText
432+ show (ReprUnion s) = "ReprUnion " P.++ show s
346−
347−instance (Monad m, Serial m Scientific)
348− => Serial m (JsonRepr ('SchemaNumber cs)) where
349− series = cons1 ReprNumber
350−
351−instance Monad m => Serial m (JsonRepr 'SchemaNull) where
352− series = cons0 ReprNull
353−
354−instance (Serial m (V.Vector (JsonRepr s)))
355− => Serial m (JsonRepr ('SchemaArray cs s)) where
356− series = cons1 ReprArray
357−
358−instance (Serial m (JsonRepr s))
359− => Serial m (JsonRepr ('SchemaOptional s)) where
360− series = cons1 ReprOptional
361−
362−instance (Monad m, Serial m (Rec FieldRepr fs))
363− => Serial m (JsonRepr ('SchemaObject fs)) where
364− series = cons1 ReprObject
365
433
366instance Eq (Rec FieldRepr fs) => Eq (JsonRepr ('SchemaObject fs)) where
434instance Eq (Rec FieldRepr fs) => Eq (JsonRepr ('SchemaObject fs)) where
367 ReprObject a == ReprObject b = a == b
435 ReprObject a == ReprObject b = a == b
@@ -372,6 +440,9 @@ instance Eq (JsonRepr ('SchemaText cs)) where
372instance Eq (JsonRepr ('SchemaNumber cs)) where
440instance Eq (JsonRepr ('SchemaNumber cs)) where
373 ReprNumber a == ReprNumber b = a == b
441 ReprNumber a == ReprNumber b = a == b
374
442
443+instance Eq (JsonRepr 'SchemaBoolean) where
444+ ReprBoolean a == ReprBoolean b = a == b
445+
375instance Eq (JsonRepr 'SchemaNull) where
446instance Eq (JsonRepr 'SchemaNull) where
376 ReprNull == ReprNull = True
447 ReprNull == ReprNull = True
377
448
@@ -381,6 +452,51 @@ instance Eq (JsonRepr s) => Eq (JsonRepr ('SchemaArray as s)) where
381instance Eq (JsonRepr s) => Eq (JsonRepr ('SchemaOptional s)) where
452instance Eq (JsonRepr s) => Eq (JsonRepr ('SchemaOptional s)) where
382 ReprOptional a == ReprOptional b = a == b
453 ReprOptional a == ReprOptional b = a == b
383
454
455+instance Eq (Union JsonRepr (h ': tl))
456+ => Eq (JsonRepr ('SchemaUnion (h ': tl))) where
457+ ReprUnion a == ReprUnion b = a == b
458+
459+instance Ord (Rec FieldRepr fs) => Ord (JsonRepr ('SchemaObject fs)) where
460+ ReprObject a `compare` ReprObject b = a `compare` b
461+
462+instance Ord (JsonRepr ('SchemaText cs)) where
463+ ReprText a `compare` ReprText b = a `compare` b
464+
465+instance Ord (JsonRepr ('SchemaNumber cs)) where
466+ ReprNumber a `compare` ReprNumber b = a `compare` b
467+
468+instance Ord (JsonRepr 'SchemaBoolean) where
469+ ReprBoolean a `compare` ReprBoolean b = a `compare` b
470+
471+instance Ord (JsonRepr 'SchemaNull) where
472+ compare _ _ = EQ
473+
474+instance Ord (JsonRepr s) => Ord (JsonRepr ('SchemaArray as s)) where
475+ ReprArray a `compare` ReprArray b = a `compare` b
476+
477+instance Ord (JsonRepr s) => Ord (JsonRepr ('SchemaOptional s)) where
478+ ReprOptional a `compare` ReprOptional b = a `compare` b
479+
480+instance Ord (Union JsonRepr (h ': tl))
481+ => Ord (JsonRepr ('SchemaUnion (h ': tl))) where
482+ ReprUnion a `compare` ReprUnion b = a `compare` b
483+
484+instance IsList (JsonRepr ('SchemaArray cs s)) where
485+ type Item (JsonRepr ('SchemaArray cs s)) = JsonRepr s
486+ fromList = ReprArray . GHC.Exts.fromList
487+ toList (ReprArray v) = GHC.Exts.toList v
488+
489+instance Num (JsonRepr ('SchemaNumber cs)) where
490+ ReprNumber a + ReprNumber b = ReprNumber $ a + b
491+ ReprNumber a - ReprNumber b = ReprNumber $ a - b
492+ ReprNumber a * ReprNumber b = ReprNumber $ a * b
493+ abs (ReprNumber a) = ReprNumber $ abs a
494+ signum (ReprNumber a) = ReprNumber $ signum a
495+ fromInteger = ReprNumber . fromIntegral
496+
497+instance IsString (JsonRepr ('SchemaText cs)) where
498+ fromString = ReprText . fromString
499+
384fromOptional
500fromOptional
385 :: SingI s
501 :: SingI s
386 => Sing ('SchemaOptional s)
502 => Sing ('SchemaOptional s)
@@ -388,6 +504,24 @@ fromOptional
388 -> Parser (Maybe (JsonRepr s))
504 -> Parser (Maybe (JsonRepr s))
389fromOptional _ = parseJSON
505fromOptional _ = parseJSON
390
506
507+parseUnion
508+ :: FromJSON (JsonRepr ('SchemaUnion ss))
509+ => sing (ss :: [Schema])
510+ -> Value
511+ -> Parser (JsonRepr ('SchemaUnion ss))
512+parseUnion _ val = parseJSON val
513+
514+instance FromJSON (Union JsonRepr '[]) where
515+ parseJSON = fail "empty union"
516+
517+instance (SingI a, FromJSON (Union JsonRepr as)) => FromJSON (Union JsonRepr (a ': as)) where
518+ parseJSON val = (This <$> parseJSON val)
519+ <|> (That <$> (parseJSON val :: Parser (Union JsonRepr as)))
520+
521+instance ToJSON (Union JsonRepr as) where
522+ toJSON (This fa) = toJSON fa
523+ toJSON (That u) = toJSON u
524+
391instance SingI schema => J.FromJSON (JsonRepr schema) where
525instance SingI schema => J.FromJSON (JsonRepr schema) where
392 parseJSON value = case sing :: Sing schema of
526 parseJSON value = case sing :: Sing schema of
393 SSchemaText _ -> withText "String" (pure . ReprText) value
527 SSchemaText _ -> withText "String" (pure . ReprText) value
@@ -408,27 +542,29 @@ instance SingI schema => J.FromJSON (JsonRepr schema) where
408 fieldRepr <- case s of
542 fieldRepr <- case s of
409 SSchemaText so -> case H.lookup fieldName h of
543 SSchemaText so -> case H.lookup fieldName h of
410 Just v -> withSingI so $ FieldRepr <$> parseJSON v
544 Just v -> withSingI so $ FieldRepr <$> parseJSON v
411− Nothing -> fail "schematext"
545+ Nothing -> fail $ "No text field: " P.++ show fieldName
412 SSchemaNumber so -> case H.lookup fieldName h of
546 SSchemaNumber so -> case H.lookup fieldName h of
413 Just v -> withSingI so $ FieldRepr <$> parseJSON v
547 Just v -> withSingI so $ FieldRepr <$> parseJSON v
414− Nothing -> fail "schemanumber"
548+ Nothing -> fail $ "No number field: " P.++ show fieldName
415 SSchemaBoolean -> case H.lookup fieldName h of
549 SSchemaBoolean -> case H.lookup fieldName h of
416 Just v -> FieldRepr <$> parseJSON v
550 Just v -> FieldRepr <$> parseJSON v
417− Nothing -> fail "schemaboolean"
551+ Nothing -> fail $ "No boolean field: " P.++ show fieldName
418 SSchemaNull -> case H.lookup fieldName h of
552 SSchemaNull -> case H.lookup fieldName h of
419 Just v -> FieldRepr <$> parseJSON v
553 Just v -> FieldRepr <$> parseJSON v
420− Nothing -> fail "schemanull"
554+ Nothing -> fail $ "No null field: " P.++ show fieldName
421 SSchemaArray sa sb -> case H.lookup fieldName h of
555 SSchemaArray sa sb -> case H.lookup fieldName h of
422 Just v -> withSingI sa $ withSingI sb $ FieldRepr <$> parseJSON v
556 Just v -> withSingI sa $ withSingI sb $ FieldRepr <$> parseJSON v
423− Nothing -> fail "schemaarray"
557+ Nothing -> fail $ "No array field: " P.++ show fieldName
424 SSchemaObject so -> case H.lookup fieldName h of
558 SSchemaObject so -> case H.lookup fieldName h of
425 Just v -> withSingI so $ FieldRepr <$> parseJSON v
559 Just v -> withSingI so $ FieldRepr <$> parseJSON v
426− Nothing -> fail "schemaobject"
560+ Nothing -> fail $ "No object field" P.++ show fieldName
427 SSchemaOptional so -> case H.lookup fieldName h of
561 SSchemaOptional so -> case H.lookup fieldName h of
428 Just v -> withSingI so $ FieldRepr <$> parseJSON v
562 Just v -> withSingI so $ FieldRepr <$> parseJSON v
429− Nothing -> fail "schemaoptional"
563+ Nothing -> withSingI so $ pure $ FieldRepr $ ReprOptional Nothing
564+ SSchemaUnion ss -> withSingI ss $ FieldRepr <$> parseUnion ss value
430 (fieldRepr :&) <$> demoteFields tl h
565 (fieldRepr :&) <$> demoteFields tl h
431 ReprObject <$> withObject "Object" (demoteFields fs) value
566 ReprObject <$> withObject "Object" (demoteFields fs) value
567+ SSchemaUnion ss -> parseUnion ss value
432
568
433instance J.ToJSON (JsonRepr a) where
569instance J.ToJSON (JsonRepr a) where
434 toJSON ReprNull = J.Null
570 toJSON ReprNull = J.Null
@@ -436,7 +572,7 @@ instance J.ToJSON (JsonRepr a) where
436 toJSON (ReprText t) = J.String t
572 toJSON (ReprText t) = J.String t
437 toJSON (ReprNumber n) = J.Number n
573 toJSON (ReprNumber n) = J.Number n
438 toJSON (ReprOptional s) = case s of
574 toJSON (ReprOptional s) = case s of
439− Just v -> toJSON v
575+ Just v -> toJSON v
440 Nothing -> J.Null
576 Nothing -> J.Null
441 toJSON (ReprArray v) = J.Array $ toJSON <$> v
577 toJSON (ReprArray v) = J.Array $ toJSON <$> v
442 toJSON (ReprObject r) = J.Object . H.fromList . fold $ r
578 toJSON (ReprObject r) = J.Object . H.fromList . fold $ r
@@ -449,6 +585,7 @@ instance J.ToJSON (JsonRepr a) where
449 fold = \case
585 fold = \case
450 RNil -> []
586 RNil -> []
451 fr@(FieldRepr _) :& tl -> (extract fr) : fold tl
587 fr@(FieldRepr _) :& tl -> (extract fr) : fold tl
588+ toJSON (ReprUnion u) = toJSON u
452
589
453class FalseConstraint a
590class FalseConstraint a
454
591
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/Utils.hsdeleted−42
@@ -1,42 +0,0 @@
1−{-# LANGUAGE AllowAmbiguousTypes #-}
2−
3−module Data.Schematic.Utils where
4−
5−import Data.Proxy
6−import Data.Singletons
7−import Data.Singletons.Prelude
8−import Data.Singletons.TypeLits
9−import Data.Vinyl hiding (Dict)
10−
11−
12−class Known a where
13− known :: a
14−
15−instance Known (Proxy a) where
16− known = Proxy
17−
18−instance KnownNat n => Known (Sing n) where
19− known = SNat
20−
21−instance KnownSymbol s => Known (Sing s) where
22− known = SSym
23−
24−instance (Known (Sing a), Known (Sing b)) => Known (Sing '(a,b)) where
25− known = STuple2 known known
26−
27−instance Known (Sing '[]) where known = SNil
28−
29−instance (Known (Sing a), Known (Sing as)) => Known (Sing (a ': as)) where
30− known = SCons known known
31−
32−instance Known (Rec Sing '[]) where
33− known = RNil
34−
35−instance (Known (Sing a), Known (Rec Sing tl)) => Known (Rec Sing (a ': tl)) where
36− known = known :& known
37−
38−data Dict c where
39− Dict :: c => Dict c
40−
41−instance c => Known (Dict c) where
42− known = Dict
src/Data/Schematic/Validation.hs+134−34
@@ -2,20 +2,25 @@ module Data.Schematic.Validation where
2
2
3import Control.Monad
3import Control.Monad
4import Control.Monad.Validation
4import Control.Monad.Validation
5+import Data.Aeson
6+import Data.Aeson.Internal
7+import Data.Aeson.Types
5import Data.Foldable
8import Data.Foldable
6import Data.Functor.Identity
9import Data.Functor.Identity
7import Data.Monoid
10import Data.Monoid
8import Data.Schematic.Path
11import Data.Schematic.Path
9import Data.Schematic.Schema
12import Data.Schematic.Schema
10−import Data.Schematic.Utils ()
11import Data.Scientific
13import Data.Scientific
12import Data.Singletons.Prelude
14import Data.Singletons.Prelude
13import Data.Singletons.TypeLits
15import Data.Singletons.TypeLits
14import Data.Text as T
16import Data.Text as T
17+import Data.Traversable
18+import Data.Union
15import Data.Vector as V
19import Data.Vector as V
16import Data.Vinyl
20import Data.Vinyl
21+import Data.Vinyl.TypeLevel
17import Prelude as P
22import Prelude as P
18−import Text.Regex
23+import Text.Regex.TDFA
19
24
20
25
21type Validation a = ValidationT ErrorMap Identity a
26type Validation a = ValidationT ErrorMap Identity a
@@ -26,7 +31,11 @@ data ParseResult a
26 = Valid a
31 = Valid a
27 | DecodingError Text -- static
32 | DecodingError Text -- static
28 | ValidationError ErrorMap -- runtime
33 | ValidationError ErrorMap -- runtime
29− deriving (Show, Eq, Functor)
34+ deriving (Show, Eq, Functor, Foldable, Traversable)
35+
36+instance (TopLevel a, SingI a, FromJSON (JsonRepr a))
37+ => FromJSON (ParseResult (JsonRepr a)) where
38+ parseJSON = pure . parseAndValidateJson @a
30
39
31isValid :: ParseResult a -> Bool
40isValid :: ParseResult a -> Bool
32isValid (Valid _) = True
41isValid (Valid _) = True
@@ -41,51 +50,51 @@ isValidationError (ValidationError _) = True
41isValidationError _ = False
50isValidationError _ = False
42
51
43validateTextConstraint
52validateTextConstraint
44− :: JSONPath
53+ :: JSONPathText
45 -> Text
54 -> Text
46 -> Sing (tcs :: TextConstraint)
55 -> Sing (tcs :: TextConstraint)
47 -> Validation ()
56 -> Validation ()
48−validateTextConstraint (JSONPath path) t = \case
57+validateTextConstraint (JSONPathText path) t = \case
49 STEq n -> do
58 STEq n -> do
50 let
59 let
51 nlen = withKnownNat n $ natVal n
60 nlen = withKnownNat n $ natVal n
52 predicate = nlen == (fromIntegral $ T.length t)
61 predicate = nlen == (fromIntegral $ T.length t)
53− errMsg = "length of " <> path <> " should be == " <> T.pack (show nlen)
62+ errMsg = "length should be == " <> T.pack (show nlen)
54 warn = vWarning $ mmSingleton path (pure errMsg)
63 warn = vWarning $ mmSingleton path (pure errMsg)
55 unless predicate warn
64 unless predicate warn
56 STLt n -> do
65 STLt n -> do
57 let
66 let
58 nlen = withKnownNat n $ natVal n
67 nlen = withKnownNat n $ natVal n
59− predicate = nlen < (fromIntegral $ T.length t)
68+ predicate = nlen > (fromIntegral $ T.length t)
60− errMsg = "length of " <> path <> " should be < " <> T.pack (show nlen)
69+ errMsg = "length should be < " <> T.pack (show nlen)
61 warn = vWarning $ mmSingleton path (pure errMsg)
70 warn = vWarning $ mmSingleton path (pure errMsg)
62 unless predicate warn
71 unless predicate warn
63 STLe n -> do
72 STLe n -> do
64 let
73 let
65 nlen = withKnownNat n $ natVal n
74 nlen = withKnownNat n $ natVal n
66− predicate = nlen <= (fromIntegral $ T.length t)
75+ predicate = nlen >= (fromIntegral $ T.length t)
67− errMsg = "length of " <> path <> " should be <= " <> T.pack (show nlen)
76+ errMsg = "length should be <= " <> T.pack (show nlen)
68 warn = vWarning $ mmSingleton path (pure errMsg)
77 warn = vWarning $ mmSingleton path (pure errMsg)
69 unless predicate warn
78 unless predicate warn
70 STGt n -> do
79 STGt n -> do
71 let
80 let
72 nlen = withKnownNat n $ natVal n
81 nlen = withKnownNat n $ natVal n
73− predicate = nlen > (fromIntegral $ T.length t)
82+ predicate = nlen < (fromIntegral $ T.length t)
74− errMsg = "length of " <> path <> " should be > " <> T.pack (show nlen)
83+ errMsg = "length should be > " <> T.pack (show nlen)
75 warn = vWarning $ mmSingleton path (pure errMsg)
84 warn = vWarning $ mmSingleton path (pure errMsg)
76 unless predicate warn
85 unless predicate warn
77 STGe n -> do
86 STGe n -> do
78 let
87 let
79 nlen = withKnownNat n $ natVal n
88 nlen = withKnownNat n $ natVal n
80− predicate = nlen >= (fromIntegral $ T.length t)
89+ predicate = nlen <= (fromIntegral $ T.length t)
81− errMsg = "length of " <> path <> " should be >= " <> T.pack (show nlen)
90+ errMsg = "length should be >= " <> T.pack (show nlen)
82 warn = vWarning $ mmSingleton path (pure errMsg)
91 warn = vWarning $ mmSingleton path (pure errMsg)
83 unless predicate warn
92 unless predicate warn
84 STRegex r -> do
93 STRegex r -> do
85 let
94 let
86− regex = withKnownSymbol r $ symbolVal r
95+ regex = withKnownSymbol r $ fromSing r
87− predicate = maybe False (const True) $ matchRegex (mkRegex regex) (T.unpack t)
96+ predicate = matchTest (makeRegex (T.unpack regex) :: Regex) (T.unpack t)
88− errMsg = path <> " must match " <> T.pack (show regex)
97+ errMsg = "must match " <> regex
89 warn = vWarning $ mmSingleton path (pure errMsg)
98 warn = vWarning $ mmSingleton path (pure errMsg)
90 unless predicate warn
99 unless predicate warn
91 STEnum ss -> do
100 STEnum ss -> do
@@ -93,69 +102,97 @@ validateTextConstraint (JSONPath path) t = \case
93 matching :: Sing (s :: [Symbol]) -> Bool
102 matching :: Sing (s :: [Symbol]) -> Bool
94 matching SNil = False
103 matching SNil = False
95 matching (SCons s@SSym fs) = T.pack (symbolVal s) == t || matching fs
104 matching (SCons s@SSym fs) = T.pack (symbolVal s) == t || matching fs
96− errMsg = path <> " must be one of " <> T.pack (show (fromSing ss))
105+ errMsg = "must be one of " <> T.pack (show (fromSing ss))
97 warn = vWarning $ mmSingleton path (pure errMsg)
106 warn = vWarning $ mmSingleton path (pure errMsg)
98 unless (matching ss) warn
107 unless (matching ss) warn
99
108
100validateNumberConstraint
109validateNumberConstraint
101− :: JSONPath
110+ :: JSONPathText
102 -> Scientific
111 -> Scientific
103 -> Sing (tcs :: NumberConstraint)
112 -> Sing (tcs :: NumberConstraint)
104 -> Validation ()
113 -> Validation ()
105−validateNumberConstraint (JSONPath path) num = \case
114+validateNumberConstraint (JSONPathText path) num = \case
106 SNEq n -> do
115 SNEq n -> do
107 let
116 let
108 nlen = withKnownNat n $ natVal n
117 nlen = withKnownNat n $ natVal n
109 predicate = fromIntegral nlen == num
118 predicate = fromIntegral nlen == num
110− errMsg = path <> " should be == " <> T.pack (show nlen)
119+ errMsg = "should be == " <> T.pack (show nlen)
111 warn = vWarning $ mmSingleton path (pure errMsg)
120 warn = vWarning $ mmSingleton path (pure errMsg)
112 unless predicate warn
121 unless predicate warn
113 SNGt n -> do
122 SNGt n -> do
114 let
123 let
115 nlen = withKnownNat n $ natVal n
124 nlen = withKnownNat n $ natVal n
116 predicate = num > fromIntegral nlen
125 predicate = num > fromIntegral nlen
117− errMsg = path <> " should be > " <> T.pack (show nlen)
126+ errMsg = "should be > " <> T.pack (show nlen)
118 warn = vWarning $ mmSingleton path (pure errMsg)
127 warn = vWarning $ mmSingleton path (pure errMsg)
119 unless predicate warn
128 unless predicate warn
120 SNGe n -> do
129 SNGe n -> do
121 let
130 let
122 nlen = withKnownNat n $ natVal n
131 nlen = withKnownNat n $ natVal n
123 predicate = num >= fromIntegral nlen
132 predicate = num >= fromIntegral nlen
124− errMsg = path <> " should be >= " <> T.pack (show nlen)
133+ errMsg = "should be >= " <> T.pack (show nlen)
125 warn = vWarning $ mmSingleton path (pure errMsg)
134 warn = vWarning $ mmSingleton path (pure errMsg)
126 unless predicate warn
135 unless predicate warn
127 SNLt n -> do
136 SNLt n -> do
128 let
137 let
129 nlen = withKnownNat n $ natVal n
138 nlen = withKnownNat n $ natVal n
130− predicate = fromIntegral nlen < num
139+ predicate = num < fromIntegral nlen
131− errMsg = path <> " should be < " <> T.pack (show nlen)
140+ errMsg = "should be < " <> T.pack (show nlen)
132 warn = vWarning $ mmSingleton path (pure errMsg)
141 warn = vWarning $ mmSingleton path (pure errMsg)
133 unless predicate warn
142 unless predicate warn
134 SNLe n -> do
143 SNLe n -> do
135 let
144 let
136 nlen = withKnownNat n $ natVal n
145 nlen = withKnownNat n $ natVal n
137− predicate = fromIntegral nlen <= num
146+ predicate = num <= fromIntegral nlen
138− errMsg = path <> " should be <= " <> T.pack (show nlen)
147+ errMsg = "should be <= " <> T.pack (show nlen)
139 warn = vWarning $ mmSingleton path (pure errMsg)
148 warn = vWarning $ mmSingleton path (pure errMsg)
140 unless predicate warn
149 unless predicate warn
141
150
142validateArrayConstraint
151validateArrayConstraint
143− :: JSONPath
152+ :: JSONPathText
144 -> V.Vector a
153 -> V.Vector a
145 -> Sing (tcs :: ArrayConstraint)
154 -> Sing (tcs :: ArrayConstraint)
146 -> Validation ()
155 -> Validation ()
147−validateArrayConstraint (JSONPath path) v = \case
156+validateArrayConstraint (JSONPathText path) v = \case
148 SAEq n -> do
157 SAEq n -> do
149 let
158 let
150 nlen = withKnownNat n $ natVal n
159 nlen = withKnownNat n $ natVal n
151 predicate = nlen == fromIntegral (V.length v)
160 predicate = nlen == fromIntegral (V.length v)
152− 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)
153 warn = vWarning $ mmSingleton path (pure errMsg)
190 warn = vWarning $ mmSingleton path (pure errMsg)
154 unless predicate warn
191 unless predicate warn
155
192
156validateJsonRepr
193validateJsonRepr
157 :: Sing schema
194 :: Sing schema
158− -> [DemotedPathSegment]
195+ -> JSONPath
159 -> JsonRepr schema
196 -> JsonRepr schema
160 -> Validation ()
197 -> Validation ()
161validateJsonRepr sschema dpath jr = case jr of
198validateJsonRepr sschema dpath jr = case jr of
@@ -189,7 +226,7 @@ validateJsonRepr sschema dpath jr = case jr of
189 process cs
226 process cs
190 process acs
227 process acs
191 for_ (V.indexed v) $ \(ix, jr') -> do
228 for_ (V.indexed v) $ \(ix, jr') -> do
192− let newPath = dpath <> pure (DIx $ fromIntegral ix)
229+ let newPath = dpath <> pure (Index $ fromIntegral ix)
193 validateJsonRepr s newPath jr'
230 validateJsonRepr s newPath jr'
194 ReprOptional d -> case sschema of
231 ReprOptional d -> case sschema of
195 SSchemaOptional ss -> case d of
232 SSchemaOptional ss -> case d of
@@ -198,9 +235,72 @@ validateJsonRepr sschema dpath jr = case jr of
198 ReprObject fs -> case sschema of
235 ReprObject fs -> case sschema of
199 SSchemaObject _ -> go fs
236 SSchemaObject _ -> go fs
200 where
237 where
201− go :: Rec FieldRepr (ts :: [ (Symbol, Schema) ] ) -> Validation ()
238+ go :: Rec FieldRepr (ts :: [(Symbol, Schema)] ) -> Validation ()
202 go RNil = pure ()
239 go RNil = pure ()
203 go (f@(FieldRepr d) :& ftl) = do
240 go (f@(FieldRepr d) :& ftl) = do
204− let newPath = dpath <> [DKey (knownFieldName f)]
241+ let newPath = dpath <> [Key (knownFieldName f)]
205 validateJsonRepr (knownFieldSchema f) newPath d
242 validateJsonRepr (knownFieldSchema f) newPath d
206 go ftl
243 go ftl
244+ ReprUnion _ -> pure () -- FIXME
245+ -- case sschema of
246+ -- SSchemaUnion ss -> case ss of
247+ -- SCons s stl -> case umatch' s u of
248+ -- Nothing -> case urestrict u of
249+ -- Nothing ->
250+ -- fail "impossible to produce subUnion, please report this as a bug"
251+ -- Just x -> do
252+ -- let
253+ -- JSONPathText path = demotedPathToText dpath
254+ -- case stl of
255+ -- SNil -> void $ vWarning $ mmSingleton path
256+ -- $ pure "union handling error, please report this as bug"
257+ -- SCons s' stl' ->
258+ -- validateJsonRepr (SSchemaUnion (SCons s' stl')) dpath
259+ -- $ toUnion (SCons s' stl') x
260+ -- Just x -> validateJsonRepr s dpath x
261+
262+-- subUnion
263+-- :: Sing (s ': stl)
264+-- -> ( USubset stl (s ': stl) (RImage stl (s ': stl))
265+-- => Union f (s ': stl)
266+-- -> Maybe (Union f stl) )
267+-- subUnion (SCons s stl) = urestrict
268+
269+-- withUSubset
270+-- :: Sing (s ': stl)
271+-- -> (USubset stl (s ': stl) (RImage stl (s ': stl)) => Maybe (Union f stl))
272+-- -> Maybe (Union f stl)
273+-- withUSubset (SCons s stl) r = r
274+
275+toUnion
276+ :: USubset s' (s ': ss) (RImage s' (s ': ss))
277+ => Sing (s ': ss)
278+ -> Union JsonRepr s'
279+ -> JsonRepr ('SchemaUnion (s ': ss))
280+toUnion _ = ReprUnion . urelax
281+
282+umatch' :: UElem a as i => Sing a -> Union f as -> Maybe (f a)
283+umatch' _ u = umatch u
284+
285+parseAndValidateJson
286+ :: forall schema
287+ . (FromJSON (JsonRepr schema), TopLevel schema, SingI schema)
288+ => Value
289+ -> ParseResult (JsonRepr schema)
290+parseAndValidateJson v =
291+ case parseEither parseJSON v of
292+ Left s -> DecodingError $ T.pack s
293+ Right jsonRepr ->
294+ let
295+ validate = validateJsonRepr (sing :: Sing schema) [] jsonRepr
296+ res = runIdentity . runValidationTEither $ validate
297+ in case res of
298+ Left em -> ValidationError em
299+ Right () -> Valid jsonRepr
300+
301+parseAndValidateJsonBy
302+ :: (FromJSON (JsonRepr schema), TopLevel schema, SingI schema)
303+ => proxy schema
304+ -> Value
305+ -> ParseResult (JsonRepr schema)
306+parseAndValidateJsonBy _ = parseAndValidateJson
src/Data/Schematic/Verifier.hsnew file+5
@@ -0,0 +1,5 @@
1+module Data.Schematic.Verifier (module X) where
2+
3+import Data.Schematic.Verifier.Array as X
4+import Data.Schematic.Verifier.Number as X
5+import Data.Schematic.Verifier.Text as X
src/Data/Schematic/Verifier/Array.hsnew file+14
@@ -0,0 +1,14 @@
1+module Data.Schematic.Verifier.Array where
2+
3+import {-# SOURCE #-} Data.Schematic.Schema
4+import Data.Schematic.Verifier.Common
5+
6+data VerifiedArrayConstraint =
7+ VAEq Integer
8+ deriving (Show)
9+
10+verifyArrayConstraint ::
11+ [DemotedArrayConstraint] -> Maybe (Maybe VerifiedArrayConstraint)
12+verifyArrayConstraint cs = do
13+ x <- verifyDNEq [x | DAEq x <- cs]
14+ pure $ VAEq <$> x
src/Data/Schematic/Verifier/Common.hsnew file+43
@@ -0,0 +1,43 @@
1+module Data.Schematic.Verifier.Common where
2+
3+import Data.List (nub)
4+
5+simplifyNumberConstraint :: ([Integer] -> Integer) -> [Integer] -> Maybe Integer
6+simplifyNumberConstraint f =
7+ \case
8+ [] -> Nothing
9+ x -> Just $ f x
10+
11+simplifyDNLs :: [Integer] -> Maybe Integer
12+simplifyDNLs = simplifyNumberConstraint minimum
13+
14+simplifyDNGs :: [Integer] -> Maybe Integer
15+simplifyDNGs = simplifyNumberConstraint maximum
16+
17+verifyDNEq :: [Integer] -> Maybe (Maybe Integer)
18+verifyDNEq x =
19+ case nub x of
20+ [] -> Just Nothing
21+ [y] -> Just $ Just y
22+ (_:_:_) -> Nothing
23+
24+verify3 :: Maybe Integer -> Maybe Integer -> Maybe Integer -> Maybe ()
25+verify3 (Just x) (Just y) (Just z) =
26+ if x < y && y < z
27+ then Just ()
28+ else Nothing
29+verify3 _ _ _ = Just ()
30+
31+verify2 :: Maybe Integer -> Maybe Integer -> Maybe ()
32+verify2 (Just x) (Just y) =
33+ if x < y
34+ then Just ()
35+ else Nothing
36+verify2 _ _ = Just ()
37+
38+verifyEquations :: Maybe Integer -> Maybe Integer -> Maybe Integer -> Maybe ()
39+verifyEquations mgt meq mlt = do
40+ verify3 mgt meq mlt
41+ verify2 mgt meq
42+ verify2 meq mlt
43+ verify2 mgt mlt
src/Data/Schematic/Verifier/Number.hsnew file+31
@@ -0,0 +1,31 @@
1+module Data.Schematic.Verifier.Number where
2+
3+import {-# SOURCE #-} Data.Schematic.Schema
4+import Data.Schematic.Verifier.Common
5+
6+toStrictNumber :: [DemotedNumberConstraint] -> [DemotedNumberConstraint]
7+toStrictNumber = map f
8+ where
9+ f (DNLe x) = DNLt (x + 1)
10+ f (DNGe x) = DNGt (x - 1)
11+ f x = x
12+
13+data VerifiedNumberConstraint
14+ = VNEq Integer
15+ | VNBounds (Maybe Integer) (Maybe Integer)
16+ deriving (Show)
17+
18+verifyNumberConstraints
19+ :: [DemotedNumberConstraint]
20+ -> Maybe VerifiedNumberConstraint
21+verifyNumberConstraints cs' = do
22+ let
23+ cs = toStrictNumber cs'
24+ mlt = simplifyDNLs [x | DNLt x <- cs]
25+ mgt = simplifyDNGs [x | DNGt x <- cs]
26+ meq <- verifyDNEq [x | DNEq x <- cs]
27+ verifyEquations mgt meq mlt
28+ Just $
29+ case meq of
30+ Just eq -> VNEq eq
31+ Nothing -> VNBounds mgt mlt
src/Data/Schematic/Verifier/Text.hsnew file+121
@@ -0,0 +1,121 @@
1+module Data.Schematic.Verifier.Text where
2+
3+import Control.Monad
4+import Data.Maybe
5+import {-# SOURCE #-} Data.Schematic.Schema
6+import Data.Schematic.Verifier.Common
7+import Data.Text (Text, unpack)
8+import Text.Regex.TDFA.Pattern
9+import Text.Regex.TDFA.ReadRegex (parseRegex)
10+
11+toStrictTextLength :: [DemotedTextConstraint] -> [DemotedTextConstraint]
12+toStrictTextLength = map f
13+ where
14+ f (DTLe x) = DTLt (x + 1)
15+ f (DTGe x) = DTGt (x - 1)
16+ f x = x
17+
18+data VerifiedTextConstraint
19+ = VTEq Integer
20+ | VTBounds (Maybe Integer) (Maybe Integer)
21+ | VTRegex Text Integer (Maybe Integer)
22+ | VTEnum [Text]
23+ deriving (Show)
24+
25+verifyTextLengthConstraints
26+ :: [DemotedTextConstraint]
27+ -> Maybe (Maybe VerifiedTextConstraint)
28+verifyTextLengthConstraints cs' = do
29+ let
30+ cs = toStrictTextLength cs'
31+ mlt = simplifyDNLs [x | DTLt x <- cs]
32+ mgt = simplifyDNGs [x | DTGt x <- cs]
33+ meq <- verifyDNEq [x | DTEq x <- cs]
34+ verifyEquations mgt meq mlt
35+ case all isNothing ([mgt, meq, mlt] :: [Maybe Integer]) of
36+ True -> Just Nothing
37+ _ ->
38+ Just $
39+ Just $
40+ case meq of
41+ Just eq -> VTEq eq
42+ Nothing -> VTBounds mgt mlt
43+
44+regexLength :: Text -> Maybe (Int, Maybe Int)
45+regexLength regexp =
46+ case parseRegex . unpack $ regexp of
47+ Right (p, _) -> Just (minRegexLength p, maxRegexLength p)
48+ Left _ -> Nothing
49+
50+minRegexLength :: Pattern -> Int
51+minRegexLength p =
52+ case p of
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
68+
69+maxRegexLength :: Pattern -> Maybe Int
70+maxRegexLength p =
71+ case p of
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
87+
88+verifyTextRegexConstraint
89+ :: [DemotedTextConstraint]
90+ -> Maybe (Maybe VerifiedTextConstraint)
91+verifyTextRegexConstraint cs = do
92+ let regexps = [x | DTRegex x <- cs]
93+ case regexps of
94+ [] -> Just Nothing
95+ [x] -> do
96+ (l, mh) <- regexLength x
97+ Just $ Just $ VTRegex x (fromIntegral l) (fromIntegral <$> mh)
98+ _ -> Nothing
99+
100+verifyTextEnumConstraint
101+ :: [DemotedTextConstraint]
102+ -> Maybe (Maybe VerifiedTextConstraint)
103+verifyTextEnumConstraint cs = do
104+ let enums = concat [x | DTEnum x <- cs]
105+ case enums of
106+ [] -> Just Nothing
107+ x -> Just $ Just $ VTEnum x
108+
109+verifyTextConstraints
110+ :: [DemotedTextConstraint]
111+ -> Maybe [VerifiedTextConstraint]
112+verifyTextConstraints cs = do
113+ regexp <- verifyTextRegexConstraint cs
114+ void $
115+ case regexp of
116+ Just (VTRegex _ l mh) ->
117+ verifyTextLengthConstraints (DTGe l : cs ++ maybeToList (DTLe <$> mh))
118+ _ -> pure Nothing
119+ lengths <- verifyTextLengthConstraints cs
120+ enums <- verifyTextEnumConstraint cs
121+ return $ catMaybes [lengths, enums, regexp]
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−52
@@ -1,53 +1,6 @@
1−resolver: lts-9.01
1+resolver: lts-14.22
2−
3−# User packages to be built.
4−# Various formats can be used as shown in the example below.
5−#
6−# packages:
7−# - some-directory
8−# - https://example.com/foo/bar/baz-0.0.2.tar.gz
9−# - location:
10−# git: https://github.com/commercialhaskell/stack.git
11−# commit: e7b331f14bcffb8367cd58fbfc8b40ec7642100a
12−# - location: https://github.com/commercialhaskell/stack/commit/e7b331f14bcffb8367cd58fbfc8b40ec7642100a
13−# extra-dep: true
14−# subdirs:
15−# - auto-update
16−# - wai
17−#
18−# A package marked 'extra-dep: true' will only be built if demanded by a
19−# non-dependency (i.e. a user package), and its test suites and benchmarks
20−# will not be run. This is useful for tweaking upstream packages.
21−packages:
22−#- location:
23− #git: https://github.com/typeable/validationt.git
24− #commit: 24578c9fd408179358c641ee1fff0eb182591f4b
25−- '.'
26−
27extra-deps:
2extra-deps:
28−- validationt-0.2.0.0
3+- hjsonpointer-1.4.0@rev:0
29−- smallcheck-series-0.6
4+- hjsonschema-1.9.0@rev:0
30−
5+- git: https://github.com/typeable/validationt.git
31−# Override default flag values for local packages and extra-deps
6+ commit: 97fea97c4015ab5e99f3efb2c73e1fef4b8857d8
32−flags: {}
33−
34−# Extra package databases containing global packages
35−extra-package-dbs: []
36−
37−# Control whether we use the GHC we find on the path
38−# system-ghc: true
39−#
40−# Require a specific version of stack, using version ranges
41−# require-stack-version: -any # Default
42−# require-stack-version: ">=1.4"
43−#
44−# Override the architecture used by stack, especially useful on Windows
45−# arch: i386
46−# arch: x86_64
47−#
48−# Extra directories used by stack for building
49−# extra-include-dirs: [/path/to/dir]
50−# extra-lib-dirs: [/path/to/dir]
51−#
52−# Allow a newer minor version of GHC than the snapshot specifies
53−# compiler-check: newer-minor
test/HelpersSpec.hsnew file+124
@@ -0,0 +1,124 @@
1+{-# OPTIONS_GHC -Wno-unticked-promoted-constructors #-}
2+
3+{-# LANGUAGE LambdaCase #-}
4+
5+{-# LANGUAGE DataKinds #-}
6+{-# LANGUAGE TypeApplications #-}
7+{-# LANGUAGE OverloadedStrings #-}
8+
9+module HelpersSpec (spec, main) where
10+
11+import Control.Lens
12+import Data.ByteString.Lazy.Lens
13+import Data.Foldable
14+import Data.Monoid
15+import Data.Schematic
16+import Data.Text as T
17+import Data.Text.Lens
18+import Test.Hspec
19+
20+
21+type UUIDSchema = 'SchemaObject '[ '("uuid", 'SchemaText IsUUID) ]
22+
23+-- | Taken from UUID RFC 4122
24+uuid :: Text
25+uuid = "f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
26+
27+type ISO8601DateSchema = 'SchemaObject '[ '("date", 'SchemaText IsDate) ]
28+
29+iso8601dates :: [Text]
30+iso8601dates = [ "1985-04-12" ]
31+
32+invalidIso8601dates :: [Text]
33+invalidIso8601dates = [ "1999-13-12" ]
34+
35+type ISO8601TimeSchema = 'SchemaObject '[ '("time", 'SchemaText IsTime) ]
36+
37+iso8601times :: [Text]
38+iso8601times =
39+ [ "19:23:00"
40+ , "00:00:00"
41+ , "23:47:12" ]
42+
43+invalidIso8601times :: [Text]
44+invalidIso8601times =
45+ [ "00:60:00"
46+ , "24:01:02" ]
47+
48+type ISO8601DateTimeSchema = 'SchemaObject '[ '("datetime", 'SchemaText IsDateTime) ]
49+
50+-- | Taken from ISO8601 RFC 3339
51+iso8601datetimes :: [Text]
52+iso8601datetimes =
53+ iso8601dates <>
54+ [ "1985-04-12T23:20:50.52Z"
55+ , "1996-12-19T16:39:57-08:00"
56+ , "1990-12-31T23:59:60Z"
57+ , "1990-12-31T15:59:60-08:00"
58+ , "1937-01-01T12:00:27.87+00:20"
59+ ]
60+
61+invalidIso8601datetimes :: [Text]
62+invalidIso8601datetimes =
63+ [ "1996-13-129T16:39:57-08:00"
64+ , "1990-2-31T23:59:60Z"
65+ , "1990-12-32T15:59:70"
66+ , "1937-01-1T12::27.87+24:20"
67+ ]
68+
69+spec :: Spec
70+spec = do
71+ describe "UUID: " $ do
72+ it "validates correct UUID" $ do
73+ let
74+ uuidJson = "{\"uuid\": \"" <> (uuid ^. unpacked . packedChars) <> "\" }"
75+ (decodeAndValidateJson uuidJson :: ParseResult (JsonRepr UUIDSchema))
76+ `shouldSatisfy` isValid
77+
78+ it "fails to validate incorrect UUID" $ do
79+ let
80+ incorrectJson = "{\"uuid\": \"incorrect\" }"
81+ (decodeAndValidateJson incorrectJson :: ParseResult (JsonRepr UUIDSchema))
82+ `shouldSatisfy` isValidationError
83+
84+ describe "ISO8601 date: " $ do
85+ for_ iso8601dates $ \dt -> do
86+ it ("validates correct date - " <> dt ^. unpacked) $ do
87+ let json = "{\"date\": \"" <> (dt ^. unpacked . packedChars) <> "\" }"
88+ (decodeAndValidateJson json :: ParseResult (JsonRepr ISO8601DateSchema))
89+ `shouldSatisfy` isValid
90+
91+ for_ invalidIso8601dates $ \dt -> do
92+ it ("fails to validate incorrect date - " <> dt ^. unpacked) $ do
93+ let json = "{\"date\": \"" <> (dt ^. unpacked . packedChars) <> "\" }"
94+ (decodeAndValidateJson json :: ParseResult (JsonRepr ISO8601DateSchema))
95+ `shouldSatisfy` isValidationError
96+
97+ describe "ISO8601 time: " $ do
98+ for_ iso8601times $ \dt -> do
99+ it ("validates correct time - " <> dt ^. unpacked) $ do
100+ let json = "{\"time\": \"" <> (dt ^. unpacked . packedChars) <> "\" }"
101+ (decodeAndValidateJson json :: ParseResult (JsonRepr ISO8601TimeSchema))
102+ `shouldSatisfy` isValid
103+
104+ for_ invalidIso8601times $ \dt -> do
105+ it ("fails to validate incorrect time - " <> dt ^. unpacked) $ do
106+ let json = "{\"time\": \"" <> (dt ^. unpacked . packedChars) <> "\" }"
107+ (decodeAndValidateJson json :: ParseResult (JsonRepr ISO8601TimeSchema))
108+ `shouldSatisfy` isValidationError
109+
110+ describe "ISO8601 datetime: " $ do
111+ for_ iso8601datetimes $ \dt -> do
112+ it ("validates correct datetime - " <> dt ^. unpacked) $ do
113+ let json = "{\"datetime\": \"" <> (dt ^. unpacked . packedChars) <> "\" }"
114+ (decodeAndValidateJson json :: ParseResult (JsonRepr ISO8601DateTimeSchema))
115+ `shouldSatisfy` isValid
116+
117+ for_ invalidIso8601datetimes $ \dt -> do
118+ it ("fails to validate incorrect datetime - " <> dt ^. unpacked) $ do
119+ let json = "{\"datetime\": \"" <> (dt ^. unpacked . packedChars) <> "\" }"
120+ (decodeAndValidateJson json :: ParseResult (JsonRepr ISO8601DateTimeSchema))
121+ `shouldSatisfy` isValidationError
122+
123+main :: IO ()
124+main = hspec spec
test/JsonSchemaSpec.hs+69−11
@@ -1,7 +1,16 @@
1+{-# LANGUAGE LambdaCase #-}
2+
3+{-# LANGUAGE DataKinds #-}
4+{-# LANGUAGE TypeApplications #-}
5+{-# LANGUAGE OverloadedLists #-}
6+{-# LANGUAGE OverloadedStrings #-}
7+
1module JsonSchemaSpec (spec, main) where
8module JsonSchemaSpec (spec, main) where
2
9
3import Data.Aeson as J
10import Data.Aeson as J
11+import Data.Maybe
4import Data.Proxy
12import Data.Proxy
13+import Data.ByteString.Lazy as B
5import Data.Schematic
14import Data.Schematic
6import Data.Vinyl
15import Data.Vinyl
7import JSONSchema.Draft4 as D4
16import JSONSchema.Draft4 as D4
@@ -17,27 +26,76 @@ type FieldsSchema =
17
26
18type SchemaExample = 'SchemaObject FieldsSchema
27type SchemaExample = 'SchemaObject FieldsSchema
19
28
20−arrayData :: JsonRepr ArraySchema
29+exampleData :: JsonRepr SchemaExample
30+exampleData = withRepr @SchemaExample $
21−arrayData = ReprArray [ReprNumber 13]
31+ field @"foo" [ReprNumber 13]
32+ :& field @"bar" (pure (ReprText "foo"))
33+ :& RNil
22
34
23−arrayField :: FieldRepr ArrayField
35+type SchemaArrayExample = 'SchemaObject
24−arrayField = FieldRepr arrayData
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+ ]
25
41
26−objectData :: Rec FieldRepr FieldsSchema
42+type SchemaNumberExample = 'SchemaObject
27−objectData = FieldRepr arrayData
43+ '[ '("n1", 'SchemaNumber '[ 'NGt 1 ])
28− :& FieldRepr (ReprOptional (Just (ReprText "foo")))
44+ , '("n2", 'SchemaNumber '[ 'NGe 1 ])
29− :& RNil
45+ , '("n3", 'SchemaNumber '[ 'NLt 1 ])
46+ , '("n4", 'SchemaNumber '[ 'NLe 1 ])
47+ ]
30
48
31−exampleData :: JsonRepr SchemaExample
49+type SchemaTextExample = 'SchemaObject
32−exampleData = ReprObject objectData
50+ '[ '("t1", 'SchemaText '[ 'TGt 1 ])
51+ , '("t2", 'SchemaText '[ 'TGe 1 ])
52+ , '("t3", 'SchemaText '[ 'TLt 1 ])
53+ , '("t4", 'SchemaText '[ 'TLe 1 ])
54+ ]
33
55
34spec :: Spec
56spec :: Spec
35spec = do
57spec = do
36 it "validates simple schema" $ do
58 it "validates simple schema" $ do
37− let schema = D4.SchemaWithURI (toJsonSchema (Proxy @SchemaExample)) Nothing
59+ let schema = D4.SchemaWithURI (fromJust $ toJsonSchema (Proxy @SchemaExample)) Nothing
38 fetchHTTPAndValidate schema (toJSON exampleData) >>= \case
60 fetchHTTPAndValidate schema (toJSON exampleData) >>= \case
39 Left _ -> fail "failed to validate test example"
61 Left _ -> fail "failed to validate test example"
40 Right _ -> pure ()
62 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 ()
41
99
42main :: IO ()
100main :: IO ()
43main = hspec spec
101main = hspec spec
test/LensSpec.hs+12−13
@@ -1,7 +1,11 @@
1+{-# LANGUAGE DataKinds #-}
2+{-# LANGUAGE TypeApplications #-}
3+{-# LANGUAGE OverloadedLists #-}
4+{-# LANGUAGE OverloadedStrings #-}
5+
1module LensSpec (spec, main) where
6module LensSpec (spec, main) where
2
7
3import Control.Lens
8import Control.Lens
4−import Data.Kind
5import Data.Proxy
9import Data.Proxy
6import Data.Schematic
10import Data.Schematic
7import Data.Vinyl
11import Data.Vinyl
@@ -13,9 +17,7 @@ type ArraySchema = 'SchemaArray '[ 'AEq 1] ('SchemaNumber '[ 'NGt 10])
13type ArrayField = '("foo", ArraySchema)
17type ArrayField = '("foo", ArraySchema)
14
18
15type FieldsSchema =
19type FieldsSchema =
16− '[ ArrayField, '("bar", 'SchemaOptional ('SchemaText '[ 'TEnum '["foo", "bar"]]))]
20+ '[ '("bar", 'SchemaOptional ('SchemaText '[ 'TEnum '["foo", "bar"]])), ArrayField]
17−
18−type SchemaExample = 'SchemaObject FieldsSchema
19
21
20arrayData :: JsonRepr ArraySchema
22arrayData :: JsonRepr ArraySchema
21arrayData = ReprArray [ReprNumber 13]
23arrayData = ReprArray [ReprNumber 13]
@@ -24,13 +26,10 @@ arrayField :: FieldRepr ArrayField
24arrayField = FieldRepr arrayData
26arrayField = FieldRepr arrayData
25
27
26objectData :: Rec FieldRepr FieldsSchema
28objectData :: Rec FieldRepr FieldsSchema
27−objectData = FieldRepr arrayData
28− :& FieldRepr (ReprOptional (Just (ReprText "foo")))
29+objectData = FieldRepr (ReprOptional (Just (ReprText "foo")))
30+ :& FieldRepr arrayData
29 :& RNil
31 :& RNil
30
32
31−exampleData :: JsonRepr SchemaExample
32−exampleData = ReprObject objectData
33−
34type BigRecord = Rec FieldRepr
33type BigRecord = Rec FieldRepr
35 '[ '("f1", 'SchemaNumber '[])
34 '[ '("f1", 'SchemaNumber '[])
36 , '("f2", 'SchemaNumber '[])
35 , '("f2", 'SchemaNumber '[])
@@ -304,15 +303,15 @@ spec = do
304 newFooVal = FieldRepr $ ReprArray [ReprNumber 15]
303 newFooVal = FieldRepr $ ReprArray [ReprNumber 15]
305 fooProxy = Proxy @"foo"
304 fooProxy = Proxy @"foo"
306 it "gets the field from an object" $ do
305 it "gets the field from an object" $ do
307− fget fooProxy objectData `shouldBe` arrayField
306+ fget @"foo" objectData `shouldBe` arrayField
308 it "sets the object field" $ do
307 it "sets the object field" $ do
309− fget fooProxy (fput newFooVal objectData) `shouldBe` newFooVal
308+ fget @"foo" (fput newFooVal objectData) `shouldBe` newFooVal
310
309
311 describe "(using lens library) " $ do
310 describe "(using lens library) " $ do
312 it "get the field from an object" $ do
311 it "get the field from an object" $ do
313− objectData ^. flens (Proxy @"foo") `shouldBe` arrayField
312+ objectData ^. flens @"foo" `shouldBe` arrayField
314 it "sets the object field" $ do
313 it "sets the object field" $ do
315− set (flens (Proxy @"foo")) newFooVal objectData ^. flens (Proxy @"foo")
314+ set (flens @"foo") newFooVal objectData ^. flens @"foo"
316 `shouldBe` newFooVal
315 `shouldBe` newFooVal
317
316
318main :: IO ()
317main :: IO ()
test/SchemaSpec.hs+79−38
@@ -1,32 +1,78 @@
1{-# OPTIONS_GHC -fprint-potential-instances #-}
1{-# OPTIONS_GHC -fprint-potential-instances #-}
2
2
3+{-# LANGUAGE DataKinds #-}
4+{-# LANGUAGE FlexibleContexts #-}
5+{-# LANGUAGE GADTs #-}
6+{-# LANGUAGE OverloadedLists #-}
7+{-# LANGUAGE OverloadedStrings #-}
8+{-# LANGUAGE RankNTypes #-}
9+{-# LANGUAGE ScopedTypeVariables #-}
10+{-# LANGUAGE TypeApplications #-}
11+
3module SchemaSpec (spec, main) where
12module SchemaSpec (spec, main) where
4
13
5−import Data.ByteString.Lazy
14+import Control.Lens
6import Data.Aeson
15import Data.Aeson
16+import Data.ByteString.Lazy
17+import Data.Functor.Identity
7import Data.Proxy
18import Data.Proxy
8import Data.Schematic
19import Data.Schematic
20+import Data.Schematic.Generator
21+import Data.Singletons
22+import Data.Tagged
9import Data.Vinyl
23import Data.Vinyl
10import Test.Hspec
24import Test.Hspec
25+import Test.Hspec.SmallCheck
26+import Test.SmallCheck as SC
27+import Test.SmallCheck.Drivers as SC
28+import Test.SmallCheck.Series as SC
11
29
30+import Debug.Trace
12
31
13−type SchemaExample
32+type SchemaExample = 'SchemaObject
14− = 'SchemaObject
15− '[ '("foo", 'SchemaArray '[ 'AEq 1] ('SchemaNumber '[ 'NGt 10]))
33+ '[ '("foo", 'SchemaArray '[ 'AEq 1] ('SchemaNumber '[ 'NGt 10]))
16− , '("bar", 'SchemaOptional ('SchemaText '[ 'TEnum '["foo", "bar"]]))]
34+ , '("bar", 'SchemaOptional ('SchemaText '[ 'TEnum '["foo", "bar"]]))]
17−
18−type TestMigration =
19− 'Migration "test_revision"
20− '[ 'Diff '[ 'PKey "bar" ] ('Update ('SchemaText '[]))
21− , 'Diff '[ 'PKey "foo" ] ('Update ('SchemaNumber '[])) ]
22
35
23−type VS = 'Versioned SchemaExample '[ TestMigration ]
36+type SchemaExample2 = 'SchemaObject
37+ '[ '("foo", 'SchemaArray '[ 'AEq 2] ('SchemaText '[ 'TGt 10]))
38+ , '("bar", 'SchemaOptional ('SchemaText '[ 'TRegex "[0-9]+"]))]
24
39
25jsonExample :: JsonRepr SchemaExample
40jsonExample :: JsonRepr SchemaExample
26−jsonExample = ReprObject $
41+jsonExample = withRepr @SchemaExample
27− FieldRepr (ReprArray [ReprNumber 12])
42+ $ field @"bar" (Just "bar")
28− :& FieldRepr (ReprOptional (Just (ReprText "bar")))
43+ :& field @"foo" [12]
44+ :& RNil
45+
46+type AddQuuz =
47+ 'Migration "add_field_quuz"
48+ '[ 'Diff '[] ('AddKey "quuz" (SchemaNumber '[])) ]
49+
50+type DeleteQuuz =
51+ 'Migration "remove_field_quuz"
52+ '[ 'Diff '[] ( 'DeleteKey "quuz") ]
53+
54+type SwapFields =
55+ 'Migration "swap_fields"
56+ '[ 'Diff '[ 'PKey "bar" ] ('Update
57+ ('SchemaArray '[ 'AEq 1] ('SchemaNumber '[ 'NGt 10])))
58+ , 'Diff '[ 'PKey "foo" ] ('Update
59+ ('SchemaOptional ('SchemaText '[ 'TEnum '["foo", "bar"]]))) ]
60+
61+type Migrations = '[ AddQuuz
62+ , DeleteQuuz ]
63+ -- , SwapFields ]
64+
65+type VersionedJson = 'Versioned SchemaExample Migrations
66+
67+migrationList :: MigrationList Identity VersionedJson
68+migrationList
69+ = (migrateObject (\r -> Identity $ field @"quuz" 42 :& r))
70+ :&& shrinkObject
71+ -- :&& (migrateObject (\r -> Identity
72+ -- $ field @"foo" (r ^. flens (Proxy @"bar") . _Just . optionalRepr)
73+ -- :& field @"bar" (r ^. flens (Proxy @"foo") . arrayRepr)
29− :& RNil
74+ -- :& RNil))
75+ :&& MNil
30
76
31schemaJson :: ByteString
77schemaJson :: ByteString
32schemaJson = "{\"foo\": [13], \"bar\": null}"
78schemaJson = "{\"foo\": [13], \"bar\": null}"
@@ -34,23 +80,11 @@ schemaJson = "{\"foo\": [13], \"bar\": null}"
34schemaJson2 :: ByteString
80schemaJson2 :: ByteString
35schemaJson2 = "{\"foo\": [3], \"bar\": null}"
81schemaJson2 = "{\"foo\": [3], \"bar\": null}"
36
82
37−topObject
38− :: JsonRepr
39− ('SchemaObject
40− '[ '("foo", 'SchemaNumber '[])
41− , '("bar", 'SchemaText '[])])
42−topObject = ReprObject $
43− FieldRepr (ReprNumber 42)
44− :& FieldRepr (ReprText "test")
45− :& RNil
46−
47−instance
48− MigrateSchema
49− SchemaExample
83+schemaJsonSeries :: Monad m => SC.Series m (JsonRepr SchemaExample)
50− ('SchemaObject
84+schemaJsonSeries = series
51− '[ '("foo", 'SchemaNumber '[]), '("bar", 'SchemaText '[])])
85+
52− where
86+schemaJsonSeries2 :: Monad m => SC.Series m (JsonRepr SchemaExample2)
53− migrate = const topObject
87+schemaJsonSeries2 = series
54
88
55spec :: Spec
89spec :: Spec
56spec = do
90spec = do
@@ -67,15 +101,22 @@ spec = do
67 it "validates incorrect representation" $
101 it "validates incorrect representation" $
68 ((decodeAndValidateJson schemaJson2) :: ParseResult (JsonRepr SchemaExample))
102 ((decodeAndValidateJson schemaJson2) :: ParseResult (JsonRepr SchemaExample))
69 `shouldSatisfy` isValidationError
103 `shouldSatisfy` isValidationError
70− it "validates versioned json" $ do
104+ -- it "validates versioned json" $ do
71− decodeAndValidateVersionedJson (Proxy @VS) schemaJson
105+ -- decodeAndValidateVersionedJson (Proxy @VS) schemaJson
72− `shouldSatisfy` isValid
106+ -- `shouldSatisfy` isValid
73 it "validates versioned json with a migration list" $ do
107 it "validates versioned json with a migration list" $ do
74− decodeAndValidateVersionedWithMList
108+ decodeAndValidateVersionedWithPureMList
75− (Proxy @VS)
109+ (Proxy @VersionedJson)
76− ((:&&) (Proxy @(SchemaByRevision "test_revision" VS)) (const topObject) MNil)
110+ migrationList
77 schemaJson
111 schemaJson
78 `shouldSatisfy` isValid
112 `shouldSatisfy` isValid
113+ it "validates json series" $ property $
114+ SC.over schemaJsonSeries $ \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))
119+
79
120
80main :: IO ()
121main :: IO ()
81main = hspec spec
122main = hspec spec