solargraph 0.58.3 → 0.59.2

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

@@ -1,68 +1,68 @@
-# frozen_string_literal: true
-
-require 'backport'
-
-module Solargraph
-  module LanguageServer
-    module Transport
-      # A common module for running language servers in Backport.
-      #
-      module Adapter
-        # This runs in the context of Backport::Adapter, which
-        # provides write() - but if we didn't hide this behind a parse
-        # tag, it would override the one in the class.
-        #
-        # @!method write(text)
-        #   @abstract
-        #   Write the change to the specified text.
-        #   @param text [String] The text to be changed.
-        #   @return [String] The updated text.
-
-        # @return [void]
-        def opening
-          @host = Solargraph::LanguageServer::Host.new
-          @host.add_observer self
-          @host.start
-          @data_reader = Solargraph::LanguageServer::Transport::DataReader.new
-          @data_reader.set_message_handler do |message|
-            process message
-          end
-        end
-
-        # @return [void]
-        def closing
-          @host.stop
-        end
-
-        # @param data [String]
-        # @return [void]
-        def receiving data
-          @data_reader.receive data
-        end
-
-        # @return [void]
-        def update
-          if @host.stopped?
-            shutdown
-          else
-            tmp = @host.flush
-            write tmp unless tmp.empty?
-          end
-        end
-
-        private
-
-        # @param request [Hash]
-        # @return [void]
-        def process request
-          @host.process(request)
-        end
-
-        # @return [void]
-        def shutdown
-          Backport.stop unless @host.options['transport'] == 'external'
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'backport'
+
+module Solargraph
+  module LanguageServer
+    module Transport
+      # A common module for running language servers in Backport.
+      #
+      module Adapter
+        # This runs in the context of Backport::Adapter, which
+        # provides write() - but if we didn't hide this behind a parse
+        # tag, it would override the one in the class.
+        #
+        # @!method write(text)
+        #   @abstract
+        #   Write the change to the specified text.
+        #   @param text [String] The text to be changed.
+        #   @return [String] The updated text.
+
+        # @return [void]
+        def opening
+          @host = Solargraph::LanguageServer::Host.new
+          @host.add_observer self
+          @host.start
+          @data_reader = Solargraph::LanguageServer::Transport::DataReader.new
+          @data_reader.set_message_handler do |message|
+            process message
+          end
+        end
+
+        # @return [void]
+        def closing
+          @host.stop
+        end
+
+        # @param data [String]
+        # @return [void]
+        def receiving data
+          @data_reader.receive data
+        end
+
+        # @return [void]
+        def update
+          if @host.stopped?
+            shutdown
+          else
+            tmp = @host.flush
+            write tmp unless tmp.empty?
+          end
+        end
+
+        private
+
+        # @param request [Hash]
+        # @return [void]
+        def process request
+          @host.process(request)
+        end
+
+        # @return [void]
+        def shutdown
+          Backport.stop unless @host.options['transport'] == 'external'
+        end
+      end
+    end
+  end
+end

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

@@ -33,8 +33,8 @@ module Solargraph
             @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
+            elsif @buffer.bytesize == @content_length
+              parse_message_from_buffer
             end
           end
         end
@@ -56,17 +56,15 @@ module Solargraph
 
         # @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
+          msg = JSON.parse(@buffer)
+          @message_handler&.call msg
+        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

data/lib/solargraph/language_server/uri_helpers.rb

@@ -14,7 +14,7 @@ module Solargraph
       # @param uri [String]
       # @return [String]
       def uri_to_file uri
-        decode(uri).sub(/^file\:(?:\/\/)?/, '').sub(/^\/([a-z]\:)/i, '\1')
+        decode(uri).sub(%r{^file:(?://)?}, '').sub(%r{^/([a-z]:)}i, '\1')
       end
 
       # Convert a file path to a URI.
@@ -22,7 +22,7 @@ module Solargraph
       # @param file [String]
       # @return [String]
       def file_to_uri file
-        "file://#{encode(file.gsub(/^([a-z]\:)/i, '/\1'))}"
+        "file://#{encode(file.gsub(/^([a-z]:)/i, '/\1'))}"
       end
 
       # Encode text to be used as a URI path component in LSP.

data/lib/solargraph/language_server.rb

@@ -1,20 +1,20 @@
-# frozen_string_literal: true
-
-require 'solargraph/language_server/error_codes'
-require 'solargraph/language_server/completion_item_kinds'
-require 'solargraph/language_server/symbol_kinds'
-
-module Solargraph
-  # The LanguageServer namespace contains the classes and modules that compose
-  # concrete implementations of language servers.
-  #
-  module LanguageServer
-    autoload :Host,         'solargraph/language_server/host'
-    autoload :Message,      'solargraph/language_server/message'
-    autoload :UriHelpers,   'solargraph/language_server/uri_helpers'
-    autoload :MessageTypes, 'solargraph/language_server/message_types'
-    autoload :Request,      'solargraph/language_server/request'
-    autoload :Transport,    'solargraph/language_server/transport'
-    autoload :Progress,     'solargraph/language_server/progress'
-  end
-end
+# frozen_string_literal: true
+
+require 'solargraph/language_server/error_codes'
+require 'solargraph/language_server/completion_item_kinds'
+require 'solargraph/language_server/symbol_kinds'
+
+module Solargraph
+  # The LanguageServer namespace contains the classes and modules that compose
+  # concrete implementations of language servers.
+  #
+  module LanguageServer
+    autoload :Host,         'solargraph/language_server/host'
+    autoload :Message,      'solargraph/language_server/message'
+    autoload :UriHelpers,   'solargraph/language_server/uri_helpers'
+    autoload :MessageTypes, 'solargraph/language_server/message_types'
+    autoload :Request,      'solargraph/language_server/request'
+    autoload :Transport,    'solargraph/language_server/transport'
+    autoload :Progress,     'solargraph/language_server/progress'
+  end
+end

data/lib/solargraph/library.rb

@@ -57,9 +57,11 @@ module Solargraph
     # @param source [Source, nil]
     # @return [void]
     def attach source
-      if @current && (!source || @current.filename != source.filename) && source_map_hash.key?(@current.filename) && !workspace.has_file?(@current.filename)
-        source_map_hash.delete @current.filename
-        source_map_external_require_hash.delete @current.filename
+      # @type [String, nil]
+      current_filename = @current&.filename
+      if @current && (!source || current_filename != source.filename) && current_filename && source_map_hash.key?(current_filename) && !workspace.has_file?(current_filename)
+        source_map_hash.delete current_filename
+        source_map_external_require_hash.delete current_filename
         @external_requires = nil
       end
       changed = source && @current != source
@@ -116,8 +118,8 @@ module Solargraph
     # @return [Boolean] True if at least one file was added to the workspace.
     def create_from_disk *filenames
       sources = filenames
-        .reject { |filename| File.directory?(filename) || !File.exist?(filename) }
-        .map { |filename| Solargraph::Source.load_string(File.read(filename), filename) }
+                .reject { |filename| File.directory?(filename) || !File.exist?(filename) }
+                .map { |filename| Solargraph::Source.load_string(File.read(filename), filename) }
       result = workspace.merge(*sources)
       sources.each { |source| maybe_map source }
       result
@@ -182,9 +184,12 @@ module Solargraph
       if cursor.comment?
         source = read(filename)
         offset = Solargraph::Position.to_offset(source.code, Solargraph::Position.new(line, column))
-        lft = source.code[0..offset-1].match(/\[[a-z0-9_:<, ]*?([a-z0-9_:]*)\z/i)
-        rgt = source.code[offset..-1].match(/^([a-z0-9_]*)(:[a-z0-9_:]*)?[\]>, ]/i)
+        # @type [MatchData, nil]
+        lft = source.code[0..(offset - 1)]&.match(/\[[a-z0-9_:<, ]*?([a-z0-9_:]*)\z/i)
+        # @type [MatchData, nil]
+        rgt = source.code[offset..]&.match(/^([a-z0-9_]*)(:[a-z0-9_:]*)?[\]>, ]/i)
         if lft && rgt
+          # @sg-ignore lft and rgt are checked for nil above
           tag = (lft[1] + rgt[1]).sub(/:+$/, '')
           clip = mutex.synchronize { api_map.clip(cursor) }
           clip.translate tag
@@ -246,16 +251,17 @@ module Solargraph
       clip = mutex.synchronize { api_map.clip(cursor) }
       pin = clip.define.first
       return [] unless pin
+
       result = []
       files = if only
-        [api_map.source_map(filename)]
-      else
-        (workspace.sources + (@current ? [@current] : []))
-      end
+                [api_map.source_map(filename)]
+              else
+                (workspace.sources + (@current ? [@current] : []))
+              end
       files.uniq(&:filename).each do |source|
         found = source.references(pin.name)
         found.select! do |loc|
-          referenced = definitions_at(loc.filename, loc.range.ending.line, loc.range.ending.character).first
+          referenced = definitions_at(loc.filename, loc.range.ending.line, loc.range.ending.character)&.first
           referenced&.path == pin.path
         end
         if pin.path == 'Class#new'
@@ -271,8 +277,9 @@ module Solargraph
           end
         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)
+        if strip && (match = cursor.word.match(/^[^a-z0-9_]+/i))
           found.map! do |loc|
+            # @sg-ignore Unresolved call to []
             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))
           end
         end
@@ -299,7 +306,7 @@ module Solargraph
     def locate_ref location
       map = source_map_hash[location.filename]
       return if map.nil?
-      pin = map.requires.select { |p| p.location.range.contain?(location.range.start) }.first
+      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|
@@ -309,8 +316,8 @@ module Solargraph
       end
       workspace.require_paths.each do |path|
         full = File.join path, pin.name
-        return_if_match.(full)
-        return_if_match.(full << ".rb")
+        return_if_match.call(full)
+        return_if_match.call(full << '.rb')
       end
       nil
     rescue FileNotFoundError
@@ -403,14 +410,17 @@ module Solargraph
       workspace.config.reporters.each do |line|
         if line == 'all!'
           Diagnostics.reporters.each do |reporter_name|
-            repargs[Diagnostics.reporter(reporter_name)] ||= []
+            r = Diagnostics.reporter(reporter_name)
+            repargs[r] ||= [] if r
           end
         else
           args = line.split(':').map(&:strip)
           name = args.shift
           reporter = Diagnostics.reporter(name)
           raise DiagnosticsError, "Diagnostics reporter #{name} does not exist" if reporter.nil?
+          # @sg-ignore Hash errors
           repargs[reporter] ||= []
+          # @sg-ignore Hash errors
           repargs[reporter].concat args
         end
       end
@@ -433,6 +443,7 @@ module Solargraph
         source_maps: source_map_hash.values,
         workspace: workspace,
         external_requires: external_requires,
+        # @sg-ignore OK if @current.filename is nil
         live_map: @current ? source_map_hash[@current.filename] : nil
       )
     end
@@ -472,7 +483,9 @@ module Solargraph
       src = workspace.sources.find { |s| !source_map_hash.key?(s.filename) }
       if src
         Logging.logger.debug "Mapping #{src.filename}"
+        # @sg-ignore OK if src.filename is nil
         source_map_hash[src.filename] = Solargraph::SourceMap.map(src)
+        # @sg-ignore OK if src.filename is nil
         source_map_hash[src.filename]
       else
         false
@@ -482,7 +495,9 @@ module Solargraph
     # @return [self]
     def map!
       workspace.sources.each do |src|
+        # @sg-ignore OK if src.filename is nil
         source_map_hash[src.filename] = Solargraph::SourceMap.map(src)
+        # @sg-ignore OK if src.filename is nil
         find_external_requires source_map_hash[src.filename]
       end
       self
@@ -509,14 +524,14 @@ module Solargraph
     # @return [void]
     def find_external_requires source_map
       # @type [Set<String>]
-      new_set = source_map.requires.map(&:name).to_set
-      # return if new_set == source_map_external_require_hash[source_map.filename]
+      new_set = source_map.requires.to_set(&:name)
       _filenames = nil
-      filenames = ->{ _filenames ||= workspace.filenames.to_set }
+      filenames = -> { _filenames ||= workspace.filenames.to_set }
+      # @sg-ignore OK if source_map.filename is nil
       source_map_external_require_hash[source_map.filename] = new_set.reject do |path|
         workspace.require_paths.any? do |base|
           full = File.join(base, path)
-          filenames[].include?(full) or filenames[].include?(full << ".rb")
+          filenames[].include?(full) or filenames[].include?(full << '.rb')
         end
       end
       @external_requires = nil
@@ -550,23 +565,23 @@ module Solargraph
     # @param error [FileNotFoundError]
     # @return [nil]
     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
+      raise error unless workspace.source(filename)
+      Solargraph.logger.debug "#{filename} is not cataloged in the ApiMap"
+      nil
     end
 
     # @param source [Source, nil]
     # @return [void]
     def maybe_map source
       return unless source
+      # @sg-ignore Wrong argument type for Solargraph::Workspace#has_file?: filename expected String, received String, nil
       return unless @current == source || workspace.has_file?(source.filename)
       if source_map_hash.key?(source.filename)
         new_map = Solargraph::SourceMap.map(source)
+        # @sg-ignore OK if source.filename is nil
         source_map_hash[source.filename] = new_map
       else
+        # @sg-ignore OK if source.filename is nil
         source_map_hash[source.filename] = Solargraph::SourceMap.map(source)
       end
     end
@@ -632,26 +647,30 @@ module Solargraph
     # @return [void]
     def report_cache_progress gem_name, pending
       @total ||= pending
+      # @sg-ignore Wrong argument type for Integer#>: arg_0 expected Numeric, received Integer, nil
       @total = pending if pending > @total
+      # @sg-ignore Unresolved call to - on Integer, nil
       finished = @total - pending
+      # @sg-ignore @total should always be an Integer
       pct = if @total.zero?
-        0
-      else
-        ((finished.to_f / @total.to_f) * 100).to_i
-      end
-      message = "#{gem_name}#{pending > 0 ? " (+#{pending})" : ''}"
+              0
+            else
+              # @sg-ignore Unresolved call to to_f
+              ((finished.to_f / @total) * 100).to_i
+            end
+      message = "#{gem_name}#{" (+#{pending})" if pending.positive?}"
       # "
-      if @cache_progress
-        @cache_progress.report(message, pct)
-      else
+      unless @cache_progress
         @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 Unresolved call to begin
         @cache_progress.begin(message, pct)
         changed
         notify_observers @cache_progress
-        @cache_progress.report(message, pct)
       end
+      # @sg-ignore Unresolved call to report
+      @cache_progress.report(message, pct)
       changed
       notify_observers @cache_progress
     end
@@ -666,11 +685,11 @@ module Solargraph
 
     # @return [void]
     def sync_catalog
-      return if @sync_count == 0
+      return if @sync_count.zero?
 
       mutex.synchronize do
         logger.info "Cataloging #{workspace.directory.empty? ? 'generic workspace' : workspace.directory}"
-        source_map_hash.values.each { |map| find_external_requires(map) }
+        source_map_hash.each_value { |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"

data/lib/solargraph/location.rb

@@ -6,6 +6,7 @@ module Solargraph
   #
   class Location
     include Equality
+    include Comparable
 
     # @return [String]
     attr_reader :filename
@@ -13,20 +14,17 @@ 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
-
     # @param other [self]
-    def <=>(other)
+    def <=> other
       return nil unless other.is_a?(Location)
       if filename == other.filename
         range <=> other.range
@@ -44,10 +42,6 @@ module Solargraph
       range.contain?(location.range.start) && range.contain?(location.range.ending) && filename == location.filename
     end
 
-    def inspect
-      "<#{self.class.name}: filename=#{filename}, range=#{range.inspect}>"
-    end
-
     def to_s
       inspect
     end
@@ -62,21 +56,30 @@ module Solargraph
 
     # @param node [Parser::AST::Node, nil]
     # @return [Location, nil]
-    def self.from_node(node)
+    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
+      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
 
     def inspect
       "#<#{self.class} #{filename}, #{range.inspect}>"
     end
+
+    protected
+
+    def equality_fields
+      [filename, range]
+    end
   end
 end

data/lib/solargraph/logging.rb

@@ -10,7 +10,7 @@ module Solargraph
       'warn' => Logger::WARN,
       'info' => Logger::INFO,
       'debug' => Logger::DEBUG
-    }
+    }.freeze
     configured_level = ENV.fetch('SOLARGRAPH_LOG', nil)
     level = if LOG_LEVELS.keys.include?(configured_level)
               LOG_LEVELS.fetch(configured_level)
@@ -21,17 +21,35 @@ module Solargraph
               end
               DEFAULT_LOG_LEVEL
             end
-    @@logger = Logger.new(STDERR, level: level)
+    @@logger = Logger.new($stderr, level: level)
     # @sg-ignore Fix cvar issue
-    @@logger.formatter = proc do |severity, datetime, progname, msg|
+    @@logger.formatter = proc do |severity, _datetime, _progname, msg|
       "[#{severity}] #{msg}\n"
     end
 
     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)
+
+        logger.formatter = @@logger.formatter
+        logger
+      end
     end
   end
 end

data/lib/solargraph/page.rb

@@ -49,7 +49,7 @@ module Solargraph
 
     # @param directory [String]
     def initialize directory = VIEWS_PATH
-      directory = VIEWS_PATH if directory.nil? or !File.directory?(directory)
+      directory = VIEWS_PATH if directory.nil? || !File.directory?(directory)
       directories = [directory]
       directories.push VIEWS_PATH if directory != VIEWS_PATH
       # @type [Proc]

data/lib/solargraph/parser/comment_ripper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ripper'
 
 module Solargraph
@@ -23,37 +25,50 @@ module Solargraph
         # @sg-ignore
         # @type [Array(Symbol, String, Array([Integer, nil], [Integer, nil]))]
         result = super
+        # @sg-ignore Need to add nil check here
         if @buffer_lines[result[2][0]][0..result[2][1]].strip =~ /^#/
           chomped = result[1].chomp
-          if result[2][0] == 0 && chomped.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '').match(/^#\s*frozen_string_literal:/)
+          if result[2][0].zero? && chomped.encode('UTF-8', 'binary', invalid: :replace, undef: :replace,
+                                                                     replace: '').match(/^#\s*frozen_string_literal:/)
             chomped = '#'
           end
-          @comments[result[2][0]] = Snippet.new(Range.from_to(result[2][0], result[2][1], result[2][0], result[2][1] + chomped.length), chomped)
+          @comments[result[2][0]] =
+            Snippet.new(Range.from_to(result[2][0], result[2][1], result[2][0], result[2][1] + chomped.length), chomped)
         end
         result
       end
 
       # @param result [Array(Symbol, String, Array([Integer, nil], [Integer, nil]))]
       # @return [void]
-      def create_snippet(result)
+      def create_snippet result
         chomped = result[1].chomp
-        @comments[result[2][0]] = Snippet.new(Range.from_to(result[2][0] || 0, result[2][1] || 0, result[2][0] || 0, (result[2][1] || 0) + chomped.length), chomped)
+        @comments[result[2][0]] =
+          Snippet.new(
+            Range.from_to(result[2][0] || 0, result[2][1] || 0, result[2][0] || 0,
+                          (result[2][1] || 0) + chomped.length), chomped
+          )
       end
 
+      # @sg-ignore @override is adding, not overriding
       def on_embdoc_beg *args
         result = super
+        # @sg-ignore @override is adding, not overriding
         create_snippet(result)
         result
       end
 
+      # @sg-ignore @override is adding, not overriding
       def on_embdoc *args
         result = super
+        # @sg-ignore @override is adding, not overriding
         create_snippet(result)
         result
       end
 
+      # @sg-ignore @override is adding, not overriding
       def on_embdoc_end *args
         result = super
+        # @sg-ignore @override is adding, not overriding
         create_snippet(result)
         result
       end