rspec-openapi 0.19.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0fd8968099cf455a6ee1eabe6039c60955020493d97e584fb57b1ba79aca8d3
-  data.tar.gz: 15ae08318ba0843a65cbd4bf418b82f2ce9d7c173600f0ea2d776763f4790819
+  metadata.gz: 6b40fcb7598d29cf3c8bf2f95f6aafb5a011ddbb2beff06d6366052d11effa02
+  data.tar.gz: 85bd479d5b7e4da9e19dcc8bbbb963a594eed99437cb911a965695d04768a4bd
 SHA512:
-  metadata.gz: 2c15dc4a7d63f610cd654ea2718ffccbd15c59ec66bcc45f219352bdccbe7a6e49baa4810a866fefd483b34ec94992a7f48ce799d8cace7ced59f2dd5fb9db81
-  data.tar.gz: 9306ae8e95e9d4dcb0aa40d20b716217c2712ad081448c7f61cb832dd210864883c6f93999257715347fd85b5eb9f1d5ccb0615db3102de112fdfddebeb78318
+  metadata.gz: 89c7e3788cfccd022711d1ce76be3ee1b1568af4bade87908afb3384e64e88714a0d4b30499f0eeebb45909fe5eab5267c96afc231ea1db60a6b2fe8fc0155d6
+  data.tar.gz: 71e418493c5f3db1c8a5388bd2826fe36e15375445d3ddc7c1b2364cdfb7d160cdf3c9b02554e6134abf82e0f994355b725223c773857fb034e3b7eb034c2db7

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

@@ -25,15 +25,15 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v4
+      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

@@ -14,7 +14,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v4
+      uses: actions/checkout@v5
 
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
@@ -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/.github/workflows/test.yml

@@ -32,7 +32,7 @@ jobs:
       RAILS_VERSION: ${{ matrix.rails == '' && '6.1.6' || matrix.rails }}
       COVERAGE: ${{ matrix.coverage || '' }}
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: bundle install
         run: bundle install -j$(nproc) --retry 3
       - run: bundle exec rspec

data/.gitignore

@@ -10,3 +10,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+spec/apps/rails/log/

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/extractors/hanami.rb

@@ -56,7 +56,7 @@ class << RSpec::OpenAPI::Extractors::Hanami = Object.new
 
     return RSpec::OpenAPI::Extractors::Rack.request_attributes(request, example) unless route.routable?
 
-    metadata = example.metadata[:openapi] || {}
+    metadata = merge_openapi_metadata(example.metadata)
     summary = metadata[:summary] || RSpec::OpenAPI.summary_builder.call(example)
     tags = metadata[:tags] || RSpec::OpenAPI.tags_builder.call(example)
     formats = metadata[:formats] || RSpec::OpenAPI.formats_builder.curry.call(example)
@@ -100,6 +100,26 @@ class << RSpec::OpenAPI::Extractors::Hanami = Object.new
     [request, response]
   end
 
+  private
+
+  def merge_openapi_metadata(metadata)
+    collect_openapi_metadata(metadata).reduce({}, &:merge)
+  end
+
+  def collect_openapi_metadata(metadata)
+    [].tap do |result|
+      current = metadata
+
+      while current
+        [current[:example_group], current].each do |meta|
+          result.unshift(meta[:openapi]) if meta&.dig(:openapi)
+        end
+
+        current = current[:parent_example_group]
+      end
+    end
+  end
+
   def add_id(path, route)
     return path if route.params.empty?
 

data/lib/rspec/openapi/extractors/rack.rb

@@ -6,7 +6,7 @@ class << RSpec::OpenAPI::Extractors::Rack = Object.new
   # @param [RSpec::Core::Example] example
   # @return Array
   def request_attributes(request, example)
-    metadata = example.metadata[:openapi] || {}
+    metadata = merge_openapi_metadata(example.metadata)
     summary = metadata[:summary] || RSpec::OpenAPI.summary_builder.call(example)
     tags = metadata[:tags] || RSpec::OpenAPI.tags_builder.call(example)
     formats = metadata[:formats] || RSpec::OpenAPI.formats_builder.curry.call(example)
@@ -40,4 +40,24 @@ class << RSpec::OpenAPI::Extractors::Rack = Object.new
 
     [request, response]
   end
+
+  private
+
+  def merge_openapi_metadata(metadata)
+    collect_openapi_metadata(metadata).reduce({}, &:merge)
+  end
+
+  def collect_openapi_metadata(metadata)
+    [].tap do |result|
+      current = metadata
+
+      while current
+        [current[:example_group], current].each do |meta|
+          result.unshift(meta[:openapi]) if meta&.dig(:openapi)
+        end
+
+        current = current[:parent_example_group]
+      end
+    end
+  end
 end

data/lib/rspec/openapi/extractors/rails.rb

@@ -16,7 +16,7 @@ class << RSpec::OpenAPI::Extractors::Rails = Object.new
 
     raise "No route matched for #{fixed_request.request_method} #{fixed_request.path_info}" if route.nil?
 
-    metadata = example.metadata[:openapi] || {}
+    metadata = merge_openapi_metadata(example.metadata)
     summary = metadata[:summary] || RSpec::OpenAPI.summary_builder.call(example)
     tags = metadata[:tags] || RSpec::OpenAPI.tags_builder.call(example)
     formats = metadata[:formats] || RSpec::OpenAPI.formats_builder.curry.call(example)
@@ -55,6 +55,26 @@ class << RSpec::OpenAPI::Extractors::Rails = Object.new
     [context.request, context.response]
   end
 
+  private
+
+  def merge_openapi_metadata(metadata)
+    collect_openapi_metadata(metadata).reduce({}, &:merge)
+  end
+
+  def collect_openapi_metadata(metadata)
+    [].tap do |result|
+      current = metadata
+
+      while current
+        [current[:example_group], current].each do |meta|
+          result.unshift(meta[:openapi]) if meta&.dig(:openapi)
+        end
+
+        current = current[:parent_example_group]
+      end
+    end
+  end
+
   # @param [ActionDispatch::Request] request
   def find_rails_route(request, app: Rails.application, path_prefix: '')
     app.routes.router.recognize(request) do |route, _parameters|

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,72 @@ 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?
+
+    merged_schema = build_property(array.first, record: record)
+
+    # 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)
+      end
+    end
+
+    merged_schema
+  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_file.rb

@@ -4,6 +4,9 @@ require 'fileutils'
 require 'yaml'
 require 'json'
 
+# For Ruby 2.7
+require 'date'
+
 # TODO: Support JSON
 class RSpec::OpenAPI::SchemaFile
   # @param [String] path
@@ -24,7 +27,12 @@ class RSpec::OpenAPI::SchemaFile
   def read
     return {} unless File.exist?(@path)
 
-    RSpec::OpenAPI::KeyTransformer.symbolize(YAML.safe_load(File.read(@path))) # this can also parse JSON
+    RSpec::OpenAPI::KeyTransformer.symbolize(
+      YAML.safe_load(
+        File.read(@path),
+        permitted_classes: [Date, Time],
+      ),
+    ) # this can also parse JSON
   end
 
   # @param [Hash] spec

data/lib/rspec/openapi/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module OpenAPI
-    VERSION = '0.19.0'
+    VERSION = '0.21.0'
   end
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Takashi Kokubun
 - TATSUNO Yasuhiro
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -109,9 +108,8 @@ 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.19.0
+  changelog_uri: https://github.com/exoego/rspec-openapi/releases/tag/v0.21.0
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -126,8 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs
 test_files: []