solargraph 0.58.0 → 0.59.0

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

@@ -1,97 +1,97 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    module Message
-      class Base
-        # @return [Solargraph::LanguageServer::Host]
-        attr_reader :host
-
-        # @return [Integer]
-        attr_reader :id
-
-        # @return [Hash]
-        attr_reader :request
-
-        # @return [String]
-        attr_reader :method
-
-        # @return [Hash{String => undefined}]
-        attr_reader :params
-
-        # @return [Hash, Array, nil]
-        attr_reader :result
-
-        # @return [Hash, nil]
-        attr_reader :error
-
-        # @param host [Solargraph::LanguageServer::Host]
-        # @param request [Hash]
-        def initialize host, request
-          @host = host
-          @id = request['id'].freeze
-          @request = request.freeze
-          @method = request['method'].freeze
-          @params = (request['params'] || {}).freeze
-          post_initialize
-        end
-
-        # @return [void]
-        def post_initialize; end
-
-        # @return [void]
-        def process; end
-
-        # @param data [Hash, Array, nil]
-        # @return [void]
-        def set_result data
-          @result = data
-        end
-
-        # @param code [Integer] See Solargraph::LanguageServer::ErrorCodes
-        # @param message [String]
-        # @return [void]
-        def set_error code, message
-          @error = {
-            code: code,
-            message: message
-          }
-        end
-
-        # @return [void]
-        def send_response
-          return if id.nil?
-
-          accept_or_cancel
-          response = {
-            jsonrpc: '2.0',
-            id: id
-          }
-          response[:result] = result unless result.nil?
-          response[:error] = error unless error.nil?
-          response[:result] = nil if result.nil? and error.nil?
-          json = response.to_json
-          envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
-          Solargraph.logger.debug envelope
-          host.queue envelope
-          host.clear id
-        end
-
-        private
-
-        # @return [void]
-        def accept_or_cancel
-          if host.cancel?(id)
-            # https://microsoft.github.io/language-server-protocol/specifications/specification-current/#cancelRequest
-            # cancel should send response RequestCancelled
-            Solargraph::Logging.logger.info "Cancelled response to ##{id} #{method}"
-            set_result nil
-            set_error ErrorCodes::REQUEST_CANCELLED, 'Cancelled by client'
-          else
-            Solargraph::Logging.logger.info "Sending response to ##{id} #{method}"
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      class Base
+        # @return [Solargraph::LanguageServer::Host]
+        attr_reader :host
+
+        # @return [Integer]
+        attr_reader :id
+
+        # @return [Hash]
+        attr_reader :request
+
+        # @return [String]
+        attr_reader :method
+
+        # @return [Hash{String => undefined}]
+        attr_reader :params
+
+        # @return [Hash, Array, nil]
+        attr_reader :result
+
+        # @return [Hash, nil]
+        attr_reader :error
+
+        # @param host [Solargraph::LanguageServer::Host]
+        # @param request [Hash]
+        def initialize host, request
+          @host = host
+          @id = request['id'].freeze
+          @request = request.freeze
+          @method = request['method'].freeze
+          @params = (request['params'] || {}).freeze
+          post_initialize
+        end
+
+        # @return [void]
+        def post_initialize; end
+
+        # @return [void]
+        def process; end
+
+        # @param data [Hash, Array, nil]
+        # @return [void]
+        def set_result data
+          @result = data
+        end
+
+        # @param code [Integer] See Solargraph::LanguageServer::ErrorCodes
+        # @param message [String]
+        # @return [void]
+        def set_error code, message
+          @error = {
+            code: code,
+            message: message
+          }
+        end
+
+        # @return [void]
+        def send_response
+          return if id.nil?
+
+          accept_or_cancel
+          response = {
+            jsonrpc: '2.0',
+            id: id
+          }
+          response[:result] = result unless result.nil?
+          response[:error] = error unless 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
+          host.queue envelope
+          host.clear id
+        end
+
+        private
+
+        # @return [void]
+        def accept_or_cancel
+          if host.cancel?(id)
+            # https://microsoft.github.io/language-server-protocol/specifications/specification-current/#cancelRequest
+            # cancel should send response RequestCancelled
+            Solargraph::Logging.logger.info "Cancelled response to ##{id} #{method}"
+            set_result nil
+            set_error ErrorCodes::REQUEST_CANCELLED, 'Cancelled by client'
+          else
+            Solargraph::Logging.logger.info "Sending response to ##{id} #{method}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,15 +1,13 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    module Message
-      module Client
-        class RegisterCapability < Solargraph::LanguageServer::Message::Base
-          def process
-            
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module Client
+        class RegisterCapability < Solargraph::LanguageServer::Message::Base
+          def process; end
+        end
+      end
+    end
+  end
+end

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

@@ -1,60 +1,58 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    module Message
-      module CompletionItem
-        # completionItem/resolve message handler
-        #
-        class Resolve < Base
-          def process
-            pins = host.locate_pins(params)
-            set_result merge(pins)
-          end
-
-          private
-
-          # @param pins [Array<Pin::Base>]
-          # @return [Hash]
-          def merge pins
-            return params if pins.empty?
-            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)))
-            result[:detail] = pins.first.detail
-            result
-          end
-
-          # @param text [String]
-          # @return [Hash{Symbol => String}, nil]
-          def markup_content text
-            return nil if text.strip.empty?
-            {
-              kind: 'markdown',
-              value: text
-            }
-          end
-
-          # @param pins [Array<Pin::Base>]
-          # @return [String]
-          def join_docs pins
-            result = []
-            last_link = nil
-            pins.each_with_index 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)
-              last_link = this_link
-            end
-            result.join("\n\n")
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module CompletionItem
+        # completionItem/resolve message handler
+        #
+        class Resolve < Base
+          def process
+            pins = host.locate_pins(params)
+            set_result merge(pins)
+          end
+
+          private
+
+          # @param pins [Array<Pin::Base>]
+          # @return [Hash]
+          def merge pins
+            return params if pins.empty?
+            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)))
+            result[:detail] = pins.first.detail
+            result
+          end
+
+          # @param text [String]
+          # @return [Hash{Symbol => String}, nil]
+          def markup_content text
+            return nil if text.strip.empty?
+            {
+              kind: 'markdown',
+              value: text
+            }
+          end
+
+          # @param pins [Array<Pin::Base>]
+          # @return [String]
+          def join_docs pins
+            result = []
+            last_link = nil
+            pins.each do |pin|
+              this_link = host.options['enablePages'] ? pin.link_documentation : pin.text_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")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,114 +1,108 @@
-# 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
-      module Extended
-        # Check if a more recent version of the Solargraph gem is available.
-        # Notify the client when an update exists. If the `verbose` parameter
-        # is true, notify the client when the gem is up to date.
-        #
-        class CheckGemVersion < Base
-          # @return [Gem::SpecFetcher]
-          def self.fetcher
-            @fetcher ||= Gem::SpecFetcher.new
-          end
-
-          # @param obj [Gem::SpecFetcher]
-          # @return [Gem::SpecFetcher]
-          def self.fetcher= obj
-            @fetcher = obj
-          end
-
-          GEM_ZERO = Gem::Version.new('0.0.0')
-
-          # @param host [Solargraph::LanguageServer::Host]
-          # @param request [Hash]
-          # @param current [Gem::Version]
-          # @param available [Gem::Version, nil]
-          def initialize host, request, current: Gem::Version.new(Solargraph::VERSION), available: nil
-            super(host, request)
-            @current = current
-            @available = available
-          end
-
-          def process
-            if available > GEM_ZERO
-              if available > current
-                host.show_message_request "Solargraph gem version #{available} is available. (Current version: #{current})",
-                                          LanguageServer::MessageTypes::INFO,
-                                          ['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)
-                                            if s == 0
-                                              host.show_message 'Successfully updated the Solargraph gem.', LanguageServer::MessageTypes::INFO
-                                              host.send_notification '$/solargraph/restart', {}
-                                            else
-                                              host.show_message 'An error occurred while updating the gem.', LanguageServer::MessageTypes::ERROR
-                                            end
-                                          end
-              elsif params['verbose']
-                host.show_message "The Solargraph gem is up to date (version #{Solargraph::VERSION})."
-              end
-            elsif fetched?
-              Solargraph::Logging.logger.warn error
-              host.show_message(error, MessageTypes::ERROR) if params['verbose']
-            end
-            set_result({
-              installed: current,
-              available: available
-            })
-          end
-
-          private
-
-          # @return [Gem::Version]
-          attr_reader :current
-
-          # @return [Gem::Version]
-          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?
-                    @error = 'An error occurred fetching the gem data'
-                    GEM_ZERO
-                  else
-                    tuple.version
-                  end
-                end
-              rescue Errno::EADDRNOTAVAIL => e
-                @error = "Unable to connect to gem source: #{e.message}"
-                GEM_ZERO
-              end
-            end
-            @available
-          end
-
-          def fetched?
-            @fetched ||= false
-          end
-
-          # @return [String, nil]
-          attr_reader :error
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module Extended
+        # Check if a more recent version of the Solargraph gem is available.
+        # Notify the client when an update exists. If the `verbose` parameter
+        # is true, notify the client when the gem is up to date.
+        #
+        class CheckGemVersion < Base
+          # @return [Gem::SpecFetcher]
+          def self.fetcher
+            @fetcher ||= Gem::SpecFetcher.new
+          end
+
+          # @param obj [Gem::SpecFetcher]
+          # @return [Gem::SpecFetcher]
+          class << self
+            attr_writer :fetcher
+          end
+
+          GEM_ZERO = Gem::Version.new('0.0.0')
+
+          # @param host [Solargraph::LanguageServer::Host]
+          # @param request [Hash]
+          # @param current [Gem::Version]
+          # @param available [Gem::Version, nil]
+          def initialize host, request, current: Gem::Version.new(Solargraph::VERSION), available: nil
+            super(host, request)
+            @current = current
+            @available = available
+          end
+
+          def process
+            if available > GEM_ZERO
+              if available > current
+                host.show_message_request "Solargraph gem version #{available} is available. (Current version: #{current})",
+                                          LanguageServer::MessageTypes::INFO,
+                                          ['Update now'] do |result|
+                                            next unless result == 'Update now'
+                                            cmd = if host.options['useBundler']
+                                                    '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', {}
+                                            else
+                                              host.show_message 'An error occurred while updating the gem.', LanguageServer::MessageTypes::ERROR
+                                            end
+                                          end
+              elsif params['verbose']
+                host.show_message "The Solargraph gem is up to date (version #{Solargraph::VERSION})."
+              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
+                       })
+          end
+
+          private
+
+          # @return [Gem::Version]
+          attr_reader :current
+
+          # @return [Gem::Version]
+          # @sg-ignore Need to add nil check here
+          def available
+            if !@available && !@fetched
+              @fetched = true
+              begin
+                @available ||= begin
+                  # @type [Gem::Dependency, nil]
+                  tuple = CheckGemVersion.fetcher.search_for_dependency(Gem::Dependency.new('solargraph')).flatten.first
+                  if tuple.nil?
+                    @error = 'An error occurred fetching the gem data'
+                    GEM_ZERO
+                  else
+                    tuple.version
+                  end
+                end
+              rescue Errno::EADDRNOTAVAIL => e
+                @error = "Unable to connect to gem source: #{e.message}"
+                GEM_ZERO
+              end
+            end
+            @available
+          end
+
+          def fetched?
+            @fetched ||= false
+          end
+
+          # @return [String, nil]
+          attr_reader :error
+        end
+      end
+    end
+  end
+end

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

@@ -1,23 +1,24 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    module Message
-      module Extended
-        class Document < Base
-          def process
-            api_map, pins = host.document(params['query'])
-            page = Solargraph::Page.new(host.options['viewsPath'])
-            content = page.render('document', layout: true, locals: { api_map: api_map, pins: pins })
-            set_result(
-              content: content
-            )
-          rescue StandardError => e
-            Solargraph.logger.warn "Error processing document: [#{e.class}] #{e.message}"
-            Solargraph.logger.debug e.backtrace.join("\n")
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module Extended
+        class Document < Base
+          def process
+            api_map, pins = host.document(params['query'])
+            page = Solargraph::Page.new(host.options['viewsPath'])
+            content = page.render('document', layout: true, locals: { api_map: api_map, pins: pins })
+            set_result(
+              content: content
+            )
+          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
+      end
+    end
+  end
+end