solargraph 0.39.7

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

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

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class FoldingRange < Base
+          def process
+            result = host.folding_ranges(params['textDocument']['uri']).map do |range|
+              {
+                startLine: range.start.line,
+                startCharacter: 0,
+                endLine: range.ending.line - 1,
+                endCharacter: 0,
+                kind: 'region'
+              }
+            end
+            set_result result
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+require 'securerandom'
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class Formatting < Base
+          include Solargraph::Diagnostics::RubocopHelpers
+
+          def process
+            filename = uri_to_file(params['textDocument']['uri'])
+            # Make the temp file in the original file's directory so RuboCop
+            # detects the correct configuration
+            # the .rb extension is needed for ruby file without extension, else rubocop won't format
+            tempfile = File.join(File.dirname(filename), "_tmp_#{SecureRandom.hex(8)}_#{File.basename(filename)}.rb")
+            rubocop_file = Diagnostics::RubocopHelpers.find_rubocop_file(filename)
+            original = host.read_text(params['textDocument']['uri'])
+            File.write tempfile, original
+            begin
+              args = ['-a', '-f', 'fi', tempfile]
+              args.unshift('-c', fix_drive_letter(rubocop_file)) unless rubocop_file.nil?
+              options, paths = RuboCop::Options.new.parse(args)
+              store = RuboCop::ConfigStore.new
+              redirect_stdout { RuboCop::Runner.new(options, store).run(paths) }
+              result = File.read(tempfile)
+              File.unlink tempfile
+              format original, result
+            rescue RuboCop::ValidationError, RuboCop::ConfigNotFoundError => e
+              set_error(Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, "[#{e.class}] #{e.message}")
+              File.unlink tempfile
+            end
+          end
+
+          private
+
+          # @param original [String]
+          # @param result [String]
+          # @return [void]
+          def format original, result
+            ending = if original.end_with?("\n")
+                       {
+                         line: original.lines.length,
+                         character: 0
+                       }
+                     elsif original.lines.empty?
+                       {
+                         line: 0,
+                         character: 0
+                       }
+                     else
+                       {
+                         line: original.lines.length - 1,
+                         character: original.lines.last.length
+                       }
+                     end
+            set_result(
+              [
+                {
+                  range: {
+                    start: {
+                      line: 0,
+                      character: 0
+                    },
+                    end: ending
+                  },
+                  newText: result
+                }
+              ]
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class Hover < Base
+          def process
+            line = params['position']['line']
+            col = params['position']['character']
+            contents = []
+            suggestions = host.definitions_at(params['textDocument']['uri'], line, col)
+            last_link = nil
+            suggestions.each do |pin|
+              parts = []
+              this_link = host.options['enablePages'] ? pin.link_documentation : pin.text_documentation
+              if !this_link.nil? && this_link != last_link
+                parts.push this_link
+              end
+              parts.push pin.detail.gsub(':', '\\:') unless pin.is_a?(Pin::Namespace) || pin.detail.nil?
+              parts.push pin.documentation unless pin.documentation.nil? || pin.documentation.empty?
+              unless parts.empty?
+                data = parts.join("\n\n")
+                next if contents.last && contents.last.end_with?(data)
+                contents.push data
+              end
+              last_link = this_link unless this_link.nil?
+            end
+            set_result(
+              contents: {
+                kind: 'markdown',
+                value: contents.join("\n\n")
+              }
+            )
+          rescue FileNotFoundError => e
+            Logging.logger.warn "[#{e.class}] #{e.message}"
+            Logging.logger.warn e.backtrace.join("\n")
+            set_result nil
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class OnTypeFormatting < Base
+          def process
+            # @todo Temporarily disabled due to conflicts with VSCode formatting on type
+            # src = host.send(:library).checkout(uri_to_file(params['textDocument']['uri']))
+            # fragment = src.fragment_at(params['position']['line'], params['position']['character'] - 1)
+            # offset = fragment.send(:offset)
+            # if fragment.string? and params['ch'] == '{' and src.code[offset - 1, 2] == '#{'
+            #   set_result(
+            #     [
+            #       {
+            #         range: {
+            #           start: params['position'],
+            #           end: params['position']
+            #         },
+            #         newText: '}'
+            #       }
+            #     ]
+            #   )
+            # else
+            #   # @todo Is `nil` or `[]` more appropriate here?
+            #   set_result nil
+            # end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Solargraph::LanguageServer::Message::TextDocument
+  class PrepareRename < Base
+    def process
+      line = params['position']['line']
+      col = params['position']['character']
+      set_result host.sources.find(params['textDocument']['uri']).cursor_at(Solargraph::Position.new(line, col)).range.to_hash
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Solargraph::LanguageServer::Message::TextDocument
+  class References < Base
+    def process
+      locs = host.references_from(params['textDocument']['uri'], params['position']['line'], params['position']['character'])
+      result = locs.map do |loc|
+        {
+          uri: file_to_uri(loc.filename),
+          range: loc.range.to_hash
+        }
+      end
+      set_result result
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Solargraph::LanguageServer::Message::TextDocument
+  class Rename < Base
+    def process
+      locs = host.references_from(params['textDocument']['uri'], params['position']['line'], params['position']['character'], strip: true)
+      changes = {}
+      locs.each do |loc|
+        uri = file_to_uri(loc.filename)
+        changes[uri] ||= []
+        changes[uri].push({
+          range: loc.range.to_hash,
+          newText: params['newName']
+        })
+      end
+      set_result changes: changes
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class SignatureHelp < TextDocument::Base
+          def process
+            line = params['position']['line']
+            col = params['position']['character']
+            suggestions = host.signatures_at(params['textDocument']['uri'], line, col)
+            info = []
+            suggestions.each do |pin|
+              info.concat pin.overloads.map(&:signature_help)
+              info.push pin.signature_help
+            end
+            set_result({
+              signatures: info
+            })
+          rescue FileNotFoundError => e
+            Logging.logger.warn "[#{e.class}] #{e.message}"
+            Logging.logger.warn e.backtrace.join("\n")
+            set_result nil
+          end
+        end
+      end
+    end
+  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/workspace/did_change_configuration.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Solargraph::LanguageServer::Message::Workspace
+  class DidChangeConfiguration < Solargraph::LanguageServer::Message::Base
+    def process
+      return unless params['settings']
+      update = params['settings']['solargraph']
+      host.configure update
+      register_from_options
+    end
+
+    private
+
+    def register_from_options
+      y = []
+      n = []
+      (host.options['completion'] ? y : n).push('textDocument/completion')
+      (host.options['hover'] ? y : n).push('textDocument/hover', 'textDocument/signatureHelp')
+      (host.options['autoformat'] ? y : n).push('textDocument/onTypeFormatting')
+      (host.options['formatting'] ? y : n).push('textDocument/formatting')
+      (host.options['symbols'] ? y : n).push('textDocument/documentSymbol', 'workspace/symbol')
+      (host.options['definitions'] ? y : n).push('textDocument/definition')
+      (host.options['references'] ? y : n).push('textDocument/references')
+      (host.options['folding'] ? y : n).push('textDocument/folding')
+      host.register_capabilities y
+      host.unregister_capabilities n
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# 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
+      # @param change [Hash]
+      params['changes'].each do |change|
+        if change['type'] == CREATED
+          host.create change['uri']
+          need_catalog = true
+        elsif change['type'] == CHANGED
+          next if host.open?(change['uri'])
+          host.create change['uri']
+          need_catalog = true
+        elsif change['type'] == DELETED
+          host.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
+      # 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.name,
+        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_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