solargraph 0.58.3 → 0.59.0

data/lib/solargraph/language_server/host/message_worker.rb

@@ -20,7 +20,7 @@ module Solargraph
         ].freeze
 
         # @param host [Host]
-        def initialize(host)
+        def initialize host
           @host = host
           @mutex = Mutex.new
           @resource = ConditionVariable.new
@@ -28,7 +28,7 @@ module Solargraph
         end
 
         # pending handle messages
-        # @return [Array<Hash>]
+        # @return [Array<Hash{String => undefined}>]
         def messages
           @messages ||= []
         end
@@ -44,7 +44,7 @@ module Solargraph
 
         # @param message [Hash] The message to handle. Will be forwarded to Host#receive
         # @return [void]
-        def queue(message)
+        def queue message
           @mutex.synchronize do
             messages.push(message)
             @resource.signal
@@ -66,6 +66,7 @@ module Solargraph
             @resource.wait(@mutex) if messages.empty?
             next_message
           end
+          # @sg-ignore Need to add nil check here
           handler = @host.receive(message)
           handler&.send_response
         end

data/lib/solargraph/language_server/host/sources.rb

@@ -13,7 +13,7 @@ module Solargraph
 
         # @param uri [String]
         # @return [void]
-        def add_uri(uri)
+        def add_uri uri
           queue.push(uri)
         end
 
@@ -55,6 +55,7 @@ module Solargraph
         # @raise [FileNotFoundError] if the URI does not match an open source.
         #
         # @param uri [String]
+        # @sg-ignore flow ensitive typing should understand raise
         # @return [Solargraph::Source]
         def find uri
           open_source_hash[uri] || raise(Solargraph::FileNotFoundError, "Host could not find #{uri}")

data/lib/solargraph/language_server/host.rb

@@ -53,7 +53,7 @@ module Solargraph
         logger.level = LOG_LEVELS[options['logLevel']] || DEFAULT_LOG_LEVEL
       end
 
-      # @return [Hash{String => [Boolean, String]}]
+      # @return [Hash{String => Boolean, String}]
       def options
         @options ||= default_configuration
       end
@@ -105,6 +105,7 @@ module Solargraph
             message.process unless cancel?(request['id'])
           rescue StandardError => e
             logger.warn "Error processing request: [#{e.class}] #{e.message}"
+            # @sg-ignore Need to add nil check here
             logger.warn e.backtrace.join("\n")
             message.set_error Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, "[#{e.class}] #{e.message}"
           end
@@ -118,7 +119,7 @@ module Solargraph
             nil
           end
         else
-          logger.warn "Invalid message received."
+          logger.warn 'Invalid message received.'
           logger.debug request
           nil
         end
@@ -153,7 +154,7 @@ module Solargraph
           lib.delete(*filenames)
         end
         uris.each do |uri|
-          send_notification "textDocument/publishDiagnostics", {
+          send_notification 'textDocument/publishDiagnostics', {
             uri: uri,
             diagnostics: []
           }
@@ -208,7 +209,7 @@ module Solargraph
             logger.info "Diagnosing #{uri}"
             begin
               results = library.diagnose uri_to_file(uri)
-              send_notification "textDocument/publishDiagnostics", {
+              send_notification 'textDocument/publishDiagnostics', {
                 uri: uri,
                 diagnostics: results
               }
@@ -300,8 +301,11 @@ module Solargraph
         end
       end
 
+      # @sg-ignore Need to validate config
       # @return [String]
+      # @sg-ignore Need to validate config
       def command_path
+        # @type [String]
         options['commandPath'] || 'solargraph'
       end
 
@@ -350,7 +354,7 @@ module Solargraph
       # @return [void]
       def send_notification method, params
         response = {
-          jsonrpc: "2.0",
+          jsonrpc: '2.0',
           method: method,
           params: params
         }
@@ -373,7 +377,7 @@ module Solargraph
       def send_request method, params, &block
         @request_mutex.synchronize do
           message = {
-            jsonrpc: "2.0",
+            jsonrpc: '2.0',
             method: method,
             params: params,
             id: @next_request_id
@@ -415,13 +419,13 @@ module Solargraph
       # @return [void]
       def unregister_capabilities methods
         logger.debug "Unregistering capabilities: #{methods}"
-        unregisterations = methods.select{|m| registered?(m)}.map{ |m|
+        unregisterations = methods.select { |m| registered?(m) }.map do |m|
           @registered_capabilities.delete m
           {
             id: m,
             method: m
           }
-        }
+        end
         return if unregisterations.empty?
         send_request 'client/unregisterCapability', { unregisterations: unregisterations }
       end
@@ -489,7 +493,7 @@ module Solargraph
               params['data']['location']['range']['end']['character']
             )
           )
-          result.concat library.locate_pins(location).select{ |pin| pin.name == params['label'] }
+          result.concat(library.locate_pins(location).select { |pin| pin.name == params['label'] })
         end
         if params['data']['path']
           result.concat library.path_pins(params['data']['path'])
@@ -543,7 +547,7 @@ module Solargraph
       end
 
       # @return [Bool] if has pending completion request
-      def has_pending_completions?
+      def pending_completions?
         message_worker.messages.reverse_each.any? { |req| req['method'] == 'textDocument/completion' }
       end
 
@@ -644,7 +648,7 @@ module Solargraph
       # @param text [String]
       # @param type [Integer] A MessageType constant
       # @param actions [Array<String>] Response options for the client
-      # @param block The block that processes the response
+      # @param block [Proc] The block that processes the response
       # @yieldparam [String] The action received from the client
       # @return [void]
       def show_message_request text, type, actions, &block
@@ -663,7 +667,7 @@ module Solargraph
         requests.keys
       end
 
-      # @return [Hash{String => [Boolean,String]}]
+      # @return [Hash{String => Boolean,String}]
       def default_configuration
         {
           'completion' => true,
@@ -729,9 +733,11 @@ module Solargraph
       end
 
       # @param path [String]
+      # @sg-ignore Need to be able to choose signature on String#gsub
       # @return [String]
       def normalize_separators path
         return path if File::ALT_SEPARATOR.nil?
+        # @sg-ignore flow sensitive typing needs to handle constants
         path.gsub(File::ALT_SEPARATOR, File::SEPARATOR)
       end
 
@@ -742,9 +748,12 @@ module Solargraph
         params['contentChanges'].each do |recvd|
           chng = check_diff(params['textDocument']['uri'], recvd)
           changes.push Solargraph::Source::Change.new(
-            (chng['range'].nil? ?
-              nil :
-              Solargraph::Range.from_to(chng['range']['start']['line'], chng['range']['start']['character'], chng['range']['end']['line'], chng['range']['end']['character'])
+            (if chng['range'].nil?
+               nil
+             else
+               Solargraph::Range.from_to(chng['range']['start']['line'], chng['range']['start']['character'],
+                                         chng['range']['end']['line'], chng['range']['end']['character'])
+             end
             ),
             chng['text']
           )
@@ -764,8 +773,7 @@ module Solargraph
         source = sources.find(uri)
         return change if source.code.length + 1 != change['text'].length
         diffs = Diff::LCS.diff(source.code, change['text'])
-        return change if diffs.length.zero? || diffs.length > 1 || diffs.first.length > 1
-        # @sg-ignore push this upstream
+        return change if diffs.empty? || diffs.length > 1 || diffs.first.length > 1
         # @type [Diff::LCS::Change]
         diff = diffs.first.first
         return change unless diff.adding? && ['.', ':', '(', ',', ' '].include?(diff.element)
@@ -808,10 +816,10 @@ module Solargraph
           # documentSymbolProvider: true,
           # workspaceSymbolProvider: true,
           # workspace: {
-            # workspaceFolders: {
-              # supported: true,
-              # changeNotifications: true
-            # }
+          # workspaceFolders: {
+          # supported: true,
+          # changeNotifications: true
+          # }
           # }
           'textDocument/definition' => {
             definitionProvider: true
@@ -858,7 +866,7 @@ module Solargraph
       end
 
       # @param library [Library]
-      # @param uuid [String, nil]
+      #
       # @return [void]
       def sync_library_map library
         total = library.workspace.sources.length

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

@@ -69,7 +69,7 @@ module Solargraph
           }
           response[:result] = result unless result.nil?
           response[:error] = error unless error.nil?
-          response[:result] = nil if result.nil? and error.nil?
+          response[:result] = nil if result.nil? && error.nil?
           json = response.to_json
           envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
           Solargraph.logger.debug envelope

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

@@ -5,9 +5,7 @@ module Solargraph
     module Message
       module Client
         class RegisterCapability < Solargraph::LanguageServer::Message::Base
-          def process
-            
-          end
+          def process; end
         end
       end
     end

data/lib/solargraph/language_server/message/completion_item/resolve.rb

@@ -21,9 +21,9 @@ module Solargraph
             docs = pins
                    .reject { |pin| pin.documentation.empty? && pin.return_type.undefined? }
             result = params
-              .transform_keys(&:to_sym)
-              .merge(pins.first.resolve_completion_item)
-              .merge(documentation: markup_content(join_docs(docs)))
+                     .transform_keys(&:to_sym)
+                     .merge(pins.first.resolve_completion_item)
+                     .merge(documentation: markup_content(join_docs(docs)))
             result[:detail] = pins.first.detail
             result
           end
@@ -43,12 +43,10 @@ module Solargraph
           def join_docs pins
             result = []
             last_link = nil
-            pins.each_with_index do |pin|
+            pins.each do |pin|
               this_link = host.options['enablePages'] ? pin.link_documentation : pin.text_documentation
-              if this_link && this_link != last_link && this_link != 'undefined'
-                result.push this_link
-              end
-              result.push pin.documentation unless result.last && result.last.end_with?(pin.documentation)
+              result.push this_link if this_link && this_link != last_link && this_link != 'undefined'
+              result.push pin.documentation unless result.last&.end_with?(pin.documentation)
               last_link = this_link
             end
             result.join("\n\n")

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

@@ -1,12 +1,5 @@
 # frozen_string_literal: true
 
-
-# @todo PR the RBS gem to add this
-# @!parse
-#   module ::Gem
-#    class SpecFetcher; end
-#   end
-
 module Solargraph
   module LanguageServer
     module Message
@@ -23,8 +16,8 @@ module Solargraph
 
           # @param obj [Gem::SpecFetcher]
           # @return [Gem::SpecFetcher]
-          def self.fetcher= obj
-            @fetcher = obj
+          class << self
+            attr_writer :fetcher
           end
 
           GEM_ZERO = Gem::Version.new('0.0.0')
@@ -47,11 +40,11 @@ module Solargraph
                                           ['Update now'] do |result|
                                             next unless result == 'Update now'
                                             cmd = if host.options['useBundler']
-                                              'bundle update solargraph'
-                                            else
-                                              'gem update solargraph'
-                                            end
-                                            o, s = Open3.capture2(cmd)
+                                                    'bundle update solargraph'
+                                                  else
+                                                    'gem update solargraph'
+                                                  end
+                                            _, s = Open3.capture2(cmd)
                                             if s == 0
                                               host.show_message 'Successfully updated the Solargraph gem.', LanguageServer::MessageTypes::INFO
                                               host.send_notification '$/solargraph/restart', {}
@@ -64,12 +57,13 @@ module Solargraph
               end
             elsif fetched?
               Solargraph::Logging.logger.warn error
+              # @sg-ignore Need to add nil check here
               host.show_message(error, MessageTypes::ERROR) if params['verbose']
             end
             set_result({
-              installed: current,
-              available: available
-            })
+                         installed: current,
+                         available: available
+                       })
           end
 
           private
@@ -78,12 +72,12 @@ module Solargraph
           attr_reader :current
 
           # @return [Gem::Version]
+          # @sg-ignore Need to add nil check here
           def available
             if !@available && !@fetched
               @fetched = true
               begin
                 @available ||= begin
-                  # @sg-ignore Variable type could not be inferred for tuple
                   # @type [Gem::Dependency, nil]
                   tuple = CheckGemVersion.fetcher.search_for_dependency(Gem::Dependency.new('solargraph')).flatten.first
                   if tuple.nil?

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

@@ -14,6 +14,7 @@ module Solargraph
             )
           rescue StandardError => e
             Solargraph.logger.warn "Error processing document: [#{e.class}] #{e.message}"
+            # @sg-ignore Need to add nil check here
             Solargraph.logger.debug e.backtrace.join("\n")
           end
         end

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

@@ -13,16 +13,16 @@ module Solargraph
           def process
             cmd = [host.command_path, 'gems']
             cmd.push '--rebuild' if params['rebuild']
-            o, s = Open3.capture2(*cmd)
-            if s != 0
-              host.show_message "An error occurred while building gem documentation.", LanguageServer::MessageTypes::ERROR
+            _, s = Open3.capture2(*cmd)
+            if s == 0
               set_result({
-                status: 'err'
-              })
+                           status: 'ok'
+                         })
             else
+              host.show_message 'An error occurred while building gem documentation.', LanguageServer::MessageTypes::ERROR
               set_result({
-                status: 'ok'
-              })
+                           status: 'err'
+                         })
             end
           end
         end

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

@@ -10,7 +10,8 @@ module Solargraph
         #
         class DownloadCore < Base
           def process
-            host.show_message "Downloading cores is deprecated. Solargraph currently uses RBS for core and stdlib documentation", LanguageServer::MessageTypes::INFO
+            host.show_message 'Downloading cores is deprecated. Solargraph currently uses RBS for core and stdlib documentation',
+                              LanguageServer::MessageTypes::INFO
           end
         end
       end

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

@@ -8,7 +8,7 @@ module Solargraph
           def process
             results = host.search(params['query'])
             page = Solargraph::Page.new(host.options['viewsPath'])
-            content = page.render('search', layout: true, locals: {query: params['query'], results: results})
+            content = page.render('search', layout: true, locals: { query: params['query'], results: results })
             set_result(
               content: content
             )

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/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