rspec-openapi 0.7.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ce13b09ac314ce43bb224b5c8ff1260f283f2a415032418c3908ac51a4a6b8b
-  data.tar.gz: dc9aaa1fe4d3f1228bed06e37cf1b26e87e045b3666b244514587204b31a8b78
+  metadata.gz: ef97d7a9ebc7c50fb3cc6d6ef7d148c375a190680fa1f2a6d6adb4b4971a4106
+  data.tar.gz: 0ca35f6a022fa7a257818b29b5e5dd35d786f2e9374e0833966756bbf1cd51e1
 SHA512:
-  metadata.gz: 37d15147e73665c3dd236e971623a4a7a2feafeb08042191d42952e2b46a0526617bdbce87b2294d62856fc96730a92cee538bd408ea8218190ec8d90c7a151f
-  data.tar.gz: 209e5b659ccaa36c63673314172f1d05e67d1a3d879afb2cb5907d12500dc2fa18c52c42bfc9cb0193d0e4c13a85649f9930b91e52339a5ffa900183aa400be3
+  metadata.gz: 32ccb146dafc799631c7dc37c557d278fbe771f3f017263ff38eaf644ec69967369757f6e7aa48ff0074bff38641dd72354203a36a2f399fe80035c62c9bf85d
+  data.tar.gz: 5932e0c01b98c0b6d662c43b8a3d26f4fa6709699f9eae0de92dc40cabdfb2b3fd8c2c65bfc65bd2a6ff75ab0edac14490f443bd182a4ca1164d039da2f9b5b2

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

@@ -0,0 +1,39 @@
+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@v3
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

data/.github/workflows/rubocop.yml

@@ -0,0 +1,37 @@
+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@v3
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+
+    - name: Install dependencies
+      run: bundle install
+
+    - 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@v2
+      with:
+        sarif_file: rubocop.sarif

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+## v0.7.2
+- $ref enhancements: Support $ref in arbitrary depth
+  [#82](https://github.com/k0kubun/rspec-openapi/pull/82)
+
+## v0.7.1
+- $ref enhancements: Auto-generate components referenced in "items"
+  [#80](https://github.com/k0kubun/rspec-openapi/pull/80)
+- Administration
+  - Setup RuboCop
+    [#73](https://github.com/k0kubun/rspec-openapi/pull/73)
+  - Setup CodeQL
+    [#73](https://github.com/k0kubun/rspec-openapi/pull/73)
+  - Bump Rails v6.0.3.x to fix bundle failure
+    [#72](https://github.com/k0kubun/rspec-openapi/pull/72)
+
+## v0.7.0
+- Generate Response Headers
+  [#69](https://github.com/k0kubun/rspec-openapi/pull/69)
+- Initial support for $ref
+  [#67](https://github.com/k0kubun/rspec-openapi/pull/67)
+- Fixed an empty array is turned into nullable object wrongly
+  [#70](https://github.com/k0kubun/rspec-openapi/pull/70)
+
 ## v0.6.1
 
 * Stabilize the order parameter objects and preserve newer examples

data/Gemfile

@@ -3,7 +3,7 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in rspec-openapi.gemspec
 gemspec
 
-gem 'rails', ENV['RAILS_VERSION'] || '6.0.3.2'
+gem 'rails', ENV['RAILS_VERSION'] || '6.0.3.7'
 gem 'roda'
 gem 'rspec-rails'
 
@@ -13,4 +13,5 @@ end
 
 group :development do
   gem 'pry'
+  gem "code-scanning-rubocop"
 end

data/lib/rspec/openapi/components_updater.rb

@@ -13,9 +13,15 @@ class << RSpec::OpenAPI::ComponentsUpdater = Object.new
     generated_schema_names = fresh_schemas.keys
     nested_refs = find_non_top_level_nested_refs(base, generated_schema_names)
     nested_refs.each do |paths|
-      parent_name = paths[-4]
-      property_name = paths[-2]
-      nested_schema = fresh_schemas.dig(parent_name, 'properties', property_name)
+      # Slice between the parent name and the element before "$ref"
+      # ["components", "schema", "Table", "properties", "database",                       "$ref"]
+      #  0             1         2 ^....................^
+      # ["components", "schema", "Table", "properties", "columns", "items",               "$ref"]
+      #  0             1         2 ^...............................^
+      # ["components", "schema", "Table", "properties", "owner", "properties", "company", "$ref"]
+      #  0             1         2 ^...........................................^
+      needle = paths.slice(2, paths.size - 3)
+      nested_schema = fresh_schemas.dig(*needle)
 
       # Skip if the property using $ref is not found in the parent schema. The property may be removed.
       next if nested_schema.nil?
@@ -53,8 +59,10 @@ class << RSpec::OpenAPI::ComponentsUpdater = Object.new
   end
 
   def find_non_top_level_nested_refs(base, generated_names)
-    nested_refs = RSpec::OpenAPI::HashHelper::matched_paths(base, 'components.schemas.*.properties.*.$ref')
-
+    nested_refs = [
+      *RSpec::OpenAPI::HashHelper.matched_paths_deeply_nested(base, 'components.schemas', 'properties.*.$ref'),
+      *RSpec::OpenAPI::HashHelper.matched_paths_deeply_nested(base, 'components.schemas', 'properties.*.items.$ref')
+    ]
     # Reject already-generated schemas to reduce unnecessary loop
     nested_refs.reject do |paths|
       ref_link = base.dig(*paths)

data/lib/rspec/openapi/hash_helper.rb

@@ -20,4 +20,17 @@ class << RSpec::OpenAPI::HashHelper = Object.new
     end
     selectors
   end
+
+  def matched_paths_deeply_nested(obj, begin_selector, end_selector)
+    path_depth_sizes = paths_to_all_fields(obj).map(&:size).uniq
+    path_depth_sizes.map do |depth|
+      diff = depth - begin_selector.count('.') - end_selector.count('.')
+      if diff >= 0
+        selector = "#{begin_selector}.#{'*.' * diff}#{end_selector}"
+        matched_paths(obj, selector)
+      else
+        []
+      end
+    end.flatten(1)
+  end
 end

data/lib/rspec/openapi/hooks.rb

@@ -12,7 +12,7 @@ error_records = {}
 
 RSpec.configuration.after(:each) do |example|
   if RSpec::OpenAPI.example_types.include?(example.metadata[:type]) && example.metadata[:openapi] != false
-    path = RSpec::OpenAPI.path.yield_self { |path| path.is_a?(Proc) ? path.call(example) : path }
+    path = RSpec::OpenAPI.path.yield_self { |p| p.is_a?(Proc) ? p.call(example) : p }
     record = RSpec::OpenAPI::RecordBuilder.build(self, example: example)
     path_records[path] << record if record
   end

data/lib/rspec/openapi/record.rb

@@ -1,5 +1,5 @@
 RSpec::OpenAPI::Record = Struct.new(
-  :method,                # @param [String]  - "GET"
+  :http_method,           # @param [String]  - "GET"
   :path,                  # @param [String]  - "/v1/status/:id"
   :path_params,           # @param [Hash]    - {:controller=>"v1/statuses", :action=>"create", :id=>"1"}
   :query_params,          # @param [Hash]    - {:query=>"string"}

data/lib/rspec/openapi/record_builder.rb

@@ -49,7 +49,7 @@ class << RSpec::OpenAPI::RecordBuilder = Object.new
     end
 
     RSpec::OpenAPI::Record.new(
-      method: request.request_method,
+      http_method: request.method,
       path: path,
       path_params: raw_path_params(request),
       query_params: request.query_parameters,

data/lib/rspec/openapi/schema_builder.rb

@@ -22,7 +22,7 @@ class << RSpec::OpenAPI::SchemaBuilder = Object.new
     {
       paths: {
         normalize_path(record.path) => {
-          record.method.downcase => {
+          record.http_method.downcase => {
             summary: record.summary,
             tags: record.tags,
             parameters: build_parameters(record),

data/lib/rspec/openapi/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module OpenAPI
-    VERSION = '0.7.0'
+    VERSION = '0.7.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-openapi
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.2
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-24 00:00:00.000000000 Z
+date: 2022-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -46,6 +46,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/FUNDING.yml"
+- ".github/workflows/codeql-analysis.yml"
+- ".github/workflows/rubocop.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
@@ -92,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.24
 signing_key: 
 specification_version: 4
 summary: Generate OpenAPI schema from RSpec request specs