solargraph 0.59.1 → 0.60.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9346852d9ba48c677a63c6ac2dd3bf6b7cb536309f28569c256bc8654c19c865
-  data.tar.gz: 9fd017aedc2b705156999d93f5bc8f5f6b99cd7cc3716565ef42ab26936336eb
+  metadata.gz: e3eff86e8759fbaaa9526cf9cceb70827c701f3b1925d58e1575870989d60e60
+  data.tar.gz: a60b5c8e9598afdca808c94fa68e2551d17f970b812ca64c3f00d530d0498fff
 SHA512:
-  metadata.gz: 5b8d3c627dec8757b70444e444a66dd024818f3e62e7c8d9ea57a638182de64524cca532c7b8ae9c5944d373cfdb2e0f3a1ede46e1e8b3e4e728d02b2f9db0e0
-  data.tar.gz: 41321b8ad277092a434241bc099488c99c721fb7bf593cb3c41f703329ba2d90e2416b5f407ed858db69776d02eb9bb3c93025d094de6f4413fd368f933a7398
+  metadata.gz: 201861185888f275b0c7690887cca60a76d0bb90955c514ba4336e23f2adb9907d305f5e930b08f03c3c388d81bfd40996cd54c0f854035aab5a60703c40f954
+  data.tar.gz: b37cc2ed827560a2365b77af0921c0240498dcb287e1a1ba064f0879a748c2d365f0e61cec610233b11521206ab402e83aebbdec5c897a21eb3e9f7313fba602

data/.github/workflows/linting.yml

@@ -59,6 +59,8 @@ jobs:
         run: |
           bundle exec overcommit --sign
           SOLARGRAPH_ASSERTS=on bundle exec overcommit --run --diff origin/master
+        # @todo Temporary, expect to revert in 0.60
+        continue-on-error: true
   rubocop:
     name: rubocop
     runs-on: ubuntu-latest
@@ -95,6 +97,8 @@ jobs:
 
     - name: Run rbs validate
       run: bundle exec rbs validate
+      # @todo Temporary, expect to revert in 0.60
+      continue-on-error: true
   rubocop_todo:
     name: .rubocop_todo.yml
     runs-on: ubuntu-latest
@@ -112,6 +116,8 @@ jobs:
 
     - name: Run RuboCop
       run: bundle exec rubocop -c .rubocop.yml
+      # @todo Temporary, expect to revert in 0.60
+      continue-on-error: true
 
     - name: Run RuboCop against todo file
       continue-on-error: true

data/.github/workflows/plugins.yml

@@ -45,6 +45,8 @@ jobs:
       run: bundle exec rbs collection update
     - name: Ensure typechecking still works
       run: bundle exec solargraph typecheck --level strong
+      # @todo Temporary, expect to revert in 0.60
+      continue-on-error: true
     - name: Ensure specs still run
       run: bundle exec rake spec
   rails:
@@ -78,6 +80,8 @@ jobs:
       run: bundle exec rbs collection update
     - name: Ensure typechecking still works
       run: bundle exec solargraph typecheck --level strong
+      # @todo Temporary, expect to revert in 0.60
+      continue-on-error: true
     - name: Ensure specs still run
       run: bundle exec rake spec
   rspec:
@@ -109,6 +113,8 @@ jobs:
       run: bundle exec rbs collection update
     - name: Ensure typechecking still works
       run: bundle exec solargraph typecheck --level strong
+      # @todo Temporary, expect to revert in 0.60
+      continue-on-error: true
     - name: Ensure specs still run
       run: bundle exec rake spec
 
@@ -229,3 +235,5 @@ jobs:
         ALLOW_IMPROVEMENTS=true bundle exec rake spec
       env:
         MATRIX_RAILS_VERSION: "7.0"
+      # @todo Temporary, expect to revert in 0.60
+      continue-on-error: true

data/.github/workflows/rspec.yml

@@ -21,7 +21,10 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['3.1', '3.2', '3.3', '3.4', '4.0', 'head']
+        # @todo Restore 'head' once ruby/setup-ruby publishes it for ubuntu-24.04.
+        #   It currently 404s ("Unavailable version head for ruby"), failing CI:
+        #   https://github.com/castwide/solargraph/actions/runs/25863741955/job/76000137015?pr=1187
+        ruby-version: ['3.1', '3.2', '3.3', '3.4', '4.0']
         rbs-version: ['3.10.0', '4.0.0', '4.0.1', '4.0.2']
         exclude:
           - ruby-version: '3.1'

data/.github/workflows/typecheck.yml

@@ -38,3 +38,5 @@ jobs:
       run: bundle exec rbs collection install
     - name: Typecheck self
       run: SOLARGRAPH_ASSERTS=on bundle exec solargraph typecheck --level strong
+      # @todo Temporary, expect to revert in 0.60
+      continue-on-error: true

data/.rubocop.yml

@@ -17,6 +17,7 @@ AllCops:
     - "spec/fixtures/invalid_byte.rb"
     - "spec/fixtures/invalid_node_comment.rb"
     - "spec/fixtures/invalid_utf8.rb"
+    - "spec/fixtures/gem-with-yard-macros/**/*"
     - "vendor/**/*"
     - "vendor/**/.*"
   TargetRubyVersion: 3.1

data/.rubocop_todo.yml

@@ -118,7 +118,7 @@ Metrics/MethodLength:
 
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
-  Max: 167
+  Max: 195
 
 # Configuration parameters: Max, CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 0.60.0 - June 15, 2026
+- Add YARD macro support for DSL methods (#1187)
+- YARD macros - More typecheck fixes (#1188)
+- Macro fixes (#1189)
+- Unused macro methods (#1191)
+- Transitive macros (#1203)
+- Allow CTRL-C interruption of profile command + macro debug logs (#1206)
+- Support for Inline RBS (#1173)
+- Make typechecker errors vim quickfix friendly (#1072)
+- Generate RBS (#812)
+
+## 0.59.2 - May 22, 2026
+- Convert RBS implicit nil annotations (#1197)
+- Temporary job stubs (#1200)
+- Limit pin combination to doc maps (#1195)
+- Ignore literal values in type inference (#1201)
+- Fix for clips with flaky node recipients
+
 ## 0.59.1 - May 18, 2026
 - Fix signatureHelp bug (#1185)
 - Linting fixes for Ruby 3.1 (#1193)

data/Gemfile

@@ -4,6 +4,9 @@ source 'https://rubygems.org'
 
 gemspec name: 'solargraph'
 
+# Test fixture gems
+gem 'gem-with-yard-macros', path: 'spec/fixtures/gem-with-yard-macros'
+
 # Local gemfile for development tools, etc.
 local_gemfile = File.expand_path('.Gemfile', __dir__)
 instance_eval File.read local_gemfile if File.exist? local_gemfile

data/lib/solargraph/api_map/index.rb

@@ -5,6 +5,12 @@ module Solargraph
     class Index
       include Logging
 
+      # @return [Array<String>]
+      attr_reader :macro_method_names
+
+      # @return [Hash{String => Array<Pin::Method>}]
+      attr_reader :macro_method_name_pins
+
       # @param pins [Array<Pin::Base>]
       def initialize pins = []
         catalog pins
@@ -95,16 +101,18 @@ module Solargraph
       protected
 
       attr_writer :pins, :pin_select_cache, :namespace_hash, :pin_class_hash, :path_pin_hash, :include_references,
-                  :extend_references, :prepend_references, :superclass_references
+                  :extend_references, :prepend_references, :superclass_references, :macro_method_names,
+                  :macro_method_name_pins
 
       # @return [self]
       def deep_clone
         Index.allocate.tap do |copy|
           copy.pin_select_cache = {}
           copy.pins = pins.clone
+          copy.macro_method_names = macro_method_names
           %i[
             namespace_hash pin_class_hash path_pin_hash include_references extend_references prepend_references
-            superclass_references
+            superclass_references macro_method_name_pins
           ].each do |sym|
             copy.send("#{sym}=", send(sym).clone)
             copy.send(sym)&.transform_values!(&:clone)
@@ -137,6 +145,9 @@ module Solargraph
         map_references Pin::Reference::Prepend, prepend_references
         map_references Pin::Reference::Extend, extend_references
         map_references Pin::Reference::Superclass, superclass_references
+        macro_pins = pins_by_class(Pin::Method).select { |pin| pin.macros.any? }
+        @macro_method_names = macro_pins.to_set(&:name)
+        @macro_method_name_pins = macro_pins.to_set.classify(&:name)
         map_overrides
         pins_by_class(Pin::Reference::TypeAlias).each { |pin| alias_hash[pin.name] = pin.return_type }
         self

data/lib/solargraph/api_map/store.rb

@@ -21,11 +21,11 @@ module Solargraph
       #   - pinsets[0] = core Ruby pins
       #   - pinsets[1] = documentation/gem pins
       #   - pinsets[2] = convention pins
-      #   - pinsets[3] = workspace source pins
+      #   - pinsets[3] = workspace source pins (aka. "iced_pins")
       #   - pinsets[4] = currently open file pins
       # @return [Boolean] True if the index was updated
-      def update *pinsets
-        return catalog(pinsets) if pinsets.length != @pinsets.length
+      def update *pinsets, &block
+        return catalog(pinsets, &block) if pinsets.length != @pinsets.length
 
         changed = pinsets.find_index.with_index { |pinset, idx| @pinsets[idx] != pinset }
         return false unless changed
@@ -43,6 +43,9 @@ module Solargraph
                                       @indexes[changed + idx - 1].merge(pins)
                                     end
         end
+        # @type [Index]
+        @index = @indexes.last.clone
+        @index = @index.merge(block.call) if block
         constants.clear
         cached_qualify_superclass.clear
         true
@@ -71,10 +74,9 @@ module Solargraph
       # @param visibility [Array<Symbol>]
       # @return [Enumerable<Solargraph::Pin::Method>]
       def get_methods fqns, scope: :instance, visibility: [:public]
-        all_pins = namespace_children(fqns).select do |pin|
+        namespace_children(fqns).select do |pin|
           pin.is_a?(Pin::Method) && pin.scope == scope && visibility.include?(pin.visibility)
         end
-        GemPins.combine_method_pins_by_path(all_pins)
       end
 
       BOOLEAN_SUPERCLASS_PIN = Pin::Reference::Superclass.new(name: 'Boolean', closure: Pin::ROOT_PIN,
@@ -175,7 +177,7 @@ module Solargraph
         result
       end
 
-      # @return [Hash{String => YARD::Tags::MacroDirective}]
+      # @return [Hash{String => YardMap::Macro}]
       def named_macros
         @named_macros ||= begin
           result = {}
@@ -277,17 +279,27 @@ module Solargraph
         index.alias_hash[name]
       end
 
+      # @return [Array<String>]
+      def macro_method_names
+        index.macro_method_names
+      end
+
+      # @return [Hash{String => Array<Pin::Method>}]
+      def macro_method_name_pins
+        index.macro_method_name_pins
+      end
+
       private
 
       # @return [Index]
       def index
-        @indexes.last
+        @index ||= Index.new
       end
 
       # @param pinsets [Array<Array<Pin::Base>>]
       #
       # @return [true]
-      def catalog pinsets
+      def catalog pinsets, &block
         @pinsets = pinsets
         # @type [Array<Index>]
         @indexes = []
@@ -298,6 +310,8 @@ module Solargraph
             @indexes.push(@indexes.last&.merge(pins) || Solargraph::ApiMap::Index.new(pins))
           end
         end
+        @index = @indexes.last.clone
+        @index = @index.merge(block.call) if block
         constants.clear
         cached_qualify_superclass.clear
         true

data/lib/solargraph/api_map.rb

@@ -107,6 +107,7 @@ module Solargraph
     # @return [self]
     def catalog bench
       @source_map_hash = bench.source_map_hash
+      # @type [Array<Pin::Base>]
       iced_pins = bench.icebox.flat_map(&:pins)
       live_pins = bench.live_map&.all_pins || []
       conventions_environ.clear
@@ -123,11 +124,42 @@ module Solargraph
         @doc_map = DocMap.new(unresolved_requires, bench.workspace, out: nil) # @todo Implement gem preferences
         @unresolved_requires = @doc_map.unresolved_requires
       end
-      @cache.clear if store.update(@@core_map.pins, @doc_map.pins, conventions_environ.pins, iced_pins, live_pins)
+      start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      Solargraph.logger.info 'Cataloging ApiMap started'
+      @cache.clear if store.update(@@core_map.pins, @doc_map.pins, conventions_environ.pins, iced_pins, live_pins) { process_macros }
       @missing_docs = [] # @todo Implement missing docs
+      Solargraph.logger.info "Cataloging ApiMap finished in #{Process.clock_gettime(Process::CLOCK_MONOTONIC) - start_time} seconds"
       self
     end
 
+    # @return [Array<Pin::Base>]
+    def process_macros
+      macro_pins = []
+      Solargraph.logger.debug { "ApiMap#process_macros: processing macros for #{source_maps.size} source maps" }
+      Solargraph.logger.debug { "ApiMap#process_macros: store has #{store.macro_method_name_pins.size} macro method name pins" }
+      Solargraph.logger.debug { "ApiMap#process_macros: named macros: #{store.named_macros.keys.join(', ')}" }
+      source_maps.each do |source_map|
+        method_candidates = source_map.macro_method_candidates(store.macro_method_names)
+        Solargraph.logger.debug { "ApiMap#process_macros: processing source map for #{source_map.filename} with #{method_candidates.size} macro method candidates" }
+        method_candidates.each do |node|
+          closure = source_map.locate_closure_pin(node.location.line, node.location.column)
+          chain = Solargraph::Parser::ParserGem::NodeChainer.chain(node)
+          if node.children[0].nil? && store.macro_method_name_pins.key?(node.children[1].to_s)
+            match = store.macro_method_name_pins[node.children[1].to_s].find do |pin|
+              super_and_sub?(pin.namespace, closure.name)
+            end
+            if match
+              match.macros.each do |macro|
+                macro_pins.concat macro.generate_pins_from(chain, match, source_map)
+              end
+              next
+            end
+          end
+        end
+      end
+      macro_pins
+    end
+
     # @return [DocMap]
     def doc_map
       @doc_map ||= DocMap.new([], Workspace.new('.'))
@@ -154,7 +186,7 @@ module Solargraph
     end
 
     # @param name [String, nil]
-    # @return [YARD::Tags::MacroDirective, nil]
+    # @return [Solargraph::YardMap::Macro, nil]
     def named_macro name
       # @sg-ignore Need to add nil check here
       store.named_macros[name]
@@ -375,6 +407,9 @@ module Solargraph
     #
     # @return [Pin::BaseVariable, nil]
     def var_at_location candidates, name, closure, location
+      # @todo Location can be nil if clips have trouble finding node recipients
+      return unless location
+
       with_correct_name = candidates.select { |pin| pin.name == name }
       vars_at_location = with_correct_name.reject do |pin|
         # visible_at? excludes the starting position, but we want to
@@ -416,11 +451,6 @@ module Solargraph
     # @param deep [Boolean] True to include superclasses, mixins, etc.
     # @return [Array<Solargraph::Pin::Method>]
     def get_methods rooted_tag, scope: :instance, visibility: [:public], deep: true
-      if rooted_tag.start_with? 'Array('
-        # Array() are really tuples - use our fill, as the RBS repo
-        # does not give us definitions for it
-        rooted_tag = "Solargraph::Fills::Tuple(#{rooted_tag[6..-2]})"
-      end
       rooted_type = ComplexType.try_parse(rooted_tag)
       fqns = rooted_type.namespace
       namespace_pin = store.get_path_pins(fqns).select { |p| p.is_a?(Pin::Namespace) }.first
@@ -721,7 +751,7 @@ module Solargraph
       logger.debug do
         "ApiMap#resolve_method_aliases(pins=#{pins.map(&:name)}, visibility=#{visibility}) => #{with_resolved_aliases.map(&:name)}"
       end
-      GemPins.combine_method_pins_by_path(with_resolved_aliases)
+      with_resolved_aliases
     end
 
     # @return [Workspace, nil]

data/lib/solargraph/complex_type/type_methods.rb

@@ -59,6 +59,7 @@ module Solargraph
       end
 
       def tuple?
+        return false
         @tuple ||= (name == 'Tuple') || (name == 'Array' && subtypes.length >= 1 && fixed_parameters?)
       end
 

data/lib/solargraph/complex_type/unique_type.rb

@@ -147,6 +147,7 @@ module Solargraph
       end
 
       def literal?
+        return false
         non_literal_name != name
       end
 
@@ -228,11 +229,11 @@ module Solargraph
         #   covariant
         # contravariant?: Proc - can be changed, so we can pass
         #   in less specific super types
-        if %w[Hash Tuple Array Set Enumerable].include?(name) && fixed_parameters?
-          :covariant
-        else
-          default
-        end
+        # if %w[Hash Tuple Array Set Enumerable].include?(name) && fixed_parameters?
+        #   :covariant
+        # else
+        default
+        # end
       end
 
       # Whether this is an RBS interface like _ToAry or Hash::_Key.
@@ -374,6 +375,7 @@ module Solargraph
 
       # @return [UniqueType]
       def downcast_to_literal_if_possible
+        return self
         SINGLE_SUBTYPE.fetch(rooted_tag, self)
       end
 
@@ -456,15 +458,12 @@ module Solargraph
               else
                 next ComplexType::UNDEFINED
               end
-            elsif context_type.all?(&:implicit_union?)
-              if idx.zero? && !context_type.all_params.empty?
-                ComplexType.new(context_type.all_params)
-              else
-                ComplexType::UNDEFINED
-              end
+            # @todo Treating parameterized classes and tuples the same for now
+            # elsif context_type.all?(&:implicit_union?) || true
+            elsif idx.zero? && !context_type.all_params.empty?
+              ComplexType.new(context_type.all_params)
             else
-              # @sg-ignore Need to add nil check here
-              context_type.all_params[idx] || definitions.generic_defaults[generic_name] || ComplexType::UNDEFINED
+              ComplexType::UNDEFINED
             end
           else
             t
@@ -548,6 +547,10 @@ module Solargraph
         yield new_type
       end
 
+      def expand named_types
+        named_types[name] || self
+      end
+
       # Generate a ComplexType that fully qualifies this type's namespaces.
       #
       # @param api_map [ApiMap] The ApiMap that performs qualification

data/lib/solargraph/complex_type.rb

@@ -189,6 +189,7 @@ module Solargraph
 
     # @return [ComplexType]
     def downcast_to_literal_if_possible
+      return self
       ComplexType.new(items.map(&:downcast_to_literal_if_possible))
     end
 
@@ -297,6 +298,10 @@ module Solargraph
       ComplexType.new(map { |ut| ut.transform(new_name, &transform_type) })
     end
 
+    def expand named_types
+      ComplexType.new(map { |ut| ut.expand(named_types) })
+    end
+
     # @return [self]
     def force_rooted
       transform do |t|