rspec-openapi 0.4.6 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f83672f313f4451abb668adf66697c74be2d0ad7866c6fbc433b2ef815e06419
-  data.tar.gz: 696c074c32d5ec4f6dfc0f5ea2ab02f9123a4b88a8ce7d09a4c8aada60fe1b6f
+  metadata.gz: b35634b5756cb3719f38bdb5bbb501033b69472d0680615b5e1dcdba2251f41f
+  data.tar.gz: 6600c602466bf0ea6a468c22a2762c6717086ed2ee1ae89c4d132b7d5edc21cc
 SHA512:
-  metadata.gz: 232765a27c157fdbb1bd479b14987d095c0fce190e3b76cc10a4f8f3b990c253456af15a79924be632daaf0d08254e934b9da00f24c9779f4f9c4531b3f36bae
-  data.tar.gz: fbf0fb968a2d1afde12566cc472bb72a97b800101e60c640c1b7fa218a5563f993f48070532af6903c0cf1432a4142fd08235c1e9b6443847e5c2e4b6b22dfdb
+  metadata.gz: 13c6e8ad06467426186336d53a387e7e92207d5caf5c6838a076275674e3f334a490185cbf20d889f59b04160d6ec056b3030e35862217d6425f88ccef7fc97c
+  data.tar.gz: 4393d139ac38acd1ccf1b8404482671932b39491eed44ab69cbf57c28e06a186cdf452cb610b01377d2237f28ee4fe024fd43e28780b8662e8c76626be414332

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.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
+  [#43](https://github.com/k0kubun/rspec-openapi/pull/43)
+
 ## v0.4.6
 
 * Fix "No route matched for" error in engine routes

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'
 
@@ -126,6 +128,15 @@ RSpec::OpenAPI.enable_example = false
 # Change `info.version`
 RSpec::OpenAPI.application_version = '1.0.0'
 
+# Set the info header details
+RSpec::OpenAPI.info = {
+  description: 'My beautiful API',
+  license: {
+    'name': 'Apache 2.0',
+    'url': 'https://www.apache.org/licenses/LICENSE-2.0.html'
+  }
+}
+
 # Set `headers` - generate parameters with headers for a request
 RSpec::OpenAPI.request_headers = %w[X-Authorization-Token]
 

data/lib/rspec/openapi/hooks.rb

@@ -20,10 +20,12 @@ RSpec.configuration.after(:suite) do
   title = File.basename(Dir.pwd)
   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))
+      schema = RSpec::OpenAPI::DefaultSchema.build(title)
+      schema[:info].merge!(RSpec::OpenAPI.info)
+      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.6'
+    VERSION = '0.5.0'
   end
 end

data/lib/rspec/openapi.rb

@@ -6,12 +6,13 @@ module RSpec::OpenAPI
   @comment = nil
   @enable_example = true
   @description_builder = -> (example) { example.description }
+  @info = {}
   @application_version = '1.0.0'
   @request_headers = []
   @server_urls = []
   @example_types = %i[request]
 
   class << self
-    attr_accessor :path, :comment, :enable_example, :description_builder, :application_version, :request_headers, :server_urls, :example_types
+    attr_accessor :path, :comment, :enable_example, :description_builder, :info, :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.4.6
+  version: 0.5.0
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-24 00:00:00.000000000 Z
+date: 2022-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -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