solargraph 0.58.3 → 0.59.2

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

@@ -1,28 +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 :OnTypeFormatting,  'solargraph/language_server/message/text_document/on_type_formatting'
-        autoload :Definition,        'solargraph/language_server/message/text_document/definition'
-        autoload :TypeDefinition,    'solargraph/language_server/message/text_document/type_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
+# 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 :OnTypeFormatting,  'solargraph/language_server/message/text_document/on_type_formatting'
+        autoload :Definition,        'solargraph/language_server/message/text_document/definition'
+        autoload :TypeDefinition,    'solargraph/language_server/message/text_document/type_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

@@ -1,35 +1,41 @@
 # 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
+module Solargraph
+  module LanguageServer
+    module Message
+      module 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
+          private
 
-    # @return [void]
-    def register_from_options
-      Solargraph.logger.debug "Registering capabilities from options: #{host.options.inspect}"
-      # @type [Array<String>]
-      y = []
-      # @type [Array<String>]
-      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['typeDefinitions'] ? y : n).push('textDocument/typeDefinition')
-      (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
+          # @return [void]
+          def register_from_options
+            Solargraph.logger.debug "Registering capabilities from options: #{host.options.inspect}"
+            # @type [Array<String>]
+            y = []
+            # @type [Array<String>]
+            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['typeDefinitions'] ? y : n).push('textDocument/typeDefinition')
+            (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
     end
   end
 end

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

@@ -1,40 +1,48 @@
 # frozen_string_literal: true
 
-module Solargraph::LanguageServer::Message::Workspace
-  class DidChangeWatchedFiles < Solargraph::LanguageServer::Message::Base
-    CREATED = 1
-    CHANGED = 2
-    DELETED = 3
+module Solargraph
+  module LanguageServer
+    module Message
+      module Workspace
+        class DidChangeWatchedFiles < Solargraph::LanguageServer::Message::Base
+          CREATED = 1
+          CHANGED = 2
+          DELETED = 3
 
-    include Solargraph::LanguageServer::UriHelpers
+          include Solargraph::LanguageServer::UriHelpers
 
-    def process
-      need_catalog = false
-      to_create = []
-      to_delete = []
+          def process
+            need_catalog = false
+            to_create = []
+            to_delete = []
 
-      # @param change [Hash]
-      params['changes'].each do |change|
-        if change['type'] == CREATED
-          to_create << change['uri']
-          need_catalog = true
-        elsif change['type'] == CHANGED
-          next if host.open?(change['uri'])
-          to_create << change['uri']
-          need_catalog = true
-        elsif change['type'] == DELETED
-          to_delete << change['uri']
-          need_catalog = true
-        else
-          set_error Solargraph::LanguageServer::ErrorCodes::INVALID_PARAMS, "Unknown change type ##{change['type']} for #{uri_to_file(change['uri'])}"
-        end
-      end
+            # @param change [Hash]
+            params['changes'].each do |change|
+              case change['type']
+              when CREATED
+                to_create << change['uri']
+                need_catalog = true
+              when CHANGED
+                next if host.open?(change['uri'])
+                to_create << change['uri']
+                need_catalog = true
+              when DELETED
+                to_delete << change['uri']
+                need_catalog = true
+              else
+                set_error Solargraph::LanguageServer::ErrorCodes::INVALID_PARAMS,
+                          "Unknown change type ##{change['type']} for #{uri_to_file(change['uri'])}"
+              end
+            end
 
-      host.create *to_create
-      host.delete *to_delete
+            host.create(*to_create)
+            host.delete(*to_delete)
 
-      # Force host to catalog libraries after file changes (see castwide/solargraph#139)
-      host.catalog if need_catalog
+            # Force host to catalog libraries after file changes (see castwide/solargraph#139)
+            host.catalog if need_catalog
+          end
+        end
+      end
     end
   end
 end

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

@@ -1,25 +1,31 @@
 # frozen_string_literal: true
 
-module Solargraph::LanguageServer::Message::Workspace
-  class DidChangeWorkspaceFolders < Solargraph::LanguageServer::Message::Base
-    def process
-      add_folders
-      remove_folders
-    end
+module Solargraph
+  module LanguageServer
+    module Message
+      module Workspace
+        class DidChangeWorkspaceFolders < Solargraph::LanguageServer::Message::Base
+          def process
+            add_folders
+            remove_folders
+          end
 
-    private
+          private
 
-    # @return [void]
-    def add_folders
-      return unless params['event'] && params['event']['added']
-      host.prepare_folders params['event']['added']
-    end
+          # @return [void]
+          def add_folders
+            return unless params['event'] && params['event']['added']
+            host.prepare_folders params['event']['added']
+          end
 
-    # @return [void]
-    def remove_folders
-      return unless params['event'] && params['event']['removed']
-      params['event']['removed'].each do |folder|
-        host.remove_folders params['event']['removed']
+          # @return [void]
+          def remove_folders
+            return unless params['event'] && params['event']['removed']
+            params['event']['removed'].each do |_folder|
+              host.remove_folders params['event']['removed']
+            end
+          end
+        end
       end
     end
   end

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

@@ -1,23 +1,33 @@
 # frozen_string_literal: true
 
-class Solargraph::LanguageServer::Message::Workspace::WorkspaceSymbol < Solargraph::LanguageServer::Message::Base
-  include Solargraph::LanguageServer::UriHelpers
+module Solargraph
+  module LanguageServer
+    module Message
+      module Workspace
+        class WorkspaceSymbol < Solargraph::LanguageServer::Message::Base
+          include Solargraph::LanguageServer::UriHelpers
 
-  def process
-    pins = host.query_symbols(params['query'])
-    info = pins.map do |pin|
-      uri = file_to_uri(pin.best_location.filename)
-      {
-        name: pin.path,
-        containerName: pin.namespace,
-        kind: pin.symbol_kind,
-        location: {
-          uri: uri,
-          range: pin.best_location.range.to_hash
-        },
-        deprecated: pin.deprecated?
-      }
+          def process
+            pins = host.query_symbols(params['query'])
+            info = pins.map do |pin|
+              # @sg-ignore Need to add nil check here
+              uri = file_to_uri(pin.best_location.filename)
+              {
+                name: pin.path,
+                containerName: pin.namespace,
+                kind: pin.symbol_kind,
+                location: {
+                  uri: uri,
+                  # @sg-ignore Need to add nil check here
+                  range: pin.best_location.range.to_hash
+                },
+                deprecated: pin.deprecated?
+              }
+            end
+            set_result info
+          end
+        end
+      end
     end
-    set_result info
   end
 end

data/lib/solargraph/language_server/message.rb

@@ -38,7 +38,7 @@ module Solargraph
         # @param path [String]
         # @return [Class<Solargraph::LanguageServer::Message::Base>]
         def select path
-          if method_map.has_key?(path)
+          if method_map.key?(path)
             method_map[path]
           elsif path.start_with?('$/')
             MethodNotImplemented

data/lib/solargraph/language_server/progress.rb

@@ -1,143 +1,143 @@
-# frozen_string_literal: true
-
-require 'securerandom'
-
-module Solargraph
-  module LanguageServer
-    # Progress notification handling for language server hosts.
-    #
-    class Progress
-      WAITING = :waiting
-      CREATED = :created
-      FINISHED = :finished
-
-      # @return [String]
-      attr_reader :uuid
-
-      # @return [String]
-      attr_reader :title
-
-      # @return [String, nil]
-      attr_reader :kind
-
-      # @return [String, nil]
-      attr_reader :message
-
-      # @return [Integer]
-      attr_reader :percentage
-
-      # @return [Symbol]
-      attr_reader :status
-
-      # @param title [String]
-      def initialize title
-        @title = title
-        @uuid = SecureRandom.uuid
-        @percentage = 0
-        @status = WAITING
-      end
-
-      # @param message [String]
-      # @param percentage [Integer]
-      # @return [void]
-      def begin message, percentage
-        @kind = 'begin'
-        @message = message
-        @percentage = percentage
-      end
-
-      # @param message [String]
-      # @param percentage [Integer]
-      # @return [void]
-      def report message, percentage
-        @kind = 'report'
-        @message = message
-        @percentage = percentage
-      end
-
-      # @param message [String]
-      # @return [void]
-      def finish message
-        @kind = 'end'
-        @message = message
-        @percentage = 100
-        true
-      end
-
-      # @param host [Solargraph::LanguageServer::Host]
-      # @return [void]
-      def send host
-        return unless host.client_supports_progress? && !finished?
-
-        message = build
-        create(host)
-        host.send_notification '$/progress', message
-        @status = FINISHED if kind == 'end'
-        keep_alive host
-      end
-
-      def created?
-        [CREATED, FINISHED].include?(status)
-      end
-
-      def finished?
-        status == FINISHED
-      end
-
-      private
-
-      # @param host [Solargraph::LanguageServer::Host]
-      # @return [void]
-      def create host
-        return if created?
-
-        host.send_request 'window/workDoneProgress/create', { token: uuid }
-        @status = CREATED
-      end
-
-      # @return [Hash]
-      def build
-        {
-          token: uuid,
-          value: {
-            kind: kind,
-            cancellable: false
-          }.merge(build_value)
-        }
-      end
-
-      # @return [Hash]
-      def build_value
-        case kind
-        when 'begin'
-          { title: title, message: message, percentage: percentage }
-        when 'report'
-          { message: message, percentage: percentage }
-        when 'end'
-          { message: message }
-        else
-          raise "Invalid progress kind #{kind}"
-        end
-      end
-
-      # @param host [Host]
-      # @return [void]
-      def keep_alive host
-        mutex.synchronize { @last = Time.now }
-        @keep_alive ||= Thread.new do
-          until finished?
-            sleep 10
-            break if finished?
-            next if mutex.synchronize { Time.now - @last < 10 }
-            send host
-          end
-        end
-      end
-
-      # @return [Thread::Mutex]
-      def mutex
-        @mutex ||= Mutex.new
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'securerandom'
+
+module Solargraph
+  module LanguageServer
+    # Progress notification handling for language server hosts.
+    #
+    class Progress
+      WAITING = :waiting
+      CREATED = :created
+      FINISHED = :finished
+
+      # @return [String]
+      attr_reader :uuid
+
+      # @return [String]
+      attr_reader :title
+
+      # @return [String, nil]
+      attr_reader :kind
+
+      # @return [String, nil]
+      attr_reader :message
+
+      # @return [Integer]
+      attr_reader :percentage
+
+      # @return [Symbol]
+      attr_reader :status
+
+      # @param title [String]
+      def initialize title
+        @title = title
+        @uuid = SecureRandom.uuid
+        @percentage = 0
+        @status = WAITING
+      end
+
+      # @param message [String]
+      # @param percentage [Integer]
+      # @return [void]
+      def begin message, percentage
+        @kind = 'begin'
+        @message = message
+        @percentage = percentage
+      end
+
+      # @param message [String]
+      # @param percentage [Integer]
+      # @return [void]
+      def report message, percentage
+        @kind = 'report'
+        @message = message
+        @percentage = percentage
+      end
+
+      # @param message [String]
+      # @return [void]
+      def finish message
+        @kind = 'end'
+        @message = message
+        @percentage = 100
+        true
+      end
+
+      # @param host [Solargraph::LanguageServer::Host]
+      # @return [void]
+      def send host
+        return unless host.client_supports_progress? && !finished?
+
+        message = build
+        create(host)
+        host.send_notification '$/progress', message
+        @status = FINISHED if kind == 'end'
+        keep_alive host
+      end
+
+      def created?
+        [CREATED, FINISHED].include?(status)
+      end
+
+      def finished?
+        status == FINISHED
+      end
+
+      private
+
+      # @param host [Solargraph::LanguageServer::Host]
+      # @return [void]
+      def create host
+        return if created?
+
+        host.send_request 'window/workDoneProgress/create', { token: uuid }
+        @status = CREATED
+      end
+
+      # @return [Hash]
+      def build
+        {
+          token: uuid,
+          value: {
+            kind: kind,
+            cancellable: false
+          }.merge(build_value)
+        }
+      end
+
+      # @return [Hash]
+      def build_value
+        case kind
+        when 'begin'
+          { title: title, message: message, percentage: percentage }
+        when 'report'
+          { message: message, percentage: percentage }
+        when 'end'
+          { message: message }
+        else
+          raise "Invalid progress kind #{kind}"
+        end
+      end
+
+      # @param host [Host]
+      # @return [void]
+      def keep_alive host
+        mutex.synchronize { @last = Time.now }
+        @keep_alive ||= Thread.new do
+          until finished?
+            sleep 10
+            break if finished?
+            next if mutex.synchronize { Time.now - @last < 10 }
+            send host
+          end
+        end
+      end
+
+      # @return [Thread::Mutex]
+      def mutex
+        @mutex ||= Mutex.new
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/request.rb

@@ -4,18 +4,20 @@ module Solargraph
   module LanguageServer
     class Request
       # @param id [Integer]
-      # @param &block The block that processes the client's response
+      # @param block [Proc] The block that processes the client's response
       def initialize id, &block
         @id = id
         @block = block
       end
 
+      # @sg-ignore Solargraph::LanguageServer::Request#process return
+      #   type could not be inferred
       # @param result [Object]
       # @generic T
       # @yieldreturn [generic<T>]
       # @return [generic<T>, nil]
       def process result
-        @block.call(result) unless @block.nil?
+        @block&.call(result)
       end
 
       # @return [void]