solargraph 0.54.4 → 0.58.2

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

@@ -16,7 +16,7 @@ module Solargraph
         # @return [String]
         attr_reader :method
 
-        # @return [Hash{String => Array<undefined>, Hash{String => undefined}, String, Integer}]
+        # @return [Hash{String => undefined}]
         attr_reader :params
 
         # @return [Hash, Array, nil]
@@ -79,6 +79,7 @@ module Solargraph
 
         private
 
+        # @return [void]
         def accept_or_cancel
           if host.cancel?(id)
             # https://microsoft.github.io/language-server-protocol/specifications/specification-current/#cancelRequest

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

@@ -1,112 +1,114 @@
-# 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
-                  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
+
+
+# @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

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

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

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

@@ -11,9 +11,9 @@ module Solargraph
         #
         class DocumentGems < Base
           def process
-            cmd = "yard gems"
-            cmd += " --rebuild" if params['rebuild']
-            o, s = Open3.capture2(cmd)
+            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
               set_result({

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

@@ -1,56 +1,56 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    module Message
-      module TextDocument
-        class Completion < Base
-          def process
-            return set_error(ErrorCodes::REQUEST_CANCELLED, "cancelled by so many request") if host.has_pending_completions?
-
-            line = params['position']['line']
-            col = params['position']['character']
-            begin
-              completion = host.completions_at(params['textDocument']['uri'], line, col)
-              items = []
-              last_context = nil
-              idx = -1
-              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}"
-                })
-                items.last[:data][:uri] = params['textDocument']['uri']
-                last_context = pin.context
-              end
-              set_result(
-                isIncomplete: false,
-                items: items
-              )
-            rescue InvalidOffsetError => e
-              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}"
-            Logging.logger.warn e.backtrace.join("\n")
-            set_result empty_result
-          end
-
-          # @param incomplete [Boolean]
-          # @return [Hash]
-          def empty_result incomplete = false
-            {
-              isIncomplete: incomplete,
-              items: []
-            }
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class Completion < Base
+          def process
+            return set_error(ErrorCodes::REQUEST_CANCELLED, "cancelled by so many request") if host.has_pending_completions?
+
+            line = params['position']['line']
+            col = params['position']['character']
+            begin
+              completion = host.completions_at(params['textDocument']['uri'], line, col)
+              items = []
+              last_context = nil
+              idx = -1
+              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}"
+                })
+                items.last[:data][:uri] = params['textDocument']['uri']
+                last_context = pin.context
+              end
+              set_result(
+                isIncomplete: false,
+                items: items
+              )
+            rescue InvalidOffsetError => e
+              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}"
+            Logging.logger.warn e.backtrace.join("\n")
+            set_result empty_result
+          end
+
+          # @param incomplete [Boolean]
+          # @return [Hash]
+          def empty_result incomplete = false
+            {
+              isIncomplete: incomplete,
+              items: []
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,38 +1,40 @@
-# 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
-
-    private
-
-    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
-
-    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
+# 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
+
+    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 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

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

@@ -1,26 +1,26 @@
-# frozen_string_literal: true
-
-class Solargraph::LanguageServer::Message::TextDocument::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
-
-      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
-
-    set_result info
-  end
-end
+# frozen_string_literal: true
+
+class Solargraph::LanguageServer::Message::TextDocument::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
+
+      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
+
+    set_result info
+  end
+end