rspec-rails-api 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 331b6d7af2333dde18fea74c45a4e07b01fae9d276540298eed0e7505423ae51
-  data.tar.gz: 1691d15f501cd1d9fd56059b3fea6c9c5b40e2fa21e29c5912ca30c34713b4ce
+  metadata.gz: 2d61d749d64eb07dbb6958760895a8b5335a703a88b4e2eff44f987c526dce52
+  data.tar.gz: df1710c41a7ac14958f5e6ed0dc623597a51abd4f7a47b6d0188d73c9555b98b
 SHA512:
-  metadata.gz: ef79c2fba59a70e1dbd9406360aa321bd59d289da466963cb54c74078dd1b60ad632e711491dfd4e869ce0fe912e8b4d0f30cdf125333ea49bb20691f3f354a9
-  data.tar.gz: bdc2ec91fcea8cd0b3a27bef42f9d83e7a6527c7ad3b4f096066f78eec50fccec35c2db23dbd067f5353dc4d1fed1ee5baf3a70118194a053538cca6f9f951ce
+  metadata.gz: 8b2cae44f3c07fe735199f767ea507d6f79c98cdf22d500026d5ad58aaec006db33b1d381a42b3b647211c7663778b3fdc110cf44db838354bcba228f7954aba
+  data.tar.gz: aa2b145cf56a14f55874dbad7b194b59a0c87e64f8d5b0f046e317e7fbc55ed80f8cc1a5fe9d9a70bedbcb719face6acad778086dbb7be7fcdc2e319d074f4d7

data/CHANGELOG.md

@@ -18,6 +18,18 @@ Maintenance, in case of rework, dependencies change
 
 ## [Unreleased]
 
+## [0.9.0] - 2024-12-26
+
+### Added
+
+- Support for entries of any type: use `:any` as type
+
+## [0.8.3] - 2024-11-22
+
+### Fixed
+
+- Fixed documentation generation of the description on objects and arrays
+
 ## [0.8.2] - 2024-11-22
 
 ### Fixed

data/Gemfile

@@ -10,6 +10,7 @@ gemspec
 gem 'activesupport', '~> 7.2'
 gem 'bundler'
 gem 'byebug'
+gem 'json-schema'
 gem 'rack'
 gem 'rake', '~> 10.0'
 gem 'rspec', '~> 3.0'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rspec-rails-api (0.8.2)
+    rspec-rails-api (0.9.0)
 
 GEM
   remote: https://rubygems.org/
@@ -17,6 +17,8 @@ GEM
       minitest (>= 5.1)
       securerandom (>= 0.3)
       tzinfo (~> 2.0, >= 2.0.5)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.2)
     base64 (0.2.0)
     bigdecimal (3.1.8)
@@ -29,6 +31,9 @@ GEM
     i18n (1.14.6)
       concurrent-ruby (~> 1.0)
     json (2.7.2)
+    json-schema (5.1.1)
+      addressable (~> 2.8)
+      bigdecimal (~> 3.1)
     language_server-protocol (3.17.0.3)
     logger (1.6.1)
     minitest (5.25.1)
@@ -36,6 +41,7 @@ GEM
     parser (3.3.5.0)
       ast (~> 2.4.1)
       racc
+    public_suffix (6.0.1)
     racc (1.8.1)
     rack (3.1.7)
     rainbow (3.1.1)
@@ -94,6 +100,7 @@ DEPENDENCIES
   activesupport (~> 7.2)
   bundler
   byebug
+  json-schema
   rack
   rake (~> 10.0)
   rspec (~> 3.0)

data/README.md

@@ -384,6 +384,7 @@ An attribute should have the following form:
   - `:date`, `:datetime`
   - `:password`
   - `:object`, `:array`
+  - `:any` for an attribute of any type (except `null`; use `required: false` to allow null values)
 
 - `description` should be some valid
   [CommonMark](https://commonmark.org/)

data/lib/rspec/rails/api/open_api_renderer.rb

@@ -226,8 +226,8 @@ module RSpec
           entity.fields.each do |name, field|
             property = {
               description: field.description.presence&.strip || '',
-              type:        PARAM_TYPES[field.type][:type],
             }
+            property[:type] = PARAM_TYPES[field.type][:type] unless field.type == :any
             property[:format] = PARAM_TYPES[field.type][:format] if PARAM_TYPES[field.type][:format]
 
             if PRIMITIVES.include? field.attributes
@@ -235,11 +235,13 @@ module RSpec
             elsif field.type == :object && field.attributes.is_a?(Symbol)
               property = { '$ref' => "#/components/schemas/#{field.attributes}" }
             elsif field.type == :object && field.attributes
-              property = { type: :object, properties: process_entity(field.attributes)[:properties] }
+              property = { type: :object, description: field.description,
+properties: process_entity(field.attributes)[:properties] }
             elsif field.type == :array && field.attributes.is_a?(Symbol)
-              property = { type: :array, items: { '$ref' => "#/components/schemas/#{field.attributes}" } }
+              property = { type: :array, description: field.description,
+items: { '$ref' => "#/components/schemas/#{field.attributes}" } }
             elsif field.type == :array && field.attributes
-              property = { type: :array, items: process_entity(field.attributes) }
+              property = { type: :array, description: field.description, items: process_entity(field.attributes) }
             end
 
             required.push name unless field.required == false

data/lib/rspec/rails/api/validator.rb

@@ -97,7 +97,13 @@ module RSpec
           # @param type  [Symbol] Type to compare to
           #
           # @return [String,NilClass] True when the value corresponds to the given type
-          def validate_type(value, type)
+          def validate_type(value, type) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
+            if type == :any
+              return 'is null' if value.nil?
+
+              return
+            end
+
             if type == :boolean
               return nil if value.is_a?(TrueClass) || value.is_a?(FalseClass)
 

data/lib/rspec/rails/api/version.rb

@@ -3,7 +3,7 @@
 module RSpec
   module Rails
     module Api
-      VERSION = '0.8.2'
+      VERSION = '0.9.0'
     end
   end
 end

data/lib/rspec_rails_api.rb

@@ -34,6 +34,8 @@ module RSpec
         array:    { type: 'array', format: nil, class: Array },
         object:   { type: 'object', format: nil, class: Hash },
         file:     { type: 'string', format: 'binary' },
+        # Not a real type, but we want this
+        any:      {},
       }.freeze
 
       PRIMITIVES = PARAM_TYPES.keys

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-rails-api
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Manuel Tancoigne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-22 00:00:00.000000000 Z
+date: 2024-12-26 00:00:00.000000000 Z
 dependencies: []
 description: |
   Create acceptance tests to check the Rails API responses and generate
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Tests standard Rails API responses and generate doc