solargraph 0.55.3 → 0.56.1

data/lib/solargraph/workspace.rb

@@ -106,7 +106,7 @@ module Solargraph
     def would_require? path
       require_paths.each do |rp|
         full = File.join rp, path
-        return true if File.exist?(full) or File.exist?(full << ".rb")
+        return true if File.file?(full) || File.file?(full << ".rb")
       end
       false
     end
@@ -133,6 +133,15 @@ module Solargraph
       @gem_rbs_collection ||= read_rbs_collection_path
     end
 
+    def rbs_collection_config_path
+      @rbs_collection_config_path ||= begin
+        unless directory.empty? || directory == '*'
+          yaml_file = File.join(directory, 'rbs_collection.yaml')
+          yaml_file if File.file?(yaml_file)
+        end
+      end
+    end
+
     # Synchronize the workspace from the provided updater.
     #
     # @param updater [Source::Updater]
@@ -146,6 +155,14 @@ module Solargraph
       server['commandPath'] || 'solargraph'
     end
 
+    # True if the workspace has a root Gemfile.
+    #
+    # @todo Handle projects with custom Bundler/Gemfile setups (see DocMap#gemspecs_required_from_bundler)
+    #
+    def gemfile?
+      directory && File.file?(File.join(directory, 'Gemfile'))
+    end
+
     private
 
     # The language server configuration (or an empty hash if the workspace was
@@ -214,7 +231,7 @@ module Solargraph
     def configured_require_paths
       return ['lib'] if directory.empty?
       return [File.join(directory, 'lib')] if config.require_paths.empty?
-      config.require_paths.map{|p| File.join(directory, p)}
+      config.require_paths.map { |p| File.join(directory, p) }
     end
 
     # @return [void]
@@ -230,10 +247,11 @@ module Solargraph
 
     # @return [String, nil]
     def read_rbs_collection_path
-      yaml_file = File.join(directory, 'rbs_collection.yaml')
-      return unless File.file?(yaml_file)
+      return unless rbs_collection_config_path
 
-      YAML.load_file(yaml_file)&.fetch('path')
+      path = YAML.load_file(rbs_collection_config_path)&.fetch('path')
+      # make fully qualified
+      File.expand_path(path, directory)
     end
   end
 end

data/lib/solargraph/yard_map/mapper/to_constant.rb

@@ -10,14 +10,16 @@ module Solargraph
         def self.make code_object, closure = nil, spec = nil
           closure ||= Solargraph::Pin::Namespace.new(
             name: code_object.namespace.to_s,
-            gates: [code_object.namespace.to_s]
+            gates: [code_object.namespace.to_s],
+            source: :yardoc,
           )
           Pin::Constant.new(
             location: object_location(code_object, spec),
             closure: closure,
             name: code_object.name.to_s,
             comments: code_object.docstring ? code_object.docstring.all.to_s : '',
-            visibility: code_object.visibility
+            visibility: code_object.visibility,
+            source: :yardoc
           )
         end
       end

data/lib/solargraph/yard_map/mapper/to_method.rb

@@ -6,6 +6,11 @@ module Solargraph
       module ToMethod
         extend YardMap::Helpers
 
+        VISIBILITY_OVERRIDE = {
+          # YARD pays attention to 'private' statements prior to class methods but shouldn't
+          ["Rails::Engine", :class, "find_root_with_flag"] => :public
+        }
+
         # @param code_object [YARD::CodeObjects::Base]
         # @param name [String, nil]
         # @param scope [Symbol, nil]
@@ -25,7 +30,14 @@ module Solargraph
           return_type = ComplexType::SELF if name == 'new'
           comments = code_object.docstring ? code_object.docstring.all.to_s : ''
           final_scope = scope || code_object.scope
-          final_visibility = visibility || code_object.visibility
+          override_key = [closure.path, final_scope, name]
+          final_visibility = VISIBILITY_OVERRIDE[override_key]
+          final_visibility ||= VISIBILITY_OVERRIDE[override_key[0..-2]]
+          final_visibility ||= :private if closure.path == 'Kernel' && Kernel.private_instance_methods(false).include?(name)
+          final_visibility ||= visibility
+          final_visibility ||= :private if code_object.module_function? && final_scope == :instance
+          final_visibility ||= :public if code_object.module_function? && final_scope == :class
+          final_visibility ||= code_object.visibility
           if code_object.is_alias?
             origin_code_object = code_object.namespace.aliases[code_object]
             pin = Pin::MethodAlias.new(
@@ -57,6 +69,7 @@ module Solargraph
               source: :yardoc,
             )
             pin.parameters.concat get_parameters(code_object, location, comments, pin)
+            pin.parameters.freeze
           end
           logger.debug { "ToMethod.make: Just created method pin: #{pin.inspect}" }
           pin

data/lib/solargraph/yard_map/mapper/to_namespace.rb

@@ -11,7 +11,8 @@ module Solargraph
           closure ||= Solargraph::Pin::Namespace.new(
             name: code_object.namespace.to_s,
             closure: Pin::ROOT_PIN,
-            gates: [code_object.namespace.to_s]
+            gates: [code_object.namespace.to_s],
+            source: :yardoc,
           )
           Pin::Namespace.new(
             location: object_location(code_object, spec),
@@ -19,7 +20,8 @@ module Solargraph
             comments: code_object.docstring ? code_object.docstring.all.to_s : '',
             type: code_object.is_a?(YARD::CodeObjects::ClassObject) ? :class : :module,
             visibility: code_object.visibility,
-            closure: closure
+            closure: closure,
+            source: :yardoc,
           )
         end
       end

data/lib/solargraph/yard_map/mapper.rb

@@ -47,15 +47,16 @@ module Solargraph
             else
               code_object.superclass.to_s
             end
-            result.push Solargraph::Pin::Reference::Superclass.new(name: superclass, closure: nspin)
+            result.push Solargraph::Pin::Reference::Superclass.new(name: superclass, closure: nspin, source: :yard_map)
           end
           code_object.class_mixins.each do |m|
-            result.push Solargraph::Pin::Reference::Extend.new(closure: nspin, name: m.path)
+            result.push Solargraph::Pin::Reference::Extend.new(closure: nspin, name: m.path, source: :yard_map)
           end
           code_object.instance_mixins.each do |m|
             result.push Solargraph::Pin::Reference::Include.new(
               closure: nspin, # @todo Fix this
-              name: m.path
+              name: m.path,
+              source: :yard_map
             )
           end
         elsif code_object.is_a?(YARD::CodeObjects::MethodObject)

data/lib/solargraph/yard_map/to_method.rb

@@ -23,7 +23,8 @@ module Solargraph
               name: arg_name(a),
               presence: nil,
               decl: arg_type(a),
-              asgn_code: a[1]
+              asgn_code: a[1],
+              source: :yard_map
             )
           end
         end
@@ -78,7 +79,8 @@ module Solargraph
           scope: scope || code_object.scope,
           visibility: visibility || code_object.visibility,
           parameters: InnerMethods.get_parameters(code_object, location, comments),
-          explicit: code_object.is_explicit?
+          explicit: code_object.is_explicit?,
+          source: :yard_map
         )
       end
     end

data/lib/solargraph/yardoc.rb

@@ -12,7 +12,7 @@ module Solargraph
     # @param gemspec [Gem::Specification]
     # @return [String] The path to the cached yardoc.
     def cache(gemspec)
-      path = path_for(gemspec)
+      path = PinCache.yardoc_path gemspec
       return path if cached?(gemspec)
 
       Solargraph.logger.info "Caching yardoc for #{gemspec.name} #{gemspec.version}"
@@ -26,16 +26,15 @@ module Solargraph
     #
     # @param gemspec [Gem::Specification]
     def cached?(gemspec)
-      yardoc = File.join(path_for(gemspec), 'complete')
+      yardoc = File.join(PinCache.yardoc_path(gemspec), 'complete')
       File.exist?(yardoc)
     end
 
-    # Get the absolute path for a cached gem yardoc.
+    # True if another process is currently building the yardoc cache.
     #
-    # @param gemspec [Gem::Specification]
-    # @return [String]
-    def path_for(gemspec)
-      File.join(Solargraph::Cache.base_dir, "yard-#{YARD::VERSION}", "#{gemspec.name}-#{gemspec.version}.yardoc")
+    def processing?(gemspec)
+      yardoc = File.join(PinCache.yardoc_path(gemspec), 'processing')
+      File.exist?(yardoc)
     end
 
     # Load a gem's yardoc and return its code objects.
@@ -45,7 +44,7 @@ module Solargraph
     # @param gemspec [Gem::Specification]
     # @return [Array<YARD::CodeObjects::Base>]
     def load!(gemspec)
-      YARD::Registry.load! path_for(gemspec)
+      YARD::Registry.load! PinCache.yardoc_path gemspec
       YARD::Registry.all
     end
   end

data/lib/solargraph.rb

@@ -48,11 +48,28 @@ module Solargraph
   autoload :Parser,           'solargraph/parser'
   autoload :RbsMap,           'solargraph/rbs_map'
   autoload :GemPins,          'solargraph/gem_pins'
-  autoload :Cache,            'solargraph/cache'
+  autoload :PinCache,         'solargraph/pin_cache'
 
   dir = File.dirname(__FILE__)
   VIEWS_PATH = File.join(dir, 'solargraph', 'views')
 
+  # @param type [Symbol] Type of assert.
+  def self.asserts_on?(type)
+    if ENV['SOLARGRAPH_ASSERTS'].nil? || ENV['SOLARGRAPH_ASSERTS'].empty?
+      false
+    elsif ENV['SOLARGRAPH_ASSERTS'] == 'on'
+      true
+    else
+      logger.warn "Unrecognized SOLARGRAPH_ASSERTS value: #{ENV['SOLARGRAPH_ASSERTS']}"
+      false
+    end
+  end
+
+  def self.assert_or_log(type, msg = nil, &block)
+    raise (msg || block.call) if asserts_on?(type) && ![:combine_with_visibility].include?(type)
+    logger.info msg, &block
+  end
+
   # A convenience method for Solargraph::Logging.logger.
   #
   # @return [Logger]

data/rbs/fills/tuple.rbs

@@ -0,0 +1,150 @@
+# <-- liberally borrowed from
+#     https://github.com/ruby/rbs/blob/master/core/array.rbs, which
+#     was generated from
+#     https://github.com/ruby/ruby/blob/master/array.c
+#     -->
+module Solargraph
+  module Fills
+    class Tuple[unchecked out A,
+                unchecked out B = A,
+                unchecked out C = A | B,
+                unchecked out D = A | B | C,
+                unchecked out E = A | B | C | D,
+                unchecked out F = A | B | C | D | E,
+                unchecked out G = A | B | C | D | E | F,
+                unchecked out H = A | B | C | D | E | F | G,
+                unchecked out I = A | B | C | D | E | F | G | H,
+                unchecked out J = A | B | C | D | E | F | G | H | I] < Array[A | B | C | D | E | F | G | H | I | J]
+      # <!--
+      #   rdoc-file=array.c
+      #   - self[index] -> object or nil
+      # -->
+      # Returns elements from `self`; does not modify `self`.
+      #
+      # In brief:
+      #
+      #     a = [:foo, 'bar', 2]
+      #
+      #     # Single argument index: returns one element.
+      #     a[0]     # => :foo          # Zero-based index.
+      #
+      # When a single integer argument `index` is given, returns the element at offset
+      # `index`:
+      #
+      #     a = [:foo, 'bar', 2]
+      #     a[0] # => :foo
+      #     a[2] # => 2
+      #     a # => [:foo, "bar", 2]
+      def []: (0 index) -> A
+            | (1 index) -> B
+            | (2 index) -> C
+            | (3 index) -> D
+            | (4 index) -> E
+            | (5 index) -> F
+            | (6 index) -> G
+            | (7 index) -> H
+            | (8 index) -> I
+            | (9 index) -> J
+            | (0 index) -> K
+            | (int index) -> nil
+
+      # <!--
+      #   rdoc-file=array.c
+      #   - at(index) -> object or nil
+      # -->
+      # Returns the element of `self` specified by the given `index` or `nil` if there
+      # is no such element; `index` must be an [integer-convertible
+      # object](rdoc-ref:implicit_conversion.rdoc@Integer-Convertible+Objects).
+      #
+      # For non-negative `index`, returns the element of `self` at offset `index`:
+      #
+      #     a = [:foo, 'bar', 2]
+      #     a.at(0)   # => :foo
+      #     a.at(2)   # => 2
+      #     a.at(2.0) # => 2
+      #
+      # Related: Array#[]; see also [Methods for
+      # Fetching](rdoc-ref:Array@Methods+for+Fetching).
+      #
+      def at: (0 index) -> A
+            | (1 index) -> B
+            | (2 index) -> C
+            | (3 index) -> D
+            | (4 index) -> E
+            | (5 index) -> F
+            | (6 index) -> G
+            | (7 index) -> H
+            | (8 index) -> I
+            | (9 index) -> J
+            | (int index) -> nil
+
+      # <!--
+      #   rdoc-file=array.c
+      #   - fetch(index) -> element
+      #   - fetch(index, default_value) -> element or default_value
+      #   - fetch(index) {|index| ... } -> element or block_return_value
+      # -->
+      # Returns the element of `self` at offset `index` if `index` is in range;
+      # `index` must be an [integer-convertible
+      # object](rdoc-ref:implicit_conversion.rdoc@Integer-Convertible+Objects).
+      #
+      # With the single argument `index` and no block, returns the element at offset
+      # `index`:
+      #
+      #     a = [:foo, 'bar', 2]
+      #     a.fetch(1)   # => "bar"
+      #     a.fetch(1.1) # => "bar"
+      #
+      # With arguments `index` and `default_value` (which may be any object) and no
+      # block, returns `default_value` if `index` is out-of-range:
+      #
+      #     a = [:foo, 'bar', 2]
+      #     a.fetch(1, nil)  # => "bar"
+      #     a.fetch(3, :foo) # => :foo
+      #
+      # With argument `index` and a block, returns the element at offset `index` if
+      # index is in range (and the block is not called); otherwise calls the block
+      # with index and returns its return value:
+      #
+      #     a = [:foo, 'bar', 2]
+      #     a.fetch(1) {|index| raise 'Cannot happen' } # => "bar"
+      #     a.fetch(50) {|index| "Value for #{index}" } # => "Value for 50"
+      #
+      # Related: see [Methods for Fetching](rdoc-ref:Array@Methods+for+Fetching).
+      #
+      def fetch: (0 index) -> A
+               | (1 index) -> B
+               | (2 index) -> C
+               | (3 index) -> D
+               | (4 index) -> E
+               | (5 index) -> F
+               | (6 index) -> G
+               | (7 index) -> H
+               | (8 index) -> I
+               | (9 index) -> J
+               | (int index) -> void
+               | [T] (0 index, T default) -> (A | T)
+               | [T] (1 index, T default) -> (B | T)
+               | [T] (2 index, T default) -> (C | T)
+               | [T] (3 index, T default) -> (D | T)
+               | [T] (4 index, T default) -> (E | T)
+               | [T] (5 index, T default) -> (F | T)
+               | [T] (6 index, T default) -> (G | T)
+               | [T] (7 index, T default) -> (H | T)
+               | [T] (8 index, T default) -> (I | T)
+               | [T] (9 index, T default) -> (J | T)
+               | [T] (int index, T default) -> (A | B | C | D | E | F |G | H | I | J | T)
+               | [T] (0 index) { (int index) -> T } -> (A | T)
+               | [T] (1 index) { (int index) -> T } -> (B | T)
+               | [T] (2 index) { (int index) -> T } -> (C | T)
+               | [T] (3 index) { (int index) -> T } -> (D | T)
+               | [T] (4 index) { (int index) -> T } -> (E | T)
+               | [T] (5 index) { (int index) -> T } -> (F | T)
+               | [T] (6 index) { (int index) -> T } -> (G | T)
+               | [T] (7 index) { (int index) -> T } -> (H | T)
+               | [T] (8 index) { (int index) -> T } -> (I | T)
+               | [T] (9 index) { (int index) -> T } -> (J | T)
+               | [T] (int index) { (int index) -> T } -> (A | B | C | D | E | F |G | H | I | J | T)
+    end
+  end
+end

data/rbs_collection.yaml

@@ -0,0 +1,19 @@
+# Download sources
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# You can specify local directories as sources also.
+# - type: local
+#   path: path/to/your/local/repository
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+# gems:
+#   # If you want to avoid installing rbs files for gems, you can specify them here.
+#   - name: GEM_NAME
+#     ignore: true

data/solargraph.gemspec

@@ -34,7 +34,8 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'observer', '~> 0.1'
   s.add_runtime_dependency 'ostruct', '~> 0.6'
   s.add_runtime_dependency 'parser', '~> 3.0'
-  s.add_runtime_dependency 'rbs', '~> 3.3'
+  s.add_runtime_dependency 'prism', '~> 1.4'
+  s.add_runtime_dependency 'rbs', '~> 3.6.1'
   s.add_runtime_dependency 'reverse_markdown', '~> 3.0'
   s.add_runtime_dependency 'rubocop', '~> 1.38'
   s.add_runtime_dependency 'thor', '~> 1.0'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.55.3
+  version: 0.56.1
 platform: ruby
 authors:
 - Fred Snyder
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-25 00:00:00.000000000 Z
+date: 2025-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backport
@@ -170,20 +169,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rbs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: 3.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: 3.6.1
 - !ruby/object:Gem::Dependency
   name: reverse_markdown
   requirement: !ruby/object:Gem::Requirement
@@ -401,7 +414,6 @@ files:
 - lib/solargraph/api_map/source_to_yard.rb
 - lib/solargraph/api_map/store.rb
 - lib/solargraph/bench.rb
-- lib/solargraph/cache.rb
 - lib/solargraph/complex_type.rb
 - lib/solargraph/complex_type/type_methods.rb
 - lib/solargraph/complex_type/unique_type.rb
@@ -568,6 +580,7 @@ files:
 - lib/solargraph/pin/symbol.rb
 - lib/solargraph/pin/until.rb
 - lib/solargraph/pin/while.rb
+- lib/solargraph/pin_cache.rb
 - lib/solargraph/position.rb
 - lib/solargraph/range.rb
 - lib/solargraph/rbs_map.rb
@@ -631,6 +644,8 @@ files:
 - lib/solargraph/yard_map/to_method.rb
 - lib/solargraph/yard_tags.rb
 - lib/solargraph/yardoc.rb
+- rbs/fills/tuple.rbs
+- rbs_collection.yaml
 - solargraph.gemspec
 homepage: https://solargraph.org
 licenses:
@@ -640,7 +655,6 @@ metadata:
   bug_tracker_uri: https://github.com/castwide/solargraph/issues
   changelog_uri: https://github.com/castwide/solargraph/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/castwide/solargraph
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -655,8 +669,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: A Ruby language server
 test_files: []

data/lib/solargraph/cache.rb

@@ -1,77 +0,0 @@
-require 'fileutils'
-require 'rbs'
-
-module Solargraph
-  module Cache
-    class << self
-      # The base directory where cached documentation is installed.
-      #
-      # @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
-
-      # Append the given path to the current cache directory (`work_dir`).
-      #
-      # @example
-      #   Cache.join('date-3.4.1.ser')
-      #
-      # @param path [Array<String>]
-      # @return [String]
-      def join *path
-        File.join(work_dir, *path)
-      end
-
-      # @param path [Array<String>]
-      # @return [Array<Solargraph::Pin::Base>, nil]
-      def load *path
-        file = join(*path)
-        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
-
-      def exist? *path
-        File.file? join(*path)
-      end
-
-      # @param path [Array<String>]
-      # @param pins [Array<Pin::Base>]
-      # @return [void]
-      def save *path, pins
-        file = File.join(work_dir, *path)
-        base = File.dirname(file)
-        FileUtils.mkdir_p base unless File.directory?(base)
-        ser = Marshal.dump(pins)
-        File.write file, ser, mode: 'wb'
-      end
-
-      # @return [void]
-      # @param path [Array<String>]
-      def uncache *path
-        FileUtils.rm_rf File.join(work_dir, *path), secure: true
-      end
-
-      # @return [void]
-      def clear
-        FileUtils.rm_rf base_dir, secure: true
-      end
-    end
-  end
-end