Transform absolute file paths to file URI scheme

[jgoz]

This is a fix for the issues reported in #3, #7 and maybe #4.

1. Phantomjs appears to have issues processing relative paths for referenced files (e.g., script/style refs) when its webpage is created via an absolute path. (I was unable to find a relevant issue on the phantomjs GH page.)
2. gulp.src produces absolute paths in some cases/environments, which will trigger (1) when using this plugin. I'm not really clear on when this occurs, but it happens on my Win8.1/x64 machine.

This fix will determine if a file path is absolute and, if so, will transform it to the file URI scheme (e.g., file:///c:/path/to/test.html), which phantomjs can handle. Relative file paths remain untouched.

I also included a test case demonstrating the behaviour.

---

For anyone else affected by this issue, there is a workaround that you can add to your gulpfile. Fixing it here in the repository would obviously be preferable, but the following works in my environment:

var gulp = require("gulp");
var qunit = require("gulp-qunit");
var path = require("path"),
var util = require('util');
var Transform = require('stream').Transform;

util.inherits(FilePathToUrl, Transform);

function FilePathToUrl(options){
    Transform.call(this, options);
}

FilePathToUrl.prototype._transform = function(file, encoding, done) {
    file.path = 'file:///' + path.resolve(file.path).replace(/\\/g, '/');
    this.push(file);
    return done();
};

function toUrl() {
    return new FilePathToUrl({ objectMode: true });
}

gulp.task("test", function() {
    return gulp.src("./qunit/test-runner.html")
        .pipe(toUrl())
        .pipe(qunit());
});

[jonkemp]

I went ahead and merged this. I never had this issue on Mac or on Windows but it seemed some people did. I'm wondering if there is any case where the paths from gulp are not absolute though, in which case you wouldn't need to just pass file.path.

[jonkemp]

Closes #7

[jgoz]

I went ahead and merged this. I never had this issue on Mac or on Windows but it seemed some people did.

Thank you.

I'm wondering if there is any case where the paths from gulp are not absolute though, in which case you wouldn't need to just pass file.path.

I'm not sure I follow you here, but there are definitely cases where gulp paths are not absolute. All my machines use absolute paths for my projects, but since you were unable to reproduce this issue, your machine would have been using relative paths...

[jonkemp]

Good to know then. Thanks!

[ikari-pl]

I love it! I had the same issue, worked around by starting a local express and hardcoding localhost URLs, but this solves it :) I can simplify the paths again.