solargraph 0.58.3 → 0.59.0.dev.1

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

@@ -1,89 +1,89 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    class Host
-      # An asynchronous diagnosis reporter.
-      #
-      class Diagnoser
-        # @param host [Host]
-        def initialize host
-          @host = host
-          @mutex = Mutex.new
-          @queue = []
-          @stopped = true
-        end
-
-        # Schedule a file to be diagnosed.
-        #
-        # @param uri [String]
-        # @return [void]
-        def schedule uri
-          mutex.synchronize { queue.push uri }
-        end
-
-        # Stop the diagnosis thread.
-        #
-        # @return [void]
-        def stop
-          @stopped = true
-        end
-
-        # True is the diagnoser is stopped.
-        #
-        # @return [Boolean]
-        def stopped?
-          @stopped
-        end
-
-        # Start the diagnosis thread.
-        #
-        # @return [self, nil]
-        def start
-          return unless @stopped
-          @stopped = false
-          Thread.new do
-            until stopped?
-              tick
-              sleep 0.1
-            end
-          end
-          self
-        end
-
-        # Perform diagnoses.
-        #
-        # @return [void]
-        def tick
-          return if queue.empty? || host.synchronizing?
-          if !host.options['diagnostics']
-            mutex.synchronize { queue.clear }
-            return
-          end
-          current = mutex.synchronize { queue.shift }
-          return if queue.include?(current)
-          begin
-            host.diagnose current
-          rescue InvalidOffsetError
-            # @todo This error can occur when the Source is out of sync with
-            #   with the ApiMap. It's probably not the best way to handle it,
-            #   but it's quick and easy.
-            Logging.logger.warn "Deferring diagnosis due to invalid offset: #{current}"
-            mutex.synchronize { queue.push current }
-          end
-        end
-
-        private
-
-        # @return [Host]
-        attr_reader :host
-
-        # @return [Mutex]
-        attr_reader :mutex
-
-        # @return [::Array]
-        attr_reader :queue
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    class Host
+      # An asynchronous diagnosis reporter.
+      #
+      class Diagnoser
+        # @param host [Host]
+        def initialize host
+          @host = host
+          @mutex = Mutex.new
+          @queue = []
+          @stopped = true
+        end
+
+        # Schedule a file to be diagnosed.
+        #
+        # @param uri [String]
+        # @return [void]
+        def schedule uri
+          mutex.synchronize { queue.push uri }
+        end
+
+        # Stop the diagnosis thread.
+        #
+        # @return [void]
+        def stop
+          @stopped = true
+        end
+
+        # True is the diagnoser is stopped.
+        #
+        # @return [Boolean]
+        def stopped?
+          @stopped
+        end
+
+        # Start the diagnosis thread.
+        #
+        # @return [self, nil]
+        def start
+          return unless @stopped
+          @stopped = false
+          Thread.new do
+            until stopped?
+              tick
+              sleep 0.1
+            end
+          end
+          self
+        end
+
+        # Perform diagnoses.
+        #
+        # @return [void]
+        def tick
+          return if queue.empty? || host.synchronizing?
+          if !host.options['diagnostics']
+            mutex.synchronize { queue.clear }
+            return
+          end
+          current = mutex.synchronize { queue.shift }
+          return if queue.include?(current)
+          begin
+            host.diagnose current
+          rescue InvalidOffsetError
+            # @todo This error can occur when the Source is out of sync with
+            #   with the ApiMap. It's probably not the best way to handle it,
+            #   but it's quick and easy.
+            Logging.logger.warn "Deferring diagnosis due to invalid offset: #{current}"
+            mutex.synchronize { queue.push current }
+          end
+        end
+
+        private
+
+        # @return [Host]
+        attr_reader :host
+
+        # @return [Mutex]
+        attr_reader :mutex
+
+        # @return [::Array]
+        attr_reader :queue
+      end
+    end
+  end
+end

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

@@ -33,6 +33,7 @@ module Solargraph
         # @return [void]
         def update_libraries uri
           src = sources.find(uri)
+          # @sg-ignore Need to add nil check here
           using = libraries.select { |lib| lib.contain?(src.filename) }
           using.push library_for(uri) if using.empty?
           using.each { |lib| lib.merge src }

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

@@ -28,7 +28,7 @@ module Solargraph
         end
 
         # pending handle messages
-        # @return [Array<Hash>]
+        # @return [Array<Hash{String => undefined}>]
         def messages
           @messages ||= []
         end
@@ -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

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

@@ -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
@@ -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
 
@@ -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
 
@@ -765,7 +771,6 @@ module Solargraph
         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
         # @type [Diff::LCS::Change]
         diff = diffs.first.first
         return change unless diff.adding? && ['.', ':', '(', ',', ' '].include?(diff.element)

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

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

@@ -1,15 +1,15 @@
-# 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,60 @@
-# 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_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

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

@@ -1,12 +1,6 @@
 # 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
@@ -64,6 +58,7 @@ 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({
@@ -78,12 +73,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