make unixfs be just unixfs, continue the importing on data-importing

Author: daviddias

README.md

@@ -9,3 +9,5 @@ ipfs-unixfs
 [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
 
 > JavaScript implementation of IPFS' unixfs (a Unix FileSystem representation on top of a MerkleDAG)
+
+# Usage

src/index.js

@@ -1 +1,86 @@
-exports.format = require('./unixfs-format.js')
+const fs = require('fs')
+const path = require('path')
+const protobuf = require('protocol-buffers')
+const schema = fs.readFileSync(path.resolve(__dirname, 'unixfs.proto'))
+const pb = protobuf(schema)
+const unixfsData = pb.Data // encode/decode
+// const unixfsMetadata = pb.MetaData // encode/decode
+
+const types = [
+  'raw',
+  'directory',
+  'file',
+  'metadata',
+  'symlink'
+]
+
+exports = module.exports = Data
+
+function Data (type, data) {
+  if (!(this instanceof Data)) {
+    return new Data(type, data)
+  }
+  if (types.indexOf(type) === -1) {
+    throw new Error('Type: ' + type + ' is not valid')
+  }
+
+  this.type = type
+  this.data = data
+  this.blockSizes = []
+
+  this.addBlockSize = (size) => {
+    this.blockSizes.push(size)
+  }
+
+  this.removeBlockSize = (index) => {
+    this.blockSizes.splice(index, 1)
+  }
+
+  // data.length + blockSizes
+  this.fileSize = () => {
+    var sum = 0
+    this.blockSizes.forEach((size) => {
+      sum += size
+    })
+    if (data) {
+      sum += data.length
+    }
+    return sum
+  }
+
+  // encode to protobuf
+  this.marshal = () => {
+    var type
+
+    switch (this.type) {
+      case 'raw': type = unixfsData.DataType.Raw; break
+      case 'directory': type = unixfsData.DataType.Directory; break
+      case 'file': type = unixfsData.DataType.File; break
+      case 'metadata': type = unixfsData.DataType.Metadata; break
+      case 'symlink': type = unixfsData.DataType.Symlink; break
+    }
+    var fileSize = this.fileSize()
+
+    if (fileSize === 0) {
+      fileSize = undefined
+    }
+
+    return unixfsData.encode({
+      Type: type,
+      Data: this.data,
+      filesize: fileSize,
+      blocksizes: this.blockSizes.length > 0 ? this.blockSizes : undefined
+    })
+  }
+}
+
+// decode from protobuf https://github.com/ipfs/go-ipfs/blob/master/unixfs/format.go#L24
+exports.unmarshal = (marsheled) => {
+  const decoded = unixfsData.decode(marsheled)
+  if (!decoded.Data) {
+    decoded.Data = undefined
+  }
+  const obj = new Data(types[decoded.Type], decoded.Data)
+  obj.blockSizes = decoded.blocksizes
+  return obj
+}

src/unixfs-format.js

@@ -3,13 +3,13 @@
 const expect = require('chai').expect
 const fs = require('fs')
 
-const UnixfsFormat = require('../src').format
+const UnixFS = require('../src')
 
 describe('unixfs-format', () => {
   it('raw', (done) => {
-    const data = new UnixfsFormat('raw', new Buffer('bananas'))
+    const data = new UnixFS('raw', new Buffer('bananas'))
     const marsheled = data.marshal()
-    const unmarsheled = UnixfsFormat.unmarshal(marsheled)
+    const unmarsheled = UnixFS.unmarshal(marsheled)
     expect(data.type).to.equal(unmarsheled.type)
     expect(data.data).to.deep.equal(unmarsheled.data)
     expect(data.blockSizes).to.deep.equal(unmarsheled.blockSizes)
@@ -18,9 +18,9 @@ describe('unixfs-format', () => {
   })
 
   it('directory', (done) => {
-    const data = new UnixfsFormat('directory')
+    const data = new UnixFS('directory')
     const marsheled = data.marshal()
-    const unmarsheled = UnixfsFormat.unmarshal(marsheled)
+    const unmarsheled = UnixFS.unmarshal(marsheled)
     expect(data.type).to.equal(unmarsheled.type)
     expect(data.data).to.deep.equal(unmarsheled.data)
     expect(data.blockSizes).to.deep.equal(unmarsheled.blockSizes)
@@ -29,9 +29,9 @@ describe('unixfs-format', () => {
   })
 
   it('file', (done) => {
-    const data = new UnixfsFormat('file', new Buffer('batata'))
+    const data = new UnixFS('file', new Buffer('batata'))
     const marsheled = data.marshal()
-    const unmarsheled = UnixfsFormat.unmarshal(marsheled)
+    const unmarsheled = UnixFS.unmarshal(marsheled)
     expect(data.type).to.equal(unmarsheled.type)
     expect(data.data).to.deep.equal(unmarsheled.data)
     expect(data.blockSizes).to.deep.equal(unmarsheled.blockSizes)
@@ -40,10 +40,10 @@ describe('unixfs-format', () => {
   })
 
   it('file add blocksize', (done) => {
-    const data = new UnixfsFormat('file')
+    const data = new UnixFS('file')
     data.addBlockSize(256)
     const marsheled = data.marshal()
-    const unmarsheled = UnixfsFormat.unmarshal(marsheled)
+    const unmarsheled = UnixFS.unmarshal(marsheled)
     expect(data.type).to.equal(unmarsheled.type)
     expect(data.data).to.deep.equal(unmarsheled.data)
     expect(data.blockSizes).to.deep.equal(unmarsheled.blockSizes)
@@ -52,10 +52,10 @@ describe('unixfs-format', () => {
   })
 
   it('file add and remove blocksize', (done) => {
-    const data = new UnixfsFormat('file')
+    const data = new UnixFS('file')
     data.addBlockSize(256)
     const marsheled = data.marshal()
-    const unmarsheled = UnixfsFormat.unmarshal(marsheled)
+    const unmarsheled = UnixFS.unmarshal(marsheled)
     expect(data.type).to.equal(unmarsheled.type)
     expect(data.data).to.deep.equal(unmarsheled.data)
     expect(data.blockSizes).to.deep.equal(unmarsheled.blockSizes)
@@ -69,9 +69,9 @@ describe('unixfs-format', () => {
   it.skip('metadata', (done) => {})
 
   it('symlink', (done) => {
-    const data = new UnixfsFormat('symlink')
+    const data = new UnixFS('symlink')
     const marsheled = data.marshal()
-    const unmarsheled = UnixfsFormat.unmarshal(marsheled)
+    const unmarsheled = UnixFS.unmarshal(marsheled)
     expect(data.type).to.equal(unmarsheled.type)
     expect(data.data).to.deep.equal(unmarsheled.data)
     expect(data.blockSizes).to.deep.equal(unmarsheled.blockSizes)
@@ -81,7 +81,7 @@ describe('unixfs-format', () => {
   it('wrong type', (done) => {
     var data
     try {
-      data = new UnixfsFormat('bananas')
+      data = new UnixFS('bananas')
     } catch (err) {
       expect(err).to.exist
       expect(data).to.not.exist
@@ -92,7 +92,7 @@ describe('unixfs-format', () => {
   describe('interop', () => {
     it('raw', (done) => {
       var raw = fs.readFileSync(__dirname + '/test-data/raw.unixfs')
-      const unmarsheled = UnixfsFormat.unmarshal(raw)
+      const unmarsheled = UnixFS.unmarshal(raw)
       expect(unmarsheled.data).to.deep.equal(new Buffer('Hello UnixFS\n'))
       expect(unmarsheled.type).to.equal('file')
       expect(unmarsheled.marshal()).to.deep.equal(raw)
@@ -101,7 +101,7 @@ describe('unixfs-format', () => {
 
     it('directory', (done) => {
       var raw = fs.readFileSync(__dirname + '/test-data/directory.unixfs')
-      const unmarsheled = UnixfsFormat.unmarshal(raw)
+      const unmarsheled = UnixFS.unmarshal(raw)
       expect(unmarsheled.data).to.deep.equal(undefined)
       expect(unmarsheled.type).to.equal('directory')
       expect(unmarsheled.marshal()).to.deep.equal(raw)
@@ -110,7 +110,7 @@ describe('unixfs-format', () => {
 
     it('file', (done) => {
       var raw = fs.readFileSync(__dirname + '/test-data/file.txt.unixfs')
-      const unmarsheled = UnixfsFormat.unmarshal(raw)
+      const unmarsheled = UnixFS.unmarshal(raw)
       expect(unmarsheled.data).to.deep.equal(new Buffer('Hello UnixFS\n'))
       expect(unmarsheled.type).to.equal('file')
       expect(unmarsheled.marshal()).to.deep.equal(raw)
@@ -122,7 +122,7 @@ describe('unixfs-format', () => {
 
     it('symlink', (done) => {
       var raw = fs.readFileSync(__dirname + '/test-data/symlink.txt.unixfs')
-      const unmarsheled = UnixfsFormat.unmarshal(raw)
+      const unmarsheled = UnixFS.unmarshal(raw)
       expect(unmarsheled.data).to.deep.equal(new Buffer('file.txt'))
       expect(unmarsheled.type).to.equal('symlink')
       // TODO: waiting on https://github.com/ipfs/js-ipfs-data-importing/issues/3#issuecomment-182440079