rspec-openapi 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3032d3fed3b9bdc2b2a8512db3d1645679163539106650c1ad05069a15ab59cd
-  data.tar.gz: d1d3e85b467226a857b30bfe95b5643a1a37df2c0a925e509bdd893ae3017177
+  metadata.gz: a02d800d2c00b3cfec6a1a860f17eafaed45e51329aaa7407ed1e96892a10ac9
+  data.tar.gz: db0ec61540014497148d218846c01287d2b4f0e1ec4782148d932c5308ccbc75
 SHA512:
-  metadata.gz: 0c65c74db1ada24cf360545bda34830ca82d9cbd11b6e862a0563f9fc2bf244d65a96ec74e8223c182d1a2bff72b237e30c5884c2818576f9c142585d177351b
-  data.tar.gz: 397cfcddeaf3c1f683b9a1cd75960bf7d61e24adfcc9988bea2533c7a781acd42f43178b2ffb45deb5b3e821090f979d18af041a078f9ca3c2c7cd124cb4aff2
+  metadata.gz: b357caa7a5b3f497a743ddf7be434ceb141e5de9b93d5995ac66e7d42abce47fddaa65f5f62f0ceffca4e4d42a40405c7b6d8190b4d2557148d633af1c9e289d
+  data.tar.gz: c8166a897c99f4b60747bc4c51f223c20627303fd6276c2e8e9a4908fee6287d43f1fb43135354ff7615f7c0cece8665c1b5a96da234e3598dbe311c1468d712

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 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,23 +172,6 @@ RSpec.describe '/resources', type: :request do
 end
 ```
 
-## Project status
-
-Beta
-
-Basic features are there, and some people are already using this.
-
-### Other missing features with notes
-
-* 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.
-
 ## Links
 
 Existing RSpec plugins which have OpenAPI integration:

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

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.4.1'
+    VERSION = '0.4.2'
   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.2
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-22 00:00:00.000000000 Z
+date: 2022-03-10 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.2.22
 signing_key:
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs