solargraph 0.58.3 → 0.59.0.dev.1

data/lib/solargraph/yard_map/mapper.rb

@@ -24,6 +24,7 @@ module Solargraph
         end
         # Some yardocs contain documentation for dependencies that can be
         # ignored here. The YardMap will load dependencies separately.
+        # @sg-ignore Need to add nil check here
         @pins.keep_if { |pin| pin.location.nil? || File.file?(pin.location.filename) } if @spec
         @pins
       end
@@ -38,13 +39,17 @@ module Solargraph
           nspin = ToNamespace.make(code_object, @spec, @namespace_pins[code_object.namespace.to_s])
           @namespace_pins[code_object.path] = nspin
           result.push nspin
+          # @sg-ignore flow sensitive typing needs to narrow down type with an if is_a? check
           if code_object.is_a?(YARD::CodeObjects::ClassObject) and !code_object.superclass.nil?
             # This method of superclass detection is a bit of a hack. If
             # the superclass is a Proxy, it is assumed to be undefined in its
             # yardoc and converted to a fully qualified namespace.
+            # @sg-ignore flow sensitive typing needs to narrow down type with an if is_a? check
             superclass = if code_object.superclass.is_a?(YARD::CodeObjects::Proxy)
+              # @sg-ignore flow sensitive typing needs to narrow down type with an if is_a? check
               "::#{code_object.superclass}"
             else
+              # @sg-ignore flow sensitive typing needs to narrow down type with an if is_a? check
               code_object.superclass.to_s
             end
             result.push Solargraph::Pin::Reference::Superclass.new(name: superclass, closure: nspin, source: :yard_map)

data/lib/solargraph/yard_tags.rb

@@ -1,20 +1,20 @@
-# frozen_string_literal: true
-
-require 'yard'
-
-# Change YARD log IO to avoid sending unexpected messages to STDOUT
-YARD::Logger.instance.io = File.new(File::NULL, 'w')
-
-module Solargraph
-  # A placeholder for the @!domain directive. It doesn't need to do anything
-  # for yardocs. It's only used for Solargraph API maps.
-  class DomainDirective < YARD::Tags::Directive
-    def call; end
-  end
-end
-
-# Define a @type tag for documenting variables
-YARD::Tags::Library.define_tag("Type", :type, :with_types_and_name)
-
-# Define an @!override directive for overriding method tags
-YARD::Tags::Library.define_directive("override", :with_name, Solargraph::DomainDirective)
+# frozen_string_literal: true
+
+require 'yard'
+
+# Change YARD log IO to avoid sending unexpected messages to STDOUT
+YARD::Logger.instance.io = File.new(File::NULL, 'w')
+
+module Solargraph
+  # A placeholder for the @!domain directive. It doesn't need to do anything
+  # for yardocs. It's only used for Solargraph API maps.
+  class DomainDirective < YARD::Tags::Directive
+    def call; end
+  end
+end
+
+# Define a @type tag for documenting variables
+YARD::Tags::Library.define_tag("Type", :type, :with_types_and_name)
+
+# Define an @!override directive for overriding method tags
+YARD::Tags::Library.define_directive("override", :with_name, Solargraph::DomainDirective)

data/lib/solargraph/yardoc.rb

@@ -8,15 +8,15 @@ module Solargraph
   module Yardoc
     module_function
 
-    # Build and cache a gem's yardoc and return the path. If the cache already
-    # exists, do nothing and return the path.
+    # Build and save a gem's yardoc into a given path.
     #
-    # @param yard_plugins [Array<String>] The names of YARD plugins to use.
+    # @param gem_yardoc_path [String] the path to the yardoc cache of a particular gem
+    # @param yard_plugins [Array<String>]
     # @param gemspec [Gem::Specification]
-    # @return [String] The path to the cached yardoc.
-    def cache(yard_plugins, gemspec)
-      path = PinCache.yardoc_path gemspec
-      return path if cached?(gemspec)
+    #
+    # @return [void]
+    def build_docs gem_yardoc_path, yard_plugins, gemspec
+      return if docs_built?(gem_yardoc_path)
 
       unless Dir.exist? gemspec.gem_dir
         # Can happen in at least some (old?) RubyGems versions when we
@@ -24,35 +24,44 @@ module Solargraph
         #
         # https://github.com/apiology/solargraph/actions/runs/17650140201/job/50158676842?pr=10
         Solargraph.logger.info { "Bad info from gemspec - #{gemspec.gem_dir} does not exist" }
-        return path
+        return
       end
 
       Solargraph.logger.info "Caching yardoc for #{gemspec.name} #{gemspec.version}"
-      cmd = "yardoc --db #{path} --no-output --plugin solargraph"
+      cmd = "yardoc --db #{gem_yardoc_path} --no-output --plugin solargraph"
       yard_plugins.each { |plugin| cmd << " --plugin #{plugin}" }
       Solargraph.logger.debug { "Running: #{cmd}" }
       # @todo set these up to run in parallel
+      # @sg-ignore Our fill won't work properly due to an issue in
+      #   Callable#arity_matches? - see comment there
       stdout_and_stderr_str, status = Open3.capture2e(current_bundle_env_tweaks, cmd, chdir: gemspec.gem_dir)
-      unless status.success?
-        Solargraph.logger.warn { "YARD failed running #{cmd.inspect} in #{gemspec.gem_dir}" }
-        Solargraph.logger.info stdout_and_stderr_str
-      end
-      path
+      return if status.success?
+      Solargraph.logger.warn { "YARD failed running #{cmd.inspect} in #{gemspec.gem_dir}" }
+      Solargraph.logger.info stdout_and_stderr_str
+    end
+
+    # @param gem_yardoc_path [String] the path to the yardoc cache of a particular gem
+    # @param gemspec [Gem::Specification, Bundler::LazySpecification]
+    # @param out [StringIO, IO, nil] where to log messages
+    # @return [Array<Pin::Base>]
+    def build_pins gem_yardoc_path, gemspec, out: $stderr
+      yardoc = load!(gem_yardoc_path)
+      YardMap::Mapper.new(yardoc, gemspec).map
     end
 
     # True if the gem yardoc is cached.
     #
-    # @param gemspec [Gem::Specification]
-    def cached?(gemspec)
-      yardoc = File.join(PinCache.yardoc_path(gemspec), 'complete')
+    # @param gem_yardoc_path [String]
+    def docs_built? gem_yardoc_path
+      yardoc = File.join(gem_yardoc_path, 'complete')
       File.exist?(yardoc)
     end
 
     # True if another process is currently building the yardoc cache.
     #
-    # @param gemspec [Gem::Specification]
-    def processing?(gemspec)
-      yardoc = File.join(PinCache.yardoc_path(gemspec), 'processing')
+    # @param gem_yardoc_path [String] the path to the yardoc cache of a particular gem
+    def processing? gem_yardoc_path
+      yardoc = File.join(gem_yardoc_path, 'processing')
       File.exist?(yardoc)
     end
 
@@ -60,10 +69,10 @@ module Solargraph
     #
     # @note This method modifies the global YARD registry.
     #
-    # @param gemspec [Gem::Specification]
+    # @param gem_yardoc_path [String] the path to the yardoc cache of a particular gem
     # @return [Array<YARD::CodeObjects::Base>]
-    def load!(gemspec)
-      YARD::Registry.load! PinCache.yardoc_path gemspec
+    def load! gem_yardoc_path
+      YARD::Registry.load! gem_yardoc_path
       YARD::Registry.all
     end
 
@@ -78,6 +87,7 @@ module Solargraph
     # @return [Hash{String => String}] a hash of environment variables to override
     def current_bundle_env_tweaks
       tweaks = {}
+      # @sg-ignore Translate to something flow sensitive typing understands
       if ENV['BUNDLE_GEMFILE'] && !ENV['BUNDLE_GEMFILE'].empty?
         tweaks['BUNDLE_GEMFILE'] = File.expand_path(ENV['BUNDLE_GEMFILE'])
       end

data/lib/solargraph.rb

@@ -55,8 +55,8 @@ module Solargraph
 
   CHDIR_MUTEX = Mutex.new
 
-  # @param type [Symbol] Type of assert.
-  def self.asserts_on?(type)
+  def self.asserts_on?
+    # @sg-ignore Translate to something flow sensitive typing understands
     if ENV['SOLARGRAPH_ASSERTS'].nil? || ENV['SOLARGRAPH_ASSERTS'].empty?
       false
     elsif ENV['SOLARGRAPH_ASSERTS'] == 'on'
@@ -72,7 +72,28 @@ module Solargraph
   # @param block [Proc] A block that returns a message to log
   # @return [void]
   def self.assert_or_log(type, msg = nil, &block)
-    raise (msg || block.call) if asserts_on?(type) && ![:combine_with_visibility].include?(type)
+    if asserts_on?
+      # @type [String, nil]
+      msg ||= block.call
+
+      raise "No message given for #{type.inspect}" if msg.nil?
+
+      # conditional aliases to handle compatibility corner cases
+      # @sg-ignore flow sensitive typing needs to handle 'raise if'
+      return if type == :alias_target_missing && msg.include?('highline/compatibility.rb')
+      # @sg-ignore flow sensitive typing needs to handle 'raise if'
+      return if type == :alias_target_missing && msg.include?('lib/json/add/date.rb')
+      # @todo :combine_with_visibility is not ready for prime time -
+      #  lots of disagreements found in practice that heuristics need
+      #  to be created for and/or debugging needs to resolve in pin
+      #  generation.
+      # @todo :api_map_namespace_pin_stack triggers in a badly handled
+      #   self type case - 'keeps track of self type in method
+      #   parameters in subclass' in call_spec.rb
+      return if %i[api_map_namespace_pin_stack combine_with_visibility].include?(type)
+
+      raise msg
+    end
     logger.info msg, &block
   end
 

data/rbs/fills/rubygems/0/dependency.rbs

@@ -0,0 +1,193 @@
+# <!-- rdoc-file=lib/rubygems/dependency.rb -->
+# The Dependency class holds a Gem name and a Gem::Requirement.
+#
+class Gem::Dependency
+  @name: untyped
+
+  @requirement: untyped
+
+  @type: untyped
+
+  @prerelease: untyped
+
+  @version_requirements: untyped
+
+  @version_requirement: untyped
+
+  # <!-- rdoc-file=lib/rubygems/dependency.rb -->
+  # Valid dependency types.
+  #
+  TYPES: ::Array[:development | :runtime]
+
+  # <!-- rdoc-file=lib/rubygems/dependency.rb -->
+  # Dependency name or regular expression.
+  #
+  attr_accessor name: untyped
+
+  # <!-- rdoc-file=lib/rubygems/dependency.rb -->
+  # Allows you to force this dependency to be a prerelease.
+  #
+  attr_writer prerelease: untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/dependency.rb
+  #   - new(name, *requirements)
+  # -->
+  # Constructs a dependency with `name` and `requirements`. The last argument can
+  # optionally be the dependency type, which defaults to `:runtime`.
+  #
+  def initialize: (untyped name, *untyped requirements) -> void
+
+  def hash: () -> untyped
+
+  def inspect: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/dependency.rb
+  #   - prerelease?()
+  # -->
+  # Does this dependency require a prerelease?
+  #
+  def prerelease?: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/dependency.rb
+  #   - latest_version?()
+  # -->
+  # Is this dependency simply asking for the latest version of a gem?
+  #
+  def latest_version?: () -> untyped
+
+  def pretty_print: (untyped q) -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/dependency.rb
+  #   - requirement()
+  # -->
+  # What does this dependency require?
+  #
+  def requirement: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/dependency.rb
+  #   - requirements_list()
+  # -->
+  #
+  def requirements_list: () -> untyped
+
+  def to_s: () -> ::String
+
+  # <!--
+  #   rdoc-file=lib/rubygems/dependency.rb
+  #   - type()
+  # -->
+  # Dependency type.
+  #
+  def type: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/dependency.rb
+  #   - runtime?()
+  # -->
+  #
+  def runtime?: () -> untyped
+
+  def ==: (untyped other) -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/dependency.rb
+  #   - <=>(other)
+  # -->
+  # Dependencies are ordered by name.
+  #
+  def <=>: (untyped other) -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/dependency.rb
+  #   - =~(other)
+  # -->
+  # Uses this dependency as a pattern to compare to `other`. This dependency will
+  # match if the name matches the other's name, and other has only an equal
+  # version requirement that satisfies this dependency.
+  #
+  def =~: (untyped other) -> (nil | false | untyped)
+
+  # <!--
+  #   rdoc-file=lib/rubygems/dependency.rb
+  #   - ===(other)
+  # -->
+  #
+  alias === =~
+
+  # <!--
+  #   rdoc-file=lib/rubygems/dependency.rb
+  #   - dep.match? name          => true or false
+  #   - dep.match? name, version => true or false
+  #   - dep.match? spec          => true or false
+  # -->
+  # Does this dependency match the specification described by `name` and `version`
+  # or match `spec`?
+  #
+  # NOTE:  Unlike #matches_spec? this method does not return true when the version
+  # is a prerelease version unless this is a prerelease dependency.
+  #
+  def match?: (untyped obj, ?untyped? version, ?bool allow_prerelease) -> (false | true | untyped)
+
+  # <!--
+  #   rdoc-file=lib/rubygems/dependency.rb
+  #   - matches_spec?(spec)
+  # -->
+  # Does this dependency match `spec`?
+  #
+  # NOTE:  This is not a convenience method.  Unlike #match? this method returns
+  # true when `spec` is a prerelease version even if this dependency is not a
+  # prerelease dependency.
+  #
+  def matches_spec?: (untyped spec) -> (false | true | untyped)
+
+  # <!--
+  #   rdoc-file=lib/rubygems/dependency.rb
+  #   - merge(other)
+  # -->
+  # Merges the requirements of `other` into this dependency
+  #
+  def merge: (untyped other) -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/dependency.rb
+  #   - matching_specs(platform_only = false)
+  # -->
+  #
+  def matching_specs: (?bool platform_only) -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/dependency.rb
+  #   - specific?()
+  # -->
+  # True if the dependency will not always match the latest version.
+  #
+  def specific?: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/dependency.rb
+  #   - to_specs()
+  # -->
+  #
+  def to_specs: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/dependency.rb
+  #   - to_spec()
+  # -->
+  #
+  def to_spec: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/dependency.rb
+  #   - identity()
+  # -->
+  #
+  def identity: () -> (:complete | :abs_latest | :latest | :released)
+
+  def encode_with: (untyped coder) -> untyped
+end

data/rbs/fills/tuple/tuple.rbs

@@ -144,6 +144,34 @@ module Solargraph
                | [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)
+
+      # <!--
+      #   rdoc-file=array.rb
+      #   - first -> object or nil
+      #   - first(count) -> new_array
+      # -->
+      # Returns elements from `self`, or `nil`; does not modify `self`.
+      #
+      # With no argument given, returns the first element (if available):
+      #
+      #     a = [:foo, 'bar', 2]
+      #     a.first # => :foo
+      #     a # => [:foo, "bar", 2]
+      #
+      # If `self` is empty, returns `nil`.
+      #
+      #     [].first # => nil
+      #
+      # With a non-negative integer argument `count` given, returns the first `count`
+      # elements (as available) in a new array:
+      #
+      #     a.first(0)  # => []
+      #     a.first(2)  # => [:foo, "bar"]
+      #     a.first(50) # => [:foo, "bar", 2]
+      #
+      # Related: see [Methods for Querying](rdoc-ref:Array@Methods+for+Querying).
+      #
+      def first: %a{implicitly-returns-nil} () -> A
     end
   end
 end

data/rbs/shims/ast/0/node.rbs

@@ -1,5 +1,5 @@
 module ::AST
   class Node
-     def children: () -> [self, Integer, String, Symbol, nil]
+     def children: () -> Array[self | Integer | String | Symbol | nil]
   end
 end

data/rbs/shims/diff-lcs/1.5/diff-lcs.rbs

@@ -0,0 +1,11 @@
+module Diff
+end
+
+module Diff::LCS
+  def self.LCS: (Array[String], Array[String]) -> Array[String]
+              | (String, String) -> Array[String]
+  def self.diff: (Array[String], Array[String]) -> Array[Array[String]]
+              | (String, String) -> Array[Array[Diff::LCS::Change]]
+
+  def self.patch!: (Array[String], Array[String]) -> String
+end

data/solargraph.gemspec

@@ -1,3 +1,4 @@
+# @sg-ignore Should better support meaning of '&' in RBS
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/lib'
 require 'solargraph/version'
 require 'date'
@@ -42,7 +43,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'open3', '~> 0.2.1'
   s.add_runtime_dependency 'parser', '~> 3.0'
   s.add_runtime_dependency 'prism', '~> 1.4'
-  s.add_runtime_dependency 'rbs', ['>= 3.6.1', '<= 4.0.0.dev.4']
+  s.add_runtime_dependency 'rbs', ['>= 3.6.1', '<= 4.0.0.dev.5']
   s.add_runtime_dependency 'reverse_markdown', '~> 3.0'
   s.add_runtime_dependency 'rubocop', '~> 1.76'
   s.add_runtime_dependency 'thor', '~> 1.0'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.58.3
+  version: 0.59.0.dev.1
 platform: ruby
 authors:
 - Fred Snyder
 bindir: bin
 cert_chain: []
-date: 2026-03-09 00:00:00.000000000 Z
+date: 2026-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ast
@@ -220,7 +220,7 @@ dependencies:
         version: 3.6.1
     - - "<="
       - !ruby/object:Gem::Version
-        version: 4.0.0.dev.4
+        version: 4.0.0.dev.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -230,7 +230,7 @@ dependencies:
         version: 3.6.1
     - - "<="
       - !ruby/object:Gem::Version
-        version: 4.0.0.dev.4
+        version: 4.0.0.dev.5
 - !ruby/object:Gem::Dependency
   name: reverse_markdown
   requirement: !ruby/object:Gem::Requirement
@@ -538,6 +538,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".envrc"
 - ".gitattributes"
 - ".github/FUNDING.yml"
 - ".github/workflows/linting.yml"
@@ -566,6 +567,7 @@ files:
 - lib/solargraph/api_map/store.rb
 - lib/solargraph/bench.rb
 - lib/solargraph/complex_type.rb
+- lib/solargraph/complex_type/conformance.rb
 - lib/solargraph/complex_type/type_methods.rb
 - lib/solargraph/complex_type/unique_type.rb
 - lib/solargraph/convention.rb
@@ -688,12 +690,14 @@ files:
 - lib/solargraph/parser/parser_gem/node_processors/masgn_node.rb
 - lib/solargraph/parser/parser_gem/node_processors/namespace_node.rb
 - lib/solargraph/parser/parser_gem/node_processors/opasgn_node.rb
+- lib/solargraph/parser/parser_gem/node_processors/or_node.rb
 - lib/solargraph/parser/parser_gem/node_processors/orasgn_node.rb
 - lib/solargraph/parser/parser_gem/node_processors/resbody_node.rb
 - lib/solargraph/parser/parser_gem/node_processors/sclass_node.rb
 - lib/solargraph/parser/parser_gem/node_processors/send_node.rb
 - lib/solargraph/parser/parser_gem/node_processors/sym_node.rb
 - lib/solargraph/parser/parser_gem/node_processors/until_node.rb
+- lib/solargraph/parser/parser_gem/node_processors/when_node.rb
 - lib/solargraph/parser/parser_gem/node_processors/while_node.rb
 - lib/solargraph/parser/region.rb
 - lib/solargraph/parser/snippet.rb
@@ -706,6 +710,7 @@ files:
 - lib/solargraph/pin/class_variable.rb
 - lib/solargraph/pin/closure.rb
 - lib/solargraph/pin/common.rb
+- lib/solargraph/pin/compound_statement.rb
 - lib/solargraph/pin/constant.rb
 - lib/solargraph/pin/conversions.rb
 - lib/solargraph/pin/delegated_method.rb
@@ -774,8 +779,6 @@ files:
 - lib/solargraph/source_map/data.rb
 - lib/solargraph/source_map/mapper.rb
 - lib/solargraph/type_checker.rb
-- lib/solargraph/type_checker/checks.rb
-- lib/solargraph/type_checker/param_def.rb
 - lib/solargraph/type_checker/problem.rb
 - lib/solargraph/type_checker/rules.rb
 - lib/solargraph/version.rb
@@ -788,6 +791,7 @@ files:
 - lib/solargraph/views/search.erb
 - lib/solargraph/workspace.rb
 - lib/solargraph/workspace/config.rb
+- lib/solargraph/workspace/gemspecs.rb
 - lib/solargraph/workspace/require_paths.rb
 - lib/solargraph/yard_map.rb
 - lib/solargraph/yard_map/cache.rb
@@ -796,12 +800,12 @@ files:
 - lib/solargraph/yard_map/mapper/to_constant.rb
 - lib/solargraph/yard_map/mapper/to_method.rb
 - lib/solargraph/yard_map/mapper/to_namespace.rb
-- lib/solargraph/yard_map/to_method.rb
 - lib/solargraph/yard_tags.rb
 - lib/solargraph/yardoc.rb
 - rbs/fills/bundler/0/bundler.rbs
 - rbs/fills/open3/0/open3.rbs
 - rbs/fills/rubygems/0/basic_specification.rbs
+- rbs/fills/rubygems/0/dependency.rbs
 - rbs/fills/rubygems/0/errors.rbs
 - rbs/fills/rubygems/0/spec_fetcher.rbs
 - rbs/fills/rubygems/0/specification.rbs
@@ -809,6 +813,7 @@ files:
 - rbs/shims/ast/0/node.rbs
 - rbs/shims/ast/2.4/.rbs_meta.yaml
 - rbs/shims/ast/2.4/ast.rbs
+- rbs/shims/diff-lcs/1.5/diff-lcs.rbs
 - rbs/shims/parser/3.2.0.1/builders/default.rbs
 - rbs/shims/parser/3.2.0.1/manifest.yaml
 - rbs/shims/parser/3.2.0.1/parser.rbs