rspec-openapi 0.21.1 → 0.21.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcdab2071b77e7d4df6910839d60df6d3493fcf3bc10c47829fc0609451c5094
-  data.tar.gz: 0efb97d546a285eaa1108dbec9b9dd6598a119b93f46dde04e070cdaf8f029d3
+  metadata.gz: d28b278fc0d9e8f0ce356103ea53e7b97392eac4f7c09fda493a9d7b1e2bfa10
+  data.tar.gz: 501c53f68a84d09f96f40a0e0749d65b2ceba13d16ebeb4819c989fdd7f62c2e
 SHA512:
-  metadata.gz: cb16c77c27f8a766cb5e09bce79d2ef7af160277b274dbd75785f8ca9466e28e6800f498f167644fb16e66b4f6a1dc7becd77b0632d4c1a717b49739e4ed014c
-  data.tar.gz: efa94d5ea193fd56f3ac3b4f220453c3ceb184596688422fff7fe9e14223a44c5427ad17206a7cd4014e16f8e1f4bafc3f3ebdce3a336251a036f5daee83ee2e
+  metadata.gz: 7e4636d3f30bb1114932aabdb6ae2ef40bb9492a08d5d7c9022f52d8b5e4a415e424abc8611a14a8f7f6d8c139947ee900bc50cdfafda19e95bcd6cb06d26142
+  data.tar.gz: 8a3e455ed8a022f5e9df443a14f3159665b77ca4a416b6b3f29404efd367717060f7121fd1a3ec77190d1bc426850b58faf2cc6092c7acc9c18e8f78e732aeb7

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

@@ -25,7 +25,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v5
+      uses: actions/checkout@v6
 
     - name: Initialize CodeQL
       uses: github/codeql-action/init@v4

data/.github/workflows/create_release.yml

@@ -0,0 +1,79 @@
+name: prepare release
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to release (e.g. 0.21.3 or v0.21.3)'
+        required: true
+
+jobs:
+  push:
+    name: Prepare release PR
+    runs-on: ubuntu-latest
+
+    permissions:
+      id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
+      contents: write # required to push release branch and open PR
+      pull-requests: write # required to create the release PR with GITHUB_TOKEN
+
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - 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
+          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@v6
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          add-paths: |
+            lib/rspec/openapi/version.rb
+          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

@@ -0,0 +1,46 @@
+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@v5
+        with:
+          fetch-depth: 0
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ruby
+
+      - 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@v2
+        with:
+          tag_name: ${{ github.ref_name }}
+          name: ${{ github.ref_name }}
+          generate_release_notes: true

data/.github/workflows/rubocop.yml

@@ -14,7 +14,7 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v5
+      uses: actions/checkout@v6
 
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1

data/.github/workflows/test.yml

@@ -32,7 +32,7 @@ jobs:
       RAILS_VERSION: ${{ matrix.rails == '' && '6.1.6' || matrix.rails }}
       COVERAGE: ${{ matrix.coverage || '' }}
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - name: bundle install
         run: bundle install -j$(nproc) --retry 3
       - run: bundle exec rspec

data/.gitignore

@@ -7,6 +7,7 @@
 /spec/reports/
 /tmp/
 /Gemfile.lock
+/vendor/
 .DS_Store
 
 # rspec failure tracking

data/README.md

@@ -410,9 +410,10 @@ Existing RSpec plugins which have OpenAPI integration:
 
 ## Releasing
 
-1. Bump version in `lib/rspec/openapi/version.rb`
-2. Run `bundle exec rake release`
-3. Push tag
+1. Ensure RubyGems trusted publishing is configured for this repo and gem ownership (see [Trusted publishing](https://guides.rubygems.org/trusted-publishing/)).
+2. In GitHub Actions, run the `prepare release` workflow manually. It bumps `lib/rspec/openapi/version.rb`, pushes `release/v<version>` to origin, and opens a PR.
+3. Review and merge the release PR into the default branch.
+4. Create and push a tag `v<version>` on the merged commit (via the GitHub UI or `git tag v<version>; git push origin v<version>`). Tag creation triggers the `Publish to RubyGems` workflow, which publishes the gem and creates the GitHub release notes automatically.
 
 ## License
 

data/lib/rspec/openapi/schema_builder.rb

@@ -256,12 +256,19 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
     all_keys = all_schemas.flat_map { |s| s[:properties]&.keys || [] }.uniq
 
     all_keys.each do |key|
-      property_variations = all_schemas.map { |s| s[:properties]&.[](key) }.compact
+      all_property_schemas = all_schemas.map { |s| s[:properties]&.[](key) }
 
-      next if property_variations.empty?
+      nullable_only_schemas = all_property_schemas.select { |p| p && p.keys == [:nullable] }
+      property_variations = all_property_schemas.select { |p| p && p.keys != [:nullable] }
 
-      if property_variations.size == 1
-        merged_schema[:properties][key] = make_property_nullable(property_variations.first)
+      has_nullable = all_property_schemas.any?(&:nil?) || nullable_only_schemas.any?
+
+      next if property_variations.empty? && !has_nullable
+
+      if property_variations.empty? && has_nullable
+        merged_schema[:properties][key] = { nullable: true }
+      elsif property_variations.size == 1
+        merged_schema[:properties][key] = property_variations.first.dup
       else
         unique_types = property_variations.map { |p| p[:type] }.compact.uniq
 
@@ -275,9 +282,9 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
         else
           merged_schema[:properties][key] = property_variations.first.dup
         end
-
-        merged_schema[:properties][key][:nullable] = true if property_variations.size < all_schemas.size
       end
+
+      merged_schema[:properties][key][:nullable] = true if has_nullable && merged_schema[:properties][key].is_a?(Hash)
     end
 
     all_required_sets = all_schemas.map { |s| s[:required] || [] }
@@ -297,21 +304,34 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
       all_keys = variations.flat_map { |v| v[:properties]&.keys || [] }.uniq
 
       all_keys.each do |key|
-        prop_variations = variations.map { |v| v[:properties]&.[](key) }.compact
+        all_prop_variations = variations.map { |v| v[:properties]&.[](key) }
 
-        if prop_variations.size == 1
-          merged[:properties][key] = make_property_nullable(prop_variations.first)
+        nullable_only = all_prop_variations.select { |p| p && p.keys == [:nullable] }
+        prop_variations = all_prop_variations.select { |p| p && p.keys != [:nullable] }.compact
+
+        has_nullable = all_prop_variations.any?(&:nil?) || nullable_only.any?
+
+        if prop_variations.empty? && has_nullable
+          merged[:properties][key] = { nullable: true }
+        elsif prop_variations.size == 1
+          merged[:properties][key] = prop_variations.first.dup
+          merged[:properties][key][:nullable] = true if has_nullable
         elsif prop_variations.size > 1
           prop_types = prop_variations.map { |p| p[:type] }.compact.uniq
 
           if prop_types.size == 1
-            merged[:properties][key] = prop_variations.first.dup
+            # Only recursively merge if it's an object type
+            merged[:properties][key] = if prop_types.first == 'object'
+                                         build_merged_schema_from_variations(prop_variations)
+                                       else
+                                         prop_variations.first.dup
+                                       end
           else
             unique_props = prop_variations.map { |p| p.reject { |k, _| k == :nullable } }.uniq
             merged[:properties][key] = { oneOf: unique_props }
           end
 
-          merged[:properties][key][:nullable] = true if prop_variations.size < variations.size
+          merged[:properties][key][:nullable] = true if has_nullable || prop_variations.size < variations.size
         end
       end
 
@@ -323,56 +343,4 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
       variations.first
     end
   end
-
-  def merge_object_schemas(schema1, schema2)
-    return schema1 unless schema2.is_a?(Hash) && schema1.is_a?(Hash)
-    return schema1 unless schema1[:type] == 'object' && schema2[:type] == 'object'
-
-    merged = schema1.dup
-
-    if schema1[:properties] && schema2[:properties]
-      merged[:properties] = schema1[:properties].dup
-
-      schema2[:properties].each do |key, prop2|
-        if merged[:properties][key]
-          prop1 = merged[:properties][key]
-          merged[:properties][key] = merge_property_schemas(prop1, prop2)
-        else
-          merged[:properties][key] = make_property_nullable(prop2)
-        end
-      end
-
-      schema1[:properties].each do |key, prop1|
-        merged[:properties][key] = make_property_nullable(prop1) unless schema2[:properties][key]
-      end
-
-      required1 = Set.new(schema1[:required] || [])
-      required2 = Set.new(schema2[:required] || [])
-      merged[:required] = (required1 & required2).to_a
-    end
-
-    merged
-  end
-
-  def merge_property_schemas(prop1, prop2)
-    return prop1 unless prop2.is_a?(Hash) && prop1.is_a?(Hash)
-
-    merged = prop1.dup
-
-    # If either property is nullable, the merged property should be nullable
-    merged[:nullable] = true if prop2[:nullable] && !prop1[:nullable]
-
-    # If both are objects, recursively merge their properties
-    merged = merge_object_schemas(prop1, prop2) if prop1[:type] == 'object' && prop2[:type] == 'object'
-
-    merged
-  end
-
-  def make_property_nullable(property)
-    return property unless property.is_a?(Hash)
-
-    nullable_prop = property.dup
-    nullable_prop[:nullable] = true unless nullable_prop[:nullable]
-    nullable_prop
-  end
 end

data/lib/rspec/openapi/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module OpenAPI
-    VERSION = '0.21.1'
+    VERSION = '0.21.3'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.21.1
+  version: 0.21.3
 platform: ruby
 authors:
 - Takashi Kokubun
@@ -63,6 +63,8 @@ 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"
 - ".gitignore"
@@ -108,7 +110,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.21.1
+  changelog_uri: https://github.com/exoego/rspec-openapi/releases/tag/v0.21.3
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: