openapi-ruby 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b58ff6e6c8ccbf7c8c02d01f6a79ea02717cf3c709de9d1c8a8f870bb44a84fb
-  data.tar.gz: e18b82cac3cd08bee2fcbee279d45e9b705b62ad0015feb8e3e5408cf4af63a5
+  metadata.gz: 4fd91990e73c6bcd5fae00558bb63afd1c4999de976b16d542aa495ddf2ad6a4
+  data.tar.gz: 19391cec8179b314284b51afa6adc977849f75aa431a7ec54df70f29b9877e45
 SHA512:
-  metadata.gz: d9248a97e6b5f513516f5d97d87ef81f68047ce4db54c62503667d20751bf15f99fb4644cde3369d017b388184e92e65f904aa171e546c189134d8d1dc742eea
-  data.tar.gz: 4a627ed1b9bc867c24263627a27f01f22d5fc50bfde5ffe9d93e87484c50e68f61e739162c198c808b979d484c9c1a3b80921c14eedd32a9c7b076a702a90cb9
+  metadata.gz: e9384c41d176a5cdf12a8164a148e8ff0a853aa15c73b06efb4f32bc96d40aaa18d4667c93ab6db863bf12de8eac783308a232a99dad66f755b3e1141ad456e5
+  data.tar.gz: c6d8b92d8473ac2f2582632c93d1f5d72fc41645b3c34a0b88192530d0bd1808aef836ac99b8864a92a88cb0587a89f1b0cf867811190e2758fdb86900e25552

data/README.md

@@ -481,7 +481,7 @@ Two things to set up on the consumer side so the two test frameworks don't both
 
 ```ruby
 # test/test_helper.rb
-unless ENV["OPENAPI_RUBY_GENERATING"]
+unless OpenapiRuby.schema_generating?
   require "rails/test_help"
   # ...other test-time setup...
 end
@@ -489,13 +489,15 @@ end
 
 ```ruby
 # spec/rails_helper.rb
-unless ENV["OPENAPI_RUBY_GENERATING"]
+unless OpenapiRuby.schema_generating?
   require "rspec/rails"
   # ...other spec-time setup...
 end
 ```
 
-The rake task sets `OPENAPI_RUBY_GENERATING=true` in the subprocess. With the guards in place, neither test framework boots its full Rails integration during generation — only the DSL needs to be live for `api_path` / `path` to register.
+`OpenapiRuby.schema_generating?` returns `true` when the rake task launched the current process (it sets `OPENAPI_RUBY_GENERATING=true` in the subprocess). With the guards in place, neither test framework boots its full Rails integration during generation — only the DSL needs to be live for `api_path` / `path` to register.
+
+The guards are only needed while both frameworks are live. Once the migration completes and only one test framework remains, the rake task auto-detects that framework and the guard becomes dead code that can be removed.
 
 ## Runtime Middleware
 

data/lib/openapi_ruby/generator/rake_task_support.rb

@@ -63,7 +63,7 @@ module OpenapiRuby
       # during a phased RSpec → Minitest migration where the suite
       # holds both DSL styles. Consumers should guard
       # `require "rails/test_help"` and `require "rspec/rails"` in
-      # their test helpers with `unless ENV["OPENAPI_RUBY_GENERATING"]`
+      # their test helpers with `unless OpenapiRuby.schema_generating?`
       # so the two test frameworks don't both register Rails lazy
       # hooks in the same process — only the DSL needs to be live for
       # schema generation.

data/lib/openapi_ruby/version.rb

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

data/lib/openapi_ruby.rb

@@ -27,6 +27,22 @@ module OpenapiRuby
     def reset_configuration!
       @configuration = Configuration.new
     end
+
+    # True when the current process was started by `openapi_ruby:generate`
+    # (the rake task sets OPENAPI_RUBY_GENERATING=true in the subprocess).
+    #
+    # Useful in consumer test helpers to guard test-framework requires
+    # that conflict when both `rspec/rails` and `rails/test_help` load
+    # in the same process (the FRAMEWORK=hybrid case):
+    #
+    #   # test/test_helper.rb
+    #   unless OpenapiRuby.schema_generating?
+    #     require "rails/test_help"
+    #     # ...other test-time setup...
+    #   end
+    def schema_generating?
+      ENV["OPENAPI_RUBY_GENERATING"] == "true"
+    end
   end
 end
 

metadata

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