rspec-openapi 0.3.20 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0ff0f4854e68684d59b37788218a797c61cdff744808237ca08818493a393eb
-  data.tar.gz: 0730c2487ccb75a2fd3bec8052136cb75b9410d42daea1e3a6c9826d6854df8d
+  metadata.gz: a02d800d2c00b3cfec6a1a860f17eafaed45e51329aaa7407ed1e96892a10ac9
+  data.tar.gz: db0ec61540014497148d218846c01287d2b4f0e1ec4782148d932c5308ccbc75
 SHA512:
-  metadata.gz: dadb96bc250a1c615176c5ada6e5dd6a41f1dec2a96099ef5181ac83e77d9c008168c0219c0a92d59bfc7a5ca0388138bcdd2641d8c5eb767d42a38a2cbd4096
-  data.tar.gz: 276bf5d35e634db31d6cdcaac519dac4972cbf0c93014c9c45d59a97bb0d2c20ee969c843f54e879eca8bab29cea0192cf36aab9c3ba5b0c2ee803692b0a5816
+  metadata.gz: b357caa7a5b3f497a743ddf7be434ceb141e5de9b93d5995ac66e7d42abce47fddaa65f5f62f0ceffca4e4d42a40405c7b6d8190b4d2557148d633af1c9e289d
+  data.tar.gz: c8166a897c99f4b60747bc4c51f223c20627303fd6276c2e8e9a4908fee6287d43f1fb43135354ff7615f7c0cece8665c1b5a96da234e3598dbe311c1468d712

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 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`.
+  [#32](https://github.com/k0kubun/rspec-openapi/pull/32)
+
+## v0.4.0
+
+* Drop `RSpec::OpenAPI.output` introduced in v0.3.20
+* Guess whether it's JSON or not by the extension of `RSpec::OpenAPI.path`
+
 ## v0.3.20
 
 * Add `RSpec::OpenAPI.output` config to output JSON

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
@@ -108,8 +108,17 @@ The following configurations are optional.
 # Change the path to generate schema from `doc/openapi.yaml`
 RSpec::OpenAPI.path = 'doc/schema.yaml'
 
-# Change the output type yaml or json
-RSpec::OpenAPI.output = :json
+# 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
@@ -135,6 +144,9 @@ EOS
 
 # Generate a custom description, given an RSpec example
 RSpec::OpenAPI.description_builder = -> (example) { example.description }
+
+# Change the example type(s) that will generate schema
+RSpec::OpenAPI.example_types = %i[request]
 ```
 
 ### How can I add information which can't be generated from RSpec?
@@ -160,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 example.metadata[:type] == :request && example.metadata[:openapi] != false
+  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
-      
-      #{records_errors.map {|e, record| "#{e.inspect}: #{record.inspect}" }.join("\n")}
+      RSpec::OpenAPI got errors building #{error_records.size} requests
+
+      #{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/schema_file.rb

@@ -21,24 +21,18 @@ class RSpec::OpenAPI::SchemaFile
   # @return [Hash]
   def read
     return {} unless File.exist?(@path)
-
-    content = File.read(@path)
-
-    return JSON.load(content) if json?
-
-    YAML.load(content)
+    YAML.load(File.read(@path)) # this can also parse JSON
   end
 
   # @param [Hash] spec
   def write(spec)
     FileUtils.mkdir_p(File.dirname(@path))
-
-    output = if json?
-               JSON.pretty_generate(spec)
-             else
-               prepend_comment(YAML.dump(spec))
-             end
-
+    output =
+      if json?
+        JSON.pretty_generate(spec)
+      else
+        prepend_comment(YAML.dump(spec))
+      end
     File.write(@path, output)
   end
 
@@ -53,6 +47,6 @@ class RSpec::OpenAPI::SchemaFile
   end
 
   def json?
-    RSpec::OpenAPI.output.to_s == 'json'
+    File.extname(@path) == '.json'
   end
 end

data/lib/rspec/openapi/version.rb

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

data/lib/rspec/openapi.rb

@@ -7,11 +7,11 @@ module RSpec::OpenAPI
   @enable_example = true
   @description_builder = -> (example) { example.description }
   @application_version = '1.0.0'
-  @output = :yaml
   @request_headers = []
   @server_urls = []
+  @example_types = %i[request]
 
   class << self
-    attr_accessor :path, :comment, :enable_example, :description_builder, :application_version, :request_headers, :server_urls, :output
+    attr_accessor :path, :comment, :enable_example, :description_builder, :application_version, :request_headers, :server_urls, :example_types
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.3.20
+  version: 0.4.2
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-11 00:00:00.000000000 Z
+date: 2022-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack