rspec-openapi 0.26.0 → 0.28.0

data/lib/rspec/openapi/schema_cleaner.rb

@@ -27,7 +27,7 @@ class << RSpec::OpenAPI::SchemaCleaner = Object.new
     cleanup_hash!(base, spec, 'paths.*.*')
 
     # cleanup parameters
-    cleanup_array!(base, spec, 'paths.*.*.parameters', %i[name in])
+    cleanup_array!(base, spec, 'paths.*.*.parameters', [:name, :in])
 
     # cleanup requestBody
     cleanup_hash!(base, spec, 'paths.*.*.requestBody.content.application/json.schema.properties.*')

data/lib/rspec/openapi/schema_file.rb

@@ -27,12 +27,10 @@ class RSpec::OpenAPI::SchemaFile
   def read
     return {} unless File.exist?(@path)
 
-    RSpec::OpenAPI::KeyTransformer.symbolize(
-      YAML.safe_load(
-        File.read(@path),
-        permitted_classes: [Date, Time],
-      ),
-    ) # this can also parse JSON
+    content = YAML.safe_load(File.read(@path), permitted_classes: [Date, Time]) # this can also parse JSON
+    return {} if content.nil?
+
+    RSpec::OpenAPI::KeyTransformer.symbolize(content)
   end
 
   # @param [Hash] spec

data/lib/rspec/openapi/schema_merger.rb

@@ -25,37 +25,51 @@ class << RSpec::OpenAPI::SchemaMerger = Object.new
       return base
     end
 
-    # When the new spec converts an object to a dictionary (introduces
-    # `additionalProperties` on a node that previously had `properties` /
-    # `required`), drop the stale fields so the merged result reflects the
-    # new intent. We only prune when base does not already declare
-    # `additionalProperties`, to preserve manual edits that intentionally
-    # combine fixed and dynamic keys.
-    if spec.is_a?(Hash) && spec.key?(:additionalProperties) && !base.key?(:additionalProperties)
-      base.delete(:properties)
-      base.delete(:required)
+    prune_stale_object_fields!(base, spec)
+
+    spec.each { |key, value| merge_entry!(base, key, value) }
+    base
+  end
+
+  # When the new spec converts an object to a dictionary (introduces
+  # `additionalProperties` on a node that previously had `properties` /
+  # `required`), drop the stale fields so the merged result reflects the
+  # new intent. We only prune when base does not already declare
+  # `additionalProperties`, to preserve manual edits that intentionally
+  # combine fixed and dynamic keys.
+  def prune_stale_object_fields!(base, spec)
+    return unless spec.is_a?(Hash) && spec.key?(:additionalProperties) && !base.key?(:additionalProperties)
+
+    base.delete(:properties)
+    base.delete(:required)
+  end
+
+  def merge_entry!(base, key, value)
+    if base[key].is_a?(Hash) && value.is_a?(Hash)
+      merge_hash_entry!(base, key, value)
+    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)
+    elsif !skip_due_to_additional_properties?(base, key)
+      base[key] = value
     end
+  end
 
-    spec.each do |key, value|
-      if base[key].is_a?(Hash) && value.is_a?(Hash)
-        # Handle example/examples conflict - convert to examples when mixed
-        normalize_example_fields!(base[key], value)
-
-        # If the new value has oneOf, replace the entire value instead of merging
-        if value.key?(:oneOf)
-          base[key] = value
-        else
-          merge_schema!(base[key], value) unless base[key].key?(:$ref)
-        end
-      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
-        # do not ADD `properties` or `required` fields if `additionalProperties` field is present
-        base[key] = value unless base.key?(:additionalProperties) && %i[properties required].include?(key)
-      end
+  def merge_hash_entry!(base, key, value)
+    # Handle example/examples conflict - convert to examples when mixed
+    normalize_example_fields!(base[key], value)
+
+    # If the new value has oneOf, replace the entire value instead of merging
+    if value.key?(:oneOf)
+      base[key] = value
+    elsif !base[key].key?(:$ref)
+      merge_schema!(base[key], value)
     end
-    base
+  end
+
+  # do not ADD `properties` or `required` fields if `additionalProperties` field is present
+  def skip_due_to_additional_properties?(base, key)
+    base.key?(:additionalProperties) && [:properties, :required].include?(key)
   end
 
   def merge_arrays(base, key, value)
@@ -72,21 +86,33 @@ class << RSpec::OpenAPI::SchemaMerger = Object.new
   end
 
   def merge_parameters(base, key, value)
-    all_parameters = value | base[key]
-
-    unique_base_parameters = build_unique_params(base, key)
-
-    all_parameters = all_parameters.map do |parameter|
-      base_parameter = unique_base_parameters[[parameter[:name], parameter[:in]]] || {}
-      if base_parameter.empty?
-        parameter
+    base_params = index_parameters_by_identity(base[key])
+    new_params = index_parameters_by_identity(value)
+
+    base[key] = (base_params.keys | new_params.keys).map do |param_key|
+      base_param = base_params[param_key]
+      new_param = new_params[param_key]
+
+      if base_param && new_param
+        merge_parameter_with_schema(base_param, new_param)
+      elsif new_param
+        # Parameter only in the new spec. Treat as optional unless its `required: true`
+        # came from explicit `required_request_params` metadata — distinguishable only
+        # for `query`, where the schema_builder default is `required: false`. `header`
+        # defaults to `required: true`, so the value alone can't signal user intent.
+        new_param[:in] == 'query' && new_param[:required] ? new_param : mark_optional_unless_path(new_param)
       else
-        merge_parameter_with_schema(base_parameter, parameter)
+        mark_optional_unless_path(base_param)
       end
     end
+  end
+
+  # OpenAPI requires `in: path` parameters to be `required: true`, so this leaves
+  # them untouched.
+  def mark_optional_unless_path(parameter)
+    return parameter if parameter[:in] == 'path'
 
-    all_parameters.uniq! { |param| param.slice(:name, :in) }
-    base[key] = all_parameters
+    parameter.merge(required: false)
   end
 
   def merge_parameter_with_schema(base_param, new_param)
@@ -94,12 +120,18 @@ class << RSpec::OpenAPI::SchemaMerger = Object.new
     new_schema = new_param[:schema]
 
     # If schemas have different types, create a oneOf
-    if base_schema && new_schema && schemas_have_different_types?(base_schema, new_schema)
-      merged_schema = merge_schemas_into_one_of(base_schema, new_schema)
-      base_param.merge(new_param).merge(schema: merged_schema)
-    else
-      base_param.merge(new_param)
-    end
+    merged = if base_schema && new_schema && schemas_have_different_types?(base_schema, new_schema)
+               merged_schema = merge_schemas_into_one_of(base_schema, new_schema)
+               base_param.merge(new_param).merge(schema: merged_schema)
+             else
+               base_param.merge(new_param)
+             end
+
+    # Once a parameter has been seen missing in any earlier test case, keep it optional
+    # even if later test cases mark it required again.
+    merged = mark_optional_unless_path(merged) if base_param[:required] == false || new_param[:required] == false
+
+    merged
   end
 
   def schemas_have_different_types?(schema1, schema2)
@@ -133,10 +165,8 @@ class << RSpec::OpenAPI::SchemaMerger = Object.new
     end
   end
 
-  def build_unique_params(base, key)
-    base[key].to_h do |parameter|
-      [[parameter[:name], parameter[:in]], parameter]
-    end
+  def index_parameters_by_identity(parameters)
+    parameters.to_h { |p| [[p[:name], p[:in]], p] }
   end
 
   # Normalize example/examples fields when there's a conflict

data/lib/rspec/openapi/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module OpenAPI
-    VERSION = '0.26.0'
+    VERSION = '0.28.0'
   end
 end

data/lib/rspec/openapi.rb

@@ -43,10 +43,10 @@ module RSpec::OpenAPI
   @request_headers = []
   @servers = []
   @security_schemes = []
-  @example_types = %i[request]
+  @example_types = [:request]
   @response_headers = []
   @path_records = Hash.new { |h, k| h[k] = [] }
-  @ignored_path_params = %i[controller action format]
+  @ignored_path_params = [:controller, :action, :format]
   @ignored_paths = []
   @post_process_hook = nil
 

data/rspec-openapi.gemspec

@@ -22,10 +22,10 @@ Gem::Specification.new do |spec|
   }
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").select do |f|
+      f.start_with?('lib/') || ['LICENSE.txt', 'README.md', 'rspec-openapi.gemspec'].include?(f)
+    end
   end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.add_dependency 'actionpack', '>= 5.2.0'

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.28.0
 platform: ruby
 authors:
 - Takashi Kokubun
 - TATSUNO Yasuhiro
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
@@ -60,26 +60,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/dependabot.yml"
-- ".github/release.yaml"
-- ".github/workflows/codeql-analysis.yml"
-- ".github/workflows/create_release.yml"
-- ".github/workflows/publish.yml"
-- ".github/workflows/rubocop.yml"
-- ".github/workflows/test.yml"
-- ".github/workflows/validate-openapi.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".simplecov_spawn.rb"
-- CHANGELOG.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/rspec/openapi.rb
 - lib/rspec/openapi/components_updater.rb
 - lib/rspec/openapi/default_schema.rb
@@ -97,24 +79,21 @@ files:
 - lib/rspec/openapi/result_recorder.rb
 - lib/rspec/openapi/rspec_hooks.rb
 - lib/rspec/openapi/schema_builder.rb
+- lib/rspec/openapi/schema_builder/build_context.rb
 - lib/rspec/openapi/schema_cleaner.rb
 - lib/rspec/openapi/schema_file.rb
 - lib/rspec/openapi/schema_merger.rb
 - lib/rspec/openapi/schema_sorter.rb
 - lib/rspec/openapi/shared_hooks.rb
 - lib/rspec/openapi/version.rb
-- redocly.yaml
 - rspec-openapi.gemspec
-- scripts/rspec
-- scripts/rspec_with_simplecov
-- test.png
 homepage: https://github.com/exoego/rspec-openapi
 licenses:
 - MIT
 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.26.0
+  changelog_uri: https://github.com/exoego/rspec-openapi/releases/tag/v0.28.0
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
@@ -130,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs
 test_files: []

data/.github/dependabot.yml

@@ -1,8 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "monthly"
-    labels:
-      - "chore"

data/.github/release.yaml

@@ -1,24 +0,0 @@
-changelog:
-  exclude:
-    labels:
-      - ignore-for-release
-    authors:
-      - octocat
-  categories:
-    - title: 🛠 Breaking Changes
-      labels:
-        - semver-major
-        - breaking-change
-    - title: 🎉 Exciting New Features
-      labels:
-        - semver-minor
-        - enhancement
-    - title: 🐞 Bugfixes
-      labels:
-        - bug
-    - title: 📄 Documentation
-      labels:
-        - documentation
-    - title: 📦 Other Changes
-      labels:
-        - "*"

data/.github/workflows/codeql-analysis.yml

@@ -1,39 +0,0 @@
-name: "CodeQL"
-
-on:
-  push:
-    branches: [ "master" ]
-  pull_request:
-    # The branches below must be a subset of the branches above
-    branches: [ "master" ]
-  schedule:
-    - cron: '20 22 * * 2'
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-latest
-    permissions:
-      actions: read
-      contents: read
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        language: [ 'ruby' ]
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v6
-
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v4
-      with:
-        languages: ${{ matrix.language }}
-        
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v4
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v4

data/.github/workflows/create_release.yml

@@ -1,95 +0,0 @@
-name: prepare release
-
-on:
-  workflow_dispatch:
-    inputs:
-      version:
-        description: 'Version to release (e.g. 0.26.1 or 0.27.0)'
-        required: true
-
-jobs:
-  push:
-    name: Prepare release PR
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v6
-        with:
-          fetch-depth: 0
-          token: ${{ secrets.PREPARE_RELEASE_PAT }}
-
-      - name: Bump version.rb
-        run: |
-          set -euo pipefail
-          version="${{ github.event.inputs.version }}"
-          version="${version#v}"
-
-          echo "VERSION_NO_V=$version" >> "$GITHUB_ENV"
-          echo "VERSION_TAG=v$version" >> "$GITHUB_ENV"
-
-          current_version=$(ruby -e "require_relative './lib/rspec/openapi/version'; puts RSpec::OpenAPI::VERSION")
-          VERSION_NO_V="$version" CURRENT_VERSION="$current_version" ruby - <<'RUBY'
-            version = ENV.fetch('VERSION_NO_V')
-            unless version.match?(/\A\d+(?:\.\d+)*\z/)
-              warn "Invalid version format: #{version}"
-              exit 1
-            end
-
-            require 'rubygems'
-            new_version = Gem::Version.new(version)
-            current_version = Gem::Version.new(ENV.fetch('CURRENT_VERSION'))
-            if new_version <= current_version
-              warn "Given version (#{new_version}) must be newer than current version (#{current_version})"
-              exit 1
-            end
-          RUBY
-          ruby -pi -e "sub(/VERSION = .*/, \"VERSION = '$version'\")" lib/rspec/openapi/version.rb
-
-          VERSION_NO_V="$version" ruby - <<'RUBY'
-            version = ENV.fetch('VERSION_NO_V')
-            segments = version.split('.').map(&:to_i)
-            unless segments.size >= 3
-              warn "Version must have at least major.minor.patch: #{version}"
-              exit 1
-            end
-
-            major, minor, patch = segments
-            patch_bump = [major, minor, patch + 1].join('.')
-            minor_bump = [major, minor + 1, 0].join('.')
-            example = "Version to release (e.g. #{patch_bump} or #{minor_bump})"
-
-            path = ".github/workflows/create_release.yml"
-            content = File.read(path)
-            content.sub!(/description:\s*'Version to release \(e\.g\. [^']+\)'/,
-                         "description: '#{example}'")
-            File.write(path, content)
-          RUBY
-          git status --short
-
-      - name: Commit version bump
-        run: |
-          set -euo pipefail
-          version="$VERSION_NO_V"
-
-          release_branch="release/v${version}"
-          echo "RELEASE_BRANCH=${release_branch}" >> "$GITHUB_ENV"
-
-          git config user.name "github-actions[bot]"
-          git config user.email "github-actions[bot]@users.noreply.github.com"
-          git commit -am "Bump version to ${version}"
-          git push origin "HEAD:${release_branch}"
-
-      - name: Open release PR
-        uses: peter-evans/create-pull-request@v8
-        with:
-          token: ${{ secrets.PREPARE_RELEASE_PAT }}
-          add-paths: |
-            lib/rspec/openapi/version.rb
-            .github/workflows/create_release.yml
-          branch: ${{ env.RELEASE_BRANCH }}
-          title: Release v${{ env.VERSION_NO_V }}
-          commit-message: Bump version to ${{ env.VERSION_NO_V }}
-          body: |
-            Automated release PR created by workflow_dispatch.
-            - Version: v${{ env.VERSION_NO_V }}
-            - Triggered by: ${{ github.actor }}

data/.github/workflows/publish.yml

@@ -1,46 +0,0 @@
-name: Publish to RubyGems
-
-on:
-  push:
-    tags:
-      - 'v*'
-
-jobs:
-  publish:
-    name: Publish gem and GitHub release
-    runs-on: ubuntu-latest
-
-    permissions:
-      id-token: write   # for RubyGems trusted publishing
-      contents: write   # to create GitHub release
-
-    steps:
-      - uses: actions/checkout@v6
-        with:
-          fetch-depth: 0
-
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-          ruby-version: '4.0'
-
-      - name: Verify tag matches version.rb
-        run: |
-          set -euo pipefail
-          tag="${GITHUB_REF_NAME}"
-          version="${tag#v}"
-          file_version=$(ruby -e "require_relative './lib/rspec/openapi/version'; puts RSpec::OpenAPI::VERSION")
-          if [ "$version" != "$file_version" ]; then
-            echo "Tag version ($version) does not match lib/rspec/openapi/version.rb ($file_version)" >&2
-            exit 1
-          fi
-
-      - uses: rubygems/release-gem@v1
-
-      - name: Create GitHub release
-        uses: softprops/action-gh-release@v3
-        with:
-          tag_name: ${{ github.ref_name }}
-          name: ${{ github.ref_name }}
-          generate_release_notes: true

data/.github/workflows/rubocop.yml

@@ -1,35 +0,0 @@
-name: "Rubocop"
-
-on:
-  push:
-    branches: [ "master" ]
-  pull_request:
-    branches: [ "master" ]
-
-jobs:
-  rubocop:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@v6
-
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: '4.0'
-        bundler-cache: true
-
-    - name: Rubocop run
-      run: |
-        bash -c "
-          bundle exec rubocop --require code_scanning --format CodeScanning::SarifFormatter -o rubocop.sarif
-          [[ $? -ne 2 ]]
-        "
-
-    - name: Upload Sarif output
-      uses: github/codeql-action/upload-sarif@v4
-      with:
-        sarif_file: rubocop.sarif

data/.github/workflows/test.yml

@@ -1,50 +0,0 @@
-name: test
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-    types:
-      - opened
-      - synchronize
-      - reopened
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    container: ${{ matrix.ruby }}
-    strategy:
-      fail-fast: false
-      matrix:
-        include:
-          - ruby: ruby:2.7
-          - ruby: ruby:3.0
-          - ruby: ruby:3.1
-          - ruby: ruby:3.1
-            rails: 6.1.7
-          - ruby: ruby:3.1
-            rails: 7.0.8
-          - ruby: ruby:3.3
-            rails: 7.1.3.2
-          - ruby: ruby:3.4
-            rails: 8.0.2
-          - ruby: ruby:4.0
-            rails: 8.1.2
-            coverage: coverage
-    env:
-      RAILS_VERSION: ${{ matrix.rails == '' && '6.1.6' || matrix.rails }}
-      COVERAGE: ${{ matrix.coverage || '' }}
-    steps:
-      - uses: actions/checkout@v6
-      - name: bundle install
-        run: bundle install -j$(nproc) --retry 3
-      - run: bundle exec rspec
-        timeout-minutes: 1
-      - run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
-        name: codecov-action@v4 workaround
-      - name: Upload coverage reports
-        uses: codecov/codecov-action@v6
-        if: matrix.coverage == 'coverage'
-        with:
-          fail_ci_if_error: true
-          files: ./coverage/coverage.xml
-          token: ${{ secrets.CODECOV_TOKEN }}

data/.github/workflows/validate-openapi.yml

@@ -1,21 +0,0 @@
-name: validate-openapi
-
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-    types:
-      - opened
-      - synchronize
-      - reopened
-
-jobs:
-  redocly-lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v6
-      - uses: actions/setup-node@v4
-        with:
-          node-version: '22'
-      - run: npx --yes @redocly/cli@2.30.4 lint

data/.gitignore

@@ -1,18 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/Gemfile.lock
-/vendor/
-.DS_Store
-
-# rspec failure tracking
-.rspec_status
-
-spec/apps/rails/log/
-
-/mise.toml

data/.rspec

@@ -1,4 +0,0 @@
---exclude-pattern spec/requests/**/*_spec.rb
---format documentation
---require rspec/openapi
---color