rspec-openapi 0.4.2 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a02d800d2c00b3cfec6a1a860f17eafaed45e51329aaa7407ed1e96892a10ac9
-  data.tar.gz: db0ec61540014497148d218846c01287d2b4f0e1ec4782148d932c5308ccbc75
+  metadata.gz: f962e8e048c5a935842a4d45896ead010b7e8bf0568161f8b9dddadd17b6c751
+  data.tar.gz: c4d0098e4f6a8c4d3a747b9045897627621085cf5c995d4129b099293dc99bdb
 SHA512:
-  metadata.gz: b357caa7a5b3f497a743ddf7be434ceb141e5de9b93d5995ac66e7d42abce47fddaa65f5f62f0ceffca4e4d42a40405c7b6d8190b4d2557148d633af1c9e289d
-  data.tar.gz: c8166a897c99f4b60747bc4c51f223c20627303fd6276c2e8e9a4908fee6287d43f1fb43135354ff7615f7c0cece8665c1b5a96da234e3598dbe311c1468d712
+  metadata.gz: 37626fc7ba17753cc589d76e68c1cafb2cb84039873985ca702b6439448303f62bb7527257aea1128db3b4bbd53cdd12f909c8a5aa40c9feccc2ab00ba27e16e
+  data.tar.gz: 2dacbbf2be2111fe1a80a8482e885b07b56a8e09f78b002d5b5e1ba15d7d109e02ee81f29ecc50ebbb7c6bd1a24c080e62d05e98d34f67cbb7120e1e3578c55f

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## v0.4.5
+
+- Fix linter issues for `tags` and `summary`
+  [#40](https://github.com/k0kubun/rspec-openapi/pull/40)
+
+## v0.4.4
+
+- De-duplicate parameters by a combination of `name` and `in`
+  [#39](https://github.com/k0kubun/rspec-openapi/pull/39)
+
+## v0.4.3
+
+* Allow customizing `schema`, `description`, and `tags` through `:openapi` metadata
+  [#36](https://github.com/k0kubun/rspec-openapi/pull/36)
+
 ## v0.4.2
 
 * Allow using Proc as `RSpec::OpenAPI.path`

data/README.md

@@ -172,6 +172,22 @@ RSpec.describe '/resources', type: :request do
 end
 ```
 
+## Customizations
+
+Some examples' attributes can be overwritten via RSpec metadata options. Example:
+
+```rb
+  describe 'GET /api/v1/posts', openapi: {
+    summary: 'list all posts',
+    description: 'list all posts ordered by pub_date',
+    tags: %w[v1 posts],
+  } do
+    # ...
+  end
+```
+
+**NOTE**: `description` key will override also the one provided by `RSpec::OpenAPI.description_builder` method.
+
 ## Links
 
 Existing RSpec plugins which have OpenAPI integration:

data/lib/rspec/openapi/record_builder.rb

@@ -20,8 +20,8 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
     if rails?
       route = find_rails_route(request)
       path = route.path.spec.to_s.delete_suffix('(.:format)')
-      summary = "#{route.requirements[:action]}"
-      tags = [route.requirements[:controller].classify]
+      summary = route.requirements[:action] || "#{request.method} #{path}"
+      tags = [route.requirements[:controller]&.classify].compact
     else
       path = request.path
       summary = "#{request.method} #{request.path}"
@@ -40,6 +40,8 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
       headers_arr << [header, header_value] if header_value
     end
 
+    metadata_options = example.metadata[:openapi] || {}
+
     RSpec::OpenAPI::Record.new(
       method: request.request_method,
       path: path,
@@ -48,9 +50,9 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
       request_params: raw_request_params(request),
       request_content_type: request.media_type,
       request_headers: request_headers,
-      summary: summary,
-      tags: tags,
-      description: RSpec::OpenAPI.description_builder.call(example),
+      summary: metadata_options[:summary] || summary,
+      tags: metadata_options[:tags] || tags,
+      description: metadata_options[:description] || RSpec::OpenAPI.description_builder.call(example),
       status: response.status,
       response_body: response_body,
       response_content_type: response.media_type,

data/lib/rspec/openapi/schema_merger.rb

@@ -21,9 +21,12 @@ class << RSpec::OpenAPI::SchemaMerger = Object.new
     end
   end
 
-  # Not doing `base.replace(deep_merge(base, spec))` to preserve key orders
+  # Not doing `base.replace(deep_merge(base, spec))` to preserve key orders.
+  # Also this needs to be aware of OpenAPI details unlike an ordinary deep_reverse_merge
+  # because a Hash-like structure may be an array whose Hash elements have a key name.
+  #
   # TODO: Perform more intelligent merges like rerouting edits / merging types
-  # Should we probably force-merge `summary` regardless of manual modifications?
+  # TODO: Should we probably force-merge `summary` regardless of manual modifications?
   def deep_reverse_merge!(base, spec)
     spec.each do |key, value|
       if base[key].is_a?(Hash) && value.is_a?(Hash)
@@ -31,9 +34,10 @@ class << RSpec::OpenAPI::SchemaMerger = Object.new
       elsif !base.key?(key)
         base[key] = value
       elsif base[key].is_a?(Array) && value.is_a?(Array)
-        if key == "parameters"
-          # merge arrays
+        # parameters need to be merged as if `name` and `in` were the Hash keys.
+        if key == 'parameters'
           base[key] |= value
+          base[key].uniq! { |param| param.slice('name', 'in') }
         end
       else
         # no-op

data/lib/rspec/openapi/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.4.2'
+    VERSION = '0.4.5'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.5
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-10 00:00:00.000000000 Z
+date: 2022-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -90,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs