solargraph 0.23.6 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5b6ac3cd79425340ddf486c9b3447115553a374a3c782d8c8a103825b4461b9
-  data.tar.gz: 4561568bb8075f955777c2a17a2a19a91c14b198df6c8f5798168b01abdeac19
+  metadata.gz: 102d3ab02b96835a5e3efc7a5ec5f07b2bd53c94660d16905f6c7264e6ac520a
+  data.tar.gz: 29aab3c067c6e9e95eeb5cf108ae5f71560f325aa02612bb69957840706e9d43
 SHA512:
-  metadata.gz: 489953a5c791e8475b217b4033a502196a1d0aa0112f5d778ce2dba9ed488e773b867fb596ca02a1f81a6143b426d54007ab0448f979d1c9ad98344034fa96a1
-  data.tar.gz: 390e4c2bf98f7733232f551749114229afb6e4f7271ac1792e2034cd223de6e0b636ab001281ad225b7f8267b0a8e1e48e927be0a88bab63a4ded3c7779e3bc3
+  metadata.gz: eed6ec2beee0afb8bcb8fc976f1d1487b5d79cd44acc1c27c89751f896da3ede2f8ec33da4d14278ea597e3308c3770cf6952d57dabf19de67d759b0a1464c1a
+  data.tar.gz: c7e7b79cf903a07e1237598a3d0f645aff86602128703af72531ee12d8bb7c1bf85a9445a097aec9f90ac8bd5dab9a9fcb24aa95fc6935250f24d017e8b85872

data/lib/solargraph.rb

@@ -36,6 +36,7 @@ module Solargraph
   autoload :Page,           'solargraph/page'
   autoload :Library,        'solargraph/library'
   autoload :Diagnostics,    'solargraph/diagnostics'
+  autoload :ComplexType,    'solargraph/complex_type'
 
   YARDOC_PATH = File.join(File.realpath(File.dirname(__FILE__)), '..', 'yardoc')
   YARD_EXTENSION_FILE = File.join(File.realpath(File.dirname(__FILE__)), 'yard-solargraph.rb')

data/lib/solargraph/api_map.rb

@@ -3,6 +3,9 @@ require 'set'
 require 'time'
 
 module Solargraph
+  # An aggregate provider for information about workspaces, sources, gems, and
+  # the Ruby core.
+  #
   class ApiMap
     autoload :Cache,        'solargraph/api_map/cache'
     autoload :SourceToYard, 'solargraph/api_map/source_to_yard'
@@ -120,13 +123,15 @@ module Solargraph
       virtualize source
     end
 
-    # Refresh the ApiMap.
+    # Refresh the ApiMap. This method checks for pending changes before
+    # performing the refresh unless the `force` parameter is true.
     #
     # @param force [Boolean] Perform a refresh even if the map is not "stale."
+    # @return [Boolean] True if a refresh was performed.
     def refresh force = false
-      return unless @force or changed?
+      return false unless force or changed?
       if force
-        @api_map = ApiMap::Store.new(@sources)
+        refresh_store_and_maps
       else
         store.remove *(current_workspace_sources.reject{ |s| workspace.sources.include?(s) })
         @sources = workspace.sources
@@ -134,6 +139,7 @@ module Solargraph
         store.update *(@sources.select{ |s| @stime.nil? or s.stime > @stime })
       end
       @stime = Time.new
+      true
     end
 
     # True if a workspace file has been created, modified, or deleted since
@@ -319,10 +325,26 @@ module Solargraph
         elsif fragment.signature.include?('::') and !fragment.signature.include?('.')
           result.concat get_constants(fragment.base, fragment.namespace)
         else
-          type = probe.infer_signature_type(fragment.base, fragment.named_path, fragment.locals)
-          unless type.nil?
-            namespace, scope = extract_namespace_and_scope(type)
-            result.concat get_methods(namespace, scope: scope)
+          pins = probe.infer_signature_pins(fragment.base, fragment.named_path, fragment.locals)
+          unless pins.empty?
+            pin = pins.first
+            if pin.return_complex_types.any? and pin.return_complex_types.first.duck_type?
+              pin.return_complex_types.each do |t|
+                next unless t.duck_type?
+                result.push Pin::DuckMethod.new(pin.location, t.tag[1..-1])
+              end
+              result.concat(get_methods('Object', scope: :instance))
+            end
+            if result.empty?
+              pins.each do |pin|
+                type = pin.return_type
+                unless type.nil?
+                  namespace, scope = extract_namespace_and_scope(type)
+                  result.concat get_methods(namespace, scope: scope)
+                  break
+                end
+              end
+            end
           end
         end
       end
@@ -428,6 +450,7 @@ module Solargraph
 
     # Get an array of all symbols in the workspace that match the query.
     #
+    # @param query [String]
     # @return [Array<Pin::Base>]
     def query_symbols query
       result = []

data/lib/solargraph/api_map/probe.rb

@@ -167,7 +167,8 @@ module Solargraph
       def virtual_new_pin new_pin, context_pin
         pin = Pin::Method.new(new_pin.location, new_pin.namespace, new_pin.name, new_pin.docstring, new_pin.scope, new_pin.visibility, new_pin.parameters)
         # @todo Smelly instance variable access.
-        pin.instance_variable_set(:@return_type, context_pin.path)
+        # pin.instance_variable_set(:@return_type, context_pin.path)
+        pin.instance_variable_set(:@return_complex_types, ComplexType.parse(context_pin.path))
         pin
       end
 
@@ -175,9 +176,9 @@ module Solargraph
       # @param locals [Array<Solargraph::Pin::Base>]
       # @return [String]
       def resolve_pin_type pin, locals
-        pin.return_type
         return pin.return_type unless pin.return_type.nil?
         return resolve_block_parameter(pin, locals) if pin.kind == Pin::BLOCK_PARAMETER
+        return resolve_method_parameter(pin) if pin.is_a?(Pin::MethodParameter)
         return resolve_variable(pin, locals) if pin.variable?
         nil
       end
@@ -210,6 +211,18 @@ module Solargraph
         nil
       end
 
+      def resolve_method_parameter pin
+        matches = api_map.get_methods(pin.namespace, scope: pin.scope, visibility: [:public, :private, :protected]).select{|p| p.name == pin.context.name}
+        matches.each do |m|
+          next unless pin.context.parameters == m.parameters
+          next if m.docstring.nil?
+          tag = m.docstring.tags(:param).select{|t| t.name == pin.name}.first
+          next if tag.nil? or tag.types.nil?
+          return tag.types[0]
+        end
+        nil
+      end
+
       def resolve_variable(pin, locals)
         return nil if pin.nil_assignment?
         # @todo Do we need the locals here?

data/lib/solargraph/complex_type.rb

@@ -0,0 +1,90 @@
+module Solargraph
+  class ComplexType
+    # @return [String]
+    attr_reader :name
+
+    # @return [String]
+    attr_reader :substring
+
+    # @return [String]
+    attr_reader :tag
+
+    # @return [Array<ComplexType>]
+    attr_reader :subtypes
+
+    # Create a ComplexType with the specified name and an optional substring.
+    # The substring is parameter of a parameterized type, e.g., for the type
+    # `Array<String>`, the name is `Array` and the substring is `String`.
+    #
+    # @param name [String] The name of the type
+    # @param substring [String] The substring of the type
+    def initialize name, substring = ''
+      @name = name
+      @substring = substring
+      @tag = name
+      @tag += "<#{substring}>" unless substring.empty?
+      @subtypes = []
+      @subtypes.concat(ComplexType.parse(substring)) unless substring.empty?
+    end
+
+    # @return [Boolean]
+    def duck_type?
+      @duck_type ||= name.start_with?('#')
+    end
+
+    # @return [Boolean]
+    def nil_type?
+      @nil_type ||= (name.downcase == 'nil')
+    end
+
+    # @return [String]
+    def namespace
+      @namespace ||= 'Object' if duck_type?
+      @namespace ||= 'NilClass' if nil_type?
+      @namespace ||= ((name == 'Class' or name == 'Module') and !subtypes.empty?) ? subtypes.first.name : name
+    end
+
+    # @return [Symbol] :class or :instance
+    def scope
+      @scope ||= :instance if duck_type? or nil_type?
+      @scope ||= ((name == 'Class' or name == 'Module') and !subtypes.empty?) ? :class : :instance
+    end
+
+    class << self
+      # @param *strings [Array<String>] The type definitions to parse
+      # @return [Array<ComplexType>]
+      def parse *strings
+        types = []
+        strings.each do |type_string|
+          point_stack = 0
+          base = ''
+          subtype_string = ''
+          type_string.each_char do |char|
+            if char == '<'
+              point_stack += 1
+              next if point_stack == 1
+            elsif char == '>'
+              point_stack -= 1
+              raise 'Invalid close in type' if point_stack < 0
+            elsif char == ',' and point_stack == 0
+              types.push ComplexType.new base.strip, subtype_string.strip
+              base = ''
+              subtype_string = ''
+              next
+            end
+            if point_stack == 0 and char != '>'
+              base += char 
+            elsif point_stack != 0
+              subtype_string += char
+            end
+          end
+          base.strip!
+          subtype_string.strip!
+          raise 'Unclosed subtype' if point_stack != 0
+          types.push ComplexType.new base, subtype_string
+        end
+        types
+      end
+    end
+  end
+end

data/lib/solargraph/diagnostics.rb

@@ -7,6 +7,7 @@ module Solargraph
     autoload :Severities, 'solargraph/diagnostics/severities'
     autoload :Rubocop, 'solargraph/diagnostics/rubocop'
     autoload :RequireNotFound, 'solargraph/diagnostics/require_not_found'
+    autoload :TypeNotDefined, 'solargraph/diagnostics/type_not_defined'
 
     class << self
       # Add a reporter with a name to identify it in .solargraph.yml files.
@@ -42,5 +43,6 @@ module Solargraph
 
     register 'rubocop', Rubocop
     register 'require_not_found', RequireNotFound
+    register 'type_not_defined', TypeNotDefined
   end
 end

data/lib/solargraph/diagnostics/base.rb

@@ -1,9 +1,12 @@
 module Solargraph
   module Diagnostics
     class Base
-      # @param source [Solargraph::Source]
-      # @param source [Solargraph::ApiMap]
+      # Perform a diagnosis on a Source within the context of an ApiMap.
+      # The result is an array of hash objects that conform to the LSP's
+      # Diagnostic specification.
       #
+      # @param source [Solargraph::Source]
+      # @param api_map [Solargraph::ApiMap]
       # @return [Array<Hash>]
       def diagnose source, api_map
       end

data/lib/solargraph/diagnostics/type_not_defined.rb

@@ -0,0 +1,110 @@
+module Solargraph
+  module Diagnostics
+    # TypeNotDefined reports methods with undefined return types, untagged
+    # parameters, and invalid param tags.
+    #
+    class TypeNotDefined < Base
+      def diagnose source, api_map
+        result = []
+        source.pins.select{|p| p.kind == Pin::METHOD or p.kind == Pin::ATTRIBUTE}.each do |pin|
+          result.concat check_return_type(pin, api_map, source)
+          result.concat check_param_types(pin, api_map, source)
+          result.concat check_param_tags(pin, api_map, source)
+        end
+        result
+      end
+
+      private
+
+      def check_return_type pin, api_map, source
+        return [] if (pin.name == 'initialize' and pin.scope == :instance) or (pin.name == 'new' and pin.scope == :class)
+        result = []
+        unless defined_return_type?(pin, api_map)
+          result.push(
+            range: extract_first_line(pin, source),
+            severity: Diagnostics::Severities::WARNING,
+            source: 'Solargraph',
+            message: "Method `#{pin.name}` has undefined return type."
+          )
+        end
+        result
+      end
+
+      def check_param_types pin, api_map, source
+        return [] if pin.name == 'new' and pin.scope == :class
+        result = []
+        pin.parameter_names.each do |par|
+          next if defined_param_type?(pin, par, api_map)
+          result.push(
+            range: extract_first_line(pin, source),
+            severity: Diagnostics::Severities::WARNING,
+            source: 'Solargraph',
+            message: "Method `#{pin.name}` has undefined param `#{par}`."
+          )
+        end
+        result
+      end
+
+      def check_param_tags pin, api_map, source
+        result = []
+        unless pin.docstring.nil?
+          pin.docstring.tags(:param).each do |par|
+            next if pin.parameter_names.include?(par.name)
+            result.push(
+              range: extract_first_line(pin, source),
+              severity: Diagnostics::Severities::WARNING,
+              source: 'Solargraph',
+              message: "Method `#{pin.name}` has mistagged param `#{par.name}`."
+            )
+          end
+        end
+        result
+      end
+
+      def extract_first_line pin, source
+        {
+          start: {
+            line: pin.location.range.start.line,
+            character: pin.location.range.start.character
+          },
+          end: {
+            line: pin.location.range.start.line,
+            character: last_character(pin.location.range.start, source)
+          }
+        }
+      end
+
+      def defined_return_type? pin, api_map
+        return true unless pin.return_type.nil?
+        matches = api_map.get_methods(pin.namespace, scope: pin.scope, visibility: [:public, :private, :protected]).select{|p| p.name == pin.name}
+        matches.shift
+        matches.any?{|m| !m.return_type.nil?}
+      end
+
+      def defined_param_type? pin, param, api_map
+        return true if param_in_docstring?(param, pin.docstring)
+        matches = api_map.get_methods(pin.namespace, scope: pin.scope, visibility: [:public, :private, :protected]).select{|p| p.name == pin.name}
+        matches.shift
+        matches.each do |m|
+          next unless pin.parameter_names == m.parameter_names
+          return true if param_in_docstring?(param, m.docstring)
+        end
+        false
+      end
+
+      def param_in_docstring? param, docstring
+        return false if docstring.nil?
+        tags = docstring.tags(:param)
+        tags.any?{|t| t.name == param}
+      end
+
+      # @param position [Solargraph::Source::Position]
+      # @param source [Solargraph::Source]
+      # @return [Integer]
+      def last_character position, source
+        cursor = Source::Position.to_offset(source.code, position)
+        source.code.index(/[\r\n]/, cursor) || source.code.length
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/host.rb

@@ -477,12 +477,18 @@ module Solargraph
               begin
                 changed = false
                 @change_queue.sort!{|a, b| a['textDocument']['version'] <=> b['textDocument']['version']}
+                pending = {}
+                @change_queue.each do |obj|
+                  pending[obj['textDocument']['uri']] ||= 0
+                  pending[obj['textDocument']['uri']] += 1
+                end
                 @change_queue.delete_if do |change|
                   filename = uri_to_file(change['textDocument']['uri'])
                   source = library.checkout(filename)
                   if change['textDocument']['version'] == source.version + change['contentChanges'].length
+                    pending[change['textDocument']['uri']] -= 1
                     updater = generate_updater(change)
-                    library.synchronize updater
+                    library.synchronize updater, pending[change['textDocument']['uri']] == 0
                     @diagnostics_queue.push change['textDocument']['uri']
                     changed = true
                     next true
@@ -491,8 +497,9 @@ module Solargraph
                     # increments the version by one regardless of the number
                     # of changes
                     STDERR.puts "Warning: change applied to #{uri_to_file(change['textDocument']['uri'])} is possibly out of sync"
+                    pending[change['textDocument']['uri']] -= 1
                     updater = generate_updater(change)
-                    library.synchronize updater
+                    library.synchronize updater, pending[change['textDocument']['uri']] == 0
                     @diagnostics_queue.push change['textDocument']['uri']
                     changed = true
                     next true
@@ -521,7 +528,6 @@ module Solargraph
 
       def start_diagnostics_thread
         Thread.new do
-          diagnoser = Diagnostics::Rubocop.new
           until stopped?
             sleep 0.1
             if !options['diagnostics']

data/lib/solargraph/language_server/message/exit_notification.rb

@@ -4,7 +4,6 @@ module Solargraph
       class ExitNotification < Base
         def process
           host.stop
-          exit
         end
       end
     end

data/lib/solargraph/language_server/message/shutdown.rb

@@ -3,7 +3,7 @@ module Solargraph
     module Message
       class Shutdown < Base
         def process
-          set_result({})
+          # Nothing to do?
         end
       end
     end

data/lib/solargraph/library.rb

@@ -2,7 +2,6 @@ module Solargraph
   # A library handles coordination between a Workspace and an ApiMap.
   #
   class Library
-
     # @param workspace [Solargraph::Workspace]
     def initialize workspace = Solargraph::Workspace.new(nil)
       @workspace = workspace
@@ -93,6 +92,8 @@ module Solargraph
       end
     end
 
+    # @param filename [String]
+    # @param version [Integer]
     def overwrite filename, version
       source = source_hash[filename]
       return if source.nil?
@@ -206,14 +207,22 @@ module Solargraph
       api_map.refresh force
     end
 
+    # @param query [String]
+    # @return [Array<YARD::CodeObject::Base>]
     def document query
       api_map.document query
     end
 
+    # @param query [String]
+    # @return [Array<String>]
     def search query
       api_map.search query
     end
 
+    # Get an array of all symbols in the workspace that match the query.
+    #
+    # @param query [String]
+    # @return [Array<Pin::Base>]
     def query_symbols query
       api_map.query_symbols query
     end
@@ -231,9 +240,9 @@ module Solargraph
     end
 
     # @param updater [Solargraph::Source::Updater]
-    def synchronize updater
+    def synchronize updater, reparse = true
       source = read(updater.filename)
-      source.synchronize updater
+      source.synchronize updater, reparse
     end
 
     # Get the current text of a file in the library.