solargraph 0.60.3 → 0.61.0

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Solargraph
-  class YardMap
+  module YardMap
     class Mapper
       module ToConstant
         extend YardMap::Helpers

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Solargraph
-  class YardMap
+  module YardMap
     class Mapper
       module ToMethod
         extend YardMap::Helpers

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Solargraph
-  class YardMap
+  module YardMap
     class Mapper
       module ToNamespace
         extend YardMap::Helpers

data/lib/solargraph/yard_map/mapper.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Solargraph
-  class YardMap
+  module YardMap
     class Mapper
       autoload :ToMethod, 'solargraph/yard_map/mapper/to_method'
       autoload :ToNamespace, 'solargraph/yard_map/mapper/to_namespace'
@@ -11,7 +11,7 @@ module Solargraph
       # @param spec [Gem::Specification, nil]
       def initialize code_objects, spec = nil
         @code_objects = code_objects
-        @macro_code_objects = code_objects.select { |co| co.is_a?(YARD::CodeObjects::MacroObject) }
+        @macro_code_objects = code_objects.grep(YARD::CodeObjects::MacroObject)
         @spec = spec
         # @type [Array<Solargraph::Pin::Base>]
         @pins = []
@@ -32,13 +32,17 @@ module Solargraph
 
       private
 
+      def core_store
+        @core_store ||= ApiMap::Store.new(RbsMap::Core.new.pins)
+      end
+
       # @param code_object [YARD::CodeObjects::Base]
       # @return [Array<Pin::Base>]
       def generate_pins code_object
         result = []
         case code_object
         when YARD::CodeObjects::NamespaceObject
-          nspin = ToNamespace.make(code_object, @spec, @namespace_pins[code_object.namespace.to_s])
+          nspin = namespace_with_bug_fix(code_object)
           @namespace_pins[code_object.path] = nspin
           result.push nspin
           if code_object.is_a?(YARD::CodeObjects::ClassObject) && !code_object.superclass.nil?
@@ -50,7 +54,16 @@ module Solargraph
                          else
                            code_object.superclass.to_s
                          end
-            result.push Solargraph::Pin::Reference::Superclass.new(name: superclass, closure: nspin, source: :yard_map)
+            # YARD fills in `Object` for every class whose definition it never
+            # saw a superclass clause on - including a bare `class Foo`
+            # reopening, which asserts nothing about ancestry - and keeps no
+            # record of which case it was. A class with no superclass reference
+            # already resolves to Object, so recording this one adds nothing and
+            # can shadow a superclass declared in another source.
+            unless superclass.delete_prefix('::') == 'Object'
+              result.push Solargraph::Pin::Reference::Superclass.new(name: superclass, closure: nspin,
+                                                                     source: :yard_map)
+            end
           end
           # @sg-ignore flow sensitive typing ought to be able to handle 'when ClassName'
           code_object.class_mixins.each do |m|
@@ -72,6 +85,8 @@ module Solargraph
             # @todo Check the visibility of <Class>.new
             result.push ToMethod.make(code_object, 'new', :class, :public, closure, @spec)
             result.push ToMethod.make(code_object, 'initialize', :instance, :private, closure, @spec)
+          elsif closure&.source == :yard_map_hack
+            result.push ToMethod.make(code_object, nil, :instance, nil, closure, @spec)
           else
             result.push ToMethod.make(code_object, nil, nil, nil, closure, @spec)
           end
@@ -97,6 +112,24 @@ module Solargraph
       def macros_for_method_object method_object
         attached_macros_by_method_object[method_object]
       end
+
+      # Handle a bug in YARD where code that opens a constant's singleton class
+      # (e.g., `class << ENV`) creates a pin that incorrectly overrides the
+      # original constant's value.
+      #
+      # @param code_object [YARD::CodeObjects::NamespaceObject]
+      # @return [Pin::Namespace]
+      def namespace_with_bug_fix code_object
+        core_pin = core_store.get_path_pins(code_object.path)
+                             .find { |pin| pin.is_a?(Pin::Constant) }
+        if core_pin
+          location = Helpers.object_location(code_object, @spec)
+          Solargraph.logger.warn "Adjusting YARD pin that conflicts with RBS core (#{code_object.inspect} #{location.inspect})"
+          Pin::Namespace.new(name: core_pin.return_type.namespace, location: location, source: :yard_map_hack)
+        else
+          ToNamespace.make(code_object, @spec, @namespace_pins[code_object.namespace.to_s])
+        end
+      end
     end
   end
 end

data/lib/solargraph/yard_map.rb

@@ -7,7 +7,7 @@ module Solargraph
   # The YardMap provides access to YARD documentation for the Ruby core, the
   # stdlib, and gems.
   #
-  class YardMap
+  module YardMap
     class NoYardocError < StandardError; end
 
     autoload :Cache,       'solargraph/yard_map/cache'

data/lib/solargraph/yardoc.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'open3'
+require 'fileutils'
 
 module Solargraph
   # Methods for caching and loading YARD documentation for gems.
@@ -8,83 +9,65 @@ 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.
-    #
-    # @param yard_plugins [Array<String>] The names of YARD plugins to use.
-    # @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)
+    def path_for metagem
+      File.join(CacheDir.yard_dir, "#{metagem.cache_name}.yardoc")
+    end
+
+    # @param metagem [Metagem]
+    # @param force [Boolean]
+    # @return [void]
+    def cache metagem, force: false
+      return unless force || !cached?(metagem)
 
-      unless Dir.exist? gemspec.gem_dir
-        # Can happen in at least some (old?) RubyGems versions when we
-        # have a gemspec describing a standard library like bundler.
-        #
-        # 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
-      end
+      Solargraph.logger.info "Caching yardoc for #{metagem.cache_name}"
+      path = path_for(metagem)
+      FileUtils.mkdir_p File.dirname(path)
+      cmd = ['yardoc', '--db', path, '--no-output', '--plugin', 'solargraph', '--plugin', 'activesupport-concern']
+      Solargraph.logger.debug "Running: #{cmd.inspect}"
+      output, status = Open3.capture2e(*cmd, chdir: metagem.full_path)
+      return if status.success?
 
-      Solargraph.logger.info "Caching yardoc for #{gemspec.name} #{gemspec.version}"
-      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
-      # @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)
-      unless status.success?
-        Solargraph.logger.warn { "YARD failed running #{cmd.inspect} in #{gemspec.gem_dir}" }
-        Solargraph.logger.info stdout_and_stderr_str
-      end
-      path
+      Solargraph.logger.warn { "YARD failed running #{cmd.inspect} in #{metagem.full_path}" }
+      Solargraph.logger.info output
+    # @todo Ignore missing metagems for now. We need to figure out why this
+    #   happens in GitHub actions.
+    rescue Errno::ENOENT => _e
+      Solargraph.logger.warn "Gem #{metagem.name} #{metagem.version} not found at #{metagem.full_path}"
     end
 
-    # True if the gem yardoc is cached.
-    #
-    # @param gemspec [Gem::Specification]
-    def cached? gemspec
-      yardoc = File.join(PinCache.yardoc_path(gemspec), 'complete')
+    # @param metagem [Metagem]
+    # @return [void]
+    def uncache metagem
+      FileUtils.rm_rf path_for(metagem)
+    end
+
+    # @param metagem [Metagem]
+    def cached? metagem
+      yardoc = File.join(path_for(metagem), 'complete')
       File.exist?(yardoc)
     end
+    alias exist? cached?
 
     # 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 metagem [Metagem]
+    def processing? metagem
+      yardoc = File.join(path_for(metagem), 'processing')
       File.exist?(yardoc)
     end
 
-    # Load a gem's yardoc and return its code objects.
+    # Load a gem's yardoc cache and return its code objects.
     #
     # @note This method modifies the global YARD registry.
     #
-    # @param gemspec [Gem::Specification]
+    # @param metagem [Metagem]
     # @return [Array<YARD::CodeObjects::Base>]
-    def load! gemspec
-      YARD::Registry.load! PinCache.yardoc_path gemspec
-      YARD::Registry.all
-    end
+    def load! metagem
+      cache metagem
+      return [] unless cached?(metagem)
 
-    # If the BUNDLE_GEMFILE environment variable is set, we need to
-    # make sure it's an absolute path, as we'll be changing
-    # directories.
-    #
-    # 'bundle exec' sets an absolute path here, but at least the
-    # overcommit gem does not, breaking on-the-fly documention with a
-    # spawned yardoc command from our current bundle
-    #
-    # @return [Hash{String => String}] a hash of environment variables to override
-    def current_bundle_env_tweaks
-      tweaks = {}
-      # @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
-      tweaks
+      YARD::Registry.load! path_for(metagem)
+      YARD::Registry.all
     end
   end
 end

data/lib/solargraph.rb

@@ -4,6 +4,7 @@ Encoding.default_external = 'UTF-8'
 
 require 'bundler'
 require 'set'
+require 'yard-activesupport-concern'
 require 'yard-solargraph'
 require 'solargraph/yard_tags'
 require 'solargraph/version'
@@ -31,7 +32,10 @@ module Solargraph
   autoload :Yardoc,           'solargraph/yardoc'
   autoload :YardMap,          'solargraph/yard_map'
   autoload :Pin,              'solargraph/pin'
-  autoload :DocMap,           'solargraph/doc_map'
+  autoload :Metagem,          'solargraph/metagem'
+  autoload :Repo,             'solargraph/repo'
+  autoload :External,         'solargraph/external'
+  autoload :Collection,       'solargraph/collection'
   autoload :ServerMethods,    'solargraph/server_methods'
   autoload :LanguageServer,   'solargraph/language_server'
   autoload :Workspace,        'solargraph/workspace'
@@ -47,8 +51,7 @@ module Solargraph
   autoload :Convention,       'solargraph/convention'
   autoload :Parser,           'solargraph/parser'
   autoload :RbsMap,           'solargraph/rbs_map'
-  autoload :GemPins,          'solargraph/gem_pins'
-  autoload :PinCache,         'solargraph/pin_cache'
+  autoload :CacheDir,         'solargraph/cache_dir'
   autoload :RbsTranslator,    'solargraph/rbs_translator'
 
   dir = File.dirname(__FILE__)

data/solargraph.gemspec

@@ -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.10.0'
+  s.add_dependency 'rbs', '>= 3.10.4'
   s.add_dependency 'rdoc', '~> 7.0'
   s.add_dependency 'reverse_markdown', '~> 3.0'
   s.add_dependency 'rubocop', '~> 1.76'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.60.3
+  version: 0.61.0
 platform: ruby
 authors:
 - Fred Snyder
@@ -217,14 +217,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.10.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.10.4
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -588,6 +588,13 @@ files:
 - lib/solargraph/api_map/source_to_yard.rb
 - lib/solargraph/api_map/store.rb
 - lib/solargraph/bench.rb
+- lib/solargraph/cache_dir.rb
+- lib/solargraph/collection.rb
+- lib/solargraph/collection/base.rb
+- lib/solargraph/collection/core.rb
+- lib/solargraph/collection/gem.rb
+- lib/solargraph/collection/rbs.rb
+- lib/solargraph/collection/stdlib.rb
 - lib/solargraph/complex_type.rb
 - lib/solargraph/complex_type/conformance.rb
 - lib/solargraph/complex_type/type_methods.rb
@@ -616,10 +623,9 @@ files:
 - lib/solargraph/diagnostics/severities.rb
 - lib/solargraph/diagnostics/type_check.rb
 - lib/solargraph/diagnostics/update_errors.rb
-- lib/solargraph/doc_map.rb
 - lib/solargraph/environ.rb
 - lib/solargraph/equality.rb
-- lib/solargraph/gem_pins.rb
+- lib/solargraph/external.rb
 - lib/solargraph/language_server.rb
 - lib/solargraph/language_server/completion_item_kinds.rb
 - lib/solargraph/language_server/error_codes.rb
@@ -684,6 +690,7 @@ files:
 - lib/solargraph/library.rb
 - lib/solargraph/location.rb
 - lib/solargraph/logging.rb
+- lib/solargraph/metagem.rb
 - lib/solargraph/page.rb
 - lib/solargraph/parser.rb
 - lib/solargraph/parser/comment_ripper.rb
@@ -738,6 +745,7 @@ files:
 - lib/solargraph/pin/delegated_method.rb
 - lib/solargraph/pin/documenting.rb
 - lib/solargraph/pin/duck_method.rb
+- lib/solargraph/pin/factory_parameter.rb
 - lib/solargraph/pin/global_variable.rb
 - lib/solargraph/pin/instance_variable.rb
 - lib/solargraph/pin/keyword.rb
@@ -762,15 +770,19 @@ 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
+- lib/solargraph/rbs_map/base.rb
 - lib/solargraph/rbs_map/conversions.rb
+- lib/solargraph/rbs_map/core.rb
 - lib/solargraph/rbs_map/core_fills.rb
-- lib/solargraph/rbs_map/core_map.rb
-- lib/solargraph/rbs_map/stdlib_map.rb
+- lib/solargraph/rbs_map/gem.rb
+- lib/solargraph/rbs_map/helpers.rb
+- lib/solargraph/rbs_map/path.rb
+- lib/solargraph/rbs_map/stdlib.rb
 - lib/solargraph/rbs_translator.rb
+- lib/solargraph/repo.rb
 - lib/solargraph/server_methods.rb
 - lib/solargraph/shell.rb
 - lib/solargraph/source.rb
@@ -789,6 +801,7 @@ files:
 - lib/solargraph/source/chain/link.rb
 - lib/solargraph/source/chain/literal.rb
 - lib/solargraph/source/chain/or.rb
+- lib/solargraph/source/chain/parameter.rb
 - lib/solargraph/source/chain/q_call.rb
 - lib/solargraph/source/chain/variable.rb
 - lib/solargraph/source/chain/z_super.rb
@@ -815,7 +828,6 @@ 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
@@ -825,6 +837,7 @@ files:
 - lib/solargraph/yard_map/directives/method_directive.rb
 - lib/solargraph/yard_map/directives/override_directive.rb
 - lib/solargraph/yard_map/directives/parse_directive.rb
+- lib/solargraph/yard_map/directives/scope_directive.rb
 - lib/solargraph/yard_map/directives/visibility_directive.rb
 - lib/solargraph/yard_map/helpers.rb
 - lib/solargraph/yard_map/macro.rb