rspec-openapi 0.13.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5139294ebac456aadd2c09832f55cb214b7bf4ba9893919445823455cbee18a
-  data.tar.gz: b77813ff2d18290e714482bfa45350f69b182a638162d083923acb9b21124cfe
+  metadata.gz: cf9d4a386bc3e6a08230a32ae5593c8787f255cc901df5493daa8fb196796cc0
+  data.tar.gz: ba75408ae751a4c010a6e42872376c6bc539e0a4820fe1c2387649d5f9826f7a
 SHA512:
-  metadata.gz: 58de63dbf9608beb5f313eb57e6e1e4386eefa23fd1b572d17b06319f571ca3c6b1ac172a7886b3dcd42e14feb1f5f60ebd5a532951441193f8400d66e5229ce
-  data.tar.gz: 95765054acd231993f058a9f3a31a596c56ff143af9f1dc576bfb2f201773e611025329069b8c49751f50d3bf14b16a4f83ef863587d2f7815209f0afcdccb4a
+  metadata.gz: 22fc87ba0e0b3140f62d9b2396b2d24dbd9fc34fdbdf2664826db02fb3549c4ac3ddc4097ce85a348ff01b4b79279cfe5f450bc65bebb99c95982bf8c06beff0
+  data.tar.gz: fdd836b66e540d2e2488810ac1570ea0565c963d5817da740da3691d337e5b090e21b287fed92a3c12c9c434916e2481982eee117ee0add52e2bd4ef66a80961

data/.github/workflows/rubocop.yml

@@ -19,7 +19,7 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6
+        ruby-version: 3.3
         bundler-cache: true
 
     - name: Rubocop run

data/.github/workflows/test.yml

@@ -16,8 +16,6 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - ruby: ruby:2.5
-          - ruby: ruby:2.6
           - ruby: ruby:2.7
           - ruby: ruby:3.0
           - ruby: ruby:3.1
@@ -36,11 +34,6 @@ jobs:
       - uses: actions/checkout@v4
       - name: bundle install
         run: bundle install -j$(nproc) --retry 3
-      - name: install simplecov-fork only for minitest with coverage
-        run: |
-          gem install specific_install
-          gem specific_install https://github.com/exoego/simplecov.git branch-fix
-        if: matrix.coverage == 'coverage'
       - run: bundle exec rspec
         timeout-minutes: 1
       - run: git config --global --add safe.directory "$GITHUB_WORKSPACE"

data/.rubocop.yml

@@ -2,7 +2,8 @@ inherit_from: .rubocop_todo.yml
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.5
+  SuggestExtensions: false
+  TargetRubyVersion: 2.7
   Exclude:
     - 'spec/rails/**/*'
     - 'vendor/**/*'

data/.rubocop_todo.yml

@@ -1,12 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-01-13 11:12:43 UTC using RuboCop version 1.50.2.
+# on 2024-03-25 05:35:37 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: 9
+# Offense count: 11
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 48
@@ -14,19 +14,19 @@ Metrics/AbcSize:
 # Offense count: 2
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 192
+  Max: 207
 
-# Offense count: 5
+# Offense count: 8
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
   Max: 13
 
-# Offense count: 16
+# Offense count: 19
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 31
+  Max: 34
 
-# Offense count: 1
+# Offense count: 3
 # Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/PerceivedComplexity:
   Max: 13

data/README.md

@@ -29,7 +29,7 @@ $ OPENAPI=1 bundle exec rspec
 
 ### Example
 
-Let's say you have [a request spec](./spec/requests/rails/tables_spec.rb) like this:
+Let's say you have [a request spec](https://github.com/exoego/rspec-openapi/blob/24e5c567c2e90945c7a41f19f71634ac028cc314/spec/requests/rails_spec.rb#L38) like this:
 
 ```rb
 RSpec.describe 'Tables', type: :request do
@@ -184,6 +184,12 @@ RSpec::OpenAPI.example_types = %i[request]
 # :controller and :action always exist. :format is added when routes is configured as such.
 RSpec::OpenAPI.ignored_path_params = %i[controller action format]
 
+# Configure which paths to ignore.
+# You can exclude some specs via `openapi: false`.
+# But, in a complex API usage scenario, you may need to include spec itself, but exclude some private paths.
+# In that case, you can specify the paths to ignore.
+# String or Regexp is acceptable.
+RSpec::OpenAPI.ignored_paths = ["/admin/full/path/", Regexp.new("^/_internal/")]
 ```
 
 ### Can I use rspec-openapi with `$ref` to minimize duplication of schema?

data/lib/rspec/openapi/minitest_hooks.rb

@@ -12,7 +12,7 @@ module RSpec::OpenAPI::Minitest
         file_path = method(name).source_location.first
         human_name = name.sub(/^test_/, '').gsub('_', ' ')
         example = Example.new(self, human_name, {}, file_path)
-        path = RSpec::OpenAPI.path.yield_self { |p| p.is_a?(Proc) ? p.call(example) : p }
+        path = RSpec::OpenAPI.path.then { |p| p.is_a?(Proc) ? p.call(example) : p }
         record = RSpec::OpenAPI::RecordBuilder.build(self, example: example)
         RSpec::OpenAPI.path_records[path] << record if record
       end
@@ -45,6 +45,6 @@ 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?
+    puts result_recorder.error_message if result_recorder.errors?
   end
 end

data/lib/rspec/openapi/record_builder.rb

@@ -14,6 +14,8 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
     path, summary, tags, operation_id, required_request_params, raw_path_params, description, security =
       extract_request_attributes(request, example)
 
+    return if RSpec::OpenAPI.ignored_paths.any? { |ignored_path| path.match?(ignored_path) }
+
     request_headers, response_headers = extract_headers(request, response)
 
     RSpec::OpenAPI::Record.new(
@@ -31,7 +33,7 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
       description: description,
       security: security,
       status: response.status,
-      response_body: safe_parse_body(response),
+      response_body: safe_parse_body(response, response.media_type),
       response_headers: response_headers,
       response_content_type: response.media_type,
       response_content_disposition: response.header['Content-Disposition'],
@@ -40,7 +42,10 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
 
   private
 
-  def safe_parse_body(response)
+  def safe_parse_body(response, media_type)
+    # Use raw body, because Nokogiri-parsed HTML are modified (new lines injection, meta injection, and so on) :(
+    return response.body if media_type == 'text/html'
+
     response.parsed_body
   rescue JSON::ParserError
     nil

data/lib/rspec/openapi/rspec_hooks.rb

@@ -4,7 +4,7 @@ require 'rspec/core'
 
 RSpec.configuration.after(:each) do |example|
   if RSpec::OpenAPI.example_types.include?(example.metadata[:type]) && example.metadata[:openapi] != false
-    path = RSpec::OpenAPI.path.yield_self { |p| p.is_a?(Proc) ? p.call(example) : p }
+    path = RSpec::OpenAPI.path.then { |p| p.is_a?(Proc) ? p.call(example) : p }
     record = RSpec::OpenAPI::RecordBuilder.build(self, example: example)
     RSpec::OpenAPI.path_records[path] << record if record
   end

data/lib/rspec/openapi/schema_builder.rb

@@ -13,12 +13,16 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
 
     if record.response_body
       disposition = normalize_content_disposition(record.response_content_disposition)
-      response[:content] = {
-        normalize_content_type(record.response_content_type) => {
-          schema: build_property(record.response_body, disposition: disposition),
-          example: response_example(record, disposition: disposition),
-        }.compact,
-      }
+
+      has_content = !normalize_content_type(record.response_content_type).nil?
+      if has_content
+        response[:content] = {
+          normalize_content_type(record.response_content_type) => {
+            schema: build_property(record.response_body, disposition: disposition),
+            example: response_example(record, disposition: disposition),
+          }.compact,
+        }
+      end
     end
 
     {

data/lib/rspec/openapi/schema_merger.rb

@@ -13,9 +13,9 @@ class << RSpec::OpenAPI::SchemaMerger = Object.new
   def normalize_keys(spec)
     case spec
     when Hash
-      spec.map do |key, value|
+      spec.to_h do |key, value|
         [key.to_s, normalize_keys(value)]
-      end.to_h
+      end
     when Array
       spec.map { |s| normalize_keys(s) }
     else

data/lib/rspec/openapi/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module OpenAPI
-    VERSION = '0.13.0'
+    VERSION = '0.15.0'
   end
 end

data/lib/rspec/openapi.rb

@@ -31,6 +31,7 @@ module RSpec::OpenAPI
   @response_headers = []
   @path_records = Hash.new { |h, k| h[k] = [] }
   @ignored_path_params = %i[controller action format]
+  @ignored_paths = []
 
   # This is the configuraion override file name we look for within each path.
   @config_filename = 'rspec_openapi.rb'
@@ -51,6 +52,7 @@ module RSpec::OpenAPI
                   :example_types,
                   :response_headers,
                   :path_records,
+                  :ignored_paths,
                   :ignored_path_params
 
     attr_reader   :config_filename

data/rspec-openapi.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'Generate OpenAPI from RSpec request specs'
   spec.homepage      = 'https://github.com/exoego/rspec-openapi'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
   spec.metadata = {
     'homepage_uri' => 'https://github.com/exoego/rspec-openapi',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Takashi Kokubun
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-02 00:00:00.000000000 Z
+date: 2024-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -88,7 +88,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/exoego/rspec-openapi
   source_code_uri: https://github.com/exoego/rspec-openapi
-  changelog_uri: https://github.com/exoego/rspec-openapi/releases/tag/v0.13.0
+  changelog_uri: https://github.com/exoego/rspec-openapi/releases/tag/v0.15.0
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -98,7 +98,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="