Fixed bugs in "file://" url handling on Windows and on old versions of Node

Author: JamesMessinger

dist/ref-parser.js

@@ -1870,20 +1870,45 @@ exports.path.localPathToUrl = function localPathToUrl(path) {
  * @returns {string}
  */
 exports.path.urlToLocalPath = function urlToLocalPath(url, keepFileProtocol) {
+  // Decode URL-encoded characters
   url = decodeURI(url);
+
   // Manually decode characters that are not decoded by `decodeURI`
   for (var i = 0; i < urlDecodePatterns.length; i += 2) {
     url = url.replace(urlDecodePatterns[i], urlDecodePatterns[i + 1]);
   }
-  if (!keepFileProtocol && url.substr(0, 7).toLowerCase() === 'file://') {
-    url = url.substr(7);
+
+  // Handle "file://" URLs
+  var isFileUrl = url.substr(0, 7).toLowerCase() === 'file://';
+  if (isFileUrl) {
+    var protocol = 'file:///';
+
+    // Remove the third "/" if there is one
+    var path = url[7] === '/' ? url.substr(8) : url.substr(7);
+
+    if (isWindows && path[1] === '/') {
+      // insert a colon (":") after the drive letter on Windows
+      path = path[0] + ':' + path.substr(1);
+    }
+
+    if (keepFileProtocol) {
+      url = protocol + path;
+    }
+    else {
+      isFileUrl = false;
+      url = isWindows ? path : '/' + path;
+    }
   }
-  if (isWindows) {
+
+  // Format path separators on Windows
+  if (isWindows && !isFileUrl) {
     url = url.replace(forwardSlashPattern, '\\');
   }
+
   return url;
 };
 
+
 /**
  * Returns the hash (URL fragment), if any, of the given path.
  *

dist/ref-parser.js.map

@@ -82,20 +82,45 @@ exports.path.localPathToUrl = function localPathToUrl(path) {
  * @returns {string}
  */
 exports.path.urlToLocalPath = function urlToLocalPath(url, keepFileProtocol) {
+  // Decode URL-encoded characters
   url = decodeURI(url);
+
   // Manually decode characters that are not decoded by `decodeURI`
   for (var i = 0; i < urlDecodePatterns.length; i += 2) {
     url = url.replace(urlDecodePatterns[i], urlDecodePatterns[i + 1]);
   }
-  if (!keepFileProtocol && url.substr(0, 7).toLowerCase() === 'file://') {
-    url = url.substr(7);
+
+  // Handle "file://" URLs
+  var isFileUrl = url.substr(0, 7).toLowerCase() === 'file://';
+  if (isFileUrl) {
+    var protocol = 'file:///';
+
+    // Remove the third "/" if there is one
+    var path = url[7] === '/' ? url.substr(8) : url.substr(7);
+
+    if (isWindows && path[1] === '/') {
+      // insert a colon (":") after the drive letter on Windows
+      path = path[0] + ':' + path.substr(1);
+    }
+
+    if (keepFileProtocol) {
+      url = protocol + path;
+    }
+    else {
+      isFileUrl = false;
+      url = isWindows ? path : '/' + path;
+    }
   }
-  if (isWindows) {
+
+  // Format path separators on Windows
+  if (isWindows && !isFileUrl) {
     url = url.replace(forwardSlashPattern, '\\');
   }
+
   return url;
 };
 
+
 /**
  * Returns the hash (URL fragment), if any, of the given path.
  *

dist/ref-parser.min.js

@@ -28,6 +28,7 @@
 
     global.userAgent = {
       isNode: true,
+      isOldNode: /^v0\./.test(process.version),
       isBrowser: false,
       isTravisCI: !!process.env.TRAVIS
     };

dist/ref-parser.min.js.map

@@ -49,6 +49,7 @@
   helper.testResolve = function testResolve(filePath, params) {
     var parsedSchema = arguments[2];
     var expectedFiles = [], expectedValues = [], actualFiles;
+
     for (var i = 1; i < arguments.length; i += 2) {
       expectedFiles.push(arguments[i]);
       expectedValues.push(arguments[i + 1]);

lib/util.js

@@ -19,7 +19,7 @@
   path.rel = function(file) {
     if (userAgent.isNode) {
       // Return the relative path from the project root
-      return file;
+      return _path.normalize(file);
     }
 
     // Encode special characters in paths when running in a browser
@@ -71,6 +71,7 @@
       slashes: true,
       pathname: pathname
     });
+
     return url;
   };
 

tests/fixtures/globals.js

@@ -50,13 +50,16 @@ describe('Schema with external $refs', function() {
     path.abs('specs/external/definitions/required-string.yaml'), helper.parsed.external.requiredString
   ));
 
-  it('should resolve successfully from a url', helper.testResolve(
-    path.url('specs/external/external.yaml'),
-    path.url('specs/external/external.yaml'), helper.parsed.external.schema,
-    path.url('specs/external/definitions/definitions.json'), helper.parsed.external.definitions,
-    path.url('specs/external/definitions/name.yaml'), helper.parsed.external.name,
-    path.url('specs/external/definitions/required-string.yaml'), helper.parsed.external.requiredString
-  ));
+  // Skip this test on Node v0.x, due to bugs in `url.resolve()`
+  if (!userAgent.isOldNode) {
+    it('should resolve successfully from a url', helper.testResolve(
+      path.url('specs/external/external.yaml'),
+      path.url('specs/external/external.yaml'), helper.parsed.external.schema,
+      path.url('specs/external/definitions/definitions.json'), helper.parsed.external.definitions,
+      path.url('specs/external/definitions/name.yaml'), helper.parsed.external.name,
+      path.url('specs/external/definitions/required-string.yaml'), helper.parsed.external.requiredString
+    ));
+  }
 
   it('should dereference successfully', function() {
     var parser = new $RefParser();