Merge pull request #241 from pizzafroide/feat/promises-api

feat: promises api

README.md

@@ -118,6 +118,9 @@ This package depends on the following Node modules: `buffer`, `events`,
 It also uses `process` and `setImmediate` globals, but mocks them, if not
 available.
 
+It uses `Promise` when available and throws when `promises` property is
+accessed in an environment that do not support this ES2015 feature.
+
 [npm-url]: https://www.npmjs.com/package/memfs
 [npm-badge]: https://img.shields.io/npm/v/memfs.svg
 [travis-url]: https://travis-ci.org/streamich/memfs

docs/api-status.md

@@ -4,7 +4,7 @@ All of the [Node's `fs` API](https://nodejs.org/api/fs.html) is implemented.
 Some error messages may be inaccurate. File permissions are currently not
 implemented (you have access to any file), basically `fs.access()` is a no-op.
 
-  - [ ] Promises
+  - [x] Promises
   - [x] Constants
   - [x] `FSWatcher`
   - [x] `ReadStream`

src/__tests__/index.test.ts

@@ -35,4 +35,7 @@ describe('memfs', () => {
             expect(typeof memfs[method]).toBe('function');
         }
     });
+    it('Exports promises API', () => {
+        expect(typeof memfs.promises).toBe('object');
+    });
 });

src/__tests__/volume.test.ts

@@ -419,7 +419,7 @@ describe('volume', () => {
             });
         });
         describe('.read(fd, buffer, offset, length, position, callback)', () => {
-            xit('...');
+            xit('...', () => {});
         });
         describe('.readFileSync(path[, options])', () => {
             const vol = new Volume;
@@ -595,7 +595,7 @@ describe('volume', () => {
             });
         });
         describe('.symlink(target, path[, type], callback)', () => {
-            xit('...');
+            xit('...', () => {});
         });
         describe('.realpathSync(path[, options])', () => {
             const vol = new Volume;
@@ -662,7 +662,7 @@ describe('volume', () => {
             });
         });
         describe('.lstat(path, callback)', () => {
-            xit('...');
+            xit('...', () => {});
         });
         describe('.statSync(path)', () => {
             const vol = new Volume;
@@ -695,7 +695,7 @@ describe('volume', () => {
             });
         });
         describe('.stat(path, callback)', () => {
-            xit('...');
+            xit('...', () => {});
         });
         describe('.fstatSync(fd)', () => {
             const vol = new Volume;
@@ -713,7 +713,7 @@ describe('volume', () => {
             });
         });
         describe('.fstat(fd, callback)', () => {
-            xit('...');
+            xit('...', () => {});
         });
         describe('.linkSync(existingPath, newPath)', () => {
             const vol = new Volume;
@@ -733,7 +733,7 @@ describe('volume', () => {
             });
         });
         describe('.link(existingPath, newPath, callback)', () => {
-            xit('...');
+            xit('...', () => {});
         });
         describe('.readdirSync(path)', () => {
             it('Returns simple list', () => {
@@ -760,7 +760,7 @@ describe('volume', () => {
             });
         });
         describe('.readdir(path, callback)', () => {
-            xit('...');
+            xit('...', () => {});
         });
         describe('.readlinkSync(path[, options])', () => {
             it('Simple symbolic link to one file', () => {
@@ -808,7 +808,7 @@ describe('volume', () => {
             });
         });
         describe('.ftruncate(fd[, len], callback)', () => {
-            xit('...');
+            xit('...', () => {});
         });
         describe('.truncateSync(path[, len])', () => {
             const vol = new Volume;
@@ -828,7 +828,7 @@ describe('volume', () => {
             });
         });
         describe('.truncate(path[, len], callback)', () => {
-            xit('...');
+            xit('...', () => {});
         });
         describe('.utimesSync(path, atime, mtime)', () => {
             const vol = new Volume;
@@ -878,7 +878,7 @@ describe('volume', () => {
             });
         });
         describe('.mkdir(path[, mode], callback)', () => {
-            xit('...');
+            xit('...', () => {});
             xit('Create /dir1/dir2/dir3', () => { });
         });
         describe('.mkdtempSync(prefix[, options])', () => {
@@ -936,6 +936,12 @@ describe('volume', () => {
                 }, 1);
             });
         });
+        describe('.promises', () => {
+            it('Have a promises property', () => {
+                const vol = new Volume;
+                expect(typeof vol.promises).toBe('object');
+            });
+        });
     });
     describe('StatWatcher', () => {
         it('.vol points to current volume', () => {

src/index.ts

@@ -1,6 +1,7 @@
 import {Stats, Dirent} from './node';
 import {Volume as _Volume, StatWatcher, FSWatcher, toUnixTimestamp, IReadStream, IWriteStream} from './volume';
 import * as volume from './volume';
+import { IPromisesAPI } from './promises';
 const {fsSyncMethods, fsAsyncMethods} = require('fs-monkey/lib/util/lists');
 import {constants} from './constants';
 const {F_OK, R_OK, W_OK, X_OK} = constants;
@@ -21,6 +22,7 @@ export interface IFs extends _Volume {
     FSWatcher: new () => FSWatcher,
     ReadStream: new (...args) => IReadStream,
     WriteStream: new (...args) => IWriteStream,
+    promises: IPromisesAPI,
     _toUnixTimestamp,
 }
 
@@ -39,6 +41,7 @@ export function createFsFromVolume(vol: _Volume): IFs {
     fs.FSWatcher = vol.FSWatcher;
     fs.WriteStream = vol.WriteStream;
     fs.ReadStream = vol.ReadStream;
+    fs.promises = vol.promises;
 
     fs._toUnixTimestamp = toUnixTimestamp;
 

src/node.ts

@@ -154,7 +154,7 @@ export class Node extends EventEmitter {
 
     chmod(perm: number) {
         this.perm = perm;
-        this.mode |= perm;
+        this.mode = (this.mode & ~0o777) | perm;
         this.touch();
     }