Moved the allow.circular options to $refs.circular to be more consistent with other $ref-related options

JamesMessinger · JamesMessinger · commit 31c2e8072d73 · 2015-09-21T04:13:46.000-05:00
diff --git a/dist/ref-parser.js b/dist/ref-parser.js
@@ -156,7 +156,7 @@ function crawl(obj, path, parents, $refs, options) {
         // Check for circular references
         var circular = pointer.circular || parents.indexOf(pointer.value) !== -1;
         $refs.circular = $refs.circular || true;
-        if (!options.allow.circular) {
+        if (!options.$refs.circular) {
           throw ono.reference('Circular $ref pointer found at %s', keyPath);
         }
 
@@ -520,14 +520,7 @@ function $RefParserOptions(options) {
      * If false, then an error will be thrown.
      * @type {boolean}
      */
-    unknown: true,
-
-    /**
-     * Allow circular (recursive) JSON references?
-     * If false, then a {@link ReferenceError} will be thrown if a circular reference is found.
-     * @type {boolean}
-     */
-    circular: true
+    unknown: true
   };
 
   /**
@@ -544,7 +537,14 @@ function $RefParserOptions(options) {
      * Allow JSON references to external files/URLs?
      * @type {boolean}
      */
-    external: true
+    external: true,
+
+    /**
+     * Allow circular (recursive) JSON references?
+     * If false, then a {@link ReferenceError} will be thrown if a circular reference is found.
+     * @type {boolean}
+     */
+    circular: true
   };
 
   /**
diff --git a/dist/ref-parser.js.map b/dist/ref-parser.js.map
diff --git a/dist/ref-parser.min.js b/dist/ref-parser.min.js
diff --git a/dist/ref-parser.min.js.map b/dist/ref-parser.min.js.map
diff --git a/lib/dereference.js b/lib/dereference.js
@@ -47,7 +47,7 @@ function crawl(obj, path, parents, $refs, options) {
         // Check for circular references
         var circular = pointer.circular || parents.indexOf(pointer.value) !== -1;
         $refs.circular = $refs.circular || true;
-        if (!options.allow.circular) {
+        if (!options.$refs.circular) {
           throw ono.reference('Circular $ref pointer found at %s', keyPath);
         }
 
diff --git a/lib/options.js b/lib/options.js
@@ -40,14 +40,7 @@ function $RefParserOptions(options) {
      * If false, then an error will be thrown.
      * @type {boolean}
      */
-    unknown: true,
-
-    /**
-     * Allow circular (recursive) JSON references?
-     * If false, then a {@link ReferenceError} will be thrown if a circular reference is found.
-     * @type {boolean}
-     */
-    circular: true
+    unknown: true
   };
 
   /**
@@ -64,7 +57,14 @@ function $RefParserOptions(options) {
      * Allow JSON references to external files/URLs?
      * @type {boolean}
      */
-    external: true
+    external: true,
+
+    /**
+     * Allow circular (recursive) JSON references?
+     * If false, then a {@link ReferenceError} will be thrown if a circular reference is found.
+     * @type {boolean}
+     */
+    circular: true
   };
 
   /**
diff --git a/tests/specs/circular-external/circular-external.spec.js b/tests/specs/circular-external/circular-external.spec.js
@@ -47,10 +47,10 @@ describe('Schema with circular (recursive) external $refs', function() {
       .catch(helper.shouldNotGetCalled(done));
   });
 
-  it('should throw an error if "options.allow.circular" is false', function(done) {
+  it('should throw an error if "options.$refs.circular" is false', function(done) {
     var parser = new $RefParser();
     parser
-      .dereference(path.rel('specs/circular-external/circular-external.yaml'), {allow: {circular: false}})
+      .dereference(path.rel('specs/circular-external/circular-external.yaml'), {$refs: {circular: false}})
       .then(helper.shouldNotGetCalled(done))
       .catch(function(err) {
         // A ReferenceError should have been thrown
diff --git a/tests/specs/circular/circular.spec.js b/tests/specs/circular/circular.spec.js
@@ -45,10 +45,10 @@ describe('Schema with circular (recursive) $refs', function() {
       .catch(helper.shouldNotGetCalled(done));
   });
 
-  it('should throw an error if "options.allow.circular" is false', function(done) {
+  it('should throw an error if "options.$refs.circular" is false', function(done) {
     var parser = new $RefParser();
     parser
-      .dereference(path.rel('specs/circular/circular.yaml'), {allow: {circular: false}})
+      .dereference(path.rel('specs/circular/circular.yaml'), {$refs: {circular: false}})
       .then(helper.shouldNotGetCalled(done))
       .catch(function(err) {
         // A ReferenceError should have been thrown
diff --git a/tests/specs/deep-circular/deep-circular.spec.js b/tests/specs/deep-circular/deep-circular.spec.js
@@ -48,10 +48,10 @@ describe('Schema with deeply-nested circular $refs', function() {
       .catch(helper.shouldNotGetCalled(done));
   });
 
-  it('should throw an error if "options.allow.circular" is false', function(done) {
+  it('should throw an error if "options.$refs.circular" is false', function(done) {
     var parser = new $RefParser();
     parser
-      .dereference(path.rel('specs/deep-circular/deep-circular.yaml'), {allow: {circular: false}})
+      .dereference(path.rel('specs/deep-circular/deep-circular.yaml'), {$refs: {circular: false}})
       .then(helper.shouldNotGetCalled(done))
       .catch(function(err) {
         // A ReferenceError should have been thrown

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ function crawl(obj, path, parents, $refs, options) {`
`47`	`47`	`// Check for circular references`
`48`	`48`	`var circular = pointer.circular \|\| parents.indexOf(pointer.value) !== -1;`
`49`	`49`	`$refs.circular = $refs.circular \|\| true;`
`50`		`- if (!options.allow.circular) {`
	`50`	`+ if (!options.$refs.circular) {`
`51`	`51`	`throw ono.reference('Circular $ref pointer found at %s', keyPath);`
`52`	`52`	`}`
`53`	`53`