jsonfile: support arbitrary fs like mock-fs

Author: jprichardson

index.js

@@ -1,4 +1,4 @@
-var fs = require('fs')
+var _fs = require('fs')
 
 function readFile (file, options, callback) {
   if (callback == null) {
@@ -11,6 +11,7 @@ function readFile (file, options, callback) {
   }
 
   options = options || {}
+  var fs = options.fs || _fs
 
   var shouldThrow = true
   // DO NOT USE 'passParsingErrors' THE NAME WILL CHANGE!!!, use 'throws' instead
@@ -45,6 +46,8 @@ function readFileSync (file, options) {
     options = {encoding: options}
   }
 
+  var fs = options.fs || _fs
+
   var shouldThrow = true
   // DO NOT USE 'passParsingErrors' THE NAME WILL CHANGE!!!, use 'throws' instead
   if ('passParsingErrors' in options) {
@@ -72,6 +75,8 @@ function writeFile (file, obj, options, callback) {
     callback = options
     options = {}
   }
+  options = options || {}
+  var fs = options.fs || _fs
 
   var spaces = typeof options === 'object' && options !== null
     ? 'spaces' in options
@@ -90,6 +95,7 @@ function writeFile (file, obj, options, callback) {
 
 function writeFileSync (file, obj, options) {
   options = options || {}
+  var fs = options.fs || _fs
 
   var spaces = typeof options === 'object' && options !== null
     ? 'spaces' in options

package.json

@@ -19,6 +19,7 @@
   "dependencies": {},
   "devDependencies": {
     "mocha": "2.x",
+    "mock-fs": "^3.8.0",
     "rimraf": "^2.4.0",
     "standard": "^6.0.8"
   },

test/read-file-sync.test.js

@@ -1,5 +1,6 @@
 var assert = require('assert')
 var fs = require('fs')
+var mockfs = require('mock-fs')
 var os = require('os')
 var path = require('path')
 var rimraf = require('rimraf')
@@ -151,4 +152,14 @@ describe('+ readFileSync()', function () {
       assert.strictEqual(data.name, 'jp')
     })
   })
+
+  describe('mockfs', function () {
+    it('should read from a mockfs', function () {
+      var mfs = mockfs.fs()
+      var dataOut = {name: 'JP'}
+      mfs.writeFileSync('test.json', JSON.stringify(dataOut), 'utf8')
+      var dataIn = jf.readFileSync('test.json', { fs: mfs })
+      assert.deepEqual(dataOut, dataIn)
+    })
+  })
 })

test/read-file.test.js

@@ -1,5 +1,6 @@
 var assert = require('assert')
 var fs = require('fs')
+var mockfs = require('mock-fs')
 var os = require('os')
 var path = require('path')
 var rimraf = require('rimraf')
@@ -217,4 +218,17 @@ describe('+ readFile()', function () {
       })
     })
   })
+
+  describe('mockfs', function () {
+    it('should read from a mockfs', function (done) {
+      var mfs = mockfs.fs()
+      var dataOut = {name: 'JP'}
+      mfs.writeFileSync('test.json', JSON.stringify(dataOut), 'utf8')
+      jf.readFile('test.json', { fs: mfs }, function (err, dataIn) {
+        assert.ifError(err)
+        assert.deepEqual(dataOut, dataIn)
+        done()
+      })
+    })
+  })
 })

test/write-file-sync.test.js

@@ -1,5 +1,6 @@
 var assert = require('assert')
 var fs = require('fs')
+var mockfs = require('mock-fs')
 var os = require('os')
 var path = require('path')
 var rimraf = require('rimraf')
@@ -89,4 +90,15 @@ describe('+ writeFileSync()', function () {
       assert.strictEqual(data, JSON.stringify(obj) + '\n')
     })
   })
+
+  describe('mockfs', function () {
+    it('should write to mockfs', function () {
+      var mfs = mockfs.fs()
+      var dataOut = { name: 'JP' }
+      var file = 'somefile.json'
+      jf.writeFileSync(file, dataOut, { fs: mfs })
+      var dataIn = JSON.parse(mfs.readFileSync(file, 'utf8'))
+      assert.deepEqual(dataOut, dataIn)
+    })
+  })
 })

test/write-file.test.js

@@ -1,5 +1,6 @@
 var assert = require('assert')
 var fs = require('fs')
+var mockfs = require('mock-fs')
 var os = require('os')
 var path = require('path')
 var rimraf = require('rimraf')
@@ -118,4 +119,18 @@ describe('+ writeFile()', function () {
       })
     })
   })
+
+  describe('mockfs', function () {
+    it('should write to mockfs', function (done) {
+      var mfs = mockfs.fs()
+      var dataOut = { name: 'JP' }
+      var file = 'somefile.json'
+      jf.writeFile(file, dataOut, { fs: mfs }, function (err) {
+        assert.ifError(err)
+        var dataIn = JSON.parse(mfs.readFileSync(file, 'utf8'))
+        assert.deepEqual(dataOut, dataIn)
+        done()
+      })
+    })
+  })
 })