No description
Find a file
2020-06-19 13:02:01 +02:00
config json_ld: mix new json_ld --module JSON.LD 2016-12-08 00:27:27 +01:00
lib Cleanup of the remote context processing 2020-06-19 02:40:06 +02:00
test Disable remote-doc test suite 2020-06-19 02:40:57 +02:00
.editorconfig Add .editorconfig 2017-06-25 02:06:24 +02:00
.gitignore Add .tool-versions to gitignore 2018-09-17 04:06:21 +02:00
.iex.exs Adapt to new RDF.ex literal datatype system 2020-05-07 17:21:12 +02:00
.travis.yml Drop support for Elixir < 1.8 and add newer Elixir/OTP versions to CI 2020-05-30 20:46:08 +02:00
CHANGELOG.md Prepare release 0.3.2 2020-06-19 02:52:44 +02:00
CODE_OF_CONDUCT.md Add CODE_OF_CONDUCT 2017-06-25 02:07:04 +02:00
CONTRIBUTING.md Update links to new repo URL under the rdf-elixir organization 2020-06-01 17:52:01 +02:00
LICENSE.md Prepare release 0.3.1 2020-06-01 21:44:16 +02:00
mix.exs Fix failing CI builds under OTP 21 2020-06-19 13:02:01 +02:00
mix.lock Fix failing CI builds under OTP 21 2020-06-19 13:02:01 +02:00
README.md Update README 2020-06-19 02:49:23 +02:00
VERSION Prepare release 0.3.2 2020-06-19 02:52:44 +02:00

JSON-LD-logo-64

JSON-LD.ex

Travis Hex.pm Coverage Status

An implementation of the JSON-LD standard for Elixir and RDF.ex.

Features

  • fully conforming JSON-LD API processor
  • JSON-LD reader/writer for RDF.ex
  • tests of the JSON-LD test suite (see here for a detailed status report)

TODO

Installation

The JSON-LD.ex Hex package can be installed as usual, by adding json_ld to your list of dependencies in mix.exs:

def deps do
  [{:json_ld, "~> 0.3"}]
end

Usage

Expand a document

"""
{
 "@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!
|> JSON.LD.expand

produces

[%{"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

context = Jason.decode! """
  {
    "@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!
|> JSON.LD.compact(context)

produces

%{"@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.

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, the underlying JSON encoder, to which the given options are passed through.

JSON.LD.write_file!(dataset, "file.jsonld", pretty: true)
JSON.LD.write_string(dataset, "file.jsonld", pretty: [indent: "\t"])

Getting help

Contributing

see CONTRIBUTING for details.

(c) 2017-2020 Marcel Otto. MIT Licensed, see LICENSE for details.