rspec-openapi 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98be98f98f98819f1d1b018ad1a155184ebbe1c226b96414895acc0f60106b18
-  data.tar.gz: 6985138afe53b9223647f67d8802acdab580d737c18caec6b312d625d649d7c7
+  metadata.gz: a6a204535e3afe650434a20936c2d1ec34bc5136071cb76e48f1481b13629de8
+  data.tar.gz: d102d224884511c60d2b15030083d382d5c8da0bbbfa12dc3c293248456fd7ed
 SHA512:
-  metadata.gz: 13906efcf4d94054aea6c6132c09990bc99f264fc3fc37842f6d4d98515a5974f91a39cc3c7d749f0b2f24107e7fc9fb6bb94cfa6f3655fa0f13429101d17a20
-  data.tar.gz: 10ca07bb2370cf61dee4bdbc0d19d1194d64daf558813d8fff113868226a5d1ff6036f71071f58106492592e012ab999dc430976e1e5b7a4361dc36ec1bc5fb8
+  metadata.gz: 241b1dd789ae12fa853dc90b12cb497945dfc1bf4da0974a93d097c9f685ce6d585ddf08874a8dccfdec22467a8e47428e3a85a68ce847e8d306821b402b36fa
+  data.tar.gz: 60f6569f6d91262742732d45eacf8ef3192e201ddf91254b49fe00bdeada72ef05db02f3fcc61a817ed9ff54dc44a12fc45ffc4a1ee95e229f93c9e14b0e5b08

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-## Unreleased
+## v0.3.2
+
+* Stop generating format as path parameters in Rails
+  [#8](https://github.com/k0kubun/rspec-openapi/issues/8)
+
+## v0.3.1
 
 * Add `RSpec::OpenAPI.description_builder` config to dynamically generate a description [experimental]
   [#6](https://github.com/k0kubun/rspec-openapi/issues/6)

data/README.md

@@ -115,7 +115,7 @@ RSpec::OpenAPI.comment = <<~EOS
   update this file automatically. You can also manually edit this file.
 EOS
 
-# Generate a custom description, given a RSpec example
+# Generate a custom description, given an RSpec example
 RSpec::OpenAPI.description_builder = -> (example) { example.description }
 ```
 

data/lib/rspec/openapi/record_builder.rb

@@ -15,7 +15,7 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
     end
 
     # Generate `path` and `summary` in a framework-friendly manner when possible
-    if defined?(Rails) && Rails.application
+    if rails?
       route = find_rails_route(request)
       path = route.path.spec.to_s.delete_suffix('(.:format)')
       summary = "#{route.requirements[:controller]} ##{route.requirements[:action]}"
@@ -27,7 +27,7 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
     RSpec::OpenAPI::Record.new(
       method: request.request_method,
       path: path,
-      path_params: request.path_parameters,
+      path_params: raw_path_params(request),
       query_params: request.query_parameters,
       request_params: raw_request_params(request),
       request_content_type: request.content_type,
@@ -41,6 +41,10 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
 
   private
 
+  def rails?
+    defined?(Rails) && Rails.application
+  end
+
   def rack_test?(context)
     defined?(Rack::Test::Methods) && context.class < Rack::Test::Methods
   end
@@ -53,6 +57,17 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
     raise "No route matched for #{request.request_method} #{request.path_info}"
   end
 
+  # :controller and :action always exist. :format is added when routes is configured as such.
+  def raw_path_params(request)
+    if rails?
+      request.path_parameters.reject do |key, _value|
+        %i[controller action format].include?(key)
+      end
+    else
+      request.path_parameters
+    end
+  end
+
   # workaround to get real request parameters
   # because ActionController::ParamsWrapper overwrites request_parameters
   def raw_request_params(request)

data/lib/rspec/openapi/schema_builder.rb

@@ -36,7 +36,6 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
     parameters = []
 
     record.path_params.each do |key, value|
-      next if %i[controller action].include?(key)
       parameters << {
         name: key.to_s,
         in: 'path',

data/lib/rspec/openapi/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.3.1'
+    VERSION = '0.3.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-13 00:00:00.000000000 Z
+date: 2020-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack