rspec-openapi 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0fd8968099cf455a6ee1eabe6039c60955020493d97e584fb57b1ba79aca8d3
-  data.tar.gz: 15ae08318ba0843a65cbd4bf418b82f2ce9d7c173600f0ea2d776763f4790819
+  metadata.gz: a94cc7be13ab8a500bf3eb4bb5831f1c06c7722e96f9f7157e424fa402f2f137
+  data.tar.gz: db6591ab069d1f7bd1d7f07b6f2c4d9be9ef86f90df497c28a2b8ed01ee1d5e4
 SHA512:
-  metadata.gz: 2c15dc4a7d63f610cd654ea2718ffccbd15c59ec66bcc45f219352bdccbe7a6e49baa4810a866fefd483b34ec94992a7f48ce799d8cace7ced59f2dd5fb9db81
-  data.tar.gz: 9306ae8e95e9d4dcb0aa40d20b716217c2712ad081448c7f61cb832dd210864883c6f93999257715347fd85b5eb9f1d5ccb0615db3102de112fdfddebeb78318
+  metadata.gz: 785d100550f4ecde118a8986ee7c98349e310de9c870a04067a9f84892d37b63cadf9a88d0ff2158012c153c561c3a0576a3c0c79860a645bb53bb295c64bbc5
+  data.tar.gz: 660bd242fa8c5686bc6fbead56f595be959f1f1cae465723ed89e93c0b0096ee6c86094c8561193cabf119cedb74762e84e6b9c3651d34fca7691b63317fc611

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

@@ -25,7 +25,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v4
+      uses: actions/checkout@v5
 
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v3

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

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/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_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.20.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.20.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.20.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: []