cosmicgraph 0.49.0

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Solargraph::LanguageServer::Message::Workspace
+  class DidChangeWatchedFiles < Solargraph::LanguageServer::Message::Base
+    CREATED = 1
+    CHANGED = 2
+    DELETED = 3
+
+    include Solargraph::LanguageServer::UriHelpers
+
+    def process
+      need_catalog = false
+      to_create = []
+      to_delete = []
+
+      # @param change [Hash]
+      params['changes'].each do |change|
+        if change['type'] == CREATED
+          to_create << change['uri']
+          need_catalog = true
+        elsif change['type'] == CHANGED
+          next if host.open?(change['uri'])
+          to_create << change['uri']
+          need_catalog = true
+        elsif change['type'] == DELETED
+          to_delete << change['uri']
+          need_catalog = true
+        else
+          set_error Solargraph::LanguageServer::ErrorCodes::INVALID_PARAMS, "Unknown change type ##{change['type']} for #{uri_to_file(change['uri'])}"
+        end
+      end
+
+      host.create *to_create
+      host.delete *to_delete
+
+      # Force host to catalog libraries after file changes (see castwide/solargraph#139)
+      host.catalog if need_catalog
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Solargraph::LanguageServer::Message::Workspace
+  class DidChangeWorkspaceFolders < Solargraph::LanguageServer::Message::Base
+    def process
+      add_folders
+      remove_folders
+    end
+
+    private
+
+    def add_folders
+      return unless params['event'] && params['event']['added']
+      host.prepare_folders params['event']['added']
+    end
+
+    def remove_folders
+      return unless params['event'] && params['event']['removed']
+      params['event']['removed'].each do |folder|
+        host.remove_folders params['event']['removed']
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+class Solargraph::LanguageServer::Message::Workspace::WorkspaceSymbol < Solargraph::LanguageServer::Message::Base
+  include Solargraph::LanguageServer::UriHelpers
+
+  def process
+    pins = host.query_symbols(params['query'])
+    info = pins.map do |pin|
+      uri = file_to_uri(pin.location.filename)
+      {
+        name: pin.path,
+        containerName: pin.namespace,
+        kind: pin.symbol_kind,
+        location: {
+          uri: uri,
+          range: pin.location.range.to_hash
+        },
+        deprecated: pin.deprecated?
+      }
+    end
+    set_result info
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+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'
+        autoload :DidChangeWorkspaceFolders, 'solargraph/language_server/message/workspace/did_change_workspace_folders'
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'solargraph'
+
+module Solargraph
+  module LanguageServer
+    # The Message namespace contains classes that implement language server
+    # protocol methods.
+    #
+    module Message
+      autoload :Base,                 'solargraph/language_server/message/base'
+      autoload :Initialize,           'solargraph/language_server/message/initialize'
+      autoload :Initialized,          'solargraph/language_server/message/initialized'
+      autoload :TextDocument,         'solargraph/language_server/message/text_document'
+      autoload :CompletionItem,       'solargraph/language_server/message/completion_item'
+      autoload :CancelRequest,        'solargraph/language_server/message/cancel_request'
+      autoload :MethodNotFound,       'solargraph/language_server/message/method_not_found'
+      autoload :MethodNotImplemented, 'solargraph/language_server/message/method_not_implemented'
+      autoload :Extended,             'solargraph/language_server/message/extended'
+      autoload :Shutdown,             'solargraph/language_server/message/shutdown'
+      autoload :ExitNotification,     'solargraph/language_server/message/exit_notification'
+      autoload :Workspace,            'solargraph/language_server/message/workspace'
+
+      class << self
+        # Register a method name and message for handling by the language
+        # server.
+        #
+        # @example
+        #   Message.register 'initialize', Solargraph::Message::Initialize
+        #
+        # @param path [String] The method name
+        # @param message_class [Class<Message::Base>] The message class
+        # @return [void]
+        def register path, message_class
+          method_map[path] = message_class
+        end
+
+        # @param path [String]
+        # @return [Class<Solargraph::LanguageServer::Message::Base>]
+        def select path
+          if method_map.has_key?(path)
+            method_map[path]
+          elsif path.start_with?('$/')
+            MethodNotImplemented
+          else
+            MethodNotFound
+          end
+        end
+
+        private
+
+        # @return [Hash{String => Class<Message::Base>}]
+        def method_map
+          @method_map ||= {}
+        end
+      end
+
+      register 'initialize',                          Initialize
+      register 'initialized',                         Initialized
+      register 'textDocument/completion',             TextDocument::Completion
+      register 'completionItem/resolve',              CompletionItem::Resolve
+      register 'textDocument/signatureHelp',          TextDocument::SignatureHelp
+      register 'textDocument/didOpen',                TextDocument::DidOpen
+      register 'textDocument/didChange',              TextDocument::DidChange
+      register 'textDocument/didSave',                TextDocument::DidSave
+      register 'textDocument/didClose',               TextDocument::DidClose
+      register 'textDocument/hover',                  TextDocument::Hover
+      register 'textDocument/definition',             TextDocument::Definition
+      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 'textDocument/prepareRename',          TextDocument::PrepareRename
+      register 'textDocument/foldingRange',           TextDocument::FoldingRange
+      # register 'textDocument/codeAction',             TextDocument::CodeAction
+      register 'textDocument/documentHighlight',      TextDocument::DocumentHighlight
+      register 'workspace/didChangeWatchedFiles',     Workspace::DidChangeWatchedFiles
+      register 'workspace/didChangeConfiguration',    Workspace::DidChangeConfiguration
+      register 'workspace/didChangeWorkspaceFolders', Workspace::DidChangeWorkspaceFolders
+      register 'workspace/symbol',                    Workspace::WorkspaceSymbol
+      register '$/cancelRequest',                     CancelRequest
+      register '$/solargraph/document',               Extended::Document
+      register '$/solargraph/search',                 Extended::Search
+      register '$/solargraph/checkGemVersion',        Extended::CheckGemVersion
+      register '$/solargraph/documentGems',           Extended::DocumentGems
+      register '$/solargraph/downloadCore',           Extended::DownloadCore
+      register '$/solargraph/environment',            Extended::Environment
+      register 'shutdown',                            Shutdown
+      register 'exit',                                ExitNotification
+    end
+  end
+end

data/lib/solargraph/language_server/message_types.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    # The MessageType constants from the language server specification.
+    #
+    module MessageTypes
+      ERROR = 1
+      WARNING = 2
+      INFO = 3
+      LOG = 4
+    end
+  end
+end

data/lib/solargraph/language_server/request.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    class Request
+      # @param id [Integer]
+      # @param &block The block that processes the client's response
+      def initialize id, &block
+        @id = id
+        @block = block
+      end
+
+      # @param result [Object]
+      # @return [void]
+      def process result
+        @block.call(result) unless @block.nil?
+      end
+
+      def send_response
+        # noop
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/symbol_kinds.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    # The SymbolKind constants for the language server protocol.
+    #
+    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/adapter.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'backport'
+
+module Solargraph
+  module LanguageServer
+    module Transport
+      # A common module for running language servers in Backport.
+      #
+      module Adapter
+        def opening
+          @host = Solargraph::LanguageServer::Host.new
+          @host.add_observer self
+          @host.start
+          @data_reader = Solargraph::LanguageServer::Transport::DataReader.new
+          @data_reader.set_message_handler do |message|
+            process message
+          end
+        end
+
+        def closing
+          @host.stop
+        end
+
+        # @param data [String]
+        def receiving data
+          @data_reader.receive data
+        end
+
+        def update
+          if @host.stopped?
+            shutdown
+          else
+            tmp = @host.flush
+            write tmp unless tmp.empty?
+          end
+        end
+
+        private
+
+        # @param request [String]
+        # @return [void]
+        def process request
+          @host.process(request)
+        end
+
+        def shutdown
+          Backport.stop unless @host.options['transport'] == 'external'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Solargraph
+  module LanguageServer
+    module Transport
+      class DataReader
+        def initialize
+          @in_header = true
+          @content_length = 0
+          @buffer = String.new
+        end
+
+        # Declare a block to be executed for each message received from the
+        # client.
+        #
+        # @yieldparam [Hash] The message received from the client
+        def set_message_handler &block
+          @message_handler = block
+        end
+
+        # Process raw data received from the client. The data will be parsed
+        # into messages based on the JSON-RPC protocol. Each message will be
+        # passed to the block declared via set_message_handler. Incomplete data
+        # will be buffered and subsequent data will be appended to the buffer.
+        #
+        # @param data [String]
+        def receive data
+          data.each_char do |char|
+            @buffer.concat char
+            if @in_header
+              prepare_to_parse_message if @buffer.end_with?("\r\n\r\n")
+            else
+              parse_message_from_buffer if @buffer.bytesize == @content_length
+            end
+          end
+        end
+
+        private
+
+        # @return [void]
+        def prepare_to_parse_message
+          @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
+
+        # @return [void]
+        def parse_message_from_buffer
+          begin
+            msg = JSON.parse(@buffer)
+            @message_handler.call msg unless @message_handler.nil?
+          rescue JSON::ParserError => e
+            Solargraph::Logging.logger.warn "Failed to parse request: #{e.message}"
+            Solargraph::Logging.logger.debug "Buffer: #{@buffer}"
+          ensure
+            @buffer.clear
+            @in_header = true
+            @content_length = 0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/transport.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    # The Transport namespace contains concrete implementations of
+    # communication protocols for language servers.
+    #
+    module Transport
+      autoload :Adapter,    'solargraph/language_server/transport/adapter'
+      autoload :DataReader, 'solargraph/language_server/transport/data_reader'
+    end
+  end
+end

data/lib/solargraph/language_server/uri_helpers.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'cgi'
+
+module Solargraph
+  module LanguageServer
+    # Methods to handle conversions between file URIs and paths.
+    #
+    module UriHelpers
+      module_function
+
+      # Convert a file URI to a path.
+      #
+      # @param uri [String]
+      # @return [String]
+      def uri_to_file 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://#{encode(file.gsub(/^([a-z]\:)/i, '/\1'))}"
+      end
+
+      # Encode text to be used as a URI path component in LSP.
+      #
+      # @param text [String]
+      # @return [String]
+      def encode text
+        CGI.escape(text)
+           .gsub('%3A', ':')
+           .gsub('%5C', '\\')
+           .gsub('%2F', '/')
+           .gsub('+', '%20')
+      end
+
+      # Decode text from a URI path component in LSP.
+      #
+      # @param text [String]
+      # @return [String]
+      def decode text
+        CGI.unescape(text)
+      end
+    end
+  end
+end

data/lib/solargraph/language_server.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'solargraph/language_server/error_codes'
+require 'solargraph/language_server/completion_item_kinds'
+require 'solargraph/language_server/symbol_kinds'
+
+module Solargraph
+  # The LanguageServer namespace contains the classes and modules that compose
+  # concrete implementations of language servers.
+  #
+  module LanguageServer
+    autoload :Host,         'solargraph/language_server/host'
+    autoload :Message,      'solargraph/language_server/message'
+    autoload :UriHelpers,   'solargraph/language_server/uri_helpers'
+    autoload :MessageTypes, 'solargraph/language_server/message_types'
+    autoload :Request,      'solargraph/language_server/request'
+    autoload :Transport,    'solargraph/language_server/transport'
+  end
+end