rspec-openapi 0.4.1 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3032d3fed3b9bdc2b2a8512db3d1645679163539106650c1ad05069a15ab59cd
-  data.tar.gz: d1d3e85b467226a857b30bfe95b5643a1a37df2c0a925e509bdd893ae3017177
+  metadata.gz: 78fd09cf0ef8419c47bd5b9f8f225260b83f700fcfcb23a2515c50e341832961
+  data.tar.gz: f1895433af3d0a5ee6b065f1e4bbc92bdd4707749480a95b307b685132206bc3
 SHA512:
-  metadata.gz: 0c65c74db1ada24cf360545bda34830ca82d9cbd11b6e862a0563f9fc2bf244d65a96ec74e8223c182d1a2bff72b237e30c5884c2818576f9c142585d177351b
-  data.tar.gz: 397cfcddeaf3c1f683b9a1cd75960bf7d61e24adfcc9988bea2533c7a781acd42f43178b2ffb45deb5b3e821090f979d18af041a078f9ca3c2c7cd124cb4aff2
+  metadata.gz: ae459f44e0471afec512959b999b47fa23b3144efd9272d140a47af6a65ec4f40c234b1f317d197610952263225e247505f8febca1901fe094ebd74b5c8e27b4
+  data.tar.gz: a74f8c5a3121ecbff640c40eccd0f420ae2869b676fdb592411c13e7fddfbfb13fd31c96b9d1ea1e73578c9007c3e78f34dda9bcb820ae4f67b9db5d209fbad7

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 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`
+  [#35](https://github.com/k0kubun/rspec-openapi/pull/35)
+
 ## v0.4.1
 
 * Add `RSpec::OpenAPI.example_types` to hook types other than `type: :request`.

data/README.md

@@ -24,7 +24,7 @@ gem 'rspec-openapi', group: :test
 Run rspec with OPENAPI=1 to generate `doc/openapi.yaml` for your request specs.
 
 ```bash
-$ OPENAPI=1 rspec
+$ OPENAPI=1 bundle exec rspec
 ```
 
 ### Example
@@ -111,6 +111,15 @@ RSpec::OpenAPI.path = 'doc/schema.yaml'
 # Change the output type to JSON
 RSpec::OpenAPI.path = 'doc/schema.json'
 
+# Or generate multiple partial schema files, given an RSpec example
+RSpec::OpenAPI.path = -> (example) {
+  case example.file_path
+  when %r[spec/requests/api/v1/] then 'doc/openapi/v1.yaml'
+  when %r[spec/requests/api/v2/] then 'doc/openapi/v2.yaml'
+  else 'doc/openapi.yaml'
+  end
+}
+
 # Disable generating `example`
 RSpec::OpenAPI.enable_example = false
 
@@ -163,22 +172,21 @@ RSpec.describe '/resources', type: :request do
 end
 ```
 
-## Project status
+## Customizations
 
-Beta
+Some examples' attributes can be overwritten via RSpec metadata options. Example:
 
-Basic features are there, and some people are already using this.
-
-### Other missing features with notes
+```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
+```
 
-* Delete obsoleted endpoints
-  * Give up, or at least make the feature optional?
-  * Running all to detect obsoleted endpoints is sometimes not realistic anyway.
-* Intelligent merges
-  * To maintain both automated changes and manual edits, the schema merge needs to be intelligent.
-  * We'll just deep-reverse-merge schema for now, but if there's a $ref for example, modifications
-    there should be rerouted to the referenced object.
-  * A type could be an array of all possible types when merged.
+**NOTE**: `description` key will override also the one provided by `RSpec::OpenAPI.description_builder` method.
 
 ## Links
 

data/lib/rspec/openapi/hooks.rb

@@ -5,34 +5,36 @@ require 'rspec/openapi/schema_builder'
 require 'rspec/openapi/schema_file'
 require 'rspec/openapi/schema_merger'
 
-records = []
-records_errors = []
+path_records = Hash.new { |h, k| h[k] = [] }
+error_records = {}
 
 RSpec.configuration.after(:each) do |example|
   if RSpec::OpenAPI.example_types.include?(example.metadata[:type]) && example.metadata[:openapi] != false
+    path = RSpec::OpenAPI.path.yield_self { |path| path.is_a?(Proc) ? path.call(example) : path }
     record = RSpec::OpenAPI::RecordBuilder.build(self, example: example)
-    records << record if record
+    path_records[path] << record if record
   end
 end
 
 RSpec.configuration.after(:suite) do
   title = File.basename(Dir.pwd)
-  RSpec::OpenAPI::SchemaFile.new(RSpec::OpenAPI.path).edit do |spec|
-    RSpec::OpenAPI::SchemaMerger.reverse_merge!(spec, RSpec::OpenAPI::DefaultSchema.build(title))
-    records.each do |record|
-      begin
-        RSpec::OpenAPI::SchemaMerger.reverse_merge!(spec, RSpec::OpenAPI::SchemaBuilder.build(record))
-      rescue StandardError, NotImplementedError => e # e.g. SchemaBuilder raises a NotImplementedError
-        # NOTE: Don't fail the build
-        records_errors << [e, record]
+  path_records.each do |path, records|
+    RSpec::OpenAPI::SchemaFile.new(path).edit do |spec|
+      RSpec::OpenAPI::SchemaMerger.reverse_merge!(spec, RSpec::OpenAPI::DefaultSchema.build(title))
+      records.each do |record|
+        begin
+          RSpec::OpenAPI::SchemaMerger.reverse_merge!(spec, RSpec::OpenAPI::SchemaBuilder.build(record))
+        rescue StandardError, NotImplementedError => e # e.g. SchemaBuilder raises a NotImplementedError
+          error_records[e] = record # Avoid failing the build
+        end
       end
     end
   end
-  if records_errors.any?
+  if error_records.any?
     error_message = <<~EOS
-      RSpec::OpenAPI got errors building #{records_errors.size} requests
+      RSpec::OpenAPI got errors building #{error_records.size} requests
 
-      #{records_errors.map {|e, record| "#{e.inspect}: #{record.inspect}" }.join("\n")}
+      #{error_records.map {|e, record| "#{e.inspect}: #{record.inspect}" }.join("\n")}
     EOS
     colorizer = ::RSpec::Core::Formatters::ConsoleCodes
     RSpec.configuration.reporter.message colorizer.wrap(error_message, :failure)

data/lib/rspec/openapi/record_builder.rb

@@ -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.1'
+    VERSION = '0.4.4'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.4
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-22 00:00:00.000000000 Z
+date: 2022-03-18 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.1.2
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs