solargraph 0.40.3 → 0.42.0

data/lib/solargraph/diagnostics/rubocop.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'rubocop'
 require 'stringio'
 
 module Solargraph
@@ -23,6 +22,7 @@ module Solargraph
       # @param _api_map [Solargraph::ApiMap]
       # @return [Array<Hash>]
       def diagnose source, _api_map
+        require_rubocop(rubocop_version)
         options, paths = generate_options(source.filename, source.code)
         store = RuboCop::ConfigStore.new
         runner = RuboCop::Runner.new(options, store)
@@ -36,6 +36,13 @@ module Solargraph
 
       private
 
+      # Extracts the rubocop version from _args_
+      #
+      # @return [String]
+      def rubocop_version
+        args.find { |a| a =~ /version=/ }.to_s.split('=').last
+      end
+
       # @param resp [Hash]
       # @return [Array<Hash>]
       def make_array resp
@@ -57,7 +64,8 @@ module Solargraph
           range: offense_range(off).to_hash,
           # 1 = Error, 2 = Warning, 3 = Information, 4 = Hint
           severity: SEVERITIES[off['severity']],
-          source: off['cop_name'],
+          source: 'rubocop',
+          code: off['cop_name'],
           message: off['message'].gsub(/^#{off['cop_name']}\:/, '')
         }
       end

data/lib/solargraph/diagnostics/rubocop_helpers.rb

@@ -7,6 +7,24 @@ module Solargraph
     module RubocopHelpers
       module_function
 
+      # Requires a specific version of rubocop, or the latest installed version
+      # if _version_ is `nil`.
+      #
+      # @param version [String]
+      # @raise [InvalidRubocopVersionError] if _version_ is not installed
+      def require_rubocop(version = nil)
+        begin
+          gem_path = Gem::Specification.find_by_name('rubocop', version).full_gem_path
+          gem_lib_path = File.join(gem_path, 'lib')
+          $LOAD_PATH.unshift(gem_lib_path) unless $LOAD_PATH.include?(gem_lib_path)
+        rescue Gem::MissingSpecVersionError => e
+          raise InvalidRubocopVersionError,
+                "could not find '#{e.name}' (#{e.requirement}) - "\
+                "did find: [#{e.specs.map { |s| s.version.version }.join(', ')}]"
+        end
+        require 'rubocop'
+      end
+
       # Generate command-line options for the specified filename and code.
       #
       # @param filename [String]

data/lib/solargraph/diagnostics/type_check.rb

@@ -7,7 +7,7 @@ module Solargraph
     #
     class TypeCheck < Base
       def diagnose source, api_map
-        return [] unless args.include?('always') || api_map.workspaced?(source.filename)
+        # return [] unless args.include?('always') || api_map.workspaced?(source.filename)
         severity = Diagnostics::Severities::ERROR
         level = (args.reverse.find { |a| ['normal', 'typed', 'strict', 'strong'].include?(a) }) || :normal
         checker = Solargraph::TypeChecker.new(source.filename, api_map: api_map, level: level.to_sym)

data/lib/solargraph/language_server/host.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
+require 'diff/lcs'
 require 'observer'
+require 'securerandom'
 require 'set'
 
 module Solargraph
@@ -106,9 +108,12 @@ module Solargraph
           end
           message
         elsif request['id']
-          # @todo What if the id is invalid?
-          requests[request['id']].process(request['result'])
-          requests.delete request['id']
+          if requests[request['id']]
+            requests[request['id']].process(request['result'])
+            requests.delete request['id']
+          else
+            logger.warn "Discarding client response to unrecognized message #{request['id']}"
+          end
         else
           logger.warn "Invalid message received."
           logger.debug request
@@ -164,8 +169,6 @@ module Solargraph
       # @return [void]
       def open_from_disk uri
         sources.open_from_disk(uri)
-        library = library_for(uri)
-        # library.open_from_disk uri_to_file(uri)
         diagnoser.schedule uri
       end
 
@@ -192,7 +195,7 @@ module Solargraph
       def diagnose uri
         if sources.include?(uri)
           library = library_for(uri)
-          if library.synchronized?
+          if library.mapped? && library.synchronized?
             logger.info "Diagnosing #{uri}"
             begin
               results = library.diagnose uri_to_file(uri)
@@ -277,6 +280,7 @@ module Solargraph
         begin
           lib = Solargraph::Library.load(path, name)
           libraries.push lib
+          async_library_map lib
         rescue WorkspaceTooLargeError => e
           send_notification 'window/showMessage', {
             'type' => Solargraph::LanguageServer::MessageTypes::WARNING,
@@ -631,6 +635,7 @@ module Solargraph
 
       # @return [void]
       def catalog
+        return unless libraries.all?(&:mapped?)
         libraries.each(&:catalog)
       end
 
@@ -669,7 +674,8 @@ module Solargraph
       # @return [Source::Updater]
       def generate_updater params
         changes = []
-        params['contentChanges'].each do |chng|
+        params['contentChanges'].each do |recvd|
+          chng = check_diff(params['textDocument']['uri'], recvd)
           changes.push Solargraph::Source::Change.new(
             (chng['range'].nil? ? 
               nil :
@@ -685,6 +691,36 @@ module Solargraph
         )
       end
 
+      # @param uri [String]
+      # @param change [Hash]
+      # @return [Hash]
+      def check_diff uri, change
+        return change if change['range']
+        source = sources.find(uri)
+        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
+        # @type [Diff::LCS::Change]
+        diff = diffs.first.first
+        return change unless diff.adding? && ['.', ':'].include?(diff.element)
+        position = Solargraph::Position.from_offset(source.code, diff.position)
+        {
+          'range' => {
+            'start' => {
+              'line' => position.line,
+              'character' => position.character
+            },
+            'end' => {
+              'line' => position.line,
+              'character' => position.character
+            }
+          },
+          'text' => diff.element
+        }
+      rescue Solargraph::FileNotFoundError
+        change
+      end
+
       # @return [Hash]
       def dynamic_capability_options
         @dynamic_capability_options ||= {
@@ -741,6 +777,71 @@ module Solargraph
       def prepare_rename?
         client_capabilities['rename'] && client_capabilities['rename']['prepareSupport']
       end
+
+      def client_supports_progress?
+        client_capabilities['window'] && client_capabilities['window']['workDoneProgress']
+      end
+
+      # @param library [Library]
+      # @return [void]
+      def async_library_map library
+        return if library.mapped?
+        Thread.new do
+          if client_supports_progress?
+            uuid = SecureRandom.uuid
+            send_request 'window/workDoneProgress/create', {
+              token: uuid
+            } do |response|
+              do_async_library_map library, response.nil? ? uuid : nil
+            end
+          else
+            do_async_library_map library
+          end
+        end
+      end
+
+      def do_async_library_map library, uuid = nil
+        total = library.workspace.sources.length
+        if uuid
+          send_notification '$/progress', {
+            token: uuid,
+            value: {
+              kind: 'begin',
+              title: "Mapping workspace",
+              message: "0/#{total} files",
+              cancellable: false,
+              percentage: 0
+            }
+          }
+        end
+        pct = 0
+        mod = 10
+        while library.next_map
+          next unless uuid
+          cur = ((library.source_map_hash.keys.length.to_f / total.to_f) * 100).to_i
+          if cur > pct && cur % mod == 0
+            pct = cur
+            send_notification '$/progress', {
+              token: uuid,
+              value: {
+                kind: 'report',
+                cancellable: false,
+                message: "#{library.source_map_hash.keys.length}/#{total} files",
+                percentage: pct
+              }
+            }
+          end
+        end
+        if uuid
+          send_notification '$/progress', {
+            token: uuid,
+            value: {
+              kind: 'end',
+              message: 'Mapping complete'
+            }
+          }
+        end
+      end
     end
   end
 end

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

@@ -62,7 +62,15 @@ module Solargraph
           end
           current = mutex.synchronize { queue.shift }
           return if queue.include?(current)
-          host.diagnose 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

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

@@ -76,7 +76,7 @@ module Solargraph
           source = Solargraph::Source.load(UriHelpers.uri_to_file(uri))
           open_source_hash[uri] = source
         end
-    
+
         # Update an existing source.
         #
         # @raise [FileNotFoundError] if the URI does not match an open source.

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

@@ -21,6 +21,7 @@ module Solargraph
             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

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

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-# Make sure the environment page can report RuboCop's version
-require 'rubocop'
-
 module Solargraph
   module LanguageServer
     module Message
@@ -12,6 +9,9 @@ module Solargraph
         #
         class Environment < Base
           def process
+            # Make sure the environment page can report RuboCop's version
+            require 'rubocop'
+
             page = Solargraph::Page.new(host.options['viewsPath'])
             content = page.render('environment', layout: true, locals: { config: host.options, folders: host.folders })
             set_result(

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

@@ -1,49 +1,44 @@
 # frozen_string_literal: true
 
-require 'benchmark'
-
 module Solargraph
   module LanguageServer
     module Message
       class Initialize < Base
         def process
-          bm = Benchmark.measure {
-            host.configure params['initializationOptions']
-            host.client_capabilities = params['capabilities']
-            if support_workspace_folders?
-              host.prepare_folders params['workspaceFolders']
-            elsif params['rootUri']
-              host.prepare UriHelpers.uri_to_file(params['rootUri'])
-            else
-              host.prepare params['rootPath']
-            end
-            result = {
-              capabilities: {
-                textDocumentSync: 2, # @todo What should this be?
-                workspace: {
-                  workspaceFolders: {
-                    supported: true,
-                    changeNotifications: true
-                  }
+          host.configure params['initializationOptions']
+          host.client_capabilities = params['capabilities']
+          if support_workspace_folders?
+            host.prepare_folders params['workspaceFolders']
+          elsif params['rootUri']
+            host.prepare UriHelpers.uri_to_file(params['rootUri'])
+          else
+            host.prepare params['rootPath']
+          end
+          result = {
+            capabilities: {
+              textDocumentSync: 2, # @todo What should this be?
+              workspace: {
+                workspaceFolders: {
+                  supported: true,
+                  changeNotifications: true
                 }
               }
             }
-            result[:capabilities].merge! static_completion unless dynamic_registration_for?('textDocument', 'completion')
-            result[:capabilities].merge! static_signature_help unless dynamic_registration_for?('textDocument', 'signatureHelp')
-            # result[:capabilities].merge! static_on_type_formatting unless dynamic_registration_for?('textDocument', 'onTypeFormatting')
-            result[:capabilities].merge! static_hover unless dynamic_registration_for?('textDocument', 'hover')
-            result[:capabilities].merge! static_document_formatting unless dynamic_registration_for?('textDocument', 'formatting')
-            result[:capabilities].merge! static_document_symbols unless dynamic_registration_for?('textDocument', 'documentSymbol')
-            result[:capabilities].merge! static_definitions unless dynamic_registration_for?('textDocument', 'definition')
-            result[:capabilities].merge! static_rename unless dynamic_registration_for?('textDocument', 'rename')
-            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)"
+          result[:capabilities].merge! static_completion unless dynamic_registration_for?('textDocument', 'completion')
+          result[:capabilities].merge! static_signature_help unless dynamic_registration_for?('textDocument', 'signatureHelp')
+          # result[:capabilities].merge! static_on_type_formatting unless dynamic_registration_for?('textDocument', 'onTypeFormatting')
+          result[:capabilities].merge! static_hover unless dynamic_registration_for?('textDocument', 'hover')
+          result[:capabilities].merge! static_document_formatting unless dynamic_registration_for?('textDocument', 'formatting')
+          result[:capabilities].merge! static_document_symbols unless dynamic_registration_for?('textDocument', 'documentSymbol')
+          result[:capabilities].merge! static_definitions unless dynamic_registration_for?('textDocument', 'definition')
+          result[:capabilities].merge! static_rename unless dynamic_registration_for?('textDocument', 'rename')
+          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
         end
 
         private
@@ -56,6 +51,7 @@ module Solargraph
         end
 
         def static_completion
+          return {} unless host.options['completion']
           {
             completionProvider: {
               resolveProvider: true,
@@ -89,18 +85,21 @@ module Solargraph
         end
 
         def static_hover
+          return {} unless host.options['hover']
           {
             hoverProvider: true
           }
         end
 
         def static_document_formatting
+          return {} unless host.options['formatting']
           {
             documentFormattingProvider: true
           }
         end
 
         def static_document_symbols
+          return {} unless host.options['symbols']
           {
             documentSymbolProvider: true
           }
@@ -113,6 +112,7 @@ module Solargraph
         end
 
         def static_definitions
+          return {} unless host.options['definitions']
           {
             definitionProvider: true
           }
@@ -125,12 +125,14 @@ module Solargraph
         end
 
         def static_references
+          return {} unless host.options['references']
           {
             referencesProvider: true
           }
         end
 
         def static_folding_range
+          return {} unless host.options['folding']
           {
             foldingRangeProvider: true
           }

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'rubocop'
 require 'securerandom'
 require 'tmpdir'
 
@@ -11,21 +10,22 @@ module Solargraph
         class Formatting < Base
           include Solargraph::Diagnostics::RubocopHelpers
 
-          class BlankRubocopFormatter < ::RuboCop::Formatter::BaseFormatter; end
-
           def process
             file_uri = params['textDocument']['uri']
             config = config_for(file_uri)
             original = host.read_text(file_uri)
             args = cli_args(file_uri, config)
 
+            require_rubocop(config['version'])
             options, paths = RuboCop::Options.new.parse(args)
             options[:stdin] = original
-            redirect_stdout do
+            corrections = redirect_stdout do
               RuboCop::Runner.new(options, RuboCop::ConfigStore.new).run(paths)
             end
             result = options[:stdin]
 
+            log_corrections(corrections)
+
             format original, result
           rescue RuboCop::ValidationError, RuboCop::ConfigNotFoundError => e
             set_error(Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, "[#{e.class}] #{e.message}")
@@ -33,6 +33,17 @@ module Solargraph
 
           private
 
+          def log_corrections(corrections)
+            corrections = corrections&.strip
+            return if corrections&.empty?
+
+            Solargraph.logger.info('Formatting result:')
+            corrections.each_line do |line|
+              next if line.strip.empty?
+              Solargraph.logger.info(line.strip)
+            end
+          end
+
           def config_for(file_uri)
             conf = host.formatter_config(file_uri)
             return {} unless conf.is_a?(Hash)
@@ -40,12 +51,12 @@ module Solargraph
             conf['rubocop'] || {}
           end
 
-          def cli_args file, config
+          def cli_args file_uri, config
+            file = UriHelpers.uri_to_file(file_uri)
             args = [
               config['cops'] == 'all' ? '--auto-correct-all' : '--auto-correct',
               '--cache', 'false',
-              '--format', 'Solargraph::LanguageServer::Message::' \
-                          'TextDocument::Formatting::BlankRubocopFormatter',
+              '--format', formatter_class(config).name,
             ]
 
             ['except', 'only'].each do |arg|
@@ -57,6 +68,16 @@ module Solargraph
             args + [file]
           end
 
+          def formatter_class(config)
+            if self.class.const_defined?('BlankRubocopFormatter')
+              BlankRubocopFormatter
+            else
+              require_rubocop(config['version'])
+              klass = Class.new(::RuboCop::Formatter::BaseFormatter)
+              self.class.const_set 'BlankRubocopFormatter', klass
+            end
+          end
+
           def cop_list(value)
             value = value.join(',') if value.respond_to?(:join)
             return nil if value == '' || !value.is_a?(String)