fix: better determination of oneOf for hash arrays in hash arrays (#269)

Author: Spence1115

.gitignore

@@ -7,6 +7,7 @@
 /spec/reports/
 /tmp/
 /Gemfile.lock
+.DS_Store
 
 # rspec failure tracking
 .rspec_status

lib/rspec/openapi/schema_builder.rb

@@ -246,20 +246,84 @@ def normalize_content_disposition(content_disposition)
 
   def build_array_items_schema(array, record: nil)
     return {} if array.empty?
+    return build_property(array.first, record: record) if array.size == 1
+    return build_property(array.first, record: record) unless array.all? { |item| item.is_a?(Hash) }
 
-    merged_schema = build_property(array.first, record: record)
+    all_schemas = array.map { |item| build_property(item, record: record) }
+    merged_schema = all_schemas.first.dup
+    merged_schema[:properties] = {}
 
-    # Future improvement - cover other types than just hashes
-    if array.size > 1 && array.all? { |item| item.is_a?(Hash) }
-      array[1..].each do |item|
-        item_schema = build_property(item, record: record)
-        merged_schema = merge_object_schemas(merged_schema, item_schema)
+    all_keys = all_schemas.flat_map { |s| s[:properties]&.keys || [] }.uniq
+
+    all_keys.each do |key|
+      property_variations = all_schemas.map { |s| s[:properties]&.[](key) }.compact
+
+      next if property_variations.empty?
+
+      if property_variations.size == 1
+        merged_schema[:properties][key] = make_property_nullable(property_variations.first)
+      else
+        unique_types = property_variations.map { |p| p[:type] }.compact.uniq
+
+        case unique_types.first
+        when 'array'
+          merged_schema[:properties][key] = { type: 'array' }
+          items_variations = property_variations.map { |p| p[:items] }.compact
+          merged_schema[:properties][key][:items] = build_merged_schema_from_variations(items_variations)
+        when 'object'
+          merged_schema[:properties][key] = build_merged_schema_from_variations(property_variations)
+        else
+          merged_schema[:properties][key] = property_variations.first.dup
+        end
+
+        merged_schema[:properties][key][:nullable] = true if property_variations.size < all_schemas.size
       end
     end
 
+    all_required_sets = all_schemas.map { |s| s[:required] || [] }
+    merged_schema[:required] = all_required_sets.reduce(:&) || []
+
     merged_schema
   end
 
+  def build_merged_schema_from_variations(variations)
+    return {} if variations.empty?
+    return variations.first if variations.size == 1
+
+    types = variations.map { |v| v[:type] }.compact.uniq
+
+    if types.size == 1 && types.first == 'object'
+      merged = { type: 'object', properties: {} }
+      all_keys = variations.flat_map { |v| v[:properties]&.keys || [] }.uniq
+
+      all_keys.each do |key|
+        prop_variations = variations.map { |v| v[:properties]&.[](key) }.compact
+
+        if prop_variations.size == 1
+          merged[:properties][key] = make_property_nullable(prop_variations.first)
+        elsif prop_variations.size > 1
+          prop_types = prop_variations.map { |p| p[:type] }.compact.uniq
+
+          if prop_types.size == 1
+            merged[:properties][key] = prop_variations.first.dup
+          else
+            unique_props = prop_variations.map { |p| p.reject { |k, _| k == :nullable } }.uniq
+            merged[:properties][key] = { oneOf: unique_props }
+          end
+
+          merged[:properties][key][:nullable] = true if prop_variations.size < variations.size
+        end
+      end
+
+      all_required = variations.map { |v| v[:required] || [] }
+      merged[:required] = all_required.reduce(:&) || []
+
+      merged
+    else
+      variations.first
+    end
+  end
+
   def merge_object_schemas(schema1, schema2)
     return schema1 unless schema2.is_a?(Hash) && schema1.is_a?(Hash)
     return schema1 unless schema1[:type] == 'object' && schema2[:type] == 'object'

lib/rspec/openapi/schema_merger.rb

@@ -77,6 +77,8 @@ def merge_closest_match!(options, spec)
 
     return if option&.key?(:$ref)
 
+    return if spec[:oneOf]
+
     if score.to_f > SIMILARITY_THRESHOLD
       merge_schema!(option, spec)
     else

spec/apps/hanami/app/actions/array_hashes/empty_array.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module HanamiTest
+  module Actions
+    module ArrayHashes
+      class EmptyArray < HanamiTest::Action
+        def handle(request, response)
+          response.format = :json
+
+          response.body = {
+            "items" => []
+          }.to_json
+        end
+      end
+    end
+  end
+end

spec/apps/hanami/app/actions/array_hashes/mixed_types_nested.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module HanamiTest
+  module Actions
+    module ArrayHashes
+      class MixedTypesNested < HanamiTest::Action
+        def handle(request, response)
+          response.format = :json
+
+          response.body = {
+            "items" => [
+              {
+                "id" => 1,
+                "config" => {
+                  "port" => 8080,
+                  "host" => "localhost"
+                }
+              },
+              {
+                "id" => 2,
+                "config" => {
+                  "port" => "3000",
+                  "host" => "example.com",
+                  "ssl" => true
+                }
+              }
+            ]
+          }.to_json
+        end
+      end
+    end
+  end
+end

spec/apps/hanami/app/actions/array_hashes/nested.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module HanamiTest
+  module Actions
+    module ArrayHashes
+      class Nested < HanamiTest::Action
+        def handle(request, response)
+          response.format = :json
+
+          response.body = {
+            "fields" => [
+              {
+                "id" => "country_code",
+                "options" => [
+                  {
+                    "id" => "us",
+                    "label" => "United States"
+                  },
+                  {
+                    "id" => "ca",
+                    "label" => "Canada"
+                  }
+                ]
+              },
+              {
+                "id" => "region_id",
+                "options" => [
+                  {
+                    "id" => 1,
+                    "label" => "New York"
+                  },
+                  {
+                    "id" => 2,
+                    "label" => "California"
+                  }
+                ]
+              }
+            ]
+          }.to_json
+        end
+      end
+    end
+  end
+end

spec/apps/hanami/app/actions/array_hashes/nested_arrays.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module HanamiTest
+  module Actions
+    module ArrayHashes
+      class NestedArrays < HanamiTest::Action
+        def handle(request, response)
+          response.format = :json
+
+          response.body = {
+            "items" => [
+              {
+                "id" => 1,
+                "tags" => ["ruby", "rails"]
+              },
+              {
+                "id" => 2,
+                "tags" => ["python", "django"]
+              },
+              {
+                "id" => 3,
+                "tags" => ["javascript"]
+              }
+            ]
+          }.to_json
+        end
+      end
+    end
+  end
+end

spec/apps/hanami/app/actions/array_hashes/nested_objects.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module HanamiTest
+  module Actions
+    module ArrayHashes
+      class NestedObjects < HanamiTest::Action
+        def handle(request, response)
+          response.format = :json
+
+          response.body = {
+            "items" => [
+              {
+                "id" => 1,
+                "metadata" => {
+                  "author" => "Alice",
+                  "version" => "1.0"
+                }
+              },
+              {
+                "id" => 2,
+                "metadata" => {
+                  "author" => "Bob",
+                  "version" => "2.0",
+                  "reviewed" => true
+                }
+              },
+              {
+                "id" => 3,
+                "metadata" => {
+                  "author" => "Charlie"
+                }
+              }
+            ]
+          }.to_json
+        end
+      end
+    end
+  end
+end

spec/apps/hanami/app/actions/array_hashes/non_hash_items.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module HanamiTest
+  module Actions
+    module ArrayHashes
+      class NonHashItems < HanamiTest::Action
+        def handle(request, response)
+          response.format = :json
+
+          response.body = {
+            "items" => ["string1", "string2", "string3"]
+          }.to_json
+        end
+      end
+    end
+  end
+end

spec/apps/hanami/app/actions/array_hashes/single_item.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module HanamiTest
+  module Actions
+    module ArrayHashes
+      class SingleItem < HanamiTest::Action
+        def handle(request, response)
+          response.format = :json
+
+          response.body = {
+            "items" => [
+              {
+                "id" => 1,
+                "name" => "Item 1"
+              }
+            ]
+          }.to_json
+        end
+      end
+    end
+  end
+end