rspec-openapi 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '04058c6bcfd8f9ec499d5c7eb82da1e1123bfd9a666056384cda5a39aa70e4b7'
-  data.tar.gz: a4df891dbf2ba621f1cf3a78dbfcaab22da75583a40ea974935ad6e9aad1dfa0
+  metadata.gz: c6e2096ff66c70fb288c3a18a0a9e14c47908ce55963f1cd22a26fa676f86858
+  data.tar.gz: 1e2baa5f03c45f80b26647ef2c623bf9af4ae281fd4305c682112786d509ef44
 SHA512:
-  metadata.gz: 9764345746f2c8133a18580eb1dffcf97709dd6e077b86e326f62604daffc856fd0c67e2735c7e8dbc16ae56828d9d3d9222cbc75f2f4a2e63789308df6ea4fd
-  data.tar.gz: e54bf06b9d2bd91952b56e91cc2cfcbae1cfb0998ab00a7019c4176b114a3652ef3e3323bf922530c2cf8e207742df6ff6fb6764be680ba8db7a8910bf260cdc
+  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/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/lib/rspec/openapi/extractors/hanami.rb

@@ -48,10 +48,14 @@ Hanami::Slice::ClassMethods.prepend(InspectorAnalyzerPrepender)
 
 # Extractor for hanami
 class << RSpec::OpenAPI::Extractors::Hanami = Object.new
-  # @param [RSpec::ExampleGroups::*] context
+  # @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)
@@ -62,8 +66,6 @@ class << RSpec::OpenAPI::Extractors::Hanami = Object.new
     deprecated = metadata[:deprecated]
     path = request.path
 
-    route = Hanami.app.router.recognize(request.path, method: request.method)
-
     raw_path_params = route.params.filter { |_key, value| number_or_nil(value) }
 
     result = InspectorAnalyzer.call(request.method, add_id(path, route))

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

@@ -2,7 +2,7 @@
 
 # Extractor for rack
 class << RSpec::OpenAPI::Extractors::Rack = Object.new
-  # @param [RSpec::ExampleGroups::*] context
+  # @param [ActionDispatch::Request] request
   # @param [RSpec::Core::Example] example
   # @return Array
   def request_attributes(request, example)

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

@@ -2,10 +2,20 @@
 
 # Extractor for rails
 class << RSpec::OpenAPI::Extractors::Rails = Object.new
-  # @param [RSpec::ExampleGroups::*] context
+  # @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)
@@ -16,14 +26,6 @@ class << RSpec::OpenAPI::Extractors::Rails = Object.new
     deprecated = metadata[:deprecated]
     raw_path_params = request.path_parameters
 
-    # 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.
@@ -42,12 +44,17 @@ class << RSpec::OpenAPI::Extractors::Rails = Object.new
 
   # @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
+    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
@@ -55,4 +62,20 @@ class << RSpec::OpenAPI::Extractors::Rails = Object.new
 
     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/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/version.rb

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

data/lib/rspec/openapi.rb

@@ -15,18 +15,24 @@ require 'rspec/openapi/shared_hooks'
 require 'rspec/openapi/extractors'
 require 'rspec/openapi/extractors/rack'
 
-begin
-  require 'hanami'
-  require 'rspec/openapi/extractors/hanami'
-rescue LoadError
-  puts 'Hanami not detected'
-end
+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'
-  require 'rspec/openapi/extractors/rails'
-rescue LoadError
-  puts 'Rails not detected'
+  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')

metadata

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