solargraph 0.58.3 → 0.60.0

data/lib/solargraph/yard_map/mapper.rb

@@ -11,6 +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) }
         @spec = spec
         # @type [Array<Solargraph::Pin::Base>]
         @pins = []
@@ -24,6 +25,7 @@ module Solargraph
         end
         # Some yardocs contain documentation for dependencies that can be
         # ignored here. The YardMap will load dependencies separately.
+        # @sg-ignore does not consider `pin.location.nil? || ` condition
         @pins.keep_if { |pin| pin.location.nil? || File.file?(pin.location.filename) } if @spec
         @pins
       end
@@ -34,24 +36,27 @@ module Solargraph
       # @return [Array<Pin::Base>]
       def generate_pins code_object
         result = []
-        if code_object.is_a?(YARD::CodeObjects::NamespaceObject)
+        case code_object
+        when YARD::CodeObjects::NamespaceObject
           nspin = ToNamespace.make(code_object, @spec, @namespace_pins[code_object.namespace.to_s])
           @namespace_pins[code_object.path] = nspin
           result.push nspin
-          if code_object.is_a?(YARD::CodeObjects::ClassObject) and !code_object.superclass.nil?
+          if code_object.is_a?(YARD::CodeObjects::ClassObject) && !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.
             superclass = if code_object.superclass.is_a?(YARD::CodeObjects::Proxy)
-              "::#{code_object.superclass}"
-            else
-              code_object.superclass.to_s
-            end
+                           "::#{code_object.superclass}"
+                         else
+                           code_object.superclass.to_s
+                         end
             result.push Solargraph::Pin::Reference::Superclass.new(name: superclass, closure: nspin, source: :yard_map)
           end
+          # @sg-ignore flow sensitive typing ought to be able to handle 'when ClassName'
           code_object.class_mixins.each do |m|
             result.push Solargraph::Pin::Reference::Extend.new(closure: nspin, name: m.path, source: :yard_map)
           end
+          # @sg-ignore flow sensitive typing ought to be able to handle 'when ClassName'
           code_object.instance_mixins.each do |m|
             result.push Solargraph::Pin::Reference::Include.new(
               closure: nspin, # @todo Fix this
@@ -59,8 +64,10 @@ module Solargraph
               source: :yard_map
             )
           end
-        elsif code_object.is_a?(YARD::CodeObjects::MethodObject)
+        when YARD::CodeObjects::MethodObject
           closure = @namespace_pins[code_object.namespace.to_s]
+          macros_for_method_object(code_object)
+          # @sg-ignore flow sensitive typing ought to be able to handle 'when ClassName'
           if code_object.name == :initialize && code_object.scope == :instance
             # @todo Check the visibility of <Class>.new
             result.push ToMethod.make(code_object, 'new', :class, :public, closure, @spec)
@@ -68,12 +75,28 @@ module Solargraph
           else
             result.push ToMethod.make(code_object, nil, nil, nil, closure, @spec)
           end
-        elsif code_object.is_a?(YARD::CodeObjects::ConstantObject)
+        when YARD::CodeObjects::ConstantObject
           closure = @namespace_pins[code_object.namespace]
           result.push ToConstant.make(code_object, closure, @spec)
         end
         result
       end
+
+      # @return [Array<YARD::CodeObjects::MacroObject>]
+      def attached_macros
+        @attached_macros ||= @macro_code_objects.select(&:attached?)
+      end
+
+      # @return [Hash{YARD::CodeObjects::MethodObject => Array<YARD::CodeObjects::MacroObject>}]
+      def attached_macros_by_method_object
+        @attached_macros_by_method_object ||= attached_macros.group_by(&:method_object)
+      end
+
+      # @param method_object [YARD::CodeObjects::MethodObject]
+      # @return [Array<YARD::CodeObjects::MacroObject>]
+      def macros_for_method_object method_object
+        attached_macros_by_method_object[method_object]
+      end
     end
   end
 end

data/lib/solargraph/yard_map.rb

@@ -1,18 +1,19 @@
-# 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'
+    autoload :Macro,       'solargraph/yard_map/macro'
+    autoload :Directives,  'solargraph/yard_map/directives'
+  end
+end

data/lib/solargraph/yard_tags.rb

@@ -14,7 +14,7 @@ module Solargraph
 end
 
 # Define a @type tag for documenting variables
-YARD::Tags::Library.define_tag("Type", :type, :with_types_and_name)
+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)
+YARD::Tags::Library.define_directive('override', :with_name, Solargraph::DomainDirective)

data/lib/solargraph/yardoc.rb

@@ -14,7 +14,7 @@ module Solargraph
     # @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)
+    def cache yard_plugins, gemspec
       path = PinCache.yardoc_path gemspec
       return path if cached?(gemspec)
 
@@ -32,6 +32,8 @@ module 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}" }
@@ -43,7 +45,7 @@ module Solargraph
     # True if the gem yardoc is cached.
     #
     # @param gemspec [Gem::Specification]
-    def cached?(gemspec)
+    def cached? gemspec
       yardoc = File.join(PinCache.yardoc_path(gemspec), 'complete')
       File.exist?(yardoc)
     end
@@ -51,7 +53,7 @@ module Solargraph
     # True if another process is currently building the yardoc cache.
     #
     # @param gemspec [Gem::Specification]
-    def processing?(gemspec)
+    def processing? gemspec
       yardoc = File.join(PinCache.yardoc_path(gemspec), 'processing')
       File.exist?(yardoc)
     end
@@ -62,7 +64,7 @@ module Solargraph
     #
     # @param gemspec [Gem::Specification]
     # @return [Array<YARD::CodeObjects::Base>]
-    def load!(gemspec)
+    def load! gemspec
       YARD::Registry.load! PinCache.yardoc_path gemspec
       YARD::Registry.all
     end
@@ -78,6 +80,7 @@ module Solargraph
     # @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

data/lib/solargraph.rb

@@ -49,14 +49,15 @@ module Solargraph
   autoload :RbsMap,           'solargraph/rbs_map'
   autoload :GemPins,          'solargraph/gem_pins'
   autoload :PinCache,         'solargraph/pin_cache'
+  autoload :RbsTranslator,    'solargraph/rbs_translator'
 
   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)
+  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'
@@ -71,8 +72,31 @@ module Solargraph
   # @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)
+  def self.assert_or_log type, msg = nil, &block
+    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')
+      # @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
+      #  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
 
@@ -90,13 +114,13 @@ module Solargraph
   # @yieldreturn [generic<T>]
   # @sg-ignore dynamic call, but both functions behave the same
   # @return [generic<T>]
-  def self.with_clean_env &block
+  def self.with_clean_env(&)
     meth = if Bundler.respond_to?(:with_original_env)
-      :with_original_env
-    else
-      :with_clean_env
-    end
-    Bundler.send meth, &block
+             :with_original_env
+           else
+             :with_clean_env
+           end
+    Bundler.send(meth, &)
   end
 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/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,4 +1,7 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/lib'
+# frozen_string_literal: true
+
+# @sg-ignore Should better support meaning of '&' in RBS
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/lib"
 require 'solargraph/version'
 require 'date'
 
@@ -6,12 +9,11 @@ require 'date'
 Gem::Specification.new do |s|
   s.name        = 'solargraph'
   s.version     = Solargraph::VERSION
-  s.date        = Date.today.strftime("%Y-%m-%d")
-  s.summary     = "A Ruby language server"
-  s.description = "IDE tools for code completion, inline documentation, and static analysis"
-  s.authors     = ["Fred Snyder"]
+  s.summary     = 'A Ruby language server'
+  s.description = 'IDE tools for code completion, inline documentation, and static analysis'
+  s.authors     = ['Fred Snyder']
   s.email       = 'admin@castwide.com'
-  s.files       = Dir.chdir(File.expand_path('..', __FILE__)) do
+  s.files       = Dir.chdir(File.expand_path(__dir__)) do
     # @sg-ignore Need backtick support
     # @type [String]
     all_files = `git ls-files -z`
@@ -20,36 +22,37 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://solargraph.org'
   s.license     = 'MIT'
   s.executables = ['solargraph']
-  s.metadata["funding_uri"]     = "https://www.patreon.com/castwide"
-  s.metadata["bug_tracker_uri"] = "https://github.com/castwide/solargraph/issues"
-  s.metadata["changelog_uri"]   = "https://github.com/castwide/solargraph/blob/master/CHANGELOG.md"
-  s.metadata["source_code_uri"] = "https://github.com/castwide/solargraph"
-  s.metadata["rubygems_mfa_required"] = "true"
+  s.metadata['funding_uri']     = 'https://www.patreon.com/castwide'
+  s.metadata['bug_tracker_uri'] = 'https://github.com/castwide/solargraph/issues'
+  s.metadata['changelog_uri']   = 'https://github.com/castwide/solargraph/blob/master/CHANGELOG.md'
+  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_runtime_dependency 'ast', '~> 2.4.3'
-  s.add_runtime_dependency 'backport', '~> 1.2'
-  s.add_runtime_dependency 'benchmark', '~> 0.4'
-  s.add_runtime_dependency 'bundler', '>= 2.0'
-  s.add_runtime_dependency 'diff-lcs', '~> 1.4'
-  s.add_runtime_dependency 'jaro_winkler', '~> 1.6', '>= 1.6.1'
-  s.add_runtime_dependency 'kramdown', '~> 2.3'
-  s.add_runtime_dependency 'kramdown-parser-gfm', '~> 1.1'
-  s.add_runtime_dependency 'logger', '~> 1.6'
-  s.add_runtime_dependency 'observer', '~> 0.1'
-  s.add_runtime_dependency 'ostruct', '~> 0.6'
-  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 'reverse_markdown', '~> 3.0'
-  s.add_runtime_dependency 'rubocop', '~> 1.76'
-  s.add_runtime_dependency 'thor', '~> 1.0'
-  s.add_runtime_dependency 'tilt', '~> 2.0'
-  s.add_runtime_dependency 'yard', '~> 0.9', '>= 0.9.24'
-  s.add_runtime_dependency 'yard-solargraph', '~> 0.1'
-  s.add_runtime_dependency 'yard-activesupport-concern', '~> 0.0'
+  s.add_dependency 'ast', '~> 2.4.3'
+  s.add_dependency 'backport', '~> 1.2'
+  s.add_dependency 'benchmark', '~> 0.4'
+  s.add_dependency 'bundler', '>= 2.0'
+  s.add_dependency 'diff-lcs', '~> 1.4'
+  s.add_dependency 'jaro_winkler', '~> 1.6', '>= 1.6.1'
+  s.add_dependency 'kramdown', '~> 2.3'
+  s.add_dependency 'kramdown-parser-gfm', '~> 1.1'
+  s.add_dependency 'logger', '~> 1.6'
+  s.add_dependency 'observer', '~> 0.1'
+  s.add_dependency 'open3', '~> 0.2.1'
+  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 'reverse_markdown', '~> 3.0'
+  s.add_dependency 'rubocop', '~> 1.76'
+  s.add_dependency 'sord', '~> 7.0'
+  s.add_dependency 'thor', '~> 1.0'
+  s.add_dependency 'tilt', '~> 2.0'
+  s.add_dependency 'yard', '~> 0.9', '>= 0.9.24'
+  s.add_dependency 'yard-activesupport-concern', '~> 0.0'
+  s.add_dependency 'yard-solargraph', '~> 0.1'
 
   s.add_development_dependency 'pry', '~> 0.15'
   s.add_development_dependency 'public_suffix', '~> 3.1'
@@ -61,6 +64,7 @@ Gem::Specification.new do |s|
   #
   # even more specific on RuboCop itself, which is written into _todo
   # file.
+  s.add_development_dependency 'overcommit', '~> 0.68.0'
   s.add_development_dependency 'rubocop', '~> 1.80.0.0'
   s.add_development_dependency 'rubocop-rake', '~> 0.7.1'
   s.add_development_dependency 'rubocop-rspec', '~> 3.6.0'
@@ -68,7 +72,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'simplecov', '~> 0.21'
   s.add_development_dependency 'simplecov-lcov', '~> 0.8'
   s.add_development_dependency 'undercover', '~> 0.7'
-  s.add_development_dependency 'overcommit', '~> 0.68.0'
   s.add_development_dependency 'webmock', '~> 3.6'
   # work around missing yard dependency needed as of Ruby 3.5
   s.add_development_dependency 'irb', '~> 1.15'