git.iko.soy/typeable/schematic
on 5356a27 help sign in
7db0b46
swap
0 ahead, 92 behind
31 files changed+465−1901
since splitsnapshots
unifiedsplit
.travis.yml+2−2 ChangeLog.md−53 README.md+26−145 release−43 release.nix−32 schematic.cabal+47−33 src/Data/Schematic.hs+34−12 src/Data/Schematic/DSL.hs−92 src/Data/Schematic/Generator.hs−91 src/Data/Schematic/Generator/Regex.hs−76 src/Data/Schematic/Helpers.hs−59 src/Data/Schematic/Instances.hs−4 src/Data/Schematic/JsonSchema.hs+37−86 src/Data/Schematic/Lens.hs+27−168 src/Data/Schematic/Migration.hs+8−45 src/Data/Schematic/Path.hs+32−18 src/Data/Schematic/Schema.hs+74−211 src/Data/Schematic/Schema.hs-boot−95 src/Data/Schematic/Utils.hs+42 src/Data/Schematic/Validation.hs+33−132 src/Data/Schematic/Verifier.hs−5 src/Data/Schematic/Verifier/Array.hs−14 src/Data/Schematic/Verifier/Common.hs−43 src/Data/Schematic/Verifier/Number.hs−31 src/Data/Schematic/Verifier/Text.hs−121 stack-13.21.yaml−7 stack.yaml+52−5 test/HelpersSpec.hs−124 test/JsonSchemaSpec.hs+11−69 test/LensSpec.hs+13−12 test/SchemaSpec.hs+27−73
.travis.yml+2−2
@@ -1,4 +1,4 @@
1−sudo: required
1+sudo: false
22
33language: c
44
@@ -22,4 +22,4 @@ script:
2222
2323cache:
2424 directories:
25− - $HOME/.stack
25+ - $HOME/.stack
ChangeLog.md−53
@@ -1,58 +1,5 @@
11# Revision history for schematic
22
3−## 0.6.0.0 -- 2021-01-15
4−
5−Added compatability with aeson-1.4.3.0. Since version 1.4.3 the module `Data.Aeson` started exporting `JSONPath`, which was conflicting with our own `JSONPath`. Furthermore, started using `JSONPathElement` from `aeson` instead of `DemotedPathSegment`.
6−
7−## 0.5.1.0 -- 2021-01-15
8−
9−Fix the generation of json schema for numbers.
10−Add array constraints.
11−Fix the generation of text and number constraints.
12−Remove jsonpath from the error message.
13−
14−## 0.5.0.0 -- 2019-02-20
15−
16−GHC 8.6, json generation by schema definition, validation bug fixes, better
17−parsing error messages.
18−
19−## 0.4.3.0 -- 2018-07-12
20−
21−GHC 8.4 support, dropping support for older GHC versions
22−
23−## 0.4.2.0
24−
25−Support ghc-8.4 and drop support for older versions
26−
27−## 0.4.1.0 -- 2017-11-05
28−
29−Convenience isomorphisms: txt, num, opt, bln etc
30−
31−## 0.4.1.0 -- 2017-11-01
32−
33−flens and fget now use type application syntax
34−
35−## 0.4.0.0 -- 2017-10-17
36−
37−Object building DSL, more convenience helpers, MCons simplified with Tagged
38−
39−## 0.3.2.0 -- 2017-10-02
40−
41−Fixed FIndex bug, added bunch of convenience isomorphism, re-exports.
42−
43−## 0.3.1.0 -- 2017-09-28
44−
45−Add UUID and ISO8601 helpers, json schema constraint export, fsubset lens
46−combinator.
47−
48−## 0.3.0.0 -- 2017-09-28
49−
50−Updated to GHC 8.2.1 and singletons 2.3.1
51−
52−## 0.2.1.0 -- 2017-09-26
53−
54−Add decodeAndValidateVersionedWithPureMList, fix tests
55−
563## 0.2.0.0 -- 2017-09-26
574
585Migratable is deprecated, migrations are now possible in an arbitrary monad.
README.md+26−145
@@ -22,35 +22,9 @@ Be aware that library is experimental and subject to change a lot. The current s
2222$ stack install schematic
2323```
2424
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:
29−
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−
5125## Basic Examples
5226
53−```haskell
27+```
5428type SchemaExample
5529 = SchemaObject
5630 '[ '("foo", SchemaArray '[AEq 1] (SchemaNumber '[NGt 10]))
@@ -68,21 +42,21 @@ type SchemaExample
6842
6943This one is valid for example
7044
71−```haskell
45+```
7246schemaJson :: ByteString
7347schemaJson = "{\"foo\": [13], \"bar\": null}"
7448```
7549
7650Also valid
7751
78−```haskell
52+```
7953schemaJson :: ByteString
8054schemaJson = "{\"foo\": [13], \"bar\": \"bar\"}"
8155```
8256
8357it can be parsed and validated like this:
8458
85−```haskell
59+```
8660decodeAndValidateJson schemaJson :: ParseResult (JsonRepr SchemaExample)
8761```
8862
@@ -92,64 +66,24 @@ decodeAndValidateJson schemaJson :: ParseResult (JsonRepr SchemaExample)
9266* some of the runtime validations have failed, but it's structurally correct
9367 overall
9468
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−```
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.
10670
107−The most basic and sugar-free way of constructing the same object will look like this:
10871
10972```
110−jsonExample' :: JsonRepr SchemaExample
111−jsonExample' = ReprObject $
73+jsonExample :: JsonRepr SchemaExample
74+jsonExample = ReprObject $
11275 FieldRepr (ReprArray [ReprNumber 12])
11376 :& FieldRepr (ReprOptional (Just (ReprText "bar")))
11477 :& RNil
11578```
11679
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−
13880## Migrations
13981
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,
147−which describes a series of json-path/change pairs. Migrations can be applied in
148−succession.
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.
14983
15084This piece of code will apply a migration to the schema, decode and validate the latest version.
15185
152−```haskell
86+```
15387type SchemaExample
15488 = SchemaObject
15589 '[ '("foo", SchemaArray '[AEq 1] (SchemaNumber '[NGt 10]))
@@ -157,8 +91,8 @@ type SchemaExample
15791
15892type TestMigration =
15993 'Migration "test_revision"
160− '[ Diff '[ PKey "bar" ] (Update (SchemaText '[]))
161− , Diff '[ PKey "foo" ] (Update (SchemaNumber '[])) ]
94+ '[ 'Diff '[ 'PKey "bar" ] ('Update ('SchemaText '[]))
95+ , 'Diff '[ 'PKey "foo" ] ('Update ('SchemaNumber '[])) ]
16296
16397type VS = 'Versioned SchemaExample '[ TestMigration ]
16498
@@ -172,84 +106,31 @@ It's possible to decode the latest version like this:
172106decodeAndValidateJson schemaJsonTopVersion :: ParseResult (JsonRepr (TopVersion (AllVersions VS)))
173107```
174108
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:
180−
181−```haskell
182−type SchemaExample = 'SchemaObject
183− '[ '("foo", 'SchemaArray '[ 'AEq 1] ('SchemaNumber '[ 'NGt 10]))
184− , '("bar", 'SchemaOptional ('SchemaText '[ 'TEnum '["foo", "bar"]]))]
185−
186−jsonExample :: JsonRepr SchemaExample
187−jsonExample = withRepr @SchemaExample
188− $ field @"bar" (Just "bar")
189− :& field @"foo" [12]
190− :& RNil
191−
192−type AddQuuz =
193− 'Migration "add_field_quuz"
194− '[ 'Diff '[] ('AddKey "quuz" (SchemaNumber '[])) ]
195−
196−type DeleteQuuz =
197− 'Migration "remove_field_quuz"
198− '[ 'Diff '[] ( 'DeleteKey "quuz") ]
199−
200−type Migrations = '[ AddQuuz
201− , DeleteQuuz ]
202−
203−type VersionedJson = 'Versioned SchemaExample Migrations
109+## Lens-compatibility
204110
205−migrationList :: MigrationList Identity VersionedJson
206−migrationList
207− = (migrateObject (\r -> Identity $ field @"quuz" 42 :& r))
208− :&& shrinkObject
209− :&& MNil
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:
210112
211113```
114+type ArraySchema = 'SchemaArray '[AEq 1] ('SchemaNumber '[NGt 10])
212115
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.
223−
224−## How do I construct a value of `JsonRepr schema`?
116+type ArrayField = '("foo", ArraySchema)
225117
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:
118+type FieldsSchema =
119+ '[ ArrayField, '("bar", 'SchemaOptional ('SchemaText '[TEnum '["foo", "bar"]]))]
232120
233−```haskell
234−type SchemaExample = 'SchemaObject
235− '[ '("foo", SchemaArray '[ AEq 1] (SchemaNumber '[NGt 10]))
236− , '("bar", SchemaOptional (SchemaText '[TEnum '["foo", "bar"]]))]
121+type SchemaExample = 'SchemaObject FieldsSchema
237122
238−jsonExample = withRepr @SchemaExample
239− $ field @"bar" (Just "bar")
240− :& field @"foo" [12]
241− :& RNil
242123```
243124
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.
125+There are two ways of working with named fields in the objects:
126+
127+* Using the `fget` and `fset` functions: `fget fooProxy (fput newFooVal objectData) == newFooVal`
128+* Using the lens library: `set (flens (Proxy @"foo")) newFooVal objectData ^. flens (Proxy @"foo") == newFooVal`
247129
248−[GHC Type Applications](https://ghc.haskell.org/trac/ghc/wiki/TypeApplication)
130+## Export to json-schema (draft 4)
249131
250−`schematic` provides instances for `OverloadedLists` and `OverloadedStrings`
251−GHC extensions to make use of string and list literals for values in a previous
252−example.
253132
133+## TODO
254134
255−## Export to json-schema (draft 4)
135+* Overall user friendliness
136+* Versioned http endpoints
releasedeleted−43
@@ -1,43 +0,0 @@
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.nixdeleted−32
@@ -1,32 +0,0 @@
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+47−33
@@ -1,37 +1,32 @@
1+-- Initial schematic.cabal generated by cabal init. For further
2+-- documentation, see http://haskell.org/cabal/users-guide/
3+
14name: schematic
2−version: 0.6.0.0
5+version: 0.2.0.0
36synopsis: 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.
7+-- description:
58license: BSD3
69license-file: LICENSE
710author: Denis Redozubov
811maintainer: denis.redozubov@gmail.com
9−homepage: http://github.com/typeable/schematic
10−Bug-reports: http://github.com/typeable/schematic/issues/
12+-- copyright:
1113category: Data
1214build-type: Simple
13−extra-source-files: ChangeLog.md, README.md
15+extra-source-files: ChangeLog.md
1416cabal-version: >=1.10
1517
1618library
1719 exposed-modules: Data.Schematic
18− , Data.Schematic.DSL
19− , Data.Schematic.Generator
20− , Data.Schematic.Generator.Regex
2120 , Data.Schematic.Instances
2221 , Data.Schematic.JsonSchema
23− , Data.Schematic.Helpers
2422 , Data.Schematic.Lens
2523 , Data.Schematic.Migration
2624 , Data.Schematic.Path
2725 , Data.Schematic.Schema
2826 , 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
27+ , Data.Schematic.Utils
3428 ghc-options: -Wall
29+ -- other-modules:
3530 default-extensions: ConstraintKinds
3631 , DataKinds
3732 , DefaultSignatures
@@ -65,24 +60,21 @@ library
6560 , TypeOperators
6661 , TypeSynonymInstances
6762 , UndecidableInstances
68− build-depends: base >=4.11 && <5
63+ build-depends: base >=4.9 && <4.10
6964 , bytestring
70− , aeson >= 1.4.3.0 && < 1.6
65+ , aeson >= 1
7166 , containers
7267 , hjsonschema
7368 , mtl
74− , profunctors
75− , regex-tdfa
76− , regex-tdfa-text
69+ , regex-compat
7770 , scientific
78− , singletons >= 2.4
71+ , singletons >= 2.2
7972 , smallcheck
73+ , smallcheck-series
8074 , tagged
81− , template-haskell
8275 , text
83− , union
8476 , unordered-containers
85− , validationt >= 0.2.1.0
77+ , validationt >= 0.1.0.1
8678 , vector
8779 , vinyl
8880 hs-source-dirs: src
@@ -93,9 +85,36 @@ test-suite spec
9385 hs-source-dirs: test
9486 main-is: Spec.hs
9587 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
96115 build-depends: HUnit
97116 , aeson >= 1
98− , base >=4.11 && <4.13
117+ , base >=4.9 && <4.10
99118 , bytestring
100119 , containers
101120 , hjsonschema
@@ -104,21 +123,16 @@ test-suite spec
104123 , hspec-discover
105124 , hspec-smallcheck
106125 , lens
107− , regex-tdfa
108− , regex-tdfa-text
126+ , regex-compat
109127 , schematic
110128 , smallcheck
129+ , smallcheck-series
111130 , singletons
112131 , tagged
113132 , text
114133 , unordered-containers
115− , validationt >= 0.2.1.0
134+ , validationt >= 0.1.0.1
116135 , vinyl
117136 other-modules: SchemaSpec
118− , HelpersSpec
119137 , LensSpec
120− , JsonSchemaSpec
121−
122−source-repository head
123− type: git
124− location: https://github.com/typeable/schematic
138+ , JsonSchemaSpec
src/Data/Schematic.hs+34−12
@@ -3,10 +3,10 @@
33
44module Data.Schematic
55 ( module Data.Schematic.JsonSchema
6− , module Data.Schematic.Helpers
6+ , module Data.Schematic.Schema
77 , module Data.Schematic.Lens
88 , module Data.Schematic.Migration
9− , module Data.Schematic.Schema
9+ , module Data.Schematic.Utils
1010 , decodeAndValidateJson
1111 , parseAndValidateJson
1212 , parseAndValidateJsonBy
@@ -18,27 +18,46 @@ module Data.Schematic
1818 , isDecodingError
1919 , isValidationError
2020 , ParseResult(..)
21− , withRepr
22− , field
2321 ) where
2422
2523import Control.Monad.Validation
2624import Data.Aeson as J
2725import Data.Aeson.Types as J
2826import Data.ByteString.Lazy as BL
29−import Data.Functor.Identity as F
30−import Data.Schematic.DSL
31−import Data.Schematic.Helpers
27+import Data.Functor.Identity
3228import Data.Schematic.JsonSchema
3329import Data.Schematic.Lens
3430import Data.Schematic.Migration
3531import Data.Schematic.Schema
32+import Data.Schematic.Utils
3633import Data.Schematic.Validation
37−import Data.Singletons.Prelude hiding ((:.))
38−import Data.Tagged
34+import Data.Singletons.Prelude
3935import Data.Text as T
4036
4137
38+parseAndValidateJson
39+ :: forall schema
40+ . (J.FromJSON (JsonRepr schema), TopLevel schema, SingI schema)
41+ => J.Value
42+ -> ParseResult (JsonRepr schema)
43+parseAndValidateJson v =
44+ case parseEither parseJSON v of
45+ Left s -> DecodingError $ T.pack s
46+ Right jsonRepr ->
47+ let
48+ validate = validateJsonRepr (sing :: Sing schema) [] jsonRepr
49+ res = runIdentity . runValidationTEither $ validate
50+ in case res of
51+ Left em -> ValidationError em
52+ Right () -> Valid jsonRepr
53+
54+parseAndValidateJsonBy
55+ :: (J.FromJSON (JsonRepr schema), TopLevel schema, SingI schema)
56+ => proxy schema
57+ -> J.Value
58+ -> ParseResult (JsonRepr schema)
59+parseAndValidateJsonBy _ = parseAndValidateJson
60+
4261parseAndValidateTopVersionJson
4362 :: forall proxy (v :: Versioned)
4463 . (SingI (TopVersion (AllVersions v)))
@@ -63,8 +82,7 @@ parseAndValidateWithMList
6382 -> J.Value
6483 -> m (ParseResult (JsonRepr (Head revisions)))
6584parseAndValidateWithMList MNil v = pure $ parseAndValidateJson v
66−parseAndValidateWithMList (Tagged f :&& tl) v =
67− case parseAndValidateJsonBy Proxy v of
85+parseAndValidateWithMList ((:&&) p f tl) v = case parseAndValidateJsonBy p v of
6886 Valid a -> pure $ Valid a
6987 DecodingError _ -> do
7088 pr <- parseAndValidateWithMList tl v
@@ -84,6 +102,10 @@ decodeAndValidateJson bs = case decode bs of
84102 Nothing -> DecodingError "malformed json"
85103 Just x -> parseAndValidateJson x
86104
105+type family MapSnd (l :: [(a,k)]) = (r :: [k]) where
106+ MapSnd '[] = '[]
107+ MapSnd ( '(a, b) ': tl) = b ': MapSnd tl
108+
87109decodeAndValidateVersionedWithMList
88110 :: Monad m
89111 => proxy versioned
@@ -96,7 +118,7 @@ decodeAndValidateVersionedWithMList _ mlist bs = case decode bs of
96118
97119decodeAndValidateVersionedWithPureMList
98120 :: proxy versioned
99− -> MList F.Identity (MapSnd (AllVersions versioned))
121+ -> MList Identity (MapSnd (AllVersions versioned))
100122 -> BL.ByteString
101123 -> ParseResult (JsonRepr (Head (MapSnd (AllVersions versioned))))
102124decodeAndValidateVersionedWithPureMList a b c =
src/Data/Schematic/DSL.hsdeleted−92
@@ -1,92 +0,0 @@
1−{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# LANGUAGE CPP #-}
3−
4−module Data.Schematic.DSL where
5−
6−import Data.Kind
7−import Data.Schematic.Lens
8−import Data.Schematic.Schema
9−import Data.Scientific
10−import Data.Singletons
11−import Data.Singletons.Prelude hiding ((:.))
12−import Data.Singletons.TypeLits
13−import Data.Tagged
14−import Data.Text as T
15−import Data.Union
16−import qualified Data.Vector as V
17−import Data.Vinyl
18−import Data.Vinyl.Functor
19−
20−
21−#if MIN_VERSION_base(4,12,0)
22−type Constructor a
23− = forall fields b
24− . (fields ~ FieldsOf a, FSubset fields b (FImage fields b), RMap fields)
25− => Rec (Tagged fields :. FieldRepr) b
26− -> JsonRepr ('SchemaObject fields)
27−#else
28−type Constructor a
29− = forall fields b
30− . (fields ~ FieldsOf a, FSubset fields b (FImage fields b))
31− => Rec (Tagged fields :. FieldRepr) b
32− -> JsonRepr ('SchemaObject fields)
33−#endif
34−withRepr :: Constructor a
35−withRepr = ReprObject . rmap (unTagged . getCompose) . fcast
36−
37−class Representable s where
38− constructField :: Sing fn -> Proxy s -> Repr s -> FieldRepr '(fn, s)
39−
40−instance SingI so => Representable ('SchemaObject so) where
41− constructField sfn _ o = withKnownSymbol sfn $ FieldRepr $ ReprObject o
42−
43−instance (SingI cs, SingI sa) => Representable ('SchemaArray cs sa) where
44− constructField sfn _ a = withKnownSymbol sfn $ FieldRepr $ ReprArray a
45−
46−instance SingI cs => Representable ('SchemaText cs) where
47− constructField sfn _ t = withKnownSymbol sfn $ FieldRepr $ ReprText t
48−
49−instance SingI cs => Representable ('SchemaNumber cs) where
50− constructField sfn _ n = withKnownSymbol sfn $ FieldRepr $ ReprNumber n
51−
52−instance Representable 'SchemaBoolean where
53− constructField sfn _ b = withKnownSymbol sfn $ FieldRepr $ ReprBoolean b
54−
55−instance SingI so => Representable ('SchemaOptional so) where
56− constructField sfn _ o = withKnownSymbol sfn $ FieldRepr $ ReprOptional o
57−
58−instance SingI (h ': tl) => Representable ('SchemaUnion (h ': tl)) where
59− constructField sfn _ u = withKnownSymbol sfn $ FieldRepr $ ReprUnion u
60−
61−construct :: Sing s -> Repr s -> JsonRepr s
62−construct s r = case s of
63− SSchemaObject _ -> ReprObject r
64− SSchemaArray _ _ -> ReprArray r
65− SSchemaText _ -> ReprText r
66− SSchemaNumber _ -> ReprNumber r
67− SSchemaBoolean -> ReprBoolean r
68− SSchemaOptional _ -> ReprOptional r
69− SSchemaNull -> ReprNull
70− SSchemaUnion ss -> case ss of
71− SNil -> error "unconstructable union"
72− SCons _ _ -> ReprUnion r
73−
74−type family FieldsOf (s :: Schema) :: [(Symbol, Schema)] where
75− FieldsOf ('SchemaObject fs) = fs
76−
77−type FieldConstructor fn =
78− forall byField fs. (byField ~ ByField fn fs (FIndex fn fs), Representable byField)
79− => Repr byField
80− -> (Tagged fs :. FieldRepr) '(fn, byField)
81−
82−field :: forall fn. KnownSymbol fn => FieldConstructor fn
83−field = Compose . Tagged . constructField (sing :: Sing fn) Proxy
84−
85−type family Repr (s :: Schema) = (ty :: Type) where
86− Repr ('SchemaObject so) = Rec FieldRepr so
87− Repr ('SchemaArray cs sa) = V.Vector (JsonRepr sa)
88− Repr ('SchemaText cs) = Text
89− Repr ('SchemaNumber cs) = Scientific
90− Repr 'SchemaBoolean = Bool
91− Repr ('SchemaOptional so) = Maybe (JsonRepr so)
92− Repr ('SchemaUnion (h ': tl)) = Union JsonRepr (h ': tl)
src/Data/Schematic/Generator.hsdeleted−91
@@ -1,91 +0,0 @@
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.hsdeleted−76
@@ -1,76 +0,0 @@
1−module Data.Schematic.Generator.Regex where
2−
3−import Control.Monad
4−import Data.List
5−import Data.Maybe
6−import qualified Data.Set as S
7−import Data.Text (Text, unpack)
8−import Data.Text.Lazy (toStrict)
9−import Data.Text.Lazy.Builder (Builder, singleton, toLazyText)
10−import Test.SmallCheck.Series
11−import Text.Regex.TDFA.Pattern
12−import Text.Regex.TDFA.ReadRegex (parseRegex)
13−
14−
15−minRepeat :: Int
16−minRepeat = 2
17−
18−maxRepeat :: Int
19−maxRepeat = 10
20−
21−regexSeries :: (Monad m) => Text -> Series m Text
22−regexSeries regexp =
23− case parseRegex . unpack $ regexp of
24− Right (p, _) -> toStrict . toLazyText <$> regexSeries' p
25− Left _ -> pure ""
26−
27−regexSeries' :: (Monad m) => Pattern -> Series m Builder
28−regexSeries' pt =
29− case pt of
30− PEmpty -> pure mempty
31− PChar {..} -> pure $ singleton getPatternChar
32− PAny {getPatternSet = PatternSet (Just cset) _ _ _} -> do
33− x <- generate $ \depth -> take depth $ S.toList cset
34− pure $ singleton x
35− PAnyNot {getPatternSet = PatternSet (Just cset) _ _ _} -> do
36− x <-
37− generate $ \depth ->
38− take depth $ notChars $ concatMap expandEscape $ S.toList cset
39− pure $ singleton x
40− PQuest p -> regexSeries' p \/ pure mempty
41− PPlus p -> regexSeries' $ PBound 1 Nothing p
42− PStar _ p -> regexSeries' $ PBound 0 Nothing p
43− PBound low mhigh p -> do
44− let high = fromMaybe (low + maxRepeat) mhigh
45− n <- generate $ \depth -> take depth [low .. high]
46− decDepth $ do
47− ps <- replicateM n $ regexSeries' p
48− pure $ mconcat ps
49− PConcat ps -> mconcat <$> mapM regexSeries' ps
50− POr xs -> regexSeries' =<< (generate $ \depth -> take depth xs)
51− PDot _ -> do
52− x <- generate $ \depth -> take depth $ notChars []
53− pure $ singleton x
54− PEscape {..} -> do
55− x <- generate $ \depth -> take depth $ expandEscape getPatternChar
56− pure $ singleton x
57− PCarat _ -> pure mempty
58− PDollar _ -> pure mempty
59− _ -> pure mempty
60− where
61− notChars = ([' ' .. '~'] \\)
62− expandEscape ch =
63− case ch of
64− 'n' -> "\n"
65− 't' -> "\t"
66− 'r' -> "\r"
67− 'f' -> "\f"
68− 'a' -> "\a"
69− 'e' -> "\ESC"
70− 'd' -> ['0' .. '9']
71− 'w' -> ['0' .. '9'] ++ '_' : ['a' .. 'z'] ++ ['A' .. 'Z']
72− 's' -> "\9\32"
73− 'D' -> notChars $ ['0' .. '9']
74− 'W' -> notChars $ ['0' .. '9'] ++ '_' : ['a' .. 'z'] ++ ['A' .. 'Z']
75− 'S' -> notChars "\9\32"
76− ch' -> [ch']
src/Data/Schematic/Helpers.hsdeleted−59
@@ -1,59 +0,0 @@
1−module Data.Schematic.Helpers where
2−
3−import Data.Schematic.Schema
4−import GHC.TypeLits
5−
6−
7−type UUIDRegex =
8− 'TRegex "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
9−
10−type IsUUID = '[UUIDRegex]
11−
12−-- [ "1985-04-12T23:20:50.52Z"
13−-- , "1996-12-19T16:39:57-08:00"
14−-- , "1990-12-31T23:59:60Z"
15−-- , "1990-12-31T15:59:60-08:00"
16−-- , "1937-01-01T12:00:27.87+00:20"
17−-- ]
18−
19−-- components
20−type ISO8601Date = "[1-9][0-9]{3}-(0[1-9]|1[0-2])-([0-2][0-9]|3[0-1])"
21−
22−type ISO8601Time = "([0-1][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]"
23−
24−type ISO8601DateTime =
25− AppendSymbol
26− ISO8601Date
27− (AppendSymbol "(T" (AppendSymbol ISO8601Time ")?"))
28−
29−type ISO8601UTC = "(Z|\\+00:00)"
30−
31−type ISO8601DateTimeUTC =
32− AppendSymbol ISO8601Date (AppendSymbol "T" (AppendSymbol ISO8601Time ISO8601UTC))
33−
34−type ISO8601TZ = "\\+[0-1][0-9]:[0-6][0-9]"
35−
36−type ISO8601DateTimeZoned =
37− AppendSymbol ISO8601Date (AppendSymbol "T" (AppendSymbol ISO8601Time ISO8601TZ))
38−
39−-- regexes
40−type ISO8601DateRegex = 'TRegex ISO8601Date
41−
42−type ISO8601TimeRegex = 'TRegex ISO8601Time
43−
44−type ISO8601DateTimeRegex = 'TRegex ISO8601DateTime
45−
46−type ISO8601DateTimeRegexUTC = 'TRegex ISO8601DateTimeUTC
47−
48−type ISO8601DateTimeRegexZoned = 'TRegex ISO8601DateTimeZoned
49−
50−-- constraints
51−type IsDate = '[ISO8601DateRegex]
52−
53−type IsTime = '[ISO8601TimeRegex]
54−
55−type IsDateTime = '[ISO8601DateTimeRegex]
56−
57−type IsZonedDateTime = '[ISO8601DateTimeRegexZoned]
58−
59−type IsUTCDateTime = '[ISO8601DateTimeRegexUTC]
src/Data/Schematic/Instances.hs−4
@@ -4,7 +4,6 @@
44module Data.Schematic.Instances where
55
66import Data.Scientific
7−import Data.Text (Text, pack)
87import Data.Vector as V
98import Data.Vinyl
109import Test.SmallCheck.Series
@@ -22,6 +21,3 @@ instance Serial m a => Serial m (V.Vector a) where
2221
2322instance Monad m => Serial m Scientific where
2423 series = scientific <$> series <*> series
25−
26−instance Monad m => Serial m Text where
27− series = pack <$> series
src/Data/Schematic/JsonSchema.hs+37−86
@@ -1,7 +1,6 @@
11{-# LANGUAGE AllowAmbiguousTypes #-}
22{-# LANGUAGE RecordWildCards #-}
33{-# LANGUAGE OverloadedLabels #-}
4−{-# LANGUAGE TemplateHaskell #-}
54
65module Data.Schematic.JsonSchema
76 ( toJsonSchema
@@ -9,116 +8,68 @@ module Data.Schematic.JsonSchema
98 ) where
109
1110import Control.Monad.State.Strict
12−import Data.Aeson as J
13−import Data.Foldable as F
11+import Data.Foldable
1412import Data.HashMap.Strict as H
15−import Data.List as L
16−import Data.List.NonEmpty as NE
13+import Data.List.NonEmpty
1714import Data.Schematic.Schema as S
18−import Data.Set as Set
1915import Data.Singletons
2016import Data.Text
21−import Data.Traversable
2217import JSONSchema.Draft4.Schema as D4
2318import JSONSchema.Validator.Draft4 as D4
2419
2520
2621draft4 :: Text
27−draft4 = "http://json-schema.org/draft-04/schema#"
22+draft4 = "http://Jason-schema.org/draft-04/schema#"
2823
24+-- FIXME: implement all this later
2925textConstraint :: DemotedTextConstraint -> State D4.Schema ()
30−textConstraint (DTEq n) = modify $ \s -> s
31− { _schemaMinLength = pure $ fromIntegral n
32− , _schemaMaxLength = pure $ fromIntegral n }
33−textConstraint (DTLe n) = modify $ \s -> s
34− { _schemaMaxLength = pure . fromIntegral $ n }
35−textConstraint (DTLt n) =
36− let n' = if n == 0 then 0 else n - 1
37− in modify $ \s -> s { _schemaMaxLength = pure . fromIntegral $ n' }
38−textConstraint (DTGt n) = modify $ \s -> s
39− { _schemaMinLength = pure . fromIntegral $ n + 1 }
40−textConstraint (DTGe n) = modify $ \s -> s
41− { _schemaMinLength = pure . fromIntegral $ n }
42−textConstraint (DTRegex r) = modify $ \s -> s { _schemaPattern = pure r }
43−textConstraint (DTEnum ss) =
44− let ss' = if F.length ss == 0 then [] else NE.fromList $ J.String <$> ss
45− in modify $ \s -> s { _schemaEnum = pure ss' }
26+textConstraint (DTEq _) = pure ()
27+textConstraint (DTLt _) = pure ()
28+textConstraint (DTLe _) = pure ()
29+textConstraint (DTGt _) = pure ()
30+textConstraint (DTGe _) = pure ()
31+textConstraint (DTRegex _) = pure ()
32+textConstraint (DTEnum _) = pure ()
4633
4734numberConstraint :: DemotedNumberConstraint -> State D4.Schema ()
48−numberConstraint (DNLe n) = modify $ \s -> s
49− { _schemaMaximum = pure . fromIntegral $ n }
50−numberConstraint (DNLt n) = modify $ \s -> s
51− { _schemaMaximum = pure . fromIntegral $ n
52− , _schemaExclusiveMaximum = pure True }
53−numberConstraint (DNGt n) = modify $ \s -> s
54− { _schemaMinimum = pure . fromIntegral $ n
55− , _schemaExclusiveMinimum = pure True }
56−numberConstraint (DNGe n) = modify $ \s -> s
57− { _schemaMinimum = pure . fromIntegral $ n }
58−numberConstraint (DNEq n) = modify $ \s -> s
59− { _schemaMinimum = pure $ fromIntegral n
60− , _schemaMaximum = pure $ fromIntegral n }
35+numberConstraint (DNLe _) = pure ()
36+numberConstraint (DNLt _) = pure ()
37+numberConstraint (DNGt _) = pure ()
38+numberConstraint (DNGe _) = pure ()
39+numberConstraint (DNEq _) = pure ()
6140
6241arrayConstraint :: DemotedArrayConstraint -> State D4.Schema ()
63−arrayConstraint (DALe n) = modify $ \s -> s
64− { _schemaMaxItems = pure . fromIntegral $ n }
65−arrayConstraint (DALt n) =
66− let n' = if n == 0 then 0 else n - 1
67− in modify $ \s -> s { _schemaMaxItems = pure . fromIntegral $ n' }
68−arrayConstraint (DAGt n) = modify $ \s -> s
69− { _schemaMinItems = pure . fromIntegral $ n + 1 }
70−arrayConstraint (DAGe n) = modify $ \s -> s
71− { _schemaMinItems = pure . fromIntegral $ n }
72−arrayConstraint (DAEq n) = modify $ \s -> s
73− { _schemaMinItems = pure $ fromIntegral n
74− , _schemaMaxItems = pure $ fromIntegral n }
42+arrayConstraint (DAEq _) = pure ()
7543
7644toJsonSchema
7745 :: forall proxy schema
7846 . SingI schema
7947 => proxy (schema :: S.Schema)
80− -> Maybe D4.Schema
81−toJsonSchema _ = do
82− js <- toJsonSchema' $ fromSing (sing :: Sing schema)
83− pure $ js { _schemaVersion = pure draft4 }
48+ -> D4.Schema
49+toJsonSchema _ = (toJsonSchema' $ fromSing (sing :: Sing schema))
50+ { _schemaVersion = pure draft4 }
8451
8552toJsonSchema'
8653 :: DemotedSchema
87− -> Maybe D4.Schema
54+ -> D4.Schema
8855toJsonSchema' = \case
8956 DSchemaText tcs ->
90− pure $ execState (traverse_ textConstraint tcs) $ emptySchema
57+ execState (traverse_ textConstraint tcs) $ emptySchema
9158 { _schemaType = pure $ TypeValidatorString D4.SchemaString }
9259 DSchemaNumber ncs ->
93− pure $ execState (traverse_ numberConstraint ncs) $ emptySchema
60+ execState (traverse_ numberConstraint ncs) $ emptySchema
9461 { _schemaType = pure $ TypeValidatorString D4.SchemaNumber }
95− DSchemaBoolean -> pure $ emptySchema
96− { _schemaType = pure $ TypeValidatorString D4.SchemaBoolean }
97− DSchemaObject objs -> do
98− res <- for objs $ \(n,s) -> do
99− s' <- toJsonSchema' s
100− pure (n, s')
101− let
102− nonOpt = \case
103− (_, DSchemaOptional _) -> False
104− _ -> True
105− pure $ emptySchema
106− { _schemaType = pure $ TypeValidatorString D4.SchemaObject
107− , _schemaRequired = pure $ Set.fromList $ fst <$> L.filter nonOpt objs
108− , _schemaProperties = pure $ H.fromList res }
109− DSchemaArray acs sch -> do
110− res <- toJsonSchema' sch
111− pure $ execState (traverse_ arrayConstraint acs) $ emptySchema
112− { _schemaType = pure $ TypeValidatorString D4.SchemaArray
113− , _schemaItems = pure $ ItemsObject res }
114− DSchemaNull -> pure $ emptySchema
115− { _schemaType = pure $ TypeValidatorString D4.SchemaNull }
116− DSchemaOptional sch -> do
117− snull <- toJsonSchema' DSchemaNull
118− sres <- toJsonSchema' sch
119− pure $ emptySchema { _schemaOneOf = pure (snull :| [sres]) }
120− DSchemaUnion sch -> do
121− schemaUnion <- traverse toJsonSchema' sch >>= \case
122− [] -> Nothing
123− x -> Just x
124− pure $ emptySchema { _schemaAnyOf = pure $ NE.fromList schemaUnion }
62+ DSchemaBoolean -> emptySchema
63+ { _schemaType = pure $ TypeValidatorString D4.SchemaBoolean }
64+ DSchemaObject objs -> emptySchema
65+ { _schemaType = pure $ TypeValidatorString D4.SchemaObject
66+ , _schemaProperties = pure $ H.fromList $ (\(n,s) -> (n, toJsonSchema' s))
67+ <$> objs }
68+ DSchemaArray acs sch ->
69+ execState (traverse_ arrayConstraint acs) $ emptySchema
70+ { _schemaType = pure $ TypeValidatorString D4.SchemaArray
71+ , _schemaItems = pure $ ItemsArray [toJsonSchema' sch] }
72+ DSchemaNull -> emptySchema
73+ { _schemaType = pure $ TypeValidatorString D4.SchemaNull }
74+ DSchemaOptional sch -> emptySchema
75+ { _schemaOneOf = pure $ toJsonSchema' DSchemaNull :| [toJsonSchema' sch] }
src/Data/Schematic/Lens.hs+27−168
@@ -3,205 +3,64 @@
33{-# LANGUAGE AllowAmbiguousTypes #-}
44{-# LANGUAGE InstanceSigs #-}
55
6−module Data.Schematic.Lens
7− ( FIndex
8− , FElem(..)
9− , FImage
10− , FSubset(..)
11− , obj
12− , arr
13− , uni
14− , txt
15− , num
16− , opt
17− , bln
18− , textRepr
19− , numberRepr
20− , boolRepr
21− , arrayRepr
22− , objectRepr
23− , optionalRepr
24− ) where
6+module Data.Schematic.Lens where
257
26−import Data.Profunctor
8+import Data.Proxy
279import Data.Schematic.Schema
28−import Data.Scientific
29−import Data.Singletons
30−import Data.Text
31−import Data.Union
32−import Data.Vector as V
3310import Data.Vinyl
3411import Data.Vinyl.Functor
3512import Data.Vinyl.TypeLevel (Nat(..))
36−import GHC.TypeLits (Symbol, KnownSymbol)
13+import GHC.TypeLits (Symbol)
3714
3815
3916-- | A partial relation that gives the index of a value in a list.
4017type family FIndex (r :: Symbol) (rs :: [(Symbol, Schema)]) :: Nat where
41− FIndex r ( '(r, s) ': rs) = 'Z
42− FIndex r ( s ': rs) = 'S (FIndex r rs)
43−
44−type Flens fn f g rs i
45− = Functor g
46− => (f '(fn, (ByField fn rs i)) -> g (f '(fn, (ByField fn rs i))))
47− -> Rec f rs
48− -> g (Rec f rs)
49−
50−type FGetter fn f rs i = Rec f rs -> f '(fn, (ByField fn rs i))
18+ FIndex r ( '(fn, s) ': rs) = 'Z
19+ FIndex r ( s ': rs) = 'S (FIndex r rs)
5120
5221class i ~ FIndex fn rs => FElem (fn :: Symbol) (rs :: [(Symbol, Schema)]) (i :: Nat) where
53− type ByField fn rs i :: Schema
54− flens :: Flens fn f g rs i
22+ type ByRevision fn rs i :: Schema
23+ flens
24+ :: Functor g
25+ => proxy fn
26+ -> (FieldRepr '(fn, (ByRevision fn rs i)) -> g (FieldRepr '(fn, (ByRevision fn rs i))))
27+ -> Rec FieldRepr rs
28+ -> g (Rec FieldRepr rs)
5529
5630 -- | For Vinyl users who are not using the @lens@ package, we provide a getter.
57− fget :: FGetter fn f rs i
31+ fget
32+ :: proxy fn
33+ -> Rec FieldRepr rs
34+ -> FieldRepr '(fn, (ByRevision fn rs i))
5835
5936 -- | For Vinyl users who are not using the @lens@ package, we also provide a
6037 -- setter. In general, it will be unambiguous what field is being written to,
6138 -- and so we do not take a proxy argument here.
6239 fput
63− :: f '(fn, ByField fn rs i)
64− -> Rec f rs
65− -> Rec f rs
40+ :: FieldRepr '(fn, ByRevision fn rs i)
41+ -> Rec FieldRepr rs
42+ -> Rec FieldRepr rs
6643
6744instance FElem fn ('(fn, r) ': rs) 'Z where
68− type ByField fn ('(fn, r) ': rs) 'Z = r
45+ type ByRevision fn ('(fn, r) ': rs) 'Z = r
6946
70− flens f (x :& xs) = fmap (:& xs) (f x)
47+ flens _ f (x :& xs) = fmap (:& xs) (f x)
7148 {-# INLINE flens #-}
7249
73− fget = getConst . flens Const
50+ fget k = getConst . flens k Const
7451 {-# INLINE fget #-}
7552
76− fput y = getIdentity . flens (\_ -> Identity y)
53+ fput y = getIdentity . flens Proxy (\_ -> Identity y)
7754 {-# INLINE fput #-}
7855
7956instance (FIndex r (s ': rs) ~ 'S i, FElem r rs i) => FElem r (s ': rs) ('S i) where
80− type ByField r (s ': rs) ('S i) = ByField r rs i
57+ type ByRevision fn (s ': rs) ('S i) = ByRevision fn rs i
8158
82− flens f (x :& xs) = fmap (x :&) (flens f xs)
59+ flens p f (x :& xs) = fmap (x :&) (flens p f xs)
8360 {-# INLINE flens #-}
8461
85− fget = getConst . flens Const
62+ fget k = getConst . flens k Const
8663 {-# INLINE fget #-}
8764
88− fput y = getIdentity . flens (\_ -> Identity y)
65+ fput y = getIdentity . flens Proxy (\_ -> Identity y)
8966 {-# INLINE fput #-}
90−
91−-- This is an internal convenience helpers stolen from the @lens@ library.
92−lens
93− :: Functor f
94− => (t -> s)
95− -> (t -> a -> b)
96− -> (s -> f a)
97− -> t
98− -> f b
99−lens sa sbt afb s = fmap (sbt s) $ afb (sa s)
100−{-# INLINE lens #-}
101−
102−type Iso s t a b = forall p f. (Profunctor p, Functor f) => p a (f b) -> p s (f t)
103−
104−type Iso' s a = Iso s s a a
105−
106−iso
107− :: (s -> a) -> (b -> t)
108− -> Iso s t a b
109−iso sa bt = dimap sa (fmap bt)
110−{-# INLINE iso #-}
111−
112−-- | A partial relation that gives the indices of a sublist in a larger list.
113−type family FImage (rs :: [(Symbol, Schema)]) (ss :: [(Symbol, Schema)]) :: [Nat] where
114− FImage '[] ss = '[]
115− FImage ('(fn,s) ': rs) ss = FIndex fn ss ': FImage rs ss
116−
117−class is ~ FImage rs ss
118− => FSubset (rs :: [(Symbol, Schema)]) (ss :: [(Symbol, Schema)]) is where
119− -- | This is a lens into a slice of the larger record. Morally, we have:
120− --
121− -- > fsubset :: Lens' (Rec FieldRepr ss) (Rec FieldRepr rs)
122− fsubset
123− :: Functor g
124− => (Rec f rs -> g (Rec f rs))
125− -> Rec f ss
126− -> g (Rec f ss)
127−
128− -- | The getter of the 'fsubset' lens is 'fcast', which takes a larger record
129− -- to a smaller one by forgetting fields.
130− fcast
131− :: Rec f ss
132− -> Rec f rs
133− fcast = getConst . fsubset Const
134− {-# INLINE fcast #-}
135−
136− -- | The setter of the 'fsubset' lens is 'freplace', which allows a slice of
137− -- a record to be replaced with different values.
138− freplace
139− :: Rec f rs
140− -> Rec f ss
141− -> Rec f ss
142− freplace rs = getIdentity . fsubset (\_ -> Identity rs)
143− {-# INLINE freplace #-}
144−
145−instance FSubset '[] ss '[] where
146− fsubset = lens (const RNil) const
147−
148−instance
149− ( ByField fn ss i ~ s
150− , FElem fn ss i
151− , FSubset rs ss is) => FSubset ( '(fn,s) ': rs) ss (i ': is) where
152− fsubset = lens (\ss -> fget @fn ss :& fcast ss) set
153− where
154− set :: Rec f ss -> Rec f ( '(fn,s) ': rs) -> Rec f ss
155− set ss (r :& rs) = fput r $ freplace rs ss
156−
157−-- A bunch of @Iso@morphisms
158−textRepr
159− :: (KnownSymbol fn, SingI cs)
160− => Iso' (FieldRepr '(fn, ('SchemaText cs))) Text
161−textRepr = iso (\(FieldRepr (ReprText t)) -> t) (FieldRepr . ReprText)
162−
163−numberRepr
164− :: (KnownSymbol fn, SingI cs)
165− => Iso' (FieldRepr '(fn, ('SchemaNumber cs))) Scientific
166−numberRepr = iso (\(FieldRepr (ReprNumber n)) -> n) (FieldRepr . ReprNumber)
167−
168−boolRepr
169− :: (KnownSymbol fn)
170− => Iso' (FieldRepr '(fn, 'SchemaBoolean)) Bool
171−boolRepr = iso (\(FieldRepr (ReprBoolean b)) -> b) (FieldRepr . ReprBoolean)
172−
173−arrayRepr
174− :: (KnownSymbol fn, SingI cs, SingI schema)
175− => Iso' (FieldRepr '(fn, ('SchemaArray cs schema))) (V.Vector (JsonRepr schema))
176−arrayRepr = iso (\(FieldRepr (ReprArray a)) -> a) (FieldRepr . ReprArray)
177−
178−objectRepr
179− :: (KnownSymbol fn, SingI fields)
180− => Iso' (FieldRepr '(fn, ('SchemaObject fields))) (Rec FieldRepr fields)
181−objectRepr = iso (\(FieldRepr (ReprObject o)) -> o) (FieldRepr . ReprObject)
182−
183−optionalRepr
184− :: (KnownSymbol fn, SingI schema)
185− => Iso' (FieldRepr '(fn, ('SchemaOptional schema))) (Maybe (JsonRepr schema))
186−optionalRepr = iso (\(FieldRepr (ReprOptional r)) -> r) (FieldRepr . ReprOptional)
187−
188−obj :: Iso' (JsonRepr ('SchemaObject fields)) (Rec FieldRepr fields)
189−obj = iso (\(ReprObject r) -> r) ReprObject
190−
191−arr :: Iso' (JsonRepr ('SchemaArray cs schema)) (V.Vector (JsonRepr schema))
192−arr = iso (\(ReprArray r) -> r) ReprArray
193−
194−uni :: Iso' (JsonRepr ('SchemaUnion (h ': tl))) (Union JsonRepr (h ': tl))
195−uni = iso (\(ReprUnion u) -> u) ReprUnion
196−
197−txt :: Iso' (JsonRepr ('SchemaText cs)) Text
198−txt = iso (\(ReprText t) -> t) ReprText
199−
200−num :: Iso' (JsonRepr ('SchemaNumber cs)) Scientific
201−num = iso (\(ReprNumber t) -> t) ReprNumber
202−
203−bln :: Iso' (JsonRepr 'SchemaBoolean) Bool
204−bln = iso (\(ReprBoolean b) -> b) ReprBoolean
205−
206−opt :: Iso' (JsonRepr ('SchemaOptional schema)) (Maybe (JsonRepr schema))
207−opt = iso (\(ReprOptional o) -> o) ReprOptional
src/Data/Schematic/Migration.hs+8−45
@@ -1,19 +1,13 @@
11{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# LANGUAGE CPP #-}
3−{-# LANGUAGE TemplateHaskell #-}
2+{-# LANGUAGE TemplateHaskell #-}
43
54module Data.Schematic.Migration where
65
76import Data.Kind
8−import Data.Schematic.DSL
9−import Data.Schematic.Lens
107import Data.Schematic.Path
118import Data.Schematic.Schema
12−import Data.Singletons.Prelude hiding ((:.), All)
9+import Data.Singletons.Prelude hiding (All)
1310import Data.Singletons.TypeLits
14−import Data.Tagged
15−import Data.Vinyl
16−import Data.Vinyl.Functor
1711
1812
1913data Path
@@ -43,8 +37,8 @@ type family SchemaByKey (fs :: [(Symbol, Schema)]) (s :: Symbol) :: Schema where
4337 SchemaByKey ( '(a, s) ': tl) fn = SchemaByKey tl fn
4438
4539type family DeleteKey (acc :: [(Symbol, Schema)]) (fn :: Symbol) (fs :: [(Symbol, Schema)]) :: [(Symbol, Schema)] where
46− DeleteKey acc fn ('(fn, a) ': tl) = acc ++ tl
47− DeleteKey acc fn (fna ': tl) = acc ++ (fna ': tl)
40+ DeleteKey acc fn ('(fn, a) ': tl) = acc :++ tl
41+ DeleteKey acc fn (fna ': tl) = acc :++ (fna ': tl)
4842
4943type family UpdateKey
5044 (fn :: Symbol)
@@ -97,8 +91,7 @@ type family ElemOf (e :: k) (l :: [(a,k)]) :: Constraint where
9791type family AllVersions (vd :: Versioned) :: [(Revision, Schema)] where
9892 AllVersions ('Versioned s ms) = Reverse (AllVersions' '[ '("initial", s) ] ms)
9993
100−type family AllVersions' (acc :: [(Revision, Schema)]) (ms :: [Migration])
101− = (r :: [(Revision, Schema)]) where
94+type family AllVersions' (acc :: [(Revision, Schema)]) (ms :: [Migration]) = (r :: [(Revision, Schema)]) where
10295 AllVersions' acc '[] = acc
10396 AllVersions' ( '(rh, sh) ': tl ) (m ': ms) =
10497 AllVersions' ( '(rh, sh) ': ApplyMigration m sh ': tl ) ms
@@ -145,43 +138,13 @@ data instance Sing (v :: Versioned) where
145138 -> Sing (ms :: [Migration]) -- a bunch of migrations
146139 -> Sing ('Versioned s ms)
147140
148−type DataMigration s m h = Tagged s (JsonRepr h -> m (JsonRepr s))
149−
150−data MList :: (Type -> Type) -> [Schema] -> Type where
141+data MList :: (* -> *) -> [Schema] -> Type where
151142 MNil :: (Monad m, SingI s, TopLevel s) => MList m '[s]
152143 (:&&)
153144 :: (TopLevel s, SingI s)
154− => DataMigration s m h
145+ => proxy s
146+ -> (JsonRepr h -> m (JsonRepr s))
155147 -> MList m (h ': tl)
156148 -> MList m (s ': h ': tl)
157149
158150infixr 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+32−18
@@ -1,36 +1,50 @@
11module Data.Schematic.Path where
22
33import Data.Foldable as F
4+import Data.Monoid
5+import Data.Schematic.Utils
6+import Data.Singletons
47import Data.Singletons.Prelude
58import Data.Singletons.TypeLits
69import Data.Text as T
7−import Data.Aeson.Internal
810
911
10−newtype JSONPathText = JSONPathText Text
11− deriving (Show)
12−
13−data PathSegment = PathKey Symbol | PathIx Nat
12+data PathSegment = Key Symbol | Ix Nat
1413
1514data 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)
15+ SKey :: (KnownSymbol k, Known (Sing k)) => Sing (k :: Symbol) -> Sing ('Key k)
16+ SIx :: (KnownNat n, Known (Sing n)) => Sing (n :: Nat) -> Sing ('Ix n)
17+
18+instance (KnownSymbol k, Known (Sing k))
19+ => Known (Sing ('Key k)) where
20+ known = SKey known
21+
22+instance (KnownNat n, Known (Sing n))
23+ => Known (Sing ('Ix n)) where
24+ known = SIx known
25+
26+data DemotedPathSegment = DKey Text | DIx Integer
27+ deriving (Show)
28+
29+-- | Textual representation of json path.
30+newtype JSONPath = JSONPath Text
31+ deriving (Show)
1832
19−demotePath :: Sing (ps :: [PathSegment]) -> JSONPath
33+demotePath :: Sing (ps :: [PathSegment]) -> [DemotedPathSegment]
2034demotePath = go []
2135 where
22− go :: JSONPath -> Sing (ps :: [PathSegment]) -> JSONPath
36+ go :: [DemotedPathSegment] -> Sing (ps :: [PathSegment]) -> [DemotedPathSegment]
2337 go acc SNil = acc
24− go acc (SCons p ps) = go (acc ++ [demotePathSeg p]) ps
25− demotePathSeg :: Sing (ps :: PathSegment) -> JSONPathElement
26− demotePathSeg (SKey s) = Key $ T.pack $ withKnownSymbol s $ symbolVal s
27− demotePathSeg (SIx n) = Index $ withKnownNat n $ fromIntegral $ natVal n
38+ go acc (SCons p ps) = go (acc ++ [demote p]) ps
39+ demote :: Sing (ps :: PathSegment) -> DemotedPathSegment
40+ demote (SKey s) = DKey $ T.pack $ symbolVal s
41+ demote (SIx n) = DIx $ natVal n
2842
29−demotedPathToText :: JSONPath -> JSONPathText
30−demotedPathToText = JSONPathText . F.foldl' renderPathSegment ""
43+demotedPathToText :: [DemotedPathSegment] -> JSONPath
44+demotedPathToText = JSONPath . F.foldl' renderPathSegment ""
3145 where
32− renderPathSegment acc (Key t) = acc <> "." <> t
33− renderPathSegment acc (Index n) = acc <> "[" <> T.pack (show n) <> "]"
46+ renderPathSegment acc (DKey t) = acc <> "." <> t
47+ renderPathSegment acc (DIx n) = acc <> "[" <> T.pack (show n) <> "]"
3448
35−pathToText :: Sing (ps :: [PathSegment]) -> JSONPathText
49+pathToText :: Sing (ps :: [PathSegment]) -> JSONPath
3650pathToText = demotedPathToText . demotePath
src/Data/Schematic/Schema.hs+74−211
@@ -1,33 +1,28 @@
11{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# LANGUAGE CPP #-}
3−{-# LANGUAGE OverloadedLists #-}
4−{-# LANGUAGE OverloadedStrings #-}
2+{-# LANGUAGE OverloadedLists #-}
3+{-# LANGUAGE OverloadedStrings #-}
54{-# OPTIONS_GHC -fprint-explicit-kinds #-}
65
76module Data.Schematic.Schema where
87
9−import Control.Applicative ((<|>))
8+import Control.Applicative ()
109import Control.Monad
1110import Data.Aeson as J
1211import Data.Aeson.Types as J
1312import Data.HashMap.Strict as H
1413import Data.Kind
1514import Data.Maybe
16−import Data.Schematic.Generator
1715import Data.Schematic.Instances ()
1816import Data.Scientific
19−import Data.Singletons.Prelude.List hiding (All, Union)
17+import Data.Singletons.Prelude.List hiding (All)
2018import Data.Singletons.TH
2119import Data.Singletons.TypeLits
2220import Data.Text as T
23−import Data.Union
2421import Data.Vector as V
2522import Data.Vinyl hiding (Dict)
2623import qualified Data.Vinyl.TypeLevel as V
27−import GHC.Exts
2824import GHC.Generics (Generic)
29−import GHC.TypeLits
30− (SomeNat(..), SomeSymbol(..), someNatVal, someSymbolVal)
25+import GHC.TypeLits (SomeNat(..), SomeSymbol(..), someSymbolVal, someNatVal)
3126import Prelude as P
3227import Test.SmallCheck.Series
3328
@@ -49,38 +44,38 @@ data TextConstraint
4944 deriving (Generic)
5045
5146instance SingKind TextConstraint where
52− type Demote TextConstraint = DemotedTextConstraint
47+ type DemoteRep TextConstraint = DemotedTextConstraint
5348 fromSing = \case
54− STEq n -> withKnownNat n (DTEq . fromIntegral $ natVal n)
55− STLt n -> withKnownNat n (DTLt . fromIntegral $ natVal n)
56− STLe n -> withKnownNat n (DTLe . fromIntegral $ natVal n)
57− STGt n -> withKnownNat n (DTGt . fromIntegral $ natVal n)
58− STGe n -> withKnownNat n (DTGe . fromIntegral $ natVal n)
49+ STEq n -> withKnownNat n (DTEq $ natVal n)
50+ STLt n -> withKnownNat n (DTLt $ natVal n)
51+ STLe n -> withKnownNat n (DTLe $ natVal n)
52+ STGt n -> withKnownNat n (DTGt $ natVal n)
53+ STGe n -> withKnownNat n (DTGe $ natVal n)
5954 STRegex s -> withKnownSymbol s (DTRegex $ T.pack $ symbolVal s)
6055 STEnum s -> let
6156 d :: Sing (s :: [Symbol]) -> [Text]
62− d SNil = []
57+ d SNil = []
6358 d (SCons ss@SSym fs) = T.pack (symbolVal ss) : d fs
6459 in DTEnum $ d s
6560 toSing = \case
6661 DTEq n -> case someNatVal n of
6762 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STEq (SNat :: Sing n))
68− Nothing -> error "Negative singleton nat"
63+ Nothing -> error "Negative singleton nat"
6964 DTLt n -> case someNatVal n of
7065 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STLt (SNat :: Sing n))
71− Nothing -> error "Negative singleton nat"
66+ Nothing -> error "Negative singleton nat"
7267 DTLe n -> case someNatVal n of
7368 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STLe (SNat :: Sing n))
74− Nothing -> error "Negative singleton nat"
69+ Nothing -> error "Negative singleton nat"
7570 DTGt n -> case someNatVal n of
7671 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STGt (SNat :: Sing n))
77− Nothing -> error "Negative singleton nat"
72+ Nothing -> error "Negative singleton nat"
7873 DTGe n -> case someNatVal n of
7974 Just (SomeNat (_ :: Proxy n)) -> SomeSing (STGe (SNat :: Sing n))
80− Nothing -> error "Negative singleton nat"
75+ Nothing -> error "Negative singleton nat"
8176 DTRegex s -> case someSymbolVal (T.unpack s) of
8277 SomeSymbol (_ :: Proxy n) -> SomeSing (STRegex (SSym :: Sing n))
83− DTEnum ss -> case toSing ss of
78+ DTEnum ss -> case toSing (T.unpack <$> ss) of
8479 SomeSing l -> SomeSing (STEnum l)
8580
8681data DemotedTextConstraint
@@ -91,7 +86,7 @@ data DemotedTextConstraint
9186 | DTGe Integer
9287 | DTRegex Text
9388 | DTEnum [Text]
94− deriving (Generic, Eq, Show)
89+ deriving (Generic)
9590
9691data instance Sing (tc :: TextConstraint) where
9792 STEq :: Sing n -> Sing ('TEq n)
@@ -132,7 +127,7 @@ data DemotedNumberConstraint
132127 | DNGt Integer
133128 | DNGe Integer
134129 | DNEq Integer
135− deriving (Generic, Eq, Show)
130+ deriving (Generic)
136131
137132data instance Sing (nc :: NumberConstraint) where
138133 SNEq :: Sing n -> Sing ('NEq n)
@@ -154,89 +149,53 @@ instance Eq (Sing ('NGt n)) where _ == _ = True
154149instance Eq (Sing ('NGe n)) where _ == _ = True
155150
156151instance SingKind NumberConstraint where
157− type Demote NumberConstraint = DemotedNumberConstraint
152+ type DemoteRep NumberConstraint = DemotedNumberConstraint
158153 fromSing = \case
159− SNEq n -> withKnownNat n (DNEq . fromIntegral $ natVal n)
160− SNGt n -> withKnownNat n (DNGt . fromIntegral $ natVal n)
161− SNGe n -> withKnownNat n (DNGe . fromIntegral $ natVal n)
162− SNLt n -> withKnownNat n (DNLt . fromIntegral $ natVal n)
163− SNLe n -> withKnownNat n (DNLe . fromIntegral $ natVal n)
154+ SNEq n -> withKnownNat n (DNEq $ natVal n)
155+ SNGt n -> withKnownNat n (DNGt $ natVal n)
156+ SNGe n -> withKnownNat n (DNGe $ natVal n)
157+ SNLt n -> withKnownNat n (DNLt $ natVal n)
158+ SNLe n -> withKnownNat n (DNLe $ natVal n)
164159 toSing = \case
165160 DNEq n -> case someNatVal n of
166161 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNEq (SNat :: Sing n))
167− Nothing -> error "Negative singleton nat"
162+ Nothing -> error "Negative singleton nat"
168163 DNGt n -> case someNatVal n of
169164 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNGt (SNat :: Sing n))
170− Nothing -> error "Negative singleton nat"
165+ Nothing -> error "Negative singleton nat"
171166 DNGe n -> case someNatVal n of
172167 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNGe (SNat :: Sing n))
173− Nothing -> error "Negative singleton nat"
168+ Nothing -> error "Negative singleton nat"
174169 DNLt n -> case someNatVal n of
175170 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNLt (SNat :: Sing n))
176− Nothing -> error "Negative singleton nat"
171+ Nothing -> error "Negative singleton nat"
177172 DNLe n -> case someNatVal n of
178173 Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNLe (SNat :: Sing n))
179− Nothing -> error "Negative singleton nat"
174+ Nothing -> error "Negative singleton nat"
180175
181176data ArrayConstraint
182177 = AEq Nat
183− | AGt Nat
184− | AGe Nat
185− | ALt Nat
186− | ALe Nat
187178 deriving (Generic)
188179
189180data DemotedArrayConstraint
190181 = DAEq Integer
191− | DAGt Integer
192− | DAGe Integer
193− | DALt Integer
194− | DALe Integer
195− deriving (Generic, Eq, Show)
182+ deriving (Generic)
196183
197184data instance Sing (ac :: ArrayConstraint) where
198185 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)
203186
204187instance 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
209188
210189instance 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
215190
216191instance SingKind ArrayConstraint where
217− type Demote ArrayConstraint = DemotedArrayConstraint
192+ type DemoteRep ArrayConstraint = DemotedArrayConstraint
218193 fromSing = \case
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)
194+ SAEq n -> withKnownNat n (DAEq $ natVal n)
224195 toSing = \case
225196 DAEq n -> case someNatVal n of
226197 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))
239− Nothing -> error "Negative singleton nat"
198+ Nothing -> error "Negative singleton nat"
240199
241200data Schema
242201 = SchemaText [TextConstraint]
@@ -246,7 +205,6 @@ data Schema
246205 | SchemaArray [ArrayConstraint] Schema
247206 | SchemaNull
248207 | SchemaOptional Schema
249− | SchemaUnion [Schema]
250208 deriving (Generic)
251209
252210data DemotedSchema
@@ -257,8 +215,7 @@ data DemotedSchema
257215 | DSchemaArray [DemotedArrayConstraint] DemotedSchema
258216 | DSchemaNull
259217 | DSchemaOptional DemotedSchema
260− | DSchemaUnion [DemotedSchema]
261− deriving (Generic, Eq, Show)
218+ deriving (Generic)
262219
263220data instance Sing (schema :: Schema) where
264221 SSchemaText :: Sing tcs -> Sing ('SchemaText tcs)
@@ -268,7 +225,6 @@ data instance Sing (schema :: Schema) where
268225 SSchemaObject :: Sing fields -> Sing ('SchemaObject fields)
269226 SSchemaOptional :: Sing s -> Sing ('SchemaOptional s)
270227 SSchemaNull :: Sing 'SchemaNull
271− SSchemaUnion :: Sing ss -> Sing ('SchemaUnion ss)
272228
273229instance SingI sl => SingI ('SchemaText sl) where
274230 sing = SSchemaText sing
@@ -284,8 +240,6 @@ instance SingI stl => SingI ('SchemaObject stl) where
284240 sing = SSchemaObject sing
285241instance SingI s => SingI ('SchemaOptional s) where
286242 sing = SSchemaOptional sing
287−instance SingI s => SingI ('SchemaUnion s) where
288− sing = SSchemaUnion sing
289243
290244instance Eq (Sing ('SchemaText cs)) where _ == _ = True
291245instance Eq (Sing ('SchemaNumber cs)) where _ == _ = True
@@ -294,10 +248,9 @@ instance Eq (Sing 'SchemaBoolean) where _ == _ = True
294248instance Eq (Sing ('SchemaArray as s)) where _ == _ = True
295249instance Eq (Sing ('SchemaObject cs)) where _ == _ = True
296250instance Eq (Sing ('SchemaOptional s)) where _ == _ = True
297−instance Eq (Sing ('SchemaUnion s)) where _ == _ = True
298251
299252instance SingKind Schema where
300− type Demote Schema = DemotedSchema
253+ type DemoteRep Schema = DemotedSchema
301254 fromSing = \case
302255 SSchemaText cs -> DSchemaText $ fromSing cs
303256 SSchemaNumber cs -> DSchemaNumber $ fromSing cs
@@ -305,8 +258,12 @@ instance SingKind Schema where
305258 SSchemaArray cs s -> DSchemaArray (fromSing cs) (fromSing s)
306259 SSchemaOptional s -> DSchemaOptional $ fromSing s
307260 SSchemaNull -> DSchemaNull
308− SSchemaObject cs -> DSchemaObject $ fromSing cs
309− SSchemaUnion ss -> DSchemaUnion $ fromSing ss
261+ SSchemaObject cs -> let
262+ dem :: Sing (s :: [(Symbol, Schema)]) -> [(Text, DemotedSchema)]
263+ dem SNil = []
264+ dem (SCons (STuple2 ss ssch) fs) = withKnownSymbol ss
265+ $ (T.pack (symbolVal ss), fromSing ssch) : dem fs
266+ in DSchemaObject $ dem cs
310267 toSing = \case
311268 DSchemaText cs -> case toSing cs of
312269 SomeSing scs -> SomeSing $ SSchemaText scs
@@ -318,10 +275,8 @@ instance SingKind Schema where
318275 DSchemaOptional sch -> case toSing sch of
319276 SomeSing ssch -> SomeSing $ SSchemaOptional ssch
320277 DSchemaNull -> SomeSing SSchemaNull
321− DSchemaObject cs -> case toSing cs of
278+ DSchemaObject cs -> case toSing ((\(sym,sch) -> (T.unpack sym, sch)) <$> cs) of
322279 SomeSing scs -> SomeSing $ SSchemaObject scs
323− DSchemaUnion ss -> case toSing ss of
324− SomeSing sss -> SomeSing $ SSchemaUnion sss
325280
326281data FieldRepr :: (Symbol, Schema) -> Type where
327282 FieldRepr
@@ -359,10 +314,6 @@ instance
359314 => Serial m (FieldRepr '(name, schema)) where
360315 series = FieldRepr <$> series
361316
362−type family USubsets (u :: [k]) :: Constraint where
363− USubsets '[] = ()
364− USubsets (h ': tl) = (USubset tl (h ': tl) (V.RImage tl (h ': tl)), USubsets tl)
365−
366317data JsonRepr :: Schema -> Type where
367318 ReprText :: Text -> JsonRepr ('SchemaText cs)
368319 ReprNumber :: Scientific -> JsonRepr ('SchemaNumber cs)
@@ -371,65 +322,46 @@ data JsonRepr :: Schema -> Type where
371322 ReprArray :: V.Vector (JsonRepr s) -> JsonRepr ('SchemaArray cs s)
372323 ReprObject :: Rec FieldRepr fs -> JsonRepr ('SchemaObject fs)
373324 ReprOptional :: Maybe (JsonRepr s) -> JsonRepr ('SchemaOptional s)
374− ReprUnion :: Union JsonRepr (h ': tl) -> JsonRepr ('SchemaUnion (h ': tl))
375−
376−instance (Monad m, Serial m Text, SingI cs)
377− => Serial m (JsonRepr ('SchemaText cs)) where
378− series = decDepth $ fmap ReprText $ textSeries $ fromSing (sing :: Sing cs)
379325
380−instance (Monad m, Serial m Scientific, SingI cs)
381− => Serial m (JsonRepr ('SchemaNumber cs)) where
382− series = decDepth $ fmap ReprNumber
383− $ numberSeries $ fromSing (sing :: Sing cs)
384−
385−instance Monad m => Serial m (JsonRepr 'SchemaNull) where
386− series = cons0 ReprNull
387−
388−instance (Serial m (JsonRepr s), Serial m (V.Vector (JsonRepr s)), SingI cs)
389− => Serial m (JsonRepr ('SchemaArray cs s)) where
390− series = decDepth $ fmap ReprArray
391− $ arraySeries $ fromSing (sing :: Sing cs)
392−
393−instance (Serial m (JsonRepr s))
394− => Serial m (JsonRepr ('SchemaOptional s)) where
395− series = cons1 ReprOptional
396−
397−instance (Monad m, Serial m (Rec FieldRepr fs))
398− => Serial m (JsonRepr ('SchemaObject fs)) where
399− series = cons1 ReprObject
400−
401−-- | Move to the union package
402326instance Show (JsonRepr ('SchemaText cs)) where
403327 show (ReprText t) = "ReprText " P.++ show t
404328
405329instance Show (JsonRepr ('SchemaNumber cs)) where
406330 show (ReprNumber n) = "ReprNumber " P.++ show n
407331
408−instance Show (JsonRepr 'SchemaBoolean) where
409− show (ReprBoolean n) = "ReprBoolean " P.++ show n
410−
411332instance Show (JsonRepr 'SchemaNull) where show _ = "ReprNull"
412333
413334instance Show (JsonRepr s) => Show (JsonRepr ('SchemaArray acs s)) where
414335 show (ReprArray v) = "ReprArray " P.++ show v
415336
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
423337instance V.RecAll FieldRepr fs Show => Show (JsonRepr ('SchemaObject fs)) where
424338 show (ReprObject fs) = "ReprObject " P.++ show fs
425−#endif
426339
427340instance Show (JsonRepr s) => Show (JsonRepr ('SchemaOptional s)) where
428341 show (ReprOptional s) = "ReprOptional " P.++ show s
429342
430−instance Show (Union JsonRepr (h ': tl))
431− => Show (JsonRepr ('SchemaUnion (h ': tl))) where
432− show (ReprUnion s) = "ReprUnion " P.++ show s
343+instance (Monad m, Serial m Text)
344+ => Serial m (JsonRepr ('SchemaText cs)) where
345+ series = cons1 ReprText
346+
347+instance (Monad m, Serial m Scientific)
348+ => Serial m (JsonRepr ('SchemaNumber cs)) where
349+ series = cons1 ReprNumber
350+
351+instance Monad m => Serial m (JsonRepr 'SchemaNull) where
352+ series = cons0 ReprNull
353+
354+instance (Serial m (V.Vector (JsonRepr s)))
355+ => Serial m (JsonRepr ('SchemaArray cs s)) where
356+ series = cons1 ReprArray
357+
358+instance (Serial m (JsonRepr s))
359+ => Serial m (JsonRepr ('SchemaOptional s)) where
360+ series = cons1 ReprOptional
361+
362+instance (Monad m, Serial m (Rec FieldRepr fs))
363+ => Serial m (JsonRepr ('SchemaObject fs)) where
364+ series = cons1 ReprObject
433365
434366instance Eq (Rec FieldRepr fs) => Eq (JsonRepr ('SchemaObject fs)) where
435367 ReprObject a == ReprObject b = a == b
@@ -440,9 +372,6 @@ instance Eq (JsonRepr ('SchemaText cs)) where
440372instance Eq (JsonRepr ('SchemaNumber cs)) where
441373 ReprNumber a == ReprNumber b = a == b
442374
443−instance Eq (JsonRepr 'SchemaBoolean) where
444− ReprBoolean a == ReprBoolean b = a == b
445−
446375instance Eq (JsonRepr 'SchemaNull) where
447376 ReprNull == ReprNull = True
448377
@@ -452,51 +381,6 @@ instance Eq (JsonRepr s) => Eq (JsonRepr ('SchemaArray as s)) where
452381instance Eq (JsonRepr s) => Eq (JsonRepr ('SchemaOptional s)) where
453382 ReprOptional a == ReprOptional b = a == b
454383
455−instance Eq (Union JsonRepr (h ': tl))
456− => Eq (JsonRepr ('SchemaUnion (h ': tl))) where
457− ReprUnion a == ReprUnion b = a == b
458−
459−instance Ord (Rec FieldRepr fs) => Ord (JsonRepr ('SchemaObject fs)) where
460− ReprObject a `compare` ReprObject b = a `compare` b
461−
462−instance Ord (JsonRepr ('SchemaText cs)) where
463− ReprText a `compare` ReprText b = a `compare` b
464−
465−instance Ord (JsonRepr ('SchemaNumber cs)) where
466− ReprNumber a `compare` ReprNumber b = a `compare` b
467−
468−instance Ord (JsonRepr 'SchemaBoolean) where
469− ReprBoolean a `compare` ReprBoolean b = a `compare` b
470−
471−instance Ord (JsonRepr 'SchemaNull) where
472− compare _ _ = EQ
473−
474−instance Ord (JsonRepr s) => Ord (JsonRepr ('SchemaArray as s)) where
475− ReprArray a `compare` ReprArray b = a `compare` b
476−
477−instance Ord (JsonRepr s) => Ord (JsonRepr ('SchemaOptional s)) where
478− ReprOptional a `compare` ReprOptional b = a `compare` b
479−
480−instance Ord (Union JsonRepr (h ': tl))
481− => Ord (JsonRepr ('SchemaUnion (h ': tl))) where
482− ReprUnion a `compare` ReprUnion b = a `compare` b
483−
484−instance IsList (JsonRepr ('SchemaArray cs s)) where
485− type Item (JsonRepr ('SchemaArray cs s)) = JsonRepr s
486− fromList = ReprArray . GHC.Exts.fromList
487− toList (ReprArray v) = GHC.Exts.toList v
488−
489−instance Num (JsonRepr ('SchemaNumber cs)) where
490− ReprNumber a + ReprNumber b = ReprNumber $ a + b
491− ReprNumber a - ReprNumber b = ReprNumber $ a - b
492− ReprNumber a * ReprNumber b = ReprNumber $ a * b
493− abs (ReprNumber a) = ReprNumber $ abs a
494− signum (ReprNumber a) = ReprNumber $ signum a
495− fromInteger = ReprNumber . fromIntegral
496−
497−instance IsString (JsonRepr ('SchemaText cs)) where
498− fromString = ReprText . fromString
499−
500384fromOptional
501385 :: SingI s
502386 => Sing ('SchemaOptional s)
@@ -504,24 +388,6 @@ fromOptional
504388 -> Parser (Maybe (JsonRepr s))
505389fromOptional _ = parseJSON
506390
507−parseUnion
508− :: FromJSON (JsonRepr ('SchemaUnion ss))
509− => sing (ss :: [Schema])
510− -> Value
511− -> Parser (JsonRepr ('SchemaUnion ss))
512−parseUnion _ val = parseJSON val
513−
514−instance FromJSON (Union JsonRepr '[]) where
515− parseJSON = fail "empty union"
516−
517−instance (SingI a, FromJSON (Union JsonRepr as)) => FromJSON (Union JsonRepr (a ': as)) where
518− parseJSON val = (This <$> parseJSON val)
519− <|> (That <$> (parseJSON val :: Parser (Union JsonRepr as)))
520−
521−instance ToJSON (Union JsonRepr as) where
522− toJSON (This fa) = toJSON fa
523− toJSON (That u) = toJSON u
524−
525391instance SingI schema => J.FromJSON (JsonRepr schema) where
526392 parseJSON value = case sing :: Sing schema of
527393 SSchemaText _ -> withText "String" (pure . ReprText) value
@@ -542,29 +408,27 @@ instance SingI schema => J.FromJSON (JsonRepr schema) where
542408 fieldRepr <- case s of
543409 SSchemaText so -> case H.lookup fieldName h of
544410 Just v -> withSingI so $ FieldRepr <$> parseJSON v
545− Nothing -> fail $ "No text field: " P.++ show fieldName
411+ Nothing -> fail "schematext"
546412 SSchemaNumber so -> case H.lookup fieldName h of
547413 Just v -> withSingI so $ FieldRepr <$> parseJSON v
548− Nothing -> fail $ "No number field: " P.++ show fieldName
414+ Nothing -> fail "schemanumber"
549415 SSchemaBoolean -> case H.lookup fieldName h of
550416 Just v -> FieldRepr <$> parseJSON v
551− Nothing -> fail $ "No boolean field: " P.++ show fieldName
417+ Nothing -> fail "schemaboolean"
552418 SSchemaNull -> case H.lookup fieldName h of
553419 Just v -> FieldRepr <$> parseJSON v
554− Nothing -> fail $ "No null field: " P.++ show fieldName
420+ Nothing -> fail "schemanull"
555421 SSchemaArray sa sb -> case H.lookup fieldName h of
556422 Just v -> withSingI sa $ withSingI sb $ FieldRepr <$> parseJSON v
557− Nothing -> fail $ "No array field: " P.++ show fieldName
423+ Nothing -> fail "schemaarray"
558424 SSchemaObject so -> case H.lookup fieldName h of
559425 Just v -> withSingI so $ FieldRepr <$> parseJSON v
560− Nothing -> fail $ "No object field" P.++ show fieldName
426+ Nothing -> fail "schemaobject"
561427 SSchemaOptional so -> case H.lookup fieldName h of
562428 Just v -> withSingI so $ FieldRepr <$> parseJSON v
563− Nothing -> withSingI so $ pure $ FieldRepr $ ReprOptional Nothing
564− SSchemaUnion ss -> withSingI ss $ FieldRepr <$> parseUnion ss value
429+ Nothing -> fail "schemaoptional"
565430 (fieldRepr :&) <$> demoteFields tl h
566431 ReprObject <$> withObject "Object" (demoteFields fs) value
567− SSchemaUnion ss -> parseUnion ss value
568432
569433instance J.ToJSON (JsonRepr a) where
570434 toJSON ReprNull = J.Null
@@ -572,7 +436,7 @@ instance J.ToJSON (JsonRepr a) where
572436 toJSON (ReprText t) = J.String t
573437 toJSON (ReprNumber n) = J.Number n
574438 toJSON (ReprOptional s) = case s of
575− Just v -> toJSON v
439+ Just v -> toJSON v
576440 Nothing -> J.Null
577441 toJSON (ReprArray v) = J.Array $ toJSON <$> v
578442 toJSON (ReprObject r) = J.Object . H.fromList . fold $ r
@@ -585,7 +449,6 @@ instance J.ToJSON (JsonRepr a) where
585449 fold = \case
586450 RNil -> []
587451 fr@(FieldRepr _) :& tl -> (extract fr) : fold tl
588− toJSON (ReprUnion u) = toJSON u
589452
590453class FalseConstraint a
591454
src/Data/Schematic/Schema.hs-bootdeleted−95
@@ -1,95 +0,0 @@
1−module Data.Schematic.Schema where
2−
3−import Data.Kind
4−import Data.Maybe
5−import Data.Schematic.Instances ()
6−import Data.Scientific
7−import Data.Singletons.TH
8−import Data.Singletons.TypeLits
9−import Data.Text as T
10−import Data.Union
11−import Data.Vector as V
12−import Data.Vinyl hiding (Dict)
13−import Prelude as P
14−
15−data TextConstraint
16− = TEq Nat
17− | TLt Nat
18− | TLe Nat
19− | TGt Nat
20− | TGe Nat
21− | TRegex Symbol
22− | TEnum [Symbol]
23−
24−data DemotedTextConstraint
25− = DTEq Integer
26− | DTLt Integer
27− | DTLe Integer
28− | DTGt Integer
29− | DTGe Integer
30− | DTRegex Text
31− | DTEnum [Text]
32−
33−data NumberConstraint
34− = NLe Nat
35− | NLt Nat
36− | NGt Nat
37− | NGe Nat
38− | NEq Nat
39−
40−data DemotedNumberConstraint
41− = DNLe Integer
42− | DNLt Integer
43− | DNGt Integer
44− | DNGe Integer
45− | DNEq Integer
46−
47−data ArrayConstraint
48− = AEq Nat
49− | AGt Nat
50− | AGe Nat
51− | ALt Nat
52− | ALe Nat
53−
54−data DemotedArrayConstraint
55− = DAEq Integer
56− | DAGt Integer
57− | DAGe Integer
58− | DALt Integer
59− | DALe Integer
60−
61−data Schema
62− = SchemaText [TextConstraint]
63− | SchemaBoolean
64− | SchemaNumber [NumberConstraint]
65− | SchemaObject [(Symbol, Schema)]
66− | SchemaArray [ArrayConstraint] Schema
67− | SchemaNull
68− | SchemaOptional Schema
69− | SchemaUnion [Schema]
70−
71−data DemotedSchema
72− = DSchemaText [DemotedTextConstraint]
73− | DSchemaNumber [DemotedNumberConstraint]
74− | DSchemaBoolean
75− | DSchemaObject [(Text, DemotedSchema)]
76− | DSchemaArray [DemotedArrayConstraint] DemotedSchema
77− | DSchemaNull
78− | DSchemaOptional DemotedSchema
79− | DSchemaUnion [DemotedSchema]
80−
81−data FieldRepr :: (Symbol, Schema) -> Type where
82− FieldRepr
83− :: (SingI schema, KnownSymbol name)
84− => JsonRepr schema
85− -> FieldRepr '(name, schema)
86−
87−data JsonRepr :: Schema -> Type where
88− ReprText :: Text -> JsonRepr ('SchemaText cs)
89− ReprNumber :: Scientific -> JsonRepr ('SchemaNumber cs)
90− ReprBoolean :: Bool -> JsonRepr 'SchemaBoolean
91− ReprNull :: JsonRepr 'SchemaNull
92− ReprArray :: V.Vector (JsonRepr s) -> JsonRepr ('SchemaArray cs s)
93− ReprObject :: Rec FieldRepr fs -> JsonRepr ('SchemaObject fs)
94− ReprOptional :: Maybe (JsonRepr s) -> JsonRepr ('SchemaOptional s)
95− ReprUnion :: Union JsonRepr (h ': tl) -> JsonRepr ('SchemaUnion (h ': tl))
src/Data/Schematic/Utils.hsnew file+42
@@ -0,0 +1,42 @@
1+{-# LANGUAGE AllowAmbiguousTypes #-}
2+
3+module Data.Schematic.Utils where
4+
5+import Data.Proxy
6+import Data.Singletons
7+import Data.Singletons.Prelude
8+import Data.Singletons.TypeLits
9+import Data.Vinyl hiding (Dict)
10+
11+
12+class Known a where
13+ known :: a
14+
15+instance Known (Proxy a) where
16+ known = Proxy
17+
18+instance KnownNat n => Known (Sing n) where
19+ known = SNat
20+
21+instance KnownSymbol s => Known (Sing s) where
22+ known = SSym
23+
24+instance (Known (Sing a), Known (Sing b)) => Known (Sing '(a,b)) where
25+ known = STuple2 known known
26+
27+instance Known (Sing '[]) where known = SNil
28+
29+instance (Known (Sing a), Known (Sing as)) => Known (Sing (a ': as)) where
30+ known = SCons known known
31+
32+instance Known (Rec Sing '[]) where
33+ known = RNil
34+
35+instance (Known (Sing a), Known (Rec Sing tl)) => Known (Rec Sing (a ': tl)) where
36+ known = known :& known
37+
38+data Dict c where
39+ Dict :: c => Dict c
40+
41+instance c => Known (Dict c) where
42+ known = Dict
src/Data/Schematic/Validation.hs+33−132
@@ -2,25 +2,21 @@ module Data.Schematic.Validation where
22
33import Control.Monad
44import Control.Monad.Validation
5−import Data.Aeson
6−import Data.Aeson.Internal
7−import Data.Aeson.Types
85import Data.Foldable
96import Data.Functor.Identity
107import Data.Monoid
118import Data.Schematic.Path
129import Data.Schematic.Schema
10+import Data.Schematic.Utils ()
1311import Data.Scientific
1412import Data.Singletons.Prelude
1513import Data.Singletons.TypeLits
1614import Data.Text as T
1715import Data.Traversable
18−import Data.Union
1916import Data.Vector as V
2017import Data.Vinyl
21−import Data.Vinyl.TypeLevel
2218import Prelude as P
23−import Text.Regex.TDFA
19+import Text.Regex
2420
2521
2622type Validation a = ValidationT ErrorMap Identity a
@@ -33,10 +29,6 @@ data ParseResult a
3329 | ValidationError ErrorMap -- runtime
3430 deriving (Show, Eq, Functor, Foldable, Traversable)
3531
36−instance (TopLevel a, SingI a, FromJSON (JsonRepr a))
37− => FromJSON (ParseResult (JsonRepr a)) where
38− parseJSON = pure . parseAndValidateJson @a
39−
4032isValid :: ParseResult a -> Bool
4133isValid (Valid _) = True
4234isValid _ = False
@@ -50,51 +42,51 @@ isValidationError (ValidationError _) = True
5042isValidationError _ = False
5143
5244validateTextConstraint
53− :: JSONPathText
45+ :: JSONPath
5446 -> Text
5547 -> Sing (tcs :: TextConstraint)
5648 -> Validation ()
57−validateTextConstraint (JSONPathText path) t = \case
49+validateTextConstraint (JSONPath path) t = \case
5850 STEq n -> do
5951 let
6052 nlen = withKnownNat n $ natVal n
6153 predicate = nlen == (fromIntegral $ T.length t)
62− errMsg = "length should be == " <> T.pack (show nlen)
54+ errMsg = "length of " <> path <> " should be == " <> T.pack (show nlen)
6355 warn = vWarning $ mmSingleton path (pure errMsg)
6456 unless predicate warn
6557 STLt n -> do
6658 let
6759 nlen = withKnownNat n $ natVal n
68− predicate = nlen > (fromIntegral $ T.length t)
69− errMsg = "length should be < " <> T.pack (show nlen)
60+ predicate = nlen < (fromIntegral $ T.length t)
61+ errMsg = "length of " <> path <> " should be < " <> T.pack (show nlen)
7062 warn = vWarning $ mmSingleton path (pure errMsg)
7163 unless predicate warn
7264 STLe n -> do
7365 let
7466 nlen = withKnownNat n $ natVal n
75− predicate = nlen >= (fromIntegral $ T.length t)
76− errMsg = "length should be <= " <> T.pack (show nlen)
67+ predicate = nlen <= (fromIntegral $ T.length t)
68+ errMsg = "length of " <> path <> " should be <= " <> T.pack (show nlen)
7769 warn = vWarning $ mmSingleton path (pure errMsg)
7870 unless predicate warn
7971 STGt n -> do
8072 let
8173 nlen = withKnownNat n $ natVal n
82− predicate = nlen < (fromIntegral $ T.length t)
83− errMsg = "length should be > " <> T.pack (show nlen)
74+ predicate = nlen > (fromIntegral $ T.length t)
75+ errMsg = "length of " <> path <> " should be > " <> T.pack (show nlen)
8476 warn = vWarning $ mmSingleton path (pure errMsg)
8577 unless predicate warn
8678 STGe n -> do
8779 let
8880 nlen = withKnownNat n $ natVal n
89− predicate = nlen <= (fromIntegral $ T.length t)
90− errMsg = "length should be >= " <> T.pack (show nlen)
81+ predicate = nlen >= (fromIntegral $ T.length t)
82+ errMsg = "length of " <> path <> " should be >= " <> T.pack (show nlen)
9183 warn = vWarning $ mmSingleton path (pure errMsg)
9284 unless predicate warn
9385 STRegex r -> do
9486 let
95− regex = withKnownSymbol r $ fromSing r
96− predicate = matchTest (makeRegex (T.unpack regex) :: Regex) (T.unpack t)
97− errMsg = "must match " <> regex
87+ regex = withKnownSymbol r $ symbolVal r
88+ predicate = maybe False (const True) $ matchRegex (mkRegex regex) (T.unpack t)
89+ errMsg = path <> " must match " <> T.pack (show regex)
9890 warn = vWarning $ mmSingleton path (pure errMsg)
9991 unless predicate warn
10092 STEnum ss -> do
@@ -102,97 +94,69 @@ validateTextConstraint (JSONPathText path) t = \case
10294 matching :: Sing (s :: [Symbol]) -> Bool
10395 matching SNil = False
10496 matching (SCons s@SSym fs) = T.pack (symbolVal s) == t || matching fs
105− errMsg = "must be one of " <> T.pack (show (fromSing ss))
97+ errMsg = path <> " must be one of " <> T.pack (show (fromSing ss))
10698 warn = vWarning $ mmSingleton path (pure errMsg)
10799 unless (matching ss) warn
108100
109101validateNumberConstraint
110− :: JSONPathText
102+ :: JSONPath
111103 -> Scientific
112104 -> Sing (tcs :: NumberConstraint)
113105 -> Validation ()
114−validateNumberConstraint (JSONPathText path) num = \case
106+validateNumberConstraint (JSONPath path) num = \case
115107 SNEq n -> do
116108 let
117109 nlen = withKnownNat n $ natVal n
118110 predicate = fromIntegral nlen == num
119− errMsg = "should be == " <> T.pack (show nlen)
111+ errMsg = path <> " should be == " <> T.pack (show nlen)
120112 warn = vWarning $ mmSingleton path (pure errMsg)
121113 unless predicate warn
122114 SNGt n -> do
123115 let
124116 nlen = withKnownNat n $ natVal n
125117 predicate = num > fromIntegral nlen
126− errMsg = "should be > " <> T.pack (show nlen)
118+ errMsg = path <> " should be > " <> T.pack (show nlen)
127119 warn = vWarning $ mmSingleton path (pure errMsg)
128120 unless predicate warn
129121 SNGe n -> do
130122 let
131123 nlen = withKnownNat n $ natVal n
132124 predicate = num >= fromIntegral nlen
133− errMsg = "should be >= " <> T.pack (show nlen)
125+ errMsg = path <> " should be >= " <> T.pack (show nlen)
134126 warn = vWarning $ mmSingleton path (pure errMsg)
135127 unless predicate warn
136128 SNLt n -> do
137129 let
138130 nlen = withKnownNat n $ natVal n
139− predicate = num < fromIntegral nlen
140− errMsg = "should be < " <> T.pack (show nlen)
131+ predicate = fromIntegral nlen < num
132+ errMsg = path <> " should be < " <> T.pack (show nlen)
141133 warn = vWarning $ mmSingleton path (pure errMsg)
142134 unless predicate warn
143135 SNLe n -> do
144136 let
145137 nlen = withKnownNat n $ natVal n
146− predicate = num <= fromIntegral nlen
147− errMsg = "should be <= " <> T.pack (show nlen)
138+ predicate = fromIntegral nlen <= num
139+ errMsg = path <> " should be <= " <> T.pack (show nlen)
148140 warn = vWarning $ mmSingleton path (pure errMsg)
149141 unless predicate warn
150142
151143validateArrayConstraint
152− :: JSONPathText
144+ :: JSONPath
153145 -> V.Vector a
154146 -> Sing (tcs :: ArrayConstraint)
155147 -> Validation ()
156−validateArrayConstraint (JSONPathText path) v = \case
148+validateArrayConstraint (JSONPath path) v = \case
157149 SAEq n -> do
158150 let
159151 nlen = withKnownNat n $ natVal n
160152 predicate = nlen == fromIntegral (V.length v)
161− errMsg = "length should be == " <> T.pack (show nlen)
162− warn = vWarning $ mmSingleton path (pure errMsg)
163− unless predicate warn
164− SAGt n -> do
165− let
166− nlen = withKnownNat n $ natVal n
167− predicate = fromIntegral (V.length v) > nlen
168− errMsg = "length should be > " <> T.pack (show nlen)
169− warn = vWarning $ mmSingleton path (pure errMsg)
170− unless predicate warn
171− SAGe n -> do
172− let
173− nlen = withKnownNat n $ natVal n
174− predicate = fromIntegral (V.length v) >= nlen
175− errMsg = "length should be >= " <> T.pack (show nlen)
176− warn = vWarning $ mmSingleton path (pure errMsg)
177− unless predicate warn
178− SALt n -> do
179− let
180− nlen = withKnownNat n $ natVal n
181− predicate = fromIntegral (V.length v) < nlen
182− errMsg = "length should be < " <> T.pack (show nlen)
183− warn = vWarning $ mmSingleton path (pure errMsg)
184− unless predicate warn
185− SALe n -> do
186− let
187− nlen = withKnownNat n $ natVal n
188− predicate = fromIntegral (V.length v) <= nlen
189− errMsg = "length should be <= " <> T.pack (show nlen)
153+ errMsg = "length of " <> path <> " should be == " <> T.pack (show nlen)
190154 warn = vWarning $ mmSingleton path (pure errMsg)
191155 unless predicate warn
192156
193157validateJsonRepr
194158 :: Sing schema
195− -> JSONPath
159+ -> [DemotedPathSegment]
196160 -> JsonRepr schema
197161 -> Validation ()
198162validateJsonRepr sschema dpath jr = case jr of
@@ -226,7 +190,7 @@ validateJsonRepr sschema dpath jr = case jr of
226190 process cs
227191 process acs
228192 for_ (V.indexed v) $ \(ix, jr') -> do
229− let newPath = dpath <> pure (Index $ fromIntegral ix)
193+ let newPath = dpath <> pure (DIx $ fromIntegral ix)
230194 validateJsonRepr s newPath jr'
231195 ReprOptional d -> case sschema of
232196 SSchemaOptional ss -> case d of
@@ -235,72 +199,9 @@ validateJsonRepr sschema dpath jr = case jr of
235199 ReprObject fs -> case sschema of
236200 SSchemaObject _ -> go fs
237201 where
238− go :: Rec FieldRepr (ts :: [(Symbol, Schema)] ) -> Validation ()
202+ go :: Rec FieldRepr (ts :: [ (Symbol, Schema) ] ) -> Validation ()
239203 go RNil = pure ()
240204 go (f@(FieldRepr d) :& ftl) = do
241− let newPath = dpath <> [Key (knownFieldName f)]
205+ let newPath = dpath <> [DKey (knownFieldName f)]
242206 validateJsonRepr (knownFieldSchema f) newPath d
243207 go ftl
244− ReprUnion _ -> pure () -- FIXME
245− -- case sschema of
246− -- SSchemaUnion ss -> case ss of
247− -- SCons s stl -> case umatch' s u of
248− -- Nothing -> case urestrict u of
249− -- Nothing ->
250− -- fail "impossible to produce subUnion, please report this as a bug"
251− -- Just x -> do
252− -- let
253− -- JSONPathText path = demotedPathToText dpath
254− -- case stl of
255− -- SNil -> void $ vWarning $ mmSingleton path
256− -- $ pure "union handling error, please report this as bug"
257− -- SCons s' stl' ->
258− -- validateJsonRepr (SSchemaUnion (SCons s' stl')) dpath
259− -- $ toUnion (SCons s' stl') x
260− -- Just x -> validateJsonRepr s dpath x
261−
262−-- subUnion
263−-- :: Sing (s ': stl)
264−-- -> ( USubset stl (s ': stl) (RImage stl (s ': stl))
265−-- => Union f (s ': stl)
266−-- -> Maybe (Union f stl) )
267−-- subUnion (SCons s stl) = urestrict
268−
269−-- withUSubset
270−-- :: Sing (s ': stl)
271−-- -> (USubset stl (s ': stl) (RImage stl (s ': stl)) => Maybe (Union f stl))
272−-- -> Maybe (Union f stl)
273−-- withUSubset (SCons s stl) r = r
274−
275−toUnion
276− :: USubset s' (s ': ss) (RImage s' (s ': ss))
277− => Sing (s ': ss)
278− -> Union JsonRepr s'
279− -> JsonRepr ('SchemaUnion (s ': ss))
280−toUnion _ = ReprUnion . urelax
281−
282−umatch' :: UElem a as i => Sing a -> Union f as -> Maybe (f a)
283−umatch' _ u = umatch u
284−
285−parseAndValidateJson
286− :: forall schema
287− . (FromJSON (JsonRepr schema), TopLevel schema, SingI schema)
288− => Value
289− -> ParseResult (JsonRepr schema)
290−parseAndValidateJson v =
291− case parseEither parseJSON v of
292− Left s -> DecodingError $ T.pack s
293− Right jsonRepr ->
294− let
295− validate = validateJsonRepr (sing :: Sing schema) [] jsonRepr
296− res = runIdentity . runValidationTEither $ validate
297− in case res of
298− Left em -> ValidationError em
299− Right () -> Valid jsonRepr
300−
301−parseAndValidateJsonBy
302− :: (FromJSON (JsonRepr schema), TopLevel schema, SingI schema)
303− => proxy schema
304− -> Value
305− -> ParseResult (JsonRepr schema)
306−parseAndValidateJsonBy _ = parseAndValidateJson
src/Data/Schematic/Verifier.hsdeleted−5
@@ -1,5 +0,0 @@
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.hsdeleted−14
@@ -1,14 +0,0 @@
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.hsdeleted−43
@@ -1,43 +0,0 @@
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.hsdeleted−31
@@ -1,31 +0,0 @@
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.hsdeleted−121
@@ -1,121 +0,0 @@
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.yamldeleted−7
@@ -1,7 +0,0 @@
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+52−5
@@ -1,6 +1,53 @@
1−resolver: lts-14.22
1+resolver: lts-9.01
2+
3+# User packages to be built.
4+# Various formats can be used as shown in the example below.
5+#
6+# packages:
7+# - some-directory
8+# - https://example.com/foo/bar/baz-0.0.2.tar.gz
9+# - location:
10+# git: https://github.com/commercialhaskell/stack.git
11+# commit: e7b331f14bcffb8367cd58fbfc8b40ec7642100a
12+# - location: https://github.com/commercialhaskell/stack/commit/e7b331f14bcffb8367cd58fbfc8b40ec7642100a
13+# extra-dep: true
14+# subdirs:
15+# - auto-update
16+# - wai
17+#
18+# A package marked 'extra-dep: true' will only be built if demanded by a
19+# non-dependency (i.e. a user package), and its test suites and benchmarks
20+# will not be run. This is useful for tweaking upstream packages.
21+packages:
22+#- location:
23+ #git: https://github.com/typeable/validationt.git
24+ #commit: 24578c9fd408179358c641ee1fff0eb182591f4b
25+- '.'
26+
227extra-deps:
3−- hjsonpointer-1.4.0@rev:0
4−- hjsonschema-1.9.0@rev:0
5−- git: https://github.com/typeable/validationt.git
6− commit: 97fea97c4015ab5e99f3efb2c73e1fef4b8857d8
28+- validationt-0.2.0.0
29+- smallcheck-series-0.6
30+
31+# Override default flag values for local packages and extra-deps
32+flags: {}
33+
34+# Extra package databases containing global packages
35+extra-package-dbs: []
36+
37+# Control whether we use the GHC we find on the path
38+# system-ghc: true
39+#
40+# Require a specific version of stack, using version ranges
41+# require-stack-version: -any # Default
42+# require-stack-version: ">=1.4"
43+#
44+# Override the architecture used by stack, especially useful on Windows
45+# arch: i386
46+# arch: x86_64
47+#
48+# Extra directories used by stack for building
49+# extra-include-dirs: [/path/to/dir]
50+# extra-lib-dirs: [/path/to/dir]
51+#
52+# Allow a newer minor version of GHC than the snapshot specifies
53+# compiler-check: newer-minor
test/HelpersSpec.hsdeleted−124
@@ -1,124 +0,0 @@
1−{-# OPTIONS_GHC -Wno-unticked-promoted-constructors #-}
2−
3−{-# LANGUAGE LambdaCase #-}
4−
5−{-# LANGUAGE DataKinds #-}
6−{-# LANGUAGE TypeApplications #-}
7−{-# LANGUAGE OverloadedStrings #-}
8−
9−module HelpersSpec (spec, main) where
10−
11−import Control.Lens
12−import Data.ByteString.Lazy.Lens
13−import Data.Foldable
14−import Data.Monoid
15−import Data.Schematic
16−import Data.Text as T
17−import Data.Text.Lens
18−import Test.Hspec
19−
20−
21−type UUIDSchema = 'SchemaObject '[ '("uuid", 'SchemaText IsUUID) ]
22−
23−-- | Taken from UUID RFC 4122
24−uuid :: Text
25−uuid = "f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
26−
27−type ISO8601DateSchema = 'SchemaObject '[ '("date", 'SchemaText IsDate) ]
28−
29−iso8601dates :: [Text]
30−iso8601dates = [ "1985-04-12" ]
31−
32−invalidIso8601dates :: [Text]
33−invalidIso8601dates = [ "1999-13-12" ]
34−
35−type ISO8601TimeSchema = 'SchemaObject '[ '("time", 'SchemaText IsTime) ]
36−
37−iso8601times :: [Text]
38−iso8601times =
39− [ "19:23:00"
40− , "00:00:00"
41− , "23:47:12" ]
42−
43−invalidIso8601times :: [Text]
44−invalidIso8601times =
45− [ "00:60:00"
46− , "24:01:02" ]
47−
48−type ISO8601DateTimeSchema = 'SchemaObject '[ '("datetime", 'SchemaText IsDateTime) ]
49−
50−-- | Taken from ISO8601 RFC 3339
51−iso8601datetimes :: [Text]
52−iso8601datetimes =
53− iso8601dates <>
54− [ "1985-04-12T23:20:50.52Z"
55− , "1996-12-19T16:39:57-08:00"
56− , "1990-12-31T23:59:60Z"
57− , "1990-12-31T15:59:60-08:00"
58− , "1937-01-01T12:00:27.87+00:20"
59− ]
60−
61−invalidIso8601datetimes :: [Text]
62−invalidIso8601datetimes =
63− [ "1996-13-129T16:39:57-08:00"
64− , "1990-2-31T23:59:60Z"
65− , "1990-12-32T15:59:70"
66− , "1937-01-1T12::27.87+24:20"
67− ]
68−
69−spec :: Spec
70−spec = do
71− describe "UUID: " $ do
72− it "validates correct UUID" $ do
73− let
74− uuidJson = "{\"uuid\": \"" <> (uuid ^. unpacked . packedChars) <> "\" }"
75− (decodeAndValidateJson uuidJson :: ParseResult (JsonRepr UUIDSchema))
76− `shouldSatisfy` isValid
77−
78− it "fails to validate incorrect UUID" $ do
79− let
80− incorrectJson = "{\"uuid\": \"incorrect\" }"
81− (decodeAndValidateJson incorrectJson :: ParseResult (JsonRepr UUIDSchema))
82− `shouldSatisfy` isValidationError
83−
84− describe "ISO8601 date: " $ do
85− for_ iso8601dates $ \dt -> do
86− it ("validates correct date - " <> dt ^. unpacked) $ do
87− let json = "{\"date\": \"" <> (dt ^. unpacked . packedChars) <> "\" }"
88− (decodeAndValidateJson json :: ParseResult (JsonRepr ISO8601DateSchema))
89− `shouldSatisfy` isValid
90−
91− for_ invalidIso8601dates $ \dt -> do
92− it ("fails to validate incorrect date - " <> dt ^. unpacked) $ do
93− let json = "{\"date\": \"" <> (dt ^. unpacked . packedChars) <> "\" }"
94− (decodeAndValidateJson json :: ParseResult (JsonRepr ISO8601DateSchema))
95− `shouldSatisfy` isValidationError
96−
97− describe "ISO8601 time: " $ do
98− for_ iso8601times $ \dt -> do
99− it ("validates correct time - " <> dt ^. unpacked) $ do
100− let json = "{\"time\": \"" <> (dt ^. unpacked . packedChars) <> "\" }"
101− (decodeAndValidateJson json :: ParseResult (JsonRepr ISO8601TimeSchema))
102− `shouldSatisfy` isValid
103−
104− for_ invalidIso8601times $ \dt -> do
105− it ("fails to validate incorrect time - " <> dt ^. unpacked) $ do
106− let json = "{\"time\": \"" <> (dt ^. unpacked . packedChars) <> "\" }"
107− (decodeAndValidateJson json :: ParseResult (JsonRepr ISO8601TimeSchema))
108− `shouldSatisfy` isValidationError
109−
110− describe "ISO8601 datetime: " $ do
111− for_ iso8601datetimes $ \dt -> do
112− it ("validates correct datetime - " <> dt ^. unpacked) $ do
113− let json = "{\"datetime\": \"" <> (dt ^. unpacked . packedChars) <> "\" }"
114− (decodeAndValidateJson json :: ParseResult (JsonRepr ISO8601DateTimeSchema))
115− `shouldSatisfy` isValid
116−
117− for_ invalidIso8601datetimes $ \dt -> do
118− it ("fails to validate incorrect datetime - " <> dt ^. unpacked) $ do
119− let json = "{\"datetime\": \"" <> (dt ^. unpacked . packedChars) <> "\" }"
120− (decodeAndValidateJson json :: ParseResult (JsonRepr ISO8601DateTimeSchema))
121− `shouldSatisfy` isValidationError
122−
123−main :: IO ()
124−main = hspec spec
test/JsonSchemaSpec.hs+11−69
@@ -1,16 +1,7 @@
1−{-# LANGUAGE LambdaCase #-}
2−
3−{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE TypeApplications #-}
5−{-# LANGUAGE OverloadedLists #-}
6−{-# LANGUAGE OverloadedStrings #-}
7−
81module JsonSchemaSpec (spec, main) where
92
103import Data.Aeson as J
11−import Data.Maybe
124import Data.Proxy
13−import Data.ByteString.Lazy as B
145import Data.Schematic
156import Data.Vinyl
167import JSONSchema.Draft4 as D4
@@ -26,76 +17,27 @@ type FieldsSchema =
2617
2718type SchemaExample = 'SchemaObject FieldsSchema
2819
29−exampleData :: JsonRepr SchemaExample
30−exampleData = withRepr @SchemaExample $
31− field @"foo" [ReprNumber 13]
32− :& field @"bar" (pure (ReprText "foo"))
33− :& RNil
20+arrayData :: JsonRepr ArraySchema
21+arrayData = ReprArray [ReprNumber 13]
3422
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− ]
23+arrayField :: FieldRepr ArrayField
24+arrayField = FieldRepr arrayData
4125
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− ]
26+objectData :: Rec FieldRepr FieldsSchema
27+objectData = FieldRepr arrayData
28+ :& FieldRepr (ReprOptional (Just (ReprText "foo")))
29+ :& RNil
4830
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− ]
31+exampleData :: JsonRepr SchemaExample
32+exampleData = ReprObject objectData
5533
5634spec :: Spec
5735spec = do
5836 it "validates simple schema" $ do
59− let schema = D4.SchemaWithURI (fromJust $ toJsonSchema (Proxy @SchemaExample)) Nothing
37+ let schema = D4.SchemaWithURI (toJsonSchema (Proxy @SchemaExample)) Nothing
6038 fetchHTTPAndValidate schema (toJSON exampleData) >>= \case
6139 Left _ -> fail "failed to validate test example"
6240 Right _ -> pure ()
63− it "validates schema with arrays" $ do
64− let
65− schema = D4.SchemaWithURI (fromJust $ toJsonSchema (Proxy @SchemaArrayExample)) Nothing
66− obj = withRepr @SchemaArrayExample $
67− field @"a1" [ReprNumber 13, ReprNumber 13]
68− :& field @"a2" [ReprNumber 13]
69− :& field @"a3" []
70− :& field @"a4" [ReprNumber 13]
71− :& RNil
72− fetchHTTPAndValidate schema (toJSON obj) >>= \case
73− Left e -> fail "failed to validate test example"
74− Right _ -> pure ()
75− it "validates schema with numbers" $ do
76− let
77− schema = D4.SchemaWithURI (fromJust $ toJsonSchema (Proxy @SchemaNumberExample)) Nothing
78− obj = withRepr @SchemaNumberExample $
79− field @"n1" 1.1
80− :& field @"n2" 1
81− :& field @"n3" 0.9
82− :& field @"n4" 1.0
83− :& RNil
84− fetchHTTPAndValidate schema (toJSON obj) >>= \case
85− Left e -> fail "failed to validate test example"
86− Right _ -> pure ()
87− it "validates schema with strings" $ do
88− let
89− schema = D4.SchemaWithURI (fromJust $ toJsonSchema (Proxy @SchemaTextExample)) Nothing
90− obj = withRepr @SchemaTextExample $
91− field @"t1" "11"
92− :& field @"t2" "1"
93− :& field @"t3" ""
94− :& field @"t4" "1"
95− :& RNil
96− fetchHTTPAndValidate schema (toJSON obj) >>= \case
97− Left e -> fail "failed to validate test example"
98− Right _ -> pure ()
9941
10042main :: IO ()
10143main = hspec spec
test/LensSpec.hs+13−12
@@ -1,11 +1,7 @@
1−{-# LANGUAGE DataKinds #-}
2−{-# LANGUAGE TypeApplications #-}
3−{-# LANGUAGE OverloadedLists #-}
4−{-# LANGUAGE OverloadedStrings #-}
5−
61module LensSpec (spec, main) where
72
83import Control.Lens
4+import Data.Kind
95import Data.Proxy
106import Data.Schematic
117import Data.Vinyl
@@ -17,7 +13,9 @@ type ArraySchema = 'SchemaArray '[ 'AEq 1] ('SchemaNumber '[ 'NGt 10])
1713type ArrayField = '("foo", ArraySchema)
1814
1915type FieldsSchema =
20− '[ '("bar", 'SchemaOptional ('SchemaText '[ 'TEnum '["foo", "bar"]])), ArrayField]
16+ '[ ArrayField, '("bar", 'SchemaOptional ('SchemaText '[ 'TEnum '["foo", "bar"]]))]
17+
18+type SchemaExample = 'SchemaObject FieldsSchema
2119
2220arrayData :: JsonRepr ArraySchema
2321arrayData = ReprArray [ReprNumber 13]
@@ -26,10 +24,13 @@ arrayField :: FieldRepr ArrayField
2624arrayField = FieldRepr arrayData
2725
2826objectData :: Rec FieldRepr FieldsSchema
29−objectData = FieldRepr (ReprOptional (Just (ReprText "foo")))
30− :& FieldRepr arrayData
27+objectData = FieldRepr arrayData
28+ :& FieldRepr (ReprOptional (Just (ReprText "foo")))
3129 :& RNil
3230
31+exampleData :: JsonRepr SchemaExample
32+exampleData = ReprObject objectData
33+
3334type BigRecord = Rec FieldRepr
3435 '[ '("f1", 'SchemaNumber '[])
3536 , '("f2", 'SchemaNumber '[])
@@ -303,15 +304,15 @@ spec = do
303304 newFooVal = FieldRepr $ ReprArray [ReprNumber 15]
304305 fooProxy = Proxy @"foo"
305306 it "gets the field from an object" $ do
306− fget @"foo" objectData `shouldBe` arrayField
307+ fget fooProxy objectData `shouldBe` arrayField
307308 it "sets the object field" $ do
308− fget @"foo" (fput newFooVal objectData) `shouldBe` newFooVal
309+ fget fooProxy (fput newFooVal objectData) `shouldBe` newFooVal
309310
310311 describe "(using lens library) " $ do
311312 it "get the field from an object" $ do
312− objectData ^. flens @"foo" `shouldBe` arrayField
313+ objectData ^. flens (Proxy @"foo") `shouldBe` arrayField
313314 it "sets the object field" $ do
314− set (flens @"foo") newFooVal objectData ^. flens @"foo"
315+ set (flens (Proxy @"foo")) newFooVal objectData ^. flens (Proxy @"foo")
315316 `shouldBe` newFooVal
316317
317318main :: IO ()
test/SchemaSpec.hs+27−73
@@ -1,78 +1,33 @@
11{-# OPTIONS_GHC -fprint-potential-instances #-}
22
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−
123module SchemaSpec (spec, main) where
134
14−import Control.Lens
155import Data.Aeson
166import Data.ByteString.Lazy
177import Data.Functor.Identity
188import Data.Proxy
199import Data.Schematic
20−import Data.Schematic.Generator
21−import Data.Singletons
22−import Data.Tagged
2310import Data.Vinyl
2411import 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
29−
30−import Debug.Trace
31−
32−type SchemaExample = 'SchemaObject
33− '[ '("foo", 'SchemaArray '[ 'AEq 1] ('SchemaNumber '[ 'NGt 10]))
34− , '("bar", 'SchemaOptional ('SchemaText '[ 'TEnum '["foo", "bar"]]))]
35−
36−type SchemaExample2 = 'SchemaObject
37− '[ '("foo", 'SchemaArray '[ 'AEq 2] ('SchemaText '[ 'TGt 10]))
38− , '("bar", 'SchemaOptional ('SchemaText '[ 'TRegex "[0-9]+"]))]
39−
40−jsonExample :: JsonRepr SchemaExample
41−jsonExample = withRepr @SchemaExample
42− $ field @"bar" (Just "bar")
43− :& field @"foo" [12]
44− :& RNil
45−
46−type AddQuuz =
47− 'Migration "add_field_quuz"
48− '[ 'Diff '[] ('AddKey "quuz" (SchemaNumber '[])) ]
4912
50−type DeleteQuuz =
51− 'Migration "remove_field_quuz"
52− '[ 'Diff '[] ( 'DeleteKey "quuz") ]
5313
54−type SwapFields =
55− 'Migration "swap_fields"
56− '[ 'Diff '[ 'PKey "bar" ] ('Update
57− ('SchemaArray '[ 'AEq 1] ('SchemaNumber '[ 'NGt 10])))
58− , 'Diff '[ 'PKey "foo" ] ('Update
59− ('SchemaOptional ('SchemaText '[ 'TEnum '["foo", "bar"]]))) ]
14+type SchemaExample
15+ = 'SchemaObject
16+ '[ '("foo", 'SchemaArray '[ 'AEq 1] ('SchemaNumber '[ 'NGt 10]))
17+ , '("bar", 'SchemaOptional ('SchemaText '[ 'TEnum '["foo", "bar"]]))]
6018
61−type Migrations = '[ AddQuuz
62− , DeleteQuuz ]
63− -- , SwapFields ]
19+type TestMigration =
20+ 'Migration "test_revision"
21+ '[ 'Diff '[ 'PKey "bar" ] ('Update ('SchemaText '[]))
22+ , 'Diff '[ 'PKey "foo" ] ('Update ('SchemaNumber '[])) ]
6423
65−type VersionedJson = 'Versioned SchemaExample Migrations
24+type VS = 'Versioned SchemaExample '[ TestMigration ]
6625
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
26+jsonExample :: JsonRepr SchemaExample
27+jsonExample = ReprObject $
28+ FieldRepr (ReprArray [ReprNumber 12])
29+ :& FieldRepr (ReprOptional (Just (ReprText "bar")))
30+ :& RNil
7631
7732schemaJson :: ByteString
7833schemaJson = "{\"foo\": [13], \"bar\": null}"
@@ -80,11 +35,15 @@ schemaJson = "{\"foo\": [13], \"bar\": null}"
8035schemaJson2 :: ByteString
8136schemaJson2 = "{\"foo\": [3], \"bar\": null}"
8237
83−schemaJsonSeries :: Monad m => SC.Series m (JsonRepr SchemaExample)
84−schemaJsonSeries = series
85−
86−schemaJsonSeries2 :: Monad m => SC.Series m (JsonRepr SchemaExample2)
87−schemaJsonSeries2 = series
38+topObject
39+ :: JsonRepr
40+ ('SchemaObject
41+ '[ '("foo", 'SchemaNumber '[])
42+ , '("bar", 'SchemaText '[])])
43+topObject = ReprObject $
44+ FieldRepr (ReprNumber 42)
45+ :& FieldRepr (ReprText "test")
46+ :& RNil
8847
8948spec :: Spec
9049spec = do
@@ -106,17 +65,12 @@ spec = do
10665 -- `shouldSatisfy` isValid
10766 it "validates versioned json with a migration list" $ do
10867 decodeAndValidateVersionedWithPureMList
109− (Proxy @VersionedJson)
110− migrationList
68+ (Proxy @VS)
69+ ((:&&)
70+ (Proxy @(SchemaByRevision "test_revision" VS))
71+ (const $ Identity topObject) MNil)
11172 schemaJson
11273 `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−
12074
12175main :: IO ()
12276main = hspec spec