rspec-openapi 0.26.0 → 0.28.0

data/.rubocop.yml

@@ -1,25 +0,0 @@
-inherit_from: .rubocop_todo.yml
-
-AllCops:
-  NewCops: enable
-  SuggestExtensions: false
-  TargetRubyVersion: 2.7
-  Exclude:
-    - 'spec/apps/**/*'
-    - 'vendor/**/*'
-
-Style/TrailingCommaInHashLiteral:
-  EnforcedStyleForMultiline: consistent_comma
-Style/TrailingCommaInArguments:
-  EnforcedStyleForMultiline: consistent_comma
-Style/TrailingCommaInArrayLiteral:
-  EnforcedStyleForMultiline: consistent_comma
-Style/ClassAndModuleChildren:
-  EnforcedStyle: compact
-  Exclude:
-    - 'lib/rspec/openapi/version.rb'
-Layout/FirstArrayElementIndentation:
-  EnforcedStyle: consistent
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*'

data/.rubocop_todo.yml

@@ -1,52 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2024-04-20 21:25:22 UTC using RuboCop version 1.62.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 14
-# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
-Metrics/AbcSize:
-  Max: 46
-
-# Offense count: 1
-# Configuration parameters: CountComments, CountAsOne.
-Metrics/ClassLength:
-  Max: 195
-
-# Offense count: 9
-# Configuration parameters: AllowedMethods, AllowedPatterns.
-Metrics/CyclomaticComplexity:
-  Max: 13
-
-# Offense count: 22
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
-Metrics/MethodLength:
-  Max: 37
-
-# Offense count: 5
-# Configuration parameters: AllowedMethods, AllowedPatterns.
-Metrics/PerceivedComplexity:
-  Max: 13
-
-# Offense count: 1
-# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
-# SupportedStyles: snake_case, normalcase, non_integer
-# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
-Naming/VariableNumber:
-  Exclude:
-    - 'spec/integration_tests/roda_test.rb'
-
-# Offense count: 7
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/rspec/openapi.rb'
-    - 'lib/rspec/openapi/minitest_hooks.rb'
-    - 'lib/rspec/openapi/result_recorder.rb'
-    - 'lib/rspec/openapi/schema_file.rb'
-    - 'lib/rspec/openapi/shared_hooks.rb'

data/.simplecov_spawn.rb

@@ -1,16 +0,0 @@
-# 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
-    enable_coverage :branch
-    add_filter '/spec/'
-    add_filter '/scripts/'
-  end
-end

data/CHANGELOG.md

@@ -1,290 +0,0 @@
-# THIS CHANGELOG IS DEPRECATED!!
-
-Refer https://github.com/exoego/rspec-openapi/releases instead.
-
-## v0.12.0
-
-- feat: Initial support of complex schema with manually-added `oneOf`
-  [#174](https://github.com/exoego/rspec-openapi/pull/174)
-- chore: Test with Ruby 3.3 and Rails 7.1.x 
-  [#169](https://github.com/exoego/rspec-openapi/pull/169)
-
-## v0.11.0
-- feat: Allow path-based config overrides
-  [#162](https://github.com/exoego/rspec-openapi/pull/162)
-- enhancement: Sort HTTP methods, response status codes, and contents lexicographically
-  [#163](https://github.com/exoego/rspec-openapi/pull/163)
-- enhancement: Remove parameters that conflict with security schemas
-  [#166](https://github.com/exoego/rspec-openapi/pull/166)
-
-## v0.10.0
-- bugfix: Merge parameter data to preserve description in manually edited Openapi spec 
-  [#149](https://github.com/exoego/rspec-openapi/pull/149)
-- feat: Add ability to configure which path params to ignore
-  [#150](https://github.com/exoego/rspec-openapi/pull/150)
-- feat: Add custom title 
-  [#147](https://github.com/exoego/rspec-openapi/pull/147)
-- feat: Add ability to define custom summary and tags builders
-  [#148](https://github.com/exoego/rspec-openapi/pull/148)
-- enhancement: Sort paths lexicographically so the order of paths is more stable and predictable
-  [#155](https://github.com/exoego/rspec-openapi/pull/155)
-- enhancement: requestBody should not merge requestBody from error examples
-  [#154](https://github.com/exoego/rspec-openapi/pull/154)
-
-## 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)
-- Generate OpenAPI with minitest instead of RSpec
-  [#90](https://github.com/exoego/rspec-openapi/pull/90)
-- Generate security schemas via RSpec::OpenAPI.security_schemes
-  [#84](https://github.com/exoego/rspec-openapi/pull/84)
-- Bunch of refactorings
-
-## v0.7.2
-- $ref enhancements: Support $ref in arbitrary depth
-  [#82](https://github.com/k0kubun/rspec-openapi/pull/82)
-
-## v0.7.1
-- $ref enhancements: Auto-generate components referenced in "items"
-  [#80](https://github.com/k0kubun/rspec-openapi/pull/80)
-- Administration
-  - Setup RuboCop
-    [#73](https://github.com/k0kubun/rspec-openapi/pull/73)
-  - Setup CodeQL
-    [#73](https://github.com/k0kubun/rspec-openapi/pull/73)
-  - Bump Rails v6.0.3.x to fix bundle failure
-    [#72](https://github.com/k0kubun/rspec-openapi/pull/72)
-
-## v0.7.0
-- Generate Response Headers
-  [#69](https://github.com/k0kubun/rspec-openapi/pull/69)
-- Initial support for $ref
-  [#67](https://github.com/k0kubun/rspec-openapi/pull/67)
-- Fixed an empty array is turned into nullable object wrongly
-  [#70](https://github.com/k0kubun/rspec-openapi/pull/70)
-
-## v0.6.1
-
-* Stabilize the order parameter objects and preserve newer examples
-  [#59](https://github.com/k0kubun/rspec-openapi/pull/59)
-
-## 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
-  [#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
-  [#38](https://github.com/k0kubun/rspec-openapi/pull/38)
-
-## v0.4.5
-
-* Fix linter issues for `tags` and `summary`
-  [#40](https://github.com/k0kubun/rspec-openapi/pull/40)
-
-## v0.4.4
-
-* De-duplicate parameters by a combination of `name` and `in`
-  [#39](https://github.com/k0kubun/rspec-openapi/pull/39)
-
-## v0.4.3
-
-* Allow customizing `schema`, `description`, and `tags` through `:openapi` metadata
-  [#36](https://github.com/k0kubun/rspec-openapi/pull/36)
-
-## 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
-  [#31](https://github.com/k0kubun/rspec-openapi/pull/31)
-
-## v0.3.19
-
-* Add `server_urls` and `request_headers` configs
-  [#30](https://github.com/k0kubun/rspec-openapi/pull/30)
-
-## v0.3.18
-
-* Support nested query parameters
-  [#29](https://github.com/k0kubun/rspec-openapi/pull/29)
-
-## v0.3.17
-
-* Rescue NotImplementedError in the after suite hook as well
-  [#28](https://github.com/k0kubun/rspec-openapi/pull/28)
-
-## v0.3.16
-
-* Use `media_type` instead of `content_type` for Rails 6.1
-  [#26](https://github.com/k0kubun/rspec-openapi/pull/26)
-* Avoid crashing the after suite hook when it fails to build schema
-  [#27](https://github.com/k0kubun/rspec-openapi/pull/27)
-
-## v0.3.15
-
-* Fix an error when Content-Disposition header is inline
-  [#24](https://github.com/k0kubun/rspec-openapi/pull/24)
-
-## v0.3.14
-
-* Avoid an error when an application calls `request.body.read`
-  [#20](https://github.com/k0kubun/rspec-openapi/pull/20)
-
-## v0.3.13
-
-* Avoid crashing when there's no request made in a spec
-  [#19](https://github.com/k0kubun/rspec-openapi/pull/19)
-
-## v0.3.12
-
-* Generate `nullable: true` for null fields in schema
-  [#18](https://github.com/k0kubun/rspec-openapi/pull/18)
-
-## v0.3.11
-
-* Show a filename as an `example` for `ActionDispatch::Http::UploadedFile`
-  [#17](https://github.com/k0kubun/rspec-openapi/pull/17)
-
-## v0.3.10
-
-* Add `info.version`
-  [#16](https://github.com/k0kubun/rspec-openapi/pull/16)
-
-## v0.3.9
-
-* Initial support for multipart/form-data
-  [#12](https://github.com/k0kubun/rspec-openapi/pull/12)
-
-## v0.3.8
-
-* Generate `type: 'number', format: 'float'` instead of `type: 'float'` for Float
-  [#11](https://github.com/k0kubun/rspec-openapi/issues/11)
-
-## v0.3.7
-
-* Classify tag names and remove controller names from summary in Rails
-
-## v0.3.6
-
-* Fix documents generated by Rails engines
-
-## v0.3.5
-
-* Support finding routes in Rails engines
-
-## v0.3.4
-
-* Generate tags by controller names
-  [#10](https://github.com/k0kubun/rspec-openapi/issues/10)
-
-## v0.3.3
-
-* Avoid `JSON::ParserError` when a response body is no content
-  [#9](https://github.com/k0kubun/rspec-openapi/issues/9)
-
-## v0.3.2
-
-* Stop generating format as path parameters in Rails
-  [#8](https://github.com/k0kubun/rspec-openapi/issues/8)
-
-## v0.3.1
-
-* Add `RSpec::OpenAPI.description_builder` config to dynamically generate a description [experimental]
-  [#6](https://github.com/k0kubun/rspec-openapi/issues/6)
-
-## v0.3.0
-
-* Initial support of rack-test and non-Rails apps [#5](https://github.com/k0kubun/rspec-openapi/issues/5)
-
-## v0.2.2
-
-* Allow disabling `example` by `RSpec::OpenAPI.enable_example = false`
-
-## v0.2.1
-
-* Generate `example` of request body and path / query params
-  [#4](https://github.com/k0kubun/rspec-openapi/issues/4)
-* Remove a wrapper param created by Rails in request body
-  [#4](https://github.com/k0kubun/rspec-openapi/issues/4)
-
-## v0.2.0
-
-* Generate `example` of response body [#3](https://github.com/k0kubun/rspec-openapi/issues/3)
-
-## v0.1.5
-
-* Support detecting `float` type [#2](https://github.com/k0kubun/rspec-openapi/issues/2)
-
-## v0.1.4
-
-* Avoid NoMethodError on nil Content-Type
-* Include a space between controller and action in summary
-
-## v0.1.3
-
-* Add `RSpec::OpenAPI.comment` configuration
-
-## v0.1.2
-
-* Generate `required: true` for path params [#1](https://github.com/k0kubun/rspec-openapi/issues/1)
-
-## v0.1.1
-
-* Generate a path like `/{id}` instead of `/:id`
-
-## v0.1.0
-
-* Initial release

data/Gemfile

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in rspec-openapi.gemspec
-gemspec
-
-gem 'rails', ENV['RAILS_VERSION'] || '6.0.6.1'
-
-if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.0.0')
-  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('4.0.0')
-    gem 'dry-logger', '1.2.1'
-    gem 'hanami', ENV['HANAMI_VERSION'] || '2.3.2'
-  else
-    gem 'dry-logger', '1.0.3'
-    gem 'hanami', ENV['HANAMI_VERSION'] || '2.1.0'
-  end
-  gem 'hanami-controller'
-  gem 'hanami-router'
-end
-
-gem 'concurrent-ruby', '1.3.4'
-
-gem 'roda'
-
-gem 'rails-dom-testing', '~> 2.2'
-gem 'rspec-rails', '>= 5.0'
-
-group :test do
-  gem 'simplecov', git: 'https://github.com/exoego/simplecov.git', branch: 'branch-fix'
-  gem 'simplecov-cobertura'
-  gem 'super_diff'
-end
-
-group :development do
-  gem 'code-scanning-rubocop'
-  gem 'pry'
-end

data/Rakefile

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = 'spec/rspec/openapi/**/*_spec.rb'
-end
-
-task default: :spec

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'rspec/openapi'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/redocly.yaml

@@ -1,31 +0,0 @@
-# Config for `redocly lint` used by .github/workflows/validate-openapi.yml
-# to validate test-fixture OpenAPI documents shipped under spec/apps/.
-#
-# spec/apps/rails/doc/smart/openapi.yaml is intentionally excluded:
-# it is the input fixture for the smart-merge feature test (it contains
-# unresolved $refs by design), not a complete API description.
-extends:
-  - minimal
-apis:
-  rails-rspec-yaml:
-    root: spec/apps/rails/doc/rspec_openapi.yaml
-  rails-rspec-json:
-    root: spec/apps/rails/doc/rspec_openapi.json
-  rails-minitest-yaml:
-    root: spec/apps/rails/doc/minitest_openapi.yaml
-  rails-minitest-json:
-    root: spec/apps/rails/doc/minitest_openapi.json
-  rails-smart-expected:
-    root: spec/apps/rails/doc/smart/expected.yaml
-  roda-rspec-yaml:
-    root: spec/apps/roda/doc/rspec_openapi.yaml
-  roda-rspec-json:
-    root: spec/apps/roda/doc/rspec_openapi.json
-  roda-minitest-yaml:
-    root: spec/apps/roda/doc/minitest_openapi.yaml
-  roda-minitest-json:
-    root: spec/apps/roda/doc/minitest_openapi.json
-  hanami-yaml:
-    root: spec/apps/hanami/doc/openapi.yaml
-  hanami-json:
-    root: spec/apps/hanami/doc/openapi.json

data/scripts/rspec

@@ -1,11 +0,0 @@
-#!/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

@@ -1,48 +0,0 @@
-#!/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
-      enable_coverage :branch
-    end
-  end
-rescue LoadError
-  # simplecov is not available
-ensure
-  $VERBOSE = old_verbose
-end
-
-load File.expand_path('rspec', __dir__)