rspec-openapi 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f835fe8be895164639ec2bfdbb6414b922734cc9598b30b100ac7da15d31b98f
-  data.tar.gz: 60ba1234561313d8e9fbe5c1f5667e6c759d477ad124867045e3e2e516174ece
+  metadata.gz: d55c7178770a58a980d06669adfab735ba84b51a283302dd8e14e91af4b7b4e9
+  data.tar.gz: 7b0030924262f8a1cd7027df612315b8d6e3fb89e91f9b4e57c3ec83f7e9bfd6
 SHA512:
-  metadata.gz: 44c56d011d95c1350eef4ed83011ff00c749cf9e83ec3cb44f605a6e3ee50c05173117d618d3472ea44b20aeef8981c17ae35f8b91220ff8891382447c1a4679
-  data.tar.gz: c264b04decebbcd4389633eed77cd98a0241980fa283c320e99c5bdaf5a5b5be36e242367da23abcefbf0f31802dd27f1d123324005c8234657d11328e9e1e60
+  metadata.gz: 4cf846ca12d2062ae17c0b5d1829a7887c206425330c015f5fdde310c59678cb802b4cadb60f63c1ca6d55063c3d4f1cc2ac7813db10c6d8611a0fa3af975192
+  data.tar.gz: 7501fac5fbfd8b0c4cec6cb196feb9ff09a640c4aff7165a93a6880eebea194d5c30674eefadb53987538ebed913d8d43ab625f1a7c8a3a12ad76ba15b459687

data/.github/workflows/test.yml

@@ -26,11 +26,19 @@ jobs:
             rails: 6.1.6
           - ruby: ruby:3.1
             rails: 7.0.3
+            coverage: coverage
     env:
       RAILS_VERSION: ${{ matrix.rails == '' && '6.1.6' || matrix.rails }}
+      COVERAGE: ${{ matrix.coverage || '' }}
     steps:
       - uses: actions/checkout@v2
       - name: bundle install
         run: bundle install -j$(nproc) --retry 3
       - run: bundle exec rspec
         timeout-minutes: 1
+      - name: Upload coverage reports
+        uses: codecov/codecov-action@v3
+        if: matrix.coverage == 'coverage'
+        with:
+          fail_ci_if_error: true
+          files: ./coverage/coverage.xml

data/.rubocop.yml

@@ -17,6 +17,8 @@ Style/ClassAndModuleChildren:
   EnforcedStyle: compact
   Exclude:
     - 'lib/rspec/openapi/version.rb'
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'

data/.simplecov_spawn.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+unless ENV['COVERAGE'] && ENV['COVERAGE'].empty?
+  require 'simplecov'
+  require 'simplecov-cobertura'
+
+  SimpleCov.at_fork.call(Process.pid)
+  SimpleCov.formatter SimpleCov::Formatter::MultiFormatter.new([
+    SimpleCov::Formatter::CoberturaFormatter,
+  ])
+  SimpleCov.start do
+    add_filter '/spec/'
+    add_filter '/scripts/'
+  end
+end

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## v0.9.0
+- bugfix: Fix engine path resolution
+  [#113](https://github.com/exoego/rspec-openapi/pull/113)
+- bugfix: fix multiple uploaded files
+  [#117](https://github.com/exoego/rspec-openapi/pull/117), [#126](https://github.com/exoego/rspec-openapi/pull/126)
+- feat: Add required_request_params to metadata
+ [#114](https://github.com/exoego/rspec-openapi/pull/114)
+- bugfix(minitest):
+  [#128](https://github.com/exoego/rspec-openapi/pull/128)
+- doc(minitest): Add instructions for minitest triggered yaml generation
+  [#116](https://github.com/exoego/rspec-openapi/pull/116)
+- chore: Don't dump records into temporary file
+  [#127](https://github.com/exoego/rspec-openapi/pull/127)
+
+## v0.8.1
+- bugfix: Empty `required` array should not be present.
+  [#111](https://github.com/exoego/rspec-openapi/pull/111)
+
 ## v0.8.0
 - Set `required` in request body and response body
   [#95](https://github.com/exoego/rspec-openapi/pull/95), [#98](https://github.com/exoego/rspec-openapi/pull/98)

data/Gemfile

@@ -10,6 +10,8 @@ gem 'roda'
 gem 'rspec-rails'
 
 group :test do
+  gem 'simplecov'
+  gem 'simplecov-cobertura'
   gem 'super_diff'
 end
 

data/README.md

@@ -1,4 +1,4 @@
-# rspec-openapi ![test](https://github.com/k0kubun/rspec-openapi/workflows/test/badge.svg)
+# rspec-openapi ![test](https://github.com/exoego/rspec-openapi/workflows/test/badge.svg) [![codecov](https://codecov.io/gh/exoego/rspec-openapi/branch/master/graph/badge.svg?token=egYm6AlxkD)](https://codecov.io/gh/exoego/rspec-openapi)
 
 Generate OpenAPI schema from RSpec request specs.
 
@@ -308,6 +308,7 @@ Some examples' attributes can be overwritten via RSpec metadata options. Example
     summary: 'list all posts',
     description: 'list all posts ordered by pub_date',
     tags: %w[v1 posts],
+    required_request_params: %w[limit],
     security: [{"MyToken" => []}],
   } do
     # ...
@@ -344,6 +345,12 @@ It should work with both classes inheriting from `ActionDispatch::IntegrationTes
 
 Please note that not all features present in the rspec integration work with minitest (yet). For example, custom per test case metadata is not supported. A custom `description_builder` will not work either.
 
+Run minitest with OPENAPI=1 to generate `doc/openapi.yaml` for your request specs.
+
+```bash
+$ OPENAPI=1 bundle exec rails t
+```
+
 ## Links
 
 Existing RSpec plugins which have OpenAPI integration:

data/lib/rspec/openapi/minitest_hooks.rb

@@ -5,11 +5,7 @@ require 'minitest'
 module RSpec::OpenAPI::Minitest
   Example = Struct.new(:context, :description, :metadata, :file_path)
 
-  module TestPatch
-    def self.prepended(base)
-      base.extend(ClassMethods)
-    end
-
+  module RunPatch
     def run(*args)
       result = super
       if ENV['OPENAPI'] && self.class.openapi?
@@ -22,6 +18,12 @@ module RSpec::OpenAPI::Minitest
       end
       result
     end
+  end
+
+  module ActivateOpenApiClassMethods
+    def self.prepended(base)
+      base.extend(ClassMethods)
+    end
 
     module ClassMethods
       def openapi?
@@ -35,10 +37,12 @@ module RSpec::OpenAPI::Minitest
   end
 end
 
-Minitest::Test.prepend RSpec::OpenAPI::Minitest::TestPatch
+Minitest::Test.prepend RSpec::OpenAPI::Minitest::ActivateOpenApiClassMethods
+
+if ENV['OPENAPI']
+  Minitest::Test.prepend RSpec::OpenAPI::Minitest::RunPatch
 
-Minitest.after_run do
-  if ENV['OPENAPI']
+  Minitest.after_run do
     result_recorder = RSpec::OpenAPI::ResultRecorder.new(RSpec::OpenAPI.path_records)
     result_recorder.record_results!
     puts result_record.error_message if result_recorder.errors?

data/lib/rspec/openapi/record.rb

@@ -6,10 +6,12 @@ RSpec::OpenAPI::Record = Struct.new(
   :path_params,           # @param [Hash]    - {:controller=>"v1/statuses", :action=>"create", :id=>"1"}
   :query_params,          # @param [Hash]    - {:query=>"string"}
   :request_params,        # @param [Hash]    - {:request=>"body"}
+  :required_request_params, # @param [Array]    - ["param1", "param2"]
   :request_content_type,  # @param [String]  - "application/json"
   :request_headers,       # @param [Array]  - [["header_key1", "header_value1"], ["header_key2", "header_value2"]]
   :summary,               # @param [String]  - "v1/statuses #show"
   :tags,                  # @param [Array]   - ["Status"]
+  :operation_id,          # @param [String]   - "request-1234"
   :description,           # @param [String]  - "returns a status"
   :security,              # @param [Array]  - [{securityScheme1: []}]
   :status,                # @param [Integer] - 200

data/lib/rspec/openapi/record_builder.rb

@@ -11,7 +11,8 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
     request, response = extract_request_response(context)
     return if request.nil?
 
-    path, summary, tags, raw_path_params, description, security = extract_request_attributes(request, example)
+    path, summary, tags, operation_id, required_request_params, raw_path_params, description, security =
+      extract_request_attributes(request, example)
 
     request_headers, response_headers = extract_headers(request, response)
 
@@ -21,10 +22,12 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
       path_params: raw_path_params,
       query_params: request.query_parameters,
       request_params: raw_request_params(request),
+      required_request_params: required_request_params,
       request_content_type: request.media_type,
       request_headers: request_headers,
       summary: summary,
       tags: tags,
+      operation_id: operation_id,
       description: description,
       security: security,
       status: response.status,
@@ -61,13 +64,21 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
     metadata = example.metadata[:openapi] || {}
     summary = metadata[:summary]
     tags = metadata[:tags]
+    operation_id = metadata[:operation_id]
+    required_request_params = metadata[:required_request_params] || []
     security = metadata[:security]
     description = metadata[:description] || RSpec::OpenAPI.description_builder.call(example)
     raw_path_params = request.path_parameters
     path = request.path
     if rails?
-      route = find_rails_route(request)
-      path = route.path.spec.to_s.delete_suffix('(.:format)')
+      # Reverse the destructive modification by Rails https://github.com/rails/rails/blob/v6.0.3.4/actionpack/lib/action_dispatch/journey/router.rb#L33-L41
+      fixed_request = request.dup
+      fixed_request.path_info = File.join(request.script_name, request.path_info) if request.script_name.present?
+
+      route, path = find_rails_route(fixed_request)
+      raise "No route matched for #{fixed_request.request_method} #{fixed_request.path_info}" if route.nil?
+
+      path = path.delete_suffix('(.:format)')
       summary ||= route.requirements[:action]
       tags ||= [route.requirements[:controller]&.classify].compact
       # :controller and :action always exist. :format is added when routes is configured as such.
@@ -75,7 +86,7 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
       raw_path_params = raw_path_params.slice(*(raw_path_params.keys - %i[controller action format]))
     end
     summary ||= "#{request.method} #{path}"
-    [path, summary, tags, raw_path_params, description, security]
+    [path, summary, tags, operation_id, required_request_params, raw_path_params, description, security]
   end
 
   def extract_request_response(context)
@@ -99,21 +110,18 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
   end
 
   # @param [ActionDispatch::Request] request
-  def find_rails_route(request, app: Rails.application, fix_path: true)
-    # Reverse the destructive modification by Rails https://github.com/rails/rails/blob/v6.0.3.4/actionpack/lib/action_dispatch/journey/router.rb#L33-L41
-    if fix_path && !request.script_name.empty?
-      request = request.dup
-      request.path_info = File.join(request.script_name, request.path_info)
-    end
-
+  def find_rails_route(request, app: Rails.application, path_prefix: '')
     app.routes.router.recognize(request) do |route|
+      path = route.path.spec.to_s
       if route.app.matches?(request)
-        return find_rails_route(request, app: route.app.app, fix_path: false) if route.app.engine?
-
-        return route
+        if route.app.engine?
+          route, path = find_rails_route(request, app: route.app.app, path_prefix: path)
+          next if route.nil?
+        end
+        return [route, path_prefix + path]
       end
     end
-    raise "No route matched for #{request.request_method} #{request.path_info}"
+    nil
   end
 
   # workaround to get real request parameters

data/lib/rspec/openapi/result_recorder.rb

@@ -15,7 +15,6 @@ class RSpec::OpenAPI::ResultRecorder
         RSpec::OpenAPI::SchemaMerger.merge!(spec, schema)
         new_from_zero = {}
         records.each do |record|
-          File.open('/tmp/records', 'a') { |f| f.puts record.to_yaml }
           begin
             record_schema = RSpec::OpenAPI::SchemaBuilder.build(record)
             RSpec::OpenAPI::SchemaMerger.merge!(spec, record_schema)
@@ -26,6 +25,7 @@ class RSpec::OpenAPI::ResultRecorder
         end
         RSpec::OpenAPI::SchemaCleaner.cleanup!(spec, new_from_zero)
         RSpec::OpenAPI::ComponentsUpdater.update!(spec, new_from_zero)
+        RSpec::OpenAPI::SchemaCleaner.cleanup_empty_required_array!(spec)
       end
     end
   end

data/lib/rspec/openapi/schema_builder.rb

@@ -27,6 +27,7 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
           record.http_method.downcase => {
             summary: record.summary,
             tags: record.tags,
+            operationId: record.operation_id,
             security: record.security,
             parameters: build_parameters(record),
             requestBody: build_request_body(record),
@@ -73,6 +74,7 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
       parameters << {
         name: build_parameter_name(key, value),
         in: 'query',
+        required: record.required_request_params.include?(key),
         schema: build_property(try_cast(value)),
         example: (try_cast(value) if example_enabled?),
       }.compact
@@ -191,10 +193,23 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
 
   def adjust_params(value)
     value.each do |key, v|
-      if v.is_a?(ActionDispatch::Http::UploadedFile)
+      case v
+      when ActionDispatch::Http::UploadedFile
         value[key] = v.original_filename
-      elsif v.is_a?(Hash)
+      when Hash
         adjust_params(v)
+      when Array
+        result = v.map do |item|
+          case item
+          when ActionDispatch::Http::UploadedFile
+            item.original_filename
+          when Hash
+            adjust_params(item)
+          else
+            item
+          end
+        end
+        value[key] = result
       end
     end
   end

data/lib/rspec/openapi/schema_cleaner.rb

@@ -39,6 +39,18 @@ class << RSpec::OpenAPI::SchemaCleaner = Object.new
     base
   end
 
+  def cleanup_empty_required_array!(base)
+    paths_to_objects = [
+      *RSpec::OpenAPI::HashHelper.matched_paths_deeply_nested(base, 'components.schemas', 'properties'),
+      *RSpec::OpenAPI::HashHelper.matched_paths_deeply_nested(base, 'paths', 'properties'),
+    ]
+    paths_to_objects.each do |path|
+      parent = base.dig(*path.take(path.length - 1))
+      # "required" array  must not be present if empty
+      parent.delete('required') if parent['required'] && parent['required'].empty?
+    end
+  end
+
   private
 
   def cleanup_array!(base, spec, selector, fields_for_identity = [])

data/lib/rspec/openapi/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module OpenAPI
-    VERSION = '0.8.0'
+    VERSION = '0.9.0'
   end
 end

data/lib/rspec/openapi.rb

@@ -10,10 +10,8 @@ require 'rspec/openapi/schema_file'
 require 'rspec/openapi/schema_merger'
 require 'rspec/openapi/schema_cleaner'
 
-if ENV['OPENAPI']
-  require 'rspec/openapi/minitest_hooks'
-  require 'rspec/openapi/rspec_hooks'
-end
+require 'rspec/openapi/minitest_hooks' if Object.const_defined?('Minitest')
+require 'rspec/openapi/rspec_hooks' if ENV['OPENAPI'] && Object.const_defined?('RSpec')
 
 module RSpec::OpenAPI
   @path = 'doc/openapi.yaml'

data/scripts/rspec

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# (The MIT License)
+# Copyright (c) 2012 Chad Humphries, David Chelimsky, Myron Marston
+# Copyright (c) 2009 Chad Humphries, David Chelimsky
+# Copyright (c) 2006 David Chelimsky, The RSpec Development Team
+# Copyright (c) 2005 Steven Baker
+
+require 'rspec/core'
+RSpec::Core::Runner.invoke

data/scripts/rspec_with_simplecov

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# (The MIT License)
+# Copyright (c) 2012 Chad Humphries, David Chelimsky, Myron Marston
+# Copyright (c) 2009 Chad Humphries, David Chelimsky
+# Copyright (c) 2006 David Chelimsky, The RSpec Development Team
+# Copyright (c) 2005 Steven Baker
+
+# Turn on verbose to make sure we not generating any ruby warning
+$VERBOSE = true
+
+# So our "did they run the rspec command?" detection logic thinks
+# that we run `rspec`.
+$0 = 'rspec'
+
+# This is necessary for when `--standalone` is being used.
+$LOAD_PATH.unshift File.expand_path '../bundle', __dir__
+
+# For the travis build we put the bundle directory up a directory
+# so it can be shared among the repos for faster bundle installs.
+$LOAD_PATH.unshift File.expand_path '../../bundle', __dir__
+
+require 'bundler/setup'
+
+# To use simplecov while running rspec-core's test suite, we must
+# load simplecov _before_ loading any of rspec-core's files.
+# So, this executable exists purely as a wrapper script that
+# first loads simplecov, and then loads rspec.
+begin
+  # Simplecov emits some ruby warnings when loaded, so silence them.
+  old_verbose = $VERBOSE
+  $VERBOSE = false
+
+  unless (ENV.fetch('COVERAGE', nil) && ENV['COVERAGE'].empty?) || RUBY_VERSION < '1.9.3'
+    require 'simplecov'
+
+    SimpleCov.start do
+      # Flaky :(
+      # enable_coverage :branch
+    end
+  end
+rescue LoadError
+  # simplecov is not available
+ensure
+  $VERBOSE = old_verbose
+end
+
+load File.expand_path('rspec', __dir__)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Takashi Kokubun
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-20 00:00:00.000000000 Z
+date: 2023-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -54,6 +54,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".simplecov_spawn.rb"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -76,6 +77,8 @@ files:
 - lib/rspec/openapi/schema_merger.rb
 - lib/rspec/openapi/version.rb
 - rspec-openapi.gemspec
+- scripts/rspec
+- scripts/rspec_with_simplecov
 - test.png
 homepage: https://github.com/exoego/rspec-openapi
 licenses: