oas_rails 1.3.4 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '084f6ab46fcab4522ee4a647d510183b5c7d1dc5ddd4a78bdd808208cbde3fc0'
-  data.tar.gz: ea44520a949dd1644ab77a85e0d9c03cb359f486ec13e0911cd97a6c027e4a4f
+  metadata.gz: '09529237dfb6748e3a3f1d61722d8ac67643bc8d7b98c24ba4a78d20a9c44dee'
+  data.tar.gz: 5a81b05b2b1bfd73739a88edbbbc7173e1b16d2e34a5a011c6b3d7e201b270ee
 SHA512:
-  metadata.gz: 490456ca0185bb3c7024ec098f9f036ee2aa5f59f5ae3e39c05e12644dd21eb1cc7a751894e8bbc215e95bdab3ba24a82179ba6220ca31fa6de57c37b6b3583a
-  data.tar.gz: 952a4d1eecca40e356e72306bf7c6a7184d266364472866274f5660eed0169c23b1ea82993a861a0f95acb6651f5fcf956afb1ca5cdbd6807530fc5a4d66295a
+  metadata.gz: c97e67a13e1a8bde1d9d6f9ad08834734ad2211455b9ba100a8eec030561133c77494020705a941bb118fb2578b9d0a739d3d41c80f4d09eb5811c6d79830550
+  data.tar.gz: b3bafc5f8160f61e4c5fd427a9571426d5e7b9c5cc251d5984addef3547de1eb79f43bb0081795a25cbfa8ea6e0fbb67f2cdebbe4c48d045b71f58d1e86fa2e8

data/lib/oas_rails/builders/oas_route_builder.rb

@@ -1,6 +1,12 @@
 module OasRails
   module Builders
     class OasRouteBuilder
+      # Gems/frameworks (like Sorbet) may wrap methods at runtime, causing
+      # +instance_method.source_location+ to point to the wrapper rather than
+      # the original source file. We detect this and fall back to reading the
+      # source file directly so that OasRails annotations remain readable.
+      KNOWN_RUNTIME_WRAPPERS = %w[sorbet-runtime].freeze
+
       def self.build_from_rails_route(rails_route)
         new(rails_route).build
       end
@@ -48,7 +54,8 @@ module OasRails
       end
 
       def docstring
-        comment_lines = controller_class.constantize.instance_method(method).comment.lines
+        comment = method_comment_safe
+        comment_lines = comment.lines
         processed_lines = comment_lines.map { |line| line.sub(/^# /, '') }
 
         filtered_lines = processed_lines.reject do |line|
@@ -60,11 +67,8 @@ module OasRails
       end
 
       def tags
-        method_comment = controller_class.constantize.instance_method(method).comment
-        class_comment = controller_class.constantize.instance_method(method).class_comment
-
-        method_tags = parse_tags(method_comment)
-        class_tags = parse_tags(class_comment)
+        method_tags = parse_tags(method_comment_safe)
+        class_tags = parse_tags(class_comment_safe)
 
         method_tags + class_tags
       end
@@ -73,6 +77,101 @@ module OasRails
         lines = comment.lines.map { |line| line.sub(/^# /, '') }
         ::YARD::Docstring.parser.parse(lines.join).tags
       end
+
+      # Returns the method-level comment, falling back to direct source-file
+      # reading when the method has been wrapped by a runtime library
+      # (e.g. Sorbet's +sig+ blocks replace the method at runtime, causing
+      # +instance_method.source_location+ to point to sorbet-runtime internals
+      # rather than the controller file).
+      def method_comment_safe
+        unbound = controller_class.constantize.instance_method(method)
+        return unbound.comment unless wrapped_by_runtime?(unbound)
+
+        read_comment_from_source(method)
+      end
+
+      def class_comment_safe
+        unbound = controller_class.constantize.instance_method(method)
+        return unbound.class_comment unless wrapped_by_runtime?(unbound)
+
+        read_comment_from_source(:class)
+      end
+
+      # Returns true when the unbound method's source_location points to a
+      # known runtime wrapper gem rather than the application source.
+      def wrapped_by_runtime?(unbound_method)
+        loc = unbound_method.source_location
+        return false unless loc
+
+        KNOWN_RUNTIME_WRAPPERS.any? { |wrapper| loc.first.include?(wrapper) }
+      end
+
+      # Reads the contiguous comment block above a +def+ or +class+ line in
+      # the controller source file, skipping over non-comment lines such as
+      # +sig { void }+ injected by Sorbet.
+      #
+      # When +target+ is +:class+, finds the class declaration line.
+      # Otherwise, finds +def <target>+.
+      def read_comment_from_source(target)
+        source_file = find_source_file
+        return "" unless source_file
+
+        lines = File.readlines(source_file)
+        target_idx = if target == :class
+                       lines.index { |l| l.match?(/^\s*class\s+\w+/) }
+                     else
+                       lines.index { |l| l.match?(/^\s+def #{Regexp.escape(target.to_s)}\b/) }
+                     end
+        return "" unless target_idx
+
+        collect_comments_before(lines, target_idx)
+      rescue StandardError
+        ""
+      end
+
+      # Walk backwards from +target_idx+ collecting contiguous comment lines,
+      # skipping blank lines and non-comment lines (like +sig { void }+).
+      # Leading whitespace is stripped so output matches method_source format.
+      def collect_comments_before(lines, target_idx)
+        comment_lines = []
+        idx = target_idx - 1
+
+        while idx >= 0
+          stripped = lines[idx].strip
+          if stripped.start_with?("#")
+            comment_lines.unshift("#{stripped}\n")
+          elsif stripped.empty? || stripped.match?(/\Asig\s*[{(]/)
+            # skip blank lines and Sorbet sig blocks
+          else
+            break
+          end
+          idx -= 1
+        end
+
+        comment_lines.join
+      end
+
+      # Attempts to locate the controller source file by scanning the Rails
+      # autoload paths, since +source_location+ is unavailable when wrapped.
+      def find_source_file
+        # Try using ancestors with valid source locations first
+        klass = controller_class.constantize
+        klass.instance_methods(false).each do |m|
+          loc = klass.instance_method(m).source_location
+          next unless loc && !wrapped_by_runtime?(klass.instance_method(m))
+
+          return loc.first
+        end
+
+        # Fall back to searching autoload paths for the expected filename
+        expected_path = "#{controller}_controller.rb"
+        Rails.autoloaders.main.dirs.each do |dir|
+          candidate = File.join(dir, expected_path)
+          return candidate if File.exist?(candidate)
+        end
+
+        nil
+      end
     end
   end
 end

data/lib/oas_rails/version.rb

@@ -1,3 +1,3 @@
 module OasRails
-  VERSION = "1.3.4"
+  VERSION = "1.3.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oas_rails
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.3.5
 platform: ruby
 authors:
 - a-chacon