solargraph 0.57.0 → 0.58.3

data/lib/solargraph/yard_map/to_method.rb

@@ -1,88 +1,89 @@
-# frozen_string_literal: true
-
-module Solargraph
-  class YardMap
-    class ToMethod
-      module InnerMethods
-        module_function
-
-        # @param code_object [YARD::CodeObjects::Base]
-        # @param location [Solargraph::Location]
-        # @param comments [String]
-        # @return [Array<Solargraph::Pin::Parameter>]
-        def get_parameters code_object, location, comments
-          return [] unless code_object.is_a?(YARD::CodeObjects::MethodObject)
-          # HACK: Skip `nil` and `self` parameters that are sometimes emitted
-          # for methods defined in C
-          # See https://github.com/castwide/solargraph/issues/345
-          code_object.parameters.select { |a| a[0] && a[0] != 'self' }.map do |a|
-            Solargraph::Pin::Parameter.new(
-              location: location,
-              closure: self,
-              comments: comments,
-              name: arg_name(a),
-              presence: nil,
-              decl: arg_type(a),
-              asgn_code: a[1],
-              source: :yard_map
-            )
-          end
-        end
-
-        # @param a [Array<String>]
-        # @return [String]
-        def arg_name a
-          a[0].gsub(/[^a-z0-9_]/i, '')
-        end
-
-        # @param a [Array]
-        # @return [::Symbol]
-        def arg_type a
-          if a[0].start_with?('**')
-            :kwrestarg
-          elsif a[0].start_with?('*')
-            :restarg
-          elsif a[0].start_with?('&')
-            :blockarg
-          elsif a[0].end_with?(':')
-            a[1] ? :kwoptarg : :kwarg
-          elsif a[1]
-            :optarg
-          else
-            :arg
-          end
-        end
-      end
-      private_constant :InnerMethods
-
-      include Helpers
-
-      # @param code_object [YARD::CodeObjects::Base]
-      # @param name [String, nil]
-      # @param scope [Symbol, nil]
-      # @param visibility [Symbol, nil]
-      # @param closure [Solargraph::Pin::Base, nil]
-      # @param spec [Solargraph::Pin::Base, nil]
-      # @return [Solargraph::Pin::Method]
-      def make code_object, name = nil, scope = nil, visibility = nil, closure = nil, spec = nil
-        closure ||= Solargraph::Pin::Namespace.new(
-          name: code_object.namespace.to_s,
-          gates: [code_object.namespace.to_s]
-        )
-        location = object_location(code_object, spec)
-        comments = code_object.docstring ? code_object.docstring.all.to_s : ''
-        Pin::Method.new(
-          location: location,
-          closure: closure,
-          name: name || code_object.name.to_s,
-          comments: comments,
-          scope: scope || code_object.scope,
-          visibility: visibility || code_object.visibility,
-          parameters: InnerMethods.get_parameters(code_object, location, comments),
-          explicit: code_object.is_explicit?,
-          source: :yard_map
-        )
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  class YardMap
+    class ToMethod
+      module InnerMethods
+        module_function
+
+        # @param code_object [YARD::CodeObjects::Base]
+        # @param location [Solargraph::Location]
+        # @param comments [String]
+        # @return [Array<Solargraph::Pin::Parameter>]
+        def get_parameters code_object, location, comments
+          return [] unless code_object.is_a?(YARD::CodeObjects::MethodObject)
+          # HACK: Skip `nil` and `self` parameters that are sometimes emitted
+          # for methods defined in C
+          # See https://github.com/castwide/solargraph/issues/345
+          # @sg-ignore https://github.com/castwide/solargraph/pull/1114
+          code_object.parameters.select { |a| a[0] && a[0] != 'self' }.map do |a|
+            Solargraph::Pin::Parameter.new(
+              location: location,
+              closure: self,
+              comments: comments,
+              name: arg_name(a),
+              presence: nil,
+              decl: arg_type(a),
+              asgn_code: a[1],
+              source: :yard_map
+            )
+          end
+        end
+
+        # @param a [Array<String>]
+        # @return [String]
+        def arg_name a
+          a[0].gsub(/[^a-z0-9_]/i, '')
+        end
+
+        # @param a [Array]
+        # @return [::Symbol]
+        def arg_type a
+          if a[0].start_with?('**')
+            :kwrestarg
+          elsif a[0].start_with?('*')
+            :restarg
+          elsif a[0].start_with?('&')
+            :blockarg
+          elsif a[0].end_with?(':')
+            a[1] ? :kwoptarg : :kwarg
+          elsif a[1]
+            :optarg
+          else
+            :arg
+          end
+        end
+      end
+      private_constant :InnerMethods
+
+      include Helpers
+
+      # @param code_object [YARD::CodeObjects::MethodObject]
+      # @param name [String, nil]
+      # @param scope [Symbol, nil]
+      # @param visibility [Symbol, nil]
+      # @param closure [Solargraph::Pin::Base, nil]
+      # @param spec [Solargraph::Pin::Base, nil]
+      # @return [Solargraph::Pin::Method]
+      def make code_object, name = nil, scope = nil, visibility = nil, closure = nil, spec = nil
+        closure ||= Solargraph::Pin::Namespace.new(
+          name: code_object.namespace.to_s,
+          gates: [code_object.namespace.to_s]
+        )
+        location = object_location(code_object, spec)
+        comments = code_object.docstring ? code_object.docstring.all.to_s : ''
+        Pin::Method.new(
+          location: location,
+          closure: closure,
+          name: name || code_object.name.to_s,
+          comments: comments,
+          scope: scope || code_object.scope,
+          visibility: visibility || code_object.visibility,
+          parameters: InnerMethods.get_parameters(code_object, location, comments),
+          explicit: code_object.is_explicit?,
+          source: :yard_map
+        )
+      end
+    end
+  end
+end

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

@@ -1,64 +1,87 @@
-# frozen_string_literal: true
-
-require 'open3'
-
-module Solargraph
-  # Methods for caching and loading YARD documentation for gems.
-  #
-  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)
-
-      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
-      #
-      # @sg-ignore RBS gem doesn't reflect that Open3.* also include
-      #   kwopts from Process.spawn()
-      stdout_and_stderr_str, status = Open3.capture2e(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
-    end
-
-    # True if the gem yardoc is cached.
-    #
-    # @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 gemspec [Gem::Specification]
-    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.
-    #
-    # @note This method modifies the global YARD registry.
-    #
-    # @param gemspec [Gem::Specification]
-    # @return [Array<YARD::CodeObjects::Base>]
-    def load!(gemspec)
-      YARD::Registry.load! PinCache.yardoc_path gemspec
-      YARD::Registry.all
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'open3'
+
+module Solargraph
+  # Methods for caching and loading YARD documentation for gems.
+  #
+  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)
+
+      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 #{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
+      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
+    end
+
+    # True if the gem yardoc is cached.
+    #
+    # @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 gemspec [Gem::Specification]
+    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.
+    #
+    # @note This method modifies the global YARD registry.
+    #
+    # @param gemspec [Gem::Specification]
+    # @return [Array<YARD::CodeObjects::Base>]
+    def load!(gemspec)
+      YARD::Registry.load! PinCache.yardoc_path gemspec
+      YARD::Registry.all
+    end
+
+    # 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 = {}
+      if ENV['BUNDLE_GEMFILE'] && !ENV['BUNDLE_GEMFILE'].empty?
+        tweaks['BUNDLE_GEMFILE'] = File.expand_path(ENV['BUNDLE_GEMFILE'])
+      end
+      tweaks
+    end
+  end
+end

data/lib/solargraph.rb

@@ -1,105 +1,105 @@
-# frozen_string_literal: true
-
-Encoding.default_external = 'UTF-8'
-
-require 'bundler'
-require 'set'
-require 'yard-solargraph'
-require 'solargraph/yard_tags'
-require 'solargraph/version'
-
-# The top-level namespace for the Solargraph code mapping, documentation,
-# static analysis, and language server libraries.
-#
-module Solargraph
-  class InvalidOffsetError         < RangeError;    end
-  class DiagnosticsError           < RuntimeError;  end
-  class FileNotFoundError          < RuntimeError;  end
-  class SourceNotAvailableError    < StandardError; end
-  class ComplexTypeError           < StandardError; end
-  class WorkspaceTooLargeError     < RuntimeError;  end
-  class BundleNotFoundError        < StandardError; end
-  class InvalidRubocopVersionError < RuntimeError;  end
-
-  autoload :Position,         'solargraph/position'
-  autoload :Range,            'solargraph/range'
-  autoload :Location,         'solargraph/location'
-  autoload :Shell,            'solargraph/shell'
-  autoload :Source,           'solargraph/source'
-  autoload :SourceMap,        'solargraph/source_map'
-  autoload :ApiMap,           'solargraph/api_map'
-  autoload :Yardoc,           'solargraph/yardoc'
-  autoload :YardMap,          'solargraph/yard_map'
-  autoload :Pin,              'solargraph/pin'
-  autoload :DocMap,           'solargraph/doc_map'
-  autoload :ServerMethods,    'solargraph/server_methods'
-  autoload :LanguageServer,   'solargraph/language_server'
-  autoload :Workspace,        'solargraph/workspace'
-  autoload :Page,             'solargraph/page'
-  autoload :Library,          'solargraph/library'
-  autoload :Diagnostics,      'solargraph/diagnostics'
-  autoload :ComplexType,      'solargraph/complex_type'
-  autoload :Bench,            'solargraph/bench'
-  autoload :Logging,          'solargraph/logging'
-  autoload :TypeChecker,      'solargraph/type_checker'
-  autoload :Environ,          'solargraph/environ'
-  autoload :Equality,         'solargraph/equality'
-  autoload :Convention,       'solargraph/convention'
-  autoload :Parser,           'solargraph/parser'
-  autoload :RbsMap,           'solargraph/rbs_map'
-  autoload :GemPins,          'solargraph/gem_pins'
-  autoload :PinCache,         'solargraph/pin_cache'
-
-  dir = File.dirname(__FILE__)
-  VIEWS_PATH = File.join(dir, 'solargraph', 'views')
-
-  CHDIR_MUTEX = Mutex.new
-
-  # @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
-
-  # @param type [Symbol] The type of assertion to perform.
-  # @param msg [String, nil] An optional message to log
-  # @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)
-    logger.info msg, &block
-  end
-
-  # A convenience method for Solargraph::Logging.logger.
-  #
-  # @return [Logger]
-  def self.logger
-    Solargraph::Logging.logger
-  end
-
-  # A helper method that runs Bundler.with_unbundled_env or falls back to
-  # Bundler.with_clean_env for earlier versions of Bundler.
-  #
-  # @generic T
-  # @yieldreturn [generic<T>]
-  # @sg-ignore dynamic call, but both functions behave the same
-  # @return [generic<T>]
-  def self.with_clean_env &block
-    meth = if Bundler.respond_to?(:with_original_env)
-      :with_original_env
-    else
-      :with_clean_env
-    end
-    Bundler.send meth, &block
-  end
-end
-
-# Ensure that ParserGem node processors are properly loaded to avoid conflicts
-# with Convention node processors
-require 'solargraph/parser/parser_gem/node_processors'
+# frozen_string_literal: true
+
+Encoding.default_external = 'UTF-8'
+
+require 'bundler'
+require 'set'
+require 'yard-solargraph'
+require 'solargraph/yard_tags'
+require 'solargraph/version'
+
+# The top-level namespace for the Solargraph code mapping, documentation,
+# static analysis, and language server libraries.
+#
+module Solargraph
+  class InvalidOffsetError         < RangeError;    end
+  class DiagnosticsError           < RuntimeError;  end
+  class FileNotFoundError          < RuntimeError;  end
+  class SourceNotAvailableError    < StandardError; end
+  class ComplexTypeError           < StandardError; end
+  class WorkspaceTooLargeError     < RuntimeError;  end
+  class BundleNotFoundError        < StandardError; end
+  class InvalidRubocopVersionError < RuntimeError;  end
+
+  autoload :Position,         'solargraph/position'
+  autoload :Range,            'solargraph/range'
+  autoload :Location,         'solargraph/location'
+  autoload :Shell,            'solargraph/shell'
+  autoload :Source,           'solargraph/source'
+  autoload :SourceMap,        'solargraph/source_map'
+  autoload :ApiMap,           'solargraph/api_map'
+  autoload :Yardoc,           'solargraph/yardoc'
+  autoload :YardMap,          'solargraph/yard_map'
+  autoload :Pin,              'solargraph/pin'
+  autoload :DocMap,           'solargraph/doc_map'
+  autoload :ServerMethods,    'solargraph/server_methods'
+  autoload :LanguageServer,   'solargraph/language_server'
+  autoload :Workspace,        'solargraph/workspace'
+  autoload :Page,             'solargraph/page'
+  autoload :Library,          'solargraph/library'
+  autoload :Diagnostics,      'solargraph/diagnostics'
+  autoload :ComplexType,      'solargraph/complex_type'
+  autoload :Bench,            'solargraph/bench'
+  autoload :Logging,          'solargraph/logging'
+  autoload :TypeChecker,      'solargraph/type_checker'
+  autoload :Environ,          'solargraph/environ'
+  autoload :Equality,         'solargraph/equality'
+  autoload :Convention,       'solargraph/convention'
+  autoload :Parser,           'solargraph/parser'
+  autoload :RbsMap,           'solargraph/rbs_map'
+  autoload :GemPins,          'solargraph/gem_pins'
+  autoload :PinCache,         'solargraph/pin_cache'
+
+  dir = File.dirname(__FILE__)
+  VIEWS_PATH = File.join(dir, 'solargraph', 'views')
+
+  CHDIR_MUTEX = Mutex.new
+
+  # @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
+
+  # @param type [Symbol] The type of assertion to perform.
+  # @param msg [String, nil] An optional message to log
+  # @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)
+    logger.info msg, &block
+  end
+
+  # A convenience method for Solargraph::Logging.logger.
+  #
+  # @return [Logger]
+  def self.logger
+    Solargraph::Logging.logger
+  end
+
+  # A helper method that runs Bundler.with_unbundled_env or falls back to
+  # Bundler.with_clean_env for earlier versions of Bundler.
+  #
+  # @generic T
+  # @yieldreturn [generic<T>]
+  # @sg-ignore dynamic call, but both functions behave the same
+  # @return [generic<T>]
+  def self.with_clean_env &block
+    meth = if Bundler.respond_to?(:with_original_env)
+      :with_original_env
+    else
+      :with_clean_env
+    end
+    Bundler.send meth, &block
+  end
+end
+
+# Ensure that ParserGem node processors are properly loaded to avoid conflicts
+# with Convention node processors
+require 'solargraph/parser/parser_gem/node_processors'