rspec-openapi 0.26.0 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 254e5e91a3965a417ad69c8b61d4bfdde6af42ab7aba14854d5531d73f4a793d
-  data.tar.gz: 3fa43709cf02b95bb1f4815eb4eebefde3ad5e5e2aabf0439267dce2c06cba36
+  metadata.gz: 43c486a798aeae6de0f9ecbec34ab2b69a11bb2b1ff053011110c611e5151fc0
+  data.tar.gz: f483a6aca96935df40e9b34386b34548f3322982935c3801bab33ee72d20746e
 SHA512:
-  metadata.gz: 486180ee4a5b04de2f3539864e6f5be519ea262f0b30afc661377aa2da69c9c6fba883128ff02c006a9b073766848fc8b2ef5ad99cbb2fc55f8201de1a5975de
-  data.tar.gz: a074396a8847d7d9950fc414591e68da5c1def3121fdae896aa6e626e512c5860dc58b5be83248979bb6612628f224d367d066a8d5939991fbe98f8000626934
+  metadata.gz: 7860f7a5030487e9671ee926bcf27967c827a4d80f6119eca70c8e9b330c296a5813bc8412d3b210e679700baef2d8710bcd9c9ca24c8b5890a14d90823f8c36
+  data.tar.gz: c2d9e3aaab37b25acc4d1ce563076a2fcb151f33a699268d9035d1559b428f75a75dab52394d0810a0443f031e9f3f338e9996320e5c258b598d0262a71bf1a0

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

@@ -48,52 +48,25 @@ end)
 class << RSpec::OpenAPI::Extractors::Hanami = Object.new
   # @param [ActionDispatch::Request] request
   # @param [RSpec::Core::Example] example
-  # @return Array
+  # @return [Hash]
   def request_attributes(request, example)
     route = Hanami.app.router.recognize(Rack::MockRequest.env_for(request.path, method: request.method))
 
     return RSpec::OpenAPI::Extractors::Rack.request_attributes(request, example) unless route.routable?
 
-    summary, tags, formats, operation_id, required_request_params, security, description, deprecated,
-      request_example_mode, response_example_mode,
-      example_key, example_name, response_enum, request_enum, response_additional_properties,
-      request_additional_properties, response_hybrid_additional_properties,
-      request_hybrid_additional_properties = SharedExtractor.attributes(example)
-
+    attrs = SharedExtractor.attributes(example)
     path = request.path
+    result = InspectorAnalyzer.call(request.method, replace_path_params(path, route, '/:%<key>s'))
 
     raw_path_params = route.params
-
-    result = InspectorAnalyzer.call(request.method, replace_path_params(path, route, '/:%{key}'))
-
-    summary ||= result[:summary]
-    tags ||= result[:tags]
-    path = replace_path_params(path, route, '/{%{key}}')
-
     raw_path_params = raw_path_params.slice(*(raw_path_params.keys - RSpec::OpenAPI.ignored_path_params))
 
-    [
-      path,
-      summary,
-      tags,
-      operation_id,
-      required_request_params,
-      raw_path_params,
-      description,
-      security,
-      deprecated,
-      formats,
-      request_example_mode,
-      response_example_mode,
-      example_key,
-      example_name,
-      response_enum,
-      request_enum,
-      response_additional_properties,
-      request_additional_properties,
-      response_hybrid_additional_properties,
-      request_hybrid_additional_properties,
-    ]
+    attrs.merge(
+      path: replace_path_params(path, route, '/{%<key>s}'),
+      path_params: raw_path_params,
+      summary: attrs[:summary] || result[:summary],
+      tags: attrs[:tags] || result[:tags],
+    )
   end
 
   # @param [RSpec::ExampleGroups::*] context
@@ -111,7 +84,7 @@ class << RSpec::OpenAPI::Extractors::Hanami = Object.new
     return path if route.params.empty?
 
     route.params.each_pair do |key, value|
-      path = path.sub("/#{value}", format % { key: key })
+      path = path.sub("/#{value}", format(format, key: key))
     end
 
     path

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

@@ -4,40 +4,15 @@
 class << RSpec::OpenAPI::Extractors::Rack = Object.new
   # @param [ActionDispatch::Request] request
   # @param [RSpec::Core::Example] example
-  # @return Array
+  # @return [Hash]
   def request_attributes(request, example)
-    summary, tags, formats, operation_id, required_request_params, security, description, deprecated,
-      request_example_mode, response_example_mode,
-      example_key, example_name, response_enum, request_enum, response_additional_properties,
-      request_additional_properties, response_hybrid_additional_properties,
-      request_hybrid_additional_properties = SharedExtractor.attributes(example)
-
-    raw_path_params = request.path_parameters
     path = request.path
-    summary ||= "#{request.method} #{path}"
-
-    [
-      path,
-      summary,
-      tags,
-      operation_id,
-      required_request_params,
-      raw_path_params,
-      description,
-      security,
-      deprecated,
-      formats,
-      request_example_mode,
-      response_example_mode,
-      example_key,
-      example_name,
-      response_enum,
-      request_enum,
-      response_additional_properties,
-      request_additional_properties,
-      response_hybrid_additional_properties,
-      request_hybrid_additional_properties,
-    ]
+    attrs = SharedExtractor.attributes(example)
+    attrs.merge(
+      path: path,
+      path_params: request.path_parameters,
+      summary: attrs[:summary] || "#{request.method} #{path}",
+    )
   end
 
   # @param [RSpec::ExampleGroups::*] context

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

@@ -4,7 +4,7 @@
 class << RSpec::OpenAPI::Extractors::Rails = Object.new
   # @param [ActionDispatch::Request] request
   # @param [RSpec::Core::Example] example
-  # @return Array
+  # @return [Hash]
   def request_attributes(request, example)
     # 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
@@ -16,44 +16,18 @@ class << RSpec::OpenAPI::Extractors::Rails = Object.new
 
     raise "No route matched for #{fixed_request.request_method} #{fixed_request.path_info}" if route.nil?
 
-    summary, tags, formats, operation_id, required_request_params, security, description, deprecated,
-      request_example_mode, response_example_mode,
-      example_key, example_name, response_enum, request_enum, response_additional_properties,
-      request_additional_properties, response_hybrid_additional_properties,
-      request_hybrid_additional_properties = SharedExtractor.attributes(example)
-
-    raw_path_params = request.path_parameters
-
-    summary ||= route.requirements[:action]
-    tags ||= [route.requirements[:controller]&.classify].compact
+    attrs = SharedExtractor.attributes(example)
     # :controller and :action always exist. :format is added when routes is configured as such.
     # TODO: Use .except(:controller, :action, :format) when we drop support for Ruby 2.x
+    raw_path_params = request.path_parameters
     raw_path_params = raw_path_params.slice(*(raw_path_params.keys - RSpec::OpenAPI.ignored_path_params))
 
-    summary ||= "#{request.method} #{path}"
-
-    [
-      path,
-      summary,
-      tags,
-      operation_id,
-      required_request_params,
-      raw_path_params,
-      description,
-      security,
-      deprecated,
-      formats,
-      request_example_mode,
-      response_example_mode,
-      example_key,
-      example_name,
-      response_enum,
-      request_enum,
-      response_additional_properties,
-      request_additional_properties,
-      response_hybrid_additional_properties,
-      request_hybrid_additional_properties,
-    ]
+    attrs.merge(
+      path: path,
+      path_params: raw_path_params,
+      summary: attrs[:summary] || route.requirements[:action] || "#{request.method} #{path}",
+      tags: attrs[:tags] || [route.requirements[:controller]&.classify].compact,
+    )
   end
 
   # @param [RSpec::ExampleGroups::*] context

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

@@ -2,7 +2,7 @@
 
 # Shared extractor for extracting OpenAPI metadata from RSpec examples
 class SharedExtractor
-  VALID_EXAMPLE_MODES = %i[none single multiple].freeze
+  VALID_EXAMPLE_MODES = [:none, :single, :multiple].freeze
 
   EXAMPLE_MODE_MULTIPLE_SHORTHAND_WARNING = <<~MSG.tr("\n", ' ').strip.freeze
     [rspec-openapi] DEPRECATION: example_mode: :multiple currently means
@@ -14,34 +14,41 @@ class SharedExtractor
 
   def self.attributes(example)
     metadata = merge_openapi_metadata(example.metadata)
-    summary = metadata[:summary] || RSpec::OpenAPI.summary_builder.call(example)
-    tags = metadata[:tags] || RSpec::OpenAPI.tags_builder.call(example)
-    formats = metadata[:formats] || RSpec::OpenAPI.formats_builder.curry.call(example)
-    operation_id = metadata[:operation_id]
-    required_request_params = metadata[:required_request_params] || []
-    security = metadata[:security]
-    description = metadata[:description] || RSpec::OpenAPI.description_builder.call(example)
-    deprecated = metadata[:deprecated]
     request_example_mode, response_example_mode = normalize_example_mode(metadata[:example_mode], example)
-    example_name = metadata[:example_name] || RSpec::OpenAPI.example_name_builder.call(example)
-    raw_example_key = metadata[:example_key] || example_name
-    example_key = RSpec::OpenAPI::ExampleKey.normalize(raw_example_key)
-    example_key = 'default' if example_key.nil? || example_key.empty?
-
-    # Enum support: response_enum and request_enum can override the general enum
-    base_enum = normalize_enum(metadata[:enum])
-    response_enum = normalize_enum(metadata[:response_enum]) || base_enum
-    request_enum = normalize_enum(metadata[:request_enum]) || base_enum
-
     response_additional_properties, request_additional_properties = resolve_additional_properties(metadata)
     response_hybrid_additional_properties, request_hybrid_additional_properties =
       resolve_hybrid_additional_properties(metadata)
+    # Enum support: response_enum and request_enum can override the general enum
+    base_enum = normalize_enum(metadata[:enum])
+
+    {
+      summary: metadata[:summary] || RSpec::OpenAPI.summary_builder.call(example),
+      tags: metadata[:tags] || RSpec::OpenAPI.tags_builder.call(example),
+      formats: metadata[:formats] || RSpec::OpenAPI.formats_builder.curry.call(example),
+      operation_id: metadata[:operation_id],
+      required_request_params: metadata[:required_request_params] || [],
+      security: metadata[:security],
+      description: metadata[:description] || RSpec::OpenAPI.description_builder.call(example),
+      deprecated: metadata[:deprecated],
+      request_example_mode: request_example_mode,
+      response_example_mode: response_example_mode,
+      example_key: resolve_example_key(metadata, example),
+      example_name: metadata[:example_name] || RSpec::OpenAPI.example_name_builder.call(example),
+      response_enum: normalize_enum(metadata[:response_enum]) || base_enum,
+      request_enum: normalize_enum(metadata[:request_enum]) || base_enum,
+      response_additional_properties: response_additional_properties,
+      request_additional_properties: request_additional_properties,
+      response_hybrid_additional_properties: response_hybrid_additional_properties,
+      request_hybrid_additional_properties: request_hybrid_additional_properties,
+    }
+  end
 
-    [summary, tags, formats, operation_id, required_request_params, security, description, deprecated,
-     request_example_mode, response_example_mode,
-     example_key, example_name, response_enum, request_enum, response_additional_properties,
-     request_additional_properties, response_hybrid_additional_properties,
-     request_hybrid_additional_properties,]
+  def self.resolve_example_key(metadata, example)
+    example_name = metadata[:example_name] || RSpec::OpenAPI.example_name_builder.call(example)
+    raw_example_key = metadata[:example_key] || example_name
+    example_key = RSpec::OpenAPI::ExampleKey.normalize(raw_example_key)
+    example_key = 'default' if example_key.nil? || example_key.empty?
+    example_key
   end
 
   def self.resolve_additional_properties(metadata)
@@ -96,7 +103,7 @@ class SharedExtractor
   # shorthand for { request: :single, response: :multiple } and emits a one-time
   # deprecation warning) or a Hash with :request / :response keys.
   def self.normalize_example_mode(value, example = nil)
-    return %i[single single] if value.nil?
+    return [:single, :single] if value.nil?
 
     case value
     when Hash
@@ -108,7 +115,7 @@ class SharedExtractor
       mode = coerce_example_mode_value(value, example)
       if mode == :multiple
         warn_example_mode_multiple_shorthand
-        %i[single multiple]
+        [:single, :multiple]
       else
         [mode, mode]
       end

data/lib/rspec/openapi/record_builder.rb

@@ -11,55 +11,34 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
     request, response = extractor.request_response(context)
     return if request.nil?
 
+    attributes = extractor.request_attributes(request, example)
+    return if RSpec::OpenAPI.ignored_paths.any? { |ignored_path| attributes[:path].match?(ignored_path) }
+
     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, request_example_mode, response_example_mode,
-      example_key, example_name, response_enum, request_enum, response_additional_properties,
-      request_additional_properties, response_hybrid_additional_properties,
-      request_hybrid_additional_properties = extractor.request_attributes(request, example)
+    build_record(title, request, response, attributes)
+  end
 
-    return if RSpec::OpenAPI.ignored_paths.any? { |ignored_path| path.match?(ignored_path) }
+  private
 
+  def build_record(title, request, response, attributes)
     request_headers, response_headers = extract_headers(request, response)
-
     RSpec::OpenAPI::Record.new(
       title: title,
       http_method: request.method,
-      path: path,
-      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,
-      formats: formats,
-      operation_id: operation_id,
-      description: description,
-      security: security,
-      deprecated: deprecated,
       status: response.status,
       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'],
       example_enabled: RSpec::OpenAPI.enable_example,
-      request_example_mode: request_example_mode,
-      response_example_mode: response_example_mode,
-      example_key: example_key,
-      example_name: example_name,
-      response_enum: response_enum,
-      request_enum: request_enum,
-      response_additional_properties: response_additional_properties,
-      request_additional_properties: request_additional_properties,
-      response_hybrid_additional_properties: response_hybrid_additional_properties,
-      request_hybrid_additional_properties: request_hybrid_additional_properties,
+      **attributes,
     ).freeze
   end
 
-  private
-
   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'

data/lib/rspec/openapi/schema_builder/build_context.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class << RSpec::OpenAPI::SchemaBuilder
+  # Lookup context threaded through schema building. Bundles the metadata
+  # needed to resolve formats, enums, and additionalProperties overrides for
+  # a value at a given path under a record's request/response side.
+  BuildContext = Struct.new(:record, :context, :path, :key, keyword_init: true) do
+    def descend(child_key)
+      self.class.new(
+        record: record, context: context, key: child_key,
+        path: path ? "#{path}.#{child_key}" : child_key.to_s,
+      )
+    end
+
+    def for_array_items
+      self.class.new(record: record, context: context, path: path, key: nil)
+    end
+  end
+  private_constant :BuildContext
+end