solargraph 0.16.0 → 0.17.0

data/lib/solargraph/code_map.rb

@@ -2,6 +2,7 @@ require 'parser/current'
 
 module Solargraph
   class CodeMap
+    autoload :Statement, 'solargraph/code_map/statement'
 
     # The root node of the parsed code.
     #
@@ -24,10 +25,7 @@ module Solargraph
     attr_reader :filename
 
     include NodeMethods
-
-    METHODS_WITH_YIELDPARAM_SUBTYPES = %w[
-      Array#each Hash#each_pair Array#map
-    ]
+    include CoreFills
 
     def initialize code: '', filename: nil, api_map: nil, cursor: nil
       # HACK: Adjust incoming filename's path separator for yardoc file comparisons
@@ -195,7 +193,7 @@ module Solargraph
     # source.
     #
     # @return [Array<Solargraph::Suggestion>] The completion suggestions
-    def suggest_at index, filtered: true, with_snippets: false
+    def suggest_at index, filtered: true
       return [] if string_at?(index) or string_at?(index - 1) or comment_at?(index)
       signature = get_signature_at(index)
       unless signature.include?('.')
@@ -227,23 +225,23 @@ module Solargraph
             result = api_map.get_constants(ns, namespace)
           else
             type = infer_literal_node_type(node_at(index - 2))
+            return [] if type.nil? and signature.empty? and !@code[0..index].rindex('.').nil? and @code[@code[0..index].rindex('.')..-1].strip == '.'
             if type.nil?
-              result += get_snippets_at(index) if with_snippets
-              result += get_local_variables_and_methods_at(index)
-              result += ApiMap.get_keywords
-              result += api_map.get_constants('', namespace)
-              result += api_map.get_constants('')
-              result += api_map.get_instance_methods('Kernel', namespace)
-              result += api_map.get_methods('', namespace)
-              #result += api_map.get_instance_methods('', namespace)
+              result.concat get_local_variables_and_methods_at(index)
+              result.concat ApiMap.keywords
+              result.concat api_map.get_constants('', namespace)
+              result.concat api_map.get_constants('')
+              result.concat api_map.get_instance_methods('Kernel', namespace)
+              result.concat api_map.get_methods('', namespace)
             else
-              result.concat api_map.get_instance_methods(type)
+              result.concat api_map.get_instance_methods(type) unless @code[index - 1] != '.'
             end
           end
         end
       else
         result.concat api_map.get_instance_methods(type) unless (type == '' and signature.include?('.'))
       end
+      result.keep_if{|s| s.kind != Solargraph::Suggestion::METHOD or s.label.match(/^[a-z0-9_]*(\!|\?|=)?$/i)}
       result = reduce_starting_with(result, word_at(index)) if filtered
       # Use a stable sort to keep the class order (e.g., local methods before superclass methods)
       result.uniq(&:path).sort_by.with_index{ |x, idx| [x.label, idx] }
@@ -257,42 +255,44 @@ module Solargraph
       sugg.select{|s| s.label == word}
     end
 
-    def resolve_object_at index
+    # @return [Array<Solargraph::Suggestion>]
+    def define_symbol_at index
       return [] if string_at?(index)
-      signature = get_signature_at(index)
-      cursor = index
-      while @code[cursor] =~ /[a-z0-9_\?]/i
-        signature += @code[cursor]
-        cursor += 1
-        break if cursor >= @code.length
-      end
-      return [] if signature.to_s == ''
-      path = nil
-      ns_here = namespace_at(index)
+      signature = get_signature_at(index, final: true)
+      return [] if signature.to_s.empty?
       node = parent_node_from(index, :class, :module, :def, :defs) || @node
-      parts = signature.split('.')
-      if parts.length > 1
-        beginner = parts[0..-2].join('.')
-        type = infer_signature_from_node(beginner, node)
-        ender = parts.last
-        path = "#{type}##{ender}"
-      else
+      ns_here = namespace_from(node)
+      unless signature.include?('.')
         if local_variable_in_node?(signature, node)
-          path = infer_signature_from_node(signature, node)
+          return get_local_variables_from(node).select{|s| s.label == signature}
+        elsif signature.start_with?('@@')
+          return api_map.get_class_variables(ns_here).select{|s| s.label == signature}
         elsif signature.start_with?('@')
-          path = api_map.infer_instance_variable(signature, ns_here, (node.type == :def ? :instance : :class))
-        else
-          path = signature
-        end
-        if path.nil?
-          path = api_map.find_fully_qualified_namespace(signature, ns_here)
+          return api_map.get_instance_variables(ns_here, (node.type == :def ? :instance : :class)).select{|s| s.label == signature}
         end
       end
-      return [] if path.nil?
-      if path.start_with?('Class<')
-        path.gsub!(/^Class<([a-z0-9_:]*)>#([a-z0-9_]*)$/i, '\\1.\\2')
+      path = infer_path_from_signature_and_node(signature, node)
+      ps = []
+      ps = api_map.get_path_suggestions(path) unless path.nil?
+      return ps unless ps.empty?
+      ps = api_map.get_path_suggestions(signature)
+      return ps unless ps.empty?
+      scope = (node.type == :def ? :instance : :class)
+      final = []
+      if scope == :instance
+        final.concat api_map.get_instance_methods('', namespace_from(node), visibility: [:public, :private, :protected]).select{|s| s.to_s == signature}
+      else
+        final.concat api_map.get_methods('', namespace_from(node), visibility: [:public, :private, :protected]).select{|s| s.to_s == signature}
+      end
+      if final.empty? and !signature.include?('.')
+        fqns = api_map.find_fully_qualified_namespace(signature, ns_here)
+        final.concat api_map.get_path_suggestions(fqns) unless fqns.nil? or fqns.empty?
       end
-      api_map.get_path_suggestions(path)
+      final
+    end
+
+    def resolve_object_at index
+      define_symbol_at index
     end
 
     # Infer the type of the signature located at the specified index.
@@ -308,21 +308,14 @@ module Solargraph
     #
     # @return [String]
     def infer_signature_at index
-      signature = get_signature_at(index)
+      beg_sig, signature = get_signature_data_at(index)
       # Check for literals first
       return 'Integer' if signature.match(/^[0-9]+?\.?$/)
       literal = nil
       if (signature.empty? and @code[index - 1] == '.') or signature == '[].'
         literal = node_at(index - 2)
-      elsif signature.start_with?('.')
-        literal = node_at(index - 1)
       else
-        beg_sig = get_signature_index_at(index)
-        if @code[beg_sig] == '.'
-          literal = node_at(beg_sig - 1)
-        else
-          literal = node_at(1 + beg_sig)
-        end
+        literal = node_at(1 + beg_sig)
       end
       type = infer_literal_node_type(literal)
       if type.nil?
@@ -350,17 +343,15 @@ module Solargraph
             yp = get_yieldparams_at(index).keep_if{|s| s.to_s == parts[0]}.first
             unless yp.nil?
               if parts[1].nil? or parts[1].empty?
-                if yp.return_type.nil?
-                  STDERR.puts "Here is where we try to get the stupid, you know, the yieldparam type"
-                else
-                  result = yp.return_type
-                end
+                result = yp.return_type
               else
                 newsig = parts[1..-1].join('.')
                 result = api_map.infer_signature_type(newsig, yp.return_type, scope: :instance)
               end
             end
           end
+        #elsif match = result.match(/^\$(\-?[0-9]*)$/)
+        #  STDERR.puts "TODO: handle expression variable #{match[1]}"
         end
       else
         if signature.empty? or signature == '[].'
@@ -400,7 +391,7 @@ module Solargraph
       false
     end
 
-    def infer_signature_from_node signature, node
+    def infer_signature_from_node signature, node, call_node: nil
       inferred = nil
       parts = signature.split('.')
       ns_here = namespace_from(node)
@@ -438,33 +429,34 @@ module Solargraph
           return api_map.infer_signature_type(remainder.join('.'), vartype, scope: :instance)
         end
       end
+      # @todo There might be some redundancy between find_local_variable_node and call_node
       var = find_local_variable_node(start, node)
       if var.nil?
-        scope = (node.type == :def ? :instance : :class)
-        type = api_map.infer_signature_type(signature, ns_here, scope: scope)
-        return type unless type.nil?
+        arg = get_method_arguments_from(node).select{|s| s.label == start}.first
+        if arg.nil?
+          scope = (node.type == :def ? :instance : :class)
+          type = api_map.infer_signature_type(signature, ns_here, scope: scope, call_node: call_node)
+          return type unless type.nil?
+        else
+          type = arg.return_type
+        end
       else
         # Signature starts with a local variable
         type = nil
         lvp = source.local_variable_pins.select{|p| p.name == var.children[0].to_s and p.visible_from?(node) and (!p.nil_assignment? or p.return_type)}.first
-        type = lvp.return_type unless lvp.nil?
-        if type.nil?
-          vsig = resolve_node_signature(var.children[1])
-          type = infer_signature_from_node vsig, node
+        unless lvp.nil?
+          type = lvp.return_type
+          if type.nil?
+            vsig = resolve_node_signature(var.children[1])
+            type = infer_signature_from_node vsig, node, call_node: lvp.assignment_node
+          end
         end
       end
       unless type.nil?
-        if remainder[0] == 'new'
-          remainder.shift
-          if remainder.empty?
-            inferred = type
-          else
-            inferred = api_map.infer_signature_type(remainder.join('.'), type, scope: :instance)
-          end
-        elsif remainder.empty?
+        if remainder.empty?
           inferred = type
         else
-          inferred = api_map.infer_signature_type(remainder.join('.'), type, scope: :instance)
+          inferred = api_map.infer_signature_type(remainder.join('.'), type, scope: :instance, call_node: call_node)
         end
       end
       if inferred.nil? and node.respond_to?(:loc)
@@ -493,33 +485,23 @@ module Solargraph
     #
     # @param index [Integer]
     # @return [String]
-    def get_signature_at index
-      get_signature_data_at(index)[1]
+    def get_signature_at index, final: false
+      sig = get_signature_data_at(index)[1]
+      if final
+        cursor = index
+        while @code[cursor] =~ /[a-z0-9_\?]/i
+          sig += @code[cursor]
+          cursor += 1
+          break if cursor >= @code.length
+        end
+      end
+      sig
     end
 
     def get_signature_index_at index
       get_signature_data_at(index)[0]
     end
 
-    def get_snippets_at(index)
-      result = []
-      Snippets.definitions.each_pair { |name, detail|
-        matched = false
-        prefix = detail['prefix']
-        while prefix.length > 0
-          if @code[index-prefix.length, prefix.length] == prefix
-            matched = true
-            break
-          end
-          prefix = prefix[0..-2]
-        end
-        if matched
-          result.push Suggestion.new(detail['prefix'], kind: Suggestion::SNIPPET, detail: name, insert: detail['body'].join("\r\n"))
-        end
-      }
-      result
-    end
-
     # Get an array of local variables and methods that can be accessed from
     # the specified location in the code.
     #
@@ -542,6 +524,10 @@ module Solargraph
       result
     end
 
+    #def get_call_arguments_at index
+    #  called = parent_node_from(index, :send)
+    #end
+
     private
 
     def get_signature_data_at index
@@ -550,32 +536,46 @@ module Solargraph
       parens = 0
       signature = ''
       index -=1
+      in_whitespace = false
       while index >= 0
-        unless string_at?(index)
+        unless !in_whitespace and string_at?(index)
           break if brackets > 0 or parens > 0 or squares > 0
           char = @code[index, 1]
-          if char == ')'
-            parens -=1
-          elsif char == ']'
-            squares -=1
-          elsif char == '}'
-            brackets -= 1
-          elsif char == '('
-            parens += 1
-          elsif char == '{'
-            brackets += 1
-          elsif char == '['
-            squares += 1
-            signature = ".[]#{signature}" if squares == 0 and @code[index-2] != '%'
-          end
-          if brackets == 0 and parens == 0 and squares == 0
-            break if ['"', "'", ',', ' ', "\t", "\n", ';', '%'].include?(char)
-            signature = char + signature if char.match(/[a-z0-9:\._@\$]/i) and @code[index - 1] != '%'
-            break if char == '$'
-            if char == '@'
-              signature = "@#{signature}" if @code[index-1, 1] == '@'
-              break
+          if brackets.zero? and parens.zero? and squares.zero? and [' ', "\n", "\t"].include?(char)
+            in_whitespace = true
+          else
+            if brackets.zero? and parens.zero? and squares.zero? and in_whitespace
+              unless char == '.' or @code[index+1..-1].strip.start_with?('.')
+                old = @code[index+1..-1]
+                nxt = @code[index+1..-1].lstrip
+                index += (@code[index+1..-1].length - @code[index+1..-1].lstrip.length)
+                break
+              end
+            end
+            if char == ')'
+              parens -=1
+            elsif char == ']'
+              squares -=1
+            elsif char == '}'
+              brackets -= 1
+            elsif char == '('
+              parens += 1
+            elsif char == '{'
+              brackets += 1
+            elsif char == '['
+              squares += 1
+              signature = ".[]#{signature}" if squares == 0 and @code[index-2] != '%'
             end
+            if brackets.zero? and parens.zero? and squares.zero?
+              break if ['"', "'", ',', ';', '%'].include?(char)
+              signature = char + signature if char.match(/[a-z0-9:\._@\$]/i) and @code[index - 1] != '%'
+              break if char == '$'
+              if char == '@'
+                signature = "@#{signature}" if @code[index-1, 1] == '@'
+                break
+              end
+            end
+            in_whitespace = false
           end
         end
         index -= 1
@@ -621,23 +621,26 @@ module Solargraph
       return [] unless block_node.kind_of?(AST::Node) and block_node.type == :block
       result = []
       unless block_node.nil? or block_node.children[1].nil?
-        meth = get_yielding_method(block_node, scope_node)
+        ymeth = get_yielding_method(block_node, scope_node)
         yps = []
-        unless meth.nil? or meth.docstring.nil?
-          yps = meth.docstring.tags(:yieldparam) || []
+        unless ymeth.nil? or ymeth.docstring.nil?
+          yps = ymeth.docstring.tags(:yieldparam) || []
         end
         self_yield = nil
         meth = get_yielding_method_with_yieldself(block_node, scope_node)
         unless meth.nil?
           match = meth.docstring.all.match(/@yieldself \[([a-z0-9:_]*)/i)
           self_yield = match[1]
+          if self_yield == 'self'
+            blocksig = resolve_node_signature(block_node.children[0]).split('.')[0..-2].join('.')
+            self_yield = infer_signature_from_node(blocksig, scope_node)
+          end
         end
-        i = 0
-        block_node.children[1].children.each do |a|
+        block_node.children[1].children.each_with_index do |a, i|
           rt = nil
           if yps[i].nil? or yps[i].types.nil? or yps[i].types.empty?
             zsig = api_map.resolve_node_signature(block_node.children[0])
-            vartype = infer_signature_from_node(zsig.split('.').first, scope_node)
+            vartype = infer_signature_from_node(zsig.split('.')[0..-2].join('.'), scope_node)
             subtypes = get_subtypes(vartype)
             zpath = infer_path_from_signature_and_node(zsig, scope_node)
             rt = subtypes[i] if METHODS_WITH_YIELDPARAM_SUBTYPES.include?(zpath)
@@ -645,7 +648,6 @@ module Solargraph
             rt = yps[i].types[0]
           end
           result.push Suggestion.new(a.children[0], kind: Suggestion::PROPERTY, return_type: rt)
-          i += 1
         end
         result.concat api_map.get_instance_methods(self_yield, namespace_from(scope_node)) unless self_yield.nil?
       end
@@ -657,7 +659,8 @@ module Solargraph
       fqns = namespace_from(block_node)
       lvarnode = find_local_variable_node(recv, scope_node)
       if lvarnode.nil?
-        sig = api_map.infer_signature_type(recv, fqns)
+        #sig = api_map.infer_signature_type(recv, fqns)
+        sig = infer_signature_from_node(recv, scope_node)
       else
         tmp = resolve_node_signature(lvarnode.children[1])
         sig = infer_signature_from_node tmp, scope_node
@@ -800,10 +803,12 @@ module Solargraph
       parts = signature.split('.')
       last = parts.pop
       type = infer_signature_from_node(parts.join('.'), node)
+      return nil if type.nil?
       "#{type.gsub(/<[a-z0-9:, ]*>/i, '')}##{last}"
     end
 
     def get_subtypes type
+      return nil if type.nil?
       match = type.match(/<([a-z0-9_:, ]*)>/i)
       return [] if match.nil?
       match[1].split(',').map(&:strip)

data/lib/solargraph/core_fills.rb

@@ -0,0 +1,23 @@
+module Solargraph
+  module CoreFills
+    KEYWORDS = [
+      '__ENCODING__', '__LINE__', '__FILE__', 'BEGIN', 'END', 'alias', 'and',
+      'begin', 'break', 'case', 'class', 'def', 'defined?', 'do', 'else',
+      'elsif', 'end', 'ensure', 'false', 'for', 'if', 'in', 'module', 'next',
+      'nil', 'not', 'or', 'redo', 'rescue', 'retry', 'return', 'self', 'super',
+      'then', 'true', 'undef', 'unless', 'until', 'when', 'while', 'yield'
+    ].freeze
+
+    METHODS_RETURNING_SELF = %w{
+      Object#clone Object#dup Object#freeze Object#taint Object#untaint
+    }.freeze
+
+    METHODS_RETURNING_SUBTYPES = %w{
+      Array#[]
+    }.freeze
+
+    METHODS_WITH_YIELDPARAM_SUBTYPES = %w{
+      Array#each Hash#each_pair Array#map
+    }.freeze
+  end
+end

data/lib/solargraph/live_map.rb

@@ -76,25 +76,6 @@ module Solargraph
       @@plugin_registry[name] = klass
     end
 
-    # Register a plugin for LiveMap to use when generating suggestions.
-    # @deprecated See Solargraph::LiveMap.register instead
-    #
-    # @param cls [Class<Solargraph::Plugin::Base>]
-    def self.install cls
-      STDERR.puts "WARNING: The Solargraph::LiveMap.install procedure for installing plugins is no longer used. This operation will be ignored."
-    end
-
-    # @deprecated
-    def self.uninstall cls
-      STDERR.puts "WARNING: The Solargraph::LiveMap.uninstall procedure for uninstalling plugins is no longer used. This operation will be ignored."
-    end
-
-    # @deprecated
-    def self.plugins
-      STDERR.puts "WARNING: Plugins have changed. The Solargraph::LiveMap.plugins attribute is no longer used."
-      []
-    end
-
     def refresh
       changed = false
       runners.each do |p|

data/lib/solargraph/pin/base.rb

@@ -62,7 +62,7 @@ module Solargraph
       end
 
       def location
-        "#{source.filename}:#{node.location.expression.begin_pos}"
+        "#{source.filename}:#{node.location.expression.line - 1}:#{node.location.expression.column}"
       end
     end
   end

data/lib/solargraph/pin/base_variable.rb

@@ -19,8 +19,12 @@ module Solargraph
         @return_type ||= literal_from_assignment
       end
 
+      def assignment_node
+        @assignment_node ||= node.children[(node.type == :casgn ? 2 : 1)]
+      end
+
       def nil_assignment?
-        node.children[(node.type == :casgn ? 2 : 1)].type == :nil
+        assignment_node.type == :nil
       end
 
       def signature
@@ -30,7 +34,7 @@ module Solargraph
       private
 
       def literal_from_assignment
-        infer_literal_node_type(node.children[(node.type == :casgn ? 2 : 1)])
+        infer_literal_node_type(assignment_node)
       end
     end
   end

data/lib/solargraph/pin/method.rb

@@ -25,7 +25,7 @@ module Solargraph
       def return_type
         if @return_type.nil? and !docstring.nil?
           tag = docstring.tag(:return)
-          @return_type = tag.types[0] unless tag.nil?
+          @return_type = tag.types[0] unless tag.nil? or tag.types.nil?
         end
         @return_type
       end

data/lib/solargraph/plugin/process.rb

@@ -71,6 +71,7 @@ module Solargraph
             result.concat con.public_instance_methods(false)
           end
         end
+        result.keep_if{|m| m.to_s.match(/^[a-z_]/i)}
         respond_ok (result.uniq.sort.map do |name|
           # @type [Method]
           meth = con.method(name)