Preparing for release v0.1.0 :).

Author: mcollina

README.md

@@ -0,0 +1,231 @@
+LevelGraph-JSONLD
+===========
+
+![Logo](https://github.com/mcollina/node-levelgraph/raw/master/logo.png)
+
+__LevelGraph-JSONLD__ is a plugin for
+[LevelGraph](http://github.com/mcollina/levelgraph) that adds the
+ability to store, retrieve and delete JSON-LD objects.
+In fact, it is a full-bown Object-Document-Mapper (ODM) for
+__LevelGraph__.
+
+[![Build
+Status](https://travis-ci.org/mcollina/levelgraph-jsonld.png)](https://travis-ci.org/mcollina/levelgraph-jsonld)
+
+## Install on Node.js
+
+```
+npm install levelgraph levelgraph-jsonld --save
+```
+
+At the moment it requires node v0.10.x, but the port to node v0.8.x
+should be straighforward.
+If you need it, just open a pull request.
+
+## Install in the Browser
+
+TO BE DONE!
+
+## Usage
+
+Adding support for JSON-LD to LevelGraph is easy:
+```
+var levelgraph = require("levelgraph")
+  , jsonld     = require("levelgraph-jsonld")
+  , db         = jsonld(levelgraph("yourdb"));
+```
+
+### Put
+
+Storing a JSON-LD file in the database is extremey easy:
+```
+var manu = {
+    "@context": {
+      "name": "http://xmlns.com/foaf/0.1/name"
+      , "homepage": {
+        "@id": "http://xmlns.com/foaf/0.1/homepage"
+        , "@type": "@id"
+      }
+    }
+  , "@id": "http://manu.sporny.org#person"
+  , "name": "Manu Sporny"
+  , "homepage": "http://manu.sporny.org/"
+}
+
+db.jsonld.put(manu, function(err, obj) {
+  // do something after the obj is inserted
+});
+```
+
+if the object as no `'@id'` key, one will be generated for you,
+using a UUID and the `'base'` argument, like so:
+```
+delete manu["@id"];
+db.jsonld.put(manu, { base: "http://this/is/an/iri" }, function(err, obj) {
+  // obj["@id"] will be something like
+http://this/is/an/iri/b1e783b0-eda6-11e2-9540-d7575689f4bc
+});
+```
+
+`'base'` can also be specified when you create the db:
+```
+var levelgraph = require("levelgraph")
+  , jsonld     = require("levelgraph-jsonld")
+  , opts       = { base: "http://matteocollina.com/base" }
+  , db         = jsonld(levelgraph("yourdb"), opts);
+```
+
+__LevelGraph-JSONLD__ also support nested objects, like so:
+```
+var nested = {
+                 "@context": {
+                     "name": "http://xmlns.com/foaf/0.1/name"
+                   , "knows": "http://xmlns.com/foaf/0.1/knows"
+                 }
+               , "@id": "http://matteocollina.com"
+               , "name": "matteo"
+               , "knows": [{
+                     "name": "daniele"
+                 }, {
+                     "name": "lucio"
+                 }]
+             };
+
+db.jsonld.put(nested, function(err, obj) {
+  // do something...
+});
+```
+
+### Get
+
+Retrieving a JSON-LD document from the store requires its `'@id'`:
+```
+db.jsonld.get(manu["@id"], { "@context": manu["@context"] }, function(err, obj) {
+  // obj will be the very same of the manu object
+});
+```
+
+The format of the loaded object is entirely specified by the
+`'@context'`, so have fun :).
+
+As with `'put'` it correctly support nested objects, but it
+inserts `'@id'` properties for them, like so:
+```
+var nested = {
+                 "@context": {
+                     "name": "http://xmlns.com/foaf/0.1/name"
+                   , "knows": "http://xmlns.com/foaf/0.1/knows"
+                 }
+               , "@id": "http://matteocollina.com"
+               , "name": "matteo"
+               , "knows": [{
+                     "name": "daniele"
+                 }, {
+                     "name": "lucio"
+                 }]
+             };
+
+db.jsonld.put(nested, function(err, obj) {
+  // obj will be 
+  // {
+  //     "@context": {
+  //         "name": "http://xmlns.com/foaf/0.1/name"
+  //       , "knows": "http://xmlns.com/foaf/0.1/knows"
+  //     }
+  //   , "@id": "http://matteocollina.com"
+  //   , "name": "matteo"
+  //   , "knows": [{
+  //         "name": "daniele"
+  //     }, {
+  //         "name": "lucio"
+  //     }]
+  // }
+});
+```
+
+### Deleting
+
+In order to delete an object, you can just pass it's `'@id'` to the
+`'@del'` method:
+```
+db.jsonld.del(manu["@id"], function(err) {
+  // do something after it is deleted!
+});
+```
+
+### Searching with LevelGraph
+
+__LevelGraph-JSONLD__ does not support searching for objects, because
+that problem is already solved by __LevelGraph__ itself, like these:
+```
+var nested = {
+                 "@context": {
+                     "name": "http://xmlns.com/foaf/0.1/name"
+                   , "knows": "http://xmlns.com/foaf/0.1/knows"
+                 }
+               , "@id": "http://matteocollina.com"
+               , "name": "matteo"
+               , "knows": [{
+                     "name": "daniele"
+                 }, {
+                     "name": "lucio"
+                 }]
+             };
+
+db.jsonld.put(nested, function(err) {
+  db.join([{
+      subject: db.v("person")
+    , predicate: "http://xmlns.com/foaf/0.1/knows"
+    , object: db.v("friend")
+  }, {
+      subject: db.v("friend")
+    , predicate: "http://xmlns.com/foaf/0.1/knows"
+    , object: "daniele"
+  }], function(err, solutions) {
+    // The solutions will be:
+    // 1. { person: "http://matteocollina.com", friend: "_:abcde" }
+    // 1. { person: "http://matteocollina.com", friend: "_:efghi" }
+  });
+});
+```
+
+## Contributing to LevelGraph-JSONLD
+
+* Check out the latest master to make sure the feature hasn't been
+  implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't
+  requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it
+  in a future version unintentionally.
+* Please try not to mess with the Makefile and package.json. If you
+  want to have your own version, or is otherwise necessary, that is
+  fine, but please isolate to its own commit so I can cherry-pick around
+  it.
+
+## LICENSE - "MIT License"
+
+Copyright (c) 2013 Matteo Collina (http://matteocollina.com)
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

index.js

@@ -131,12 +131,19 @@ function levelgraphJSONLD(db, jsonldOpts) {
           cb(null, acc);
         } else if (triple.object.indexOf("_:") !== 0) {
           acc[triple.subject][triple.predicate] = {};
-          key = (triple.object.match(IRI) || triple.object.indexOf("_:") === 0) ? "@id" : "@value";
+          key = (triple.object.match(IRI)) ? "@id" : "@value";
           acc[triple.subject][triple.predicate][key] = triple.object;
           cb(null, acc);
         } else {
           fetchExpandedTriples(triple.object, function(err, expanded) {
-            acc[triple.subject][triple.predicate] = expanded[triple.object];
+            if (!acc[triple.subject][triple.predicate]) {
+              acc[triple.subject][triple.predicate] = expanded[triple.object];
+            } else {
+              if (!acc[triple.subject][triple.predicate].push) {
+                acc[triple.subject][triple.predicate] = [acc[triple.subject][triple.predicate]];
+              }
+              acc[triple.subject][triple.predicate].push(expanded[triple.object]);
+            }
             cb(err, acc);
           });
         }
@@ -155,12 +162,8 @@ function levelgraphJSONLD(db, jsonldOpts) {
       if (err || expanded === null) {
         return callback(err, expanded);
       }
-      expanded = Object.keys(expanded).reduce(function(acc, key) {
-        acc.push(expanded[key]);
-        return acc;
-      }, []);
 
-      jsonld.compact(expanded, context, options, callback);
+      jsonld.compact(expanded[iri], context, options, callback);
     });
   };
 

package.json

@@ -1,12 +1,18 @@
 {
   "name": "levelgraph-jsonld",
-  "version": "0.0.0",
-  "description": "The Object Document Mapper of LevelGraph based on JSON-LD",
+  "version": "0.1.0",
+  "description": "The Object Document Mapper for LevelGraph based on JSON-LD",
   "main": "index.js",
   "scripts": {
     "test": "./node_modules/.bin/mocha --recursive test"
   },
-  "repository": "",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mcollina/levelgraph-jsonld.git"
+  },
+  "bugs": {
+    "url": "http://github.com/mcollina/levelgraph-jsonld/issues"
+  },
   "keywords": [
     "object",
     "document",
@@ -20,7 +26,7 @@
     "rdf",
     "linked data"
   ],
-  "author": "",
+  "author": "Matteo Collina <hello@matteocollina.com>",
   "license": "MIT",
   "dependencies": {
     "jsonld": "0.0.62",
@@ -33,7 +39,6 @@
   "devDependencies": {
     "mocha": "~1.10.0",
     "levelgraph": "~0.6.1",
-    "levelgraph-n3": "~0.1.0",
     "level-test": "~1.4.0",
     "chai": "~1.7.2"
   }

test/fixture/nested.json

@@ -0,0 +1,13 @@
+{
+    "@context": {
+        "name": "http://xmlns.com/foaf/0.1/name"
+      , "knows": "http://xmlns.com/foaf/0.1/knows"
+    }
+  , "@id": "http://matteocollina.com"
+  , "name": "matteo"
+  , "knows": [{
+        "name": "daniele"
+    }, {
+        "name": "lucio"
+    }]
+}

test/get_spec.js

@@ -53,4 +53,17 @@ describe("jsonld.get", function() {
       });
     });
   });
+
+  it("should support nested objects", function(done) {
+    var nested = fixture("nested.json");
+
+    db.jsonld.put(nested, function(err, obj) {
+      db.jsonld.get(obj["@id"], { "@context": obj["@context"] }, function(err, result) {
+        delete result["knows"][0]["@id"];
+        delete result["knows"][1]["@id"];
+        expect(result).to.eql(nested);
+        done();
+      });
+    });
+  });
 });

test/put_spec.js

@@ -165,4 +165,15 @@ describe("jsonld.put with default base", function() {
       });
     });
   });
+
+  it("should support nested objects", function(done) {
+    var nested = fixture("nested.json");
+
+    db.jsonld.put(nested, function() {
+      db.get({}, function(err, triples) {
+        expect(triples).to.have.property("length", 5);
+        done();
+      });
+    });
+  });
 });