rspec-openapi 0.20.0 → 0.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a94cc7be13ab8a500bf3eb4bb5831f1c06c7722e96f9f7157e424fa402f2f137
-  data.tar.gz: db6591ab069d1f7bd1d7f07b6f2c4d9be9ef86f90df497c28a2b8ed01ee1d5e4
+  metadata.gz: fcdab2071b77e7d4df6910839d60df6d3493fcf3bc10c47829fc0609451c5094
+  data.tar.gz: 0efb97d546a285eaa1108dbec9b9dd6598a119b93f46dde04e070cdaf8f029d3
 SHA512:
-  metadata.gz: 785d100550f4ecde118a8986ee7c98349e310de9c870a04067a9f84892d37b63cadf9a88d0ff2158012c153c561c3a0576a3c0c79860a645bb53bb295c64bbc5
-  data.tar.gz: 660bd242fa8c5686bc6fbead56f595be959f1f1cae465723ed89e93c0b0096ee6c86094c8561193cabf119cedb74762e84e6b9c3651d34fca7691b63317fc611
+  metadata.gz: cb16c77c27f8a766cb5e09bce79d2ef7af160277b274dbd75785f8ca9466e28e6800f498f167644fb16e66b4f6a1dc7becd77b0632d4c1a717b49739e4ed014c
+  data.tar.gz: efa94d5ea193fd56f3ac3b4f220453c3ceb184596688422fff7fe9e14223a44c5427ad17206a7cd4014e16f8e1f4bafc3f3ebdce3a336251a036f5daee83ee2e

data/.github/workflows/codeql-analysis.yml

@@ -28,12 +28,12 @@ jobs:
       uses: actions/checkout@v5
 
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v3
+      uses: github/codeql-action/init@v4
       with:
         languages: ${{ matrix.language }}
         
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v3
+      uses: github/codeql-action/autobuild@v4
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v3
+      uses: github/codeql-action/analyze@v4

data/.github/workflows/rubocop.yml

@@ -30,6 +30,6 @@ jobs:
         "
 
     - name: Upload Sarif output
-      uses: github/codeql-action/upload-sarif@v3
+      uses: github/codeql-action/upload-sarif@v4
       with:
         sarif_file: rubocop.sarif

data/.gitignore

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

data/README.md

@@ -408,6 +408,12 @@ Existing RSpec plugins which have OpenAPI integration:
 * Orignally created by [k0kubun](https://github.com/k0kubun) and the ownership was transferred to [exoego](https://github.com/exoego) in 2022-11-29.
 
 
+## Releasing
+
+1. Bump version in `lib/rspec/openapi/version.rb`
+2. Run `bundle exec rake release`
+3. Push tag
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/rspec/openapi/schema_builder.rb

@@ -151,7 +151,7 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
       property[:items] = if value.empty?
                            {} # unknown
                          else
-                           build_property(value.first, record: record)
+                           build_array_items_schema(value, record: record)
                          end
     when Hash
       property[:properties] = {}.tap do |properties|
@@ -243,4 +243,136 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
   def normalize_content_disposition(content_disposition)
     content_disposition&.sub(/;.+\z/, '')
   end
+
+  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) }
+
+    all_schemas = array.map { |item| build_property(item, record: record) }
+    merged_schema = all_schemas.first.dup
+    merged_schema[:properties] = {}
+
+    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'
+
+    merged = schema1.dup
+
+    if schema1[:properties] && schema2[:properties]
+      merged[:properties] = schema1[:properties].dup
+
+      schema2[:properties].each do |key, prop2|
+        if merged[:properties][key]
+          prop1 = merged[:properties][key]
+          merged[:properties][key] = merge_property_schemas(prop1, prop2)
+        else
+          merged[:properties][key] = make_property_nullable(prop2)
+        end
+      end
+
+      schema1[:properties].each do |key, prop1|
+        merged[:properties][key] = make_property_nullable(prop1) unless schema2[:properties][key]
+      end
+
+      required1 = Set.new(schema1[:required] || [])
+      required2 = Set.new(schema2[:required] || [])
+      merged[:required] = (required1 & required2).to_a
+    end
+
+    merged
+  end
+
+  def merge_property_schemas(prop1, prop2)
+    return prop1 unless prop2.is_a?(Hash) && prop1.is_a?(Hash)
+
+    merged = prop1.dup
+
+    # If either property is nullable, the merged property should be nullable
+    merged[:nullable] = true if prop2[:nullable] && !prop1[:nullable]
+
+    # If both are objects, recursively merge their properties
+    merged = merge_object_schemas(prop1, prop2) if prop1[:type] == 'object' && prop2[:type] == 'object'
+
+    merged
+  end
+
+  def make_property_nullable(property)
+    return property unless property.is_a?(Hash)
+
+    nullable_prop = property.dup
+    nullable_prop[:nullable] = true unless nullable_prop[:nullable]
+    nullable_prop
+  end
 end

data/lib/rspec/openapi/schema_merger.rb

@@ -77,6 +77,8 @@ class << RSpec::OpenAPI::SchemaMerger = Object.new
 
     return if option&.key?(:$ref)
 
+    return if spec[:oneOf]
+
     if score.to_f > SIMILARITY_THRESHOLD
       merge_schema!(option, spec)
     else

data/lib/rspec/openapi/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module OpenAPI
-    VERSION = '0.20.0'
+    VERSION = '0.21.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.1
 platform: ruby
 authors:
 - Takashi Kokubun
@@ -108,7 +108,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.20.0
+  changelog_uri: https://github.com/exoego/rspec-openapi/releases/tag/v0.21.1
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: