solargraph 0.58.3 → 0.59.0.dev.1

data/lib/solargraph/language_server/transport/data_reader.rb

@@ -1,74 +1,74 @@
-# frozen_string_literal: true
-
-require 'json'
-
-module Solargraph
-  module LanguageServer
-    module Transport
-      class DataReader
-        def initialize
-          @in_header = true
-          @content_length = 0
-          @buffer = String.new
-        end
-
-        # Declare a block to be executed for each message received from the
-        # client.
-        #
-        # @yieldparam [Hash] The message received from the client
-        # @return [void]
-        def set_message_handler &block
-          @message_handler = block
-        end
-
-        # Process raw data received from the client. The data will be parsed
-        # into messages based on the JSON-RPC protocol. Each message will be
-        # passed to the block declared via set_message_handler. Incomplete data
-        # will be buffered and subsequent data will be appended to the buffer.
-        #
-        # @param data [String]
-        # @return [void]
-        def receive data
-          data.each_char do |char|
-            @buffer.concat char
-            if @in_header
-              prepare_to_parse_message if @buffer.end_with?("\r\n\r\n")
-            else
-              parse_message_from_buffer if @buffer.bytesize == @content_length
-            end
-          end
-        end
-
-        private
-
-        # @return [void]
-        def prepare_to_parse_message
-          @in_header = false
-          @buffer.each_line do |line|
-            parts = line.split(':').map(&:strip)
-            if parts[0] == 'Content-Length'
-              @content_length = parts[1].to_i
-              break
-            end
-          end
-          @buffer.clear
-        end
-
-        # @return [void]
-        def parse_message_from_buffer
-          begin
-            msg = JSON.parse(@buffer)
-            @message_handler.call msg unless @message_handler.nil?
-          rescue JSON::ParserError => e
-            Solargraph::Logging.logger.warn "Failed to parse request: #{e.message}"
-            Solargraph::Logging.logger.debug "Buffer: #{@buffer}"
-          ensure
-            @buffer.clear
-            @in_header = true
-            @content_length = 0
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'json'
+
+module Solargraph
+  module LanguageServer
+    module Transport
+      class DataReader
+        def initialize
+          @in_header = true
+          @content_length = 0
+          @buffer = String.new
+        end
+
+        # Declare a block to be executed for each message received from the
+        # client.
+        #
+        # @yieldparam [Hash] The message received from the client
+        # @return [void]
+        def set_message_handler &block
+          @message_handler = block
+        end
+
+        # Process raw data received from the client. The data will be parsed
+        # into messages based on the JSON-RPC protocol. Each message will be
+        # passed to the block declared via set_message_handler. Incomplete data
+        # will be buffered and subsequent data will be appended to the buffer.
+        #
+        # @param data [String]
+        # @return [void]
+        def receive data
+          data.each_char do |char|
+            @buffer.concat char
+            if @in_header
+              prepare_to_parse_message if @buffer.end_with?("\r\n\r\n")
+            else
+              parse_message_from_buffer if @buffer.bytesize == @content_length
+            end
+          end
+        end
+
+        private
+
+        # @return [void]
+        def prepare_to_parse_message
+          @in_header = false
+          @buffer.each_line do |line|
+            parts = line.split(':').map(&:strip)
+            if parts[0] == 'Content-Length'
+              @content_length = parts[1].to_i
+              break
+            end
+          end
+          @buffer.clear
+        end
+
+        # @return [void]
+        def parse_message_from_buffer
+          begin
+            msg = JSON.parse(@buffer)
+            @message_handler.call msg unless @message_handler.nil?
+          rescue JSON::ParserError => e
+            Solargraph::Logging.logger.warn "Failed to parse request: #{e.message}"
+            Solargraph::Logging.logger.debug "Buffer: #{@buffer}"
+          ensure
+            @buffer.clear
+            @in_header = true
+            @content_length = 0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/uri_helpers.rb

@@ -1,49 +1,49 @@
-# frozen_string_literal: true
-
-require 'cgi'
-
-module Solargraph
-  module LanguageServer
-    # Methods to handle conversions between file URIs and paths.
-    #
-    module UriHelpers
-      module_function
-
-      # Convert a file URI to a path.
-      #
-      # @param uri [String]
-      # @return [String]
-      def uri_to_file uri
-        decode(uri).sub(/^file\:(?:\/\/)?/, '').sub(/^\/([a-z]\:)/i, '\1')
-      end
-
-      # Convert a file path to a URI.
-      #
-      # @param file [String]
-      # @return [String]
-      def file_to_uri file
-        "file://#{encode(file.gsub(/^([a-z]\:)/i, '/\1'))}"
-      end
-
-      # Encode text to be used as a URI path component in LSP.
-      #
-      # @param text [String]
-      # @return [String]
-      def encode text
-        CGI.escape(text)
-           .gsub('%3A', ':')
-           .gsub('%5C', '\\')
-           .gsub('%2F', '/')
-           .gsub('+', '%20')
-      end
-
-      # Decode text from a URI path component in LSP.
-      #
-      # @param text [String]
-      # @return [String]
-      def decode text
-        CGI.unescape(text)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'cgi'
+
+module Solargraph
+  module LanguageServer
+    # Methods to handle conversions between file URIs and paths.
+    #
+    module UriHelpers
+      module_function
+
+      # Convert a file URI to a path.
+      #
+      # @param uri [String]
+      # @return [String]
+      def uri_to_file uri
+        decode(uri).sub(/^file\:(?:\/\/)?/, '').sub(/^\/([a-z]\:)/i, '\1')
+      end
+
+      # Convert a file path to a URI.
+      #
+      # @param file [String]
+      # @return [String]
+      def file_to_uri file
+        "file://#{encode(file.gsub(/^([a-z]\:)/i, '/\1'))}"
+      end
+
+      # Encode text to be used as a URI path component in LSP.
+      #
+      # @param text [String]
+      # @return [String]
+      def encode text
+        CGI.escape(text)
+           .gsub('%3A', ':')
+           .gsub('%5C', '\\')
+           .gsub('%2F', '/')
+           .gsub('+', '%20')
+      end
+
+      # Decode text from a URI path component in LSP.
+      #
+      # @param text [String]
+      # @return [String]
+      def decode text
+        CGI.unescape(text)
+      end
+    end
+  end
+end

data/lib/solargraph/library.rb

@@ -1,9 +1,16 @@
 # frozen_string_literal: true
 
+require 'rubygems'
 require 'pathname'
 require 'observer'
 require 'open3'
 
+# @!parse
+#   class ::Gem::Specification
+#     # @return [String]
+#     def name; end
+#   end
+
 module Solargraph
   # A Library handles coordination between a Workspace and an ApiMap.
   #
@@ -33,6 +40,7 @@ module Solargraph
       # @type [Source, nil]
       @current = nil
       @sync_count = 0
+      @cache_progress = nil
     end
 
     def inspect
@@ -57,8 +65,11 @@ module Solargraph
     # @param source [Source, nil]
     # @return [void]
     def attach source
+      # @sg-ignore Need to add nil check here
       if @current && (!source || @current.filename != source.filename) && source_map_hash.key?(@current.filename) && !workspace.has_file?(@current.filename)
+        # @sg-ignore Need to add nil check here
         source_map_hash.delete @current.filename
+        # @sg-ignore Need to add nil check here
         source_map_external_require_hash.delete @current.filename
         @external_requires = nil
       end
@@ -182,9 +193,14 @@ module Solargraph
       if cursor.comment?
         source = read(filename)
         offset = Solargraph::Position.to_offset(source.code, Solargraph::Position.new(line, column))
+        # @sg-ignore Need to add nil check here
+        # @type [MatchData, nil]
         lft = source.code[0..offset-1].match(/\[[a-z0-9_:<, ]*?([a-z0-9_:]*)\z/i)
+        # @sg-ignore Need to add nil check here
+        # @type [MatchData, nil]
         rgt = source.code[offset..-1].match(/^([a-z0-9_]*)(:[a-z0-9_:]*)?[\]>, ]/i)
         if lft && rgt
+          # @sg-ignore Need to add nil check here
           tag = (lft[1] + rgt[1]).sub(/:+$/, '')
           clip = mutex.synchronize { api_map.clip(cursor) }
           clip.translate tag
@@ -255,15 +271,19 @@ module Solargraph
       files.uniq(&:filename).each do |source|
         found = source.references(pin.name)
         found.select! do |loc|
+          # @sg-ignore Need to add nil check here
+          # @type [Solargraph::Pin::Base, nil]
           referenced = definitions_at(loc.filename, loc.range.ending.line, loc.range.ending.character).first
           referenced&.path == pin.path
         end
         if pin.path == 'Class#new'
+          # @todo flow sensitive typing should allow shadowing of Kernel#caller
           caller = cursor.chain.base.infer(api_map, clip.send(:closure), clip.locals).first
           if caller.defined?
             found.select! do |loc|
               clip = api_map.clip_at(loc.filename, loc.range.start)
               other = clip.send(:cursor).chain.base.infer(api_map, clip.send(:closure), clip.locals).first
+              # @todo flow sensitive typing should allow shadowing of Kernel#caller
               caller == other
             end
           else
@@ -273,12 +293,13 @@ module Solargraph
         # HACK: for language clients that exclude special characters from the start of variable names
         if strip && match = cursor.word.match(/^[^a-z0-9_]+/i)
           found.map! do |loc|
-            Solargraph::Location.new(loc.filename, Solargraph::Range.from_to(loc.range.start.line, loc.range.start.column + match[0].length, loc.range.ending.line, loc.range.ending.column))
+            Solargraph::Location.new(loc.filename,
+                                     # @sg-ignore flow sensitive typing needs to handle if foo = bar
+                                     Solargraph::Range.from_to(loc.range.start.line, loc.range.start.column + match[0].length, loc.range.ending.line,
+                                                               loc.range.ending.column))
           end
         end
-        result.concat(found.sort do |a, b|
-          a.range.start.line <=> b.range.start.line
-        end)
+        result.concat(found.sort { |a, b| a.range.start.line <=> b.range.start.line })
       end
       result.uniq
     end
@@ -299,13 +320,12 @@ module Solargraph
     def locate_ref location
       map = source_map_hash[location.filename]
       return if map.nil?
+      # @sg-ignore Need to add nil check here
       pin = map.requires.select { |p| p.location.range.contain?(location.range.start) }.first
       return nil if pin.nil?
       # @param full [String]
       return_if_match = proc do |full|
-        if source_map_hash.key?(full)
-          return Location.new(full, Solargraph::Range.from_to(0, 0, 0, 0))
-        end
+        return Location.new(full, Solargraph::Range.from_to(0, 0, 0, 0)) if source_map_hash.key?(full)
       end
       workspace.require_paths.each do |path|
         full = File.join path, pin.name
@@ -403,6 +423,7 @@ module Solargraph
       workspace.config.reporters.each do |line|
         if line == 'all!'
           Diagnostics.reporters.each do |reporter_name|
+            # @sg-ignore Need to add nil check here
             repargs[Diagnostics.reporter(reporter_name)] ||= []
           end
         else
@@ -410,7 +431,9 @@ module Solargraph
           name = args.shift
           reporter = Diagnostics.reporter(name)
           raise DiagnosticsError, "Diagnostics reporter #{name} does not exist" if reporter.nil?
+          # @sg-ignore flow sensitive typing needs to handle 'raise if'
           repargs[reporter] ||= []
+          # @sg-ignore flow sensitive typing needs to handle 'raise if'
           repargs[reporter].concat args
         end
       end
@@ -433,6 +456,7 @@ module Solargraph
         source_maps: source_map_hash.values,
         workspace: workspace,
         external_requires: external_requires,
+        # @sg-ignore Need to add nil check here
         live_map: @current ? source_map_hash[@current.filename] : nil
       )
     end
@@ -469,10 +493,13 @@ module Solargraph
     # @return [SourceMap, Boolean]
     def next_map
       return false if mapped?
+      # @sg-ignore Need to add nil check here
       src = workspace.sources.find { |s| !source_map_hash.key?(s.filename) }
       if src
         Logging.logger.debug "Mapping #{src.filename}"
+        # @sg-ignore Need to add nil check here
         source_map_hash[src.filename] = Solargraph::SourceMap.map(src)
+        # @sg-ignore Need to add nil check here
         source_map_hash[src.filename]
       else
         false
@@ -482,7 +509,9 @@ module Solargraph
     # @return [self]
     def map!
       workspace.sources.each do |src|
+        # @sg-ignore Need to add nil check here
         source_map_hash[src.filename] = Solargraph::SourceMap.map(src)
+        # @sg-ignore Need to add nil check here
         find_external_requires source_map_hash[src.filename]
       end
       self
@@ -500,6 +529,11 @@ module Solargraph
 
     private
 
+    # @return [PinCache]
+    def pin_cache
+      workspace.pin_cache
+    end
+
     # @return [Hash{String => Array<String>}]
     def source_map_external_require_hash
       @source_map_external_require_hash ||= {}
@@ -513,6 +547,7 @@ module Solargraph
       # return if new_set == source_map_external_require_hash[source_map.filename]
       _filenames = nil
       filenames = ->{ _filenames ||= workspace.filenames.to_set }
+      # @sg-ignore Need to add nil check here
       source_map_external_require_hash[source_map.filename] = new_set.reject do |path|
         workspace.require_paths.any? do |base|
           full = File.join(base, path)
@@ -562,11 +597,15 @@ module Solargraph
     # @return [void]
     def maybe_map source
       return unless source
+      # @sg-ignore Need to add nil check here
       return unless @current == source || workspace.has_file?(source.filename)
+      # @sg-ignore Need to add nil check here
       if source_map_hash.key?(source.filename)
         new_map = Solargraph::SourceMap.map(source)
+        # @sg-ignore Need to add nil check here
         source_map_hash[source.filename] = new_map
       else
+        # @sg-ignore Need to add nil check here
         source_map_hash[source.filename] = Solargraph::SourceMap.map(source)
       end
     end
@@ -585,7 +624,7 @@ module Solargraph
 
       pending = api_map.uncached_gemspecs.length - cache_errors.length - 1
 
-      if Yardoc.processing?(spec)
+      if pin_cache.yardoc_processing?(spec)
         logger.info "Enqueuing cache of #{spec.name} #{spec.version} (already being processed)"
         queued_gemspec_cache.push(spec)
         return if pending - queued_gemspec_cache.length < 1
@@ -596,7 +635,10 @@ module Solargraph
         logger.info "Caching #{spec.name} #{spec.version}"
         Thread.new do
           report_cache_progress spec.name, pending
-          _o, e, s = Open3.capture3(workspace.command_path, 'cache', spec.name, spec.version.to_s)
+          kwargs = {}
+          kwargs[:chdir] = workspace.directory.to_s if workspace.directory && !workspace.directory.empty?
+          _o, e, s = Open3.capture3(workspace.command_path, 'cache', spec.name, spec.version.to_s,
+                                    **kwargs)
           if s.success?
             logger.info "Cached #{spec.name} #{spec.version}"
           else
@@ -613,8 +655,7 @@ module Solargraph
 
     # @return [Array<Gem::Specification>]
     def cacheable_specs
-      cacheable = api_map.uncached_yard_gemspecs +
-                  api_map.uncached_rbs_collection_gemspecs -
+      cacheable = api_map.uncached_gemspecs +
                   queued_gemspec_cache -
                   cache_errors.to_a
       return cacheable unless cacheable.empty?
@@ -632,11 +673,15 @@ module Solargraph
     # @return [void]
     def report_cache_progress gem_name, pending
       @total ||= pending
+      # @sg-ignore flow sensitive typing needs better handling of ||= on lvars
       @total = pending if pending > @total
+      # @sg-ignore flow sensitive typing needs better handling of ||= on lvars
       finished = @total - pending
+      # @sg-ignore flow sensitive typing needs better handling of ||= on lvars
       pct = if @total.zero?
         0
       else
+        # @sg-ignore flow sensitive typing needs better handling of ||= on lvars
         ((finished.to_f / @total.to_f) * 100).to_i
       end
       message = "#{gem_name}#{pending > 0 ? " (+#{pending})" : ''}"
@@ -647,9 +692,11 @@ module Solargraph
         @cache_progress = LanguageServer::Progress.new('Caching gem')
         # If we don't send both a begin and a report, the progress notification
         # might get stuck in the status bar forever
+        # @sg-ignore flow sensitive typing should be able to handle redefinition
         @cache_progress.begin(message, pct)
         changed
         notify_observers @cache_progress
+        # @sg-ignore flow sensitive typing should be able to handle redefinition
         @cache_progress.report(message, pct)
       end
       changed
@@ -673,8 +720,7 @@ module Solargraph
         source_map_hash.values.each { |map| find_external_requires(map) }
         api_map.catalog bench
         logger.info "Catalog complete (#{api_map.source_maps.length} files, #{api_map.pins.length} pins)"
-        logger.info "#{api_map.uncached_yard_gemspecs.length} uncached YARD gemspecs"
-        logger.info "#{api_map.uncached_rbs_collection_gemspecs.length} uncached RBS collection gemspecs"
+        logger.info "#{api_map.uncached_gemspecs.length} uncached gemspecs"
         cache_next_gemspec
         @sync_count = 0
       end

data/lib/solargraph/location.rb

@@ -6,6 +6,7 @@ module Solargraph
   #
   class Location
     include Equality
+    include Comparable
 
     # @return [String]
     attr_reader :filename
@@ -13,14 +14,15 @@ module Solargraph
     # @return [Solargraph::Range]
     attr_reader :range
 
-    # @param filename [String]
+    # @param filename [String, nil]
     # @param range [Solargraph::Range]
     def initialize filename, range
+      raise "Use nil to represent no-file" if filename&.empty?
+
       @filename = filename
       @range = range
     end
 
-    # @sg-ignore Fix "Not enough arguments to Module#protected"
     protected def equality_fields
       [filename, range]
     end
@@ -64,14 +66,17 @@ module Solargraph
     # @return [Location, nil]
     def self.from_node(node)
       return nil if node.nil? || node.loc.nil?
+      filename = node.loc.expression.source_buffer.name
+      # @sg-ignore flow sensitive typing needs to create separate ranges for postfix if
+      filename = nil if filename.empty?
       range = Range.from_node(node)
-      self.new(node.loc.expression.source_buffer.name, range)
+      # @sg-ignore Need to add nil check here
+      self.new(filename, range)
     end
 
     # @param other [BasicObject]
     def == other
       return false unless other.is_a?(Location)
-      # @sg-ignore https://github.com/castwide/solargraph/pull/1114
       filename == other.filename and range == other.range
     end
 

data/lib/solargraph/logging.rb

@@ -29,9 +29,29 @@ module Solargraph
 
     module_function
 
+    # override this in your class to temporarily set a custom
+    # filtering log level for the class (e.g., suppress any debug
+    # message by setting it to :info even if it is set elsewhere, or
+    # show existing debug messages by setting to :debug).
+    #
+    # @return [Symbol]
+    def log_level
+      :warn
+    end
+
     # @return [Logger]
     def logger
-      @@logger
+      if LOG_LEVELS[log_level.to_s] == DEFAULT_LOG_LEVEL
+        @@logger
+      else
+        new_log_level = LOG_LEVELS[log_level.to_s]
+        logger = Logger.new(STDERR, level: new_log_level)
+
+        # @sg-ignore Wrong argument type for Logger#formatter=: arg_0
+        #   expected nil, received Logger::_Formatter, nil
+        logger.formatter = @@logger.formatter
+        logger
+      end
     end
   end
 end