solargraph 0.40.0 → 0.41.0

data/lib/solargraph/language_server/host.rb

@@ -2,6 +2,7 @@
 
 require 'observer'
 require 'set'
+require 'securerandom'
 
 module Solargraph
   module LanguageServer
@@ -192,7 +193,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 +278,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,
@@ -494,6 +496,11 @@ module Solargraph
         library.read_text(filename)
       end
 
+      def formatter_config uri
+        library = library_for(uri)
+        library.workspace.config.formatter
+      end
+
       # @param uri [String]
       # @param line [Integer]
       # @param column [Integer]
@@ -626,6 +633,7 @@ module Solargraph
 
       # @return [void]
       def catalog
+        return unless libraries.all?(&:mapped?)
         libraries.each(&:catalog)
       end
 
@@ -736,6 +744,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/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

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'rubocop'
 require 'securerandom'
+require 'tmpdir'
 
 module Solargraph
   module LanguageServer
@@ -11,31 +11,79 @@ module Solargraph
           include Solargraph::Diagnostics::RubocopHelpers
 
           def process
-            filename = uri_to_file(params['textDocument']['uri'])
-            # Make the temp file in the original file's directory so RuboCop
-            # detects the correct configuration
-            # the .rb extension is needed for ruby file without extension, else rubocop won't format
-            tempfile = File.join(File.dirname(filename), "_tmp_#{SecureRandom.hex(8)}_#{File.basename(filename)}.rb")
-            rubocop_file = Diagnostics::RubocopHelpers.find_rubocop_file(filename)
-            original = host.read_text(params['textDocument']['uri'])
-            File.write tempfile, original
-            begin
-              args = ['-a', '-f', 'fi', tempfile]
-              args.unshift('-c', fix_drive_letter(rubocop_file)) unless rubocop_file.nil?
-              options, paths = RuboCop::Options.new.parse(args)
-              store = RuboCop::ConfigStore.new
-              redirect_stdout { RuboCop::Runner.new(options, store).run(paths) }
-              result = File.read(tempfile)
-              format original, result
-            rescue RuboCop::ValidationError, RuboCop::ConfigNotFoundError => e
-              set_error(Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, "[#{e.class}] #{e.message}")
-            ensure
-              File.unlink tempfile
+            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
+            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}")
           end
 
           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)
+
+            conf['rubocop'] || {}
+          end
+
+          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', formatter_class(config).name,
+            ]
+
+            ['except', 'only'].each do |arg|
+              cops = cop_list(config[arg])
+              args += ["--#{arg}", cops] if cops
+            end
+
+            args += config['extra_args'] if config['extra_args']
+            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)
+            value
+          end
+
           # @param original [String]
           # @param result [String]
           # @return [void]

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

@@ -17,7 +17,7 @@ module Solargraph
               if !this_link.nil? && this_link != last_link
                 parts.push this_link
               end
-              parts.push pin.detail.gsub(':', '\\:') unless pin.is_a?(Pin::Namespace) || pin.detail.nil?
+              parts.push "`" + pin.detail.gsub(':', '\\:') + "`" unless pin.is_a?(Pin::Namespace) || pin.detail.nil?
               parts.push pin.documentation unless pin.documentation.nil? || pin.documentation.empty?
               unless parts.empty?
                 data = parts.join("\n\n")

data/lib/solargraph/library.rb

@@ -20,9 +20,7 @@ module Solargraph
     def initialize workspace = Solargraph::Workspace.new, name = nil
       @workspace = workspace
       @name = name
-      api_map.catalog bench
-      @synchronized = true
-      @catalog_mutex = Mutex.new
+      @synchronized = false
     end
 
     def inspect
@@ -48,9 +46,13 @@ module Solargraph
     # @return [void]
     def attach source
       mutex.synchronize do
-        @synchronized = (@current == source) if synchronized?
+        if @current && @current.filename != source.filename && source_map_hash.key?(@current.filename) && !workspace.has_file?(@current.filename)
+          source_map_hash.delete @current.filename
+          @synchronized = false
+        end
         @current = source
-        catalog
+        maybe_map @current
+        api_map.catalog bench unless synchronized?
       end
     end
 
@@ -110,9 +112,9 @@ module Solargraph
       mutex.synchronize do
         next if File.directory?(filename) || !File.exist?(filename)
         next unless contain?(filename) || open?(filename) || workspace.would_merge?(filename)
-        @synchronized = false
         source = Solargraph::Source.load_string(File.read(filename), filename)
         workspace.merge(source)
+        maybe_map source
         result = true
       end
       result
@@ -158,6 +160,8 @@ module Solargraph
       position = Position.new(line, column)
       cursor = Source::Cursor.new(read(filename), position)
       api_map.clip(cursor).complete
+    rescue FileNotFoundError => e
+      handle_file_not_found filename, e
     end
 
     # Get definition suggestions for the expression at the specified file and
@@ -186,6 +190,8 @@ module Solargraph
       else
         api_map.clip(cursor).define.map { |pin| pin.realize(api_map) }
       end
+    rescue FileNotFoundError => e
+      handle_file_not_found(filename, e)
     end
 
     # Get signature suggestions for the method at the specified file and
@@ -209,7 +215,6 @@ module Solargraph
     # @return [Array<Solargraph::Range>]
     # @todo Take a Location instead of filename/line/column
     def references_from filename, line, column, strip: false
-      # checkout filename
       cursor = api_map.cursor_at(filename, Position.new(line, column))
       clip = api_map.clip(cursor)
       pins = clip.define
@@ -222,7 +227,7 @@ module Solargraph
             referenced = definitions_at(loc.filename, loc.range.ending.line, loc.range.ending.character)
             # HACK: The additional location comparison is necessary because
             # Clip#define can return proxies for parameter pins
-            referenced.any?{|r| r == pin || r.location == pin.location}
+            referenced.any? { |r| r == pin || r.location == pin.location }
           end
           # HACK: for language clients that exclude special characters from the start of variable names
           if strip && match = cursor.word.match(/^[^a-z0-9_]+/i)
@@ -261,14 +266,12 @@ module Solargraph
     # @param query [String]
     # @return [Array<YARD::CodeObjects::Base>]
     def document query
-      catalog
       api_map.document query
     end
 
     # @param query [String]
     # @return [Array<String>]
     def search query
-      catalog
       api_map.search query
     end
 
@@ -277,7 +280,6 @@ module Solargraph
     # @param query [String]
     # @return [Array<Pin::Base>]
     def query_symbols query
-      catalog
       api_map.query_symbols query
     end
 
@@ -290,17 +292,19 @@ module Solargraph
     # @param filename [String]
     # @return [Array<Solargraph::Pin::Base>]
     def document_symbols filename
-      # checkout filename
       api_map.document_symbols(filename)
     end
 
     # @param path [String]
     # @return [Array<Solargraph::Pin::Base>]
     def path_pins path
-      catalog
       api_map.get_path_suggestions(path)
     end
 
+    def source_maps
+      source_map_hash.values
+    end
+
     # Get the current text of a file in the library.
     #
     # @param filename [String]
@@ -320,7 +324,6 @@ module Solargraph
       #   be an option to do so.
       #
       return [] unless open?(filename)
-      catalog
       result = []
       source = read(filename)
       repargs = {}
@@ -348,7 +351,7 @@ module Solargraph
     #
     # @return [void]
     def catalog
-      @catalog_mutex.synchronize do
+      mutex.synchronize do
         break if synchronized?
         logger.info "Cataloging #{workspace.directory.empty? ? 'generic workspace' : workspace.directory}"
         api_map.catalog bench
@@ -357,6 +360,16 @@ module Solargraph
       end
     end
 
+    def bench
+      source_maps = @current ? [@current] : []
+      source_maps.concat source_map_hash.values
+      Bench.new(
+        source_maps: source_maps,
+        load_paths: workspace.require_paths,
+        gemnames: workspace.gemnames
+      )
+    end
+
     # Get an array of foldable ranges for the specified file.
     #
     # @deprecated The library should not need to handle folding ranges. The
@@ -383,14 +396,49 @@ module Solargraph
     # @param source [Source]
     # @return [Boolean] True if the source was merged into the workspace.
     def merge source
+      Logging.logger.debug "Merging source: #{source.filename}"
       result = false
       mutex.synchronize do
         result = workspace.merge(source)
-        @synchronized = !result if synchronized?
+        maybe_map source
       end
+      # catalog
       result
     end
 
+    def source_map_hash
+      @source_map_hash ||= {}
+    end
+
+    def mapped?
+      (workspace.filenames - source_map_hash.keys).empty?
+    end
+
+    def next_map
+      return false if mapped?
+      mutex.synchronize do
+        @synchronized = false
+        src = workspace.sources.find { |s| !source_map_hash.key?(s.filename) }
+        if src
+          Logging.logger.debug "Mapping #{src.filename}"
+          source_map_hash[src.filename] = Solargraph::SourceMap.map(src)
+        else
+          false
+        end
+      end
+    end
+
+    def map!
+      workspace.sources.each do |src|
+        source_map_hash[src.filename] = Solargraph::SourceMap.map(src)
+      end
+      self
+    end
+
+    def pins
+      @pins ||= []
+    end
+
     private
 
     # @return [Mutex]
@@ -403,14 +451,6 @@ module Solargraph
       @api_map ||= Solargraph::ApiMap.new
     end
 
-    # @return [Bench]
-    def bench
-      Bench.new(
-        workspace: workspace,
-        opened: @current ? [@current] : []
-      )
-    end
-
     # Get the source for an open file or create a new source if the file
     # exists on disk. Sources created from disk are not added to the open
     # workspace files, i.e., the version on disk remains the authoritative
@@ -424,5 +464,35 @@ module Solargraph
       raise FileNotFoundError, "File not found: #{filename}" unless workspace.has_file?(filename)
       workspace.source(filename)
     end
+
+    def handle_file_not_found filename, error
+      if workspace.source(filename)
+        Solargraph.logger.debug "#{filename} is not cataloged in the ApiMap"
+        nil
+      else
+        raise error
+      end
+    end
+
+    def maybe_map source
+      if source_map_hash.key?(source.filename)
+        return if source_map_hash[source.filename].code == source.code && 
+          source_map_hash[source.filename].source.synchronized? &&
+          source.synchronized?
+        if source.synchronized?
+          new_map = Solargraph::SourceMap.map(source)
+          unless source_map_hash[source.filename].try_merge!(new_map)
+            source_map_hash[source.filename] = new_map
+            @synchronized = false
+          end
+        else
+          # @todo Smelly instance variable access
+          source_map_hash[source.filename].instance_variable_set(:@source, source)
+        end
+      else
+        source_map_hash[source.filename] = Solargraph::SourceMap.map(source)
+        @synchronized = false
+      end
+    end
   end
 end