openapi-ruby 4.0.2 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27487aa88423921e2f0274f7d93a5abd534dc3fca2567692d07c73001b66017f
-  data.tar.gz: 3f62cffd0f03d943b7198e6d230b5ad851746d4e7982f65ea891d213fd509490
+  metadata.gz: f4bf806084ec440728b07b1cb5105c2e2f8529852b143a087bb919111afd6498
+  data.tar.gz: d73357f612fa69222d354a2f122a496c63bf8d8259ddb15bdfb38c898c7fb335
 SHA512:
-  metadata.gz: 580fb57048ffea5a623ba2b7940b83c8bee9a8e7d73db91ccbe566095fcf64b09ae0228fe9a791df6c2a7a9c03f6a14cdb92d65a24cfd7b881bc245715f1e198
-  data.tar.gz: be207593a6158ea4b1fd0cc0758d332f5557ba61788b04a32e8eabbc85ae8300060956d20bfad9198952bccd92e0ce41e76fd2a02e298cf4dff17a8a0ec2cd10
+  metadata.gz: ea9f2ab82f0cdae01a6a578daa13f7274914a77b2476ba4ff7bbaf4cfd991ea685c608dcd71eac23bb2bc9ebf0ce35d0ac764b63a89bbb35add7e95c73a9d048
+  data.tar.gz: b940f94f696df915e90eccc593ae3901b1bc63229b4158391da62ffddb7fef1932a788358c1bffe771054f3e7d5f68faae36ff549ebb2c1166c078ed8ee58c66

data/README.md

@@ -473,9 +473,17 @@ Loading a test file normally *is* enough to run it: `rails/test_help` requires `
 
 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.
 
+### No database required
+
+The document is built from your declarations, never from the database — but `rails/test_help` verifies the test schema at require time (`maintain_test_schema!`), and many hand-written helpers add `ActiveRecord::Migration.check_all_pending!`. Both open a connection, which would make a database a hard requirement for generating a document that doesn't need one.
+
+Generation stubs both out, so `rake openapi_ruby:generate` runs with no database available. Nothing else about your helper changes, and the stubs exist only inside the generation subprocess — normal test runs still verify the schema as usual.
+
+Only the schema *check* is skipped. A connection is still available if your declarations genuinely need one (an enum built from a query at load time, say); such a suite needs a database either way.
+
 ### 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.
+Generation only needs your `path` / `api_path` declarations to register. Booting the full test framework and loading fixtures 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`):
 
@@ -489,7 +497,7 @@ require "rails/test_help"
 # ...other test-time setup...
 ```
 
-This is an optimization, not a correctness requirement — the suppressor handles the autorun hook either way.
+This is purely an optimization — generation is already correct and database-free without it.
 
 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:
 

data/lib/openapi_ruby/generator/rake_task_support.rb

@@ -42,12 +42,15 @@ module OpenapiRuby
         end
       end
 
-      # Prepended to every generated script. Loading the consumer's test files
-      # must not run them — see AutorunSuppressor.
+      # Prepended to every generated script, before any consumer file is
+      # required. Loading the consumer's test files must neither run them
+      # (AutorunSuppressor) nor drag in a database (TestSchemaSuppressor).
       def suppress_autorun
         <<~RUBY.chomp
           require "openapi_ruby/generator/autorun_suppressor"
+          require "openapi_ruby/generator/test_schema_suppressor"
           OpenapiRuby::Generator::AutorunSuppressor.install!
+          OpenapiRuby::Generator::TestSchemaSuppressor.install!
         RUBY
       end
 

data/lib/openapi_ruby/generator/test_schema_suppressor.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module OpenapiRuby
+  module Generator
+    # Schema generation never runs tests, so keeping the test database's schema
+    # current is wasted work — but `rails/test_help` does it unconditionally at
+    # require time (`rails/testing/maintain_test_schema` → `maintain_test_schema!`),
+    # which opens a database connection. That makes a database a hard
+    # requirement for generating a document that doesn't depend on one.
+    #
+    # `maintain_test_schema!` is a no-op when the setting is off, so turning it
+    # off for the generation subprocess drops the requirement.
+    #
+    # This only skips the schema *check*. A connection is still available if the
+    # consumer's declarations genuinely need one (say, an enum built from a
+    # query at load time) — such a suite needs a database either way.
+    module TestSchemaSuppressor
+      module_function
+
+      def install!
+        return unless defined?(::ActiveSupport) && ::ActiveSupport.respond_to?(:on_load)
+
+        # Registered as a load hook so it applies whenever the consumer's helper
+        # boots Rails, rather than depending on require order.
+        ::ActiveSupport.on_load(:active_record) do
+          OpenapiRuby::Generator::TestSchemaSuppressor.disable!
+        end
+      end
+
+      # Neutralises the methods rather than clearing
+      # `ActiveRecord.maintain_test_schema`. The flag is reapplied from app
+      # config by the `active_record.set_configs` initializer, which runs after
+      # any load hook we can register from here — so setting it is silently
+      # undone before `rails/test_help` reads it.
+      def disable!
+        ::ActiveRecord::Migration.singleton_class.prepend(MigrationSilencer)
+      end
+
+      module MigrationSilencer
+        # Called by rails/test_help at require time.
+        def maintain_test_schema!
+          nil
+        end
+
+        # Not called by Rails during boot, but a common addition to a
+        # hand-written test_helper. Same intent as the above: assert the test
+        # database matches the migrations. Nothing is loaded from the database
+        # to build the document, so there is nothing to verify.
+        def check_all_pending!
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/openapi_ruby/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi-ruby
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.0.3
 platform: ruby
 authors:
 - Morten Hartvig
@@ -108,6 +108,7 @@ files:
 - 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/generator/test_schema_suppressor.rb
 - lib/openapi_ruby/middleware/coercion.rb
 - lib/openapi_ruby/middleware/error_handler.rb
 - lib/openapi_ruby/middleware/path_matcher.rb