solargraph 0.54.4 → 0.58.3

data/lib/solargraph/pin_cache.rb

@@ -0,0 +1,245 @@
+require 'yard-activesupport-concern'
+require 'fileutils'
+require 'rbs'
+
+module Solargraph
+  module PinCache
+    class << self
+      include Logging
+
+      # The base directory where cached YARD documentation and serialized pins are serialized
+      #
+      # @return [String]
+      def base_dir
+        # The directory is not stored in a variable so it can be overridden
+        # in specs.
+        ENV['SOLARGRAPH_CACHE'] ||
+          (ENV['XDG_CACHE_HOME'] ? File.join(ENV['XDG_CACHE_HOME'], 'solargraph') : nil) ||
+          File.join(Dir.home, '.cache', 'solargraph')
+      end
+
+      # The working directory for the current Ruby, RBS, and Solargraph versions.
+      #
+      # @return [String]
+      def work_dir
+        # The directory is not stored in a variable so it can be overridden
+        # in specs.
+        File.join(base_dir, "ruby-#{RUBY_VERSION}", "rbs-#{RBS::VERSION}", "solargraph-#{Solargraph::VERSION}")
+      end
+
+      # @param gemspec [Gem::Specification]
+      # @return [String]
+      def yardoc_path gemspec
+        File.join(base_dir,
+                  "yard-#{YARD::VERSION}",
+                  "yard-activesupport-concern-#{YARD::ActiveSupport::Concern::VERSION}",
+                  "#{gemspec.name}-#{gemspec.version}.yardoc")
+      end
+
+      # @return [String]
+      def stdlib_path
+        File.join(work_dir, 'stdlib')
+      end
+
+      # @param require [String]
+      # @return [String]
+      def stdlib_require_path require
+        File.join(stdlib_path, "#{require}.ser")
+      end
+
+      # @param require [String]
+      # @return [Array<Pin::Base>, nil]
+      def deserialize_stdlib_require require
+        load(stdlib_require_path(require))
+      end
+
+      # @param require [String]
+      # @param pins [Array<Pin::Base>]
+      # @return [void]
+      def serialize_stdlib_require require, pins
+        save(stdlib_require_path(require), pins)
+      end
+
+      # @return [String]
+      def core_path
+        File.join(work_dir, 'core.ser')
+      end
+
+      # @return [Array<Pin::Base>, nil]
+      def deserialize_core
+        load(core_path)
+      end
+
+      # @param pins [Array<Pin::Base>]
+      # @return [void]
+      def serialize_core pins
+        save(core_path, pins)
+      end
+
+      # @param gemspec [Gem::Specification]
+      # @return [String]
+      def yard_gem_path gemspec
+        File.join(work_dir, 'yard', "#{gemspec.name}-#{gemspec.version}.ser")
+      end
+
+      # @param gemspec [Gem::Specification]
+      # @return [Array<Pin::Base>, nil]
+      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)
+        save(yard_gem_path(gemspec), pins)
+      end
+
+      # @param gemspec [Gem::Specification]
+      # @return [Boolean]
+      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)
+        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)
+        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)
+        load(rbs_collection_path(gemspec, hash))
+      end
+
+      # @param gemspec [Gem::Specification]
+      # @param hash [String, nil]
+      # @param pins [Array<Pin::Base>]n
+      # @return [void]
+      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)
+        File.join(work_dir, 'combined', "#{gemspec.name}-#{gemspec.version}-#{hash || 0}.ser")
+      end
+
+      # @param gemspec [Gem::Specification]
+      # @return [String]
+      def combined_path_prefix(gemspec)
+        File.join(work_dir, 'combined', "#{gemspec.name}-#{gemspec.version}-")
+      end
+
+      # @param gemspec [Gem::Specification]
+      # @param hash [String, nil]
+      # @param pins [Array<Pin::Base>]
+      # @return [void]
+      def serialize_combined_gem(gemspec, hash, pins)
+        save(combined_path(gemspec, hash), pins)
+      end
+
+      # @param gemspec [Gem::Specification]
+      # @param hash [String, nil]
+      # @return [Array<Pin::Base>, nil]
+      def deserialize_combined_gem gemspec, hash
+        load(combined_path(gemspec, hash))
+      end
+
+      # @param gemspec [Gem::Specification]
+      # @param hash [String, nil]
+      # @return [Boolean]
+      def has_rbs_collection?(gemspec, hash)
+        exist?(rbs_collection_path(gemspec, hash))
+      end
+
+      # @return [void]
+      def uncache_core
+        uncache(core_path)
+      end
+
+      # @return [void]
+      def uncache_stdlib
+        uncache(stdlib_path)
+      end
+
+      # @param gemspec [Gem::Specification]
+      # @param out [IO, nil]
+      # @return [void]
+      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)
+        uncache_by_prefix(combined_path_prefix(gemspec), out: out)
+      end
+
+      # @return [void]
+      def clear
+        FileUtils.rm_rf base_dir, secure: true
+      end
+
+      private
+
+      # @param file [String]
+      # @return [Array<Solargraph::Pin::Base>, nil]
+      def load file
+        return nil unless File.file?(file)
+        Marshal.load(File.read(file, mode: 'rb'))
+      rescue StandardError => e
+        Solargraph.logger.warn "Failed to load cached file #{file}: [#{e.class}] #{e.message}"
+        FileUtils.rm_f file
+        nil
+      end
+
+      # @param path [String]
+      def exist? *path
+        File.file? File.join(*path)
+      end
+
+      # @param file [String]
+      # @param pins [Array<Pin::Base>]
+      # @return [void]
+      def save file, pins
+        base = File.dirname(file)
+        FileUtils.mkdir_p base unless File.directory?(base)
+        ser = Marshal.dump(pins)
+        File.write file, ser, mode: 'wb'
+        logger.debug { "Cache#save: Saved #{pins.length} pins to #{file}" }
+      end
+
+      # @param path_segments [Array<String>]
+      # @return [void]
+      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
+      end
+
+      # @return [void]
+      # @param path_segments [Array<String>]
+      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?
+        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?
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/position.rb

@@ -1,107 +1,132 @@
-# frozen_string_literal: true
-
-module Solargraph
-  # The zero-based line and column numbers of a position in a string.
-  #
-  class Position
-    include Equality
-
-    # @return [Integer]
-    attr_reader :line
-
-    # @return [Integer]
-    attr_reader :character
-
-    alias column character
-
-    # @param line [Integer]
-    # @param character [Integer]
-    def initialize line, character
-      @line = line
-      @character = character
-    end
-
-    # @sg-ignore Fix "Not enough arguments to Module#protected"
-    protected def equality_fields
-      [line, character]
-    end
-
-    # Get a hash of the position. This representation is suitable for use in
-    # the language server protocol.
-    #
-    # @return [Hash]
-    def to_hash
-      {
-        line: line,
-        character: character
-      }
-    end
-
-    def inspect
-      "#<#{self.class} #{line}, #{character}>"
-    end
-
-    # Get a numeric offset for the specified text and position.
-    #
-    # @param text [String]
-    # @param position [Position]
-    # @return [Integer]
-    def self.to_offset text, position
-      return 0 if text.empty?
-      text.lines[0...position.line].sum(&:length) + position.character
-    end
-
-    # Get a numeric offset for the specified text and a position identified
-    # by its line and character.
-    #
-    # @param text [String]
-    # @param line [Integer]
-    # @param character [Integer]
-    # @return [Integer]
-    def self.line_char_to_offset text, line, character
-      to_offset(text, Position.new(line, character))
-    end
-
-    # Get a position for the specified text and offset.
-    #
-    # @param text [String]
-    # @param offset [Integer]
-    # @return [Position]
-    def self.from_offset text, offset
-      cursor = 0
-      line = 0
-      character = nil
-      text.lines.each do |l|
-        line_length = l.length
-        char_length = l.chomp.length
-        if cursor + char_length >= offset
-          character = offset - cursor
-          break
-        end
-        cursor += line_length
-        line += 1
-      end
-      character = 0 if character.nil? and (cursor - offset).between?(0, 1)
-      raise InvalidOffsetError if character.nil?
-      Position.new(line, character)
-    end
-
-    # A helper method for generating positions from arrays of integers. The
-    # original parameter is returned if it is already a position.
-    #
-    # @raise [ArgumentError] if the object cannot be converted to a position.
-    #
-    # @param object [Position, Array(Integer, Integer)]
-    # @return [Position]
-    def self.normalize object
-      return object if object.is_a?(Position)
-      return Position.new(object[0], object[1]) if object.is_a?(Array)
-      raise ArgumentError, "Unable to convert #{object.class} to Position"
-    end
-
-    def == other
-      return false unless other.is_a?(Position)
-      line == other.line and character == other.character
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  # The zero-based line and column numbers of a position in a string.
+  #
+  class Position
+    include Equality
+
+    # @return [Integer]
+    attr_reader :line
+
+    # @return [Integer]
+    attr_reader :character
+
+    alias column character
+
+    # @param line [Integer]
+    # @param character [Integer]
+    def initialize line, character
+      @line = line
+      @character = character
+    end
+
+    # @sg-ignore Fix "Not enough arguments to Module#protected"
+    protected def equality_fields
+      [line, character]
+    end
+
+    # @param other [Position]
+    def <=>(other)
+      return nil unless other.is_a?(Position)
+      if line == other.line
+        character <=> other.character
+      else
+        line <=> other.line
+      end
+    end
+
+    # Get a hash of the position. This representation is suitable for use in
+    # the language server protocol.
+    #
+    # @return [Hash]
+    def to_hash
+      {
+        line: line,
+        character: character
+      }
+    end
+
+    def inspect
+      "#<#{self.class} #{line}, #{character}>"
+    end
+
+    # Get a numeric offset for the specified text and position.
+    #
+    # @param text [String]
+    # @param position [Position]
+    # @return [Integer]
+    def self.to_offset text, position
+      return 0 if text.empty?
+
+      newline_index = -1
+      line = -1
+      last_line_index = 0
+
+      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 + position.character
+    end
+
+    # Get a numeric offset for the specified text and a position identified
+    # by its line and character.
+    #
+    # @param text [String]
+    # @param line [Integer]
+    # @param character [Integer]
+    # @return [Integer]
+    def self.line_char_to_offset text, line, character
+      to_offset(text, Position.new(line, character))
+    end
+
+    # Get a position for the specified text and offset.
+    #
+    # @raise [InvalidOffsetError] if the offset is outside the text range
+    #
+    # @param text [String]
+    # @param offset [Integer]
+    # @return [Position]
+    def self.from_offset text, offset
+      raise InvalidOffsetError if offset > text.length
+
+      cursor = 0
+      line = 0
+      character = offset
+      newline_index = -1
+
+      while (newline_index = text.index("\n", newline_index + 1)) && newline_index < offset
+        line += 1
+        character = offset - newline_index - 1
+      end
+      character = 0 if character.nil? and (cursor - offset).between?(0, 1)
+      raise InvalidOffsetError if character.nil?
+      Position.new(line, character)
+    end
+
+    # A helper method for generating positions from arrays of integers. The
+    # original parameter is returned if it is already a position.
+    #
+    # @raise [ArgumentError] if the object cannot be converted to a position.
+    #
+    # @param object [Position, Array(Integer, Integer)]
+    # @return [Position]
+    def self.normalize object
+      return object if object.is_a?(Position)
+      return Position.new(object[0], object[1]) if object.is_a?(Array)
+      raise ArgumentError, "Unable to convert #{object.class} to Position"
+    end
+
+    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
+  end
+end