fix: use os specific path separator

.flowconfig

@@ -2,6 +2,7 @@
 .*/radium/.*
 .*/standard-changelog/.*
 .*/conventional-changelog-core/.*
+.*/documentation/.*
 
 [include]
 

appveyor.yml

@@ -0,0 +1,27 @@
+version: "{build}"
+
+environment:
+  matrix:
+    - nodejs_version: "6"
+
+matrix:
+  fast_finish: true
+
+install:
+  # Install Node.js
+  - ps: Install-Product node $env:nodejs_version
+
+  # Upgrade npm
+  - npm install -g npm
+
+  # Output our current versions for debugging
+  - node --version
+  - npm --version
+
+  # Install our package dependencies
+  - npm install
+
+test_script:
+  - npm run test:node
+
+build: off

package.json

@@ -37,7 +37,7 @@
     "aegir": "^11.0.2",
     "chai": "^3.5.0",
     "dirty-chai": "^1.2.2",
-    "flow-bin": "^0.46.0"
+    "flow-bin": "^0.47.0"
   },
   "dependencies": {
     "async": "^2.4.1",
@@ -55,5 +55,6 @@
     "Erin Dachtler <download333@gmail.com>",
     "Friedel Ziegelmayer <dignifiedquire@gmail.com>",
     "Juan Batiz-Benet <juan@benet.ai>"
-  ]
-}
+  ],
+  "bundleDependencies": []
+}

src/key.js

@@ -4,6 +4,9 @@
 const path = require('path')
 const uuid = require('uuid/v4')
 
+const pathSepS = path.sep
+const pathSep = new Buffer(pathSepS, 'utf8')[0]
+
 /**
  * A Key represents the unique identifier of an object.
  * Our Key scheme is inspired by file systems and Google App Engine key model.
@@ -38,7 +41,7 @@ class Key {
       this.clean()
     }
 
-    if (this._buf.length === 0 || this._buf[0] !== 47) {
+    if (this._buf.length === 0 || this._buf[0] !== pathSep) {
       throw new Error(`Invalid key: ${this.toString()}`)
     }
   }
@@ -80,7 +83,7 @@ class Key {
    *
    */
   static withNamespaces (list /* : Array<string> */) /* : Key */ {
-    return new Key(list.join('/'))
+    return new Key(list.join(pathSepS))
   }
 
   /**
@@ -104,18 +107,18 @@ class Key {
    */
   clean () {
     if (!this._buf || this._buf.length === 0) {
-      this._buf = new Buffer('/')
-    }
-
-    if (this._buf[0] !== 47 /* / is 47 */) {
-      this._buf = Buffer.concat([new Buffer('/'), this._buf])
+      this._buf = new Buffer(pathSepS, 'utf8')
     }
 
     this._buf = new Buffer(path.normalize(this.toString()))
 
+    if (this._buf[0] !== pathSep) {
+      this._buf = Buffer.concat([new Buffer(pathSepS, 'utf8'), this._buf])
+    }
+
     // normalize does not remove trailing slashes
-    if (this.toString().length > 1) {
-      this._buf = new Buffer(this.toString().replace(/\/$/, ''))
+    if (this.toString().length > 1 && this._buf[this._buf.length - 1] === pathSep) {
+      this._buf = this._buf.slice(0, -1)
     }
   }
 
@@ -194,7 +197,7 @@ class Key {
    *
    */
   list () /* : Array<string> */ {
-    return this.toString().split('/').slice(1)
+    return this.toString().split(pathSepS).slice(1)
   }
 
   /**
@@ -249,7 +252,7 @@ class Key {
    *
    */
   path () /* : Key */ {
-    return new Key(this.parent().toString() + '/' + this.type())
+    return new Key(this.parent().toString() + pathSepS + this.type())
   }
 
   /**
@@ -265,10 +268,10 @@ class Key {
   parent () /* : Key */ {
     const list = this.list()
     if (list.length === 1) {
-      return new Key('/', false)
+      return new Key(pathSepS, false)
     }
 
-    return new Key(list.slice(0, -1).join('/'))
+    return new Key(list.slice(0, -1).join(pathSepS))
   }
 
   /**
@@ -283,9 +286,9 @@ class Key {
    *
    */
   child (key /* : Key */) /* : Key */ {
-    if (this.toString() === '/') {
+    if (this.toString() === pathSepS) {
       return key
-    } else if (key.toString() === '/') {
+    } else if (key.toString() === pathSepS) {
       return this
     }
 

src/tests.js

@@ -12,8 +12,10 @@ const parallel = require('async/parallel')
 const map = require('async/map')
 const each = require('async/each')
 const crypto = require('libp2p-crypto')
+const path = require('path')
 
 const Key = require('../src').Key
+const n = (p) => path.normalize(p)
 
 /* ::
 import type {Datastore, Callback} from '../src'
@@ -44,7 +46,7 @@ module.exports = (test/* : Test */) => {
     beforeEach((done) => {
       test.setup((err, s) => {
         if (err) {
-          return done(err)
+          throw err
         }
         store = s
         done()
@@ -89,7 +91,7 @@ module.exports = (test/* : Test */) => {
     beforeEach((done) => {
       test.setup((err, s) => {
         if (err) {
-          return done(err)
+          throw err
         }
         store = s
         done()
@@ -119,7 +121,7 @@ module.exports = (test/* : Test */) => {
     beforeEach((done) => {
       test.setup((err, s) => {
         if (err) {
-          return done(err)
+          throw err
         }
         store = s
         done()
@@ -189,7 +191,7 @@ module.exports = (test/* : Test */) => {
     beforeEach((done) => {
       test.setup((err, s) => {
         if (err) {
-          return done(err)
+          throw err
         }
         store = s
         done()
@@ -236,9 +238,9 @@ module.exports = (test/* : Test */) => {
       series([
         (cb) => b.commit(cb),
         (cb) => parallel([
-          (cb) => pull(check(store).query({prefix: '/a'}), pull.collect(cb)),
-          (cb) => pull(check(store).query({prefix: '/z'}), pull.collect(cb)),
-          (cb) => pull(check(store).query({prefix: '/q'}), pull.collect(cb))
+          (cb) => pull(check(store).query({prefix: n('/a')}), pull.collect(cb)),
+          (cb) => pull(check(store).query({prefix: n('/z')}), pull.collect(cb)),
+          (cb) => pull(check(store).query({prefix: n('/q')}), pull.collect(cb))
         ], (err, res) => {
           expect(err).to.not.exist()
           expect(res[0]).to.have.length(count)
@@ -288,7 +290,7 @@ module.exports = (test/* : Test */) => {
 
     const tests = [
       ['empty', {}, [hello, world, hello2]],
-      ['prefix', {prefix: '/z'}, [world, hello2]],
+      ['prefix', {prefix: n('/z')}, [world, hello2]],
       ['1 filter', {filters: [filter1]}, [world, hello2]],
       ['2 filters', {filters: [filter1, filter2]}, [hello2]],
       ['limit', {limit: 1}, 1],
@@ -301,7 +303,7 @@ module.exports = (test/* : Test */) => {
     before((done) => {
       test.setup((err, s) => {
         if (err) {
-          return done(err)
+          throw err
         }
         store = s
 
@@ -363,7 +365,7 @@ module.exports = (test/* : Test */) => {
     before((done) => {
       test.setup((err, s) => {
         if (err) {
-          return done(err)
+          throw err
         }
         store = s
         done()

test/key.spec.js

@@ -7,29 +7,36 @@ const path = require('path')
 
 const Key = require('../src').Key
 
-const clean = (s) => {
-  let fixed = path.normalize(s)
-  if (fixed.length > 1) {
-    return fixed.replace(/\/$/, '')
-  }
-  return fixed
-}
+const pathSep = path.sep
+const n = (p) => path.normalize(p)
 
 describe('Key', () => {
+  const clean = (s) => {
+    let fixed = n(s)
+    if (fixed.startsWith(pathSep + pathSep)) {
+      fixed = fixed.slice(1)
+    }
+    if (fixed.length > 1 && fixed.endsWith(pathSep)) {
+      fixed = fixed.slice(0, -1)
+    }
+
+    return fixed
+  }
+
   describe('basic', () => {
     const validKey = (s) => it(s, () => {
-      const fixed = clean('/' + s)
-      const namespaces = fixed.split('/').slice(1)
+      const fixed = clean(pathSep + s)
+      const namespaces = fixed.split(pathSep).slice(1)
       const lastNamespace = namespaces[namespaces.length - 1]
       const lnparts = lastNamespace.split(':')
       let ktype = ''
       if (lnparts.length > 1) {
         ktype = lnparts.slice(0, -1).join(':')
       }
       const kname = lnparts[lnparts.length - 1]
-      const kchild = clean(fixed + '/cchildd')
-      const kparent = '/' + namespaces.slice(0, -1).join('/')
-      const kpath = clean(kparent + '/' + ktype)
+      const kchild = clean(fixed + n('/cchildd'))
+      const kparent = pathSep + namespaces.slice(0, -1).join(pathSep)
+      const kpath = clean(kparent + pathSep + ktype)
       const kinstance = fixed + ':inst'
 
       const k = new Key(s)
@@ -55,34 +62,35 @@ describe('Key', () => {
     validKey('')
     validKey('abcde')
     validKey('disahfidsalfhduisaufidsail')
-    validKey('/fdisahfodisa/fdsa/fdsafdsafdsafdsa/fdsafdsa/')
+    validKey(n('/fdisahfodisa/fdsa/fdsafdsafdsafdsa/fdsafdsa/'))
     validKey('4215432143214321432143214321')
-    validKey('/fdisaha////fdsa////fdsafdsafdsafdsa/fdsafdsa/')
+    validKey(n('a\\b\\c//d\\'))
+    validKey(n('/fdisaha////fdsa////fdsafdsafdsafdsa/fdsafdsa/'))
     validKey('abcde:fdsfd')
     validKey('disahfidsalfhduisaufidsail:fdsa')
-    validKey('/fdisahfodisa/fdsa/fdsafdsafdsafdsa/fdsafdsa/:')
+    validKey(n('/fdisahfodisa/fdsa/fdsafdsafdsafdsa/fdsafdsa/:'))
     validKey('4215432143214321432143214321:')
-    validKey('fdisaha////fdsa////fdsafdsafdsafdsa/fdsafdsa/f:fdaf')
+    validKey(n('fdisaha////fdsa////fdsafdsafdsafdsa/fdsafdsa/f:fdaf'))
   })
 
   it('ancestry', () => {
-    const k1 = new Key('/A/B/C')
-    const k2 = new Key('/A/B/C/D')
+    const k1 = new Key(n('/A/B/C'))
+    const k2 = new Key(n('/A/B/C/D'))
 
-    expect(k1.toString()).to.be.eql('/A/B/C')
-    expect(k2.toString()).to.be.eql('/A/B/C/D')
+    expect(k1.toString()).to.be.eql(n('/A/B/C'))
+    expect(k2.toString()).to.be.eql(n('/A/B/C/D'))
 
     const checks = [
       k1.isAncestorOf(k2),
       k2.isDecendantOf(k1),
-      new Key('/A').isAncestorOf(k2),
-      new Key('/A').isAncestorOf(k1),
-      !new Key('/A').isDecendantOf(k2),
-      !new Key('/A').isDecendantOf(k1),
-      k2.isDecendantOf(new Key('/A')),
-      k1.isDecendantOf(new Key('/A')),
-      !k2.isAncestorOf(new Key('/A')),
-      !k1.isAncestorOf(new Key('/A')),
+      new Key(n('/A')).isAncestorOf(k2),
+      new Key(n('/A')).isAncestorOf(k1),
+      !new Key(n('/A')).isDecendantOf(k2),
+      !new Key(n('/A')).isDecendantOf(k1),
+      k2.isDecendantOf(new Key(n('/A'))),
+      k1.isDecendantOf(new Key(n('/A'))),
+      !k2.isAncestorOf(new Key(n('/A'))),
+      !k1.isAncestorOf(new Key(n('/A'))),
       !k2.isAncestorOf(k2),
       !k1.isAncestorOf(k1)
     ]
@@ -95,8 +103,8 @@ describe('Key', () => {
   })
 
   it('type', () => {
-    const k1 = new Key('/A/B/C:c')
-    const k2 = new Key('/A/B/C:c/D:d')
+    const k1 = new Key(n('/A/B/C:c'))
+    const k2 = new Key(n('/A/B/C:c/D:d'))
 
     expect(k1.isAncestorOf(k2)).to.eql(true)
     expect(k2.isDecendantOf(k1)).to.eql(true)
@@ -126,12 +134,12 @@ describe('Key', () => {
       expect(bk.less(ak)).to.eql(false)
     }
 
-    checkLess('/a/b/c', '/a/b/c/d')
-    checkLess('/a/b', '/a/b/c/d')
-    checkLess('/a', '/a/b/c/d')
-    checkLess('/a/a/c', '/a/b/c')
-    checkLess('/a/a/d', '/a/b/c')
-    checkLess('/a/b/c/d/e/f/g/h', '/b')
-    checkLess('/', '/a')
+    checkLess(n('/a/b/c'), n('/a/b/c/d'))
+    checkLess(n('/a/b'), n('/a/b/c/d'))
+    checkLess(n('/a'), n('/a/b/c/d'))
+    checkLess(n('/a/a/c'), n('/a/b/c'))
+    checkLess(n('/a/a/d'), n('/a/b/c'))
+    checkLess(n('/a/b/c/d/e/f/g/h'), n('/b'))
+    checkLess(pathSep, n('/a'))
   })
 })