solargraph 0.59.1 → 0.60.0

data/lib/solargraph/parser/parser_gem/node_processors/alias_node.rb

@@ -1,24 +1,24 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Parser
-    module ParserGem
-      module NodeProcessors
-        class AliasNode < Parser::NodeProcessor::Base
-          def process
-            loc = get_node_location(node)
-            pins.push Solargraph::Pin::MethodAlias.new(
-              location: loc,
-              closure: region.closure,
-              name: node.children[0].children[0].to_s,
-              original: node.children[1].children[0].to_s,
-              scope: region.scope || :instance,
-              source: :parser
-            )
-            process_children
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Parser
+    module ParserGem
+      module NodeProcessors
+        class AliasNode < Parser::NodeProcessor::Base
+          def process
+            loc = get_node_location(node)
+            pins.push Solargraph::Pin::MethodAlias.new(
+              location: loc,
+              closure: region.closure,
+              name: node.children[0].children[0].to_s,
+              original: node.children[1].children[0].to_s,
+              scope: region.scope || :instance,
+              source: :parser
+            )
+            process_children
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/parser/parser_gem/node_processors/casgn_node.rb

@@ -1,36 +1,36 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Parser
-    module ParserGem
-      module NodeProcessors
-        class CasgnNode < Parser::NodeProcessor::Base
-          include ParserGem::NodeMethods
-
-          def process
-            pins.push Solargraph::Pin::Constant.new(
-              location: get_node_location(node),
-              closure: region.closure,
-              name: const_name,
-              comments: comments_for(node),
-              assignment: node.children[2],
-              source: :parser
-            )
-            process_children
-          end
-
-          private
-
-          # @return [String]
-          def const_name
-            if node.children[0]
-              Parser::NodeMethods.unpack_name(node.children[0]) + "::#{node.children[1]}"
-            else
-              node.children[1].to_s
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Parser
+    module ParserGem
+      module NodeProcessors
+        class CasgnNode < Parser::NodeProcessor::Base
+          include ParserGem::NodeMethods
+
+          def process
+            pins.push Solargraph::Pin::Constant.new(
+              location: get_node_location(node),
+              closure: region.closure,
+              name: const_name,
+              comments: comments_for(node),
+              assignment: node.children[2],
+              source: :parser
+            )
+            process_children
+          end
+
+          private
+
+          # @return [String]
+          def const_name
+            if node.children[0]
+              Parser::NodeMethods.unpack_name(node.children[0]) + "::#{node.children[1]}"
+            else
+              node.children[1].to_s
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/parser/parser_gem/node_processors/cvasgn_node.rb

@@ -1,24 +1,24 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Parser
-    module ParserGem
-      module NodeProcessors
-        class CvasgnNode < Parser::NodeProcessor::Base
-          def process
-            loc = get_node_location(node)
-            pins.push Solargraph::Pin::ClassVariable.new(
-              location: loc,
-              closure: region.closure,
-              name: node.children[0].to_s,
-              comments: comments_for(node),
-              assignment: node.children[1],
-              source: :parser
-            )
-            process_children
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Parser
+    module ParserGem
+      module NodeProcessors
+        class CvasgnNode < Parser::NodeProcessor::Base
+          def process
+            loc = get_node_location(node)
+            pins.push Solargraph::Pin::ClassVariable.new(
+              location: loc,
+              closure: region.closure,
+              name: node.children[0].to_s,
+              comments: comments_for(node),
+              assignment: node.children[1],
+              source: :parser
+            )
+            process_children
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/parser/parser_gem/node_processors/gvasgn_node.rb

@@ -1,24 +1,24 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Parser
-    module ParserGem
-      module NodeProcessors
-        class GvasgnNode < Parser::NodeProcessor::Base
-          def process
-            loc = get_node_location(node)
-            pins.push Solargraph::Pin::GlobalVariable.new(
-              location: loc,
-              closure: region.closure,
-              name: node.children[0].to_s,
-              comments: comments_for(node),
-              assignment: node.children[1],
-              source: :parser
-            )
-            process_children
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Parser
+    module ParserGem
+      module NodeProcessors
+        class GvasgnNode < Parser::NodeProcessor::Base
+          def process
+            loc = get_node_location(node)
+            pins.push Solargraph::Pin::GlobalVariable.new(
+              location: loc,
+              closure: region.closure,
+              name: node.children[0].to_s,
+              comments: comments_for(node),
+              assignment: node.children[1],
+              source: :parser
+            )
+            process_children
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/parser/parser_gem/node_processors/namespace_node.rb

@@ -8,22 +8,27 @@ module Solargraph
           include ParserGem::NodeMethods
 
           def process
-            superclass_name = nil
-            superclass_name = unpack_name(node.children[1]) if node.type == :class && node.children[1]&.type == :const
+            name = unpack_name(node.children[0])
+            comments = comments_for(node)
+
+            superclass_name = if node.type == :class && node.children[1]&.type == :const
+              "#{type_from_node}#{parameters_from_inline_rbs}"
+            end
 
             loc = get_node_location(node)
             nspin = Solargraph::Pin::Namespace.new(
               type: node.type,
               location: loc,
               closure: region.closure,
-              name: unpack_name(node.children[0]),
-              comments: comments_for(node),
+              name: name,
+              comments: comments,
               visibility: :public,
               gates: region.closure.gates.freeze,
               source: :parser
             )
             pins.push nspin
-            unless superclass_name.nil?
+            Solargraph.logger.warn "Superclass: #{superclass_name}" if superclass_name&.start_with?('Array')
+            if superclass_name
               pins.push Pin::Reference::Superclass.new(
                 location: loc,
                 closure: pins.last,
@@ -33,6 +38,25 @@ module Solargraph
             end
             process_children region.update(closure: nspin, visibility: :public)
           end
+
+          private
+
+          # @param comments [String]
+          # @return [String, nil]
+          def parameters_from_inline_rbs
+            source = region.source.code_for(node)
+            match = source.match(/[^\n]*?#\s?+\[([^\]]*)/)
+            return unless match && match[1]
+
+            code = match[1].strip
+            return if code.empty?
+
+            "<#{code}>"
+          end
+
+          def type_from_node
+            unpack_name(node.children[1]) if node.children[1]&.type == :const
+          end
         end
       end
     end

data/lib/solargraph/parser/parser_gem/node_processors/sym_node.rb

@@ -1,20 +1,20 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Parser
-    module ParserGem
-      module NodeProcessors
-        class SymNode < Parser::NodeProcessor::Base
-          # @return [void]
-          def process
-            pins.push Solargraph::Pin::Symbol.new(
-              get_node_location(node),
-              ":#{node.children[0]}",
-              source: :parser
-            )
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Parser
+    module ParserGem
+      module NodeProcessors
+        class SymNode < Parser::NodeProcessor::Base
+          # @return [void]
+          def process
+            pins.push Solargraph::Pin::Symbol.new(
+              get_node_location(node),
+              ":#{node.children[0]}",
+              source: :parser
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/pin/base.rb

@@ -534,11 +534,20 @@ module Solargraph
         @directives
       end
 
-      # @return [::Array<YARD::Tags::MacroDirective>]
+      # @return [::Array<Solargraph::YardMap::Macro>]
       def macros
         @macros ||= collect_macros
       end
 
+      def macro_names
+        parse_comments unless @macro_names
+        @macro_names ||= collect_macro_names
+      end
+
+      def macro_names?
+        macro_names.any?
+      end
+
       # Perform a quick check to see if this pin possibly includes YARD
       # directives. This method does not require parsing the comments.
       #
@@ -569,6 +578,15 @@ module Solargraph
         return_type.qualify(api_map, *(closure&.gates || ['']))
       end
 
+      # @todo Candidate for deprecation (see ApiMap#process_macros)
+      def maybe_macros?
+        comments.include?('@macro')        
+      end
+
+      def macros_names?
+        macro_names.any?
+      end
+
       # Infer the pin's return type via static code analysis.
       #
       # @param api_map [ApiMap]
@@ -619,6 +637,8 @@ module Solargraph
         result = dup
         result.return_type = return_type
         result.proxied = true
+        # Macros should have been processed already
+        result.macro_names.clear
         result
       end
 
@@ -717,12 +737,14 @@ module Solargraph
         if comments.nil? || comments.empty? || comments.strip.end_with?('@overload')
           @docstring = nil
           @directives = []
+          @macro_names = []
         else
           # HACK: Pass a dummy code object to the parser for plugins that
           # expect it not to be nil
           parse = Solargraph::Source.parse_docstring(comments)
           @docstring = parse.to_docstring
           @directives = parse.directives
+          @macro_names = collect_macro_names
         end
       end
 
@@ -762,11 +784,17 @@ module Solargraph
           tag1.types == tag2.types
       end
 
-      # @return [::Array<YARD::Tags::Handlers::Directive>]
+      # @return [::Array<Solargraph::YardMap::Macro>]
       def collect_macros
         return [] unless maybe_directives?
         parse = Solargraph::Source.parse_docstring(comments)
-        parse.directives.select { |d| d.tag.tag_name == 'macro' }
+        parse.directives.select { |d| d.tag.tag_name == 'macro' }.map do |macro_directive|
+          Solargraph::YardMap::Macro.from_directive macro_directive, self
+        end
+      end
+
+      def collect_macro_names
+        "#{comments}\n".scan(/\s*?@macro +(\S+).*?[\n]/).map { |match| match[0] }
       end
     end
   end

data/lib/solargraph/pin/callable.rb

@@ -161,8 +161,8 @@ module Solargraph
       end
 
       def typify api_map
-        type = super
-        return type if type.defined?
+        type = return_type
+        return type.qualify(api_map, *gates) if type.defined?
         if method_name.end_with?('?')
           logger.debug { "Callable#typify(self=#{self}) => Boolean (? suffix)" }
           ComplexType::BOOLEAN

data/lib/solargraph/pin/common.rb

@@ -72,6 +72,18 @@ module Solargraph
         @path ||= name.empty? ? context.namespace : "#{context.namespace}::#{name}"
       end
 
+      # @yieldparam [Pin::Base]
+      # @return [void, Enumerator<Pin::Base>]
+      def each_closure &block
+        return enum_for(:each_closure) unless block_given?
+
+        here = closure
+        until here.nil?
+          yield here
+          here = here&.closure
+        end
+      end
+
       protected
 
       attr_writer :context

data/lib/solargraph/pin/method.rb

@@ -143,7 +143,7 @@ module Solargraph
       end
 
       def return_type
-        @return_type ||= ComplexType.new(signatures.map(&:return_type).flat_map(&:items))
+        @return_type ||= return_type_from_inline_rbs || ComplexType.new(signatures.map(&:return_type).flat_map(&:items))
       end
 
       # @param parameters [::Array<Parameter>]
@@ -188,18 +188,11 @@ module Solargraph
 
       # @return [::Array<Signature>]
       def signatures
-        @signatures ||= begin
-          top_type = generate_complex_type
-          result = []
-          result.push generate_signature(parameters, top_type) if top_type.defined?
-          unless overloads.empty?
-            result.concat(overloads.map do |meth|
-              generate_signature(meth.parameters, meth.return_type)
-            end)
-          end
-          result.push generate_signature(parameters, @return_type || ComplexType::UNDEFINED) if result.empty?
-          result
-        end
+        @signatures ||= if inline_rbs.empty?
+                          signatures_from_yard
+                        else
+                          signatures_from_inline_rbs
+                        end
       end
 
       # @param return_type [ComplexType]
@@ -279,7 +272,19 @@ module Solargraph
           # @sg-ignore Need to add nil check here
           "Method#typify(self=#{self}, binder=#{binder}, closure=#{closure}, context=#{context.rooted_tags}, return_type=#{return_type.rooted_tags}) - starting"
         end
-        decl = super
+        decl = if macro_names?
+          types = macro_names.flat_map do |mac|
+            directive = api_map.named_macro(mac)
+            next unless directive
+            macro = Solargraph::YardMap::Macro.from_directive(directive, self)
+            expanded = macro.macro_object.expand([name, *parameter_names])
+            docstring = Solargraph::Source.parse_docstring(expanded).to_docstring
+            docstring.tags(:return).flat_map(&:types)
+          end
+          ComplexType.try_parse(*types)
+        else
+          super
+        end
         unless decl.undefined?
           logger.debug do
             "Method#typify(self=#{self}, binder=#{binder}, closure=#{closure}, context=#{context}) => #{decl.rooted_tags.inspect} - decl found"
@@ -451,7 +456,6 @@ module Solargraph
 
       attr_writer :block, :signature_help, :documentation, :return_type
 
-      # @sg-ignore Need to add nil check here
       def dodgy_visibility_source?
         # as of 2025-03-12, the RBS generator used for
         # e.g. activesupport did not understand 'private' markings
@@ -505,7 +509,8 @@ module Solargraph
       #
       # @return [Array<Pin::Signature>]
       def combine_same_type_arity_signatures same_type_arity_signatures
-        # @todo Stubbing this method while we debug an infinite loop bug in Ruby 3.x
+        # @todo Stubbing this method while we debug an infinite loop bug in Ruby 3.x.
+        #   The body below is intentionally preserved for when the stub is removed.
         return same_type_arity_signatures
 
         # rubocop:disable Lint/UnreachableCode
@@ -721,6 +726,41 @@ module Solargraph
         .join("\n")
         .concat("```\n")
       end
+
+      # @return [ComplexType, nil]
+      def return_type_from_inline_rbs
+        return nil if inline_rbs.empty?
+        method_type = RBS::Parser.parse_method_type(inline_rbs)
+        RbsTranslator.to_complex_type(method_type.type.return_type)
+      rescue RBS::ParsingError
+        nil
+      end
+
+      # @return [Array<Pin::Signature>]
+      def signatures_from_inline_rbs
+        method_type = RBS::Parser.parse_method_type(inline_rbs)
+        [RbsTranslator.to_signature(method_type, self, parameter_names)]
+      rescue RBS::ParsingError
+        signatures_from_yard
+      end
+
+      # @return [Array<Pin::Signature>]
+      def signatures_from_yard
+        top_type = generate_complex_type
+        result = []
+        result.push generate_signature(parameters, top_type) if top_type.defined?
+        result.concat(overloads.map { |meth| generate_signature(meth.parameters, meth.return_type) }) unless overloads.empty?
+        result.push generate_signature(parameters, @return_type || ComplexType::UNDEFINED) if result.empty?
+        result
+      end
+
+      # @return [String]
+      def inline_rbs
+        comments.lines
+                .select { |line| line.start_with?(': ') }
+                .map { |line| line[2..].strip }
+                .join("\n")
+      end
     end
   end
 end

data/lib/solargraph/pin/reference/require.rb

@@ -1,14 +1,14 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Pin
-    class Reference
-      class Require < Reference
-        def initialize location, name, **splat
-          # super(location, '', name)
-          super(location: location, name: name, closure: Pin::ROOT_PIN, **splat)
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    class Reference
+      class Require < Reference
+        def initialize location, name, **splat
+          # super(location, '', name)
+          super(location: location, name: name, closure: Pin::ROOT_PIN, **splat)
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/pin/singleton.rb

@@ -1,11 +1,11 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Pin
-    class Singleton < Closure
-      def initialize name: '', location: nil, closure: nil, **splat
-        super
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    class Singleton < Closure
+      def initialize name: '', location: nil, closure: nil, **splat
+        super
+      end
+    end
+  end
+end