solargraph 0.13.0 → 0.13.1

data/lib/solargraph/code_map.rb

@@ -5,7 +5,7 @@ module Solargraph
 
     # The root node of the parsed code.
     #
-    # @return [AST::Node]
+    # @return [Parser::AST::Node]
     attr_reader :node
 
     # The source code being analyzed.
@@ -39,13 +39,11 @@ module Solargraph
       self.api_map.refresh
     end
 
-    # Get the ApiMap that was generated for this CodeMap.
+    # Get the associated ApiMap.
     #
     # @return [Solargraph::ApiMap]
     def api_map
       @api_map ||= ApiMap.new(workspace)
-      #@api_map.refresh
-      #@api_map
     end
 
     # Get the offset of the specified line and column.
@@ -67,7 +65,7 @@ module Solargraph
           offset += l.length
         }
       end
-      offset + col      
+      offset + col
     end
 
     # Get an array of nodes containing the specified index, starting with the
@@ -156,25 +154,6 @@ module Solargraph
       end
     end
 
-    # Select the phrase that directly precedes the specified index.
-    # A phrase can consist of most types of characters other than whitespace,
-    # semi-colons, equal signs, parentheses, or brackets.
-    #
-    # @param index [Integer]
-    # @return [String]
-    def phrase_at index
-      word = ''
-      cursor = index - 1
-      while cursor > -1
-        char = @code[cursor, 1]
-        break if char.nil? or char == ''
-        break unless char.match(/[\s;=\(\)\[\]\{\}]/).nil?
-        word = char + word
-        cursor -= 1
-      end
-      word
-    end
-
     # Select the word that directly precedes the specified index.
     # A word can only consist of letters, numbers, and underscores.
     #
@@ -186,6 +165,7 @@ module Solargraph
       while cursor > -1
         char = @code[cursor, 1]
         break if char.nil? or char == ''
+        word = char + word if char == '$'
         break unless char.match(/[a-z0-9_]/i)
         word = char + word
         cursor -= 1
@@ -193,6 +173,7 @@ module Solargraph
       word
     end
 
+    # @return [Array<Solargraph::Suggestion>]
     def get_class_variables_at(index)
       ns = namespace_at(index) || ''
       api_map.get_class_variables(ns)
@@ -209,73 +190,59 @@ module Solargraph
     # Get suggestions for code completion at the specified location in the
     # source.
     #
-    # @return [Array<Suggestions>] The completion suggestions
-    def suggest_at index, filtered: false, with_snippets: false
+    # @return [Array<Solargraph::Suggestion>] The completion suggestions
+    def suggest_at index, filtered: true, with_snippets: false
       return [] if string_at?(index) or string_at?(index - 1) or comment_at?(index)
-      result = []
       signature = get_signature_at(index)
-      if signature.start_with?(':')
-        result.concat api_map.get_symbols
-      else
-        if index == 0 or @code[index - 1].match(/[\.\s]/)
-          type = infer_signature_at(index)
-        else
-          if signature.include?('.')
-            last_period = @code[0..index].rindex('.')
-            if last_period.nil?
-              type = infer_signature_at(index)
-            else
-              type = infer_signature_at(last_period)
-            end  
-          else
-            if signature.start_with?('@@')
-              return get_class_variables_at(index)
-            elsif signature.start_with?('@')
-              return get_instance_variables_at(index)
-            elsif signature.start_with?('$')
-              return api_map.get_global_variables
-            else
-              type = infer_signature_at(index)
-            end
-          end
+      unless signature.include?('.')
+        if signature.start_with?(':')
+          return api_map.get_symbols
+        elsif signature.start_with?('@@')
+          return get_class_variables_at(index)
+        elsif signature.start_with?('@')
+          return get_instance_variables_at(index)
+        elsif signature.start_with?('$')
+          return api_map.get_global_variables
         end
-        if type.nil?
-          unless signature.include?('.')
-            phrase = phrase_at(index)
-            signature = get_signature_at(index)
-            namespace = namespace_at(index)
-            if phrase.include?('::')
-              parts = phrase.split('::', -1)
-              ns = parts[0..-2].join('::')
-              if parts.last.include?('.')
-                ns = parts[0..-2].join('::') + '::' + parts.last[0..parts.last.index('.')-1]
-                result = api_map.get_methods(ns)
-              else
-                result = api_map.namespaces_in(ns, namespace)
+      end
+      result = []
+      type = nil
+      if signature.include?('.')
+        type = infer_signature_at(index)
+        if type.nil? and signature.include?('.')
+          last_period = @code[0..index].rindex('.')
+          type = infer_signature_at(last_period)
+        end
+      end
+      if type.nil?
+        unless signature.include?('.')
+          namespace = namespace_at(index)
+          if signature.include?('::')
+            parts = signature.split('::', -1)
+            ns = parts[0..-2].join('::')
+            result = api_map.namespaces_in(ns, namespace)
+          else
+            type = infer_literal_node_type(node_at(index - 2))
+            if type.nil?
+              current_namespace = namespace_at(index)
+              parts = current_namespace.to_s.split('::')
+              result += get_snippets_at(index) if with_snippets
+              result += get_local_variables_and_methods_at(index)
+              result += ApiMap.get_keywords
+              while parts.length > 0
+                ns = parts.join('::')
+                result += api_map.namespaces_in(ns, namespace)
+                parts.pop
               end
+              result += api_map.namespaces_in('')
+              result += api_map.get_instance_methods('Kernel')
             else
-              type = infer_literal_node_type(node_at(index - 2))
-              if type.nil?
-                current_namespace = namespace_at(index)
-                parts = current_namespace.to_s.split('::')
-                result += get_snippets_at(index) if with_snippets
-                result += get_local_variables_and_methods_at(index)
-                result += ApiMap.get_keywords
-                while parts.length > 0
-                  ns = parts.join('::')
-                  result += api_map.namespaces_in(ns, namespace)
-                  parts.pop
-                end
-                result += api_map.namespaces_in('')
-                result += api_map.get_instance_methods('Kernel')
-              else
-                result.concat api_map.get_instance_methods(type)
-              end
+              result.concat api_map.get_instance_methods(type)
             end
           end
-        else
-          result.concat api_map.get_instance_methods(type)
         end
+      else
+        result.concat api_map.get_instance_methods(type)
       end
       result = reduce_starting_with(result, word_at(index)) if filtered
       result.uniq{|s| s.path}.sort{|a,b| a.label <=> b.label}
@@ -285,7 +252,8 @@ module Solargraph
       sig = signature_index_before(index)
       return [] if sig.nil?
       word = word_at(sig)
-      suggest_at(sig).reject{|s| s.label != word}
+      sugg = suggest_at(sig - word.length)
+      sugg.select{|s| s.label == word}
     end
 
     def resolve_object_at index
@@ -323,7 +291,7 @@ module Solargraph
       if path.start_with?('Class<')
         path.gsub!(/^Class<([a-z0-9_:]*)>#([a-z0-9_]*)$/i, '\\1.\\2')
       end
-      api_map.yard_map.objects(path, ns_here)
+      api_map.get_path_suggestions(path)
     end
 
     # Infer the type of the signature located at the specified index.
@@ -360,6 +328,7 @@ module Solargraph
         node = parent_node_from(index, :class, :module, :def, :defs) || @node
         result = infer_signature_from_node signature, node
         if result.nil? or result.empty?
+          # The rest of this routine is dedicated to method and block parameters
           arg = nil
           if node.type == :def or node.type == :defs or node.type == :block
             # Check for method arguments
@@ -370,7 +339,7 @@ module Solargraph
               if parts[1].nil?
                 result = arg.return_type
               else
-                result = api_map.infer_signature_type(parts[1], parts[0], scope: :instance)
+                result = api_map.infer_signature_type(parts[1], arg.return_type, scope: :instance)
               end
             end
           end
@@ -445,20 +414,12 @@ module Solargraph
       return nil if start.nil?
       remainder = parts[1..-1]
       if start.start_with?('@@')
-        #type = api_map.infer_class_variable(start, ns_here)
-        #return nil if type.nil?
-        #return type if remainder.empty?
-        #return api_map.infer_signature_type(remainder.join('.'), type, scope: :instance)
-        cv = api_map.get_class_variables(ns_here).select{|s| s.label == start}.first
-        return cv.return_type unless cv.nil?
+        cv = api_map.get_class_variable_pins(ns_here).select{|s| s.name == start}.first
+        return (cv.return_type || api_map.infer_assignment_node_type(cv.node, cv.namespace)) unless cv.nil?
       elsif start.start_with?('@')
         scope = (node.type == :def ? :instance : :class)
-        #type = api_map.infer_instance_variable(start, ns_here, scope)
-        #return nil if type.nil?
-        #return type if remainder.empty?
-        #return api_map.infer_signature_type(remainder.join('.'), type, scope: :instance)
-        iv = api_map.get_instance_variables(ns_here, scope).select{|s| s.label == start}.first
-        return iv.return_type unless iv.nil?
+        iv = api_map.get_instance_variable_pins(ns_here, scope).select{|s| s.name == start}.first
+        return (iv.return_type || api_map.infer_assignment_node_type(iv.node, iv.namespace)) unless iv.nil?
       end
       var = find_local_variable_node(start, node)
       if var.nil?
@@ -512,81 +473,11 @@ module Solargraph
     # @param index [Integer]
     # @return [String]
     def get_signature_at index
-      brackets = 0
-      squares = 0
-      parens = 0
-      signature = ''
-      index -=1
-      while index >= 0
-        unless 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] != '%'
-            if char == '@'
-              signature = "@#{signature}" if @code[index-1, 1] == '@'
-              break
-            end
-          end
-        end
-        index -= 1
-      end
-      signature = signature[1..-1] if signature.start_with?('.')
-      #signature = signature[2..-1] if signature.start_with?('[]')
-      signature
+      get_signature_data_at(index)[1]
     end
 
     def get_signature_index_at index
-      brackets = 0
-      squares = 0
-      parens = 0
-      signature = ''
-      index -=1
-      while index >= 0
-        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
-        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)
-          if char == '@'
-            signature = "@#{signature}" if @code[index-1, 1] == '@'
-            break
-          end
-        end
-        index -= 1
-      end
-      signature = signature[1..-1] if signature.start_with?('.')
-      signature = signature[2..-1] if signature.start_with?('[]')
-      index + 1
+      get_signature_data_at(index)[0]
     end
 
     def get_snippets_at(index)
@@ -616,7 +507,8 @@ module Solargraph
     def get_local_variables_and_methods_at(index)
       result = []
       local = parent_node_from(index, :class, :module, :def, :defs) || @node
-      result += get_local_variables_from(local)
+      #result += get_local_variables_from(local)
+      result += get_local_variables_from(node_at(index))
       scope = namespace_at(index) || @node
       if local.type == :def
         result += api_map.get_instance_methods(scope, visibility: [:public, :private, :protected])
@@ -627,12 +519,53 @@ module Solargraph
         result += get_method_arguments_from local
       end
       result += get_yieldparams_at(index)
-      result += api_map.get_methods('Kernel')
+      # @todo This might not be necessary.
+      #result += api_map.get_methods('Kernel')
       result
     end
 
     private
 
+    def get_signature_data_at index
+      brackets = 0
+      squares = 0
+      parens = 0
+      signature = ''
+      index -=1
+      while index >= 0
+        unless 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
+            end
+          end
+        end
+        index -= 1
+      end
+      signature = signature[1..-1] if signature.start_with?('.')
+      [index + 1, signature]
+    end
+
     # Get a node's arguments as an array of suggestions. The node's type must
     # be a method (:def or :defs).
     #
@@ -682,8 +615,8 @@ module Solargraph
         meths += api_map.get_methods('')
         meth = meths.keep_if{ |s| s.to_s == block_node.children[0].children[1].to_s }.first
         yps = []
-        unless meth.nil? or meth.documentation.nil?
-          yps = meth.documentation.tags(:yieldparam) || []
+        unless meth.nil? or meth.docstring.nil?
+          yps = meth.docstring.tags(:yieldparam) || []
         end
         i = 0
         block_node.children[1].children.each do |a|
@@ -703,24 +636,22 @@ module Solargraph
       }
     end
 
+    # Find all the local variables in the node's scope.
+    #
+    # @return [Array<Solargraph::Suggestion>]
     def get_local_variables_from(node)
       node ||= @node
+      namespace = namespace_from(node)
       arr = []
-      node.children.each { |c|
-        if c.kind_of?(AST::Node)
-          if c.type == :lvasgn
-            type = api_map.infer_assignment_node_type(c, namespace_from(c))
-            arr.push Suggestion.new(c.children[0], kind: Suggestion::VARIABLE, documentation: api_map.get_comment_for(c), return_type: type)
-          else
-            arr += get_local_variables_from(c) unless [:class, :module, :def, :defs].include?(c.type)
-          end
-        end
-      }
+      @source.local_variable_pins.select{|p| p.visible_from?(node) }.each do |pin|
+        #arr.push Suggestion.new(pin.name, kind: Suggestion::VARIABLE, return_type: api_map.infer_assignment_node_type(pin.node, namespace))
+        arr.push Suggestion.new(pin.name, kind: Suggestion::VARIABLE)
+      end
       arr
     end
 
     def inner_node_at(index, node, arr)
-      node.children.each { |c|
+      node.children.each do |c|
         if c.kind_of?(AST::Node)
           unless c.loc.expression.nil?
             if index >= c.loc.expression.begin_pos
@@ -735,7 +666,7 @@ module Solargraph
           end
           inner_node_at(index, c, arr)
         end
-      }
+      end
     end
 
     def find_local_variable_node name, scope
@@ -762,11 +693,9 @@ module Solargraph
       while parts.length > 0
         result = api_map.find_fully_qualified_namespace("#{conc}::#{parts[0]}", namespace)
         if result.nil? or result.empty?
-          #sugg = api_map.namespaces_in(conc, namespace).select{ |s| s.label == parts[0] }.first
-          bla = api_map.get_constants(conc, namespace)
-          sugg = api_map.get_constants(conc, namespace).select{|s| s.label == parts[0]}.first
-          return nil if sugg.nil?
-          result = sugg.return_type
+          pin = api_map.get_constant_pins(conc, namespace).select{|s| s.name == parts[0]}.first
+          return nil if pin.nil?
+          result = pin.return_type || api_map.infer_assignment_node_type(pin.node, namespace)
           break if result.nil?
           is_constant = true
           conc = result

data/lib/solargraph/node_methods.rb

@@ -1,9 +1,11 @@
 module Solargraph
   module NodeMethods
+    # @return [String]
     def unpack_name(node)
       pack_name(node).join("::")
     end
-    
+
+    # @return [Array<String>]
     def pack_name(node)
       parts = []
       if node.kind_of?(AST::Node)
@@ -22,6 +24,7 @@ module Solargraph
       parts
     end
 
+    # @return [String]
     def const_from node
       if node.kind_of?(AST::Node) and node.type == :const
         result = ''
@@ -39,6 +42,7 @@ module Solargraph
       end
     end
 
+    # @return [String]
     def infer_literal_node_type node
       return nil unless node.kind_of?(AST::Node)
       if node.type == :str or node.type == :dstr

data/lib/solargraph/pin/attribute.rb

@@ -3,14 +3,27 @@ module Solargraph
     class Attribute < Base
       attr_reader :access
 
-      def initialize source, node, namespace, access
+      def initialize source, node, namespace, access, docstring
         super(source, node, namespace)
         @access = access
+        @docstring = docstring
       end
 
       def name
         @name ||= "#{node.children[0]}#{access == :writer ? '=' : ''}"
       end
+
+      def path
+        @path ||= namespace + '#' + name
+      end
+
+      def return_type
+        if @return_type.nil? and !docstring.nil?
+          tag = docstring.tag(:return)
+          @return_type = tag.types[0] unless tag.nil?
+        end
+        @return_type
+      end
     end
   end
 end

data/lib/solargraph/pin/base.rb

@@ -1,8 +1,13 @@
 module Solargraph
   module Pin
     class Base
+      # @return [Solargraph::ApiMap::Source]
       attr_reader :source
+
+      # @return [Parser::AST::Node]
       attr_reader :node
+
+      # @return [String]
       attr_reader :namespace
 
       def initialize source, node, namespace
@@ -11,37 +16,50 @@ module Solargraph
         @namespace = namespace
       end
 
+      # @return [YARD::Docstring]
       def docstring
         @docstring ||= source.docstring_for(node)
       end
 
+      # @return [String]
       def name
         nil
       end
 
+      # @return [String]
       def path
         nil
       end
 
+      # @return [String]
       def kind
         nil
       end
 
+      # @return [String]
       def return_type
         nil
       end
 
+      # @return [String]
       def signature
         nil
       end
 
+      # @return [String]
       def value
         nil
       end
 
+      # @return [Array<String>]
       def parameters
         []
       end
+
+      # @return [String]
+      def filename
+        source.filename
+      end
     end
   end
 end

data/lib/solargraph/pin/global_variable.rb

@@ -0,0 +1,6 @@
+module Solargraph
+  module Pin
+    class GlobalVariable < BaseVariable
+    end
+  end
+end

data/lib/solargraph/pin/local_variable.rb

@@ -0,0 +1,25 @@
+module Solargraph
+  module Pin
+    class LocalVariable < BaseVariable
+      def initialize source, node, namespace, ancestors
+        super(source, node, namespace)
+        @tree = []
+        ancestors.each do |parent|
+          if [:block, :def, :defs, :class, :module, :source].include? parent.type
+            @tree.push parent
+            break unless parent.type == :block
+          end
+        end
+      end
+
+      def visible_from? node
+        parents = [node] + (source.tree_for(node) || [])
+        parents.each do |p|
+          return true if @tree[0] == p
+          return false if [:def, :defs, :class, :module].include?(p.type)
+        end
+        false
+      end
+    end
+  end
+end

data/lib/solargraph/pin/method.rb

@@ -50,6 +50,8 @@ module Solargraph
         list.children.each { |c|
           if c.type == :arg
             args.push c.children[0].to_s
+          elsif c.type == :restarg
+            args.push "*#{c.children[0]}"
           elsif c.type == :optarg
             args.push "#{c.children[0]} = #{source.code_for(c.children[1])}"
           elsif c.type == :kwarg

data/lib/solargraph/pin.rb

@@ -6,6 +6,8 @@ module Solargraph
     autoload :BaseVariable, 'solargraph/pin/base_variable'
     autoload :InstanceVariable, 'solargraph/pin/instance_variable'
     autoload :ClassVariable, 'solargraph/pin/class_variable'
+    autoload :LocalVariable, 'solargraph/pin/local_variable'
+    autoload :GlobalVariable, 'solargraph/pin/global_variable'
     autoload :Constant, 'solargraph/pin/constant'
     autoload :Symbol, 'solargraph/pin/symbol'
   end