solargraph 0.17.4 → 0.18.0

data/lib/solargraph/api_map/completion.rb

@@ -0,0 +1,16 @@
+module Solargraph
+  class ApiMap
+    class Completion
+      # @return [Array<Solargraph::Pin::Base>]
+      attr_reader :pins
+
+      # @return [Solargraph::Source::Range]
+      attr_reader :range
+
+      def initialize pins, range
+        @pins = pins
+        @range = range
+      end
+    end
+  end
+end

data/lib/solargraph/api_map/source_to_yard.rb

@@ -13,7 +13,7 @@ module Solargraph
         code_object_map.keys
       end
 
-      # @param sources [Array<Solargraph::ApiMap::Source>] Sources for code objects
+      # @param sources [Array<Solargraph::Source>] Sources for code objects
       def rake_yard sources
         code_object_map.clear
         sources.each do |s|
@@ -28,7 +28,7 @@ module Solargraph
           end
           s.namespace_includes.each_pair do |n, i|
             i.each do |inc|
-              code_object_map[n].instance_mixins.push code_object_map[inc] unless code_object_map[inc].nil?
+              code_object_map[n].instance_mixins.push code_object_map[inc] unless code_object_map[inc].nil? or code_object_map[n].nil?
             end
           end
           s.attribute_pins.each do |pin|

data/lib/solargraph/language_server.rb

@@ -0,0 +1,12 @@
+require 'solargraph/language_server/error_codes'
+require 'solargraph/language_server/completion_item_kinds'
+require 'solargraph/language_server/symbol_kinds'
+
+module Solargraph
+  module LanguageServer
+    autoload :Host, 'solargraph/language_server/host'
+    autoload :Message, 'solargraph/language_server/message'
+    autoload :Transport, 'solargraph/language_server/transport'
+    autoload :UriHelpers, 'solargraph/language_server/uri_helpers'
+  end
+end

data/lib/solargraph/language_server/completion_item_kinds.rb

@@ -0,0 +1,31 @@
+module Solargraph
+  module LanguageServer
+    module CompletionItemKinds
+      TEXT = 1
+      METHOD = 2
+      FUNCTION = 3
+      CONSTRUCTOR = 4
+      FIELD = 5
+      VARIABLE = 6
+      CLASS = 7
+      INTERFACE = 8
+      MODULE = 9
+      PROPERTY = 10
+      UNIT = 11
+      VALUE = 12
+      ENUM = 13
+      KEYWORD = 14
+      SNIPPET = 15
+      COLOR = 16
+      FILE = 17
+      REFERENCE = 18
+      FOLDER = 19
+      ENUM_MEMBER = 20
+      CONSTANT = 21
+      STRUCT = 22
+      EVENT = 23
+      OPERATOR = 24
+      TYPE_PARAMETER = 25
+    end
+  end
+end

data/lib/solargraph/language_server/error_codes.rb

@@ -0,0 +1,16 @@
+module Solargraph
+  module LanguageServer
+    module ErrorCodes
+      PARSE_ERROR =            -32700
+      INVALID_REQUEST =        -32600
+      METHOD_NOT_FOUND =       -32601
+      INVALID_PARAMS =         -32602
+      INTERNAL_ERROR =         -32603
+      SERVER_ERROR_START =     -32099
+      SERVER_ERROR_END =       -32000
+      SERVER_NOT_INITIALIZED = -32002
+      UNKNOWN_ERROR_CODE =     -32001
+      REQUEST_CANCELLED =      -32800
+    end
+  end
+end

data/lib/solargraph/language_server/host.rb

@@ -0,0 +1,305 @@
+require 'open3'
+require 'shellwords'
+# require 'rubocop'
+require 'thread'
+require 'set'
+
+module Solargraph
+  module LanguageServer
+    # The language server protocol's data provider. Hosts are responsible for
+    # querying the library and processing messages.
+    #
+    class Host
+      include Solargraph::LanguageServer::UriHelpers
+
+      # @return [Solargraph::Library]
+      attr_reader :library
+
+      def initialize
+        @change_semaphore = Mutex.new
+        @buffer_semaphore = Mutex.new
+        @change_queue = []
+        @diagnostics_queue = []
+        @cancel = []
+        @buffer = ''
+        @stopped = false
+        @library = nil # @todo How to initialize the library
+        start_change_thread
+        start_diagnostics_thread
+      end
+
+      # @param update [Hash]
+      def configure update
+        options.merge! update
+      end
+
+      # @return [Hash]
+      def options
+        @options ||= {}
+      end
+
+      def cancel id
+        @cancel.push id
+      end
+
+      def cancel? id
+        @cancel.include? id
+      end
+
+      def clear id
+        @cancel.delete id
+      end
+
+      def start request
+        message = Message.select(request['method']).new(self, request)
+        begin
+          message.process
+        rescue Exception => e
+          STDERR.puts e.message
+          STDERR.puts e.backtrace
+          message.set_error Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, e.message
+        end
+        message
+      end
+
+      def create uri
+        filename = uri_to_file(uri)
+        library.create filename, File.read(filename)
+      end
+
+      def delete uri
+        filename = uri_to_file(uri)
+        library.delete filename
+      end
+
+      def open uri, text, version
+        library.open uri_to_file(uri), text, version
+        @change_semaphore.synchronize { @diagnostics_queue.push uri }
+      end
+
+      def change params
+        @change_semaphore.synchronize do
+          if changing? params['textDocument']['uri']
+            @change_queue.push params
+          else
+            source = library.checkout(uri_to_file(params['textDocument']['uri']))
+            @change_queue.push params
+            if params['textDocument']['version'] == source.version + params['contentChanges'].length
+              source.synchronize(params['contentChanges'], params['textDocument']['version'])
+              library.refresh
+              @change_queue.pop
+              @diagnostics_queue.push params['textDocument']['uri']
+            end
+          end
+        end
+      end
+
+      def queue message
+        @buffer_semaphore.synchronize do
+          @buffer += message
+        end
+      end
+
+      def flush
+        tmp = nil
+        @buffer_semaphore.synchronize do
+          tmp = @buffer.clone
+          @buffer.clear
+        end
+        tmp
+      end
+
+      # @param directory [String]
+      def prepare directory
+        path = nil
+        path = normalize_separators(directory) unless directory.nil?
+        @change_semaphore.synchronize do
+          @library = Solargraph::Library.load(path)
+        end
+      end
+
+      def send_notification method, params
+        response = {
+          jsonrpc: "2.0",
+          method: method,
+          params: params
+        }
+        json = response.to_json
+        envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
+        queue envelope
+      end
+
+      def changing? file_uri
+        @change_queue.any?{|change| change['textDocument']['uri'] == file_uri}
+      end
+
+      def stop
+        @stopped = true
+      end
+
+      def stopped?
+        @stopped
+      end
+
+      def synchronize &block
+        @change_semaphore.synchronize do
+          block.call
+        end
+      end
+
+      def locate_pin params
+        pin = nil
+        @change_semaphore.synchronize do
+          pin = library.locate_pin(params['data']['location']) unless params['data']['location'].nil?
+          # @todo Improve pin location
+          if pin.nil? or pin.path != params['data']['path']
+            pin = library.path_pins(params['data']['path']).first
+          end
+        end
+        pin
+      end
+
+      def read_text uri
+        filename = uri_to_file(uri)
+        library.read_text(filename)
+      end
+
+      private
+
+      def start_change_thread
+        Thread.new do
+          until stopped?
+            @change_semaphore.synchronize do
+              begin
+                changed = false
+                @change_queue.delete_if do |change|
+                  filename = uri_to_file(change['textDocument']['uri'])
+                  source = library.checkout(filename)
+                  if change['textDocument']['version'] == source.version + change['contentChanges'].length
+                    source.synchronize(change['contentChanges'], change['textDocument']['version'])
+                    @diagnostics_queue.push change['textDocument']['uri']
+                    changed = true
+                    true
+                  elsif change['textDocument']['version'] == source.version + 1 #and change['contentChanges'].length == 0
+                    # HACK: This condition fixes the fact that formatting
+                    # increments the version by one regardless of the number
+                    # of changes
+                    source.synchronize(change['contentChanges'], change['textDocument']['version'])
+                    @diagnostics_queue.push change['textDocument']['uri']
+                    true
+                  elsif change['textDocument']['version'] <= source.version
+                    # @todo Is deleting outdated changes correct behavior?
+                    STDERR.puts "Deleting stale change"
+                    @diagnostics_queue.push change['textDocument']['uri']
+                    changed = true
+                    true
+                  else
+                    # @todo Change is out of order. Save it for later
+                    STDERR.puts "Kept in queue: #{change['textDocument']['uri']} from #{source.version} to #{change['textDocument']['version']}"
+                    false
+                  end
+                end
+                STDERR.puts "#{@change_queue.length} pending" unless @change_queue.empty?
+                library.refresh if changed
+              rescue Exception => e
+                STDERR.puts e.message
+              end
+            end
+            sleep 0.1
+          end
+        end
+      end
+
+      def start_diagnostics_thread
+        Thread.new do
+          until stopped?
+            if options['diagnostics'] != 'rubocop'
+              @change_semaphore.synchronize { @diagnostics_queue.clear }
+              sleep 1
+              next
+            end
+            unless @change_semaphore.locked?
+              begin
+                current = nil
+                @change_semaphore.synchronize do
+                  current = @diagnostics_queue.shift
+                end
+                unless current.nil?
+                  already_changing = false
+                  @change_semaphore.synchronize { already_changing = (changing?(current) or @diagnostics_queue.include?(current)) }
+                  unless already_changing
+                    resp = read_diagnostics(current)
+                    @change_semaphore.synchronize { already_changing = (changing?(current) or @diagnostics_queue.include?(current)) }
+                    publish_diagnostics current, resp unless already_changing
+                  end
+                end
+              rescue Exception => e
+                STDERR.puts e.message
+              end
+            end
+            sleep 0.1
+          end
+        end
+      end
+
+      def normalize_separators path
+        return path if File::ALT_SEPARATOR.nil?
+        path.gsub(File::ALT_SEPARATOR, File::SEPARATOR)
+      end
+
+      def read_diagnostics uri
+        begin
+          filename = nil
+          text = nil
+          @change_semaphore.synchronize do
+            filename = uri_to_file(uri)
+            text = library.read_text(filename)
+          end
+          cmd = "rubocop -f j -s #{Shellwords.escape(filename)}"
+          o, e, s = Open3.capture3(cmd, stdin_data: text)
+          JSON.parse(o)
+        rescue Exception => e
+          STDERR.puts "#{e}"
+          STDERR.puts "#{e.backtrace}"
+          nil
+        end
+      end
+
+      def publish_diagnostics uri, resp
+        severities = {
+          'refactor' => 4,
+          'convention' => 3,
+          'warning' => 2,
+          'error' => 1,
+          'fatal' => 1
+        }
+        diagnostics = []
+        resp['files'].each do |file|
+          file['offenses'].each do |off|
+            diag = {
+              range: {
+                start: {
+                  line: off['location']['start_line'] - 1,
+                  character: off['location']['start_column'] - 1
+                },
+                end: {
+                  line: off['location']['last_line'] - 1,
+                  character: off['location']['last_column']
+                }
+              },
+              # 1 = Error, 2 = Warning, 3 = Information, 4 = Hint
+              severity: severities[off['severity']],
+              source: off['cop_name'],
+              message: off['message'].gsub(/^#{off['cop_name']}\:/, '')
+            }
+            diagnostics.push diag
+          end
+        end
+        send_notification "textDocument/publishDiagnostics", {
+          uri: uri,
+          diagnostics: diagnostics
+        }
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message.rb

@@ -0,0 +1,70 @@
+require 'solargraph'
+require 'uri'
+require 'thread'
+
+module Solargraph
+  module LanguageServer
+    module Message
+      autoload :Base,                 'solargraph/language_server/message/base'
+      autoload :Initialize,           'solargraph/language_server/message/initialize'
+      autoload :Initialized,          'solargraph/language_server/message/initialized'
+      autoload :TextDocument,         'solargraph/language_server/message/text_document'
+      autoload :CompletionItem,       'solargraph/language_server/message/completion_item'
+      autoload :CancelRequest,        'solargraph/language_server/message/cancel_request'
+      autoload :MethodNotFound,       'solargraph/language_server/message/method_not_found'
+      autoload :MethodNotImplemented, 'solargraph/language_server/message/method_not_implemented'
+      autoload :Extended,             'solargraph/language_server/message/extended'
+      autoload :Shutdown,             'solargraph/language_server/message/shutdown'
+      autoload :ExitNotification,     'solargraph/language_server/message/exit_notification'
+      autoload :Workspace,            'solargraph/language_server/message/workspace'
+
+      class << self
+        def register path, message_class
+          method_map[path] = message_class
+        end
+
+        # @param path [String]
+        # @return [Solargraph::LanguageServer::Message::Base]
+        def select path
+          if method_map.has_key?(path)
+            method_map[path]
+          elsif path.start_with?('$/')
+            MethodNotImplemented
+          else
+            STDERR.puts "Method not found: #{path}"
+            MethodNotFound
+          end
+        end
+
+        private
+
+        def method_map
+          @method_map ||= {}
+        end
+      end
+
+      register 'initialize',                       Initialize
+      register 'initialized',                      Initialized
+      register 'textDocument/completion',          TextDocument::Completion
+      register 'completionItem/resolve',           CompletionItem::Resolve
+      register 'textDocument/signatureHelp',       TextDocument::SignatureHelp
+      register 'textDocument/didOpen',             TextDocument::DidOpen
+      register 'textDocument/didChange',           TextDocument::DidChange
+      register 'textDocument/didSave',             TextDocument::DidSave
+      register 'textDocument/didClose',            TextDocument::DidClose
+      register 'textDocument/hover',               TextDocument::Hover
+      register 'textDocument/definition',          TextDocument::Definition
+      register 'textDocument/formatting',          TextDocument::Formatting
+      register 'textDocument/onTypeFormatting',    TextDocument::OnTypeFormatting
+      register 'textDocument/documentSymbol',      TextDocument::DocumentSymbol
+      register 'workspace/didChangeWatchedFiles',  Workspace::DidChangeWatchedFiles
+      register 'workspace/didChangeConfiguration', Workspace::DidChangeConfiguration
+      register 'workspace/symbol',                 Workspace::WorkspaceSymbol
+      register '$/cancelRequest',                  CancelRequest
+      register '$/solargraph/document',            Extended::Document
+      register '$/solargraph/search',              Extended::Search
+      register 'shutdown',                         Shutdown
+      register 'exit',                             ExitNotification
+    end
+  end
+end