git.iko.soy/typeable/schematic
on master help sign in
swap
7db0b4671 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+36
@@ -1,5 +1,41 @@
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+
3## 0.3.2.0 -- 2017-10-02
39## 0.3.2.0 -- 2017-10-02
4
40
5Fixed FIndex bug, added bunch of convenience isomorphism, re-exports.
41Fixed FIndex bug, added bunch of convenience isomorphism, re-exports.
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+21−36
@@ -1,6 +1,7 @@
1name: schematic
1name: schematic
2−version: 0.3.2.0
2+version: 0.6.0.0
3synopsis: JSON-biased spec and validation tool
3synopsis: JSON-biased spec and validation tool
4+description: JSON-biased spec and validation tool. Makes possible to have a schema as a haskell type and derive json instances, validation actions, JSON generation for property-test generically. Built-in lens support.
4license: BSD3
5license: BSD3
5license-file: LICENSE
6license-file: LICENSE
6author: Denis Redozubov
7author: Denis Redozubov
@@ -9,12 +10,14 @@ homepage: http://github.com/typeable/schematic
9Bug-reports: http://github.com/typeable/schematic/issues/
10Bug-reports: http://github.com/typeable/schematic/issues/
10category: Data
11category: Data
11build-type: Simple
12build-type: Simple
12−extra-source-files: ChangeLog.md
13+extra-source-files: ChangeLog.md, README.md
13cabal-version: >=1.10
14cabal-version: >=1.10
14
15
15library
16library
16 exposed-modules: Data.Schematic
17 exposed-modules: Data.Schematic
17 , Data.Schematic.DSL
18 , Data.Schematic.DSL
19+ , Data.Schematic.Generator
20+ , Data.Schematic.Generator.Regex
18 , Data.Schematic.Instances
21 , Data.Schematic.Instances
19 , Data.Schematic.JsonSchema
22 , Data.Schematic.JsonSchema
20 , Data.Schematic.Helpers
23 , Data.Schematic.Helpers
@@ -23,6 +26,11 @@ library
23 , Data.Schematic.Path
26 , Data.Schematic.Path
24 , Data.Schematic.Schema
27 , Data.Schematic.Schema
25 , Data.Schematic.Validation
28 , Data.Schematic.Validation
29+ , Data.Schematic.Verifier
30+ , Data.Schematic.Verifier.Array
31+ , Data.Schematic.Verifier.Common
32+ , Data.Schematic.Verifier.Number
33+ , Data.Schematic.Verifier.Text
26 ghc-options: -Wall
34 ghc-options: -Wall
27 default-extensions: ConstraintKinds
35 default-extensions: ConstraintKinds
28 , DataKinds
36 , DataKinds
@@ -57,9 +65,9 @@ library
57 , TypeOperators
65 , TypeOperators
58 , TypeSynonymInstances
66 , TypeSynonymInstances
59 , UndecidableInstances
67 , UndecidableInstances
60− build-depends: base >=4.9 && <4.11
68+ build-depends: base >=4.11 && <5
61 , bytestring
69 , bytestring
62− , aeson >= 1
70+ , aeson >= 1.4.3.0 && < 1.6
63 , containers
71 , containers
64 , hjsonschema
72 , hjsonschema
65 , mtl
73 , mtl
@@ -67,14 +75,14 @@ library
67 , regex-tdfa
75 , regex-tdfa
68 , regex-tdfa-text
76 , regex-tdfa-text
69 , scientific
77 , scientific
70− , singletons >= 2.2
78+ , singletons >= 2.4
71 , smallcheck
79 , smallcheck
72 , tagged
80 , tagged
73 , template-haskell
81 , template-haskell
74 , text
82 , text
75 , union
83 , union
76 , unordered-containers
84 , unordered-containers
77− , validationt >= 0.1.0.1
85+ , validationt >= 0.2.1.0
78 , vector
86 , vector
79 , vinyl
87 , vinyl
80 hs-source-dirs: src
88 hs-source-dirs: src
@@ -85,36 +93,9 @@ test-suite spec
85 hs-source-dirs: test
93 hs-source-dirs: test
86 main-is: Spec.hs
94 main-is: Spec.hs
87 default-language: Haskell2010
95 default-language: Haskell2010
88− default-extensions: ConstraintKinds
89− , DataKinds
90− , DeriveFunctor
91− , DeriveFoldable
92− , DeriveGeneric
93− , DeriveDataTypeable
94− , FlexibleContexts
95− , FlexibleInstances
96− , FunctionalDependencies
97− , GADTs
98− , KindSignatures
99− , InstanceSigs
100− , LambdaCase
101− , MultiParamTypeClasses
102− , OverloadedLists
103− , OverloadedStrings
104− , PolyKinds
105− , QuasiQuotes
106− , PartialTypeSignatures
107− , RecordWildCards
108− , ScopedTypeVariables
109− , TemplateHaskell
110− , TypeApplications
111− , TypeFamilies
112− , TypeInType
113− , TypeOperators
114− , TypeSynonymInstances
115 build-depends: HUnit
96 build-depends: HUnit
116 , aeson >= 1
97 , aeson >= 1
117− , base >=4.9 && <4.11
98+ , base >=4.11 && <4.13
118 , bytestring
99 , bytestring
119 , containers
100 , containers
120 , hjsonschema
101 , hjsonschema
@@ -131,9 +112,13 @@ test-suite spec
131 , tagged
112 , tagged
132 , text
113 , text
133 , unordered-containers
114 , unordered-containers
134− , validationt >= 0.1.0.1
115+ , validationt >= 0.2.1.0
135 , vinyl
116 , vinyl
136 other-modules: SchemaSpec
117 other-modules: SchemaSpec
137 , HelpersSpec
118 , HelpersSpec
138 , LensSpec
119 , LensSpec
139− , JsonSchemaSpec
120+ , JsonSchemaSpec
121+
122+source-repository head
123+ type: git
124+ location: https://github.com/typeable/schematic
src/Data/Schematic.hs−27
@@ -39,29 +39,6 @@ import Data.Tagged
39import Data.Text as T
39import Data.Text as T
40
40
41
41
42−parseAndValidateJson
43− :: forall schema
44− . (J.FromJSON (JsonRepr schema), TopLevel schema, SingI schema)
45− => J.Value
46− -> ParseResult (JsonRepr schema)
47−parseAndValidateJson v =
48− case parseEither parseJSON v of
49− Left s -> DecodingError $ T.pack s
50− Right jsonRepr ->
51− let
52− validate = validateJsonRepr (sing :: Sing schema) [] jsonRepr
53− res = runIdentity . runValidationTEither $ validate
54− in case res of
55− Left em -> ValidationError em
56− Right () -> Valid jsonRepr
57−
58−parseAndValidateJsonBy
59− :: (J.FromJSON (JsonRepr schema), TopLevel schema, SingI schema)
60− => proxy schema
61− -> J.Value
62− -> ParseResult (JsonRepr schema)
63−parseAndValidateJsonBy _ = parseAndValidateJson
64−
65parseAndValidateTopVersionJson
42parseAndValidateTopVersionJson
66 :: forall proxy (v :: Versioned)
43 :: forall proxy (v :: Versioned)
67 . (SingI (TopVersion (AllVersions v)))
44 . (SingI (TopVersion (AllVersions v)))
@@ -107,10 +84,6 @@ decodeAndValidateJson bs = case decode bs of
107 Nothing -> DecodingError "malformed json"
84 Nothing -> DecodingError "malformed json"
108 Just x -> parseAndValidateJson x
85 Just x -> parseAndValidateJson x
109
86
110−type family MapSnd (l :: [(a,k)]) = (r :: [k]) where
111− MapSnd '[] = '[]
112− MapSnd ( '(a, b) ': tl) = b ': MapSnd tl
113−
114decodeAndValidateVersionedWithMList
87decodeAndValidateVersionedWithMList
115 :: Monad m
88 :: Monad m
116 => proxy versioned
89 => proxy versioned
src/Data/Schematic/DSL.hs+47−25
@@ -1,10 +1,10 @@
1{-# LANGUAGE AllowAmbiguousTypes #-}
1{-# LANGUAGE AllowAmbiguousTypes #-}
2+{-# LANGUAGE CPP #-}
2
3
3module Data.Schematic.DSL where
4module Data.Schematic.DSL where
4
5
5import Data.Kind
6import Data.Kind
6import Data.Schematic.Lens
7import Data.Schematic.Lens
7−import Data.Schematic.Migration
8import Data.Schematic.Schema
8import Data.Schematic.Schema
9import Data.Scientific
9import Data.Scientific
10import Data.Singletons
10import Data.Singletons
@@ -18,53 +18,75 @@ import Data.Vinyl
18import Data.Vinyl.Functor
18import Data.Vinyl.Functor
19
19
20
20
21+#if MIN_VERSION_base(4,12,0)
21type Constructor a
22type Constructor a
22− = forall b. FSubset (FieldsOf a) b (FImage (FieldsOf a) b)
23+ = forall fields b
23− => Rec (Tagged (FieldsOf a) :. FieldRepr) 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
24− -> JsonRepr ('SchemaObject (FieldsOf a))
32+ -> JsonRepr ('SchemaObject fields)
25−
33+#endif
26withRepr :: Constructor a
34withRepr :: Constructor a
27withRepr = ReprObject . rmap (unTagged . getCompose) . fcast
35withRepr = ReprObject . rmap (unTagged . getCompose) . fcast
28
36
29class Representable s where
37class Representable s where
30− type Repr s :: Type
31− construct :: Sing fn -> Proxy s -> Repr s -> FieldRepr '(fn, s)
38+ constructField :: Sing fn -> Proxy s -> Repr s -> FieldRepr '(fn, s)
32
39
33instance SingI so => Representable ('SchemaObject so) where
40instance SingI so => Representable ('SchemaObject so) where
34− type Repr ('SchemaObject so) = Rec FieldRepr so
35− construct sfn _ o = withKnownSymbol sfn $ FieldRepr $ ReprObject o
41+ constructField sfn _ o = withKnownSymbol sfn $ FieldRepr $ ReprObject o
36
42
37instance (SingI cs, SingI sa) => Representable ('SchemaArray cs sa) where
43instance (SingI cs, SingI sa) => Representable ('SchemaArray cs sa) where
38− type Repr ('SchemaArray cs sa) = V.Vector (JsonRepr sa)
39− construct sfn _ a = withKnownSymbol sfn $ FieldRepr $ ReprArray a
44+ constructField sfn _ a = withKnownSymbol sfn $ FieldRepr $ ReprArray a
40
45
41instance SingI cs => Representable ('SchemaText cs) where
46instance SingI cs => Representable ('SchemaText cs) where
42− type Repr ('SchemaText cs) = Text
43− construct sfn _ t = withKnownSymbol sfn $ FieldRepr $ ReprText t
47+ constructField sfn _ t = withKnownSymbol sfn $ FieldRepr $ ReprText t
44
48
45instance SingI cs => Representable ('SchemaNumber cs) where
49instance SingI cs => Representable ('SchemaNumber cs) where
46− type Repr ('SchemaNumber cs) = Scientific
47− construct sfn _ n = withKnownSymbol sfn $ FieldRepr $ ReprNumber n
50+ constructField sfn _ n = withKnownSymbol sfn $ FieldRepr $ ReprNumber n
48
51
49instance Representable 'SchemaBoolean where
52instance Representable 'SchemaBoolean where
50− type Repr 'SchemaBoolean = Bool
51− construct sfn _ b = withKnownSymbol sfn $ FieldRepr $ ReprBoolean b
53+ constructField sfn _ b = withKnownSymbol sfn $ FieldRepr $ ReprBoolean b
52
54
53instance SingI so => Representable ('SchemaOptional so) where
55instance SingI so => Representable ('SchemaOptional so) where
54− type Repr ('SchemaOptional so) = Maybe (JsonRepr so)
55− construct sfn _ o = withKnownSymbol sfn $ FieldRepr $ ReprOptional o
56+ constructField sfn _ o = withKnownSymbol sfn $ FieldRepr $ ReprOptional o
56
57
57instance SingI (h ': tl) => Representable ('SchemaUnion (h ': tl)) where
58instance SingI (h ': tl) => Representable ('SchemaUnion (h ': tl)) where
58− type Repr ('SchemaUnion (h ': tl)) = Union JsonRepr (h ': tl)
59+ constructField sfn _ u = withKnownSymbol sfn $ FieldRepr $ ReprUnion u
59− construct 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
60
73
61type family FieldsOf (s :: Schema) :: [(Symbol, Schema)] where
74type family FieldsOf (s :: Schema) :: [(Symbol, Schema)] where
62 FieldsOf ('SchemaObject fs) = fs
75 FieldsOf ('SchemaObject fs) = fs
63
76
64type FieldConstructor fn =
77type FieldConstructor fn =
65− forall fs. (Representable (ByField fn fs (FIndex fn fs)))
78+ forall byField fs. (byField ~ ByField fn fs (FIndex fn fs), Representable byField)
66− => Repr (ByField fn fs (FIndex fn fs))
79+ => Repr byField
67− -> (Tagged fs :. FieldRepr) '(fn, (ByField fn fs (FIndex fn fs)))
80+ -> (Tagged fs :. FieldRepr) '(fn, byField)
68
81
69field :: forall fn. KnownSymbol fn => FieldConstructor fn
82field :: forall fn. KnownSymbol fn => FieldConstructor fn
70−field = Compose . Tagged . construct (sing :: Sing fn) Proxy
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/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+29−10
@@ -12,8 +12,10 @@ import Control.Monad.State.Strict
12import Data.Aeson as J
12import Data.Aeson as J
13import Data.Foldable as F
13import Data.Foldable as F
14import Data.HashMap.Strict as H
14import Data.HashMap.Strict as H
15+import Data.List as L
15import Data.List.NonEmpty as NE
16import Data.List.NonEmpty as NE
16import Data.Schematic.Schema as S
17import Data.Schematic.Schema as S
18+import Data.Set as Set
17import Data.Singletons
19import Data.Singletons
18import Data.Text
20import Data.Text
19import Data.Traversable
21import Data.Traversable
@@ -28,13 +30,13 @@ textConstraint :: DemotedTextConstraint -> State D4.Schema ()
28textConstraint (DTEq n) = modify $ \s -> s
30textConstraint (DTEq n) = modify $ \s -> s
29 { _schemaMinLength = pure $ fromIntegral n
31 { _schemaMinLength = pure $ fromIntegral n
30 , _schemaMaxLength = pure $ fromIntegral n }
32 , _schemaMaxLength = pure $ fromIntegral n }
31−textConstraint (DTLt n) = modify $ \s -> s
32− { _schemaMaxLength = pure . fromIntegral $ n + 1 }
33textConstraint (DTLe n) = modify $ \s -> s
33textConstraint (DTLe n) = modify $ \s -> s
34 { _schemaMaxLength = pure . fromIntegral $ n }
34 { _schemaMaxLength = pure . fromIntegral $ n }
35−textConstraint (DTGt n) =
35+textConstraint (DTLt n) =
36 let n' = if n == 0 then 0 else n - 1
36 let n' = if n == 0 then 0 else n - 1
37+ in modify $ \s -> s { _schemaMaxLength = pure . fromIntegral $ n' }
38+textConstraint (DTGt n) = modify $ \s -> s
37− in modify $ \s -> s { _schemaMinLength = pure . fromIntegral $ n' }
39+ { _schemaMinLength = pure . fromIntegral $ n + 1 }
38textConstraint (DTGe n) = modify $ \s -> s
40textConstraint (DTGe n) = modify $ \s -> s
39 { _schemaMinLength = pure . fromIntegral $ n }
41 { _schemaMinLength = pure . fromIntegral $ n }
40textConstraint (DTRegex r) = modify $ \s -> s { _schemaPattern = pure r }
42textConstraint (DTRegex r) = modify $ \s -> s { _schemaPattern = pure r }
@@ -46,18 +48,30 @@ numberConstraint :: DemotedNumberConstraint -> State D4.Schema ()
46numberConstraint (DNLe n) = modify $ \s -> s
48numberConstraint (DNLe n) = modify $ \s -> s
47 { _schemaMaximum = pure . fromIntegral $ n }
49 { _schemaMaximum = pure . fromIntegral $ n }
48numberConstraint (DNLt n) = modify $ \s -> s
50numberConstraint (DNLt n) = modify $ \s -> s
49− { _schemaMaximum = pure . fromIntegral $ n + 1 }
51+ { _schemaMaximum = pure . fromIntegral $ n
52+ , _schemaExclusiveMaximum = pure True }
50numberConstraint (DNGt n) = modify $ \s -> s
53numberConstraint (DNGt n) = modify $ \s -> s
54+ { _schemaMinimum = pure . fromIntegral $ n
55+ , _schemaExclusiveMinimum = pure True }
56+numberConstraint (DNGe n) = modify $ \s -> s
51 { _schemaMinimum = pure . fromIntegral $ n }
57 { _schemaMinimum = pure . fromIntegral $ n }
52−numberConstraint (DNGe n) =
53− let n' = if n == 0 then 0 else n - 1
54− in modify $ \s -> s { _schemaMinimum = pure . fromIntegral $ n' }
55numberConstraint (DNEq n) = modify $ \s -> s
58numberConstraint (DNEq n) = modify $ \s -> s
56 { _schemaMinimum = pure $ fromIntegral n
59 { _schemaMinimum = pure $ fromIntegral n
57 , _schemaMaximum = pure $ fromIntegral n }
60 , _schemaMaximum = pure $ fromIntegral n }
58
61
59arrayConstraint :: DemotedArrayConstraint -> State D4.Schema ()
62arrayConstraint :: DemotedArrayConstraint -> State D4.Schema ()
60−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 }
61
75
62toJsonSchema
76toJsonSchema
63 :: forall proxy schema
77 :: forall proxy schema
@@ -84,14 +98,19 @@ toJsonSchema' = \case
84 res <- for objs $ \(n,s) -> do
98 res <- for objs $ \(n,s) -> do
85 s' <- toJsonSchema' s
99 s' <- toJsonSchema' s
86 pure (n, s')
100 pure (n, s')
101+ let
102+ nonOpt = \case
103+ (_, DSchemaOptional _) -> False
104+ _ -> True
87 pure $ emptySchema
105 pure $ emptySchema
88 { _schemaType = pure $ TypeValidatorString D4.SchemaObject
106 { _schemaType = pure $ TypeValidatorString D4.SchemaObject
107+ , _schemaRequired = pure $ Set.fromList $ fst <$> L.filter nonOpt objs
89 , _schemaProperties = pure $ H.fromList res }
108 , _schemaProperties = pure $ H.fromList res }
90 DSchemaArray acs sch -> do
109 DSchemaArray acs sch -> do
91 res <- toJsonSchema' sch
110 res <- toJsonSchema' sch
92 pure $ execState (traverse_ arrayConstraint acs) $ emptySchema
111 pure $ execState (traverse_ arrayConstraint acs) $ emptySchema
93 { _schemaType = pure $ TypeValidatorString D4.SchemaArray
112 { _schemaType = pure $ TypeValidatorString D4.SchemaArray
94− , _schemaItems = pure $ ItemsArray [res] }
113+ , _schemaItems = pure $ ItemsObject res }
95 DSchemaNull -> pure $ emptySchema
114 DSchemaNull -> pure $ emptySchema
96 { _schemaType = pure $ TypeValidatorString D4.SchemaNull }
115 { _schemaType = pure $ TypeValidatorString D4.SchemaNull }
97 DSchemaOptional sch -> do
116 DSchemaOptional sch -> do
src/Data/Schematic/Lens.hs+49−25
@@ -9,6 +9,12 @@ module Data.Schematic.Lens
9 , FImage
9 , FImage
10 , FSubset(..)
10 , FSubset(..)
11 , obj
11 , obj
12+ , arr
13+ , uni
14+ , txt
15+ , num
16+ , opt
17+ , bln
12 , textRepr
18 , textRepr
13 , numberRepr
19 , numberRepr
14 , boolRepr
20 , boolRepr
@@ -18,11 +24,11 @@ module Data.Schematic.Lens
18 ) where
24 ) where
19
25
20import Data.Profunctor
26import Data.Profunctor
21−import Data.Proxy
22import Data.Schematic.Schema
27import Data.Schematic.Schema
23import Data.Scientific
28import Data.Scientific
24import Data.Singletons
29import Data.Singletons
25import Data.Text
30import Data.Text
31+import Data.Union
26import Data.Vector as V
32import Data.Vector as V
27import Data.Vinyl
33import Data.Vinyl
28import Data.Vinyl.Functor
34import Data.Vinyl.Functor
@@ -35,20 +41,20 @@ type family FIndex (r :: Symbol) (rs :: [(Symbol, Schema)]) :: Nat where
35 FIndex r ( '(r, s) ': rs) = 'Z
41 FIndex r ( '(r, s) ': rs) = 'Z
36 FIndex r ( s ': rs) = 'S (FIndex r rs)
42 FIndex r ( s ': rs) = 'S (FIndex r rs)
37
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))
51+
38class 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
39 type ByField fn rs i :: Schema
53 type ByField fn rs i :: Schema
40− flens
54+ flens :: Flens fn f g rs i
41− :: Functor g
42− => proxy fn
43− -> (f '(fn, (ByField fn rs i)) -> g (f '(fn, (ByField fn rs i))))
44− -> Rec f rs
45− -> g (Rec f rs)
46
55
47 -- | 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.
48− fget
57+ fget :: FGetter fn f rs i
49− :: proxy fn
50− -> Rec f rs
51− -> f '(fn, (ByField fn rs i))
52
58
53 -- | 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
54 -- 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,
@@ -61,25 +67,25 @@ class i ~ FIndex fn rs => FElem (fn :: Symbol) (rs :: [(Symbol, Schema)]) (i ::
61instance FElem fn ('(fn, r) ': rs) 'Z where
67instance FElem fn ('(fn, r) ': rs) 'Z where
62 type ByField fn ('(fn, r) ': rs) 'Z = r
68 type ByField fn ('(fn, r) ': rs) 'Z = r
63
69
64− flens _ f (x :& xs) = fmap (:& xs) (f x)
70+ flens f (x :& xs) = fmap (:& xs) (f x)
65 {-# INLINE flens #-}
71 {-# INLINE flens #-}
66
72
67− fget k = getConst . flens k Const
73+ fget = getConst . flens Const
68 {-# INLINE fget #-}
74 {-# INLINE fget #-}
69
75
70− fput y = getIdentity . flens Proxy (\_ -> Identity y)
76+ fput y = getIdentity . flens (\_ -> Identity y)
71 {-# INLINE fput #-}
77 {-# INLINE fput #-}
72
78
73instance (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
74 type ByField r (s ': rs) ('S i) = ByField r rs i
80 type ByField r (s ': rs) ('S i) = ByField r rs i
75
81
76− flens p f (x :& xs) = fmap (x :&) (flens p f xs)
82+ flens f (x :& xs) = fmap (x :&) (flens f xs)
77 {-# INLINE flens #-}
83 {-# INLINE flens #-}
78
84
79− fget k = getConst . flens k Const
85+ fget = getConst . flens Const
80 {-# INLINE fget #-}
86 {-# INLINE fget #-}
81
87
82− fput y = getIdentity . flens Proxy (\_ -> Identity y)
88+ fput y = getIdentity . flens (\_ -> Identity y)
83 {-# INLINE fput #-}
89 {-# INLINE fput #-}
84
90
85-- This is an internal convenience helpers stolen from the @lens@ library.
91-- This is an internal convenience helpers stolen from the @lens@ library.
@@ -143,41 +149,59 @@ instance
143 ( ByField fn ss i ~ s
149 ( ByField fn ss i ~ s
144 , FElem fn ss i
150 , FElem fn ss i
145 , FSubset rs ss is) => FSubset ( '(fn,s) ': rs) ss (i ': is) where
151 , FSubset rs ss is) => FSubset ( '(fn,s) ': rs) ss (i ': is) where
146− fsubset = lens (\ss -> fget Proxy ss :& fcast ss) set
152+ fsubset = lens (\ss -> fget @fn ss :& fcast ss) set
147 where
153 where
148 set :: Rec f ss -> Rec f ( '(fn,s) ': rs) -> Rec f ss
154 set :: Rec f ss -> Rec f ( '(fn,s) ': rs) -> Rec f ss
149 set ss (r :& rs) = fput r $ freplace rs ss
155 set ss (r :& rs) = fput r $ freplace rs ss
150
156
151-- A bunch of @Iso@morphisms
157-- A bunch of @Iso@morphisms
152textRepr
158textRepr
153− :: (KnownSymbol fn, SingI fn, SingI cs)
159+ :: (KnownSymbol fn, SingI cs)
154 => Iso' (FieldRepr '(fn, ('SchemaText cs))) Text
160 => Iso' (FieldRepr '(fn, ('SchemaText cs))) Text
155textRepr = iso (\(FieldRepr (ReprText t)) -> t) (FieldRepr . ReprText)
161textRepr = iso (\(FieldRepr (ReprText t)) -> t) (FieldRepr . ReprText)
156
162
157numberRepr
163numberRepr
158− :: (KnownSymbol fn, SingI fn, SingI cs)
164+ :: (KnownSymbol fn, SingI cs)
159 => Iso' (FieldRepr '(fn, ('SchemaNumber cs))) Scientific
165 => Iso' (FieldRepr '(fn, ('SchemaNumber cs))) Scientific
160numberRepr = iso (\(FieldRepr (ReprNumber n)) -> n) (FieldRepr . ReprNumber)
166numberRepr = iso (\(FieldRepr (ReprNumber n)) -> n) (FieldRepr . ReprNumber)
161
167
162boolRepr
168boolRepr
163− :: (KnownSymbol fn, SingI fn, SingI cs)
169+ :: (KnownSymbol fn)
164 => Iso' (FieldRepr '(fn, 'SchemaBoolean)) Bool
170 => Iso' (FieldRepr '(fn, 'SchemaBoolean)) Bool
165boolRepr = iso (\(FieldRepr (ReprBoolean b)) -> b) (FieldRepr . ReprBoolean)
171boolRepr = iso (\(FieldRepr (ReprBoolean b)) -> b) (FieldRepr . ReprBoolean)
166
172
167arrayRepr
173arrayRepr
168− :: (KnownSymbol fn, SingI fn, SingI cs, SingI schema)
174+ :: (KnownSymbol fn, SingI cs, SingI schema)
169 => Iso' (FieldRepr '(fn, ('SchemaArray cs schema))) (V.Vector (JsonRepr schema))
175 => Iso' (FieldRepr '(fn, ('SchemaArray cs schema))) (V.Vector (JsonRepr schema))
170arrayRepr = iso (\(FieldRepr (ReprArray a)) -> a) (FieldRepr . ReprArray)
176arrayRepr = iso (\(FieldRepr (ReprArray a)) -> a) (FieldRepr . ReprArray)
171
177
172objectRepr
178objectRepr
173− :: (KnownSymbol fn, SingI fn, SingI fields)
179+ :: (KnownSymbol fn, SingI fields)
174 => Iso' (FieldRepr '(fn, ('SchemaObject fields))) (Rec FieldRepr fields)
180 => Iso' (FieldRepr '(fn, ('SchemaObject fields))) (Rec FieldRepr fields)
175objectRepr = iso (\(FieldRepr (ReprObject o)) -> o) (FieldRepr . ReprObject)
181objectRepr = iso (\(FieldRepr (ReprObject o)) -> o) (FieldRepr . ReprObject)
176
182
177optionalRepr
183optionalRepr
178− :: (KnownSymbol fn, SingI fn, SingI schema)
184+ :: (KnownSymbol fn, SingI schema)
179 => Iso' (FieldRepr '(fn, ('SchemaOptional schema))) (Maybe (JsonRepr schema))
185 => Iso' (FieldRepr '(fn, ('SchemaOptional schema))) (Maybe (JsonRepr schema))
180optionalRepr = iso (\(FieldRepr (ReprOptional r)) -> r) (FieldRepr . ReprOptional)
186optionalRepr = iso (\(FieldRepr (ReprOptional r)) -> r) (FieldRepr . ReprOptional)
181
187
182−obj :: (SingI fields) => Iso' (JsonRepr ('SchemaObject fields)) (Rec FieldRepr fields)
188+obj :: Iso' (JsonRepr ('SchemaObject fields)) (Rec FieldRepr fields)
183obj = iso (\(ReprObject r) -> r) ReprObject
189obj = 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+42−7
@@ -1,14 +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
7−import Data.Tagged
8+import Data.Schematic.DSL
9+import Data.Schematic.Lens
8import Data.Schematic.Path
10import Data.Schematic.Path
9import Data.Schematic.Schema
11import Data.Schematic.Schema
10−import Data.Singletons.Prelude hiding (All)
12+import Data.Singletons.Prelude hiding ((:.), All)
11import Data.Singletons.TypeLits
13import Data.Singletons.TypeLits
14+import Data.Tagged
15+import Data.Vinyl
16+import Data.Vinyl.Functor
12
17
13
18
14data Path
19data Path
@@ -38,8 +43,8 @@ type family SchemaByKey (fs :: [(Symbol, Schema)]) (s :: Symbol) :: Schema where
38 SchemaByKey ( '(a, s) ': tl) fn = SchemaByKey tl fn
43 SchemaByKey ( '(a, s) ': tl) fn = SchemaByKey tl fn
39
44
40type 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
41− DeleteKey acc fn ('(fn, a) ': tl) = acc :++ tl
46+ DeleteKey acc fn ('(fn, a) ': tl) = acc ++ tl
42− DeleteKey acc fn (fna ': tl) = acc :++ (fna ': tl)
47+ DeleteKey acc fn (fna ': tl) = acc ++ (fna ': tl)
43
48
44type family UpdateKey
49type family UpdateKey
45 (fn :: Symbol)
50 (fn :: Symbol)
@@ -92,7 +97,8 @@ type family ElemOf (e :: k) (l :: [(a,k)]) :: Constraint where
92type family AllVersions (vd :: Versioned) :: [(Revision, Schema)] where
97type family AllVersions (vd :: Versioned) :: [(Revision, Schema)] where
93 AllVersions ('Versioned s ms) = Reverse (AllVersions' '[ '("initial", s) ] ms)
98 AllVersions ('Versioned s ms) = Reverse (AllVersions' '[ '("initial", s) ] ms)
94
99
95−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
96 AllVersions' acc '[] = acc
102 AllVersions' acc '[] = acc
97 AllVersions' ( '(rh, sh) ': tl ) (m ': ms) =
103 AllVersions' ( '(rh, sh) ': tl ) (m ': ms) =
98 AllVersions' ( '(rh, sh) ': ApplyMigration m sh ': tl ) ms
104 AllVersions' ( '(rh, sh) ': ApplyMigration m sh ': tl ) ms
@@ -141,7 +147,7 @@ data instance Sing (v :: Versioned) where
141
147
142type DataMigration s m h = Tagged s (JsonRepr h -> m (JsonRepr s))
148type DataMigration s m h = Tagged s (JsonRepr h -> m (JsonRepr s))
143
149
144−data MList :: (* -> *) -> [Schema] -> Type where
150+data MList :: (Type -> Type) -> [Schema] -> Type where
145 MNil :: (Monad m, SingI s, TopLevel s) => MList m '[s]
151 MNil :: (Monad m, SingI s, TopLevel s) => MList m '[s]
146 (:&&)
152 (:&&)
147 :: (TopLevel s, SingI s)
153 :: (TopLevel s, SingI s)
@@ -150,3 +156,32 @@ data MList :: (* -> *) -> [Schema] -> Type where
150 -> MList m (s ': h ': tl)
156 -> MList m (s ': h ': tl)
151
157
152infixr 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−23
@@ -1,41 +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.Singletons
6import Data.Singletons.Prelude
4import Data.Singletons.Prelude
7import Data.Singletons.TypeLits
5import Data.Singletons.TypeLits
8import Data.Text as T
6import Data.Text as T
7+import Data.Aeson.Internal
9
8
10
9
11−data PathSegment = Key Symbol | Ix Nat
10+newtype JSONPathText = JSONPathText Text
12−
13−data instance Sing (jp :: PathSegment) where
14− SKey :: (SingI k) => Sing (k :: Symbol) -> Sing ('Key k)
15− SIx :: (SingI n) => Sing (n :: Nat) -> Sing ('Ix n)
16−
17−data DemotedPathSegment = DKey Text | DIx Integer
18 deriving (Show)
11 deriving (Show)
19
12
20−-- | Textual representation of json path.
13+data PathSegment = PathKey Symbol | PathIx Nat
21−newtype JSONPath = JSONPath Text
14+
22− 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)
23
18
24−demotePath :: Sing (ps :: [PathSegment]) -> [DemotedPathSegment]
19+demotePath :: Sing (ps :: [PathSegment]) -> JSONPath
25demotePath = go []
20demotePath = go []
26 where
21 where
27− go :: [DemotedPathSegment] -> Sing (ps :: [PathSegment]) -> [DemotedPathSegment]
22+ go :: JSONPath -> Sing (ps :: [PathSegment]) -> JSONPath
28 go acc SNil = acc
23 go acc SNil = acc
29− go acc (SCons p ps) = go (acc ++ [demote p]) ps
24+ go acc (SCons p ps) = go (acc ++ [demotePathSeg p]) ps
30− demote :: Sing (ps :: PathSegment) -> DemotedPathSegment
25+ demotePathSeg :: Sing (ps :: PathSegment) -> JSONPathElement
31− demote (SKey s) = DKey $ T.pack $ withKnownSymbol s $ symbolVal s
26+ demotePathSeg (SKey s) = Key $ T.pack $ withKnownSymbol s $ symbolVal s
32− demote (SIx n) = DIx $ withKnownNat n $ natVal n
27+ demotePathSeg (SIx n) = Index $ withKnownNat n $ fromIntegral $ natVal n
33
28
34−demotedPathToText :: [DemotedPathSegment] -> JSONPath
29+demotedPathToText :: JSONPath -> JSONPathText
35−demotedPathToText = JSONPath . F.foldl' renderPathSegment ""
30+demotedPathToText = JSONPathText . F.foldl' renderPathSegment ""
36 where
31 where
37− renderPathSegment acc (DKey t) = acc <> "." <> t
32+ renderPathSegment acc (Key t) = acc <> "." <> t
38− renderPathSegment acc (DIx n) = acc <> "[" <> T.pack (show n) <> "]"
33+ renderPathSegment acc (Index n) = acc <> "[" <> T.pack (show n) <> "]"
39
34
40−pathToText :: Sing (ps :: [PathSegment]) -> JSONPath
35+pathToText :: Sing (ps :: [PathSegment]) -> JSONPathText
41pathToText = demotedPathToText . demotePath
36pathToText = demotedPathToText . demotePath
src/Data/Schematic/Schema.hs+148−60
@@ -1,6 +1,7 @@
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
@@ -12,6 +13,7 @@ import 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
17import Data.Singletons.Prelude.List hiding (All, Union)
19import Data.Singletons.Prelude.List hiding (All, Union)
@@ -24,7 +26,8 @@ import Data.Vinyl hiding (Dict)
24import qualified Data.Vinyl.TypeLevel as V
26import qualified Data.Vinyl.TypeLevel as V
25import GHC.Exts
27import GHC.Exts
26import GHC.Generics (Generic)
28import GHC.Generics (Generic)
29+import GHC.TypeLits
27−import GHC.TypeLits (SomeNat(..), SomeSymbol(..), someSymbolVal, someNatVal)
30+ (SomeNat(..), SomeSymbol(..), someNatVal, someSymbolVal)
28import Prelude as P
31import Prelude as P
29import Test.SmallCheck.Series
32import Test.SmallCheck.Series
30
33
@@ -48,33 +51,33 @@ data TextConstraint
48instance SingKind TextConstraint where
51instance SingKind TextConstraint where
49 type Demote TextConstraint = DemotedTextConstraint
52 type Demote TextConstraint = DemotedTextConstraint
50 fromSing = \case
53 fromSing = \case
51− STEq n -> withKnownNat n (DTEq $ natVal n)
54+ STEq n -> withKnownNat n (DTEq . fromIntegral $ natVal n)
52− STLt n -> withKnownNat n (DTLt $ natVal n)
55+ STLt n -> withKnownNat n (DTLt . fromIntegral $ natVal n)
53− STLe n -> withKnownNat n (DTLe $ natVal n)
56+ STLe n -> withKnownNat n (DTLe . fromIntegral $ natVal n)
54− STGt n -> withKnownNat n (DTGt $ natVal n)
57+ STGt n -> withKnownNat n (DTGt . fromIntegral $ natVal n)
55− STGe n -> withKnownNat n (DTGe $ natVal n)
58+ STGe n -> withKnownNat n (DTGe . fromIntegral $ natVal n)
56 STRegex s -> withKnownSymbol s (DTRegex $ T.pack $ symbolVal s)
59 STRegex s -> withKnownSymbol s (DTRegex $ T.pack $ symbolVal s)
57 STEnum s -> let
60 STEnum s -> let
58 d :: Sing (s :: [Symbol]) -> [Text]
61 d :: Sing (s :: [Symbol]) -> [Text]
59− d SNil = []
62+ d SNil = []
60 d (SCons ss@SSym fs) = T.pack (symbolVal ss) : d fs
63 d (SCons ss@SSym fs) = T.pack (symbolVal ss) : d fs
61 in DTEnum $ d s
64 in DTEnum $ d s
62 toSing = \case
65 toSing = \case
63 DTEq n -> case someNatVal n of
66 DTEq n -> case someNatVal n of
64 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STEq (SNat :: Sing n))
67 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STEq (SNat :: Sing n))
65− Nothing -> error "Negative singleton nat"
68+ Nothing -> error "Negative singleton nat"
66 DTLt n -> case someNatVal n of
69 DTLt n -> case someNatVal n of
67 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STLt (SNat :: Sing n))
70 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STLt (SNat :: Sing n))
68− Nothing -> error "Negative singleton nat"
71+ Nothing -> error "Negative singleton nat"
69 DTLe n -> case someNatVal n of
72 DTLe n -> case someNatVal n of
70 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STLe (SNat :: Sing n))
73 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STLe (SNat :: Sing n))
71− Nothing -> error "Negative singleton nat"
74+ Nothing -> error "Negative singleton nat"
72 DTGt n -> case someNatVal n of
75 DTGt n -> case someNatVal n of
73 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STGt (SNat :: Sing n))
76 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STGt (SNat :: Sing n))
74− Nothing -> error "Negative singleton nat"
77+ Nothing -> error "Negative singleton nat"
75 DTGe n -> case someNatVal n of
78 DTGe n -> case someNatVal n of
76 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STGe (SNat :: Sing n))
79 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STGe (SNat :: Sing n))
77− Nothing -> error "Negative singleton nat"
80+ Nothing -> error "Negative singleton nat"
78 DTRegex s -> case someSymbolVal (T.unpack s) of
81 DTRegex s -> case someSymbolVal (T.unpack s) of
79 SomeSymbol (_ :: Proxy n) -> SomeSing (STRegex (SSym :: Sing n))
82 SomeSymbol (_ :: Proxy n) -> SomeSing (STRegex (SSym :: Sing n))
80 DTEnum ss -> case toSing ss of
83 DTEnum ss -> case toSing ss of
@@ -88,7 +91,7 @@ data DemotedTextConstraint
88 | DTGe Integer
91 | DTGe Integer
89 | DTRegex Text
92 | DTRegex Text
90 | DTEnum [Text]
93 | DTEnum [Text]
91− deriving (Generic)
94+ deriving (Generic, Eq, Show)
92
95
93data instance Sing (tc :: TextConstraint) where
96data instance Sing (tc :: TextConstraint) where
94 STEq :: Sing n -> Sing ('TEq n)
97 STEq :: Sing n -> Sing ('TEq n)
@@ -129,7 +132,7 @@ data DemotedNumberConstraint
129 | DNGt Integer
132 | DNGt Integer
130 | DNGe Integer
133 | DNGe Integer
131 | DNEq Integer
134 | DNEq Integer
132− deriving (Generic)
135+ deriving (Generic, Eq, Show)
133
136
134data instance Sing (nc :: NumberConstraint) where
137data instance Sing (nc :: NumberConstraint) where
135 SNEq :: Sing n -> Sing ('NEq n)
138 SNEq :: Sing n -> Sing ('NEq n)
@@ -153,51 +156,87 @@ instance Eq (Sing ('NGe n)) where _ == _ = True
153instance SingKind NumberConstraint where
156instance SingKind NumberConstraint where
154 type Demote NumberConstraint = DemotedNumberConstraint
157 type Demote NumberConstraint = DemotedNumberConstraint
155 fromSing = \case
158 fromSing = \case
156− SNEq n -> withKnownNat n (DNEq $ natVal n)
159+ SNEq n -> withKnownNat n (DNEq . fromIntegral $ natVal n)
157− SNGt n -> withKnownNat n (DNGt $ natVal n)
160+ SNGt n -> withKnownNat n (DNGt . fromIntegral $ natVal n)
158− SNGe n -> withKnownNat n (DNGe $ natVal n)
161+ SNGe n -> withKnownNat n (DNGe . fromIntegral $ natVal n)
159− SNLt n -> withKnownNat n (DNLt $ natVal n)
162+ SNLt n -> withKnownNat n (DNLt . fromIntegral $ natVal n)
160− SNLe n -> withKnownNat n (DNLe $ natVal n)
163+ SNLe n -> withKnownNat n (DNLe . fromIntegral $ natVal n)
161 toSing = \case
164 toSing = \case
162 DNEq n -> case someNatVal n of
165 DNEq n -> case someNatVal n of
163 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNEq (SNat :: Sing n))
166 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNEq (SNat :: Sing n))
164− Nothing -> error "Negative singleton nat"
167+ Nothing -> error "Negative singleton nat"
165 DNGt n -> case someNatVal n of
168 DNGt n -> case someNatVal n of
166 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNGt (SNat :: Sing n))
169 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNGt (SNat :: Sing n))
167− Nothing -> error "Negative singleton nat"
170+ Nothing -> error "Negative singleton nat"
168 DNGe n -> case someNatVal n of
171 DNGe n -> case someNatVal n of
169 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNGe (SNat :: Sing n))
172 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNGe (SNat :: Sing n))
170− Nothing -> error "Negative singleton nat"
173+ Nothing -> error "Negative singleton nat"
171 DNLt n -> case someNatVal n of
174 DNLt n -> case someNatVal n of
172 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNLt (SNat :: Sing n))
175 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNLt (SNat :: Sing n))
173− Nothing -> error "Negative singleton nat"
176+ Nothing -> error "Negative singleton nat"
174 DNLe n -> case someNatVal n of
177 DNLe n -> case someNatVal n of
175 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNLe (SNat :: Sing n))
178 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNLe (SNat :: Sing n))
176− Nothing -> error "Negative singleton nat"
179+ Nothing -> error "Negative singleton nat"
177
180
178data ArrayConstraint
181data ArrayConstraint
179 = AEq Nat
182 = AEq Nat
183+ | AGt Nat
184+ | AGe Nat
185+ | ALt Nat
186+ | ALe Nat
180 deriving (Generic)
187 deriving (Generic)
181
188
182data DemotedArrayConstraint
189data DemotedArrayConstraint
183 = DAEq Integer
190 = DAEq Integer
191+ | DAGt Integer
192+ | DAGe Integer
193+ | DALt Integer
194+ | DALe Integer
184− deriving (Generic)
195+ deriving (Generic, Eq, Show)
185
196
186data instance Sing (ac :: ArrayConstraint) where
197data instance Sing (ac :: ArrayConstraint) where
187 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)
188
203
189instance 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
190
209
191instance 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
192
215
193instance SingKind ArrayConstraint where
216instance SingKind ArrayConstraint where
194 type Demote ArrayConstraint = DemotedArrayConstraint
217 type Demote ArrayConstraint = DemotedArrayConstraint
195 fromSing = \case
218 fromSing = \case
196− 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)
197 toSing = \case
224 toSing = \case
198 DAEq n -> case someNatVal n of
225 DAEq n -> case someNatVal n of
199 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))
200− Nothing -> error "Negative singleton nat"
239+ Nothing -> error "Negative singleton nat"
201
240
202data Schema
241data Schema
203 = SchemaText [TextConstraint]
242 = SchemaText [TextConstraint]
@@ -219,7 +258,7 @@ data DemotedSchema
219 | DSchemaNull
258 | DSchemaNull
220 | DSchemaOptional DemotedSchema
259 | DSchemaOptional DemotedSchema
221 | DSchemaUnion [DemotedSchema]
260 | DSchemaUnion [DemotedSchema]
222− deriving (Generic)
261+ deriving (Generic, Eq, Show)
223
262
224data instance Sing (schema :: Schema) where
263data instance Sing (schema :: Schema) where
225 SSchemaText :: Sing tcs -> Sing ('SchemaText tcs)
264 SSchemaText :: Sing tcs -> Sing ('SchemaText tcs)
@@ -334,6 +373,31 @@ data JsonRepr :: Schema -> Type where
334 ReprOptional :: Maybe (JsonRepr s) -> JsonRepr ('SchemaOptional s)
373 ReprOptional :: Maybe (JsonRepr s) -> JsonRepr ('SchemaOptional s)
335 ReprUnion :: Union JsonRepr (h ': tl) -> JsonRepr ('SchemaUnion (h ': tl))
374 ReprUnion :: Union JsonRepr (h ': tl) -> JsonRepr ('SchemaUnion (h ': tl))
336
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)
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+
337-- | Move to the union package
401-- | Move to the union package
338instance Show (JsonRepr ('SchemaText cs)) where
402instance Show (JsonRepr ('SchemaText cs)) where
339 show (ReprText t) = "ReprText " P.++ show t
403 show (ReprText t) = "ReprText " P.++ show t
@@ -341,39 +405,31 @@ instance Show (JsonRepr ('SchemaText cs)) where
341instance Show (JsonRepr ('SchemaNumber cs)) where
405instance Show (JsonRepr ('SchemaNumber cs)) where
342 show (ReprNumber n) = "ReprNumber " P.++ show n
406 show (ReprNumber n) = "ReprNumber " P.++ show n
343
407
408+instance Show (JsonRepr 'SchemaBoolean) where
409+ show (ReprBoolean n) = "ReprBoolean " P.++ show n
410+
344instance Show (JsonRepr 'SchemaNull) where show _ = "ReprNull"
411instance Show (JsonRepr 'SchemaNull) where show _ = "ReprNull"
345
412
346instance Show (JsonRepr s) => Show (JsonRepr ('SchemaArray acs s)) where
413instance Show (JsonRepr s) => Show (JsonRepr ('SchemaArray acs s)) where
347 show (ReprArray v) = "ReprArray " P.++ show v
414 show (ReprArray v) = "ReprArray " P.++ show v
348
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
349instance V.RecAll FieldRepr fs Show => Show (JsonRepr ('SchemaObject fs)) where
423instance V.RecAll FieldRepr fs Show => Show (JsonRepr ('SchemaObject fs)) where
350 show (ReprObject fs) = "ReprObject " P.++ show fs
424 show (ReprObject fs) = "ReprObject " P.++ show fs
425+#endif
351
426
352instance Show (JsonRepr s) => Show (JsonRepr ('SchemaOptional s)) where
427instance Show (JsonRepr s) => Show (JsonRepr ('SchemaOptional s)) where
353 show (ReprOptional s) = "ReprOptional " P.++ show s
428 show (ReprOptional s) = "ReprOptional " P.++ show s
354
429
355−instance (Monad m, Serial m Text)
430+instance Show (Union JsonRepr (h ': tl))
356− => Serial m (JsonRepr ('SchemaText cs)) where
431+ => Show (JsonRepr ('SchemaUnion (h ': tl))) where
357− series = cons1 ReprText
432+ show (ReprUnion s) = "ReprUnion " P.++ show s
358−
359−instance (Monad m, Serial m Scientific)
360− => Serial m (JsonRepr ('SchemaNumber cs)) where
361− series = cons1 ReprNumber
362−
363−instance Monad m => Serial m (JsonRepr 'SchemaNull) where
364− series = cons0 ReprNull
365−
366−instance (Serial m (V.Vector (JsonRepr s)))
367− => Serial m (JsonRepr ('SchemaArray cs s)) where
368− series = cons1 ReprArray
369−
370−instance (Serial m (JsonRepr s))
371− => Serial m (JsonRepr ('SchemaOptional s)) where
372− series = cons1 ReprOptional
373−
374−instance (Monad m, Serial m (Rec FieldRepr fs))
375− => Serial m (JsonRepr ('SchemaObject fs)) where
376− series = cons1 ReprObject
377
433
378instance Eq (Rec FieldRepr fs) => Eq (JsonRepr ('SchemaObject fs)) where
434instance Eq (Rec FieldRepr fs) => Eq (JsonRepr ('SchemaObject fs)) where
379 ReprObject a == ReprObject b = a == b
435 ReprObject a == ReprObject b = a == b
@@ -384,6 +440,9 @@ instance Eq (JsonRepr ('SchemaText cs)) where
384instance Eq (JsonRepr ('SchemaNumber cs)) where
440instance Eq (JsonRepr ('SchemaNumber cs)) where
385 ReprNumber a == ReprNumber b = a == b
441 ReprNumber a == ReprNumber b = a == b
386
442
443+instance Eq (JsonRepr 'SchemaBoolean) where
444+ ReprBoolean a == ReprBoolean b = a == b
445+
387instance Eq (JsonRepr 'SchemaNull) where
446instance Eq (JsonRepr 'SchemaNull) where
388 ReprNull == ReprNull = True
447 ReprNull == ReprNull = True
389
448
@@ -393,6 +452,35 @@ instance Eq (JsonRepr s) => Eq (JsonRepr ('SchemaArray as s)) where
393instance Eq (JsonRepr s) => Eq (JsonRepr ('SchemaOptional s)) where
452instance Eq (JsonRepr s) => Eq (JsonRepr ('SchemaOptional s)) where
394 ReprOptional a == ReprOptional b = a == b
453 ReprOptional a == ReprOptional b = a == b
395
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+
396instance IsList (JsonRepr ('SchemaArray cs s)) where
484instance IsList (JsonRepr ('SchemaArray cs s)) where
397 type Item (JsonRepr ('SchemaArray cs s)) = JsonRepr s
485 type Item (JsonRepr ('SchemaArray cs s)) = JsonRepr s
398 fromList = ReprArray . GHC.Exts.fromList
486 fromList = ReprArray . GHC.Exts.fromList
@@ -454,25 +542,25 @@ instance SingI schema => J.FromJSON (JsonRepr schema) where
454 fieldRepr <- case s of
542 fieldRepr <- case s of
455 SSchemaText so -> case H.lookup fieldName h of
543 SSchemaText so -> case H.lookup fieldName h of
456 Just v -> withSingI so $ FieldRepr <$> parseJSON v
544 Just v -> withSingI so $ FieldRepr <$> parseJSON v
457− Nothing -> fail "schematext"
545+ Nothing -> fail $ "No text field: " P.++ show fieldName
458 SSchemaNumber so -> case H.lookup fieldName h of
546 SSchemaNumber so -> case H.lookup fieldName h of
459 Just v -> withSingI so $ FieldRepr <$> parseJSON v
547 Just v -> withSingI so $ FieldRepr <$> parseJSON v
460− Nothing -> fail "schemanumber"
548+ Nothing -> fail $ "No number field: " P.++ show fieldName
461 SSchemaBoolean -> case H.lookup fieldName h of
549 SSchemaBoolean -> case H.lookup fieldName h of
462 Just v -> FieldRepr <$> parseJSON v
550 Just v -> FieldRepr <$> parseJSON v
463− Nothing -> fail "schemaboolean"
551+ Nothing -> fail $ "No boolean field: " P.++ show fieldName
464 SSchemaNull -> case H.lookup fieldName h of
552 SSchemaNull -> case H.lookup fieldName h of
465 Just v -> FieldRepr <$> parseJSON v
553 Just v -> FieldRepr <$> parseJSON v
466− Nothing -> fail "schemanull"
554+ Nothing -> fail $ "No null field: " P.++ show fieldName
467 SSchemaArray sa sb -> case H.lookup fieldName h of
555 SSchemaArray sa sb -> case H.lookup fieldName h of
468 Just v -> withSingI sa $ withSingI sb $ FieldRepr <$> parseJSON v
556 Just v -> withSingI sa $ withSingI sb $ FieldRepr <$> parseJSON v
469− Nothing -> fail "schemaarray"
557+ Nothing -> fail $ "No array field: " P.++ show fieldName
470 SSchemaObject so -> case H.lookup fieldName h of
558 SSchemaObject so -> case H.lookup fieldName h of
471 Just v -> withSingI so $ FieldRepr <$> parseJSON v
559 Just v -> withSingI so $ FieldRepr <$> parseJSON v
472− Nothing -> fail "schemaobject"
560+ Nothing -> fail $ "No object field" P.++ show fieldName
473 SSchemaOptional so -> case H.lookup fieldName h of
561 SSchemaOptional so -> case H.lookup fieldName h of
474 Just v -> withSingI so $ FieldRepr <$> parseJSON v
562 Just v -> withSingI so $ FieldRepr <$> parseJSON v
475− Nothing -> fail "schemaoptional"
563+ Nothing -> withSingI so $ pure $ FieldRepr $ ReprOptional Nothing
476 SSchemaUnion ss -> withSingI ss $ FieldRepr <$> parseUnion ss value
564 SSchemaUnion ss -> withSingI ss $ FieldRepr <$> parseUnion ss value
477 (fieldRepr :&) <$> demoteFields tl h
565 (fieldRepr :&) <$> demoteFields tl h
478 ReprObject <$> withObject "Object" (demoteFields fs) value
566 ReprObject <$> withObject "Object" (demoteFields fs) value
@@ -484,7 +572,7 @@ instance J.ToJSON (JsonRepr a) where
484 toJSON (ReprText t) = J.String t
572 toJSON (ReprText t) = J.String t
485 toJSON (ReprNumber n) = J.Number n
573 toJSON (ReprNumber n) = J.Number n
486 toJSON (ReprOptional s) = case s of
574 toJSON (ReprOptional s) = case s of
487− Just v -> toJSON v
575+ Just v -> toJSON v
488 Nothing -> J.Null
576 Nothing -> J.Null
489 toJSON (ReprArray v) = J.Array $ toJSON <$> v
577 toJSON (ReprArray v) = J.Array $ toJSON <$> v
490 toJSON (ReprObject r) = J.Object . H.fromList . fold $ r
578 toJSON (ReprObject r) = J.Object . H.fromList . fold $ r
src/Data/Schematic/Schema.hs-bootnew file+95
@@ -0,0 +1,95 @@
1+module Data.Schematic.Schema where
2+
3+import Data.Kind
4+import Data.Maybe
5+import Data.Schematic.Instances ()
6+import Data.Scientific
7+import Data.Singletons.TH
8+import Data.Singletons.TypeLits
9+import Data.Text as T
10+import Data.Union
11+import Data.Vector as V
12+import Data.Vinyl hiding (Dict)
13+import Prelude as P
14+
15+data TextConstraint
16+ = TEq Nat
17+ | TLt Nat
18+ | TLe Nat
19+ | TGt Nat
20+ | TGe Nat
21+ | TRegex Symbol
22+ | TEnum [Symbol]
23+
24+data DemotedTextConstraint
25+ = DTEq Integer
26+ | DTLt Integer
27+ | DTLe Integer
28+ | DTGt Integer
29+ | DTGe Integer
30+ | DTRegex Text
31+ | DTEnum [Text]
32+
33+data NumberConstraint
34+ = NLe Nat
35+ | NLt Nat
36+ | NGt Nat
37+ | NGe Nat
38+ | NEq Nat
39+
40+data DemotedNumberConstraint
41+ = DNLe Integer
42+ | DNLt Integer
43+ | DNGt Integer
44+ | DNGe Integer
45+ | DNEq Integer
46+
47+data ArrayConstraint
48+ = AEq Nat
49+ | AGt Nat
50+ | AGe Nat
51+ | ALt Nat
52+ | ALe Nat
53+
54+data DemotedArrayConstraint
55+ = DAEq Integer
56+ | DAGt Integer
57+ | DAGe Integer
58+ | DALt Integer
59+ | DALe Integer
60+
61+data Schema
62+ = SchemaText [TextConstraint]
63+ | SchemaBoolean
64+ | SchemaNumber [NumberConstraint]
65+ | SchemaObject [(Symbol, Schema)]
66+ | SchemaArray [ArrayConstraint] Schema
67+ | SchemaNull
68+ | SchemaOptional Schema
69+ | SchemaUnion [Schema]
70+
71+data DemotedSchema
72+ = DSchemaText [DemotedTextConstraint]
73+ | DSchemaNumber [DemotedNumberConstraint]
74+ | DSchemaBoolean
75+ | DSchemaObject [(Text, DemotedSchema)]
76+ | DSchemaArray [DemotedArrayConstraint] DemotedSchema
77+ | DSchemaNull
78+ | DSchemaOptional DemotedSchema
79+ | DSchemaUnion [DemotedSchema]
80+
81+data FieldRepr :: (Symbol, Schema) -> Type where
82+ FieldRepr
83+ :: (SingI schema, KnownSymbol name)
84+ => JsonRepr schema
85+ -> FieldRepr '(name, schema)
86+
87+data JsonRepr :: Schema -> Type where
88+ ReprText :: Text -> JsonRepr ('SchemaText cs)
89+ ReprNumber :: Scientific -> JsonRepr ('SchemaNumber cs)
90+ ReprBoolean :: Bool -> JsonRepr 'SchemaBoolean
91+ ReprNull :: JsonRepr 'SchemaNull
92+ ReprArray :: V.Vector (JsonRepr s) -> JsonRepr ('SchemaArray cs s)
93+ ReprObject :: Rec FieldRepr fs -> JsonRepr ('SchemaObject fs)
94+ ReprOptional :: Maybe (JsonRepr s) -> JsonRepr ('SchemaOptional s)
95+ ReprUnion :: Union JsonRepr (h ': tl) -> JsonRepr ('SchemaUnion (h ': tl))
src/Data/Schematic/Validation.hs+87−29
@@ -2,6 +2,9 @@ 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
@@ -30,6 +33,10 @@ data ParseResult a
30 | ValidationError ErrorMap -- runtime
33 | ValidationError ErrorMap -- runtime
31 deriving (Show, Eq, Functor, Foldable, Traversable)
34 deriving (Show, Eq, Functor, Foldable, Traversable)
32
35
36+instance (TopLevel a, SingI a, FromJSON (JsonRepr a))
37+ => FromJSON (ParseResult (JsonRepr a)) where
38+ parseJSON = pure . parseAndValidateJson @a
39+
33isValid :: ParseResult a -> Bool
40isValid :: ParseResult a -> Bool
34isValid (Valid _) = True
41isValid (Valid _) = True
35isValid _ = False
42isValid _ = False
@@ -43,51 +50,51 @@ isValidationError (ValidationError _) = True
43isValidationError _ = False
50isValidationError _ = False
44
51
45validateTextConstraint
52validateTextConstraint
46− :: JSONPath
53+ :: JSONPathText
47 -> Text
54 -> Text
48 -> Sing (tcs :: TextConstraint)
55 -> Sing (tcs :: TextConstraint)
49 -> Validation ()
56 -> Validation ()
50−validateTextConstraint (JSONPath path) t = \case
57+validateTextConstraint (JSONPathText path) t = \case
51 STEq n -> do
58 STEq n -> do
52 let
59 let
53 nlen = withKnownNat n $ natVal n
60 nlen = withKnownNat n $ natVal n
54 predicate = nlen == (fromIntegral $ T.length t)
61 predicate = nlen == (fromIntegral $ T.length t)
55− errMsg = "length of " <> path <> " should be == " <> T.pack (show nlen)
62+ errMsg = "length should be == " <> T.pack (show nlen)
56 warn = vWarning $ mmSingleton path (pure errMsg)
63 warn = vWarning $ mmSingleton path (pure errMsg)
57 unless predicate warn
64 unless predicate warn
58 STLt n -> do
65 STLt n -> do
59 let
66 let
60 nlen = withKnownNat n $ natVal n
67 nlen = withKnownNat n $ natVal n
61− predicate = nlen < (fromIntegral $ T.length t)
68+ predicate = nlen > (fromIntegral $ T.length t)
62− errMsg = "length of " <> path <> " should be < " <> T.pack (show nlen)
69+ errMsg = "length should be < " <> T.pack (show nlen)
63 warn = vWarning $ mmSingleton path (pure errMsg)
70 warn = vWarning $ mmSingleton path (pure errMsg)
64 unless predicate warn
71 unless predicate warn
65 STLe n -> do
72 STLe n -> do
66 let
73 let
67 nlen = withKnownNat n $ natVal n
74 nlen = withKnownNat n $ natVal n
68− predicate = nlen <= (fromIntegral $ T.length t)
75+ predicate = nlen >= (fromIntegral $ T.length t)
69− errMsg = "length of " <> path <> " should be <= " <> T.pack (show nlen)
76+ errMsg = "length should be <= " <> T.pack (show nlen)
70 warn = vWarning $ mmSingleton path (pure errMsg)
77 warn = vWarning $ mmSingleton path (pure errMsg)
71 unless predicate warn
78 unless predicate warn
72 STGt n -> do
79 STGt n -> do
73 let
80 let
74 nlen = withKnownNat n $ natVal n
81 nlen = withKnownNat n $ natVal n
75− predicate = nlen > (fromIntegral $ T.length t)
82+ predicate = nlen < (fromIntegral $ T.length t)
76− errMsg = "length of " <> path <> " should be > " <> T.pack (show nlen)
83+ errMsg = "length should be > " <> T.pack (show nlen)
77 warn = vWarning $ mmSingleton path (pure errMsg)
84 warn = vWarning $ mmSingleton path (pure errMsg)
78 unless predicate warn
85 unless predicate warn
79 STGe n -> do
86 STGe n -> do
80 let
87 let
81 nlen = withKnownNat n $ natVal n
88 nlen = withKnownNat n $ natVal n
82− predicate = nlen >= (fromIntegral $ T.length t)
89+ predicate = nlen <= (fromIntegral $ T.length t)
83− errMsg = "length of " <> path <> " should be >= " <> T.pack (show nlen)
90+ errMsg = "length should be >= " <> T.pack (show nlen)
84 warn = vWarning $ mmSingleton path (pure errMsg)
91 warn = vWarning $ mmSingleton path (pure errMsg)
85 unless predicate warn
92 unless predicate warn
86 STRegex r -> do
93 STRegex r -> do
87 let
94 let
88 regex = withKnownSymbol r $ fromSing r
95 regex = withKnownSymbol r $ fromSing r
89 predicate = matchTest (makeRegex (T.unpack regex) :: Regex) (T.unpack t)
96 predicate = matchTest (makeRegex (T.unpack regex) :: Regex) (T.unpack t)
90− errMsg = path <> " must match " <> regex
97+ errMsg = "must match " <> regex
91 warn = vWarning $ mmSingleton path (pure errMsg)
98 warn = vWarning $ mmSingleton path (pure errMsg)
92 unless predicate warn
99 unless predicate warn
93 STEnum ss -> do
100 STEnum ss -> do
@@ -95,69 +102,97 @@ validateTextConstraint (JSONPath path) t = \case
95 matching :: Sing (s :: [Symbol]) -> Bool
102 matching :: Sing (s :: [Symbol]) -> Bool
96 matching SNil = False
103 matching SNil = False
97 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
98− errMsg = path <> " must be one of " <> T.pack (show (fromSing ss))
105+ errMsg = "must be one of " <> T.pack (show (fromSing ss))
99 warn = vWarning $ mmSingleton path (pure errMsg)
106 warn = vWarning $ mmSingleton path (pure errMsg)
100 unless (matching ss) warn
107 unless (matching ss) warn
101
108
102validateNumberConstraint
109validateNumberConstraint
103− :: JSONPath
110+ :: JSONPathText
104 -> Scientific
111 -> Scientific
105 -> Sing (tcs :: NumberConstraint)
112 -> Sing (tcs :: NumberConstraint)
106 -> Validation ()
113 -> Validation ()
107−validateNumberConstraint (JSONPath path) num = \case
114+validateNumberConstraint (JSONPathText path) num = \case
108 SNEq n -> do
115 SNEq n -> do
109 let
116 let
110 nlen = withKnownNat n $ natVal n
117 nlen = withKnownNat n $ natVal n
111 predicate = fromIntegral nlen == num
118 predicate = fromIntegral nlen == num
112− errMsg = path <> " should be == " <> T.pack (show nlen)
119+ errMsg = "should be == " <> T.pack (show nlen)
113 warn = vWarning $ mmSingleton path (pure errMsg)
120 warn = vWarning $ mmSingleton path (pure errMsg)
114 unless predicate warn
121 unless predicate warn
115 SNGt n -> do
122 SNGt n -> do
116 let
123 let
117 nlen = withKnownNat n $ natVal n
124 nlen = withKnownNat n $ natVal n
118 predicate = num > fromIntegral nlen
125 predicate = num > fromIntegral nlen
119− errMsg = path <> " should be > " <> T.pack (show nlen)
126+ errMsg = "should be > " <> T.pack (show nlen)
120 warn = vWarning $ mmSingleton path (pure errMsg)
127 warn = vWarning $ mmSingleton path (pure errMsg)
121 unless predicate warn
128 unless predicate warn
122 SNGe n -> do
129 SNGe n -> do
123 let
130 let
124 nlen = withKnownNat n $ natVal n
131 nlen = withKnownNat n $ natVal n
125 predicate = num >= fromIntegral nlen
132 predicate = num >= fromIntegral nlen
126− errMsg = path <> " should be >= " <> T.pack (show nlen)
133+ errMsg = "should be >= " <> T.pack (show nlen)
127 warn = vWarning $ mmSingleton path (pure errMsg)
134 warn = vWarning $ mmSingleton path (pure errMsg)
128 unless predicate warn
135 unless predicate warn
129 SNLt n -> do
136 SNLt n -> do
130 let
137 let
131 nlen = withKnownNat n $ natVal n
138 nlen = withKnownNat n $ natVal n
132− predicate = fromIntegral nlen < num
139+ predicate = num < fromIntegral nlen
133− errMsg = path <> " should be < " <> T.pack (show nlen)
140+ errMsg = "should be < " <> T.pack (show nlen)
134 warn = vWarning $ mmSingleton path (pure errMsg)
141 warn = vWarning $ mmSingleton path (pure errMsg)
135 unless predicate warn
142 unless predicate warn
136 SNLe n -> do
143 SNLe n -> do
137 let
144 let
138 nlen = withKnownNat n $ natVal n
145 nlen = withKnownNat n $ natVal n
139− predicate = fromIntegral nlen <= num
146+ predicate = num <= fromIntegral nlen
140− errMsg = path <> " should be <= " <> T.pack (show nlen)
147+ errMsg = "should be <= " <> T.pack (show nlen)
141 warn = vWarning $ mmSingleton path (pure errMsg)
148 warn = vWarning $ mmSingleton path (pure errMsg)
142 unless predicate warn
149 unless predicate warn
143
150
144validateArrayConstraint
151validateArrayConstraint
145− :: JSONPath
152+ :: JSONPathText
146 -> V.Vector a
153 -> V.Vector a
147 -> Sing (tcs :: ArrayConstraint)
154 -> Sing (tcs :: ArrayConstraint)
148 -> Validation ()
155 -> Validation ()
149−validateArrayConstraint (JSONPath path) v = \case
156+validateArrayConstraint (JSONPathText path) v = \case
150 SAEq n -> do
157 SAEq n -> do
151 let
158 let
152 nlen = withKnownNat n $ natVal n
159 nlen = withKnownNat n $ natVal n
153 predicate = nlen == fromIntegral (V.length v)
160 predicate = nlen == fromIntegral (V.length v)
154− 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)
155 warn = vWarning $ mmSingleton path (pure errMsg)
190 warn = vWarning $ mmSingleton path (pure errMsg)
156 unless predicate warn
191 unless predicate warn
157
192
158validateJsonRepr
193validateJsonRepr
159 :: Sing schema
194 :: Sing schema
160− -> [DemotedPathSegment]
195+ -> JSONPath
161 -> JsonRepr schema
196 -> JsonRepr schema
162 -> Validation ()
197 -> Validation ()
163validateJsonRepr sschema dpath jr = case jr of
198validateJsonRepr sschema dpath jr = case jr of
@@ -191,7 +226,7 @@ validateJsonRepr sschema dpath jr = case jr of
191 process cs
226 process cs
192 process acs
227 process acs
193 for_ (V.indexed v) $ \(ix, jr') -> do
228 for_ (V.indexed v) $ \(ix, jr') -> do
194− let newPath = dpath <> pure (DIx $ fromIntegral ix)
229+ let newPath = dpath <> pure (Index $ fromIntegral ix)
195 validateJsonRepr s newPath jr'
230 validateJsonRepr s newPath jr'
196 ReprOptional d -> case sschema of
231 ReprOptional d -> case sschema of
197 SSchemaOptional ss -> case d of
232 SSchemaOptional ss -> case d of
@@ -203,7 +238,7 @@ validateJsonRepr sschema dpath jr = case jr of
203 go :: Rec FieldRepr (ts :: [(Symbol, Schema)] ) -> Validation ()
238 go :: Rec FieldRepr (ts :: [(Symbol, Schema)] ) -> Validation ()
204 go RNil = pure ()
239 go RNil = pure ()
205 go (f@(FieldRepr d) :& ftl) = do
240 go (f@(FieldRepr d) :& ftl) = do
206− let newPath = dpath <> [DKey (knownFieldName f)]
241+ let newPath = dpath <> [Key (knownFieldName f)]
207 validateJsonRepr (knownFieldSchema f) newPath d
242 validateJsonRepr (knownFieldSchema f) newPath d
208 go ftl
243 go ftl
209 ReprUnion _ -> pure () -- FIXME
244 ReprUnion _ -> pure () -- FIXME
@@ -215,7 +250,7 @@ validateJsonRepr sschema dpath jr = case jr of
215 -- fail "impossible to produce subUnion, please report this as a bug"
250 -- fail "impossible to produce subUnion, please report this as a bug"
216 -- Just x -> do
251 -- Just x -> do
217 -- let
252 -- let
218− -- JSONPath path = demotedPathToText dpath
253+ -- JSONPathText path = demotedPathToText dpath
219 -- case stl of
254 -- case stl of
220 -- SNil -> void $ vWarning $ mmSingleton path
255 -- SNil -> void $ vWarning $ mmSingleton path
221 -- $ pure "union handling error, please report this as bug"
256 -- $ pure "union handling error, please report this as bug"
@@ -246,3 +281,26 @@ toUnion _ = ReprUnion . urelax
246
281
247umatch' :: UElem a as i => Sing a -> Union f as -> Maybe (f a)
282umatch' :: UElem a as i => Sing a -> Union f as -> Maybe (f a)
248umatch' _ u = umatch u
283umatch' _ 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−50
@@ -1,51 +1,6 @@
1−resolver: nightly-2017-09-17
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−- '.'
23−
24extra-deps:
2extra-deps:
25−- hjsonpointer-1.3.0
3+- hjsonpointer-1.4.0@rev:0
26−- hjsonschema-1.7.0
4+- hjsonschema-1.9.0@rev:0
27−- validationt-0.2.0.0
5+- git: https://github.com/typeable/validationt.git
28−
6+ commit: 97fea97c4015ab5e99f3efb2c73e1fef4b8857d8
29−# Override default flag values for local packages and extra-deps
30−flags: {}
31−
32−# Extra package databases containing global packages
33−extra-package-dbs: []
34−
35−# Control whether we use the GHC we find on the path
36−# system-ghc: true
37−#
38−# Require a specific version of stack, using version ranges
39−# require-stack-version: -any # Default
40−# require-stack-version: ">=1.4"
41−#
42−# Override the architecture used by stack, especially useful on Windows
43−# arch: i386
44−# arch: x86_64
45−#
46−# Extra directories used by stack for building
47−# extra-include-dirs: [/path/to/dir]
48−# extra-lib-dirs: [/path/to/dir]
49−#
50−# Allow a newer minor version of GHC than the snapshot specifies
51−# compiler-check: newer-minor
test/HelpersSpec.hs+6
@@ -1,5 +1,11 @@
1{-# OPTIONS_GHC -Wno-unticked-promoted-constructors #-}
1{-# OPTIONS_GHC -Wno-unticked-promoted-constructors #-}
2
2
3+{-# LANGUAGE LambdaCase #-}
4+
5+{-# LANGUAGE DataKinds #-}
6+{-# LANGUAGE TypeApplications #-}
7+{-# LANGUAGE OverloadedStrings #-}
8+
3module HelpersSpec (spec, main) where
9module HelpersSpec (spec, main) where
4
10
5import Control.Lens
11import Control.Lens
test/JsonSchemaSpec.hs+65
@@ -1,8 +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
4import Data.Maybe
11import Data.Maybe
5import Data.Proxy
12import Data.Proxy
13+import Data.ByteString.Lazy as B
6import Data.Schematic
14import Data.Schematic
7import Data.Vinyl
15import Data.Vinyl
8import JSONSchema.Draft4 as D4
16import JSONSchema.Draft4 as D4
@@ -24,6 +32,27 @@ exampleData = withRepr @SchemaExample $
24 :& field @"bar" (pure (ReprText "foo"))
32 :& field @"bar" (pure (ReprText "foo"))
25 :& RNil
33 :& RNil
26
34
35+type SchemaArrayExample = 'SchemaObject
36+ '[ '("a1", 'SchemaArray '[ 'AGt 1 ] ('SchemaNumber '[]))
37+ , '("a2", 'SchemaArray '[ 'AGe 1 ] ('SchemaNumber '[]))
38+ , '("a3", 'SchemaArray '[ 'ALt 1 ] ('SchemaNumber '[]))
39+ , '("a4", 'SchemaArray '[ 'ALe 1 ] ('SchemaNumber '[]))
40+ ]
41+
42+type SchemaNumberExample = 'SchemaObject
43+ '[ '("n1", 'SchemaNumber '[ 'NGt 1 ])
44+ , '("n2", 'SchemaNumber '[ 'NGe 1 ])
45+ , '("n3", 'SchemaNumber '[ 'NLt 1 ])
46+ , '("n4", 'SchemaNumber '[ 'NLe 1 ])
47+ ]
48+
49+type SchemaTextExample = 'SchemaObject
50+ '[ '("t1", 'SchemaText '[ 'TGt 1 ])
51+ , '("t2", 'SchemaText '[ 'TGe 1 ])
52+ , '("t3", 'SchemaText '[ 'TLt 1 ])
53+ , '("t4", 'SchemaText '[ 'TLe 1 ])
54+ ]
55+
27spec :: Spec
56spec :: Spec
28spec = do
57spec = do
29 it "validates simple schema" $ do
58 it "validates simple schema" $ do
@@ -31,6 +60,42 @@ spec = do
31 fetchHTTPAndValidate schema (toJSON exampleData) >>= \case
60 fetchHTTPAndValidate schema (toJSON exampleData) >>= \case
32 Left _ -> fail "failed to validate test example"
61 Left _ -> fail "failed to validate test example"
33 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 ()
34
99
35main :: IO ()
100main :: IO ()
36main = hspec spec
101main = hspec spec
test/LensSpec.hs+9−4
@@ -1,3 +1,8 @@
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
@@ -298,15 +303,15 @@ spec = do
298 newFooVal = FieldRepr $ ReprArray [ReprNumber 15]
303 newFooVal = FieldRepr $ ReprArray [ReprNumber 15]
299 fooProxy = Proxy @"foo"
304 fooProxy = Proxy @"foo"
300 it "gets the field from an object" $ do
305 it "gets the field from an object" $ do
301− fget fooProxy objectData `shouldBe` arrayField
306+ fget @"foo" objectData `shouldBe` arrayField
302 it "sets the object field" $ do
307 it "sets the object field" $ do
303− fget fooProxy (fput newFooVal objectData) `shouldBe` newFooVal
308+ fget @"foo" (fput newFooVal objectData) `shouldBe` newFooVal
304
309
305 describe "(using lens library) " $ do
310 describe "(using lens library) " $ do
306 it "get the field from an object" $ do
311 it "get the field from an object" $ do
307− objectData ^. flens (Proxy @"foo") `shouldBe` arrayField
312+ objectData ^. flens @"foo" `shouldBe` arrayField
308 it "sets the object field" $ do
313 it "sets the object field" $ do
309− set (flens (Proxy @"foo")) newFooVal objectData ^. flens (Proxy @"foo")
314+ set (flens @"foo") newFooVal objectData ^. flens @"foo"
310 `shouldBe` newFooVal
315 `shouldBe` newFooVal
311
316
312main :: IO ()
317main :: IO ()
test/SchemaSpec.hs+64−16
@@ -1,33 +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
14+import Control.Lens
5import Data.Aeson
15import Data.Aeson
6import Data.ByteString.Lazy
16import Data.ByteString.Lazy
7import Data.Functor.Identity
17import Data.Functor.Identity
8import Data.Proxy
18import Data.Proxy
9import Data.Schematic
19import Data.Schematic
20+import Data.Schematic.Generator
21+import Data.Singletons
10import Data.Tagged
22import Data.Tagged
11import Data.Vinyl
23import Data.Vinyl
12import 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
13
29
30+import Debug.Trace
14
31
15type SchemaExample = 'SchemaObject
32type SchemaExample = 'SchemaObject
16 '[ '("foo", 'SchemaArray '[ 'AEq 1] ('SchemaNumber '[ 'NGt 10]))
33 '[ '("foo", 'SchemaArray '[ 'AEq 1] ('SchemaNumber '[ 'NGt 10]))
17 , '("bar", 'SchemaOptional ('SchemaText '[ 'TEnum '["foo", "bar"]]))]
34 , '("bar", 'SchemaOptional ('SchemaText '[ 'TEnum '["foo", "bar"]]))]
18
35
36+type SchemaExample2 = 'SchemaObject
37+ '[ '("foo", 'SchemaArray '[ 'AEq 2] ('SchemaText '[ 'TGt 10]))
38+ , '("bar", 'SchemaOptional ('SchemaText '[ 'TRegex "[0-9]+"]))]
39+
19jsonExample :: JsonRepr SchemaExample
40jsonExample :: JsonRepr SchemaExample
20jsonExample = withRepr @SchemaExample
41jsonExample = withRepr @SchemaExample
21 $ field @"bar" (Just "bar")
42 $ field @"bar" (Just "bar")
22 :& field @"foo" [12]
43 :& field @"foo" [12]
23 :& RNil
44 :& RNil
24
45
25−type TestMigration =
46+type AddQuuz =
26− 'Migration "test_revision"
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"
27− '[ 'Diff '[ 'PKey "bar" ] ('Update ('SchemaText '[]))
56+ '[ 'Diff '[ 'PKey "bar" ] ('Update
57+ ('SchemaArray '[ 'AEq 1] ('SchemaNumber '[ 'NGt 10])))
28− , 'Diff '[ 'PKey "foo" ] ('Update ('SchemaNumber '[])) ]
58+ , 'Diff '[ 'PKey "foo" ] ('Update
59+ ('SchemaOptional ('SchemaText '[ 'TEnum '["foo", "bar"]]))) ]
29
60
61+type Migrations = '[ AddQuuz
62+ , DeleteQuuz ]
63+ -- , SwapFields ]
64+
30−type VS = 'Versioned SchemaExample '[ TestMigration ]
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)
74+ -- :& RNil))
75+ :&& MNil
31
76
32schemaJson :: ByteString
77schemaJson :: ByteString
33schemaJson = "{\"foo\": [13], \"bar\": null}"
78schemaJson = "{\"foo\": [13], \"bar\": null}"
@@ -35,15 +80,11 @@ schemaJson = "{\"foo\": [13], \"bar\": null}"
35schemaJson2 :: ByteString
80schemaJson2 :: ByteString
36schemaJson2 = "{\"foo\": [3], \"bar\": null}"
81schemaJson2 = "{\"foo\": [3], \"bar\": null}"
37
82
38−topObject
83+schemaJsonSeries :: Monad m => SC.Series m (JsonRepr SchemaExample)
39− :: JsonRepr
84+schemaJsonSeries = series
40− ('SchemaObject
85+
41− '[ '("foo", 'SchemaNumber '[])
86+schemaJsonSeries2 :: Monad m => SC.Series m (JsonRepr SchemaExample2)
42− , '("bar", 'SchemaText '[])])
87+schemaJsonSeries2 = series
43−topObject = ReprObject $
44− FieldRepr (ReprNumber 42)
45− :& FieldRepr (ReprText "test")
46− :& RNil
47
88
48spec :: Spec
89spec :: Spec
49spec = do
90spec = do
@@ -65,10 +106,17 @@ spec = do
65 -- `shouldSatisfy` isValid
106 -- `shouldSatisfy` isValid
66 it "validates versioned json with a migration list" $ do
107 it "validates versioned json with a migration list" $ do
67 decodeAndValidateVersionedWithPureMList
108 decodeAndValidateVersionedWithPureMList
68− (Proxy @VS)
109+ (Proxy @VersionedJson)
69− (Tagged (const $ Identity topObject) :&& MNil)
110+ migrationList
70 schemaJson
111 schemaJson
71 `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+
72
120
73main :: IO ()
121main :: IO ()
74main = hspec spec
122main = hspec spec