rspec-openapi 0.4.8 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d6f2c98f9e3462e319dc05435274d53b933deb41553c2f4d7b70b3d4d135c7e
-  data.tar.gz: 48e8862133eebc1cf0a700eb720603159f6274012342b4f9d259157d527af525
+  metadata.gz: b4d19b6239f38863e5cc4a7924d4dc9fc6f684a03f057f49371b4bd110fc312e
+  data.tar.gz: 972520dcffe3b393e32194a0fa4f9154c93c097f63d81750d7ac5d5b15d229d6
 SHA512:
-  metadata.gz: 8420b3ad4d97a8a5e1d1dd89280f2dd95335e362997740fbbd342d7a352a2a90f3b1d912366ac3d32693c44e3b65ef0058522323fbdd5f1d6900cc122d1d1ae1
-  data.tar.gz: 891a7b33e112310e66ec6bcff616aac5c93a8036028ba95cf25b5ac40a3d89e2599a906782a15a107c37779a7c657bfda4b92d5fb4e364725300d071c2a870e3
+  metadata.gz: 377aa3ea1a708b7ba2a8fd9cbaf96f0e6cf3588bdfbedcb14ee3ccb30c478c54e2d34fcd8e08bafc25c4c3cfab0062a4deb9781cf63e1c001b6e16750348222e
+  data.tar.gz: eebc893ceb3eaa4207fcbac83e453ea19adcfdc5b64d82725f441dfa8fa33142bab178dd21b76318dbf6f01afa80da40a9f50b5c87c726a2e63fd3bfd56e4386

data/.github/workflows/test.yml

@@ -15,11 +15,19 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby:
-          - ruby:2.5
-          - ruby:2.6
-          - ruby:2.7
-          - ruby:3.0
+        include:
+          - ruby: ruby:2.5
+          - ruby: ruby:2.6
+          - ruby: ruby:2.7
+          - ruby: ruby:3.0
+          - ruby: ruby:3.1
+            rails: 6.0.5
+          - ruby: ruby:3.1
+            rails: 6.1.6
+          - ruby: ruby:3.1
+            rails: 7.0.3
+    env:
+      RAILS_VERSION: ${{ matrix.rails == '' && '6.1.6' || matrix.rails }}
     steps:
       - uses: actions/checkout@v2
       - name: bundle install

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## v0.6.0
+
+* Replace `RSpec::OpenAPI.server_urls` with `RSpec::OpenAPI.servers`
+  [#60](https://github.com/k0kubun/rspec-openapi/pull/60)
+
+## v0.5.1
+
+* Clarify the version requirement for actionpack
+  [#62](https://github.com/k0kubun/rspec-openapi/pull/62)
+
+## v0.5.0
+
+* Overwrite fields in an existing schema file instead of leaving all existing fields as is
+  [#55](https://github.com/k0kubun/rspec-openapi/pull/55)
+
 ## v0.4.8
 
 * Fix a bug in nested parameters handling

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in rspec-openapi.gemspec
 gemspec
 
-gem 'rails', '6.0.3.2'
+gem 'rails', ENV['RAILS_VERSION'] || '6.0.3.2'
 gem 'roda'
 gem 'rspec-rails'
 

data/README.md

@@ -105,6 +105,8 @@ and the schema file can be used as an input of [Swagger UI](https://github.com/s
 The following configurations are optional.
 
 ```rb
+require 'rspec/openapi'
+
 # Change the path to generate schema from `doc/openapi.yaml`
 RSpec::OpenAPI.path = 'doc/schema.yaml'
 
@@ -138,10 +140,8 @@ RSpec::OpenAPI.info = {
 # Set `headers` - generate parameters with headers for a request
 RSpec::OpenAPI.request_headers = %w[X-Authorization-Token]
 
-# Set `server_urls` - generate servers of a schema file
-RSpec::OpenAPI.server_urls = %w[
-  http://localhost:3000
-]
+# Set `servers` - generate servers of a schema file
+RSpec::OpenAPI.servers = [{ url: 'http://localhost:3000' }]
 
 # Generate a comment on top of a schema file
 RSpec::OpenAPI.comment = <<~EOS

data/lib/rspec/openapi/default_schema.rb

@@ -6,7 +6,7 @@ class << RSpec::OpenAPI::DefaultSchema = Object.new
         title: title,
         version: RSpec::OpenAPI.application_version,
       },
-      servers: RSpec::OpenAPI.server_urls.map { |url| { url: url } } || [],
+      servers: RSpec::OpenAPI.servers,
       paths: {},
     }.freeze
   end

data/lib/rspec/openapi/hooks.rb

@@ -22,10 +22,10 @@ RSpec.configuration.after(:suite) do
     RSpec::OpenAPI::SchemaFile.new(path).edit do |spec|
       schema = RSpec::OpenAPI::DefaultSchema.build(title)
       schema[:info].merge!(RSpec::OpenAPI.info)
-      RSpec::OpenAPI::SchemaMerger.reverse_merge!(spec, schema)
+      RSpec::OpenAPI::SchemaMerger.merge!(spec, schema)
       records.each do |record|
         begin
-          RSpec::OpenAPI::SchemaMerger.reverse_merge!(spec, RSpec::OpenAPI::SchemaBuilder.build(record))
+          RSpec::OpenAPI::SchemaMerger.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

data/lib/rspec/openapi/schema_merger.rb

@@ -1,9 +1,9 @@
 class << RSpec::OpenAPI::SchemaMerger = Object.new
   # @param [Hash] base
   # @param [Hash] spec
-  def reverse_merge!(base, spec)
+  def merge!(base, spec)
     spec = normalize_keys(spec)
-    deep_reverse_merge!(base, spec)
+    merge_schema!(base, spec)
   end
 
   private
@@ -22,25 +22,26 @@ class << RSpec::OpenAPI::SchemaMerger = Object.new
   end
 
   # 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.
+  # Also this needs to be aware of OpenAPI details 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
   # TODO: Should we probably force-merge `summary` regardless of manual modifications?
-  def deep_reverse_merge!(base, spec)
+  def merge_schema!(base, spec)
     spec.each do |key, value|
       if base[key].is_a?(Hash) && value.is_a?(Hash)
-        deep_reverse_merge!(base[key], value)
-      elsif !base.key?(key)
-        base[key] = value
+        if !base[key].key?("$ref")
+          merge_schema!(base[key], value)
+        end
       elsif base[key].is_a?(Array) && value.is_a?(Array)
         # 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') }
+        else
+          base[key] = value
         end
       else
-        # no-op
+        base[key] = value
       end
     end
     base

data/lib/rspec/openapi/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.4.8'
+    VERSION = '0.6.0'
   end
 end

data/lib/rspec/openapi.rb

@@ -9,10 +9,10 @@ module RSpec::OpenAPI
   @info = {}
   @application_version = '1.0.0'
   @request_headers = []
-  @server_urls = []
+  @servers = []
   @example_types = %i[request]
 
   class << self
-    attr_accessor :path, :comment, :enable_example, :description_builder, :info, :application_version, :request_headers, :server_urls, :example_types
+    attr_accessor :path, :comment, :enable_example, :description_builder, :info, :application_version, :request_headers, :servers, :example_types
   end
 end

data/rspec-openapi.gemspec

@@ -23,6 +23,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'actionpack'
+  spec.add_dependency 'actionpack', '>= 5.2.0'
   spec.add_dependency 'rspec'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.6.0
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-30 00:00:00.000000000 Z
+date: 2022-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -49,7 +49,6 @@ files:
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.7.1
-before_install: gem install bundler -v 2.1.4