solargraph 0.23.6 → 0.24.0

data/lib/solargraph/pin.rb

@@ -22,6 +22,7 @@ module Solargraph
     autoload :Block,            'solargraph/pin/block'
     autoload :Localized,        'solargraph/pin/localized'
     autoload :ProxyMethod,      'solargraph/pin/proxy_method'
+    autoload :DuckMethod,       'solargraph/pin/duck_method'
 
     ATTRIBUTE = 1
     CLASS_VARIABLE = 2

data/lib/solargraph/pin/attribute.rb

@@ -30,12 +30,15 @@ module Solargraph
         @path ||= namespace + (scope == :instance ? '#' : '.') + name
       end
 
-      def return_type
-        if @return_type.nil? and !docstring.nil?
-          tag = docstring.tag(:return)
-          @return_type = tag.types[0] unless tag.nil?
+      def return_complex_types
+        if @return_complex_types.nil?
+          @return_complex_types = []
+          unless docstring.nil?
+            tag = docstring.tag(:return)
+            @return_complex_types.concat ComplexType.parse(*tag.types) unless tag.nil?
+          end
         end
-        @return_type
+        @return_complex_types
       end
 
       def visibility
@@ -48,6 +51,10 @@ module Solargraph
         # them as methods without parameters
         []
       end
+
+      def parameter_names
+        []
+      end
     end
   end
 end

data/lib/solargraph/pin/base.rb

@@ -18,15 +18,16 @@ module Solargraph
       # @return [YARD::Docstring]
       attr_reader :docstring
 
-      # @return [String]
-      attr_reader :return_type
-
       # @return [Integer]
       attr_reader :kind
 
       # @return [String]
       attr_reader :path
 
+      # @param location [Solargraph::Source::Location]
+      # @param namespace [String]
+      # @param name [String]
+      # @param docstring [YARD::Docstring]
       def initialize location, namespace, name, docstring
         @location = location
         @namespace = namespace
@@ -58,6 +59,7 @@ module Solargraph
         @identifier ||= "#{path}|#{name}"
       end
 
+      # @return [Boolean]
       def variable?
         false
       end
@@ -66,6 +68,48 @@ module Solargraph
       def named_context
         namespace
       end
+
+      def == other
+        return false unless self.class == other.class
+        location == other.location and
+          namespace == other.namespace and
+          name == other.name and
+          ( (docstring.nil? and other.docstring.nil?) or (docstring == other.docstring and docstring.all == other.docstring.all) )
+      end
+
+      # The first return type associated with the pin.
+      # Use return_complex_types for an array of all return types.
+      #
+      # @return [String]
+      def return_type
+        return nil if return_complex_types.empty?
+        return_complex_types.first.tag
+      end
+
+      # The namespace of the first return type.
+      # Use return_complex_types for an array of all return types.
+      #
+      # @return [String]
+      def return_namespace
+        return nil if return_complex_types.empty?
+        @return_namespace ||= return_complex_types.first.namespace
+      end
+
+      # The scope of the first return type.
+      # Use return_complex_types for an array of all return types.
+      #
+      # @return [String]
+      def return_scope
+        return nil if complex_types.empty?
+        @return_scope ||= return_complex_types.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 ||= []
+      end
     end
   end
 end

data/lib/solargraph/pin/base_variable.rb

@@ -26,17 +26,29 @@ module Solargraph
       end
 
       def return_type
+        # if @return_type.nil?
+        #   if !docstring.nil?
+        #     tag = docstring.tag(:type)
+        #     @return_type = tag.types[0] unless tag.nil?
+        #   else
+        #     @return_type = @literal
+        #   end
+        # end
+        # @return_type
         if @return_type.nil?
-          if !docstring.nil?
-            tag = docstring.tag(:type)
-            @return_type = tag.types[0] unless tag.nil?
-          else
+          if return_complex_types.empty?
             @return_type = @literal
+          else
+            @return_type = return_complex_types.first.tag
           end
         end
         @return_type
       end
 
+      def return_complex_types
+        @return_complex_types ||= generate_complex_types
+      end
+
       def nil_assignment?
         return_type == 'NilClass'
       end
@@ -44,6 +56,15 @@ module Solargraph
       def variable?
         true
       end
+
+      private
+
+      def generate_complex_types
+        return [] if docstring.nil?
+        tag = docstring.tag(:type)
+        return [] if tag.nil?
+        ComplexType.parse *tag.types
+      end
     end
   end
 end

data/lib/solargraph/pin/block_parameter.rb

@@ -3,8 +3,7 @@ module Solargraph
     class BlockParameter < Base
       include Localized
 
-      attr_reader :index
-
+      # @return [Pin::Block]
       attr_reader :block
 
       def initialize location, namespace, name, docstring, block
@@ -13,33 +12,43 @@ module Solargraph
         @presence = block.location.range
       end
 
+      # @return [Integer]
       def kind
         Pin::BLOCK_PARAMETER
       end
 
+      # @return [Integer]
       def completion_item_kind
         Solargraph::LanguageServer::CompletionItemKinds::VARIABLE
       end
 
+      # @return [Integer]
       def symbol_kind
         Solargraph::LanguageServer::SymbolKinds::VARIABLE
       end
 
+      # The parameter's zero-based location in the block's signature.
+      #
+      # @return [Integer]
       def index
         block.parameters.index(self)
       end
 
-      def return_type
-        if @return_type.nil? and !block.docstring.nil?
-          found = nil
-          params = block.docstring.tags(:param)
-          params.each do |p|
-            next unless p.name == name
-            found = p
+      # @return [Array<Solargraph::ComplexType>]
+      def return_complex_types
+        if @return_complex_types.nil?
+          @return_complex_types = []
+          unless block.docstring.nil?
+            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?
           end
-          @return_type = found.types[0] unless found.nil? or found.types.nil?
         end
-        @return_type
+        @return_complex_types
       end
     end
   end

data/lib/solargraph/pin/duck_method.rb

@@ -0,0 +1,15 @@
+module Solargraph
+  module Pin
+    # DuckMethod pins are used to add completion items for type tags that
+    # use duck typing, e.g., `@param file [#read]`.
+    #
+    class DuckMethod < Pin::Method
+      # @param location [Solargraph::Source::Location]
+      # @param name [String]
+      #
+      def initialize location, name
+        super(location, 'Object', name, nil, :instance, :public, [])
+      end
+    end
+  end
+end

data/lib/solargraph/pin/method.rb

@@ -12,6 +12,10 @@ module Solargraph
         @parameters = args
       end
 
+      def parameter_names
+        @parameter_names ||= parameters.map{|p| p.split(/[ =:]/).first}
+      end
+
       def kind
         Solargraph::Pin::METHOD
       end
@@ -29,16 +33,8 @@ module Solargraph
         LanguageServer::SymbolKinds::METHOD
       end
 
-      def return_type
-        if @return_type.nil? and !docstring.nil?
-          tag = docstring.tag(:return)
-          if tag.nil?
-            ol = docstring.tag(:overload)
-            tag = ol.tag(:return) unless ol.nil?
-          end
-          @return_type = tag.types[0] unless tag.nil? or tag.types.nil?
-        end
-        @return_type
+      def return_complex_types
+        @return_complex_types ||= generate_complex_types
       end
 
       def documentation
@@ -63,23 +59,17 @@ module Solargraph
         @documentation
       end
 
-      # @todo This method was temporarily migrated directly from Suggestion
-      # @return [Array<String>]
-      def params
-        if @params.nil?
-          @params = []
-          return @params if docstring.nil?
-          param_tags = docstring.tags(:param)
-          unless param_tags.empty?
-            param_tags.each do |t|
-              txt = t.name.to_s
-              txt += " [#{t.types.join(',')}]" unless t.types.nil? or t.types.empty?
-              txt += " #{t.text}" unless t.text.nil? or t.text.empty?
-              @params.push txt
-            end
-          end
+      private
+
+      def generate_complex_types
+        return [] if docstring.nil?
+        tag = docstring.tag(:return)
+        if tag.nil?
+          ol = docstring.tag(:overload)
+          tag = ol.tag(:return) unless ol.nil?
         end
-        @params
+        return [] if tag.nil?
+        ComplexType.parse *tag.types
       end
     end
   end

data/lib/solargraph/pin/method_parameter.rb

@@ -1,18 +1,21 @@
 module Solargraph
   module Pin
     class MethodParameter < LocalVariable
-      def return_type
-        if @return_type.nil? and !block.docstring.nil?
-          found = nil
-          params = block.docstring.tags(:param)
-          params.each do |p|
-            next unless p.name == name
-            found = p
+      def return_complex_types
+        if @return_complex_types.nil?
+          @return_complex_types = []
+          unless block.docstring.nil?
+            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?
           end
-          @return_type = found.types[0] unless found.nil? or found.types.nil?
         end
         super
-        @return_type
+        @return_complex_types
       end
     end
   end

data/lib/solargraph/pin/namespace.rb

@@ -51,8 +51,8 @@ module Solargraph
         @path ||= (namespace.empty? ? '' : "#{namespace}::") + name
       end
 
-      def return_type
-        @return_type ||= (type == :class ? 'Class' : 'Module') + "<#{path}>"
+      def return_complex_types
+        @return_complex_types ||= ComplexType.parse( (type == :class ? 'Class' : 'Module') + "<#{path}>" )
       end
     end
   end

data/lib/solargraph/pin/proxy_method.rb

@@ -5,16 +5,15 @@ module Solargraph
     # method while analyzing signatures.
     #
     class ProxyMethod < Base
-      # @return [String]
-      attr_reader :return_type
-
-      def initialize return_type
-        @return_type = return_type
+      def initialize *return_types
+        @return_complex_types = ComplexType.parse(*return_types.reject(&:nil?))
       end
 
       # @return [String]
       def namespace
-        @namespace ||= ApiMap::TypeMethods.extract_namespace(@return_type)
+        # @namespace ||= ApiMap::TypeMethods.extract_namespace(return_type)
+        return nil if @return_complex_types.empty?
+        @namespace ||= @return_complex_types.first.namespace
       end
 
       # @return [Integer]

data/lib/solargraph/pin/yard_object.rb

@@ -86,6 +86,10 @@ module Solargraph
         @parameters ||= get_method_args
       end
 
+      def parameter_names
+        @parameter_names ||= parameters.map{|p| p.split(/[ =:]/).first}
+      end
+
       def visibility
         @visibility ||= (code_object.respond_to?(:visibility) ? code_object.visibility : :public)
       end
@@ -100,14 +104,14 @@ module Solargraph
       def get_method_args
         return [] unless code_object.kind_of?(YARD::CodeObjects::MethodObject)
         args = []
-        code_object.parameters.each { |a|
+        code_object.parameters.each do |a|
           p = a[0]
           unless a[1].nil?
             p += ' =' unless p.end_with?(':')
             p += " #{a[1]}"
           end
           args.push p
-        }
+        end
         args
       end
     end

data/lib/solargraph/source.rb

@@ -207,7 +207,7 @@ module Solargraph
     end
 
     # @param updater [Source::Updater]
-    def synchronize updater
+    def synchronize updater, reparse = true
       raise 'Invalid synchronization' unless updater.filename == filename
       original_code = @code
       original_fixed = @fixed
@@ -215,6 +215,7 @@ module Solargraph
       @fixed = updater.write(original_code, true)
       @version = updater.version
       return if @code == original_code
+      return unless reparse
       begin
         parse
         @fixed = @code
@@ -248,6 +249,8 @@ module Solargraph
       @all_pins.select{|pin| pin.location == location}.first
     end
 
+    # @param line [Integer] A zero-based line number
+    # @param column [Integer] A zero-based column number
     # @return [Solargraph::Source::Fragment]
     def fragment_at line, column
       Fragment.new(self, line, column)
@@ -321,8 +324,28 @@ module Solargraph
     end
 
     def process_parsed node, comments
-      @pins, @locals, @requires, @symbols, @path_macros, @domains = Mapper.map filename, code, node, comments
-      @stime = Time.now
+      new_map_data = Mapper.map(filename, code, node, comments)
+      synchronize_mapped *new_map_data
+    end
+
+    def synchronize_mapped new_pins, new_locals, new_requires, new_symbols, new_path_macros, new_domains
+      resync = (
+        @pins.nil? or
+        @locals.nil? or
+        @pins[1..-1] != new_pins[1..-1] or
+        @locals != new_locals
+        # @requires != new_requires or
+        # @path_macros != new_path_macros or
+        # @new_domains != new_domains
+      )
+      @pins = new_pins
+      @locals = new_locals
+      @requires = new_requires
+      @symbols = new_symbols
+      @path_macros = new_path_macros
+      @domains = new_domains
+      # Check for bare minimum change required to synchronize workspaces, etc.
+      @stime = Time.now if resync
     end
 
     class << self