solargraph 0.46.0 → 0.54.5

data/lib/solargraph/language_server/progress.rb

@@ -0,0 +1,135 @@
+# 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]
+      def begin message, percentage
+        @kind = 'begin'
+        @message = message
+        @percentage = percentage
+      end
+
+      # @param message [String]
+      # @param percentage [Integer]
+      def report message, percentage
+        @kind = 'report'
+        @message = message
+        @percentage = percentage
+      end
+
+      # @param message [String]
+      def finish message
+        @kind = 'end'
+        @message = message
+        @percentage = 100
+        true
+      end
+
+      # @param host [Solargraph::LanguageServer::Host]
+      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
+
+      def build
+        {
+          token: uuid,
+          value: {
+            kind: kind,
+            cancellable: false
+          }.merge(build_value)
+        }
+      end
+
+      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]
+      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
+
+      def mutex
+        @mutex ||= Mutex.new
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/request.rb

@@ -1,24 +1,24 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    class Request
-      # @param id [Integer]
-      # @param &block The block that processes the client's response
-      def initialize id, &block
-        @id = id
-        @block = block
-      end
-
-      # @param result [Object]
-      # @return [void]
-      def process result
-        @block.call(result) unless @block.nil?
-      end
-
-      def send_response
-        # noop
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    class Request
+      # @param id [Integer]
+      # @param &block The block that processes the client's response
+      def initialize id, &block
+        @id = id
+        @block = block
+      end
+
+      # @param result [Object]
+      # @return [void]
+      def process result
+        @block.call(result) unless @block.nil?
+      end
+
+      def send_response
+        # noop
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/symbol_kinds.rb

@@ -1,36 +1,36 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    # The SymbolKind constants for the language server protocol.
-    #
-    module SymbolKinds
-      FILE = 1
-      MODULE = 2
-      NAMESPACE = 3
-      PACKAGE = 4
-      CLASS = 5
-      METHOD = 6
-      PROPERTY = 7
-      FIELD = 8
-      CONSTRUCTOR = 9
-      ENUM = 10
-      INTERFACE = 11
-      FUNCTION = 12
-      VARIABLE = 13
-      CONSTANT = 14
-      STRING = 15
-      NUMBER = 16
-      BOOLEAN = 17
-      ARRAY = 18
-      OBJECT = 19
-      KEY = 20
-      NULL = 21
-      ENUM_MEMBER = 22
-      STRUCT = 23
-      EVENT = 24
-      OPERATOR = 25
-      TYPE_PARAMETER = 26
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    # The SymbolKind constants for the language server protocol.
+    #
+    module SymbolKinds
+      FILE = 1
+      MODULE = 2
+      NAMESPACE = 3
+      PACKAGE = 4
+      CLASS = 5
+      METHOD = 6
+      PROPERTY = 7
+      FIELD = 8
+      CONSTRUCTOR = 9
+      ENUM = 10
+      INTERFACE = 11
+      FUNCTION = 12
+      VARIABLE = 13
+      CONSTANT = 14
+      STRING = 15
+      NUMBER = 16
+      BOOLEAN = 17
+      ARRAY = 18
+      OBJECT = 19
+      KEY = 20
+      NULL = 21
+      ENUM_MEMBER = 22
+      STRUCT = 23
+      EVENT = 24
+      OPERATOR = 25
+      TYPE_PARAMETER = 26
+    end
+  end
+end

data/lib/solargraph/language_server/transport/adapter.rb

@@ -1,53 +1,68 @@
-# frozen_string_literal: true
-
-require 'backport'
-
-module Solargraph
-  module LanguageServer
-    module Transport
-      # A common module for running language servers in Backport.
-      #
-      module Adapter
-        def opening
-          @host = Solargraph::LanguageServer::Host.new
-          @host.add_observer self
-          @host.start
-          @data_reader = Solargraph::LanguageServer::Transport::DataReader.new
-          @data_reader.set_message_handler do |message|
-            process message
-          end
-        end
-
-        def closing
-          @host.stop
-        end
-
-        # @param data [String]
-        def receiving data
-          @data_reader.receive data
-        end
-
-        def update
-          if @host.stopped?
-            shutdown
-          else
-            tmp = @host.flush
-            write tmp unless tmp.empty?
-          end
-        end
-
-        private
-
-        # @param request [String]
-        # @return [void]
-        def process request
-          @host.process(request)
-        end
-
-        def shutdown
-          Backport.stop unless @host.options['transport'] == 'external'
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'backport'
+
+module Solargraph
+  module LanguageServer
+    module Transport
+      # A common module for running language servers in Backport.
+      #
+      module Adapter
+        # This runs in the context of Backport::Adapter, which
+        # provides write() - but if we didn't hide this behind a parse
+        # tag, it would override the one in the class.
+        #
+        # @!method write(text)
+        #   @abstract
+        #   Write the change to the specified text.
+        #   @param text [String] The text to be changed.
+        #   @return [String] The updated text.
+
+        # @return [void]
+        def opening
+          @host = Solargraph::LanguageServer::Host.new
+          @host.add_observer self
+          @host.start
+          @data_reader = Solargraph::LanguageServer::Transport::DataReader.new
+          @data_reader.set_message_handler do |message|
+            process message
+          end
+        end
+
+        # @return [void]
+        def closing
+          @host.stop
+        end
+
+        # @param data [String]
+        # @return [void]
+        def receiving data
+          @data_reader.receive data
+        end
+
+        # @return [void]
+        def update
+          if @host.stopped?
+            shutdown
+          else
+            tmp = @host.flush
+            write tmp unless tmp.empty?
+          end
+        end
+
+        private
+
+        # @param request [Hash]
+        # @return [void]
+        def process request
+          @host.process(request)
+        end
+
+        # @return [void]
+        def shutdown
+          Backport.stop unless @host.options['transport'] == 'external'
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/transport/data_reader.rb

@@ -1,72 +1,74 @@
-# frozen_string_literal: true
-
-require 'json'
-
-module Solargraph
-  module LanguageServer
-    module Transport
-      class DataReader
-        def initialize
-          @in_header = true
-          @content_length = 0
-          @buffer = String.new
-        end
-
-        # Declare a block to be executed for each message received from the
-        # client.
-        #
-        # @yieldparam [Hash] The message received from the client
-        def set_message_handler &block
-          @message_handler = block
-        end
-
-        # Process raw data received from the client. The data will be parsed
-        # into messages based on the JSON-RPC protocol. Each message will be
-        # passed to the block declared via set_message_handler. Incomplete data
-        # will be buffered and subsequent data will be appended to the buffer.
-        #
-        # @param data [String]
-        def receive data
-          data.each_char do |char|
-            @buffer.concat char
-            if @in_header
-              prepare_to_parse_message if @buffer.end_with?("\r\n\r\n")
-            else
-              parse_message_from_buffer if @buffer.bytesize == @content_length
-            end
-          end
-        end
-
-        private
-
-        # @return [void]
-        def prepare_to_parse_message
-          @in_header = false
-          @buffer.each_line do |line|
-            parts = line.split(':').map(&:strip)
-            if parts[0] == 'Content-Length'
-              @content_length = parts[1].to_i
-              break
-            end
-          end
-          @buffer.clear
-        end
-
-        # @return [void]
-        def parse_message_from_buffer
-          begin
-            msg = JSON.parse(@buffer)
-            @message_handler.call msg unless @message_handler.nil?
-          rescue JSON::ParserError => e
-            Solargraph::Logging.logger.warn "Failed to parse request: #{e.message}"
-            Solargraph::Logging.logger.debug "Buffer: #{@buffer}"
-          ensure
-            @buffer.clear
-            @in_header = true
-            @content_length = 0
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'json'
+
+module Solargraph
+  module LanguageServer
+    module Transport
+      class DataReader
+        def initialize
+          @in_header = true
+          @content_length = 0
+          @buffer = String.new
+        end
+
+        # Declare a block to be executed for each message received from the
+        # client.
+        #
+        # @yieldparam [Hash] The message received from the client
+        # @return [void]
+        def set_message_handler &block
+          @message_handler = block
+        end
+
+        # Process raw data received from the client. The data will be parsed
+        # into messages based on the JSON-RPC protocol. Each message will be
+        # passed to the block declared via set_message_handler. Incomplete data
+        # will be buffered and subsequent data will be appended to the buffer.
+        #
+        # @param data [String]
+        # @return [void]
+        def receive data
+          data.each_char do |char|
+            @buffer.concat char
+            if @in_header
+              prepare_to_parse_message if @buffer.end_with?("\r\n\r\n")
+            else
+              parse_message_from_buffer if @buffer.bytesize == @content_length
+            end
+          end
+        end
+
+        private
+
+        # @return [void]
+        def prepare_to_parse_message
+          @in_header = false
+          @buffer.each_line do |line|
+            parts = line.split(':').map(&:strip)
+            if parts[0] == 'Content-Length'
+              @content_length = parts[1].to_i
+              break
+            end
+          end
+          @buffer.clear
+        end
+
+        # @return [void]
+        def parse_message_from_buffer
+          begin
+            msg = JSON.parse(@buffer)
+            @message_handler.call msg unless @message_handler.nil?
+          rescue JSON::ParserError => e
+            Solargraph::Logging.logger.warn "Failed to parse request: #{e.message}"
+            Solargraph::Logging.logger.debug "Buffer: #{@buffer}"
+          ensure
+            @buffer.clear
+            @in_header = true
+            @content_length = 0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/transport.rb

@@ -1,13 +1,13 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    # The Transport namespace contains concrete implementations of
-    # communication protocols for language servers.
-    #
-    module Transport
-      autoload :Adapter,    'solargraph/language_server/transport/adapter'
-      autoload :DataReader, 'solargraph/language_server/transport/data_reader'
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    # The Transport namespace contains concrete implementations of
+    # communication protocols for language servers.
+    #
+    module Transport
+      autoload :Adapter,    'solargraph/language_server/transport/adapter'
+      autoload :DataReader, 'solargraph/language_server/transport/data_reader'
+    end
+  end
+end

data/lib/solargraph/language_server/uri_helpers.rb

@@ -1,49 +1,49 @@
-# frozen_string_literal: true
-
-require 'cgi'
-
-module Solargraph
-  module LanguageServer
-    # Methods to handle conversions between file URIs and paths.
-    #
-    module UriHelpers
-      module_function
-
-      # Convert a file URI to a path.
-      #
-      # @param uri [String]
-      # @return [String]
-      def uri_to_file uri
-        decode(uri).sub(/^file\:(?:\/\/)?/, '').sub(/^\/([a-z]\:)/i, '\1')
-      end
-
-      # Convert a file path to a URI.
-      #
-      # @param file [String]
-      # @return [String]
-      def file_to_uri file
-        "file://#{encode(file.gsub(/^([a-z]\:)/i, '/\1'))}"
-      end
-
-      # Encode text to be used as a URI path component in LSP.
-      #
-      # @param text [String]
-      # @return [String]
-      def encode text
-        CGI.escape(text)
-           .gsub('%3A', ':')
-           .gsub('%5C', '\\')
-           .gsub('%2F', '/')
-           .gsub('+', '%20')
-      end
-
-      # Decode text from a URI path component in LSP.
-      #
-      # @param text [String]
-      # @return [String]
-      def decode text
-        CGI.unescape(text)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'cgi'
+
+module Solargraph
+  module LanguageServer
+    # Methods to handle conversions between file URIs and paths.
+    #
+    module UriHelpers
+      module_function
+
+      # Convert a file URI to a path.
+      #
+      # @param uri [String]
+      # @return [String]
+      def uri_to_file uri
+        decode(uri).sub(/^file\:(?:\/\/)?/, '').sub(/^\/([a-z]\:)/i, '\1')
+      end
+
+      # Convert a file path to a URI.
+      #
+      # @param file [String]
+      # @return [String]
+      def file_to_uri file
+        "file://#{encode(file.gsub(/^([a-z]\:)/i, '/\1'))}"
+      end
+
+      # Encode text to be used as a URI path component in LSP.
+      #
+      # @param text [String]
+      # @return [String]
+      def encode text
+        CGI.escape(text)
+           .gsub('%3A', ':')
+           .gsub('%5C', '\\')
+           .gsub('%2F', '/')
+           .gsub('+', '%20')
+      end
+
+      # Decode text from a URI path component in LSP.
+      #
+      # @param text [String]
+      # @return [String]
+      def decode text
+        CGI.unescape(text)
+      end
+    end
+  end
+end