Go to file

Marcel Otto d06c83340e Drop support for Elixir 1.5		2018-09-17 02:53:51 +02:00
config	json_ld: mix new json_ld --module JSON.LD	2016-12-08 00:27:27 +01:00
lib	Add @impl annotations	2018-09-17 02:47:20 +02:00
test	Adapt JSON.LD.TestSuite to new RDF.Serialization.Reader option handling	2018-08-31 01:44:57 +02:00
.editorconfig	Add .editorconfig	2017-06-25 02:06:24 +02:00
.gitignore	json_ld: mix new json_ld --module JSON.LD	2016-12-08 00:27:27 +01:00
.iex.exs	Add .iex.exs file	2018-07-10 22:57:19 +02:00
.travis.yml	Drop support for Elixir 1.5	2018-09-17 02:53:51 +02:00
CHANGELOG.md	Drop support for Elixir 1.5	2018-09-17 02:53:51 +02:00
CODE_OF_CONDUCT.md	Add CODE_OF_CONDUCT	2017-06-25 02:07:04 +02:00
CONTRIBUTING.md	Add CONTRIBUTING.md	2017-06-25 20:19:26 +02:00
LICENSE.md	Update copyright	2017-06-25 02:06:43 +02:00
mix.exs	Drop support for Elixir 1.5	2018-09-17 02:53:51 +02:00
mix.lock	Update development dependencies	2018-09-17 02:25:15 +02:00
README.md	Support for pretty printing by passing options through to Jason 1.1	2018-07-11 00:17:36 +02:00
VERSION	Upgrade to latest master of RDF.ex	2018-08-31 01:43:37 +02:00

README.md

JSON-LD.ex

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

remote contexts
JSON-LD Framing
JSON-LD 1.1 support

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.2"}]
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.