rspec-openapi 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a48ebba5d2201f35bb94f47d5bd649444bb9c58ae1f0ef91f57e315553f9ef2
-  data.tar.gz: 71d4dec68449c2e14b4d3ce7058622b7c56629bee2814e04b1f16e5e817a7bf2
+  metadata.gz: a5139294ebac456aadd2c09832f55cb214b7bf4ba9893919445823455cbee18a
+  data.tar.gz: b77813ff2d18290e714482bfa45350f69b182a638162d083923acb9b21124cfe
 SHA512:
-  metadata.gz: 4c984f5dbd1a4587a9d34686c50e06a832051215f5e22abc8a96781ecebe57e0bdddabeef093db06f5bea23f58e70322a7574168f621e8765721ab2c2cf19c48
-  data.tar.gz: 2877daab4753106d04275e3189b8a8e648b7268a6c6d7e422e94d5bfb230064a2e875e73531abe6930bfa6c8b7cdefe7d06ee512cdcb4e22adb618915349514b
+  metadata.gz: 58de63dbf9608beb5f313eb57e6e1e4386eefa23fd1b572d17b06319f571ca3c6b1ac172a7886b3dcd42e14feb1f5f60ebd5a532951441193f8400d66e5229ce
+  data.tar.gz: 95765054acd231993f058a9f3a31a596c56ff143af9f1dc576bfb2f201773e611025329069b8c49751f50d3bf14b16a4f83ef863587d2f7815209f0afcdccb4a

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,15 @@
-## v0.11.0
+# THIS CHANGELOG IS DEPRECATED!!
+
+Refer https://github.com/exoego/rspec-openapi/releases instead.
+
+## v0.12.0
 
-## What's Changed
+- 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)
+
+## 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/minitest_hooks.rb

@@ -10,7 +10,7 @@ module RSpec::OpenAPI::Minitest
       result = super
       if ENV['OPENAPI'] && self.class.openapi?
         file_path = method(name).source_location.first
-        human_name = name.sub(/^test_/, '').gsub(/_/, ' ')
+        human_name = name.sub(/^test_/, '').gsub('_', ' ')
         example = Example.new(self, human_name, {}, file_path)
         path = RSpec::OpenAPI.path.yield_self { |p| p.is_a?(Proc) ? p.call(example) : p }
         record = RSpec::OpenAPI::RecordBuilder.build(self, example: example)

data/lib/rspec/openapi/record_builder.rb

@@ -48,7 +48,7 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
 
   def extract_headers(request, response)
     request_headers = RSpec::OpenAPI.request_headers.each_with_object([]) do |header, headers_arr|
-      header_key = header.gsub(/-/, '_').upcase
+      header_key = header.gsub('-', '_').upcase
       header_value = request.get_header(['HTTP', header_key].join('_')) || request.get_header(header_key)
       headers_arr << [header, header_value] if header_value
     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')
@@ -36,7 +42,8 @@ class << RSpec::OpenAPI::SchemaMerger = Object.new
         # parameters need to be merged as if `name` and `in` were the Hash keys.
         merge_arrays(base, key, value)
       else
-        base[key] = value
+        # do not ADD `properties` or `required` fields if `additionalProperties` field is present
+        base[key] = value unless base.key?('additionalProperties') && %w[properties required].include?(key)
       end
     end
     base
@@ -67,4 +74,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.13.0'
   end
 end

data/rspec-openapi.gemspec

@@ -14,9 +14,12 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
 
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = File.join(spec.homepage, 'blob/master/CHANGELOG.md')
+  spec.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/v#{RSpec::OpenAPI::VERSION}",
+    'rubygems_mfa_required' => 'true',
+  }
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.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-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -88,7 +88,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/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/exoego/rspec-openapi/releases/tag/v0.13.0
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []