2.7 File object

CHANGELOG.md

@@ -1,5 +1,10 @@
 # gulp changelog
 
+## 2.7
+
+- Breaking change to the way options are passed to glob-stream
+- Introduce new File object to ease pain of computing shortened names
+
 ## 2.4 - 2.6
 
 - Moved stuff to gulp-util

README.md

@@ -22,8 +22,10 @@ This project is in its early stages. If something is not working or you would li
 ## Links
 
 [Slideshow](http://slid.es/contra/gulp)
-[Twitter for updates](http://twitter.com/eschoffs)
-[Our company twitter](http://twitter.com/wearefractal)
+
+[Twitter for updates](http://twitter.com/eschoff)
+
+[Company twitter](http://twitter.com/wearefractal)
 
 ## Plugin List
 
@@ -94,7 +96,7 @@ gulp.task('default', function(){
 
 ### gulp.src(glob[, opt])
 
-Takes a glob and represents a file structure. Can be piped to plugins.
+Takes a glob and represents a file structure. Can be piped to plugins. You can specify a single glob or an array of globs (see docs)56. All options are passed directly through to [glob-stream](https://github.com/wearefractal/glob-stream). See the [glob-stream documentation](https://github.com/wearefractal/glob-stream) for more information.
 
 ```javascript
 gulp.src("./client/templates/*.jade")

index.js

@@ -50,7 +50,7 @@ Gulp.prototype.src = require('./lib/createInputStream');
 Gulp.prototype.dest = require('./lib/createOutputStream');
 Gulp.prototype.watch = require('./lib/watchFile');
 
-Gulp.prototype.formatFile = require('./lib/formatFile');
+Gulp.prototype.File = require("./lib/File");
 Gulp.prototype.bufferFile = require('./lib/bufferFile');
 Gulp.prototype.streamFile = require('./lib/streamFile');
 

lib/File.js

@@ -0,0 +1,16 @@
+var realBase = require('gulp-util').realBase;
+
+function File(base, path) {
+  this.base = base;
+  this.path = path;
+
+  // other fields are
+  // stats = fs stats object
+  // contents = stream, buffer, or null if not read
+
+  this.__defineGetter__("shortened", function(){
+    return realBase(this.base, this.path);
+  });
+}
+
+module.exports = File;

lib/createInputStream.js

@@ -1,16 +1,20 @@
 var es = require('event-stream');
 var gs = require('glob-stream');
-var formatFile = require('./formatFile');
 
+var File = require('./File');
 var getContents = require('./getContents');
 
 module.exports = function(glob, opt) {
   if (!opt) opt = {};
   if (typeof opt.read !== 'boolean') opt.read = true;
   if (typeof opt.buffer !== 'boolean') opt.buffer = true;
 
-  var globStream = gs.create(glob, opt.glob);
-  var stream = globStream.pipe(es.map(formatFile));
+  var globStream = gs.create(glob, opt);
+  var formatStream = es.map(function(file, cb){
+    cb(null, new File(file.base, file.path));
+  });
+
+  var stream = globStream.pipe(formatStream);
 
   return stream.pipe(getContents(opt));
 };

lib/isStream.js

@@ -1,4 +1,4 @@
 module.exports = function(o) {
   // really shitty for now
-  return !!o.pipe;
+  return !!o && !!o.pipe;
 };

package.json

@@ -1,7 +1,7 @@
 {
   "name": "gulp",
   "description": "The streaming build system",
-  "version": "2.6.1",
+  "version": "2.7.0",
   "homepage": "http://github.com/wearefractal/gulp",
   "repository": "git://github.com/wearefractal/gulp.git",
   "author": "Fractal <[email protected]> (http://wearefractal.com/)",

test/file-utils.js

@@ -57,22 +57,20 @@ describe('gulp streamFile', function() {
   });
 });
 
-describe('gulp formatFile', function() {
-  describe('formatFile()', function() {
+describe('gulp File class', function() {
+  describe('File()', function() {
     it('should return a valid file', function(done) {
       var fname = join(__dirname, "./fixtures/test.coffee");
       var base = dirname(fname);
-      gulp.formatFile({path:fname,base:base}, function(err, file) {
-        should.not.exist(err);
-        should.exist(file);
-        should.exist(file.shortened);
-        should.exist(file.path);
-        should.exist(file.base);
-        file.path.should.equal(fname);
-        file.base.should.equal(base);
-        file.shortened.should.equal("test.coffee");
-        done();
-      });
+      var file = new gulp.File(base, fname);
+      should.exist(file);
+      should.exist(file.shortened);
+      should.exist(file.path);
+      should.exist(file.base);
+      file.path.should.equal(fname);
+      file.base.should.equal(base);
+      file.shortened.should.equal("test.coffee");
+      done();
     });
   });
 });