solargraph 0.17.4 → 0.18.0

data/lib/solargraph/language_server/message/text_document/did_change.rb

@@ -0,0 +1,15 @@
+require 'thread'
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class DidChange < Base
+          def process
+            host.change params
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/text_document/did_close.rb

@@ -0,0 +1,12 @@
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class DidClose < Base
+          def process
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/text_document/did_open.rb

@@ -0,0 +1,13 @@
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class DidOpen < Base
+          def process
+            host.open params['textDocument']['uri'], params['textDocument']['text'], params['textDocument']['version']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/text_document/did_save.rb

@@ -0,0 +1,15 @@
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class DidSave < Base
+          def process
+            STDERR.puts "TODO: TextDocument saved"
+            # host.open params['textDocument']
+            # publish_diagnostics
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/text_document/document_symbol.rb

@@ -0,0 +1,31 @@
+class Solargraph::LanguageServer::Message::TextDocument::DocumentSymbol < Solargraph::LanguageServer::Message::Base
+  include Solargraph::LanguageServer::UriHelpers
+
+  def process
+    pins = host.library.file_symbols(uri_to_file(params['textDocument']['uri']))
+    info = pins.map do |pin|
+      parts = pin.location.split(':')
+      char = parts.pop.to_i
+      line = parts.pop.to_i
+      filename = parts.join(':')
+      {
+        name: pin.path,
+        kind: Solargraph::LanguageServer::SymbolKinds::NAMESPACE,
+        location: {
+          uri: file_to_uri(filename),
+          range: {
+            start: {
+              line: line,
+              character: char
+            },
+            end: {
+              line: line,
+              character: char
+            }
+          }
+        }
+      }
+    end
+    set_result info
+  end
+end

data/lib/solargraph/language_server/message/text_document/formatting.rb

@@ -0,0 +1,36 @@
+require 'open3'
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class Formatting < Base
+          def process
+            filename = uri_to_file(params['textDocument']['uri'])
+            original = host.read_text(params['textDocument']['uri'])
+            cmd = "rubocop -a -f fi -s #{Shellwords.escape(filename)}"
+            o, e, s = Open3.capture3(cmd, stdin_data: original)
+            formatted = o.lines[2..-1].join
+            set_result(
+              [
+                {
+                  range: {
+                    start: {
+                      line: 0,
+                      character: 0
+                    },
+                    end: {
+                      line: original.lines.length,
+                      character: 0
+                    }
+                  },
+                  newText: formatted
+                }
+              ]
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/text_document/hover.rb

@@ -0,0 +1,19 @@
+require 'uri'
+
+module Solargraph::LanguageServer::Message::TextDocument
+  class Hover < Base
+    def process
+      filename = uri_to_file(params['textDocument']['uri'])
+      line = params['position']['line']
+      col = params['position']['character']
+      suggestions = host.library.definitions_at(filename, line, col)
+      contents = suggestions.map(&:hover)
+      set_result(
+        contents: {
+          kind: 'markdown',
+          value: contents.join("\n\n")
+        }
+      )
+    end
+  end
+end

data/lib/solargraph/language_server/message/text_document/on_type_formatting.rb

@@ -0,0 +1,29 @@
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class OnTypeFormatting < Base
+          def process
+            src = host.library.checkout(uri_to_file(params['textDocument']['uri']))
+            offset = src.get_offset(params['position']['line'], params['position']['character'])
+            if src.string_at?(offset-1) and params['ch'] == '{' and src.code[offset-2,2] == '#{'
+              set_result(
+                [
+                  {
+                    range: {
+                      start: params['position'],
+                      end: params['position']
+                    },
+                    newText: '}'
+                  }
+                ]
+              )
+            else
+              set_result []
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/text_document/signature_help.rb

@@ -0,0 +1,23 @@
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class SignatureHelp < TextDocument::Base
+          def process
+            filename = uri_to_file(params['textDocument']['uri'])
+            line = params['position']['line']
+            col = params['position']['character']
+            suggestions = host.library.signatures_at(filename, line, col)
+            info = []
+            suggestions.each do |s|
+              info.push s.signature_help
+            end
+            set_result({
+              signatures: info
+            })
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+module Solargraph
+  module LanguageServer
+    module Message
+      module Workspace
+        autoload :DidChangeWatchedFiles, 'solargraph/language_server/message/workspace/did_change_watched_files'
+        autoload :WorkspaceSymbol,       'solargraph/language_server/message/workspace/workspace_symbol'
+        autoload :DidChangeConfiguration, 'solargraph/language_server/message/workspace/did_change_configuration'
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/workspace/did_change_configuration.rb

@@ -0,0 +1,9 @@
+require 'uri'
+
+module Solargraph::LanguageServer::Message::Workspace
+  class DidChangeConfiguration < Solargraph::LanguageServer::Message::Base
+    def process
+      host.configure params['settings']['solargraph']
+    end
+  end
+end

data/lib/solargraph/language_server/message/workspace/did_change_watched_files.rb

@@ -0,0 +1,30 @@
+require 'uri'
+
+module Solargraph::LanguageServer::Message::Workspace
+  class DidChangeWatchedFiles < Solargraph::LanguageServer::Message::Base
+    CREATED = 1
+    CHANGED = 2
+    DELETED = 3
+
+    include Solargraph::LanguageServer::UriHelpers
+
+    def process
+      params['changes'].each do |change|
+        if change['type'] == CREATED
+          STDERR.puts "TODO: Need to handle a created file?"
+          # host.create change['uri']
+        elsif change['type'] == CHANGED
+          # @todo Should this check if the source is already loaded in the source?
+          # Possibly out of sync with the disk?
+          # host.workspace.handle_changed filename
+          # host.api_map.refresh
+          STDERR.puts "TODO: Workspace changed"
+        elsif change['type'] == DELETED
+          host.delete change['uri']
+        else
+          # @todo Handle error
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/workspace/workspace_symbol.rb

@@ -0,0 +1,31 @@
+class Solargraph::LanguageServer::Message::Workspace::WorkspaceSymbol < Solargraph::LanguageServer::Message::Base
+  include Solargraph::LanguageServer::UriHelpers
+
+  def process
+    pins = host.library.query_symbols(params['query'])
+    info = pins.map do |pin|
+      parts = pin.location.split(':')
+      char = parts.pop.to_i
+      line = parts.pop.to_i
+      filename = parts.join(':')
+      {
+        name: pin.path,
+        kind: Solargraph::LanguageServer::SymbolKinds::NAMESPACE,
+        location: {
+          uri: file_to_uri(filename),
+          range: {
+            start: {
+              line: line,
+              character: char
+            },
+            end: {
+              line: line,
+              character: char
+            }
+          }
+        }
+      }
+    end
+    set_result info
+  end
+end

data/lib/solargraph/language_server/symbol_kinds.rb

@@ -0,0 +1,32 @@
+module Solargraph
+  module LanguageServer
+    module SymbolKinds
+      FILE = 1;
+      MODULE = 2;
+      NAMESPACE = 3;
+      PACKAGE = 4;
+      CLASS = 5;
+      METHOD = 6;
+      PROPERTY = 7;
+      FIELD = 8;
+      CONSTRUCTOR = 9;
+      ENUM = 10;
+      INTERFACE = 11;
+      FUNCTION = 12;
+      VARIABLE = 13;
+      CONSTANT = 14;
+      STRING = 15;
+      NUMBER = 16;
+      BOOLEAN = 17;
+      ARRAY = 18;
+      OBJECT = 19;
+      KEY = 20;
+      NULL = 21;
+      ENUM_MEMBER = 22;
+      STRUCT = 23;
+      EVENT = 24;
+      OPERATOR = 25;
+      TYPE_PARAMETER = 26;
+    end
+  end
+end

data/lib/solargraph/language_server/transport.rb

@@ -0,0 +1,7 @@
+module Solargraph
+  module LanguageServer
+    module Transport
+      autoload :Socket, 'solargraph/language_server/transport/socket'
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+require 'thread'
+
+module Solargraph
+  module LanguageServer
+    module Transport
+      # A module for running language servers in EventMachine.
+      #
+      module Socket
+        def post_init
+          @in_header = true
+          @content_length = 0
+          @buffer = ''
+          @host = Solargraph::LanguageServer::Host.new
+          EventMachine.add_periodic_timer 0.1 do
+            tmp = @host.flush
+            send_data tmp unless tmp.empty?
+            EventMachine.stop if @host.stopped?
+          end
+        end
+      
+        def process request
+          Thread.new do
+            message = @host.start(request)
+            message.send
+            tmp = @host.flush
+            send_data tmp unless tmp.empty?
+          end
+        end
+      
+        # @param data [String]
+        def receive_data data
+          data.each_char do |char|
+            @buffer.concat char
+            if @in_header
+              if @buffer.end_with?("\r\n\r\n")
+                @in_header = false
+                @buffer.each_line do |line|
+                  parts = line.split(':').map(&:strip)
+                  if parts[0] == 'Content-Length'
+                    @content_length = parts[1].to_i
+                    break
+                  end
+                end
+                @buffer.clear
+              end
+            else
+              if @buffer.bytesize == @content_length
+                begin
+                  process JSON.parse(@buffer)
+                rescue Exception => e
+                  STDERR.puts "Failed to parse request: #{e.message}"
+                  STDERR.puts e.backtrace.inspect
+                  STDERR.puts "Buffer: #{@buffer}"
+                ensure
+                  @buffer.clear
+                  @in_header = true
+                  @content_length = 0
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/uri_helpers.rb

@@ -0,0 +1,21 @@
+module Solargraph
+  module LanguageServer
+    module UriHelpers
+      # Convert a file URI to a path.
+      #
+      # @param uri [String]
+      # @return [String]
+      def uri_to_file uri
+        URI.decode(uri).sub(/^file\:\/\//, '').sub(/^\/([a-z]\:)/i, '\1')
+      end
+
+      # Convert a file path to a URI.
+      #
+      # @param file [String]
+      # @return [String]
+      def file_to_uri file
+        "file://#{URI.encode(file.gsub(/^([a-z]\:)/i, '/\1'))}"
+      end
+    end
+  end
+end

data/lib/solargraph/library.rb

@@ -0,0 +1,225 @@
+module Solargraph
+  # A library handles coordination between a Workspace and an ApiMap.
+  #
+  class Library
+    class FileNotFoundError < Exception; end
+
+    # @param workspace [Solargraph::Workspace]
+    def initialize workspace = Solargraph::Workspace.new(nil)
+      @workspace = workspace
+      api_map
+    end
+
+    # Open a file in the library. Opening a file will make it available for
+    # checkout and merge it into the workspace if applicable.
+    #
+    # @param filename [String]
+    # @param text [String]
+    # @param version [Integer]
+    def open filename, text, version
+      source = Solargraph::Source.load_string(text, filename)
+      source.version = version
+      source_hash[filename] = source
+      workspace.merge source
+      api_map.refresh
+    end
+
+    # Create a file source to be added to the workspace. The source is ignored
+    # if the workspace is not configured to include the file.
+    #
+    # @param filename [String]
+    # @param text [String] The contents of the file
+    # @return [Boolean] True if the file was added to the workspace.
+    def create filename, text
+      result = false
+      if workspace.would_merge?(filename)
+        source = Solargraph::Source.load_string(text, filename)
+        if workspace.merge(source)
+          source_hash[filename] = source
+          api_map.refresh
+          result = true
+        end
+      end
+      result
+    end
+
+    # Delete a file from the library. Deleting a file will make it unavailable
+    # for checkout and optionally remove it from the workspace unless the
+    # workspace configuration determines that it should still exist.
+    #
+    # @param filename [String]
+    def delete filename
+      source = source_hash[filename]
+      return if source.nil?
+      source_hash.delete filename
+      workspace.remove source
+      api_map.refresh
+    end
+
+    # Close a file in the library. Closing a file will make it unavailable for
+    # checkout although it may still exist in the workspace.
+    #
+    # @param filename [String]
+    def close filename
+      source_hash.delete filename
+    end
+
+    # Get completion suggestions at the specified file and location.
+    #
+    # @param filename [String] The file to analyze
+    # @param line [Integer] The zero-based line number
+    # @param column [Integer] The zero-based column number
+    # @return [ApiMap::Completion]
+    def completions_at filename, line, column
+      # @type [Solargraph::Source]
+      source = nil
+      source = read(filename)
+      fragment = Solargraph::Source::Fragment.new(source, source.get_offset(line, column))
+      api_map.complete(fragment)
+    end
+
+    # Get definition suggestions for the expression at the specified file and
+    # location.
+    #
+    # @param filename [String] The file to analyze
+    # @param line [Integer] The zero-based line number
+    # @param column [Integer] The zero-based column number
+    # @return [Array<Solargraph::Pin::Base>]
+    def definitions_at filename, line, column
+      source = read(filename)
+      fragment = Solargraph::Source::Fragment.new(source, source.get_offset(line, column))
+      result = api_map.define(fragment)
+      result
+    end
+
+    # Get signature suggestions for the method at the specified file and
+    # location.
+    #
+    # @param filename [String] The file to analyze
+    # @param line [Integer] The zero-based line number
+    # @param column [Integer] The zero-based column number
+    # @return [Array<Solargraph::Pin::Base>]
+    def signatures_at filename, line, column
+      source = read(filename)
+      fragment = Solargraph::Source::Fragment.new(source, signature_index_before(source, source.get_offset(line, column)))
+      api_map.define(fragment).select{|pin| pin.method?}
+    end
+
+    # Get the pin at the specified location or nil if the pin does not exist.
+    #
+    # @return [Solargraph::Pin::Base]
+    def locate_pin location
+      api_map.locate_pin location
+    end
+
+    # Get an array of pins that match a path.
+    #
+    # @param path [String]
+    # @return [Array<Solargraph::Pin::Base>]
+    def get_path_pins path
+      api_map.get_path_suggestions(path)
+    end
+
+    # Check a file out of the library. If the file is not part of the
+    # workspace, the ApiMap will virtualize it for mapping purposes. If
+    # filename is nil, any source currently checked out of the library
+    # will be removed from the ApiMap. Only one file can be checked out
+    # (virtualized) at a time.
+    #
+    # @raise [FileNotFoundError] if the file is not in the library.
+    #
+    # @param filename [String]
+    # @return [Source]
+    def checkout filename
+      if filename.nil?
+        api_map.virtualize nil
+        nil
+      else
+        read filename
+      end
+    end
+
+    def refresh force = false
+      api_map.refresh force
+    end
+
+    def document query
+      api_map.document query
+    end
+
+    def search query
+      api_map.search query
+    end
+
+    def query_symbols query
+      api_map.query_symbols query
+    end
+
+    def file_symbols filename
+      read(filename).all_symbols
+    end
+
+    def path_pins path
+      api_map.get_path_suggestions(path)
+    end
+
+    # Get the current text of a file in the library.
+    #
+    # @param filename [String]
+    # @return [String]
+    def read_text filename
+      source = read(filename)
+      source.code
+    end
+
+    # Create a library from a directory.
+    #
+    # @param directory [String] The path to be used for the workspace
+    # @return [Solargraph::Library]
+    def self.load directory
+      Solargraph::Library.new(Solargraph::Workspace.new(directory))
+    end
+
+    private
+
+    # @return [Hash<String, Solargraph::Source>]
+    def source_hash
+      @source_hash ||= {}
+    end
+
+    # @return [Solargraph::ApiMap]
+    def api_map
+      @api_map ||= Solargraph::ApiMap.new(workspace)
+    end
+    
+    # @return [Solargraph::Workspace]
+    def workspace
+      @workspace
+    end
+
+    # @return [Solargraph::Source]
+    def read filename
+      source = source_hash[filename]
+      raise FileNotFoundError, "Source not found for #{filename}" if source.nil?
+      api_map.virtualize source
+      source
+    end
+
+    def signature_index_before source, index
+      open_parens = 0
+      cursor = index - 1
+      while cursor >= 0
+        break if cursor < 0
+        if source.code[cursor] == ')'
+          open_parens -= 1
+        elsif source.code[cursor] == '('
+          open_parens += 1
+        end
+        break if open_parens == 1
+        cursor -= 1
+      end
+      cursor = 0 if cursor < 0
+      cursor
+    end
+  end
+end