New: Add dirname, basename and extname accessors

Author: jeremyruppel

README.md

@@ -4,7 +4,7 @@
 ## Information
 
 <table>
-<tr> 
+<tr>
 <td>Package</td><td>vinyl</td>
 </tr>
 <tr>
@@ -38,42 +38,42 @@ var coffeeFile = new File({
 
 #### options.cwd
 
-Type: `String`  
+Type: `String`
 Default: `process.cwd()`
 
 #### options.base
 
 Used for relative pathing. Typically where a glob starts.
 
-Type: `String`  
+Type: `String`
 Default: `options.cwd`
 
 #### options.path
 
 Full path to the file.
 
-Type: `String`  
+Type: `String`
 Default: `undefined`
 
 #### options.history
 
 Path history. Has no effect if `options.path` is passed.
 
-Type: `Array`  
+Type: `Array`
 Default: `options.path ? [options.path] : []`
 
 #### options.stat
 
 The result of an fs.stat call. See [fs.Stats](http://nodejs.org/api/fs.html#fs_class_fs_stats) for more information.
 
-Type: `fs.Stats`  
+Type: `fs.Stats`
 Default: `null`
 
 #### options.contents
 
 File contents.
 
-Type: `Buffer, Stream, or null`  
+Type: `Buffer, Stream, or null`
 Default: `null`
 
 ### isBuffer()
@@ -117,6 +117,10 @@ Returns a pretty String interpretation of the File. Useful for console.log.
 
 Absolute pathname string or `undefined`. Setting to a different value pushes the old value to `history`.
 
+### history
+
+Array of `path` values the file object has had, from `history[0]` (original) through `history[history.length - 1]` (current). `history` and its elements should normally be treated as read-only and only altered indirectly by setting `path`.
+
 ### relative
 
 Returns path.relative for the file base and file path.
@@ -133,9 +137,68 @@ var file = new File({
 console.log(file.relative); // file.coffee
 ```
 
-### history
+### dirname
 
-Array of `path` values the file object has had, from `history[0]` (original) through `history[history.length - 1]` (current). `history` and its elements should normally be treated as read-only and only altered indirectly by setting `path`.
+Gets and sets path.dirname for the file path.
+
+Example:
+
+```javascript
+var file = new File({
+  cwd: "/",
+  base: "/test/",
+  path: "/test/file.coffee"
+});
+
+console.log(file.dirname); // /test
+
+file.dirname = '/specs';
+
+console.log(file.dirname); // /specs
+console.log(file.path); // /specs/file.coffee
+````
+
+### basename
+
+Gets and sets path.basename for the file path.
+
+Example:
+
+```javascript
+var file = new File({
+  cwd: "/",
+  base: "/test/",
+  path: "/test/file.coffee"
+});
+
+console.log(file.basename); // file.coffee
+
+file.basename = 'file.js';
+
+console.log(file.basename); // file.js
+console.log(file.path); // /test/file.js
+````
+
+### extname
+
+Gets and sets path.extname for the file path.
+
+Example:
+
+```javascript
+var file = new File({
+  cwd: "/",
+  base: "/test/",
+  path: "/test/file.coffee"
+});
+
+console.log(file.extname); // .coffee
+
+file.extname = '.js';
+
+console.log(file.extname); // .js
+console.log(file.path); // /test/file.js
+````
 
 [npm-url]: https://npmjs.org/package/vinyl
 [npm-image]: https://badge.fury.io/js/vinyl.png

index.js

@@ -7,6 +7,7 @@ var isStream = require('./lib/isStream');
 var isNull = require('./lib/isNull');
 var inspectStream = require('./lib/inspectStream');
 var Stream = require('stream');
+var replaceExt = require('replace-ext');
 
 function File(file) {
   if (!file) file = {};
@@ -158,6 +159,39 @@ Object.defineProperty(File.prototype, 'relative', {
   }
 });
 
+Object.defineProperty(File.prototype, 'dirname', {
+  get: function() {
+    if (!this.path) throw new Error('No path specified! Can not get dirname.');
+    return path.dirname(this.path);
+  },
+  set: function(dirname) {
+    if (!this.path) throw new Error('No path specified! Can not set dirname.');
+    this.path = path.join(dirname, path.basename(this.path));
+  }
+});
+
+Object.defineProperty(File.prototype, 'basename', {
+  get: function() {
+    if (!this.path) throw new Error('No path specified! Can not get basename.');
+    return path.basename(this.path);
+  },
+  set: function(basename) {
+    if (!this.path) throw new Error('No path specified! Can not set basename.');
+    this.path = path.join(path.dirname(this.path), basename);
+  }
+});
+
+Object.defineProperty(File.prototype, 'extname', {
+  get: function() {
+    if (!this.path) throw new Error('No path specified! Can not get extname.');
+    return path.extname(this.path);
+  },
+  set: function(extname) {
+    if (!this.path) throw new Error('No path specified! Can not set extname.');
+    this.path = replaceExt(this.path, extname);
+  }
+});
+
 Object.defineProperty(File.prototype, 'path', {
   get: function() {
     return this.history[this.history.length - 1];

package.json

@@ -12,7 +12,8 @@
   ],
   "dependencies": {
     "clone": "^1.0.0",
-    "clone-stats": "^0.0.1"
+    "clone-stats": "^0.0.1",
+    "replace-ext": "0.0.1"
   },
   "devDependencies": {
     "buffer-equal": "0.0.1",

test/File.js

@@ -692,6 +692,138 @@ describe('File', function() {
     });
   });
 
+  describe('dirname get/set', function() {
+    it('should error on get when no path', function(done) {
+      var a;
+      var file = new File();
+      try {
+        a = file.dirname;
+      } catch (err) {
+        should.exist(err);
+        done();
+      }
+    });
+
+    it('should return the dirname of the path', function(done) {
+      var file = new File({
+        cwd: '/',
+        base: '/test/',
+        path: '/test/test.coffee'
+      });
+      file.dirname.should.equal('/test');
+      done();
+    });
+
+    it('should error on set when no path', function(done) {
+      var file = new File();
+      try {
+        file.dirname = '/test';
+      } catch (err) {
+        should.exist(err);
+        done();
+      }
+    });
+
+    it('should set the dirname of the path', function(done) {
+      var file = new File({
+        cwd: '/',
+        base: '/test/',
+        path: '/test/test.coffee'
+      });
+      file.dirname = '/test/foo';
+      file.path.should.equal('/test/foo/test.coffee');
+      done();
+    });
+  });
+
+  describe('basename get/set', function() {
+    it('should error on get when no path', function(done) {
+      var a;
+      var file = new File();
+      try {
+        a = file.basename;
+      } catch (err) {
+        should.exist(err);
+        done();
+      }
+    });
+
+    it('should return the basename of the path', function(done) {
+      var file = new File({
+        cwd: '/',
+        base: '/test/',
+        path: '/test/test.coffee'
+      });
+      file.basename.should.equal('test.coffee');
+      done();
+    });
+
+    it('should error on set when no path', function(done) {
+      var file = new File();
+      try {
+        file.basename = 'test.coffee';
+      } catch (err) {
+        should.exist(err);
+        done();
+      }
+    });
+
+    it('should set the basename of the path', function(done) {
+      var file = new File({
+        cwd: '/',
+        base: '/test/',
+        path: '/test/test.coffee'
+      });
+      file.basename = 'foo.png';
+      file.path.should.equal('/test/foo.png');
+      done();
+    });
+  });
+
+  describe('extname get/set', function() {
+    it('should error on get when no path', function(done) {
+      var a;
+      var file = new File();
+      try {
+        a = file.extname;
+      } catch (err) {
+        should.exist(err);
+        done();
+      }
+    });
+
+    it('should return the extname of the path', function(done) {
+      var file = new File({
+        cwd: '/',
+        base: '/test/',
+        path: '/test/test.coffee'
+      });
+      file.extname.should.equal('.coffee');
+      done();
+    });
+
+    it('should error on set when no path', function(done) {
+      var file = new File();
+      try {
+        file.extname = '.coffee';
+      } catch (err) {
+        should.exist(err);
+        done();
+      }
+    });
+
+    it('should set the extname of the path', function(done) {
+      var file = new File({
+        cwd: '/',
+        base: '/test/',
+        path: '/test/test.coffee'
+      });
+      file.extname = '.png';
+      file.path.should.equal('/test/test.png');
+      done();
+    });
+  });
+
   describe('path get/set', function() {
 
     it('should record history when instantiation', function() {