openapi-ruby 3.4.0 → 3.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b58ff6e6c8ccbf7c8c02d01f6a79ea02717cf3c709de9d1c8a8f870bb44a84fb
-  data.tar.gz: e18b82cac3cd08bee2fcbee279d45e9b705b62ad0015feb8e3e5408cf4af63a5
+  metadata.gz: 420f08f5a6cc99f77fc5ecd23c7e280a52b1bc930996ca637c2f61828822cc54
+  data.tar.gz: 831c0a52dd27d6ed1c60986b82d0e71ca271290ea5c22b40653698fd969895ae
 SHA512:
-  metadata.gz: d9248a97e6b5f513516f5d97d87ef81f68047ce4db54c62503667d20751bf15f99fb4644cde3369d017b388184e92e65f904aa171e546c189134d8d1dc742eea
-  data.tar.gz: 4a627ed1b9bc867c24263627a27f01f22d5fc50bfde5ffe9d93e87484c50e68f61e739162c198c808b979d484c9c1a3b80921c14eedd32a9c7b076a702a90cb9
+  metadata.gz: 5e0c13aaa9b0d389f067224265cb11a358679228fafd7e864cefb4cb4a037b3b80b823b4d30050e7b667eb7849c509611490403e042e4f072b78a3af88526e60
+  data.tar.gz: d075ef796755e29033fee117fff4cb6a4177b30749afbd6a57993e9a47273d111cce9f7c672fb87c841af3107e150120dac59655c32652da19108ca60e017821

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/core/document.rb

@@ -46,12 +46,12 @@ module OpenapiRuby
       end
 
       def to_json(*_args)
-        JSON.pretty_generate(@data)
+        JSON.pretty_generate(to_h)
       end
 
       def to_yaml
         require "yaml"
-        @data.to_yaml
+        to_h.to_yaml
       end
 
       def valid?

data/lib/openapi_ruby/generator/rake_task_support.rb

@@ -63,18 +63,44 @@ 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.
+      #
+      # Each glob runs with its own framework's directory at the head
+      # of $LOAD_PATH so the typical `require "openapi_helper"` /
+      # `require "rails_helper"` / `require "test_helper"` resolves
+      # to the right file. Without this, both spec/ and test/ getting
+      # unshifted in one block leads to whichever was unshifted last
+      # winning every lookup — and the wrong helper getting loaded
+      # for the other side's files.
       def hybrid_script(pattern)
+        globs = pattern.split(",").map(&:strip)
+        spec_globs = globs.grep(%r{\bspec/})
+        test_globs = globs.grep(%r{\btest/})
+        other_globs = globs - spec_globs - test_globs
+
         <<~RUBY
           require "rspec/core"
           require "openapi_ruby/rspec"
           require "openapi_ruby/minitest"
-          $LOAD_PATH.unshift(File.expand_path("spec")) unless $LOAD_PATH.include?(File.expand_path("spec"))
-          $LOAD_PATH.unshift(File.expand_path("test")) unless $LOAD_PATH.include?(File.expand_path("test"))
-          #{glob_loads(pattern)}
+
+          load_with_path = lambda do |dir, glob|
+            path = File.expand_path(dir)
+            added = !$LOAD_PATH.include?(path)
+            $LOAD_PATH.unshift(path) if added
+            begin
+              Dir.glob(glob).sort.each { |f| require File.expand_path(f) }
+            ensure
+              $LOAD_PATH.delete(path) if added
+            end
+          end
+
+          #{spec_globs.map { |g| "load_with_path.call(\"spec\", #{g.inspect})" }.join("\n          ")}
+          #{test_globs.map { |g| "load_with_path.call(\"test\", #{g.inspect})" }.join("\n          ")}
+          #{other_globs.map { |g| %[Dir.glob(#{g.inspect}).sort.each { |f| require File.expand_path(f) }] }.join("\n          ")}
+
           OpenapiRuby::Generator::SchemaWriter.generate_all!
         RUBY
       end

data/lib/openapi_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiRuby
-  VERSION = "3.4.0"
+  VERSION = "3.5.1"
 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.1
 platform: ruby
 authors:
 - Morten Hartvig