solargraph 0.58.0 → 0.58.2

data/lib/solargraph/pin.rb

@@ -1,44 +1,44 @@
-# frozen_string_literal: true
-
-require 'yard'
-
-module Solargraph
-  # The namespace for Pins used in SourceMaps.
-  #
-  # Pins represent declarations, from gems, Sources, and the Ruby core.
-  #
-  module Pin
-    autoload :Common,           'solargraph/pin/common'
-    autoload :Conversions,      'solargraph/pin/conversions'
-    autoload :Base,             'solargraph/pin/base'
-    autoload :Method,           'solargraph/pin/method'
-    autoload :Signature,        'solargraph/pin/signature'
-    autoload :MethodAlias,      'solargraph/pin/method_alias'
-    autoload :DelegatedMethod,  'solargraph/pin/delegated_method'
-    autoload :BaseVariable,     'solargraph/pin/base_variable'
-    autoload :InstanceVariable, 'solargraph/pin/instance_variable'
-    autoload :ClassVariable,    'solargraph/pin/class_variable'
-    autoload :LocalVariable,    'solargraph/pin/local_variable'
-    autoload :GlobalVariable,   'solargraph/pin/global_variable'
-    autoload :Constant,         'solargraph/pin/constant'
-    autoload :Symbol,           'solargraph/pin/symbol'
-    autoload :Closure,          'solargraph/pin/closure'
-    autoload :Namespace,        'solargraph/pin/namespace'
-    autoload :Keyword,          'solargraph/pin/keyword'
-    autoload :Parameter,        'solargraph/pin/parameter'
-    autoload :Reference,        'solargraph/pin/reference'
-    autoload :Documenting,      'solargraph/pin/documenting'
-    autoload :Block,            'solargraph/pin/block'
-    autoload :ProxyType,        'solargraph/pin/proxy_type'
-    autoload :DuckMethod,       'solargraph/pin/duck_method'
-    autoload :Singleton,        'solargraph/pin/singleton'
-    autoload :KeywordParam,     'solargraph/pin/keyword_param'
-    autoload :Search,           'solargraph/pin/search'
-    autoload :Breakable,        'solargraph/pin/breakable'
-    autoload :Until,            'solargraph/pin/until'
-    autoload :While,            'solargraph/pin/while'
-    autoload :Callable,         'solargraph/pin/callable'
-
-    ROOT_PIN = Pin::Namespace.new(type: :class, name: '', closure: nil, source: :pin_rb)
-  end
-end
+# frozen_string_literal: true
+
+require 'yard'
+
+module Solargraph
+  # The namespace for Pins used in SourceMaps.
+  #
+  # Pins represent declarations, from gems, Sources, and the Ruby core.
+  #
+  module Pin
+    autoload :Common,           'solargraph/pin/common'
+    autoload :Conversions,      'solargraph/pin/conversions'
+    autoload :Base,             'solargraph/pin/base'
+    autoload :Method,           'solargraph/pin/method'
+    autoload :Signature,        'solargraph/pin/signature'
+    autoload :MethodAlias,      'solargraph/pin/method_alias'
+    autoload :DelegatedMethod,  'solargraph/pin/delegated_method'
+    autoload :BaseVariable,     'solargraph/pin/base_variable'
+    autoload :InstanceVariable, 'solargraph/pin/instance_variable'
+    autoload :ClassVariable,    'solargraph/pin/class_variable'
+    autoload :LocalVariable,    'solargraph/pin/local_variable'
+    autoload :GlobalVariable,   'solargraph/pin/global_variable'
+    autoload :Constant,         'solargraph/pin/constant'
+    autoload :Symbol,           'solargraph/pin/symbol'
+    autoload :Closure,          'solargraph/pin/closure'
+    autoload :Namespace,        'solargraph/pin/namespace'
+    autoload :Keyword,          'solargraph/pin/keyword'
+    autoload :Parameter,        'solargraph/pin/parameter'
+    autoload :Reference,        'solargraph/pin/reference'
+    autoload :Documenting,      'solargraph/pin/documenting'
+    autoload :Block,            'solargraph/pin/block'
+    autoload :ProxyType,        'solargraph/pin/proxy_type'
+    autoload :DuckMethod,       'solargraph/pin/duck_method'
+    autoload :Singleton,        'solargraph/pin/singleton'
+    autoload :KeywordParam,     'solargraph/pin/keyword_param'
+    autoload :Search,           'solargraph/pin/search'
+    autoload :Breakable,        'solargraph/pin/breakable'
+    autoload :Until,            'solargraph/pin/until'
+    autoload :While,            'solargraph/pin/while'
+    autoload :Callable,         'solargraph/pin/callable'
+
+    ROOT_PIN = Pin::Namespace.new(type: :class, name: '', closure: nil, source: :pin_rb)
+  end
+end

data/lib/solargraph/pin_cache.rb

@@ -1,245 +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
+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