rspec-openapi 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d55c7178770a58a980d06669adfab735ba84b51a283302dd8e14e91af4b7b4e9
-  data.tar.gz: 7b0030924262f8a1cd7027df612315b8d6e3fb89e91f9b4e57c3ec83f7e9bfd6
+  metadata.gz: 9749f7a6121a78737336bd436f5fda8b20381a82f4cb507f42667bf3d38a2a4b
+  data.tar.gz: ff0bc4a559323f1285d282ab786b5666c950b8ad0b9585fa749cf1f2b0f3613e
 SHA512:
-  metadata.gz: 4cf846ca12d2062ae17c0b5d1829a7887c206425330c015f5fdde310c59678cb802b4cadb60f63c1ca6d55063c3d4f1cc2ac7813db10c6d8611a0fa3af975192
-  data.tar.gz: 7501fac5fbfd8b0c4cec6cb196feb9ff09a640c4aff7165a93a6880eebea194d5c30674eefadb53987538ebed913d8d43ab625f1a7c8a3a12ad76ba15b459687
+  metadata.gz: 4e412c58158ffaa1518640e3082ef04c41d50ec43de94ef032c866ebbec2468775d4ea3b2c976294f14ce6b8570b3e86df7248f17877c491efa9fc31e5a8819a
+  data.tar.gz: 65d7308f7d552d9ac299a6d3330933283c237345b477de260a2e2af24210268f2e41350619cec83f145f028a7374b197281cbd9752d1cb2aa3baa696f8240739

data/.github/dependabot.yml

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

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

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

data/.github/workflows/rubocop.yml

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

data/.github/workflows/test.yml

@@ -31,9 +31,14 @@ jobs:
       RAILS_VERSION: ${{ matrix.rails == '' && '6.1.6' || matrix.rails }}
       COVERAGE: ${{ matrix.coverage || '' }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: bundle install
         run: bundle install -j$(nproc) --retry 3
+      - name: install simplecov-fork only for minitest with coverage
+        run: |
+          gem install specific_install
+          gem specific_install https://github.com/exoego/simplecov.git branch-fix
+        if: matrix.coverage == 'coverage'
       - run: bundle exec rspec
         timeout-minutes: 1
       - name: Upload coverage reports

data/.simplecov_spawn.rb

@@ -9,6 +9,7 @@ unless ENV['COVERAGE'] && ENV['COVERAGE'].empty?
     SimpleCov::Formatter::CoberturaFormatter,
   ])
   SimpleCov.start do
+    enable_coverage :branch
     add_filter '/spec/'
     add_filter '/scripts/'
   end

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## v0.10.0
+- bugfix: Merge parameter data to preserve description in manually edited Openapi spec 
+  [#149](https://github.com/exoego/rspec-openapi/pull/149)
+- feat: Add ability to configure which path params to ignore
+  [#150](https://github.com/exoego/rspec-openapi/pull/150)
+- feat: Add custom title 
+  [#147](https://github.com/exoego/rspec-openapi/pull/147)
+- feat: Add ability to define custom summary and tags builders
+  [#148](https://github.com/exoego/rspec-openapi/pull/148)
+- enhancement: Sort paths lexicographically so the order of paths is more stable and predictable
+  [#155](https://github.com/exoego/rspec-openapi/pull/155)
+- enhancement: requestBody should not merge requestBody from error examples
+  [#154](https://github.com/exoego/rspec-openapi/pull/154)
+
 ## v0.9.0
 - bugfix: Fix engine path resolution
   [#113](https://github.com/exoego/rspec-openapi/pull/113)

data/Gemfile

@@ -10,7 +10,7 @@ gem 'roda'
 gem 'rspec-rails'
 
 group :test do
-  gem 'simplecov'
+  gem 'simplecov', git: 'https://github.com/exoego/simplecov.git', branch: 'branch-fix'
   gem 'simplecov-cobertura'
   gem 'super_diff'
 end

data/README.md

@@ -1,4 +1,4 @@
-# rspec-openapi ![test](https://github.com/exoego/rspec-openapi/workflows/test/badge.svg) [![codecov](https://codecov.io/gh/exoego/rspec-openapi/branch/master/graph/badge.svg?token=egYm6AlxkD)](https://codecov.io/gh/exoego/rspec-openapi)
+# rspec-openapi [![Gem Version](https://badge.fury.io/rb/rspec-openapi.svg)](https://badge.fury.io/rb/rspec-openapi) [![test](https://github.com/exoego/rspec-openapi/actions/workflows/test.yml/badge.svg)](https://github.com/exoego/rspec-openapi/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/exoego/rspec-openapi/branch/master/graph/badge.svg?token=egYm6AlxkD)](https://codecov.io/gh/exoego/rspec-openapi)
 
 Generate OpenAPI schema from RSpec request specs.
 
@@ -122,6 +122,8 @@ RSpec::OpenAPI.path = -> (example) {
   end
 }
 
+RSpec::OpenAPI.title = 'OpenAPI Documentation'
+
 # Disable generating `example`
 RSpec::OpenAPI.enable_example = false
 
@@ -167,8 +169,21 @@ EOS
 # Generate a custom description, given an RSpec example
 RSpec::OpenAPI.description_builder = -> (example) { example.description }
 
+# Generate a custom summary, given an RSpec example
+# This example uses the summary from the example_group.
+RSpec::OpenAPI.summary_builder = ->(example) { example.metadata.dig(:example_group, :openapi, :summary) }
+
+# Generate a custom tags, given an RSpec example
+# This example uses the tags from the parent_example_group
+RSpec::OpenAPI.tags_builder = -> (example) { example.metadata.dig(:example_group, :parent_example_group, :openapi, :tags) }
+
 # Change the example type(s) that will generate schema
 RSpec::OpenAPI.example_types = %i[request]
+
+# Configure which path params to ignore
+# :controller and :action always exist. :format is added when routes is configured as such.
+RSpec::OpenAPI.ignored_path_params = %i[controller action format]
+
 ```
 
 ### Can I use rspec-openapi with `$ref` to minimize duplication of schema?
@@ -199,7 +214,7 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/User"
-# Note) #/components/schamas is not needed to be defined.
+# Note) #/components/schemas is not needed to be defined.
 ```
 
 3. Then, re-run rspec-openapi. It will generate `#/components/schemas` with the referenced schema (`User` for example) newly-generated or updated.
@@ -278,7 +293,7 @@ If you find a room for improvement, open an issue.
 
 ### How can I add information which can't be generated from RSpec?
 
-rspec-openapi tries to keep manual modifications as much as possible when generating specs.
+rspec-openapi tries to preserve manual modifications as much as possible when generating specs.
 You can directly edit `doc/openapi.yaml` as you like without spoiling the automatic generation capability.
 
 ### Can I exclude specific specs from OpenAPI generation?

data/lib/rspec/openapi/record_builder.rb

@@ -62,8 +62,8 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
 
   def extract_request_attributes(request, example)
     metadata = example.metadata[:openapi] || {}
-    summary = metadata[:summary]
-    tags = metadata[:tags]
+    summary = metadata[:summary] || RSpec::OpenAPI.summary_builder.call(example)
+    tags = metadata[:tags] || RSpec::OpenAPI.tags_builder.call(example)
     operation_id = metadata[:operation_id]
     required_request_params = metadata[:required_request_params] || []
     security = metadata[:security]
@@ -83,7 +83,7 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
       tags ||= [route.requirements[:controller]&.classify].compact
       # :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 = raw_path_params.slice(*(raw_path_params.keys - %i[controller action format]))
+      raw_path_params = raw_path_params.slice(*(raw_path_params.keys - RSpec::OpenAPI.ignored_path_params))
     end
     summary ||= "#{request.method} #{path}"
     [path, summary, tags, operation_id, required_request_params, raw_path_params, description, security]

data/lib/rspec/openapi/result_recorder.rb

@@ -7,7 +7,7 @@ class RSpec::OpenAPI::ResultRecorder
   end
 
   def record_results!
-    title = File.basename(Dir.pwd)
+    title = RSpec::OpenAPI.title
     @path_records.each do |path, records|
       RSpec::OpenAPI::SchemaFile.new(path).edit do |spec|
         schema = RSpec::OpenAPI::DefaultSchema.build(title)
@@ -26,6 +26,7 @@ class RSpec::OpenAPI::ResultRecorder
         RSpec::OpenAPI::SchemaCleaner.cleanup!(spec, new_from_zero)
         RSpec::OpenAPI::ComponentsUpdater.update!(spec, new_from_zero)
         RSpec::OpenAPI::SchemaCleaner.cleanup_empty_required_array!(spec)
+        RSpec::OpenAPI::SchemaCleaner.sort_paths!(spec)
       end
     end
   end

data/lib/rspec/openapi/schema_builder.rb

@@ -120,6 +120,7 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
   def build_request_body(record)
     return nil if record.request_content_type.nil?
     return nil if record.request_params.empty?
+    return nil if record.status >= 400
 
     {
       content: {

data/lib/rspec/openapi/schema_cleaner.rb

@@ -51,6 +51,13 @@ class << RSpec::OpenAPI::SchemaCleaner = Object.new
     end
   end
 
+  # Sort "paths" lexicographically to make the order more predictable
+  #
+  # @param [Hash]   #
+  def sort_paths!(spec)
+    spec['paths'] = spec['paths']&.entries&.sort_by! { |path, _| path }.to_h
+  end
+
   private
 
   def cleanup_array!(base, spec, selector, fields_for_identity = [])

data/lib/rspec/openapi/schema_merger.rb

@@ -43,16 +43,28 @@ class << RSpec::OpenAPI::SchemaMerger = Object.new
   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
+    base[key] = case key
+                when 'parameters'
+                  merge_parameters(base, key, value)
+                when 'required'
+                  # Preserve properties that appears in all test cases
+                  value & base[key]
+                else
+                  # last one wins
+                  value
+                end
+  end
+
+  def merge_parameters(base, key, value)
+    all_parameters = value | base[key]
+
+    unique_base_parameters = base[key].index_by { |parameter| [parameter['name'], parameter['in']] }
+    all_parameters = all_parameters.map do |parameter|
+      base_parameter = unique_base_parameters[[parameter['name'], parameter['in']]] || {}
+      base_parameter ? base_parameter.merge(parameter) : parameter
     end
+
+    all_parameters.uniq! { |param| param.slice('name', 'in') }
+    base[key] = all_parameters
   end
 end

data/lib/rspec/openapi/version.rb

@@ -2,6 +2,6 @@
 
 module RSpec
   module OpenAPI
-    VERSION = '0.9.0'
+    VERSION = '0.10.0'
   end
 end

data/lib/rspec/openapi.rb

@@ -15,9 +15,12 @@ require 'rspec/openapi/rspec_hooks' if ENV['OPENAPI'] && Object.const_defined?('
 
 module RSpec::OpenAPI
   @path = 'doc/openapi.yaml'
+  @title = File.basename(Dir.pwd)
   @comment = nil
   @enable_example = true
   @description_builder = ->(example) { example.description }
+  @summary_builder = ->(example) { example.metadata[:summary] }
+  @tags_builder = ->(example) { example.metadata[:tags] }
   @info = {}
   @application_version = '1.0.0'
   @request_headers = []
@@ -26,12 +29,16 @@ module RSpec::OpenAPI
   @example_types = %i[request]
   @response_headers = []
   @path_records = Hash.new { |h, k| h[k] = [] }
+  @ignored_path_params = %i[controller action format]
 
   class << self
     attr_accessor :path,
+                  :title,
                   :comment,
                   :enable_example,
                   :description_builder,
+                  :summary_builder,
+                  :tags_builder,
                   :info,
                   :application_version,
                   :request_headers,
@@ -39,6 +46,7 @@ module RSpec::OpenAPI
                   :security_schemes,
                   :example_types,
                   :response_headers,
-                  :path_records
+                  :path_records,
+                  :ignored_path_params
   end
 end

data/scripts/rspec_with_simplecov

@@ -36,8 +36,7 @@ begin
     require 'simplecov'
 
     SimpleCov.start do
-      # Flaky :(
-      # enable_coverage :branch
+      enable_coverage :branch
     end
   end
 rescue LoadError

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Takashi Kokubun
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-10 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -47,6 +47,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/codeql-analysis.yml"
 - ".github/workflows/rubocop.yml"
 - ".github/workflows/test.yml"