.ls, .lsReadableStream and .lsPullStream

Author: daviddias

package.json

@@ -10,16 +10,16 @@
     "http": "stream-http"
   },
   "scripts": {
-    "test": "aegir test --no-parallel",
-    "test:node": "aegir test --target node --no-parallel",
+    "test": "aegir test ",
+    "test:node": "aegir test --target node ",
     "test:browser": "aegir test --target browser",
     "lint": "aegir lint",
     "build": "aegir build",
-    "release": "aegir release --no-parallel",
-    "release-minor": "aegir release --type minor --no-parallel",
-    "release-major": "aegir release --type major --no-parallel",
-    "coverage": "aegir coverage --no-parallel --timeout 100000",
-    "coverage-publish": "aegir coverage --provider coveralls --no-parallel --timeout 100000"
+    "release": "aegir release ",
+    "release-minor": "aegir release --type minor ",
+    "release-major": "aegir release --type major ",
+    "coverage": "aegir coverage  --timeout 100000",
+    "coverage-publish": "aegir coverage --provider coveralls  --timeout 100000"
   },
   "dependencies": {
     "async": "^2.6.0",

src/files/index.js

@@ -15,11 +15,13 @@ module.exports = (arg) => {
     get: require('./get')(send),
     getReadableStream: require('./get-readable-stream')(send),
     getPullStream: require('./get-pull-stream')(send),
+
+    // Specific to MFS (for now)
     cp: require('./cp')(send),
-    ls: require('./ls')(send),
     mkdir: require('./mkdir')(send),
     stat: require('./stat')(send),
     rm: require('./rm')(send),
+    ls: require('./ls')(send),
     read: require('./read')(send),
     write: require('./write')(send),
     mv: require('./mv')(send)

src/ls-pull-stream.js

@@ -0,0 +1,64 @@
+'use strict'
+
+const moduleConfig = require('./utils/module-config')
+const pull = require('pull-stream')
+const deferred = require('pull-defer')
+
+module.exports = (arg) => {
+  const send = moduleConfig(arg)
+
+  return (args, opts, callback) => {
+    if (typeof (opts) === 'function') {
+      callback = opts
+      opts = {}
+    }
+
+    const p = deferred.source()
+
+    send({ path: 'ls', args: args, qs: opts }, (err, results) => {
+      if (err) {
+        return callback(err)
+      }
+
+      let result = results.Objects
+      if (!result) {
+        return callback(new Error('expected .Objects in results'))
+      }
+
+      result = result[0]
+      if (!result) {
+        return callback(new Error('expected one array in results.Objects'))
+      }
+
+      result = result.Links
+      if (!Array.isArray(result)) {
+        return callback(new Error('expected one array in results.Objects[0].Links'))
+      }
+
+      result = result.map((link) => ({
+        depth: 1,
+        name: link.Name,
+        path: args + '/' + link.Name,
+        size: link.Size,
+        hash: link.Hash,
+        type: typeOf(link)
+      }))
+
+      p.resolve(pull.values(result))
+    })
+
+    return p
+  }
+}
+
+function typeOf (link) {
+  switch (link.Type) {
+    case 1:
+    case 5:
+      return 'dir'
+    case 2:
+      return 'file'
+    default:
+      return 'unknown'
+  }
+}

src/ls-readable-stream.js

@@ -0,0 +1,62 @@
+'use strict'
+
+const moduleConfig = require('./utils/module-config')
+const Stream = require('readable-stream')
+
+module.exports = (arg) => {
+  const send = moduleConfig(arg)
+
+  return (args, opts, callback) => {
+    if (typeof (opts) === 'function') {
+      callback = opts
+      opts = {}
+    }
+
+    const pt = new Stream.PassThrough({objectMode: true})
+
+    send({ path: 'ls', args: args, qs: opts }, (err, results) => {
+      if (err) { return callback(err) }
+
+      let result = results.Objects
+      if (!result) {
+        return callback(new Error('expected .Objects in results'))
+      }
+
+      result = result[0]
+      if (!result) {
+        return callback(new Error('expected one array in results.Objects'))
+      }
+
+      result = result.Links
+      if (!Array.isArray(result)) {
+        return callback(new Error('expected one array in results.Objects[0].Links'))
+      }
+
+      result = result.map((link) => ({
+        depth: 1,
+        name: link.Name,
+        path: args + '/' + link.Name,
+        size: link.Size,
+        hash: link.Hash,
+        type: typeOf(link)
+      }))
+
+      result.forEach((item) => pt.write(item))
+      pt.end()
+    })
+
+    return pt
+  }
+}
+
+function typeOf (link) {
+  switch (link.Type) {
+    case 1:
+    case 5:
+      return 'dir'
+    case 2:
+      return 'file'
+    default:
+      return 'unknown'
+  }
+}

src/utils/load-commands.js

@@ -2,7 +2,7 @@
 
 function requireCommands () {
   const cmds = {
-    // add and createAddStream alias
+    // Files (not MFS)
     add: require('../files/add'),
     addReadableStream: require('../files/add-readable-stream'),
     addPullStream: require('../files/add-pull-stream'),
@@ -12,6 +12,10 @@ function requireCommands () {
     get: require('../files/get'),
     getReadableStream: require('../files/get-readable-stream'),
     getPullStream: require('../files/get-pull-stream'),
+    ls: require('../ls'),
+    lsReadableStream: require('../ls-readable-stream'),
+    lsPullStream: require('../ls-pull-stream'),
+
     bitswap: require('../bitswap'),
     block: require('../block'),
     bootstrap: require('../bootstrap'),
@@ -22,7 +26,6 @@ function requireCommands () {
     id: require('../id'),
     key: require('../key'),
     log: require('../log'),
-    ls: require('../ls'),
     mount: require('../mount'),
     name: require('../name'),
     object: require('../object'),