cosmicgraph 0.49.0

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      class Base
+        # @return [Solargraph::LanguageServer::Host]
+        attr_reader :host
+
+        # @return [Integer]
+        attr_reader :id
+
+        # @return [Hash]
+        attr_reader :request
+
+        # @return [String]
+        attr_reader :method
+
+        # @return [Hash]
+        attr_reader :params
+
+        # @return [Hash, Array, nil]
+        attr_reader :result
+
+        # @return [Hash, nil]
+        attr_reader :error
+
+        # @param host [Solargraph::LanguageServer::Host]
+        # @param request [Hash]
+        def initialize host, request
+          @host = host
+          @id = request['id'].freeze
+          @request = request.freeze
+          @method = request['method'].freeze
+          @params = (request['params'] || {}).freeze
+          post_initialize
+        end
+
+        # @return [void]
+        def post_initialize; end
+
+        # @return [void]
+        def process; end
+
+        # @param data [Hash, Array, nil]
+        # @return [void]
+        def set_result data
+          @result = data
+        end
+
+        # @param code [Integer] See Solargraph::LanguageServer::ErrorCodes
+        # @param message [String]
+        # @return [void]
+        def set_error code, message
+          @error = {
+            code: code,
+            message: message
+          }
+        end
+
+        # @return [void]
+        def send_response
+          return if id.nil?
+          if host.cancel?(id)
+            # https://microsoft.github.io/language-server-protocol/specifications/specification-current/#cancelRequest
+            # cancel should send response RequestCancelled
+            Solargraph::Logging.logger.info "Cancelled response to #{method}"
+            set_result nil
+            set_error ErrorCodes::REQUEST_CANCELLED, "cancelled by client"
+          else
+            Solargraph::Logging.logger.info "Sending response to #{method}"
+          end
+          response = {
+            jsonrpc: "2.0",
+            id: id,
+          }
+          response[:result] = result unless result.nil?
+          response[:error] = error unless error.nil?
+          response[:result] = nil if result.nil? and error.nil?
+          json = response.to_json
+          envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
+          Solargraph.logger.debug envelope
+          host.queue envelope
+          host.clear id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      class CancelRequest < Base
+        def process
+          host.cancel params['id']
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/client/register_capability.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module Client
+        class RegisterCapability < Solargraph::LanguageServer::Message::Base
+          def process
+            
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module Client
+        autoload :RegisterCapability, 'solargraph/language_server/message/client/register_capability'
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/completion_item/resolve.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module CompletionItem
+        # completionItem/resolve message handler
+        #
+        class Resolve < Base
+          def process
+            pins = host.locate_pins(params)
+            set_result merge(pins)
+          end
+
+          private
+
+          # @param pins [Array<Pin::Base>]
+          # @return [Hash]
+          def merge pins
+            return params if pins.empty?
+            docs = pins
+                   .reject { |pin| pin.documentation.empty? && pin.return_type.undefined? }
+            result = params
+              .transform_keys(&:to_sym)
+              .merge(pins.first.resolve_completion_item)
+              .merge(documentation: markup_content(join_docs(docs)))
+            result[:detail] = pins.first.detail
+            result
+          end
+
+          # @param text [String]
+          # @return [Hash{Symbol => String}]
+          def markup_content text
+            return nil if text.strip.empty?
+            {
+              kind: 'markdown',
+              value: text
+            }
+          end
+
+          def join_docs pins
+            result = []
+            last_link = nil
+            pins.each_with_index do |pin|
+              this_link = host.options['enablePages'] ? pin.link_documentation : pin.text_documentation
+              if this_link && this_link != last_link && this_link != 'undefined'
+                result.push this_link
+              end
+              result.push pin.documentation unless result.last && result.last.end_with?(pin.documentation)
+              last_link = this_link
+            end
+            result.join("\n\n")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module CompletionItem
+        autoload :Resolve, 'solargraph/language_server/message/completion_item/resolve'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      class ExitNotification < Base
+        def process
+          host.stop
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/extended/check_gem_version.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module Extended
+        # Check if a more recent version of the Solargraph gem is available.
+        # Notify the client when an update exists. If the `verbose` parameter
+        # is true, notify the client when the gem is up to date.
+        #
+        class CheckGemVersion < Base
+          def self.fetcher
+            @fetcher ||= Gem::SpecFetcher.new
+          end
+
+          def self.fetcher= obj
+            @fetcher = obj
+          end
+
+          GEM_ZERO = Gem::Version.new('0.0.0')
+
+          def initialize host, request, current: Gem::Version.new(Solargraph::VERSION), available: nil
+            super(host, request)
+            @current = current
+            @available = available
+          end
+
+          def process
+            if available > GEM_ZERO
+              if available > current
+                host.show_message_request "Solargraph gem version #{available} is available. (Current version: #{current})",
+                                          LanguageServer::MessageTypes::INFO,
+                                          ['Update now'] do |result|
+                                            next unless result == 'Update now'
+                                            cmd = if host.options['useBundler']
+                                              'bundle update solargraph'
+                                            else
+                                              'gem update solargraph'
+                                            end
+                                            o, s = Open3.capture2(cmd)
+                                            if s == 0
+                                              host.show_message 'Successfully updated the Solargraph gem.', LanguageServer::MessageTypes::INFO
+                                              host.send_notification '$/solargraph/restart', {}
+                                            else
+                                              host.show_message 'An error occurred while updating the gem.', LanguageServer::MessageTypes::ERROR
+                                            end
+                                          end
+              elsif params['verbose']
+                host.show_message "The Solargraph gem is up to date (version #{Solargraph::VERSION})."
+              end
+            elsif fetched?
+              Solargraph::Logging.logger.warn error
+              host.show_message(error, MessageTypes::ERROR) if params['verbose']
+            end
+            set_result({
+              installed: current,
+              available: available
+            })
+          end
+
+          private
+
+          # @return [Gem::Version]
+          attr_reader :current
+
+          # @return [Gem::Version]
+          def available
+            if !@available && !@fetched
+              @fetched = true
+              begin
+                @available ||= begin
+                  tuple = CheckGemVersion.fetcher.search_for_dependency(Gem::Dependency.new('solargraph')).flatten.first
+                  if tuple.nil?
+                    @error = 'An error occurred fetching the gem data'
+                    GEM_ZERO
+                  else
+                    tuple.version
+                  end
+                end
+              rescue Errno::EADDRNOTAVAIL => e
+                @error = "Unable to connect to gem source: #{e.message}"
+                GEM_ZERO
+              end
+            end
+            @available
+          end
+
+          def fetched?
+            @fetched ||= false
+          end
+
+          # @return [String, nil]
+          attr_reader :error
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/extended/document.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module Extended
+        class Document < Base
+          def process
+            objects = host.document(params['query'])
+            page = Solargraph::Page.new(host.options['viewsPath'])
+            content = page.render('document', layout: true, locals: {objects: objects})
+            set_result(
+              content: content
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/extended/document_gems.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module Extended
+        # Update YARD documentation for installed gems. If the `rebuild`
+        # parameter is true, rebuild existing yardocs.
+        #
+        class DocumentGems < Base
+          def process
+            cmd = "yard gems"
+            cmd += " --rebuild" if params['rebuild']
+            o, s = Open3.capture2(cmd)
+            if s != 0
+              host.show_message "An error occurred while building gem documentation.", LanguageServer::MessageTypes::ERROR
+              set_result({
+                status: 'err'
+              })
+            else
+              set_result({
+                status: 'ok'
+              })
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/extended/download_core.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module Extended
+        # Update core Ruby documentation.
+        #
+        class DownloadCore < Base
+          def process
+            host.show_message "Downloading cores is deprecated. Solargraph currently uses RBS for core and stdlib documentation", LanguageServer::MessageTypes::INFO
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/extended/environment.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module Extended
+        # Update YARD documentation for installed gems. If the `rebuild`
+        # parameter is true, rebuild existing yardocs.
+        #
+        class Environment < Base
+          def process
+            # Make sure the environment page can report RuboCop's version
+            require 'rubocop'
+
+            page = Solargraph::Page.new(host.options['viewsPath'])
+            content = page.render('environment', layout: true, locals: { config: host.options, folders: host.folders })
+            set_result(
+              content: content
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/extended/search.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module Extended
+        class Search < Base
+          def process
+            results = host.search(params['query'])
+            page = Solargraph::Page.new(host.options['viewsPath'])
+            content = page.render('search', layout: true, locals: {query: params['query'], results: results})
+            set_result(
+              content: content
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      # Messages in the Extended module are custom to the Solargraph
+      # implementation of the language server. In the protocol, the method
+      # names should start with "$/" so clients that don't recognize them can
+      # ignore them, as per the LSP specification.
+      #
+      module Extended
+        autoload :Document,        'solargraph/language_server/message/extended/document'
+        autoload :Search,          'solargraph/language_server/message/extended/search'
+        autoload :CheckGemVersion, 'solargraph/language_server/message/extended/check_gem_version'
+        autoload :DocumentGems,    'solargraph/language_server/message/extended/document_gems'
+        autoload :DownloadCore,    'solargraph/language_server/message/extended/download_core'
+        autoload :Environment,     'solargraph/language_server/message/extended/environment'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      class Initialize < Base
+        def process
+          host.configure params['initializationOptions']
+          host.client_capabilities = params['capabilities']
+          if support_workspace_folders?
+            host.prepare_folders params['workspaceFolders']
+          elsif params['rootUri']
+            host.prepare UriHelpers.uri_to_file(params['rootUri'])
+          else
+            host.prepare params['rootPath']
+          end
+          result = {
+            capabilities: {
+              textDocumentSync: 2, # @todo What should this be?
+              workspace: {
+                workspaceFolders: {
+                  supported: true,
+                  changeNotifications: true
+                }
+              }
+            }
+          }
+          # FIXME: lsp default is utf-16, may have different position
+          result[:capabilities][:positionEncoding] = "utf-32" if params.dig("capabilities", "general", "positionEncodings")&.include?("utf-32")
+          result[:capabilities].merge! static_completion unless dynamic_registration_for?('textDocument', 'completion')
+          result[:capabilities].merge! static_signature_help unless dynamic_registration_for?('textDocument', 'signatureHelp')
+          # result[:capabilities].merge! static_on_type_formatting unless dynamic_registration_for?('textDocument', 'onTypeFormatting')
+          result[:capabilities].merge! static_hover unless dynamic_registration_for?('textDocument', 'hover')
+          result[:capabilities].merge! static_document_formatting unless dynamic_registration_for?('textDocument', 'formatting')
+          result[:capabilities].merge! static_document_symbols unless dynamic_registration_for?('textDocument', 'documentSymbol')
+          result[:capabilities].merge! static_definitions unless dynamic_registration_for?('textDocument', 'definition')
+          result[:capabilities].merge! static_rename unless dynamic_registration_for?('textDocument', 'rename')
+          result[:capabilities].merge! static_references unless dynamic_registration_for?('textDocument', 'references')
+          result[:capabilities].merge! static_workspace_symbols unless dynamic_registration_for?('workspace', 'symbol')
+          result[:capabilities].merge! static_folding_range unless dynamic_registration_for?('textDocument', 'foldingRange')
+          result[:capabilities].merge! static_highlights unless dynamic_registration_for?('textDocument', 'documentHighlight')
+          # @todo Temporarily disabled
+          # result[:capabilities].merge! static_code_action unless dynamic_registration_for?('textDocument', 'codeAction')
+          set_result result
+        end
+
+        private
+
+        def support_workspace_folders?
+          params['capabilities'] &&
+            params['capabilities']['workspace'] &&
+            params['capabilities']['workspace']['workspaceFolders'] &&
+            params['workspaceFolders']
+        end
+
+        def static_completion
+          return {} unless host.options['completion']
+          {
+            completionProvider: {
+              resolveProvider: true,
+              triggerCharacters: ['.', ':', '@']
+            }
+          }
+        end
+
+        def static_code_action
+          {
+            codeActionProvider: true,
+            codeActionKinds: ["quickfix"]
+          }
+        end
+
+        def static_signature_help
+          {
+            signatureHelpProvider: {
+              triggerCharacters: ['(', ',']
+            }
+          }
+        end
+
+        def static_on_type_formatting
+          {
+            documentOnTypeFormattingProvider: {
+              firstTriggerCharacter: '{',
+              moreTriggerCharacter: ['(']
+            }
+          }
+        end
+
+        def static_hover
+          return {} unless host.options['hover']
+          {
+            hoverProvider: true
+          }
+        end
+
+        def static_document_formatting
+          return {} unless host.options['formatting']
+          {
+            documentFormattingProvider: true
+          }
+        end
+
+        def static_document_symbols
+          return {} unless host.options['symbols']
+          {
+            documentSymbolProvider: true
+          }
+        end
+
+        def static_workspace_symbols
+          {
+            workspaceSymbolProvider: true
+          }
+        end
+
+        def static_definitions
+          return {} unless host.options['definitions']
+          {
+            definitionProvider: true
+          }
+        end
+
+        def static_rename
+          {
+            renameProvider: {prepareProvider: true}
+          }
+        end
+
+        def static_references
+          return {} unless host.options['references']
+          {
+            referencesProvider: true
+          }
+        end
+
+        def static_folding_range
+          return {} unless host.options['folding']
+          {
+            foldingRangeProvider: true
+          }
+        end
+
+        def static_highlights
+          {
+            documentHighlightProvider: true
+          }
+        end
+
+        # @param section [String]
+        # @param capability [String]
+        # @return [Boolean]
+        def dynamic_registration_for? section, capability
+          result = (params['capabilities'] &&
+            params['capabilities'][section] &&
+            params['capabilities'][section][capability] &&
+            params['capabilities'][section][capability]['dynamicRegistration'])
+          host.allow_registration("#{section}/#{capability}") if result
+          result
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      class Initialized < Base
+        def process
+          # @todo Temporarily removed textDocument/codeAction
+          host.register_capabilities %w[
+            textDocument/completion
+            textDocument/hover
+            textDocument/signatureHelp
+            textDocument/formatting
+            textDocument/documentSymbol
+            textDocument/definition
+            textDocument/references
+            textDocument/rename
+            textDocument/prepareRename
+            textDocument/foldingRange
+            textDocument/documentHighlight
+            workspace/symbol
+          ]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      class MethodNotFound < Base
+        def process
+          set_error(
+            Solargraph::LanguageServer::ErrorCodes::METHOD_NOT_FOUND,
+            "Method not found: #{request['method']}"
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      class MethodNotImplemented < Base
+        def process
+          # This method ignores optional requests, e.g., any method that
+          # starts with `$/`.
+        end
+      end
+    end
+  end
+end