Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/krakphp/schema
Data Schema Declarations and Processing
https://github.com/krakphp/schema
config declarative dx functional json-schema schema schema-validation symfony validation
Last synced: 28 days ago
JSON representation
Data Schema Declarations and Processing
- Host: GitHub
- URL: https://github.com/krakphp/schema
- Owner: krakphp
- Created: 2020-03-21T23:28:16.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-17T10:44:55.000Z (over 1 year ago)
- Last Synced: 2024-11-13T08:47:38.168Z (about 2 months ago)
- Topics: config, declarative, dx, functional, json-schema, schema, schema-validation, symfony, validation
- Language: PHP
- Homepage:
- Size: 19.5 KB
- Stars: 1
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Schema
The schema library provides the ability to define schemas with a declarative API and in turn using any of the processors to act on that schema.
We separate the concepts of the schema definition and the processors to allow us to build an AST describing a schema, and then allow different processors handle that structure for things like validation, generate a symfony config tree, building valid json schema, etc etc.
## Installation
Install with composer at `krak/schema`
## Usage
### Defining a Schema
```php
string(),
'isAdmin' => bool(),
'age' => int(),
'tags' => listOf(string()),
'photos' => dict(struct([
'url' => string(),
'width' => int(),
'height' => int(),
]))
]);
/* would match a structure like:
{
"name": "Bob",
"isAdmin": true,
"age": 26,
"tags": ["tall", "dark", "handsome"],
"photos": {
"small": {
"url": "https://mydomain.com/images/bob/small",
"width": 100,
"height": 200
},
"large": {
"url": "https://mydomain.com/images/bob/large",
"width": 600,
"height": 1200
},
}
}
*/
```
### Validation (Coming Soon)
Eventually we'll support the ability to take a schema and validate array structures against them.
### Symfony Config Tree Processor
Declare and build symfony config tree builders declaratively with the `configTree` schema processor.
```php
string(),
'region' => string(),
'credentials' => struct([
'key' => string(),
'secret' => string(),
])
]));
}
}
```
*Note:* This currently supports Symfony 4 and 5 config.
[Check out the feature test suite to see examples of all the supported api.](test/feature/SymfonyConfigTest.php)
#### Comparison of Declarative vs Builder Syntax
Here's a seemingly simple config file that we'd want to validate the schema of:
```yaml
my_package:
string_key: 'abc'
int_key: 1
struct_key:
a: 1
b: 2
list_key: [1, 2, 3]
list_of_struct_key:
- a: 1
b: 2
struct_of_list:
a: ['', '']
b: [0, 0]
```
Here is the builder syntax:
```php
return (new TreeBuilder('my_package'))->getRootNode();
->children()
->scalarNode('string_key')->end()
->integerNode('int_key')->end()
->arrayNode('struct_key')
->children()
->scalarNode('a')->end()
->integerNode('b')->end()
->end()
->end()
->arrayNode('list_key')
->integerPrototype()->end()
->end()
->arrayNode('list_of_struct_key')
->arrayPrototype()
->children()
->integerNode('a')->end()
->integerNode('b')->end()
->end()
->end()
->end()
->arrayNode('struct_of_list_key')
->children()
->arrayNode('a')
->scalarPrototype()->end()
->end()
->arrayNode('b')
->integerPrototype()->end()
->end()
->end()
->end()
->end()
->end();
```
Here is the declarative syntax for the same definition:
```php
return configTree('my_package', struct([
'string_key' => string(),
'int_key' => int(),
'struct_key' => struct([
'a' => int(),
'b' => int(),
]),
'list_key' => listOf(int()),
'list_of_struct_key' => listOf(struct([
'a' => int(),
'b' => int(),
])),
'struct_of_list_key' => struct([
'a' => listOf(string()),
'b' => listOf(int()),
])
]));
```
#### References
Original RFC Pull Request to Symfony: https://github.com/symfony/symfony/issues/35127
## Documentation
No formal API documentation is setup, but the src dir is under 200loc at this point. Also the tests directory gives a good overview of the various features as well.
- [Symfony Config Feature Tests](./test/feature/SymfonyConfigTest.php)
## Testing
Run `composer test` to run the test suite.
## Roadmap
- Api Documentation
- Additional schema fns to support more string/numeric constraints (regex, min, max, etc)
- JSON Schema ProcessSchema
- Create the ability to export a schema definition to valid json schema json
- Validation ProcessSchema
- Create a function validation library for basic schemas
- Support custom validators and schema fns
- Symfony Validation ProcessSchema
- Export to symfony constraints to use with the SF validator. With one api, we could define schemas that export to SF config and SF validation!