Merge pull request #363 from ahx/fix-resolve-array

Fix resolving referenced array values

Author: ahx

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Unreleased
 
+## 2.7.2
+
+- Fix $ref-resolving for referenced arrays.
+  This fixes loading something like this:
+  ```yaml
+  parameters:
+    $ref: 'my-paramters.yaml'
+  ```
+
 ## 2.7.1
 
 - Speedup loading very large OADs by deferring creation of JSONSchemer::Schema instances.

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    openapi_first (2.7.1)
+    openapi_first (2.7.2)
       hana (~> 1.3)
       json_schemer (>= 2.1, < 3.0)
       openapi_parameters (>= 0.3.3, < 2.0)
@@ -47,23 +47,23 @@ GEM
     concurrent-ruby (1.3.5)
     connection_pool (2.5.3)
     crass (1.0.6)
-    diff-lcs (1.6.1)
+    diff-lcs (1.6.2)
     docile (1.4.1)
     drb (2.2.1)
     erubi (1.13.1)
     hana (1.3.7)
     i18n (1.14.7)
       concurrent-ruby (~> 1.0)
-    json (2.11.3)
+    json (2.12.0)
     json_schemer (2.4.0)
       bigdecimal
       hana (~> 1.3)
       regexp_parser (~> 2.0)
       simpleidn (~> 0.2)
-    language_server-protocol (3.17.0.4)
+    language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
-    loofah (2.24.0)
+    loofah (2.24.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     minitest (5.25.5)
@@ -79,7 +79,7 @@ GEM
       racc
     prism (1.4.0)
     racc (1.8.1)
-    rack (3.1.13)
+    rack (3.1.14)
     rack-session (2.1.1)
       base64 (>= 0.1.0)
       rack (>= 3.0.0)
@@ -110,7 +110,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.3)
-    rubocop (1.75.5)
+    rubocop (1.75.6)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)

benchmarks/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    openapi_first (2.7.1)
+    openapi_first (2.7.2)
       hana (~> 1.3)
       json_schemer (>= 2.1, < 3.0)
       openapi_parameters (>= 0.3.3, < 2.0)
@@ -16,7 +16,7 @@ GEM
     benchmark-memory (0.2.0)
       memory_profiler (~> 1)
     bigdecimal (3.1.9)
-    committee (5.5.3)
+    committee (5.5.4)
       json_schema (~> 0.14, >= 0.14.3)
       openapi_parser (~> 2.0)
       rack (>= 1.5, < 3.2)
@@ -36,12 +36,12 @@ GEM
       rack (>= 2.2)
     openapi_parser (2.2.6)
     optparse (0.6.0)
-    profile-viewer (0.0.4)
+    profile-viewer (0.0.5)
       optparse
       webrick
     puma (6.6.0)
       nio4r (~> 2.0)
-    rack (3.1.13)
+    rack (3.1.14)
     rack-protection (4.1.1)
       base64 (>= 0.1.0)
       logger (>= 1.6.0)
@@ -60,7 +60,7 @@ GEM
       rack-session (>= 2.0.0, < 3)
       tilt (~> 2.0)
     tilt (2.6.0)
-    vernier (1.7.0)
+    vernier (1.7.1)
     webrick (1.9.1)
 
 PLATFORMS

lib/openapi_first/ref_resolver.rb

@@ -14,7 +14,12 @@ def self.load(filepath)
     def self.for(value, filepath: nil, context: value)
       case value
       when ::Hash
-        Hash.new(value, context:, filepath:)
+        resolver = Hash.new(value, context:, filepath:)
+        if value.key?('$ref')
+          probe = resolver.resolve_ref(value['$ref'])
+          return probe if probe.is_a?(Array)
+        end
+        resolver
       when ::Array
         Array.new(value, context:, filepath:)
       when ::NilClass

lib/openapi_first/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiFirst
-  VERSION = '2.7.1'
+  VERSION = '2.7.2'
 end

spec/ref_resolver_spec.rb

@@ -295,6 +295,30 @@
                                 { 'name' => 'B' }
                               ])
       end
+
+      it 'works with a referenced array' do
+        contents = {
+          'definitions' => {
+            'Thing' => { 'type' => 'object' },
+            'A' => { 'name' => 'A' },
+            'array' => [
+              { 'object' => { '$ref' => '#/definitions/A' } },
+              { 'object' => { 'name' => 'B' } }
+            ]
+          },
+          'array' => { '$ref' => '#/definitions/array' }
+        }
+        doc = described_class.for(contents)
+
+        results = []
+        doc['array'].each do |node|
+          results << node['object'].resolved
+        end
+        expect(results).to eq([
+                                { 'name' => 'A' },
+                                { 'name' => 'B' }
+                              ])
+      end
     end
   end
 end