cosmicgraph 0.49.0

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      class Shutdown < Base
+        def process
+          # Nothing to do?
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+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/code_action.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'open3'
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class CodeAction < Base
+          def process
+            # @todo Find code actions
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class Completion < Base
+          def process
+            return set_error(ErrorCodes::REQUEST_CANCELLED, "cancelled by so many request") if host.has_pending_completions?
+
+            line = params['position']['line']
+            col = params['position']['character']
+            begin
+              completion = host.completions_at(params['textDocument']['uri'], line, col)
+              if host.cancel?(id)
+                return set_result(empty_result) if host.cancel?(id)
+              end
+              items = []
+              last_context = nil
+              idx = -1
+              completion.pins.each do |pin|
+                idx += 1 if last_context != pin.context
+                items.push pin.completion_item.merge({
+                  textEdit: {
+                    range: completion.range.to_hash,
+                    newText: pin.name.sub(/=$/, ' = ').sub(/:$/, ': ')
+                  },
+                  sortText: "#{idx.to_s.rjust(4, '0')}#{pin.name}"
+                })
+                items.last[:data][:uri] = params['textDocument']['uri']
+                last_context = pin.context
+              end
+              set_result(
+                isIncomplete: false,
+                items: items
+              )
+            rescue InvalidOffsetError => e
+              Logging.logger.info "Completion ignored invalid offset: #{params['textDocument']['uri']}, line #{line}, character #{col}"
+              set_result empty_result
+            end
+          rescue FileNotFoundError => e
+            Logging.logger.warn "[#{e.class}] #{e.message}"
+            Logging.logger.warn e.backtrace.join("\n")
+            set_result empty_result
+          end
+
+          # @param incomplete [Boolean]
+          # @return [Hash]
+          def empty_result incomplete = false
+            {
+              isIncomplete: incomplete,
+              items: []
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Solargraph::LanguageServer::Message::TextDocument
+  class Definition < Base
+    def process
+      @line = params['position']['line']
+      @column = params['position']['character']
+      set_result(code_location || require_location || [])
+    end
+
+    private
+
+    def code_location
+      suggestions = host.definitions_at(params['textDocument']['uri'], @line, @column)
+      return nil if suggestions.empty?
+      suggestions.reject { |pin| pin.location.nil? || pin.location.filename.nil? }.map do |pin|
+        {
+          uri: file_to_uri(pin.location.filename),
+          range: pin.location.range.to_hash
+        }
+      end
+    end
+
+    def require_location
+      # @todo Terrible hack
+      lib = host.library_for(params['textDocument']['uri'])
+      rloc = Solargraph::Location.new(uri_to_file(params['textDocument']['uri']), Solargraph::Range.from_to(@line, @column, @line, @column))
+      dloc = lib.locate_ref(rloc)
+      return nil if dloc.nil?
+      [
+        {
+          uri: file_to_uri(dloc.filename),
+          range: dloc.range.to_hash
+        }
+      ]
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class DidChange < Base
+          def process
+            host.change params
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class DidClose < Base
+          def process
+            host.close params['textDocument']['uri']
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class DidOpen < Base
+          def process
+            host.open params['textDocument']['uri'], params['textDocument']['text'], params['textDocument']['version']
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class DidSave < Base
+          def process
+            # @todo The server might not need to do anything in response to
+            #   this notification. See https://github.com/castwide/solargraph/issues/73
+            # host.save params
+          end
+        end
+      end
+    end
+  end
+end

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

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

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,126 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+require 'tmpdir'
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class Formatting < Base
+          include Solargraph::Diagnostics::RubocopHelpers
+
+          def process
+            file_uri = params['textDocument']['uri']
+            config = config_for(file_uri)
+            original = host.read_text(file_uri)
+            args = cli_args(file_uri, config)
+
+            require_rubocop(config['version'])
+            options, paths = RuboCop::Options.new.parse(args)
+            options[:stdin] = original
+            corrections = redirect_stdout do
+              RuboCop::Runner.new(options, RuboCop::ConfigStore.new).run(paths)
+            end
+            result = options[:stdin]
+
+            log_corrections(corrections)
+
+            format original, result
+          rescue RuboCop::ValidationError, RuboCop::ConfigNotFoundError => e
+            set_error(Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, "[#{e.class}] #{e.message}")
+          end
+
+          private
+
+          def log_corrections(corrections)
+            corrections = corrections&.strip
+            return if corrections&.empty?
+
+            Solargraph.logger.info('Formatting result:')
+            corrections.each_line do |line|
+              next if line.strip.empty?
+              Solargraph.logger.info(line.strip)
+            end
+          end
+
+          def config_for(file_uri)
+            conf = host.formatter_config(file_uri)
+            return {} unless conf.is_a?(Hash)
+
+            conf['rubocop'] || {}
+          end
+
+          def cli_args file_uri, config
+            file = UriHelpers.uri_to_file(file_uri)
+            args = [
+              config['cops'] == 'all' ? '--autocorrect-all' : '--autocorrect',
+              '--cache', 'false',
+              '--format', formatter_class(config).name,
+            ]
+
+            ['except', 'only'].each do |arg|
+              cops = cop_list(config[arg])
+              args += ["--#{arg}", cops] if cops
+            end
+
+            args += config['extra_args'] if config['extra_args']
+            args + [file]
+          end
+
+          def formatter_class(config)
+            if self.class.const_defined?('BlankRubocopFormatter')
+              BlankRubocopFormatter
+            else
+              require_rubocop(config['version'])
+              klass = Class.new(::RuboCop::Formatter::BaseFormatter)
+              self.class.const_set 'BlankRubocopFormatter', klass
+            end
+          end
+
+          def cop_list(value)
+            value = value.join(',') if value.respond_to?(:join)
+            return nil if value == '' || !value.is_a?(String)
+            value
+          end
+
+          # @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,56 @@
+# 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}`" 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_or_nil(contents)
+            )
+          rescue FileNotFoundError => e
+            Logging.logger.warn "[#{e.class}] #{e.message}"
+            Logging.logger.warn e.backtrace.join("\n")
+            set_result nil
+          end
+
+          private
+
+          def contents_or_nil contents
+            stripped = contents
+              .map(&:strip)
+              .reject { |c| c.empty? }
+            return nil if stripped.empty?
+            {
+              contents: {
+                kind: 'markdown',
+                value: stripped.join("\n\n")
+              }
+            }
+          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,24 @@
+# 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)
+            set_result({
+              signatures: suggestions.flat_map { |pin| pin.signature_help }
+            })
+          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.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+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'
+        autoload :References,        'solargraph/language_server/message/text_document/references'
+        autoload :Rename,            'solargraph/language_server/message/text_document/rename'
+        autoload :PrepareRename,     'solargraph/language_server/message/text_document/prepare_rename'
+        autoload :FoldingRange,      'solargraph/language_server/message/text_document/folding_range'
+        autoload :DocumentHighlight, 'solargraph/language_server/message/text_document/document_highlight'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# 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.options['highlights'] ? y : n).push('textDocument/documentHighlight')
+      host.register_capabilities y
+      host.unregister_capabilities n
+    end
+  end
+end