solargraph 0.58.3 → 0.59.2

data/lib/solargraph/pin_cache.rb

@@ -1,5 +1,6 @@
 require 'yard-activesupport-concern'
 require 'fileutils'
+require 'pathname' # @todo Required by RBS but not loaded in some use cases
 require 'rbs'
 
 module Solargraph
@@ -84,40 +85,40 @@ module Solargraph
 
       # @param gemspec [Gem::Specification]
       # @return [Array<Pin::Base>, nil]
-      def deserialize_yard_gem(gemspec)
+      def deserialize_yard_gem gemspec
         load(yard_gem_path(gemspec))
       end
 
       # @param gemspec [Gem::Specification]
       # @param pins [Array<Pin::Base>]
       # @return [void]
-      def serialize_yard_gem(gemspec, pins)
+      def serialize_yard_gem gemspec, pins
         save(yard_gem_path(gemspec), pins)
       end
 
       # @param gemspec [Gem::Specification]
       # @return [Boolean]
-      def has_yard?(gemspec)
+      def has_yard? gemspec
         exist?(yard_gem_path(gemspec))
       end
 
       # @param gemspec [Gem::Specification]
       # @param hash [String, nil]
       # @return [String]
-      def rbs_collection_path(gemspec, hash)
+      def rbs_collection_path gemspec, hash
         File.join(work_dir, 'rbs', "#{gemspec.name}-#{gemspec.version}-#{hash || 0}.ser")
       end
 
       # @param gemspec [Gem::Specification]
       # @return [String]
-      def rbs_collection_path_prefix(gemspec)
+      def rbs_collection_path_prefix gemspec
         File.join(work_dir, 'rbs', "#{gemspec.name}-#{gemspec.version}-")
       end
 
       # @param gemspec [Gem::Specification]
       # @param hash [String, nil]
       # @return [Array<Pin::Base>, nil]
-      def deserialize_rbs_collection_gem(gemspec, hash)
+      def deserialize_rbs_collection_gem gemspec, hash
         load(rbs_collection_path(gemspec, hash))
       end
 
@@ -125,20 +126,20 @@ module Solargraph
       # @param hash [String, nil]
       # @param pins [Array<Pin::Base>]n
       # @return [void]
-      def serialize_rbs_collection_gem(gemspec, hash, pins)
+      def serialize_rbs_collection_gem gemspec, hash, pins
         save(rbs_collection_path(gemspec, hash), pins)
       end
 
       # @param gemspec [Gem::Specification]
       # @param hash [String, nil]
       # @return [String]
-      def combined_path(gemspec, hash)
+      def combined_path gemspec, hash
         File.join(work_dir, 'combined', "#{gemspec.name}-#{gemspec.version}-#{hash || 0}.ser")
       end
 
       # @param gemspec [Gem::Specification]
       # @return [String]
-      def combined_path_prefix(gemspec)
+      def combined_path_prefix gemspec
         File.join(work_dir, 'combined', "#{gemspec.name}-#{gemspec.version}-")
       end
 
@@ -146,7 +147,7 @@ module Solargraph
       # @param hash [String, nil]
       # @param pins [Array<Pin::Base>]
       # @return [void]
-      def serialize_combined_gem(gemspec, hash, pins)
+      def serialize_combined_gem gemspec, hash, pins
         save(combined_path(gemspec, hash), pins)
       end
 
@@ -160,7 +161,7 @@ module Solargraph
       # @param gemspec [Gem::Specification]
       # @param hash [String, nil]
       # @return [Boolean]
-      def has_rbs_collection?(gemspec, hash)
+      def has_rbs_collection? gemspec, hash
         exist?(rbs_collection_path(gemspec, hash))
       end
 
@@ -175,9 +176,9 @@ module Solargraph
       end
 
       # @param gemspec [Gem::Specification]
-      # @param out [IO, nil]
+      # @param out [IO, StringIO, nil]
       # @return [void]
-      def uncache_gem(gemspec, out: nil)
+      def uncache_gem gemspec, out: nil
         uncache(yardoc_path(gemspec), out: out)
         uncache_by_prefix(rbs_collection_path_prefix(gemspec), out: out)
         uncache(yard_gem_path(gemspec), out: out)
@@ -192,6 +193,7 @@ module Solargraph
       private
 
       # @param file [String]
+      # @sg-ignore Marshal.load returns Object; we know it's Array<Pin::Base>
       # @return [Array<Solargraph::Pin::Base>, nil]
       def load file
         return nil unless File.file?(file)
@@ -220,24 +222,25 @@ module Solargraph
 
       # @param path_segments [Array<String>]
       # @return [void]
+      # @param [Object, nil] out
       def uncache *path_segments, out: nil
         path = File.join(*path_segments)
-        if File.exist?(path)
-          FileUtils.rm_rf path, secure: true
-          out.puts "Clearing pin cache in #{path}" unless out.nil?
-        end
+        return unless File.exist?(path)
+        FileUtils.rm_rf path, secure: true
+        out&.puts "Clearing pin cache in #{path}"
       end
 
       # @return [void]
       # @param path_segments [Array<String>]
+      # @param [Object, nil] out
       def uncache_by_prefix *path_segments, out: nil
         path = File.join(*path_segments)
         glob = "#{path}*"
-        out.puts "Clearing pin cache in #{glob}" unless out.nil?
+        out&.puts "Clearing pin cache in #{glob}"
         Dir.glob(glob).each do |file|
           next unless File.file?(file)
           FileUtils.rm_rf file, secure: true
-          out.puts "Clearing pin cache in #{file}" unless out.nil?
+          out&.puts "Clearing pin cache in #{file}"
         end
       end
     end

data/lib/solargraph/position.rb

@@ -21,13 +21,8 @@ module Solargraph
       @character = character
     end
 
-    # @sg-ignore Fix "Not enough arguments to Module#protected"
-    protected def equality_fields
-      [line, character]
-    end
-
     # @param other [Position]
-    def <=>(other)
+    def <=> other
       return nil unless other.is_a?(Position)
       if line == other.line
         character <=> other.character
@@ -63,15 +58,18 @@ module Solargraph
       line = -1
       last_line_index = 0
 
+      # @sg-ignore Typechecker thinks `newline_index` inside of the assignment
+      #   can be nil
       while (newline_index = text.index("\n", newline_index + 1)) && line <= position.line
         line += 1
         break if line == position.line
 
-        line_length = newline_index - last_line_index
         last_line_index = newline_index
       end
 
-      last_line_index += 1 if position.line > 0
+      last_line_index += 1 if position.line.positive?
+      # @sg-ignore `last_line_index` is always an Integer because `newline_index`
+      #   is never nil inside the while block
       last_line_index + position.character
     end
 
@@ -101,12 +99,16 @@ module Solargraph
       character = offset
       newline_index = -1
 
+      # @sg-ignore Typechecker thinks `newline_index` inside of the assignment
+      #   can be nil
       while (newline_index = text.index("\n", newline_index + 1)) && newline_index < offset
         line += 1
+        # @sg-ignore `newline_index` is always an Integer inside the while block
         character = offset - newline_index - 1
       end
-      character = 0 if character.nil? and (cursor - offset).between?(0, 1)
+      character = 0 if character.nil? && (cursor - offset).between?(0, 1)
       raise InvalidOffsetError if character.nil?
+      # @sg-ignore flow sensitive typing needs to handle 'raise if'
       Position.new(line, character)
     end
 
@@ -125,8 +127,13 @@ module Solargraph
 
     def == other
       return false unless other.is_a?(Position)
-      # @sg-ignore https://github.com/castwide/solargraph/pull/1114
       line == other.line and character == other.character
     end
+
+    protected
+
+    def equality_fields
+      [line, character]
+    end
   end
 end

data/lib/solargraph/range.rb

@@ -19,20 +19,12 @@ module Solargraph
       @ending = ending
     end
 
-    # @sg-ignore Fix "Not enough arguments to Module#protected"
-    protected def equality_fields
-      [start, ending]
-    end
-
     # @param other [BasicObject]
-    def <=>(other)
+    def <=> other
       return nil unless other.is_a?(Range)
-      # @sg-ignore https://github.com/castwide/solargraph/pull/1114
       if start == other.start
-        # @sg-ignore https://github.com/castwide/solargraph/pull/1114
         ending <=> other.ending
       else
-        # @sg-ignore https://github.com/castwide/solargraph/pull/1114
         start <=> other.start
       end
     end
@@ -40,7 +32,7 @@ module Solargraph
     # Get a hash of the range. This representation is suitable for use in
     # the language server protocol.
     #
-    # @return [Hash<Symbol, Position>]
+    # @return [Hash{Symbol => Position}]
     def to_hash
       {
         start: start.to_hash,
@@ -54,8 +46,11 @@ module Solargraph
     # @return [Boolean]
     def contain? position
       position = Position.normalize(position)
+      # @sg-ignore flow sensitive typing should be able to handle redefinition
       return false if position.line < start.line || position.line > ending.line
+      # @sg-ignore flow sensitive typing should be able to handle redefinition
       return false if position.line == start.line && position.character < start.character
+      # @sg-ignore flow sensitive typing should be able to handle redefinition
       return false if position.line == ending.line && position.character > ending.character
       true
     end
@@ -63,9 +58,11 @@ module Solargraph
     # True if the range contains the specified position and the position does not precede it.
     #
     # @param position [Position, Array(Integer, Integer)]
+    # @sg-ignore flow sensitive typing should be able to handle redefinition
     # @return [Boolean]
     def include? position
       position = Position.normalize(position)
+      # @sg-ignore flow sensitive typing should be able to handle redefinition
       contain?(position) && !(position.line == start.line && position.character == start.character)
     end
 
@@ -82,12 +79,11 @@ module Solargraph
 
     # Get a range from a node.
     #
-    # @param node [Parser::AST::Node]
+    # @param node [::Parser::AST::Node]
     # @return [Range, nil]
     def self.from_node node
-      if node&.loc && node.loc.expression
-        from_expr(node.loc.expression)
-      end
+      return unless node&.loc&.expression
+      from_expr(node.loc.expression)
     end
 
     # Get a range from a Parser range, usually found in
@@ -101,12 +97,17 @@ module Solargraph
 
     def == other
       return false unless other.is_a?(Range)
-      # @sg-ignore https://github.com/castwide/solargraph/pull/1114
       start == other.start && ending == other.ending
     end
 
     def inspect
       "#<#{self.class} #{start.inspect} to #{ending.inspect}>"
     end
+
+    protected
+
+    def equality_fields
+      [start, ending]
+    end
   end
 end