solargraph 0.25.1 → 0.26.0

data/lib/solargraph/pin.rb

@@ -20,7 +20,7 @@ module Solargraph
     autoload :Documenting,      'solargraph/pin/documenting'
     autoload :Block,            'solargraph/pin/block'
     autoload :Localized,        'solargraph/pin/localized'
-    autoload :ProxyMethod,      'solargraph/pin/proxy_method'
+    autoload :ProxyType,        'solargraph/pin/proxy_type'
     autoload :DuckMethod,       'solargraph/pin/duck_method'
     autoload :YardPin,          'solargraph/pin/yard_pin'
 

data/lib/solargraph/pin/attribute.rb

@@ -29,13 +29,13 @@ module Solargraph
         @path ||= namespace + (scope == :instance ? '#' : '.') + name
       end
 
-      def return_complex_types
-        if @return_complex_types.nil?
-          @return_complex_types = []
+      def return_complex_type
+        if @return_complex_type.nil?
+          @return_complex_type = ComplexType.new
           tag = docstring.tag(:return)
-          @return_complex_types.concat ComplexType.parse(*tag.types) unless tag.nil?
+          @return_complex_type = ComplexType.parse(*tag.types) unless tag.nil?
         end
-        @return_complex_types
+        @return_complex_type
       end
 
       def visibility

data/lib/solargraph/pin/base.rb

@@ -9,15 +9,15 @@ module Solargraph
       # @return [Solargraph::Source::Location]
       attr_reader :location
 
+      # The namespace in which this pin is defined.
+      # The root namespace is an empty string.
+      #
       # @return [String]
       attr_reader :namespace
 
       # @return [String]
       attr_reader :name
 
-      # @return [String]
-      attr_reader :comments
-
       # @return [Integer]
       attr_reader :kind
 
@@ -32,7 +32,12 @@ module Solargraph
         @location = location
         @namespace = namespace
         @name = name
-        @comments = comments || ''
+        @comments = comments
+      end
+
+      # @return [String]
+      def comments
+        @comments ||= ''
       end
 
       # @return [String]
@@ -65,6 +70,7 @@ module Solargraph
         false
       end
 
+      # @return [Boolean]
       def yard_pin?
         false
       end
@@ -105,33 +111,38 @@ module Solargraph
       #
       # @return [String]
       def return_type
-        return nil if return_complex_types.empty?
-        return_complex_types.first.tag
+        return nil if return_complex_type.void?
+        return_complex_type.first.tag
       end
 
       # The namespace of the first return type.
       # Use return_complex_types for an array of all return types.
       #
+      # @deprecated Not in active internal use
+      #
       # @return [String]
       def return_namespace
-        return nil if return_complex_types.empty?
-        @return_namespace ||= return_complex_types.first.namespace
+        return_type
+        return nil if return_complex_type.void?
+        @return_namespace ||= return_complex_type.first.namespace
       end
 
       # The scope of the first return type.
       # Use return_complex_types for an array of all return types.
       #
+      # @deprecated Not in active internal use
+      #
       # @return [String]
       def return_scope
-        return nil if return_complex_types.empty?
-        @return_scope ||= return_complex_types.first.scope
+        return nil if return_complex_type.void?
+        @return_scope ||= return_complex_type.first.scope
       end
 
       # All of the pin's return types as an array of ComplexTypes.
       #
-      # @return [Array<ComplexType>]
-      def return_complex_types
-        @return_complex_types ||= []
+      # @return [ComplexType]
+      def return_complex_type
+        @return_complex_type ||= ComplexType.new
       end
 
       # @return [YARD::Docstring]
@@ -140,7 +151,7 @@ module Solargraph
         @docstring ||= YARD::Docstring.parser.parse('').to_docstring
       end
 
-      # @param [Array<YARD::Tags::Directive>]
+      # @return [Array<YARD::Tags::Directive>]
       def directives
         parse_comments unless defined?(@directives)
         @directives
@@ -159,6 +170,17 @@ module Solargraph
         @maybe_directives ||= comments.include?('@!')
       end
 
+      # @return [Boolean]
+      def deprecated?
+        @deprecated ||= docstring.has_tag?('deprecated')
+      end
+
+      # @param api_map [ApiMap]
+      # @return [ComplexType]
+      def infer api_map
+        return_complex_type.qualify(api_map, namespace)
+      end
+
       # Try to merge data from another pin. Merges are only possible if the
       # pins are near matches (see the #nearly? method). The changes should
       # not have any side effects on the API surface.
@@ -171,8 +193,9 @@ module Solargraph
         if comments != pin.comments
           @comments = pin.comments
           @docstring = pin.docstring
-          @return_complex_types = pin.return_complex_types
+          @return_complex_type = pin.return_complex_type
           @documentation = nil
+          @deprecated = nil
           reset_conversions
         end
         true
@@ -192,6 +215,12 @@ module Solargraph
         end
       end
 
+      # True if two docstrings have the same tags, regardless of any other
+      # differences.
+      #
+      # @param d1 [YARD::Docstring]
+      # @param d2 [YARD::Docstring]
+      # @return [boolean]
       def compare_docstring_tags d1, d2
         return false if d1.tags.length != d2.tags.length
         d1.tags.each_index do |i|
@@ -200,6 +229,9 @@ module Solargraph
         true
       end
 
+      # @param d1 [Array<YARD::Tags::Directive>]
+      # @param d2 [Array<YARD::Tags::Directive>]
+      # @return [Boolean]
       def compare_directives d1, d2
         return false if d1.length != d2.length
         d1.each_index do |i|
@@ -208,8 +240,11 @@ module Solargraph
         true
       end
 
+      # @param t1 [YARD::Tags::Tag]
+      # @param t2 [YARD::Tags::Tag]
+      # @return [Boolean]
       def compare_tags t1, t2
-        return true if t1.class == t2.class and
+        t1.class == t2.class and
           t1.tag_name == t2.tag_name and
           t1.text == t2.text and
           t1.name == t2.name and

data/lib/solargraph/pin/base_variable.rb

@@ -1,17 +1,23 @@
 module Solargraph
   module Pin
     class BaseVariable < Base
+      include Solargraph::Source::NodeMethods
+
       attr_reader :signature
 
       attr_reader :context
 
-      def initialize location, namespace, name, comments, signature, literal, context
+      def initialize location, namespace, name, comments, assignment, literal, context
         super(location, namespace, name, comments)
-        @signature = signature
+        @assignment = assignment
         @literal = literal
         @context = context
       end
 
+      def signature
+        @signature ||= resolve_node_signature(@assignment)
+      end
+
       def scope
         @scope ||= (context.kind == Pin::METHOD and context.scope == :instance ? :instance : :class)
       end
@@ -25,8 +31,8 @@ module Solargraph
         Solargraph::LanguageServer::SymbolKinds::VARIABLE
       end
 
-      def return_complex_types
-        @return_complex_types ||= generate_complex_types
+      def return_complex_type
+        @return_complex_type ||= generate_complex_type
       end
 
       def nil_assignment?
@@ -37,6 +43,18 @@ module Solargraph
         true
       end
 
+      # @param api_map [ApiMap]
+      def infer api_map
+        result = super
+        return result if result.defined? or @assignment.nil?
+        # chain = Source::Chain.new(filename, @assignment)
+        # @todo Use NodeChainer
+        chain = Source::NodeChainer.chain(location.filename, @assignment)
+        fragment = api_map.fragment_at(location)
+        locals = fragment.locals - [self]
+        chain.infer_type_with(api_map, context, locals)
+      end
+
       def == other
         return false unless super
         signature == other.signature
@@ -45,17 +63,17 @@ module Solargraph
       def try_merge! pin
         return false unless super
         @signature = pin.signature
-        @return_complex_types = pin.return_complex_types
+        @return_complex_type = pin.return_complex_type
         true
       end
 
       private
 
-      def generate_complex_types
+      def generate_complex_type
         tag = docstring.tag(:type)
         return ComplexType.parse(*tag.types) unless tag.nil?
         return ComplexType.parse(@literal) unless @literal.nil?
-        []
+        ComplexType.new
       end
     end
   end

data/lib/solargraph/pin/block.rb

@@ -1,21 +1,38 @@
 module Solargraph
   module Pin
     class Block < Base
+      # The signature of the method that receives this block.
+      #
+      # @return [Parser::AST::Node]
       attr_reader :receiver
+
+      # @return [Array<String>]
       attr_reader :parameters
 
-      def initialize location, namespace, name, comments, receiver
+      attr_reader :scope
+
+      def initialize location, namespace, name, comments, receiver, scope
         super(location, namespace, name, comments)
         @receiver = receiver
+        @scope = scope
       end
 
       def kind
         Pin::BLOCK
       end
 
+      def return_complex_type
+        @return_complex_type ||= Solargraph::ComplexType.parse(namespace)
+      end
+
       def parameters
         @parameters ||= []
       end
+
+      def nearly? other
+        return false unless super
+        receiver == other.receiver and parameters == other.parameters
+      end
     end
   end
 end

data/lib/solargraph/pin/block_parameter.rb

@@ -34,19 +34,56 @@ module Solargraph
         block.parameters.index(self)
       end
 
+      def nearly? other
+        return false unless super
+        block.nearly?(other.block)
+      end
+
+      def try_merge! other
+        return false unless super
+        @block = other.block
+        @presence = block.location.range
+        @return_complex_type = nil
+      end
+
       # @return [Array<Solargraph::ComplexType>]
-      def return_complex_types
-        if @return_complex_types.nil?
-          @return_complex_types = []
+      def return_complex_type
+        if @return_complex_type.nil?
+          @return_complex_type = ComplexType.new
           found = nil
           params = block.docstring.tags(:param)
           params.each do |p|
             next unless p.name == name
             found = p
           end
-          @return_complex_types.concat ComplexType.parse(*found.types) unless found.nil? or found.types.nil?
+          @return_complex_type = ComplexType.parse(*found.types) unless found.nil? or found.types.nil?
+        end
+        @return_complex_type
+      end
+
+      def context
+        block
+      end
+
+      def infer api_map
+        return return_complex_type unless return_complex_type.undefined?
+        chain = Source::NodeChainer.chain(location.filename, block.receiver)
+        fragment = api_map.fragment_at(location)
+        locals = fragment.locals - [self]
+        meths = chain.define_with(api_map, block, fragment.locals)
+        meths.each do |meth|
+          if (Solargraph::CoreFills::METHODS_WITH_YIELDPARAM_SUBTYPES.include?(meth.path))
+            bmeth = chain.define_base_with(api_map, context, locals).first
+            return ComplexType::UNDEFINED if bmeth.nil? or bmeth.return_complex_type.undefined? or bmeth.return_complex_type.subtypes.empty?
+            return bmeth.return_complex_type.subtypes.first.qualify(api_map)
+          else
+            yps = meth.docstring.tags(:yieldparam)
+            unless yps[index].nil? or yps[index].types.nil? or yps[index].types.empty?
+              return ComplexType.parse(yps[index].types[0]).first
+            end
+          end
         end
-        @return_complex_types
+        ComplexType::UNDEFINED
       end
     end
   end

data/lib/solargraph/pin/conversions.rb

@@ -11,7 +11,8 @@ module Solargraph
           data: {
             path: path,
             return_type: return_type,
-            location: location
+            location: location,
+            deprecated: deprecated?
           }
         }
       end
@@ -43,7 +44,7 @@ module Solargraph
         if @detail.nil?
           @detail = ''
           @detail += "(#{parameters.join(', ')}) " unless kind != Pin::METHOD or parameters.empty?
-          @detail += "=> #{return_type}" unless return_type.nil?
+          @detail += "=> #{return_complex_type.tag}" unless return_complex_type.undefined?
           @detail.strip!
         end
         return nil if @detail.empty?
@@ -68,6 +69,7 @@ module Solargraph
       private
 
       def generate_link
+        return nil if return_complex_type.undefined?
         this_path = path || return_type
         return nil if this_path.nil?
         "[#{this_path.gsub('_', '\\\\_')}](solargraph:/document?query=#{URI.encode(this_path)})"

data/lib/solargraph/pin/method.rb

@@ -39,8 +39,8 @@ module Solargraph
         LanguageServer::SymbolKinds::METHOD
       end
 
-      def return_complex_types
-        @return_complex_types ||= generate_complex_types
+      def return_complex_type
+        @return_complex_type ||= generate_complex_type
       end
 
       def documentation
@@ -72,19 +72,19 @@ module Solargraph
 
       private
 
-      # @return [Array<ComplexType>]
-      def generate_complex_types
+      # @return [ComplexType]
+      def generate_complex_type
         tag = docstring.tag(:return)
         if tag.nil?
           ol = docstring.tag(:overload)
           tag = ol.tag(:return) unless ol.nil?
         end
-        return [] if tag.nil?
+        return ComplexType::UNDEFINED if tag.nil? or tag.types.nil? or tag.types.empty?
         begin
           ComplexType.parse *tag.types
         rescue Solargraph::ComplexTypeError => e
           STDERR.puts e.message
-          []
+          ComplexType::UNDEFINED
         end
       end
     end

data/lib/solargraph/pin/method_parameter.rb

@@ -1,26 +1,26 @@
 module Solargraph
   module Pin
     class MethodParameter < LocalVariable
-      def return_complex_types
-        if @return_complex_types.nil?
-          @return_complex_types = []
+      def return_complex_type
+        if @return_complex_type.nil?
+          @return_complex_type = ComplexType.new
           found = nil
           params = block.docstring.tags(:param)
           params.each do |p|
             next unless p.name == name
             found = p
           end
-          @return_complex_types.concat ComplexType.parse(*found.types) unless found.nil? or found.types.nil?
+          @return_complex_type = ComplexType.parse(*found.types) unless found.nil? or found.types.nil?
         end
         super
-        @return_complex_types
+        @return_complex_type
       end
 
       def try_merge! pin
         return false unless super
         # @todo This is a little expensive, but it's necessary because
         #   parameter data depends on the method's docstring.
-        @return_complex_types = pin.return_complex_types
+        @return_complex_type = pin.return_complex_type
         reset_conversions
         true
       end