solargraph 0.21.0 → 0.22.0

data/lib/solargraph/language_server/message.rb

@@ -56,6 +56,8 @@ module Solargraph
       register 'textDocument/formatting',          TextDocument::Formatting
       register 'textDocument/onTypeFormatting',    TextDocument::OnTypeFormatting
       register 'textDocument/documentSymbol',      TextDocument::DocumentSymbol
+      register 'textDocument/references',          TextDocument::References
+      register 'textDocument/rename',              TextDocument::Rename
       register 'workspace/didChangeWatchedFiles',  Workspace::DidChangeWatchedFiles
       register 'workspace/didChangeConfiguration', Workspace::DidChangeConfiguration
       register 'workspace/symbol',                 Workspace::WorkspaceSymbol
@@ -64,6 +66,7 @@ module Solargraph
       register '$/solargraph/search',              Extended::Search
       register '$/solargraph/checkGemVersion',     Extended::CheckGemVersion
       register '$/solargraph/documentGems',        Extended::DocumentGems
+      register '$/solargraph/downloadCore',        Extended::DownloadCore
       register 'shutdown',                         Shutdown
       register 'exit',                             ExitNotification
     end

data/lib/solargraph/language_server/request.rb

@@ -9,6 +9,10 @@ module Solargraph
       def process result
         @block.call(result) unless @block.nil?
       end
+
+      def send_response
+        # noop
+      end
     end
   end
 end

data/lib/solargraph/language_server/transport/socket.rb

@@ -18,13 +18,13 @@ module Solargraph
           start_timers
         end
 
-        def process message
+        def process request
           Thread.new do
-            message = @host.start(message)
-            message.send
+            message = @host.start(request)
+            message.send_response
             tmp = @host.flush
             send_data tmp unless tmp.empty?
-            GC.start unless message['method'] == 'textDocument/didChange'
+            GC.start unless request['method'] == 'textDocument/didChange'
           end
         end
 

data/lib/solargraph/language_server/uri_helpers.rb

@@ -1,6 +1,8 @@
 module Solargraph
   module LanguageServer
     module UriHelpers
+      module_function
+
       # Convert a file URI to a path.
       #
       # @param uri [String]

data/lib/solargraph/library.rb

@@ -141,6 +141,30 @@ module Solargraph
       api_map.signify(fragment)
     end
 
+    def references_from filename, line, column
+      source = read(filename)
+      api_map.virtualize source
+      fragment = source.fragment_at(line, column)
+      pins = api_map.define(fragment)
+      return [] if pins.empty?
+      result = []
+      # @param pin [Solargraph::Pin::Base]
+      pins.uniq.each do |pin|
+        if pin.kind != Solargraph::Pin::NAMESPACE and !pin.location.nil?
+          mn_loc = get_symbol_name_location(pin)
+          result.push mn_loc unless mn_loc.nil?
+        end
+        (workspace.sources + source_hash.values).uniq(&:filename).each do |source|
+          found = source.references(pin.name).select do |loc|
+            referenced = definitions_at(loc.filename, loc.range.ending.line, loc.range.ending.character).first
+            !referenced.nil? and referenced.path == pin.path
+          end
+          result.concat found.sort{|a, b| a.range.start.line <=> b.range.start.line}
+        end
+      end
+      result
+    end
+
     # Get the pin at the specified location or nil if the pin does not exist.
     #
     # @return [Solargraph::Pin::Base]
@@ -270,5 +294,18 @@ module Solargraph
       raise FileNotFoundError, "File not found: #{filename}" unless File.file?(filename)
       Solargraph::Source.load(filename)
     end
+
+    def get_symbol_name_location pin
+      decsrc = read(pin.location.filename)
+      offset = Solargraph::Source::Position.to_offset(decsrc.code, pin.location.range.start)
+      soff = decsrc.code.index(pin.name, offset)
+      eoff = soff + pin.name.length
+      Solargraph::Source::Location.new(
+        pin.location.filename, Solargraph::Source::Range.new(
+          Solargraph::Source::Position.from_offset(decsrc.code, soff),
+          Solargraph::Source::Position.from_offset(decsrc.code, eoff)
+        )
+      )
+    end
   end
 end

data/lib/solargraph/live_map/cache.rb

@@ -4,6 +4,7 @@ module Solargraph
       def initialize
         @method_cache = {}
         @constant_cache = {}
+        @path_cache = {}
       end
 
       def get_methods options
@@ -12,6 +13,7 @@ module Solargraph
 
       def set_methods options, values
         @method_cache[options] = values
+        values.each { |pin| @path_cache[pin.path] = pin }
       end
 
       def get_constants namespace, root
@@ -22,9 +24,14 @@ module Solargraph
         @constant_cache[[namespace, root]] = values
       end
 
+      def get_path_pin path
+        @path_cache[path]
+      end
+
       def clear
         @method_cache.clear
         @constant_cache.clear
+        @path_cache.clear
       end
     end
   end

data/lib/solargraph/live_map.rb

@@ -9,11 +9,17 @@ module Solargraph
     # @return [Solargraph::ApiMap]
     attr_reader :api_map
 
+    # @param api_map [Solargraph::ApiMap]
     def initialize api_map
       @api_map = api_map
       runners
     end
 
+    def get_path_pin path
+      cache.get_path_pin(path)
+    end
+
+    # @return [Array<Solargraph::Pin::Base>]
     def get_methods(namespace, root = '', scope = 'instance', with_private = false)
       fqns = api_map.find_fully_qualified_namespace(namespace, root)
       params = {
@@ -26,7 +32,7 @@ module Solargraph
       runners.each do |p|
         next if did_runtime and p.runtime?
         p.get_methods(namespace: namespace, root: root, scope: scope, with_private: with_private).each do |m|
-          result.push Suggestion.new(m['name'], kind: Suggestion::METHOD, docstring: YARD::Docstring.new('(defined at runtime)'), path: "#{fqns}.#{m['name']}", arguments: m['parameters'])
+          result.push Solargraph::Pin::Method.new(nil, namespace, m['name'], YARD::Docstring.new('(defined at runtime)'), scope.to_sym, nil, [])
         end
         did_runtime = true if p.runtime?
       end
@@ -34,7 +40,7 @@ module Solargraph
       result
     end
 
-    # @return [Array<Solargraph::Suggestion>]
+    # @return [Array<Solargraph::Pin::Base>]
     def get_constants(namespace, root = '')
       cached = cache.get_constants(namespace, root)
       return cached unless cached.nil?

data/lib/solargraph/pin/attribute.rb

@@ -4,10 +4,14 @@ module Solargraph
       # @return [Symbol] :reader or :writer
       attr_reader :access
 
-      def initialize location, namespace, name, docstring, access
+      # @return [Symbol] :class or :instance
+      attr_reader :scope
+
+      def initialize location, namespace, name, docstring, access, scope
         super(location, namespace, name, docstring)
         @access = access
         @docstring = docstring
+        @scope = scope
       end
 
       def kind

data/lib/solargraph/pin/namespace.rb

@@ -1,8 +1,6 @@
 module Solargraph
   module Pin
     class Namespace < Pin::Base
-      include Solargraph::NodeMethods
-
       attr_reader :visibility
 
       attr_reader :type

data/lib/solargraph/pin/proxy_method.rb

@@ -0,0 +1,31 @@
+module Solargraph
+  module Pin
+    # ProxyMethod serves as a quick, disposable shortcut for providing context
+    # to type inference methods. ApiMap::Probe can treat it as an anonymous
+    # method while analyzing signatures.
+    #
+    class ProxyMethod
+      # @return [String]
+      attr_reader :return_type
+
+      def initialize return_type
+        @return_type = return_type
+      end
+
+      # @return [String]
+      def namespace
+        @namespace ||= ApiMap::TypeMethods.extract_namespace(@return_type)
+      end
+
+      # @return [Integer]
+      def kind
+        Pin::METHOD
+      end
+
+      # @return [Symbol]
+      def scope
+        :instance
+      end
+    end
+  end
+end

data/lib/solargraph/pin.rb

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

data/lib/solargraph/plugin/process.rb

@@ -33,7 +33,7 @@ module Solargraph
           rescue JSON::ParserError => e
             STDOUT.puts respond_err "Error parsing input: #{e.message}"
           rescue Exception => e
-            STDOUT.puts respond_err "Error processing input: #{e.message}"
+            STDOUT.puts respond_err "Error processing input: #{e.message}\n#{e.backtrace}"
           end
           STDOUT.flush
         end

data/lib/solargraph/plugin/runtime.rb

@@ -53,11 +53,14 @@ module Solargraph
         end
       end
 
+      def stop
+        @io.close
+      end
+
       protected
 
       def load_environment
         return if api_map.nil?
-        STDERR.puts "Required paths given to Runtime: #{api_map.required}"
         send_require api_map.required
         @current_required = api_map.required.clone
       end
@@ -66,8 +69,8 @@ module Solargraph
 
       def start_process
         dir = Dir.pwd
-        unless api_map.nil? or api_map.workspace.nil?
-          dir = api_map.workspace
+        unless api_map.nil? or api_map.workspace.nil? or api_map.workspace.directory.nil?
+          dir = api_map.workspace.directory
         end
         Dir.chdir(dir) do
           @io = IO.popen(executable, 'r+')

data/lib/solargraph/shell.rb

@@ -69,7 +69,6 @@ module Solargraph
       matches = []
       if options[:extensions]
         Gem::Specification.each do |g|
-          puts g.name
           if g.name.match(/^solargraph\-[A-Za-z0-9_\-]*?\-ext/)
             require g.name
             matches.push g.name

data/lib/solargraph/source/flawed_builder.rb

@@ -1,5 +1,8 @@
 module Solargraph
   class Source
+    # A custom builder for source parsers that ignores character encoding
+    # issues in literal strings.
+    #
     class FlawedBuilder < Parser::Builders::Default
       def string_value(token)
         value(token)

data/lib/solargraph/source/fragment.rb

@@ -3,12 +3,11 @@ module Solargraph
     class Fragment
       include NodeMethods
 
-      attr_reader :tree
-
       attr_reader :line
 
       attr_reader :column
 
+      # @return [Solargraph::Source]
       attr_reader :source
 
       # @param source [Solargraph::Source]
@@ -46,17 +45,6 @@ module Solargraph
         @argument ||= !signature_position.nil?
       end
 
-      def chained?
-        if @chained.nil?
-          @chained = false
-          @tree.each do |n|
-            @chained = true if n.type == :send
-            break
-          end
-        end
-        @chained
-      end
-
       # @return [Fragment]
       def recipient
         return nil if signature_position.nil?
@@ -319,9 +307,18 @@ module Solargraph
           @base_literal = 'Integer'
         # @todo Smelly exceptional case for array literals
         elsif signature.start_with?('.[]')
-          index += 3
-          signature = signature[index+3..-1].to_s
+          index += 2
+          signature = signature[3..-1].to_s
           @base_literal = 'Array'
+        elsif signature.start_with?('.')
+          pos = Position.from_offset(source.code, index)
+          node = source.node_at(pos.line, pos.character)
+          lit = infer_literal_node_type(node)
+          unless lit.nil?
+            signature = signature[1..-1].to_s
+            index += 1
+            @base_literal = lit
+          end
         end
         [index + 1, signature]
       end

data/lib/solargraph/source/location.rb

@@ -1,7 +1,10 @@
 module Solargraph
   class Source
     class Location
+      # @return [String]
       attr_reader :filename
+
+      # @return [Solargraph::Source::Range]
       attr_reader :range
 
       def initialize filename, range

data/lib/solargraph/source/mapper.rb

@@ -1,11 +1,19 @@
 module Solargraph
   class Source
+    # The Mapper generates pins and other data for Sources.
+    #
+    # This class is used internally by the Source class on initialization,
+    # e.g., via Source.new or Source.load. Users should not normally need to
+    # call it directly.
+    #
     class Mapper
       include NodeMethods
 
       private_class_method :new
 
-      # @return [Array<Solargraph::Pin::Base>]
+      # Generate the data.
+      #
+      # @return [Array]
       def map filename, code, node, comments
         @filename = filename
         @code = code
@@ -37,7 +45,7 @@ module Solargraph
       end
 
       class << self
-        # @return [Array<Solargraph::Pin::Base>]
+        # @return [Array]
         def map filename, code, node, comments
           new.map filename, code, node, comments
         end
@@ -98,9 +106,17 @@ module Solargraph
                     u = c.updated(:ivasgn, c.children + ora.children[1..-1], nil)
                     @docstring_hash[u.loc] = docstring_for(ora)
                     pins.push Solargraph::Pin::InstanceVariable.new(get_node_location(u), fqn || '', c.children[0].to_s, docstring_for(u), resolve_node_signature(u.children[1]), infer_literal_node_type(u.children[1]), context)
+                    if visibility == :module_function and context.kind == Pin::METHOD
+                      other = pins.select{|pin| pin.path == "#{context.namespace}.#{context.name}"}.first
+                      pins.push Solargraph::Pin::InstanceVariable.new(get_node_location(u), fqn || '', c.children[0].to_s, docstring_for(u), resolve_node_signature(u.children[1]), infer_literal_node_type(u.children[1]), other) unless other.nil?
+                    end
                   end
                 else
                   pins.push Solargraph::Pin::InstanceVariable.new(get_node_location(c), fqn || '',c.children[0].to_s, docstring_for(c), resolve_node_signature(c.children[1]), infer_literal_node_type(c.children[1]), context)
+                  if visibility == :module_function and context.kind == Pin::METHOD
+                    other = pins.select{|pin| pin.path == "#{context.namespace}.#{context.name}"}.first
+                    pins.push Solargraph::Pin::InstanceVariable.new(get_node_location(c), fqn || '',c.children[0].to_s, docstring_for(c), resolve_node_signature(c.children[1]), infer_literal_node_type(c.children[1]), other)
+                  end
                 end
               elsif c.type == :cvasgn
                 here = get_node_start_position(c)
@@ -134,7 +150,6 @@ module Solargraph
                 pins.push Solargraph::Pin::GlobalVariable.new(get_node_location(c), fqn, c.children[0].to_s, docstring_for(c), resolve_node_signature(c.children[1]), infer_literal_node_type(c.children[1]), @pins.first)
               elsif c.type == :sym
                 @symbols.push Solargraph::Pin::Symbol.new(get_node_location(c), ":#{c.children[0]}")
-
               elsif c.type == :casgn
                 here = get_node_start_position(c)
                 block = get_block_pin(here)
@@ -146,12 +161,15 @@ module Solargraph
                   # @todo Smelly instance variable access.
                   pins.last.instance_variable_set(:@return_type, methpin.namespace)
                   pins.push Solargraph::Pin::Method.new(methpin.location, methpin.namespace, methpin.name, methpin.docstring, methpin.scope, :private, methpin.parameters)
+                elsif visibility == :module_function
+                  pins.push Solargraph::Pin::Method.new(methpin.location, methpin.namespace, methpin.name, methpin.docstring, :class, :public, methpin.parameters)
+                  pins.push Solargraph::Pin::Method.new(methpin.location, methpin.namespace, methpin.name, methpin.docstring, :instance, :private, methpin.parameters)
                 else
                   pins.push methpin
                 end
               elsif c.type == :defs
                 s_visi = visibility
-                s_visi = :public if scope != :class
+                s_visi = :public if s_visi == :module_function or scope != :class
                 if c.children[0].is_a?(AST::Node) and c.children[0].type == :self
                   dfqn = fqn || ''
                 else
@@ -191,6 +209,32 @@ module Solargraph
                   end
                 end
                 next
+              elsif c.type == :send and c.children[1] == :module_function
+                # @todo Handle module_function
+                if c.children[2].nil?
+                  visibility = :module_function
+                elsif c.children[2].type == :sym or c.children[2].type == :str
+                  # @todo What to do about references?
+                  c.children[2..-1].each do |x|
+                    cn = x.children[0].to_s
+                    ref = pins.select{|p| p.namespace == (fqn || '') and p.name == cn}.first
+                    unless ref.nil?
+                      pins.delete ref
+                      mm = Solargraph::Pin::Method.new(ref.location, ref.namespace, ref.name, ref.docstring, :class, :public, ref.parameters)
+                      cm = Solargraph::Pin::Method.new(ref.location, ref.namespace, ref.name, ref.docstring, :instance, :private, ref.parameters)
+                      pins.push mm, cm
+                      pins.select{|pin| pin.kind == Pin::INSTANCE_VARIABLE and pin.context == ref}.each do |ivar|
+                        pins.delete ivar
+                        pins.push Solargraph::Pin::InstanceVariable.new(ivar.location, ivar.namespace, ivar.name, ivar.docstring, ivar.signature, ivar.instance_variable_get(:@literal), mm)
+                        pins.push Solargraph::Pin::InstanceVariable.new(ivar.location, ivar.namespace, ivar.name, ivar.docstring, ivar.signature, ivar.instance_variable_get(:@literal), cm)
+                      end
+                    end
+                  end
+                elsif c.children[2].type == :def
+                  # @todo A single function
+                  process c, tree, :module_function, :class, fqn, stack
+                  next
+                end
               elsif c.type == :send and c.children[1] == :include and c.children[0].nil?
                 last_node = get_last_in_stack_not_begin(stack)
                 if last_node.nil? or last_node.type == :class or last_node.type == :module or last_node.type == :source
@@ -207,24 +251,26 @@ module Solargraph
               elsif c.type == :send and c.children[1] == :extend and c.children[0].nil?
                 last_node = get_last_in_stack_not_begin(stack)
                 if last_node.nil? or last_node.type == :class or last_node.type == :module or last_node.type == :source
-                  if c.children[2].kind_of?(AST::Node) and c.children[2].type == :const
-                    # namespace_extends[fqn || ''] ||= []
-                    c.children[2..-1].each do |i|
-                      nspin = @pins.select{|pin| pin.kind == Pin::NAMESPACE and pin.path == fqn}.last
-                      unless nspin.nil?
+                  c.children[2..-1].each do |i|
+                    nspin = @pins.select{|pin| pin.kind == Pin::NAMESPACE and pin.path == fqn}.last
+                    unless nspin.nil?
+                      ref = nil
+                      if i.type == :self
+                        ref = Pin::Reference.new(get_node_location(c), nspin.path, nspin.path)
+                      elsif i.type == :const
                         ref = Pin::Reference.new(get_node_location(c), nspin.path, unpack_name(i))
-                        nspin.extend_references.push(ref)
                       end
+                      nspin.extend_references.push(ref) unless ref.nil?
                     end
                   end
                 end
               elsif c.type == :send and [:attr_reader, :attr_writer, :attr_accessor].include?(c.children[1])
                 c.children[2..-1].each do |a|
                   if c.children[1] == :attr_reader or c.children[1] == :attr_accessor
-                    pins.push Solargraph::Pin::Attribute.new(get_node_location(c), fqn || '', "#{a.children[0]}", docstring_for(c), :reader) #AttrPin.new(c)
+                    pins.push Solargraph::Pin::Attribute.new(get_node_location(c), fqn || '', "#{a.children[0]}", docstring_for(c), :reader, scope)
                   end
                   if c.children[1] == :attr_writer or c.children[1] == :attr_accessor
-                    pins.push Solargraph::Pin::Attribute.new(get_node_location(c), fqn || '', "#{a.children[0]}=", docstring_for(c), :writer) #AttrPin.new(c)
+                    pins.push Solargraph::Pin::Attribute.new(get_node_location(c), fqn || '', "#{a.children[0]}=", docstring_for(c), :writer, scope)
                   end
                 end
               elsif c.type == :sclass and c.children[0].type == :self
@@ -298,10 +344,6 @@ module Solargraph
         nil
       end
 
-      def get_node_start_position(node)
-        Position.new(node.loc.line - 1, node.loc.column)
-      end
-
       def get_node_location(node)
         if node.nil?
           st = Position.new(0, 0)
@@ -360,10 +402,10 @@ module Solargraph
               t = (d.tag.types.nil? || d.tag.types.empty?) ? nil : d.tag.types.flatten.join('')
               if t.nil? or t.include?('r')
                 # location, namespace, name, docstring, access
-                pins.push Solargraph::Pin::Attribute.new(get_node_location(k.node), namespace_for(k.node).path, d.tag.name, docstring, :reader)
+                pins.push Solargraph::Pin::Attribute.new(get_node_location(k.node), namespace_for(k.node).path, d.tag.name, docstring, :reader, :instance)
               end
               if t.nil? or t.include?('w')
-                pins.push Solargraph::Pin::Attribute.new(get_node_location(k.node), namespace_for(k.node).path, "#{d.tag.name}=", docstring, :reader)
+                pins.push Solargraph::Pin::Attribute.new(get_node_location(k.node), namespace_for(k.node).path, "#{d.tag.name}=", docstring, :writer, :instance)
               end
             elsif d.tag.tag_name == 'method'
               gen_src = Source.new("def #{d.tag.name};end", filename)

data/lib/solargraph/source/node_methods.rb

@@ -0,0 +1,111 @@
+module Solargraph
+  class Source
+    module NodeMethods
+      module_function
+
+      # @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)
+          node.children.each { |n|
+            if n.kind_of?(AST::Node)
+              if n.type == :cbase
+                parts = pack_name(n)
+              else
+                parts += pack_name(n)
+              end
+            else
+              parts.push n unless n.nil?
+            end
+          }
+        end
+        parts
+      end
+
+      # @return [String]
+      def const_from node
+        if node.kind_of?(AST::Node) and node.type == :const
+          result = ''
+          unless node.children[0].nil?
+            result = const_from(node.children[0])
+          end
+          if result == ''
+            result = node.children[1].to_s
+          else
+            result = result + '::' + node.children[1].to_s
+          end
+          result
+        else
+          nil
+        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
+          return 'String'
+        elsif node.type == :array
+          return 'Array'
+        elsif node.type == :hash
+          return 'Hash'
+        elsif node.type == :int
+          return 'Integer'
+        elsif node.type == :float
+          return 'Float'
+        elsif node.type == :sym
+          return 'Symbol'
+        # @todo Maybe ignore nils
+        # elsif node.type == :nil
+        #   return 'NilClass'
+        end
+        nil
+      end
+
+      # Get a call signature from a node.
+      # The result should be a string in the form of a method path, e.g.,
+      # String.new or variable.method.
+      #
+      # @return [String]
+      def resolve_node_signature node
+        result = drill_signature node, ''
+        return nil if result.empty?
+        result
+      end
+
+      def get_node_start_position(node)
+        Position.new(node.loc.line - 1, node.loc.column)
+      end
+
+      def get_node_end_position(node)
+        Position.new(node.loc.last_line - 1, node.loc.last_column)
+      end
+
+      def drill_signature node, signature
+        return signature unless node.kind_of?(AST::Node)
+        if node.type == :const or node.type == :cbase
+          unless node.children[0].nil?
+            signature += drill_signature(node.children[0], signature)
+          end
+          signature += '::' unless signature.empty?
+          signature += node.children[1].to_s
+        elsif node.type == :lvar or node.type == :ivar or node.type == :cvar
+          signature += '.' unless signature.empty?
+          signature += node.children[0].to_s
+        elsif node.type == :send
+          unless node.children[0].nil?
+            signature += drill_signature(node.children[0], signature)
+          end
+          signature += '.' unless signature.empty?
+          signature += node.children[1].to_s
+        end
+        signature
+      end
+    end
+  end
+end