openapi-ruby 4.0.1 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1104f4d110622c6c94bce175fbb538fa07a5621ecc1d45901eac1d4f5ad1907
-  data.tar.gz: e62100c294bd83d9ddfb8f435bd92af9df3ddfce68fbb0d1e194badb5b799f5a
+  metadata.gz: 27487aa88423921e2f0274f7d93a5abd534dc3fca2567692d07c73001b66017f
+  data.tar.gz: 3f62cffd0f03d943b7198e6d230b5ad851746d4e7982f65ea891d213fd509490
 SHA512:
-  metadata.gz: e04da5e753006dc5342abadf092ac9067ba46b661098eafcf090f9e64a861b6d73a46001ca3b69a21052dd6953cba2beed9fb44238dc186c465ec7fc1ceb1715
-  data.tar.gz: 63bc2eeff43bbd5efbb82c66eb00239797b7f413ada695cd1b1afe1753872d9237bf419a735fcf48cd785f2c2c58074da5a289ae8761c73df382b7d9a11871b6
+  metadata.gz: 580fb57048ffea5a623ba2b7940b83c8bee9a8e7d73db91ccbe566095fcf64b09ae0228fe9a791df6c2a7a9c03f6a14cdb92d65a24cfd7b881bc245715f1e198
+  data.tar.gz: be207593a6158ea4b1fd0cc0758d332f5557ba61788b04a32e8eabbc85ae8300060956d20bfad9198952bccd92e0ce41e76fd2a02e298cf4dff17a8a0ec2cd10

data/README.md

@@ -469,13 +469,41 @@ rake openapi_ruby:generate
 
 This loads spec/test files to collect API definitions and writes schemas without running any tests. It auto-detects the test framework, or you can set `FRAMEWORK=rspec`, `FRAMEWORK=minitest`, or `FRAMEWORK=hybrid`. Custom patterns: `PATTERN="packs/*/spec/**/*_spec.rb"`.
 
+Loading a test file normally *is* enough to run it: `rails/test_help` requires `active_support/testing/autorun`, and `rspec/autorun` does the equivalent — both register an `at_exit` hook that runs the suite. The generated script therefore installs `OpenapiRuby::Generator::AutorunSuppressor` before requiring anything of yours, so the hook is never registered. Generation stays a load-only operation no matter how your helpers are wired.
+
 Schemas are **only** written by the rake task — running tests (`bundle exec rspec`, `rails test`) does not generate or overwrite schema files. This prevents partial schema overwrites when running a subset of specs.
 
+### Making generation cheaper (optional)
+
+Generation only needs your `path` / `api_path` declarations to register. Everything else a test helper does — connecting to a database, loading fixtures, `maintain_test_schema!` — is dead weight, and on a large suite it dominates the runtime.
+
+Guard that setup with `OpenapiRuby.schema_generating?`, which returns `true` only in the rake task's subprocess (it sets `OPENAPI_RUBY_GENERATING=true`):
+
+```ruby
+# test/test_helper.rb
+require "minitest/rails" # keep the spec DSL if your api_path classes use describe/it/let
+
+return if OpenapiRuby.schema_generating?
+
+require "rails/test_help"
+# ...other test-time setup...
+```
+
+This is an optimization, not a correctness requirement — the suppressor handles the autorun hook either way.
+
+One caveat if you do guard: skipping `rails/test_help` also means `fixtures` is undefined, so any test file calling `fixtures :all` in its class body fails to *load*. Point `PATTERN` at just the files carrying `api_path` declarations:
+
+```bash
+PATTERN="test/integration/api/**/*_test.rb" rake openapi_ruby:generate
+```
+
+Suites using FactoryBot rather than fixtures don't hit this.
+
 ### Migrating from RSpec to Minitest (or vice versa)
 
 When both `spec/spec_helper.rb` and `test/test_helper.rb` are present, the rake task auto-selects `FRAMEWORK=hybrid` — it requires both adapters and loads both glob patterns (`spec/**/*_spec.rb,test/**/*_test.rb`) into one process. Style 1 `path(...)` and Style 2 `api_path(...)` definitions register into the same `MetadataStore`, so a single schema file holds paths contributed by either DSL.
 
-Two things to set up on the consumer side so the two test frameworks don't both wire themselves into Rails' lazy-load hooks during schema generation:
+Here the guards described above stop being optional: without them both test frameworks wire themselves into Rails' lazy-load hooks in the same process.
 
 ```ruby
 # test/test_helper.rb
@@ -495,7 +523,7 @@ end
 
 `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.
+Once the migration completes and only one test framework remains, the rake task auto-detects that framework. The guard is then no longer *required* — but it's still worth keeping for the reasons in "Making generation cheaper" above.
 
 ## Runtime Middleware
 

data/lib/openapi_ruby/generator/autorun_suppressor.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module OpenapiRuby
+  module Generator
+    # Schema generation loads the consumer's spec/test files purely to collect
+    # their `path` / `api_path` declarations. Loading them must not also *run*
+    # them.
+    #
+    # Both frameworks install an `at_exit` hook that runs the suite as a side
+    # effect of being required, and a consumer's helper almost always pulls one
+    # in transitively — `rails/test_help` requires
+    # `active_support/testing/autorun`, which calls `Minitest.autorun`; RSpec
+    # does the same via `rspec/autorun`. Without this, `rake openapi_ruby:generate`
+    # runs the entire suite and fails whenever any unrelated test fails.
+    #
+    # Installed by the generated script *before* any consumer file is required,
+    # so the hook is never registered in the first place.
+    module AutorunSuppressor
+      module_function
+
+      def install!
+        suppress_minitest!
+        suppress_rspec!
+      end
+
+      def suppress_minitest!
+        require "minitest"
+
+        ::Minitest.singleton_class.prepend(MinitestSilencer)
+      rescue LoadError
+        # Minitest isn't in the bundle — nothing to suppress.
+      end
+
+      def suppress_rspec!
+        return unless defined?(::RSpec::Core::Runner)
+
+        ::RSpec::Core::Runner.disable_autorun!
+      end
+
+      module MinitestSilencer
+        # Swallow the `at_exit` registration. Defined as a no-op rather than
+        # setting `@@installed_at_exit` so this doesn't depend on Minitest's
+        # internals.
+        def autorun
+          nil
+        end
+
+        # Belt and braces: if something registered the hook before this module
+        # was installed, the hook still fires but finds nothing to do.
+        def run(*)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/openapi_ruby/generator/rake_task_support.rb

@@ -42,9 +42,19 @@ module OpenapiRuby
         end
       end
 
+      # Prepended to every generated script. Loading the consumer's test files
+      # must not run them — see AutorunSuppressor.
+      def suppress_autorun
+        <<~RUBY.chomp
+          require "openapi_ruby/generator/autorun_suppressor"
+          OpenapiRuby::Generator::AutorunSuppressor.install!
+        RUBY
+      end
+
       def rspec_script(pattern)
         <<~RUBY
           require "rspec/core"
+          #{suppress_autorun}
           $LOAD_PATH.unshift(File.expand_path("spec")) unless $LOAD_PATH.include?(File.expand_path("spec"))
           #{glob_loads(pattern)}
           OpenapiRuby::Generator::SchemaWriter.generate_all!
@@ -54,6 +64,7 @@ module OpenapiRuby
       def minitest_script(pattern)
         <<~RUBY
           require "openapi_ruby/minitest"
+          #{suppress_autorun}
           $LOAD_PATH.unshift(File.expand_path("test")) unless $LOAD_PATH.include?(File.expand_path("test"))
           #{glob_loads(pattern)}
           OpenapiRuby::Generator::SchemaWriter.generate_all!
@@ -86,6 +97,7 @@ module OpenapiRuby
           require "rspec/core"
           require "openapi_ruby/rspec"
           require "openapi_ruby/minitest"
+          #{suppress_autorun}
 
           load_with_path = lambda do |dir, glob|
             path = File.expand_path(dir)

data/lib/openapi_ruby/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi-ruby
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.0.2
 platform: ruby
 authors:
 - Morten Hartvig
@@ -105,6 +105,7 @@ files:
 - lib/openapi_ruby/dsl/response_context.rb
 - lib/openapi_ruby/engine.rb
 - lib/openapi_ruby/errors.rb
+- lib/openapi_ruby/generator/autorun_suppressor.rb
 - lib/openapi_ruby/generator/rake_task_support.rb
 - lib/openapi_ruby/generator/schema_writer.rb
 - lib/openapi_ruby/middleware/coercion.rb