Fixes whitlockjc#80

medallia · Sep 12, 2016 · fde6b19 · fde6b19
1 parent 5ad1f63
commit fde6b19
Show file tree

Hide file tree

Showing 9 changed files with 2,244 additions and 2,000 deletions.
diff --git a/browser/json-refs-min.js b/browser/json-refs-min.js
diff --git a/browser/json-refs-standalone-min.js b/browser/json-refs-standalone-min.js
diff --git a/browser/json-refs-standalone.js b/browser/json-refs-standalone.js
diff --git a/browser/json-refs.js b/browser/json-refs.js
diff --git a/index.js b/index.js
@@ -150,7 +150,7 @@ function findAncestors (obj, path) {
   return ancestors;
 }
 
-function processSubDocument (mode, doc, subDocPath, refDetails, options, parents, parentPtrs, allRefs, indirect) {
+function processSubDocument (mode, doc, subDocPath, refDetails, options, parents, parentPtrs, allRefs, indirect, isRootFile) {
   var refValue;
   var rOptions;
 
@@ -190,19 +190,21 @@ function processSubDocument (mode, doc, subDocPath, refDetails, options, parents
       }
     }
 
-    return findRefsRecursive(doc, rOptions, parents, parentPtrs, allRefs, indirect);
+    return findRefsRecursive(doc, rOptions, parents, parentPtrs, allRefs, indirect, isRootFile);
   }
 }
 
 // Should this be its own exported API?
-function findRefsRecursive (obj, options, parents, parentPtrs, allRefs, indirect) {
+function findRefsRecursive (obj, options, parents, parentPtrs, allRefs, indirect, isRootFile) {
   var allTasks = Promise.resolve();
   var parentPath = parentPtrs.length ? pathFromPtr(parentPtrs[parentPtrs.length - 1]) : [];
-  var refs = findRefs(obj, options);
+  var refs = findRefs(obj, options, isRootFile);
   var subDocPath = options.subDocPath || [];
   var subDocPtr = pathToPtr(subDocPath);
   var ancestorPtrs = ['#'];
 
+  isRootFile = typeof isRootFile !== 'undefined' ? isRootFile : true;
+
   parents.forEach(function (parent, index) {
     if (parent.charAt(0) !== '#') {
       ancestorPtrs.push(parentPtrs[index]);
@@ -275,7 +277,8 @@ function findRefsRecursive (obj, options, parents, parentPtrs, allRefs, indirect
                                             parents.concat(location),
                                             parentPtrs.concat(refFullPtr),
                                             allRefs,
-                                            indirect);
+                                            indirect,
+                                            false);
                 })
                 .catch(function (err) {
                   refDetails.error = err.message;
@@ -296,7 +299,8 @@ function findRefsRecursive (obj, options, parents, parentPtrs, allRefs, indirect
                                             parents.concat(location),
                                             parentPtrs.concat(refFullPtr),
                                             allRefs,
-                                            indirect || (location.indexOf(subDocPtr + '/') === -1 && location !== subDocPtr));
+                                            indirect || (location.indexOf(subDocPtr + '/') === -1 && location !== subDocPtr),
+                                            isRootFile);
                 });
             }
           } else {
@@ -492,7 +496,7 @@ function makeRefFilter (options) {
 
   if (isType(options.filter, 'Array') || isType(options.filter, 'String')) {
     validTypes = isType(options.filter, 'String') ? [options.filter] : options.filter;
-    refFilter = function (refDetails) {
+    refFilter = function (refDetails, path) {
       // Check the exact type or for invalid URIs, check its original type
       return validTypes.indexOf(refDetails.type) > -1 || validTypes.indexOf(getRefType(refDetails)) > -1;
     };
@@ -830,9 +834,11 @@ function encodePath (path) {
  * // Finding all invalid references
  * var invalidRefs = JsonRefs.findRefs(obj, {filter: 'invalid', includeInvalid: true});
  */
-function findRefs (obj, options) {
+function findRefs (obj, options, isRootFile) {
   var refs = {};
 
+  isRootFile = typeof isRootFile !== 'undefined' ? isRootFile : true;
+
   // Validate the provided document
   if (!isType(obj, 'Array') && !isType(obj, 'Object')) {
     throw new TypeError('obj must be an Array or an Object');
@@ -862,7 +868,7 @@ function findRefs (obj, options) {
              refDetails = options.refPostProcessor(refDetails, path);
            }
 
-           if (options.filter(refDetails, path)) {
+           if (!isRootFile || options.filter(refDetails, path)) {
              refs[pathToPtr(path)] = refDetails;
            }
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
-  "name": "json-refs",
-  "version": "2.1.6",
+  "name": "@m/json-refs",
+  "version": "2.1.7",
   "description": "Various utilities for JSON References (http://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03).",
   "main": "index.js",
   "scripts": {

diff --git a/test/browser/documents/nested-refs/a.yaml b/test/browser/documents/nested-refs/a.yaml
@@ -0,0 +1,36 @@
+---
+swagger: "2.0"
+info:
+  title: test
+  version: '0.0.0'
+responses:
+  500:
+    description: "error"
+    schema:
+      $ref: "#/definitions/e"
+paths: {}
+definitions:
+  y:
+    type: object
+    properties:
+      children:
+        type: array
+        items:
+          $ref: "#/definitions/z"
+  z:
+    type: object
+    properties:
+      name:
+        type: string
+  t:
+    type: string
+    enum:
+    - unauthorized
+    - forbidden
+  e:
+    type: object
+    properties:
+      error_type:
+        $ref: "#/definitions/t"
+      message:
+        type: string
diff --git a/test/browser/documents/nested-refs/b.yaml b/test/browser/documents/nested-refs/b.yaml
@@ -0,0 +1,11 @@
+---
+swagger: "2.0"
+info:
+  title: test
+  version: '0.0.0'
+responses:
+  $ref: "./a.yaml#/responses"
+paths: {}
+definitions:
+  x:
+    $ref: "./a.yaml#/definitions/y"
diff --git a/test/test-issues.js b/test/test-issues.js
@@ -376,4 +376,43 @@ describe('json-refs Issues', function () {
         .then(done, done);
     });
   });
+
+  describe('Issue #77', function () {
+    it('combined URI\'s should handle windows pathing correctly', function (done) {
+      JsonRefs.resolveRefsAt('../documents/test-document.yaml', {
+        loaderOptions: {
+          processContent: function (res, callback) {
+            callback(undefined, YAML.safeLoad(res.text));
+          }
+        },
+        relativeBase: relativeBase
+      })
+        .then(function (results) {
+          assert.notEqual(results.refs['#/remote/relative'].missing, true);
+        })
+        .then(done, done);
+    });
+  });
+
+  describe('Issue #80', function () {
+    it('should resolve nested references correctly', function (done) {
+      JsonRefs.resolveRefsAt('nested-refs/b.yaml', {
+        filter: 'relative',
+        loaderOptions: {
+          processContent: function (res, callback) {
+            callback(undefined, YAML.safeLoad(res.text));
+          }
+        },
+        relativeBase: relativeBase
+      })
+        .then(function (results) {
+          assert.ok(!_.has(results, 'resolved.definitions.x.properties.children.items.$ref'));
+          assert.equal(results.resolved.definitions.x.properties.children.items.type, 'object');
+
+          assert.ok(!_.has(results, 'resolved.responses.500.schema.properties.error_type.$ref'));
+          assert.equal(results.resolved.responses['500'].schema.properties.error_type.type, 'string');
+        })
+        .then(done, done);
+    });
+  });
 });