mtrudel/pragmatic_context

A library to declaratively add JSON-LD support to your ActiveModel objects

pragmatic_context's Issues

Namespace Collision (& Related Development FYI)

First off, I wanted to let you know that I'm working on ensuring compatibility between pragmatic_context and the newly minted active-triples gem. I have a branch in place with appropriate tests. Any feedback is welcome.

I'm dealing with a namespace conflict on #context between RDF::Graph and PragmaticContext::Contextualizable. They use it, of course, in very different ways and the effect is that including Contextualizable breaks my models. This may not be an issue you are interested in dealing with on your end, but I figured It couldn't hurt to make you aware of the conflict.

jsonld_context should also be a class method

It's not dependent on instance attributes, and it's awkward to instantiate a model in order to produce a context document -- e.g. to serve at a URL, so that API responses can use the Link header instead of embedding the context.

Add support for compacting nested Hash objects

This will help cleanly support @mjsuhonos' use case, namely:

{
    "@id" : "http://some.uri/a_book",
    "@type" : "http://schema.org/Book",
    "@context" : {
        "mods" : "http://www.loc.gov/mods/rdf/v1#"
    },
    "mods:title" : "Of Mice and Men"
}

I suspect that the DSL for this would look like:

class Resource
  field :mods, :type => Hash
  contextualize :mods, :as => "http://www.loc.gov/mods/rdf/v1#', :compact => true
end

Recursion into nested Contextualizable objects does not work on lists

Lists of objects are serialized as they appear, even when the objects within them are Contextualiziable.

I have a proposed failing test in a branch:
https://github.com/no-reply/pragmatic_context/compare/feature;lists

Add support to DSL to define type and id for a document

Define a canonical serializer

We have a need to serialize consistently, as leaving it to the user is error prone and not the simplest thing for many cases.

Define an as_jsonld method in a separate mixin that builds an object consisting of contextualized terms, and properly compacts hashes where indicated.

Also, ensure that it properly walks embedded documents

Add a section to the documentation to describe the use case