jsonld-ex/README.md

159 lines
3.7 KiB
Markdown
Raw Normal View History

2019-07-21 21:58:44 +00:00
<img style="border:0px;" width="64" src="https://json-ld.org/images/json-ld-logo-64.png" alt="JSON-LD-logo-64" align="right"/>
2017-06-25 00:11:10 +00:00
# JSON-LD.ex
2017-06-25 19:55:24 +00:00
[![Travis](https://img.shields.io/travis/marcelotto/jsonld-ex.svg?style=flat-square)](https://travis-ci.org/marcelotto/jsonld-ex)
[![Hex.pm](https://img.shields.io/hexpm/v/json_ld.svg?style=flat-square)](https://hex.pm/packages/json_ld)
2017-08-11 12:34:34 +00:00
[![Coverage Status](https://coveralls.io/repos/github/marcelotto/jsonld-ex/badge.svg?branch=master)](https://coveralls.io/github/marcelotto/jsonld-ex?branch=master)
2017-06-25 19:55:24 +00:00
2017-06-25 00:11:10 +00:00
An implementation of the [JSON-LD] standard for Elixir and [RDF.ex].
2017-06-25 00:11:10 +00:00
## Features
- fully conforming JSON-LD API processor
- JSON-LD reader/writer for [RDF.ex]
2017-06-25 01:10:27 +00:00
- tests of the [JSON-LD test suite][] (see [here](https://github.com/marcelotto/jsonld-ex/wiki/JSON-LD.ex-implementation-report) for a detailed status report)
2017-06-25 00:11:10 +00:00
## TODO
- remote contexts
- [JSON-LD Framing]
- [JSON-LD 1.1] support
2017-06-25 00:11:10 +00:00
## Installation
2017-06-26 17:27:13 +00:00
The [JSON-LD.ex](https://hex.pm/packages/json_ld) Hex package can be installed as usual, by adding `json_ld` to your list of dependencies in `mix.exs`:
2017-06-25 00:11:10 +00:00
```elixir
def deps do
2018-09-17 02:14:35 +00:00
[{:json_ld, "~> 0.3"}]
2017-06-25 00:11:10 +00:00
end
```
## Usage
2017-06-25 00:11:10 +00:00
### Expand a document
```elixir
"""
{
"@context":
{
"name": "http://xmlns.com/foaf/0.1/name",
"homepage": {
"@id": "http://xmlns.com/foaf/0.1/homepage",
"@type": "@id"
}
},
"name": "Manu Sporny",
"homepage": "http://manu.sporny.org/"
}
"""
|> Jason.decode!
2017-06-25 00:11:10 +00:00
|> JSON.LD.expand
```
produces
```elixir
[%{"http://xmlns.com/foaf/0.1/homepage" => [%{"@id" => "http://manu.sporny.org/"}],
"http://xmlns.com/foaf/0.1/name" => [%{"@value" => "Manu Sporny"}]}]
```
### Compact a document
```elixir
context = Jason.decode! """
2017-06-25 00:11:10 +00:00
{
"@context": {
"name": "http://xmlns.com/foaf/0.1/name",
"homepage": {
"@id": "http://xmlns.com/foaf/0.1/homepage",
"@type": "@id"
}
}
}
"""
"""
[
{
"http://xmlns.com/foaf/0.1/name": [ "Manu Sporny" ],
"http://xmlns.com/foaf/0.1/homepage": [
{
"@id": "http://manu.sporny.org/"
}
]
}
]
"""
|> Jason.decode!
2017-06-25 00:11:10 +00:00
|> JSON.LD.compact(context)
```
produces
```elixir
%{"@context" => %{
"homepage" => %{
"@id" => "http://xmlns.com/foaf/0.1/homepage",
"@type" => "@id"},
"name" => "http://xmlns.com/foaf/0.1/name"
},
"homepage" => "http://manu.sporny.org/",
"name" => "Manu Sporny"}
```
## RDF Reader and Writer
JSON-LD.ex can be used to serialize or deserialize RDF graphs by using it as a RDF.ex reader and writer.
```elixir
dataset = JSON.LD.read_file!("file.jsonld")
JSON.LD.write_file!(dataset, "file.jsonld")
```
## Pretty printing
Pretty printing is possible on all writer functions with all of the formatter options of [Jason](https://hexdocs.pm/jason/Jason.Formatter.html#pretty_print/2), the underlying JSON encoder, to which the given options are passed through.
```elixir
JSON.LD.write_file!(dataset, "file.jsonld", pretty: true)
JSON.LD.write_string(dataset, "file.jsonld", pretty: [indent: "\t"])
```
2017-06-25 00:11:10 +00:00
## Getting help
- [Documentation](http://hexdocs.pm/json_ld)
- [Google Group](https://groups.google.com/d/forum/rdfex)
## Contributing
see [CONTRIBUTING](CONTRIBUTING.md) for details.
## License and Copyright
(c) 2017 Marcel Otto. MIT Licensed, see [LICENSE](LICENSE.md) for details.
[RDF.ex]: https://hex.pm/packages/rdf
[JSON-LD]: http://www.w3.org/TR/json-ld/ "JSON-LD 1.0"
[JSON-LD 1.1]: https://json-ld.org/spec/latest/json-ld/ "JSON-LD 1.1"
[JSON-LD API]: http://www.w3.org/TR/json-ld-api/ "JSON-LD 1.0 Processing Algorithms and API"
[JSON-LD Framing]: http://json-ld.org/spec/latest/json-ld-framing/
[JSON-LD test suite]: http://json-ld.org/test-suite/