rspec-openapi 0.4.7 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91fc5996b0273d0dd4a7e0261b86902db52e7a64c1433bbcb8cf107abf5d3784
-  data.tar.gz: 342051d1e3b6bb7a81af2f46fbb75b4c99658bf9cb075359104b6e2feef09985
+  metadata.gz: a696c48f7c8321f2b6807cd7b87ce31238c8cf5670fc9159fd4683cbb3c0698b
+  data.tar.gz: 4ac66642cb916439782d6a28aaf393da4e240f7579e1a8c072f679267b697869
 SHA512:
-  metadata.gz: 0445f41450ef4cfa70548431356aea9dc94abe0a18a6b5132398f63db7c5c46eaf1a572ee41cdf234ed864d0aba490a51abfb36859edc637f4098c32c8ef39c1
-  data.tar.gz: 5b318c2f1bec7f0608b89ab6cda871f4dddf6e8e2a2c7bd6dfed8430bb28597b97733bb34f1e03ee5fa0100170fedb0e47545b082b787e24e22e0e98a471591b
+  metadata.gz: b1f84f9475e56012381b1cc37dc4efcfe8eef0b09bdd6e94641c4961ef58b090312493501dfafc8a0ae6a48987da9f8db1f7fea0781b8ec35d4f3dcccf0d17b0
+  data.tar.gz: f49341e3bb0886b26670c0be59a1a878291e65761f727ccf15d7076bcdada19bc5745cc7c78428c1e8b2338cc2b4665697569e3588630910ecf21338a19645f1

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.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
+  [#46](https://github.com/k0kubun/rspec-openapi/pull/46)
+
 ## v0.4.7
 
 * Add `info` config hash

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'
 

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_builder.rb

@@ -158,9 +158,15 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
   def build_example(value)
     return nil if value.nil?
     value = value.dup
+    adjust_params(value)
+  end
+
+  def adjust_params(value)
     value.each do |key, v|
       if v.is_a?(ActionDispatch::Http::UploadedFile)
         value[key] = v.original_filename
+      elsif v.is_a?(Hash)
+        adjust_params(v)
       end
     end
   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.7'
+    VERSION = '0.5.1'
   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.7
+  version: 0.5.1
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-26 00:00:00.000000000 Z
+date: 2022-06-22 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