https://github.com/ttab/revisor
https://github.com/ttab/revisor
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ttab/revisor
- Owner: ttab
- License: mit
- Created: 2024-05-29T13:16:36.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-18T07:22:06.000Z (over 1 year ago)
- Last Synced: 2025-04-07T10:46:01.119Z (about 1 year ago)
- Language: Go
- Size: 240 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Revisor
Revisor allows you to define specifications for NewsDoc contents as a series of declarations and pattern matching extensions to existing declarations.
## Breaking changes
### v0.9.0
I this release we remove the ability to define global blocks and attributes that automatically are available for all document types. Globals was a mistake and have now been replaced by block definitions:
``` json
{
"version": 1,
"name": "block-example",
"documents": [
{
"name": "Article",
"description": "An editorial article",
"declares": "core/article",
"content": [
{"ref": "core://text"}
]
}
],
"content": [
{
"id": "core://text",
"block": {
"description": "A standard text block",
"declares": {"type":"core/text"},
"attributes": {
"role": {
"optional":true,
"enum": ["heading-1", "heading-2", "preamble"]
}
},
"data": {
"text":{
"allowEmpty":true,
"format": "html"
}
}
}
}
]
}
```
Inline blocks can still be declared as before.
When using `ref` it's possible to extend the block in the same block constraint. Writing this:
``` json
{
"version": 1,
"name": "block-example",
"documents": [
{
"name": "Article",
...
"meta": [
{
"ref": "core://newsvalue",
"count": 1
}
]
...
```
...is equivalent to:
``` json
...
"meta": [
{
"ref": "core://newsvalue"
},
{
"match": {"type": "core/newsvalue"},
"count": 1
}
]
...
```
...as any constraints will be treated as a block constraint with a `match` directive equivalent to the `declares` object of the referenced block.
## Writing specifications
The main entities points in a specification are documents, blocks and properties. Documents are declared by type, blocks by type, rel, and/or role, and properties by name. An entity is not valid if we don't have a matching declaration for it, regardless of whether somebody has pattern-matched against it.
Both pattern matching and a lot of the validation that's performed is done though key value pairs of a name and a string constraint. Say that we want to match all links that have a rel of "subject", "channel", or "section" and add the ability to have "broader" links added to them, the specification would then look like this:
``` json
{
"name": "Associated with and broader links",
"description": "Extends subject, channel, and section links with broader links",
"match": {"rel": {
"enum": ["subject", "channel", "section"]
}},
"links": [
{
"declares": {"rel":"broader"},
"attributes": {
"type": {},
"title": {}
}
}
]
}
```
Here we declare that links with `rel` "broader" are valid for all blocks that matches our expression, see "Block attributes" for a list of attributes that can be used in pattern matching. We also define that the attributes `type` and `title` must be present. The `{"enum":...}` object and the empty objects (`{}`) for `type` and `title` are all examples of string constraints.
### String constraints
| Name | Use |
|:--------------|:-----------------------------------------------------------------------------------------------------------|
| optional | Set to `true` if the value doesn't have to be present |
| allowEmpty | Set to `true` if an empty value is ok. |
| const | A specific `"value"` that must match |
| enum | A list `["of", "values"]` where one must match |
| pattern | A regular expression that the value must match |
| glob | A list of glob patterns `["http://**", "https://**"]` where one must match |
| format | A named format that the value must follow |
| time | A time format specification |
| colourFormats | Controls the "colour" format. Any combination of "hex", "rgb", and "rgba". Defaults to `["rgb", "rgba"]`. |
| geometry | The geometry and coordinate type that must be used for WKT strings. |
| labels | Labels used to describe the value |
| hints | Key value pairs used to describe the value |
The distinction between optional and allowEmpty is only relevant for data attributes. The document and block attributes defined in the NewsDoc schema always exist, so `optional` and `allowEmpty` will be treated as equivalent.
#### Formats
The following formats are available:
* `RFC3339`: an RFC3339 timestamp ("2022-05-11T14:10:32Z")
* `int`: an integer ("1234")
* `float`: a floating point number ("12.34")
* `bool`: a boolean ("true" or "false")
* `html`: validate the contents as HTML
* `uuid`: validate the string as a UUID
* `wkt`: validate the string as a [WKT geometry](#wkt-geometry).
* `colour`: a colour in one of the formats specified in `colourFormats`.
When using the format "html" it's also possible to use `htmlPolicy` to use a specific HTML policy. See the section on [HTML policies](#markdown-header-html-policies).
The document and block `uuid` attributes are always validated as UUIDs and need no additional "uuid" format specified.
#### Time formats
A Go time parsing layout (see the [time package](https://pkg.go.dev/time#pkg-constants) for documentation) that should be used to validate the timestamp.
#### Globs
Glob matching uses [https://github.com/gobwas/glob](https://github.com/gobwas/glob) for matching, and the glob patterns are compiled with "/" and "+" as separators.
#### WKT geometry
The geometry specification is a combination of the geometry type to expect, and optionally the types of coordinates it should contain, in the format `{geometry-type}[-{coordinates}]`. If no geometry is specified any of the supported types and coordinates are allowed. If no coordinates are specified the default X and Y coordinates are assumed.
Geometry types:
* `point`
* `multipoint`
* `linestring`
* `multilinestring`
* `polygon`
* `multipolygon`
* `circularstring`
Coordinates, X and Y is the default if nothing else is specified:
* `z`: X, Y, and Z coordinates
* `m`: X and Y coordinates and a measurement
* `zm`:X, Y and Z coordinates and a measurement
#### Labels and hints
Labels and hints do not play any role in the validation of documents. They are instead meant to describe the value for systems that use the information in the revisor schema to process the data correctly. It could f.ex. be used to tell a system that a specific WKT point is the position of the document itself, that a string value should be indexed as a keyword (non-tokenised), or provide other kinds of processing hints unrelated to the validation.
Example block declaration:
``` json
{
"declares": {
"type": "tt/slugline"
},
"maxCount": 1,
"attributes": {
"value": {
"labels": ["keyword"],
"hints": {"alias": ["slug"]}
}
}
}
```
### Writing a document specification
A specification for a document contains:
* documentation attributes `name` and `description`
* a declaration (`declares`) or pattern matching rule (`match`)
* attribute constraints (`attributes`)
* `meta`, `links`, and `content` block specifications
``` json
{
"name": "Planning item",
"description": "Planned news coverage",
"declares": "core/newscoverage",
"meta": [
{
"name": "Main metadata block",
"declares": {"type":"core/newscoverage"},
"count": 1,
"data": {
"dateGranularity": {"enum":["date", "datetime"]},
"description": {"allowEmpty":true},
"start": {"format":"RFC3339"},
"end": {"format":"RFC3339"},
"priority": {},
"publicDescription":{"allowEmpty":true},
"slug": {"allowEmpty":true}
}
}
],
"links": [
{
"declares": {"type": "x-im/assignment"},
"links": [
{
"declares": {
"rel":"assignment", "type": "x-im/assignment"
},
"attributes": {
"uuid": {}
}
}
]
}
]
}
```
### Writing a block specification
A block specification can contain:
* documentation attributes `name` and `description`
* a declaration (`declares`) or pattern matching rule (`match`)
* attribute constraints (`attributes`)
* `data` constraints
* `meta`, `links`, and `content` block specifications
* `count`, `minCount` and `maxCount` to control how many times a block can occur in the list of blocks it's in
* `blocksFrom` directives that borrows the allowed blocks from a declared document type.
``` json
{
"declares": {"type": "core/socialembed"},
"links": [
{
"declares": {"rel":"self", "type":"core/tweet"},
"maxCount": 1,
"attributes": {
"uri": {"glob":["core://tweet/*"]},
"url": {"glob":["https://twitter.com/narendramodi/status/*"]}
}
},
{
"declares": {"rel":"alternate", "type":"text/html"},
"maxCount": 1,
"attributes": {
"url": {"glob":["https://**"]},
"title": {}
},
"data": {
"context": {},
"provider": {}
}
}
]
}
```
### HTML policies
HTML policies are used to restrict what elements and attributes can be used in strings with the format "html". Attributes are defined as string constraints on elements. The default policy could look like this:
``` json
"htmlPolicies": [
{
"name": "default",
"elements": {
"strong": {
"attributes": {
"id": {"optional":true}
}
},
"a": {
"attributes": {
"id": {"optional":true},
"href": {}
}
}
}
},
{
"name": "table",
"uses": "default",
"elements": {
"tr": {
"attributes": {
"id": {"optional":true}
}
},
"td": {
"attributes": {
"id": {"optional":true}
}
},
"th": {
"attributes": {
"id": {"optional":true}
}
}
}
}
]
```
All "html" strings that use the default policy would then be able to use `` and ``, and the "href" attribute would be requred for ``. A "html" string that uses the "table" policy would be able to use everything from the default policy *and* ``, ``, and ``.
A customer can extend HTML policies using the "extend" attribute:
``` json
"htmlPolicies": [
{
"extends": "default",
"elements": {
"personTag": {
"attributes": {
"id": {}
}
}
}
}
]
```
This would add support for "/" (HTML is case insensitive) to the default policy, and any policies that use it. Only one level of "extends" and "uses" is allowed, further chaining policies will result in an error.
### Attribute reference
#### Document attributes
A list of available document attributes, and whether they can be used in pattern matching.
| Name | Description | Match |
|:---------|------------------------------------------------|:------|
| uuid | The document uuid | No |
| uri | The URI that identifies the document | No |
| url | A web-browsable location for the document | No |
| type | The type of the document | Yes |
| language | The document language | No |
| title | The document title | No |
#### Block attributes
A list of available block attributes, and whether they can be used in pattern matching.
| Name | Description | Match |
|:------------|:----------------------------------------------------------|:------|
| uuid | The UUID of the document the block represents | No |
| type | The type of the block | Yes |
| uri | Identifies a resource in in URI form | Yes |
| url | A web-browsable location for the block | Yes |
| title | Human readable title of the block | No |
| rel | The relationship the block describes | Yes |
| name | A name that identifies the block | Yes |
| value | A generic value for the block | Yes |
| contenttype | The content type of the resource that the block describes | Yes |
| role | The role that the block or resource has | Yes |
## Testing
Revisor implements a file-driven test in `TestValidateDocument` that checks so that all the "testdata/results/*.json" files match the validation results for the corresponding document under "testdata/". Result files with the prefix "base-" will be validated against "constraints/naviga.json", for result files with the prefix "example-" the "constraints/example.json" constraints will be used as well.
If the constraints have been updated, or new example documents have been added, the result files can be regenerated using `./update-test-results.sh`.
### Benchmarks
The benchmark `BenchmarkValidateDocument` tests the performance of validating "testdata/example-article.json" against the naviga and example organisation contsraint sets.
To run the benchmark execute:
``` bash
$ go test -bench . -benchmem -cpu 1
```
Add the flags `-memprofile memprofile.out -cpuprofile profile.out` to collect CPU and memory profiles. Run `go tool pprof -web profile.out` for the respective profile files to open a profile graph in your web browser.
#### Comparing benchmarks
Install `benchstat`: `go install golang.org/x/perf/cmd/benchstat@latest`.
Run the benchmark on the unchanged code (stash your changes or check out main):
``` bash
$ go test -bench . -benchmem -count 5 -cpu 1 | tee old.txt
```
Then run the benchmarks on the new code:
``` bash
$ go test -bench . -benchmem -count 5 -cpu 1 | tee new.txt
```
Finally, run benchstat to get a summary of the change:
``` bash
$ benchstat old.txt new.txt
name old time/op new time/op delta
ValidateDocument 203µs ± 7% 99µs ± 3% -51.03% (p=0.008 n=5+5)
name old alloc/op new alloc/op delta
ValidateDocument 134kB ± 0% 35kB ± 0% -73.74% (p=0.008 n=5+5)
name old allocs/op new allocs/op delta
ValidateDocument 1.05k ± 0% 0.59k ± 0% -43.48% (p=0.008 n=5+5)
```
### Fuzz tests
There are two fuzz targets in the project: `FuzzValidationWide` that allows fuzzing of the document and two constraint sets. It will load the core constraints, the example organisation constraints, and all documents in "./testdata/" and add them as fuzzing seeds. `FuzzValidationConstraints` adds all constraint sets from the "./constraints/" and adds them as fuzzing seeds. The fuzzing operation is then done against all documents in "./testdata/".