solargraph 0.58.2 → 0.59.0.dev.2

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

@@ -1,191 +1,197 @@
-# 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_type_definitions unless dynamic_registration_for?('textDocument', 'typeDefinition')
-          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
-
-        # @todo '?' methods should type like RBS 'boolish' rather than a strict true or false
-        # @sg-ignore
-        def support_workspace_folders?
-          params['capabilities'] &&
-            params['capabilities']['workspace'] &&
-            params['capabilities']['workspace']['workspaceFolders'] &&
-            params['workspaceFolders']
-        end
-
-        # @return [Hash{Symbol => undefined}]
-        def static_completion
-          return {} unless host.options['completion']
-          {
-            completionProvider: {
-              resolveProvider: true,
-              triggerCharacters: ['.', ':', '@']
-            }
-          }
-        end
-
-        # @return [Hash{Symbol => BasicObject}]
-        def static_code_action
-          {
-            codeActionProvider: true,
-            codeActionKinds: ["quickfix"]
-          }
-        end
-
-        # @return [Hash{Symbol => BasicObject}]
-        def static_signature_help
-          {
-            signatureHelpProvider: {
-              triggerCharacters: ['(', ',']
-            }
-          }
-        end
-
-        # @return [Hash{Symbol => Hash{Symbol => String, Array<String>}}]
-        def static_on_type_formatting
-          {
-            documentOnTypeFormattingProvider: {
-              firstTriggerCharacter: '{',
-              moreTriggerCharacter: ['(']
-            }
-          }
-        end
-
-        # @return [Hash{Symbol => Boolean}]
-        def static_hover
-          return {} unless host.options['hover']
-          {
-            hoverProvider: true
-          }
-        end
-
-        # @return [Hash{Symbol => Boolean}]
-        def static_document_formatting
-          return {} unless host.options['formatting']
-          {
-            documentFormattingProvider: true
-          }
-        end
-
-        # @return [Hash{Symbol => Boolean}]
-        def static_document_symbols
-          return {} unless host.options['symbols']
-          {
-            documentSymbolProvider: true
-          }
-        end
-
-        # @return [Hash{Symbol => Boolean}]
-        def static_workspace_symbols
-          {
-            workspaceSymbolProvider: true
-          }
-        end
-
-        # @return [Hash{Symbol => Boolean}]
-        def static_definitions
-          return {} unless host.options['definitions']
-          {
-            definitionProvider: true
-          }
-        end
-
-        # @return [Hash{Symbol => Boolean}]
-        def static_type_definitions
-          return {} unless host.options['typeDefinitions']
-          {
-            typeDefinitionProvider: true
-          }
-        end
-
-        # @return [Hash{Symbol => Hash{Symbol => Boolean}}]
-        def static_rename
-          {
-            renameProvider: {prepareProvider: true}
-          }
-        end
-
-
-        # @return [Hash{Symbol => Boolean}]
-        def static_references
-          return {} unless host.options['references']
-          {
-            referencesProvider: true
-          }
-        end
-
-        # @return [Hash{Symbol => Boolean}]
-        def static_folding_range
-          return {} unless host.options['folding']
-          {
-            foldingRangeProvider: true
-          }
-        end
-
-        # @return [Hash{Symbol => Boolean}]
-        def static_highlights
-          {
-            documentHighlightProvider: true
-          }
-        end
-
-        # @param section [String]
-        # @param capability [String]
-        # @todo Need support for RBS' boolish "type", which doesn't
-        #   enforce strict true/false-ness
-        # @sg-ignore
-        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
+# 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_type_definitions unless dynamic_registration_for?('textDocument',
+                                                                                                'typeDefinition')
+          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
+
+        # @todo '?' methods should type like RBS 'boolish' rather than a strict true or false
+        # @sg-ignore
+        def support_workspace_folders?
+          params['capabilities'] &&
+            params['capabilities']['workspace'] &&
+            params['capabilities']['workspace']['workspaceFolders'] &&
+            params['workspaceFolders']
+        end
+
+        # @return [Hash{Symbol => undefined}]
+        def static_completion
+          return {} unless host.options['completion']
+          {
+            completionProvider: {
+              resolveProvider: true,
+              triggerCharacters: ['.', ':', '@']
+            }
+          }
+        end
+
+        # @return [Hash{Symbol => BasicObject}]
+        def static_code_action
+          {
+            codeActionProvider: true,
+            codeActionKinds: ['quickfix']
+          }
+        end
+
+        # @return [Hash{Symbol => BasicObject}]
+        def static_signature_help
+          {
+            signatureHelpProvider: {
+              triggerCharacters: ['(', ',']
+            }
+          }
+        end
+
+        # @return [Hash{Symbol => Hash{Symbol => String, Array<String>}}]
+        def static_on_type_formatting
+          {
+            documentOnTypeFormattingProvider: {
+              firstTriggerCharacter: '{',
+              moreTriggerCharacter: ['(']
+            }
+          }
+        end
+
+        # @return [Hash{Symbol => Boolean}]
+        def static_hover
+          return {} unless host.options['hover']
+          {
+            hoverProvider: true
+          }
+        end
+
+        # @return [Hash{Symbol => Boolean}]
+        def static_document_formatting
+          return {} unless host.options['formatting']
+          {
+            documentFormattingProvider: true
+          }
+        end
+
+        # @return [Hash{Symbol => Boolean}]
+        def static_document_symbols
+          return {} unless host.options['symbols']
+          {
+            documentSymbolProvider: true
+          }
+        end
+
+        # @return [Hash{Symbol => Boolean}]
+        def static_workspace_symbols
+          {
+            workspaceSymbolProvider: true
+          }
+        end
+
+        # @return [Hash{Symbol => Boolean}]
+        def static_definitions
+          return {} unless host.options['definitions']
+          {
+            definitionProvider: true
+          }
+        end
+
+        # @return [Hash{Symbol => Boolean}]
+        def static_type_definitions
+          return {} unless host.options['typeDefinitions']
+          {
+            typeDefinitionProvider: true
+          }
+        end
+
+        # @return [Hash{Symbol => Hash{Symbol => Boolean}}]
+        def static_rename
+          {
+            renameProvider: { prepareProvider: true }
+          }
+        end
+
+        # @return [Hash{Symbol => Boolean}]
+        def static_references
+          return {} unless host.options['references']
+          {
+            referencesProvider: true
+          }
+        end
+
+        # @return [Hash{Symbol => Boolean}]
+        def static_folding_range
+          return {} unless host.options['folding']
+          {
+            foldingRangeProvider: true
+          }
+        end
+
+        # @return [Hash{Symbol => Boolean}]
+        def static_highlights
+          {
+            documentHighlightProvider: true
+          }
+        end
+
+        # @param section [String]
+        # @param capability [String]
+        # @todo Need support for RBS' boolish "type", which doesn't
+        #   enforce strict true/false-ness
+        # @sg-ignore
+        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/text_document/completion.rb

@@ -6,7 +6,7 @@ module Solargraph
       module TextDocument
         class Completion < Base
           def process
-            return set_error(ErrorCodes::REQUEST_CANCELLED, "cancelled by so many request") if host.has_pending_completions?
+            return set_error(ErrorCodes::REQUEST_CANCELLED, 'cancelled by so many request') if host.pending_completions?
 
             line = params['position']['line']
             col = params['position']['character']
@@ -15,15 +15,16 @@ module Solargraph
               items = []
               last_context = nil
               idx = -1
+              # @sg-ignore Need to add nil check here
               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}"
-                })
+                                                       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
@@ -31,12 +32,13 @@ module Solargraph
                 isIncomplete: false,
                 items: items
               )
-            rescue InvalidOffsetError => e
+            rescue InvalidOffsetError
               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}"
+            # @sg-ignore Need to add nil check here
             Logging.logger.warn e.backtrace.join("\n")
             set_result empty_result
           end

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

@@ -1,40 +1,49 @@
 # 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
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class Definition < Base
+          def process
+            @line = params['position']['line']
+            @column = params['position']['character']
+            set_result(code_location || require_location || [])
+          end
 
-    private
+          private
 
-    # @return [Array<Hash>, nil]
-    def code_location
-      suggestions = host.definitions_at(params['textDocument']['uri'], @line, @column)
-      return nil if suggestions.empty?
-      suggestions.reject { |pin| pin.best_location.nil? || pin.best_location.filename.nil? }.map do |pin|
-        {
-          uri: file_to_uri(pin.best_location.filename),
-          range: pin.best_location.range.to_hash
-        }
-      end
-    end
+          # @return [Array<Hash>, nil]
+          def code_location
+            suggestions = host.definitions_at(params['textDocument']['uri'], @line, @column)
+            # @sg-ignore Need to add nil check here
+            return nil if suggestions.empty?
+            # @sg-ignore Need to add nil check here
+            suggestions.reject { |pin| pin.best_location.nil? || pin.best_location.filename.nil? }.map do |pin|
+              {
+                uri: file_to_uri(pin.best_location.filename),
+                range: pin.best_location.range.to_hash
+              }
+            end
+          end
 
-    # @return [Array<Hash>, nil]
-    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
-        }
-      ]
+          # @return [Array<Hash>, nil]
+          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
     end
   end
 end

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

@@ -1,16 +1,23 @@
-# 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
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module 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
+    end
+  end
+end

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

@@ -1,26 +1,36 @@
 # frozen_string_literal: true
 
-class Solargraph::LanguageServer::Message::TextDocument::DocumentSymbol < Solargraph::LanguageServer::Message::Base
-  include Solargraph::LanguageServer::UriHelpers
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class DocumentSymbol < Solargraph::LanguageServer::Message::Base
+          include Solargraph::LanguageServer::UriHelpers
 
-  def process
-    pins = host.document_symbols params['textDocument']['uri']
-    info = pins.map do |pin|
-      next nil unless pin.best_location&.filename
+          def process
+            pins = host.document_symbols params['textDocument']['uri']
+            info = pins.map do |pin|
+              next nil unless pin.best_location&.filename
 
-      result = {
-        name: pin.name,
-        containerName: pin.namespace,
-        kind: pin.symbol_kind,
-        location: {
-          uri: file_to_uri(pin.best_location.filename),
-          range: pin.best_location.range.to_hash
-        },
-        deprecated: pin.deprecated?
-      }
-      result
-    end.compact
+              result = {
+                name: pin.name,
+                containerName: pin.namespace,
+                kind: pin.symbol_kind,
+                location: {
+                  # @sg-ignore Need to add nil check here
+                  uri: file_to_uri(pin.best_location.filename),
+                  # @sg-ignore Need to add nil check here
+                  range: pin.best_location.range.to_hash
+                },
+                deprecated: pin.deprecated?
+              }
+              result
+            end.compact
 
-    set_result info
+            set_result info
+          end
+        end
+      end
+    end
   end
 end