rspec-openapi 0.33.1 → 0.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb54f98b3234ebee5ea46c0c703f094265d37c17f8fc1c8dcfec5c1f70c88667
-  data.tar.gz: 30972c7a4dd8387e1db47d954b3b5e380ee9a0d6282981ba73d14007e5fcdce8
+  metadata.gz: d493f4696b8bf07c0dcdfe1cbfb4d06736ac7b7efc3c103b8692f6d7aab01db7
+  data.tar.gz: 38e4d7f3268a4d84e60ad6f047c3176b1d161ef895f5648422d7231e34ccfff5
 SHA512:
-  metadata.gz: 19552292efc3339da373ca62b6e7c20ce23546d5ba81bd7b245ce6796dca729a12fd4138c905b11d90b9892e67f0a3abc18f15eaf7ea8f153f3a4c4b5f76de3c
-  data.tar.gz: ff754813db11c90118d4169428547b84c7c5a7163384124e94c15eefacff9dd62e701cc6c0c37716cb889dccba061086858ccc32161ed41f4a275d2a0eb8fcff
+  metadata.gz: c1dbea1b90c265e2e636a77f406456c2e871fdefa476845538cd44d4486887e09298ce3e55406cb1e2f0c9305a030328a1300638a9804753c56d3b56b40e96cb
+  data.tar.gz: 597cf318feef44fa58393dc94c3f4101d990e755028df0df16f76024aa6d79baff86a6d689b5f968c792a8e86e695ddd8f7abfdf89b2c314c9d4c381b83a4309

data/lib/rspec/openapi/components_updater.rb

@@ -10,14 +10,26 @@ class << RSpec::OpenAPI::ComponentsUpdater = Object.new
   def update!(base, fresh)
     # Top-level schema: Used as the body of request or response
     top_level_refs = paths_to_top_level_refs(base)
-    return if top_level_refs.empty?
-
     fresh_schemas = build_fresh_schemas(top_level_refs, base, fresh)
 
-    # Nested schema: References in Top-level schemas. May contain some top-level schema.
-    generated_schema_names = fresh_schemas.keys
-    nested_refs = find_non_top_level_nested_refs(base, generated_schema_names)
-    nested_refs.each do |paths|
+    # Nested schema: References in top-level schemas. May contain some top-level schema.
+    # A parent to dig fresh data out of only exists once some top-level schema was found.
+    apply_component_nested_refs!(fresh_schemas, base) unless top_level_refs.empty?
+
+    # Nested schema: References inline in a request/response body, not inside a component.
+    # Unlike the above, this doesn't depend on any top-level schema being found first.
+    apply_inline_nested_refs!(fresh_schemas, base, fresh)
+
+    return if fresh_schemas.empty?
+
+    RSpec::OpenAPI::SchemaMerger.merge_normalized!(base, { components: { schemas: fresh_schemas } })
+    RSpec::OpenAPI::SchemaCleaner.cleanup_components_schemas!(base, { components: { schemas: fresh_schemas } })
+  end
+
+  private
+
+  def apply_component_nested_refs!(fresh_schemas, base)
+    find_non_top_level_nested_refs(base, fresh_schemas.keys).each do |paths|
       # Slice between the parent name and the element before "$ref"
       # ["components", "schema", "Table", "properties", "database",                       "$ref"]
       #  0             1         2 ^....................^
@@ -32,16 +44,26 @@ class << RSpec::OpenAPI::ComponentsUpdater = Object.new
       # Skip if the property using $ref is not found in the parent schema. The property may be removed.
       next if nested_schema.nil?
 
-      schema_name = extract_schema_name(base.dig(*paths)).to_sym
-      fresh_schemas[schema_name] ||= {}
-      RSpec::OpenAPI::SchemaMerger.merge_normalized!(fresh_schemas[schema_name], nested_schema)
+      merge_fresh_schema!(fresh_schemas, base, paths, nested_schema)
     end
+  end
 
-    RSpec::OpenAPI::SchemaMerger.merge_normalized!(base, { components: { schemas: fresh_schemas } })
-    RSpec::OpenAPI::SchemaCleaner.cleanup_components_schemas!(base, { components: { schemas: fresh_schemas } })
+  # No promoted parent schema to dig from here, so pull the fresh data from the same
+  # relative path in the raw document instead.
+  def apply_inline_nested_refs!(fresh_schemas, base, fresh)
+    find_inline_nested_refs(base, fresh_schemas.keys).each do |paths|
+      nested_schema = fresh.dig(*paths[0..-2])
+      next if nested_schema.nil?
+
+      merge_fresh_schema!(fresh_schemas, base, paths, nested_schema)
+    end
   end
 
-  private
+  def merge_fresh_schema!(fresh_schemas, base, paths, nested_schema)
+    schema_name = extract_schema_name(base.dig(*paths)).to_sym
+    fresh_schemas[schema_name] ||= {}
+    RSpec::OpenAPI::SchemaMerger.merge_normalized!(fresh_schemas[schema_name], nested_schema)
+  end
 
   def build_fresh_schemas(references, base, fresh)
     references.inject({}) do |acc, paths|
@@ -80,7 +102,26 @@ class << RSpec::OpenAPI::ComponentsUpdater = Object.new
       *RSpec::OpenAPI::HashHelper.matched_paths_deeply_nested(base, 'components.schemas', 'properties.*.items.$ref'),
       *RSpec::OpenAPI::HashHelper.matched_paths_deeply_nested(base, 'components.schemas', 'oneOf.*.$ref'),
     ]
-    # Reject already-generated schemas to reduce unnecessary loop
+    reject_already_generated_refs(nested_refs, base, generated_names)
+  end
+
+  # Like find_non_top_level_nested_refs, but for a $ref inside a schema that's inline
+  # rather than itself a component, so it's not reachable by walking components.schemas.
+  def find_inline_nested_refs(base, generated_names)
+    roots = [
+      'paths.*.*.requestBody.content.application/json.schema',
+      'paths.*.*.responses.*.content.application/json.schema',
+    ]
+    nested_refs = roots.flat_map do |root|
+      [
+        *RSpec::OpenAPI::HashHelper.matched_paths_deeply_nested(base, root, 'properties.*.$ref'),
+        *RSpec::OpenAPI::HashHelper.matched_paths_deeply_nested(base, root, 'properties.*.items.$ref'),
+      ]
+    end
+    reject_already_generated_refs(nested_refs, base, generated_names)
+  end
+
+  def reject_already_generated_refs(nested_refs, base, generated_names)
     nested_refs.reject do |paths|
       ref_link = base.dig(*paths)
       schema_name = extract_schema_name(ref_link)

data/lib/rspec/openapi/nullable_converter.rb

@@ -27,6 +27,7 @@ class << RSpec::OpenAPI::NullableConverter = Object.new
     schema[:type] =
       case (type = schema[:type])
       when nil then 'null'
+      when Array then type | ['null']
       else [type, 'null']
       end
   end

data/lib/rspec/openapi/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module OpenAPI
-    VERSION = '0.33.1'
+    VERSION = '0.34.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.33.1
+  version: 0.34.0
 platform: ruby
 authors:
 - Takashi Kokubun
@@ -99,7 +99,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/exoego/rspec-openapi
   source_code_uri: https://github.com/exoego/rspec-openapi
-  changelog_uri: https://github.com/exoego/rspec-openapi/releases/tag/v0.33.1
+  changelog_uri: https://github.com/exoego/rspec-openapi/releases/tag/v0.34.0
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: