rspec-openapi 0.18.3 → 0.18.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39da96c0f0b1650e0504d45a624be7905c9f47a2b128e992eecb5b05b828dd87
-  data.tar.gz: 5c6cb0fdaf3900ae93d0618c82b6762c8cf50002e7ac155c23a46b543f91d126
+  metadata.gz: ec34ef0e56eb4c46221d956120a836d20addbfa8d636807effad4b93cf5ac8f8
+  data.tar.gz: 8b2c33feefc0f7173e6f31a09c66c9824b2f3f6124a24c6f56f59f7f5ff3e938
 SHA512:
-  metadata.gz: df87ce7e2b08623ec314330020d011ede771872a435f11b266be1f1c1a2e24c8329559b1f3e42b50a58a86c442c0afed2e98444694138823b9b17ebb94e54878
-  data.tar.gz: c89fb952a0d8fbc4c5ed814bd11513d2323f2c5237ad0a7b0e341e2522c329a331230b51ecab3bcf42a60dd4e5da090a337202dac37db3d4f68ab82ad7a9f91b
+  metadata.gz: e2e12be8f18ac6e3c6641bb3b128bad631c120f4400148f999b758b1b2820b44dd047569036c1adc4393b001a438f2595aacf5869540411ec077c054a6b8d4c3
+  data.tar.gz: 347a1c54c418ad9957b3137b2d7db8c0c74496b473cdaf9f14dc9e4dab0205340e510317c324ff68494e237b27a369642d7cba2687b6eaa88318a70387557f37

data/.github/workflows/test.yml

@@ -38,7 +38,7 @@ jobs:
       - run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
         name: codecov-action@v4 workaround
       - name: Upload coverage reports
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5
         if: matrix.coverage == 'coverage'
         with:
           fail_ci_if_error: true

data/Gemfile

@@ -11,8 +11,12 @@ if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.0.0')
   gem 'hanami', ENV['HANAMI_VERSION'] || '2.1.0'
   gem 'hanami-controller', ENV['HANAMI_VERSION'] || '2.1.0'
   gem 'hanami-router', ENV['HANAMI_VERSION'] || '2.1.0'
+
+  gem 'dry-logger', '1.0.3'
 end
 
+gem 'concurrent-ruby', '1.3.4'
+
 gem 'roda'
 
 gem 'rails-dom-testing', '~> 2.2'

data/README.md

@@ -122,8 +122,18 @@ RSpec::OpenAPI.path = -> (example) {
   end
 }
 
+# Change the default title of the generated schema
 RSpec::OpenAPI.title = 'OpenAPI Documentation'
 
+# Or generate individual titles for your partial schema files, given an RSpec example
+RSpec::OpenAPI.title = -> (example) {
+  case example.file_path
+  when %r[spec/requests/api/v1/] then 'API v1 Documentation'
+  when %r[spec/requests/api/v2/] then 'API v2 Documentation'
+  else 'OpenAPI Documentation'
+  end
+}
+
 # Disable generating `example`
 RSpec::OpenAPI.enable_example = false
 

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

@@ -12,10 +12,10 @@ class << RSpec::OpenAPI::Extractors::Rails = Object.new
 
     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
 
+    raise "No route matched for #{fixed_request.request_method} #{fixed_request.path_info}" if route.nil?
+
     metadata = example.metadata[:openapi] || {}
     summary = metadata[:summary] || RSpec::OpenAPI.summary_builder.call(example)
     tags = metadata[:tags] || RSpec::OpenAPI.tags_builder.call(example)

data/lib/rspec/openapi/record.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 RSpec::OpenAPI::Record = Struct.new(
+  :title,                 # @param [String]  - "API Documentation - Statuses"
   :http_method,           # @param [String]  - "GET"
   :path,                  # @param [String]  - "/v1/status/:id"
   :path_params,           # @param [Hash]    - {:controller=>"v1/statuses", :action=>"create", :id=>"1"}

data/lib/rspec/openapi/record_builder.rb

@@ -11,6 +11,7 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
     request, response = extractor.request_response(context)
     return if request.nil?
 
+    title = RSpec::OpenAPI.title.then { |t| t.is_a?(Proc) ? t.call(example) : t }
     path, summary, tags, operation_id, required_request_params, raw_path_params, description, security, deprecated =
       extractor.request_attributes(request, example)
 
@@ -19,6 +20,7 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
     request_headers, response_headers = extract_headers(request, response)
 
     RSpec::OpenAPI::Record.new(
+      title: title,
       http_method: request.method,
       path: path,
       path_params: raw_path_params,

data/lib/rspec/openapi/result_recorder.rb

@@ -16,7 +16,7 @@ class RSpec::OpenAPI::ResultRecorder
         puts "WARNING: Unable to load #{config_file}: #{e}"
       end
 
-      title = RSpec::OpenAPI.title
+      title = records.first.title
       RSpec::OpenAPI::SchemaFile.new(path).edit do |spec|
         schema = RSpec::OpenAPI::DefaultSchema.build(title)
         schema[:info].merge!(RSpec::OpenAPI.info)

data/lib/rspec/openapi/schema_builder.rb

@@ -36,7 +36,7 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
             security: record.security,
             deprecated: record.deprecated ? true : nil,
             parameters: build_parameters(record),
-            requestBody: http_method == 'get' ? nil : build_request_body(record),
+            requestBody: include_nil_request_body?(http_method) ? nil : build_request_body(record),
             responses: {
               record.status.to_s => response,
             },
@@ -48,6 +48,10 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
 
   private
 
+  def include_nil_request_body?(http_method)
+    %w[delete get].include?(http_method)
+  end
+
   def enrich_with_required_keys(obj)
     obj[:required] = obj[:properties]&.keys || []
     obj

data/lib/rspec/openapi/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module OpenAPI
-    VERSION = '0.18.3'
+    VERSION = '0.18.4'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.18.3
+  version: 0.18.4
 platform: ruby
 authors:
 - Takashi Kokubun
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-01 00:00:00.000000000 Z
+date: 2025-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -109,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.18.3
+  changelog_uri: https://github.com/exoego/rspec-openapi/releases/tag/v0.18.4
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []