openapi-ruby 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e97365e4c2b566d59db1f4946a2b0e1f45f8ee9b938f2b5c049ac0ac9f56dcc
-  data.tar.gz: 431709a674d6a028fd8a14f47200761215a6e4576888009b3b2b637fd5a453b9
+  metadata.gz: 2596878f73873970637c965935c1f4689cc744f3496467d734bd9a2c816904ee
+  data.tar.gz: 2c7f2d7b4497175d0c558f2179888529ae1397d724cba0088248049ef5fda518
 SHA512:
-  metadata.gz: 0a670b21d1043c474b2eead1844c47258521df05b247d561a5578de4c8495a6519b575c7b3d2d4fe4fc54c22d5d524e45ee2fab492e99e3366c8eab5bc381ecf
-  data.tar.gz: e2981bfa965fef6c6db6767d8e36592b8166fa20f675265c9d0147265565250e845093ca4fb3dc3bd3a7d2a2b1c3a7c6cb9d52169a0142bc0be2a90727a50b77
+  metadata.gz: d54c13cb1de806e0e5f21ed1e17d6287a525b00be8654d2c77e554a6bc6762dc206002797874fa6882872754b2bc6438dbfa590e0f3c03f0211383d1fa2490ff
+  data.tar.gz: fb01ab7bb2b8f51d7fb9ef0432a261717d5cf1dc90a7c2c17168f3039456d0b5af99c74eb1853d9ebbf1df80dc8410bbaffa5c53af4f3799960a00c4a128d287

data/README.md

@@ -193,6 +193,31 @@ class Schemas::AdminUser
 end
 ```
 
+### Class References
+
+Instead of writing `$ref` strings manually, you can pass component classes directly anywhere a `$ref` is expected. This gives you typo protection (via `NameError`), IDE navigation, and less boilerplate:
+
+```ruby
+# Instead of:
+schema "$ref" => "#/components/schemas/User"
+schema type: :array, items: { "$ref" => "#/components/schemas/User" }
+
+# You can write:
+schema Schemas::User
+schema type: :array, items: Schemas::User
+```
+
+This works in `schema`, `request_body`, and anywhere nested inside hash/array definitions. Non-component classes raise `ArgumentError`.
+
+You can also use the explicit `.to_ref` method:
+
+```ruby
+Schemas::User.to_ref
+# => { "$ref" => "#/components/schemas/User" }
+```
+
+Both class refs and string `$ref` hashes are fully supported — use whichever you prefer.
+
 ### Strong Params
 
 Schema components can derive Rails strong params permit lists:
@@ -252,7 +277,7 @@ RSpec.describe "Users API", type: :openapi do
       produces "application/json"
 
       response 200, "returns all users" do
-        schema type: :array, items: { "$ref" => "#/components/schemas/User" }
+        schema type: :array, items: Schemas::User
 
         run_test! do
           expect(JSON.parse(response.body).length).to be > 0
@@ -265,19 +290,17 @@ RSpec.describe "Users API", type: :openapi do
       consumes "application/json"
 
       request_body required: true, content: {
-        "application/json" => {
-          schema: { "$ref" => "#/components/schemas/UserInput" }
-        }
+        "application/json" => { schema: Schemas::UserInput }
       }
 
       response 201, "user created" do
-        schema "$ref" => "#/components/schemas/User"
+        schema Schemas::User
         let(:request_body) { { name: "Jane", email: "jane@example.com" } }
         run_test!
       end
 
       response 422, "validation errors" do
-        schema "$ref" => "#/components/schemas/ValidationErrors"
+        schema Schemas::ValidationErrors
         let(:request_body) { { name: "" } }
         run_test!
       end
@@ -289,7 +312,7 @@ RSpec.describe "Users API", type: :openapi do
 
     get "Get a user" do
       response 200, "user found" do
-        schema "$ref" => "#/components/schemas/User"
+        schema Schemas::User
         let(:id) { User.create!(name: "Jane", email: "jane@example.com").id }
         run_test!
       end
@@ -319,7 +342,7 @@ RSpec.describe "Users API", type: :openapi do
       produces "application/json"
 
       response 200, "returns all users" do
-        schema type: :array, items: { "$ref" => "#/components/schemas/User" }
+        schema type: :array, items: Schemas::User
       end
     end
 
@@ -327,17 +350,15 @@ RSpec.describe "Users API", type: :openapi do
       consumes "application/json"
 
       request_body required: true, content: {
-        "application/json" => {
-          schema: { "$ref" => "#/components/schemas/UserInput" }
-        }
+        "application/json" => { schema: Schemas::UserInput }
       }
 
       response 201, "user created" do
-        schema "$ref" => "#/components/schemas/User"
+        schema Schemas::User
       end
 
       response 422, "validation errors" do
-        schema "$ref" => "#/components/schemas/ValidationErrors"
+        schema Schemas::ValidationErrors
       end
     end
   end
@@ -407,7 +428,7 @@ class UsersApiTest < ActionDispatch::IntegrationTest
       produces "application/json"
 
       response 200, "returns all users" do
-        schema type: :array, items: { "$ref" => "#/components/schemas/User" }
+        schema type: :array, items: Schemas::User
       end
     end
 
@@ -415,13 +436,11 @@ class UsersApiTest < ActionDispatch::IntegrationTest
       consumes "application/json"
 
       request_body required: true, content: {
-        "application/json" => {
-          schema: { "$ref" => "#/components/schemas/UserInput" }
-        }
+        "application/json" => { schema: Schemas::UserInput }
       }
 
       response 201, "user created" do
-        schema "$ref" => "#/components/schemas/User"
+        schema Schemas::User
       end
     end
   end

data/lib/openapi_ruby/components/base.rb

@@ -85,6 +85,10 @@ module OpenapiRuby
           end
         end
 
+        def to_ref
+          OpenapiRuby::Core::RefResolver.ref_object(_component_type, component_name)
+        end
+
         def to_openapi
           definition = _schema_definition.deep_dup
 
@@ -147,6 +151,12 @@ module OpenapiRuby
 
         def deep_stringify(value)
           case value
+          when Class
+            if value < OpenapiRuby::Components::Base
+              value.to_ref
+            else
+              raise ArgumentError, "#{value} is not an OpenapiRuby component"
+            end
           when Hash
             value.each_with_object({}) { |(k, v), h| h[k.to_s] = deep_stringify(v) }
           when Array

data/lib/openapi_ruby/dsl/context.rb

@@ -45,6 +45,12 @@ module OpenapiRuby
 
       def deep_stringify(value)
         case value
+        when Class
+          if value < OpenapiRuby::Components::Base
+            value.to_ref
+          else
+            raise ArgumentError, "#{value} is not an OpenapiRuby component"
+          end
         when Hash
           value.each_with_object({}) { |(k, v), h| h[k.to_s] = deep_stringify(v) }
         when Array

data/lib/openapi_ruby/dsl/operation_context.rb

@@ -128,6 +128,12 @@ module OpenapiRuby
 
       def deep_stringify(value)
         case value
+        when Class
+          if value < OpenapiRuby::Components::Base
+            value.to_ref
+          else
+            raise ArgumentError, "#{value} is not an OpenapiRuby component"
+          end
         when Hash
           value.each_with_object({}) { |(k, v), h| h[k.to_s] = deep_stringify(v) }
         when Array

data/lib/openapi_ruby/dsl/response_context.rb

@@ -72,6 +72,12 @@ module OpenapiRuby
 
       def deep_stringify(value)
         case value
+        when Class
+          if value < OpenapiRuby::Components::Base
+            value.to_ref
+          else
+            raise ArgumentError, "#{value} is not an OpenapiRuby component"
+          end
         when Hash
           value.each_with_object({}) { |(k, v), h| h[k.to_s] = deep_stringify(v) }
         when Array

data/lib/openapi_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiRuby
-  VERSION = "3.2.0"
+  VERSION = "3.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi-ruby
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Morten Hartvig