solargraph 0.59.0.dev.2 → 0.59.0

data/lib/solargraph/workspace.rb

@@ -2,7 +2,6 @@
 
 require 'open3'
 require 'json'
-require 'yaml'
 
 module Solargraph
   # A workspace consists of the files in a project's directory and the
@@ -10,8 +9,6 @@ module Solargraph
   # in an associated Library or ApiMap.
   #
   class Workspace
-    include Logging
-
     autoload :Config, 'solargraph/workspace/config'
     autoload :Gemspecs, 'solargraph/workspace/gemspecs'
     autoload :RequirePaths, 'solargraph/workspace/require_paths'
@@ -23,8 +20,7 @@ module Solargraph
     attr_reader :gemnames
     alias source_gems gemnames
 
-    # @todo Remove '' and '*' special cases
-    # @param directory [String]
+    # @param directory [String] TODO: Remove '' and '*' special cases
     # @param config [Config, nil]
     # @param server [Hash]
     def initialize directory = '', config = nil, server = {}
@@ -55,68 +51,6 @@ module Solargraph
       @config ||= Solargraph::Workspace::Config.new(directory)
     end
 
-    # @param stdlib_name [String]
-    #
-    # @return [Array<String>]
-    def stdlib_dependencies stdlib_name
-      gemspecs.stdlib_dependencies(stdlib_name)
-    end
-
-    # @param out [IO, nil] output stream for logging
-    # @param gemspec [Gem::Specification]
-    # @return [Array<Gem::Specification>]
-    def fetch_dependencies gemspec, out: $stderr
-      gemspecs.fetch_dependencies(gemspec, out: out)
-    end
-
-    # @param require [String] The string sent to 'require' in the code to resolve, e.g. 'rails', 'bundler/require'
-    # @return [Array<Gem::Specification>, nil]
-    def resolve_require require
-      gemspecs.resolve_require(require)
-    end
-
-    # @return [Solargraph::PinCache]
-    def pin_cache
-      @pin_cache ||= fresh_pincache
-    end
-
-    # @return [Environ]
-    def global_environ
-      # empty docmap, since the result needs to work in any possible
-      # context here
-      @global_environ ||= Convention.for_global(DocMap.new([], self, out: nil))
-    end
-
-    # @param gemspec [Gem::Specification]
-    # @param out [StringIO, IO, nil] output stream for logging
-    # @param rebuild [Boolean] whether to rebuild the pins even if they are cached
-    #
-    # @return [void]
-    def cache_gem gemspec, out: nil, rebuild: false
-      pin_cache.cache_gem(gemspec: gemspec, out: out, rebuild: rebuild)
-    end
-
-    # @param gemspec [Gem::Specification, Bundler::LazySpecification]
-    # @param out [StringIO, IO, nil] output stream for logging
-    #
-    # @return [void]
-    def uncache_gem gemspec, out: nil
-      pin_cache.uncache_gem(gemspec, out: out)
-    end
-
-    # @return [Solargraph::PinCache]
-    def fresh_pincache
-      PinCache.new(rbs_collection_path: rbs_collection_path,
-                   rbs_collection_config_path: rbs_collection_config_path,
-                   yard_plugins: yard_plugins,
-                   directory: directory)
-    end
-
-    # @return [Array<String>]
-    def yard_plugins
-      @yard_plugins ||= global_environ.yard_plugins.sort.uniq
-    end
-
     # @param level [Symbol]
     # @return [TypeChecker::Rules]
     def rules level
@@ -130,7 +64,6 @@ module Solargraph
     # @param sources [Array<Solargraph::Source>]
     # @return [Boolean] True if the source was added to the workspace
     def merge *sources
-      # @sg-ignore Need to add nil check here
       unless directory == '*' || sources.all? { |source| source_hash.key?(source.filename) }
         # Reload the config to determine if a new source should be included
         @config = Solargraph::Workspace::Config.new(directory)
@@ -138,10 +71,9 @@ module Solargraph
 
       includes_any = false
       sources.each do |source|
-        # @sg-ignore Need to add nil check here
         next unless directory == '*' || config.calculated.include?(source.filename)
 
-        # @sg-ignore Need to add nil check here
+        # @sg-ignore Wrong argument type for Hash#[]=: arg0 expected String, received String, nil
         source_hash[source.filename] = source
         includes_any = true
       end
@@ -196,23 +128,6 @@ module Solargraph
       false
     end
 
-    # True if the workspace contains at least one gemspec file.
-    #
-    # @return [Boolean]
-    def gemspec?
-      !gemspec_files.empty?
-    end
-
-    # Get an array of all gemspec files in the workspace.
-    #
-    # @return [Array<String>]
-    def gemspec_files
-      return [] if directory.empty? || directory == '*'
-      @gemspec_files ||= Dir[File.join(directory, '**/*.gemspec')].select do |gs|
-        config.allow? gs
-      end
-    end
-
     # @return [String, nil]
     def rbs_collection_path
       @rbs_collection_path ||= read_rbs_collection_path
@@ -220,11 +135,10 @@ module Solargraph
 
     # @return [String, nil]
     def rbs_collection_config_path
-      @rbs_collection_config_path ||=
-        unless directory.empty? || directory == '*'
-          yaml_file = File.join(directory, 'rbs_collection.yaml')
-          yaml_file if File.file?(yaml_file)
-        end
+      @rbs_collection_config_path ||= unless directory.empty? || directory == '*'
+                                        yaml_file = File.join(directory, 'rbs_collection.yaml')
+                                        yaml_file if File.file?(yaml_file)
+                                      end
     end
 
     # @param name [String]
@@ -233,34 +147,7 @@ module Solargraph
     #
     # @return [Gem::Specification, nil]
     def find_gem name, version = nil, out: nil
-      gemspecs.find_gem(name, version, out: out)
-    end
-
-    # @return [Array<Gem::Specification>]
-    def all_gemspecs_from_bundle
-      gemspecs.all_gemspecs_from_bundle
-    end
-
-    # @param out [StringIO, IO, nil] output stream for logging
-    # @param rebuild [Boolean] whether to rebuild the pins even if they are cached
-    # @return [void]
-    def cache_all_for_workspace! out, rebuild: false
-      PinCache.cache_core(out: out) unless PinCache.core? && !rebuild
-
-      gem_specs = all_gemspecs_from_bundle
-      # try any possible standard libraries, but be quiet about it
-      stdlib_specs = pin_cache.possible_stdlibs.map { |stdlib| find_gem(stdlib, out: nil) }.compact
-      specs = (gem_specs + stdlib_specs)
-      specs.each do |spec|
-        pin_cache.cache_gem(gemspec: spec, rebuild: rebuild, out: out) unless pin_cache.cached?(spec)
-      end
-      out&.puts "Documentation cached for all #{specs.length} gems."
-
-      # do this after so that we prefer stdlib requires from gems,
-      # which are likely to be newer and have more pins
-      pin_cache.cache_all_stdlibs(out: out, rebuild: rebuild)
-
-      out&.puts 'Documentation cached for core, standard library and gems.'
+      Gem::Specification.find_by_name(name, version)
     end
 
     # Synchronize the workspace from the provided updater.
@@ -271,9 +158,8 @@ module Solargraph
       source_hash[updater.filename] = source_hash[updater.filename].synchronize(updater)
     end
 
-    # @sg-ignore Need to validate config
+    # @sg-ignore return type could not be inferred
     # @return [String]
-    # @sg-ignore Need to validate config
     def command_path
       server['commandPath'] || 'solargraph'
     end
@@ -284,9 +170,29 @@ module Solargraph
       directory
     end
 
-    # @return [Solargraph::Workspace::Gemspecs]
-    def gemspecs
-      @gemspecs ||= Solargraph::Workspace::Gemspecs.new(directory_or_nil)
+    # 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
+
+    # True if the workspace contains at least one gemspec file.
+    #
+    # @return [Boolean]
+    def gemspec?
+      !gemspec_files.empty?
+    end
+
+    # Get an array of all gemspec files in the workspace.
+    #
+    # @return [Array<String>]
+    def gemspec_files
+      return [] if directory.empty? || directory == '*'
+      @gemspec_files ||= Dir[File.join(directory, '**/*.gemspec')].select do |gs|
+        config.allow? gs
+      end
     end
 
     private
@@ -307,10 +213,7 @@ module Solargraph
       source_hash.clear
       return if directory.empty? || directory == '*'
       size = config.calculated.length
-      if config.max_files.positive? && (size > config.max_files)
-        raise WorkspaceTooLargeError,
-              "The workspace is too large to index (#{size} files, #{config.max_files} max)"
-      end
+      raise WorkspaceTooLargeError, "The workspace is too large to index (#{size} files, #{config.max_files} max)" if config.max_files.positive? && size > config.max_files
       config.calculated.each do |filename|
         source_hash[filename] = Solargraph::Source.load(filename)
       rescue Errno::ENOENT => e

data/lib/solargraph/yard_map.rb

@@ -1,18 +1,17 @@
-# frozen_string_literal: true
-
-require 'yard'
-require 'solargraph/yard_tags'
-
-module Solargraph
-  # The YardMap provides access to YARD documentation for the Ruby core, the
-  # stdlib, and gems.
-  #
-  class YardMap
-    class NoYardocError < StandardError; end
-
-    autoload :Cache,       'solargraph/yard_map/cache'
-    autoload :Mapper,      'solargraph/yard_map/mapper'
-    autoload :Helpers,     'solargraph/yard_map/helpers'
-    autoload :ToMethod,    'solargraph/yard_map/to_method'
-  end
-end
+# frozen_string_literal: true
+
+require 'yard'
+require 'solargraph/yard_tags'
+
+module Solargraph
+  # The YardMap provides access to YARD documentation for the Ruby core, the
+  # stdlib, and gems.
+  #
+  class YardMap
+    class NoYardocError < StandardError; end
+
+    autoload :Cache,       'solargraph/yard_map/cache'
+    autoload :Mapper,      'solargraph/yard_map/mapper'
+    autoload :Helpers,     'solargraph/yard_map/helpers'
+  end
+end

data/lib/solargraph/yardoc.rb

@@ -8,15 +8,15 @@ module Solargraph
   module Yardoc
     module_function
 
-    # Build and save a gem's yardoc into a given path.
+    # Build and cache a gem's yardoc and return the path. If the cache already
+    # exists, do nothing and return the path.
     #
-    # @param gem_yardoc_path [String] the path to the yardoc cache of a particular gem
-    # @param yard_plugins [Array<String>]
+    # @param yard_plugins [Array<String>] The names of YARD plugins to use.
     # @param gemspec [Gem::Specification]
-    #
-    # @return [void]
-    def build_docs gem_yardoc_path, yard_plugins, gemspec
-      return if docs_built?(gem_yardoc_path)
+    # @return [String] The path to the cached yardoc.
+    def cache yard_plugins, gemspec
+      path = PinCache.yardoc_path gemspec
+      return path if cached?(gemspec)
 
       unless Dir.exist? gemspec.gem_dir
         # Can happen in at least some (old?) RubyGems versions when we
@@ -24,44 +24,37 @@ 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
+        return path
       end
 
       Solargraph.logger.info "Caching yardoc for #{gemspec.name} #{gemspec.version}"
-      cmd = "yardoc --db #{gem_yardoc_path} --no-output --plugin solargraph"
+      cmd = "yardoc --db #{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
+      # @todo Is the chdir argument being used here?
+      # @sg-ignore Unrecognized keyword argument chdir to Open3.capture2e
       stdout_and_stderr_str, status = Open3.capture2e(current_bundle_env_tweaks, cmd, chdir: gemspec.gem_dir)
-      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
+      unless status.success?
+        Solargraph.logger.warn { "YARD failed running #{cmd.inspect} in #{gemspec.gem_dir}" }
+        Solargraph.logger.info stdout_and_stderr_str
+      end
+      path
     end
 
     # True if the gem yardoc is cached.
     #
-    # @param gem_yardoc_path [String]
-    def docs_built? gem_yardoc_path
-      yardoc = File.join(gem_yardoc_path, 'complete')
+    # @param gemspec [Gem::Specification]
+    def cached? gemspec
+      yardoc = File.join(PinCache.yardoc_path(gemspec), 'complete')
       File.exist?(yardoc)
     end
 
     # True if another process is currently building the yardoc cache.
     #
-    # @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')
+    # @param gemspec [Gem::Specification]
+    def processing? gemspec
+      yardoc = File.join(PinCache.yardoc_path(gemspec), 'processing')
       File.exist?(yardoc)
     end
 
@@ -69,10 +62,10 @@ module Solargraph
     #
     # @note This method modifies the global YARD registry.
     #
-    # @param gem_yardoc_path [String] the path to the yardoc cache of a particular gem
+    # @param gemspec [Gem::Specification]
     # @return [Array<YARD::CodeObjects::Base>]
-    def load! gem_yardoc_path
-      YARD::Registry.load! gem_yardoc_path
+    def load! gemspec
+      YARD::Registry.load! PinCache.yardoc_path gemspec
       YARD::Registry.all
     end
 
@@ -87,7 +80,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
+      # @sg-ignore Unresolved call to empty? on String, nil
       if ENV['BUNDLE_GEMFILE'] && !ENV['BUNDLE_GEMFILE'].empty?
         tweaks['BUNDLE_GEMFILE'] = File.expand_path(ENV['BUNDLE_GEMFILE'])
       end

data/lib/solargraph.rb

@@ -83,6 +83,8 @@ module Solargraph
       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')
+      # @sg-ignore flow sensitive typing needs to handle 'raise if'
+      return if type == :alias_target_missing && msg.include?('rubocop-ast.rbs')
       # @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

data/solargraph.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
   s.metadata['source_code_uri'] = 'https://github.com/castwide/solargraph'
   s.metadata['rubygems_mfa_required'] = 'true'
 
-  s.required_ruby_version = '>= 3.0'
+  s.required_ruby_version = '>= 3.1'
 
   s.add_dependency 'ast', '~> 2.4.3'
   s.add_dependency 'backport', '~> 1.2'
@@ -44,7 +44,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'ostruct', '~> 0.6'
   s.add_dependency 'parser', '~> 3.0'
   s.add_dependency 'prism', '~> 1.4'
-  s.add_dependency 'rbs', ['>= 3.6.1', '<= 4.0.0.dev.5']
+  s.add_dependency 'rbs', '>= 3.10.0'
   s.add_dependency 'reverse_markdown', '~> 3.0'
   s.add_dependency 'rubocop', '~> 1.76'
   s.add_dependency 'thor', '~> 1.0'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.59.0.dev.2
+  version: 0.59.0
 platform: ruby
 authors:
 - Fred Snyder
@@ -217,20 +217,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.6.1
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 4.0.0.dev.5
+        version: 3.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.6.1
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 4.0.0.dev.5
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: reverse_markdown
   requirement: !ruby/object:Gem::Requirement
@@ -733,6 +727,7 @@ files:
 - lib/solargraph/pin/reference/prepend.rb
 - lib/solargraph/pin/reference/require.rb
 - lib/solargraph/pin/reference/superclass.rb
+- lib/solargraph/pin/reference/type_alias.rb
 - lib/solargraph/pin/search.rb
 - lib/solargraph/pin/signature.rb
 - lib/solargraph/pin/singleton.rb
@@ -839,14 +834,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 4.0.6
 specification_version: 4
 summary: A Ruby language server
 test_files: []