solargraph 0.58.2 → 0.59.0.dev.2

data/lib/solargraph/language_server/message.rb

@@ -1,94 +1,94 @@
-# 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/typeDefinition',         TextDocument::TypeDefinition
-      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
+# 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.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/typeDefinition',         TextDocument::TypeDefinition
+      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/request.rb

@@ -1,27 +1,29 @@
-# 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]
-      # @generic T
-      # @yieldreturn [generic<T>]
-      # @return [generic<T>, nil]
-      def process result
-        @block.call(result) unless @block.nil?
-      end
-
-      # @return [void]
-      def send_response
-        # noop
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    class Request
+      # @param id [Integer]
+      # @param block [Proc] The block that processes the client's response
+      def initialize id, &block
+        @id = id
+        @block = block
+      end
+
+      # @sg-ignore Solargraph::LanguageServer::Request#process return
+      #   type could not be inferred
+      # @param result [Object]
+      # @generic T
+      # @yieldreturn [generic<T>]
+      # @return [generic<T>, nil]
+      def process result
+        @block&.call(result)
+      end
+
+      # @return [void]
+      def send_response
+        # noop
+      end
+    end
+  end
+end

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

@@ -1,74 +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
-        # @return [void]
-        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]
-        # @return [void]
-        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
+# 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
+        # @return [void]
+        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]
+        # @return [void]
+        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")
+            elsif @buffer.bytesize == @content_length
+              parse_message_from_buffer
+            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
+          msg = JSON.parse(@buffer)
+          @message_handler&.call msg
+        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

data/lib/solargraph/language_server/uri_helpers.rb

@@ -1,49 +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
+# 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(%r{^file:(?://)?}, '').sub(%r{^/([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