rspec-openapi 0.18.2 → 0.18.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9d5e7e261220ae8c790eff0702c0d5e08dbf53667a410a1a540bdb4557d5f55
-  data.tar.gz: ffd9b3d5cab09166652fb03d1a22cf774170c6e80690ed4215e3483b951d8f73
+  metadata.gz: ec34ef0e56eb4c46221d956120a836d20addbfa8d636807effad4b93cf5ac8f8
+  data.tar.gz: 8b2c33feefc0f7173e6f31a09c66c9824b2f3f6124a24c6f56f59f7f5ff3e938
 SHA512:
-  metadata.gz: 007a4e0466e55fa656667eb498a0f27cd3b049dc8fb2d3a2b46b1b511fbe0f28fab3a79282577b0c5db08a55301576e8104013854fdf400884ab58d3312fba04
-  data.tar.gz: 39f0f78cfe88df09e7b16c540dc95890ac712feb7700df6f18101e5355540f21881f2905652c808422065f9330abfdd0c8f1037342192e5ee0b643fc71b65713
+  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/hanami.rb

@@ -19,10 +19,7 @@ class Inspector
   def call(verb, path)
     route = routes.find { |r| r.http_method == verb && r.path == path }
 
-    if route.nil?
-      # FIXME: This is a hack to pass `/sites/***` in testing
-      {}
-    elsif route.to.is_a?(Proc)
+    if route.to.is_a?(Proc)
       {
         tags: [],
         summary: "#{verb} #{path}",
@@ -55,7 +52,7 @@ class << RSpec::OpenAPI::Extractors::Hanami = Object.new
   # @param [RSpec::Core::Example] example
   # @return Array
   def request_attributes(request, example)
-    route = Hanami.app.router.recognize(request.path, method: request.method)
+    route = Hanami.app.router.recognize(Rack::MockRequest.env_for(request.path, method: request.method))
 
     return RSpec::OpenAPI::Extractors::Rack.request_attributes(request, example) unless route.routable?
 
@@ -69,7 +66,7 @@ class << RSpec::OpenAPI::Extractors::Hanami = Object.new
     deprecated = metadata[:deprecated]
     path = request.path
 
-    raw_path_params = route.params.filter { |_key, value| RSpec::OpenAPI::Extractors.number_or_nil(value) }
+    raw_path_params = route.params
 
     result = InspectorAnalyzer.call(request.method, add_id(path, route))
 
@@ -95,8 +92,6 @@ class << RSpec::OpenAPI::Extractors::Hanami = Object.new
     return path if route.params.empty?
 
     route.params.each_pair do |key, value|
-      next unless RSpec::OpenAPI::Extractors.number_or_nil(value)
-
       path = path.sub("/#{value}", "/:#{key}")
     end
 
@@ -107,8 +102,6 @@ class << RSpec::OpenAPI::Extractors::Hanami = Object.new
     return path if route.params.empty?
 
     route.params.each_pair do |key, value|
-      next unless RSpec::OpenAPI::Extractors.number_or_nil(value)
-
       path = path.sub("/#{value}", "/{#{key}}")
     end
 

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

@@ -2,11 +2,4 @@
 
 # Create namespace
 module RSpec::OpenAPI::Extractors
-  # @param [String, Symbol] path_parameter
-  # @return [Integer, nil]
-  def self.number_or_nil(path_parameter)
-    Integer(path_parameter.to_s || '')
-  rescue ArgumentError
-    nil
-  end
 end

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.2'
+    VERSION = '0.18.4'
   end
 end

data/lib/rspec/openapi.rb

@@ -15,30 +15,17 @@ 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
+module RSpec::OpenAPI
+  class Config
+    class << self
+      attr_accessor :debug_enabled
 
-  begin
-    require 'rails'
-  rescue LoadError
-    warn 'Rails not detected' if DEBUG_ENABLED
-  else
-    require 'rspec/openapi/extractors/rails'
+      def load_environment_settings
+        @debug_enabled = ['', '1', 'true'].include?(ENV['DEBUG']&.downcase)
+      end
+    end
   end
-end
 
-require 'rspec/openapi/minitest_hooks' if Object.const_defined?('Minitest')
-require 'rspec/openapi/rspec_hooks' if ENV['OPENAPI'] && Object.const_defined?('RSpec')
-
-module RSpec::OpenAPI
   @path = 'doc/openapi.yaml'
   @title = File.basename(Dir.pwd)
   @comment = nil
@@ -84,3 +71,26 @@ module RSpec::OpenAPI
     attr_reader   :config_filename
   end
 end
+
+if ENV['OPENAPI']
+  RSpec::OpenAPI::Config.load_environment_settings
+
+  begin
+    require 'hanami'
+  rescue LoadError
+    warn 'Hanami not detected' if RSpec::OpenAPI::Config.debug_enabled
+  else
+    require 'rspec/openapi/extractors/hanami'
+  end
+
+  begin
+    require 'rails'
+  rescue LoadError
+    warn 'Rails not detected' if RSpec::OpenAPI::Config.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')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.18.2
+  version: 0.18.4
 platform: ruby
 authors:
 - Takashi Kokubun
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-22 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.2
+  changelog_uri: https://github.com/exoego/rspec-openapi/releases/tag/v0.18.4
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []