Merge pull request #2 from tschaub/dir-mtime

Update directory mtime when an item is added, removed, or renamed.

Author: tschaub

lib/directory.js

@@ -42,6 +42,7 @@ Directory.prototype.addItem = function(name, item) {
     // for subdirectory
     ++this.links;
   }
+  this.setMTime(new Date());
   return item;
 };
 
@@ -78,6 +79,7 @@ Directory.prototype.removeItem = function(name) {
     // for subdirectory
     --this.links;
   }
+  this.setMTime(new Date());
   return item;
 };
 

readme.md

@@ -57,9 +57,9 @@ Create a factory for new files.  Supported properties:
  * **mode** - `number` File mode (permission and sticky bits).  Defaults to `0666`.
  * **uid** - `number` The user id.  Defaults to `process.getuid()`.
  * **git** - `number` The group id.  Defaults to `process.getgid()`.
- * **atime** - `Date` The last file access time.  Defaults to `Date.now()`.  Updated when file contents are accessed.
- * **ctime** - `Date` The last file change time.  Defaults to `Date.now()`.  Updated when file owner or permissions change.
- * **mtime** - `Date` The last file modification time.  Defaults to `Date.now()`.  Updated when file contents change.
+ * **atime** - `Date` The last file access time.  Defaults to `new Date()`.  Updated when file contents are accessed.
+ * **ctime** - `Date` The last file change time.  Defaults to `new Date()`.  Updated when file owner or permissions change.
+ * **mtime** - `Date` The last file modification time.  Defaults to `new Date()`.  Updated when file contents change.
 
 To create a mock filesystem with a very old file named `foo`, you could do something like this:
 ```js
@@ -101,9 +101,9 @@ Create a factory for new directories.  Supported properties:
  * **mode** - `number` Directory mode (permission and sticky bits).  Defaults to `0777`.
  * **uid** - `number` The user id.  Defaults to `process.getuid()`.
  * **git** - `number` The group id.  Defaults to `process.getgid()`.
- * **atime** - `Date` The last directory access time.  Defaults to `Date.now()`.
- * **ctime** - `Date` The last directory change time.  Defaults to `Date.now()`.  Updated when owner or permissions change.
- * **mtime** - `Date` The last directory modification time.  Defaults to `Date.now()`.
+ * **atime** - `Date` The last directory access time.  Defaults to `new Date()`.
+ * **ctime** - `Date` The last directory change time.  Defaults to `new Date()`.  Updated when owner or permissions change.
+ * **mtime** - `Date` The last directory modification time.  Defaults to `new Date()`.  Updated when an item is added, removed, or renamed.
  * **items** - `Object` Directory contents.  Members will generate additional files, directories, or symlinks.
 
 To create a mock filesystem with a directory with the relative path `some/dir` that has a mode of `0755` and a couple child files, you could do something like this:
@@ -133,9 +133,9 @@ Create a factory for new symlinks.  Supported properties:
  * **mode** - `number` Symlink mode (permission and sticky bits).  Defaults to `0666`.
  * **uid** - `number` The user id.  Defaults to `process.getuid()`.
  * **git** - `number` The group id.  Defaults to `process.getgid()`.
- * **atime** - `Date` The last symlink access time.  Defaults to `Date.now()`.
- * **ctime** - `Date` The last symlink change time.  Defaults to `Date.now()`.
- * **mtime** - `Date` The last symlink modification time.  Defaults to `Date.now()`.
+ * **atime** - `Date` The last symlink access time.  Defaults to `new Date()`.
+ * **ctime** - `Date` The last symlink change time.  Defaults to `new Date()`.
+ * **mtime** - `Date` The last symlink modification time.  Defaults to `new Date()`.
 
 To create a mock filesystem with a file and a symlink, you could do something like this:
 ```js

test/lib/index.spec.js

@@ -157,9 +157,10 @@ describe('Mocking the file system', function() {
         'path/to/a.bin': new Buffer([1, 2, 3]),
         'empty': {},
         'nested': {
-          'dir': {
-            'file.txt': ''
-          }
+          'dir': mock.directory({
+            mtime: new Date(1),
+            items: {'file.txt': ''}
+          })
         }
       });
     });
@@ -174,6 +175,18 @@ describe('Mocking the file system', function() {
       });
     });
 
+    it('updates mtime of parent directory', function(done) {
+      var oldTime = fs.statSync('nested/dir').mtime;
+      fs.rename('nested/dir/file.txt', 'nested/dir/renamed.txt', function(err) {
+        assert.isTrue(!err);
+        assert.isFalse(fs.existsSync('nested/dir/file.txt'));
+        assert.isTrue(fs.existsSync('nested/dir/renamed.txt'));
+        var newTime = fs.statSync('nested/dir').mtime;
+        assert.isTrue(newTime > oldTime);
+        done();
+      });
+    });
+
     it('calls callback with error if old path does not exist', function(done) {
       fs.rename('bogus', 'empty', function(err) {
         assert.instanceOf(err, Error);
@@ -1356,27 +1369,41 @@ describe('Mocking the file system', function() {
 
     beforeEach(function() {
       mock({
-        '.': {}
+        dir: mock.directory({
+          mtime: new Date(1)
+        })
       });
     });
     afterEach(mock.restore);
 
     it('writes a string to a file', function(done) {
-      fs.writeFile('foo', 'bar', function(err) {
+      fs.writeFile('dir/foo', 'bar', function(err) {
         if (err) {
           return done(err);
         }
-        assert.equal(String(fs.readFileSync('foo')), 'bar');
+        assert.equal(String(fs.readFileSync('dir/foo')), 'bar');
+        done();
+      });
+    });
+
+    it('updates mtime of parent directory', function(done) {
+      var oldTime = fs.statSync('dir').mtime;
+      fs.writeFile('dir/foo', 'bar', function(err) {
+        if (err) {
+          return done(err);
+        }
+        var newTime = fs.statSync('dir').mtime;
+        assert.isTrue(newTime > oldTime);
         done();
       });
     });
 
     it('writes a buffer to a file', function(done) {
-      fs.writeFile('foo', new Buffer('bar'), function(err) {
+      fs.writeFile('dir/foo', new Buffer('bar'), function(err) {
         if (err) {
           return done(err);
         }
-        assert.equal(String(fs.readFileSync('foo')), 'bar');
+        assert.equal(String(fs.readFileSync('dir/foo')), 'bar');
         done();
       });
     });
@@ -1840,6 +1867,10 @@ describe('Mocking the file system', function() {
     beforeEach(function() {
       mock({
         'dir': {},
+        'dir2': mock.directory({
+          mtime: new Date(1),
+          items: {file: 'content here'}
+        }),
         'file.txt': 'content'
       });
     });
@@ -1855,6 +1886,19 @@ describe('Mocking the file system', function() {
       });
     });
 
+    it('updates mtime of parent', function(done) {
+      var oldTime = fs.statSync('dir2').mtime;
+      fs.unlink('dir2/file', function(err) {
+        if (err) {
+          return done(err);
+        }
+        assert.isFalse(fs.existsSync('dir2/file'));
+        var newTime = fs.statSync('dir2').mtime;
+        assert.isTrue(newTime > oldTime);
+        done();
+      });
+    });
+
     it('fails for a directory', function(done) {
       fs.unlink('dir', function(err) {
         assert.instanceOf(err, Error);