rspec-openapi 0.16.1 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c69f9d896be2ad115cb158175dbcf2c1cba9b6d08a7214d23a107a67ec5fc529
-  data.tar.gz: a5af92611c4b47790f165ce6d861bfdedd1214f5dcd9c5641e618f272fe5a7ca
+  metadata.gz: c6e2096ff66c70fb288c3a18a0a9e14c47908ce55963f1cd22a26fa676f86858
+  data.tar.gz: 1e2baa5f03c45f80b26647ef2c623bf9af4ae281fd4305c682112786d509ef44
 SHA512:
-  metadata.gz: 8e345e850fc539eb4e9fb018cdc48e7acadb47c774b47b438fcd1a95ebc680708999ae6d5440ee45f793bab47d27effd4e054fa3a08e25bf4e6956085effe9ea
-  data.tar.gz: b1f47ba0a95186141f38465ac4e6a89636185606c48b8a0a67b7f163934c18181ea59e4c7fe94e54291aa821f662ee726437f350f69f872399063b024f7cbfde
+  metadata.gz: 13be21458d7e45bb8c2cba02dc89e125efccc1c56a2f2cb44e18bd607e859634bf8174e7ad650c920254ef0c649453f0f6ac38e0ed20e33b689a80e4f457a41e
+  data.tar.gz: e77910efe4dfb113fab8f022a7333aa81f1aae36004715ffdeef93706e77921f639ee743f143829943259d6ba562441ebfeb8fa8ade8d653416b2c755c8ee7f8

data/.github/release.yaml

@@ -0,0 +1,24 @@
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+    authors:
+      - octocat
+  categories:
+    - title: 🛠 Breaking Changes
+      labels:
+        - semver-major
+        - breaking-change
+    - title: 🎉 Exciting New Features
+      labels:
+        - semver-minor
+        - enhancement
+    - title: 🐞 Bugfixes
+      labels:
+        - bug
+    - title: 📄 Documentation
+      labels:
+        - documentation
+    - title: 📦 Other Changes
+      labels:
+        - "*"

data/.github/workflows/test.yml

@@ -19,13 +19,12 @@ jobs:
           - ruby: ruby:2.7
           - ruby: ruby:3.0
           - ruby: ruby:3.1
-            rails: 6.0.5
           - ruby: ruby:3.1
-            rails: 6.1.6
+            rails: 6.1.7
           - ruby: ruby:3.1
-            rails: 7.0.3
+            rails: 7.0.8
           - ruby: ruby:3.3
-            rails: 7.1.2
+            rails: 7.1.3.2
             coverage: coverage
     env:
       RAILS_VERSION: ${{ matrix.rails == '' && '6.1.6' || matrix.rails }}

data/.rubocop_todo.yml

@@ -1,35 +1,35 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-04-01 14:13:50 UTC using RuboCop version 1.62.1.
+# on 2024-04-12 14:06:44 UTC using RuboCop version 1.62.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 11
+# Offense count: 13
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 49
+  Max: 47
 
-# Offense count: 2
+# Offense count: 1
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
   Max: 195
 
-# Offense count: 8
+# Offense count: 9
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
-  Max: 13
+  Max: 12
 
-# Offense count: 19
+# Offense count: 22
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 36
 
-# Offense count: 4
+# Offense count: 5
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
-  Max: 13
+  Max: 12
 
 # Offense count: 1
 # Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
@@ -39,7 +39,7 @@ Naming/VariableNumber:
   Exclude:
     - 'spec/integration_tests/roda_test.rb'
 
-# Offense count: 6
+# Offense count: 7
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Exclude:
@@ -49,3 +49,4 @@ Style/Documentation:
     - 'lib/rspec/openapi/minitest_hooks.rb'
     - 'lib/rspec/openapi/result_recorder.rb'
     - 'lib/rspec/openapi/schema_file.rb'
+    - 'lib/rspec/openapi/shared_hooks.rb'

data/Gemfile

@@ -5,7 +5,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in rspec-openapi.gemspec
 gemspec
 
-gem 'rails', ENV['RAILS_VERSION'] || '6.0.3.7'
+gem 'rails', ENV['RAILS_VERSION'] || '6.0.6.1'
 
 if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.0.0')
   gem 'hanami', ENV['HANAMI_VERSION'] || '2.1.0'

data/README.md

@@ -1,4 +1,4 @@
-# rspec-openapi [![Gem Version](https://badge.fury.io/rb/rspec-openapi.svg)](https://badge.fury.io/rb/rspec-openapi) [![test](https://github.com/exoego/rspec-openapi/actions/workflows/test.yml/badge.svg)](https://github.com/exoego/rspec-openapi/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/exoego/rspec-openapi/branch/master/graph/badge.svg?token=egYm6AlxkD)](https://codecov.io/gh/exoego/rspec-openapi)
+# rspec-openapi [![Gem Version](https://badge.fury.io/rb/rspec-openapi.svg)](https://rubygems.org/gems/rspec-openapi) [![test](https://github.com/exoego/rspec-openapi/actions/workflows/test.yml/badge.svg)](https://github.com/exoego/rspec-openapi/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/exoego/rspec-openapi/branch/master/graph/badge.svg?token=egYm6AlxkD)](https://codecov.io/gh/exoego/rspec-openapi) [![Ruby-toolbox](https://img.shields.io/badge/ruby-toolbox-a61414?cacheSeconds=31536000)](https://www.ruby-toolbox.com/projects/rspec-openapi)
 
 Generate OpenAPI schema from RSpec request specs.
 
@@ -97,7 +97,7 @@ paths:
 
 and the schema file can be used as an input of [Swagger UI](https://github.com/swagger-api/swagger-ui) or [Redoc](https://github.com/Redocly/redoc).
 
-![Redoc example](./spec/rails/doc/screenshot.png)
+![Redoc example](./spec/apps/rails/doc/screenshot.png)
 
 
 ### Configuration
@@ -190,6 +190,13 @@ RSpec::OpenAPI.ignored_path_params = %i[controller action format]
 # In that case, you can specify the paths to ignore.
 # String or Regexp is acceptable.
 RSpec::OpenAPI.ignored_paths = ["/admin/full/path/", Regexp.new("^/_internal/")]
+
+# Your custom post-processing hook (like unrandomizing IDs)
+RSpec::OpenAPI.post_process_hook = -> (path, records, spec) do
+  RSpec::OpenAPI::HashHelper.matched_paths(spec, 'paths.*.*.responses.*.content.*.*.*.id').each do |paths|
+    spec.dig(*paths[0..-2]).merge!(id: '123')
+  end
+end
 ```
 
 ### Can I use rspec-openapi with `$ref` to minimize duplication of schema?

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

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require 'dry/inflector'
+require 'hanami'
+
+# https://github.com/hanami/router/blob/97f75b8529574bd4ff23165460e82a6587bc323c/lib/hanami/router/inspector.rb#L13
+class Inspector
+  attr_accessor :routes, :inflector
+
+  def initialize(routes: [])
+    @routes = routes
+    @inflector = Dry::Inflector.new
+  end
+
+  def add_route(route)
+    routes.push(route)
+  end
+
+  def call(verb, path)
+    route = routes.find { |r| r.http_method == verb && r.path == path }
+
+    if route.to.is_a?(Proc)
+      {
+        tags: [],
+        summary: "#{verb} #{path}",
+      }
+    else
+      data = route.to.split('.')
+
+      {
+        tags: [inflector.classify(data[0])],
+        summary: data[1],
+      }
+    end
+  end
+end
+
+InspectorAnalyzer = Inspector.new
+
+# Add default parameter to load inspector before test cases run
+module InspectorAnalyzerPrepender
+  def router(inspector: InspectorAnalyzer)
+    super
+  end
+end
+
+Hanami::Slice::ClassMethods.prepend(InspectorAnalyzerPrepender)
+
+# Extractor for hanami
+class << RSpec::OpenAPI::Extractors::Hanami = Object.new
+  # @param [ActionDispatch::Request] request
+  # @param [RSpec::Core::Example] example
+  # @return Array
+  def request_attributes(request, example)
+    route = Hanami.app.router.recognize(request.path, method: request.method)
+
+    return RSpec::OpenAPI::Extractors::Rack.request_attributes(request, example) unless route.routable?
+
+    metadata = example.metadata[:openapi] || {}
+    summary = metadata[:summary] || RSpec::OpenAPI.summary_builder.call(example)
+    tags = metadata[:tags] || RSpec::OpenAPI.tags_builder.call(example)
+    operation_id = metadata[:operation_id]
+    required_request_params = metadata[:required_request_params] || []
+    security = metadata[:security]
+    description = metadata[:description] || RSpec::OpenAPI.description_builder.call(example)
+    deprecated = metadata[:deprecated]
+    path = request.path
+
+    raw_path_params = route.params.filter { |_key, value| number_or_nil(value) }
+
+    result = InspectorAnalyzer.call(request.method, add_id(path, route))
+
+    summary ||= result[:summary]
+    tags ||= result[:tags]
+    path = add_openapi_id(path, route)
+
+    raw_path_params = raw_path_params.slice(*(raw_path_params.keys - RSpec::OpenAPI.ignored_path_params))
+
+    [path, summary, tags, operation_id, required_request_params, raw_path_params, description, security, deprecated]
+  end
+
+  # @param [RSpec::ExampleGroups::*] context
+  def request_response(context)
+    request = ActionDispatch::Request.new(context.last_request.env)
+    request.body.rewind if request.body.respond_to?(:rewind)
+    response = ActionDispatch::TestResponse.new(*context.last_response.to_a)
+
+    [request, response]
+  end
+
+  def add_id(path, route)
+    return path if route.params.empty?
+
+    route.params.each_pair do |key, value|
+      next unless number_or_nil(value)
+
+      path = path.sub("/#{value}", "/:#{key}")
+    end
+
+    path
+  end
+
+  def add_openapi_id(path, route)
+    return path if route.params.empty?
+
+    route.params.each_pair do |key, value|
+      next unless number_or_nil(value)
+
+      path = path.sub("/#{value}", "/{#{key}}")
+    end
+
+    path
+  end
+
+  def number_or_nil(string)
+    Integer(string || '')
+  rescue ArgumentError
+    nil
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Extractor for rack
+class << RSpec::OpenAPI::Extractors::Rack = Object.new
+  # @param [ActionDispatch::Request] request
+  # @param [RSpec::Core::Example] example
+  # @return Array
+  def request_attributes(request, example)
+    metadata = example.metadata[:openapi] || {}
+    summary = metadata[:summary] || RSpec::OpenAPI.summary_builder.call(example)
+    tags = metadata[:tags] || RSpec::OpenAPI.tags_builder.call(example)
+    operation_id = metadata[:operation_id]
+    required_request_params = metadata[:required_request_params] || []
+    security = metadata[:security]
+    description = metadata[:description] || RSpec::OpenAPI.description_builder.call(example)
+    deprecated = metadata[:deprecated]
+    raw_path_params = request.path_parameters
+    path = request.path
+    summary ||= "#{request.method} #{path}"
+    [path, summary, tags, operation_id, required_request_params, raw_path_params, description, security, deprecated]
+  end
+
+  # @param [RSpec::ExampleGroups::*] context
+  def request_response(context)
+    request = ActionDispatch::Request.new(context.last_request.env)
+    request.body.rewind if request.body.respond_to?(:rewind)
+    response = ActionDispatch::TestResponse.new(*context.last_response.to_a)
+
+    [request, response]
+  end
+end

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+# Extractor for rails
+class << RSpec::OpenAPI::Extractors::Rails = Object.new
+  # @param [ActionDispatch::Request] request
+  # @param [RSpec::Core::Example] example
+  # @return Array
+  def request_attributes(request, example)
+    # Reverse the destructive modification by Rails https://github.com/rails/rails/blob/v6.0.3.4/actionpack/lib/action_dispatch/journey/router.rb#L33-L41
+    fixed_request = request.dup
+    fixed_request.path_info = File.join(request.script_name, request.path_info) if request.script_name.present?
+
+    route, path = find_rails_route(fixed_request)
+
+    raise "No route matched for #{fixed_request.request_method} #{fixed_request.path_info}" if route.nil?
+
+    return RSpec::OpenAPI::Extractors::Rack.request_attributes(request, example) unless path
+
+    metadata = example.metadata[:openapi] || {}
+    summary = metadata[:summary] || RSpec::OpenAPI.summary_builder.call(example)
+    tags = metadata[:tags] || RSpec::OpenAPI.tags_builder.call(example)
+    operation_id = metadata[:operation_id]
+    required_request_params = metadata[:required_request_params] || []
+    security = metadata[:security]
+    description = metadata[:description] || RSpec::OpenAPI.description_builder.call(example)
+    deprecated = metadata[:deprecated]
+    raw_path_params = request.path_parameters
+
+    summary ||= route.requirements[:action]
+    tags ||= [route.requirements[:controller]&.classify].compact
+    # :controller and :action always exist. :format is added when routes is configured as such.
+    # TODO: Use .except(:controller, :action, :format) when we drop support for Ruby 2.x
+    raw_path_params = raw_path_params.slice(*(raw_path_params.keys - RSpec::OpenAPI.ignored_path_params))
+
+    summary ||= "#{request.method} #{path}"
+
+    [path, summary, tags, operation_id, required_request_params, raw_path_params, description, security, deprecated]
+  end
+
+  # @param [RSpec::ExampleGroups::*] context
+  def request_response(context)
+    [context.request, context.response]
+  end
+
+  # @param [ActionDispatch::Request] request
+  def find_rails_route(request, app: Rails.application, path_prefix: '')
+    app.routes.router.recognize(request) do |route, parameters|
+      path = route.path.spec.to_s.delete_suffix('(.:format)')
+
+      if route.app.matches?(request)
+        if route.app.engine?
+          route, path = find_rails_route(request, app: route.app.app, path_prefix: path)
+          next if route.nil?
+        elsif path_prefix + path == add_id(request.path, parameters)
+          return [route, path_prefix + path]
+        else
+          return [route, nil]
+        end
+        return [route, path_prefix + path]
+      end
+    end
+
+    nil
+  end
+
+  def add_id(path, parameters)
+    parameters.each_pair do |key, value|
+      next unless number_or_nil(value)
+
+      path = path.sub("/#{value}", "/:#{key}")
+    end
+
+    path
+  end
+
+  def number_or_nil(string)
+    Integer(string || '')
+  rescue ArgumentError
+    nil
+  end
+end

data/lib/rspec/openapi/extractors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# Create namespace
+module RSpec::OpenAPI::Extractors
+end

data/lib/rspec/openapi/minitest_hooks.rb

@@ -13,7 +13,7 @@ module RSpec::OpenAPI::Minitest
         human_name = name.sub(/^test_/, '').gsub('_', ' ')
         example = Example.new(self, human_name, {}, file_path)
         path = RSpec::OpenAPI.path.then { |p| p.is_a?(Proc) ? p.call(example) : p }
-        record = RSpec::OpenAPI::RecordBuilder.build(self, example: example)
+        record = RSpec::OpenAPI::RecordBuilder.build(self, example: example, extractor: SharedHooks.find_extractor)
         RSpec::OpenAPI.path_records[path] << record if record
       end
       result

data/lib/rspec/openapi/record_builder.rb

@@ -7,12 +7,12 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
   # @param [RSpec::ExampleGroups::*] context
   # @param [RSpec::Core::Example] example
   # @return [RSpec::OpenAPI::Record,nil]
-  def build(context, example:)
-    request, response = extract_request_response(context)
+  def build(context, example:, extractor:)
+    request, response = extractor.request_response(context)
     return if request.nil?
 
     path, summary, tags, operation_id, required_request_params, raw_path_params, description, security, deprecated =
-      extract_request_attributes(request, example)
+      extractor.request_attributes(request, example)
 
     return if RSpec::OpenAPI.ignored_paths.any? { |ignored_path| path.match?(ignored_path) }
 
@@ -69,71 +69,6 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
     [request_headers, response_headers]
   end
 
-  def extract_request_attributes(request, example)
-    metadata = example.metadata[:openapi] || {}
-    summary = metadata[:summary] || RSpec::OpenAPI.summary_builder.call(example)
-    tags = metadata[:tags] || RSpec::OpenAPI.tags_builder.call(example)
-    operation_id = metadata[:operation_id]
-    required_request_params = metadata[:required_request_params] || []
-    security = metadata[:security]
-    description = metadata[:description] || RSpec::OpenAPI.description_builder.call(example)
-    deprecated = metadata[:deprecated]
-    raw_path_params = request.path_parameters
-    path = request.path
-    if rails?
-      # Reverse the destructive modification by Rails https://github.com/rails/rails/blob/v6.0.3.4/actionpack/lib/action_dispatch/journey/router.rb#L33-L41
-      fixed_request = request.dup
-      fixed_request.path_info = File.join(request.script_name, request.path_info) if request.script_name.present?
-
-      route, path = find_rails_route(fixed_request)
-      raise "No route matched for #{fixed_request.request_method} #{fixed_request.path_info}" if route.nil?
-
-      path = path.delete_suffix('(.:format)')
-      summary ||= route.requirements[:action]
-      tags ||= [route.requirements[:controller]&.classify].compact
-      # :controller and :action always exist. :format is added when routes is configured as such.
-      # TODO: Use .except(:controller, :action, :format) when we drop support for Ruby 2.x
-      raw_path_params = raw_path_params.slice(*(raw_path_params.keys - RSpec::OpenAPI.ignored_path_params))
-    end
-    summary ||= "#{request.method} #{path}"
-    [path, summary, tags, operation_id, required_request_params, raw_path_params, description, security, deprecated]
-  end
-
-  def extract_request_response(context)
-    if rack_test?(context)
-      request = ActionDispatch::Request.new(context.last_request.env)
-      request.body.rewind if request.body.respond_to?(:rewind)
-      response = ActionDispatch::TestResponse.new(*context.last_response.to_a)
-    else
-      request = context.request
-      response = context.response
-    end
-    [request, response]
-  end
-
-  def rails?
-    defined?(Rails) && Rails.respond_to?(:application) && Rails.application
-  end
-
-  def rack_test?(context)
-    defined?(Rack::Test::Methods) && context.class < Rack::Test::Methods
-  end
-
-  # @param [ActionDispatch::Request] request
-  def find_rails_route(request, app: Rails.application, path_prefix: '')
-    app.routes.router.recognize(request) do |route|
-      path = route.path.spec.to_s
-      if route.app.matches?(request)
-        if route.app.engine?
-          route, path = find_rails_route(request, app: route.app.app, path_prefix: path)
-          next if route.nil?
-        end
-        return [route, path_prefix + path]
-      end
-    end
-    nil
-  end
-
   # workaround to get real request parameters
   # because ActionController::ParamsWrapper overwrites request_parameters
   def raw_request_params(request)

data/lib/rspec/openapi/result_recorder.rb

@@ -29,11 +29,8 @@ class RSpec::OpenAPI::ResultRecorder
         rescue StandardError, NotImplementedError => e # e.g. SchemaBuilder raises a NotImplementedError
           @error_records[e] = record # Avoid failing the build
         end
-        RSpec::OpenAPI::SchemaCleaner.cleanup_conflicting_security_parameters!(spec)
-        RSpec::OpenAPI::SchemaCleaner.cleanup!(spec, new_from_zero)
-        RSpec::OpenAPI::ComponentsUpdater.update!(spec, new_from_zero)
-        RSpec::OpenAPI::SchemaCleaner.cleanup_empty_required_array!(spec)
-        RSpec::OpenAPI::SchemaSorter.deep_sort!(spec)
+        cleanup_schema!(new_from_zero, spec)
+        execute_post_process_hook(path, records, spec)
       end
     end
   end
@@ -49,4 +46,18 @@ class RSpec::OpenAPI::ResultRecorder
       #{@error_records.map { |e, record| "#{e.inspect}: #{record.inspect}" }.join("\n")}
     ERR_MSG
   end
+
+  private
+
+  def execute_post_process_hook(path, records, spec)
+    RSpec::OpenAPI.post_process_hook.call(path, records, spec) if RSpec::OpenAPI.post_process_hook.is_a?(Proc)
+  end
+
+  def cleanup_schema!(new_from_zero, spec)
+    RSpec::OpenAPI::SchemaCleaner.cleanup_conflicting_security_parameters!(spec)
+    RSpec::OpenAPI::SchemaCleaner.cleanup!(spec, new_from_zero)
+    RSpec::OpenAPI::ComponentsUpdater.update!(spec, new_from_zero)
+    RSpec::OpenAPI::SchemaCleaner.cleanup_empty_required_array!(spec)
+    RSpec::OpenAPI::SchemaSorter.deep_sort!(spec)
+  end
 end

data/lib/rspec/openapi/rspec_hooks.rb

@@ -5,7 +5,7 @@ require 'rspec/core'
 RSpec.configuration.after(:each) do |example|
   if RSpec::OpenAPI.example_types.include?(example.metadata[:type]) && example.metadata[:openapi] != false
     path = RSpec::OpenAPI.path.then { |p| p.is_a?(Proc) ? p.call(example) : p }
-    record = RSpec::OpenAPI::RecordBuilder.build(self, example: example)
+    record = RSpec::OpenAPI::RecordBuilder.build(self, example: example, extractor: SharedHooks.find_extractor)
     RSpec::OpenAPI.path_records[path] << record if record
   end
 end

data/lib/rspec/openapi/schema_builder.rb

@@ -64,10 +64,8 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
   end
 
   def build_parameters(record)
-    parameters = []
-
-    record.path_params.each do |key, value|
-      parameters << {
+    path_params = record.path_params.map do |key, value|
+      {
         name: build_parameter_name(key, value),
         in: 'path',
         required: true,
@@ -76,8 +74,8 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
       }.compact
     end
 
-    record.query_params.each do |key, value|
-      parameters << {
+    query_params = record.query_params.map do |key, value|
+      {
         name: build_parameter_name(key, value),
         in: 'query',
         required: record.required_request_params.include?(key),
@@ -86,8 +84,8 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
       }.compact
     end
 
-    record.request_headers.each do |key, value|
-      parameters << {
+    header_params = record.request_headers.map do |key, value|
+      {
         name: build_parameter_name(key, value),
         in: 'header',
         required: true,
@@ -96,6 +94,8 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
       }.compact
     end
 
+    parameters = path_params + query_params + header_params
+
     return nil if parameters.empty?
 
     parameters

data/lib/rspec/openapi/shared_hooks.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SharedHooks
+  def self.find_extractor
+    if defined?(Rails) && Rails.respond_to?(:application) && Rails.application
+      RSpec::OpenAPI::Extractors::Rails
+    elsif defined?(Hanami) && Hanami.respond_to?(:app) && Hanami.app?
+      RSpec::OpenAPI::Extractors::Hanami
+      # elsif defined?(Roda)
+      #   some Roda extractor
+    else
+      RSpec::OpenAPI::Extractors::Rack
+    end
+  end
+end

data/lib/rspec/openapi/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module OpenAPI
-    VERSION = '0.16.1'
+    VERSION = '0.18.0'
   end
 end

data/lib/rspec/openapi.rb

@@ -11,6 +11,29 @@ require 'rspec/openapi/schema_merger'
 require 'rspec/openapi/schema_cleaner'
 require 'rspec/openapi/schema_sorter'
 require 'rspec/openapi/key_transformer'
+require 'rspec/openapi/shared_hooks'
+require 'rspec/openapi/extractors'
+require 'rspec/openapi/extractors/rack'
+
+if ENV['OPENAPI']
+  DEBUG_ENABLED = ['', '1', 'true'].include?(ENV['DEBUG']&.downcase)
+
+  begin
+    require 'hanami'
+  rescue LoadError
+    warn 'Hanami not detected' if DEBUG_ENABLED
+  else
+    require 'rspec/openapi/extractors/hanami'
+  end
+
+  begin
+    require 'rails'
+  rescue LoadError
+    warn 'Rails not detected' if DEBUG_ENABLED
+  else
+    require 'rspec/openapi/extractors/rails'
+  end
+end
 
 require 'rspec/openapi/minitest_hooks' if Object.const_defined?('Minitest')
 require 'rspec/openapi/rspec_hooks' if ENV['OPENAPI'] && Object.const_defined?('RSpec')
@@ -33,6 +56,7 @@ module RSpec::OpenAPI
   @path_records = Hash.new { |h, k| h[k] = [] }
   @ignored_path_params = %i[controller action format]
   @ignored_paths = []
+  @post_process_hook = nil
 
   # This is the configuraion override file name we look for within each path.
   @config_filename = 'rspec_openapi.rb'
@@ -54,7 +78,8 @@ module RSpec::OpenAPI
                   :response_headers,
                   :path_records,
                   :ignored_paths,
-                  :ignored_path_params
+                  :ignored_path_params,
+                  :post_process_hook
 
     attr_reader   :config_filename
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.16.1
+  version: 0.18.0
 platform: ruby
 authors:
 - Takashi Kokubun
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-01 00:00:00.000000000 Z
+date: 2024-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -62,6 +62,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/dependabot.yml"
+- ".github/release.yaml"
 - ".github/workflows/codeql-analysis.yml"
 - ".github/workflows/rubocop.yml"
 - ".github/workflows/test.yml"
@@ -80,6 +81,10 @@ files:
 - lib/rspec/openapi.rb
 - lib/rspec/openapi/components_updater.rb
 - lib/rspec/openapi/default_schema.rb
+- lib/rspec/openapi/extractors.rb
+- lib/rspec/openapi/extractors/hanami.rb
+- lib/rspec/openapi/extractors/rack.rb
+- lib/rspec/openapi/extractors/rails.rb
 - lib/rspec/openapi/hash_helper.rb
 - lib/rspec/openapi/key_transformer.rb
 - lib/rspec/openapi/minitest_hooks.rb
@@ -92,6 +97,7 @@ files:
 - lib/rspec/openapi/schema_file.rb
 - lib/rspec/openapi/schema_merger.rb
 - lib/rspec/openapi/schema_sorter.rb
+- lib/rspec/openapi/shared_hooks.rb
 - lib/rspec/openapi/version.rb
 - rspec-openapi.gemspec
 - scripts/rspec
@@ -103,7 +109,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.16.1
+  changelog_uri: https://github.com/exoego/rspec-openapi/releases/tag/v0.18.0
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []