rspec-openapi 0.25.0 → 0.25.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65e97b91c81a4798c7907d907174d8c7efe874ad26dd3d630db2c86db97f913d
-  data.tar.gz: a593eaf58214a7bc5578f3cee065d263d7b494507727ac05c60111d01b0a2a7d
+  metadata.gz: fdb09465b214320cfd32bf020363827d17c3346d48cb7e724effc99df6bdf722
+  data.tar.gz: 9947b0df4b2af301473ff89cd52cd035d8a4cb129bd83f8aacef2fc4df107cd5
 SHA512:
-  metadata.gz: 3e88fae82f5452b748d2ade83adc141fff0e888946c48ec3219999012bd75a7162e678d89af1e1ccb584e14250739715e0ffd53ec1b1ff101080ca2abd44ba82
-  data.tar.gz: e49fdd879b02d43fe0f8ac4ef2d443b7a0366c5f133d5012f771be380c706b9fa28597f6bd6e6e111bee599bee26e5ae71f8dec262e4bf6070c679790e42d654
+  metadata.gz: f17329553b8d2a02b196faba4ac592826557acb79648f364994614759e762608241d1310be6080873703af3b7f45d111db3509302f9ec22270c6c3c849bbd180
+  data.tar.gz: dd616bc6570e99d2b6439d4003bcadcdc9881613c6f4ba0428191ceef2c7c73dd185c5e385ea6c8af271f98d5c67d3e597062052d2c3bd7c59d1c0f6e75f0deb

data/.github/workflows/create_release.yml

@@ -4,7 +4,7 @@ on:
   workflow_dispatch:
     inputs:
       version:
-        description: 'Version to release (e.g. 0.25.1 or 0.26.0)'
+        description: 'Version to release (e.g. 0.25.2 or 0.26.0)'
         required: true
 
 jobs:

data/.github/workflows/test.yml

@@ -42,7 +42,7 @@ jobs:
       - run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
         name: codecov-action@v4 workaround
       - name: Upload coverage reports
-        uses: codecov/codecov-action@v5
+        uses: codecov/codecov-action@v6
         if: matrix.coverage == 'coverage'
         with:
           fail_ci_if_error: true

data/lib/rspec/openapi/components_updater.rb

@@ -3,6 +3,8 @@
 require_relative 'hash_helper'
 
 class << RSpec::OpenAPI::ComponentsUpdater = Object.new
+  SCHEMA_REF_PREFIX = '#/components/schemas/'
+
   # @param [Hash] base
   # @param [Hash] fresh
   def update!(base, fresh)
@@ -30,7 +32,7 @@ class << RSpec::OpenAPI::ComponentsUpdater = Object.new
       # Skip if the property using $ref is not found in the parent schema. The property may be removed.
       next if nested_schema.nil?
 
-      schema_name = base.dig(*paths)&.gsub('#/components/schemas/', '')&.to_sym
+      schema_name = extract_schema_name(base.dig(*paths))&.to_sym
       fresh_schemas[schema_name] ||= {}
       RSpec::OpenAPI::SchemaMerger.merge!(fresh_schemas[schema_name], nested_schema)
     end
@@ -44,8 +46,8 @@ class << RSpec::OpenAPI::ComponentsUpdater = Object.new
   def build_fresh_schemas(references, base, fresh)
     references.inject({}) do |acc, paths|
       ref_link = dig_schema(base, paths)[:$ref]
-      schema_name = ref_link.to_s.gsub('#/components/schemas/', '')
-      schema_body = dig_schema(fresh, paths.reject { |path| path.is_a?(Integer) })
+      schema_name = extract_schema_name(ref_link)
+      schema_body = dig_schema(fresh, paths.grep_v(Integer))
 
       RSpec::OpenAPI::SchemaMerger.merge!(acc, { schema_name => schema_body })
     end
@@ -81,18 +83,29 @@ class << RSpec::OpenAPI::ComponentsUpdater = Object.new
     # Reject already-generated schemas to reduce unnecessary loop
     nested_refs.reject do |paths|
       ref_link = base.dig(*paths)
-      schema_name = ref_link.gsub('#/components/schemas/', '')
+      schema_name = extract_schema_name(ref_link)
       generated_names.include?(schema_name)
     end
   end
 
   def find_one_of_refs(base, paths)
-    dig_schema(base, paths)&.dig(:oneOf)&.map&.with_index do |schema, index|
-      paths + [index] if schema&.dig(:$ref)&.start_with?('#/components/schemas/')
-    end&.compact
+    one_of = dig_schema(base, paths)&.dig(:oneOf)
+    return unless one_of
+
+    one_of.each_with_index.filter_map do |schema, index|
+      paths + [index] if schema_ref?(schema&.dig(:$ref))
+    end
   end
 
   def find_object_refs(base, paths)
-    [paths] if dig_schema(base, paths)&.dig(:$ref)&.start_with?('#/components/schemas/')
+    [paths] if schema_ref?(dig_schema(base, paths)&.dig(:$ref))
+  end
+
+  def extract_schema_name(ref_link)
+    ref_link&.delete_prefix(SCHEMA_REF_PREFIX)
+  end
+
+  def schema_ref?(ref_link)
+    ref_link&.start_with?(SCHEMA_REF_PREFIX)
   end
 end

data/lib/rspec/openapi/extractors/hanami.rb

@@ -38,13 +38,11 @@ end
 InspectorAnalyzer = Inspector.new
 
 # Add default parameter to load inspector before test cases run
-module InspectorAnalyzerPrepender
+Hanami::Slice::ClassMethods.prepend(Module.new do
   def router(inspector: InspectorAnalyzer)
     super
   end
-end
-
-Hanami::Slice::ClassMethods.prepend(InspectorAnalyzerPrepender)
+end)
 
 # Extractor for hanami
 class << RSpec::OpenAPI::Extractors::Hanami = Object.new
@@ -63,11 +61,11 @@ class << RSpec::OpenAPI::Extractors::Hanami = Object.new
 
     raw_path_params = route.params
 
-    result = InspectorAnalyzer.call(request.method, add_id(path, route))
+    result = InspectorAnalyzer.call(request.method, replace_path_params(path, route, '/:%{key}'))
 
     summary ||= result[:summary]
     tags ||= result[:tags]
-    path = add_openapi_id(path, route)
+    path = replace_path_params(path, route, '/{%{key}}')
 
     raw_path_params = raw_path_params.slice(*(raw_path_params.keys - RSpec::OpenAPI.ignored_path_params))
 
@@ -101,21 +99,11 @@ class << RSpec::OpenAPI::Extractors::Hanami = Object.new
 
   private
 
-  def add_id(path, route)
-    return path if route.params.empty?
-
-    route.params.each_pair do |key, value|
-      path = path.sub("/#{value}", "/:#{key}")
-    end
-
-    path
-  end
-
-  def add_openapi_id(path, route)
+  def replace_path_params(path, route, format)
     return path if route.params.empty?
 
     route.params.each_pair do |key, value|
-      path = path.sub("/#{value}", "/{#{key}}")
+      path = path.sub("/#{value}", format % { key: key })
     end
 
     path

data/lib/rspec/openapi/record_builder.rb

@@ -12,8 +12,9 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
     return if request.nil?
 
     title = RSpec::OpenAPI.title.then { |t| t.is_a?(Proc) ? t.call(example) : t }
-    path, summary, tags, operation_id, required_request_params, raw_path_params, description, security, deprecated,
-      formats, example_mode, example_key, example_name, response_enum, request_enum = extractor.request_attributes(request, example)
+    path, summary, tags, operation_id, required_request_params, raw_path_params,
+      description, security, deprecated, formats, example_mode, example_key,
+      example_name, response_enum, request_enum = extractor.request_attributes(request, example)
 
     return if RSpec::OpenAPI.ignored_paths.any? { |ignored_path| path.match?(ignored_path) }
 

data/lib/rspec/openapi/schema_builder.rb

@@ -270,8 +270,8 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
     enum_hash = context == :request ? record.request_enum : record.response_enum
     return nil unless enum_hash
 
-    # Try both string and symbol keys
-    enum_hash[path.to_s] || enum_hash[path.to_sym]
+    # Keys are already normalized to strings by SharedExtractor.normalize_enum
+    enum_hash[path.to_s]
   end
 
   # Convert an always-String param to an appropriate type
@@ -319,14 +319,13 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
     content_type&.sub(/;.+\z/, '')
   end
 
-  def normalize_content_disposition(content_disposition)
-    content_disposition&.sub(/;.+\z/, '')
-  end
+  # Same logic as normalize_content_type – strips header parameters after ';'
+  alias normalize_content_disposition normalize_content_type
 
   def build_array_items_schema(array, record: nil, path: nil, context: nil)
     return {} if array.empty?
     return build_property(array.first, record: record, path: path, context: context) if array.size == 1
-    return build_property(array.first, record: record, path: path, context: context) unless array.all? { |item| item.is_a?(Hash) }
+    return build_property(array.first, record: record, path: path, context: context) unless array.all?(Hash)
 
     all_schemas = array.map { |item| build_property(item, record: record, path: path, context: context) }
     merged_schema = all_schemas.first.dup

data/lib/rspec/openapi/schema_cleaner.rb

@@ -70,6 +70,8 @@ class << RSpec::OpenAPI::SchemaCleaner = Object.new
     ]
     paths_to_objects.each do |path|
       parent = base.dig(*path.take(path.length - 1))
+      next unless parent
+
       # "required" array  must not be present if empty
       parent.delete(:required) if parent[:required] && parent[:required].empty?
     end

data/lib/rspec/openapi/schema_merger.rb

@@ -9,6 +9,8 @@ class << RSpec::OpenAPI::SchemaMerger = Object.new
     merge_schema!(base, spec)
   end
 
+  SIMILARITY_THRESHOLD = 0.5
+
   private
 
   # Not doing `base.replace(deep_merge(base, spec))` to preserve key orders.
@@ -121,13 +123,11 @@ class << RSpec::OpenAPI::SchemaMerger = Object.new
   end
 
   def build_unique_params(base, key)
-    base[key].each_with_object({}) do |parameter, hash|
-      hash[[parameter[:name], parameter[:in]]] = parameter
+    base[key].to_h do |parameter|
+      [[parameter[:name], parameter[:in]], parameter]
     end
   end
 
-  SIMILARITY_THRESHOLD = 0.5
-
   # Normalize example/examples fields when there's a conflict
   # OpenAPI spec doesn't allow both example and examples in the same object
   def normalize_example_fields!(base, spec)

data/lib/rspec/openapi/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module OpenAPI
-    VERSION = '0.25.0'
+    VERSION = '0.25.1'
   end
 end

data/lib/rspec/openapi.rb

@@ -33,7 +33,7 @@ module RSpec::OpenAPI
   @comment = nil
   @enable_example = true
   @enable_example_summary = true
-  @description_builder = ->(example) { example.description }
+  @description_builder = :description.to_proc
   @example_name_builder = :description.to_proc
   @summary_builder = ->(example) { example.metadata[:summary] }
   @tags_builder = ->(example) { example.metadata[:tags] }

data/rspec-openapi.gemspec

@@ -31,5 +31,4 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'actionpack', '>= 5.2.0'
   spec.add_dependency 'rails-dom-testing'
   spec.add_dependency 'rspec-core'
-  spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.25.1
 platform: ruby
 authors:
 - Takashi Kokubun
@@ -112,7 +112,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.25.0
+  changelog_uri: https://github.com/exoego/rspec-openapi/releases/tag/v0.25.1
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -128,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs
 test_files: []