oas_parser 0.18.2 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86b2e4324d8cc77f1acd3dd60c95f613144330308d65a68a5a51233bf63ff8b1
-  data.tar.gz: 013b58bd9b70b51146a80f1d382681e9e2ccd9ded347a599ff4257e1a7e74668
+  metadata.gz: 825c569ee33db4ed6f8b1e666b9bbba45a5440d34d3490074e63f5815414efd8
+  data.tar.gz: 289f26572fa6abbf927305aaba1452d1c15ca6639726bf29768ec5ad12b490ef
 SHA512:
-  metadata.gz: 6d1885cd3dae1b5d17f2c0d050e6fcc96b365b6bd5cdbe696abf9d18186b6d48475a70c28baa01efbbff77e8b5fb1f19231a3dda3b3d1425390162c1aafacc6d
-  data.tar.gz: e3415696c0428e05e6f73de30f5464479d1ffefc6389b373184f8d0b927bbca1d3536dc34ccc21cb7751712f684b15042e1317159ed740cbf87749aac6384f6f
+  metadata.gz: ff8b3c7bcedfd51b38de3a61b0781ea8f64af25238918091b83304c549331aec97ec9714c7daa5c481e37867adb1306529460406e66b21e33fc987772d2b81d8
+  data.tar.gz: 35fe373a593e01a8b26fa8a1e04f0dbc388a6d87475c6523254a54a5de5883adb7ca65c5cc28f566c6c641f5e7a98c21aa9bf0e5db356b561043d875c0efba69

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    oas_parser (0.18.2)
+    oas_parser (0.19.0)
       activesupport (>= 4.0.0)
       addressable (~> 2.3)
       builder (~> 3.2.3)

data/lib/oas_parser/CHANGELOG.md

@@ -0,0 +1,3 @@
+## Unreleased
+
+- Parser now handles circular/self reference by returning the $ref as is instead of expanding it indefinitely. (Qihuan Piao)

data/lib/oas_parser/parser.rb

@@ -11,38 +11,38 @@ module OasParser
     end
 
     def resolve
-      deeply_expand_refs(@content)
+      deeply_expand_refs(@content, nil)
     end
 
     private
 
-    def deeply_expand_refs(fragment)
-      fragment = expand_refs(fragment)
+    def deeply_expand_refs(fragment, path)
+      fragment, current_path = expand_refs(fragment, path)
 
       if fragment.is_a?(Hash)
         fragment.reduce({}) do |hash, (k, v)|
-          hash.merge(k => deeply_expand_refs(v))
+          hash.merge(k => deeply_expand_refs(v, "#{current_path}/#{k}"))
         end
       elsif fragment.is_a?(Array)
-        fragment.map { |e| deeply_expand_refs(e) }
+        fragment.map { |e| deeply_expand_refs(e, current_path) }
       else
         fragment
       end
     end
 
-    def expand_refs(fragment)
-      if fragment.is_a?(Hash) && fragment.has_key?("$ref")
-        ref = fragment["$ref"]
+    def expand_refs(fragment, current_path)
+      unless fragment.is_a?(Hash) && fragment.key?("$ref")
+        return [fragment, current_path]
+      end
 
-        if ref =~ /^#/
-          expand_pointer(ref)
-        elsif ref =~ /^(http(s)?|\/\/)/
-          expand_url(ref)
-        else
-          expand_file(ref)
-        end
+      ref = fragment["$ref"]
+
+      if ref =~ /^#/
+        expand_pointer(ref, current_path)
+      elsif ref =~ /^(http(s)?|\/\/)/
+        expand_url(ref)
       else
-        fragment
+        expand_file(ref)
       end
     end
 
@@ -59,11 +59,15 @@ module OasParser
       resolved_remote_reference
     end
 
-    def expand_pointer(ref, content=nil)
+    def expand_pointer(ref, current_path)
       pointer = OasParser::Pointer.new(ref)
-      fragment = pointer.resolve(content || @content)
 
-      expand_refs(fragment)
+      if pointer.circular_reference?(current_path)
+        { "$ref" => ref }
+      else
+        fragment = pointer.resolve(@content)
+        expand_refs(fragment, current_path + pointer.escaped_pointer)
+      end
     end
 
     def expand_url(ref)

data/lib/oas_parser/pointer.rb

@@ -12,7 +12,28 @@ module OasParser
       end
     end
 
-    private
+    # Detect circular reference by checking whether the ref exists in current path.
+    #
+    # Example:
+    # components:
+    #   schemas:
+    #     Pet:
+    #       type: object
+    #       properties:
+    #         name:
+    #           type: string
+    #         children:
+    #           type: array
+    #           items: # <--- parsing here
+    #             - $ref: '#/components/schemas/Pet'
+    #
+    # path: "/components/schemas/Pet/properties/children/items"
+    # raw_pointer: "#/components/schemas/Pet"
+    #
+    # It'd return true when we're parsing the pet children items where the ref points back to itself.
+    def circular_reference?(path)
+      path.include?("#{escaped_pointer}/")
+    end
 
     def escaped_pointer
       if @raw_pointer.start_with?("#")
@@ -22,6 +43,8 @@ module OasParser
       end
     end
 
+    private
+
     def parse_token(token)
       if token =~ /\A\d+\z/
         token.to_i

data/lib/oas_parser/version.rb

@@ -1,3 +1,3 @@
 module OasParser
-  VERSION = '0.18.2'.freeze
+  VERSION = '0.19.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oas_parser
 version: !ruby/object:Gem::Version
-  version: 0.18.2
+  version: 0.19.0
 platform: ruby
 authors:
 - Adam Butler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-09 00:00:00.000000000 Z
+date: 2019-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -212,6 +212,7 @@ files:
 - bin/console
 - bin/setup
 - lib/oas_parser.rb
+- lib/oas_parser/CHANGELOG.md
 - lib/oas_parser/abstract_attribute.rb
 - lib/oas_parser/callback.rb
 - lib/oas_parser/definition.rb