rspec-openapi 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a48ebba5d2201f35bb94f47d5bd649444bb9c58ae1f0ef91f57e315553f9ef2
-  data.tar.gz: 71d4dec68449c2e14b4d3ce7058622b7c56629bee2814e04b1f16e5e817a7bf2
+  metadata.gz: b221d36e6ff92306e1bd720b4bb07e114839c8e047ad530f6ac4cb2a11eb4ae5
+  data.tar.gz: 5f5daf56dddc8a7b9477f961611d3bd4550eb498aa38d166035e5b18fe7027bd
 SHA512:
-  metadata.gz: 4c984f5dbd1a4587a9d34686c50e06a832051215f5e22abc8a96781ecebe57e0bdddabeef093db06f5bea23f58e70322a7574168f621e8765721ab2c2cf19c48
-  data.tar.gz: 2877daab4753106d04275e3189b8a8e648b7268a6c6d7e422e94d5bfb230064a2e875e73531abe6930bfa6c8b7cdefe7d06ee512cdcb4e22adb618915349514b
+  metadata.gz: 18410768ff613a19b39f910e20e58ecda87337095b354e718bdb5f6b6e2713429acd26a289fd4ffa89a493348aa226561d89340d9685d37caa30b44c54d17be8
+  data.tar.gz: 5542bf85a5f1d46eacbdc0936b57ae197279bf618fa1628082e7d33c5600a2583f450426999dbc6eea4d4a401ffb307ea5d207b551aa27d586eb4682e572c9fb

data/.github/workflows/test.yml

@@ -43,9 +43,12 @@ jobs:
         if: matrix.coverage == 'coverage'
       - run: bundle exec rspec
         timeout-minutes: 1
+      - run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
+        name: codecov-action@v4 workaround
       - name: Upload coverage reports
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         if: matrix.coverage == 'coverage'
         with:
           fail_ci_if_error: true
           files: ./coverage/coverage.xml
+          token: ${{ secrets.CODECOV_TOKEN }}

data/CHANGELOG.md

@@ -1,6 +1,11 @@
-## v0.11.0
+## v0.12.0
+
+- feat: Initial support of complex schema with manually-added `oneOf`
+  [#174](https://github.com/exoego/rspec-openapi/pull/174)
+- chore: Test with Ruby 3.3 and Rails 7.1.x 
+  [#169](https://github.com/exoego/rspec-openapi/pull/169)
 
-## What's Changed
+## v0.11.0
 - feat: Allow path-based config overrides
   [#162](https://github.com/exoego/rspec-openapi/pull/162)
 - enhancement: Sort HTTP methods, response status codes, and contents lexicographically

data/lib/rspec/openapi/components_updater.rb

@@ -23,7 +23,8 @@ class << RSpec::OpenAPI::ComponentsUpdater = Object.new
       #  0             1         2 ^...............................^
       # ["components", "schema", "Table", "properties", "owner", "properties", "company", "$ref"]
       #  0             1         2 ^...........................................^
-      needle = paths.slice(2, paths.size - 3)
+      needle = paths.reject { |path| path.is_a?(Integer) || path == 'oneOf' }
+      needle = needle.slice(2, needle.size - 3)
       nested_schema = fresh_schemas.dig(*needle)
 
       # Skip if the property using $ref is not found in the parent schema. The property may be removed.
@@ -44,20 +45,28 @@ class << RSpec::OpenAPI::ComponentsUpdater = Object.new
     references.inject({}) do |acc, paths|
       ref_link = dig_schema(base, paths)['$ref']
       schema_name = ref_link.gsub('#/components/schemas/', '')
-      schema_body = dig_schema(fresh, paths)
+      schema_body = dig_schema(fresh, paths.reject { |path| path.is_a?(Integer) })
+
       RSpec::OpenAPI::SchemaMerger.merge!(acc, { schema_name => schema_body })
     end
   end
 
   def dig_schema(obj, paths)
-    obj.dig(*paths, 'schema', 'items') || obj.dig(*paths, 'schema')
+    item_schema = obj.dig(*paths, 'schema', 'items')
+    object_schema = obj.dig(*paths, 'schema')
+    one_of_schema = obj.dig(*paths.take(paths.size - 1), 'schema', 'oneOf', paths.last)
+
+    item_schema || object_schema || one_of_schema
   end
 
   def paths_to_top_level_refs(base)
     request_bodies = RSpec::OpenAPI::HashHelper.matched_paths(base, 'paths.*.*.requestBody.content.application/json')
     responses = RSpec::OpenAPI::HashHelper.matched_paths(base, 'paths.*.*.responses.*.content.application/json')
-    (request_bodies + responses).select do |paths|
-      dig_schema(base, paths)&.dig('$ref')&.start_with?('#/components/schemas/')
+    (request_bodies + responses).flat_map do |paths|
+      object_paths = find_object_refs(base, paths)
+      one_of_paths = find_one_of_refs(base, paths)
+
+      object_paths || one_of_paths || []
     end
   end
 
@@ -65,6 +74,7 @@ class << RSpec::OpenAPI::ComponentsUpdater = Object.new
     nested_refs = [
       *RSpec::OpenAPI::HashHelper.matched_paths_deeply_nested(base, 'components.schemas', 'properties.*.$ref'),
       *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
     nested_refs.reject do |paths|
@@ -73,4 +83,14 @@ class << RSpec::OpenAPI::ComponentsUpdater = Object.new
       generated_names.include?(schema_name)
     end
   end
+
+  def find_one_of_refs(base, paths)
+    dig_schema(base, paths)&.dig('oneOf')&.map&.with_index do |schema, index|
+      paths + [index] if schema&.dig('$ref')&.start_with?('#/components/schemas/')
+    end&.compact
+  end
+
+  def find_object_refs(base, paths)
+    [paths] if dig_schema(base, paths)&.dig('$ref')&.start_with?('#/components/schemas/')
+  end
 end

data/lib/rspec/openapi/hash_helper.rb

@@ -8,6 +8,10 @@ class << RSpec::OpenAPI::HashHelper = Object.new
         k = k.to_s
         [[k]] + paths_to_all_fields(v).map { |x| [k, *x] }
       end
+    when Array
+      obj.flat_map.with_index do |value, i|
+        [[i]] + paths_to_all_fields(value).map { |x| [i, *x] }
+      end
     else
       []
     end

data/lib/rspec/openapi/schema_merger.rb

@@ -29,6 +29,12 @@ class << RSpec::OpenAPI::SchemaMerger = Object.new
   #
   # TODO: Should we probably force-merge `summary` regardless of manual modifications?
   def merge_schema!(base, spec)
+    if (options = base['oneOf'])
+      merge_closest_match!(options, spec)
+
+      return base
+    end
+
     spec.each do |key, value|
       if base[key].is_a?(Hash) && value.is_a?(Hash)
         merge_schema!(base[key], value) unless base[key].key?('$ref')
@@ -67,4 +73,39 @@ class << RSpec::OpenAPI::SchemaMerger = Object.new
     all_parameters.uniq! { |param| param.slice('name', 'in') }
     base[key] = all_parameters
   end
+
+  SIMILARITY_THRESHOLD = 0.5
+
+  def merge_closest_match!(options, spec)
+    score, option = options.map { |option| [similarity(option, spec), option] }.max_by(&:first)
+
+    return if option&.key?('$ref')
+
+    if score.to_f > SIMILARITY_THRESHOLD
+      merge_schema!(option, spec)
+    else
+      options.push(spec)
+    end
+  end
+
+  def similarity(first, second)
+    return 1 if first == second
+
+    score =
+      case [first.class, second.class]
+      when [Array, Array]
+        (first & second).size / [first.size, second.size].max.to_f
+      when [Hash, Hash]
+        return 1 if first.merge(second).key?('$ref')
+
+        intersection = first.keys & second.keys
+        total_size = [first.size, second.size].max.to_f
+
+        intersection.sum { |key| similarity(first[key], second[key]) } / total_size
+      else
+        0
+      end
+
+    score.finite? ? score : 0
+  end
 end

data/lib/rspec/openapi/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module OpenAPI
-    VERSION = '0.11.0'
+    VERSION = '0.12.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Takashi Kokubun
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-13 00:00:00.000000000 Z
+date: 2024-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack