solargraph 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e1a1a75c9706d5d54ca2359b21bf336b9980bce
-  data.tar.gz: 618ae6ec9b01ddd2ee7656a34c787cc6b26bfc0b
+  metadata.gz: 04dd49e264774d545fbdf1a7f52d0b7227ff3f11
+  data.tar.gz: cb617a8800b2eec8688c46fc89cf4ee79445dd50
 SHA512:
-  metadata.gz: 7ab817f132710bdb79f93773937cb8280dd764b07e7bd29f4b33064e097690a192afc219f6bbcf69b00d3ca1257cb8a6e90db91c9c8ee3109fa522f6ea054474
-  data.tar.gz: ccb208a618f8c891c6bfd102e45bd65a31307abc87bb51cd738ed64582eb0e1a45adbc4ba7e7248de64b5cc6760dfa68370eb6f883c63a18c340a2657e38a4b3
+  metadata.gz: db20a5e3053060171bf9077c1ce572de8428193b4d562c7d939c9a7003074de64f41ffe879100b7f7a31bb42f625a32e69ad7755afc68b8c31d2cc64d15be353
+  data.tar.gz: bb9a311819e91501145c05fc2045178a791933fb6f9598e6265f68efe301664cbb6bfa50170928989d1fd8543a726cd36e0079b2f650c2ded36f9ad3a66c92c6

data/lib/solargraph.rb

@@ -1,7 +1,6 @@
 require 'solargraph/version'
 require 'rubygems/package'
 require 'yard-solargraph'
-require 'sinatra'
 
 module Solargraph
   class InvalidOffsetError <      RangeError; end
@@ -11,6 +10,8 @@ module Solargraph
 
   class WorkspaceTooLargeError < RuntimeError
     attr_reader :size
+
+    # @param size [Integer] The number of files included in the workspace
     def initialize size
       @size = size
     end
@@ -20,8 +21,6 @@ module Solargraph
   autoload :Source,         'solargraph/source'
   autoload :ApiMap,         'solargraph/api_map'
   autoload :NodeMethods,    'solargraph/node_methods'
-  autoload :Suggestion,     'solargraph/suggestion'
-  autoload :Server,         'solargraph/server'
   autoload :YardMap,        'solargraph/yard_map'
   autoload :Pin,            'solargraph/pin'
   autoload :LiveMap,        'solargraph/live_map'

data/lib/solargraph/api_map.rb

@@ -57,6 +57,7 @@ module Solargraph
       @sources.each do |s|
         result.concat s.required.map(&:name)
       end
+      result.concat workspace.config.required
       result.uniq
     end
 
@@ -341,7 +342,9 @@ module Solargraph
     def signify fragment
       return [] unless fragment.argument?
       return [] if fragment.recipient.whole_signature.nil? or fragment.recipient.whole_signature.empty?
-      probe.infer_signature_pins fragment.recipient.whole_signature, fragment.named_path, fragment.locals
+      probe.infer_signature_pins(
+        fragment.recipient.whole_signature, fragment.named_path, fragment.locals
+      ).select{ |pin| pin.kind == Pin::METHOD }
     end
 
     # Get an array of all suggestions that match the specified path.
@@ -471,11 +474,8 @@ module Solargraph
           end
           result.concat yard_map.get_methods(fqns, '', visibility: visibility)
           type = get_namespace_type(fqns)
-          if type == :class
-            result.concat inner_get_methods('Class', :instance, [:public], deep, skip)
-          else
-            result.concat inner_get_methods('Module', :instance, [:public], deep, skip)
-          end
+          result.concat inner_get_methods('Class', :instance, fqns == '' ? [:public] : visibility, deep, skip) if type == :class
+          result.concat inner_get_methods('Module', :instance, fqns == '' ? [:public] : visibility, deep, skip)
         end
       end
       result

data/lib/solargraph/api_map/source_to_yard.rb

@@ -19,7 +19,7 @@ module Solargraph
         sources.each do |s|
           s.namespace_pins.each do |pin|
             next if pin.path.empty?
-            if pin.kind == Solargraph::Suggestion::CLASS
+            if pin.type == :class
               code_object_map[pin.path] ||= YARD::CodeObjects::ClassObject.new(root_code_object, pin.path)
             else
               code_object_map[pin.path] ||= YARD::CodeObjects::ModuleObject.new(root_code_object, pin.path)

data/lib/solargraph/language_server/host.rb

@@ -33,7 +33,7 @@ module Solargraph
 
       # @return [Hash]
       def options
-        @options ||= {}
+        @options ||= default_configuration
       end
 
       def cancel id
@@ -54,7 +54,7 @@ module Solargraph
       # processed, the transport is responsible for sending the response.
       #
       # @param request [Hash] The contents of the message.
-      # @return [Solargraph::LanguageServer::Message] The message handler.
+      # @return [Solargraph::LanguageServer::Message::Base] The message handler.
       def start request
         if request['method']
           message = Message.select(request['method']).new(self, request)
@@ -214,10 +214,12 @@ module Solargraph
       end
 
       # Send a request to the client and execute the provided block to process
-      # the response.
+      # the response. If an ID is not provided, the host will use an auto-
+      # incrementing integer.
       #
       # @param method [String] The message method
       # @param params [Hash] The method parameters
+      # @param id [String] An optional ID
       # @yieldparam [Hash] The result sent by the client
       def send_request method, params, &block
         message = {
@@ -233,6 +235,29 @@ module Solargraph
         @next_request_id += 1
       end
 
+      def register_capabilities methods
+        send_request 'client/registerCapability', {
+          registrations: methods.map { |m|
+            {
+              id: m,
+              method: m,
+              registerOptions: dynamic_capability_options[m]
+            }
+          }
+        }
+      end
+
+      def unregister_capabilities methods
+        send_request 'client/unregisterCapability', {
+          unregisterations: methods.map { |m|
+            {
+              id: m,
+              method: m
+            }
+          }
+        }
+      end
+
       # True if the specified file is in the process of changing.
       #
       # @return [Boolean]
@@ -343,6 +368,16 @@ module Solargraph
         requests.keys
       end
 
+      def default_configuration
+        {
+          'completion' => true,
+          'hover' => true,
+          'autoformat' => false,
+          'diagnostics' => false,
+          'formatting' => false
+        }
+      end
+
       private
 
       # @return [Solargraph::Library]
@@ -412,13 +447,13 @@ module Solargraph
           diagnoser = Diagnostics::Rubocop.new
           until stopped?
             sleep 1
-            if options['diagnostics'] != 'rubocop'
+            if !options['diagnostics']
               @change_semaphore.synchronize { @diagnostics_queue.clear }
               next
             end
             begin
-              # Diagnosis is broken into two parts to reduce the amount of times it runs while
-              # a document is changing
+              # Diagnosis is broken into two parts to reduce the number of
+              # times it runs while a document is changing
               current = nil
               already_changing = nil
               @change_semaphore.synchronize do
@@ -429,13 +464,9 @@ module Solargraph
               end
               next if current.nil? or already_changing
               filename = uri_to_file(current)
-              # text = library.read_text(filename)
-              # results = diagnoser.diagnose text, filename
-              # results.concat library.diagnose(filename)
               results = library.diagnose(filename)
               @change_semaphore.synchronize do
                 already_changing = (unsafe_changing?(current) or @diagnostics_queue.include?(current))
-                # publish_diagnostics current, resp unless already_changing
                 unless already_changing
                   send_notification "textDocument/publishDiagnostics", {
                     uri: current,
@@ -480,6 +511,34 @@ module Solargraph
           changes
         )
       end
+
+      def dynamic_capability_options
+        @dynamic_capability_options ||= {
+          # textDocumentSync: 2, # @todo What should this be?
+          'textDocument/completion' => {
+            resolveProvider: true,
+            triggerCharacters: ['.', ':', '@']
+          },
+          # hoverProvider: true,
+          # definitionProvider: true,
+          'textDocument/signatureHelp' => {
+            triggerCharacters: ['(', ',']
+          },
+          # documentFormattingProvider: true,
+          'textDocument/onTypeFormatting' => {
+            firstTriggerCharacter: '{',
+            moreTriggerCharacter: ['(']
+          },
+          # documentSymbolProvider: true,
+          # workspaceSymbolProvider: true,
+          # workspace: {
+            # workspaceFolders: {
+              # supported: true,
+              # changeNotifications: true
+            # }
+          # }
+        }
+      end
     end
   end
 end

data/lib/solargraph/language_server/message.rb

@@ -24,14 +24,13 @@ module Solargraph
         end
 
         # @param path [String]
-        # @return [Solargraph::LanguageServer::Message::Base]
+        # @return [Class<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

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

@@ -5,23 +5,10 @@ module Solargraph
         def process
           host.configure params['initializationOptions']
           host.prepare params['rootPath']
-          set_result(
+          result = {
             capabilities: {
               textDocumentSync: 2, # @todo What should this be?
-              completionProvider: {
-                resolveProvider: true,
-                triggerCharacters: ['.', ':', '@']
-              },
-              hoverProvider: true,
               definitionProvider: true,
-              signatureHelpProvider: {
-                triggerCharacters: ['(', ',']
-              },
-              documentFormattingProvider: true,
-              documentOnTypeFormattingProvider: {
-                firstTriggerCharacter: '{',
-                moreTriggerCharacter: ['(']
-              },
               documentSymbolProvider: true,
               workspaceSymbolProvider: true,
               workspace: {
@@ -31,7 +18,88 @@ module Solargraph
                 }
               }
             }
-          )
+          }
+          result[:capabilities].merge! static_completion unless dynamic_completion?
+          result[:capabilities].merge! static_signature_help unless dynamic_signature_help?
+          result[:capabilities].merge! static_on_type_formatting unless dynamic_on_type_formatting?
+          result[:capabilities].merge! static_hover unless dynamic_hover?
+          result[:capabilities].merge! static_document_formatting unless dynamic_document_formatting?
+          set_result result
+        end
+
+        private
+
+        def static_completion
+          {
+            completionProvider: {
+              resolveProvider: true,
+              triggerCharacters: ['.', ':', '@']
+            }
+          }
+        end
+
+        def dynamic_completion?
+          params['capabilities'] and
+            params['capabilities']['textDocument'] and
+            params['capabilities']['textDocument']['completion'] and
+            params['capabilities']['textDocument']['completion']['dynamicRegistration']
+        end
+
+        def static_signature_help
+          {
+            signatureHelpProvider: {
+              triggerCharacters: ['(', ',']
+            }
+          }
+        end
+
+        def dynamic_signature_help?
+          params['capabilities'] and
+            params['capabilities']['textDocument'] and
+            params['capabilities']['textDocument']['signatureHelp'] and
+            params['capabilities']['textDocument']['signatureHelp']['dynamicRegistration']
+        end
+
+        def static_on_type_formatting
+          {
+            documentOnTypeFormattingProvider: {
+              firstTriggerCharacter: '{',
+              moreTriggerCharacter: ['(']
+            }
+          }
+        end
+
+        def dynamic_on_type_formatting?
+          params['capabilities'] and
+            params['capabilities']['textDocument'] and
+            params['capabilities']['textDocument']['onTypeFormatting'] and
+            params['capabilities']['textDocument']['onTypeFormatting']['dynamicRegistration']
+        end
+
+        def static_hover
+          {
+            hoverProvider: true
+          }
+        end
+
+        def dynamic_hover?
+          params['capabilities'] and
+            params['capabilities']['textDocument'] and
+            params['capabilities']['textDocument']['hover'] and
+            params['capabilities']['textDocument']['hover']['dynamicRegistration']
+        end
+
+        def static_document_formatting
+          {
+            documentFormattingProvider: true
+          }
+        end
+
+        def dynamic_document_formatting?
+          params['capabilities'] and
+            params['capabilities']['textDocument'] and
+            params['capabilities']['textDocument']['hover'] and
+            params['capabilities']['textDocument']['hover']['dynamicRegistration']
         end
       end
     end

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

@@ -3,6 +3,13 @@ module Solargraph
     module Message
       class Initialized < Base
         def process
+          meths = []
+          meths.push 'textDocument/completion' if host.options['completion']
+          meths.push 'textDocument/hover' if host.options['hover']
+          meths.push 'textDocument/signatureHelp' if host.options['hover']
+          meths.push 'textDocument/onTypeFormatting' if host.options['autoformat']
+          meths.push 'textDocument/formatting' if host.options['formatting']
+          host.register_capabilities meths unless meths.empty?
         end
       end
     end

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

@@ -7,10 +7,13 @@ module Solargraph
         class Formatting < Base
           def process
             filename = uri_to_file(params['textDocument']['uri'])
+            filename = 'tmp.rb' if filename.nil? or filename.empty?
             original = host.read_text(params['textDocument']['uri'])
             cmd = "rubocop -a -f fi -s #{Shellwords.escape(filename)}"
             o, e, s = Open3.capture3(cmd, stdin_data: original)
-            formatted = o.lines[2..-1].join
+            lines = o.lines
+            index = lines.index{|l| l.start_with?('====================')}
+            formatted = lines[index+1..-1].join
             set_result(
               [
                 {

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

@@ -4,25 +4,26 @@ module Solargraph
       module TextDocument
         class OnTypeFormatting < Base
           def process
-            src = host.send(:library).checkout(uri_to_file(params['textDocument']['uri']))
-            fragment = src.fragment_at(params['position']['line'], params['position']['character'] - 1)
-            offset = fragment.send(:offset)
-            if fragment.string? and params['ch'] == '{' and src.code[offset-1,2] == '#{'
-              set_result(
-                [
-                  {
-                    range: {
-                      start: params['position'],
-                      end: params['position']
-                    },
-                    newText: '}'
-                  }
-                ]
-              )
-            else
-              # @todo Is `nil` or `[]` more appropriate here?
-              set_result nil
-            end
+            # @todo Temporarily disabled due to conflicts with VSCode formatting on type
+            # src = host.send(:library).checkout(uri_to_file(params['textDocument']['uri']))
+            # fragment = src.fragment_at(params['position']['line'], params['position']['character'] - 1)
+            # offset = fragment.send(:offset)
+            # if fragment.string? and params['ch'] == '{' and src.code[offset - 1, 2] == '#{'
+            #   set_result(
+            #     [
+            #       {
+            #         range: {
+            #           start: params['position'],
+            #           end: params['position']
+            #         },
+            #         newText: '}'
+            #       }
+            #     ]
+            #   )
+            # else
+            #   # @todo Is `nil` or `[]` more appropriate here?
+            #   set_result nil
+            # end
           end
         end
       end

data/lib/solargraph/language_server/message/workspace/did_change_configuration.rb

@@ -3,7 +3,25 @@ require 'uri'
 module Solargraph::LanguageServer::Message::Workspace
   class DidChangeConfiguration < Solargraph::LanguageServer::Message::Base
     def process
-      host.configure params['settings']['solargraph']
+      update = params['settings']['solargraph']
+
+      meths = []
+      meths.push 'textDocument/completion' if update.has_key?('completion') and update['completion'] and !host.options['completion']
+      meths.push 'textDocument/hover' if update.has_key?('hover') and update['hover']  and !host.options['hover']
+      meths.push 'textDocument/signatureHelp' if update.has_key?('hover') and update['hover'] and !host.options['hover']
+      meths.push 'textDocument/onTypeFormatting' if update.has_key?('autoformat') and update['autoformat'] and !host.options['autoformat']
+      meths.push "textDocument/formatting" if update.has_key?('formatting') and update['formatting'] and !host.options['formatting']
+      host.register_capabilities meths unless meths.empty?
+
+      meths = []
+      meths.push 'textDocument/completion' if update.has_key?('completion') and !update['completion'] and host.options['completion']
+      meths.push 'textDocument/hover' if update.has_key?('hover') and !update['hover'] and host.options['hover']
+      meths.push 'textDocument/signatureHelp' if update.has_key?('hover') and !update['hover'] and host.options['hover']
+      meths.push 'textDocument/onTypeFormatting' if update.has_key?('autoformat') and !update['autoformat'] and host.options['autoformat']
+      meths.push "textDocument/formatting" if update.has_key?('formatting') and !update['formatting'] and host.options['formatting']
+      host.unregister_capabilities meths unless meths.empty?
+
+      host.configure update
     end
   end
 end