dat-json

Author: joehand

.gitignore

@@ -0,0 +1,27 @@
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
+node_modules

.travis.yml

@@ -0,0 +1,7 @@
+language: node_js
+node_js:
+  - '4'
+  - '6'
+cache:
+  directories:
+    - node_modules

LICENSE.md

@@ -0,0 +1,9 @@
+# [MIT License](https://spdx.org/licenses/MIT)
+
+Copyright (c) 2017 Joe Hand <joe@hand.email>
+
+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.

README.md

@@ -0,0 +1,56 @@
+# dat-json
+
+read & write dat.json files. Uses toiletdb under the hood.
+
+[![npm][npm-image]][npm-url]
+[![travis][travis-image]][travis-url]
+[![standard][standard-image]][standard-url]
+
+## Install
+
+```
+npm install dat-json
+```
+
+## Usage
+
+```js
+var DatJSON = require('dat-json')
+
+var datjson = DatJSON(archive)
+
+datjson.create({title: 'a dat', description: 'exciting'}, function (err) {
+  if (err) throw err
+})
+```
+
+## API
+
+### `var datjson = DatJSON(archive)`
+
+#### `datjson.create([data], cb)`
+
+Create a new `dat.json` file in the archive with the default keys (`name`, `url`, `title`, `description`). Pass in any additional data to add on initial create.
+
+#### `datjson.write(key, val, cb)` or `datjson.write(data, cb)`
+
+Write a single `key` and `value` or an object, `data`, to the `dat.json` file.
+
+#### `datjson.delete(key, cb)`
+
+Delete a `key` from the `dat.json` file.
+
+#### `datjson.read(cb)`
+
+Read the current `dat.json`.
+
+## License
+
+[MIT](LICENSE.md)
+
+[npm-image]: https://img.shields.io/npm/v/dat-json.svg?style=flat-square
+[npm-url]: https://www.npmjs.com/package/dat-json
+[travis-image]: https://img.shields.io/travis/joehand/dat-json.svg?style=flat-square
+[travis-url]: https://travis-ci.org/joehand/dat-json
+[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
+[standard-url]: http://npm.im/standard

index.js

@@ -0,0 +1,49 @@
+var stringKey = require('dat-encoding').toStr
+// var path = require('path')
+var xtend = require('xtend')
+var toiletdb = require('toiletdb')
+
+module.exports = function (archive) {
+  var db = toiletdb({name: '/dat.json', fs: archive})
+  var that = {
+    read: function (cb) {
+      archive.stat('/dat.json', function (err, stat) {
+        if (err) return cb(err)
+        db.read(cb)
+      })
+    },
+    write: function (key, val, cb) {
+      if (!archive.writable) return cb(new Error('Archive not writable'))
+      if (typeof key === 'object') return writeAll(key, val) // assume val = cb
+      // TODO: validate things
+      db.write(key, val, cb)
+    },
+    delete: db.delete,
+    create: function (data, cb) {
+      if (typeof data === 'function') return that.create(null, data)
+      if (!archive.writable) return cb(new Error('Archive not writable'))
+      var defaults = xtend({
+        title: '', // TODO path.basename(dir),
+        name: '',
+        description: ''
+      }, data, {
+        url: 'dat://' + stringKey(archive.key) // force the key as default
+      })
+      that.write(defaults, cb)
+    }
+  }
+
+  return that
+
+  function writeAll (data, cb) {
+    if (!archive.writable) return cb(new Error('Archive not writable'))
+    var keys = Object.keys(data)
+    var pending = keys.length
+    keys.map(function (key) {
+      that.write(key, data[key], function (err) {
+        if (err) return cb(err)
+        if (!--pending) return cb()
+      })
+    })
+  }
+}

package.json

@@ -0,0 +1,31 @@
+{
+  "name": "dat-json",
+  "description": "read & write dat.json files",
+  "version": "0.0.0",
+  "author": "Joe Hand <joe@hand.email>",
+  "bugs": {
+    "url": "https://github.com/joehand/dat-json/issues"
+  },
+  "devDependencies": {
+    "random-access-memory": "^2.4.0",
+    "standard": "*",
+    "tap-spec": "^4.0.2",
+    "tape": "^4.0.0"
+  },
+  "homepage": "https://github.com/joehand/dat-json",
+  "keywords": [],
+  "license": "MIT",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/joehand/dat-json.git"
+  },
+  "scripts": {
+    "test": "standard && tape test/*.js | tap-spec"
+  },
+  "dependencies": {
+    "dat-encoding": "^4.0.2",
+    "toiletdb": "github:joehand/toiletdb#custom-fs",
+    "xtend": "^4.0.1"
+  }
+}

test/index.js

@@ -0,0 +1,47 @@
+var test = require('tape')
+var hyperdrive = require('hyperdrive')
+var ram = require('random-access-memory')
+var datJSON = require('..')
+
+test('Default dat.json', function (t) {
+  var archive = hyperdrive(ram)
+  archive.ready(function () {
+    var datjson = datJSON(archive)
+    datjson.read(function (err) {
+      t.ok(err, 'error read before write')
+      datjson.create({name: 'test'}, function (err) {
+        t.error(err, 'no error')
+
+        datjson.read(function (err, data) {
+          t.error(err, 'no error')
+          t.ok(data, 'has metadata')
+          t.same(data.url, `dat://${archive.key.toString('hex')}`)
+          t.same(data.name, 'test', 'has name value')
+          t.end()
+        })
+      })
+    })
+  })
+})
+
+test('Write dat.json to archive', function (t) {
+  var archive = hyperdrive(ram)
+  archive.ready(function () {
+    var datjson = datJSON(archive)
+    datjson.create(function (err) {
+      t.error(err, 'no error')
+      datjson.write({specialVal: 'cat'}, check)
+
+      function check (err) {
+        t.error(err, 'no error')
+        datjson.read(function (err, data) {
+          t.error(err, 'no error')
+          t.ok(data, 'has metadata')
+          t.same(data.url, `dat://${archive.key.toString('hex')}`, 'url ok')
+          t.same(data.specialVal, 'cat', 'has special value')
+          t.end()
+        })
+      }
+    })
+  })
+})