solargraph 0.58.3 → 0.59.2

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

@@ -26,20 +26,27 @@ module Solargraph
             }
           }
           # 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][: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_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_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_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')
+          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
@@ -71,7 +78,7 @@ module Solargraph
         def static_code_action
           {
             codeActionProvider: true,
-            codeActionKinds: ["quickfix"]
+            codeActionKinds: ['quickfix']
           }
         end
 
@@ -144,11 +151,10 @@ module Solargraph
         # @return [Hash{Symbol => Hash{Symbol => Boolean}}]
         def static_rename
           {
-            renameProvider: {prepareProvider: true}
+            renameProvider: { prepareProvider: true }
           }
         end
 
-
         # @return [Hash{Symbol => Boolean}]
         def static_references
           return {} unless host.options['references']
@@ -178,10 +184,10 @@ module Solargraph
         #   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'])
+          result = params['capabilities'] &&
+                   params['capabilities'][section] &&
+                   params['capabilities'][section][capability] &&
+                   params['capabilities'][section][capability]['dynamicRegistration']
           host.allow_registration("#{section}/#{capability}") if result
           result
         end

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

@@ -1,28 +1,28 @@
-# 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/typeDefinition
-            textDocument/references
-            textDocument/rename
-            textDocument/prepareRename
-            textDocument/foldingRange
-            textDocument/documentHighlight
-            workspace/symbol
-          ]
-        end
-      end
-    end
-  end
-end
+# 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/typeDefinition
+            textDocument/references
+            textDocument/rename
+            textDocument/prepareRename
+            textDocument/foldingRange
+            textDocument/documentHighlight
+            workspace/symbol
+          ]
+        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
-        }
+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
-      set_result result
     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

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

@@ -43,7 +43,7 @@ module Solargraph
 
           # @param corrections [String]
           # @return [void]
-          def log_corrections(corrections)
+          def log_corrections corrections
             corrections = corrections&.strip
             return if corrections&.empty?
 
@@ -56,7 +56,7 @@ module Solargraph
 
           # @param file_uri [String]
           # @return [Hash{String => undefined}]
-          def config_for(file_uri)
+          def config_for file_uri
             conf = host.formatter_config(file_uri)
             return {} unless conf.is_a?(Hash)
 
@@ -71,10 +71,10 @@ module Solargraph
             args = [
               config['cops'] == 'all' ? '-A' : '-a',
               '--cache', 'false',
-              '--format', formatter_class(config).name,
+              '--format', formatter_class(config).name
             ]
 
-            ['except', 'only'].each do |arg|
+            %w[except only].each do |arg|
               cops = cop_list(config[arg])
               args += ["--#{arg}", cops] if cops
             end
@@ -86,7 +86,7 @@ module Solargraph
           # @param config [Hash{String => String}]
           # @sg-ignore
           # @return [Class<RuboCop::Formatter::BaseFormatter>]
-          def formatter_class(config)
+          def formatter_class config
             if self.class.const_defined?('BlankRubocopFormatter')
               # @sg-ignore
               BlankRubocopFormatter
@@ -98,9 +98,11 @@ module Solargraph
           end
 
           # @param value [Array, String]
+          #
           # @return [String, nil]
-          def cop_list(value)
+          def cop_list value
             # @type [String]
+            # @sg-ignore Translate to something flow sensitive typing understands
             value = value.join(',') if value.respond_to?(:join)
             return nil if value == '' || !value.is_a?(String)
             value

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

@@ -11,12 +11,11 @@ module Solargraph
             contents = []
             suggestions = host.definitions_at(params['textDocument']['uri'], line, col)
             last_link = nil
+            # @sg-ignore Need to add nil check here
             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 this_link if !this_link.nil? && this_link != last_link
               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?
@@ -31,6 +30,7 @@ module Solargraph
             )
           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 nil
           end
@@ -41,8 +41,8 @@ module Solargraph
           # @return [Hash{Symbol => Hash{Symbol => String}}, nil]
           def contents_or_nil contents
             stripped = contents
-              .map(&:strip)
-              .reject { |c| c.empty? }
+                       .map(&:strip)
+                       .reject(&:empty?)
             return nil if stripped.empty?
             {
               contents: {

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

@@ -1,11 +1,18 @@
 # 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
+module Solargraph
+  module LanguageServer
+    module Message
+      module 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
     end
   end
 end

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

@@ -1,16 +1,23 @@
 # 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
-        }
+module Solargraph
+  module LanguageServer
+    module Message
+      module 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
-      set_result result
     end
   end
 end

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

@@ -1,19 +1,26 @@
 # 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']
-        })
+module Solargraph
+  module LanguageServer
+    module Message
+      module 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
-      set_result changes: changes
     end
   end
 end

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

@@ -10,10 +10,11 @@ module Solargraph
             col = params['position']['character']
             suggestions = host.signatures_at(params['textDocument']['uri'], line, col)
             set_result({
-              signatures: suggestions.flat_map { |pin| pin.signature_help }
-            })
+                         signatures: suggestions.flat_map(&:signature_help)
+                       })
           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 nil
           end

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

@@ -1,24 +1,32 @@
 # frozen_string_literal: true
 
-module Solargraph::LanguageServer::Message::TextDocument
-  class TypeDefinition < Base
-    def process
-      @line = params['position']['line']
-      @column = params['position']['character']
-      set_result(code_location || [])
-    end
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class TypeDefinition < Base
+          def process
+            @line = params['position']['line']
+            @column = params['position']['character']
+            set_result(code_location || [])
+          end
 
-    private
+          private
 
-    # @return [Array<Hash>, nil]
-    def code_location
-      suggestions = host.type_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
-        }
+          # @return [Array<Hash>, nil]
+          def code_location
+            suggestions = host.type_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
+        end
       end
     end
   end