git.iko.soy/schematic
on b6a94f1 help sign in
f5ed14a
swap
0 ahead, 152 behind
33 files changed+435−3243
since splitsnapshots
unifiedsplit
.travis.yml−25 ChangeLog.md−55 README.md−255 release−43 release.nix−32 schematic.cabal+46−50 src/Data/Aeson/Validation.hs+82 src/Data/Schematic.hs+3−99 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−27 src/Data/Schematic/JsonSchema.hs−124 src/Data/Schematic/Lens.hs−207 src/Data/Schematic/Migration.hs−187 src/Data/Schematic/OldSchema.hs+76 src/Data/Schematic/Path.hs−39 src/Data/Schematic/Schema.hs+127−517 src/Data/Schematic/Schema.hs-boot−95 src/Data/Schematic/Validatable.hs+5 src/Data/Schematic/Validation.hs−305 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.7.yaml−5 stack.yaml+68−4 test/HelpersSpec.hs−124 test/JsonSchemaSpec.hs−101 test/LensSpec.hs−318 test/SchemaSpec.hs+28−99
.travis.ymldeleted−25
@@ -1,25 +0,0 @@
1−sudo: required
2−
3−language: c
4−
5−addons:
6− apt:
7− packages:
8− - libgmp-dev
9−
10−env:
11− - STACK_YAML=stack.yaml
12−
13−install:
14− - mkdir -p ~/.local/bin
15− - export PATH=$HOME/.local/bin:$PATH
16− - travis_retry curl -L https://www.stackage.org/stack/linux-x86_64 | tar xz --wildcards --strip-components=1 -C ~/.local/bin '*/stack'
17− - stack --version
18− - stack setup --no-terminal
19−
20−script:
21− - stack test --ghc-options=-Werror --no-terminal
22−
23−cache:
24− directories:
25− - $HOME/.stack
ChangeLog.mddeleted−55
@@ -1,55 +0,0 @@
1−# Revision history for schematic
2−
3−## 0.5.0.0 -- 2019-02-20
4−
5−GHC 8.6, json generation by schema definition, validation bug fixes, better
6−parsing error messages.
7−
8−## 0.4.3.0 -- 2018-07-12
9−
10−GHC 8.4 support, dropping support for older GHC versions
11−
12−## 0.4.2.0
13−
14−Support ghc-8.4 and drop support for older versions
15−
16−## 0.4.1.0 -- 2017-11-05
17−
18−Convenience isomorphisms: txt, num, opt, bln etc
19−
20−## 0.4.1.0 -- 2017-11-01
21−
22−flens and fget now use type application syntax
23−
24−## 0.4.0.0 -- 2017-10-17
25−
26−Object building DSL, more convenience helpers, MCons simplified with Tagged
27−
28−## 0.3.2.0 -- 2017-10-02
29−
30−Fixed FIndex bug, added bunch of convenience isomorphism, re-exports.
31−
32−## 0.3.1.0 -- 2017-09-28
33−
34−Add UUID and ISO8601 helpers, json schema constraint export, fsubset lens
35−combinator.
36−
37−## 0.3.0.0 -- 2017-09-28
38−
39−Updated to GHC 8.2.1 and singletons 2.3.1
40−
41−## 0.2.1.0 -- 2017-09-26
42−
43−Add decodeAndValidateVersionedWithPureMList, fix tests
44−
45−## 0.2.0.0 -- 2017-09-26
46−
47−Migratable is deprecated, migrations are now possible in an arbitrary monad.
48−
49−## 0.1.5.0 -- 2017-08-22
50−
51−Lens compatibility for typed json objects.
52−
53−## 0.1.0.0 -- YYYY-mm-dd
54−
55−* First version. Released on an unsuspecting world.
README.mddeleted−255
@@ -1,255 +0,0 @@
1−# schematic
2−
3−[![Build Status](https://travis-ci.org/typeable/schematic.svg?branch=master)](https://travis-ci.org/typeable/schematic)
4−
5−## Goal
6−
7−The goal of the library is to provide a type-safe transport layer for serializing and validating JSON. It can be thought of as a subset of [json-schema](http://json-schema.org), which is basically a specification of a JSON document. The other goal is getting as much as possible from this specification for free. Right now the following bits are prototyped:
8−
9−* All of the instantiations of the transport types structurally follow the schema provided by user
10−* Serializers are generic, so they follow from the type-level schema and the're supposed to have a roundtrip property by an implementation.
11−* Runtime value validators are generated from the schema. Validation errors are reported as a pairs of a json-path to the element and an error message.
12−* There are migrations. It's possible to describe a series of migrations to the schema and have all the necessary machinery to deserialize a user specified version of the schema if there are multiple versions available.
13−* Schematic schemas can be exported to [json-schema](http://json-schema.org)
14−
15−Be aware that library is experimental and subject to change a lot. The current state can be viewed as a prototype.
16−
17−## Installation
18−
19−* Install [Stack](https://github.com/commercialhaskell/stack)
20−
21−```
22−$ stack install schematic
23−```
24−
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−
51−## Basic Examples
52−
53−```haskell
54−type SchemaExample
55− = SchemaObject
56− '[ '("foo", SchemaArray '[AEq 1] (SchemaNumber '[NGt 10]))
57− , '("bar", SchemaOptional (SchemaText '[TEnum '["foo", "bar"]]))]
58−```
59−
60−* This schema says that's structurally it's a JSON object which has two fields:
61− * field "foo" contains an array of numeric values
62− * field "bar" contains an optional text value
63−* It also allows you to validate JSON values itself:
64− * an array in "foo" contains exactly one element
65− * that element must be strictly greater than 10
66− * value of "bar" field must be either "foo" or "bar" if presented
67−
68−
69−This one is valid for example
70−
71−```haskell
72−schemaJson :: ByteString
73−schemaJson = "{\"foo\": [13], \"bar\": null}"
74−```
75−
76−Also valid
77−
78−```haskell
79−schemaJson :: ByteString
80−schemaJson = "{\"foo\": [13], \"bar\": \"bar\"}"
81−```
82−
83−it can be parsed and validated like this:
84−
85−```haskell
86−decodeAndValidateJson schemaJson :: ParseResult (JsonRepr SchemaExample)
87−```
88−
89−`ParseResult` type encodes three possible situations:
90−* json is structurally consistent with a schema and runtime validations pass
91−* json source is malformed or doesn't correspond to a schema structurally
92−* some of the runtime validations have failed, but it's structurally correct
93− overall
94−
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−```
106−
107−The most basic and sugar-free way of constructing the same object will look like this:
108−
109−```
110−jsonExample' :: JsonRepr SchemaExample
111−jsonExample' = ReprObject $
112− FieldRepr (ReprArray [ReprNumber 12])
113− :& FieldRepr (ReprOptional (Just (ReprText "bar")))
114− :& RNil
115−```
116−
117−## Lens-compatibility
118−
119−It's possible to use `flens` to construct a field lens for a typed object in schematic. Let's suppose you have a schema like this:
120−
121−```haskell
122−type ArraySchema = SchemaArray '[AEq 1] (SchemaNumber '[NGt 10])
123−
124−type ArrayField = '("foo", ArraySchema)
125−
126−type FieldsSchema =
127− '[ ArrayField, '("bar", SchemaOptional (SchemaText '[TEnum '["foo", "bar"]]))]
128−
129−type SchemaExample = 'SchemaObject FieldsSchema
130−
131−```
132−
133−There are two ways of working with named fields in the objects:
134−
135−* Using the `fget` and `fset` functions: `fget @"foo" (fput newFooVal objectData) == newFooVal`
136−* Using the lens library: `set (flens @"foo") newFooVal objectData ^. flens @"foo" == newFooVal`
137−
138−## Migrations
139−
140−Usually migrations are implicit and hard to deal with, `schematic` deals with it
141−by giving tools to deal with it to a programmer, being as explicit as possible,
142−notifying the developer of a missing transition with a compile-time error.
143−It allows to build versioned HTTP APIs or migrate data from the older versions
144−when reading from the JSON storages.
145−
146−It's possible to represent schema changes as a series of migrations,
147−which describes a series of json-path/change pairs. Migrations can be applied in
148−succession.
149−
150−This piece of code will apply a migration to the schema, decode and validate the latest version.
151−
152−```haskell
153−type SchemaExample
154− = SchemaObject
155− '[ '("foo", SchemaArray '[AEq 1] (SchemaNumber '[NGt 10]))
156− , '("bar", SchemaOptional (SchemaText '[TEnum '["foo", "bar"]]))]
157−
158−type TestMigration =
159− 'Migration "test_revision"
160− '[ Diff '[ PKey "bar" ] (Update (SchemaText '[]))
161− , Diff '[ PKey "foo" ] (Update (SchemaNumber '[])) ]
162−
163−type VS = 'Versioned SchemaExample '[ TestMigration ]
164−
165−schemaJsonTopVersion :: ByteString
166−schemaJsonTopVersion = "{ \"foo\": 42, \"bar\": \"bar\" }"
167−```
168−
169−It's possible to decode the latest version like this:
170−
171−```
172−decodeAndValidateJson schemaJsonTopVersion :: ParseResult (JsonRepr (TopVersion (AllVersions VS)))
173−```
174−
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
204−
205−migrationList :: MigrationList Identity VersionedJson
206−migrationList
207− = (migrateObject (\r -> Identity $ field @"quuz" 42 :& r))
208− :&& shrinkObject
209− :&& MNil
210−
211−```
212−
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`?
225−
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:
232−
233−```haskell
234−type SchemaExample = 'SchemaObject
235− '[ '("foo", SchemaArray '[ AEq 1] (SchemaNumber '[NGt 10]))
236− , '("bar", SchemaOptional (SchemaText '[TEnum '["foo", "bar"]]))]
237−
238−jsonExample = withRepr @SchemaExample
239− $ field @"bar" (Just "bar")
240− :& field @"foo" [12]
241− :& RNil
242−```
243−
244−`@foo` syntax is an explicit type application, which is a feature of GHC 8+, it
245−makes type inference possible without relying on a bunch of `Proxy`s, which
246−makes it syntactically more terse.
247−
248−[GHC Type Applications](https://ghc.haskell.org/trac/ghc/wiki/TypeApplication)
249−
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.
253−
254−
255−## Export to json-schema (draft 4)
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+46−50
@@ -1,43 +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.5.0.0
5+version: 0.1.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
1315extra-source-files: ChangeLog.md
1416cabal-version: >=1.10
1517
1618library
17− exposed-modules: Data.Schematic
18− , Data.Schematic.DSL
19− , Data.Schematic.Generator
20− , Data.Schematic.Generator.Regex
21− , Data.Schematic.Instances
22− , Data.Schematic.JsonSchema
23− , Data.Schematic.Helpers
24− , Data.Schematic.Lens
25− , Data.Schematic.Migration
26− , Data.Schematic.Path
19+ exposed-modules: Data.Aeson.Validation
20+ , Data.Schematic
2721 , Data.Schematic.Schema
28− , Data.Schematic.Validation
29− , Data.Schematic.Verifier
30− , Data.Schematic.Verifier.Array
31− , Data.Schematic.Verifier.Common
32− , Data.Schematic.Verifier.Number
33− , Data.Schematic.Verifier.Text
34− ghc-options: -Wall
22+ , Data.Schematic.Utils
23+ -- ghc-options:
24+ -- other-modules:
3525 default-extensions: ConstraintKinds
3626 , DataKinds
3727 , DefaultSignatures
3828 , DeriveFunctor
3929 , DeriveFoldable
40− , DeriveTraversable
4130 , DeriveGeneric
4231 , DeriveDataTypeable
4332 , FlexibleContexts
@@ -60,29 +49,20 @@ library
6049 , TemplateHaskell
6150 , TypeApplications
6251 , TypeFamilies
63− , TypeFamilyDependencies
6452 , TypeInType
6553 , TypeOperators
6654 , TypeSynonymInstances
6755 , UndecidableInstances
68− build-depends: base >=4.11 && <4.13
69− , bytestring
56+ build-depends: base >=4.9 && <4.10
7057 , aeson >= 1
71− , containers
72− , hjsonschema
73− , mtl
74− , profunctors
75− , regex-tdfa
76− , regex-tdfa-text
58+ , deriving-compat
59+ , regex-compat
7760 , scientific
78− , singletons >= 2.4
61+ , singletons
7962 , smallcheck
80− , tagged
81− , template-haskell
8263 , text
83− , union
8464 , unordered-containers
85− , validationt >= 0.2.1.0
65+ , validationt >= 0.1.0.1
8666 , vector
8767 , vinyl
8868 hs-source-dirs: src
@@ -93,28 +73,44 @@ test-suite spec
9373 hs-source-dirs: test
9474 main-is: Spec.hs
9575 default-language: Haskell2010
76+ default-extensions: ConstraintKinds
77+ , DataKinds
78+ , DeriveFunctor
79+ , DeriveFoldable
80+ , DeriveGeneric
81+ , DeriveDataTypeable
82+ , FlexibleContexts
83+ , FlexibleInstances
84+ , FunctionalDependencies
85+ , GADTs
86+ , KindSignatures
87+ , InstanceSigs
88+ , MultiParamTypeClasses
89+ , OverloadedLists
90+ , OverloadedStrings
91+ , PolyKinds
92+ , QuasiQuotes
93+ , PartialTypeSignatures
94+ , RecordWildCards
95+ , ScopedTypeVariables
96+ , TemplateHaskell
97+ , TypeApplications
98+ , TypeFamilies
99+ , TypeInType
100+ , TypeOperators
101+ , TypeSynonymInstances
96102 build-depends: HUnit
97103 , aeson >= 1
98− , base >=4.11 && <4.13
99− , bytestring
100− , containers
101− , hjsonschema
104+ , base >=4.9 && <4.10
102105 , hspec >= 2.2.0
103106 , hspec-core
104107 , hspec-discover
105108 , hspec-smallcheck
106− , lens
107− , regex-tdfa
108− , regex-tdfa-text
109+ , regex-compat
109110 , schematic
110− , smallcheck
111111 , singletons
112− , tagged
113112 , text
114113 , unordered-containers
115− , validationt >= 0.2.1.0
114+ , validationt >= 0.1.0.1
116115 , vinyl
117− other-modules: SchemaSpec
118− , HelpersSpec
119− , LensSpec
120− , JsonSchemaSpec
116+ other-modules: SchemaSpec
src/Data/Aeson/Validation.hsnew file+82
@@ -0,0 +1,82 @@
1+module Data.Aeson.Validation where
2+
3+
4+import Control.Applicative
5+import Control.Monad
6+import Data.Aeson.Types as J
7+import Data.Foldable as F
8+import Data.HashMap.Strict as H
9+import Data.Maybe
10+import Data.Proxy
11+import Data.Schematic.Schema
12+import Data.Singletons
13+import Data.Singletons.Decide
14+import Data.Text as T
15+import Data.Traversable
16+
17+(<&&>) :: Applicative f => f Bool -> f Bool -> f Bool
18+(<&&>) = liftA2 (&&)
19+
20+infixl 3 <&&>
21+
22+-- validateConstraint
23+-- :: TopLevel spec
24+-- => Sing spec
25+-- -> CRepr spec
26+-- -> Value
27+-- -> Maybe Bool
28+-- validateConstraint s c = \case
29+-- J.String t -> case s %~ SJText of
30+-- Proved Refl -> pure $ case fromSing c of
31+-- TEq n -> (== n) . fromIntegral . T.length $ t
32+-- TLe n -> (<= n) . fromIntegral . T.length $ t
33+-- TGt n -> (> n) . fromIntegral . T.length $ t
34+-- Disproved _ -> mzero
35+-- J.Number i -> case s %~ SJNumber of
36+-- Proved Refl -> pure $ case fromSing c of
37+-- NEq n -> i == fromIntegral n
38+-- NLe n -> i <= fromIntegral n
39+-- NGt n -> i > fromIntegral n
40+-- Disproved _ -> mzero
41+-- J.Array v -> case s %~ SJArray of
42+-- Proved Refl -> case fromSing c of
43+-- AEq n -> pure . (== fromIntegral n) . F.length $ v
44+-- Disproved _ -> Nothing
45+-- J.Null -> Just True
46+-- _ -> Just False
47+
48+-- validateConstraints
49+-- :: SDecide JType
50+-- => Sing jtype
51+-- -> [CRepr jtype]
52+-- -> Value
53+-- -> Maybe Bool
54+-- validateConstraints s cs v = and <$> traverse alg cs
55+-- where
56+-- alg c = validateConstraint s c v
57+
58+-- validateJson
59+-- :: (SDecide JType, TopLevel spec)
60+-- => Sing spec
61+-- -> Value
62+-- -> Maybe Bool
63+-- validateJson = validateBySchema . fromSing
64+
65+-- validateBySchema
66+-- :: SDecide JType
67+-- => Schema
68+-- -> Value
69+-- -> Maybe Bool
70+-- validateBySchema s v = case (unfix s, v) of
71+-- (SchemaArray cs ss, jv@(J.Array v)) -> do
72+-- itself <- validateConstraints SJArray cs jv
73+-- content <- traverse (validateBySchema ss) v
74+-- pure $ itself && and content
75+-- (SchemaObject ocs, J.Object o) -> do
76+-- fmap and $ for ocs $ \(fieldName, s) -> do
77+-- val <- H.lookup (T.pack fieldName) o
78+-- validateBySchema s val
79+-- (SchemaText cs, js@(J.String _)) -> validateConstraints SJText cs js
80+-- (SchemaNumber cs, jn@(J.Number _)) -> validateConstraints SJNumber cs jn
81+-- (SchemaNull, J.Null) -> Just True
82+-- _ -> Nothing
src/Data/Schematic.hs+3−99
@@ -1,103 +1,7 @@
1−{-# OPTIONS -fprint-explicit-kinds #-}
2−{-# LANGUAGE AllowAmbiguousTypes #-}
3−
41module Data.Schematic
5− ( module Data.Schematic.JsonSchema
6− , module Data.Schematic.Helpers
7− , module Data.Schematic.Lens
8− , module Data.Schematic.Migration
9− , module Data.Schematic.Schema
10− , decodeAndValidateJson
11− , parseAndValidateJson
12− , parseAndValidateJsonBy
13− , parseAndValidateTopVersionJson
14− , parseAndValidateWithMList
15− , decodeAndValidateVersionedWithMList
16− , decodeAndValidateVersionedWithPureMList
17− , isValid
18− , isDecodingError
19− , isValidationError
20− , ParseResult(..)
21− , withRepr
22− , field
2+ ( module Data.Schematic.Schema
3+ , module Data.Schematic.Utils
234 ) where
245
25−import Control.Monad.Validation
26−import Data.Aeson as J
27−import Data.Aeson.Types as J
28−import Data.ByteString.Lazy as BL
29−import Data.Functor.Identity as F
30−import Data.Schematic.DSL
31−import Data.Schematic.Helpers
32−import Data.Schematic.JsonSchema
33−import Data.Schematic.Lens
34−import Data.Schematic.Migration
356import Data.Schematic.Schema
36−import Data.Schematic.Validation
37−import Data.Singletons.Prelude hiding ((:.))
38−import Data.Tagged
39−import Data.Text as T
40−
41−
42−parseAndValidateTopVersionJson
43− :: forall proxy (v :: Versioned)
44− . (SingI (TopVersion (AllVersions v)))
45− => proxy v
46− -> J.Value
47− -> ParseResult (JsonRepr (TopVersion (AllVersions v)))
48−parseAndValidateTopVersionJson _ v =
49− case parseEither parseJSON v of
50− Left s -> DecodingError $ T.pack s
51− Right jsonRepr ->
52− let
53− validate =
54− validateJsonRepr (sing :: Sing (TopVersion (AllVersions v))) [] jsonRepr
55− res = runIdentity . runValidationTEither $ validate
56− in case res of
57− Left em -> ValidationError em
58− Right () -> Valid jsonRepr
59−
60−parseAndValidateWithMList
61− :: Monad m
62− => MList m revisions
63− -> J.Value
64− -> m (ParseResult (JsonRepr (Head revisions)))
65−parseAndValidateWithMList MNil v = pure $ parseAndValidateJson v
66−parseAndValidateWithMList (Tagged f :&& tl) v =
67− case parseAndValidateJsonBy Proxy v of
68− Valid a -> pure $ Valid a
69− DecodingError _ -> do
70− pr <- parseAndValidateWithMList tl v
71− let pr' = f <$> pr
72− sequence pr'
73− ValidationError _ -> do
74− pr <- parseAndValidateWithMList tl v
75− let pr' = f <$> pr
76− sequence pr'
77−
78−decodeAndValidateJson
79− :: forall schema
80− . (J.FromJSON (JsonRepr schema), TopLevel schema, SingI schema)
81− => BL.ByteString
82− -> ParseResult (JsonRepr schema)
83−decodeAndValidateJson bs = case decode bs of
84− Nothing -> DecodingError "malformed json"
85− Just x -> parseAndValidateJson x
86−
87−decodeAndValidateVersionedWithMList
88− :: Monad m
89− => proxy versioned
90− -> MList m (MapSnd (AllVersions versioned))
91− -> BL.ByteString
92− -> m (ParseResult (JsonRepr (Head (MapSnd (AllVersions versioned)))))
93−decodeAndValidateVersionedWithMList _ mlist bs = case decode bs of
94− Nothing -> pure $ DecodingError "malformed json"
95− Just x -> parseAndValidateWithMList mlist x
96−
97−decodeAndValidateVersionedWithPureMList
98− :: proxy versioned
99− -> MList F.Identity (MapSnd (AllVersions versioned))
100− -> BL.ByteString
101− -> ParseResult (JsonRepr (Head (MapSnd (AllVersions versioned))))
102−decodeAndValidateVersionedWithPureMList a b c =
103− runIdentity $ decodeAndValidateVersionedWithMList a b c
7+import Data.Schematic.Utils
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.hsdeleted−27
@@ -1,27 +0,0 @@
1−{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# OPTIONS_GHC -fno-warn-orphans #-}
3−
4−module Data.Schematic.Instances where
5−
6−import Data.Scientific
7−import Data.Text (Text, pack)
8−import Data.Vector as V
9−import Data.Vinyl
10−import Test.SmallCheck.Series
11−
12−
13−instance Monad m => Serial m (Rec f '[]) where
14− series = cons0 RNil
15−
16−instance (Serial m (f a), Serial m (Rec f as), Monad m)
17− => Serial m (Rec f (a ': as)) where
18− series = cons2 (:&)
19−
20−instance Serial m a => Serial m (V.Vector a) where
21− series = V.fromList <$> series
22−
23−instance Monad m => Serial m Scientific where
24− series = scientific <$> series <*> series
25−
26−instance Monad m => Serial m Text where
27− series = pack <$> series
src/Data/Schematic/JsonSchema.hsdeleted−124
@@ -1,124 +0,0 @@
1−{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# LANGUAGE RecordWildCards #-}
3−{-# LANGUAGE OverloadedLabels #-}
4−{-# LANGUAGE TemplateHaskell #-}
5−
6−module Data.Schematic.JsonSchema
7− ( toJsonSchema
8− , toJsonSchema'
9− ) where
10−
11−import Control.Monad.State.Strict
12−import Data.Aeson as J
13−import Data.Foldable as F
14−import Data.HashMap.Strict as H
15−import Data.List as L
16−import Data.List.NonEmpty as NE
17−import Data.Schematic.Schema as S
18−import Data.Set as Set
19−import Data.Singletons
20−import Data.Text
21−import Data.Traversable
22−import JSONSchema.Draft4.Schema as D4
23−import JSONSchema.Validator.Draft4 as D4
24−
25−
26−draft4 :: Text
27−draft4 = "http://json-schema.org/draft-04/schema#"
28−
29−textConstraint :: 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' }
46−
47−numberConstraint :: 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 }
61−
62−arrayConstraint :: 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 }
75−
76−toJsonSchema
77− :: forall proxy schema
78− . SingI schema
79− => proxy (schema :: S.Schema)
80− -> Maybe D4.Schema
81−toJsonSchema _ = do
82− js <- toJsonSchema' $ fromSing (sing :: Sing schema)
83− pure $ js { _schemaVersion = pure draft4 }
84−
85−toJsonSchema'
86− :: DemotedSchema
87− -> Maybe D4.Schema
88−toJsonSchema' = \case
89− DSchemaText tcs ->
90− pure $ execState (traverse_ textConstraint tcs) $ emptySchema
91− { _schemaType = pure $ TypeValidatorString D4.SchemaString }
92− DSchemaNumber ncs ->
93− pure $ execState (traverse_ numberConstraint ncs) $ emptySchema
94− { _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 }
src/Data/Schematic/Lens.hsdeleted−207
@@ -1,207 +0,0 @@
1−{-# LANGUAGE UndecidableSuperClasses #-}
2−{-# LANGUAGE GeneralizedNewtypeDeriving #-}
3−{-# LANGUAGE AllowAmbiguousTypes #-}
4−{-# LANGUAGE InstanceSigs #-}
5−
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
25−
26−import Data.Profunctor
27−import 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
33−import Data.Vinyl
34−import Data.Vinyl.Functor
35−import Data.Vinyl.TypeLevel (Nat(..))
36−import GHC.TypeLits (Symbol, KnownSymbol)
37−
38−
39−-- | A partial relation that gives the index of a value in a list.
40−type 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))
51−
52−class 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
55−
56− -- | For Vinyl users who are not using the @lens@ package, we provide a getter.
57− fget :: FGetter fn f rs i
58−
59− -- | For Vinyl users who are not using the @lens@ package, we also provide a
60− -- setter. In general, it will be unambiguous what field is being written to,
61− -- and so we do not take a proxy argument here.
62− fput
63− :: f '(fn, ByField fn rs i)
64− -> Rec f rs
65− -> Rec f rs
66−
67−instance FElem fn ('(fn, r) ': rs) 'Z where
68− type ByField fn ('(fn, r) ': rs) 'Z = r
69−
70− flens f (x :& xs) = fmap (:& xs) (f x)
71− {-# INLINE flens #-}
72−
73− fget = getConst . flens Const
74− {-# INLINE fget #-}
75−
76− fput y = getIdentity . flens (\_ -> Identity y)
77− {-# INLINE fput #-}
78−
79−instance (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
81−
82− flens f (x :& xs) = fmap (x :&) (flens f xs)
83− {-# INLINE flens #-}
84−
85− fget = getConst . flens Const
86− {-# INLINE fget #-}
87−
88− fput y = getIdentity . flens (\_ -> Identity y)
89− {-# INLINE fput #-}
90−
91−-- This is an internal convenience helpers stolen from the @lens@ library.
92−lens
93− :: Functor f
94− => (t -> s)
95− -> (t -> a -> b)
96− -> (s -> f a)
97− -> t
98− -> f b
99−lens sa sbt afb s = fmap (sbt s) $ afb (sa s)
100−{-# INLINE lens #-}
101−
102−type Iso s t a b = forall p f. (Profunctor p, Functor f) => p a (f b) -> p s (f t)
103−
104−type Iso' s a = Iso s s a a
105−
106−iso
107− :: (s -> a) -> (b -> t)
108− -> Iso s t a b
109−iso sa bt = dimap sa (fmap bt)
110−{-# INLINE iso #-}
111−
112−-- | A partial relation that gives the indices of a sublist in a larger list.
113−type family FImage (rs :: [(Symbol, Schema)]) (ss :: [(Symbol, Schema)]) :: [Nat] where
114− FImage '[] ss = '[]
115− FImage ('(fn,s) ': rs) ss = FIndex fn ss ': FImage rs ss
116−
117−class is ~ FImage rs ss
118− => FSubset (rs :: [(Symbol, Schema)]) (ss :: [(Symbol, Schema)]) is where
119− -- | This is a lens into a slice of the larger record. Morally, we have:
120− --
121− -- > fsubset :: Lens' (Rec FieldRepr ss) (Rec FieldRepr rs)
122− fsubset
123− :: Functor g
124− => (Rec f rs -> g (Rec f rs))
125− -> Rec f ss
126− -> g (Rec f ss)
127−
128− -- | The getter of the 'fsubset' lens is 'fcast', which takes a larger record
129− -- to a smaller one by forgetting fields.
130− fcast
131− :: Rec f ss
132− -> Rec f rs
133− fcast = getConst . fsubset Const
134− {-# INLINE fcast #-}
135−
136− -- | The setter of the 'fsubset' lens is 'freplace', which allows a slice of
137− -- a record to be replaced with different values.
138− freplace
139− :: Rec f rs
140− -> Rec f ss
141− -> Rec f ss
142− freplace rs = getIdentity . fsubset (\_ -> Identity rs)
143− {-# INLINE freplace #-}
144−
145−instance FSubset '[] ss '[] where
146− fsubset = lens (const RNil) const
147−
148−instance
149− ( ByField fn ss i ~ s
150− , FElem fn ss i
151− , FSubset rs ss is) => FSubset ( '(fn,s) ': rs) ss (i ': is) where
152− fsubset = lens (\ss -> fget @fn ss :& fcast ss) set
153− where
154− set :: Rec f ss -> Rec f ( '(fn,s) ': rs) -> Rec f ss
155− set ss (r :& rs) = fput r $ freplace rs ss
156−
157−-- A bunch of @Iso@morphisms
158−textRepr
159− :: (KnownSymbol fn, SingI cs)
160− => Iso' (FieldRepr '(fn, ('SchemaText cs))) Text
161−textRepr = iso (\(FieldRepr (ReprText t)) -> t) (FieldRepr . ReprText)
162−
163−numberRepr
164− :: (KnownSymbol fn, SingI cs)
165− => Iso' (FieldRepr '(fn, ('SchemaNumber cs))) Scientific
166−numberRepr = iso (\(FieldRepr (ReprNumber n)) -> n) (FieldRepr . ReprNumber)
167−
168−boolRepr
169− :: (KnownSymbol fn)
170− => Iso' (FieldRepr '(fn, 'SchemaBoolean)) Bool
171−boolRepr = iso (\(FieldRepr (ReprBoolean b)) -> b) (FieldRepr . ReprBoolean)
172−
173−arrayRepr
174− :: (KnownSymbol fn, SingI cs, SingI schema)
175− => Iso' (FieldRepr '(fn, ('SchemaArray cs schema))) (V.Vector (JsonRepr schema))
176−arrayRepr = iso (\(FieldRepr (ReprArray a)) -> a) (FieldRepr . ReprArray)
177−
178−objectRepr
179− :: (KnownSymbol fn, SingI fields)
180− => Iso' (FieldRepr '(fn, ('SchemaObject fields))) (Rec FieldRepr fields)
181−objectRepr = iso (\(FieldRepr (ReprObject o)) -> o) (FieldRepr . ReprObject)
182−
183−optionalRepr
184− :: (KnownSymbol fn, SingI schema)
185− => Iso' (FieldRepr '(fn, ('SchemaOptional schema))) (Maybe (JsonRepr schema))
186−optionalRepr = iso (\(FieldRepr (ReprOptional r)) -> r) (FieldRepr . ReprOptional)
187−
188−obj :: Iso' (JsonRepr ('SchemaObject fields)) (Rec FieldRepr fields)
189−obj = iso (\(ReprObject r) -> r) ReprObject
190−
191−arr :: Iso' (JsonRepr ('SchemaArray cs schema)) (V.Vector (JsonRepr schema))
192−arr = iso (\(ReprArray r) -> r) ReprArray
193−
194−uni :: Iso' (JsonRepr ('SchemaUnion (h ': tl))) (Union JsonRepr (h ': tl))
195−uni = iso (\(ReprUnion u) -> u) ReprUnion
196−
197−txt :: Iso' (JsonRepr ('SchemaText cs)) Text
198−txt = iso (\(ReprText t) -> t) ReprText
199−
200−num :: Iso' (JsonRepr ('SchemaNumber cs)) Scientific
201−num = iso (\(ReprNumber t) -> t) ReprNumber
202−
203−bln :: Iso' (JsonRepr 'SchemaBoolean) Bool
204−bln = iso (\(ReprBoolean b) -> b) ReprBoolean
205−
206−opt :: Iso' (JsonRepr ('SchemaOptional schema)) (Maybe (JsonRepr schema))
207−opt = iso (\(ReprOptional o) -> o) ReprOptional
src/Data/Schematic/Migration.hsdeleted−187
@@ -1,187 +0,0 @@
1−{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# LANGUAGE CPP #-}
3−{-# LANGUAGE TemplateHaskell #-}
4−
5−module Data.Schematic.Migration where
6−
7−import Data.Kind
8−import Data.Schematic.DSL
9−import Data.Schematic.Lens
10−import Data.Schematic.Path
11−import Data.Schematic.Schema
12−import Data.Singletons.Prelude hiding ((:.), All)
13−import Data.Singletons.TypeLits
14−import Data.Tagged
15−import Data.Vinyl
16−import Data.Vinyl.Functor
17−
18−
19−data Path
20− = PKey Symbol -- traverse into the object by key
21− | PTraverse -- traverse into the array
22−
23−data instance Sing (p :: Path) where
24− SPKey :: Sing s -> Sing ('PKey s)
25− SPTraverse :: Sing 'PTraverse
26−
27−instance KnownSymbol s => SingI ('PKey s) where
28− sing = SPKey sing
29−
30−instance SingI 'PTraverse where
31− sing = SPTraverse
32−
33−-- Result type blueprint
34−data Builder
35− = BKey Schema Symbol Builder -- field schema
36− | BTraverse Schema Builder -- array schema
37− | BScalar Schema
38−
39−-- Working with keys
40−
41−type family SchemaByKey (fs :: [(Symbol, Schema)]) (s :: Symbol) :: Schema where
42− SchemaByKey ( '(fn,s) ': tl) fn = s
43− SchemaByKey ( '(a, s) ': tl) fn = SchemaByKey tl fn
44−
45−type 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)
48−
49−type family UpdateKey
50− (fn :: Symbol)
51− (fs :: [(Symbol, Schema)])
52− (s :: Schema) = (r :: [(Symbol, Schema)]) where
53− UpdateKey fn ( '(fn, a) ': tl ) s = ( '(fn, s) ': tl )
54− UpdateKey fn ( '(fs, a) ': tl ) s = ( '(fs, a) ': UpdateKey fn tl s)
55−
56−-- schema updates
57−
58−type family Build (b :: Builder) :: Schema where
59− Build ('BKey ('SchemaObject fs) fn z) = 'SchemaObject (UpdateKey fn fs (Build z))
60− Build ('BTraverse ('SchemaArray acs s) z) = 'SchemaArray acs (Build z)
61− Build ('BScalar s) = s
62−
63−type family MakeBuilder (s :: Schema) (d :: Diff) :: Builder where
64− MakeBuilder s ('Diff '[] a) = 'BScalar (ApplyAction a s)
65− MakeBuilder ('SchemaObject fs) ('Diff ('PKey fn ': tl) a) =
66− 'BKey ('SchemaObject fs) fn (MakeBuilder (SchemaByKey fs fn) ('Diff tl a))
67− MakeBuilder ('SchemaArray acs s) ('Diff ('PTraverse ': tl) a) =
68− 'BTraverse ('SchemaArray acs s) (MakeBuilder s ('Diff tl a))
69−
70−type family ApplyAction (a :: Action) (s :: Schema) :: Schema where
71− ApplyAction ('AddKey fn s) ('SchemaObject fs) = 'SchemaObject ('(fn,s) ': fs)
72− ApplyAction ('DeleteKey fn) ('SchemaObject fs) = 'SchemaObject (DeleteKey '[] fn fs)
73− ApplyAction ('Update s) t = s
74−
75−type family ApplyMigration (m :: Migration) (s :: Schema) :: (Revision, Schema) where
76− ApplyMigration ('Migration r '[]) s = '(r, s)
77− ApplyMigration ('Migration r (d ': ds)) s =
78− '(r, Snd (ApplyMigration ('Migration r ds) (Build (MakeBuilder s d))))
79−
80−-- working with revisions
81−
82−type family SchemaByRevision (r :: Revision) (vd :: Versioned) :: Schema where
83− SchemaByRevision r ('Versioned s (('Migration r ds) ': ms)) =
84− Snd (ApplyMigration ('Migration r ds) s)
85− SchemaByRevision r ('Versioned s (m ': ms)) =
86− SchemaByRevision r ('Versioned (Snd (ApplyMigration m s)) ms)
87−
88−type family InitialSchema (v :: Versioned) = (s :: Schema) where
89− InitialSchema ('Versioned s ms) = s
90−
91−type family ElemOf (e :: k) (l :: [(a,k)]) :: Constraint where
92− ElemOf e '[] = 'True ~ 'False
93− ElemOf e ( '(a, e) ': es) = ()
94− ElemOf e (n ': es) = ElemOf e es
95−
96−-- | Extracts revision/schema pairs from @Versioned@ in reverse order.
97−type family AllVersions (vd :: Versioned) :: [(Revision, Schema)] where
98− AllVersions ('Versioned s ms) = Reverse (AllVersions' '[ '("initial", s) ] ms)
99−
100−type family AllVersions' (acc :: [(Revision, Schema)]) (ms :: [Migration])
101− = (r :: [(Revision, Schema)]) where
102− AllVersions' acc '[] = acc
103− AllVersions' ( '(rh, sh) ': tl ) (m ': ms) =
104− AllVersions' ( '(rh, sh) ': ApplyMigration m sh ': tl ) ms
105−
106−type family TopVersion (rs :: [(Revision, Schema)]) :: Schema where
107− TopVersion ( '(rh, sh) ': tl) = sh
108−
109−data Action = AddKey Symbol Schema | Update Schema | DeleteKey Symbol
110−
111−data instance Sing (a :: Action) where
112− SAddKey
113− :: Sing n
114− -> Sing s
115− -> Sing ('AddKey n s)
116− SUpdate :: Sing s -> Sing ('Update s)
117− SDeleteKey :: Sing s -> Sing ('DeleteKey s)
118−
119−-- | User-supplied atomic difference between schemas.
120−-- Migrations can consists of many differences.
121−data Diff = Diff [Path] Action
122−
123−data instance Sing (diff :: Diff) where
124− SDiff
125− :: Sing (jp :: [Path])
126− -> Sing (a :: Action)
127− -> Sing ('Diff jp a)
128−
129−-- | User-provided name of the revision.
130−type Revision = Symbol
131−
132−data Migration = Migration Revision [Diff]
133−
134−data instance Sing (m :: Migration) where
135− SMigration
136− :: Sing r
137− -> Sing ds
138− -> Sing ('Migration r ds)
139−
140−data Versioned = Versioned Schema [Migration]
141−
142−data instance Sing (v :: Versioned) where
143− SVersioned
144− :: Sing (s :: Schema) -- base version
145− -> Sing (ms :: [Migration]) -- a bunch of migrations
146− -> Sing ('Versioned s ms)
147−
148−type DataMigration s m h = Tagged s (JsonRepr h -> m (JsonRepr s))
149−
150−data MList :: (Type -> Type) -> [Schema] -> Type where
151− MNil :: (Monad m, SingI s, TopLevel s) => MList m '[s]
152− (:&&)
153− :: (TopLevel s, SingI s)
154− => DataMigration s m h
155− -> MList m (h ': tl)
156− -> MList m (s ': h ': tl)
157−
158−infixr 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/OldSchema.hsnew file+76
@@ -0,0 +1,76 @@
1+{-# LANGUAGE AllowAmbiguousTypes #-}
2+
3+module Data.Schematic.Schema where
4+
5+import Data.Maybe
6+import Data.Proxy
7+import GHC.TypeLits
8+import Text.Regex
9+
10+
11+-- JSON types
12+data JText
13+data JNumber
14+data JArray
15+data JObject
16+data JNull
17+
18+type family Repr (ty :: k1) :: k2 where
19+ Repr JText = String -- because of matchRegex
20+ Repr JNumber = Double
21+
22+class Schema schema where
23+ type Term subschema
24+ predicate :: Repr (Term ty) -> Bool
25+
26+data Regexp (s :: Symbol) = Regexp
27+
28+instance KnownSymbol reg => Schema (Regexp reg) subschema where
29+ type Term (Regexp reg) subschema = Term ((), subschema)
30+ predicate = isJust . matchRegex (mkRegex $ symbolVal (Proxy :: Proxy reg))
31+
32+data LengthEqNat (n :: Nat)
33+data LengthGtNat (n :: Nat)
34+data LengthGeNat (n :: Nat)
35+data LengthLtNat (n :: Nat)
36+data LengthLeNat (n :: Nat)
37+
38+instance KnownNat n => Schema (LengthEqNat n) subschema where
39+ type Term (LengthEqNat n) s = Term s
40+ predicate s = natVal (Proxy :: Proxy n) == fromIntegral (length s)
41+ && predicate
42+
43+instance KnownNat n => Schema (LengthGtNat n) rest where
44+ type Term (LengthGtNat n) = JNumber
45+ predicate s = natVal (Proxy :: Proxy n) > fromIntegral (length s)
46+
47+instance KnownNat n => Schema (LengthGeNat n) rest where
48+ type Term (LengthGeNat n) = JNumber
49+ predicate s = natVal (Proxy :: Proxy n) >= fromIntegral (length s)
50+
51+instance KnownNat n => Schema (LengthLtNat n) rest where
52+ type Term (LengthLtNat n) = JNumber
53+ predicate s = natVal (Proxy :: Proxy n) < fromIntegral (length s)
54+
55+instance KnownNat n => Schema (LengthLeNat n) rest where
56+ type Term (LengthLeNat n) = JNumber
57+ predicate s = natVal (Proxy :: Proxy n) <= fromIntegral (length s)
58+
59+-- | Corresponds to [] or {} json values.
60+data EmptyObj = EmptyObj
61+
62+data ConsObj (s :: Symbol) jsval = ConsObj
63+
64+-- data Schema a where
65+-- (:*:) :: KnownSymbol label => label -> Schema l -> Schema r -> Schema a
66+-- (:%:) :: Schema c a => Schema a -> c a -> Schema a
67+-- Nil :: Schema a
68+
69+data (s :: Symbol) :+: obj = (:+:) a b
70+
71+infixl 6 :+:
72+infixl 6 :*:
73+infixl 9 :%:
74+
75+schema :: Schema ()
76+schema = "foo" :%: (Regexp "foo") :*: Nil
src/Data/Schematic/Path.hsdeleted−39
@@ -1,39 +0,0 @@
1−module Data.Schematic.Path where
2−
3−import Data.Foldable as F
4−import Data.Singletons.Prelude
5−import Data.Singletons.TypeLits
6−import Data.Text as T
7−
8−
9−data PathSegment = Key Symbol | Ix Nat
10−
11−data instance Sing (jp :: PathSegment) where
12− SKey :: (SingI k) => Sing (k :: Symbol) -> Sing ('Key k)
13− SIx :: (SingI n) => Sing (n :: Nat) -> Sing ('Ix n)
14−
15−data DemotedPathSegment = DKey Text | DIx Integer
16− deriving (Show)
17−
18−-- | Textual representation of json path.
19−newtype JSONPath = JSONPath Text
20− deriving (Show)
21−
22−demotePath :: Sing (ps :: [PathSegment]) -> [DemotedPathSegment]
23−demotePath = go []
24− where
25− go :: [DemotedPathSegment] -> Sing (ps :: [PathSegment]) -> [DemotedPathSegment]
26− go acc SNil = acc
27− go acc (SCons p ps) = go (acc ++ [demotePathSeg p]) ps
28− demotePathSeg :: Sing (ps :: PathSegment) -> DemotedPathSegment
29− demotePathSeg (SKey s) = DKey $ T.pack $ withKnownSymbol s $ symbolVal s
30− demotePathSeg (SIx n) = DIx $ withKnownNat n $ fromIntegral $ natVal n
31−
32−demotedPathToText :: [DemotedPathSegment] -> JSONPath
33−demotedPathToText = JSONPath . F.foldl' renderPathSegment ""
34− where
35− renderPathSegment acc (DKey t) = acc <> "." <> t
36− renderPathSegment acc (DIx n) = acc <> "[" <> T.pack (show n) <> "]"
37−
38−pathToText :: Sing (ps :: [PathSegment]) -> JSONPath
39−pathToText = demotedPathToText . demotePath
src/Data/Schematic/Schema.hs+127−517
@@ -1,581 +1,192 @@
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 ((<|>))
10−import Control.Monad
11−import Data.Aeson as J
12−import Data.Aeson.Types as J
13−import Data.HashMap.Strict as H
14−import Data.Kind
15−import Data.Maybe
16−import Data.Schematic.Generator
17−import Data.Schematic.Instances ()
18−import Data.Scientific
19−import Data.Singletons.Prelude.List hiding (All, Union)
20−import Data.Singletons.TH
21−import Data.Singletons.TypeLits
22−import Data.Text as T
23−import Data.Union
24−import Data.Vector as V
25−import Data.Vinyl hiding (Dict)
26−import qualified Data.Vinyl.TypeLevel as V
27−import GHC.Exts
28−import GHC.Generics (Generic)
29−import GHC.TypeLits
30− (SomeNat(..), SomeSymbol(..), someNatVal, someSymbolVal)
31−import Prelude as P
32−import Test.SmallCheck.Series
8+import Control.Applicative
9+import Control.Category ((<<<), (>>>))
10+import Control.Monad
11+import Data.Aeson as J
12+import Data.Aeson.Types as J
13+import Data.Eq.Deriving (deriveEq1)
14+import Data.Foldable as F
15+import Data.Functor.Classes
16+import Data.HashMap.Strict as H
17+import Data.Kind
18+import Data.Maybe
19+import Data.Schematic.Utils
20+import Data.Scientific
21+import Data.Singletons.Decide
22+import Data.Singletons.Prelude.List
23+import Data.Singletons.TH
24+import Data.Singletons.TypeLits
25+import Data.Text as T
26+import Data.Vector as V
27+import Data.Vinyl hiding (Dict)
28+import Data.Vinyl.Functor
29+import GHC.Generics (Generic)
30+import Test.SmallCheck.Series
31+import Text.Show.Deriving (deriveShow1)
3332
3433
3534type family CRepr (s :: Schema) :: Type where
36− CRepr ('SchemaText cs) = TextConstraint
37− CRepr ('SchemaNumber cs) = NumberConstraint
38− CRepr ('SchemaObject fs) = (String, Schema)
39− CRepr ('SchemaArray ar s) = ArrayConstraint
35+ CRepr (SchemaText cs) = TextConstraint
36+ CRepr (SchemaNumber cs) = NumberConstraint
37+ CRepr (SchemaObject fs) = (String, Schema)
38+ CRepr (SchemaArray ar s) = ArrayConstraint
4039
4140data TextConstraint
4241 = TEq Nat
43− | TLt Nat
4442 | TLe Nat
4543 | TGt Nat
46− | TGe Nat
4744 | TRegex Symbol
48− | TEnum [Symbol]
4945 deriving (Generic)
5046
51−instance SingKind TextConstraint where
52− type Demote TextConstraint = DemotedTextConstraint
53− 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)
59− STRegex s -> withKnownSymbol s (DTRegex $ T.pack $ symbolVal s)
60− STEnum s -> let
61− d :: Sing (s :: [Symbol]) -> [Text]
62− d SNil = []
63− d (SCons ss@SSym fs) = T.pack (symbolVal ss) : d fs
64− in DTEnum $ d s
65− toSing = \case
66− DTEq n -> case someNatVal n of
67− Just (SomeNat (_ :: Proxy n)) -> SomeSing (STEq (SNat :: Sing n))
68− Nothing -> error "Negative singleton nat"
69− DTLt n -> case someNatVal n of
70− Just (SomeNat (_ :: Proxy n)) -> SomeSing (STLt (SNat :: Sing n))
71− Nothing -> error "Negative singleton nat"
72− DTLe n -> case someNatVal n of
73− Just (SomeNat (_ :: Proxy n)) -> SomeSing (STLe (SNat :: Sing n))
74− Nothing -> error "Negative singleton nat"
75− DTGt n -> case someNatVal n of
76− Just (SomeNat (_ :: Proxy n)) -> SomeSing (STGt (SNat :: Sing n))
77− Nothing -> error "Negative singleton nat"
78− DTGe n -> case someNatVal n of
79− Just (SomeNat (_ :: Proxy n)) -> SomeSing (STGe (SNat :: Sing n))
80− Nothing -> error "Negative singleton nat"
81− DTRegex s -> case someSymbolVal (T.unpack s) of
82− SomeSymbol (_ :: Proxy n) -> SomeSing (STRegex (SSym :: Sing n))
83− DTEnum ss -> case toSing ss of
84− SomeSing l -> SomeSing (STEnum l)
85−
86−data DemotedTextConstraint
87− = DTEq Integer
88− | DTLt Integer
89− | DTLe Integer
90− | DTGt Integer
91− | DTGe Integer
92− | DTRegex Text
93− | DTEnum [Text]
94− deriving (Generic, Eq, Show)
95−
9647data instance Sing (tc :: TextConstraint) where
97− STEq :: Sing n -> Sing ('TEq n)
98− STLt :: Sing n -> Sing ('TLt n)
99− STLe :: Sing n -> Sing ('TLe n)
100− STGt :: Sing n -> Sing ('TGt n)
101− STGe :: Sing n -> Sing ('TGe n)
102− STRegex :: Sing s -> Sing ('TRegex s)
103− STEnum :: Sing ss -> Sing ('TEnum ss)
104−
105−instance (KnownNat n) => SingI ('TEq n) where sing = STEq sing
106−instance (KnownNat n) => SingI ('TGt n) where sing = STGt sing
107−instance (KnownNat n) => SingI ('TGe n) where sing = STGe sing
108−instance (KnownNat n) => SingI ('TLt n) where sing = STLt sing
109−instance (KnownNat n) => SingI ('TLe n) where sing = STLe sing
110−instance (KnownSymbol s, SingI s) => SingI ('TRegex s) where sing = STRegex sing
111−instance (SingI ss) => SingI ('TEnum ss) where sing = STEnum sing
112−
113−instance Eq (Sing ('TEq n)) where _ == _ = True
114−instance Eq (Sing ('TLt n)) where _ == _ = True
115−instance Eq (Sing ('TLe n)) where _ == _ = True
116−instance Eq (Sing ('TGt n)) where _ == _ = True
117−instance Eq (Sing ('TGe n)) where _ == _ = True
118−instance Eq (Sing ('TRegex t)) where _ == _ = True
119−instance Eq (Sing ('TEnum ss)) where _ == _ = True
48+ STEq :: Sing n -> Sing (TEq n)
49+ STLe :: Sing n -> Sing (TLe n)
50+ STGt :: Sing n -> Sing (TGt n)
51+ STRegex :: Sing s -> Sing (TRegex s)
52+
53+instance Known (Sing n) => Known (Sing (TEq n)) where known = STEq known
54+instance Known (Sing n) => Known (Sing (TGt n)) where known = STGt known
55+instance Known (Sing n) => Known (Sing (TLe n)) where known = STLe known
56+instance Known (Sing s) => Known (Sing (TRegex s)) where known = STRegex known
57+
58+instance Eq (Sing (TEq n)) where a == b = True
59+instance Eq (Sing (TLe n)) where a == b = True
60+instance Eq (Sing (TGt n)) where a == b = True
12061
12162data NumberConstraint
12263 = NLe Nat
123− | NLt Nat
12464 | NGt Nat
125− | NGe Nat
12665 | NEq Nat
12766 deriving (Generic)
12867
129−data DemotedNumberConstraint
130− = DNLe Integer
131− | DNLt Integer
132− | DNGt Integer
133− | DNGe Integer
134− | DNEq Integer
135− deriving (Generic, Eq, Show)
136−
13768data instance Sing (nc :: NumberConstraint) where
138− SNEq :: Sing n -> Sing ('NEq n)
139− SNGt :: Sing n -> Sing ('NGt n)
140− SNGe :: Sing n -> Sing ('NGe n)
141− SNLt :: Sing n -> Sing ('NLt n)
142− SNLe :: Sing n -> Sing ('NLe n)
143−
144−instance KnownNat n => SingI ('NEq n) where sing = SNEq sing
145−instance KnownNat n => SingI ('NGt n) where sing = SNGt sing
146−instance KnownNat n => SingI ('NGe n) where sing = SNGe sing
147−instance KnownNat n => SingI ('NLt n) where sing = SNLt sing
148−instance KnownNat n => SingI ('NLe n) where sing = SNLe sing
149−
150−instance Eq (Sing ('NEq n)) where _ == _ = True
151−instance Eq (Sing ('NLt n)) where _ == _ = True
152−instance Eq (Sing ('NLe n)) where _ == _ = True
153−instance Eq (Sing ('NGt n)) where _ == _ = True
154−instance Eq (Sing ('NGe n)) where _ == _ = True
155−
156−instance SingKind NumberConstraint where
157− type Demote NumberConstraint = DemotedNumberConstraint
158− 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)
164− toSing = \case
165− DNEq n -> case someNatVal n of
166− Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNEq (SNat :: Sing n))
167− Nothing -> error "Negative singleton nat"
168− DNGt n -> case someNatVal n of
169− Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNGt (SNat :: Sing n))
170− Nothing -> error "Negative singleton nat"
171− DNGe n -> case someNatVal n of
172− Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNGe (SNat :: Sing n))
173− Nothing -> error "Negative singleton nat"
174− DNLt n -> case someNatVal n of
175− Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNLt (SNat :: Sing n))
176− Nothing -> error "Negative singleton nat"
177− DNLe n -> case someNatVal n of
178− Just (SomeNat (_ :: Proxy n)) -> SomeSing (SNLe (SNat :: Sing n))
179− Nothing -> error "Negative singleton nat"
69+ SNEq :: Sing n -> Sing (NEq n)
70+ SNGt :: Sing n -> Sing (NGt n)
71+ SNLe :: Sing n -> Sing (NLe n)
72+
73+instance Known (Sing n) => Known (Sing (NEq n)) where known = SNEq known
74+instance Known (Sing n) => Known (Sing (NGt n)) where known = SNGt known
75+instance Known (Sing n) => Known (Sing (NLe n)) where known = SNLe known
76+
77+instance Eq (Sing (NEq n)) where a == b = True
78+instance Eq (Sing (NLe n)) where a == b = True
79+instance Eq (Sing (NGt n)) where a == b = True
18080
18181data ArrayConstraint
18282 = AEq Nat
183− | AGt Nat
184− | AGe Nat
185− | ALt Nat
186− | ALe Nat
18783 deriving (Generic)
18884
189−data DemotedArrayConstraint
190− = DAEq Integer
191− | DAGt Integer
192− | DAGe Integer
193− | DALt Integer
194− | DALe Integer
195− deriving (Generic, Eq, Show)
196−
19785data instance Sing (ac :: ArrayConstraint) where
198− SAEq :: Sing n -> Sing ('AEq n)
199− SAGt :: Sing n -> Sing ('AGt n)
200− SAGe :: Sing n -> Sing ('AGe n)
201− SALt :: Sing n -> Sing ('ALt n)
202− SALe :: Sing n -> Sing ('ALe n)
203−
204−instance 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
209−
210−instance 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
215−
216−instance SingKind ArrayConstraint where
217− type Demote ArrayConstraint = DemotedArrayConstraint
218− 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)
224− toSing = \case
225− DAEq n -> case someNatVal n of
226− Just (SomeNat (_ :: Proxy n)) -> SomeSing (SAEq (SNat :: Sing n))
227− Nothing -> error "Negative singleton nat"
228− DAGt n -> case someNatVal n of
229− Just (SomeNat (_ :: Proxy n)) -> SomeSing (SAGt (SNat :: Sing n))
230− Nothing -> error "Negative singleton nat"
231− DAGe n -> case someNatVal n of
232− Just (SomeNat (_ :: Proxy n)) -> SomeSing (SAGe (SNat :: Sing n))
233− Nothing -> error "Negative singleton nat"
234− DALt n -> case someNatVal n of
235− Just (SomeNat (_ :: Proxy n)) -> SomeSing (SALt (SNat :: Sing n))
236− Nothing -> error "Negative singleton nat"
237− DALe n -> case someNatVal n of
238− Just (SomeNat (_ :: Proxy n)) -> SomeSing (SALe (SNat :: Sing n))
239− Nothing -> error "Negative singleton nat"
86+ SAEq :: Sing n -> Sing (AEq n)
87+
88+instance Known (Sing n) => Known (Sing (AEq n)) where known = SAEq known
89+
90+instance Eq (Sing (AEq n)) where a == b = True
24091
24192data Schema
24293 = SchemaText [TextConstraint]
243− | SchemaBoolean
24494 | SchemaNumber [NumberConstraint]
24595 | SchemaObject [(Symbol, Schema)]
24696 | SchemaArray [ArrayConstraint] Schema
24797 | SchemaNull
248− | SchemaOptional Schema
249− | SchemaUnion [Schema]
25098 deriving (Generic)
25199
252−data DemotedSchema
253− = DSchemaText [DemotedTextConstraint]
254− | DSchemaNumber [DemotedNumberConstraint]
255− | DSchemaBoolean
256− | DSchemaObject [(Text, DemotedSchema)]
257− | DSchemaArray [DemotedArrayConstraint] DemotedSchema
258− | DSchemaNull
259− | DSchemaOptional DemotedSchema
260− | DSchemaUnion [DemotedSchema]
261− deriving (Generic, Eq, Show)
262−
263100data instance Sing (schema :: Schema) where
264− SSchemaText :: Sing tcs -> Sing ('SchemaText tcs)
265− SSchemaNumber :: Sing ncs -> Sing ('SchemaNumber ncs)
266− SSchemaBoolean :: Sing 'SchemaBoolean
267− SSchemaArray :: Sing acs -> Sing schema -> Sing ('SchemaArray acs schema)
268− SSchemaObject :: Sing fields -> Sing ('SchemaObject fields)
269− SSchemaOptional :: Sing s -> Sing ('SchemaOptional s)
270− SSchemaNull :: Sing 'SchemaNull
271− SSchemaUnion :: Sing ss -> Sing ('SchemaUnion ss)
272−
273−instance SingI sl => SingI ('SchemaText sl) where
274− sing = SSchemaText sing
275−instance SingI sl => SingI ('SchemaNumber sl) where
276− sing = SSchemaNumber sing
277−instance SingI 'SchemaNull where
278− sing = SSchemaNull
279−instance SingI 'SchemaBoolean where
280− sing = SSchemaBoolean
281−instance (SingI ac, SingI s) => SingI ('SchemaArray ac s) where
282− sing = SSchemaArray sing sing
283−instance SingI stl => SingI ('SchemaObject stl) where
284− sing = SSchemaObject sing
285−instance SingI s => SingI ('SchemaOptional s) where
286− sing = SSchemaOptional sing
287−instance SingI s => SingI ('SchemaUnion s) where
288− sing = SSchemaUnion sing
289−
290−instance Eq (Sing ('SchemaText cs)) where _ == _ = True
291−instance Eq (Sing ('SchemaNumber cs)) where _ == _ = True
292−instance Eq (Sing 'SchemaNull) where _ == _ = True
293−instance Eq (Sing 'SchemaBoolean) where _ == _ = True
294−instance Eq (Sing ('SchemaArray as s)) where _ == _ = True
295−instance Eq (Sing ('SchemaObject cs)) where _ == _ = True
296−instance Eq (Sing ('SchemaOptional s)) where _ == _ = True
297−instance Eq (Sing ('SchemaUnion s)) where _ == _ = True
298−
299−instance SingKind Schema where
300− type Demote Schema = DemotedSchema
301− fromSing = \case
302− SSchemaText cs -> DSchemaText $ fromSing cs
303− SSchemaNumber cs -> DSchemaNumber $ fromSing cs
304− SSchemaBoolean -> DSchemaBoolean
305− SSchemaArray cs s -> DSchemaArray (fromSing cs) (fromSing s)
306− SSchemaOptional s -> DSchemaOptional $ fromSing s
307− SSchemaNull -> DSchemaNull
308− SSchemaObject cs -> DSchemaObject $ fromSing cs
309− SSchemaUnion ss -> DSchemaUnion $ fromSing ss
310− toSing = \case
311− DSchemaText cs -> case toSing cs of
312− SomeSing scs -> SomeSing $ SSchemaText scs
313− DSchemaNumber cs -> case toSing cs of
314− SomeSing scs -> SomeSing $ SSchemaNumber scs
315− DSchemaBoolean -> SomeSing $ SSchemaBoolean
316− DSchemaArray cs sch -> case (toSing cs, toSing sch) of
317− (SomeSing scs, SomeSing ssch) -> SomeSing $ SSchemaArray scs ssch
318− DSchemaOptional sch -> case toSing sch of
319− SomeSing ssch -> SomeSing $ SSchemaOptional ssch
320− DSchemaNull -> SomeSing SSchemaNull
321− DSchemaObject cs -> case toSing cs of
322− SomeSing scs -> SomeSing $ SSchemaObject scs
323− DSchemaUnion ss -> case toSing ss of
324− SomeSing sss -> SomeSing $ SSchemaUnion sss
101+ SSchemaText :: Sing tcs -> Sing (SchemaText tcs)
102+ SSchemaNumber :: Sing ncs -> Sing (SchemaNumber ncs)
103+ SSchemaArray :: Sing acs -> Sing schema -> Sing (SchemaArray acs schema)
104+ SSchemaObject :: Sing fields -> Sing (SchemaObject fields)
105+ SSchemaNull :: Sing SchemaNull
106+
107+instance Known (Sing sl) => Known (Sing (SchemaText sl)) where
108+ known = SSchemaText known
109+instance Known (Sing sl) => Known (Sing (SchemaNumber sl)) where
110+ known = SSchemaNumber known
111+instance Known (Sing SchemaNull) where
112+ known = SSchemaNull
113+instance (Known (Sing ac), Known (Sing s)) => Known (Sing (SchemaArray ac s)) where
114+ known = SSchemaArray known known
115+instance Known (Sing stl) => Known (Sing (SchemaObject stl)) where
116+ known = SSchemaObject known
117+
118+instance Eq (Sing (SchemaText cs)) where a == b = True
119+instance Eq (Sing (SchemaNumber cs)) where a == b = True
120+instance Eq (Sing SchemaNull) where a == b = True
121+instance Eq (Sing (SchemaArray as s)) where a == b = True
122+instance Eq (Sing (SchemaObject cs)) where a == b = True
325123
326124data FieldRepr :: (Symbol, Schema) -> Type where
327− FieldRepr
328− :: (SingI schema, KnownSymbol name)
329− => JsonRepr schema
330− -> FieldRepr '(name, schema)
331−
332−-- | Forgetful Functor Ufr
333−toJsonRepr :: FieldRepr '(fn, sch) -> JsonRepr sch
334−toJsonRepr (FieldRepr x) = x
335−
336−knownFieldName
337− :: forall proxy (fieldName :: Symbol) schema
338− . KnownSymbol fieldName
339− => proxy '(fieldName, schema)
340− -> Text
341−knownFieldName _ = T.pack $ symbolVal (Proxy @fieldName)
342−
343−knownFieldSchema
344− :: forall proxy fieldName schema
345− . SingI schema
346− => proxy '(fieldName, schema)
347− -> Sing schema
348−knownFieldSchema _ = sing
349−
350−deriving instance Show (JsonRepr schema) => Show (FieldRepr '(name, schema))
125+ FieldRepr :: KnownSymbol name => JsonRepr schema -> FieldRepr '(name, schema)
351126
352127instance Eq (JsonRepr schema) => Eq (FieldRepr '(name, schema)) where
353128 FieldRepr a == FieldRepr b = a == b
354129
355130instance
356131 ( KnownSymbol name
357− , SingI schema
358132 , Serial m (JsonRepr schema) )
359133 => Serial m (FieldRepr '(name, schema)) where
360134 series = FieldRepr <$> series
361135
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−
366136data JsonRepr :: Schema -> Type where
367− ReprText :: Text -> JsonRepr ('SchemaText cs)
368− ReprNumber :: Scientific -> JsonRepr ('SchemaNumber cs)
369− ReprBoolean :: Bool -> JsonRepr 'SchemaBoolean
370− ReprNull :: JsonRepr 'SchemaNull
371− ReprArray :: V.Vector (JsonRepr s) -> JsonRepr ('SchemaArray cs s)
372− ReprObject :: Rec FieldRepr fs -> JsonRepr ('SchemaObject fs)
373− ReprOptional :: Maybe (JsonRepr s) -> JsonRepr ('SchemaOptional s)
374− ReprUnion :: Union JsonRepr (h ': tl) -> JsonRepr ('SchemaUnion (h ': tl))
375−
376−instance (Monad m, Serial m Text, SingI cs)
377− => Serial m (JsonRepr ('SchemaText cs)) where
378− series = decDepth $ fmap ReprText $ textSeries $ fromSing (sing :: Sing cs)
137+ ReprText :: Text -> JsonRepr (SchemaText cs)
138+ ReprNumber :: Scientific -> JsonRepr (SchemaNumber cs)
139+ ReprNull :: JsonRepr SchemaNull
140+ ReprArray :: V.Vector (JsonRepr s) -> JsonRepr (SchemaArray cs s)
141+ ReprObject :: Rec FieldRepr fs -> JsonRepr (SchemaObject fs)
379142
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
402−instance Show (JsonRepr ('SchemaText cs)) where
403− show (ReprText t) = "ReprText " P.++ show t
404−
405−instance Show (JsonRepr ('SchemaNumber cs)) where
406− show (ReprNumber n) = "ReprNumber " P.++ show n
407−
408−instance Show (JsonRepr 'SchemaBoolean) where
409− show (ReprBoolean n) = "ReprBoolean " P.++ show n
410−
411−instance Show (JsonRepr 'SchemaNull) where show _ = "ReprNull"
412−
413−instance Show (JsonRepr s) => Show (JsonRepr ('SchemaArray acs s)) where
414− show (ReprArray v) = "ReprArray " P.++ show v
415−
416−#if MIN_VERSION_base(4,12,0)
417−instance
418− ( V.RecAll FieldRepr fs Show, RMap fs, ReifyConstraint Show FieldRepr fs
419− , RecordToList fs )
420− => Show (JsonRepr ('SchemaObject fs)) where
421− show (ReprObject fs) = "ReprObject " P.++ show fs
422−#else
423−instance V.RecAll FieldRepr fs Show => Show (JsonRepr ('SchemaObject fs)) where
424− show (ReprObject fs) = "ReprObject " P.++ show fs
425−#endif
426−
427−instance Show (JsonRepr s) => Show (JsonRepr ('SchemaOptional s)) where
428− show (ReprOptional s) = "ReprOptional " P.++ show s
429−
430−instance Show (Union JsonRepr (h ': tl))
431− => Show (JsonRepr ('SchemaUnion (h ': tl))) where
432− show (ReprUnion s) = "ReprUnion " P.++ show s
433−
434−instance Eq (Rec FieldRepr fs) => Eq (JsonRepr ('SchemaObject fs)) where
143+instance Eq (Rec FieldRepr fs) => Eq (JsonRepr (SchemaObject fs)) where
435144 ReprObject a == ReprObject b = a == b
436145
437−instance Eq (JsonRepr ('SchemaText cs)) where
146+instance Eq (JsonRepr (SchemaText cs)) where
438147 ReprText a == ReprText b = a == b
439148
440−instance Eq (JsonRepr ('SchemaNumber cs)) where
149+instance Eq (JsonRepr (SchemaNumber cs)) where
441150 ReprNumber a == ReprNumber b = a == b
442151
443−instance Eq (JsonRepr 'SchemaBoolean) where
444− ReprBoolean a == ReprBoolean b = a == b
445−
446−instance Eq (JsonRepr 'SchemaNull) where
152+instance Eq (JsonRepr SchemaNull) where
447153 ReprNull == ReprNull = True
448154
449−instance Eq (JsonRepr s) => Eq (JsonRepr ('SchemaArray as s)) where
155+instance Eq (JsonRepr s) => Eq (JsonRepr (SchemaArray as s)) where
450156 ReprArray a == ReprArray b = a == b
451157
452−instance Eq (JsonRepr s) => Eq (JsonRepr ('SchemaOptional s)) where
453− ReprOptional a == ReprOptional b = a == b
454−
455−instance Eq (Union JsonRepr (h ': tl))
456− => Eq (JsonRepr ('SchemaUnion (h ': tl))) where
457− ReprUnion a == ReprUnion b = a == b
458−
459−instance Ord (Rec FieldRepr fs) => Ord (JsonRepr ('SchemaObject fs)) where
460− ReprObject a `compare` ReprObject b = a `compare` b
461−
462−instance Ord (JsonRepr ('SchemaText cs)) where
463− ReprText a `compare` ReprText b = a `compare` b
464−
465−instance Ord (JsonRepr ('SchemaNumber cs)) where
466− ReprNumber a `compare` ReprNumber b = a `compare` b
467−
468−instance Ord (JsonRepr 'SchemaBoolean) where
469− ReprBoolean a `compare` ReprBoolean b = a `compare` b
470−
471−instance Ord (JsonRepr 'SchemaNull) where
472− compare _ _ = EQ
473−
474−instance Ord (JsonRepr s) => Ord (JsonRepr ('SchemaArray as s)) where
475− ReprArray a `compare` ReprArray b = a `compare` b
476−
477−instance Ord (JsonRepr s) => Ord (JsonRepr ('SchemaOptional s)) where
478− ReprOptional a `compare` ReprOptional b = a `compare` b
479−
480−instance Ord (Union JsonRepr (h ': tl))
481− => Ord (JsonRepr ('SchemaUnion (h ': tl))) where
482− ReprUnion a `compare` ReprUnion b = a `compare` b
483−
484−instance IsList (JsonRepr ('SchemaArray cs s)) where
485− type Item (JsonRepr ('SchemaArray cs s)) = JsonRepr s
486− fromList = ReprArray . GHC.Exts.fromList
487− toList (ReprArray v) = GHC.Exts.toList v
488−
489−instance Num (JsonRepr ('SchemaNumber cs)) where
490− ReprNumber a + ReprNumber b = ReprNumber $ a + b
491− ReprNumber a - ReprNumber b = ReprNumber $ a - b
492− ReprNumber a * ReprNumber b = ReprNumber $ a * b
493− abs (ReprNumber a) = ReprNumber $ abs a
494− signum (ReprNumber a) = ReprNumber $ signum a
495− fromInteger = ReprNumber . fromIntegral
496−
497−instance IsString (JsonRepr ('SchemaText cs)) where
498− fromString = ReprText . fromString
499−
500−fromOptional
501− :: SingI s
502− => Sing ('SchemaOptional s)
503− -> J.Value
504− -> Parser (Maybe (JsonRepr s))
505−fromOptional _ = parseJSON
506−
507−parseUnion
508− :: FromJSON (JsonRepr ('SchemaUnion ss))
509− => sing (ss :: [Schema])
510− -> Value
511− -> Parser (JsonRepr ('SchemaUnion ss))
512−parseUnion _ val = parseJSON val
513−
514−instance FromJSON (Union JsonRepr '[]) where
515− parseJSON = fail "empty union"
516−
517−instance (SingI a, FromJSON (Union JsonRepr as)) => FromJSON (Union JsonRepr (a ': as)) where
518− parseJSON val = (This <$> parseJSON val)
519− <|> (That <$> (parseJSON val :: Parser (Union JsonRepr as)))
520−
521−instance ToJSON (Union JsonRepr as) where
522− toJSON (This fa) = toJSON fa
523− toJSON (That u) = toJSON u
524−
525−instance SingI schema => J.FromJSON (JsonRepr schema) where
526− parseJSON value = case sing :: Sing schema of
527− SSchemaText _ -> withText "String" (pure . ReprText) value
528− SSchemaNumber _ -> withScientific "Number" (pure . ReprNumber) value
529− SSchemaBoolean -> ReprBoolean <$> parseJSON value
530− SSchemaNull -> case value of
531− J.Null -> pure ReprNull
532− _ -> typeMismatch "Null" value
533− so@(SSchemaOptional s) -> withSingI s $ ReprOptional <$> fromOptional so value
534− SSchemaArray sa sb -> withSingI sa $ withSingI sb
535− $ withArray "Array" (fmap ReprArray . traverse parseJSON) value
536− SSchemaObject fs -> do
158+instance Known (Sing schema) => J.FromJSON (JsonRepr schema) where
159+ parseJSON value = case known :: Sing schema of
160+ SSchemaText _ -> withText "String" (pure . ReprText) value
161+ SSchemaNumber _ -> withScientific "Number" (pure . ReprNumber) value
162+ SSchemaNull -> pure ReprNull
163+ SSchemaArray c s -> do
537164 let
538− demoteFields :: SList s -> H.HashMap Text J.Value -> Parser (Rec FieldRepr s)
539− demoteFields SNil _ = pure RNil
540− demoteFields (SCons (STuple2 (n :: Sing fn) s) tl) h = withKnownSymbol n $ do
541− let fieldName = T.pack $ symbolVal (Proxy @fn)
542− fieldRepr <- case s of
543− SSchemaText so -> case H.lookup fieldName h of
544− Just v -> withSingI so $ FieldRepr <$> parseJSON v
545− Nothing -> fail $ "No text field: " P.++ show fieldName
546− SSchemaNumber so -> case H.lookup fieldName h of
547− Just v -> withSingI so $ FieldRepr <$> parseJSON v
548− Nothing -> fail $ "No number field: " P.++ show fieldName
549− SSchemaBoolean -> case H.lookup fieldName h of
550− Just v -> FieldRepr <$> parseJSON v
551− Nothing -> fail $ "No boolean field: " P.++ show fieldName
552− SSchemaNull -> case H.lookup fieldName h of
553− Just v -> FieldRepr <$> parseJSON v
554− Nothing -> fail $ "No null field: " P.++ show fieldName
555− SSchemaArray sa sb -> case H.lookup fieldName h of
556− Just v -> withSingI sa $ withSingI sb $ FieldRepr <$> parseJSON v
557− Nothing -> fail $ "No array field: " P.++ show fieldName
558− SSchemaObject so -> case H.lookup fieldName h of
559− Just v -> withSingI so $ FieldRepr <$> parseJSON v
560− Nothing -> fail $ "No object field" P.++ show fieldName
561− SSchemaOptional so -> case H.lookup fieldName h of
562− Just v -> withSingI so $ FieldRepr <$> parseJSON v
563− Nothing -> withSingI so $ pure $ FieldRepr $ ReprOptional Nothing
564− SSchemaUnion ss -> withSingI ss $ FieldRepr <$> parseUnion ss value
565− (fieldRepr :&) <$> demoteFields tl h
566− ReprObject <$> withObject "Object" (demoteFields fs) value
567− SSchemaUnion ss -> parseUnion ss value
165+ f :: Sing cs -> Sing s -> V.Vector J.Value -> Parser (JsonRepr (SchemaArray cs s))
166+ f _ _ = fmap ReprArray . traverse parseJSON
167+ withArray "Array" (f c s) value
168+ SSchemaObject fs -> ReprObject <$> withObject "Object" (demoteFields fs) value
169+
170+demoteFields
171+ :: SList s
172+ -> H.HashMap Text J.Value
173+ -> Parser (Rec FieldRepr s)
174+demoteFields SNil h
175+ | H.null h = pure RNil
176+ | otherwise = mzero
177+demoteFields (SCons (STuple2 (n :: Sing fn) s) tl) h = withKnownSymbol n $ do
178+ let fieldName = T.pack $ symbolVal (Proxy @fn)
179+ fieldRepr <- case H.lookup fieldName h of
180+ Just v -> FieldRepr <$> (withSingI s $ parseJSON v)
181+ Nothing -> mzero
182+ (fieldRepr :&) <$> demoteFields tl h
568183
569184instance J.ToJSON (JsonRepr a) where
570− toJSON ReprNull = J.Null
571− toJSON (ReprBoolean b) = J.Bool b
572− toJSON (ReprText t) = J.String t
573− toJSON (ReprNumber n) = J.Number n
574− toJSON (ReprOptional s) = case s of
575− Just v -> toJSON v
576− Nothing -> J.Null
577− toJSON (ReprArray v) = J.Array $ toJSON <$> v
578− toJSON (ReprObject r) = J.Object . H.fromList . fold $ r
185+ toJSON ReprNull = J.Null
186+ toJSON (ReprText t) = J.String t
187+ toJSON (ReprNumber n) = J.Number n
188+ toJSON (ReprArray v) = J.Array $ toJSON <$> v
189+ toJSON (ReprObject r) = J.Object . H.fromList . fold $ r
579190 where
580191 extract :: forall name s . (KnownSymbol name)
581192 => FieldRepr '(name, s)
@@ -584,12 +195,11 @@ instance J.ToJSON (JsonRepr a) where
584195 fold :: Rec FieldRepr fs -> [(Text, J.Value)]
585196 fold = \case
586197 RNil -> []
587− fr@(FieldRepr _) :& tl -> (extract fr) : fold tl
588− toJSON (ReprUnion u) = toJSON u
198+ fr@(FieldRepr s) :& tl -> (extract fr) : fold tl
589199
590−class FalseConstraint a
200+class FalseConstraint
591201
592−type family TopLevel (schema :: Schema) :: Constraint where
593− TopLevel ('SchemaArray acs s) = ()
594− TopLevel ('SchemaObject o) = ()
595− TopLevel spec = 'True ~ 'False
202+type family TopLevel (spec :: Schema) :: Constraint where
203+ TopLevel (SchemaArray a e) = ()
204+ TopLevel (SchemaObject o) = ()
205+ TopLevel spec = FalseConstraint
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/Validatable.hsnew file+5
@@ -0,0 +1,5 @@
1+module Data.Schematic.Validatable where
2+
3+
4+class Validatable spec where
5+ type Schema a
src/Data/Schematic/Validation.hsdeleted−305
@@ -1,305 +0,0 @@
1−module Data.Schematic.Validation where
2−
3−import Control.Monad
4−import Control.Monad.Validation
5−import Data.Aeson
6−import Data.Aeson.Types
7−import Data.Foldable
8−import Data.Functor.Identity
9−import Data.Monoid
10−import Data.Schematic.Path
11−import Data.Schematic.Schema
12−import Data.Scientific
13−import Data.Singletons.Prelude
14−import Data.Singletons.TypeLits
15−import Data.Text as T
16−import Data.Traversable
17−import Data.Union
18−import Data.Vector as V
19−import Data.Vinyl
20−import Data.Vinyl.TypeLevel
21−import Prelude as P
22−import Text.Regex.TDFA
23−
24−
25−type Validation a = ValidationT ErrorMap Identity a
26−
27−type ErrorMap = MonoidMap Text [Text]
28−
29−data ParseResult a
30− = Valid a
31− | DecodingError Text -- static
32− | ValidationError ErrorMap -- runtime
33− deriving (Show, Eq, Functor, Foldable, Traversable)
34−
35−instance (TopLevel a, SingI a, FromJSON (JsonRepr a))
36− => FromJSON (ParseResult (JsonRepr a)) where
37− parseJSON = pure . parseAndValidateJson @a
38−
39−isValid :: ParseResult a -> Bool
40−isValid (Valid _) = True
41−isValid _ = False
42−
43−isDecodingError :: ParseResult a -> Bool
44−isDecodingError (DecodingError _) = True
45−isDecodingError _ = False
46−
47−isValidationError :: ParseResult a -> Bool
48−isValidationError (ValidationError _) = True
49−isValidationError _ = False
50−
51−validateTextConstraint
52− :: JSONPath
53− -> Text
54− -> Sing (tcs :: TextConstraint)
55− -> Validation ()
56−validateTextConstraint (JSONPath path) t = \case
57− STEq n -> do
58− let
59− nlen = withKnownNat n $ natVal n
60− predicate = nlen == (fromIntegral $ T.length t)
61− errMsg = "length should be == " <> T.pack (show nlen)
62− warn = vWarning $ mmSingleton path (pure errMsg)
63− unless predicate warn
64− STLt n -> do
65− let
66− nlen = withKnownNat n $ natVal n
67− predicate = nlen > (fromIntegral $ T.length t)
68− errMsg = "length should be < " <> T.pack (show nlen)
69− warn = vWarning $ mmSingleton path (pure errMsg)
70− unless predicate warn
71− STLe n -> do
72− let
73− nlen = withKnownNat n $ natVal n
74− predicate = nlen >= (fromIntegral $ T.length t)
75− errMsg = "length should be <= " <> T.pack (show nlen)
76− warn = vWarning $ mmSingleton path (pure errMsg)
77− unless predicate warn
78− STGt n -> do
79− let
80− nlen = withKnownNat n $ natVal n
81− predicate = nlen < (fromIntegral $ T.length t)
82− errMsg = "length should be > " <> T.pack (show nlen)
83− warn = vWarning $ mmSingleton path (pure errMsg)
84− unless predicate warn
85− STGe n -> do
86− let
87− nlen = withKnownNat n $ natVal n
88− predicate = nlen <= (fromIntegral $ T.length t)
89− errMsg = "length should be >= " <> T.pack (show nlen)
90− warn = vWarning $ mmSingleton path (pure errMsg)
91− unless predicate warn
92− STRegex r -> do
93− let
94− regex = withKnownSymbol r $ fromSing r
95− predicate = matchTest (makeRegex (T.unpack regex) :: Regex) (T.unpack t)
96− errMsg = "must match " <> regex
97− warn = vWarning $ mmSingleton path (pure errMsg)
98− unless predicate warn
99− STEnum ss -> do
100− let
101− matching :: Sing (s :: [Symbol]) -> Bool
102− matching SNil = False
103− matching (SCons s@SSym fs) = T.pack (symbolVal s) == t || matching fs
104− errMsg = "must be one of " <> T.pack (show (fromSing ss))
105− warn = vWarning $ mmSingleton path (pure errMsg)
106− unless (matching ss) warn
107−
108−validateNumberConstraint
109− :: JSONPath
110− -> Scientific
111− -> Sing (tcs :: NumberConstraint)
112− -> Validation ()
113−validateNumberConstraint (JSONPath path) num = \case
114− SNEq n -> do
115− let
116− nlen = withKnownNat n $ natVal n
117− predicate = fromIntegral nlen == num
118− errMsg = "should be == " <> T.pack (show nlen)
119− warn = vWarning $ mmSingleton path (pure errMsg)
120− unless predicate warn
121− SNGt n -> do
122− let
123− nlen = withKnownNat n $ natVal n
124− predicate = num > fromIntegral nlen
125− errMsg = "should be > " <> T.pack (show nlen)
126− warn = vWarning $ mmSingleton path (pure errMsg)
127− unless predicate warn
128− SNGe n -> do
129− let
130− nlen = withKnownNat n $ natVal n
131− predicate = num >= fromIntegral nlen
132− errMsg = "should be >= " <> T.pack (show nlen)
133− warn = vWarning $ mmSingleton path (pure errMsg)
134− unless predicate warn
135− SNLt n -> do
136− let
137− nlen = withKnownNat n $ natVal n
138− predicate = num < fromIntegral nlen
139− errMsg = "should be < " <> T.pack (show nlen)
140− warn = vWarning $ mmSingleton path (pure errMsg)
141− unless predicate warn
142− SNLe n -> do
143− let
144− nlen = withKnownNat n $ natVal n
145− predicate = num <= fromIntegral nlen
146− errMsg = "should be <= " <> T.pack (show nlen)
147− warn = vWarning $ mmSingleton path (pure errMsg)
148− unless predicate warn
149−
150−validateArrayConstraint
151− :: JSONPath
152− -> V.Vector a
153− -> Sing (tcs :: ArrayConstraint)
154− -> Validation ()
155−validateArrayConstraint (JSONPath path) v = \case
156− SAEq n -> do
157− let
158− nlen = withKnownNat n $ natVal n
159− predicate = nlen == fromIntegral (V.length v)
160− errMsg = "length should be == " <> T.pack (show nlen)
161− warn = vWarning $ mmSingleton path (pure errMsg)
162− unless predicate warn
163− SAGt n -> do
164− let
165− nlen = withKnownNat n $ natVal n
166− predicate = fromIntegral (V.length v) > nlen
167− errMsg = "length should be > " <> T.pack (show nlen)
168− warn = vWarning $ mmSingleton path (pure errMsg)
169− unless predicate warn
170− SAGe n -> do
171− let
172− nlen = withKnownNat n $ natVal n
173− predicate = fromIntegral (V.length v) >= nlen
174− errMsg = "length should be >= " <> T.pack (show nlen)
175− warn = vWarning $ mmSingleton path (pure errMsg)
176− unless predicate warn
177− SALt n -> do
178− let
179− nlen = withKnownNat n $ natVal n
180− predicate = fromIntegral (V.length v) < nlen
181− errMsg = "length should be < " <> T.pack (show nlen)
182− warn = vWarning $ mmSingleton path (pure errMsg)
183− unless predicate warn
184− SALe n -> do
185− let
186− nlen = withKnownNat n $ natVal n
187− predicate = fromIntegral (V.length v) <= nlen
188− errMsg = "length should be <= " <> T.pack (show nlen)
189− warn = vWarning $ mmSingleton path (pure errMsg)
190− unless predicate warn
191−
192−validateJsonRepr
193− :: Sing schema
194− -> [DemotedPathSegment]
195− -> JsonRepr schema
196− -> Validation ()
197−validateJsonRepr sschema dpath jr = case jr of
198− ReprText t -> case sschema of
199− SSchemaText scs -> do
200− let
201− process :: Sing (cs :: [TextConstraint]) -> Validation ()
202− process SNil = pure ()
203− process (SCons c cs) = do
204− validateTextConstraint (demotedPathToText dpath) t c
205− process cs
206− process scs
207− ReprNumber n -> case sschema of
208− SSchemaNumber scs -> do
209− let
210− process :: Sing (cs :: [NumberConstraint]) -> Validation ()
211− process SNil = pure ()
212− process (SCons c cs) = do
213− validateNumberConstraint (demotedPathToText dpath) n c
214− process cs
215− process scs
216− ReprNull -> pure ()
217− ReprBoolean _ -> pure ()
218− ReprArray v -> case sschema of
219− SSchemaArray acs s -> do
220− let
221− process :: Sing (cs :: [ArrayConstraint]) -> Validation ()
222− process SNil = pure ()
223− process (SCons c cs) = do
224− validateArrayConstraint (demotedPathToText dpath) v c
225− process cs
226− process acs
227− for_ (V.indexed v) $ \(ix, jr') -> do
228− let newPath = dpath <> pure (DIx $ fromIntegral ix)
229− validateJsonRepr s newPath jr'
230− ReprOptional d -> case sschema of
231− SSchemaOptional ss -> case d of
232− Just x -> validateJsonRepr ss dpath x
233− Nothing -> pure ()
234− ReprObject fs -> case sschema of
235− SSchemaObject _ -> go fs
236− where
237− go :: Rec FieldRepr (ts :: [(Symbol, Schema)] ) -> Validation ()
238− go RNil = pure ()
239− go (f@(FieldRepr d) :& ftl) = do
240− let newPath = dpath <> [DKey (knownFieldName f)]
241− validateJsonRepr (knownFieldSchema f) newPath d
242− go ftl
243− ReprUnion _ -> pure () -- FIXME
244− -- case sschema of
245− -- SSchemaUnion ss -> case ss of
246− -- SCons s stl -> case umatch' s u of
247− -- Nothing -> case urestrict u of
248− -- Nothing ->
249− -- fail "impossible to produce subUnion, please report this as a bug"
250− -- Just x -> do
251− -- let
252− -- JSONPath path = demotedPathToText dpath
253− -- case stl of
254− -- SNil -> void $ vWarning $ mmSingleton path
255− -- $ pure "union handling error, please report this as bug"
256− -- SCons s' stl' ->
257− -- validateJsonRepr (SSchemaUnion (SCons s' stl')) dpath
258− -- $ toUnion (SCons s' stl') x
259− -- Just x -> validateJsonRepr s dpath x
260−
261−-- subUnion
262−-- :: Sing (s ': stl)
263−-- -> ( USubset stl (s ': stl) (RImage stl (s ': stl))
264−-- => Union f (s ': stl)
265−-- -> Maybe (Union f stl) )
266−-- subUnion (SCons s stl) = urestrict
267−
268−-- withUSubset
269−-- :: Sing (s ': stl)
270−-- -> (USubset stl (s ': stl) (RImage stl (s ': stl)) => Maybe (Union f stl))
271−-- -> Maybe (Union f stl)
272−-- withUSubset (SCons s stl) r = r
273−
274−toUnion
275− :: USubset s' (s ': ss) (RImage s' (s ': ss))
276− => Sing (s ': ss)
277− -> Union JsonRepr s'
278− -> JsonRepr ('SchemaUnion (s ': ss))
279−toUnion _ = ReprUnion . urelax
280−
281−umatch' :: UElem a as i => Sing a -> Union f as -> Maybe (f a)
282−umatch' _ u = umatch u
283−
284−parseAndValidateJson
285− :: forall schema
286− . (FromJSON (JsonRepr schema), TopLevel schema, SingI schema)
287− => Value
288− -> ParseResult (JsonRepr schema)
289−parseAndValidateJson v =
290− case parseEither parseJSON v of
291− Left s -> DecodingError $ T.pack s
292− Right jsonRepr ->
293− let
294− validate = validateJsonRepr (sing :: Sing schema) [] jsonRepr
295− res = runIdentity . runValidationTEither $ validate
296− in case res of
297− Left em -> ValidationError em
298− Right () -> Valid jsonRepr
299−
300−parseAndValidateJsonBy
301− :: (FromJSON (JsonRepr schema), TopLevel schema, SingI schema)
302− => proxy schema
303− -> Value
304− -> ParseResult (JsonRepr schema)
305−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.7.yamldeleted−5
@@ -1,5 +0,0 @@
1−resolver: lts-13.7
2−extra-deps:
3− - hjsonpointer-1.4.0@rev:0
4− - hjsonschema-1.9.0@rev:0
5− - validationt-0.2.1.0
stack.yaml+68−4
@@ -1,5 +1,69 @@
1−resolver: lts-12.0
1+# This file was automatically generated by 'stack init'
2+#
3+# Some commonly used options have been documented as comments in this file.
4+# For advanced use and comprehensive documentation of the format, please see:
5+# http://docs.haskellstack.org/en/stable/yaml_configuration/
6+
7+# Resolver to choose a 'specific' stackage snapshot or a compiler version.
8+# A snapshot resolver dictates the compiler version and the set of packages
9+# to be used for project dependencies. For example:
10+#
11+# resolver: lts-3.5
12+# resolver: nightly-2015-09-21
13+# resolver: ghcjs-0.1.0_ghc-7.10.2
14+# resolver:
15+# name: custom-snapshot
16+# location: "./custom-snapshot.yaml"
17+resolver: lts-8.12
18+#resolver: ghc-8.0.2
19+
20+# User packages to be built.
21+# Various formats can be used as shown in the example below.
22+#
23+# packages:
24+# - some-directory
25+# - https://example.com/foo/bar/baz-0.0.2.tar.gz
26+# - location:
27+# git: https://github.com/commercialhaskell/stack.git
28+# commit: e7b331f14bcffb8367cd58fbfc8b40ec7642100a
29+# - location: https://github.com/commercialhaskell/stack/commit/e7b331f14bcffb8367cd58fbfc8b40ec7642100a
30+# extra-dep: true
31+# subdirs:
32+# - auto-update
33+# - wai
34+#
35+# A package marked 'extra-dep: true' will only be built if demanded by a
36+# non-dependency (i.e. a user package), and its test suites and benchmarks
37+# will not be run. This is useful for tweaking upstream packages.
38+packages:
39+#- location:
40+ #git: https://github.com/typeable/validationt.git
41+ #commit: 24578c9fd408179358c641ee1fff0eb182591f4b
42+- '.'
43+
244extra-deps:
3− - hjsonpointer-1.4.0@rev:0
4− - hjsonschema-1.9.0@rev:0
5− - validationt-0.2.1.0
45+- validationt-0.2.0.0
46+
47+# Override default flag values for local packages and extra-deps
48+flags: {}
49+
50+# Extra package databases containing global packages
51+extra-package-dbs: []
52+
53+# Control whether we use the GHC we find on the path
54+# system-ghc: true
55+#
56+# Require a specific version of stack, using version ranges
57+# require-stack-version: -any # Default
58+# require-stack-version: ">=1.4"
59+#
60+# Override the architecture used by stack, especially useful on Windows
61+# arch: i386
62+# arch: x86_64
63+#
64+# Extra directories used by stack for building
65+# extra-include-dirs: [/path/to/dir]
66+# extra-lib-dirs: [/path/to/dir]
67+#
68+# Allow a newer minor version of GHC than the snapshot specifies
69+# 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.hsdeleted−101
@@ -1,101 +0,0 @@
1−{-# LANGUAGE LambdaCase #-}
2−
3−{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE TypeApplications #-}
5−{-# LANGUAGE OverloadedLists #-}
6−{-# LANGUAGE OverloadedStrings #-}
7−
8−module JsonSchemaSpec (spec, main) where
9−
10−import Data.Aeson as J
11−import Data.Maybe
12−import Data.Proxy
13−import Data.ByteString.Lazy as B
14−import Data.Schematic
15−import Data.Vinyl
16−import JSONSchema.Draft4 as D4
17−import Test.Hspec
18−
19−
20−type ArraySchema = 'SchemaArray '[ 'AEq 1] ('SchemaNumber '[ 'NGt 10])
21−
22−type ArrayField = '("foo", ArraySchema)
23−
24−type FieldsSchema =
25− '[ ArrayField, '("bar", 'SchemaOptional ('SchemaText '[ 'TEnum '["foo", "bar"]]))]
26−
27−type SchemaExample = 'SchemaObject FieldsSchema
28−
29−exampleData :: JsonRepr SchemaExample
30−exampleData = withRepr @SchemaExample $
31− field @"foo" [ReprNumber 13]
32− :& field @"bar" (pure (ReprText "foo"))
33− :& RNil
34−
35−type SchemaArrayExample = 'SchemaObject
36− '[ '("a1", 'SchemaArray '[ 'AGt 1 ] ('SchemaNumber '[]))
37− , '("a2", 'SchemaArray '[ 'AGe 1 ] ('SchemaNumber '[]))
38− , '("a3", 'SchemaArray '[ 'ALt 1 ] ('SchemaNumber '[]))
39− , '("a4", 'SchemaArray '[ 'ALe 1 ] ('SchemaNumber '[]))
40− ]
41−
42−type SchemaNumberExample = 'SchemaObject
43− '[ '("n1", 'SchemaNumber '[ 'NGt 1 ])
44− , '("n2", 'SchemaNumber '[ 'NGe 1 ])
45− , '("n3", 'SchemaNumber '[ 'NLt 1 ])
46− , '("n4", 'SchemaNumber '[ 'NLe 1 ])
47− ]
48−
49−type SchemaTextExample = 'SchemaObject
50− '[ '("t1", 'SchemaText '[ 'TGt 1 ])
51− , '("t2", 'SchemaText '[ 'TGe 1 ])
52− , '("t3", 'SchemaText '[ 'TLt 1 ])
53− , '("t4", 'SchemaText '[ 'TLe 1 ])
54− ]
55−
56−spec :: Spec
57−spec = do
58− it "validates simple schema" $ do
59− let schema = D4.SchemaWithURI (fromJust $ toJsonSchema (Proxy @SchemaExample)) Nothing
60− fetchHTTPAndValidate schema (toJSON exampleData) >>= \case
61− Left _ -> fail "failed to validate test example"
62− Right _ -> pure ()
63− it "validates schema with arrays" $ do
64− let
65− schema = D4.SchemaWithURI (fromJust $ toJsonSchema (Proxy @SchemaArrayExample)) Nothing
66− obj = withRepr @SchemaArrayExample $
67− field @"a1" [ReprNumber 13, ReprNumber 13]
68− :& field @"a2" [ReprNumber 13]
69− :& field @"a3" []
70− :& field @"a4" [ReprNumber 13]
71− :& RNil
72− fetchHTTPAndValidate schema (toJSON obj) >>= \case
73− Left e -> fail "failed to validate test example"
74− Right _ -> pure ()
75− it "validates schema with numbers" $ do
76− let
77− schema = D4.SchemaWithURI (fromJust $ toJsonSchema (Proxy @SchemaNumberExample)) Nothing
78− obj = withRepr @SchemaNumberExample $
79− field @"n1" 1.1
80− :& field @"n2" 1
81− :& field @"n3" 0.9
82− :& field @"n4" 1.0
83− :& RNil
84− fetchHTTPAndValidate schema (toJSON obj) >>= \case
85− Left e -> fail "failed to validate test example"
86− Right _ -> pure ()
87− it "validates schema with strings" $ do
88− let
89− schema = D4.SchemaWithURI (fromJust $ toJsonSchema (Proxy @SchemaTextExample)) Nothing
90− obj = withRepr @SchemaTextExample $
91− field @"t1" "11"
92− :& field @"t2" "1"
93− :& field @"t3" ""
94− :& field @"t4" "1"
95− :& RNil
96− fetchHTTPAndValidate schema (toJSON obj) >>= \case
97− Left e -> fail "failed to validate test example"
98− Right _ -> pure ()
99−
100−main :: IO ()
101−main = hspec spec
test/LensSpec.hsdeleted−318
@@ -1,318 +0,0 @@
1−{-# LANGUAGE DataKinds #-}
2−{-# LANGUAGE TypeApplications #-}
3−{-# LANGUAGE OverloadedLists #-}
4−{-# LANGUAGE OverloadedStrings #-}
5−
6−module LensSpec (spec, main) where
7−
8−import Control.Lens
9−import Data.Proxy
10−import Data.Schematic
11−import Data.Vinyl
12−import Test.Hspec
13−
14−
15−type ArraySchema = 'SchemaArray '[ 'AEq 1] ('SchemaNumber '[ 'NGt 10])
16−
17−type ArrayField = '("foo", ArraySchema)
18−
19−type FieldsSchema =
20− '[ '("bar", 'SchemaOptional ('SchemaText '[ 'TEnum '["foo", "bar"]])), ArrayField]
21−
22−arrayData :: JsonRepr ArraySchema
23−arrayData = ReprArray [ReprNumber 13]
24−
25−arrayField :: FieldRepr ArrayField
26−arrayField = FieldRepr arrayData
27−
28−objectData :: Rec FieldRepr FieldsSchema
29−objectData = FieldRepr (ReprOptional (Just (ReprText "foo")))
30− :& FieldRepr arrayData
31− :& RNil
32−
33−type BigRecord = Rec FieldRepr
34− '[ '("f1", 'SchemaNumber '[])
35− , '("f2", 'SchemaNumber '[])
36− , '("f3", 'SchemaNumber '[])
37− , '("f4", 'SchemaNumber '[])
38− , '("f5", 'SchemaNumber '[])
39− , '("f6", 'SchemaNumber '[])
40− , '("f7", 'SchemaNumber '[])
41− , '("f8", 'SchemaNumber '[])
42− , '("f9", 'SchemaNumber '[])
43− , '("f10", 'SchemaNumber '[])
44− , '("f11", 'SchemaNumber '[])
45− , '("f12", 'SchemaNumber '[])
46− , '("f13", 'SchemaNumber '[])
47− , '("f14", 'SchemaNumber '[])
48− , '("f15", 'SchemaNumber '[])
49− , '("f16", 'SchemaNumber '[])
50− , '("f17", 'SchemaNumber '[])
51− , '("f18", 'SchemaNumber '[])
52− , '("f19", 'SchemaNumber '[])
53− , '("f20", 'SchemaNumber '[])
54− , '("f21", 'SchemaNumber '[])
55− , '("f22", 'SchemaNumber '[])
56− , '("f23", 'SchemaNumber '[])
57− , '("f24", 'SchemaNumber '[])
58− , '("f25", 'SchemaNumber '[])
59− , '("f26", 'SchemaNumber '[])
60− , '("f27", 'SchemaNumber '[])
61− , '("f28", 'SchemaNumber '[])
62− , '("f29", 'SchemaNumber '[])
63− , '("f30", 'SchemaNumber '[])
64− , '("f31", 'SchemaNumber '[])
65− , '("f32", 'SchemaNumber '[])
66− , '("f33", 'SchemaNumber '[])
67− , '("f34", 'SchemaNumber '[])
68− , '("f35", 'SchemaNumber '[])
69− , '("f36", 'SchemaNumber '[])
70− , '("f37", 'SchemaNumber '[])
71− , '("f38", 'SchemaNumber '[])
72− , '("f39", 'SchemaNumber '[])
73− , '("f40", 'SchemaNumber '[])
74− , '("f41", 'SchemaNumber '[])
75− , '("f42", 'SchemaNumber '[])
76− , '("f43", 'SchemaNumber '[])
77− , '("f44", 'SchemaNumber '[])
78− , '("f45", 'SchemaNumber '[])
79− , '("f46", 'SchemaNumber '[])
80− , '("f47", 'SchemaNumber '[])
81− , '("f48", 'SchemaNumber '[])
82− , '("f49", 'SchemaNumber '[])
83− , '("f50", 'SchemaNumber '[])
84− , '("f51", 'SchemaNumber '[])
85− , '("f52", 'SchemaNumber '[])
86− , '("f53", 'SchemaNumber '[])
87− , '("f54", 'SchemaNumber '[])
88− , '("f55", 'SchemaNumber '[])
89− , '("f56", 'SchemaNumber '[])
90− , '("f57", 'SchemaNumber '[])
91− , '("f58", 'SchemaNumber '[])
92− , '("f59", 'SchemaNumber '[])
93− , '("f60", 'SchemaNumber '[])
94− , '("f61", 'SchemaNumber '[])
95− , '("f62", 'SchemaNumber '[])
96− , '("f63", 'SchemaNumber '[])
97− , '("f64", 'SchemaNumber '[])
98− , '("f65", 'SchemaNumber '[])
99− , '("f66", 'SchemaNumber '[])
100− , '("f67", 'SchemaNumber '[])
101− , '("f68", 'SchemaNumber '[])
102− , '("f69", 'SchemaNumber '[])
103− , '("f70", 'SchemaNumber '[])
104− , '("f71", 'SchemaNumber '[])
105− , '("f72", 'SchemaNumber '[])
106− , '("f73", 'SchemaNumber '[])
107− , '("f74", 'SchemaNumber '[])
108− , '("f75", 'SchemaNumber '[])
109− , '("f76", 'SchemaNumber '[])
110− , '("f77", 'SchemaNumber '[])
111− , '("f78", 'SchemaNumber '[])
112− , '("f79", 'SchemaNumber '[])
113− , '("f80", 'SchemaNumber '[])
114− , '("f81", 'SchemaNumber '[])
115− , '("f82", 'SchemaNumber '[])
116− , '("f83", 'SchemaNumber '[])
117− , '("f84", 'SchemaNumber '[])
118− , '("f85", 'SchemaNumber '[])
119− , '("f86", 'SchemaNumber '[])
120− , '("f87", 'SchemaNumber '[])
121− , '("f88", 'SchemaNumber '[])
122− , '("f89", 'SchemaNumber '[])
123− , '("f90", 'SchemaNumber '[])
124− , '("f91", 'SchemaNumber '[])
125− , '("f92", 'SchemaNumber '[])
126− , '("f93", 'SchemaNumber '[])
127− , '("f94", 'SchemaNumber '[])
128− , '("f95", 'SchemaNumber '[])
129− , '("f96", 'SchemaNumber '[])
130− , '("f97", 'SchemaNumber '[])
131− , '("f98", 'SchemaNumber '[])
132− , '("f99", 'SchemaNumber '[])
133− , '("f100", 'SchemaNumber '[])
134− , '("f101", 'SchemaNumber '[])
135− , '("f102", 'SchemaNumber '[])
136− , '("f103", 'SchemaNumber '[])
137− , '("f104", 'SchemaNumber '[])
138− , '("f105", 'SchemaNumber '[])
139− , '("f106", 'SchemaNumber '[])
140− , '("f107", 'SchemaNumber '[])
141− , '("f108", 'SchemaNumber '[])
142− , '("f109", 'SchemaNumber '[])
143− , '("f110", 'SchemaNumber '[])
144− , '("f111", 'SchemaNumber '[])
145− , '("f112", 'SchemaNumber '[])
146− , '("f113", 'SchemaNumber '[])
147− , '("f114", 'SchemaNumber '[])
148− , '("f115", 'SchemaNumber '[])
149− , '("f116", 'SchemaNumber '[])
150− , '("f117", 'SchemaNumber '[])
151− , '("f118", 'SchemaNumber '[])
152− , '("f119", 'SchemaNumber '[])
153− , '("f120", 'SchemaNumber '[])
154− , '("f121", 'SchemaNumber '[])
155− , '("f122", 'SchemaNumber '[])
156− , '("f123", 'SchemaNumber '[])
157− , '("f124", 'SchemaNumber '[])
158− , '("f125", 'SchemaNumber '[])
159− , '("f126", 'SchemaNumber '[])
160− , '("f127", 'SchemaNumber '[])
161− , '("f128", 'SchemaNumber '[])
162− , '("f129", 'SchemaNumber '[])
163− , '("f130", 'SchemaNumber '[])
164− ]
165−
166−_bigRecord :: BigRecord
167−_bigRecord =
168− FieldRepr (ReprNumber 1)
169− :& FieldRepr (ReprNumber 2)
170− :& FieldRepr (ReprNumber 3)
171− :& FieldRepr (ReprNumber 4)
172− :& FieldRepr (ReprNumber 5)
173− :& FieldRepr (ReprNumber 6)
174− :& FieldRepr (ReprNumber 7)
175− :& FieldRepr (ReprNumber 8)
176− :& FieldRepr (ReprNumber 9)
177− :& FieldRepr (ReprNumber 10)
178− :& FieldRepr (ReprNumber 11)
179− :& FieldRepr (ReprNumber 12)
180− :& FieldRepr (ReprNumber 13)
181− :& FieldRepr (ReprNumber 14)
182− :& FieldRepr (ReprNumber 15)
183− :& FieldRepr (ReprNumber 16)
184− :& FieldRepr (ReprNumber 17)
185− :& FieldRepr (ReprNumber 18)
186− :& FieldRepr (ReprNumber 19)
187− :& FieldRepr (ReprNumber 20)
188− :& FieldRepr (ReprNumber 21)
189− :& FieldRepr (ReprNumber 22)
190− :& FieldRepr (ReprNumber 23)
191− :& FieldRepr (ReprNumber 24)
192− :& FieldRepr (ReprNumber 25)
193− :& FieldRepr (ReprNumber 26)
194− :& FieldRepr (ReprNumber 27)
195− :& FieldRepr (ReprNumber 28)
196− :& FieldRepr (ReprNumber 29)
197− :& FieldRepr (ReprNumber 30)
198− :& FieldRepr (ReprNumber 31)
199− :& FieldRepr (ReprNumber 32)
200− :& FieldRepr (ReprNumber 33)
201− :& FieldRepr (ReprNumber 34)
202− :& FieldRepr (ReprNumber 35)
203− :& FieldRepr (ReprNumber 36)
204− :& FieldRepr (ReprNumber 37)
205− :& FieldRepr (ReprNumber 38)
206− :& FieldRepr (ReprNumber 39)
207− :& FieldRepr (ReprNumber 40)
208− :& FieldRepr (ReprNumber 41)
209− :& FieldRepr (ReprNumber 42)
210− :& FieldRepr (ReprNumber 43)
211− :& FieldRepr (ReprNumber 44)
212− :& FieldRepr (ReprNumber 45)
213− :& FieldRepr (ReprNumber 46)
214− :& FieldRepr (ReprNumber 47)
215− :& FieldRepr (ReprNumber 48)
216− :& FieldRepr (ReprNumber 49)
217− :& FieldRepr (ReprNumber 50)
218− :& FieldRepr (ReprNumber 51)
219− :& FieldRepr (ReprNumber 52)
220− :& FieldRepr (ReprNumber 53)
221− :& FieldRepr (ReprNumber 54)
222− :& FieldRepr (ReprNumber 55)
223− :& FieldRepr (ReprNumber 56)
224− :& FieldRepr (ReprNumber 57)
225− :& FieldRepr (ReprNumber 58)
226− :& FieldRepr (ReprNumber 59)
227− :& FieldRepr (ReprNumber 60)
228− :& FieldRepr (ReprNumber 61)
229− :& FieldRepr (ReprNumber 62)
230− :& FieldRepr (ReprNumber 63)
231− :& FieldRepr (ReprNumber 64)
232− :& FieldRepr (ReprNumber 65)
233− :& FieldRepr (ReprNumber 66)
234− :& FieldRepr (ReprNumber 67)
235− :& FieldRepr (ReprNumber 68)
236− :& FieldRepr (ReprNumber 69)
237− :& FieldRepr (ReprNumber 70)
238− :& FieldRepr (ReprNumber 71)
239− :& FieldRepr (ReprNumber 72)
240− :& FieldRepr (ReprNumber 73)
241− :& FieldRepr (ReprNumber 74)
242− :& FieldRepr (ReprNumber 75)
243− :& FieldRepr (ReprNumber 76)
244− :& FieldRepr (ReprNumber 77)
245− :& FieldRepr (ReprNumber 78)
246− :& FieldRepr (ReprNumber 79)
247− :& FieldRepr (ReprNumber 80)
248− :& FieldRepr (ReprNumber 81)
249− :& FieldRepr (ReprNumber 82)
250− :& FieldRepr (ReprNumber 83)
251− :& FieldRepr (ReprNumber 84)
252− :& FieldRepr (ReprNumber 85)
253− :& FieldRepr (ReprNumber 86)
254− :& FieldRepr (ReprNumber 87)
255− :& FieldRepr (ReprNumber 88)
256− :& FieldRepr (ReprNumber 89)
257− :& FieldRepr (ReprNumber 90)
258− :& FieldRepr (ReprNumber 91)
259− :& FieldRepr (ReprNumber 92)
260− :& FieldRepr (ReprNumber 93)
261− :& FieldRepr (ReprNumber 94)
262− :& FieldRepr (ReprNumber 95)
263− :& FieldRepr (ReprNumber 96)
264− :& FieldRepr (ReprNumber 97)
265− :& FieldRepr (ReprNumber 98)
266− :& FieldRepr (ReprNumber 99)
267− :& FieldRepr (ReprNumber 100)
268− :& FieldRepr (ReprNumber 101)
269− :& FieldRepr (ReprNumber 102)
270− :& FieldRepr (ReprNumber 103)
271− :& FieldRepr (ReprNumber 104)
272− :& FieldRepr (ReprNumber 105)
273− :& FieldRepr (ReprNumber 106)
274− :& FieldRepr (ReprNumber 107)
275− :& FieldRepr (ReprNumber 108)
276− :& FieldRepr (ReprNumber 109)
277− :& FieldRepr (ReprNumber 110)
278− :& FieldRepr (ReprNumber 111)
279− :& FieldRepr (ReprNumber 112)
280− :& FieldRepr (ReprNumber 113)
281− :& FieldRepr (ReprNumber 114)
282− :& FieldRepr (ReprNumber 115)
283− :& FieldRepr (ReprNumber 116)
284− :& FieldRepr (ReprNumber 117)
285− :& FieldRepr (ReprNumber 118)
286− :& FieldRepr (ReprNumber 119)
287− :& FieldRepr (ReprNumber 120)
288− :& FieldRepr (ReprNumber 121)
289− :& FieldRepr (ReprNumber 122)
290− :& FieldRepr (ReprNumber 123)
291− :& FieldRepr (ReprNumber 124)
292− :& FieldRepr (ReprNumber 125)
293− :& FieldRepr (ReprNumber 126)
294− :& FieldRepr (ReprNumber 127)
295− :& FieldRepr (ReprNumber 128)
296− :& FieldRepr (ReprNumber 129)
297− :& FieldRepr (ReprNumber 130)
298− :& RNil
299−
300−spec :: Spec
301−spec = do
302− let
303− newFooVal = FieldRepr $ ReprArray [ReprNumber 15]
304− fooProxy = Proxy @"foo"
305− it "gets the field from an object" $ do
306− fget @"foo" objectData `shouldBe` arrayField
307− it "sets the object field" $ do
308− fget @"foo" (fput newFooVal objectData) `shouldBe` newFooVal
309−
310− describe "(using lens library) " $ do
311− it "get the field from an object" $ do
312− objectData ^. flens @"foo" `shouldBe` arrayField
313− it "sets the object field" $ do
314− set (flens @"foo") newFooVal objectData ^. flens @"foo"
315− `shouldBe` newFooVal
316−
317−main :: IO ()
318−main = hspec spec
test/SchemaSpec.hs+28−99
@@ -1,122 +1,51 @@
1−{-# OPTIONS_GHC -fprint-potential-instances #-}
2−
3−{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE GADTs #-}
6−{-# LANGUAGE OverloadedLists #-}
7−{-# LANGUAGE OverloadedStrings #-}
8−{-# LANGUAGE RankNTypes #-}
9−{-# LANGUAGE ScopedTypeVariables #-}
10−{-# LANGUAGE TypeApplications #-}
11−
121module SchemaSpec (spec, main) where
132
14−import Control.Lens
153import Data.Aeson
16−import Data.ByteString.Lazy
17−import Data.Functor.Identity
184import Data.Proxy
195import Data.Schematic
20−import Data.Schematic.Generator
216import Data.Singletons
22−import Data.Tagged
237import Data.Vinyl
248import Test.Hspec
259import 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]+"]))]
3910
40−jsonExample :: JsonRepr SchemaExample
41−jsonExample = withRepr @SchemaExample
42− $ field @"bar" (Just "bar")
43− :& field @"foo" [12]
44− :& RNil
4511
46−type AddQuuz =
47− 'Migration "add_field_quuz"
48− '[ 'Diff '[] ('AddKey "quuz" (SchemaNumber '[])) ]
12+type SchemaExample
13+ = SchemaObject
14+ '[ '("foo", SchemaArray '[AEq 3] (SchemaNumber '[NGt 10]))
15+ , '("bar", SchemaText '[TRegex "\\w+"])]
4916
50−type DeleteQuuz =
51− 'Migration "remove_field_quuz"
52− '[ 'Diff '[] ( 'DeleteKey "quuz") ]
17+schemaExample
18+ :: ( DemoteRep Schema ~ Sing SchemaExample
19+ , DemoteRep Schema ~ s
20+ , SingKind Schema
21+ , SingI SchemaExample
22+ ) => s
23+schemaExample = fromSing (sing :: Sing SchemaExample)
5324
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"]]))) ]
25+exampleTest :: JsonRepr (SchemaText '[TEq 3])
26+exampleTest = ReprText "lilo"
6027
61−type Migrations = '[ AddQuuz
62− , DeleteQuuz ]
63− -- , SwapFields ]
28+exampleNumber :: JsonRepr (SchemaNumber '[NEq 3])
29+exampleNumber = ReprNumber 3
6430
65−type VersionedJson = 'Versioned SchemaExample Migrations
31+exampleArray :: JsonRepr (SchemaArray '[AEq 1] (SchemaNumber '[NEq 3]))
32+exampleArray = ReprArray [exampleNumber]
6633
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
34+exampleObject
35+ :: JsonRepr (SchemaObject '[ '("foo", SchemaArray '[AEq 1] (SchemaNumber '[NEq 3]))] )
36+exampleObject = ReprObject $ FieldRepr exampleArray :& RNil
7637
77−schemaJson :: ByteString
78−schemaJson = "{\"foo\": [13], \"bar\": null}"
79−
80−schemaJson2 :: ByteString
81−schemaJson2 = "{\"foo\": [3], \"bar\": null}"
82−
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+example :: JsonRepr SchemaExample
39+example = ReprObject $
40+ FieldRepr (ReprArray [ReprNumber 3])
41+ :& FieldRepr (ReprText "test")
42+ :& RNil
8843
8944spec :: Spec
9045spec = do
91− -- it "show/read JsonRepr properly" $
92− -- read (show example) == example
93− it "decode/encode JsonRepr properly" $
94− decode (encode jsonExample) == Just jsonExample
95− it "validates correct representation" $
96− ((decodeAndValidateJson schemaJson) :: ParseResult (JsonRepr SchemaExample))
97− `shouldSatisfy` isValid
98− it "returns decoding error on structurally incorrect input" $
99− ((decodeAndValidateJson "{}") :: ParseResult (JsonRepr SchemaExample))
100− `shouldSatisfy` isDecodingError
101− it "validates incorrect representation" $
102− ((decodeAndValidateJson schemaJson2) :: ParseResult (JsonRepr SchemaExample))
103− `shouldSatisfy` isValidationError
104− -- it "validates versioned json" $ do
105− -- decodeAndValidateVersionedJson (Proxy @VS) schemaJson
106− -- `shouldSatisfy` isValid
107− it "validates versioned json with a migration list" $ do
108− decodeAndValidateVersionedWithPureMList
109− (Proxy @VersionedJson)
110− migrationList
111− schemaJson
112− `shouldSatisfy` isValid
113− it "validates json series" $ property $
114− SC.over schemaJsonSeries $ \x ->
115− isValid (parseAndValidateJson @SchemaExample (toJSON x))
116− it "validates json series 2" $ property $
117− SC.over schemaJsonSeries2 $ \x ->
118− isValid (parseAndValidateJson @SchemaExample2 (toJSON x))
119−
46+ it "decode/encode JsonRepr properly" $ do
47+ withSingI schemaExample $ property
48+ $ \(a :: JsonRepr SchemaExample) -> decode (encode a) == Just a
12049
12150main :: IO ()
12251main = hspec spec