openapi-ruby 2.4.0 → 2.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 625d042fe294eeec35636e245418a38ab1cdefb13412fb1cfd355429a90ead83
-  data.tar.gz: 354e09c385f606421e191f05bccfef6a1cefac42be17485f3eeb4bf38ccf3285
+  metadata.gz: e5b5aa8b42fe199142eb84aa503b7ed590e2cb0399790a3a749f1df5a98c543b
+  data.tar.gz: 9a32a812806610a71af36ea018ca7774dbc8cfd8f0ea3d44a73b91303e3dbec2
 SHA512:
-  metadata.gz: de6d641c194b48f03e20c877a9c9ab787eaf20dd88fe8bf952bb2c22963e98b060f31aea0d5d57321a99d6ffd91fe9b80805b3bbeb4274d17f085b7481747588
-  data.tar.gz: f9790faa37a74d230addcf0fdaaa346454481c63791e73efa138aa1bdc212cf08111dee1eb1cfcc6b1b867d90189cf4e76bea4305d27474f7098c7214cbebe00
+  metadata.gz: 78d10fcbf342b18f50988bf9984767cc911fc8e3466a6f07cc5b6f404277b5fa7cb93bbc41767e1eb185fd46c04503e0fb714c02ebbfa5bc78ae1f1a5393bff3
+  data.tar.gz: 6c520011e5868a4c1dca5d6b2bd51ef066cc40c9006cd8411962b250364d4aabcc7ae201982324088611eb4e35055800c90500949ca5dbe4e58df0fcde300333

data/lib/openapi_ruby/adapters/rspec.rb

@@ -140,8 +140,9 @@ module OpenapiRuby
           end
 
           method = operation&.verb || "get"
-          # Default to JSON Accept header for API requests
-          headers["Accept"] ||= "application/json"
+          # Accept header: use let(:Accept) if defined, otherwise default to JSON
+          accept = resolve_let(:Accept)
+          headers["Accept"] = accept || "application/json"
 
           if body
             content_type = operation&.request_body_definition&.dig("content")&.keys&.first || "application/json"
@@ -281,6 +282,17 @@ module OpenapiRuby
           rescue => e
             warn "[openapi_ruby] Schema generation failed: #{e.message}"
           end
+
+          # RSpec's --dry-run mode does not fire after(:suite) hooks.
+          # Describe/context blocks are still evaluated (registering DSL contexts),
+          # but the hook that writes schemas never runs. Use at_exit as a fallback.
+          if config.dry_run?
+            at_exit do
+              OpenapiRuby::Generator::SchemaWriter.generate_all!
+            rescue => e
+              warn "[openapi_ruby] Schema generation failed: #{e.message}"
+            end
+          end
         end
       end
     end

data/lib/openapi_ruby/components/loader.rb

@@ -110,28 +110,63 @@ module OpenapiRuby
       end
 
       def load_with_scope_inference(all_files, scope_paths)
+        # Build a map of file path → inferred scope before loading.
+        file_scope_map = {}
         all_files.each do |entry|
-          inferred_scope = infer_scope(entry[:relative], scope_paths)
+          scope = infer_scope(entry[:relative], scope_paths)
+          file_scope_map[entry[:file]] = scope if scope
+        end
 
+        # Load files, tracking which classes each file registers.
+        # We track both newly loaded AND already-loaded classes via before/after diffs.
+        class_to_file = {}
+        all_files.each do |entry|
           registered_before = Registry.instance.all_registered_classes.dup
           require entry[:file]
-          registered_after = Registry.instance.all_registered_classes
-
-          new_classes = registered_after - registered_before
-          new_classes.each do |klass|
-            next if klass._component_scopes_explicitly_set
-
-            if inferred_scope == :shared
-              klass._component_scopes = []
-            elsif inferred_scope
-              Registry.instance.unregister(klass)
-              klass._component_scopes = [inferred_scope]
-              Registry.instance.register(klass)
-            end
+          new_classes = Registry.instance.all_registered_classes - registered_before
+          new_classes.each { |klass| class_to_file[klass] = entry[:file] }
+        end
+
+        # For components that were already autoloaded by Rails (require returned false,
+        # so they didn't appear in the before/after diff), try to match them to files
+        # by their class name → file path convention.
+        Registry.instance.all_registered_classes.each do |klass|
+          next if class_to_file.key?(klass)
+
+          source_file = find_source_file_for(klass)
+          class_to_file[klass] = source_file if source_file
+        end
+
+        # Assign scopes to all registered components based on their source file.
+        class_to_file.each do |klass, file|
+          next if klass._component_scopes_explicitly_set
+
+          inferred_scope = file_scope_map[file]
+          next unless inferred_scope
+
+          if inferred_scope == :shared
+            klass._component_scopes = []
+          else
+            Registry.instance.unregister(klass)
+            klass._component_scopes = [inferred_scope]
+            Registry.instance.register(klass)
           end
         end
       end
 
+      def find_source_file_for(klass)
+        return nil unless klass.name
+
+        # Try the conventional path based on the class name (e.g., Internal::V1::Schemas::User → internal/v1/schemas/user.rb)
+        relative = klass.name.underscore + ".rb"
+        @paths.each do |base_path|
+          expanded = File.expand_path(base_path)
+          candidate = File.join(expanded, relative)
+          return candidate if File.exist?(candidate)
+        end
+        nil
+      end
+
       def infer_scope(relative_path, scope_paths)
         scope_paths.sort_by { |prefix, _| -prefix.length }.each do |prefix, scope|
           return scope&.to_sym if relative_path.start_with?("#{prefix}/")

data/lib/openapi_ruby/components/registry.rb

@@ -94,7 +94,18 @@ module OpenapiRuby
           result[type_key] = {}
           components.each_value do |klass|
             next if klass._schema_hidden
-            next if scope && !klass._component_scopes.empty? && !klass._component_scopes.include?(scope)
+            # When filtering by scope:
+            # - Components with matching scope: included
+            # - Components explicitly marked as shared (empty scopes + explicitly_set): included
+            # - Components with non-matching scope: excluded
+            # - Components with no scope assigned (empty scopes + NOT explicitly_set): excluded
+            if scope
+              if klass._component_scopes.empty?
+                next unless klass._component_scopes_explicitly_set
+              else
+                next unless klass._component_scopes.include?(scope)
+              end
+            end
 
             result[type_key][klass.component_name] = klass.to_openapi
           end

data/lib/openapi_ruby/core/document_builder.rb

@@ -49,9 +49,9 @@ module OpenapiRuby
       private
 
       def inject_validation_error_responses!
-        # Add ValidationError response component
+        # Add SchemaValidationError response component
         @components["responses"] ||= {}
-        @components["responses"]["ValidationError"] ||= {
+        @components["responses"]["SchemaValidationError"] ||= {
           "description" => "Request validation failed",
           "content" => {
             "application/json" => {
@@ -66,7 +66,7 @@ module OpenapiRuby
             next unless operation.is_a?(Hash) && operation.key?("responses")
             next if key == "parameters"
 
-            operation["responses"]["400"] ||= {"$ref" => "#/components/responses/ValidationError"}
+            operation["responses"]["400"] ||= {"$ref" => "#/components/responses/SchemaValidationError"}
           end
         end
       end

data/lib/openapi_ruby/dsl/operation_context.rb

@@ -77,7 +77,13 @@ module OpenapiRuby
         ctx = ResponseContext.new(status_code, description, hidden: hidden)
         ctx.produces(*@produces_list) if @produces_list.any?
         ctx.instance_eval(&block) if block
-        @responses[status_code.to_s] = ctx
+
+        key = status_code.to_s
+        # Don't overwrite a visible response with a hidden one — hidden responses
+        # are test-only variants that should not remove the endpoint from the schema.
+        existing = @responses[key]
+        @responses[key] = ctx unless hidden && existing && !existing.hidden
+
         ctx
       end
 

data/lib/openapi_ruby/version.rb

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

data/lib/tasks/openapi_ruby.rake

@@ -3,9 +3,48 @@
 namespace :openapi_ruby do
   desc "Generate OpenAPI schema files from spec definitions and components"
   task generate: :environment do
-    pattern = ENV.fetch("PATTERN", "spec/**/*_spec.rb")
-    command = "bundle exec rspec --pattern '#{pattern}' --dry-run --order defined"
-    puts "Generating OpenAPI schemas..."
-    system(command) || abort("Schema generation failed")
+    framework = ENV.fetch("FRAMEWORK", detect_test_framework).to_s
+
+    case framework
+    when "rspec"
+      generate_with_rspec
+    when "minitest"
+      generate_with_minitest
+    else
+      abort "Unknown test framework '#{framework}'. Set FRAMEWORK=rspec or FRAMEWORK=minitest."
+    end
+  end
+end
+
+def detect_test_framework
+  if File.exist?("spec/spec_helper.rb") || File.exist?("spec/rails_helper.rb")
+    "rspec"
+  elsif File.exist?("test/test_helper.rb")
+    "minitest"
+  else
+    abort "Could not detect test framework. Set FRAMEWORK=rspec or FRAMEWORK=minitest."
   end
 end
+
+def generate_with_rspec
+  pattern = ENV.fetch("PATTERN", "spec/**/*_spec.rb")
+  command = "bundle exec rspec --pattern '#{pattern}' --dry-run --order defined"
+  puts "Generating OpenAPI schemas (RSpec)..."
+  system(command) || abort("Schema generation failed")
+end
+
+def generate_with_minitest
+  pattern = ENV.fetch("PATTERN", "test/**/*_test.rb")
+  puts "Generating OpenAPI schemas (Minitest)..."
+
+  # Load Rails environment and minitest adapter
+  require "openapi_ruby/minitest"
+
+  # Load all test files to trigger api_path registrations.
+  # Minitest's api_path registers DSL contexts at class load time,
+  # so simply requiring the files is enough.
+  Dir.glob(pattern).each { |f| require File.expand_path(f) }
+
+  # Generate schemas from the registered contexts
+  OpenapiRuby::Generator::SchemaWriter.generate_all!
+end

metadata

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