From 5f610859a55dc387e227ac1f09cfd46abb839c4c Mon Sep 17 00:00:00 2001
From: Stephen Sugden <me@stephensugden.com>
Date: Sat, 10 Sep 2022 10:46:18 +0200
Subject: [PATCH] Add Pin::DelegatedMethod

This is a more complicated version of a method alias, where the type
of the method receiver can be resolved dynamically using a Source::Chain.

As hinted at by the name, this allows creating pins that fully support
the `Module.delegate` method from ActiveSupports core extensions.
---
 lib/solargraph/pin.rb                  |  1 +
 lib/solargraph/pin/delegated_method.rb | 96 ++++++++++++++++++++++++++
 2 files changed, 97 insertions(+)
 create mode 100644 lib/solargraph/pin/delegated_method.rb

diff --git a/lib/solargraph/pin.rb b/lib/solargraph/pin.rb
index 777d564de..3438fd820 100644
--- a/lib/solargraph/pin.rb
+++ b/lib/solargraph/pin.rb
@@ -11,6 +11,7 @@ module Pin
     autoload :Base,             'solargraph/pin/base'
     autoload :Method,           'solargraph/pin/method'
     autoload :MethodAlias,      'solargraph/pin/method_alias'
+    autoload :DelegatedMethod,  'solargraph/pin/delegated_method'
     autoload :BaseVariable,     'solargraph/pin/base_variable'
     autoload :InstanceVariable, 'solargraph/pin/instance_variable'
     autoload :ClassVariable,    'solargraph/pin/class_variable'
diff --git a/lib/solargraph/pin/delegated_method.rb b/lib/solargraph/pin/delegated_method.rb
new file mode 100644
index 000000000..e7b445f9b
--- /dev/null
+++ b/lib/solargraph/pin/delegated_method.rb
@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    # A DelegatedMethod is a more complicated version of a MethodAlias that
+    # allows aliasing a method from a different closure (class/module etc).
+    #
+    # This is implemented in two parts: the
+    class DelegatedMethod < Pin::Method
+      # A DelegatedMethod can be constructed with either a :resolved_method
+      # pin, or a :receiver_chain. When a :receiver_chain is supplied, it
+      # will be used to *dynamically* resolve a receiver type within the
+      # given closure/scope, and the delegated method will then be resolved
+      # to a method pin on that type.
+      #
+      # @param resolved_method [Method] an already resolved method pin.
+      # @param receiver_chain [Source::Chain] the source code used to resolve the receiver for this delegated method.
+      # @param receiver_method_name [String] the method name that will be called on the receiver (defaults to :name).
+      def initialize(method: nil, receiver: nil, name: (method && method.name), receiver_method_name: name, **splat)
+        raise ArgumentError, 'either :method or :chain is required' if (method && receiver) || (!method && !receiver)
+
+        super(name: name, **splat)
+
+        # @type [Source::Chain]
+        @receiver_chain = receiver
+        @resolved_method = method
+        @receiver_method_name = receiver_method_name
+      end
+
+      %i[comments parameters return_type location].each do |method|
+        define_method(method) do
+          @resolved_method ? @resolved_method.send(method) : super()
+        end
+      end
+
+      %i[typify realize infer probe].each do |method|
+        # @param api_map [ApiMap]
+        define_method(method) do |api_map|
+          resolve_method(api_map)
+          @resolved_method ? @resolved_method.send(method, api_map) : super(api_map)
+        end
+      end
+
+      private
+
+      # Resolves the receiver chain and method name to a method pin, resetting any previously resolution.
+      #
+      # @param api_map [ApiMap]
+      # @return [Pin::Method, nil]
+      def resolve_method api_map
+        return if @resolved_method
+
+        resolver = @receiver_chain.define(api_map, self, []).first
+
+        unless resolver
+          Solargraph.logger.warn \
+            "Delegated receiver for #{path} was resolved to nil from `#{print_chain(@receiver_chain)}'"
+          return
+        end
+
+        receiver_type = resolver.return_type
+
+        return if receiver_type.undefined?
+
+        receiver_path, method_scope =
+          if @receiver_chain.constant?
+            # HACK: the `return_type` of a constant is Class<Whatever>, but looking up a method expects
+            # the arguments `"Whatever"` and `scope: :class`.
+            [receiver_type.to_s.sub(/^Class<(.+)>$/, '\1'), :class]
+          else
+            [receiver_type.to_s, :instance]
+          end
+
+        method_stack = api_map.get_method_stack(receiver_path, @receiver_method_name, scope: method_scope)
+        @resolved_method = method_stack.first
+      end
+
+      # helper to print a source chain as code, probably not 100% correct.
+      #
+      # @param chain [Source::Chain]
+      def print_chain(chain)
+        out = +''
+        chain.links.each_with_index do |link, index|
+          if index > 0
+            if Source::Chain::Constant
+              out << '::' unless link.word.start_with?('::')
+            else
+              out << '.'
+            end
+          end
+          out << link.word
+        end
+      end
+    end
+  end
+end