rename lib - add travis and coveralls - add readme

Author: e-e-e

.coveralls.yml

@@ -0,0 +1 @@
+repo_token: UOjQpeYk2baG2Ehj54CukhLdKBIN96Bya

.gitignore

@@ -1,2 +1,3 @@
+coverage/
 node_modules/
 *.log

.travis.yml

@@ -0,0 +1,10 @@
+language: node_js
+node_js:
+  - 6
+  - 7
+  - 8
+  - 9
+script:
+  - npm run travis
+after_script:
+  - npm run report-coverage

index.js

@@ -23,10 +23,6 @@ Graph.prototype.get = function (triple, callback) {
   utils.collect(this.getStream(triple), callback)
 }
 
-// this is not implemented in hyperdb yet
-// for now we just put a null value in the db
-Graph.prototype.del = doAction('del')
-
 function doAction (action) {
   return function (triples, callback) {
     if (!triples) return callback(new Error('Must pass triple'))
@@ -38,10 +34,13 @@ function doAction (action) {
   }
 }
 
+// this is not implemented in hyperdb yet
+// for now we just put a null value in the db
+Graph.prototype.del = doAction('del')
+
 Graph.prototype.put = doAction('put')
 
-Graph.prototype.putStream = function (triple) {
-}
+Graph.prototype.putStream = function (triple) { }
 
 Graph.prototype.searchStream = function (query, options) {
   const result = new PassThrough({ objectMode: true })

package.json

@@ -1,22 +1,26 @@
 {
-  "name": "hyperdb-graph",
+  "name": "hyper-graph-db",
   "version": "0.0.1",
   "description": "",
   "main": "index.js",
   "dependencies": {
-    "hyperdb": "^1.5.0",
-    "readable-stream": "^2.3.3"
+    "hyperdb": "^2.0.0",
+    "readable-stream": "^2.3.3",
+    "pump": "^2.0.0"
   },
   "devDependencies": {
     "chai": "^4.1.2",
+    "coveralls": "^3.0.0",
+    "istanbul": "^0.4.5",
     "mocha": "^4.0.1",
-    "pump": "^2.0.0",
     "random-access-memory": "^2.4.0",
     "standard": "^10.0.3"
   },
   "scripts": {
     "test": "mocha test/**.spec.js",
-    "ttd": "mocha test/**.spec.js -w"
+    "tdd": "mocha test/**.spec.js -w",
+    "travis": "NODE_ENV=test istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec",
+    "report-coverage": "cat ./coverage/lcov.info | coveralls"
   },
   "author": "Benjamin Forster",
   "license": "MIT"

readme.md

@@ -1,7 +1,117 @@
-# hyperdb-graph [wip]
+# hyper-graph-db
 
-Not much to see here. Just a spec, failing tests, and the intention to experiment.
+[![Build Status](https://travis-ci.org/e-e-e/hyper-graph-db.svg?branch=master)](https://travis-ci.org/e-e-e/hyper-graph-db) [![Coverage Status](https://coveralls.io/repos/github/e-e-e/hyper-graph-db/badge.svg?branch=master)](https://coveralls.io/github/e-e-e/hyper-graph-db?branch=master)
 
-The aim is to build a graph database on top of [hyperdb](https://github.com/mafintosh/hyperdb).
+hyper-graph-db is a graph database on top of [hyperdb](https://github.com/mafintosh/hyperdb). It interface and test specs have been adapted from [LevelGraph](https://github.com/levelgraph/levelgraph).
 
-The test spec is adapted from [LevelGraph](https://github.com/levelgraph/levelgraph).
+Like LevelGraph, **hyper-graph-db** follows the **Hexastore** approach as presented in the article: [Hexastore: sextuple indexing for semantic web data management C Weiss, P Karras, A Bernstein - Proceedings of the VLDB Endowment, 2008](http://www.vldb.org/pvldb/1/1453965.pdf). As such hyper-graph-db uses six indices for every triple in order to access them as fast as it is possible.
+
+## install
+
+```
+npm install hyper-graph-db
+```
+
+This requires node v6.x.x or greater.
+
+## basic usage
+
+```js
+var hyperdb = require('hyperdb')
+var hypergraph = require('hyper-graph-db')
+
+var db = hypergraph(hyperdb('./my.db', {valueEncoding: 'utf-8'}))
+
+var triple = { subject: 'a', predicate: 'b', object: 'c' }
+
+db.put(triple, function (err) {
+  if (err) throw err
+  db.get({ subject: 'a' }, function(err, list) {
+    console.log(list)
+  });
+})
+```
+
+## API
+
+#### `var db = hypergraph(hyperdb)`
+
+Returns an instance of hyper-graph-db using the hyperdb passed to it.
+
+#### `db.put(triple, [callback])`
+
+Inserts **Hexastore** formated entries for triple into the graph database.
+
+#### `var stream = db.putStream(triple)`
+
+Returns a writable stream. **This is not yet implemented!**
+
+#### `db.get(triple, [callback])`
+
+Returns all entries that match the triple. This allows for partial  pattern-matching. For example `{ subject: 'a' })`, will return all triples with subject equal to 'a'.
+
+#### `db.del(triple, [callback])`
+
+Remove triples indices from the graph database.
+
+#### `var stream = db.delStream(triple)`
+
+Returns a writable stream for removing entries. **This is not yet implemented!**
+
+#### `var stream = db.getStream(triple)`
+
+Returns a readable stream of all matching triples.
+
+#### `db.search(queries, [callback])`
+
+Allows for Basic Graph Patterns searches where all queries must match.
+
+```js
+db.put([{
+    subject: 'matteo',
+    predicate: 'friend',
+    object: 'daniele'
+  }, {
+    subject: 'daniele',
+    predicate: 'friend',
+    object: 'matteo'
+  }, {
+    subject: 'daniele',
+    predicate: 'friend',
+    object: 'marco'
+  }, {
+    subject: 'lucio',
+    predicate: 'friend',
+    object: 'matteo'
+  }, {
+    subject: 'lucio',
+    predicate: 'friend',
+    object: 'marco'
+  }, {
+    subject: 'marco',
+    predicate: 'friend',
+    object: 'davide'
+  }], () => {
+
+  const stream = db.search([{
+    subject: 'matteo',
+    predicate: 'friend',
+    object: db.v('x')
+  }, {
+    subject: db.v('x'),
+    predicate: 'friend',
+    object: db.v('y')
+  }, {
+    subject: db.v('y'),
+    predicate: 'friend',
+    object: 'davide'
+  }], (err, results) => {
+    if (err) throw err
+    console.log(results)
+  })
+})
+```
+
+#### `var stream = db.searchStream(queries)`
+
+Returns search results as a stream.