solargraph 0.51.0 → 0.52.0

data/lib/solargraph/parser.rb

@@ -19,6 +19,8 @@ module Solargraph
 
     selected = rubyvm? ? Rubyvm : Legacy
     # include selected
+    # @!parse
+    #   extend Solargraph::Parser::Legacy::ClassMethods
     extend selected::ClassMethods
 
     NodeMethods = (rubyvm? ? Rubyvm::NodeMethods : Legacy::NodeMethods)

data/lib/solargraph/pin/base.rb

@@ -217,7 +217,7 @@ module Solargraph
       end
 
       def identity
-        @identity ||= "#{closure.context.namespace}|#{name}"
+        @identity ||= "#{closure.path}|#{name}"
       end
 
       def inspect

data/lib/solargraph/pin/block.rb

@@ -58,12 +58,17 @@ module Solargraph
             return Solargraph::ComplexType.parse(closure.binder.namespace)
           end
         end
-        # other case without early return, read block yieldself tags
+        # other case without early return, read block yieldreceiver tags
         receiver_pin = chain.define(api_map, self, locals).first
         if receiver_pin && receiver_pin.docstring
-          ys = receiver_pin.docstring.tag(:yieldself)
+          ys = receiver_pin.docstring.tag(:yieldreceiver)
           if ys && ys.types && !ys.types.empty?
-            return ComplexType.try_parse(*ys.types).qualify(api_map, receiver_pin.context.namespace).self_to(receiver_pin.full_context.namespace)
+            target = if chain.links.first.is_a?(Source::Chain::Constant)
+              receiver_pin.full_context.namespace
+            else
+              full_context.namespace
+            end
+            return ComplexType.try_parse(*ys.types).qualify(api_map, receiver_pin.context.namespace).self_to(target)
           end
         end
         nil

data/lib/solargraph/pin/delegated_method.rb

@@ -12,7 +12,7 @@ module Solargraph
       # to a method pin on that type.
       #
       # @param resolved_method [Method] an already resolved method pin.
-      # @param receiver [Source::Chain] the source code used to resolve the receiver for this delegated method.
+      # @param receiver [Source::Chain, nil] the source code used to resolve the receiver for this delegated method.
       # @param receiver_method_name [String] the method name that will be called on the receiver (defaults to :name).
       def initialize(method: nil, receiver: nil, name: method&.name, receiver_method_name: name, **splat)
         raise ArgumentError, 'either :method or :receiver is required' if (method && receiver) || (!method && !receiver)

data/lib/solargraph/pin/method.rb

@@ -19,7 +19,7 @@ module Solargraph
       # @param visibility [::Symbol] :public, :protected, or :private
       # @param explicit [Boolean]
       # @param parameters [Array<Pin::Parameter>]
-      # @param node [Parser::AST::Node, RubyVM::AbstractSyntaxTree::Node]
+      # @param node [Parser::AST::Node, RubyVM::AbstractSyntaxTree::Node, nil]
       # @param attribute [Boolean]
       def initialize visibility: :public, explicit: true, parameters: [], node: nil, attribute: false, signatures: nil, anon_splat: false, **splat
         super(**splat)
@@ -46,7 +46,38 @@ module Solargraph
       end
 
       def return_type
-        @return_type ||= ComplexType.try_parse(*signatures.map(&:return_type).map(&:to_s))
+        @return_type ||= ComplexType.new(signatures.map(&:return_type).flat_map(&:items))
+      end
+
+      # @return [Signature]
+      def generate_signature(parameters, return_type)
+        block = nil
+        yieldparam_tags = docstring.tags(:yieldparam)
+        yieldreturn_tags = docstring.tags(:yieldreturn)
+        needs_block_param_signature =
+          parameters.last&.block? || !yieldreturn_tags.empty? || !yieldparam_tags.empty?
+        if needs_block_param_signature
+          yield_parameters = yieldparam_tags.map do |p|
+            name = p.name
+            decl = :arg
+            if name
+              decl = select_decl(name, false)
+              name = clean_param(name)
+            end
+            Pin::Parameter.new(
+              location: location,
+              closure: self,
+              comments: p.text,
+              name: name,
+              decl: decl,
+              presence: location ? location.range : nil,
+              return_type: ComplexType.try_parse(*p.types)
+            )
+          end
+          yield_return_type = ComplexType.try_parse(*yieldreturn_tags.flat_map(&:types))
+          block = Signature.new(yield_parameters, yield_return_type)
+        end
+        Signature.new(parameters, return_type, block)
       end
 
       # @return [Array<Signature>]
@@ -54,9 +85,9 @@ module Solargraph
         @signatures ||= begin
           top_type = generate_complex_type
           result = []
-          result.push Signature.new(parameters, top_type) if top_type.defined?
-          result.concat(overloads.map { |meth| Signature.new(meth.parameters, meth.return_type) })
-          result.push Signature.new(parameters, top_type) if result.empty?
+          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, top_type) if result.empty?
           result
         end
       end
@@ -115,6 +146,32 @@ module Solargraph
             end
             @documentation += lines.join("\n")
           end
+          yieldparam_tags = docstring.tags(:yieldparam)
+          unless yieldparam_tags.nil? or yieldparam_tags.empty?
+            @documentation += "\n\n" unless @documentation.empty?
+            @documentation += "Block Params:\n"
+            lines = []
+            yieldparam_tags.each do |p|
+              l = "* #{p.name}"
+              l += " [#{escape_brackets(p.types.join(', '))}]" unless p.types.nil? or p.types.empty?
+              l += " #{p.text}"
+              lines.push l
+            end
+            @documentation += lines.join("\n")
+          end
+          yieldreturn_tags = docstring.tags(:yieldreturn)
+          unless yieldreturn_tags.empty?
+            @documentation += "\n\n" unless @documentation.empty?
+            @documentation += "Block Returns:\n"
+            lines = []
+            yieldreturn_tags.each do |r|
+              l = "*"
+              l += " [#{escape_brackets(r.types.join(', '))}]" unless r.types.nil? or r.types.empty?
+              l += " #{r.text}"
+              lines.push l
+            end
+            @documentation += lines.join("\n")
+          end
           return_tags = docstring.tags(:return)
           unless return_tags.empty?
             @documentation += "\n\n" unless @documentation.empty?
@@ -130,11 +187,7 @@ module Solargraph
           end
           @documentation += "\n\n" unless @documentation.empty?
           @documentation += "Visibility: #{visibility}"
-          example_tags = docstring.tags(:example)
-          unless example_tags.empty?
-            @documentation += "\n\nExamples:\n\n"
-            @documentation += example_tags.map(&:text).join("\n")
-          end
+          concat_example_tags
         end
         @documentation.to_s
       end
@@ -335,6 +388,18 @@ module Solargraph
           [name, :arg]
         end
       end
+
+      def concat_example_tags
+        example_tags = docstring.tags(:example)
+        return if example_tags.empty?
+        @documentation += "\n\nExamples:\n\n```ruby\n"
+        @documentation += example_tags.map do |tag|
+          (tag.name && !tag.name.empty? ? "# #{tag.name}\n" : '') +
+            "#{tag.text}\n"
+        end
+        .join("\n")
+        .concat("```\n")
+      end
     end
   end
 end

data/lib/solargraph/pin/namespace.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'solargraph/yard_tags'
+
 module Solargraph
   module Pin
     class Namespace < Closure
@@ -9,12 +11,12 @@ module Solargraph
       # @return [::Symbol] :class or :module
       attr_reader :type
 
-      attr_reader :parameters
+      attr_reader :generics
 
       # @param type [::Symbol] :class or :module
       # @param visibility [::Symbol] :public or :private
       # @param gates [Array<String>]
-      def initialize type: :class, visibility: :public, gates: [''], parameters: [], **splat
+      def initialize type: :class, visibility: :public, gates: [''], generics: nil, **splat
         # super(location, namespace, name, comments)
         super(**splat)
         @type = type
@@ -38,7 +40,7 @@ module Solargraph
           @closure = Pin::Namespace.new(name: closure_name, gates: [parts.join('::')])
           @context = nil
         end
-        @parameters = parameters
+        @generics = generics
       end
 
       def namespace
@@ -89,6 +91,11 @@ module Solargraph
           [path] + @open_gates
         end
       end
+
+      # @return [Array<String>]
+      def generics
+        @generics ||= docstring.tags(:generic).map(&:name)
+      end
     end
   end
 end

data/lib/solargraph/pin/parameter.rb

@@ -123,17 +123,16 @@ module Solargraph
           clip = api_map.clip_at(location.filename, location.range.start)
           locals = clip.locals - [self]
           meths = chain.define(api_map, closure, locals)
+          receiver_type = chain.base.infer(api_map, closure, locals)
           meths.each do |meth|
-            if meth.docstring.has_tag?(:yieldparam_single_parameter)
-              type = chain.base.infer(api_map, closure, locals)
-              if type.defined? && !type.subtypes.empty?
-                bmeth = chain.base.define(api_map, closure, locals).first
-                return type.subtypes.first.qualify(api_map, bmeth.context.namespace)
-              end
-            else
-              yps = meth.docstring.tags(:yieldparam)
-              unless yps[index].nil? or yps[index].types.nil? or yps[index].types.empty?
-                return ComplexType.try_parse(yps[index].types.first).self_to(chain.base.infer(api_map, closure, locals).namespace).qualify(api_map, meth.context.namespace)
+            yps = meth.docstring.tags(:yieldparam)
+            unless yps[index].nil? or yps[index].types.nil? or yps[index].types.empty?
+              yield_type = ComplexType.try_parse(yps[index].types.first)
+              if yield_type.generic? && receiver_type.defined?
+                namespace_pin = api_map.get_namespace_pins(meth.namespace, closure.namespace).first
+                return yield_type.resolve_generics(namespace_pin, receiver_type)
+              else
+                return yield_type.self_to(chain.base.infer(api_map, closure, locals).namespace).qualify(api_map, meth.context.namespace)
               end
             end
           end

data/lib/solargraph/pin/signature.rb

@@ -1,20 +1,28 @@
 module Solargraph
   module Pin
-    class Signature
+    class Signature < Base
       # @return [Array<Parameter>]
       attr_reader :parameters
 
       # @return [ComplexType]
       attr_reader :return_type
 
+      # @return [self]
       attr_reader :block
 
+      # @param parameters [Array<Parameter>]
+      # @param return_type [ComplexType]
+      # @param block [Signature, nil]
       def initialize parameters, return_type, block = nil
         @parameters = parameters
         @return_type = return_type
         @block = block
       end
 
+      def identity
+        @identity ||= "signature#{object_id}"
+      end
+
       def block?
         !!@block
       end

data/lib/solargraph/rbs_map/conversions.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'rbs'
+
 module Solargraph
   class RbsMap
     # Functions for converting RBS declarations to Solargraph pins
@@ -25,15 +27,42 @@ module Solargraph
 
       private
 
+      # @return Hash{String => RBS::AST::Declarations::TypeAlias}
       def type_aliases
         @type_aliases ||= {}
       end
 
+      # @param loader [RBS::EnvironmentLoader]
+      # @return [void]
+      def load_environment_to_pins(loader)
+        environment = RBS::Environment.from_loader(loader).resolve_type_names
+        cursor = pins.length
+        environment.declarations.each { |decl| convert_decl_to_pin(decl, Solargraph::Pin::ROOT_PIN) }
+        added_pins = pins[cursor..-1]
+        add_back_implicit_pins(added_pins)
+      end
+
+      # @param added_pins [Range<Pin>]
+      # @return [void]
+      def add_back_implicit_pins(added_pins)
+        added_pins.each do |pin|
+          pin.source = :rbs
+          next unless pin.is_a?(Pin::Namespace) && pin.type == :class
+          next if pins.any? { |p| p.path == "#{pin.path}.new"}
+          pins.push Solargraph::Pin::Method.new(
+                      location: nil,
+                      closure: pin,
+                      name: 'new',
+                      comments: pin.comments,
+                      scope: :class
+          )
+        end
+      end
+
       # @param decl [RBS::AST::Declarations::Base]
       # @param closure [Pin::Closure]
       # @return [void]
       def convert_decl_to_pin decl, closure
-        cursor = pins.length
         case decl
         when RBS::AST::Declarations::Class
           class_decl_to_pin decl
@@ -46,18 +75,10 @@ module Solargraph
           module_decl_to_pin decl
         when RBS::AST::Declarations::Constant
           constant_decl_to_pin decl
-        end
-        pins[cursor..-1].each do |pin|
-          pin.source = :rbs
-          next unless pin.is_a?(Pin::Namespace) && pin.type == :class
-          next if pins.any? { |p| p.path == "#{pin.path}.new"}
-          pins.push Solargraph::Pin::Method.new(
-            location: nil,
-            closure: pin.closure,
-            name: 'new',
-            comments: pin.comments,
-            scope: :class
-          )
+        when RBS::AST::Declarations::ClassAlias
+          class_alias_decl_to_pin decl
+        else
+          Solargraph.logger.info "Skipping declaration #{decl.class}"
         end
       end
 
@@ -106,7 +127,7 @@ module Solargraph
           name: decl.name.relative!.to_s,
           closure: Solargraph::Pin::ROOT_PIN,
           comments: decl.comment&.string,
-          parameters: decl.type_params.map(&:name).map(&:to_s)
+          generics: decl.type_params.map(&:name).map(&:to_s)
         )
         pins.push class_pin
         if decl.super_class
@@ -142,16 +163,20 @@ module Solargraph
           type: :module,
           name: decl.name.relative!.to_s,
           closure: Solargraph::Pin::ROOT_PIN,
-          comments: decl.comment&.string
+          comments: decl.comment&.string,
+          generics: decl.type_params.map(&:name).map(&:to_s),
         )
         pins.push module_pin
         convert_members_to_pin decl, module_pin
       end
 
-      # @param decl [RBS::AST::Declarations::Constant]
-      # @return [void]
-      def constant_decl_to_pin decl
-        parts = decl.name.relative!.to_s.split('::')
+      # @param name [String]
+      # @param tag [String]
+      # @param comments [String]
+      #
+      # @return [Solargraph::Pin::Constant]
+      def create_constant(name, tag, comments)
+        parts = name.split('::')
         if parts.length > 1
           name = parts.last
           closure = pins.select { |pin| pin && pin.path == parts[0..-2].join('::') }.first
@@ -159,15 +184,31 @@ module Solargraph
           name = parts.first
           closure = Solargraph::Pin::ROOT_PIN
         end
-        pin = Solargraph::Pin::Constant.new(
+        constant_pin = Solargraph::Pin::Constant.new(
           name: name,
           closure: closure,
-          comments: decl.comment&.string
+          comments: comments
         )
-        tag = other_type_to_tag(decl.type)
         # @todo Class or Module?
-        pin.docstring.add_tag(YARD::Tags::Tag.new(:return, '', "Class<#{tag}>"))
-        pins.push pin
+        constant_pin.docstring.add_tag(YARD::Tags::Tag.new(:return, '', "Class<#{tag}>"))
+        constant_pin
+      end
+
+      # @param decl [RBS::AST::Declarations::ClassAlias]
+      # @return [void]
+      def class_alias_decl_to_pin decl
+        # See https://www.rubydoc.info/gems/rbs/3.4.3/RBS/AST/Declarations/ClassAlias
+        new_name = decl.new_name.relative!.to_s
+        old_name = decl.old_name.relative!.to_s
+
+        pins.push create_constant(new_name, old_name, decl.comment&.string)
+      end
+
+      # @param decl [RBS::AST::Declarations::Constant]
+      # @return [void]
+      def constant_decl_to_pin decl
+        tag = other_type_to_tag(decl.type)
+        pins.push create_constant(decl.name.relative!.to_s, tag, decl.comment&.string)
       end
 
       # @param decl [RBS::AST::Members::MethodDefinition]
@@ -243,7 +284,8 @@ module Solargraph
         end
         type.type.optional_positionals.each do |param|
           name = param.name ? param.name.to_s : "arg#{arg_num += 1}"
-          parameters.push Solargraph::Pin::Parameter.new(decl: :optarg, name: name, closure: pin)
+          parameters.push Solargraph::Pin::Parameter.new(decl: :optarg, name: name, closure: pin,
+                                                         return_type: ComplexType.try_parse(other_type_to_tag(param.type)))
         end
         if type.type.rest_positionals
           name = type.type.rest_positionals.name ? type.type.rest_positionals.name.to_s : "arg#{arg_num += 1}"
@@ -253,13 +295,15 @@ module Solargraph
           name = param.name ? param.name.to_s : "arg#{arg_num += 1}"
           parameters.push Solargraph::Pin::Parameter.new(decl: :arg, name: name, closure: pin)
         end
-        type.type.required_keywords.each do |orig, _param|
+        type.type.required_keywords.each do |orig, param|
           name = orig ? orig.to_s : "arg#{arg_num += 1}"
-          parameters.push Solargraph::Pin::Parameter.new(decl: :kwarg, name: name, closure: pin)
+          parameters.push Solargraph::Pin::Parameter.new(decl: :kwarg, name: name, closure: pin,
+                                                         return_type: ComplexType.try_parse(other_type_to_tag(param.type)))
         end
-        type.type.optional_keywords.each do |orig, _param|
+        type.type.optional_keywords.each do |orig, param|
           name = orig ? orig.to_s : "arg#{arg_num += 1}"
-          parameters.push Solargraph::Pin::Parameter.new(decl: :kwoptarg, name: name, closure: pin)
+          parameters.push Solargraph::Pin::Parameter.new(decl: :kwoptarg, name: name, closure: pin,
+                                                         return_type: ComplexType.try_parse(other_type_to_tag(param.type)))
         end
         if type.type.rest_keywords
           name = type.type.rest_keywords.name ? type.type.rest_keywords.name.to_s : "arg#{arg_num += 1}"
@@ -329,6 +373,7 @@ module Solargraph
         )
       end
 
+      # @param decl [RBS::AST::Members::Alias]
       def alias_to_pin decl, closure
         pins.push Solargraph::Pin::MethodAlias.new(
           name: decl.new_name.to_s,
@@ -345,6 +390,8 @@ module Solargraph
         'NilClass' => 'nil'
       }
 
+      # @param type [RBS::AST::Members::MethodDefinition::Overload]
+      # @return [String]
       def method_type_to_tag type
         if type_aliases.key?(type.type.return_type.to_s)
           other_type_to_tag(type_aliases[type.type.return_type.to_s].type)
@@ -378,16 +425,24 @@ module Solargraph
         elsif type.is_a?(RBS::Types::Bases::Void)
           'void'
         elsif type.is_a?(RBS::Types::Variable)
-          "param<#{type.name}>"
+          "#{Solargraph::ComplexType::GENERIC_TAG_NAME}<#{type.name}>"
         elsif type.is_a?(RBS::Types::ClassInstance) #&& !type.args.empty?
           base = RBS_TO_YARD_TYPE[type.name.relative!.to_s] || type.name.relative!.to_s
           params = type.args.map { |a| other_type_to_tag(a) }.reject { |t| t == 'undefined' }
           return base if params.empty?
           "#{base}<#{params.join(', ')}>"
+        elsif type.is_a?(RBS::Types::Bases::Instance)
+          'self'
+        elsif type.is_a?(RBS::Types::Bases::Top) || type.is_a?(RBS::Types::Bases::Bottom)
+          'self'
+        elsif type.is_a?(RBS::Types::Intersection)
+          type.types.map { |member| other_type_to_tag(member) }.join(', ')
+        elsif type.is_a?(RBS::Types::Proc)
+          'Proc'
         elsif type.respond_to?(:name) && type.name.respond_to?(:relative!)
           RBS_TO_YARD_TYPE[type.name.relative!.to_s] || type.name.relative!.to_s
         else
-          Solargraph.logger.warn "Unrecognized RBS type: #{type.class} #{type}"
+          Solargraph.logger.warn "Unrecognized RBS type: #{type.class} at #{type.location}"
           'undefined'
         end
       end

data/lib/solargraph/rbs_map/core_fills.rb

@@ -16,8 +16,10 @@ module Solargraph
       ].map { |k| Pin::Keyword.new(k) }
 
       MISSING = [
-        Solargraph::Pin::Method.new(name: 'tap', scope: :instance, closure: Solargraph::Pin::Namespace.new(name: 'Object')),
-        Solargraph::Pin::Method.new(name: 'class', scope: :instance, closure: Solargraph::Pin::Namespace.new(name: 'Object'), comments: '@return [Class<self>]')
+        Solargraph::Pin::Method.new(name: 'tap', scope: :instance,
+                                    closure: Solargraph::Pin::Namespace.new(name: 'Object')),
+        Solargraph::Pin::Method.new(name: 'class', scope: :instance,
+                                    closure: Solargraph::Pin::Namespace.new(name: 'Object'), comments: '@return [Class<self>]')
       ]
 
       YIELDPARAMS = [
@@ -27,7 +29,7 @@ module Solargraph
         )),
         Override.from_comment('String#each_line', %(
 @yieldparam [String]
-        )),
+        ))
       ]
 
       methods_with_yieldparam_subtypes = %w[
@@ -39,16 +41,14 @@ module Solargraph
       ]
 
       YIELDPARAM_SINGLE_PARAMETERS = methods_with_yieldparam_subtypes.map do |path|
-        Override.from_comment(path, %(
-@yieldparam_single_parameter
-          ))
+        Override.from_comment(path, <<~DOC
+          @yieldparam [generic<Elem>]
+        DOC
+        )
       end
 
       CLASS_RETURN_TYPES = [
-        Override.method_return('Class#new', 'self'),
-        Override.method_return('Class.new', 'Class<BasicObject>'),
         Override.method_return('Class#allocate', 'self'),
-        Override.method_return('Class.allocate', 'Class<BasicObject>'),
       ]
 
       # HACK: Add Errno exception classes
@@ -64,4 +64,3 @@ module Solargraph
     end
   end
 end
-

data/lib/solargraph/rbs_map/core_map.rb

@@ -14,7 +14,7 @@ module Solargraph
         else
           loader = RBS::EnvironmentLoader.new(repository: RBS::Repository.new(no_stdlib: false))
           environment = RBS::Environment.from_loader(loader).resolve_type_names
-          environment.declarations.each { |decl| convert_decl_to_pin(decl, Solargraph::Pin::ROOT_PIN) }
+          load_environment_to_pins(loader)
           pins.concat RbsMap::CoreFills::ALL
           processed = ApiMap::Store.new(pins).pins.reject { |p| p.is_a?(Solargraph::Pin::Reference::Override) }
           pins.replace processed

data/lib/solargraph/rbs_map.rb

@@ -24,8 +24,7 @@ module Solargraph
       loader = RBS::EnvironmentLoader.new(core_root: nil, repository: repository)
       add_library loader, library
       return unless resolved?
-      environment = RBS::Environment.from_loader(loader).resolve_type_names
-      environment.declarations.each { |decl| convert_decl_to_pin(decl, Solargraph::Pin::ROOT_PIN) }
+      load_environment_to_pins(loader)
     end
 
     def path_pin path
@@ -57,7 +56,7 @@ module Solargraph
     # @return [Boolean] true if adding the library succeeded
     def add_library loader, library
       @resolved = if loader.has_library?(library: library, version: nil)
-        loader.add library: library
+        loader.add library: library, version: nil
         Solargraph.logger.info "#{short_name} successfully loaded library #{library}"
         true
       else

data/lib/solargraph/source/chain/array.rb

@@ -0,0 +1,29 @@
+module Solargraph
+  class Source
+    class Chain
+      class Array < Literal
+        # @param type [String]
+        def initialize children
+          super('::Array')
+          @children = children
+        end
+
+        def word
+          @word ||= "<#{@type}>"
+        end
+
+        def resolve api_map, name_pin, locals
+          child_types = @children.map do |child|
+            child.infer(api_map, name_pin, locals).tag
+          end
+          type = if child_types.uniq.length == 1 && child_types.first != 'undefined'
+                   "::Array<#{child_types.first}>"
+                 else
+                   '::Array'
+                 end
+          [Pin::ProxyType.anonymous(ComplexType.try_parse(type))]
+        end
+      end
+    end
+  end
+end