Avoid discarding 'rooted?' information in Pin::Method#return_type (#752)

apiology · web-flow · commit 28efa3fe40e9 · 2025-02-28T07:00:33.000-05:00
Solargraph gets confused when a return type's name exists at multiple levels - e.g., "@return [::Array]" in a Pin class method is understood as Solargraph::Pin::Array instead of Ruby's provided Array class. Avoid that issue by avoiding unnecessary round-trip serialization of UniqueType objects via #to_s, which is ambiguous as it doesn't include the '::' prefix.
diff --git a/lib/solargraph/complex_type.rb b/lib/solargraph/complex_type.rb
@@ -11,9 +11,9 @@ class ComplexType
     autoload :TypeMethods, 'solargraph/complex_type/type_methods'
     autoload :UniqueType,  'solargraph/complex_type/unique_type'
 
-    # @param types [Array<UniqueType>]
+    # @param types [Array<[UniqueType, ComplexType]>]
     def initialize types = [UniqueType::UNDEFINED]
-      @items = types.uniq(&:to_s)
+      @items = types.flat_map(&:items).uniq(&:to_s)
     end
 
     # @param api_map [ApiMap]
@@ -136,10 +136,10 @@ def all_params
       @items.first.all_params || []
     end
 
-    protected
-
     attr_reader :items
 
+    protected
+
     def reduce_object
       return self if name != 'Object' || subtypes.empty?
       ComplexType.try_parse(reduce_class(subtypes.join(', ')))
diff --git a/lib/solargraph/complex_type/unique_type.rb b/lib/solargraph/complex_type/unique_type.rb
@@ -51,6 +51,10 @@ def to_s
         tag
       end
 
+      def items
+        [self]
+      end
+
       def to_rbs
         "#{namespace}#{parameters? ? "[#{subtypes.map { |s| s.to_rbs }.join(', ')}]" : ''}"
       end
@@ -127,7 +131,7 @@ def self_to dst
       def selfy?
         @name == 'self' || @key_types.any?(&:selfy?) || @subtypes.any?(&:selfy?)
       end
-  
+
       UNDEFINED = UniqueType.new('undefined')
       BOOLEAN = UniqueType.new('Boolean')
     end
diff --git a/lib/solargraph/pin/method.rb b/lib/solargraph/pin/method.rb
@@ -46,7 +46,7 @@ def symbol_kind
       end
 
       def return_type
-        @return_type ||= ComplexType.try_parse(*signatures.map(&:return_type).map(&:to_s))
+        @return_type ||= ComplexType.new(signatures.map(&:return_type).flat_map(&:items))
       end
 
       # @return [Signature]
diff --git a/spec/complex_type_spec.rb b/spec/complex_type_spec.rb
@@ -47,6 +47,16 @@
     expect(types.first.scope).to eq(:instance)
   end
 
+  it "identify rooted types" do
+    types = Solargraph::ComplexType.parse '::Array'
+    expect(types.map(&:rooted?)).to eq([true])
+  end
+
+  it "identify unrooted types" do
+    types = Solargraph::ComplexType.parse 'Array'
+    expect(types.map(&:rooted?)).to eq([false])
+  end
+
   it "detects namespace and scope for classes with subtypes" do
     types = Solargraph::ComplexType.parse 'Class<String>'
     expect(types.length).to eq(1)
diff --git a/spec/pin/method_spec.rb b/spec/pin/method_spec.rb
@@ -42,6 +42,26 @@ def foo bar:, baz: MyClass.new
     expect(pin.documentation).to include('description2')
   end
 
+  it "tracks rooted status in return types" do
+    source = Solargraph::Source.new(<<~COMMENTS)
+      class Foo; end
+      module Bar
+        class Foo; end
+        class Baz
+          # @return [::Foo]
+          def bing; end
+          # @return [Foo]
+          def bazzle; end
+        end
+      end
+    COMMENTS
+    map = Solargraph::SourceMap.map(source)
+    bazzle = map.pins.select{|pin| pin.path == 'Bar::Baz#bazzle'}.first
+    expect(bazzle.return_type.rooted?).to eq(false)
+    bing = map.pins.select{|pin| pin.path == 'Bar::Baz#bing'}.first
+    expect(bing.return_type.rooted?).to eq(true)
+  end
+
   it "includes yieldparam tags in documentation" do
     comments = <<~COMMENTS
       @yieldparam one [First] description1
