solargraph 0.17.4 → 0.18.0

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

@@ -0,0 +1,64 @@
+module Solargraph
+  module LanguageServer
+    module Message
+      class Base
+        # @return [Solargraph::LanguageServer::Host]
+        attr_reader :host
+        attr_reader :id
+        attr_reader :request
+        attr_reader :method
+        attr_reader :params
+        attr_reader :result
+        attr_reader :error
+
+        def initialize host, request
+          @host = host
+          @id = request['id'].freeze
+          @request = request.freeze
+          @method = request['method'].freeze
+          @params = request['params'].freeze
+          post_initialize
+        end
+
+        def post_initialize
+        end
+
+        def process
+        end
+
+        def set_result data
+          @result = data
+        end
+
+        def set_error code, message
+          @error = {
+            code: code,
+            message: message
+          }
+        end
+
+        def response
+          response = {}
+          response[:result] = result
+          response[:error] = error unless error.nil?
+          response
+        end
+
+        def send
+          unless id.nil? or host.cancel?(id)
+            response = {
+              jsonrpc: "2.0",
+              id: id,
+            }
+            response[:result] = result unless result.nil?
+            response[:error] = error unless error.nil?
+            json = response.to_json
+            envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
+            host.queue envelope
+          end
+          host.clear id
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+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.rb

@@ -0,0 +1,5 @@
+module Solargraph
+  module Client
+    autoload :RegisterCapability, 'solargraph/language_server/message/client/register_capability'
+  end
+end

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

@@ -0,0 +1,13 @@
+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/completion_item.rb

@@ -0,0 +1,9 @@
+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/completion_item/resolve.rb

@@ -0,0 +1,23 @@
+require 'reverse_markdown'
+require 'uri'
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module CompletionItem
+        class Resolve < Base
+          def process
+            pin = host.locate_pin params
+            if pin.nil?
+              set_error(Solargraph::LanguageServer::ErrorCodes::INVALID_REQUEST, "Completion item could not be resolved")
+            else
+              set_result(
+                params.merge(pin.resolve_completion_item)
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Solargraph
+  module LanguageServer
+    module Message
+      class ExitNotification < Base
+        def process
+          host.stop
+          exit
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+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'
+      end
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,39 @@
+module Solargraph
+  module LanguageServer
+    module Message
+      class Initialize < Base
+        def process
+          host.configure params['initializationOptions']
+          host.prepare params['rootPath']
+          set_result(
+            capabilities: {
+              textDocumentSync: 2, # @todo What should this be?
+              completionProvider: {
+                resolveProvider: true,
+                triggerCharacters: ['.', ':', '@']
+              },
+              hoverProvider: true,
+              definitionProvider: true,
+              signatureHelpProvider: {
+                triggerCharacters: ['(', ',']
+              },
+              documentFormattingProvider: true,
+              documentOnTypeFormattingProvider: {
+                firstTriggerCharacter: '{',
+                moreTriggerCharacter: ['(']
+              },
+              documentSymbolProvider: true,
+              workspaceSymbolProvider: true,
+              workspace: {
+                workspaceFolders: {
+                  supported: true,
+                  changeNotifications: true
+                }
+              }
+            }
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+module Solargraph
+  module LanguageServer
+    module Message
+      class Initialized < Base
+        def process
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,12 @@
+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

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

@@ -0,0 +1,11 @@
+module Solargraph
+  module LanguageServer
+    module Message
+      class Shutdown < Base
+        def process
+          set_result({})
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        autoload :Base, 'solargraph/language_server/message/text_document/base'
+        autoload :Completion, 'solargraph/language_server/message/text_document/completion'
+        autoload :DidOpen, 'solargraph/language_server/message/text_document/did_open'
+        autoload :DidChange, 'solargraph/language_server/message/text_document/did_change'
+        autoload :DidClose, 'solargraph/language_server/message/text_document/did_close'
+        autoload :DidSave, 'solargraph/language_server/message/text_document/did_save'
+        autoload :Hover, 'solargraph/language_server/message/text_document/hover'
+        autoload :SignatureHelp, 'solargraph/language_server/message/text_document/signature_help'
+        autoload :DiagnosticsQueue, 'solargraph/language_server/message/text_document/diagnostics_queue'
+        autoload :OnTypeFormatting, 'solargraph/language_server/message/text_document/on_type_formatting'
+        autoload :Definition, 'solargraph/language_server/message/text_document/definition'
+        autoload :DocumentSymbol, 'solargraph/language_server/message/text_document/document_symbol'
+        autoload :Formatting, 'solargraph/language_server/message/text_document/formatting'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class Base < Solargraph::LanguageServer::Message::Base
+          include Solargraph::LanguageServer::UriHelpers
+
+          attr_reader :filename
+
+          def post_initialize
+            @filename = uri_to_file(params['textDocument']['uri'])
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+require 'time'
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class Completion < Base
+          def process
+            begin
+              start = Time.now
+              processed = false
+              until processed
+                host.synchronize do
+                  if host.changing?(params['textDocument']['uri'])
+                    # STDERR.puts "Waiting..."
+                    if Time.now - start > 1
+                      set_result empty_result
+                      processed = true
+                    end
+                  else
+                    inner_process
+                    processed = true
+                  end
+                end
+                sleep 0.1 unless processed
+              end
+            rescue Exception => e
+              STDERR.puts e.message
+              STDERR.puts e.backtrace
+              set_error ErrorCodes::INTERNAL_ERROR, e.message
+            end
+          end
+
+          private
+
+          def inner_process
+            filename = uri_to_file(params['textDocument']['uri'])
+            line = params['position']['line']
+            col = params['position']['character']
+            completion = host.library.completions_at(filename, line, col)
+            items = []
+            idx = 0
+            completion.pins.each do |pin|
+              items.push pin.completion_item.merge({
+                textEdit: {
+                  range: completion.range.to_hash,
+                  newText: pin.name
+                },
+                sortText: "#{pin.name}#{idx.to_s.rjust(4, '0')}"
+              })
+              idx += 1
+            end
+            set_result(
+              isIncomplete: false,
+              items: items
+            )
+          end
+
+          def empty_result
+            {
+              isIncomplete: false,
+              items: []
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+require 'uri'
+
+module Solargraph::LanguageServer::Message::TextDocument
+  class Definition < Base
+    def process
+      # source = host.read(params['textDocument']['uri'])
+      # code_map = Solargraph::CodeMap.from_source(source, host.api_map)
+      # offset = code_map.get_offset(params['position']['line'], params['position']['character'])
+      # suggestions = code_map.define_symbol_at(offset)
+      filename = uri_to_file(params['textDocument']['uri'])
+      line = params['position']['line']
+      col = params['position']['character']
+      suggestions = host.library.definitions_at(filename, line, col)
+      locations = suggestions.map do |pin|
+        unless pin.location.nil?
+          parts = pin.location.split(':')
+          char = parts.pop.to_i
+          line = parts.pop.to_i
+          filename = parts.join(':')
+          {
+            uri: file_to_uri(filename),
+            range: {
+              start: {
+                line: line,
+                character: char
+              },
+              end: {
+                line: line,
+                character: char
+              }
+            }
+          }
+        end
+      end
+      set_result locations
+    end
+  end
+end