solargraph 0.32.5 → 0.33.0

data/lib/solargraph/diagnostics/require_not_found.rb

@@ -9,20 +9,27 @@ module Solargraph
         result = []
         refs = {}
         map = api_map.source_map(source.filename)
-        map.requires.each do |ref|
-          refs[ref.name] = ref
-        end
+        map.requires.each { |ref| refs[ref.name] = ref }
         api_map.unresolved_requires.each do |r|
-          next unless refs.has_key?(r)
-          result.push(
-            range: refs[r].location.range.to_hash,
-            severity: Diagnostics::Severities::WARNING,
-            source: 'Solargraph',
-            message: "Required path #{r} could not be resolved."
-          )
+          next unless refs.key?(r)
+          result.push require_error(r, refs[r].location)
         end
         result
       end
+
+      private
+
+      # @param path [String]
+      # @param location [Location]
+      # @return [Hash]
+      def require_error path, location
+        {
+          range: location.range.to_hash,
+          severity: Diagnostics::Severities::WARNING,
+          source: 'RequireNotFound',
+          message: "Required path #{path} could not be resolved."
+        }
+      end
     end
   end
 end

data/lib/solargraph/diagnostics/rubocop_helpers.rb

@@ -1,5 +1,7 @@
 module Solargraph
   module Diagnostics
+    # Utility methods for the RuboCop diagnostics reporter.
+    #
     module RubocopHelpers
       module_function
 

data/lib/solargraph/diagnostics/type_check.rb

@@ -0,0 +1,51 @@
+module Solargraph
+  module Diagnostics
+    # TypeCheck reports methods with undefined return types, untagged
+    # parameters, and invalid param tags.
+    #
+    class TypeCheck < Base
+      def diagnose source, api_map
+        severity = (args.include?('strict') ? Diagnostics::Severities::ERROR : Diagnostics::Severities::WARNING)
+        checker = Solargraph::TypeChecker.new(source.filename, api_map: api_map)
+        result = checker.return_type_problems + checker.param_type_problems
+        result.concat checker.strict_type_problems if args.include?('strict')
+        result.sort! { |a, b| a.location.range.start.line <=> b.location.range.start.line }
+        result.map do |problem|
+          {
+            range: extract_first_line(problem.location, source),
+            severity: severity,
+            source: 'Typecheck',
+            message: problem.message
+          }
+        end
+      end
+
+      private
+
+      # @param location [Location]
+      # @param source [Source]
+      # @return [Hash]
+      def extract_first_line location, source
+        return location.range.to_hash if location.range.start.line == location.range.ending.line
+        {
+          start: {
+            line: location.range.start.line,
+            character: location.range.start.character
+          },
+          end: {
+            line: location.range.start.line,
+            character: last_character(location.range.start, source)
+          }
+        }
+      end
+
+      # @param position [Solargraph::Position]
+      # @param source [Solargraph::Source]
+      # @return [Integer]
+      def last_character position, source
+        cursor = Position.to_offset(source.code, position)
+        source.code.index(/[\r\n]/, cursor) || source.code.length
+      end
+    end
+  end
+end

data/lib/solargraph/diagnostics/update_errors.rb

@@ -18,6 +18,7 @@ module Solargraph
 
       # Combine an array of ranges by their starting lines.
       #
+      # @param code [String]
       # @param ranges [Array<Range>]
       # @return [Array<Range>]
       def combine_ranges code, ranges

data/lib/solargraph/language_server/host.rb

@@ -1,4 +1,4 @@
-require 'thread'
+require 'observer'
 require 'set'
 
 module Solargraph
@@ -16,6 +16,7 @@ module Solargraph
       include UriHelpers
       include Logging
       include Dispatch
+      include Observable
 
       def initialize
         @cancel_semaphore = Mutex.new
@@ -43,6 +44,7 @@ module Solargraph
       # Update the configuration options with the provided hash.
       #
       # @param update [Hash]
+      # @return [void]
       def configure update
         return if update.nil?
         options.merge! update
@@ -57,6 +59,7 @@ module Solargraph
       # Cancel the method with the specified ID.
       #
       # @param id [Integer]
+      # @return [void]
       def cancel id
         @cancel_semaphore.synchronize { @cancel.push id }
       end
@@ -94,7 +97,7 @@ module Solargraph
             message.process
           rescue Exception => e
             logger.warn "Error processing request: [#{e.class}] #{e.message}"
-            logger.warn e.backtrace
+            logger.warn e.backtrace.join("\n")
             message.set_error Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, "[#{e.class}] #{e.message}"
           end
           message
@@ -129,7 +132,6 @@ module Solargraph
       # @param uri [String] The file uri.
       # @return [void]
       def delete uri
-        # sources.close uri # @todo It's possible for a deleted file to be open in an editor
         filename = uri_to_file(uri)
         libraries.each do |lib|
           lib.delete(filename)
@@ -154,6 +156,8 @@ module Solargraph
         diagnoser.schedule uri
       end
 
+      # @param uri [String]
+      # @return [void]
       def open_from_disk uri
         library = library_for(uri)
         library.open_from_disk uri_to_file(uri)
@@ -182,22 +186,26 @@ module Solargraph
       # @return [void]
       def diagnose uri
         if sources.include?(uri)
-          logger.info "Diagnosing #{uri}"
           library = library_for(uri)
-          library.catalog
-          begin
-            results = library.diagnose uri_to_file(uri)
-            send_notification "textDocument/publishDiagnostics", {
-              uri: uri,
-              diagnostics: results
-            }
-          rescue DiagnosticsError => e
-            logger.warn "Error in diagnostics: #{e.message}"
-            options['diagnostics'] = false
-            send_notification 'window/showMessage', {
-              type: LanguageServer::MessageTypes::ERROR,
-              message: "Error in diagnostics: #{e.message}"
-            }
+          if library.synchronized?
+            logger.info "Diagnosing #{uri}"
+            begin
+              results = library.diagnose uri_to_file(uri)
+              send_notification "textDocument/publishDiagnostics", {
+                uri: uri,
+                diagnostics: results
+              }
+            rescue DiagnosticsError => e
+              logger.warn "Error in diagnostics: #{e.message}"
+              options['diagnostics'] = false
+              send_notification 'window/showMessage', {
+                type: LanguageServer::MessageTypes::ERROR,
+                message: "Error in diagnostics: #{e.message}"
+              }
+            end
+          else
+            logger.info "Deferring diagnosis of #{uri}"
+            diagnoser.schedule uri
           end
         else
           send_notification 'textDocument/publishDiagnostics', {
@@ -215,15 +223,17 @@ module Solargraph
       def change params
         updater = generate_updater(params)
         sources.async_update params['textDocument']['uri'], updater
+        diagnoser.schedule params['textDocument']['uri']
       end
 
       # Queue a message to be sent to the client.
       #
       # @param message [String] The message to send.
+      # @return [void]
       def queue message
-        @buffer_semaphore.synchronize do
-          @buffer += message
-        end
+        @buffer_semaphore.synchronize { @buffer += message }
+        changed
+        notify_observers
       end
 
       # Clear the message buffer and return the most recent data.
@@ -285,12 +295,15 @@ module Solargraph
         end
       end
 
+      # @param array [Array<Hash>]
+      # @return [void]
       def remove_folders array
         array.each do |folder|
           remove uri_to_file(folder['uri'])
         end
       end
 
+      # @return [Array<String>]
       def folders
         libraries.map { |lib| lib.workspace.directory }
       end
@@ -299,6 +312,7 @@ module Solargraph
       #
       # @param method [String] The message method
       # @param params [Hash] The method parameters
+      # @return [void]
       def send_notification method, params
         response = {
           jsonrpc: "2.0",
@@ -318,8 +332,9 @@ module Solargraph
       #
       # @param method [String] The message method
       # @param params [Hash] The method parameters
-      # @param id [String] An optional ID
+      # @param block [Proc] The block that processes the response
       # @yieldparam [Hash] The result sent by the client
+      # @return [void]
       def send_request method, params, &block
         message = {
           jsonrpc: "2.0",
@@ -416,6 +431,8 @@ module Solargraph
         cataloger.stop
         diagnoser.stop
         sources.stop
+        changed
+        notify_observers
       end
 
       def stopped?
@@ -461,7 +478,7 @@ module Solargraph
       # @param uri [String]
       # @param line [Integer]
       # @param column [Integer]
-      # @return [Solargraph::ApiMap::Completion]
+      # @return [Solargraph::SourceMap::Completion]
       def completions_at uri, line, column
         library = library_for(uri)
         library.completions_at uri_to_file(uri), line, column
@@ -546,7 +563,7 @@ module Solargraph
       # @param text [String]
       # @param type [Integer] A MessageType constant
       # @param actions [Array<String>] Response options for the client
-      # @param &block The block that processes the response
+      # @param block The block that processes the response
       # @yieldparam [String] The action received from the client
       # @return [void]
       def show_message_request text, type, actions, &block
@@ -588,6 +605,7 @@ module Solargraph
         sources.find(uri).folding_ranges
       end
 
+      # @return [void]
       def catalog
         libraries.each(&:catalog)
       end
@@ -604,15 +622,23 @@ module Solargraph
         @cataloger ||= Cataloger.new(self)
       end
 
+      # A hash of client requests by ID. The host uses this to keep track of
+      # pending responses.
+      #
+      # @return [Hash{Integer => Hash}]
       def requests
         @requests ||= {}
       end
 
+      # @param path [String]
+      # @return [String]
       def normalize_separators path
         return path if File::ALT_SEPARATOR.nil?
         path.gsub(File::ALT_SEPARATOR, File::SEPARATOR)
       end
 
+      # @param params [Hash]
+      # @return [Source::Updater]
       def generate_updater params
         changes = []
         params['contentChanges'].each do |chng|
@@ -631,6 +657,7 @@ module Solargraph
         )
       end
 
+      # @return [Hash]
       def dynamic_capability_options
         @dynamic_capability_options ||= {
           # textDocumentSync: 2, # @todo What should this be?
@@ -641,7 +668,7 @@ module Solargraph
           # hoverProvider: true,
           # definitionProvider: true,
           'textDocument/signatureHelp' => {
-            triggerCharacters: ['(', ',']
+            triggerCharacters: ['(', ',', ' ']
           },
           # documentFormattingProvider: true,
           'textDocument/onTypeFormatting' => {
@@ -676,6 +703,9 @@ module Solargraph
           },
           'textDocument/foldingRange' => {
             foldingRangeProvider: true
+          },
+          'textDocument/codeAction' => {
+            codeActionProvider: true
           }
         }
       end

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

@@ -58,8 +58,7 @@ module Solargraph
             mutex.synchronize { queue.clear }
             return
           end
-          current = nil
-          mutex.synchronize { current = queue.shift }
+          current = mutex.synchronize { queue.shift }
           return if queue.include?(current)
           host.diagnose current
         end

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

@@ -25,13 +25,10 @@ module Solargraph
         # @return [void]
         def update_libraries uri
           src = sources.find(uri)
-          # @todo This module should not call cataloger and diagnoser
           libraries.each do |lib|
-            if lib.contain?(src.filename) || lib.open?(src.filename)
-              lib.merge src
-            end
+            lib.merge src if lib.contain?(src.filename)
           end
-          diagnoser.schedule uri if src.synchronized?
+          diagnoser.schedule uri
         end
 
         # Find the best libary match for the given URI.
@@ -79,11 +76,9 @@ module Solargraph
         def implicit_library_for uri
           filename = UriHelpers.uri_to_file(uri)
           libraries.each do |lib|
-            # @todo We probably shouldn't depend on attachments to select
-            #   a library.
-            # return lib if lib.open?(filename)
             if filename.start_with?(lib.workspace.directory)
               lib.attach sources.find(uri)
+              lib.catalog
               return lib
             end
           end
@@ -99,6 +94,7 @@ module Solargraph
         # @return [Library]
         def generic_library_for uri
           generic_library.attach sources.find(uri)
+          generic_library.catalog
           generic_library
         end
 

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

@@ -75,7 +75,7 @@ module Solargraph
 
         # @param uri [String]
         # @param updater [Source::Updater]
-        # @return [Thread]
+        # @return [void]
         def async_update uri, updater
           src = find(uri)
           mutex.synchronize { open_source_hash[uri] = src.start_synchronize(updater) }

data/lib/solargraph/language_server/message.rb

@@ -72,6 +72,7 @@ module Solargraph
       register 'textDocument/rename',              TextDocument::Rename
       register 'textDocument/prepareRename',       TextDocument::PrepareRename
       register 'textDocument/foldingRange',        TextDocument::FoldingRange
+      register 'textDocument/codeAction',          TextDocument::CodeAction
       register 'workspace/didChangeWatchedFiles',  Workspace::DidChangeWatchedFiles
       register 'workspace/didChangeConfiguration', Workspace::DidChangeConfiguration
       register 'workspace/didChangeWorkspaceFolders', Workspace::DidChangeWorkspaceFolders

data/lib/solargraph/language_server/message/completion_item/resolve.rb

@@ -17,11 +17,13 @@ module Solargraph
           def merge pins
             return params if pins.empty?
             docs = pins
-                   .reject { |pin| pin.documentation.empty? }
+                   .reject { |pin| pin.documentation.empty? && pin.return_type.undefined? }
                    .map { |pin| pin.resolve_completion_item[:documentation] }
-            params
+            result = params
               .merge(pins.first.resolve_completion_item)
               .merge(documentation: markup_content(docs.join("\n\n")))
+            result[:detail] = pins.first.detail
+            result
           end
 
           # @param text [String]

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

@@ -36,6 +36,8 @@ module Solargraph
             result[:capabilities].merge! static_references unless dynamic_registration_for?('textDocument', 'references')
             result[:capabilities].merge! static_workspace_symbols unless dynamic_registration_for?('workspace', 'symbol')
             result[:capabilities].merge! static_folding_range unless dynamic_registration_for?('textDocument', 'foldingRange')
+            # @todo Temporarily disabled
+            # result[:capabilities].merge! static_code_action unless dynamic_registration_for?('textDocument', 'codeAction')
             set_result result
           }
           Solargraph.logger.unknown "Solargraph initialized (#{bm.real} seconds)"
@@ -59,6 +61,13 @@ module Solargraph
           }
         end
 
+        def static_code_action
+          {
+            codeActionProvider: true,
+            codeActionKinds: ["quickfix"]
+          }
+        end
+
         def static_signature_help
           {
             signatureHelpProvider: {

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

@@ -3,6 +3,7 @@ module Solargraph
     module Message
       class Initialized < Base
         def process
+          # @todo Temporarily removed textDocument/codeAction
           host.register_capabilities %w[
             textDocument/completion
             textDocument/hover