Contents

# frozen_string_literal: true

class << RSpec::OpenAPI::SchemaMerger = Object.new
  # @param [Hash] base
  # @param [Hash] spec
  def merge!(base, spec)
    spec = normalize_keys(spec)
    merge_schema!(base, spec)
  end

  private

  def normalize_keys(spec)
    case spec
    when Hash
      spec.map do |key, value|
        [key.to_s, normalize_keys(value)]
      end.to_h
    when Array
      spec.map { |s| normalize_keys(s) }
    else
      spec
    end
  end

  # Not doing `base.replace(deep_merge(base, spec))` to preserve key orders.
  # Also this needs to be aware of OpenAPI details because a Hash-like structure
  # may be an array whose Hash elements have a key name.
  #
  # TODO: Should we probably force-merge `summary` regardless of manual modifications?
  def merge_schema!(base, spec)
    spec.each do |key, value|
      if base[key].is_a?(Hash) && value.is_a?(Hash)
        merge_schema!(base[key], value) unless base[key].key?('$ref')
      elsif base[key].is_a?(Array) && value.is_a?(Array)
        # parameters need to be merged as if `name` and `in` were the Hash keys.
        merge_arrays(base, key, value)
      else
        base[key] = value
      end
    end
    base
  end

  def merge_arrays(base, key, value)
    case key
    when 'parameters'
      base[key] = value | base[key]
      base[key].uniq! { |param| param.slice('name', 'in') }
    when 'required'
      # Preserve properties that appears in all test cases
      base[key] = value & base[key]
    else
      # last one wins
      base[key] = value
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
rspec-openapi-0.9.0	lib/rspec/openapi/schema_merger.rb
rspec-openapi-0.8.1	lib/rspec/openapi/schema_merger.rb
rspec-openapi-0.8.0	lib/rspec/openapi/schema_merger.rb