Go to file

Marcel Otto dd63e8d792 Update travis.yml		2017-08-06 22:43:09 +02:00
config	json_ld: mix new json_ld --module JSON.LD	2016-12-08 00:27:27 +01:00
lib	core: RDF.Dataset.graphs returns a list of graphs	2017-06-05 02:41:44 +02:00
test	Add dependency on Elixir 1.5	2017-08-06 22:33:53 +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
.travis.yml	Update travis.yml	2017-08-06 22:43:09 +02:00
CHANGELOG.md	Add dependency on Elixir 1.5	2017-08-06 22:33:53 +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	Add dependency on Elixir 1.5	2017-08-06 22:33:53 +02:00
mix.lock	Prepare mix file for Hex package publishing	2017-06-25 02:19:15 +02:00
README.md	Update installation instructions	2017-06-26 19:27:13 +02:00
VERSION	Add dependency on Elixir 1.5	2017-08-06 22:33:53 +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.1"}]
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/"
}
"""
|> Poison.Parser.parse!
|> 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 = Poison.Parser.parse! """
  {
    "@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/"
      }
    ]
  }
]
"""
|> Poison.Parser.parse!
|> 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")

Getting help

Contributing

see CONTRIBUTING for details.